1 /******************************************************************************
3 * Module Name: oswintbl - Windows OSL for obtaining ACPI tables
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
153 #include "accommon.h"
158 #pragma warning(disable:4115) /* warning C4115: (caused by rpcasync.h) */
162 #include <windowsx.h>
165 #define _COMPONENT ACPI_OS_SERVICES
166 ACPI_MODULE_NAME ("oswintbl")
168 /* Local prototypes */
171 WindowsFormatException (
176 #define LOCAL_BUFFER_SIZE 64
178 static char KeyBuffer[LOCAL_BUFFER_SIZE];
179 static char ErrorBuffer[LOCAL_BUFFER_SIZE];
182 * List of table signatures reported by EnumSystemFirmwareTables ()
184 UINT32 *Gbl_AvailableTableSignatures;
185 UINT32 Gbl_TableCount = 0;
186 UINT32 Gbl_SsdtInstance = 0;
188 BOOLEAN Gbl_TableListInitialized = FALSE;
195 /******************************************************************************
197 * FUNCTION: WindowsFormatException
199 * PARAMETERS: WinStatus - Status from a Windows system call
201 * RETURN: Formatted (ascii) exception code. Front-end to Windows
202 * FormatMessage interface.
204 * DESCRIPTION: Decode a windows exception
206 *****************************************************************************/
209 WindowsFormatException (
214 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM, NULL, WinStatus, 0,
215 ErrorBuffer, LOCAL_BUFFER_SIZE, NULL);
217 return (ErrorBuffer);
221 /******************************************************************************
223 * FUNCTION: AcpiOsGetTableByAddress
225 * PARAMETERS: Address - Physical address of the ACPI table
226 * Table - Where a pointer to the table is returned
228 * RETURN: Status; Table buffer is returned if AE_OK.
229 * AE_NOT_FOUND: A valid table was not found at the address
231 * DESCRIPTION: Get an ACPI table via a physical memory address.
233 * NOTE: Cannot be implemented without a Windows device driver.
235 *****************************************************************************/
238 AcpiOsGetTableByAddress (
239 ACPI_PHYSICAL_ADDRESS Address,
240 ACPI_TABLE_HEADER **Table)
243 fprintf (stderr, "Get table by address is not supported on Windows\n");
248 /******************************************************************************
250 * FUNCTION: AcpiOsGetTableByIndex
252 * PARAMETERS: Index - Which table to get
253 * Table - Where a pointer to the table is returned
254 * Instance - Where a pointer to the table instance no. is
256 * Address - Where the table physical address is returned
258 * RETURN: Status; Table buffer and physical address returned if AE_OK.
259 * AE_LIMIT: Index is beyond valid limit
261 * DESCRIPTION: Get an ACPI table via an index value (0 through n). Returns
262 * AE_LIMIT when an invalid index is reached. Index is not
263 * necessarily an index into the RSDT/XSDT.
264 * SSDT tables are obtained from the Windows registry. All other
265 * tables are obtained through GetSystemFirmwareTable ().
267 * NOTE: Cannot get the physical address from the windows registry;
268 * zero is returned instead.
270 *****************************************************************************/
273 AcpiOsGetTableByIndex (
275 ACPI_TABLE_HEADER **Table,
277 ACPI_PHYSICAL_ADDRESS *Address)
281 UINT32 CurrentInstance;
284 /* Enumerate all ACPI table signatures on first invocation of this function */
286 Status = OslTableInitialize ();
287 if (ACPI_FAILURE (Status))
294 if (Index < Gbl_TableCount)
296 Signature = malloc (ACPI_NAMESEG_SIZE + 1);
299 return (AE_NO_MEMORY);
302 Signature = memmove (Signature, &Gbl_AvailableTableSignatures[Index], ACPI_NAMESEG_SIZE);
309 if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_SSDT))
311 CurrentInstance = Gbl_SsdtInstance;
319 Status = AcpiOsGetTableByName (Signature, CurrentInstance, Table, Address);
320 if (ACPI_SUCCESS (Status))
322 *Instance = CurrentInstance;
324 else if (Status == AE_NOT_FOUND &&
325 ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_SSDT))
327 /* Treat SSDTs that are not found as invalid index. */
335 /******************************************************************************
337 * FUNCTION: OslTableInitialize
343 * DESCRIPTION: Initialize ACPI table data. Enumerate all ACPI table signatures
344 * and save them to a global list.
346 *****************************************************************************/
354 if (Gbl_TableListInitialized)
360 * ACPI table signatures are always 4 characters. Therefore, the data size
361 * buffer should be a multiple of 4
363 DataSize = EnumSystemFirmwareTables ('ACPI', NULL, 0);
364 if (DataSize % ACPI_NAMESEG_SIZE)
370 * EnumSystemFirmwareTables () does not report the DSDT or XSDT. Work around this
371 * by adding these entries manually.
373 Gbl_TableCount = 2 + DataSize / ACPI_NAMESEG_SIZE;
374 Gbl_AvailableTableSignatures = malloc (Gbl_TableCount * ACPI_NAMESEG_SIZE);
375 if (!Gbl_AvailableTableSignatures)
377 return (AE_NO_MEMORY);
380 ResultSize = EnumSystemFirmwareTables ('ACPI', Gbl_AvailableTableSignatures, DataSize);
381 if (ResultSize > DataSize)
386 /* Insert the DSDT and XSDT tables signatures */
388 Gbl_AvailableTableSignatures [Gbl_TableCount - 1] = 'TDSD';
389 Gbl_AvailableTableSignatures [Gbl_TableCount - 2] = 'TDSX';
391 Gbl_TableListInitialized = TRUE;
396 /******************************************************************************
398 * FUNCTION: WindowsGetTableFromRegistry
400 * PARAMETERS: Signature - ACPI Signature for desired table. Must be
401 * a null terminated 4-character string.
402 * Instance - For SSDTs (0...n). Use 0 otherwise.
403 * Table - Where a pointer to the table is returned
404 * Address - Where the table physical address is returned
406 * RETURN: Status; Table buffer and physical address returned if AE_OK.
407 * AE_LIMIT: Instance is beyond valid limit
408 * AE_NOT_FOUND: A table with the signature was not found
410 * DESCRIPTION: Get an ACPI table via a table signature (4 ASCII characters).
411 * Returns AE_LIMIT when an invalid instance is reached.
412 * Table is obtained from the Windows registry.
414 * NOTE: Assumes the input signature is uppercase.
415 * Cannot get the physical address from the windows registry;
416 * zero is returned instead.
418 *****************************************************************************/
421 WindowsGetTableFromRegistry (
424 ACPI_TABLE_HEADER **Table,
425 ACPI_PHYSICAL_ADDRESS *Address)
434 ACPI_TABLE_HEADER *ReturnTable;
435 ACPI_STATUS Status = AE_OK;
438 /* Get a handle to the table key */
442 strcpy(KeyBuffer, "HARDWARE\\ACPI\\");
443 if (AcpiUtSafeStrcat(KeyBuffer, sizeof(KeyBuffer), Signature))
445 return (AE_BUFFER_OVERFLOW);
449 * Windows stores SSDT at SSDT, SSD1, ..., SSD9, SSDA, ..., SSDS, SSDT,
450 * SSDU, ..., SSDY. If the first (0th) and the 29th tables have the same
451 * OEM ID, Table ID and Revision, then the 29th entry will overwrite the
452 * first entry... Let's hope that we do not have that many entries.
454 if (Instance > 0 && ACPI_COMPARE_NAMESEG(Signature, ACPI_SIG_SSDT))
458 KeyBuffer[strlen(KeyBuffer) - 1] = '0' + (char)Instance;
460 else if (Instance < 29)
462 KeyBuffer[strlen(KeyBuffer) - 1] = 'A' + (char)(Instance - 10);
470 WinStatus = RegOpenKeyEx(HKEY_LOCAL_MACHINE, KeyBuffer,
471 0L, KEY_READ, &Handle);
473 if (WinStatus != ERROR_SUCCESS)
476 * Somewhere along the way, MS changed the registry entry for
478 * HARDWARE/ACPI/FACP to
479 * HARDWARE/ACPI/FADT.
481 * This code allows for both.
483 if (ACPI_COMPARE_NAMESEG(Signature, "FACP"))
487 else if (ACPI_COMPARE_NAMESEG(Signature, "XSDT"))
491 else if (ACPI_COMPARE_NAMESEG(Signature, ACPI_SIG_SSDT))
494 * SSDT may not be present on older Windows versions, but it is
495 * also possible that the index is not found.
497 return (AE_NOT_FOUND);
502 "Could not find %s in registry at %s: %s (WinStatus=0x%X)\n",
503 Signature, KeyBuffer, WindowsFormatException(WinStatus), WinStatus);
504 return (AE_NOT_FOUND);
513 /* Actual data for the table is down a couple levels */
517 WinStatus = RegEnumKey(Handle, i, KeyBuffer, sizeof(KeyBuffer));
519 if (WinStatus == ERROR_NO_MORE_ITEMS)
524 WinStatus = RegOpenKey(Handle, KeyBuffer, &SubKey);
525 if (WinStatus != ERROR_SUCCESS)
527 fprintf(stderr, "Could not open %s entry: %s\n",
528 Signature, WindowsFormatException(WinStatus));
538 /* Find the (binary) table entry */
542 NameSize = sizeof(KeyBuffer);
543 WinStatus = RegEnumValue(Handle, i, KeyBuffer, &NameSize, NULL,
545 if (WinStatus != ERROR_SUCCESS)
547 fprintf(stderr, "Could not get %s registry entry: %s\n",
548 Signature, WindowsFormatException(WinStatus));
553 if (Type == REG_BINARY)
559 /* Get the size of the table */
561 WinStatus = RegQueryValueEx(Handle, KeyBuffer, NULL, NULL,
563 if (WinStatus != ERROR_SUCCESS)
565 fprintf(stderr, "Could not read the %s table size: %s\n",
566 Signature, WindowsFormatException(WinStatus));
571 /* Allocate a new buffer for the table */
573 ReturnTable = malloc(DataSize);
576 Status = AE_NO_MEMORY;
580 /* Get the actual table from the registry */
582 WinStatus = RegQueryValueEx(Handle, KeyBuffer, NULL, NULL,
583 (UCHAR *)ReturnTable, &DataSize);
585 if (WinStatus != ERROR_SUCCESS)
587 fprintf(stderr, "Could not read %s data: %s\n",
588 Signature, WindowsFormatException(WinStatus));
594 *Table = ReturnTable;
603 /******************************************************************************
605 * FUNCTION: AcpiOsGetTableByName
607 * PARAMETERS: Signature - ACPI Signature for desired table. Must be
608 * a null terminated 4-character string.
609 * Instance - For SSDTs (0...n). Use 0 otherwise.
610 * Table - Where a pointer to the table is returned
611 * Address - Where the table physical address is returned
613 * RETURN: Status; Table buffer and physical address returned if AE_OK.
614 * AE_LIMIT: Instance is beyond valid limit
615 * AE_NOT_FOUND: A table with the signature was not found
617 * DESCRIPTION: Get an ACPI table via a table signature (4 ASCII characters).
618 * Returns AE_LIMIT when an invalid instance is reached.
619 * Table is obtained from the Windows registry.
621 * NOTE: Assumes the input signature is uppercase.
622 * Cannot get the physical address from the windows registry;
623 * zero is returned instead.
625 *****************************************************************************/
628 AcpiOsGetTableByName(
631 ACPI_TABLE_HEADER **Table,
632 ACPI_PHYSICAL_ADDRESS *Address)
635 ACPI_STATUS Status = AE_OK;
637 ACPI_TABLE_HEADER *ReturnTable;
638 UINT32 UIntSignature = 0;
641 /* Multiple instances are only supported for SSDT tables. */
643 if (Instance > 0 && !ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_SSDT))
648 if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_SSDT))
650 Status = WindowsGetTableFromRegistry ("SSDT", Instance, Table, Address);
654 /* GetSystemFirmwareTable requires the table signature to be UINT32 */
656 UIntSignature = *ACPI_CAST_PTR (UINT32, Signature);
657 DataSize = GetSystemFirmwareTable('ACPI', UIntSignature, NULL, 0);
660 fprintf(stderr, "The table signature %s does not exist.", Signature);
664 ReturnTable = malloc(DataSize);
667 return (AE_NO_MEMORY);
670 Result = GetSystemFirmwareTable('ACPI', UIntSignature, ReturnTable, DataSize);
671 if (Result > (LONG) DataSize)
675 fprintf (stderr, "Could not read %s data\n", Signature);
680 *Table = ReturnTable;
685 /* These are here for acpidump only, so we don't need to link oswinxf */
688 /******************************************************************************
690 * FUNCTION: AcpiOsMapMemory
692 * PARAMETERS: Where - Physical address of memory to be mapped
693 * Length - How much memory to map
695 * RETURN: Pointer to mapped memory. Null on error.
697 * DESCRIPTION: Map physical memory into caller's address space
699 *****************************************************************************/
703 ACPI_PHYSICAL_ADDRESS Where,
707 return (ACPI_TO_POINTER ((ACPI_SIZE) Where));
711 /******************************************************************************
713 * FUNCTION: AcpiOsUnmapMemory
715 * PARAMETERS: Where - Logical address of memory to be unmapped
716 * Length - How much memory to unmap
720 * DESCRIPTION: Delete a previously created mapping. Where and Length must
721 * correspond to a previous mapping exactly.
723 *****************************************************************************/