05699489adc86a99ee77a74868af3fa186cdda53
[reactos.git] / drivers / bus / acpi / acpica / parser / psutils.c
1 /******************************************************************************
2 *
3 * Module Name: psutils - Parser miscellaneous utilities (Parser only)
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 "acparser.h"
47 #include "amlcode.h"
48 #include "acconvert.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 UINT8 *Aml)
69 {
70 ACPI_PARSE_OBJECT *ScopeOp;
71
72
73 ScopeOp = AcpiPsAllocOp (AML_SCOPE_OP, Aml);
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 (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 * Aml - Address of the opcode
120 *
121 * RETURN: Pointer to the new Op, null on failure
122 *
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.
126 *
127 ******************************************************************************/
128
129 ACPI_PARSE_OBJECT*
130 AcpiPsAllocOp (
131 UINT16 Opcode,
132 UINT8 *Aml)
133 {
134 ACPI_PARSE_OBJECT *Op;
135 const ACPI_OPCODE_INFO *OpInfo;
136 UINT8 Flags = ACPI_PARSEOP_GENERIC;
137
138
139 ACPI_FUNCTION_ENTRY ();
140
141
142 OpInfo = AcpiPsGetOpcodeInfo (Opcode);
143
144 /* Determine type of ParseOp required */
145
146 if (OpInfo->Flags & AML_DEFER)
147 {
148 Flags = ACPI_PARSEOP_DEFERRED;
149 }
150 else if (OpInfo->Flags & AML_NAMED)
151 {
152 Flags = ACPI_PARSEOP_NAMED_OBJECT;
153 }
154 else if (Opcode == AML_INT_BYTELIST_OP)
155 {
156 Flags = ACPI_PARSEOP_BYTELIST;
157 }
158
159 /* Allocate the minimum required size object */
160
161 if (Flags == ACPI_PARSEOP_GENERIC)
162 {
163 /* The generic op (default) is by far the most common (16 to 1) */
164
165 Op = AcpiOsAcquireObject (AcpiGbl_PsNodeCache);
166 }
167 else
168 {
169 /* Extended parseop */
170
171 Op = AcpiOsAcquireObject (AcpiGbl_PsNodeExtCache);
172 }
173
174 /* Initialize the Op */
175
176 if (Op)
177 {
178 AcpiPsInitOp (Op, Opcode);
179 Op->Common.Aml = Aml;
180 Op->Common.Flags = Flags;
181 ASL_CV_CLEAR_OP_COMMENTS(Op);
182
183 if (Opcode == AML_SCOPE_OP)
184 {
185 AcpiGbl_CurrentScope = Op;
186 }
187 }
188
189 if (Gbl_CaptureComments)
190 {
191 ASL_CV_TRANSFER_COMMENTS (Op);
192 }
193
194 return (Op);
195 }
196
197
198 /*******************************************************************************
199 *
200 * FUNCTION: AcpiPsFreeOp
201 *
202 * PARAMETERS: Op - Op to be freed
203 *
204 * RETURN: None.
205 *
206 * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list
207 * or actually free it.
208 *
209 ******************************************************************************/
210
211 void
212 AcpiPsFreeOp (
213 ACPI_PARSE_OBJECT *Op)
214 {
215 ACPI_FUNCTION_NAME (PsFreeOp);
216
217
218 ASL_CV_CLEAR_OP_COMMENTS(Op);
219 if (Op->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP)
220 {
221 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
222 "Free retval op: %p\n", Op));
223 }
224
225 if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
226 {
227 (void) AcpiOsReleaseObject (AcpiGbl_PsNodeCache, Op);
228 }
229 else
230 {
231 (void) AcpiOsReleaseObject (AcpiGbl_PsNodeExtCache, Op);
232 }
233 }
234
235
236 /*******************************************************************************
237 *
238 * FUNCTION: Utility functions
239 *
240 * DESCRIPTION: Low level character and object functions
241 *
242 ******************************************************************************/
243
244
245 /*
246 * Is "c" a namestring lead character?
247 */
248 BOOLEAN
249 AcpiPsIsLeadingChar (
250 UINT32 c)
251 {
252 return ((BOOLEAN) (c == '_' || (c >= 'A' && c <= 'Z')));
253 }
254
255
256 /*
257 * Get op's name (4-byte name segment) or 0 if unnamed
258 */
259 UINT32
260 AcpiPsGetName (
261 ACPI_PARSE_OBJECT *Op)
262 {
263
264 /* The "generic" object has no name associated with it */
265
266 if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
267 {
268 return (0);
269 }
270
271 /* Only the "Extended" parse objects have a name */
272
273 return (Op->Named.Name);
274 }
275
276
277 /*
278 * Set op's name
279 */
280 void
281 AcpiPsSetName (
282 ACPI_PARSE_OBJECT *Op,
283 UINT32 name)
284 {
285
286 /* The "generic" object has no name associated with it */
287
288 if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
289 {
290 return;
291 }
292
293 Op->Named.Name = name;
294 }