[ACPI] ACPICA 20051117
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / acpi / tables / tbconvrt.c
blobcd33397d92310984ffdef669e9214b445f21a9d3
1 /******************************************************************************
3 * Module Name: tbconvrt - ACPI Table conversion utilities
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2005, R. Byron Moore
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
30 * NO WARRANTY
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("tbconvrt")
52 /* Local prototypes */
53 static void
54 acpi_tb_init_generic_address(struct acpi_generic_address *new_gas_struct,
55 u8 register_bit_width,
56 acpi_physical_address address);
58 static void
59 acpi_tb_convert_fadt1(struct fadt_descriptor_rev2 *local_fadt,
60 struct fadt_descriptor_rev1 *original_fadt);
62 static void
63 acpi_tb_convert_fadt2(struct fadt_descriptor_rev2 *local_fadt,
64 struct fadt_descriptor_rev2 *original_fadt);
66 u8 acpi_fadt_is_v1;
67 EXPORT_SYMBOL(acpi_fadt_is_v1);
69 /*******************************************************************************
71 * FUNCTION: acpi_tb_get_table_count
73 * PARAMETERS: RSDP - Pointer to the RSDP
74 * RSDT - Pointer to the RSDT/XSDT
76 * RETURN: The number of tables pointed to by the RSDT or XSDT.
78 * DESCRIPTION: Calculate the number of tables. Automatically handles either
79 * an RSDT or XSDT.
81 ******************************************************************************/
83 u32
84 acpi_tb_get_table_count(struct rsdp_descriptor *RSDP,
85 struct acpi_table_header *RSDT)
87 u32 pointer_size;
89 ACPI_FUNCTION_ENTRY();
91 /* RSDT pointers are 32 bits, XSDT pointers are 64 bits */
93 if (acpi_gbl_root_table_type == ACPI_TABLE_TYPE_RSDT) {
94 pointer_size = sizeof(u32);
95 } else {
96 pointer_size = sizeof(u64);
100 * Determine the number of tables pointed to by the RSDT/XSDT.
101 * This is defined by the ACPI Specification to be the number of
102 * pointers contained within the RSDT/XSDT. The size of the pointers
103 * is architecture-dependent.
105 return ((RSDT->length -
106 sizeof(struct acpi_table_header)) / pointer_size);
109 /*******************************************************************************
111 * FUNCTION: acpi_tb_convert_to_xsdt
113 * PARAMETERS: table_info - Info about the RSDT
115 * RETURN: Status
117 * DESCRIPTION: Convert an RSDT to an XSDT (internal common format)
119 ******************************************************************************/
121 acpi_status acpi_tb_convert_to_xsdt(struct acpi_table_desc *table_info)
123 acpi_size table_size;
124 u32 i;
125 XSDT_DESCRIPTOR *new_table;
127 ACPI_FUNCTION_ENTRY();
129 /* Compute size of the converted XSDT */
131 table_size = ((acpi_size) acpi_gbl_rsdt_table_count * sizeof(u64)) +
132 sizeof(struct acpi_table_header);
134 /* Allocate an XSDT */
136 new_table = ACPI_MEM_CALLOCATE(table_size);
137 if (!new_table) {
138 return (AE_NO_MEMORY);
141 /* Copy the header and set the length */
143 ACPI_MEMCPY(new_table, table_info->pointer,
144 sizeof(struct acpi_table_header));
145 new_table->length = (u32) table_size;
147 /* Copy the table pointers */
149 for (i = 0; i < acpi_gbl_rsdt_table_count; i++) {
150 /* RSDT pointers are 32 bits, XSDT pointers are 64 bits */
152 if (acpi_gbl_root_table_type == ACPI_TABLE_TYPE_RSDT) {
153 ACPI_STORE_ADDRESS(new_table->table_offset_entry[i],
154 (ACPI_CAST_PTR
155 (struct rsdt_descriptor_rev1,
156 table_info->pointer))->
157 table_offset_entry[i]);
158 } else {
159 new_table->table_offset_entry[i] =
160 (ACPI_CAST_PTR(XSDT_DESCRIPTOR,
161 table_info->pointer))->
162 table_offset_entry[i];
166 /* Delete the original table (either mapped or in a buffer) */
168 acpi_tb_delete_single_table(table_info);
170 /* Point the table descriptor to the new table */
172 table_info->pointer =
173 ACPI_CAST_PTR(struct acpi_table_header, new_table);
174 table_info->length = table_size;
175 table_info->allocation = ACPI_MEM_ALLOCATED;
177 return (AE_OK);
180 /*******************************************************************************
182 * FUNCTION: acpi_tb_init_generic_address
184 * PARAMETERS: new_gas_struct - GAS struct to be initialized
185 * register_bit_width - Width of this register
186 * Address - Address of the register
188 * RETURN: None
190 * DESCRIPTION: Initialize a GAS structure.
192 ******************************************************************************/
194 static void
195 acpi_tb_init_generic_address(struct acpi_generic_address *new_gas_struct,
196 u8 register_bit_width,
197 acpi_physical_address address)
200 ACPI_STORE_ADDRESS(new_gas_struct->address, address);
202 new_gas_struct->address_space_id = ACPI_ADR_SPACE_SYSTEM_IO;
203 new_gas_struct->register_bit_width = register_bit_width;
204 new_gas_struct->register_bit_offset = 0;
205 new_gas_struct->access_width = 0;
208 /*******************************************************************************
210 * FUNCTION: acpi_tb_convert_fadt1
212 * PARAMETERS: local_fadt - Pointer to new FADT
213 * original_fadt - Pointer to old FADT
215 * RETURN: None, populates local_fadt
217 * DESCRIPTION: Convert an ACPI 1.0 FADT to common internal format
219 ******************************************************************************/
221 static void
222 acpi_tb_convert_fadt1(struct fadt_descriptor_rev2 *local_fadt,
223 struct fadt_descriptor_rev1 *original_fadt)
226 /* ACPI 1.0 FACS */
227 /* The BIOS stored FADT should agree with Revision 1.0 */
228 acpi_fadt_is_v1 = 1;
231 * Copy the table header and the common part of the tables.
233 * The 2.0 table is an extension of the 1.0 table, so the entire 1.0
234 * table can be copied first, then expand some fields to 64 bits.
236 ACPI_MEMCPY(local_fadt, original_fadt,
237 sizeof(struct fadt_descriptor_rev1));
239 /* Convert table pointers to 64-bit fields */
241 ACPI_STORE_ADDRESS(local_fadt->xfirmware_ctrl,
242 local_fadt->V1_firmware_ctrl);
243 ACPI_STORE_ADDRESS(local_fadt->Xdsdt, local_fadt->V1_dsdt);
246 * System Interrupt Model isn't used in ACPI 2.0
247 * (local_fadt->Reserved1 = 0;)
251 * This field is set by the OEM to convey the preferred power management
252 * profile to OSPM. It doesn't have any 1.0 equivalence. Since we don't
253 * know what kind of 32-bit system this is, we will use "unspecified".
255 local_fadt->prefer_PM_profile = PM_UNSPECIFIED;
258 * Processor Performance State Control. This is the value OSPM writes to
259 * the SMI_CMD register to assume processor performance state control
260 * responsibility. There isn't any equivalence in 1.0, but as many 1.x
261 * ACPI tables contain _PCT and _PSS we also keep this value, unless
262 * acpi_strict is set.
264 if (acpi_strict)
265 local_fadt->pstate_cnt = 0;
268 * Support for the _CST object and C States change notification.
269 * This data item hasn't any 1.0 equivalence so leave it zero.
271 local_fadt->cst_cnt = 0;
274 * FADT Rev 2 was an interim FADT released between ACPI 1.0 and ACPI 2.0.
275 * It primarily adds the FADT reset mechanism.
277 if ((original_fadt->revision == 2) &&
278 (original_fadt->length ==
279 sizeof(struct fadt_descriptor_rev2_minus))) {
281 * Grab the entire generic address struct, plus the 1-byte reset value
282 * that immediately follows.
284 ACPI_MEMCPY(&local_fadt->reset_register,
285 &(ACPI_CAST_PTR(struct fadt_descriptor_rev2_minus,
286 original_fadt))->reset_register,
287 sizeof(struct acpi_generic_address) + 1);
288 } else {
290 * Since there isn't any equivalence in 1.0 and since it is highly
291 * likely that a 1.0 system has legacy support.
293 local_fadt->iapc_boot_arch = BAF_LEGACY_DEVICES;
297 * Convert the V1.0 block addresses to V2.0 GAS structures
299 acpi_tb_init_generic_address(&local_fadt->xpm1a_evt_blk,
300 local_fadt->pm1_evt_len,
301 (acpi_physical_address) local_fadt->
302 V1_pm1a_evt_blk);
303 acpi_tb_init_generic_address(&local_fadt->xpm1b_evt_blk,
304 local_fadt->pm1_evt_len,
305 (acpi_physical_address) local_fadt->
306 V1_pm1b_evt_blk);
307 acpi_tb_init_generic_address(&local_fadt->xpm1a_cnt_blk,
308 local_fadt->pm1_cnt_len,
309 (acpi_physical_address) local_fadt->
310 V1_pm1a_cnt_blk);
311 acpi_tb_init_generic_address(&local_fadt->xpm1b_cnt_blk,
312 local_fadt->pm1_cnt_len,
313 (acpi_physical_address) local_fadt->
314 V1_pm1b_cnt_blk);
315 acpi_tb_init_generic_address(&local_fadt->xpm2_cnt_blk,
316 local_fadt->pm2_cnt_len,
317 (acpi_physical_address) local_fadt->
318 V1_pm2_cnt_blk);
319 acpi_tb_init_generic_address(&local_fadt->xpm_tmr_blk,
320 local_fadt->pm_tm_len,
321 (acpi_physical_address) local_fadt->
322 V1_pm_tmr_blk);
323 acpi_tb_init_generic_address(&local_fadt->xgpe0_blk, 0,
324 (acpi_physical_address) local_fadt->
325 V1_gpe0_blk);
326 acpi_tb_init_generic_address(&local_fadt->xgpe1_blk, 0,
327 (acpi_physical_address) local_fadt->
328 V1_gpe1_blk);
330 /* Create separate GAS structs for the PM1 Enable registers */
332 acpi_tb_init_generic_address(&acpi_gbl_xpm1a_enable,
333 (u8) ACPI_DIV_2(acpi_gbl_FADT->
334 pm1_evt_len),
335 (acpi_physical_address)
336 (local_fadt->xpm1a_evt_blk.address +
337 ACPI_DIV_2(acpi_gbl_FADT->pm1_evt_len)));
339 /* PM1B is optional; leave null if not present */
341 if (local_fadt->xpm1b_evt_blk.address) {
342 acpi_tb_init_generic_address(&acpi_gbl_xpm1b_enable,
343 (u8) ACPI_DIV_2(acpi_gbl_FADT->
344 pm1_evt_len),
345 (acpi_physical_address)
346 (local_fadt->xpm1b_evt_blk.
347 address +
348 ACPI_DIV_2(acpi_gbl_FADT->
349 pm1_evt_len)));
353 /*******************************************************************************
355 * FUNCTION: acpi_tb_convert_fadt2
357 * PARAMETERS: local_fadt - Pointer to new FADT
358 * original_fadt - Pointer to old FADT
360 * RETURN: None, populates local_fadt
362 * DESCRIPTION: Convert an ACPI 2.0 FADT to common internal format.
363 * Handles optional "X" fields.
365 ******************************************************************************/
367 static void
368 acpi_tb_convert_fadt2(struct fadt_descriptor_rev2 *local_fadt,
369 struct fadt_descriptor_rev2 *original_fadt)
372 /* We have an ACPI 2.0 FADT but we must copy it to our local buffer */
374 ACPI_MEMCPY(local_fadt, original_fadt,
375 sizeof(struct fadt_descriptor_rev2));
378 * "X" fields are optional extensions to the original V1.0 fields, so
379 * we must selectively expand V1.0 fields if the corresponding X field
380 * is zero.
382 if (!(local_fadt->xfirmware_ctrl)) {
383 ACPI_STORE_ADDRESS(local_fadt->xfirmware_ctrl,
384 local_fadt->V1_firmware_ctrl);
387 if (!(local_fadt->Xdsdt)) {
388 ACPI_STORE_ADDRESS(local_fadt->Xdsdt, local_fadt->V1_dsdt);
391 if (!(local_fadt->xpm1a_evt_blk.address)) {
392 acpi_tb_init_generic_address(&local_fadt->xpm1a_evt_blk,
393 local_fadt->pm1_evt_len,
394 (acpi_physical_address)
395 local_fadt->V1_pm1a_evt_blk);
398 if (!(local_fadt->xpm1b_evt_blk.address)) {
399 acpi_tb_init_generic_address(&local_fadt->xpm1b_evt_blk,
400 local_fadt->pm1_evt_len,
401 (acpi_physical_address)
402 local_fadt->V1_pm1b_evt_blk);
405 if (!(local_fadt->xpm1a_cnt_blk.address)) {
406 acpi_tb_init_generic_address(&local_fadt->xpm1a_cnt_blk,
407 local_fadt->pm1_cnt_len,
408 (acpi_physical_address)
409 local_fadt->V1_pm1a_cnt_blk);
412 if (!(local_fadt->xpm1b_cnt_blk.address)) {
413 acpi_tb_init_generic_address(&local_fadt->xpm1b_cnt_blk,
414 local_fadt->pm1_cnt_len,
415 (acpi_physical_address)
416 local_fadt->V1_pm1b_cnt_blk);
419 if (!(local_fadt->xpm2_cnt_blk.address)) {
420 acpi_tb_init_generic_address(&local_fadt->xpm2_cnt_blk,
421 local_fadt->pm2_cnt_len,
422 (acpi_physical_address)
423 local_fadt->V1_pm2_cnt_blk);
426 if (!(local_fadt->xpm_tmr_blk.address)) {
427 acpi_tb_init_generic_address(&local_fadt->xpm_tmr_blk,
428 local_fadt->pm_tm_len,
429 (acpi_physical_address)
430 local_fadt->V1_pm_tmr_blk);
433 if (!(local_fadt->xgpe0_blk.address)) {
434 acpi_tb_init_generic_address(&local_fadt->xgpe0_blk,
436 (acpi_physical_address)
437 local_fadt->V1_gpe0_blk);
440 if (!(local_fadt->xgpe1_blk.address)) {
441 acpi_tb_init_generic_address(&local_fadt->xgpe1_blk,
443 (acpi_physical_address)
444 local_fadt->V1_gpe1_blk);
447 /* Create separate GAS structs for the PM1 Enable registers */
449 acpi_tb_init_generic_address(&acpi_gbl_xpm1a_enable,
450 (u8) ACPI_DIV_2(acpi_gbl_FADT->
451 pm1_evt_len),
452 (acpi_physical_address)
453 (local_fadt->xpm1a_evt_blk.address +
454 ACPI_DIV_2(acpi_gbl_FADT->pm1_evt_len)));
456 acpi_gbl_xpm1a_enable.address_space_id =
457 local_fadt->xpm1a_evt_blk.address_space_id;
459 /* PM1B is optional; leave null if not present */
461 if (local_fadt->xpm1b_evt_blk.address) {
462 acpi_tb_init_generic_address(&acpi_gbl_xpm1b_enable,
463 (u8) ACPI_DIV_2(acpi_gbl_FADT->
464 pm1_evt_len),
465 (acpi_physical_address)
466 (local_fadt->xpm1b_evt_blk.
467 address +
468 ACPI_DIV_2(acpi_gbl_FADT->
469 pm1_evt_len)));
471 acpi_gbl_xpm1b_enable.address_space_id =
472 local_fadt->xpm1b_evt_blk.address_space_id;
476 /*******************************************************************************
478 * FUNCTION: acpi_tb_convert_table_fadt
480 * PARAMETERS: None
482 * RETURN: Status
484 * DESCRIPTION: Converts a BIOS supplied ACPI 1.0 FADT to a local
485 * ACPI 2.0 FADT. If the BIOS supplied a 2.0 FADT then it is simply
486 * copied to the local FADT. The ACPI CA software uses this
487 * local FADT. Thus a significant amount of special #ifdef
488 * type codeing is saved.
490 ******************************************************************************/
492 acpi_status acpi_tb_convert_table_fadt(void)
494 struct fadt_descriptor_rev2 *local_fadt;
495 struct acpi_table_desc *table_desc;
497 ACPI_FUNCTION_TRACE("tb_convert_table_fadt");
500 * acpi_gbl_FADT is valid. Validate the FADT length. The table must be
501 * at least as long as the version 1.0 FADT
503 if (acpi_gbl_FADT->length < sizeof(struct fadt_descriptor_rev1)) {
504 ACPI_REPORT_ERROR(("FADT is invalid, too short: 0x%X\n",
505 acpi_gbl_FADT->length));
506 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH);
509 /* Allocate buffer for the ACPI 2.0(+) FADT */
511 local_fadt = ACPI_MEM_CALLOCATE(sizeof(struct fadt_descriptor_rev2));
512 if (!local_fadt) {
513 return_ACPI_STATUS(AE_NO_MEMORY);
516 if (acpi_gbl_FADT->revision >= FADT2_REVISION_ID) {
517 if (acpi_gbl_FADT->length < sizeof(struct fadt_descriptor_rev2)) {
518 /* Length is too short to be a V2.0 table */
520 ACPI_REPORT_WARNING(("Inconsistent FADT length (0x%X) and revision (0x%X), using FADT V1.0 portion of table\n", acpi_gbl_FADT->length, acpi_gbl_FADT->revision));
522 acpi_tb_convert_fadt1(local_fadt,
523 (void *)acpi_gbl_FADT);
524 } else {
525 /* Valid V2.0 table */
527 acpi_tb_convert_fadt2(local_fadt, acpi_gbl_FADT);
529 } else {
530 /* Valid V1.0 table */
532 acpi_tb_convert_fadt1(local_fadt, (void *)acpi_gbl_FADT);
535 /* Global FADT pointer will point to the new common V2.0 FADT */
537 acpi_gbl_FADT = local_fadt;
538 acpi_gbl_FADT->length = sizeof(FADT_DESCRIPTOR);
540 /* Free the original table */
542 table_desc = acpi_gbl_table_lists[ACPI_TABLE_FADT].next;
543 acpi_tb_delete_single_table(table_desc);
545 /* Install the new table */
547 table_desc->pointer =
548 ACPI_CAST_PTR(struct acpi_table_header, acpi_gbl_FADT);
549 table_desc->allocation = ACPI_MEM_ALLOCATED;
550 table_desc->length = sizeof(struct fadt_descriptor_rev2);
552 /* Dump the entire FADT */
554 ACPI_DEBUG_PRINT((ACPI_DB_TABLES,
555 "Hex dump of common internal FADT, size %d (%X)\n",
556 acpi_gbl_FADT->length, acpi_gbl_FADT->length));
558 ACPI_DUMP_BUFFER(ACPI_CAST_PTR(u8, acpi_gbl_FADT),
559 acpi_gbl_FADT->length);
561 return_ACPI_STATUS(AE_OK);
564 /*******************************************************************************
566 * FUNCTION: acpi_tb_build_common_facs
568 * PARAMETERS: table_info - Info for currently installed FACS
570 * RETURN: Status
572 * DESCRIPTION: Convert ACPI 1.0 and ACPI 2.0 FACS to a common internal
573 * table format.
575 ******************************************************************************/
577 acpi_status acpi_tb_build_common_facs(struct acpi_table_desc *table_info)
580 ACPI_FUNCTION_TRACE("tb_build_common_facs");
582 /* Absolute minimum length is 24, but the ACPI spec says 64 */
584 if (acpi_gbl_FACS->length < 24) {
585 ACPI_REPORT_ERROR(("Invalid FACS table length: 0x%X\n",
586 acpi_gbl_FACS->length));
587 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH);
590 if (acpi_gbl_FACS->length < 64) {
591 ACPI_REPORT_WARNING(("FACS is shorter than the ACPI specification allows: 0x%X, using anyway\n", acpi_gbl_FACS->length));
594 /* Copy fields to the new FACS */
596 acpi_gbl_common_fACS.global_lock = &(acpi_gbl_FACS->global_lock);
598 if ((acpi_gbl_RSDP->revision < 2) ||
599 (acpi_gbl_FACS->length < 32) ||
600 (!(acpi_gbl_FACS->xfirmware_waking_vector))) {
601 /* ACPI 1.0 FACS or short table or optional X_ field is zero */
603 acpi_gbl_common_fACS.firmware_waking_vector = ACPI_CAST_PTR(u64,
605 (acpi_gbl_FACS->
606 firmware_waking_vector));
607 acpi_gbl_common_fACS.vector_width = 32;
608 } else {
609 /* ACPI 2.0 FACS with valid X_ field */
611 acpi_gbl_common_fACS.firmware_waking_vector =
612 &acpi_gbl_FACS->xfirmware_waking_vector;
613 acpi_gbl_common_fACS.vector_width = 64;
616 return_ACPI_STATUS(AE_OK);