[ACPI] ACPICA 20051216
[linux-2.6/kvm.git] / drivers / acpi / parser / psargs.c
blobe6d4cb9fd3034d5a189b229a58e3dbf321db04fa
1 /******************************************************************************
3 * Module Name: psargs - Parse AML opcode arguments
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2005, R. Byron Moore
9 * All rights reserved.
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.
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.
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.
44 #include <acpi/acpi.h>
45 #include <acpi/acparser.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acnamesp.h>
48 #include <acpi/acdispat.h>
50 #define _COMPONENT ACPI_PARSER
51 ACPI_MODULE_NAME("psargs")
53 /* Local prototypes */
54 static u32
55 acpi_ps_get_next_package_length(struct acpi_parse_state *parser_state);
57 static union acpi_parse_object *acpi_ps_get_next_field(struct acpi_parse_state
58 *parser_state);
60 /*******************************************************************************
62 * FUNCTION: acpi_ps_get_next_package_length
64 * PARAMETERS: parser_state - Current parser state object
66 * RETURN: Decoded package length. On completion, the AML pointer points
67 * past the length byte or bytes.
69 * DESCRIPTION: Decode and return a package length field.
70 * Note: Largest package length is 28 bits, from ACPI specification
72 ******************************************************************************/
74 static u32
75 acpi_ps_get_next_package_length(struct acpi_parse_state *parser_state)
77 u8 *aml = parser_state->aml;
78 u32 package_length = 0;
79 acpi_native_uint byte_count;
80 u8 byte_zero_mask = 0x3F; /* Default [0:5] */
82 ACPI_FUNCTION_TRACE("ps_get_next_package_length");
85 * Byte 0 bits [6:7] contain the number of additional bytes
86 * used to encode the package length, either 0,1,2, or 3
88 byte_count = (aml[0] >> 6);
89 parser_state->aml += (byte_count + 1);
91 /* Get bytes 3, 2, 1 as needed */
93 while (byte_count) {
95 * Final bit positions for the package length bytes:
96 * Byte3->[20:27]
97 * Byte2->[12:19]
98 * Byte1->[04:11]
99 * Byte0->[00:03]
101 package_length |= (aml[byte_count] << ((byte_count << 3) - 4));
103 byte_zero_mask = 0x0F; /* Use bits [0:3] of byte 0 */
104 byte_count--;
107 /* Byte 0 is a special case, either bits [0:3] or [0:5] are used */
109 package_length |= (aml[0] & byte_zero_mask);
110 return_UINT32(package_length);
113 /*******************************************************************************
115 * FUNCTION: acpi_ps_get_next_package_end
117 * PARAMETERS: parser_state - Current parser state object
119 * RETURN: Pointer to end-of-package +1
121 * DESCRIPTION: Get next package length and return a pointer past the end of
122 * the package. Consumes the package length field
124 ******************************************************************************/
126 u8 *acpi_ps_get_next_package_end(struct acpi_parse_state *parser_state)
128 u8 *start = parser_state->aml;
129 u32 package_length;
131 ACPI_FUNCTION_TRACE("ps_get_next_package_end");
133 /* Function below updates parser_state->Aml */
135 package_length = acpi_ps_get_next_package_length(parser_state);
137 return_PTR(start + package_length); /* end of package */
140 /*******************************************************************************
142 * FUNCTION: acpi_ps_get_next_namestring
144 * PARAMETERS: parser_state - Current parser state object
146 * RETURN: Pointer to the start of the name string (pointer points into
147 * the AML.
149 * DESCRIPTION: Get next raw namestring within the AML stream. Handles all name
150 * prefix characters. Set parser state to point past the string.
151 * (Name is consumed from the AML.)
153 ******************************************************************************/
155 char *acpi_ps_get_next_namestring(struct acpi_parse_state *parser_state)
157 u8 *start = parser_state->aml;
158 u8 *end = parser_state->aml;
160 ACPI_FUNCTION_TRACE("ps_get_next_namestring");
162 /* Point past any namestring prefix characters (backslash or carat) */
164 while (acpi_ps_is_prefix_char(*end)) {
165 end++;
168 /* Decode the path prefix character */
170 switch (*end) {
171 case 0:
173 /* null_name */
175 if (end == start) {
176 start = NULL;
178 end++;
179 break;
181 case AML_DUAL_NAME_PREFIX:
183 /* Two name segments */
185 end += 1 + (2 * ACPI_NAME_SIZE);
186 break;
188 case AML_MULTI_NAME_PREFIX_OP:
190 /* Multiple name segments, 4 chars each, count in next byte */
192 end += 2 + (*(end + 1) * ACPI_NAME_SIZE);
193 break;
195 default:
197 /* Single name segment */
199 end += ACPI_NAME_SIZE;
200 break;
203 parser_state->aml = end;
204 return_PTR((char *)start);
207 /*******************************************************************************
209 * FUNCTION: acpi_ps_get_next_namepath
211 * PARAMETERS: parser_state - Current parser state object
212 * Arg - Where the namepath will be stored
213 * arg_count - If the namepath points to a control method
214 * the method's argument is returned here.
215 * possible_method_call - Whether the namepath can possibly be the
216 * start of a method call
218 * RETURN: Status
220 * DESCRIPTION: Get next name (if method call, return # of required args).
221 * Names are looked up in the internal namespace to determine
222 * if the name represents a control method. If a method
223 * is found, the number of arguments to the method is returned.
224 * This information is critical for parsing to continue correctly.
226 ******************************************************************************/
228 acpi_status
229 acpi_ps_get_next_namepath(struct acpi_walk_state *walk_state,
230 struct acpi_parse_state *parser_state,
231 union acpi_parse_object *arg, u8 possible_method_call)
233 char *path;
234 union acpi_parse_object *name_op;
235 acpi_status status;
236 union acpi_operand_object *method_desc;
237 struct acpi_namespace_node *node;
238 union acpi_generic_state scope_info;
240 ACPI_FUNCTION_TRACE("ps_get_next_namepath");
242 path = acpi_ps_get_next_namestring(parser_state);
243 acpi_ps_init_op(arg, AML_INT_NAMEPATH_OP);
245 /* Null path case is allowed, just exit */
247 if (!path) {
248 arg->common.value.name = path;
249 return_ACPI_STATUS(AE_OK);
252 /* Setup search scope info */
254 scope_info.scope.node = NULL;
255 node = parser_state->start_node;
256 if (node) {
257 scope_info.scope.node = node;
261 * Lookup the name in the internal namespace. We don't want to add
262 * anything new to the namespace here, however, so we use MODE_EXECUTE.
263 * Allow searching of the parent tree, but don't open a new scope -
264 * we just want to lookup the object (must be mode EXECUTE to perform
265 * the upsearch)
267 status =
268 acpi_ns_lookup(&scope_info, path, ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
269 ACPI_NS_SEARCH_PARENT | ACPI_NS_DONT_OPEN_SCOPE,
270 NULL, &node);
273 * If this name is a control method invocation, we must
274 * setup the method call
276 if (ACPI_SUCCESS(status) &&
277 possible_method_call && (node->type == ACPI_TYPE_METHOD)) {
278 /* This name is actually a control method invocation */
280 method_desc = acpi_ns_get_attached_object(node);
281 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
282 "Control Method - %p Desc %p Path=%p\n", node,
283 method_desc, path));
285 name_op = acpi_ps_alloc_op(AML_INT_NAMEPATH_OP);
286 if (!name_op) {
287 return_ACPI_STATUS(AE_NO_MEMORY);
290 /* Change Arg into a METHOD CALL and attach name to it */
292 acpi_ps_init_op(arg, AML_INT_METHODCALL_OP);
293 name_op->common.value.name = path;
295 /* Point METHODCALL/NAME to the METHOD Node */
297 name_op->common.node = node;
298 acpi_ps_append_arg(arg, name_op);
300 if (!method_desc) {
301 ACPI_REPORT_ERROR(("ps_get_next_namepath: Control Method %p has no attached object\n", node));
302 return_ACPI_STATUS(AE_AML_INTERNAL);
305 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
306 "Control Method - %p Args %X\n",
307 node, method_desc->method.param_count));
309 /* Get the number of arguments to expect */
311 walk_state->arg_count = method_desc->method.param_count;
312 return_ACPI_STATUS(AE_OK);
316 * Special handling if the name was not found during the lookup -
317 * some not_found cases are allowed
319 if (status == AE_NOT_FOUND) {
320 /* 1) not_found is ok during load pass 1/2 (allow forward references) */
322 if ((walk_state->parse_flags & ACPI_PARSE_MODE_MASK) !=
323 ACPI_PARSE_EXECUTE) {
324 status = AE_OK;
327 /* 2) not_found during a cond_ref_of(x) is ok by definition */
329 else if (walk_state->op->common.aml_opcode ==
330 AML_COND_REF_OF_OP) {
331 status = AE_OK;
335 * 3) not_found while building a Package is ok at this point, we
336 * may flag as an error later if slack mode is not enabled.
337 * (Some ASL code depends on allowing this behavior)
339 else if ((arg->common.parent) &&
340 ((arg->common.parent->common.aml_opcode ==
341 AML_PACKAGE_OP)
342 || (arg->common.parent->common.aml_opcode ==
343 AML_VAR_PACKAGE_OP))) {
344 status = AE_OK;
348 /* Final exception check (may have been changed from code above) */
350 if (ACPI_FAILURE(status)) {
351 ACPI_REPORT_NSERROR(path, status);
353 if ((walk_state->parse_flags & ACPI_PARSE_MODE_MASK) ==
354 ACPI_PARSE_EXECUTE) {
355 /* Report a control method execution error */
357 status = acpi_ds_method_error(status, walk_state);
361 /* Save the namepath */
363 arg->common.value.name = path;
364 return_ACPI_STATUS(status);
367 /*******************************************************************************
369 * FUNCTION: acpi_ps_get_next_simple_arg
371 * PARAMETERS: parser_state - Current parser state object
372 * arg_type - The argument type (AML_*_ARG)
373 * Arg - Where the argument is returned
375 * RETURN: None
377 * DESCRIPTION: Get the next simple argument (constant, string, or namestring)
379 ******************************************************************************/
381 void
382 acpi_ps_get_next_simple_arg(struct acpi_parse_state *parser_state,
383 u32 arg_type, union acpi_parse_object *arg)
385 u32 length;
386 u16 opcode;
387 u8 *aml = parser_state->aml;
389 ACPI_FUNCTION_TRACE_U32("ps_get_next_simple_arg", arg_type);
391 switch (arg_type) {
392 case ARGP_BYTEDATA:
394 /* Get 1 byte from the AML stream */
396 opcode = AML_BYTE_OP;
397 arg->common.value.integer = (acpi_integer) * aml;
398 length = 1;
399 break;
401 case ARGP_WORDDATA:
403 /* Get 2 bytes from the AML stream */
405 opcode = AML_WORD_OP;
406 ACPI_MOVE_16_TO_64(&arg->common.value.integer, aml);
407 length = 2;
408 break;
410 case ARGP_DWORDDATA:
412 /* Get 4 bytes from the AML stream */
414 opcode = AML_DWORD_OP;
415 ACPI_MOVE_32_TO_64(&arg->common.value.integer, aml);
416 length = 4;
417 break;
419 case ARGP_QWORDDATA:
421 /* Get 8 bytes from the AML stream */
423 opcode = AML_QWORD_OP;
424 ACPI_MOVE_64_TO_64(&arg->common.value.integer, aml);
425 length = 8;
426 break;
428 case ARGP_CHARLIST:
430 /* Get a pointer to the string, point past the string */
432 opcode = AML_STRING_OP;
433 arg->common.value.string = ACPI_CAST_PTR(char, aml);
435 /* Find the null terminator */
437 length = 0;
438 while (aml[length]) {
439 length++;
441 length++;
442 break;
444 case ARGP_NAME:
445 case ARGP_NAMESTRING:
447 acpi_ps_init_op(arg, AML_INT_NAMEPATH_OP);
448 arg->common.value.name =
449 acpi_ps_get_next_namestring(parser_state);
450 return_VOID;
452 default:
454 ACPI_REPORT_ERROR(("Invalid arg_type %X\n", arg_type));
455 return_VOID;
458 acpi_ps_init_op(arg, opcode);
459 parser_state->aml += length;
460 return_VOID;
463 /*******************************************************************************
465 * FUNCTION: acpi_ps_get_next_field
467 * PARAMETERS: parser_state - Current parser state object
469 * RETURN: A newly allocated FIELD op
471 * DESCRIPTION: Get next field (named_field, reserved_field, or access_field)
473 ******************************************************************************/
475 static union acpi_parse_object *acpi_ps_get_next_field(struct acpi_parse_state
476 *parser_state)
478 u32 aml_offset = (u32)
479 ACPI_PTR_DIFF(parser_state->aml,
480 parser_state->aml_start);
481 union acpi_parse_object *field;
482 u16 opcode;
483 u32 name;
485 ACPI_FUNCTION_TRACE("ps_get_next_field");
487 /* Determine field type */
489 switch (ACPI_GET8(parser_state->aml)) {
490 default:
492 opcode = AML_INT_NAMEDFIELD_OP;
493 break;
495 case 0x00:
497 opcode = AML_INT_RESERVEDFIELD_OP;
498 parser_state->aml++;
499 break;
501 case 0x01:
503 opcode = AML_INT_ACCESSFIELD_OP;
504 parser_state->aml++;
505 break;
508 /* Allocate a new field op */
510 field = acpi_ps_alloc_op(opcode);
511 if (!field) {
512 return_PTR(NULL);
515 field->common.aml_offset = aml_offset;
517 /* Decode the field type */
519 switch (opcode) {
520 case AML_INT_NAMEDFIELD_OP:
522 /* Get the 4-character name */
524 ACPI_MOVE_32_TO_32(&name, parser_state->aml);
525 acpi_ps_set_name(field, name);
526 parser_state->aml += ACPI_NAME_SIZE;
528 /* Get the length which is encoded as a package length */
530 field->common.value.size =
531 acpi_ps_get_next_package_length(parser_state);
532 break;
534 case AML_INT_RESERVEDFIELD_OP:
536 /* Get the length which is encoded as a package length */
538 field->common.value.size =
539 acpi_ps_get_next_package_length(parser_state);
540 break;
542 case AML_INT_ACCESSFIELD_OP:
545 * Get access_type and access_attrib and merge into the field Op
546 * access_type is first operand, access_attribute is second
548 field->common.value.integer =
549 (((u32) ACPI_GET8(parser_state->aml) << 8));
550 parser_state->aml++;
551 field->common.value.integer |= ACPI_GET8(parser_state->aml);
552 parser_state->aml++;
553 break;
555 default:
557 /* Opcode was set in previous switch */
558 break;
561 return_PTR(field);
564 /*******************************************************************************
566 * FUNCTION: acpi_ps_get_next_arg
568 * PARAMETERS: walk_state - Current state
569 * parser_state - Current parser state object
570 * arg_type - The argument type (AML_*_ARG)
571 * return_arg - Where the next arg is returned
573 * RETURN: Status, and an op object containing the next argument.
575 * DESCRIPTION: Get next argument (including complex list arguments that require
576 * pushing the parser stack)
578 ******************************************************************************/
580 acpi_status
581 acpi_ps_get_next_arg(struct acpi_walk_state *walk_state,
582 struct acpi_parse_state *parser_state,
583 u32 arg_type, union acpi_parse_object **return_arg)
585 union acpi_parse_object *arg = NULL;
586 union acpi_parse_object *prev = NULL;
587 union acpi_parse_object *field;
588 u32 subop;
589 acpi_status status = AE_OK;
591 ACPI_FUNCTION_TRACE_PTR("ps_get_next_arg", parser_state);
593 switch (arg_type) {
594 case ARGP_BYTEDATA:
595 case ARGP_WORDDATA:
596 case ARGP_DWORDDATA:
597 case ARGP_CHARLIST:
598 case ARGP_NAME:
599 case ARGP_NAMESTRING:
601 /* Constants, strings, and namestrings are all the same size */
603 arg = acpi_ps_alloc_op(AML_BYTE_OP);
604 if (!arg) {
605 return_ACPI_STATUS(AE_NO_MEMORY);
607 acpi_ps_get_next_simple_arg(parser_state, arg_type, arg);
608 break;
610 case ARGP_PKGLENGTH:
612 /* Package length, nothing returned */
614 parser_state->pkg_end =
615 acpi_ps_get_next_package_end(parser_state);
616 break;
618 case ARGP_FIELDLIST:
620 if (parser_state->aml < parser_state->pkg_end) {
621 /* Non-empty list */
623 while (parser_state->aml < parser_state->pkg_end) {
624 field = acpi_ps_get_next_field(parser_state);
625 if (!field) {
626 return_ACPI_STATUS(AE_NO_MEMORY);
629 if (prev) {
630 prev->common.next = field;
631 } else {
632 arg = field;
634 prev = field;
637 /* Skip to End of byte data */
639 parser_state->aml = parser_state->pkg_end;
641 break;
643 case ARGP_BYTELIST:
645 if (parser_state->aml < parser_state->pkg_end) {
646 /* Non-empty list */
648 arg = acpi_ps_alloc_op(AML_INT_BYTELIST_OP);
649 if (!arg) {
650 return_ACPI_STATUS(AE_NO_MEMORY);
653 /* Fill in bytelist data */
655 arg->common.value.size = (u32)
656 ACPI_PTR_DIFF(parser_state->pkg_end,
657 parser_state->aml);
658 arg->named.data = parser_state->aml;
660 /* Skip to End of byte data */
662 parser_state->aml = parser_state->pkg_end;
664 break;
666 case ARGP_TARGET:
667 case ARGP_SUPERNAME:
668 case ARGP_SIMPLENAME:
670 subop = acpi_ps_peek_opcode(parser_state);
671 if (subop == 0 ||
672 acpi_ps_is_leading_char(subop) ||
673 acpi_ps_is_prefix_char(subop)) {
674 /* null_name or name_string */
676 arg = acpi_ps_alloc_op(AML_INT_NAMEPATH_OP);
677 if (!arg) {
678 return_ACPI_STATUS(AE_NO_MEMORY);
681 status =
682 acpi_ps_get_next_namepath(walk_state, parser_state,
683 arg, 0);
684 } else {
685 /* Single complex argument, nothing returned */
687 walk_state->arg_count = 1;
689 break;
691 case ARGP_DATAOBJ:
692 case ARGP_TERMARG:
694 /* Single complex argument, nothing returned */
696 walk_state->arg_count = 1;
697 break;
699 case ARGP_DATAOBJLIST:
700 case ARGP_TERMLIST:
701 case ARGP_OBJLIST:
703 if (parser_state->aml < parser_state->pkg_end) {
704 /* Non-empty list of variable arguments, nothing returned */
706 walk_state->arg_count = ACPI_VAR_ARGS;
708 break;
710 default:
712 ACPI_REPORT_ERROR(("Invalid arg_type: %X\n", arg_type));
713 status = AE_AML_OPERAND_TYPE;
714 break;
717 *return_arg = arg;
718 return_ACPI_STATUS(status);