1 /******************************************************************************
3 * Module Name: psutils - Parser miscellaneous utilities (Parser only)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
45 #include <acpi/acpi.h>
46 #include <acpi/acparser.h>
47 #include <acpi/amlcode.h>
49 #define _COMPONENT ACPI_PARSER
50 ACPI_MODULE_NAME ("psutils")
53 /*******************************************************************************
55 * FUNCTION: acpi_ps_create_scope_op
59 * RETURN: A new Scope object, null on failure
61 * DESCRIPTION: Create a Scope and associated namepath op with the root name
63 ******************************************************************************/
65 union acpi_parse_object *
66 acpi_ps_create_scope_op (
69 union acpi_parse_object *scope_op;
72 scope_op = acpi_ps_alloc_op (AML_SCOPE_OP);
77 scope_op->named.name = ACPI_ROOT_NAME;
82 /*******************************************************************************
84 * FUNCTION: acpi_ps_init_op
86 * PARAMETERS: Op - A newly allocated Op object
87 * Opcode - Opcode to store in the Op
91 * DESCRIPTION: Initialize a parse (Op) object
93 ******************************************************************************/
97 union acpi_parse_object *op,
100 ACPI_FUNCTION_ENTRY ();
103 op->common.data_type = ACPI_DESC_TYPE_PARSER;
104 op->common.aml_opcode = opcode;
106 ACPI_DISASM_ONLY_MEMBERS (ACPI_STRNCPY (op->common.aml_op_name,
107 (acpi_ps_get_opcode_info (opcode))->name,
108 sizeof (op->common.aml_op_name)));
112 /*******************************************************************************
114 * FUNCTION: acpi_ps_alloc_op
116 * PARAMETERS: Opcode - Opcode that will be stored in the new Op
118 * RETURN: Pointer to the new Op, null on failure
120 * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on
121 * opcode. A cache of opcodes is available for the pure
122 * GENERIC_OP, since this is by far the most commonly used.
124 ******************************************************************************/
126 union acpi_parse_object*
130 union acpi_parse_object *op;
131 const struct acpi_opcode_info *op_info;
132 u8 flags = ACPI_PARSEOP_GENERIC;
135 ACPI_FUNCTION_ENTRY ();
138 op_info = acpi_ps_get_opcode_info (opcode);
140 /* Determine type of parse_op required */
142 if (op_info->flags & AML_DEFER) {
143 flags = ACPI_PARSEOP_DEFERRED;
145 else if (op_info->flags & AML_NAMED) {
146 flags = ACPI_PARSEOP_NAMED;
148 else if (opcode == AML_INT_BYTELIST_OP) {
149 flags = ACPI_PARSEOP_BYTELIST;
152 /* Allocate the minimum required size object */
154 if (flags == ACPI_PARSEOP_GENERIC) {
155 /* The generic op (default) is by far the most common (16 to 1) */
157 op = acpi_os_acquire_object (acpi_gbl_ps_node_cache);
158 memset(op, 0, sizeof(struct acpi_parse_obj_common));
161 /* Extended parseop */
163 op = acpi_os_acquire_object (acpi_gbl_ps_node_ext_cache);
164 memset(op, 0, sizeof(struct acpi_parse_obj_named));
167 /* Initialize the Op */
170 acpi_ps_init_op (op, opcode);
171 op->common.flags = flags;
178 /*******************************************************************************
180 * FUNCTION: acpi_ps_free_op
182 * PARAMETERS: Op - Op to be freed
186 * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list
187 * or actually free it.
189 ******************************************************************************/
193 union acpi_parse_object *op)
195 ACPI_FUNCTION_NAME ("ps_free_op");
198 if (op->common.aml_opcode == AML_INT_RETURN_VALUE_OP) {
199 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Free retval op: %p\n", op));
202 if (op->common.flags & ACPI_PARSEOP_GENERIC) {
203 acpi_os_release_object (acpi_gbl_ps_node_cache, op);
206 acpi_os_release_object (acpi_gbl_ps_node_ext_cache, op);
211 /*******************************************************************************
213 * FUNCTION: Utility functions
215 * DESCRIPTION: Low level character and object functions
217 ******************************************************************************/
221 * Is "c" a namestring lead character?
224 acpi_ps_is_leading_char (
227 return ((u8) (c == '_' || (c >= 'A' && c <= 'Z')));
232 * Is "c" a namestring prefix character?
235 acpi_ps_is_prefix_char (
238 return ((u8) (c == '\\' || c == '^'));
243 * Get op's name (4-byte name segment) or 0 if unnamed
245 #ifdef ACPI_FUTURE_USAGE
248 union acpi_parse_object *op)
251 /* The "generic" object has no name associated with it */
253 if (op->common.flags & ACPI_PARSEOP_GENERIC) {
257 /* Only the "Extended" parse objects have a name */
259 return (op->named.name);
261 #endif /* ACPI_FUTURE_USAGE */
269 union acpi_parse_object *op,
273 /* The "generic" object has no name associated with it */
275 if (op->common.flags & ACPI_PARSEOP_GENERIC) {
279 op->named.name = name;