ReactOS  0.4.14-dev-384-g5b37caa
hwvalid.c
Go to the documentation of this file.
1 /******************************************************************************
2  *
3  * Module Name: hwvalid - I/O request validation
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2019, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  * notice, this list of conditions, and the following disclaimer,
16  * without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  * substantially similar to the "NO WARRANTY" disclaimer below
19  * ("Disclaimer") and any redistribution must be conditioned upon
20  * including a substantially similar Disclaimer requirement for further
21  * binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  * of any contributors may be used to endorse or promote products derived
24  * from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43 
44 #include "acpi.h"
45 #include "accommon.h"
46 
47 #define _COMPONENT ACPI_HARDWARE
48  ACPI_MODULE_NAME ("hwvalid")
49 
50 /* Local prototypes */
51 
52 static ACPI_STATUS
54  ACPI_IO_ADDRESS Address,
55  UINT32 BitWidth);
56 
57 
58 /*
59  * Protected I/O ports. Some ports are always illegal, and some are
60  * conditionally illegal. This table must remain ordered by port address.
61  *
62  * The table is used to implement the Microsoft port access rules that
63  * first appeared in Windows XP. Some ports are always illegal, and some
64  * ports are only illegal if the BIOS calls _OSI with a WinXP string or
65  * later (meaning that the BIOS itelf is post-XP.)
66  *
67  * This provides ACPICA with the desired port protections and
68  * Microsoft compatibility.
69  *
70  * Description of port entries:
71  * DMA: DMA controller
72  * PIC0: Programmable Interrupt Controller (8259A)
73  * PIT1: System Timer 1
74  * PIT2: System Timer 2 failsafe
75  * RTC: Real-time clock
76  * CMOS: Extended CMOS
77  * DMA1: DMA 1 page registers
78  * DMA1L: DMA 1 Ch 0 low page
79  * DMA2: DMA 2 page registers
80  * DMA2L: DMA 2 low page refresh
81  * ARBC: Arbitration control
82  * SETUP: Reserved system board setup
83  * POS: POS channel select
84  * PIC1: Cascaded PIC
85  * IDMA: ISA DMA
86  * ELCR: PIC edge/level registers
87  * PCI: PCI configuration space
88  */
90 {
91  {"DMA", 0x0000, 0x000F, ACPI_OSI_WIN_XP},
92  {"PIC0", 0x0020, 0x0021, ACPI_ALWAYS_ILLEGAL},
93  {"PIT1", 0x0040, 0x0043, ACPI_OSI_WIN_XP},
94  {"PIT2", 0x0048, 0x004B, ACPI_OSI_WIN_XP},
95  {"RTC", 0x0070, 0x0071, ACPI_OSI_WIN_XP},
96  {"CMOS", 0x0074, 0x0076, ACPI_OSI_WIN_XP},
97  {"DMA1", 0x0081, 0x0083, ACPI_OSI_WIN_XP},
98  {"DMA1L", 0x0087, 0x0087, ACPI_OSI_WIN_XP},
99  {"DMA2", 0x0089, 0x008B, ACPI_OSI_WIN_XP},
100  {"DMA2L", 0x008F, 0x008F, ACPI_OSI_WIN_XP},
101  {"ARBC", 0x0090, 0x0091, ACPI_OSI_WIN_XP},
102  {"SETUP", 0x0093, 0x0094, ACPI_OSI_WIN_XP},
103  {"POS", 0x0096, 0x0097, ACPI_OSI_WIN_XP},
104  {"PIC1", 0x00A0, 0x00A1, ACPI_ALWAYS_ILLEGAL},
105  {"IDMA", 0x00C0, 0x00DF, ACPI_OSI_WIN_XP},
106  {"ELCR", 0x04D0, 0x04D1, ACPI_ALWAYS_ILLEGAL},
107  {"PCI", 0x0CF8, 0x0CFF, ACPI_OSI_WIN_XP}
108 };
109 
110 #define ACPI_PORT_INFO_ENTRIES ACPI_ARRAY_LENGTH (AcpiProtectedPorts)
111 
112 
113 /******************************************************************************
114  *
115  * FUNCTION: AcpiHwValidateIoRequest
116  *
117  * PARAMETERS: Address Address of I/O port/register
118  * BitWidth Number of bits (8,16,32)
119  *
120  * RETURN: Status
121  *
122  * DESCRIPTION: Validates an I/O request (address/length). Certain ports are
123  * always illegal and some ports are only illegal depending on
124  * the requests the BIOS AML code makes to the predefined
125  * _OSI method.
126  *
127  ******************************************************************************/
128 
129 static ACPI_STATUS
131  ACPI_IO_ADDRESS Address,
132  UINT32 BitWidth)
133 {
134  UINT32 i;
135  UINT32 ByteWidth;
136  ACPI_IO_ADDRESS LastAddress;
137  const ACPI_PORT_INFO *PortInfo;
138 
139 
140  ACPI_FUNCTION_TRACE (HwValidateIoRequest);
141 
142 
143  /* Supported widths are 8/16/32 */
144 
145  if ((BitWidth != 8) &&
146  (BitWidth != 16) &&
147  (BitWidth != 32))
148  {
150  "Bad BitWidth parameter: %8.8X", BitWidth));
152  }
153 
155  ByteWidth = ACPI_DIV_8 (BitWidth);
156  LastAddress = Address + ByteWidth - 1;
157 
159  "Address %8.8X%8.8X LastAddress %8.8X%8.8X Length %X",
161  ByteWidth));
162 
163  /* Maximum 16-bit address in I/O space */
164 
165  if (LastAddress > ACPI_UINT16_MAX)
166  {
168  "Illegal I/O port address/length above 64K: %8.8X%8.8X/0x%X",
169  ACPI_FORMAT_UINT64 (Address), ByteWidth));
171  }
172 
173  /* Exit if requested address is not within the protected port table */
174 
176  {
178  }
179 
180  /* Check request against the list of protected I/O ports */
181 
182  for (i = 0; i < ACPI_PORT_INFO_ENTRIES; i++, PortInfo++)
183  {
184  /*
185  * Check if the requested address range will write to a reserved
186  * port. There are four cases to consider:
187  *
188  * 1) Address range is contained completely in the port address range
189  * 2) Address range overlaps port range at the port range start
190  * 3) Address range overlaps port range at the port range end
191  * 4) Address range completely encompasses the port range
192  */
193  if ((Address <= PortInfo->End) && (LastAddress >= PortInfo->Start))
194  {
195  /* Port illegality may depend on the _OSI calls made by the BIOS */
196 
197  if (AcpiGbl_OsiData >= PortInfo->OsiDependency)
198  {
200  "Denied AML access to port 0x%8.8X%8.8X/%X (%s 0x%.4X-0x%.4X)\n",
201  ACPI_FORMAT_UINT64 (Address), ByteWidth, PortInfo->Name,
202  PortInfo->Start, PortInfo->End));
203 
205  }
206  }
207 
208  /* Finished if address range ends before the end of this port */
209 
210  if (LastAddress <= PortInfo->End)
211  {
212  break;
213  }
214  }
215 
217 }
218 
219 
220 /******************************************************************************
221  *
222  * FUNCTION: AcpiHwReadPort
223  *
224  * PARAMETERS: Address Address of I/O port/register to read
225  * Value Where value (data) is returned
226  * Width Number of bits
227  *
228  * RETURN: Status and value read from port
229  *
230  * DESCRIPTION: Read data from an I/O port or register. This is a front-end
231  * to AcpiOsReadPort that performs validation on both the port
232  * address and the length.
233  *
234  *****************************************************************************/
235 
238  ACPI_IO_ADDRESS Address,
239  UINT32 *Value,
240  UINT32 Width)
241 {
243  UINT32 OneByte;
244  UINT32 i;
245 
246 
247  /* Truncate address to 16 bits if requested */
248 
249  if (AcpiGbl_TruncateIoAddresses)
250  {
252  }
253 
254  /* Validate the entire request and perform the I/O */
255 
257  if (ACPI_SUCCESS (Status))
258  {
259  Status = AcpiOsReadPort (Address, Value, Width);
260  return (Status);
261  }
262 
264  {
265  return (Status);
266  }
267 
268  /*
269  * There has been a protection violation within the request. Fall
270  * back to byte granularity port I/O and ignore the failing bytes.
271  * This provides compatibility with other ACPI implementations.
272  */
273  for (i = 0, *Value = 0; i < Width; i += 8)
274  {
275  /* Validate and read one byte */
276 
278  {
279  Status = AcpiOsReadPort (Address, &OneByte, 8);
280  if (ACPI_FAILURE (Status))
281  {
282  return (Status);
283  }
284 
285  *Value |= (OneByte << i);
286  }
287 
288  Address++;
289  }
290 
291  return (AE_OK);
292 }
293 
294 
295 /******************************************************************************
296  *
297  * FUNCTION: AcpiHwWritePort
298  *
299  * PARAMETERS: Address Address of I/O port/register to write
300  * Value Value to write
301  * Width Number of bits
302  *
303  * RETURN: Status
304  *
305  * DESCRIPTION: Write data to an I/O port or register. This is a front-end
306  * to AcpiOsWritePort that performs validation on both the port
307  * address and the length.
308  *
309  *****************************************************************************/
310 
313  ACPI_IO_ADDRESS Address,
314  UINT32 Value,
315  UINT32 Width)
316 {
318  UINT32 i;
319 
320 
321  /* Truncate address to 16 bits if requested */
322 
323  if (AcpiGbl_TruncateIoAddresses)
324  {
326  }
327 
328  /* Validate the entire request and perform the I/O */
329 
331  if (ACPI_SUCCESS (Status))
332  {
333  Status = AcpiOsWritePort (Address, Value, Width);
334  return (Status);
335  }
336 
338  {
339  return (Status);
340  }
341 
342  /*
343  * There has been a protection violation within the request. Fall
344  * back to byte granularity port I/O and ignore the failing bytes.
345  * This provides compatibility with other ACPI implementations.
346  */
347  for (i = 0; i < Width; i += 8)
348  {
349  /* Validate and write one byte */
350 
352  {
353  Status = AcpiOsWritePort (Address, (Value >> i) & 0xFF, 8);
354  if (ACPI_FAILURE (Status))
355  {
356  return (Status);
357  }
358  }
359 
360  Address++;
361  }
362 
363  return (AE_OK);
364 }
_In_opt_ ULONG _Out_ PULONG Value
Definition: rtlfuncs.h:2343
#define ACPI_SUCCESS(a)
Definition: acexcep.h:94
#define AE_BAD_PARAMETER
Definition: acexcep.h:151
#define ACPI_DB_IO
Definition: acoutput.h:177
#define ACPI_DB_VALUES
Definition: acoutput.h:173
CPPORT PortInfo
Definition: kdinit.c:20
UINT32 ACPI_STATUS
Definition: actypes.h:460
#define AE_LIMIT
Definition: acexcep.h:124
ACPI_STATUS AcpiHwReadPort(ACPI_IO_ADDRESS Address, UINT32 *Value, UINT32 Width)
Definition: hwvalid.c:237
#define ACPI_FAILURE(a)
Definition: acexcep.h:95
GLsizei GLenum const GLvoid GLsizei GLenum GLbyte GLbyte GLbyte GLdouble GLdouble GLdouble GLfloat GLfloat GLfloat GLint GLint GLint GLshort GLshort GLshort GLubyte GLubyte GLubyte GLuint GLuint GLuint GLushort GLushort GLushort GLbyte GLbyte GLbyte GLbyte GLdouble GLdouble GLdouble GLdouble GLfloat GLfloat GLfloat GLfloat GLint GLint GLint GLint GLshort GLshort GLshort GLshort GLubyte GLubyte GLubyte GLubyte GLuint GLuint GLuint GLuint GLushort GLushort GLushort GLushort GLboolean const GLdouble const GLfloat const GLint const GLshort const GLbyte const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLdouble const GLfloat const GLfloat const GLint const GLint const GLshort const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort GLenum GLenum GLenum GLfloat GLenum GLint GLenum GLenum GLenum GLfloat GLenum GLenum GLint GLenum GLfloat GLenum GLint GLint GLushort GLenum GLenum GLfloat GLenum GLenum GLint GLfloat const GLubyte GLenum GLenum GLenum const GLfloat GLenum GLenum const GLint GLenum GLint GLint GLsizei GLsizei GLint GLenum GLenum const GLvoid GLenum GLenum const GLfloat GLenum GLenum const GLint GLenum GLenum const GLdouble GLenum GLenum const GLfloat GLenum GLenum const GLint GLsizei GLuint GLfloat GLuint GLbitfield GLfloat GLint GLuint GLboolean GLenum GLfloat GLenum GLbitfield GLenum GLfloat GLfloat GLint GLint const GLfloat GLenum GLfloat GLfloat GLint GLint GLfloat GLfloat GLint GLint const GLfloat GLint GLfloat GLfloat GLint GLfloat GLfloat GLint GLfloat GLfloat const GLdouble const GLfloat const GLdouble const GLfloat GLint i
Definition: glfuncs.h:248
#define ACPI_UINT16_MAX
Definition: actypes.h:65
unsigned int UINT32
#define ACPI_MODULE_NAME(Name)
Definition: acoutput.h:216
ACPI_STATUS AcpiHwWritePort(ACPI_IO_ADDRESS Address, UINT32 Value, UINT32 Width)
Definition: hwvalid.c:312
#define AE_INFO
Definition: acoutput.h:230
static WCHAR Address[46]
Definition: ping.c:68
#define ACPI_PORT_INFO_ENTRIES
Definition: hwvalid.c:110
ACPI_STATUS AcpiOsReadPort(ACPI_IO_ADDRESS Address, UINT32 *Value, UINT32 Width)
Definition: osl.c:701
#define ACPI_DEBUG_PRINT(pl)
Definition: acoutput.h:475
static ACPI_STATUS AcpiHwValidateIoRequest(ACPI_IO_ADDRESS Address, UINT32 BitWidth)
Definition: hwvalid.c:130
static const ACPI_PORT_INFO AcpiProtectedPorts[]
Definition: hwvalid.c:89
#define ACPI_DIV_8(a)
Definition: acmacros.h:214
Status
Definition: gdiplustypes.h:24
#define ACPI_ALWAYS_ILLEGAL
Definition: aclocal.h:1259
#define ACPI_OSI_WIN_XP
Definition: actypes.h:1397
#define return_ACPI_STATUS(s)
Definition: acoutput.h:496
#define ACPI_FUNCTION_TRACE(a)
Definition: acoutput.h:480
#define ACPI_FORMAT_UINT64(i)
Definition: acmacros.h:71
ACPI_STATUS AcpiOsWritePort(ACPI_IO_ADDRESS Address, UINT32 Value, UINT32 Width)
Definition: osl.c:731
#define ACPI_ERROR(plist)
Definition: acoutput.h:240
#define const
Definition: zconf.h:230
#define AE_OK
Definition: acexcep.h:97
#define AE_AML_ILLEGAL_ADDRESS
Definition: acexcep.h:211