1 /******************************************************************************
3 * Module Name: tbconvrt - ACPI Table conversion utilities
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, 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>
50 #define _COMPONENT ACPI_TABLES
51 ACPI_MODULE_NAME ("tbconvrt")
53 /* Local prototypes */
56 acpi_tb_init_generic_address (
57 struct acpi_generic_address
*new_gas_struct
,
58 u8 register_bit_width
,
59 acpi_physical_address address
);
62 acpi_tb_convert_fadt1 (
63 struct fadt_descriptor_rev2
*local_fadt
,
64 struct fadt_descriptor_rev1
*original_fadt
);
67 acpi_tb_convert_fadt2 (
68 struct fadt_descriptor_rev2
*local_fadt
,
69 struct fadt_descriptor_rev2
*original_fadt
);
73 EXPORT_SYMBOL(acpi_fadt_is_v1
);
75 /*******************************************************************************
77 * FUNCTION: acpi_tb_get_table_count
79 * PARAMETERS: RSDP - Pointer to the RSDP
80 * RSDT - Pointer to the RSDT/XSDT
82 * RETURN: The number of tables pointed to by the RSDT or XSDT.
84 * DESCRIPTION: Calculate the number of tables. Automatically handles either
87 ******************************************************************************/
90 acpi_tb_get_table_count (
91 struct rsdp_descriptor
*RSDP
,
92 struct acpi_table_header
*RSDT
)
97 ACPI_FUNCTION_ENTRY ();
100 if (RSDP
->revision
< 2) {
101 pointer_size
= sizeof (u32
);
104 pointer_size
= sizeof (u64
);
108 * Determine the number of tables pointed to by the RSDT/XSDT.
109 * This is defined by the ACPI Specification to be the number of
110 * pointers contained within the RSDT/XSDT. The size of the pointers
111 * is architecture-dependent.
113 return ((RSDT
->length
- sizeof (struct acpi_table_header
)) / pointer_size
);
117 /*******************************************************************************
119 * FUNCTION: acpi_tb_convert_to_xsdt
121 * PARAMETERS: table_info - Info about the RSDT
125 * DESCRIPTION: Convert an RSDT to an XSDT (internal common format)
127 ******************************************************************************/
130 acpi_tb_convert_to_xsdt (
131 struct acpi_table_desc
*table_info
)
133 acpi_size table_size
;
135 XSDT_DESCRIPTOR
*new_table
;
138 ACPI_FUNCTION_ENTRY ();
141 /* Compute size of the converted XSDT */
143 table_size
= ((acpi_size
) acpi_gbl_rsdt_table_count
* sizeof (u64
)) +
144 sizeof (struct acpi_table_header
);
146 /* Allocate an XSDT */
148 new_table
= ACPI_MEM_CALLOCATE (table_size
);
150 return (AE_NO_MEMORY
);
153 /* Copy the header and set the length */
155 ACPI_MEMCPY (new_table
, table_info
->pointer
, sizeof (struct acpi_table_header
));
156 new_table
->length
= (u32
) table_size
;
158 /* Copy the table pointers */
160 for (i
= 0; i
< acpi_gbl_rsdt_table_count
; i
++) {
161 if (acpi_gbl_RSDP
->revision
< 2) {
162 ACPI_STORE_ADDRESS (new_table
->table_offset_entry
[i
],
163 (ACPI_CAST_PTR (struct rsdt_descriptor_rev1
,
164 table_info
->pointer
))->table_offset_entry
[i
]);
167 new_table
->table_offset_entry
[i
] =
168 (ACPI_CAST_PTR (XSDT_DESCRIPTOR
,
169 table_info
->pointer
))->table_offset_entry
[i
];
173 /* Delete the original table (either mapped or in a buffer) */
175 acpi_tb_delete_single_table (table_info
);
177 /* Point the table descriptor to the new table */
179 table_info
->pointer
= ACPI_CAST_PTR (struct acpi_table_header
, new_table
);
180 table_info
->length
= table_size
;
181 table_info
->allocation
= ACPI_MEM_ALLOCATED
;
187 /*******************************************************************************
189 * FUNCTION: acpi_tb_init_generic_address
191 * PARAMETERS: new_gas_struct - GAS struct to be initialized
192 * register_bit_width - Width of this register
193 * Address - Address of the register
197 * DESCRIPTION: Initialize a GAS structure.
199 ******************************************************************************/
202 acpi_tb_init_generic_address (
203 struct acpi_generic_address
*new_gas_struct
,
204 u8 register_bit_width
,
205 acpi_physical_address address
)
208 ACPI_STORE_ADDRESS (new_gas_struct
->address
, address
);
210 new_gas_struct
->address_space_id
= ACPI_ADR_SPACE_SYSTEM_IO
;
211 new_gas_struct
->register_bit_width
= register_bit_width
;
212 new_gas_struct
->register_bit_offset
= 0;
213 new_gas_struct
->access_width
= 0;
217 /*******************************************************************************
219 * FUNCTION: acpi_tb_convert_fadt1
221 * PARAMETERS: local_fadt - Pointer to new FADT
222 * original_fadt - Pointer to old FADT
224 * RETURN: None, populates local_fadt
226 * DESCRIPTION: Convert an ACPI 1.0 FADT to common internal format
228 ******************************************************************************/
231 acpi_tb_convert_fadt1 (
232 struct fadt_descriptor_rev2
*local_fadt
,
233 struct fadt_descriptor_rev1
*original_fadt
)
237 /* The BIOS stored FADT should agree with Revision 1.0 */
241 * Copy the table header and the common part of the tables.
243 * The 2.0 table is an extension of the 1.0 table, so the entire 1.0
244 * table can be copied first, then expand some fields to 64 bits.
246 ACPI_MEMCPY (local_fadt
, original_fadt
, sizeof (struct fadt_descriptor_rev1
));
248 /* Convert table pointers to 64-bit fields */
250 ACPI_STORE_ADDRESS (local_fadt
->xfirmware_ctrl
, local_fadt
->V1_firmware_ctrl
);
251 ACPI_STORE_ADDRESS (local_fadt
->Xdsdt
, local_fadt
->V1_dsdt
);
254 * System Interrupt Model isn't used in ACPI 2.0
255 * (local_fadt->Reserved1 = 0;)
259 * This field is set by the OEM to convey the preferred power management
260 * profile to OSPM. It doesn't have any 1.0 equivalence. Since we don't
261 * know what kind of 32-bit system this is, we will use "unspecified".
263 local_fadt
->prefer_PM_profile
= PM_UNSPECIFIED
;
266 * Processor Performance State Control. This is the value OSPM writes to
267 * the SMI_CMD register to assume processor performance state control
268 * responsibility. There isn't any equivalence in 1.0, but as many 1.x
269 * ACPI tables contain _PCT and _PSS we also keep this value, unless
270 * acpi_strict is set.
273 local_fadt
->pstate_cnt
= 0;
276 * Support for the _CST object and C States change notification.
277 * This data item hasn't any 1.0 equivalence so leave it zero.
279 local_fadt
->cst_cnt
= 0;
282 * FADT Rev 2 was an interim FADT released between ACPI 1.0 and ACPI 2.0.
283 * It primarily adds the FADT reset mechanism.
285 if ((original_fadt
->revision
== 2) &&
286 (original_fadt
->length
== sizeof (struct fadt_descriptor_rev2_minus
))) {
288 * Grab the entire generic address struct, plus the 1-byte reset value
289 * that immediately follows.
291 ACPI_MEMCPY (&local_fadt
->reset_register
,
292 &(ACPI_CAST_PTR (struct fadt_descriptor_rev2_minus
,
293 original_fadt
))->reset_register
,
294 sizeof (struct acpi_generic_address
) + 1);
298 * Since there isn't any equivalence in 1.0 and since it is highly
299 * likely that a 1.0 system has legacy support.
301 local_fadt
->iapc_boot_arch
= BAF_LEGACY_DEVICES
;
305 * Convert the V1.0 block addresses to V2.0 GAS structures
307 acpi_tb_init_generic_address (&local_fadt
->xpm1a_evt_blk
, local_fadt
->pm1_evt_len
,
308 (acpi_physical_address
) local_fadt
->V1_pm1a_evt_blk
);
309 acpi_tb_init_generic_address (&local_fadt
->xpm1b_evt_blk
, local_fadt
->pm1_evt_len
,
310 (acpi_physical_address
) local_fadt
->V1_pm1b_evt_blk
);
311 acpi_tb_init_generic_address (&local_fadt
->xpm1a_cnt_blk
, local_fadt
->pm1_cnt_len
,
312 (acpi_physical_address
) local_fadt
->V1_pm1a_cnt_blk
);
313 acpi_tb_init_generic_address (&local_fadt
->xpm1b_cnt_blk
, local_fadt
->pm1_cnt_len
,
314 (acpi_physical_address
) local_fadt
->V1_pm1b_cnt_blk
);
315 acpi_tb_init_generic_address (&local_fadt
->xpm2_cnt_blk
, local_fadt
->pm2_cnt_len
,
316 (acpi_physical_address
) local_fadt
->V1_pm2_cnt_blk
);
317 acpi_tb_init_generic_address (&local_fadt
->xpm_tmr_blk
, local_fadt
->pm_tm_len
,
318 (acpi_physical_address
) local_fadt
->V1_pm_tmr_blk
);
319 acpi_tb_init_generic_address (&local_fadt
->xgpe0_blk
, 0,
320 (acpi_physical_address
) local_fadt
->V1_gpe0_blk
);
321 acpi_tb_init_generic_address (&local_fadt
->xgpe1_blk
, 0,
322 (acpi_physical_address
) local_fadt
->V1_gpe1_blk
);
324 /* Create separate GAS structs for the PM1 Enable registers */
326 acpi_tb_init_generic_address (&acpi_gbl_xpm1a_enable
,
327 (u8
) ACPI_DIV_2 (acpi_gbl_FADT
->pm1_evt_len
),
328 (acpi_physical_address
)
329 (local_fadt
->xpm1a_evt_blk
.address
+
330 ACPI_DIV_2 (acpi_gbl_FADT
->pm1_evt_len
)));
332 /* PM1B is optional; leave null if not present */
334 if (local_fadt
->xpm1b_evt_blk
.address
) {
335 acpi_tb_init_generic_address (&acpi_gbl_xpm1b_enable
,
336 (u8
) ACPI_DIV_2 (acpi_gbl_FADT
->pm1_evt_len
),
337 (acpi_physical_address
)
338 (local_fadt
->xpm1b_evt_blk
.address
+
339 ACPI_DIV_2 (acpi_gbl_FADT
->pm1_evt_len
)));
344 /*******************************************************************************
346 * FUNCTION: acpi_tb_convert_fadt2
348 * PARAMETERS: local_fadt - Pointer to new FADT
349 * original_fadt - Pointer to old FADT
351 * RETURN: None, populates local_fadt
353 * DESCRIPTION: Convert an ACPI 2.0 FADT to common internal format.
354 * Handles optional "X" fields.
356 ******************************************************************************/
359 acpi_tb_convert_fadt2 (
360 struct fadt_descriptor_rev2
*local_fadt
,
361 struct fadt_descriptor_rev2
*original_fadt
)
364 /* We have an ACPI 2.0 FADT but we must copy it to our local buffer */
366 ACPI_MEMCPY (local_fadt
, original_fadt
, sizeof (struct fadt_descriptor_rev2
));
369 * "X" fields are optional extensions to the original V1.0 fields, so
370 * we must selectively expand V1.0 fields if the corresponding X field
373 if (!(local_fadt
->xfirmware_ctrl
)) {
374 ACPI_STORE_ADDRESS (local_fadt
->xfirmware_ctrl
,
375 local_fadt
->V1_firmware_ctrl
);
378 if (!(local_fadt
->Xdsdt
)) {
379 ACPI_STORE_ADDRESS (local_fadt
->Xdsdt
, local_fadt
->V1_dsdt
);
382 if (!(local_fadt
->xpm1a_evt_blk
.address
)) {
383 acpi_tb_init_generic_address (&local_fadt
->xpm1a_evt_blk
,
384 local_fadt
->pm1_evt_len
,
385 (acpi_physical_address
) local_fadt
->V1_pm1a_evt_blk
);
388 if (!(local_fadt
->xpm1b_evt_blk
.address
)) {
389 acpi_tb_init_generic_address (&local_fadt
->xpm1b_evt_blk
,
390 local_fadt
->pm1_evt_len
,
391 (acpi_physical_address
) local_fadt
->V1_pm1b_evt_blk
);
394 if (!(local_fadt
->xpm1a_cnt_blk
.address
)) {
395 acpi_tb_init_generic_address (&local_fadt
->xpm1a_cnt_blk
,
396 local_fadt
->pm1_cnt_len
,
397 (acpi_physical_address
) local_fadt
->V1_pm1a_cnt_blk
);
400 if (!(local_fadt
->xpm1b_cnt_blk
.address
)) {
401 acpi_tb_init_generic_address (&local_fadt
->xpm1b_cnt_blk
,
402 local_fadt
->pm1_cnt_len
,
403 (acpi_physical_address
) local_fadt
->V1_pm1b_cnt_blk
);
406 if (!(local_fadt
->xpm2_cnt_blk
.address
)) {
407 acpi_tb_init_generic_address (&local_fadt
->xpm2_cnt_blk
,
408 local_fadt
->pm2_cnt_len
,
409 (acpi_physical_address
) local_fadt
->V1_pm2_cnt_blk
);
412 if (!(local_fadt
->xpm_tmr_blk
.address
)) {
413 acpi_tb_init_generic_address (&local_fadt
->xpm_tmr_blk
,
414 local_fadt
->pm_tm_len
,
415 (acpi_physical_address
) local_fadt
->V1_pm_tmr_blk
);
418 if (!(local_fadt
->xgpe0_blk
.address
)) {
419 acpi_tb_init_generic_address (&local_fadt
->xgpe0_blk
,
420 0, (acpi_physical_address
) local_fadt
->V1_gpe0_blk
);
423 if (!(local_fadt
->xgpe1_blk
.address
)) {
424 acpi_tb_init_generic_address (&local_fadt
->xgpe1_blk
,
425 0, (acpi_physical_address
) local_fadt
->V1_gpe1_blk
);
428 /* Create separate GAS structs for the PM1 Enable registers */
430 acpi_tb_init_generic_address (&acpi_gbl_xpm1a_enable
,
431 (u8
) ACPI_DIV_2 (acpi_gbl_FADT
->pm1_evt_len
),
432 (acpi_physical_address
)
433 (local_fadt
->xpm1a_evt_blk
.address
+
434 ACPI_DIV_2 (acpi_gbl_FADT
->pm1_evt_len
)));
436 acpi_gbl_xpm1a_enable
.address_space_id
=
437 local_fadt
->xpm1a_evt_blk
.address_space_id
;
439 /* PM1B is optional; leave null if not present */
441 if (local_fadt
->xpm1b_evt_blk
.address
) {
442 acpi_tb_init_generic_address (&acpi_gbl_xpm1b_enable
,
443 (u8
) ACPI_DIV_2 (acpi_gbl_FADT
->pm1_evt_len
),
444 (acpi_physical_address
)
445 (local_fadt
->xpm1b_evt_blk
.address
+
446 ACPI_DIV_2 (acpi_gbl_FADT
->pm1_evt_len
)));
448 acpi_gbl_xpm1b_enable
.address_space_id
=
449 local_fadt
->xpm1b_evt_blk
.address_space_id
;
454 /*******************************************************************************
456 * FUNCTION: acpi_tb_convert_table_fadt
462 * DESCRIPTION: Converts a BIOS supplied ACPI 1.0 FADT to a local
463 * ACPI 2.0 FADT. If the BIOS supplied a 2.0 FADT then it is simply
464 * copied to the local FADT. The ACPI CA software uses this
465 * local FADT. Thus a significant amount of special #ifdef
466 * type codeing is saved.
468 ******************************************************************************/
471 acpi_tb_convert_table_fadt (
474 struct fadt_descriptor_rev2
*local_fadt
;
475 struct acpi_table_desc
*table_desc
;
478 ACPI_FUNCTION_TRACE ("tb_convert_table_fadt");
482 * acpi_gbl_FADT is valid. Validate the FADT length. The table must be
483 * at least as long as the version 1.0 FADT
485 if (acpi_gbl_FADT
->length
< sizeof (struct fadt_descriptor_rev1
)) {
486 ACPI_REPORT_ERROR (("FADT is invalid, too short: 0x%X\n",
487 acpi_gbl_FADT
->length
));
488 return_ACPI_STATUS (AE_INVALID_TABLE_LENGTH
);
491 /* Allocate buffer for the ACPI 2.0(+) FADT */
493 local_fadt
= ACPI_MEM_CALLOCATE (sizeof (struct fadt_descriptor_rev2
));
495 return_ACPI_STATUS (AE_NO_MEMORY
);
498 if (acpi_gbl_FADT
->revision
>= FADT2_REVISION_ID
) {
499 if (acpi_gbl_FADT
->length
< sizeof (struct fadt_descriptor_rev2
)) {
500 /* Length is too short to be a V2.0 table */
502 ACPI_REPORT_WARNING ((
503 "Inconsistent FADT length (0x%X) and revision (0x%X), using FADT V1.0 portion of table\n",
504 acpi_gbl_FADT
->length
, acpi_gbl_FADT
->revision
));
506 acpi_tb_convert_fadt1 (local_fadt
, (void *) acpi_gbl_FADT
);
509 /* Valid V2.0 table */
511 acpi_tb_convert_fadt2 (local_fadt
, acpi_gbl_FADT
);
515 /* Valid V1.0 table */
517 acpi_tb_convert_fadt1 (local_fadt
, (void *) acpi_gbl_FADT
);
520 /* Global FADT pointer will point to the new common V2.0 FADT */
522 acpi_gbl_FADT
= local_fadt
;
523 acpi_gbl_FADT
->length
= sizeof (FADT_DESCRIPTOR
);
525 /* Free the original table */
527 table_desc
= acpi_gbl_table_lists
[ACPI_TABLE_FADT
].next
;
528 acpi_tb_delete_single_table (table_desc
);
530 /* Install the new table */
532 table_desc
->pointer
= ACPI_CAST_PTR (struct acpi_table_header
, acpi_gbl_FADT
);
533 table_desc
->allocation
= ACPI_MEM_ALLOCATED
;
534 table_desc
->length
= sizeof (struct fadt_descriptor_rev2
);
536 /* Dump the entire FADT */
538 ACPI_DEBUG_PRINT ((ACPI_DB_TABLES
,
539 "Hex dump of common internal FADT, size %d (%X)\n",
540 acpi_gbl_FADT
->length
, acpi_gbl_FADT
->length
));
541 ACPI_DUMP_BUFFER ((u8
*) (acpi_gbl_FADT
), acpi_gbl_FADT
->length
);
543 return_ACPI_STATUS (AE_OK
);
547 /*******************************************************************************
549 * FUNCTION: acpi_tb_build_common_facs
551 * PARAMETERS: table_info - Info for currently installed FACS
555 * DESCRIPTION: Convert ACPI 1.0 and ACPI 2.0 FACS to a common internal
558 ******************************************************************************/
561 acpi_tb_build_common_facs (
562 struct acpi_table_desc
*table_info
)
565 ACPI_FUNCTION_TRACE ("tb_build_common_facs");
568 /* Absolute minimum length is 24, but the ACPI spec says 64 */
570 if (acpi_gbl_FACS
->length
< 24) {
571 ACPI_REPORT_ERROR (("Invalid FACS table length: 0x%X\n",
572 acpi_gbl_FACS
->length
));
573 return_ACPI_STATUS (AE_INVALID_TABLE_LENGTH
);
576 if (acpi_gbl_FACS
->length
< 64) {
577 ACPI_REPORT_WARNING ((
578 "FACS is shorter than the ACPI specification allows: 0x%X, using anyway\n",
579 acpi_gbl_FACS
->length
));
582 /* Copy fields to the new FACS */
584 acpi_gbl_common_fACS
.global_lock
= &(acpi_gbl_FACS
->global_lock
);
586 if ((acpi_gbl_RSDP
->revision
< 2) ||
587 (acpi_gbl_FACS
->length
< 32) ||
588 (!(acpi_gbl_FACS
->xfirmware_waking_vector
))) {
589 /* ACPI 1.0 FACS or short table or optional X_ field is zero */
591 acpi_gbl_common_fACS
.firmware_waking_vector
= ACPI_CAST_PTR (u64
,
592 &(acpi_gbl_FACS
->firmware_waking_vector
));
593 acpi_gbl_common_fACS
.vector_width
= 32;
596 /* ACPI 2.0 FACS with valid X_ field */
598 acpi_gbl_common_fACS
.firmware_waking_vector
= &acpi_gbl_FACS
->xfirmware_waking_vector
;
599 acpi_gbl_common_fACS
.vector_width
= 64;
602 return_ACPI_STATUS (AE_OK
);