1 /******************************************************************************
3 * Module Name: tbxfroot - Find the root ACPI table (RSDT)
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, 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 *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/tbxfroot.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $ */
118 #define __TBXFROOT_C__
121 #include "actables.h"
124 #define _COMPONENT ACPI_TABLES
125 ACPI_MODULE_NAME ("tbxfroot")
128 /*******************************************************************************
130 * FUNCTION: AcpiTbFindTable
132 * PARAMETERS: Signature - String with ACPI table signature
133 * OemId - String with the table OEM ID
134 * OemTableId - String with the OEM Table ID.
138 * DESCRIPTION: Find an ACPI table (in the RSDT/XSDT) that matches the
139 * Signature, OEM ID and OEM Table ID.
141 ******************************************************************************/
148 ACPI_TABLE_HEADER **TablePtr)
151 ACPI_TABLE_HEADER *Table;
154 ACPI_FUNCTION_TRACE ("TbFindTable");
157 /* Validate string lengths */
159 if ((ACPI_STRLEN (Signature) > ACPI_NAME_SIZE) ||
160 (ACPI_STRLEN (OemId) > sizeof (Table->OemId)) ||
161 (ACPI_STRLEN (OemTableId) > sizeof (Table->OemTableId)))
163 return_ACPI_STATUS (AE_AML_STRING_LIMIT);
168 Status = AcpiGetFirmwareTable (Signature, 1,
169 ACPI_LOGICAL_ADDRESSING, &Table);
170 if (ACPI_FAILURE (Status))
172 return_ACPI_STATUS (Status);
175 /* Check OemId and OemTableId */
177 if ((OemId[0] && ACPI_STRCMP (OemId, Table->OemId)) ||
178 (OemTableId[0] && ACPI_STRCMP (OemTableId, Table->OemTableId)))
180 return_ACPI_STATUS (AE_AML_NAME_NOT_FOUND);
184 return_ACPI_STATUS (AE_OK);
188 /*******************************************************************************
190 * FUNCTION: AcpiGetFirmwareTable
192 * PARAMETERS: Signature - Any ACPI table signature
193 * Instance - the non zero instance of the table, allows
194 * support for multiple tables of the same type
195 * Flags - Physical/Virtual support
196 * RetBuffer - pointer to a structure containing a buffer to
201 * DESCRIPTION: This function is called to get an ACPI table. The caller
202 * supplies an OutBuffer large enough to contain the entire ACPI
203 * table. Upon completion
204 * the OutBuffer->Length field will indicate the number of bytes
205 * copied into the OutBuffer->BufPtr buffer. This table will be
206 * a complete table including the header.
208 ******************************************************************************/
211 AcpiGetFirmwareTable (
212 ACPI_STRING Signature,
215 ACPI_TABLE_HEADER **TablePointer)
217 ACPI_POINTER RsdpAddress;
218 ACPI_POINTER Address;
220 ACPI_TABLE_HEADER Header;
221 ACPI_TABLE_DESC TableInfo;
222 ACPI_TABLE_DESC RsdtInfo;
228 ACPI_FUNCTION_TRACE ("AcpiGetFirmwareTable");
232 * Ensure that at least the table manager is initialized. We don't
233 * require that the entire ACPI subsystem is up for this interface
237 * If we have a buffer, we must have a length too
239 if ((Instance == 0) ||
243 return_ACPI_STATUS (AE_BAD_PARAMETER);
246 RsdtInfo.Pointer = NULL;
252 Status = AcpiOsGetRootPointer (Flags, &RsdpAddress);
253 if (ACPI_FAILURE (Status))
255 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "RSDP not found\n"));
256 return_ACPI_STATUS (AE_NO_ACPI_TABLES);
259 /* Map and validate the RSDP */
261 if ((Flags & ACPI_MEMORY_MODE) == ACPI_LOGICAL_ADDRESSING)
263 Status = AcpiOsMapMemory (RsdpAddress.Pointer.Physical, sizeof (RSDP_DESCRIPTOR),
264 (void **) &AcpiGbl_RSDP);
265 if (ACPI_FAILURE (Status))
267 return_ACPI_STATUS (Status);
272 AcpiGbl_RSDP = RsdpAddress.Pointer.Logical;
276 * The signature and checksum must both be correct
278 if (ACPI_STRNCMP ((char *) AcpiGbl_RSDP, RSDP_SIG, sizeof (RSDP_SIG)-1) != 0)
280 /* Nope, BAD Signature */
282 return_ACPI_STATUS (AE_BAD_SIGNATURE);
285 if (AcpiTbChecksum (AcpiGbl_RSDP, ACPI_RSDP_CHECKSUM_LENGTH) != 0)
287 /* Nope, BAD Checksum */
289 return_ACPI_STATUS (AE_BAD_CHECKSUM);
293 /* Get the RSDT and validate it */
295 AcpiTbGetRsdtAddress (&Address);
297 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
298 "RSDP located at %p, RSDT physical=%8.8X%8.8X \n",
300 ACPI_HIDWORD (Address.Pointer.Value),
301 ACPI_LODWORD (Address.Pointer.Value)));
303 /* Insert ProcessorMode flags */
305 Address.PointerType |= Flags;
307 Status = AcpiTbGetTable (&Address, &RsdtInfo);
308 if (ACPI_FAILURE (Status))
310 return_ACPI_STATUS (Status);
313 Status = AcpiTbValidateRsdt (RsdtInfo.Pointer);
314 if (ACPI_FAILURE (Status))
319 /* Get the number of table pointers within the RSDT */
321 TableCount = AcpiTbGetTableCount (AcpiGbl_RSDP, RsdtInfo.Pointer);
323 Address.PointerType = AcpiGbl_TableFlags | Flags;
326 * Search the RSDT/XSDT for the correct instance of the
329 for (i = 0, j = 0; i < TableCount; i++)
331 /* Get the next table pointer, handle RSDT vs. XSDT */
333 if (AcpiGbl_RSDP->Revision < 2)
335 Address.Pointer.Value = ((RSDT_DESCRIPTOR *) RsdtInfo.Pointer)->TableOffsetEntry[i];
339 Address.Pointer.Value = ACPI_GET_ADDRESS (
340 ((XSDT_DESCRIPTOR *) RsdtInfo.Pointer)->TableOffsetEntry[i]);
343 /* Get the table header */
345 Status = AcpiTbGetTableHeader (&Address, &Header);
346 if (ACPI_FAILURE (Status))
351 /* Compare table signatures and table instance */
353 if (!ACPI_STRNCMP (Header.Signature, Signature, ACPI_NAME_SIZE))
355 /* An instance of the table was found */
360 /* Found the correct instance, get the entire table */
362 Status = AcpiTbGetTableBody (&Address, &Header, &TableInfo);
363 if (ACPI_FAILURE (Status))
368 *TablePointer = TableInfo.Pointer;
374 /* Did not find the table */
376 Status = AE_NOT_EXIST;
380 AcpiOsUnmapMemory (RsdtInfo.Pointer, (ACPI_SIZE) RsdtInfo.Pointer->Length);
381 return_ACPI_STATUS (Status);
385 /* TBD: Move to a new file */
387 #if ACPI_MACHINE_WIDTH != 16
389 /*******************************************************************************
391 * FUNCTION: AcpiFindRootPointer
393 * PARAMETERS: **RsdpAddress - Where to place the RSDP address
394 * Flags - Logical/Physical addressing
396 * RETURN: Status, Physical address of the RSDP
398 * DESCRIPTION: Find the RSDP
400 ******************************************************************************/
403 AcpiFindRootPointer (
405 ACPI_POINTER *RsdpAddress)
407 ACPI_TABLE_DESC TableInfo;
411 ACPI_FUNCTION_TRACE ("AcpiFindRootPointer");
416 Status = AcpiTbFindRsdp (&TableInfo, Flags);
417 if (ACPI_FAILURE (Status))
419 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "RSDP structure not found, %s Flags=%X\n",
420 AcpiFormatException (Status), Flags));
421 return_ACPI_STATUS (AE_NO_ACPI_TABLES);
424 RsdpAddress->PointerType = ACPI_PHYSICAL_POINTER;
425 RsdpAddress->Pointer.Physical = TableInfo.PhysicalAddress;
426 return_ACPI_STATUS (AE_OK);
430 /*******************************************************************************
432 * FUNCTION: AcpiTbScanMemoryForRsdp
434 * PARAMETERS: StartAddress - Starting pointer for search
435 * Length - Maximum length to search
437 * RETURN: Pointer to the RSDP if found, otherwise NULL.
439 * DESCRIPTION: Search a block of memory for the RSDP signature
441 ******************************************************************************/
444 AcpiTbScanMemoryForRsdp (
452 ACPI_FUNCTION_TRACE ("TbScanMemoryForRsdp");
455 /* Search from given start addr for the requested length */
457 for (Offset = 0, MemRover = StartAddress;
459 Offset += ACPI_RSDP_SCAN_STEP, MemRover += ACPI_RSDP_SCAN_STEP)
462 /* The signature and checksum must both be correct */
464 if (ACPI_STRNCMP ((char *) MemRover,
465 RSDP_SIG, sizeof (RSDP_SIG)-1) == 0 &&
466 AcpiTbChecksum (MemRover, ACPI_RSDP_CHECKSUM_LENGTH) == 0)
468 /* If so, we have found the RSDP */
470 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
471 "RSDP located at physical address %p\n",MemRover));
472 return_PTR (MemRover);
476 /* Searched entire block, no RSDP was found */
478 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,"Searched entire block, no RSDP was found.\n"));
483 /*******************************************************************************
485 * FUNCTION: AcpiTbFindRsdp
487 * PARAMETERS: *TableInfo - Where the table info is returned
488 * Flags - Current memory mode (logical vs.
489 * physical addressing)
493 * DESCRIPTION: Search lower 1Mbyte of memory for the root system descriptor
494 * pointer structure. If it is found, set *RSDP to point to it.
496 * NOTE: The RSDP must be either in the first 1K of the Extended
497 * BIOS Data Area or between E0000 and FFFFF (ACPI 1.0 section
498 * 5.2.2; assertion #421).
500 ******************************************************************************/
504 ACPI_TABLE_DESC *TableInfo,
510 ACPI_STATUS Status = AE_OK;
513 ACPI_FUNCTION_TRACE ("TbFindRsdp");
517 * Scan supports either 1) Logical addressing or 2) Physical addressing
519 if ((Flags & ACPI_MEMORY_MODE) == ACPI_LOGICAL_ADDRESSING)
522 * 1) Search EBDA (low memory) paragraphs
524 Status = AcpiOsMapMemory ((UINT64) ACPI_LO_RSDP_WINDOW_BASE, ACPI_LO_RSDP_WINDOW_SIZE,
525 (void **) &TablePtr);
526 if (ACPI_FAILURE (Status))
528 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not map memory at %X for length %X\n",
529 ACPI_LO_RSDP_WINDOW_BASE, ACPI_LO_RSDP_WINDOW_SIZE));
530 return_ACPI_STATUS (Status);
533 MemRover = AcpiTbScanMemoryForRsdp (TablePtr, ACPI_LO_RSDP_WINDOW_SIZE);
534 AcpiOsUnmapMemory (TablePtr, ACPI_LO_RSDP_WINDOW_SIZE);
538 /* Found it, return the physical address */
540 PhysAddr = ACPI_LO_RSDP_WINDOW_BASE;
541 PhysAddr += ACPI_PTR_DIFF (MemRover,TablePtr);
543 TableInfo->PhysicalAddress = PhysAddr;
544 return_ACPI_STATUS (AE_OK);
548 * 2) Search upper memory: 16-byte boundaries in E0000h-F0000h
550 Status = AcpiOsMapMemory ((UINT64) ACPI_HI_RSDP_WINDOW_BASE, ACPI_HI_RSDP_WINDOW_SIZE,
551 (void **) &TablePtr);
552 if (ACPI_FAILURE (Status))
554 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not map memory at %X for length %X\n",
555 ACPI_HI_RSDP_WINDOW_BASE, ACPI_HI_RSDP_WINDOW_SIZE));
556 return_ACPI_STATUS (Status);
559 MemRover = AcpiTbScanMemoryForRsdp (TablePtr, ACPI_HI_RSDP_WINDOW_SIZE);
560 AcpiOsUnmapMemory (TablePtr, ACPI_HI_RSDP_WINDOW_SIZE);
564 /* Found it, return the physical address */
566 PhysAddr = ACPI_HI_RSDP_WINDOW_BASE;
567 PhysAddr += ACPI_PTR_DIFF (MemRover, TablePtr);
569 TableInfo->PhysicalAddress = PhysAddr;
570 return_ACPI_STATUS (AE_OK);
575 * Physical addressing
580 * 1) Search EBDA (low memory) paragraphs
582 MemRover = AcpiTbScanMemoryForRsdp (ACPI_PHYSADDR_TO_PTR (ACPI_LO_RSDP_WINDOW_BASE),
583 ACPI_LO_RSDP_WINDOW_SIZE);
586 /* Found it, return the physical address */
588 TableInfo->PhysicalAddress = ACPI_TO_INTEGER (MemRover);
589 return_ACPI_STATUS (AE_OK);
593 * 2) Search upper memory: 16-byte boundaries in E0000h-F0000h
595 MemRover = AcpiTbScanMemoryForRsdp (ACPI_PHYSADDR_TO_PTR (ACPI_HI_RSDP_WINDOW_BASE),
596 ACPI_HI_RSDP_WINDOW_SIZE);
599 /* Found it, return the physical address */
601 TableInfo->PhysicalAddress = ACPI_TO_INTEGER (MemRover);
602 return_ACPI_STATUS (AE_OK);
606 /* RSDP signature was not found */
608 return_ACPI_STATUS (AE_NOT_FOUND);