1/****************************************************************************** 2 * 3 * Module Name: antables - ACPI table setup/install for AcpiNames utility 4 * 5 *****************************************************************************/ 6 7/****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2016, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 *****************************************************************************/ 115 116#include "acpinames.h" 117 118#define _COMPONENT ACPI_TOOLS 119 ACPI_MODULE_NAME ("antables") 120 121/* Local prototypes */ 122 123static void 124AnInitializeTableHeader ( 125 ACPI_TABLE_HEADER *Header, 126 char *Signature, 127 UINT32 Length); 128 129 130/* Non-AML tables that are constructed locally and installed */ 131 132static ACPI_TABLE_RSDP LocalRSDP; 133static ACPI_TABLE_FACS LocalFACS; 134 135/* 136 * We need a local FADT so that the hardware subcomponent will function, 137 * even though the underlying OSD HW access functions don't do anything. 138 */ 139static ACPI_TABLE_FADT LocalFADT; 140 141/* 142 * Use XSDT so that both 32- and 64-bit versions of this utility will 143 * function automatically. 144 */ 145static ACPI_TABLE_XSDT *LocalXSDT; 146 147#define BASE_XSDT_TABLES 1 148#define BASE_XSDT_SIZE (sizeof (ACPI_TABLE_XSDT) + \ 149 ((BASE_XSDT_TABLES -1) * sizeof (UINT64))) 150 151 152/****************************************************************************** 153 * 154 * FUNCTION: AnInitializeTableHeader 155 * 156 * PARAMETERS: Header - A valid standard ACPI table header 157 * Signature - Signature to insert 158 * Length - Length of the table 159 * 160 * RETURN: None. Header is modified. 161 * 162 * DESCRIPTION: Initialize the table header for a local ACPI table. 163 * 164 *****************************************************************************/ 165 166static void 167AnInitializeTableHeader ( 168 ACPI_TABLE_HEADER *Header, 169 char *Signature, 170 UINT32 Length) 171{ 172 173 ACPI_MOVE_NAME (Header->Signature, Signature); 174 Header->Length = Length; 175 176 Header->OemRevision = 0x1001; 177 strncpy (Header->OemId, "Intel", ACPI_OEM_ID_SIZE); 178 strncpy (Header->OemTableId, "AcpiName", ACPI_OEM_TABLE_ID_SIZE); 179 strncpy (Header->AslCompilerId, "INTL", ACPI_NAME_SIZE); 180 Header->AslCompilerRevision = ACPI_CA_VERSION; 181 182 /* Set the checksum, must set to zero first */ 183 184 Header->Checksum = 0; 185 Header->Checksum = (UINT8) -AcpiTbChecksum ( 186 (void *) Header, Header->Length); 187} 188 189 190/****************************************************************************** 191 * 192 * FUNCTION: AnBuildLocalTables 193 * 194 * PARAMETERS: TableCount - Number of tables on the command line 195 * TableList - List of actual tables from files 196 * 197 * RETURN: Status 198 * 199 * DESCRIPTION: Build a complete ACPI table chain, with a local RSDP, XSDT, 200 * FADT, FACS, and the input DSDT/SSDT. 201 * 202 *****************************************************************************/ 203 204ACPI_STATUS 205AnBuildLocalTables ( 206 ACPI_NEW_TABLE_DESC *TableList) 207{ 208 UINT32 TableCount = 0; 209 ACPI_PHYSICAL_ADDRESS DsdtAddress = 0; 210 UINT32 XsdtSize; 211 ACPI_NEW_TABLE_DESC *NextTable; 212 UINT32 NextIndex; 213 ACPI_TABLE_FADT *ExternalFadt = NULL; 214 215 216 /* 217 * Update the table count. For the DSDT, it is not put into the XSDT. 218 * For the FADT, this table is already accounted for since we usually 219 * install a local FADT. 220 */ 221 NextTable = TableList; 222 while (NextTable) 223 { 224 if (!ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_DSDT) && 225 !ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_FADT)) 226 { 227 TableCount++; 228 } 229 230 NextTable = NextTable->Next; 231 } 232 233 XsdtSize = BASE_XSDT_SIZE + (TableCount * sizeof (UINT64)); 234 235 /* Build an XSDT */ 236 237 LocalXSDT = AcpiOsAllocate (XsdtSize); 238 if (!LocalXSDT) 239 { 240 return (AE_NO_MEMORY); 241 } 242 243 memset (LocalXSDT, 0, XsdtSize); 244 LocalXSDT->TableOffsetEntry[0] = ACPI_PTR_TO_PHYSADDR (&LocalFADT); 245 246 /* 247 * Install the user tables. The DSDT must be installed in the FADT. 248 * All other tables are installed directly into the XSDT. 249 * 250 * Note: The tables are loaded in reverse order from the incoming 251 * input, which makes it match the command line order. 252 */ 253 NextIndex = BASE_XSDT_TABLES; 254 NextTable = TableList; 255 while (NextTable) 256 { 257 /* 258 * Incoming DSDT or FADT are special cases. All other tables are 259 * just immediately installed into the XSDT. 260 */ 261 if (ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_DSDT)) 262 { 263 if (DsdtAddress) 264 { 265 printf ("Already found a DSDT, only one allowed\n"); 266 return (AE_ALREADY_EXISTS); 267 } 268 269 /* The incoming user table is a DSDT */ 270 271 DsdtAddress = ACPI_PTR_TO_PHYSADDR (NextTable->Table); 272 } 273 else if (ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_FADT)) 274 { 275 ExternalFadt = 276 ACPI_CAST_PTR (ACPI_TABLE_FADT, NextTable->Table); 277 LocalXSDT->TableOffsetEntry[0] = 278 ACPI_PTR_TO_PHYSADDR (NextTable->Table); 279 } 280 else 281 { 282 /* Install the table in the XSDT */ 283 284 LocalXSDT->TableOffsetEntry[TableCount - NextIndex + 1] = 285 ACPI_PTR_TO_PHYSADDR (NextTable->Table); 286 NextIndex++; 287 } 288 289 NextTable = NextTable->Next; 290 } 291 292 /* Build an RSDP. Contains a valid XSDT only, no RSDT */ 293 294 memset (&LocalRSDP, 0, sizeof (ACPI_TABLE_RSDP)); 295 ACPI_MAKE_RSDP_SIG (LocalRSDP.Signature); 296 memcpy (LocalRSDP.OemId, "Intel", 6); 297 298 LocalRSDP.Revision = 2; 299 LocalRSDP.XsdtPhysicalAddress = ACPI_PTR_TO_PHYSADDR (LocalXSDT); 300 LocalRSDP.Length = sizeof (ACPI_TABLE_XSDT); 301 302 /* Set checksums for both XSDT and RSDP */ 303 304 AnInitializeTableHeader ((void *) LocalXSDT, ACPI_SIG_XSDT, XsdtSize); 305 306 LocalRSDP.Checksum = 0; 307 LocalRSDP.Checksum = (UINT8) -AcpiTbChecksum ( 308 (void *) &LocalRSDP, ACPI_RSDP_CHECKSUM_LENGTH); 309 310 if (!DsdtAddress) 311 { 312 return (AE_SUPPORT); 313 } 314 315 /* 316 * Build an FADT. There are two options for the FADT: 317 * 1) Incoming external FADT specified on the command line 318 * 2) A fully featured local FADT 319 */ 320 memset (&LocalFADT, 0, sizeof (ACPI_TABLE_FADT)); 321 322 if (ExternalFadt) 323 { 324 /* 325 * Use the external FADT, but we must update the DSDT/FACS 326 * addresses as well as the checksum 327 */ 328 ExternalFadt->Dsdt = (UINT32) DsdtAddress; 329 ExternalFadt->Facs = ACPI_PTR_TO_PHYSADDR (&LocalFACS); 330 331 /* 332 * If there room in the FADT for the XDsdt and XFacs 64-bit 333 * pointers, use them. 334 */ 335 if (ExternalFadt->Header.Length > ACPI_PTR_DIFF ( 336 &ExternalFadt->XDsdt, ExternalFadt)) 337 { 338 ExternalFadt->Dsdt = 0; 339 ExternalFadt->Facs = 0; 340 ExternalFadt->XDsdt = DsdtAddress; 341 ExternalFadt->XFacs = ACPI_PTR_TO_PHYSADDR (&LocalFACS); 342 } 343 344 /* Complete the external FADT with the checksum */ 345 346 ExternalFadt->Header.Checksum = 0; 347 ExternalFadt->Header.Checksum = (UINT8) -AcpiTbChecksum ( 348 (void *) ExternalFadt, ExternalFadt->Header.Length); 349 } 350 else 351 { 352 /* 353 * Build a local FADT so we can test the hardware/event init 354 */ 355 LocalFADT.Header.Revision = 5; 356 357 /* Setup FADT header and DSDT/FACS addresses */ 358 359 LocalFADT.Dsdt = 0; 360 LocalFADT.Facs = 0; 361 362 LocalFADT.XDsdt = DsdtAddress; 363 LocalFADT.XFacs = ACPI_PTR_TO_PHYSADDR (&LocalFACS); 364 365 /* Miscellaneous FADT fields */ 366 367 LocalFADT.Gpe0BlockLength = 16; 368 LocalFADT.Gpe0Block = 0x00001234; 369 370 LocalFADT.Gpe1BlockLength = 6; 371 LocalFADT.Gpe1Block = 0x00005678; 372 LocalFADT.Gpe1Base = 96; 373 374 LocalFADT.Pm1EventLength = 4; 375 LocalFADT.Pm1aEventBlock = 0x00001aaa; 376 LocalFADT.Pm1bEventBlock = 0x00001bbb; 377 378 LocalFADT.Pm1ControlLength = 2; 379 LocalFADT.Pm1aControlBlock = 0xB0; 380 381 LocalFADT.PmTimerLength = 4; 382 LocalFADT.PmTimerBlock = 0xA0; 383 384 LocalFADT.Pm2ControlBlock = 0xC0; 385 LocalFADT.Pm2ControlLength = 1; 386 387 /* Setup one example X-64 field */ 388 389 LocalFADT.XPm1bEventBlock.SpaceId = ACPI_ADR_SPACE_SYSTEM_IO; 390 LocalFADT.XPm1bEventBlock.Address = LocalFADT.Pm1bEventBlock; 391 LocalFADT.XPm1bEventBlock.BitWidth = (UINT8) 392 ACPI_MUL_8 (LocalFADT.Pm1EventLength); 393 } 394 395 AnInitializeTableHeader ((void *) &LocalFADT, 396 ACPI_SIG_FADT, sizeof (ACPI_TABLE_FADT)); 397 398 /* Build a FACS */ 399 400 memset (&LocalFACS, 0, sizeof (ACPI_TABLE_FACS)); 401 ACPI_MOVE_NAME (LocalFACS.Signature, ACPI_SIG_FACS); 402 403 LocalFACS.Length = sizeof (ACPI_TABLE_FACS); 404 LocalFACS.GlobalLock = 0x11AA0011; 405 return (AE_OK); 406} 407 408 409/****************************************************************************** 410 * 411 * FUNCTION: AcpiOsGetRootPointer 412 * 413 * PARAMETERS: None 414 * 415 * RETURN: Address of the RSDP 416 * 417 * DESCRIPTION: Return a local RSDP, used to dynamically load tables via the 418 * standard ACPI mechanism. 419 * 420 *****************************************************************************/ 421 422ACPI_PHYSICAL_ADDRESS 423AcpiOsGetRootPointer ( 424 void) 425{ 426 427 return (ACPI_PTR_TO_PHYSADDR (&LocalRSDP)); 428} 429