1 /******************************************************************************
2  *
3  * Module Name: hwvalid - I/O request validation
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #include "acpi.h"
153 #include "accommon.h"
154 
155 #define _COMPONENT          ACPI_HARDWARE
156         ACPI_MODULE_NAME    ("hwvalid")
157 
158 /* Local prototypes */
159 
160 static ACPI_STATUS
161 AcpiHwValidateIoRequest (
162     ACPI_IO_ADDRESS         Address,
163     UINT32                  BitWidth);
164 
165 
166 /*
167  * Protected I/O ports. Some ports are always illegal, and some are
168  * conditionally illegal. This table must remain ordered by port address.
169  *
170  * The table is used to implement the Microsoft port access rules that
171  * first appeared in Windows XP. Some ports are always illegal, and some
172  * ports are only illegal if the BIOS calls _OSI with a WinXP string or
173  * later (meaning that the BIOS itelf is post-XP.)
174  *
175  * This provides ACPICA with the desired port protections and
176  * Microsoft compatibility.
177  *
178  * Description of port entries:
179  *  DMA:   DMA controller
180  *  PIC0:  Programmable Interrupt Controller (8259A)
181  *  PIT1:  System Timer 1
182  *  PIT2:  System Timer 2 failsafe
183  *  RTC:   Real-time clock
184  *  CMOS:  Extended CMOS
185  *  DMA1:  DMA 1 page registers
186  *  DMA1L: DMA 1 Ch 0 low page
187  *  DMA2:  DMA 2 page registers
188  *  DMA2L: DMA 2 low page refresh
189  *  ARBC:  Arbitration control
190  *  SETUP: Reserved system board setup
191  *  POS:   POS channel select
192  *  PIC1:  Cascaded PIC
193  *  IDMA:  ISA DMA
194  *  ELCR:  PIC edge/level registers
195  *  PCI:   PCI configuration space
196  */
197 static const ACPI_PORT_INFO     AcpiProtectedPorts[] =
198 {
199     {"DMA",     0x0000, 0x000F, ACPI_OSI_WIN_XP},
200     {"PIC0",    0x0020, 0x0021, ACPI_ALWAYS_ILLEGAL},
201     {"PIT1",    0x0040, 0x0043, ACPI_OSI_WIN_XP},
202     {"PIT2",    0x0048, 0x004B, ACPI_OSI_WIN_XP},
203     {"RTC",     0x0070, 0x0071, ACPI_OSI_WIN_XP},
204     {"CMOS",    0x0074, 0x0076, ACPI_OSI_WIN_XP},
205     {"DMA1",    0x0081, 0x0083, ACPI_OSI_WIN_XP},
206     {"DMA1L",   0x0087, 0x0087, ACPI_OSI_WIN_XP},
207     {"DMA2",    0x0089, 0x008B, ACPI_OSI_WIN_XP},
208     {"DMA2L",   0x008F, 0x008F, ACPI_OSI_WIN_XP},
209     {"ARBC",    0x0090, 0x0091, ACPI_OSI_WIN_XP},
210     {"SETUP",   0x0093, 0x0094, ACPI_OSI_WIN_XP},
211     {"POS",     0x0096, 0x0097, ACPI_OSI_WIN_XP},
212     {"PIC1",    0x00A0, 0x00A1, ACPI_ALWAYS_ILLEGAL},
213     {"IDMA",    0x00C0, 0x00DF, ACPI_OSI_WIN_XP},
214     {"ELCR",    0x04D0, 0x04D1, ACPI_ALWAYS_ILLEGAL},
215     {"PCI",     0x0CF8, 0x0CFF, ACPI_OSI_WIN_XP}
216 };
217 
218 #define ACPI_PORT_INFO_ENTRIES      ACPI_ARRAY_LENGTH (AcpiProtectedPorts)
219 
220 
221 /******************************************************************************
222  *
223  * FUNCTION:    AcpiHwValidateIoRequest
224  *
225  * PARAMETERS:  Address             Address of I/O port/register
226  *              BitWidth            Number of bits (8,16,32)
227  *
228  * RETURN:      Status
229  *
230  * DESCRIPTION: Validates an I/O request (address/length). Certain ports are
231  *              always illegal and some ports are only illegal depending on
232  *              the requests the BIOS AML code makes to the predefined
233  *              _OSI method.
234  *
235  ******************************************************************************/
236 
237 static ACPI_STATUS
AcpiHwValidateIoRequest(ACPI_IO_ADDRESS Address,UINT32 BitWidth)238 AcpiHwValidateIoRequest (
239     ACPI_IO_ADDRESS         Address,
240     UINT32                  BitWidth)
241 {
242     UINT32                  i;
243     UINT32                  ByteWidth;
244     ACPI_IO_ADDRESS         LastAddress;
245     const ACPI_PORT_INFO    *PortInfo;
246 
247 
248     ACPI_FUNCTION_TRACE (HwValidateIoRequest);
249 
250 
251     /* Supported widths are 8/16/32 */
252 
253     if ((BitWidth != 8) &&
254         (BitWidth != 16) &&
255         (BitWidth != 32))
256     {
257         ACPI_ERROR ((AE_INFO,
258             "Bad BitWidth parameter: %8.8X", BitWidth));
259         return_ACPI_STATUS (AE_BAD_PARAMETER);
260     }
261 
262     PortInfo = AcpiProtectedPorts;
263     ByteWidth = ACPI_DIV_8 (BitWidth);
264     LastAddress = Address + ByteWidth - 1;
265 
266     ACPI_DEBUG_PRINT ((ACPI_DB_IO,
267         "Address %8.8X%8.8X LastAddress %8.8X%8.8X Length %X",
268         ACPI_FORMAT_UINT64 (Address), ACPI_FORMAT_UINT64 (LastAddress),
269         ByteWidth));
270 
271     /* Maximum 16-bit address in I/O space */
272 
273     if (LastAddress > ACPI_UINT16_MAX)
274     {
275         ACPI_ERROR ((AE_INFO,
276             "Illegal I/O port address/length above 64K: %8.8X%8.8X/0x%X",
277             ACPI_FORMAT_UINT64 (Address), ByteWidth));
278         return_ACPI_STATUS (AE_LIMIT);
279     }
280 
281     /* Exit if requested address is not within the protected port table */
282 
283     if (Address > AcpiProtectedPorts[ACPI_PORT_INFO_ENTRIES - 1].End)
284     {
285         return_ACPI_STATUS (AE_OK);
286     }
287 
288     /* Check request against the list of protected I/O ports */
289 
290     for (i = 0; i < ACPI_PORT_INFO_ENTRIES; i++, PortInfo++)
291     {
292         /*
293          * Check if the requested address range will write to a reserved
294          * port. There are four cases to consider:
295          *
296          * 1) Address range is contained completely in the port address range
297          * 2) Address range overlaps port range at the port range start
298          * 3) Address range overlaps port range at the port range end
299          * 4) Address range completely encompasses the port range
300          */
301         if ((Address <= PortInfo->End) && (LastAddress >= PortInfo->Start))
302         {
303             /* Port illegality may depend on the _OSI calls made by the BIOS */
304 
305             if (AcpiGbl_OsiData >= PortInfo->OsiDependency)
306             {
307                 ACPI_DEBUG_PRINT ((ACPI_DB_VALUES,
308                     "Denied AML access to port 0x%8.8X%8.8X/%X (%s 0x%.4X-0x%.4X)\n",
309                     ACPI_FORMAT_UINT64 (Address), ByteWidth, PortInfo->Name,
310                     PortInfo->Start, PortInfo->End));
311 
312                 return_ACPI_STATUS (AE_AML_ILLEGAL_ADDRESS);
313             }
314         }
315 
316         /* Finished if address range ends before the end of this port */
317 
318         if (LastAddress <= PortInfo->End)
319         {
320             break;
321         }
322     }
323 
324     return_ACPI_STATUS (AE_OK);
325 }
326 
327 
328 /******************************************************************************
329  *
330  * FUNCTION:    AcpiHwReadPort
331  *
332  * PARAMETERS:  Address             Address of I/O port/register to read
333  *              Value               Where value (data) is returned
334  *              Width               Number of bits
335  *
336  * RETURN:      Status and value read from port
337  *
338  * DESCRIPTION: Read data from an I/O port or register. This is a front-end
339  *              to AcpiOsReadPort that performs validation on both the port
340  *              address and the length.
341  *
342  *****************************************************************************/
343 
344 ACPI_STATUS
AcpiHwReadPort(ACPI_IO_ADDRESS Address,UINT32 * Value,UINT32 Width)345 AcpiHwReadPort (
346     ACPI_IO_ADDRESS         Address,
347     UINT32                  *Value,
348     UINT32                  Width)
349 {
350     ACPI_STATUS             Status;
351     UINT32                  OneByte;
352     UINT32                  i;
353 
354 
355     /* Truncate address to 16 bits if requested */
356 
357     if (AcpiGbl_TruncateIoAddresses)
358     {
359         Address &= ACPI_UINT16_MAX;
360     }
361 
362     /* Validate the entire request and perform the I/O */
363 
364     Status = AcpiHwValidateIoRequest (Address, Width);
365     if (ACPI_SUCCESS (Status))
366     {
367         Status = AcpiOsReadPort (Address, Value, Width);
368         return (Status);
369     }
370 
371     if (Status != AE_AML_ILLEGAL_ADDRESS)
372     {
373         return (Status);
374     }
375 
376     /*
377      * There has been a protection violation within the request. Fall
378      * back to byte granularity port I/O and ignore the failing bytes.
379      * This provides compatibility with other ACPI implementations.
380      */
381     for (i = 0, *Value = 0; i < Width; i += 8)
382     {
383         /* Validate and read one byte */
384 
385         if (AcpiHwValidateIoRequest (Address, 8) == AE_OK)
386         {
387             Status = AcpiOsReadPort (Address, &OneByte, 8);
388             if (ACPI_FAILURE (Status))
389             {
390                 return (Status);
391             }
392 
393             *Value |= (OneByte << i);
394         }
395 
396         Address++;
397     }
398 
399     return (AE_OK);
400 }
401 
402 
403 /******************************************************************************
404  *
405  * FUNCTION:    AcpiHwWritePort
406  *
407  * PARAMETERS:  Address             Address of I/O port/register to write
408  *              Value               Value to write
409  *              Width               Number of bits
410  *
411  * RETURN:      Status
412  *
413  * DESCRIPTION: Write data to an I/O port or register. This is a front-end
414  *              to AcpiOsWritePort that performs validation on both the port
415  *              address and the length.
416  *
417  *****************************************************************************/
418 
419 ACPI_STATUS
AcpiHwWritePort(ACPI_IO_ADDRESS Address,UINT32 Value,UINT32 Width)420 AcpiHwWritePort (
421     ACPI_IO_ADDRESS         Address,
422     UINT32                  Value,
423     UINT32                  Width)
424 {
425     ACPI_STATUS             Status;
426     UINT32                  i;
427 
428 
429     /* Truncate address to 16 bits if requested */
430 
431     if (AcpiGbl_TruncateIoAddresses)
432     {
433         Address &= ACPI_UINT16_MAX;
434     }
435 
436     /* Validate the entire request and perform the I/O */
437 
438     Status = AcpiHwValidateIoRequest (Address, Width);
439     if (ACPI_SUCCESS (Status))
440     {
441         Status = AcpiOsWritePort (Address, Value, Width);
442         return (Status);
443     }
444 
445     if (Status != AE_AML_ILLEGAL_ADDRESS)
446     {
447         return (Status);
448     }
449 
450     /*
451      * There has been a protection violation within the request. Fall
452      * back to byte granularity port I/O and ignore the failing bytes.
453      * This provides compatibility with other ACPI implementations.
454      */
455     for (i = 0; i < Width; i += 8)
456     {
457         /* Validate and write one byte */
458 
459         if (AcpiHwValidateIoRequest (Address, 8) == AE_OK)
460         {
461             Status = AcpiOsWritePort (Address, (Value >> i) & 0xFF, 8);
462             if (ACPI_FAILURE (Status))
463             {
464                 return (Status);
465             }
466         }
467 
468         Address++;
469     }
470 
471     return (AE_OK);
472 }
473