sys/contrib/dev/acpica-unix/hardware/hwvalid.c

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