1 /******************************************************************************
3 * Module Name: tbconvrt - ACPI Table conversion utilities
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/tbconvrt.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $ */
118 #define __TBCONVRT_C__
121 #include "actables.h"
124 #define _COMPONENT ACPI_TABLES
125 ACPI_MODULE_NAME ("tbconvrt")
128 /*******************************************************************************
130 * FUNCTION: AcpiTbGetTableCount
132 * PARAMETERS: RSDP - Pointer to the RSDP
133 * RSDT - Pointer to the RSDT/XSDT
135 * RETURN: The number of tables pointed to by the RSDT or XSDT.
137 * DESCRIPTION: Calculate the number of tables. Automatically handles either
140 ******************************************************************************/
143 AcpiTbGetTableCount (
144 RSDP_DESCRIPTOR *RSDP,
145 ACPI_TABLE_HEADER *RSDT)
150 ACPI_FUNCTION_ENTRY ();
153 #if ACPI_MACHINE_WIDTH != 64
155 if (RSDP->Revision < 2)
157 PointerSize = sizeof (UINT32);
162 PointerSize = sizeof (UINT64);
166 * Determine the number of tables pointed to by the RSDT/XSDT.
167 * This is defined by the ACPI Specification to be the number of
168 * pointers contained within the RSDT/XSDT. The size of the pointers
169 * is architecture-dependent.
171 return ((RSDT->Length - sizeof (ACPI_TABLE_HEADER)) / PointerSize);
175 /*******************************************************************************
177 * FUNCTION: AcpiTbConvertToXsdt
179 * PARAMETERS: TableInfo - Info about the RSDT
183 * DESCRIPTION: Convert an RSDT to an XSDT (internal common format)
185 ******************************************************************************/
188 AcpiTbConvertToXsdt (
189 ACPI_TABLE_DESC *TableInfo)
193 XSDT_DESCRIPTOR *NewTable;
196 ACPI_FUNCTION_ENTRY ();
199 /* Compute size of the converted XSDT */
201 TableSize = ((ACPI_SIZE) AcpiGbl_RsdtTableCount * sizeof (UINT64)) +
202 sizeof (ACPI_TABLE_HEADER);
204 /* Allocate an XSDT */
206 NewTable = ACPI_MEM_CALLOCATE (TableSize);
209 return (AE_NO_MEMORY);
212 /* Copy the header and set the length */
214 ACPI_MEMCPY (NewTable, TableInfo->Pointer, sizeof (ACPI_TABLE_HEADER));
215 NewTable->Header.Length = (UINT32) TableSize;
217 /* Copy the table pointers */
219 for (i = 0; i < AcpiGbl_RsdtTableCount; i++)
221 if (AcpiGbl_RSDP->Revision < 2)
223 ACPI_STORE_ADDRESS (NewTable->TableOffsetEntry[i],
224 ((RSDT_DESCRIPTOR_REV1 *) TableInfo->Pointer)->TableOffsetEntry[i]);
228 NewTable->TableOffsetEntry[i] =
229 ((XSDT_DESCRIPTOR *) TableInfo->Pointer)->TableOffsetEntry[i];
233 /* Delete the original table (either mapped or in a buffer) */
235 AcpiTbDeleteSingleTable (TableInfo);
237 /* Point the table descriptor to the new table */
239 TableInfo->Pointer = (ACPI_TABLE_HEADER *) NewTable;
240 TableInfo->Length = TableSize;
241 TableInfo->Allocation = ACPI_MEM_ALLOCATED;
247 /*******************************************************************************
249 * FUNCTION: AcpiTbConvertFadt1
251 * PARAMETERS: LocalFadt - Pointer to new FADT
252 * OriginalFadt - Pointer to old FADT
254 * RETURN: Populates LocalFadt
256 * DESCRIPTION: Convert an ACPI 1.0 FADT to common internal format
258 ******************************************************************************/
262 FADT_DESCRIPTOR_REV2 *LocalFadt,
263 FADT_DESCRIPTOR_REV1 *OriginalFadt)
268 /* The BIOS stored FADT should agree with Revision 1.0 */
271 * Copy the table header and the common part of the tables.
273 * The 2.0 table is an extension of the 1.0 table, so the entire 1.0
274 * table can be copied first, then expand some fields to 64 bits.
276 ACPI_MEMCPY (LocalFadt, OriginalFadt, sizeof (FADT_DESCRIPTOR_REV1));
278 /* Convert table pointers to 64-bit fields */
280 ACPI_STORE_ADDRESS (LocalFadt->XFirmwareCtrl, LocalFadt->V1_FirmwareCtrl);
281 ACPI_STORE_ADDRESS (LocalFadt->XDsdt, LocalFadt->V1_Dsdt);
284 * System Interrupt Model isn't used in ACPI 2.0 (LocalFadt->Reserved1 = 0;)
288 * This field is set by the OEM to convey the preferred power management
289 * profile to OSPM. It doesn't have any 1.0 equivalence. Since we don't
290 * know what kind of 32-bit system this is, we will use "unspecified".
292 LocalFadt->Prefer_PM_Profile = PM_UNSPECIFIED;
295 * Processor Performance State Control. This is the value OSPM writes to
296 * the SMI_CMD register to assume processor performance state control
297 * responsibility. There isn't any equivalence in 1.0, leave it zeroed.
299 LocalFadt->PstateCnt = 0;
302 * Support for the _CST object and C States change notification.
303 * This data item hasn't any 1.0 equivalence so leave it zero.
305 LocalFadt->CstCnt = 0;
308 * Since there isn't any equivalence in 1.0 and since it highly likely
309 * that a 1.0 system has legacy support.
311 LocalFadt->IapcBootArch = BAF_LEGACY_DEVICES;
314 * Convert the V1.0 block addresses to V2.0 GAS structures
316 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XPm1aEvtBlk, LocalFadt->Pm1EvtLen, LocalFadt->V1_Pm1aEvtBlk);
317 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XPm1bEvtBlk, LocalFadt->Pm1EvtLen, LocalFadt->V1_Pm1bEvtBlk);
318 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XPm1aCntBlk, LocalFadt->Pm1CntLen, LocalFadt->V1_Pm1aCntBlk);
319 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XPm1bCntBlk, LocalFadt->Pm1CntLen, LocalFadt->V1_Pm1bCntBlk);
320 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XPm2CntBlk, LocalFadt->Pm2CntLen, LocalFadt->V1_Pm2CntBlk);
321 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XPmTmrBlk, LocalFadt->PmTmLen, LocalFadt->V1_PmTmrBlk);
322 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XGpe0Blk, 0, LocalFadt->V1_Gpe0Blk);
323 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XGpe1Blk, 0, LocalFadt->V1_Gpe1Blk);
327 /*******************************************************************************
329 * FUNCTION: AcpiTbConvertFadt2
331 * PARAMETERS: LocalFadt - Pointer to new FADT
332 * OriginalFadt - Pointer to old FADT
334 * RETURN: Populates LocalFadt
336 * DESCRIPTION: Convert an ACPI 2.0 FADT to common internal format.
337 * Handles optional "X" fields.
339 ******************************************************************************/
343 FADT_DESCRIPTOR_REV2 *LocalFadt,
344 FADT_DESCRIPTOR_REV2 *OriginalFadt)
347 /* We have an ACPI 2.0 FADT but we must copy it to our local buffer */
349 ACPI_MEMCPY (LocalFadt, OriginalFadt, sizeof (FADT_DESCRIPTOR_REV2));
352 * "X" fields are optional extensions to the original V1.0 fields, so
353 * we must selectively expand V1.0 fields if the corresponding X field
356 if (!(ACPI_GET_ADDRESS (LocalFadt->XFirmwareCtrl)))
358 ACPI_STORE_ADDRESS (LocalFadt->XFirmwareCtrl, LocalFadt->V1_FirmwareCtrl);
361 if (!(ACPI_GET_ADDRESS (LocalFadt->XDsdt)))
363 ACPI_STORE_ADDRESS (LocalFadt->XDsdt, LocalFadt->V1_Dsdt);
366 if (!(ACPI_GET_ADDRESS (LocalFadt->XPm1aEvtBlk.Address)))
368 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XPm1aEvtBlk,
369 LocalFadt->Pm1EvtLen, LocalFadt->V1_Pm1aEvtBlk);
372 if (!(ACPI_GET_ADDRESS (LocalFadt->XPm1bEvtBlk.Address)))
374 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XPm1bEvtBlk,
375 LocalFadt->Pm1EvtLen, LocalFadt->V1_Pm1bEvtBlk);
378 if (!(ACPI_GET_ADDRESS (LocalFadt->XPm1aCntBlk.Address)))
380 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XPm1aCntBlk,
381 LocalFadt->Pm1CntLen, LocalFadt->V1_Pm1aCntBlk);
384 if (!(ACPI_GET_ADDRESS (LocalFadt->XPm1bCntBlk.Address)))
386 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XPm1bCntBlk,
387 LocalFadt->Pm1CntLen, LocalFadt->V1_Pm1bCntBlk);
390 if (!(ACPI_GET_ADDRESS (LocalFadt->XPm2CntBlk.Address)))
392 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XPm2CntBlk,
393 LocalFadt->Pm2CntLen, LocalFadt->V1_Pm2CntBlk);
396 if (!(ACPI_GET_ADDRESS (LocalFadt->XPmTmrBlk.Address)))
398 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XPmTmrBlk,
399 LocalFadt->PmTmLen, LocalFadt->V1_PmTmrBlk);
402 if (!(ACPI_GET_ADDRESS (LocalFadt->XGpe0Blk.Address)))
404 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XGpe0Blk,
405 0, LocalFadt->V1_Gpe0Blk);
408 if (!(ACPI_GET_ADDRESS (LocalFadt->XGpe1Blk.Address)))
410 ASL_BUILD_GAS_FROM_V1_ENTRY (LocalFadt->XGpe1Blk,
411 0, LocalFadt->V1_Gpe1Blk);
416 /*******************************************************************************
418 * FUNCTION: AcpiTbConvertTableFadt
424 * DESCRIPTION: Converts a BIOS supplied ACPI 1.0 FADT to a local
425 * ACPI 2.0 FADT. If the BIOS supplied a 2.0 FADT then it is simply
426 * copied to the local FADT. The ACPI CA software uses this
427 * local FADT. Thus a significant amount of special #ifdef
428 * type codeing is saved.
430 ******************************************************************************/
433 AcpiTbConvertTableFadt (void)
435 FADT_DESCRIPTOR_REV2 *LocalFadt;
436 ACPI_TABLE_DESC *TableDesc;
439 ACPI_FUNCTION_TRACE ("TbConvertTableFadt");
443 * AcpiGbl_FADT is valid
444 * Allocate and zero the 2.0 FADT buffer
446 LocalFadt = ACPI_MEM_CALLOCATE (sizeof (FADT_DESCRIPTOR_REV2));
447 if (LocalFadt == NULL)
449 return_ACPI_STATUS (AE_NO_MEMORY);
453 * FADT length and version validation. The table must be at least as
454 * long as the version 1.0 FADT
456 if (AcpiGbl_FADT->Header.Length < sizeof (FADT_DESCRIPTOR_REV1))
458 ACPI_REPORT_ERROR (("Invalid FADT table length: 0x%X\n", AcpiGbl_FADT->Header.Length));
459 return_ACPI_STATUS (AE_INVALID_TABLE_LENGTH);
462 if (AcpiGbl_FADT->Header.Revision >= FADT2_REVISION_ID)
464 if (AcpiGbl_FADT->Header.Length < sizeof (FADT_DESCRIPTOR_REV2))
466 /* Length is too short to be a V2.0 table */
468 ACPI_REPORT_WARNING (("Inconsistent FADT length (0x%X) and revision (0x%X), using FADT V1.0 portion of table\n",
469 AcpiGbl_FADT->Header.Length, AcpiGbl_FADT->Header.Revision));
471 AcpiTbConvertFadt1 (LocalFadt, (void *) AcpiGbl_FADT);
475 /* Valid V2.0 table */
477 AcpiTbConvertFadt2 (LocalFadt, AcpiGbl_FADT);
482 /* Valid V1.0 table */
484 AcpiTbConvertFadt1 (LocalFadt, (void *) AcpiGbl_FADT);
488 * Global FADT pointer will point to the new common V2.0 FADT
490 AcpiGbl_FADT = LocalFadt;
491 AcpiGbl_FADT->Header.Length = sizeof (FADT_DESCRIPTOR);
493 /* Free the original table */
495 TableDesc = &AcpiGbl_AcpiTables[ACPI_TABLE_FADT];
496 AcpiTbDeleteSingleTable (TableDesc);
498 /* Install the new table */
500 TableDesc->Pointer = (ACPI_TABLE_HEADER *) AcpiGbl_FADT;
501 TableDesc->Allocation = ACPI_MEM_ALLOCATED;
502 TableDesc->Length = sizeof (FADT_DESCRIPTOR_REV2);
504 /* Dump the entire FADT */
506 ACPI_DEBUG_PRINT ((ACPI_DB_TABLES,
507 "Hex dump of common internal FADT, size %d (%X)\n",
508 AcpiGbl_FADT->Header.Length, AcpiGbl_FADT->Header.Length));
509 ACPI_DUMP_BUFFER ((UINT8 *) (AcpiGbl_FADT), AcpiGbl_FADT->Header.Length);
511 return_ACPI_STATUS (AE_OK);
515 /*******************************************************************************
517 * FUNCTION: AcpiTbConvertTableFacs
519 * PARAMETERS: TableInfo - Info for currently installad FACS
523 * DESCRIPTION: Convert ACPI 1.0 and ACPI 2.0 FACS to a common internal
526 ******************************************************************************/
529 AcpiTbBuildCommonFacs (
530 ACPI_TABLE_DESC *TableInfo)
533 ACPI_FUNCTION_TRACE ("TbBuildCommonFacs");
536 /* Absolute minimum length is 24, but the ACPI spec says 64 */
538 if (AcpiGbl_FACS->Length < 24)
540 ACPI_REPORT_ERROR (("Invalid FACS table length: 0x%X\n", AcpiGbl_FACS->Length));
541 return_ACPI_STATUS (AE_INVALID_TABLE_LENGTH);
544 if (AcpiGbl_FACS->Length < 64)
546 ACPI_REPORT_WARNING (("FACS is shorter than the ACPI specification allows: 0x%X, using anyway\n",
547 AcpiGbl_FACS->Length));
550 /* Copy fields to the new FACS */
552 AcpiGbl_CommonFACS.GlobalLock = &(AcpiGbl_FACS->GlobalLock);
554 if ((AcpiGbl_RSDP->Revision < 2) ||
555 (AcpiGbl_FACS->Length < 32) ||
556 (!(ACPI_GET_ADDRESS (AcpiGbl_FACS->XFirmwareWakingVector))))
558 /* ACPI 1.0 FACS or short table or optional X_ field is zero */
560 AcpiGbl_CommonFACS.FirmwareWakingVector = ACPI_CAST_PTR (UINT64, &(AcpiGbl_FACS->FirmwareWakingVector));
561 AcpiGbl_CommonFACS.VectorWidth = 32;
565 /* ACPI 2.0 FACS with valid X_ field */
567 AcpiGbl_CommonFACS.FirmwareWakingVector = &AcpiGbl_FACS->XFirmwareWakingVector;
568 AcpiGbl_CommonFACS.VectorWidth = 64;
571 return_ACPI_STATUS (AE_OK);