1 /****************************************************************************** 2 * 3 * Module Name: dttable.c - handling for specific ACPI tables 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2023, 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 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 /* Compile routines for the basic ACPI tables */ 153 154 #include <contrib/dev/acpica/compiler/aslcompiler.h> 155 156 #define _COMPONENT DT_COMPILER 157 ACPI_MODULE_NAME ("dttable") 158 159 160 /****************************************************************************** 161 * 162 * FUNCTION: DtCompileRsdp 163 * 164 * PARAMETERS: PFieldList - Current field list pointer 165 * 166 * RETURN: Status 167 * 168 * DESCRIPTION: Compile RSDP. 169 * 170 *****************************************************************************/ 171 172 ACPI_STATUS 173 DtCompileRsdp ( 174 DT_FIELD **PFieldList) 175 { 176 DT_SUBTABLE *Subtable; 177 ACPI_TABLE_RSDP *Rsdp; 178 ACPI_RSDP_EXTENSION *RsdpExtension; 179 ACPI_STATUS Status; 180 181 182 /* Compile the "common" RSDP (ACPI 1.0) */ 183 184 Status = DtCompileTable (PFieldList, AcpiDmTableInfoRsdp1, 185 &AslGbl_RootTable); 186 if (ACPI_FAILURE (Status)) 187 { 188 return (Status); 189 } 190 191 Rsdp = ACPI_CAST_PTR (ACPI_TABLE_RSDP, AslGbl_RootTable->Buffer); 192 DtSetTableChecksum (&Rsdp->Checksum); 193 194 if (Rsdp->Revision > 0) 195 { 196 /* Compile the "extended" part of the RSDP as a subtable */ 197 198 Status = DtCompileTable (PFieldList, AcpiDmTableInfoRsdp2, 199 &Subtable); 200 if (ACPI_FAILURE (Status)) 201 { 202 return (Status); 203 } 204 205 DtInsertSubtable (AslGbl_RootTable, Subtable); 206 207 /* Set length and extended checksum for entire RSDP */ 208 209 RsdpExtension = ACPI_CAST_PTR (ACPI_RSDP_EXTENSION, Subtable->Buffer); 210 RsdpExtension->Length = AslGbl_RootTable->Length + Subtable->Length; 211 DtSetTableChecksum (&RsdpExtension->ExtendedChecksum); 212 } 213 214 return (AE_OK); 215 } 216 217 218 /****************************************************************************** 219 * 220 * FUNCTION: DtCompileFadt 221 * 222 * PARAMETERS: List - Current field list pointer 223 * 224 * RETURN: Status 225 * 226 * DESCRIPTION: Compile FADT (signature FACP). 227 * 228 *****************************************************************************/ 229 230 #define ACPI_XDSDT_LOCATION_IN_LIST 11 231 232 ACPI_STATUS 233 DtCompileFadt ( 234 void **List) 235 { 236 ACPI_STATUS Status; 237 DT_SUBTABLE *Subtable; 238 DT_SUBTABLE *ParentTable; 239 DT_FIELD **PFieldList = (DT_FIELD **) List; 240 DT_FIELD *DsdtFieldList; 241 ACPI_TABLE_FADT *Table; 242 UINT8 Revision; 243 UINT32 DsdtAddress; 244 UINT64 X_DsdtAddress; 245 UINT32 i; 246 247 248 /* Get the table revision and 32-bit DSDT Address definition */ 249 250 DsdtFieldList = (*PFieldList)->Next; 251 Status = DtCompileTable (PFieldList, AcpiDmTableInfoFadt1, 252 &Subtable); 253 if (ACPI_FAILURE (Status)) 254 { 255 return (Status); 256 } 257 258 ParentTable = DtPeekSubtable (); 259 DtInsertSubtable (ParentTable, Subtable); 260 261 Table = ACPI_CAST_PTR (ACPI_TABLE_FADT, ParentTable->Buffer); 262 Revision = Table->Header.Revision; 263 DsdtAddress = Table->Dsdt; 264 265 /* FADT version 1 has only 32-bit addresses - error if DSDT address is NULL */ 266 267 if ((Revision == 1) && (!DsdtAddress)) 268 { 269 DtError (ASL_ERROR, ASL_MSG_ZERO_VALUE, DsdtFieldList, NULL); 270 } 271 272 if (Revision == 2) 273 { 274 Status = DtCompileTable (PFieldList, AcpiDmTableInfoFadt2, 275 &Subtable); 276 if (ACPI_FAILURE (Status)) 277 { 278 return (Status); 279 } 280 281 DtInsertSubtable (ParentTable, Subtable); 282 } 283 284 else if (Revision > 2) 285 { 286 /* 287 * Rev 3 and greater have 64-bit addresses (as well as 32-bit). 288 * Get the 64-bit DSDT (X_DSDT) Address definition. Note: This 289 * appears at field list offset 11 within AcpiDmTableInfoFadt3. 290 */ 291 DsdtFieldList = *PFieldList; 292 for (i = 0; i < ACPI_XDSDT_LOCATION_IN_LIST; i++) 293 { 294 DsdtFieldList = DsdtFieldList->Next; 295 if (!DsdtFieldList) 296 { 297 return (ASL_MSG_BAD_PARSE_TREE); 298 } 299 } 300 301 Status = DtCompileTable (PFieldList, AcpiDmTableInfoFadt3, 302 &Subtable); 303 if (ACPI_FAILURE (Status)) 304 { 305 return (Status); 306 } 307 308 DtInsertSubtable (ParentTable, Subtable); 309 310 Table = ACPI_CAST_PTR (ACPI_TABLE_FADT, ParentTable->Buffer); 311 X_DsdtAddress = Table->XDsdt; 312 313 /* 314 * Error if both the 32-bit DSDT address and the 315 * 64-bit X_DSDT address are zero. 316 */ 317 if ((!X_DsdtAddress) && (!DsdtAddress)) 318 { 319 DtError (ASL_ERROR, ASL_MSG_TWO_ZERO_VALUES, DsdtFieldList, NULL); 320 } 321 322 /* Fields specific to FADT Revision 5 (appended to previous) */ 323 324 if (Revision >= 5) 325 { 326 Status = DtCompileTable (PFieldList, AcpiDmTableInfoFadt5, 327 &Subtable); 328 if (ACPI_FAILURE (Status)) 329 { 330 return (Status); 331 } 332 333 DtInsertSubtable (ParentTable, Subtable); 334 } 335 336 /* Fields specific to FADT Revision 6 (appended to previous) */ 337 338 if (Revision >= 6) 339 { 340 Status = DtCompileTable (PFieldList, AcpiDmTableInfoFadt6, 341 &Subtable); 342 if (ACPI_FAILURE (Status)) 343 { 344 return (Status); 345 } 346 347 DtInsertSubtable (ParentTable, Subtable); 348 } 349 } 350 351 return (AE_OK); 352 } 353 354 355 /****************************************************************************** 356 * 357 * FUNCTION: DtCompileFacs 358 * 359 * PARAMETERS: PFieldList - Current field list pointer 360 * 361 * RETURN: Status 362 * 363 * DESCRIPTION: Compile FACS. 364 * 365 *****************************************************************************/ 366 367 ACPI_STATUS 368 DtCompileFacs ( 369 DT_FIELD **PFieldList) 370 { 371 DT_SUBTABLE *Subtable; 372 UINT8 *ReservedBuffer; 373 ACPI_STATUS Status; 374 UINT32 ReservedSize; 375 376 377 Status = DtCompileTable (PFieldList, AcpiDmTableInfoFacs, 378 &AslGbl_RootTable); 379 if (ACPI_FAILURE (Status)) 380 { 381 return (Status); 382 } 383 384 /* Large FACS reserved area at the end of the table */ 385 386 ReservedSize = (UINT32) sizeof (((ACPI_TABLE_FACS *) NULL)->Reserved1); 387 ReservedBuffer = UtLocalCalloc (ReservedSize); 388 389 DtCreateSubtable (ReservedBuffer, ReservedSize, &Subtable); 390 391 ACPI_FREE (ReservedBuffer); 392 DtInsertSubtable (AslGbl_RootTable, Subtable); 393 return (AE_OK); 394 } 395