1 /******************************************************************************
3 * Module Name: tbxfroot - Find the root ACPI table (RSDT)
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
117 #define __TBXFROOT_C__
120 #include "actables.h"
123 #define _COMPONENT ACPI_TABLES
124 ACPI_MODULE_NAME ("tbxfroot")
127 /*******************************************************************************
129 * FUNCTION: AcpiTbFindTable
131 * PARAMETERS: Signature - String with ACPI table signature
132 * OemId - String with the table OEM ID
133 * OemTableId - String with the OEM Table ID.
137 * DESCRIPTION: Find an ACPI table (in the RSDT/XSDT) that matches the
138 * Signature, OEM ID and OEM Table ID.
140 ******************************************************************************/
147 ACPI_TABLE_HEADER
**TablePtr
)
150 ACPI_TABLE_HEADER
*Table
;
153 ACPI_FUNCTION_TRACE ("TbFindTable");
156 /* Validate string lengths */
158 if ((ACPI_STRLEN (Signature
) > ACPI_NAME_SIZE
) ||
159 (ACPI_STRLEN (OemId
) > sizeof (Table
->OemId
)) ||
160 (ACPI_STRLEN (OemTableId
) > sizeof (Table
->OemTableId
)))
162 return_ACPI_STATUS (AE_AML_STRING_LIMIT
);
165 if (!ACPI_STRNCMP (Signature
, DSDT_SIG
, ACPI_NAME_SIZE
))
168 * The DSDT pointer is contained in the FADT, not the RSDT.
169 * This code should suffice, because the only code that would perform
170 * a "find" on the DSDT is the DataTableRegion() AML opcode -- in
171 * which case, the DSDT is guaranteed to be already loaded.
172 * If this becomes insufficient, the FADT will have to be found first.
176 return_ACPI_STATUS (AE_NO_ACPI_TABLES
);
179 Table
= AcpiGbl_DSDT
;
185 Status
= AcpiGetFirmwareTable (Signature
, 1,
186 ACPI_LOGICAL_ADDRESSING
, &Table
);
187 if (ACPI_FAILURE (Status
))
189 return_ACPI_STATUS (Status
);
193 /* Check OemId and OemTableId */
195 if ((OemId
[0] && ACPI_STRNCMP (
196 OemId
, Table
->OemId
, sizeof (Table
->OemId
))) ||
197 (OemTableId
[0] && ACPI_STRNCMP (
198 OemTableId
, Table
->OemTableId
, sizeof (Table
->OemTableId
))))
200 return_ACPI_STATUS (AE_AML_NAME_NOT_FOUND
);
203 ACPI_DEBUG_PRINT ((ACPI_DB_TABLES
, "Found table [%4.4s]\n", Table
->Signature
));
205 return_ACPI_STATUS (AE_OK
);
209 /*******************************************************************************
211 * FUNCTION: AcpiGetFirmwareTable
213 * PARAMETERS: Signature - Any ACPI table signature
214 * Instance - the non zero instance of the table, allows
215 * support for multiple tables of the same type
216 * Flags - Physical/Virtual support
217 * TablePointer - Where a buffer containing the table is
222 * DESCRIPTION: This function is called to get an ACPI table. A buffer is
223 * allocated for the table and returned in TablePointer.
224 * This table will be a complete table including the header.
226 ******************************************************************************/
229 AcpiGetFirmwareTable (
230 ACPI_STRING Signature
,
233 ACPI_TABLE_HEADER
**TablePointer
)
236 ACPI_POINTER Address
;
237 ACPI_TABLE_HEADER
*Header
= NULL
;
238 ACPI_TABLE_DESC
*TableInfo
= NULL
;
239 ACPI_TABLE_DESC
*RsdtInfo
;
245 ACPI_FUNCTION_TRACE ("AcpiGetFirmwareTable");
249 * Ensure that at least the table manager is initialized. We don't
250 * require that the entire ACPI subsystem is up for this interface.
251 * If we have a buffer, we must have a length too
253 if ((Instance
== 0) ||
257 return_ACPI_STATUS (AE_BAD_PARAMETER
);
260 /* Ensure that we have a RSDP */
266 Status
= AcpiOsGetRootPointer (Flags
, &Address
);
267 if (ACPI_FAILURE (Status
))
269 ACPI_DEBUG_PRINT ((ACPI_DB_INFO
, "RSDP not found\n"));
270 return_ACPI_STATUS (AE_NO_ACPI_TABLES
);
273 /* Map and validate the RSDP */
275 if ((Flags
& ACPI_MEMORY_MODE
) == ACPI_LOGICAL_ADDRESSING
)
277 Status
= AcpiOsMapMemory (Address
.Pointer
.Physical
, sizeof (RSDP_DESCRIPTOR
),
278 (void *) &AcpiGbl_RSDP
);
279 if (ACPI_FAILURE (Status
))
281 return_ACPI_STATUS (Status
);
286 AcpiGbl_RSDP
= Address
.Pointer
.Logical
;
289 /* The signature and checksum must both be correct */
291 if (ACPI_STRNCMP ((char *) AcpiGbl_RSDP
, RSDP_SIG
, sizeof (RSDP_SIG
)-1) != 0)
293 /* Nope, BAD Signature */
295 return_ACPI_STATUS (AE_BAD_SIGNATURE
);
298 if (AcpiTbChecksum (AcpiGbl_RSDP
, ACPI_RSDP_CHECKSUM_LENGTH
) != 0)
300 /* Nope, BAD Checksum */
302 return_ACPI_STATUS (AE_BAD_CHECKSUM
);
306 /* Get the RSDT address via the RSDP */
308 AcpiTbGetRsdtAddress (&Address
);
309 ACPI_DEBUG_PRINT ((ACPI_DB_INFO
,
310 "RSDP located at %p, RSDT physical=%8.8X%8.8X \n",
312 ACPI_FORMAT_UINT64 (Address
.Pointer
.Value
)));
314 /* Insert ProcessorMode flags */
316 Address
.PointerType
|= Flags
;
318 /* Get and validate the RSDT */
320 RsdtInfo
= ACPI_MEM_CALLOCATE (sizeof (ACPI_TABLE_DESC
));
323 return_ACPI_STATUS (AE_NO_MEMORY
);
326 Status
= AcpiTbGetTable (&Address
, RsdtInfo
);
327 if (ACPI_FAILURE (Status
))
332 Status
= AcpiTbValidateRsdt (RsdtInfo
->Pointer
);
333 if (ACPI_FAILURE (Status
))
338 /* Allocate a scratch table header and table descriptor */
340 Header
= ACPI_MEM_ALLOCATE (sizeof (ACPI_TABLE_HEADER
));
343 Status
= AE_NO_MEMORY
;
347 TableInfo
= ACPI_MEM_ALLOCATE (sizeof (ACPI_TABLE_DESC
));
350 Status
= AE_NO_MEMORY
;
354 /* Get the number of table pointers within the RSDT */
356 TableCount
= AcpiTbGetTableCount (AcpiGbl_RSDP
, RsdtInfo
->Pointer
);
357 Address
.PointerType
= AcpiGbl_TableFlags
| Flags
;
360 * Search the RSDT/XSDT for the correct instance of the
363 for (i
= 0, j
= 0; i
< TableCount
; i
++)
365 /* Get the next table pointer, handle RSDT vs. XSDT */
367 if (AcpiGbl_RSDP
->Revision
< 2)
369 Address
.Pointer
.Value
= (ACPI_CAST_PTR (
370 RSDT_DESCRIPTOR
, RsdtInfo
->Pointer
))->TableOffsetEntry
[i
];
374 Address
.Pointer
.Value
= ACPI_GET_ADDRESS ((ACPI_CAST_PTR (
375 XSDT_DESCRIPTOR
, RsdtInfo
->Pointer
))->TableOffsetEntry
[i
]);
378 /* Get the table header */
380 Status
= AcpiTbGetTableHeader (&Address
, Header
);
381 if (ACPI_FAILURE (Status
))
386 /* Compare table signatures and table instance */
388 if (!ACPI_STRNCMP (Header
->Signature
, Signature
, ACPI_NAME_SIZE
))
390 /* An instance of the table was found */
395 /* Found the correct instance, get the entire table */
397 Status
= AcpiTbGetTableBody (&Address
, Header
, TableInfo
);
398 if (ACPI_FAILURE (Status
))
403 *TablePointer
= TableInfo
->Pointer
;
409 /* Did not find the table */
411 Status
= AE_NOT_EXIST
;
415 AcpiOsUnmapMemory (RsdtInfo
->Pointer
, (ACPI_SIZE
) RsdtInfo
->Pointer
->Length
);
416 ACPI_MEM_FREE (RsdtInfo
);
420 ACPI_MEM_FREE (Header
);
424 ACPI_MEM_FREE (TableInfo
);
426 return_ACPI_STATUS (Status
);
430 /* TBD: Move to a new file */
432 #if ACPI_MACHINE_WIDTH != 16
434 /*******************************************************************************
436 * FUNCTION: AcpiFindRootPointer
438 * PARAMETERS: **RsdpAddress - Where to place the RSDP address
439 * Flags - Logical/Physical addressing
441 * RETURN: Status, Physical address of the RSDP
443 * DESCRIPTION: Find the RSDP
445 ******************************************************************************/
448 AcpiFindRootPointer (
450 ACPI_POINTER
*RsdpAddress
)
452 ACPI_TABLE_DESC TableInfo
;
456 ACPI_FUNCTION_TRACE ("AcpiFindRootPointer");
461 Status
= AcpiTbFindRsdp (&TableInfo
, Flags
);
462 if (ACPI_FAILURE (Status
))
464 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
465 "RSDP structure not found, %s Flags=%X\n",
466 AcpiFormatException (Status
), Flags
));
467 return_ACPI_STATUS (AE_NO_ACPI_TABLES
);
470 RsdpAddress
->PointerType
= ACPI_PHYSICAL_POINTER
;
471 RsdpAddress
->Pointer
.Physical
= TableInfo
.PhysicalAddress
;
472 return_ACPI_STATUS (AE_OK
);
476 /*******************************************************************************
478 * FUNCTION: AcpiTbScanMemoryForRsdp
480 * PARAMETERS: StartAddress - Starting pointer for search
481 * Length - Maximum length to search
483 * RETURN: Pointer to the RSDP if found, otherwise NULL.
485 * DESCRIPTION: Search a block of memory for the RSDP signature
487 ******************************************************************************/
490 AcpiTbScanMemoryForRsdp (
499 ACPI_FUNCTION_TRACE ("TbScanMemoryForRsdp");
502 EndAddress
= StartAddress
+ Length
;
504 /* Search from given start address for the requested length */
506 for (MemRover
= StartAddress
; MemRover
< EndAddress
;
507 MemRover
+= ACPI_RSDP_SCAN_STEP
)
509 /* The signature and checksum must both be correct */
511 if (ACPI_STRNCMP ((char *) MemRover
, RSDP_SIG
, sizeof (RSDP_SIG
)-1) != 0)
513 /* No signature match, keep looking */
518 /* Signature matches, check the appropriate checksum */
520 if ((ACPI_CAST_PTR (RSDP_DESCRIPTOR
, MemRover
))->Revision
< 2)
522 /* ACPI version 1.0 */
524 Checksum
= AcpiTbChecksum (MemRover
, ACPI_RSDP_CHECKSUM_LENGTH
);
528 /* Post ACPI 1.0, use ExtendedChecksum */
530 Checksum
= AcpiTbChecksum (MemRover
, ACPI_RSDP_XCHECKSUM_LENGTH
);
535 /* Checksum valid, we have found a valid RSDP */
537 ACPI_DEBUG_PRINT ((ACPI_DB_INFO
,
538 "RSDP located at physical address %p\n", MemRover
));
539 return_PTR (MemRover
);
542 ACPI_DEBUG_PRINT ((ACPI_DB_INFO
,
543 "Found an RSDP at physical address %p, but it has a bad checksum\n",
547 /* Searched entire block, no RSDP was found */
549 ACPI_DEBUG_PRINT ((ACPI_DB_INFO
,
550 "Searched entire block, no valid RSDP was found.\n"));
555 /*******************************************************************************
557 * FUNCTION: AcpiTbFindRsdp
559 * PARAMETERS: *TableInfo - Where the table info is returned
560 * Flags - Current memory mode (logical vs.
561 * physical addressing)
563 * RETURN: Status, RSDP physical address
565 * DESCRIPTION: Search lower 1Mbyte of memory for the root system descriptor
566 * pointer structure. If it is found, set *RSDP to point to it.
568 * NOTE1: The RSDP must be either in the first 1K of the Extended
569 * BIOS Data Area or between E0000 and FFFFF (From ACPI Spec.)
570 * Only a 32-bit physical address is necessary.
572 * NOTE2: This function is always available, regardless of the
573 * initialization state of the rest of ACPI.
575 ******************************************************************************/
579 ACPI_TABLE_DESC
*TableInfo
,
584 UINT32 PhysicalAddress
;
588 ACPI_FUNCTION_TRACE ("TbFindRsdp");
592 * Scan supports either 1) Logical addressing or 2) Physical addressing
594 if ((Flags
& ACPI_MEMORY_MODE
) == ACPI_LOGICAL_ADDRESSING
)
597 * 1a) Get the location of the EBDA
599 Status
= AcpiOsMapMemory ((ACPI_PHYSICAL_ADDRESS
) ACPI_EBDA_PTR_LOCATION
,
600 ACPI_EBDA_PTR_LENGTH
,
602 if (ACPI_FAILURE (Status
))
604 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
605 "Could not map memory at %8.8X for length %X\n",
606 ACPI_EBDA_PTR_LOCATION
, ACPI_EBDA_PTR_LENGTH
));
607 return_ACPI_STATUS (Status
);
610 ACPI_MOVE_16_TO_32 (&PhysicalAddress
, TablePtr
);
611 PhysicalAddress
<<= 4; /* Convert segment to physical address */
612 AcpiOsUnmapMemory (TablePtr
, ACPI_EBDA_PTR_LENGTH
);
616 if (PhysicalAddress
> 0x400)
619 * 1b) Search EBDA paragraphs (EBDA is required to be a minimum of 1K length)
621 Status
= AcpiOsMapMemory ((ACPI_PHYSICAL_ADDRESS
) PhysicalAddress
,
622 ACPI_EBDA_WINDOW_SIZE
,
624 if (ACPI_FAILURE (Status
))
626 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
627 "Could not map memory at %8.8X for length %X\n",
628 PhysicalAddress
, ACPI_EBDA_WINDOW_SIZE
));
629 return_ACPI_STATUS (Status
);
632 MemRover
= AcpiTbScanMemoryForRsdp (TablePtr
, ACPI_EBDA_WINDOW_SIZE
);
633 AcpiOsUnmapMemory (TablePtr
, ACPI_EBDA_WINDOW_SIZE
);
637 /* Found it, return the physical address */
639 PhysicalAddress
+= ACPI_PTR_DIFF (MemRover
, TablePtr
);
641 TableInfo
->PhysicalAddress
= (ACPI_PHYSICAL_ADDRESS
) PhysicalAddress
;
642 return_ACPI_STATUS (AE_OK
);
647 * 2) Search upper memory: 16-byte boundaries in E0000h-FFFFFh
649 Status
= AcpiOsMapMemory ((ACPI_PHYSICAL_ADDRESS
) ACPI_HI_RSDP_WINDOW_BASE
,
650 ACPI_HI_RSDP_WINDOW_SIZE
,
652 if (ACPI_FAILURE (Status
))
654 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
655 "Could not map memory at %8.8X for length %X\n",
656 ACPI_HI_RSDP_WINDOW_BASE
, ACPI_HI_RSDP_WINDOW_SIZE
));
657 return_ACPI_STATUS (Status
);
660 MemRover
= AcpiTbScanMemoryForRsdp (TablePtr
, ACPI_HI_RSDP_WINDOW_SIZE
);
661 AcpiOsUnmapMemory (TablePtr
, ACPI_HI_RSDP_WINDOW_SIZE
);
665 /* Found it, return the physical address */
667 PhysicalAddress
= ACPI_HI_RSDP_WINDOW_BASE
+ ACPI_PTR_DIFF (MemRover
, TablePtr
);
669 TableInfo
->PhysicalAddress
= (ACPI_PHYSICAL_ADDRESS
) PhysicalAddress
;
670 return_ACPI_STATUS (AE_OK
);
675 * Physical addressing
680 * 1a) Get the location of the EBDA
682 ACPI_MOVE_16_TO_32 (&PhysicalAddress
, ACPI_EBDA_PTR_LOCATION
);
683 PhysicalAddress
<<= 4; /* Convert segment to physical address */
687 if (PhysicalAddress
> 0x400)
690 * 1b) Search EBDA paragraphs (EBDA is required to be a minimum of 1K length)
692 MemRover
= AcpiTbScanMemoryForRsdp (ACPI_PHYSADDR_TO_PTR (PhysicalAddress
),
693 ACPI_EBDA_WINDOW_SIZE
);
696 /* Found it, return the physical address */
698 TableInfo
->PhysicalAddress
= ACPI_TO_INTEGER (MemRover
);
699 return_ACPI_STATUS (AE_OK
);
704 * 2) Search upper memory: 16-byte boundaries in E0000h-FFFFFh
706 MemRover
= AcpiTbScanMemoryForRsdp (ACPI_PHYSADDR_TO_PTR (ACPI_HI_RSDP_WINDOW_BASE
),
707 ACPI_HI_RSDP_WINDOW_SIZE
);
710 /* Found it, return the physical address */
712 TableInfo
->PhysicalAddress
= ACPI_TO_INTEGER (MemRover
);
713 return_ACPI_STATUS (AE_OK
);
717 /* RSDP signature was not found */
719 return_ACPI_STATUS (AE_NOT_FOUND
);