1 /******************************************************************************
3 * Module Name: tbxfroot - Find the root ACPI table (RSDT)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <linux/module.h>
46 #include <acpi/acpi.h>
47 #include <acpi/actables.h>
49 #define _COMPONENT ACPI_TABLES
50 ACPI_MODULE_NAME("tbxfroot")
52 /* Local prototypes */
54 acpi_tb_find_rsdp(struct acpi_table_desc
*table_info
, u32 flags
);
56 static u8
*acpi_tb_scan_memory_for_rsdp(u8
* start_address
, u32 length
);
58 /*******************************************************************************
60 * FUNCTION: acpi_tb_validate_rsdp
62 * PARAMETERS: Rsdp - Pointer to unvalidated RSDP
66 * DESCRIPTION: Validate the RSDP (ptr)
68 ******************************************************************************/
70 acpi_status
acpi_tb_validate_rsdp(struct rsdp_descriptor
*rsdp
)
72 ACPI_FUNCTION_ENTRY();
75 * The signature and checksum must both be correct
77 if (ACPI_STRNCMP((char *)rsdp
, RSDP_SIG
, sizeof(RSDP_SIG
) - 1) != 0) {
79 /* Nope, BAD Signature */
81 return (AE_BAD_SIGNATURE
);
84 /* Check the standard checksum */
86 if (acpi_tb_generate_checksum(rsdp
, ACPI_RSDP_CHECKSUM_LENGTH
) != 0) {
87 return (AE_BAD_CHECKSUM
);
90 /* Check extended checksum if table version >= 2 */
92 if ((rsdp
->revision
>= 2) &&
93 (acpi_tb_generate_checksum(rsdp
, ACPI_RSDP_XCHECKSUM_LENGTH
) !=
95 return (AE_BAD_CHECKSUM
);
101 /*******************************************************************************
103 * FUNCTION: acpi_tb_find_table
105 * PARAMETERS: Signature - String with ACPI table signature
106 * oem_id - String with the table OEM ID
107 * oem_table_id - String with the OEM Table ID
108 * table_ptr - Where the table pointer is returned
112 * DESCRIPTION: Find an ACPI table (in the RSDT/XSDT) that matches the
113 * Signature, OEM ID and OEM Table ID.
115 ******************************************************************************/
118 acpi_tb_find_table(char *signature
,
120 char *oem_table_id
, struct acpi_table_header
** table_ptr
)
123 struct acpi_table_header
*table
;
125 ACPI_FUNCTION_TRACE("tb_find_table");
127 /* Validate string lengths */
129 if ((ACPI_STRLEN(signature
) > ACPI_NAME_SIZE
) ||
130 (ACPI_STRLEN(oem_id
) > sizeof(table
->oem_id
)) ||
131 (ACPI_STRLEN(oem_table_id
) > sizeof(table
->oem_table_id
))) {
132 return_ACPI_STATUS(AE_AML_STRING_LIMIT
);
135 if (!ACPI_STRNCMP(signature
, DSDT_SIG
, ACPI_NAME_SIZE
)) {
137 * The DSDT pointer is contained in the FADT, not the RSDT.
138 * This code should suffice, because the only code that would perform
139 * a "find" on the DSDT is the data_table_region() AML opcode -- in
140 * which case, the DSDT is guaranteed to be already loaded.
141 * If this becomes insufficient, the FADT will have to be found first.
143 if (!acpi_gbl_DSDT
) {
144 return_ACPI_STATUS(AE_NO_ACPI_TABLES
);
146 table
= acpi_gbl_DSDT
;
150 status
= acpi_get_firmware_table(signature
, 1,
151 ACPI_LOGICAL_ADDRESSING
,
153 if (ACPI_FAILURE(status
)) {
154 return_ACPI_STATUS(status
);
158 /* Check oem_id and oem_table_id */
160 if ((oem_id
[0] && ACPI_STRNCMP(oem_id
, table
->oem_id
,
161 sizeof(table
->oem_id
))) ||
162 (oem_table_id
[0] && ACPI_STRNCMP(oem_table_id
, table
->oem_table_id
,
163 sizeof(table
->oem_table_id
)))) {
164 return_ACPI_STATUS(AE_AML_NAME_NOT_FOUND
);
167 ACPI_DEBUG_PRINT((ACPI_DB_TABLES
, "Found table [%4.4s]\n",
171 return_ACPI_STATUS(AE_OK
);
174 /*******************************************************************************
176 * FUNCTION: acpi_get_firmware_table
178 * PARAMETERS: Signature - Any ACPI table signature
179 * Instance - the non zero instance of the table, allows
180 * support for multiple tables of the same type
181 * Flags - Physical/Virtual support
182 * table_pointer - Where a buffer containing the table is
187 * DESCRIPTION: This function is called to get an ACPI table. A buffer is
188 * allocated for the table and returned in table_pointer.
189 * This table will be a complete table including the header.
191 ******************************************************************************/
194 acpi_get_firmware_table(acpi_string signature
,
196 u32 flags
, struct acpi_table_header
**table_pointer
)
199 struct acpi_pointer address
;
200 struct acpi_table_header
*header
= NULL
;
201 struct acpi_table_desc
*table_info
= NULL
;
202 struct acpi_table_desc
*rsdt_info
;
207 ACPI_FUNCTION_TRACE("acpi_get_firmware_table");
210 * Ensure that at least the table manager is initialized. We don't
211 * require that the entire ACPI subsystem is up for this interface.
212 * If we have a buffer, we must have a length too
214 if ((instance
== 0) || (!signature
) || (!table_pointer
)) {
215 return_ACPI_STATUS(AE_BAD_PARAMETER
);
218 /* Ensure that we have a RSDP */
220 if (!acpi_gbl_RSDP
) {
224 status
= acpi_os_get_root_pointer(flags
, &address
);
225 if (ACPI_FAILURE(status
)) {
226 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "RSDP not found\n"));
227 return_ACPI_STATUS(AE_NO_ACPI_TABLES
);
230 /* Map and validate the RSDP */
232 if ((flags
& ACPI_MEMORY_MODE
) == ACPI_LOGICAL_ADDRESSING
) {
233 status
= acpi_os_map_memory(address
.pointer
.physical
,
236 (void *)&acpi_gbl_RSDP
);
237 if (ACPI_FAILURE(status
)) {
238 return_ACPI_STATUS(status
);
241 acpi_gbl_RSDP
= address
.pointer
.logical
;
244 /* The RDSP signature and checksum must both be correct */
246 status
= acpi_tb_validate_rsdp(acpi_gbl_RSDP
);
247 if (ACPI_FAILURE(status
)) {
248 return_ACPI_STATUS(status
);
252 /* Get the RSDT address via the RSDP */
254 acpi_tb_get_rsdt_address(&address
);
255 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
256 "RSDP located at %p, RSDT physical=%8.8X%8.8X\n",
258 ACPI_FORMAT_UINT64(address
.pointer
.value
)));
260 /* Insert processor_mode flags */
262 address
.pointer_type
|= flags
;
264 /* Get and validate the RSDT */
266 rsdt_info
= ACPI_MEM_CALLOCATE(sizeof(struct acpi_table_desc
));
268 return_ACPI_STATUS(AE_NO_MEMORY
);
271 status
= acpi_tb_get_table(&address
, rsdt_info
);
272 if (ACPI_FAILURE(status
)) {
276 status
= acpi_tb_validate_rsdt(rsdt_info
->pointer
);
277 if (ACPI_FAILURE(status
)) {
281 /* Allocate a scratch table header and table descriptor */
283 header
= ACPI_MEM_ALLOCATE(sizeof(struct acpi_table_header
));
285 status
= AE_NO_MEMORY
;
289 table_info
= ACPI_MEM_ALLOCATE(sizeof(struct acpi_table_desc
));
291 status
= AE_NO_MEMORY
;
295 /* Get the number of table pointers within the RSDT */
298 acpi_tb_get_table_count(acpi_gbl_RSDP
, rsdt_info
->pointer
);
299 address
.pointer_type
= acpi_gbl_table_flags
| flags
;
302 * Search the RSDT/XSDT for the correct instance of the
305 for (i
= 0, j
= 0; i
< table_count
; i
++) {
307 * Get the next table pointer, handle RSDT vs. XSDT
308 * RSDT pointers are 32 bits, XSDT pointers are 64 bits
310 if (acpi_gbl_root_table_type
== ACPI_TABLE_TYPE_RSDT
) {
311 address
.pointer
.value
=
314 rsdt_info
->pointer
))->table_offset_entry
[i
];
316 address
.pointer
.value
=
319 rsdt_info
->pointer
))->table_offset_entry
[i
];
322 /* Get the table header */
324 status
= acpi_tb_get_table_header(&address
, header
);
325 if (ACPI_FAILURE(status
)) {
329 /* Compare table signatures and table instance */
331 if (!ACPI_STRNCMP(header
->signature
, signature
, ACPI_NAME_SIZE
)) {
333 /* An instance of the table was found */
338 /* Found the correct instance, get the entire table */
341 acpi_tb_get_table_body(&address
, header
,
343 if (ACPI_FAILURE(status
)) {
347 *table_pointer
= table_info
->pointer
;
353 /* Did not find the table */
355 status
= AE_NOT_EXIST
;
358 if (rsdt_info
->pointer
) {
359 acpi_os_unmap_memory(rsdt_info
->pointer
,
360 (acpi_size
) rsdt_info
->pointer
->length
);
362 ACPI_MEM_FREE(rsdt_info
);
365 ACPI_MEM_FREE(header
);
368 ACPI_MEM_FREE(table_info
);
370 return_ACPI_STATUS(status
);
373 EXPORT_SYMBOL(acpi_get_firmware_table
);
375 /* TBD: Move to a new file */
377 #if ACPI_MACHINE_WIDTH != 16
379 /*******************************************************************************
381 * FUNCTION: acpi_find_root_pointer
383 * PARAMETERS: Flags - Logical/Physical addressing
384 * rsdp_address - Where to place the RSDP address
386 * RETURN: Status, Physical address of the RSDP
388 * DESCRIPTION: Find the RSDP
390 ******************************************************************************/
392 acpi_status
acpi_find_root_pointer(u32 flags
, struct acpi_pointer
*rsdp_address
)
394 struct acpi_table_desc table_info
;
397 ACPI_FUNCTION_TRACE("acpi_find_root_pointer");
401 status
= acpi_tb_find_rsdp(&table_info
, flags
);
402 if (ACPI_FAILURE(status
)) {
403 ACPI_EXCEPTION((AE_INFO
, status
,
404 "RSDP structure not found - Flags=%X", flags
));
406 return_ACPI_STATUS(AE_NO_ACPI_TABLES
);
409 rsdp_address
->pointer_type
= ACPI_PHYSICAL_POINTER
;
410 rsdp_address
->pointer
.physical
= table_info
.physical_address
;
411 return_ACPI_STATUS(AE_OK
);
414 /*******************************************************************************
416 * FUNCTION: acpi_tb_scan_memory_for_rsdp
418 * PARAMETERS: start_address - Starting pointer for search
419 * Length - Maximum length to search
421 * RETURN: Pointer to the RSDP if found, otherwise NULL.
423 * DESCRIPTION: Search a block of memory for the RSDP signature
425 ******************************************************************************/
427 static u8
*acpi_tb_scan_memory_for_rsdp(u8
* start_address
, u32 length
)
433 ACPI_FUNCTION_TRACE("tb_scan_memory_for_rsdp");
435 end_address
= start_address
+ length
;
437 /* Search from given start address for the requested length */
439 for (mem_rover
= start_address
; mem_rover
< end_address
;
440 mem_rover
+= ACPI_RSDP_SCAN_STEP
) {
442 /* The RSDP signature and checksum must both be correct */
445 acpi_tb_validate_rsdp(ACPI_CAST_PTR
446 (struct rsdp_descriptor
, mem_rover
));
447 if (ACPI_SUCCESS(status
)) {
449 /* Sig and checksum valid, we have found a real RSDP */
451 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
452 "RSDP located at physical address %p\n",
454 return_PTR(mem_rover
);
457 /* No sig match or bad checksum, keep searching */
460 /* Searched entire block, no RSDP was found */
462 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
463 "Searched entire block from %p, valid RSDP was not found\n",
468 /*******************************************************************************
470 * FUNCTION: acpi_tb_find_rsdp
472 * PARAMETERS: table_info - Where the table info is returned
473 * Flags - Current memory mode (logical vs.
474 * physical addressing)
476 * RETURN: Status, RSDP physical address
478 * DESCRIPTION: search lower 1_mbyte of memory for the root system descriptor
479 * pointer structure. If it is found, set *RSDP to point to it.
481 * NOTE1: The RSDp must be either in the first 1_k of the Extended
482 * BIOS Data Area or between E0000 and FFFFF (From ACPI Spec.)
483 * Only a 32-bit physical address is necessary.
485 * NOTE2: This function is always available, regardless of the
486 * initialization state of the rest of ACPI.
488 ******************************************************************************/
491 acpi_tb_find_rsdp(struct acpi_table_desc
*table_info
, u32 flags
)
495 u32 physical_address
;
498 ACPI_FUNCTION_TRACE("tb_find_rsdp");
501 * Scan supports either logical addressing or physical addressing
503 if ((flags
& ACPI_MEMORY_MODE
) == ACPI_LOGICAL_ADDRESSING
) {
505 /* 1a) Get the location of the Extended BIOS Data Area (EBDA) */
507 status
= acpi_os_map_memory((acpi_physical_address
)
508 ACPI_EBDA_PTR_LOCATION
,
509 ACPI_EBDA_PTR_LENGTH
,
511 if (ACPI_FAILURE(status
)) {
513 "Could not map memory at %8.8X for length %X",
514 ACPI_EBDA_PTR_LOCATION
,
515 ACPI_EBDA_PTR_LENGTH
));
517 return_ACPI_STATUS(status
);
520 ACPI_MOVE_16_TO_32(&physical_address
, table_ptr
);
522 /* Convert segment part to physical address */
524 physical_address
<<= 4;
525 acpi_os_unmap_memory(table_ptr
, ACPI_EBDA_PTR_LENGTH
);
529 if (physical_address
> 0x400) {
531 * 1b) Search EBDA paragraphs (EBDa is required to be a
532 * minimum of 1_k length)
534 status
= acpi_os_map_memory((acpi_physical_address
)
536 ACPI_EBDA_WINDOW_SIZE
,
538 if (ACPI_FAILURE(status
)) {
540 "Could not map memory at %8.8X for length %X",
542 ACPI_EBDA_WINDOW_SIZE
));
544 return_ACPI_STATUS(status
);
547 mem_rover
= acpi_tb_scan_memory_for_rsdp(table_ptr
,
548 ACPI_EBDA_WINDOW_SIZE
);
549 acpi_os_unmap_memory(table_ptr
, ACPI_EBDA_WINDOW_SIZE
);
553 /* Return the physical address */
556 ACPI_PTR_DIFF(mem_rover
, table_ptr
);
558 table_info
->physical_address
=
559 (acpi_physical_address
) physical_address
;
560 return_ACPI_STATUS(AE_OK
);
565 * 2) Search upper memory: 16-byte boundaries in E0000h-FFFFFh
567 status
= acpi_os_map_memory((acpi_physical_address
)
568 ACPI_HI_RSDP_WINDOW_BASE
,
569 ACPI_HI_RSDP_WINDOW_SIZE
,
572 if (ACPI_FAILURE(status
)) {
574 "Could not map memory at %8.8X for length %X",
575 ACPI_HI_RSDP_WINDOW_BASE
,
576 ACPI_HI_RSDP_WINDOW_SIZE
));
578 return_ACPI_STATUS(status
);
582 acpi_tb_scan_memory_for_rsdp(table_ptr
,
583 ACPI_HI_RSDP_WINDOW_SIZE
);
584 acpi_os_unmap_memory(table_ptr
, ACPI_HI_RSDP_WINDOW_SIZE
);
588 /* Return the physical address */
591 ACPI_HI_RSDP_WINDOW_BASE
+ ACPI_PTR_DIFF(mem_rover
,
594 table_info
->physical_address
=
595 (acpi_physical_address
) physical_address
;
596 return_ACPI_STATUS(AE_OK
);
601 * Physical addressing
604 /* 1a) Get the location of the EBDA */
606 ACPI_MOVE_16_TO_32(&physical_address
, ACPI_EBDA_PTR_LOCATION
);
607 physical_address
<<= 4; /* Convert segment to physical address */
611 if (physical_address
> 0x400) {
613 * 1b) Search EBDA paragraphs (EBDa is required to be a minimum of
617 acpi_tb_scan_memory_for_rsdp(ACPI_PHYSADDR_TO_PTR
619 ACPI_EBDA_WINDOW_SIZE
);
622 /* Return the physical address */
624 table_info
->physical_address
=
625 ACPI_TO_INTEGER(mem_rover
);
626 return_ACPI_STATUS(AE_OK
);
630 /* 2) Search upper memory: 16-byte boundaries in E0000h-FFFFFh */
633 acpi_tb_scan_memory_for_rsdp(ACPI_PHYSADDR_TO_PTR
634 (ACPI_HI_RSDP_WINDOW_BASE
),
635 ACPI_HI_RSDP_WINDOW_SIZE
);
638 /* Found it, return the physical address */
640 table_info
->physical_address
=
641 ACPI_TO_INTEGER(mem_rover
);
642 return_ACPI_STATUS(AE_OK
);
646 /* A valid RSDP was not found */
648 ACPI_ERROR((AE_INFO
, "No valid RSDP was found"));
649 return_ACPI_STATUS(AE_NOT_FOUND
);