1
/******************************************************************************
3
* Module Name: psargs - Parse AML opcode arguments
5
*****************************************************************************/
8
* Copyright (C) 2000 - 2011, Intel Corp.
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.
44
#include <acpi/acpi.h>
51
#define _COMPONENT ACPI_PARSER
52
ACPI_MODULE_NAME("psargs")
54
/* Local prototypes */
56
acpi_ps_get_next_package_length(struct acpi_parse_state *parser_state);
58
static union acpi_parse_object *acpi_ps_get_next_field(struct acpi_parse_state
61
/*******************************************************************************
63
* FUNCTION: acpi_ps_get_next_package_length
65
* PARAMETERS: parser_state - Current parser state object
67
* RETURN: Decoded package length. On completion, the AML pointer points
68
* past the length byte or bytes.
70
* DESCRIPTION: Decode and return a package length field.
71
* Note: Largest package length is 28 bits, from ACPI specification
73
******************************************************************************/
76
acpi_ps_get_next_package_length(struct acpi_parse_state *parser_state)
78
u8 *aml = parser_state->aml;
79
u32 package_length = 0;
81
u8 byte_zero_mask = 0x3F; /* Default [0:5] */
83
ACPI_FUNCTION_TRACE(ps_get_next_package_length);
86
* Byte 0 bits [6:7] contain the number of additional bytes
87
* used to encode the package length, either 0,1,2, or 3
89
byte_count = (aml[0] >> 6);
90
parser_state->aml += ((acpi_size) byte_count + 1);
92
/* Get bytes 3, 2, 1 as needed */
96
* Final bit positions for the package length bytes:
102
package_length |= (aml[byte_count] << ((byte_count << 3) - 4));
104
byte_zero_mask = 0x0F; /* Use bits [0:3] of byte 0 */
108
/* Byte 0 is a special case, either bits [0:3] or [0:5] are used */
110
package_length |= (aml[0] & byte_zero_mask);
111
return_UINT32(package_length);
114
/*******************************************************************************
116
* FUNCTION: acpi_ps_get_next_package_end
118
* PARAMETERS: parser_state - Current parser state object
120
* RETURN: Pointer to end-of-package +1
122
* DESCRIPTION: Get next package length and return a pointer past the end of
123
* the package. Consumes the package length field
125
******************************************************************************/
127
u8 *acpi_ps_get_next_package_end(struct acpi_parse_state *parser_state)
129
u8 *start = parser_state->aml;
132
ACPI_FUNCTION_TRACE(ps_get_next_package_end);
134
/* Function below updates parser_state->Aml */
136
package_length = acpi_ps_get_next_package_length(parser_state);
138
return_PTR(start + package_length); /* end of package */
141
/*******************************************************************************
143
* FUNCTION: acpi_ps_get_next_namestring
145
* PARAMETERS: parser_state - Current parser state object
147
* RETURN: Pointer to the start of the name string (pointer points into
150
* DESCRIPTION: Get next raw namestring within the AML stream. Handles all name
151
* prefix characters. Set parser state to point past the string.
152
* (Name is consumed from the AML.)
154
******************************************************************************/
156
char *acpi_ps_get_next_namestring(struct acpi_parse_state *parser_state)
158
u8 *start = parser_state->aml;
159
u8 *end = parser_state->aml;
161
ACPI_FUNCTION_TRACE(ps_get_next_namestring);
163
/* Point past any namestring prefix characters (backslash or carat) */
165
while (acpi_ps_is_prefix_char(*end)) {
169
/* Decode the path prefix character */
182
case AML_DUAL_NAME_PREFIX:
184
/* Two name segments */
186
end += 1 + (2 * ACPI_NAME_SIZE);
189
case AML_MULTI_NAME_PREFIX_OP:
191
/* Multiple name segments, 4 chars each, count in next byte */
193
end += 2 + (*(end + 1) * ACPI_NAME_SIZE);
198
/* Single name segment */
200
end += ACPI_NAME_SIZE;
204
parser_state->aml = end;
205
return_PTR((char *)start);
208
/*******************************************************************************
210
* FUNCTION: acpi_ps_get_next_namepath
212
* PARAMETERS: parser_state - Current parser state object
213
* Arg - Where the namepath will be stored
214
* arg_count - If the namepath points to a control method
215
* the method's argument is returned here.
216
* possible_method_call - Whether the namepath can possibly be the
217
* start of a method call
221
* DESCRIPTION: Get next name (if method call, return # of required args).
222
* Names are looked up in the internal namespace to determine
223
* if the name represents a control method. If a method
224
* is found, the number of arguments to the method is returned.
225
* This information is critical for parsing to continue correctly.
227
******************************************************************************/
230
acpi_ps_get_next_namepath(struct acpi_walk_state *walk_state,
231
struct acpi_parse_state *parser_state,
232
union acpi_parse_object *arg, u8 possible_method_call)
236
union acpi_parse_object *name_op;
237
union acpi_operand_object *method_desc;
238
struct acpi_namespace_node *node;
239
u8 *start = parser_state->aml;
241
ACPI_FUNCTION_TRACE(ps_get_next_namepath);
243
path = acpi_ps_get_next_namestring(parser_state);
244
acpi_ps_init_op(arg, AML_INT_NAMEPATH_OP);
246
/* Null path case is allowed, just exit */
249
arg->common.value.name = path;
250
return_ACPI_STATUS(AE_OK);
254
* Lookup the name in the internal namespace, starting with the current
255
* scope. We don't want to add anything new to the namespace here,
256
* however, so we use MODE_EXECUTE.
257
* Allow searching of the parent tree, but don't open a new scope -
258
* we just want to lookup the object (must be mode EXECUTE to perform
261
status = acpi_ns_lookup(walk_state->scope_info, path,
262
ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
263
ACPI_NS_SEARCH_PARENT | ACPI_NS_DONT_OPEN_SCOPE,
267
* If this name is a control method invocation, we must
268
* setup the method call
270
if (ACPI_SUCCESS(status) &&
271
possible_method_call && (node->type == ACPI_TYPE_METHOD)) {
272
if (walk_state->opcode == AML_UNLOAD_OP) {
274
* acpi_ps_get_next_namestring has increased the AML pointer,
275
* so we need to restore the saved AML pointer for method call.
277
walk_state->parser_state.aml = start;
278
walk_state->arg_count = 1;
279
acpi_ps_init_op(arg, AML_INT_METHODCALL_OP);
280
return_ACPI_STATUS(AE_OK);
283
/* This name is actually a control method invocation */
285
method_desc = acpi_ns_get_attached_object(node);
286
ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
287
"Control Method - %p Desc %p Path=%p\n", node,
290
name_op = acpi_ps_alloc_op(AML_INT_NAMEPATH_OP);
292
return_ACPI_STATUS(AE_NO_MEMORY);
295
/* Change Arg into a METHOD CALL and attach name to it */
297
acpi_ps_init_op(arg, AML_INT_METHODCALL_OP);
298
name_op->common.value.name = path;
300
/* Point METHODCALL/NAME to the METHOD Node */
302
name_op->common.node = node;
303
acpi_ps_append_arg(arg, name_op);
307
"Control Method %p has no attached object",
309
return_ACPI_STATUS(AE_AML_INTERNAL);
312
ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
313
"Control Method - %p Args %X\n",
314
node, method_desc->method.param_count));
316
/* Get the number of arguments to expect */
318
walk_state->arg_count = method_desc->method.param_count;
319
return_ACPI_STATUS(AE_OK);
323
* Special handling if the name was not found during the lookup -
324
* some not_found cases are allowed
326
if (status == AE_NOT_FOUND) {
328
/* 1) not_found is ok during load pass 1/2 (allow forward references) */
330
if ((walk_state->parse_flags & ACPI_PARSE_MODE_MASK) !=
331
ACPI_PARSE_EXECUTE) {
335
/* 2) not_found during a cond_ref_of(x) is ok by definition */
337
else if (walk_state->op->common.aml_opcode ==
338
AML_COND_REF_OF_OP) {
343
* 3) not_found while building a Package is ok at this point, we
344
* may flag as an error later if slack mode is not enabled.
345
* (Some ASL code depends on allowing this behavior)
347
else if ((arg->common.parent) &&
348
((arg->common.parent->common.aml_opcode ==
350
|| (arg->common.parent->common.aml_opcode ==
351
AML_VAR_PACKAGE_OP))) {
356
/* Final exception check (may have been changed from code above) */
358
if (ACPI_FAILURE(status)) {
359
ACPI_ERROR_NAMESPACE(path, status);
361
if ((walk_state->parse_flags & ACPI_PARSE_MODE_MASK) ==
362
ACPI_PARSE_EXECUTE) {
364
/* Report a control method execution error */
366
status = acpi_ds_method_error(status, walk_state);
370
/* Save the namepath */
372
arg->common.value.name = path;
373
return_ACPI_STATUS(status);
376
/*******************************************************************************
378
* FUNCTION: acpi_ps_get_next_simple_arg
380
* PARAMETERS: parser_state - Current parser state object
381
* arg_type - The argument type (AML_*_ARG)
382
* Arg - Where the argument is returned
386
* DESCRIPTION: Get the next simple argument (constant, string, or namestring)
388
******************************************************************************/
391
acpi_ps_get_next_simple_arg(struct acpi_parse_state *parser_state,
392
u32 arg_type, union acpi_parse_object *arg)
396
u8 *aml = parser_state->aml;
398
ACPI_FUNCTION_TRACE_U32(ps_get_next_simple_arg, arg_type);
403
/* Get 1 byte from the AML stream */
405
opcode = AML_BYTE_OP;
406
arg->common.value.integer = (u64) *aml;
412
/* Get 2 bytes from the AML stream */
414
opcode = AML_WORD_OP;
415
ACPI_MOVE_16_TO_64(&arg->common.value.integer, aml);
421
/* Get 4 bytes from the AML stream */
423
opcode = AML_DWORD_OP;
424
ACPI_MOVE_32_TO_64(&arg->common.value.integer, aml);
430
/* Get 8 bytes from the AML stream */
432
opcode = AML_QWORD_OP;
433
ACPI_MOVE_64_TO_64(&arg->common.value.integer, aml);
439
/* Get a pointer to the string, point past the string */
441
opcode = AML_STRING_OP;
442
arg->common.value.string = ACPI_CAST_PTR(char, aml);
444
/* Find the null terminator */
447
while (aml[length]) {
454
case ARGP_NAMESTRING:
456
acpi_ps_init_op(arg, AML_INT_NAMEPATH_OP);
457
arg->common.value.name =
458
acpi_ps_get_next_namestring(parser_state);
463
ACPI_ERROR((AE_INFO, "Invalid ArgType 0x%X", arg_type));
467
acpi_ps_init_op(arg, opcode);
468
parser_state->aml += length;
472
/*******************************************************************************
474
* FUNCTION: acpi_ps_get_next_field
476
* PARAMETERS: parser_state - Current parser state object
478
* RETURN: A newly allocated FIELD op
480
* DESCRIPTION: Get next field (named_field, reserved_field, or access_field)
482
******************************************************************************/
484
static union acpi_parse_object *acpi_ps_get_next_field(struct acpi_parse_state
487
u32 aml_offset = (u32)
488
ACPI_PTR_DIFF(parser_state->aml,
489
parser_state->aml_start);
490
union acpi_parse_object *field;
494
ACPI_FUNCTION_TRACE(ps_get_next_field);
496
/* Determine field type */
498
switch (ACPI_GET8(parser_state->aml)) {
501
opcode = AML_INT_NAMEDFIELD_OP;
506
opcode = AML_INT_RESERVEDFIELD_OP;
512
opcode = AML_INT_ACCESSFIELD_OP;
517
/* Allocate a new field op */
519
field = acpi_ps_alloc_op(opcode);
524
field->common.aml_offset = aml_offset;
526
/* Decode the field type */
529
case AML_INT_NAMEDFIELD_OP:
531
/* Get the 4-character name */
533
ACPI_MOVE_32_TO_32(&name, parser_state->aml);
534
acpi_ps_set_name(field, name);
535
parser_state->aml += ACPI_NAME_SIZE;
537
/* Get the length which is encoded as a package length */
539
field->common.value.size =
540
acpi_ps_get_next_package_length(parser_state);
543
case AML_INT_RESERVEDFIELD_OP:
545
/* Get the length which is encoded as a package length */
547
field->common.value.size =
548
acpi_ps_get_next_package_length(parser_state);
551
case AML_INT_ACCESSFIELD_OP:
554
* Get access_type and access_attrib and merge into the field Op
555
* access_type is first operand, access_attribute is second
557
field->common.value.integer =
558
(((u32) ACPI_GET8(parser_state->aml) << 8));
560
field->common.value.integer |= ACPI_GET8(parser_state->aml);
566
/* Opcode was set in previous switch */
573
/*******************************************************************************
575
* FUNCTION: acpi_ps_get_next_arg
577
* PARAMETERS: walk_state - Current state
578
* parser_state - Current parser state object
579
* arg_type - The argument type (AML_*_ARG)
580
* return_arg - Where the next arg is returned
582
* RETURN: Status, and an op object containing the next argument.
584
* DESCRIPTION: Get next argument (including complex list arguments that require
585
* pushing the parser stack)
587
******************************************************************************/
590
acpi_ps_get_next_arg(struct acpi_walk_state *walk_state,
591
struct acpi_parse_state *parser_state,
592
u32 arg_type, union acpi_parse_object **return_arg)
594
union acpi_parse_object *arg = NULL;
595
union acpi_parse_object *prev = NULL;
596
union acpi_parse_object *field;
598
acpi_status status = AE_OK;
600
ACPI_FUNCTION_TRACE_PTR(ps_get_next_arg, parser_state);
608
case ARGP_NAMESTRING:
610
/* Constants, strings, and namestrings are all the same size */
612
arg = acpi_ps_alloc_op(AML_BYTE_OP);
614
return_ACPI_STATUS(AE_NO_MEMORY);
616
acpi_ps_get_next_simple_arg(parser_state, arg_type, arg);
621
/* Package length, nothing returned */
623
parser_state->pkg_end =
624
acpi_ps_get_next_package_end(parser_state);
629
if (parser_state->aml < parser_state->pkg_end) {
633
while (parser_state->aml < parser_state->pkg_end) {
634
field = acpi_ps_get_next_field(parser_state);
636
return_ACPI_STATUS(AE_NO_MEMORY);
640
prev->common.next = field;
647
/* Skip to End of byte data */
649
parser_state->aml = parser_state->pkg_end;
655
if (parser_state->aml < parser_state->pkg_end) {
659
arg = acpi_ps_alloc_op(AML_INT_BYTELIST_OP);
661
return_ACPI_STATUS(AE_NO_MEMORY);
664
/* Fill in bytelist data */
666
arg->common.value.size = (u32)
667
ACPI_PTR_DIFF(parser_state->pkg_end,
669
arg->named.data = parser_state->aml;
671
/* Skip to End of byte data */
673
parser_state->aml = parser_state->pkg_end;
679
case ARGP_SIMPLENAME:
681
subop = acpi_ps_peek_opcode(parser_state);
683
acpi_ps_is_leading_char(subop) ||
684
acpi_ps_is_prefix_char(subop)) {
686
/* null_name or name_string */
688
arg = acpi_ps_alloc_op(AML_INT_NAMEPATH_OP);
690
return_ACPI_STATUS(AE_NO_MEMORY);
693
/* To support super_name arg of Unload */
695
if (walk_state->opcode == AML_UNLOAD_OP) {
697
acpi_ps_get_next_namepath(walk_state,
702
* If the super_name arg of Unload is a method call,
703
* we have restored the AML pointer, just free this Arg
705
if (arg->common.aml_opcode ==
706
AML_INT_METHODCALL_OP) {
707
acpi_ps_free_op(arg);
712
acpi_ps_get_next_namepath(walk_state,
717
/* Single complex argument, nothing returned */
719
walk_state->arg_count = 1;
726
/* Single complex argument, nothing returned */
728
walk_state->arg_count = 1;
731
case ARGP_DATAOBJLIST:
735
if (parser_state->aml < parser_state->pkg_end) {
737
/* Non-empty list of variable arguments, nothing returned */
739
walk_state->arg_count = ACPI_VAR_ARGS;
745
ACPI_ERROR((AE_INFO, "Invalid ArgType: 0x%X", arg_type));
746
status = AE_AML_OPERAND_TYPE;
751
return_ACPI_STATUS(status);