Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: psutils - Parser miscellaneous utilities (Parser only) | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
4a90c7e8 | 8 | * Copyright (C) 2000 - 2006, R. Byron Moore |
1da177e4 LT |
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 | ||
1da177e4 LT |
44 | #include <acpi/acpi.h> |
45 | #include <acpi/acparser.h> | |
46 | #include <acpi/amlcode.h> | |
1da177e4 LT |
47 | |
48 | #define _COMPONENT ACPI_PARSER | |
4be44fcd | 49 | ACPI_MODULE_NAME("psutils") |
1da177e4 LT |
50 | |
51 | /******************************************************************************* | |
52 | * | |
53 | * FUNCTION: acpi_ps_create_scope_op | |
54 | * | |
55 | * PARAMETERS: None | |
56 | * | |
44f6c012 | 57 | * RETURN: A new Scope object, null on failure |
1da177e4 LT |
58 | * |
59 | * DESCRIPTION: Create a Scope and associated namepath op with the root name | |
60 | * | |
61 | ******************************************************************************/ | |
4be44fcd | 62 | union acpi_parse_object *acpi_ps_create_scope_op(void) |
1da177e4 | 63 | { |
4be44fcd | 64 | union acpi_parse_object *scope_op; |
1da177e4 | 65 | |
4be44fcd | 66 | scope_op = acpi_ps_alloc_op(AML_SCOPE_OP); |
1da177e4 LT |
67 | if (!scope_op) { |
68 | return (NULL); | |
69 | } | |
70 | ||
1da177e4 LT |
71 | scope_op->named.name = ACPI_ROOT_NAME; |
72 | return (scope_op); | |
73 | } | |
74 | ||
1da177e4 LT |
75 | /******************************************************************************* |
76 | * | |
77 | * FUNCTION: acpi_ps_init_op | |
78 | * | |
79 | * PARAMETERS: Op - A newly allocated Op object | |
80 | * Opcode - Opcode to store in the Op | |
81 | * | |
44f6c012 | 82 | * RETURN: None |
1da177e4 | 83 | * |
44f6c012 | 84 | * DESCRIPTION: Initialize a parse (Op) object |
1da177e4 LT |
85 | * |
86 | ******************************************************************************/ | |
87 | ||
4be44fcd | 88 | void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode) |
1da177e4 | 89 | { |
4be44fcd | 90 | ACPI_FUNCTION_ENTRY(); |
1da177e4 | 91 | |
61686124 | 92 | op->common.descriptor_type = ACPI_DESC_TYPE_PARSER; |
1da177e4 LT |
93 | op->common.aml_opcode = opcode; |
94 | ||
4be44fcd LB |
95 | ACPI_DISASM_ONLY_MEMBERS(ACPI_STRNCPY(op->common.aml_op_name, |
96 | (acpi_ps_get_opcode_info | |
97 | (opcode))->name, | |
98 | sizeof(op->common.aml_op_name))); | |
1da177e4 LT |
99 | } |
100 | ||
1da177e4 LT |
101 | /******************************************************************************* |
102 | * | |
103 | * FUNCTION: acpi_ps_alloc_op | |
104 | * | |
105 | * PARAMETERS: Opcode - Opcode that will be stored in the new Op | |
106 | * | |
44f6c012 | 107 | * RETURN: Pointer to the new Op, null on failure |
1da177e4 LT |
108 | * |
109 | * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on | |
110 | * opcode. A cache of opcodes is available for the pure | |
111 | * GENERIC_OP, since this is by far the most commonly used. | |
112 | * | |
113 | ******************************************************************************/ | |
114 | ||
4be44fcd | 115 | union acpi_parse_object *acpi_ps_alloc_op(u16 opcode) |
1da177e4 | 116 | { |
4be44fcd LB |
117 | union acpi_parse_object *op; |
118 | const struct acpi_opcode_info *op_info; | |
119 | u8 flags = ACPI_PARSEOP_GENERIC; | |
1da177e4 | 120 | |
4be44fcd | 121 | ACPI_FUNCTION_ENTRY(); |
1da177e4 | 122 | |
4be44fcd | 123 | op_info = acpi_ps_get_opcode_info(opcode); |
1da177e4 LT |
124 | |
125 | /* Determine type of parse_op required */ | |
126 | ||
127 | if (op_info->flags & AML_DEFER) { | |
128 | flags = ACPI_PARSEOP_DEFERRED; | |
4be44fcd | 129 | } else if (op_info->flags & AML_NAMED) { |
1da177e4 | 130 | flags = ACPI_PARSEOP_NAMED; |
4be44fcd | 131 | } else if (opcode == AML_INT_BYTELIST_OP) { |
1da177e4 LT |
132 | flags = ACPI_PARSEOP_BYTELIST; |
133 | } | |
134 | ||
135 | /* Allocate the minimum required size object */ | |
136 | ||
137 | if (flags == ACPI_PARSEOP_GENERIC) { | |
52fc0b02 | 138 | |
1da177e4 LT |
139 | /* The generic op (default) is by far the most common (16 to 1) */ |
140 | ||
4be44fcd | 141 | op = acpi_os_acquire_object(acpi_gbl_ps_node_cache); |
73459f73 | 142 | memset(op, 0, sizeof(struct acpi_parse_obj_common)); |
4be44fcd | 143 | } else { |
1da177e4 LT |
144 | /* Extended parseop */ |
145 | ||
4be44fcd | 146 | op = acpi_os_acquire_object(acpi_gbl_ps_node_ext_cache); |
73459f73 | 147 | memset(op, 0, sizeof(struct acpi_parse_obj_named)); |
1da177e4 LT |
148 | } |
149 | ||
150 | /* Initialize the Op */ | |
151 | ||
152 | if (op) { | |
4be44fcd | 153 | acpi_ps_init_op(op, opcode); |
1da177e4 LT |
154 | op->common.flags = flags; |
155 | } | |
156 | ||
157 | return (op); | |
158 | } | |
159 | ||
1da177e4 LT |
160 | /******************************************************************************* |
161 | * | |
162 | * FUNCTION: acpi_ps_free_op | |
163 | * | |
164 | * PARAMETERS: Op - Op to be freed | |
165 | * | |
166 | * RETURN: None. | |
167 | * | |
168 | * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list | |
169 | * or actually free it. | |
170 | * | |
171 | ******************************************************************************/ | |
172 | ||
4be44fcd | 173 | void acpi_ps_free_op(union acpi_parse_object *op) |
1da177e4 | 174 | { |
b229cf92 | 175 | ACPI_FUNCTION_NAME(ps_free_op); |
1da177e4 LT |
176 | |
177 | if (op->common.aml_opcode == AML_INT_RETURN_VALUE_OP) { | |
4be44fcd LB |
178 | ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "Free retval op: %p\n", |
179 | op)); | |
1da177e4 LT |
180 | } |
181 | ||
182 | if (op->common.flags & ACPI_PARSEOP_GENERIC) { | |
4be44fcd LB |
183 | (void)acpi_os_release_object(acpi_gbl_ps_node_cache, op); |
184 | } else { | |
185 | (void)acpi_os_release_object(acpi_gbl_ps_node_ext_cache, op); | |
1da177e4 LT |
186 | } |
187 | } | |
188 | ||
1da177e4 LT |
189 | /******************************************************************************* |
190 | * | |
191 | * FUNCTION: Utility functions | |
192 | * | |
193 | * DESCRIPTION: Low level character and object functions | |
194 | * | |
195 | ******************************************************************************/ | |
196 | ||
1da177e4 LT |
197 | /* |
198 | * Is "c" a namestring lead character? | |
199 | */ | |
4be44fcd | 200 | u8 acpi_ps_is_leading_char(u32 c) |
1da177e4 LT |
201 | { |
202 | return ((u8) (c == '_' || (c >= 'A' && c <= 'Z'))); | |
203 | } | |
204 | ||
1da177e4 LT |
205 | /* |
206 | * Is "c" a namestring prefix character? | |
207 | */ | |
4be44fcd | 208 | u8 acpi_ps_is_prefix_char(u32 c) |
1da177e4 LT |
209 | { |
210 | return ((u8) (c == '\\' || c == '^')); | |
211 | } | |
212 | ||
1da177e4 LT |
213 | /* |
214 | * Get op's name (4-byte name segment) or 0 if unnamed | |
215 | */ | |
216 | #ifdef ACPI_FUTURE_USAGE | |
4be44fcd | 217 | u32 acpi_ps_get_name(union acpi_parse_object * op) |
1da177e4 LT |
218 | { |
219 | ||
1da177e4 LT |
220 | /* The "generic" object has no name associated with it */ |
221 | ||
222 | if (op->common.flags & ACPI_PARSEOP_GENERIC) { | |
223 | return (0); | |
224 | } | |
225 | ||
226 | /* Only the "Extended" parse objects have a name */ | |
227 | ||
228 | return (op->named.name); | |
229 | } | |
4be44fcd | 230 | #endif /* ACPI_FUTURE_USAGE */ |
1da177e4 LT |
231 | |
232 | /* | |
233 | * Set op's name | |
234 | */ | |
4be44fcd | 235 | void acpi_ps_set_name(union acpi_parse_object *op, u32 name) |
1da177e4 LT |
236 | { |
237 | ||
238 | /* The "generic" object has no name associated with it */ | |
239 | ||
240 | if (op->common.flags & ACPI_PARSEOP_GENERIC) { | |
241 | return; | |
242 | } | |
243 | ||
244 | op->named.name = name; | |
245 | } |