1/******************************************************************************
2 *
3 * Module Name: psutils - Parser miscellaneous utilities (Parser only)
4 *
5 *****************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 *    notice, this list of conditions, and the following disclaimer,
124 *    without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 *    substantially similar to the "NO WARRANTY" disclaimer below
127 *    ("Disclaimer") and any redistribution must be conditioned upon
128 *    including a substantially similar Disclaimer requirement for further
129 *    binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 *    of any contributors may be used to endorse or promote products derived
132 *    from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152#include "acpi.h"
153#include "accommon.h"
154#include "acparser.h"
155#include "amlcode.h"
156#include "acconvert.h"
157
158#define _COMPONENT          ACPI_PARSER
159        ACPI_MODULE_NAME    ("psutils")
160
161
162/*******************************************************************************
163 *
164 * FUNCTION:    AcpiPsCreateScopeOp
165 *
166 * PARAMETERS:  None
167 *
168 * RETURN:      A new Scope object, null on failure
169 *
170 * DESCRIPTION: Create a Scope and associated namepath op with the root name
171 *
172 ******************************************************************************/
173
174ACPI_PARSE_OBJECT *
175AcpiPsCreateScopeOp (
176    UINT8                   *Aml)
177{
178    ACPI_PARSE_OBJECT       *ScopeOp;
179
180
181    ScopeOp = AcpiPsAllocOp (AML_SCOPE_OP, Aml);
182    if (!ScopeOp)
183    {
184        return (NULL);
185    }
186
187    ScopeOp->Named.Name = ACPI_ROOT_NAME;
188    return (ScopeOp);
189}
190
191
192/*******************************************************************************
193 *
194 * FUNCTION:    AcpiPsInitOp
195 *
196 * PARAMETERS:  Op              - A newly allocated Op object
197 *              Opcode          - Opcode to store in the Op
198 *
199 * RETURN:      None
200 *
201 * DESCRIPTION: Initialize a parse (Op) object
202 *
203 ******************************************************************************/
204
205void
206AcpiPsInitOp (
207    ACPI_PARSE_OBJECT       *Op,
208    UINT16                  Opcode)
209{
210    ACPI_FUNCTION_ENTRY ();
211
212
213    Op->Common.DescriptorType = ACPI_DESC_TYPE_PARSER;
214    Op->Common.AmlOpcode = Opcode;
215
216    ACPI_DISASM_ONLY_MEMBERS (AcpiUtSafeStrncpy (Op->Common.AmlOpName,
217        (AcpiPsGetOpcodeInfo (Opcode))->Name,
218        sizeof (Op->Common.AmlOpName)));
219}
220
221
222/*******************************************************************************
223 *
224 * FUNCTION:    AcpiPsAllocOp
225 *
226 * PARAMETERS:  Opcode          - Opcode that will be stored in the new Op
227 *              Aml             - Address of the opcode
228 *
229 * RETURN:      Pointer to the new Op, null on failure
230 *
231 * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on
232 *              opcode. A cache of opcodes is available for the pure
233 *              GENERIC_OP, since this is by far the most commonly used.
234 *
235 ******************************************************************************/
236
237ACPI_PARSE_OBJECT*
238AcpiPsAllocOp (
239    UINT16                  Opcode,
240    UINT8                   *Aml)
241{
242    ACPI_PARSE_OBJECT       *Op;
243    const ACPI_OPCODE_INFO  *OpInfo;
244    UINT8                   Flags = ACPI_PARSEOP_GENERIC;
245
246
247    ACPI_FUNCTION_ENTRY ();
248
249
250    OpInfo = AcpiPsGetOpcodeInfo (Opcode);
251
252    /* Determine type of ParseOp required */
253
254    if (OpInfo->Flags & AML_DEFER)
255    {
256        Flags = ACPI_PARSEOP_DEFERRED;
257    }
258    else if (OpInfo->Flags & AML_NAMED)
259    {
260        Flags = ACPI_PARSEOP_NAMED_OBJECT;
261    }
262    else if (Opcode == AML_INT_BYTELIST_OP)
263    {
264        Flags = ACPI_PARSEOP_BYTELIST;
265    }
266
267    /* Allocate the minimum required size object */
268
269    if (Flags == ACPI_PARSEOP_GENERIC)
270    {
271        /* The generic op (default) is by far the most common (16 to 1) */
272
273        Op = AcpiOsAcquireObject (AcpiGbl_PsNodeCache);
274    }
275    else
276    {
277        /* Extended parseop */
278
279        Op = AcpiOsAcquireObject (AcpiGbl_PsNodeExtCache);
280    }
281
282    /* Initialize the Op */
283
284    if (Op)
285    {
286        AcpiPsInitOp (Op, Opcode);
287        Op->Common.Aml = Aml;
288        Op->Common.Flags = Flags;
289        ASL_CV_CLEAR_OP_COMMENTS(Op);
290
291        if (Opcode == AML_SCOPE_OP)
292        {
293            AcpiGbl_CurrentScope = Op;
294        }
295
296        if (AcpiGbl_CaptureComments)
297        {
298            ASL_CV_TRANSFER_COMMENTS (Op);
299        }
300    }
301
302    return (Op);
303}
304
305
306/*******************************************************************************
307 *
308 * FUNCTION:    AcpiPsFreeOp
309 *
310 * PARAMETERS:  Op              - Op to be freed
311 *
312 * RETURN:      None.
313 *
314 * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list
315 *              or actually free it.
316 *
317 ******************************************************************************/
318
319void
320AcpiPsFreeOp (
321    ACPI_PARSE_OBJECT       *Op)
322{
323    ACPI_FUNCTION_NAME (PsFreeOp);
324
325
326    ASL_CV_CLEAR_OP_COMMENTS(Op);
327    if (Op->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP)
328    {
329        ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
330            "Free retval op: %p\n", Op));
331    }
332
333    if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
334    {
335        (void) AcpiOsReleaseObject (AcpiGbl_PsNodeCache, Op);
336    }
337    else
338    {
339        (void) AcpiOsReleaseObject (AcpiGbl_PsNodeExtCache, Op);
340    }
341}
342
343
344/*******************************************************************************
345 *
346 * FUNCTION:    Utility functions
347 *
348 * DESCRIPTION: Low level character and object functions
349 *
350 ******************************************************************************/
351
352
353/*
354 * Is "c" a namestring lead character?
355 */
356BOOLEAN
357AcpiPsIsLeadingChar (
358    UINT32                  c)
359{
360    return ((BOOLEAN) (c == '_' || (c >= 'A' && c <= 'Z')));
361}
362
363
364/*
365 * Get op's name (4-byte name segment) or 0 if unnamed
366 */
367UINT32
368AcpiPsGetName (
369    ACPI_PARSE_OBJECT       *Op)
370{
371
372    /* The "generic" object has no name associated with it */
373
374    if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
375    {
376        return (0);
377    }
378
379    /* Only the "Extended" parse objects have a name */
380
381    return (Op->Named.Name);
382}
383
384
385/*
386 * Set op's name
387 */
388void
389AcpiPsSetName (
390    ACPI_PARSE_OBJECT       *Op,
391    UINT32                  name)
392{
393
394    /* The "generic" object has no name associated with it */
395
396    if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
397    {
398        return;
399    }
400
401    Op->Named.Name = name;
402}
403