psutils.c revision 1.1.1.2.2.2 1 1.1.1.2.2.2 bouyer /******************************************************************************
2 1.1.1.2.2.2 bouyer *
3 1.1.1.2.2.2 bouyer * Module Name: psutils - Parser miscellaneous utilities (Parser only)
4 1.1.1.2.2.2 bouyer *
5 1.1.1.2.2.2 bouyer *****************************************************************************/
6 1.1.1.2.2.2 bouyer
7 1.1.1.2.2.2 bouyer /*
8 1.1.1.2.2.2 bouyer * Copyright (C) 2000 - 2011, Intel Corp.
9 1.1.1.2.2.2 bouyer * All rights reserved.
10 1.1.1.2.2.2 bouyer *
11 1.1.1.2.2.2 bouyer * Redistribution and use in source and binary forms, with or without
12 1.1.1.2.2.2 bouyer * modification, are permitted provided that the following conditions
13 1.1.1.2.2.2 bouyer * are met:
14 1.1.1.2.2.2 bouyer * 1. Redistributions of source code must retain the above copyright
15 1.1.1.2.2.2 bouyer * notice, this list of conditions, and the following disclaimer,
16 1.1.1.2.2.2 bouyer * without modification.
17 1.1.1.2.2.2 bouyer * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.1.1.2.2.2 bouyer * substantially similar to the "NO WARRANTY" disclaimer below
19 1.1.1.2.2.2 bouyer * ("Disclaimer") and any redistribution must be conditioned upon
20 1.1.1.2.2.2 bouyer * including a substantially similar Disclaimer requirement for further
21 1.1.1.2.2.2 bouyer * binary redistribution.
22 1.1.1.2.2.2 bouyer * 3. Neither the names of the above-listed copyright holders nor the names
23 1.1.1.2.2.2 bouyer * of any contributors may be used to endorse or promote products derived
24 1.1.1.2.2.2 bouyer * from this software without specific prior written permission.
25 1.1.1.2.2.2 bouyer *
26 1.1.1.2.2.2 bouyer * Alternatively, this software may be distributed under the terms of the
27 1.1.1.2.2.2 bouyer * GNU General Public License ("GPL") version 2 as published by the Free
28 1.1.1.2.2.2 bouyer * Software Foundation.
29 1.1.1.2.2.2 bouyer *
30 1.1.1.2.2.2 bouyer * NO WARRANTY
31 1.1.1.2.2.2 bouyer * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.1.1.2.2.2 bouyer * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.1.1.2.2.2 bouyer * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.1.1.2.2.2 bouyer * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.1.1.2.2.2 bouyer * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.1.1.2.2.2 bouyer * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.1.1.2.2.2 bouyer * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.1.1.2.2.2 bouyer * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.1.1.2.2.2 bouyer * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.1.1.2.2.2 bouyer * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.1.1.2.2.2 bouyer * POSSIBILITY OF SUCH DAMAGES.
42 1.1.1.2.2.2 bouyer */
43 1.1.1.2.2.2 bouyer
44 1.1.1.2.2.2 bouyer
45 1.1.1.2.2.2 bouyer #include "acpi.h"
46 1.1.1.2.2.2 bouyer #include "accommon.h"
47 1.1.1.2.2.2 bouyer #include "acparser.h"
48 1.1.1.2.2.2 bouyer #include "amlcode.h"
49 1.1.1.2.2.2 bouyer
50 1.1.1.2.2.2 bouyer #define _COMPONENT ACPI_PARSER
51 1.1.1.2.2.2 bouyer ACPI_MODULE_NAME ("psutils")
52 1.1.1.2.2.2 bouyer
53 1.1.1.2.2.2 bouyer
54 1.1.1.2.2.2 bouyer /*******************************************************************************
55 1.1.1.2.2.2 bouyer *
56 1.1.1.2.2.2 bouyer * FUNCTION: AcpiPsCreateScopeOp
57 1.1.1.2.2.2 bouyer *
58 1.1.1.2.2.2 bouyer * PARAMETERS: None
59 1.1.1.2.2.2 bouyer *
60 1.1.1.2.2.2 bouyer * RETURN: A new Scope object, null on failure
61 1.1.1.2.2.2 bouyer *
62 1.1.1.2.2.2 bouyer * DESCRIPTION: Create a Scope and associated namepath op with the root name
63 1.1.1.2.2.2 bouyer *
64 1.1.1.2.2.2 bouyer ******************************************************************************/
65 1.1.1.2.2.2 bouyer
66 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *
67 1.1.1.2.2.2 bouyer AcpiPsCreateScopeOp (
68 1.1.1.2.2.2 bouyer void)
69 1.1.1.2.2.2 bouyer {
70 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *ScopeOp;
71 1.1.1.2.2.2 bouyer
72 1.1.1.2.2.2 bouyer
73 1.1.1.2.2.2 bouyer ScopeOp = AcpiPsAllocOp (AML_SCOPE_OP);
74 1.1.1.2.2.2 bouyer if (!ScopeOp)
75 1.1.1.2.2.2 bouyer {
76 1.1.1.2.2.2 bouyer return (NULL);
77 1.1.1.2.2.2 bouyer }
78 1.1.1.2.2.2 bouyer
79 1.1.1.2.2.2 bouyer ScopeOp->Named.Name = ACPI_ROOT_NAME;
80 1.1.1.2.2.2 bouyer return (ScopeOp);
81 1.1.1.2.2.2 bouyer }
82 1.1.1.2.2.2 bouyer
83 1.1.1.2.2.2 bouyer
84 1.1.1.2.2.2 bouyer /*******************************************************************************
85 1.1.1.2.2.2 bouyer *
86 1.1.1.2.2.2 bouyer * FUNCTION: AcpiPsInitOp
87 1.1.1.2.2.2 bouyer *
88 1.1.1.2.2.2 bouyer * PARAMETERS: Op - A newly allocated Op object
89 1.1.1.2.2.2 bouyer * Opcode - Opcode to store in the Op
90 1.1.1.2.2.2 bouyer *
91 1.1.1.2.2.2 bouyer * RETURN: None
92 1.1.1.2.2.2 bouyer *
93 1.1.1.2.2.2 bouyer * DESCRIPTION: Initialize a parse (Op) object
94 1.1.1.2.2.2 bouyer *
95 1.1.1.2.2.2 bouyer ******************************************************************************/
96 1.1.1.2.2.2 bouyer
97 1.1.1.2.2.2 bouyer void
98 1.1.1.2.2.2 bouyer AcpiPsInitOp (
99 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op,
100 1.1.1.2.2.2 bouyer UINT16 Opcode)
101 1.1.1.2.2.2 bouyer {
102 1.1.1.2.2.2 bouyer ACPI_FUNCTION_ENTRY ();
103 1.1.1.2.2.2 bouyer
104 1.1.1.2.2.2 bouyer
105 1.1.1.2.2.2 bouyer Op->Common.DescriptorType = ACPI_DESC_TYPE_PARSER;
106 1.1.1.2.2.2 bouyer Op->Common.AmlOpcode = Opcode;
107 1.1.1.2.2.2 bouyer
108 1.1.1.2.2.2 bouyer ACPI_DISASM_ONLY_MEMBERS (ACPI_STRNCPY (Op->Common.AmlOpName,
109 1.1.1.2.2.2 bouyer (AcpiPsGetOpcodeInfo (Opcode))->Name,
110 1.1.1.2.2.2 bouyer sizeof (Op->Common.AmlOpName)));
111 1.1.1.2.2.2 bouyer }
112 1.1.1.2.2.2 bouyer
113 1.1.1.2.2.2 bouyer
114 1.1.1.2.2.2 bouyer /*******************************************************************************
115 1.1.1.2.2.2 bouyer *
116 1.1.1.2.2.2 bouyer * FUNCTION: AcpiPsAllocOp
117 1.1.1.2.2.2 bouyer *
118 1.1.1.2.2.2 bouyer * PARAMETERS: Opcode - Opcode that will be stored in the new Op
119 1.1.1.2.2.2 bouyer *
120 1.1.1.2.2.2 bouyer * RETURN: Pointer to the new Op, null on failure
121 1.1.1.2.2.2 bouyer *
122 1.1.1.2.2.2 bouyer * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on
123 1.1.1.2.2.2 bouyer * opcode. A cache of opcodes is available for the pure
124 1.1.1.2.2.2 bouyer * GENERIC_OP, since this is by far the most commonly used.
125 1.1.1.2.2.2 bouyer *
126 1.1.1.2.2.2 bouyer ******************************************************************************/
127 1.1.1.2.2.2 bouyer
128 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT*
129 1.1.1.2.2.2 bouyer AcpiPsAllocOp (
130 1.1.1.2.2.2 bouyer UINT16 Opcode)
131 1.1.1.2.2.2 bouyer {
132 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op;
133 1.1.1.2.2.2 bouyer const ACPI_OPCODE_INFO *OpInfo;
134 1.1.1.2.2.2 bouyer UINT8 Flags = ACPI_PARSEOP_GENERIC;
135 1.1.1.2.2.2 bouyer
136 1.1.1.2.2.2 bouyer
137 1.1.1.2.2.2 bouyer ACPI_FUNCTION_ENTRY ();
138 1.1.1.2.2.2 bouyer
139 1.1.1.2.2.2 bouyer
140 1.1.1.2.2.2 bouyer OpInfo = AcpiPsGetOpcodeInfo (Opcode);
141 1.1.1.2.2.2 bouyer
142 1.1.1.2.2.2 bouyer /* Determine type of ParseOp required */
143 1.1.1.2.2.2 bouyer
144 1.1.1.2.2.2 bouyer if (OpInfo->Flags & AML_DEFER)
145 1.1.1.2.2.2 bouyer {
146 1.1.1.2.2.2 bouyer Flags = ACPI_PARSEOP_DEFERRED;
147 1.1.1.2.2.2 bouyer }
148 1.1.1.2.2.2 bouyer else if (OpInfo->Flags & AML_NAMED)
149 1.1.1.2.2.2 bouyer {
150 1.1.1.2.2.2 bouyer Flags = ACPI_PARSEOP_NAMED;
151 1.1.1.2.2.2 bouyer }
152 1.1.1.2.2.2 bouyer else if (Opcode == AML_INT_BYTELIST_OP)
153 1.1.1.2.2.2 bouyer {
154 1.1.1.2.2.2 bouyer Flags = ACPI_PARSEOP_BYTELIST;
155 1.1.1.2.2.2 bouyer }
156 1.1.1.2.2.2 bouyer
157 1.1.1.2.2.2 bouyer /* Allocate the minimum required size object */
158 1.1.1.2.2.2 bouyer
159 1.1.1.2.2.2 bouyer if (Flags == ACPI_PARSEOP_GENERIC)
160 1.1.1.2.2.2 bouyer {
161 1.1.1.2.2.2 bouyer /* The generic op (default) is by far the most common (16 to 1) */
162 1.1.1.2.2.2 bouyer
163 1.1.1.2.2.2 bouyer Op = AcpiOsAcquireObject (AcpiGbl_PsNodeCache);
164 1.1.1.2.2.2 bouyer }
165 1.1.1.2.2.2 bouyer else
166 1.1.1.2.2.2 bouyer {
167 1.1.1.2.2.2 bouyer /* Extended parseop */
168 1.1.1.2.2.2 bouyer
169 1.1.1.2.2.2 bouyer Op = AcpiOsAcquireObject (AcpiGbl_PsNodeExtCache);
170 1.1.1.2.2.2 bouyer }
171 1.1.1.2.2.2 bouyer
172 1.1.1.2.2.2 bouyer /* Initialize the Op */
173 1.1.1.2.2.2 bouyer
174 1.1.1.2.2.2 bouyer if (Op)
175 1.1.1.2.2.2 bouyer {
176 1.1.1.2.2.2 bouyer AcpiPsInitOp (Op, Opcode);
177 1.1.1.2.2.2 bouyer Op->Common.Flags = Flags;
178 1.1.1.2.2.2 bouyer }
179 1.1.1.2.2.2 bouyer
180 1.1.1.2.2.2 bouyer return (Op);
181 1.1.1.2.2.2 bouyer }
182 1.1.1.2.2.2 bouyer
183 1.1.1.2.2.2 bouyer
184 1.1.1.2.2.2 bouyer /*******************************************************************************
185 1.1.1.2.2.2 bouyer *
186 1.1.1.2.2.2 bouyer * FUNCTION: AcpiPsFreeOp
187 1.1.1.2.2.2 bouyer *
188 1.1.1.2.2.2 bouyer * PARAMETERS: Op - Op to be freed
189 1.1.1.2.2.2 bouyer *
190 1.1.1.2.2.2 bouyer * RETURN: None.
191 1.1.1.2.2.2 bouyer *
192 1.1.1.2.2.2 bouyer * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list
193 1.1.1.2.2.2 bouyer * or actually free it.
194 1.1.1.2.2.2 bouyer *
195 1.1.1.2.2.2 bouyer ******************************************************************************/
196 1.1.1.2.2.2 bouyer
197 1.1.1.2.2.2 bouyer void
198 1.1.1.2.2.2 bouyer AcpiPsFreeOp (
199 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op)
200 1.1.1.2.2.2 bouyer {
201 1.1.1.2.2.2 bouyer ACPI_FUNCTION_NAME (PsFreeOp);
202 1.1.1.2.2.2 bouyer
203 1.1.1.2.2.2 bouyer
204 1.1.1.2.2.2 bouyer if (Op->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP)
205 1.1.1.2.2.2 bouyer {
206 1.1.1.2.2.2 bouyer ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Free retval op: %p\n", Op));
207 1.1.1.2.2.2 bouyer }
208 1.1.1.2.2.2 bouyer
209 1.1.1.2.2.2 bouyer if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
210 1.1.1.2.2.2 bouyer {
211 1.1.1.2.2.2 bouyer (void) AcpiOsReleaseObject (AcpiGbl_PsNodeCache, Op);
212 1.1.1.2.2.2 bouyer }
213 1.1.1.2.2.2 bouyer else
214 1.1.1.2.2.2 bouyer {
215 1.1.1.2.2.2 bouyer (void) AcpiOsReleaseObject (AcpiGbl_PsNodeExtCache, Op);
216 1.1.1.2.2.2 bouyer }
217 1.1.1.2.2.2 bouyer }
218 1.1.1.2.2.2 bouyer
219 1.1.1.2.2.2 bouyer
220 1.1.1.2.2.2 bouyer /*******************************************************************************
221 1.1.1.2.2.2 bouyer *
222 1.1.1.2.2.2 bouyer * FUNCTION: Utility functions
223 1.1.1.2.2.2 bouyer *
224 1.1.1.2.2.2 bouyer * DESCRIPTION: Low level character and object functions
225 1.1.1.2.2.2 bouyer *
226 1.1.1.2.2.2 bouyer ******************************************************************************/
227 1.1.1.2.2.2 bouyer
228 1.1.1.2.2.2 bouyer
229 1.1.1.2.2.2 bouyer /*
230 1.1.1.2.2.2 bouyer * Is "c" a namestring lead character?
231 1.1.1.2.2.2 bouyer */
232 1.1.1.2.2.2 bouyer BOOLEAN
233 1.1.1.2.2.2 bouyer AcpiPsIsLeadingChar (
234 1.1.1.2.2.2 bouyer UINT32 c)
235 1.1.1.2.2.2 bouyer {
236 1.1.1.2.2.2 bouyer return ((BOOLEAN) (c == '_' || (c >= 'A' && c <= 'Z')));
237 1.1.1.2.2.2 bouyer }
238 1.1.1.2.2.2 bouyer
239 1.1.1.2.2.2 bouyer
240 1.1.1.2.2.2 bouyer /*
241 1.1.1.2.2.2 bouyer * Is "c" a namestring prefix character?
242 1.1.1.2.2.2 bouyer */
243 1.1.1.2.2.2 bouyer BOOLEAN
244 1.1.1.2.2.2 bouyer AcpiPsIsPrefixChar (
245 1.1.1.2.2.2 bouyer UINT32 c)
246 1.1.1.2.2.2 bouyer {
247 1.1.1.2.2.2 bouyer return ((BOOLEAN) (c == '\\' || c == '^'));
248 1.1.1.2.2.2 bouyer }
249 1.1.1.2.2.2 bouyer
250 1.1.1.2.2.2 bouyer
251 1.1.1.2.2.2 bouyer /*
252 1.1.1.2.2.2 bouyer * Get op's name (4-byte name segment) or 0 if unnamed
253 1.1.1.2.2.2 bouyer */
254 1.1.1.2.2.2 bouyer UINT32
255 1.1.1.2.2.2 bouyer AcpiPsGetName (
256 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op)
257 1.1.1.2.2.2 bouyer {
258 1.1.1.2.2.2 bouyer
259 1.1.1.2.2.2 bouyer /* The "generic" object has no name associated with it */
260 1.1.1.2.2.2 bouyer
261 1.1.1.2.2.2 bouyer if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
262 1.1.1.2.2.2 bouyer {
263 1.1.1.2.2.2 bouyer return (0);
264 1.1.1.2.2.2 bouyer }
265 1.1.1.2.2.2 bouyer
266 1.1.1.2.2.2 bouyer /* Only the "Extended" parse objects have a name */
267 1.1.1.2.2.2 bouyer
268 1.1.1.2.2.2 bouyer return (Op->Named.Name);
269 1.1.1.2.2.2 bouyer }
270 1.1.1.2.2.2 bouyer
271 1.1.1.2.2.2 bouyer
272 1.1.1.2.2.2 bouyer /*
273 1.1.1.2.2.2 bouyer * Set op's name
274 1.1.1.2.2.2 bouyer */
275 1.1.1.2.2.2 bouyer void
276 1.1.1.2.2.2 bouyer AcpiPsSetName (
277 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op,
278 1.1.1.2.2.2 bouyer UINT32 name)
279 1.1.1.2.2.2 bouyer {
280 1.1.1.2.2.2 bouyer
281 1.1.1.2.2.2 bouyer /* The "generic" object has no name associated with it */
282 1.1.1.2.2.2 bouyer
283 1.1.1.2.2.2 bouyer if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
284 1.1.1.2.2.2 bouyer {
285 1.1.1.2.2.2 bouyer return;
286 1.1.1.2.2.2 bouyer }
287 1.1.1.2.2.2 bouyer
288 1.1.1.2.2.2 bouyer Op->Named.Name = name;
289 1.1.1.2.2.2 bouyer }
290 1.1.1.2.2.2 bouyer
291