aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Module Name: hwvalid - I/O request validation
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers *****************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Copyright (C) 2000 - 2016, Intel Corp.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * All rights reserved.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Redistribution and use in source and binary forms, with or without
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * modification, are permitted provided that the following conditions
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * 1. Redistributions of source code must retain the above copyright
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * notice, this list of conditions, and the following disclaimer,
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * without modification.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * 2. Redistributions in binary form must reproduce at minimum a disclaimer
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * substantially similar to the "NO WARRANTY" disclaimer below
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * ("Disclaimer") and any redistribution must be conditioned upon
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * including a substantially similar Disclaimer requirement for further
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * binary redistribution.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * 3. Neither the names of the above-listed copyright holders nor the names
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * of any contributors may be used to endorse or promote products derived
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * from this software without specific prior written permission.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Alternatively, this software may be distributed under the terms of the
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * GNU General Public License ("GPL") version 2 as published by the Free
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Software Foundation.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * NO WARRANTY
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * POSSIBILITY OF SUCH DAMAGES.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/* Local prototypes */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Protected I/O ports. Some ports are always illegal, and some are
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * conditionally illegal. This table must remain ordered by port address.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * The table is used to implement the Microsoft port access rules that
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * first appeared in Windows XP. Some ports are always illegal, and some
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * ports are only illegal if the BIOS calls _OSI with a WinXP string or
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * later (meaning that the BIOS itelf is post-XP.)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * This provides ACPICA with the desired port protections and
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Microsoft compatibility.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Description of port entries:
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DMA: DMA controller
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PIC0: Programmable Interrupt Controller (8259A)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PIT1: System Timer 1
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PIT2: System Timer 2 failsafe
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RTC: Real-time clock
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * CMOS: Extended CMOS
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DMA1: DMA 1 page registers
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DMA1L: DMA 1 Ch 0 low page
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DMA2: DMA 2 page registers
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DMA2L: DMA 2 low page refresh
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * ARBC: Arbitration control
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * SETUP: Reserved system board setup
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * POS: POS channel select
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PIC1: Cascaded PIC
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * IDMA: ISA DMA
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * ELCR: PIC edge/level registers
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PCI: PCI configuration space
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myersstatic const ACPI_PORT_INFO AcpiProtectedPorts[] =
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers#define ACPI_PORT_INFO_ENTRIES ACPI_ARRAY_LENGTH (AcpiProtectedPorts)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiHwValidateIoRequest
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: Address Address of I/O port/register
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * BitWidth Number of bits (8,16,32)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Validates an I/O request (address/length). Certain ports are
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * always illegal and some ports are only illegal depending on
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * the requests the BIOS AML code makes to the predefined
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * _OSI method.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Supported widths are 8/16/32 */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_DEBUG_PRINT ((ACPI_DB_IO, "Address %8.8X%8.8X LastAddress %8.8X%8.8X Length %X",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_FORMAT_UINT64 (Address), ACPI_FORMAT_UINT64 (LastAddress),
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Maximum 16-bit address in I/O space */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Illegal I/O port address/length above 64K: %8.8X%8.8X/0x%X",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Exit if requested address is not within the protected port table */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if (Address > AcpiProtectedPorts[ACPI_PORT_INFO_ENTRIES - 1].End)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Check request against the list of protected I/O ports */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers for (i = 0; i < ACPI_PORT_INFO_ENTRIES; i++, PortInfo++)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Check if the requested address range will write to a reserved
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * port. Four cases to consider:
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 1) Address range is contained completely in the port address range
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 2) Address range overlaps port range at the port range start
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 3) Address range overlaps port range at the port range end
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 4) Address range completely encompasses the port range
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if ((Address <= PortInfo->End) && (LastAddress >= PortInfo->Start))
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Port illegality may depend on the _OSI calls made by the BIOS */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Denied AML access to port 0x%8.8X%8.8X/%X (%s 0x%.4X-0x%.4X)",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_FORMAT_UINT64 (Address), ByteWidth, PortInfo->Name,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Finished if address range ends before the end of this port */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiHwReadPort
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: Address Address of I/O port/register to read
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Value Where value is placed
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Width Number of bits
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status and value read from port
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Read data from an I/O port or register. This is a front-end
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * to AcpiOsReadPort that performs validation on both the port
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * address and the length.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers *****************************************************************************/
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross /* Truncate address to 16 bits if requested */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Validate the entire request and perform the I/O */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiHwValidateIoRequest (Address, Width);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * There has been a protection violation within the request. Fall
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * back to byte granularity port I/O and ignore the failing bytes.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * This provides Windows compatibility.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Validate and read one byte */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if (AcpiHwValidateIoRequest (Address, 8) == AE_OK)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiHwWritePort
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: Address Address of I/O port/register to write
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Value Value to write
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Width Number of bits
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Write data to an I/O port or register. This is a front-end
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * to AcpiOsWritePort that performs validation on both the port
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * address and the length.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers *****************************************************************************/
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross /* Truncate address to 16 bits if requested */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Validate the entire request and perform the I/O */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiHwValidateIoRequest (Address, Width);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiOsWritePort (Address, Value, Width);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * There has been a protection violation within the request. Fall
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * back to byte granularity port I/O and ignore the failing bytes.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * This provides Windows compatibility.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Validate and write one byte */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if (AcpiHwValidateIoRequest (Address, 8) == AE_OK)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiOsWritePort (Address, (Value >> i) & 0xFF, 8);