1 /******************************************************************************
3 * Module Name: psargs - Parse AML opcode arguments
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2017, 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_IS_ROOT_PREFIX(*end) || ACPI_IS_PARENT_PREFIX(*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:
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 ((GET_CURRENT_ARG_TYPE(walk_state->arg_types) ==
274 || (GET_CURRENT_ARG_TYPE(walk_state->arg_types) ==
277 * acpi_ps_get_next_namestring has increased the AML pointer past
278 * the method invocation namestring, so we need to restore the
279 * saved AML pointer back to the original method invocation
282 walk_state->parser_state.aml = start;
283 walk_state->arg_count = 1;
284 acpi_ps_init_op(arg, AML_INT_METHODCALL_OP);
287 /* This name is actually a control method invocation */
289 method_desc = acpi_ns_get_attached_object(node);
290 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
291 "Control Method invocation %4.4s - %p Desc %p Path=%p\n",
292 node->name.ascii, node, method_desc, path));
294 name_op = acpi_ps_alloc_op(AML_INT_NAMEPATH_OP, start);
296 return_ACPI_STATUS(AE_NO_MEMORY);
299 /* Change Arg into a METHOD CALL and attach name to it */
301 acpi_ps_init_op(arg, AML_INT_METHODCALL_OP);
302 name_op->common.value.name = path;
304 /* Point METHODCALL/NAME to the METHOD Node */
306 name_op->common.node = node;
307 acpi_ps_append_arg(arg, name_op);
311 "Control Method %p has no attached object",
313 return_ACPI_STATUS(AE_AML_INTERNAL);
316 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
317 "Control Method - %p Args %X\n",
318 node, method_desc->method.param_count));
320 /* Get the number of arguments to expect */
322 walk_state->arg_count = method_desc->method.param_count;
323 return_ACPI_STATUS(AE_OK);
327 * Special handling if the name was not found during the lookup -
328 * some not_found cases are allowed
330 if (status == AE_NOT_FOUND) {
332 /* 1) not_found is ok during load pass 1/2 (allow forward references) */
334 if ((walk_state->parse_flags & ACPI_PARSE_MODE_MASK) !=
335 ACPI_PARSE_EXECUTE) {
339 /* 2) not_found during a cond_ref_of(x) is ok by definition */
341 else if (walk_state->op->common.aml_opcode ==
342 AML_CONDITIONAL_REF_OF_OP) {
347 * 3) not_found while building a Package is ok at this point, we
348 * may flag as an error later if slack mode is not enabled.
349 * (Some ASL code depends on allowing this behavior)
351 else if ((arg->common.parent) &&
352 ((arg->common.parent->common.aml_opcode ==
354 || (arg->common.parent->common.aml_opcode ==
355 AML_VARIABLE_PACKAGE_OP))) {
360 /* Final exception check (may have been changed from code above) */
362 if (ACPI_FAILURE(status)) {
363 ACPI_ERROR_NAMESPACE(path, status);
365 if ((walk_state->parse_flags & ACPI_PARSE_MODE_MASK) ==
366 ACPI_PARSE_EXECUTE) {
368 /* Report a control method execution error */
370 status = acpi_ds_method_error(status, walk_state);
374 /* Save the namepath */
376 arg->common.value.name = path;
377 return_ACPI_STATUS(status);
380 /*******************************************************************************
382 * FUNCTION: acpi_ps_get_next_simple_arg
384 * PARAMETERS: parser_state - Current parser state object
385 * arg_type - The argument type (AML_*_ARG)
386 * arg - Where the argument is returned
390 * DESCRIPTION: Get the next simple argument (constant, string, or namestring)
392 ******************************************************************************/
395 acpi_ps_get_next_simple_arg(struct acpi_parse_state *parser_state,
396 u32 arg_type, union acpi_parse_object *arg)
400 u8 *aml = parser_state->aml;
402 ACPI_FUNCTION_TRACE_U32(ps_get_next_simple_arg, arg_type);
407 /* Get 1 byte from the AML stream */
409 opcode = AML_BYTE_OP;
410 arg->common.value.integer = (u64) *aml;
416 /* Get 2 bytes from the AML stream */
418 opcode = AML_WORD_OP;
419 ACPI_MOVE_16_TO_64(&arg->common.value.integer, aml);
425 /* Get 4 bytes from the AML stream */
427 opcode = AML_DWORD_OP;
428 ACPI_MOVE_32_TO_64(&arg->common.value.integer, aml);
434 /* Get 8 bytes from the AML stream */
436 opcode = AML_QWORD_OP;
437 ACPI_MOVE_64_TO_64(&arg->common.value.integer, aml);
443 /* Get a pointer to the string, point past the string */
445 opcode = AML_STRING_OP;
446 arg->common.value.string = ACPI_CAST_PTR(char, aml);
448 /* Find the null terminator */
451 while (aml[length]) {
458 case ARGP_NAMESTRING:
460 acpi_ps_init_op(arg, AML_INT_NAMEPATH_OP);
461 arg->common.value.name =
462 acpi_ps_get_next_namestring(parser_state);
467 ACPI_ERROR((AE_INFO, "Invalid ArgType 0x%X", arg_type));
471 acpi_ps_init_op(arg, opcode);
472 parser_state->aml += length;
476 /*******************************************************************************
478 * FUNCTION: acpi_ps_get_next_field
480 * PARAMETERS: parser_state - Current parser state object
482 * RETURN: A newly allocated FIELD op
484 * DESCRIPTION: Get next field (named_field, reserved_field, or access_field)
486 ******************************************************************************/
488 static union acpi_parse_object *acpi_ps_get_next_field(struct acpi_parse_state
492 union acpi_parse_object *field;
493 union acpi_parse_object *arg = NULL;
503 ACPI_FUNCTION_TRACE(ps_get_next_field);
505 aml = parser_state->aml;
507 /* Determine field type */
509 switch (ACPI_GET8(parser_state->aml)) {
510 case AML_FIELD_OFFSET_OP:
512 opcode = AML_INT_RESERVEDFIELD_OP;
516 case AML_FIELD_ACCESS_OP:
518 opcode = AML_INT_ACCESSFIELD_OP;
522 case AML_FIELD_CONNECTION_OP:
524 opcode = AML_INT_CONNECTION_OP;
528 case AML_FIELD_EXT_ACCESS_OP:
530 opcode = AML_INT_EXTACCESSFIELD_OP;
536 opcode = AML_INT_NAMEDFIELD_OP;
540 /* Allocate a new field op */
542 field = acpi_ps_alloc_op(opcode, aml);
547 /* Decode the field type */
550 case AML_INT_NAMEDFIELD_OP:
552 /* Get the 4-character name */
554 ACPI_MOVE_32_TO_32(&name, parser_state->aml);
555 acpi_ps_set_name(field, name);
556 parser_state->aml += ACPI_NAME_SIZE;
558 /* Get the length which is encoded as a package length */
560 field->common.value.size =
561 acpi_ps_get_next_package_length(parser_state);
564 case AML_INT_RESERVEDFIELD_OP:
566 /* Get the length which is encoded as a package length */
568 field->common.value.size =
569 acpi_ps_get_next_package_length(parser_state);
572 case AML_INT_ACCESSFIELD_OP:
573 case AML_INT_EXTACCESSFIELD_OP:
576 * Get access_type and access_attrib and merge into the field Op
577 * access_type is first operand, access_attribute is second. stuff
578 * these bytes into the node integer value for convenience.
581 /* Get the two bytes (Type/Attribute) */
583 access_type = ACPI_GET8(parser_state->aml);
585 access_attribute = ACPI_GET8(parser_state->aml);
588 field->common.value.integer = (u8)access_type;
589 field->common.value.integer |= (u16)(access_attribute << 8);
591 /* This opcode has a third byte, access_length */
593 if (opcode == AML_INT_EXTACCESSFIELD_OP) {
594 access_length = ACPI_GET8(parser_state->aml);
597 field->common.value.integer |=
598 (u32)(access_length << 16);
602 case AML_INT_CONNECTION_OP:
605 * Argument for Connection operator can be either a Buffer
606 * (resource descriptor), or a name_string.
608 aml = parser_state->aml;
609 if (ACPI_GET8(parser_state->aml) == AML_BUFFER_OP) {
612 pkg_end = parser_state->aml;
614 acpi_ps_get_next_package_length(parser_state);
615 pkg_end += pkg_length;
617 if (parser_state->aml < pkg_end) {
622 acpi_ps_alloc_op(AML_INT_BYTELIST_OP, aml);
624 acpi_ps_free_op(field);
628 /* Get the actual buffer length argument */
630 opcode = ACPI_GET8(parser_state->aml);
634 case AML_BYTE_OP: /* AML_BYTEDATA_ARG */
637 ACPI_GET8(parser_state->aml);
638 parser_state->aml += 1;
641 case AML_WORD_OP: /* AML_WORDDATA_ARG */
644 ACPI_GET16(parser_state->aml);
645 parser_state->aml += 2;
648 case AML_DWORD_OP: /* AML_DWORDATA_ARG */
651 ACPI_GET32(parser_state->aml);
652 parser_state->aml += 4;
661 /* Fill in bytelist data */
663 arg->named.value.size = buffer_length;
664 arg->named.data = parser_state->aml;
667 /* Skip to End of byte data */
669 parser_state->aml = pkg_end;
671 arg = acpi_ps_alloc_op(AML_INT_NAMEPATH_OP, aml);
673 acpi_ps_free_op(field);
677 /* Get the Namestring argument */
679 arg->common.value.name =
680 acpi_ps_get_next_namestring(parser_state);
683 /* Link the buffer/namestring to parent (CONNECTION_OP) */
685 acpi_ps_append_arg(field, arg);
690 /* Opcode was set in previous switch */
697 /*******************************************************************************
699 * FUNCTION: acpi_ps_get_next_arg
701 * PARAMETERS: walk_state - Current state
702 * parser_state - Current parser state object
703 * arg_type - The argument type (AML_*_ARG)
704 * return_arg - Where the next arg is returned
706 * RETURN: Status, and an op object containing the next argument.
708 * DESCRIPTION: Get next argument (including complex list arguments that require
709 * pushing the parser stack)
711 ******************************************************************************/
714 acpi_ps_get_next_arg(struct acpi_walk_state *walk_state,
715 struct acpi_parse_state *parser_state,
716 u32 arg_type, union acpi_parse_object **return_arg)
718 union acpi_parse_object *arg = NULL;
719 union acpi_parse_object *prev = NULL;
720 union acpi_parse_object *field;
722 acpi_status status = AE_OK;
724 ACPI_FUNCTION_TRACE_PTR(ps_get_next_arg, parser_state);
726 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
727 "Expected argument type ARGP: %s (%2.2X)\n",
728 acpi_ut_get_argument_type_name(arg_type), arg_type));
736 case ARGP_NAMESTRING:
738 /* Constants, strings, and namestrings are all the same size */
740 arg = acpi_ps_alloc_op(AML_BYTE_OP, parser_state->aml);
742 return_ACPI_STATUS(AE_NO_MEMORY);
745 acpi_ps_get_next_simple_arg(parser_state, arg_type, arg);
750 /* Package length, nothing returned */
752 parser_state->pkg_end =
753 acpi_ps_get_next_package_end(parser_state);
758 if (parser_state->aml < parser_state->pkg_end) {
762 while (parser_state->aml < parser_state->pkg_end) {
763 field = acpi_ps_get_next_field(parser_state);
765 return_ACPI_STATUS(AE_NO_MEMORY);
769 prev->common.next = field;
776 /* Skip to End of byte data */
778 parser_state->aml = parser_state->pkg_end;
784 if (parser_state->aml < parser_state->pkg_end) {
788 arg = acpi_ps_alloc_op(AML_INT_BYTELIST_OP,
791 return_ACPI_STATUS(AE_NO_MEMORY);
794 /* Fill in bytelist data */
796 arg->common.value.size = (u32)
797 ACPI_PTR_DIFF(parser_state->pkg_end,
799 arg->named.data = parser_state->aml;
801 /* Skip to End of byte data */
803 parser_state->aml = parser_state->pkg_end;
807 case ARGP_SIMPLENAME:
808 case ARGP_NAME_OR_REF:
810 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
811 "**** SimpleName/NameOrRef: %s (%2.2X)\n",
812 acpi_ut_get_argument_type_name(arg_type),
815 subop = acpi_ps_peek_opcode(parser_state);
817 acpi_ps_is_leading_char(subop) ||
818 ACPI_IS_ROOT_PREFIX(subop) ||
819 ACPI_IS_PARENT_PREFIX(subop)) {
821 /* null_name or name_string */
824 acpi_ps_alloc_op(AML_INT_NAMEPATH_OP,
827 return_ACPI_STATUS(AE_NO_MEMORY);
831 acpi_ps_get_next_namepath(walk_state, parser_state,
833 ACPI_NOT_METHOD_CALL);
835 /* Single complex argument, nothing returned */
837 walk_state->arg_count = 1;
844 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
845 "**** Target/Supername: %s (%2.2X)\n",
846 acpi_ut_get_argument_type_name(arg_type),
849 subop = acpi_ps_peek_opcode(parser_state);
851 acpi_ps_is_leading_char(subop) ||
852 ACPI_IS_ROOT_PREFIX(subop) ||
853 ACPI_IS_PARENT_PREFIX(subop)) {
855 /* NULL target (zero). Convert to a NULL namepath */
858 acpi_ps_alloc_op(AML_INT_NAMEPATH_OP,
861 return_ACPI_STATUS(AE_NO_MEMORY);
865 acpi_ps_get_next_namepath(walk_state, parser_state,
867 ACPI_POSSIBLE_METHOD_CALL);
869 if (arg->common.aml_opcode == AML_INT_METHODCALL_OP) {
870 acpi_ps_free_op(arg);
872 walk_state->arg_count = 1;
875 /* Single complex argument, nothing returned */
877 walk_state->arg_count = 1;
884 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
885 "**** TermArg/DataObj: %s (%2.2X)\n",
886 acpi_ut_get_argument_type_name(arg_type),
889 /* Single complex argument, nothing returned */
891 walk_state->arg_count = 1;
894 case ARGP_DATAOBJLIST:
898 if (parser_state->aml < parser_state->pkg_end) {
900 /* Non-empty list of variable arguments, nothing returned */
902 walk_state->arg_count = ACPI_VAR_ARGS;
908 ACPI_ERROR((AE_INFO, "Invalid ArgType: 0x%X", arg_type));
909 status = AE_AML_OPERAND_TYPE;
914 return_ACPI_STATUS(status);