1149703c7Sjruoho /******************************************************************************
2149703c7Sjruoho *
3149703c7Sjruoho * Module Name: psutils - Parser miscellaneous utilities (Parser only)
4149703c7Sjruoho *
5149703c7Sjruoho *****************************************************************************/
6149703c7Sjruoho
768471b32Sjruoho /*
8*e5631441Schristos * Copyright (C) 2000 - 2022, Intel Corp.
9149703c7Sjruoho * All rights reserved.
10149703c7Sjruoho *
1168471b32Sjruoho * Redistribution and use in source and binary forms, with or without
1268471b32Sjruoho * modification, are permitted provided that the following conditions
1368471b32Sjruoho * are met:
1468471b32Sjruoho * 1. Redistributions of source code must retain the above copyright
1568471b32Sjruoho * notice, this list of conditions, and the following disclaimer,
1668471b32Sjruoho * without modification.
1768471b32Sjruoho * 2. Redistributions in binary form must reproduce at minimum a disclaimer
1868471b32Sjruoho * substantially similar to the "NO WARRANTY" disclaimer below
1968471b32Sjruoho * ("Disclaimer") and any redistribution must be conditioned upon
2068471b32Sjruoho * including a substantially similar Disclaimer requirement for further
2168471b32Sjruoho * binary redistribution.
2268471b32Sjruoho * 3. Neither the names of the above-listed copyright holders nor the names
2368471b32Sjruoho * of any contributors may be used to endorse or promote products derived
2468471b32Sjruoho * from this software without specific prior written permission.
25149703c7Sjruoho *
2668471b32Sjruoho * Alternatively, this software may be distributed under the terms of the
2768471b32Sjruoho * GNU General Public License ("GPL") version 2 as published by the Free
2868471b32Sjruoho * Software Foundation.
29149703c7Sjruoho *
3068471b32Sjruoho * NO WARRANTY
3168471b32Sjruoho * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
3268471b32Sjruoho * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33d4291bf2Schristos * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
3468471b32Sjruoho * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
3568471b32Sjruoho * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
3668471b32Sjruoho * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
3768471b32Sjruoho * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
3868471b32Sjruoho * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
3968471b32Sjruoho * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
4068471b32Sjruoho * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
4168471b32Sjruoho * POSSIBILITY OF SUCH DAMAGES.
4268471b32Sjruoho */
43149703c7Sjruoho
44149703c7Sjruoho #include "acpi.h"
45149703c7Sjruoho #include "accommon.h"
46149703c7Sjruoho #include "acparser.h"
47149703c7Sjruoho #include "amlcode.h"
481a3716ccSchristos #include "acconvert.h"
49149703c7Sjruoho
50149703c7Sjruoho #define _COMPONENT ACPI_PARSER
51149703c7Sjruoho ACPI_MODULE_NAME ("psutils")
52149703c7Sjruoho
53149703c7Sjruoho
54149703c7Sjruoho /*******************************************************************************
55149703c7Sjruoho *
56149703c7Sjruoho * FUNCTION: AcpiPsCreateScopeOp
57149703c7Sjruoho *
58149703c7Sjruoho * PARAMETERS: None
59149703c7Sjruoho *
60149703c7Sjruoho * RETURN: A new Scope object, null on failure
61149703c7Sjruoho *
62149703c7Sjruoho * DESCRIPTION: Create a Scope and associated namepath op with the root name
63149703c7Sjruoho *
64149703c7Sjruoho ******************************************************************************/
65149703c7Sjruoho
66149703c7Sjruoho ACPI_PARSE_OBJECT *
AcpiPsCreateScopeOp(UINT8 * Aml)67149703c7Sjruoho AcpiPsCreateScopeOp (
68db5c6ae1Schristos UINT8 *Aml)
69149703c7Sjruoho {
70149703c7Sjruoho ACPI_PARSE_OBJECT *ScopeOp;
71149703c7Sjruoho
72149703c7Sjruoho
73db5c6ae1Schristos ScopeOp = AcpiPsAllocOp (AML_SCOPE_OP, Aml);
74149703c7Sjruoho if (!ScopeOp)
75149703c7Sjruoho {
76149703c7Sjruoho return (NULL);
77149703c7Sjruoho }
78149703c7Sjruoho
79149703c7Sjruoho ScopeOp->Named.Name = ACPI_ROOT_NAME;
80149703c7Sjruoho return (ScopeOp);
81149703c7Sjruoho }
82149703c7Sjruoho
83149703c7Sjruoho
84149703c7Sjruoho /*******************************************************************************
85149703c7Sjruoho *
86149703c7Sjruoho * FUNCTION: AcpiPsInitOp
87149703c7Sjruoho *
88149703c7Sjruoho * PARAMETERS: Op - A newly allocated Op object
89149703c7Sjruoho * Opcode - Opcode to store in the Op
90149703c7Sjruoho *
91149703c7Sjruoho * RETURN: None
92149703c7Sjruoho *
93149703c7Sjruoho * DESCRIPTION: Initialize a parse (Op) object
94149703c7Sjruoho *
95149703c7Sjruoho ******************************************************************************/
96149703c7Sjruoho
97149703c7Sjruoho void
AcpiPsInitOp(ACPI_PARSE_OBJECT * Op,UINT16 Opcode)98149703c7Sjruoho AcpiPsInitOp (
99149703c7Sjruoho ACPI_PARSE_OBJECT *Op,
100149703c7Sjruoho UINT16 Opcode)
101149703c7Sjruoho {
102149703c7Sjruoho ACPI_FUNCTION_ENTRY ();
103149703c7Sjruoho
104149703c7Sjruoho
105149703c7Sjruoho Op->Common.DescriptorType = ACPI_DESC_TYPE_PARSER;
106149703c7Sjruoho Op->Common.AmlOpcode = Opcode;
107149703c7Sjruoho
108e32744fcSchristos ACPI_DISASM_ONLY_MEMBERS (AcpiUtSafeStrncpy (Op->Common.AmlOpName,
109149703c7Sjruoho (AcpiPsGetOpcodeInfo (Opcode))->Name,
110149703c7Sjruoho sizeof (Op->Common.AmlOpName)));
111149703c7Sjruoho }
112149703c7Sjruoho
113149703c7Sjruoho
114149703c7Sjruoho /*******************************************************************************
115149703c7Sjruoho *
116149703c7Sjruoho * FUNCTION: AcpiPsAllocOp
117149703c7Sjruoho *
118149703c7Sjruoho * PARAMETERS: Opcode - Opcode that will be stored in the new Op
119db5c6ae1Schristos * Aml - Address of the opcode
120149703c7Sjruoho *
121149703c7Sjruoho * RETURN: Pointer to the new Op, null on failure
122149703c7Sjruoho *
123149703c7Sjruoho * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on
124149703c7Sjruoho * opcode. A cache of opcodes is available for the pure
125149703c7Sjruoho * GENERIC_OP, since this is by far the most commonly used.
126149703c7Sjruoho *
127149703c7Sjruoho ******************************************************************************/
128149703c7Sjruoho
129149703c7Sjruoho ACPI_PARSE_OBJECT*
AcpiPsAllocOp(UINT16 Opcode,UINT8 * Aml)130149703c7Sjruoho AcpiPsAllocOp (
131db5c6ae1Schristos UINT16 Opcode,
132db5c6ae1Schristos UINT8 *Aml)
133149703c7Sjruoho {
134149703c7Sjruoho ACPI_PARSE_OBJECT *Op;
135149703c7Sjruoho const ACPI_OPCODE_INFO *OpInfo;
136149703c7Sjruoho UINT8 Flags = ACPI_PARSEOP_GENERIC;
137149703c7Sjruoho
138149703c7Sjruoho
139149703c7Sjruoho ACPI_FUNCTION_ENTRY ();
140149703c7Sjruoho
141149703c7Sjruoho
142149703c7Sjruoho OpInfo = AcpiPsGetOpcodeInfo (Opcode);
143149703c7Sjruoho
144149703c7Sjruoho /* Determine type of ParseOp required */
145149703c7Sjruoho
146149703c7Sjruoho if (OpInfo->Flags & AML_DEFER)
147149703c7Sjruoho {
148149703c7Sjruoho Flags = ACPI_PARSEOP_DEFERRED;
149149703c7Sjruoho }
150149703c7Sjruoho else if (OpInfo->Flags & AML_NAMED)
151149703c7Sjruoho {
152e1e2165cSchristos Flags = ACPI_PARSEOP_NAMED_OBJECT;
153149703c7Sjruoho }
154149703c7Sjruoho else if (Opcode == AML_INT_BYTELIST_OP)
155149703c7Sjruoho {
156149703c7Sjruoho Flags = ACPI_PARSEOP_BYTELIST;
157149703c7Sjruoho }
158149703c7Sjruoho
159149703c7Sjruoho /* Allocate the minimum required size object */
160149703c7Sjruoho
161149703c7Sjruoho if (Flags == ACPI_PARSEOP_GENERIC)
162149703c7Sjruoho {
163149703c7Sjruoho /* The generic op (default) is by far the most common (16 to 1) */
164149703c7Sjruoho
165149703c7Sjruoho Op = AcpiOsAcquireObject (AcpiGbl_PsNodeCache);
166149703c7Sjruoho }
167149703c7Sjruoho else
168149703c7Sjruoho {
169149703c7Sjruoho /* Extended parseop */
170149703c7Sjruoho
171149703c7Sjruoho Op = AcpiOsAcquireObject (AcpiGbl_PsNodeExtCache);
172149703c7Sjruoho }
173149703c7Sjruoho
174149703c7Sjruoho /* Initialize the Op */
175149703c7Sjruoho
176149703c7Sjruoho if (Op)
177149703c7Sjruoho {
178149703c7Sjruoho AcpiPsInitOp (Op, Opcode);
179db5c6ae1Schristos Op->Common.Aml = Aml;
180149703c7Sjruoho Op->Common.Flags = Flags;
1811a3716ccSchristos ASL_CV_CLEAR_OP_COMMENTS(Op);
1821a3716ccSchristos
1831a3716ccSchristos if (Opcode == AML_SCOPE_OP)
1841a3716ccSchristos {
1851a3716ccSchristos AcpiGbl_CurrentScope = Op;
1861a3716ccSchristos }
1871a3716ccSchristos
188e32744fcSchristos if (AcpiGbl_CaptureComments)
1891a3716ccSchristos {
1901a3716ccSchristos ASL_CV_TRANSFER_COMMENTS (Op);
191149703c7Sjruoho }
1922baed015Schristos }
193149703c7Sjruoho
194149703c7Sjruoho return (Op);
195149703c7Sjruoho }
196149703c7Sjruoho
197149703c7Sjruoho
198149703c7Sjruoho /*******************************************************************************
199149703c7Sjruoho *
200149703c7Sjruoho * FUNCTION: AcpiPsFreeOp
201149703c7Sjruoho *
202149703c7Sjruoho * PARAMETERS: Op - Op to be freed
203149703c7Sjruoho *
204149703c7Sjruoho * RETURN: None.
205149703c7Sjruoho *
206149703c7Sjruoho * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list
207149703c7Sjruoho * or actually free it.
208149703c7Sjruoho *
209149703c7Sjruoho ******************************************************************************/
210149703c7Sjruoho
211149703c7Sjruoho void
AcpiPsFreeOp(ACPI_PARSE_OBJECT * Op)212149703c7Sjruoho AcpiPsFreeOp (
213149703c7Sjruoho ACPI_PARSE_OBJECT *Op)
214149703c7Sjruoho {
215149703c7Sjruoho ACPI_FUNCTION_NAME (PsFreeOp);
216149703c7Sjruoho
217149703c7Sjruoho
2181a3716ccSchristos ASL_CV_CLEAR_OP_COMMENTS(Op);
219149703c7Sjruoho if (Op->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP)
220149703c7Sjruoho {
2215fe1040dSchristos ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
2225fe1040dSchristos "Free retval op: %p\n", Op));
223149703c7Sjruoho }
224149703c7Sjruoho
225149703c7Sjruoho if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
226149703c7Sjruoho {
227149703c7Sjruoho (void) AcpiOsReleaseObject (AcpiGbl_PsNodeCache, Op);
228149703c7Sjruoho }
229149703c7Sjruoho else
230149703c7Sjruoho {
231149703c7Sjruoho (void) AcpiOsReleaseObject (AcpiGbl_PsNodeExtCache, Op);
232149703c7Sjruoho }
233149703c7Sjruoho }
234149703c7Sjruoho
235149703c7Sjruoho
236149703c7Sjruoho /*******************************************************************************
237149703c7Sjruoho *
238149703c7Sjruoho * FUNCTION: Utility functions
239149703c7Sjruoho *
240149703c7Sjruoho * DESCRIPTION: Low level character and object functions
241149703c7Sjruoho *
242149703c7Sjruoho ******************************************************************************/
243149703c7Sjruoho
244149703c7Sjruoho
245149703c7Sjruoho /*
246149703c7Sjruoho * Is "c" a namestring lead character?
247149703c7Sjruoho */
248149703c7Sjruoho BOOLEAN
AcpiPsIsLeadingChar(UINT32 c)249149703c7Sjruoho AcpiPsIsLeadingChar (
250149703c7Sjruoho UINT32 c)
251149703c7Sjruoho {
252149703c7Sjruoho return ((BOOLEAN) (c == '_' || (c >= 'A' && c <= 'Z')));
253149703c7Sjruoho }
254149703c7Sjruoho
255149703c7Sjruoho
256149703c7Sjruoho /*
257149703c7Sjruoho * Get op's name (4-byte name segment) or 0 if unnamed
258149703c7Sjruoho */
259149703c7Sjruoho UINT32
AcpiPsGetName(ACPI_PARSE_OBJECT * Op)260149703c7Sjruoho AcpiPsGetName (
261149703c7Sjruoho ACPI_PARSE_OBJECT *Op)
262149703c7Sjruoho {
263149703c7Sjruoho
264149703c7Sjruoho /* The "generic" object has no name associated with it */
265149703c7Sjruoho
266149703c7Sjruoho if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
267149703c7Sjruoho {
268149703c7Sjruoho return (0);
269149703c7Sjruoho }
270149703c7Sjruoho
271149703c7Sjruoho /* Only the "Extended" parse objects have a name */
272149703c7Sjruoho
273149703c7Sjruoho return (Op->Named.Name);
274149703c7Sjruoho }
275149703c7Sjruoho
276149703c7Sjruoho
277149703c7Sjruoho /*
278149703c7Sjruoho * Set op's name
279149703c7Sjruoho */
280149703c7Sjruoho void
AcpiPsSetName(ACPI_PARSE_OBJECT * Op,UINT32 name)281149703c7Sjruoho AcpiPsSetName (
282149703c7Sjruoho ACPI_PARSE_OBJECT *Op,
283149703c7Sjruoho UINT32 name)
284149703c7Sjruoho {
285149703c7Sjruoho
286149703c7Sjruoho /* The "generic" object has no name associated with it */
287149703c7Sjruoho
288149703c7Sjruoho if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
289149703c7Sjruoho {
290149703c7Sjruoho return;
291149703c7Sjruoho }
292149703c7Sjruoho
293149703c7Sjruoho Op->Named.Name = name;
294149703c7Sjruoho }
295