1 /******************************************************************************
3 * Module Name: psutils - Parser miscellaneous utilities (Parser only)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <contrib/dev/acpica/include/acpi.h>
45 #include <contrib/dev/acpica/include/accommon.h>
46 #include <contrib/dev/acpica/include/acparser.h>
47 #include <contrib/dev/acpica/include/amlcode.h>
49 #define _COMPONENT ACPI_PARSER
50 ACPI_MODULE_NAME ("psutils")
53 /*******************************************************************************
55 * FUNCTION: AcpiPsCreateScopeOp
59 * RETURN: A new Scope object, null on failure
61 * DESCRIPTION: Create a Scope and associated namepath op with the root name
63 ******************************************************************************/
69 ACPI_PARSE_OBJECT *ScopeOp;
72 ScopeOp = AcpiPsAllocOp (AML_SCOPE_OP, Aml);
78 ScopeOp->Named.Name = ACPI_ROOT_NAME;
83 /*******************************************************************************
85 * FUNCTION: AcpiPsInitOp
87 * PARAMETERS: Op - A newly allocated Op object
88 * Opcode - Opcode to store in the Op
92 * DESCRIPTION: Initialize a parse (Op) object
94 ******************************************************************************/
98 ACPI_PARSE_OBJECT *Op,
101 ACPI_FUNCTION_ENTRY ();
104 Op->Common.DescriptorType = ACPI_DESC_TYPE_PARSER;
105 Op->Common.AmlOpcode = Opcode;
107 ACPI_DISASM_ONLY_MEMBERS (strncpy (Op->Common.AmlOpName,
108 (AcpiPsGetOpcodeInfo (Opcode))->Name,
109 sizeof (Op->Common.AmlOpName)));
113 /*******************************************************************************
115 * FUNCTION: AcpiPsAllocOp
117 * PARAMETERS: Opcode - Opcode that will be stored in the new Op
118 * Aml - Address of the opcode
120 * RETURN: Pointer to the new Op, null on failure
122 * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on
123 * opcode. A cache of opcodes is available for the pure
124 * GENERIC_OP, since this is by far the most commonly used.
126 ******************************************************************************/
133 ACPI_PARSE_OBJECT *Op;
134 const ACPI_OPCODE_INFO *OpInfo;
135 UINT8 Flags = ACPI_PARSEOP_GENERIC;
138 ACPI_FUNCTION_ENTRY ();
141 OpInfo = AcpiPsGetOpcodeInfo (Opcode);
143 /* Determine type of ParseOp required */
145 if (OpInfo->Flags & AML_DEFER)
147 Flags = ACPI_PARSEOP_DEFERRED;
149 else if (OpInfo->Flags & AML_NAMED)
151 Flags = ACPI_PARSEOP_NAMED_OBJECT;
153 else if (Opcode == AML_INT_BYTELIST_OP)
155 Flags = ACPI_PARSEOP_BYTELIST;
158 /* Allocate the minimum required size object */
160 if (Flags == ACPI_PARSEOP_GENERIC)
162 /* The generic op (default) is by far the most common (16 to 1) */
164 Op = AcpiOsAcquireObject (AcpiGbl_PsNodeCache);
168 /* Extended parseop */
170 Op = AcpiOsAcquireObject (AcpiGbl_PsNodeExtCache);
173 /* Initialize the Op */
177 AcpiPsInitOp (Op, Opcode);
178 Op->Common.Aml = Aml;
179 Op->Common.Flags = Flags;
186 /*******************************************************************************
188 * FUNCTION: AcpiPsFreeOp
190 * PARAMETERS: Op - Op to be freed
194 * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list
195 * or actually free it.
197 ******************************************************************************/
201 ACPI_PARSE_OBJECT *Op)
203 ACPI_FUNCTION_NAME (PsFreeOp);
206 if (Op->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP)
208 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
209 "Free retval op: %p\n", Op));
212 if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
214 (void) AcpiOsReleaseObject (AcpiGbl_PsNodeCache, Op);
218 (void) AcpiOsReleaseObject (AcpiGbl_PsNodeExtCache, Op);
223 /*******************************************************************************
225 * FUNCTION: Utility functions
227 * DESCRIPTION: Low level character and object functions
229 ******************************************************************************/
233 * Is "c" a namestring lead character?
236 AcpiPsIsLeadingChar (
239 return ((BOOLEAN) (c == '_' || (c >= 'A' && c <= 'Z')));
244 * Get op's name (4-byte name segment) or 0 if unnamed
248 ACPI_PARSE_OBJECT *Op)
251 /* The "generic" object has no name associated with it */
253 if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
258 /* Only the "Extended" parse objects have a name */
260 return (Op->Named.Name);
269 ACPI_PARSE_OBJECT *Op,
273 /* The "generic" object has no name associated with it */
275 if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
280 Op->Named.Name = name;