2 /******************************************************************************
4 * Module Name: hwvalid - I/O request validation
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2009, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 #include <acpi/acpi.h>
48 #define _COMPONENT ACPI_HARDWARE
49 ACPI_MODULE_NAME("hwvalid")
51 /* Local prototypes */
53 acpi_hw_validate_io_request(acpi_io_address address, u32 bit_width);
56 * Protected I/O ports. Some ports are always illegal, and some are
57 * conditionally illegal. This table must remain ordered by port address.
59 * The table is used to implement the Microsoft port access rules that
60 * first appeared in Windows XP. Some ports are always illegal, and some
61 * ports are only illegal if the BIOS calls _OSI with a win_xP string or
62 * later (meaning that the BIOS itelf is post-XP.)
64 * This provides ACPICA with the desired port protections and
65 * Microsoft compatibility.
67 * Description of port entries:
69 * PIC0: Programmable Interrupt Controller (8259_a)
70 * PIT1: System Timer 1
71 * PIT2: System Timer 2 failsafe
72 * RTC: Real-time clock
74 * DMA1: DMA 1 page registers
75 * DMA1L: DMA 1 Ch 0 low page
76 * DMA2: DMA 2 page registers
77 * DMA2L: DMA 2 low page refresh
78 * ARBC: Arbitration control
79 * SETUP: Reserved system board setup
80 * POS: POS channel select
83 * ELCR: PIC edge/level registers
84 * PCI: PCI configuration space
86 static const struct acpi_port_info acpi_protected_ports[] = {
87 {"DMA", 0x0000, 0x000F, ACPI_OSI_WIN_XP},
88 {"PIC0", 0x0020, 0x0021, ACPI_ALWAYS_ILLEGAL},
89 {"PIT1", 0x0040, 0x0043, ACPI_OSI_WIN_XP},
90 {"PIT2", 0x0048, 0x004B, ACPI_OSI_WIN_XP},
91 {"RTC", 0x0070, 0x0071, ACPI_OSI_WIN_XP},
92 {"CMOS", 0x0074, 0x0076, ACPI_OSI_WIN_XP},
93 {"DMA1L", 0x0087, 0x0087, ACPI_OSI_WIN_XP},
94 {"DMA2", 0x0089, 0x008B, ACPI_OSI_WIN_XP},
95 {"DMA2L", 0x008F, 0x008F, ACPI_OSI_WIN_XP},
96 {"ARBC", 0x0090, 0x0091, ACPI_OSI_WIN_XP},
97 {"SETUP", 0x0093, 0x0094, ACPI_OSI_WIN_XP},
98 {"POS", 0x0096, 0x0097, ACPI_OSI_WIN_XP},
99 {"PIC1", 0x00A0, 0x00A1, ACPI_ALWAYS_ILLEGAL},
100 {"IDMA", 0x00C0, 0x00DF, ACPI_OSI_WIN_XP},
101 {"ELCR", 0x04D0, 0x04D1, ACPI_ALWAYS_ILLEGAL},
102 {"PCI", 0x0CF8, 0x0CFF, ACPI_OSI_WIN_XP}
105 #define ACPI_PORT_INFO_ENTRIES ACPI_ARRAY_LENGTH (acpi_protected_ports)
107 /******************************************************************************
109 * FUNCTION: acpi_hw_validate_io_request
111 * PARAMETERS: Address Address of I/O port/register
112 * bit_width Number of bits (8,16,32)
116 * DESCRIPTION: Validates an I/O request (address/length). Certain ports are
117 * always illegal and some ports are only illegal depending on
118 * the requests the BIOS AML code makes to the predefined
121 ******************************************************************************/
124 acpi_hw_validate_io_request(acpi_io_address address, u32 bit_width)
128 acpi_io_address last_address;
129 const struct acpi_port_info *port_info;
131 ACPI_FUNCTION_TRACE(hw_validate_io_request);
133 /* Supported widths are 8/16/32 */
135 if ((bit_width != 8) && (bit_width != 16) && (bit_width != 32)) {
136 return AE_BAD_PARAMETER;
139 port_info = acpi_protected_ports;
140 byte_width = ACPI_DIV_8(bit_width);
141 last_address = address + byte_width - 1;
143 ACPI_DEBUG_PRINT((ACPI_DB_IO, "Address %p LastAddress %p Length %X",
144 ACPI_CAST_PTR(void, address), ACPI_CAST_PTR(void,
148 /* Maximum 16-bit address in I/O space */
150 if (last_address > ACPI_UINT16_MAX) {
152 "Illegal I/O port address/length above 64K: 0x%p/%X",
153 ACPI_CAST_PTR(void, address), byte_width));
154 return_ACPI_STATUS(AE_AML_ILLEGAL_ADDRESS);
157 /* Exit if requested address is not within the protected port table */
159 if (address > acpi_protected_ports[ACPI_PORT_INFO_ENTRIES - 1].end) {
160 return_ACPI_STATUS(AE_OK);
163 /* Check request against the list of protected I/O ports */
165 for (i = 0; i < ACPI_PORT_INFO_ENTRIES; i++, port_info++) {
167 * Check if the requested address range will write to a reserved
168 * port. Four cases to consider:
170 * 1) Address range is contained completely in the port address range
171 * 2) Address range overlaps port range at the port range start
172 * 3) Address range overlaps port range at the port range end
173 * 4) Address range completely encompasses the port range
175 if ((address <= port_info->end)
176 && (last_address >= port_info->start)) {
178 /* Port illegality may depend on the _OSI calls made by the BIOS */
180 if (acpi_gbl_osi_data >= port_info->osi_dependency) {
182 "Denied AML access to port 0x%p/%X (%s 0x%.4X-0x%.4X)",
183 ACPI_CAST_PTR(void, address),
184 byte_width, port_info->name,
185 port_info->start, port_info->end));
187 return_ACPI_STATUS(AE_AML_ILLEGAL_ADDRESS);
191 /* Finished if address range ends before the end of this port */
193 if (last_address <= port_info->end) {
198 return_ACPI_STATUS(AE_OK);
201 /******************************************************************************
203 * FUNCTION: acpi_hw_read_port
205 * PARAMETERS: Address Address of I/O port/register to read
206 * Value Where value is placed
207 * Width Number of bits
209 * RETURN: Value read from port
211 * DESCRIPTION: Read data from an I/O port or register. This is a front-end
212 * to acpi_os_read_port that performs validation on both the port
213 * address and the length.
215 *****************************************************************************/
217 acpi_status acpi_hw_read_port(acpi_io_address address, u32 *value, u32 width)
221 status = acpi_hw_validate_io_request(address, width);
222 if (ACPI_FAILURE(status)) {
226 status = acpi_os_read_port(address, value, width);
230 /******************************************************************************
232 * FUNCTION: acpi_hw_write_port
234 * PARAMETERS: Address Address of I/O port/register to write
235 * Value Value to write
236 * Width Number of bits
240 * DESCRIPTION: Write data to an I/O port or register. This is a front-end
241 * to acpi_os_write_port that performs validation on both the port
242 * address and the length.
244 *****************************************************************************/
246 acpi_status acpi_hw_write_port(acpi_io_address address, u32 value, u32 width)
250 status = acpi_hw_validate_io_request(address, width);
251 if (ACPI_FAILURE(status)) {
255 status = acpi_os_write_port(address, value, width);