Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: psutils - Parser miscellaneous utilities (Parser only) | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
c8100dc4 | 8 | * Copyright (C) 2000 - 2016, Intel Corp. |
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 | 44 | #include <acpi/acpi.h> |
e2f7a777 LB |
45 | #include "accommon.h" |
46 | #include "acparser.h" | |
47 | #include "amlcode.h" | |
1da177e4 LT |
48 | |
49 | #define _COMPONENT ACPI_PARSER | |
4be44fcd | 50 | ACPI_MODULE_NAME("psutils") |
1da177e4 LT |
51 | |
52 | /******************************************************************************* | |
53 | * | |
54 | * FUNCTION: acpi_ps_create_scope_op | |
55 | * | |
56 | * PARAMETERS: None | |
57 | * | |
44f6c012 | 58 | * RETURN: A new Scope object, null on failure |
1da177e4 LT |
59 | * |
60 | * DESCRIPTION: Create a Scope and associated namepath op with the root name | |
61 | * | |
62 | ******************************************************************************/ | |
62eb935b | 63 | union acpi_parse_object *acpi_ps_create_scope_op(u8 *aml) |
1da177e4 | 64 | { |
4be44fcd | 65 | union acpi_parse_object *scope_op; |
1da177e4 | 66 | |
62eb935b | 67 | scope_op = acpi_ps_alloc_op(AML_SCOPE_OP, aml); |
1da177e4 LT |
68 | if (!scope_op) { |
69 | return (NULL); | |
70 | } | |
71 | ||
1da177e4 LT |
72 | scope_op->named.name = ACPI_ROOT_NAME; |
73 | return (scope_op); | |
74 | } | |
75 | ||
1da177e4 LT |
76 | /******************************************************************************* |
77 | * | |
78 | * FUNCTION: acpi_ps_init_op | |
79 | * | |
ba494bee BM |
80 | * PARAMETERS: op - A newly allocated Op object |
81 | * opcode - Opcode to store in the Op | |
1da177e4 | 82 | * |
44f6c012 | 83 | * RETURN: None |
1da177e4 | 84 | * |
44f6c012 | 85 | * DESCRIPTION: Initialize a parse (Op) object |
1da177e4 LT |
86 | * |
87 | ******************************************************************************/ | |
88 | ||
4be44fcd | 89 | void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode) |
1da177e4 | 90 | { |
4be44fcd | 91 | ACPI_FUNCTION_ENTRY(); |
1da177e4 | 92 | |
61686124 | 93 | op->common.descriptor_type = ACPI_DESC_TYPE_PARSER; |
1da177e4 LT |
94 | op->common.aml_opcode = opcode; |
95 | ||
4fa4616e BM |
96 | ACPI_DISASM_ONLY_MEMBERS(strncpy(op->common.aml_op_name, |
97 | (acpi_ps_get_opcode_info(opcode))-> | |
98 | name, sizeof(op->common.aml_op_name))); | |
1da177e4 LT |
99 | } |
100 | ||
1da177e4 LT |
101 | /******************************************************************************* |
102 | * | |
103 | * FUNCTION: acpi_ps_alloc_op | |
104 | * | |
ba494bee | 105 | * PARAMETERS: opcode - Opcode that will be stored in the new Op |
62eb935b | 106 | * aml - Address of the opcode |
1da177e4 | 107 | * |
44f6c012 | 108 | * RETURN: Pointer to the new Op, null on failure |
1da177e4 LT |
109 | * |
110 | * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on | |
73a3090a | 111 | * opcode. A cache of opcodes is available for the pure |
1da177e4 LT |
112 | * GENERIC_OP, since this is by far the most commonly used. |
113 | * | |
114 | ******************************************************************************/ | |
115 | ||
62eb935b | 116 | union acpi_parse_object *acpi_ps_alloc_op(u16 opcode, u8 *aml) |
1da177e4 | 117 | { |
4be44fcd LB |
118 | union acpi_parse_object *op; |
119 | const struct acpi_opcode_info *op_info; | |
120 | u8 flags = ACPI_PARSEOP_GENERIC; | |
1da177e4 | 121 | |
4be44fcd | 122 | ACPI_FUNCTION_ENTRY(); |
1da177e4 | 123 | |
4be44fcd | 124 | op_info = acpi_ps_get_opcode_info(opcode); |
1da177e4 LT |
125 | |
126 | /* Determine type of parse_op required */ | |
127 | ||
128 | if (op_info->flags & AML_DEFER) { | |
129 | flags = ACPI_PARSEOP_DEFERRED; | |
4be44fcd | 130 | } else if (op_info->flags & AML_NAMED) { |
5391abfd | 131 | flags = ACPI_PARSEOP_NAMED_OBJECT; |
4be44fcd | 132 | } else if (opcode == AML_INT_BYTELIST_OP) { |
1da177e4 LT |
133 | flags = ACPI_PARSEOP_BYTELIST; |
134 | } | |
135 | ||
136 | /* Allocate the minimum required size object */ | |
137 | ||
138 | if (flags == ACPI_PARSEOP_GENERIC) { | |
52fc0b02 | 139 | |
1da177e4 LT |
140 | /* The generic op (default) is by far the most common (16 to 1) */ |
141 | ||
4be44fcd | 142 | op = acpi_os_acquire_object(acpi_gbl_ps_node_cache); |
4be44fcd | 143 | } else { |
1da177e4 LT |
144 | /* Extended parseop */ |
145 | ||
4be44fcd | 146 | op = acpi_os_acquire_object(acpi_gbl_ps_node_ext_cache); |
1da177e4 LT |
147 | } |
148 | ||
149 | /* Initialize the Op */ | |
150 | ||
151 | if (op) { | |
4be44fcd | 152 | acpi_ps_init_op(op, opcode); |
62eb935b | 153 | op->common.aml = aml; |
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 | * | |
ba494bee | 164 | * PARAMETERS: op - Op to be freed |
1da177e4 LT |
165 | * |
166 | * RETURN: None. | |
167 | * | |
73a3090a | 168 | * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list |
1da177e4 LT |
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) { | |
1fad8738 BM |
178 | ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, |
179 | "Free retval op: %p\n", 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 | * Get op's name (4-byte name segment) or 0 if unnamed | |
207 | */ | |
4be44fcd | 208 | u32 acpi_ps_get_name(union acpi_parse_object * op) |
1da177e4 LT |
209 | { |
210 | ||
1da177e4 LT |
211 | /* The "generic" object has no name associated with it */ |
212 | ||
213 | if (op->common.flags & ACPI_PARSEOP_GENERIC) { | |
214 | return (0); | |
215 | } | |
216 | ||
217 | /* Only the "Extended" parse objects have a name */ | |
218 | ||
219 | return (op->named.name); | |
220 | } | |
1da177e4 LT |
221 | |
222 | /* | |
223 | * Set op's name | |
224 | */ | |
4be44fcd | 225 | void acpi_ps_set_name(union acpi_parse_object *op, u32 name) |
1da177e4 LT |
226 | { |
227 | ||
228 | /* The "generic" object has no name associated with it */ | |
229 | ||
230 | if (op->common.flags & ACPI_PARSEOP_GENERIC) { | |
231 | return; | |
232 | } | |
233 | ||
234 | op->named.name = name; | |
235 | } |