1 /****************************************************************************** 2 * 3 * Module Name: dmdeferred - Disassembly of deferred AML opcodes 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2020, 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 #include <contrib/dev/acpica/include/acpi.h> 153 #include <contrib/dev/acpica/include/accommon.h> 154 #include <contrib/dev/acpica/include/acdispat.h> 155 #include <contrib/dev/acpica/include/amlcode.h> 156 #include <contrib/dev/acpica/include/acdisasm.h> 157 #include <contrib/dev/acpica/include/acparser.h> 158 159 #define _COMPONENT ACPI_CA_DISASSEMBLER 160 ACPI_MODULE_NAME ("dmdeferred") 161 162 163 /* Local prototypes */ 164 165 static ACPI_STATUS 166 AcpiDmDeferredParse ( 167 ACPI_PARSE_OBJECT *Op, 168 UINT8 *Aml, 169 UINT32 AmlLength); 170 171 172 /****************************************************************************** 173 * 174 * FUNCTION: AcpiDmParseDeferredOps 175 * 176 * PARAMETERS: Root - Root of the parse tree 177 * 178 * RETURN: Status 179 * 180 * DESCRIPTION: Parse the deferred opcodes (Methods, regions, etc.) 181 * 182 *****************************************************************************/ 183 184 ACPI_STATUS 185 AcpiDmParseDeferredOps ( 186 ACPI_PARSE_OBJECT *Root) 187 { 188 const ACPI_OPCODE_INFO *OpInfo; 189 ACPI_PARSE_OBJECT *Op = Root; 190 ACPI_STATUS Status; 191 192 193 ACPI_FUNCTION_TRACE (DmParseDeferredOps); 194 195 196 /* Traverse the entire parse tree */ 197 198 while (Op) 199 { 200 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode); 201 if (!(OpInfo->Flags & AML_DEFER)) 202 { 203 Op = AcpiPsGetDepthNext (Root, Op); 204 continue; 205 } 206 207 /* Now we know we have a deferred opcode */ 208 209 switch (Op->Common.AmlOpcode) 210 { 211 case AML_METHOD_OP: 212 case AML_BUFFER_OP: 213 case AML_PACKAGE_OP: 214 case AML_VARIABLE_PACKAGE_OP: 215 216 Status = AcpiDmDeferredParse ( 217 Op, Op->Named.Data, Op->Named.Length); 218 if (ACPI_FAILURE (Status)) 219 { 220 return_ACPI_STATUS (Status); 221 } 222 break; 223 224 /* We don't need to do anything for these deferred opcodes */ 225 226 case AML_REGION_OP: 227 case AML_DATA_REGION_OP: 228 case AML_CREATE_QWORD_FIELD_OP: 229 case AML_CREATE_DWORD_FIELD_OP: 230 case AML_CREATE_WORD_FIELD_OP: 231 case AML_CREATE_BYTE_FIELD_OP: 232 case AML_CREATE_BIT_FIELD_OP: 233 case AML_CREATE_FIELD_OP: 234 case AML_BANK_FIELD_OP: 235 236 break; 237 238 default: 239 240 ACPI_ERROR ((AE_INFO, "Unhandled deferred AML opcode [0x%.4X]", 241 Op->Common.AmlOpcode)); 242 break; 243 } 244 245 Op = AcpiPsGetDepthNext (Root, Op); 246 } 247 248 return_ACPI_STATUS (AE_OK); 249 } 250 251 252 /****************************************************************************** 253 * 254 * FUNCTION: AcpiDmDeferredParse 255 * 256 * PARAMETERS: Op - Root Op of the deferred opcode 257 * Aml - Pointer to the raw AML 258 * AmlLength - Length of the AML 259 * 260 * RETURN: Status 261 * 262 * DESCRIPTION: Parse one deferred opcode 263 * (Methods, operation regions, etc.) 264 * 265 *****************************************************************************/ 266 267 static ACPI_STATUS 268 AcpiDmDeferredParse ( 269 ACPI_PARSE_OBJECT *Op, 270 UINT8 *Aml, 271 UINT32 AmlLength) 272 { 273 ACPI_WALK_STATE *WalkState; 274 ACPI_STATUS Status; 275 ACPI_PARSE_OBJECT *SearchOp; 276 ACPI_PARSE_OBJECT *StartOp; 277 ACPI_PARSE_OBJECT *NewRootOp; 278 ACPI_PARSE_OBJECT *ExtraOp; 279 280 281 ACPI_FUNCTION_TRACE (DmDeferredParse); 282 283 284 if (!Aml || !AmlLength) 285 { 286 return_ACPI_STATUS (AE_OK); 287 } 288 289 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Parsing deferred opcode %s [%4.4s]\n", 290 Op->Common.AmlOpName, (char *) &Op->Named.Name)); 291 292 /* Need a new walk state to parse the AML */ 293 294 WalkState = AcpiDsCreateWalkState (0, Op, NULL, NULL); 295 if (!WalkState) 296 { 297 return_ACPI_STATUS (AE_NO_MEMORY); 298 } 299 300 Status = AcpiDsInitAmlWalk (WalkState, Op, NULL, Aml, 301 AmlLength, NULL, ACPI_IMODE_LOAD_PASS1); 302 if (ACPI_FAILURE (Status)) 303 { 304 return_ACPI_STATUS (Status); 305 } 306 307 /* Parse the AML for this deferred opcode */ 308 309 WalkState->ParseFlags &= ~ACPI_PARSE_DELETE_TREE; 310 WalkState->ParseFlags |= ACPI_PARSE_DISASSEMBLE; 311 Status = AcpiPsParseAml (WalkState); 312 if (ACPI_FAILURE (Status)) 313 { 314 return_ACPI_STATUS(Status); 315 } 316 317 StartOp = (Op->Common.Value.Arg)->Common.Next; 318 SearchOp = StartOp; 319 while (SearchOp) 320 { 321 SearchOp = AcpiPsGetDepthNext (StartOp, SearchOp); 322 } 323 324 /* 325 * For Buffer and Package opcodes, link the newly parsed subtree 326 * into the main parse tree 327 */ 328 switch (Op->Common.AmlOpcode) 329 { 330 case AML_BUFFER_OP: 331 case AML_PACKAGE_OP: 332 case AML_VARIABLE_PACKAGE_OP: 333 334 switch (Op->Common.AmlOpcode) 335 { 336 case AML_PACKAGE_OP: 337 338 ExtraOp = Op->Common.Value.Arg; 339 NewRootOp = ExtraOp->Common.Next; 340 ACPI_FREE (ExtraOp); 341 break; 342 343 case AML_VARIABLE_PACKAGE_OP: 344 case AML_BUFFER_OP: 345 default: 346 347 NewRootOp = Op->Common.Value.Arg; 348 break; 349 } 350 351 Op->Common.Value.Arg = NewRootOp->Common.Value.Arg; 352 353 /* Must point all parents to the main tree */ 354 355 StartOp = Op; 356 SearchOp = StartOp; 357 while (SearchOp) 358 { 359 if (SearchOp->Common.Parent == NewRootOp) 360 { 361 SearchOp->Common.Parent = Op; 362 } 363 364 SearchOp = AcpiPsGetDepthNext (StartOp, SearchOp); 365 } 366 367 ACPI_FREE (NewRootOp); 368 break; 369 370 default: 371 372 break; 373 } 374 375 return_ACPI_STATUS (AE_OK); 376 } 377