blob: 2075efbb4324c79259083a852a023f38d03f7cfa [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Module Name: psutils - Parser miscellaneous utilities (Parser only)
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2005, R. Byron Moore
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <acpi/acpi.h>
45#include <acpi/acparser.h>
46#include <acpi/amlcode.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48#define _COMPONENT ACPI_PARSER
Len Brown4be44fc2005-08-05 00:44:28 -040049ACPI_MODULE_NAME("psutils")
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
51/*******************************************************************************
52 *
53 * FUNCTION: acpi_ps_create_scope_op
54 *
55 * PARAMETERS: None
56 *
Robert Moore44f6c012005-04-18 22:49:35 -040057 * RETURN: A new Scope object, null on failure
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 *
59 * DESCRIPTION: Create a Scope and associated namepath op with the root name
60 *
61 ******************************************************************************/
Len Brown4be44fc2005-08-05 00:44:28 -040062union acpi_parse_object *acpi_ps_create_scope_op(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -070063{
Len Brown4be44fc2005-08-05 00:44:28 -040064 union acpi_parse_object *scope_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Len Brown4be44fc2005-08-05 00:44:28 -040066 scope_op = acpi_ps_alloc_op(AML_SCOPE_OP);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 if (!scope_op) {
68 return (NULL);
69 }
70
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 scope_op->named.name = ACPI_ROOT_NAME;
72 return (scope_op);
73}
74
Linus Torvalds1da177e2005-04-16 15:20:36 -070075/*******************************************************************************
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 *
Robert Moore44f6c012005-04-18 22:49:35 -040082 * RETURN: None
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 *
Robert Moore44f6c012005-04-18 22:49:35 -040084 * DESCRIPTION: Initialize a parse (Op) object
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 *
86 ******************************************************************************/
87
Len Brown4be44fc2005-08-05 00:44:28 -040088void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode)
Linus Torvalds1da177e2005-04-16 15:20:36 -070089{
Len Brown4be44fc2005-08-05 00:44:28 -040090 ACPI_FUNCTION_ENTRY();
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
92 op->common.data_type = ACPI_DESC_TYPE_PARSER;
93 op->common.aml_opcode = opcode;
94
Len Brown4be44fc2005-08-05 00:44:28 -040095 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)));
Linus Torvalds1da177e2005-04-16 15:20:36 -070099}
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101/*******************************************************************************
102 *
103 * FUNCTION: acpi_ps_alloc_op
104 *
105 * PARAMETERS: Opcode - Opcode that will be stored in the new Op
106 *
Robert Moore44f6c012005-04-18 22:49:35 -0400107 * RETURN: Pointer to the new Op, null on failure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 *
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
Len Brown4be44fc2005-08-05 00:44:28 -0400115union acpi_parse_object *acpi_ps_alloc_op(u16 opcode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116{
Len Brown4be44fc2005-08-05 00:44:28 -0400117 union acpi_parse_object *op;
118 const struct acpi_opcode_info *op_info;
119 u8 flags = ACPI_PARSEOP_GENERIC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Len Brown4be44fc2005-08-05 00:44:28 -0400121 ACPI_FUNCTION_ENTRY();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Len Brown4be44fc2005-08-05 00:44:28 -0400123 op_info = acpi_ps_get_opcode_info(opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
125 /* Determine type of parse_op required */
126
127 if (op_info->flags & AML_DEFER) {
128 flags = ACPI_PARSEOP_DEFERRED;
Len Brown4be44fc2005-08-05 00:44:28 -0400129 } else if (op_info->flags & AML_NAMED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 flags = ACPI_PARSEOP_NAMED;
Len Brown4be44fc2005-08-05 00:44:28 -0400131 } else if (opcode == AML_INT_BYTELIST_OP) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 flags = ACPI_PARSEOP_BYTELIST;
133 }
134
135 /* Allocate the minimum required size object */
136
137 if (flags == ACPI_PARSEOP_GENERIC) {
138 /* The generic op (default) is by far the most common (16 to 1) */
139
Len Brown4be44fc2005-08-05 00:44:28 -0400140 op = acpi_os_acquire_object(acpi_gbl_ps_node_cache);
Robert Moore73459f72005-06-24 00:00:00 -0400141 memset(op, 0, sizeof(struct acpi_parse_obj_common));
Len Brown4be44fc2005-08-05 00:44:28 -0400142 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 /* Extended parseop */
144
Len Brown4be44fc2005-08-05 00:44:28 -0400145 op = acpi_os_acquire_object(acpi_gbl_ps_node_ext_cache);
Robert Moore73459f72005-06-24 00:00:00 -0400146 memset(op, 0, sizeof(struct acpi_parse_obj_named));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 }
148
149 /* Initialize the Op */
150
151 if (op) {
Len Brown4be44fc2005-08-05 00:44:28 -0400152 acpi_ps_init_op(op, opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 op->common.flags = flags;
154 }
155
156 return (op);
157}
158
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159/*******************************************************************************
160 *
161 * FUNCTION: acpi_ps_free_op
162 *
163 * PARAMETERS: Op - Op to be freed
164 *
165 * RETURN: None.
166 *
167 * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list
168 * or actually free it.
169 *
170 ******************************************************************************/
171
Len Brown4be44fc2005-08-05 00:44:28 -0400172void acpi_ps_free_op(union acpi_parse_object *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173{
Len Brown4be44fc2005-08-05 00:44:28 -0400174 ACPI_FUNCTION_NAME("ps_free_op");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
176 if (op->common.aml_opcode == AML_INT_RETURN_VALUE_OP) {
Len Brown4be44fc2005-08-05 00:44:28 -0400177 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "Free retval op: %p\n",
178 op));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 }
180
181 if (op->common.flags & ACPI_PARSEOP_GENERIC) {
Len Brown4be44fc2005-08-05 00:44:28 -0400182 (void)acpi_os_release_object(acpi_gbl_ps_node_cache, op);
183 } else {
184 (void)acpi_os_release_object(acpi_gbl_ps_node_ext_cache, op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 }
186}
187
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188/*******************************************************************************
189 *
190 * FUNCTION: Utility functions
191 *
192 * DESCRIPTION: Low level character and object functions
193 *
194 ******************************************************************************/
195
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196/*
197 * Is "c" a namestring lead character?
198 */
Len Brown4be44fc2005-08-05 00:44:28 -0400199u8 acpi_ps_is_leading_char(u32 c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200{
201 return ((u8) (c == '_' || (c >= 'A' && c <= 'Z')));
202}
203
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204/*
205 * Is "c" a namestring prefix character?
206 */
Len Brown4be44fc2005-08-05 00:44:28 -0400207u8 acpi_ps_is_prefix_char(u32 c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208{
209 return ((u8) (c == '\\' || c == '^'));
210}
211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212/*
213 * Get op's name (4-byte name segment) or 0 if unnamed
214 */
215#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400216u32 acpi_ps_get_name(union acpi_parse_object * op)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217{
218
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 /* The "generic" object has no name associated with it */
220
221 if (op->common.flags & ACPI_PARSEOP_GENERIC) {
222 return (0);
223 }
224
225 /* Only the "Extended" parse objects have a name */
226
227 return (op->named.name);
228}
Len Brown4be44fc2005-08-05 00:44:28 -0400229#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
231/*
232 * Set op's name
233 */
Len Brown4be44fc2005-08-05 00:44:28 -0400234void acpi_ps_set_name(union acpi_parse_object *op, u32 name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235{
236
237 /* The "generic" object has no name associated with it */
238
239 if (op->common.flags & ACPI_PARSEOP_GENERIC) {
240 return;
241 }
242
243 op->named.name = name;
244}