[ACPI] ACPICA 20060210
[firewire-audio.git] / drivers / acpi / tables / tbconvrt.c
blob254ebdbb7bef56e4c60bede6ae0ccc1fe173b822
1 /******************************************************************************
3 * Module Name: tbconvrt - ACPI Table conversion utilities
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2006, 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++) {
151 /* RSDT pointers are 32 bits, XSDT pointers are 64 bits */
153 if (acpi_gbl_root_table_type == ACPI_TABLE_TYPE_RSDT) {
154 ACPI_STORE_ADDRESS(new_table->table_offset_entry[i],
155 (ACPI_CAST_PTR
156 (struct rsdt_descriptor_rev1,
157 table_info->pointer))->
158 table_offset_entry[i]);
159 } else {
160 new_table->table_offset_entry[i] =
161 (ACPI_CAST_PTR(XSDT_DESCRIPTOR,
162 table_info->pointer))->
163 table_offset_entry[i];
167 /* Delete the original table (either mapped or in a buffer) */
169 acpi_tb_delete_single_table(table_info);
171 /* Point the table descriptor to the new table */
173 table_info->pointer =
174 ACPI_CAST_PTR(struct acpi_table_header, new_table);
175 table_info->length = table_size;
176 table_info->allocation = ACPI_MEM_ALLOCATED;
178 return (AE_OK);
181 /*******************************************************************************
183 * FUNCTION: acpi_tb_init_generic_address
185 * PARAMETERS: new_gas_struct - GAS struct to be initialized
186 * register_bit_width - Width of this register
187 * Address - Address of the register
189 * RETURN: None
191 * DESCRIPTION: Initialize a GAS structure.
193 ******************************************************************************/
195 static void
196 acpi_tb_init_generic_address(struct acpi_generic_address *new_gas_struct,
197 u8 register_bit_width,
198 acpi_physical_address address)
201 ACPI_STORE_ADDRESS(new_gas_struct->address, address);
203 new_gas_struct->address_space_id = ACPI_ADR_SPACE_SYSTEM_IO;
204 new_gas_struct->register_bit_width = register_bit_width;
205 new_gas_struct->register_bit_offset = 0;
206 new_gas_struct->access_width = 0;
209 /*******************************************************************************
211 * FUNCTION: acpi_tb_convert_fadt1
213 * PARAMETERS: local_fadt - Pointer to new FADT
214 * original_fadt - Pointer to old FADT
216 * RETURN: None, populates local_fadt
218 * DESCRIPTION: Convert an ACPI 1.0 FADT to common internal format
220 ******************************************************************************/
222 static void
223 acpi_tb_convert_fadt1(struct fadt_descriptor_rev2 *local_fadt,
224 struct fadt_descriptor_rev1 *original_fadt)
227 /* ACPI 1.0 FACS */
228 /* The BIOS stored FADT should agree with Revision 1.0 */
229 acpi_fadt_is_v1 = 1;
232 * Copy the table header and the common part of the tables.
234 * The 2.0 table is an extension of the 1.0 table, so the entire 1.0
235 * table can be copied first, then expand some fields to 64 bits.
237 ACPI_MEMCPY(local_fadt, original_fadt,
238 sizeof(struct fadt_descriptor_rev1));
240 /* Convert table pointers to 64-bit fields */
242 ACPI_STORE_ADDRESS(local_fadt->xfirmware_ctrl,
243 local_fadt->V1_firmware_ctrl);
244 ACPI_STORE_ADDRESS(local_fadt->Xdsdt, local_fadt->V1_dsdt);
247 * System Interrupt Model isn't used in ACPI 2.0
248 * (local_fadt->Reserved1 = 0;)
252 * This field is set by the OEM to convey the preferred power management
253 * profile to OSPM. It doesn't have any 1.0 equivalence. Since we don't
254 * know what kind of 32-bit system this is, we will use "unspecified".
256 local_fadt->prefer_PM_profile = PM_UNSPECIFIED;
259 * Processor Performance State Control. This is the value OSPM writes to
260 * the SMI_CMD register to assume processor performance state control
261 * responsibility. There isn't any equivalence in 1.0, but as many 1.x
262 * ACPI tables contain _PCT and _PSS we also keep this value, unless
263 * acpi_strict is set.
265 if (acpi_strict)
266 local_fadt->pstate_cnt = 0;
269 * Support for the _CST object and C States change notification.
270 * This data item hasn't any 1.0 equivalence so leave it zero.
272 local_fadt->cst_cnt = 0;
275 * FADT Rev 2 was an interim FADT released between ACPI 1.0 and ACPI 2.0.
276 * It primarily adds the FADT reset mechanism.
278 if ((original_fadt->revision == 2) &&
279 (original_fadt->length ==
280 sizeof(struct fadt_descriptor_rev2_minus))) {
282 * Grab the entire generic address struct, plus the 1-byte reset value
283 * that immediately follows.
285 ACPI_MEMCPY(&local_fadt->reset_register,
286 &(ACPI_CAST_PTR(struct fadt_descriptor_rev2_minus,
287 original_fadt))->reset_register,
288 sizeof(struct acpi_generic_address) + 1);
289 } else {
291 * Since there isn't any equivalence in 1.0 and since it is highly
292 * likely that a 1.0 system has legacy support.
294 local_fadt->iapc_boot_arch = BAF_LEGACY_DEVICES;
298 * Convert the V1.0 block addresses to V2.0 GAS structures
300 acpi_tb_init_generic_address(&local_fadt->xpm1a_evt_blk,
301 local_fadt->pm1_evt_len,
302 (acpi_physical_address) local_fadt->
303 V1_pm1a_evt_blk);
304 acpi_tb_init_generic_address(&local_fadt->xpm1b_evt_blk,
305 local_fadt->pm1_evt_len,
306 (acpi_physical_address) local_fadt->
307 V1_pm1b_evt_blk);
308 acpi_tb_init_generic_address(&local_fadt->xpm1a_cnt_blk,
309 local_fadt->pm1_cnt_len,
310 (acpi_physical_address) local_fadt->
311 V1_pm1a_cnt_blk);
312 acpi_tb_init_generic_address(&local_fadt->xpm1b_cnt_blk,
313 local_fadt->pm1_cnt_len,
314 (acpi_physical_address) local_fadt->
315 V1_pm1b_cnt_blk);
316 acpi_tb_init_generic_address(&local_fadt->xpm2_cnt_blk,
317 local_fadt->pm2_cnt_len,
318 (acpi_physical_address) local_fadt->
319 V1_pm2_cnt_blk);
320 acpi_tb_init_generic_address(&local_fadt->xpm_tmr_blk,
321 local_fadt->pm_tm_len,
322 (acpi_physical_address) local_fadt->
323 V1_pm_tmr_blk);
324 acpi_tb_init_generic_address(&local_fadt->xgpe0_blk, 0,
325 (acpi_physical_address) local_fadt->
326 V1_gpe0_blk);
327 acpi_tb_init_generic_address(&local_fadt->xgpe1_blk, 0,
328 (acpi_physical_address) local_fadt->
329 V1_gpe1_blk);
331 /* Create separate GAS structs for the PM1 Enable registers */
333 acpi_tb_init_generic_address(&acpi_gbl_xpm1a_enable,
334 (u8) ACPI_DIV_2(acpi_gbl_FADT->
335 pm1_evt_len),
336 (acpi_physical_address)
337 (local_fadt->xpm1a_evt_blk.address +
338 ACPI_DIV_2(acpi_gbl_FADT->pm1_evt_len)));
340 /* PM1B is optional; leave null if not present */
342 if (local_fadt->xpm1b_evt_blk.address) {
343 acpi_tb_init_generic_address(&acpi_gbl_xpm1b_enable,
344 (u8) ACPI_DIV_2(acpi_gbl_FADT->
345 pm1_evt_len),
346 (acpi_physical_address)
347 (local_fadt->xpm1b_evt_blk.
348 address +
349 ACPI_DIV_2(acpi_gbl_FADT->
350 pm1_evt_len)));
354 /*******************************************************************************
356 * FUNCTION: acpi_tb_convert_fadt2
358 * PARAMETERS: local_fadt - Pointer to new FADT
359 * original_fadt - Pointer to old FADT
361 * RETURN: None, populates local_fadt
363 * DESCRIPTION: Convert an ACPI 2.0 FADT to common internal format.
364 * Handles optional "X" fields.
366 ******************************************************************************/
368 static void
369 acpi_tb_convert_fadt2(struct fadt_descriptor_rev2 *local_fadt,
370 struct fadt_descriptor_rev2 *original_fadt)
373 /* We have an ACPI 2.0 FADT but we must copy it to our local buffer */
375 ACPI_MEMCPY(local_fadt, original_fadt,
376 sizeof(struct fadt_descriptor_rev2));
379 * "X" fields are optional extensions to the original V1.0 fields, so
380 * we must selectively expand V1.0 fields if the corresponding X field
381 * is zero.
383 if (!(local_fadt->xfirmware_ctrl)) {
384 ACPI_STORE_ADDRESS(local_fadt->xfirmware_ctrl,
385 local_fadt->V1_firmware_ctrl);
388 if (!(local_fadt->Xdsdt)) {
389 ACPI_STORE_ADDRESS(local_fadt->Xdsdt, local_fadt->V1_dsdt);
392 if (!(local_fadt->xpm1a_evt_blk.address)) {
393 acpi_tb_init_generic_address(&local_fadt->xpm1a_evt_blk,
394 local_fadt->pm1_evt_len,
395 (acpi_physical_address)
396 local_fadt->V1_pm1a_evt_blk);
399 if (!(local_fadt->xpm1b_evt_blk.address)) {
400 acpi_tb_init_generic_address(&local_fadt->xpm1b_evt_blk,
401 local_fadt->pm1_evt_len,
402 (acpi_physical_address)
403 local_fadt->V1_pm1b_evt_blk);
406 if (!(local_fadt->xpm1a_cnt_blk.address)) {
407 acpi_tb_init_generic_address(&local_fadt->xpm1a_cnt_blk,
408 local_fadt->pm1_cnt_len,
409 (acpi_physical_address)
410 local_fadt->V1_pm1a_cnt_blk);
413 if (!(local_fadt->xpm1b_cnt_blk.address)) {
414 acpi_tb_init_generic_address(&local_fadt->xpm1b_cnt_blk,
415 local_fadt->pm1_cnt_len,
416 (acpi_physical_address)
417 local_fadt->V1_pm1b_cnt_blk);
420 if (!(local_fadt->xpm2_cnt_blk.address)) {
421 acpi_tb_init_generic_address(&local_fadt->xpm2_cnt_blk,
422 local_fadt->pm2_cnt_len,
423 (acpi_physical_address)
424 local_fadt->V1_pm2_cnt_blk);
427 if (!(local_fadt->xpm_tmr_blk.address)) {
428 acpi_tb_init_generic_address(&local_fadt->xpm_tmr_blk,
429 local_fadt->pm_tm_len,
430 (acpi_physical_address)
431 local_fadt->V1_pm_tmr_blk);
434 if (!(local_fadt->xgpe0_blk.address)) {
435 acpi_tb_init_generic_address(&local_fadt->xgpe0_blk,
437 (acpi_physical_address)
438 local_fadt->V1_gpe0_blk);
441 if (!(local_fadt->xgpe1_blk.address)) {
442 acpi_tb_init_generic_address(&local_fadt->xgpe1_blk,
444 (acpi_physical_address)
445 local_fadt->V1_gpe1_blk);
448 /* Create separate GAS structs for the PM1 Enable registers */
450 acpi_tb_init_generic_address(&acpi_gbl_xpm1a_enable,
451 (u8) ACPI_DIV_2(acpi_gbl_FADT->
452 pm1_evt_len),
453 (acpi_physical_address)
454 (local_fadt->xpm1a_evt_blk.address +
455 ACPI_DIV_2(acpi_gbl_FADT->pm1_evt_len)));
457 acpi_gbl_xpm1a_enable.address_space_id =
458 local_fadt->xpm1a_evt_blk.address_space_id;
460 /* PM1B is optional; leave null if not present */
462 if (local_fadt->xpm1b_evt_blk.address) {
463 acpi_tb_init_generic_address(&acpi_gbl_xpm1b_enable,
464 (u8) ACPI_DIV_2(acpi_gbl_FADT->
465 pm1_evt_len),
466 (acpi_physical_address)
467 (local_fadt->xpm1b_evt_blk.
468 address +
469 ACPI_DIV_2(acpi_gbl_FADT->
470 pm1_evt_len)));
472 acpi_gbl_xpm1b_enable.address_space_id =
473 local_fadt->xpm1b_evt_blk.address_space_id;
477 /*******************************************************************************
479 * FUNCTION: acpi_tb_convert_table_fadt
481 * PARAMETERS: None
483 * RETURN: Status
485 * DESCRIPTION: Converts a BIOS supplied ACPI 1.0 FADT to a local
486 * ACPI 2.0 FADT. If the BIOS supplied a 2.0 FADT then it is simply
487 * copied to the local FADT. The ACPI CA software uses this
488 * local FADT. Thus a significant amount of special #ifdef
489 * type codeing is saved.
491 ******************************************************************************/
493 acpi_status acpi_tb_convert_table_fadt(void)
495 struct fadt_descriptor_rev2 *local_fadt;
496 struct acpi_table_desc *table_desc;
498 ACPI_FUNCTION_TRACE("tb_convert_table_fadt");
501 * acpi_gbl_FADT is valid. Validate the FADT length. The table must be
502 * at least as long as the version 1.0 FADT
504 if (acpi_gbl_FADT->length < sizeof(struct fadt_descriptor_rev1)) {
505 ACPI_ERROR((AE_INFO, "FADT is invalid, too short: 0x%X",
506 acpi_gbl_FADT->length));
507 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH);
510 /* Allocate buffer for the ACPI 2.0(+) FADT */
512 local_fadt = ACPI_MEM_CALLOCATE(sizeof(struct fadt_descriptor_rev2));
513 if (!local_fadt) {
514 return_ACPI_STATUS(AE_NO_MEMORY);
517 if (acpi_gbl_FADT->revision >= FADT2_REVISION_ID) {
518 if (acpi_gbl_FADT->length < sizeof(struct fadt_descriptor_rev2)) {
520 /* Length is too short to be a V2.0 table */
522 ACPI_WARNING((AE_INFO,
523 "Inconsistent FADT length (0x%X) and revision (0x%X), using FADT V1.0 portion of table",
524 acpi_gbl_FADT->length,
525 acpi_gbl_FADT->revision));
527 acpi_tb_convert_fadt1(local_fadt,
528 (void *)acpi_gbl_FADT);
529 } else {
530 /* Valid V2.0 table */
532 acpi_tb_convert_fadt2(local_fadt, acpi_gbl_FADT);
534 } else {
535 /* Valid V1.0 table */
537 acpi_tb_convert_fadt1(local_fadt, (void *)acpi_gbl_FADT);
540 /* Global FADT pointer will point to the new common V2.0 FADT */
542 acpi_gbl_FADT = local_fadt;
543 acpi_gbl_FADT->length = sizeof(FADT_DESCRIPTOR);
545 /* Free the original table */
547 table_desc = acpi_gbl_table_lists[ACPI_TABLE_FADT].next;
548 acpi_tb_delete_single_table(table_desc);
550 /* Install the new table */
552 table_desc->pointer =
553 ACPI_CAST_PTR(struct acpi_table_header, acpi_gbl_FADT);
554 table_desc->allocation = ACPI_MEM_ALLOCATED;
555 table_desc->length = sizeof(struct fadt_descriptor_rev2);
557 /* Dump the entire FADT */
559 ACPI_DEBUG_PRINT((ACPI_DB_TABLES,
560 "Hex dump of common internal FADT, size %d (%X)\n",
561 acpi_gbl_FADT->length, acpi_gbl_FADT->length));
563 ACPI_DUMP_BUFFER(ACPI_CAST_PTR(u8, acpi_gbl_FADT),
564 acpi_gbl_FADT->length);
566 return_ACPI_STATUS(AE_OK);
569 /*******************************************************************************
571 * FUNCTION: acpi_tb_build_common_facs
573 * PARAMETERS: table_info - Info for currently installed FACS
575 * RETURN: Status
577 * DESCRIPTION: Convert ACPI 1.0 and ACPI 2.0 FACS to a common internal
578 * table format.
580 ******************************************************************************/
582 acpi_status acpi_tb_build_common_facs(struct acpi_table_desc *table_info)
585 ACPI_FUNCTION_TRACE("tb_build_common_facs");
587 /* Absolute minimum length is 24, but the ACPI spec says 64 */
589 if (acpi_gbl_FACS->length < 24) {
590 ACPI_ERROR((AE_INFO, "Invalid FACS table length: 0x%X",
591 acpi_gbl_FACS->length));
592 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH);
595 if (acpi_gbl_FACS->length < 64) {
596 ACPI_WARNING((AE_INFO,
597 "FACS is shorter than the ACPI specification allows: 0x%X, using anyway",
598 acpi_gbl_FACS->length));
601 /* Copy fields to the new FACS */
603 acpi_gbl_common_fACS.global_lock = &(acpi_gbl_FACS->global_lock);
605 if ((acpi_gbl_RSDP->revision < 2) ||
606 (acpi_gbl_FACS->length < 32) ||
607 (!(acpi_gbl_FACS->xfirmware_waking_vector))) {
609 /* ACPI 1.0 FACS or short table or optional X_ field is zero */
611 acpi_gbl_common_fACS.firmware_waking_vector = ACPI_CAST_PTR(u64,
613 (acpi_gbl_FACS->
614 firmware_waking_vector));
615 acpi_gbl_common_fACS.vector_width = 32;
616 } else {
617 /* ACPI 2.0 FACS with valid X_ field */
619 acpi_gbl_common_fACS.firmware_waking_vector =
620 &acpi_gbl_FACS->xfirmware_waking_vector;
621 acpi_gbl_common_fACS.vector_width = 64;
624 return_ACPI_STATUS(AE_OK);