1 /******************************************************************************
3 * Module Name: tbxfroot - Find the root ACPI table (RSDT)
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2004, 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);
167 Status = AcpiGetFirmwareTable (Signature, 1,
168 ACPI_LOGICAL_ADDRESSING, &Table);
169 if (ACPI_FAILURE (Status))
171 return_ACPI_STATUS (Status);
174 /* Check OemId and OemTableId */
176 if ((OemId[0] && ACPI_STRCMP (OemId, Table->OemId)) ||
177 (OemTableId[0] && ACPI_STRCMP (OemTableId, Table->OemTableId)))
179 return_ACPI_STATUS (AE_AML_NAME_NOT_FOUND);
183 return_ACPI_STATUS (AE_OK);
187 /*******************************************************************************
189 * FUNCTION: AcpiGetFirmwareTable
191 * PARAMETERS: Signature - Any ACPI table signature
192 * Instance - the non zero instance of the table, allows
193 * support for multiple tables of the same type
194 * Flags - Physical/Virtual support
195 * RetBuffer - pointer to a structure containing a buffer to
200 * DESCRIPTION: This function is called to get an ACPI table. The caller
201 * supplies an OutBuffer large enough to contain the entire ACPI
202 * table. Upon completion
203 * the OutBuffer->Length field will indicate the number of bytes
204 * copied into the OutBuffer->BufPtr buffer. This table will be
205 * a complete table including the header.
207 ******************************************************************************/
210 AcpiGetFirmwareTable (
211 ACPI_STRING Signature,
214 ACPI_TABLE_HEADER **TablePointer)
216 ACPI_POINTER RsdpAddress;
217 ACPI_POINTER Address;
219 ACPI_TABLE_HEADER Header;
220 ACPI_TABLE_DESC TableInfo;
221 ACPI_TABLE_DESC RsdtInfo;
227 ACPI_FUNCTION_TRACE ("AcpiGetFirmwareTable");
231 * Ensure that at least the table manager is initialized. We don't
232 * require that the entire ACPI subsystem is up for this interface
236 * If we have a buffer, we must have a length too
238 if ((Instance == 0) ||
242 return_ACPI_STATUS (AE_BAD_PARAMETER);
245 RsdtInfo.Pointer = NULL;
251 Status = AcpiOsGetRootPointer (Flags, &RsdpAddress);
252 if (ACPI_FAILURE (Status))
254 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "RSDP not found\n"));
255 return_ACPI_STATUS (AE_NO_ACPI_TABLES);
258 /* Map and validate the RSDP */
260 if ((Flags & ACPI_MEMORY_MODE) == ACPI_LOGICAL_ADDRESSING)
262 Status = AcpiOsMapMemory (RsdpAddress.Pointer.Physical, sizeof (RSDP_DESCRIPTOR),
263 (void *) &AcpiGbl_RSDP);
264 if (ACPI_FAILURE (Status))
266 return_ACPI_STATUS (Status);
271 AcpiGbl_RSDP = RsdpAddress.Pointer.Logical;
275 * The signature and checksum must both be correct
277 if (ACPI_STRNCMP ((char *) AcpiGbl_RSDP, RSDP_SIG, sizeof (RSDP_SIG)-1) != 0)
279 /* Nope, BAD Signature */
281 return_ACPI_STATUS (AE_BAD_SIGNATURE);
284 if (AcpiTbChecksum (AcpiGbl_RSDP, ACPI_RSDP_CHECKSUM_LENGTH) != 0)
286 /* Nope, BAD Checksum */
288 return_ACPI_STATUS (AE_BAD_CHECKSUM);
292 /* Get the RSDT and validate it */
294 AcpiTbGetRsdtAddress (&Address);
296 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
297 "RSDP located at %p, RSDT physical=%8.8X%8.8X \n",
299 ACPI_FORMAT_UINT64 (Address.Pointer.Value)));
301 /* Insert ProcessorMode flags */
303 Address.PointerType |= Flags;
305 Status = AcpiTbGetTable (&Address, &RsdtInfo);
306 if (ACPI_FAILURE (Status))
308 return_ACPI_STATUS (Status);
311 Status = AcpiTbValidateRsdt (RsdtInfo.Pointer);
312 if (ACPI_FAILURE (Status))
317 /* Get the number of table pointers within the RSDT */
319 TableCount = AcpiTbGetTableCount (AcpiGbl_RSDP, RsdtInfo.Pointer);
321 Address.PointerType = AcpiGbl_TableFlags | Flags;
324 * Search the RSDT/XSDT for the correct instance of the
327 for (i = 0, j = 0; i < TableCount; i++)
329 /* Get the next table pointer, handle RSDT vs. XSDT */
331 if (AcpiGbl_RSDP->Revision < 2)
333 Address.Pointer.Value = (ACPI_CAST_PTR (RSDT_DESCRIPTOR, RsdtInfo.Pointer))->TableOffsetEntry[i];
337 Address.Pointer.Value = ACPI_GET_ADDRESS (
338 (ACPI_CAST_PTR (XSDT_DESCRIPTOR, RsdtInfo.Pointer))->TableOffsetEntry[i]);
341 /* Get the table header */
343 Status = AcpiTbGetTableHeader (&Address, &Header);
344 if (ACPI_FAILURE (Status))
349 /* Compare table signatures and table instance */
351 if (!ACPI_STRNCMP (Header.Signature, Signature, ACPI_NAME_SIZE))
353 /* An instance of the table was found */
358 /* Found the correct instance, get the entire table */
360 Status = AcpiTbGetTableBody (&Address, &Header, &TableInfo);
361 if (ACPI_FAILURE (Status))
366 *TablePointer = TableInfo.Pointer;
372 /* Did not find the table */
374 Status = AE_NOT_EXIST;
378 AcpiOsUnmapMemory (RsdtInfo.Pointer, (ACPI_SIZE) RsdtInfo.Pointer->Length);
379 return_ACPI_STATUS (Status);
383 /* TBD: Move to a new file */
385 #if ACPI_MACHINE_WIDTH != 16
387 /*******************************************************************************
389 * FUNCTION: AcpiFindRootPointer
391 * PARAMETERS: **RsdpAddress - Where to place the RSDP address
392 * Flags - Logical/Physical addressing
394 * RETURN: Status, Physical address of the RSDP
396 * DESCRIPTION: Find the RSDP
398 ******************************************************************************/
401 AcpiFindRootPointer (
403 ACPI_POINTER *RsdpAddress)
405 ACPI_TABLE_DESC TableInfo;
409 ACPI_FUNCTION_TRACE ("AcpiFindRootPointer");
414 Status = AcpiTbFindRsdp (&TableInfo, Flags);
415 if (ACPI_FAILURE (Status))
417 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "RSDP structure not found, %s Flags=%X\n",
418 AcpiFormatException (Status), Flags));
419 return_ACPI_STATUS (AE_NO_ACPI_TABLES);
422 RsdpAddress->PointerType = ACPI_PHYSICAL_POINTER;
423 RsdpAddress->Pointer.Physical = TableInfo.PhysicalAddress;
424 return_ACPI_STATUS (AE_OK);
428 /*******************************************************************************
430 * FUNCTION: AcpiTbScanMemoryForRsdp
432 * PARAMETERS: StartAddress - Starting pointer for search
433 * Length - Maximum length to search
435 * RETURN: Pointer to the RSDP if found, otherwise NULL.
437 * DESCRIPTION: Search a block of memory for the RSDP signature
439 ******************************************************************************/
442 AcpiTbScanMemoryForRsdp (
450 ACPI_FUNCTION_TRACE ("TbScanMemoryForRsdp");
453 /* Search from given start addr for the requested length */
455 for (Offset = 0, MemRover = StartAddress;
457 Offset += ACPI_RSDP_SCAN_STEP, MemRover += ACPI_RSDP_SCAN_STEP)
460 /* The signature and checksum must both be correct */
462 if (ACPI_STRNCMP ((char *) MemRover,
463 RSDP_SIG, sizeof (RSDP_SIG)-1) == 0 &&
464 AcpiTbChecksum (MemRover, ACPI_RSDP_CHECKSUM_LENGTH) == 0)
466 /* If so, we have found the RSDP */
468 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
469 "RSDP located at physical address %p\n",MemRover));
470 return_PTR (MemRover);
474 /* Searched entire block, no RSDP was found */
476 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,"Searched entire block, no RSDP was found.\n"));
481 /*******************************************************************************
483 * FUNCTION: AcpiTbFindRsdp
485 * PARAMETERS: *TableInfo - Where the table info is returned
486 * Flags - Current memory mode (logical vs.
487 * physical addressing)
489 * RETURN: Status, RSDP physical address
491 * DESCRIPTION: Search lower 1Mbyte of memory for the root system descriptor
492 * pointer structure. If it is found, set *RSDP to point to it.
494 * NOTE1: The RSDP must be either in the first 1K of the Extended
495 * BIOS Data Area or between E0000 and FFFFF (From ACPI Spec.)
496 * Only a 32-bit physical address is necessary.
498 * NOTE2: This function is always available, regardless of the
499 * initialization state of the rest of ACPI.
501 ******************************************************************************/
505 ACPI_TABLE_DESC *TableInfo,
510 UINT32 PhysicalAddress;
514 ACPI_FUNCTION_TRACE ("TbFindRsdp");
518 * Scan supports either 1) Logical addressing or 2) Physical addressing
520 if ((Flags & ACPI_MEMORY_MODE) == ACPI_LOGICAL_ADDRESSING)
523 * 1a) Get the location of the EBDA
525 Status = AcpiOsMapMemory ((ACPI_PHYSICAL_ADDRESS) ACPI_EBDA_PTR_LOCATION,
526 ACPI_EBDA_PTR_LENGTH,
528 if (ACPI_FAILURE (Status))
530 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not map memory at %8.8X for length %X\n",
531 ACPI_EBDA_PTR_LOCATION, ACPI_EBDA_PTR_LENGTH));
532 return_ACPI_STATUS (Status);
535 ACPI_MOVE_16_TO_32 (&PhysicalAddress, TablePtr);
536 PhysicalAddress <<= 4; /* Convert segment to physical address */
537 AcpiOsUnmapMemory (TablePtr, ACPI_EBDA_PTR_LENGTH);
541 if (PhysicalAddress > 0x400)
544 * 1b) Search EBDA paragraphs (EBDA is required to be a minimum of 1K length)
546 Status = AcpiOsMapMemory ((ACPI_PHYSICAL_ADDRESS) PhysicalAddress,
547 ACPI_EBDA_WINDOW_SIZE,
549 if (ACPI_FAILURE (Status))
551 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not map memory at %8.8X for length %X\n",
552 PhysicalAddress, ACPI_EBDA_WINDOW_SIZE));
553 return_ACPI_STATUS (Status);
556 MemRover = AcpiTbScanMemoryForRsdp (TablePtr, ACPI_EBDA_WINDOW_SIZE);
557 AcpiOsUnmapMemory (TablePtr, ACPI_EBDA_WINDOW_SIZE);
561 /* Found it, return the physical address */
563 PhysicalAddress += ACPI_PTR_DIFF (MemRover, TablePtr);
565 TableInfo->PhysicalAddress = (ACPI_PHYSICAL_ADDRESS) PhysicalAddress;
566 return_ACPI_STATUS (AE_OK);
571 * 2) Search upper memory: 16-byte boundaries in E0000h-FFFFFh
573 Status = AcpiOsMapMemory ((ACPI_PHYSICAL_ADDRESS) ACPI_HI_RSDP_WINDOW_BASE,
574 ACPI_HI_RSDP_WINDOW_SIZE,
576 if (ACPI_FAILURE (Status))
578 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not map memory at %8.8X for length %X\n",
579 ACPI_HI_RSDP_WINDOW_BASE, ACPI_HI_RSDP_WINDOW_SIZE));
580 return_ACPI_STATUS (Status);
583 MemRover = AcpiTbScanMemoryForRsdp (TablePtr, ACPI_HI_RSDP_WINDOW_SIZE);
584 AcpiOsUnmapMemory (TablePtr, ACPI_HI_RSDP_WINDOW_SIZE);
588 /* Found it, return the physical address */
590 PhysicalAddress = ACPI_HI_RSDP_WINDOW_BASE + ACPI_PTR_DIFF (MemRover, TablePtr);
592 TableInfo->PhysicalAddress = (ACPI_PHYSICAL_ADDRESS) PhysicalAddress;
593 return_ACPI_STATUS (AE_OK);
598 * Physical addressing
603 * 1a) Get the location of the EBDA
605 ACPI_MOVE_16_TO_32 (&PhysicalAddress, ACPI_EBDA_PTR_LOCATION);
606 PhysicalAddress <<= 4; /* Convert segment to physical address */
610 if (PhysicalAddress > 0x400)
613 * 1b) Search EBDA paragraphs (EBDA is required to be a minimum of 1K length)
615 MemRover = AcpiTbScanMemoryForRsdp (ACPI_PHYSADDR_TO_PTR (PhysicalAddress),
616 ACPI_EBDA_WINDOW_SIZE);
619 /* Found it, return the physical address */
621 TableInfo->PhysicalAddress = ACPI_TO_INTEGER (MemRover);
622 return_ACPI_STATUS (AE_OK);
627 * 2) Search upper memory: 16-byte boundaries in E0000h-FFFFFh
629 MemRover = AcpiTbScanMemoryForRsdp (ACPI_PHYSADDR_TO_PTR (ACPI_HI_RSDP_WINDOW_BASE),
630 ACPI_HI_RSDP_WINDOW_SIZE);
633 /* Found it, return the physical address */
635 TableInfo->PhysicalAddress = ACPI_TO_INTEGER (MemRover);
636 return_ACPI_STATUS (AE_OK);
640 /* RSDP signature was not found */
642 return_ACPI_STATUS (AE_NOT_FOUND);