sys/contrib/dev/acpica/source/components/disassembler/dmdeferred.c

   1 /******************************************************************************
   2  *
   3  * Module Name: dmdeferred - Disassembly of deferred AML opcodes
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2017, Intel Corp.
   9  * All rights reserved.
  10  *
  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.
  25  *
  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.
  29  *
  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.
  42  */
  43
  44 #include "acpi.h"
  45 #include "accommon.h"
  46 #include "acdispat.h"
  47 #include "amlcode.h"
  48 #include "acdisasm.h"
  49 #include "acparser.h"
  50
  51 #define _COMPONENT          ACPI_CA_DISASSEMBLER
  52         ACPI_MODULE_NAME    ("dmdeferred")
  53
  54
  55 /* Local prototypes */
  56
  57 static ACPI_STATUS
  58 AcpiDmDeferredParse (
  59     ACPI_PARSE_OBJECT       *Op,
  60     UINT8                   *Aml,
  61     UINT32                  AmlLength);
  62
  63
  64 /******************************************************************************
  65  *
  66  * FUNCTION:    AcpiDmParseDeferredOps
  67  *
  68  * PARAMETERS:  Root                - Root of the parse tree
  69  *
  70  * RETURN:      Status
  71  *
  72  * DESCRIPTION: Parse the deferred opcodes (Methods, regions, etc.)
  73  *
  74  *****************************************************************************/
  75
  76 ACPI_STATUS
  77 AcpiDmParseDeferredOps (
  78     ACPI_PARSE_OBJECT       *Root)
  79 {
  80     const ACPI_OPCODE_INFO  *OpInfo;
  81     ACPI_PARSE_OBJECT       *Op = Root;
  82     ACPI_STATUS             Status;
  83
  84
  85     ACPI_FUNCTION_ENTRY ();
  86
  87
  88     /* Traverse the entire parse tree */
  89
  90     while (Op)
  91     {
  92         OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
  93         if (!(OpInfo->Flags & AML_DEFER))
  94         {
  95             Op = AcpiPsGetDepthNext (Root, Op);
  96             continue;
  97         }
  98
  99         /* Now we know we have a deferred opcode */
 100
 101         switch (Op->Common.AmlOpcode)
 102         {
 103         case AML_METHOD_OP:
 104         case AML_BUFFER_OP:
 105         case AML_PACKAGE_OP:
 106         case AML_VARIABLE_PACKAGE_OP:
 107
 108             Status = AcpiDmDeferredParse (
 109                 Op, Op->Named.Data, Op->Named.Length);
 110             if (ACPI_FAILURE (Status))
 111             {
 112                 return (Status);
 113             }
 114             break;
 115
 116         /* We don't need to do anything for these deferred opcodes */
 117
 118         case AML_REGION_OP:
 119         case AML_DATA_REGION_OP:
 120         case AML_CREATE_QWORD_FIELD_OP:
 121         case AML_CREATE_DWORD_FIELD_OP:
 122         case AML_CREATE_WORD_FIELD_OP:
 123         case AML_CREATE_BYTE_FIELD_OP:
 124         case AML_CREATE_BIT_FIELD_OP:
 125         case AML_CREATE_FIELD_OP:
 126         case AML_BANK_FIELD_OP:
 127
 128             break;
 129
 130         default:
 131
 132             ACPI_ERROR ((AE_INFO, "Unhandled deferred AML opcode [0x%.4X]",
 133                  Op->Common.AmlOpcode));
 134             break;
 135         }
 136
 137         Op = AcpiPsGetDepthNext (Root, Op);
 138     }
 139
 140     return (AE_OK);
 141 }
 142
 143
 144 /******************************************************************************
 145  *
 146  * FUNCTION:    AcpiDmDeferredParse
 147  *
 148  * PARAMETERS:  Op                  - Root Op of the deferred opcode
 149  *              Aml                 - Pointer to the raw AML
 150  *              AmlLength           - Length of the AML
 151  *
 152  * RETURN:      Status
 153  *
 154  * DESCRIPTION: Parse one deferred opcode
 155  *              (Methods, operation regions, etc.)
 156  *
 157  *****************************************************************************/
 158
 159 static ACPI_STATUS
 160 AcpiDmDeferredParse (
 161     ACPI_PARSE_OBJECT       *Op,
 162     UINT8                   *Aml,
 163     UINT32                  AmlLength)
 164 {
 165     ACPI_WALK_STATE         *WalkState;
 166     ACPI_STATUS             Status;
 167     ACPI_PARSE_OBJECT       *SearchOp;
 168     ACPI_PARSE_OBJECT       *StartOp;
 169     ACPI_PARSE_OBJECT       *NewRootOp;
 170     ACPI_PARSE_OBJECT       *ExtraOp;
 171
 172
 173     ACPI_FUNCTION_TRACE (DmDeferredParse);
 174
 175
 176     if (!Aml || !AmlLength)
 177     {
 178         return_ACPI_STATUS (AE_OK);
 179     }
 180
 181     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Parsing deferred opcode %s [%4.4s]\n",
 182         Op->Common.AmlOpName, (char *) &Op->Named.Name));
 183
 184     /* Need a new walk state to parse the AML */
 185
 186     WalkState = AcpiDsCreateWalkState (0, Op, NULL, NULL);
 187     if (!WalkState)
 188     {
 189         return_ACPI_STATUS (AE_NO_MEMORY);
 190     }
 191
 192     Status = AcpiDsInitAmlWalk (WalkState, Op, NULL, Aml,
 193         AmlLength, NULL, ACPI_IMODE_LOAD_PASS1);
 194     if (ACPI_FAILURE (Status))
 195     {
 196         return_ACPI_STATUS (Status);
 197     }
 198
 199     /* Parse the AML for this deferred opcode */
 200
 201     WalkState->ParseFlags &= ~ACPI_PARSE_DELETE_TREE;
 202     WalkState->ParseFlags |= ACPI_PARSE_DISASSEMBLE;
 203     Status = AcpiPsParseAml (WalkState);
 204
 205     StartOp = (Op->Common.Value.Arg)->Common.Next;
 206     SearchOp = StartOp;
 207     while (SearchOp)
 208     {
 209         SearchOp = AcpiPsGetDepthNext (StartOp, SearchOp);
 210     }
 211
 212     /*
 213      * For Buffer and Package opcodes, link the newly parsed subtree
 214      * into the main parse tree
 215      */
 216     switch (Op->Common.AmlOpcode)
 217     {
 218     case AML_BUFFER_OP:
 219     case AML_PACKAGE_OP:
 220     case AML_VARIABLE_PACKAGE_OP:
 221
 222         switch (Op->Common.AmlOpcode)
 223         {
 224         case AML_PACKAGE_OP:
 225
 226             ExtraOp = Op->Common.Value.Arg;
 227             NewRootOp = ExtraOp->Common.Next;
 228             ACPI_FREE (ExtraOp);
 229             break;
 230
 231         case AML_VARIABLE_PACKAGE_OP:
 232         case AML_BUFFER_OP:
 233         default:
 234
 235             NewRootOp = Op->Common.Value.Arg;
 236             break;
 237         }
 238
 239         Op->Common.Value.Arg = NewRootOp->Common.Value.Arg;
 240
 241         /* Must point all parents to the main tree */
 242
 243         StartOp = Op;
 244         SearchOp = StartOp;
 245         while (SearchOp)
 246         {
 247             if (SearchOp->Common.Parent == NewRootOp)
 248             {
 249                 SearchOp->Common.Parent = Op;
 250             }
 251
 252             SearchOp = AcpiPsGetDepthNext (StartOp, SearchOp);
 253         }
 254
 255         ACPI_FREE (NewRootOp);
 256         break;
 257
 258     default:
 259
 260         break;
 261     }
 262
 263     return_ACPI_STATUS (AE_OK);
 264 }