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 - 2016, 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 #include "acpi.h" 117 #include "accommon.h" 118 119 #define _COMPONENT ACPI_HARDWARE 120 ACPI_MODULE_NAME ("hwvalid") 121 122 /* Local prototypes */ 123 124 static ACPI_STATUS 125 AcpiHwValidateIoRequest ( 126 ACPI_IO_ADDRESS Address, 127 UINT32 BitWidth); 128 129 130 /* 131 * Protected I/O ports. Some ports are always illegal, and some are 132 * conditionally illegal. This table must remain ordered by port address. 133 * 134 * The table is used to implement the Microsoft port access rules that 135 * first appeared in Windows XP. Some ports are always illegal, and some 136 * ports are only illegal if the BIOS calls _OSI with a WinXP string or 137 * later (meaning that the BIOS itelf is post-XP.) 138 * 139 * This provides ACPICA with the desired port protections and 140 * Microsoft compatibility. 141 * 142 * Description of port entries: 143 * DMA: DMA controller 144 * PIC0: Programmable Interrupt Controller (8259A) 145 * PIT1: System Timer 1 146 * PIT2: System Timer 2 failsafe 147 * RTC: Real-time clock 148 * CMOS: Extended CMOS 149 * DMA1: DMA 1 page registers 150 * DMA1L: DMA 1 Ch 0 low page 151 * DMA2: DMA 2 page registers 152 * DMA2L: DMA 2 low page refresh 153 * ARBC: Arbitration control 154 * SETUP: Reserved system board setup 155 * POS: POS channel select 156 * PIC1: Cascaded PIC 157 * IDMA: ISA DMA 158 * ELCR: PIC edge/level registers 159 * PCI: PCI configuration space 160 */ 161 static const ACPI_PORT_INFO AcpiProtectedPorts[] = 162 { 163 {"DMA", 0x0000, 0x000F, ACPI_OSI_WIN_XP}, 164 {"PIC0", 0x0020, 0x0021, ACPI_ALWAYS_ILLEGAL}, 165 {"PIT1", 0x0040, 0x0043, ACPI_OSI_WIN_XP}, 166 {"PIT2", 0x0048, 0x004B, ACPI_OSI_WIN_XP}, 167 {"RTC", 0x0070, 0x0071, ACPI_OSI_WIN_XP}, 168 {"CMOS", 0x0074, 0x0076, ACPI_OSI_WIN_XP}, 169 {"DMA1", 0x0081, 0x0083, ACPI_OSI_WIN_XP}, 170 {"DMA1L", 0x0087, 0x0087, ACPI_OSI_WIN_XP}, 171 {"DMA2", 0x0089, 0x008B, ACPI_OSI_WIN_XP}, 172 {"DMA2L", 0x008F, 0x008F, ACPI_OSI_WIN_XP}, 173 {"ARBC", 0x0090, 0x0091, ACPI_OSI_WIN_XP}, 174 {"SETUP", 0x0093, 0x0094, ACPI_OSI_WIN_XP}, 175 {"POS", 0x0096, 0x0097, ACPI_OSI_WIN_XP}, 176 {"PIC1", 0x00A0, 0x00A1, ACPI_ALWAYS_ILLEGAL}, 177 {"IDMA", 0x00C0, 0x00DF, ACPI_OSI_WIN_XP}, 178 {"ELCR", 0x04D0, 0x04D1, ACPI_ALWAYS_ILLEGAL}, 179 {"PCI", 0x0CF8, 0x0CFF, ACPI_OSI_WIN_XP} 180 }; 181 182 #define ACPI_PORT_INFO_ENTRIES ACPI_ARRAY_LENGTH (AcpiProtectedPorts) 183 184 185 /****************************************************************************** 186 * 187 * FUNCTION: AcpiHwValidateIoRequest 188 * 189 * PARAMETERS: Address Address of I/O port/register 190 * BitWidth Number of bits (8,16,32) 191 * 192 * RETURN: Status 193 * 194 * DESCRIPTION: Validates an I/O request (address/length). Certain ports are 195 * always illegal and some ports are only illegal depending on 196 * the requests the BIOS AML code makes to the predefined 197 * _OSI method. 198 * 199 ******************************************************************************/ 200 201 static ACPI_STATUS 202 AcpiHwValidateIoRequest ( 203 ACPI_IO_ADDRESS Address, 204 UINT32 BitWidth) 205 { 206 UINT32 i; 207 UINT32 ByteWidth; 208 ACPI_IO_ADDRESS LastAddress; 209 const ACPI_PORT_INFO *PortInfo; 210 211 212 ACPI_FUNCTION_TRACE (HwValidateIoRequest); 213 214 215 /* Supported widths are 8/16/32 */ 216 217 if ((BitWidth != 8) && 218 (BitWidth != 16) && 219 (BitWidth != 32)) 220 { 221 ACPI_ERROR ((AE_INFO, 222 "Bad BitWidth parameter: %8.8X", BitWidth)); 223 return (AE_BAD_PARAMETER); 224 } 225 226 PortInfo = AcpiProtectedPorts; 227 ByteWidth = ACPI_DIV_8 (BitWidth); 228 LastAddress = Address + ByteWidth - 1; 229 230 ACPI_DEBUG_PRINT ((ACPI_DB_IO, "Address %8.8X%8.8X LastAddress %8.8X%8.8X Length %X", 231 ACPI_FORMAT_UINT64 (Address), ACPI_FORMAT_UINT64 (LastAddress), 232 ByteWidth)); 233 234 /* Maximum 16-bit address in I/O space */ 235 236 if (LastAddress > ACPI_UINT16_MAX) 237 { 238 ACPI_ERROR ((AE_INFO, 239 "Illegal I/O port address/length above 64K: %8.8X%8.8X/0x%X", 240 ACPI_FORMAT_UINT64 (Address), ByteWidth)); 241 return_ACPI_STATUS (AE_LIMIT); 242 } 243 244 /* Exit if requested address is not within the protected port table */ 245 246 if (Address > AcpiProtectedPorts[ACPI_PORT_INFO_ENTRIES - 1].End) 247 { 248 return_ACPI_STATUS (AE_OK); 249 } 250 251 /* Check request against the list of protected I/O ports */ 252 253 for (i = 0; i < ACPI_PORT_INFO_ENTRIES; i++, PortInfo++) 254 { 255 /* 256 * Check if the requested address range will write to a reserved 257 * port. Four cases to consider: 258 * 259 * 1) Address range is contained completely in the port address range 260 * 2) Address range overlaps port range at the port range start 261 * 3) Address range overlaps port range at the port range end 262 * 4) Address range completely encompasses the port range 263 */ 264 if ((Address <= PortInfo->End) && (LastAddress >= PortInfo->Start)) 265 { 266 /* Port illegality may depend on the _OSI calls made by the BIOS */ 267 268 if (AcpiGbl_OsiData >= PortInfo->OsiDependency) 269 { 270 ACPI_DEBUG_PRINT ((ACPI_DB_IO, 271 "Denied AML access to port 0x%8.8X%8.8X/%X (%s 0x%.4X-0x%.4X)", 272 ACPI_FORMAT_UINT64 (Address), ByteWidth, PortInfo->Name, 273 PortInfo->Start, PortInfo->End)); 274 275 return_ACPI_STATUS (AE_AML_ILLEGAL_ADDRESS); 276 } 277 } 278 279 /* Finished if address range ends before the end of this port */ 280 281 if (LastAddress <= PortInfo->End) 282 { 283 break; 284 } 285 } 286 287 return_ACPI_STATUS (AE_OK); 288 } 289 290 291 /****************************************************************************** 292 * 293 * FUNCTION: AcpiHwReadPort 294 * 295 * PARAMETERS: Address Address of I/O port/register to read 296 * Value Where value is placed 297 * Width Number of bits 298 * 299 * RETURN: Status and value read from port 300 * 301 * DESCRIPTION: Read data from an I/O port or register. This is a front-end 302 * to AcpiOsReadPort that performs validation on both the port 303 * address and the length. 304 * 305 *****************************************************************************/ 306 307 ACPI_STATUS 308 AcpiHwReadPort ( 309 ACPI_IO_ADDRESS Address, 310 UINT32 *Value, 311 UINT32 Width) 312 { 313 ACPI_STATUS Status; 314 UINT32 OneByte; 315 UINT32 i; 316 317 318 /* Truncate address to 16 bits if requested */ 319 320 if (AcpiGbl_TruncateIoAddresses) 321 { 322 Address &= ACPI_UINT16_MAX; 323 } 324 325 /* Validate the entire request and perform the I/O */ 326 327 Status = AcpiHwValidateIoRequest (Address, Width); 328 if (ACPI_SUCCESS (Status)) 329 { 330 Status = AcpiOsReadPort (Address, Value, Width); 331 return (Status); 332 } 333 334 if (Status != AE_AML_ILLEGAL_ADDRESS) 335 { 336 return (Status); 337 } 338 339 /* 340 * There has been a protection violation within the request. Fall 341 * back to byte granularity port I/O and ignore the failing bytes. 342 * This provides Windows compatibility. 343 */ 344 for (i = 0, *Value = 0; i < Width; i += 8) 345 { 346 /* Validate and read one byte */ 347 348 if (AcpiHwValidateIoRequest (Address, 8) == AE_OK) 349 { 350 Status = AcpiOsReadPort (Address, &OneByte, 8); 351 if (ACPI_FAILURE (Status)) 352 { 353 return (Status); 354 } 355 356 *Value |= (OneByte << i); 357 } 358 359 Address++; 360 } 361 362 return (AE_OK); 363 } 364 365 366 /****************************************************************************** 367 * 368 * FUNCTION: AcpiHwWritePort 369 * 370 * PARAMETERS: Address Address of I/O port/register to write 371 * Value Value to write 372 * Width Number of bits 373 * 374 * RETURN: Status 375 * 376 * DESCRIPTION: Write data to an I/O port or register. This is a front-end 377 * to AcpiOsWritePort that performs validation on both the port 378 * address and the length. 379 * 380 *****************************************************************************/ 381 382 ACPI_STATUS 383 AcpiHwWritePort ( 384 ACPI_IO_ADDRESS Address, 385 UINT32 Value, 386 UINT32 Width) 387 { 388 ACPI_STATUS Status; 389 UINT32 i; 390 391 392 /* Truncate address to 16 bits if requested */ 393 394 if (AcpiGbl_TruncateIoAddresses) 395 { 396 Address &= ACPI_UINT16_MAX; 397 } 398 399 /* Validate the entire request and perform the I/O */ 400 401 Status = AcpiHwValidateIoRequest (Address, Width); 402 if (ACPI_SUCCESS (Status)) 403 { 404 Status = AcpiOsWritePort (Address, Value, Width); 405 return (Status); 406 } 407 408 if (Status != AE_AML_ILLEGAL_ADDRESS) 409 { 410 return (Status); 411 } 412 413 /* 414 * There has been a protection violation within the request. Fall 415 * back to byte granularity port I/O and ignore the failing bytes. 416 * This provides Windows compatibility. 417 */ 418 for (i = 0; i < Width; i += 8) 419 { 420 /* Validate and write one byte */ 421 422 if (AcpiHwValidateIoRequest (Address, 8) == AE_OK) 423 { 424 Status = AcpiOsWritePort (Address, (Value >> i) & 0xFF, 8); 425 if (ACPI_FAILURE (Status)) 426 { 427 return (Status); 428 } 429 } 430 431 Address++; 432 } 433 434 return (AE_OK); 435 } 436