1 /******************************************************************************
3 * Module Name: psutils - Parser miscellaneous utilities (Parser only)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2017, 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.
48 #include "acconvert.h"
50 #define _COMPONENT ACPI_PARSER
51 ACPI_MODULE_NAME ("psutils")
54 /*******************************************************************************
56 * FUNCTION: AcpiPsCreateScopeOp
60 * RETURN: A new Scope object, null on failure
62 * DESCRIPTION: Create a Scope and associated namepath op with the root name
64 ******************************************************************************/
70 ACPI_PARSE_OBJECT
*ScopeOp
;
73 ScopeOp
= AcpiPsAllocOp (AML_SCOPE_OP
, Aml
);
79 ScopeOp
->Named
.Name
= ACPI_ROOT_NAME
;
84 /*******************************************************************************
86 * FUNCTION: AcpiPsInitOp
88 * PARAMETERS: Op - A newly allocated Op object
89 * Opcode - Opcode to store in the Op
93 * DESCRIPTION: Initialize a parse (Op) object
95 ******************************************************************************/
99 ACPI_PARSE_OBJECT
*Op
,
102 ACPI_FUNCTION_ENTRY ();
105 Op
->Common
.DescriptorType
= ACPI_DESC_TYPE_PARSER
;
106 Op
->Common
.AmlOpcode
= Opcode
;
108 ACPI_DISASM_ONLY_MEMBERS (AcpiUtSafeStrncpy (Op
->Common
.AmlOpName
,
109 (AcpiPsGetOpcodeInfo (Opcode
))->Name
,
110 sizeof (Op
->Common
.AmlOpName
)));
114 /*******************************************************************************
116 * FUNCTION: AcpiPsAllocOp
118 * PARAMETERS: Opcode - Opcode that will be stored in the new Op
119 * Aml - Address of the opcode
121 * RETURN: Pointer to the new Op, null on failure
123 * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on
124 * opcode. A cache of opcodes is available for the pure
125 * GENERIC_OP, since this is by far the most commonly used.
127 ******************************************************************************/
134 ACPI_PARSE_OBJECT
*Op
;
135 const ACPI_OPCODE_INFO
*OpInfo
;
136 UINT8 Flags
= ACPI_PARSEOP_GENERIC
;
139 ACPI_FUNCTION_ENTRY ();
142 OpInfo
= AcpiPsGetOpcodeInfo (Opcode
);
144 /* Determine type of ParseOp required */
146 if (OpInfo
->Flags
& AML_DEFER
)
148 Flags
= ACPI_PARSEOP_DEFERRED
;
150 else if (OpInfo
->Flags
& AML_NAMED
)
152 Flags
= ACPI_PARSEOP_NAMED_OBJECT
;
154 else if (Opcode
== AML_INT_BYTELIST_OP
)
156 Flags
= ACPI_PARSEOP_BYTELIST
;
159 /* Allocate the minimum required size object */
161 if (Flags
== ACPI_PARSEOP_GENERIC
)
163 /* The generic op (default) is by far the most common (16 to 1) */
165 Op
= AcpiOsAcquireObject (AcpiGbl_PsNodeCache
);
169 /* Extended parseop */
171 Op
= AcpiOsAcquireObject (AcpiGbl_PsNodeExtCache
);
174 /* Initialize the Op */
178 AcpiPsInitOp (Op
, Opcode
);
179 Op
->Common
.Aml
= Aml
;
180 Op
->Common
.Flags
= Flags
;
181 ASL_CV_CLEAR_OP_COMMENTS(Op
);
183 if (Opcode
== AML_SCOPE_OP
)
185 AcpiGbl_CurrentScope
= Op
;
188 if (AcpiGbl_CaptureComments
)
190 ASL_CV_TRANSFER_COMMENTS (Op
);
198 /*******************************************************************************
200 * FUNCTION: AcpiPsFreeOp
202 * PARAMETERS: Op - Op to be freed
206 * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list
207 * or actually free it.
209 ******************************************************************************/
213 ACPI_PARSE_OBJECT
*Op
)
215 ACPI_FUNCTION_NAME (PsFreeOp
);
218 ASL_CV_CLEAR_OP_COMMENTS(Op
);
219 if (Op
->Common
.AmlOpcode
== AML_INT_RETURN_VALUE_OP
)
221 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS
,
222 "Free retval op: %p\n", Op
));
225 if (Op
->Common
.Flags
& ACPI_PARSEOP_GENERIC
)
227 (void) AcpiOsReleaseObject (AcpiGbl_PsNodeCache
, Op
);
231 (void) AcpiOsReleaseObject (AcpiGbl_PsNodeExtCache
, Op
);
236 /*******************************************************************************
238 * FUNCTION: Utility functions
240 * DESCRIPTION: Low level character and object functions
242 ******************************************************************************/
246 * Is "c" a namestring lead character?
249 AcpiPsIsLeadingChar (
252 return ((BOOLEAN
) (c
== '_' || (c
>= 'A' && c
<= 'Z')));
257 * Get op's name (4-byte name segment) or 0 if unnamed
261 ACPI_PARSE_OBJECT
*Op
)
264 /* The "generic" object has no name associated with it */
266 if (Op
->Common
.Flags
& ACPI_PARSEOP_GENERIC
)
271 /* Only the "Extended" parse objects have a name */
273 return (Op
->Named
.Name
);
282 ACPI_PARSE_OBJECT
*Op
,
286 /* The "generic" object has no name associated with it */
288 if (Op
->Common
.Flags
& ACPI_PARSEOP_GENERIC
)
293 Op
->Named
.Name
= name
;