1 /******************************************************************************
2 *
3 * Module Name: psutils - Parser miscellaneous utilities (Parser only)
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2014, 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
45 #include "acpi.h"
46 #include "accommon.h"
47 #include "acparser.h"
48 #include "amlcode.h"
49
50 #define _COMPONENT ACPI_PARSER
51 ACPI_MODULE_NAME ("psutils")
52
53
54 /*******************************************************************************
55 *
56 * FUNCTION: AcpiPsCreateScopeOp
57 *
58 * PARAMETERS: None
59 *
60 * RETURN: A new Scope object, null on failure
61 *
62 * DESCRIPTION: Create a Scope and associated namepath op with the root name
63 *
64 ******************************************************************************/
65
66 ACPI_PARSE_OBJECT *
67 AcpiPsCreateScopeOp (
68 void)
69 {
70 ACPI_PARSE_OBJECT *ScopeOp;
71
72
73 ScopeOp = AcpiPsAllocOp (AML_SCOPE_OP);
74 if (!ScopeOp)
75 {
76 return (NULL);
77 }
78
79 ScopeOp->Named.Name = ACPI_ROOT_NAME;
80 return (ScopeOp);
81 }
82
83
84 /*******************************************************************************
85 *
86 * FUNCTION: AcpiPsInitOp
87 *
88 * PARAMETERS: Op - A newly allocated Op object
89 * Opcode - Opcode to store in the Op
90 *
91 * RETURN: None
92 *
93 * DESCRIPTION: Initialize a parse (Op) object
94 *
95 ******************************************************************************/
96
97 void
98 AcpiPsInitOp (
99 ACPI_PARSE_OBJECT *Op,
100 UINT16 Opcode)
101 {
102 ACPI_FUNCTION_ENTRY ();
103
104
105 Op->Common.DescriptorType = ACPI_DESC_TYPE_PARSER;
106 Op->Common.AmlOpcode = Opcode;
107
108 ACPI_DISASM_ONLY_MEMBERS (ACPI_STRNCPY (Op->Common.AmlOpName,
109 (AcpiPsGetOpcodeInfo (Opcode))->Name,
110 sizeof (Op->Common.AmlOpName)));
111 }
112
113
114 /*******************************************************************************
115 *
116 * FUNCTION: AcpiPsAllocOp
117 *
118 * PARAMETERS: Opcode - Opcode that will be stored in the new Op
119 *
120 * RETURN: Pointer to the new Op, null on failure
121 *
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.
125 *
126 ******************************************************************************/
127
128 ACPI_PARSE_OBJECT*
129 AcpiPsAllocOp (
130 UINT16 Opcode)
131 {
132 ACPI_PARSE_OBJECT *Op;
133 const ACPI_OPCODE_INFO *OpInfo;
134 UINT8 Flags = ACPI_PARSEOP_GENERIC;
135
136
137 ACPI_FUNCTION_ENTRY ();
138
139
140 OpInfo = AcpiPsGetOpcodeInfo (Opcode);
141
142 /* Determine type of ParseOp required */
143
144 if (OpInfo->Flags & AML_DEFER)
145 {
146 Flags = ACPI_PARSEOP_DEFERRED;
147 }
148 else if (OpInfo->Flags & AML_NAMED)
149 {
150 Flags = ACPI_PARSEOP_NAMED;
151 }
152 else if (Opcode == AML_INT_BYTELIST_OP)
153 {
154 Flags = ACPI_PARSEOP_BYTELIST;
155 }
156
157 /* Allocate the minimum required size object */
158
159 if (Flags == ACPI_PARSEOP_GENERIC)
160 {
161 /* The generic op (default) is by far the most common (16 to 1) */
162
163 Op = AcpiOsAcquireObject (AcpiGbl_PsNodeCache);
164 }
165 else
166 {
167 /* Extended parseop */
168
169 Op = AcpiOsAcquireObject (AcpiGbl_PsNodeExtCache);
170 }
171
172 /* Initialize the Op */
173
174 if (Op)
175 {
176 AcpiPsInitOp (Op, Opcode);
177 Op->Common.Flags = Flags;
178 }
179
180 return (Op);
181 }
182
183
184 /*******************************************************************************
185 *
186 * FUNCTION: AcpiPsFreeOp
187 *
188 * PARAMETERS: Op - Op to be freed
189 *
190 * RETURN: None.
191 *
192 * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list
193 * or actually free it.
194 *
195 ******************************************************************************/
196
197 void
198 AcpiPsFreeOp (
199 ACPI_PARSE_OBJECT *Op)
200 {
201 ACPI_FUNCTION_NAME (PsFreeOp);
202
203
204 if (Op->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP)
205 {
206 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Free retval op: %p\n", Op));
207 }
208
209 if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
210 {
211 (void) AcpiOsReleaseObject (AcpiGbl_PsNodeCache, Op);
212 }
213 else
214 {
215 (void) AcpiOsReleaseObject (AcpiGbl_PsNodeExtCache, Op);
216 }
217 }
218
219
220 /*******************************************************************************
221 *
222 * FUNCTION: Utility functions
223 *
224 * DESCRIPTION: Low level character and object functions
225 *
226 ******************************************************************************/
227
228
229 /*
230 * Is "c" a namestring lead character?
231 */
232 BOOLEAN
233 AcpiPsIsLeadingChar (
234 UINT32 c)
235 {
236 return ((BOOLEAN) (c == '_' || (c >= 'A' && c <= 'Z')));
237 }
238
239
240 /*
241 * Get op's name (4-byte name segment) or 0 if unnamed
242 */
243 UINT32
244 AcpiPsGetName (
245 ACPI_PARSE_OBJECT *Op)
246 {
247
248 /* The "generic" object has no name associated with it */
249
250 if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
251 {
252 return (0);
253 }
254
255 /* Only the "Extended" parse objects have a name */
256
257 return (Op->Named.Name);
258 }
259
260
261 /*
262 * Set op's name
263 */
264 void
265 AcpiPsSetName (
266 ACPI_PARSE_OBJECT *Op,
267 UINT32 name)
268 {
269
270 /* The "generic" object has no name associated with it */
271
272 if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
273 {
274 return;
275 }
276
277 Op->Named.Name = name;
278 }