1 /******************************************************************************
3 * Module Name: psargs - Parse AML opcode arguments
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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.
51 #define _COMPONENT ACPI_PARSER
52 ACPI_MODULE_NAME ("psargs")
54 /* Local prototypes */
57 AcpiPsGetNextPackageLength (
58 ACPI_PARSE_STATE
*ParserState
);
60 static ACPI_PARSE_OBJECT
*
62 ACPI_PARSE_STATE
*ParserState
);
65 /*******************************************************************************
67 * FUNCTION: AcpiPsGetNextPackageLength
69 * PARAMETERS: ParserState - Current parser state object
71 * RETURN: Decoded package length. On completion, the AML pointer points
72 * past the length byte or bytes.
74 * DESCRIPTION: Decode and return a package length field.
75 * Note: Largest package length is 28 bits, from ACPI specification
77 ******************************************************************************/
80 AcpiPsGetNextPackageLength (
81 ACPI_PARSE_STATE
*ParserState
)
83 UINT8
*Aml
= ParserState
->Aml
;
84 UINT32 PackageLength
= 0;
86 UINT8 ByteZeroMask
= 0x3F; /* Default [0:5] */
89 ACPI_FUNCTION_TRACE (PsGetNextPackageLength
);
93 * Byte 0 bits [6:7] contain the number of additional bytes
94 * used to encode the package length, either 0,1,2, or 3
96 ByteCount
= (Aml
[0] >> 6);
97 ParserState
->Aml
+= ((ACPI_SIZE
) ByteCount
+ 1);
99 /* Get bytes 3, 2, 1 as needed */
104 * Final bit positions for the package length bytes:
110 PackageLength
|= (Aml
[ByteCount
] << ((ByteCount
<< 3) - 4));
112 ByteZeroMask
= 0x0F; /* Use bits [0:3] of byte 0 */
116 /* Byte 0 is a special case, either bits [0:3] or [0:5] are used */
118 PackageLength
|= (Aml
[0] & ByteZeroMask
);
119 return_UINT32 (PackageLength
);
123 /*******************************************************************************
125 * FUNCTION: AcpiPsGetNextPackageEnd
127 * PARAMETERS: ParserState - Current parser state object
129 * RETURN: Pointer to end-of-package +1
131 * DESCRIPTION: Get next package length and return a pointer past the end of
132 * the package. Consumes the package length field
134 ******************************************************************************/
137 AcpiPsGetNextPackageEnd (
138 ACPI_PARSE_STATE
*ParserState
)
140 UINT8
*Start
= ParserState
->Aml
;
141 UINT32 PackageLength
;
144 ACPI_FUNCTION_TRACE (PsGetNextPackageEnd
);
147 /* Function below updates ParserState->Aml */
149 PackageLength
= AcpiPsGetNextPackageLength (ParserState
);
151 return_PTR (Start
+ PackageLength
); /* end of package */
155 /*******************************************************************************
157 * FUNCTION: AcpiPsGetNextNamestring
159 * PARAMETERS: ParserState - Current parser state object
161 * RETURN: Pointer to the start of the name string (pointer points into
164 * DESCRIPTION: Get next raw namestring within the AML stream. Handles all name
165 * prefix characters. Set parser state to point past the string.
166 * (Name is consumed from the AML.)
168 ******************************************************************************/
171 AcpiPsGetNextNamestring (
172 ACPI_PARSE_STATE
*ParserState
)
174 UINT8
*Start
= ParserState
->Aml
;
175 UINT8
*End
= ParserState
->Aml
;
178 ACPI_FUNCTION_TRACE (PsGetNextNamestring
);
181 /* Point past any namestring prefix characters (backslash or carat) */
183 while (ACPI_IS_ROOT_PREFIX (*End
) ||
184 ACPI_IS_PARENT_PREFIX (*End
))
189 /* Decode the path prefix character */
204 case AML_DUAL_NAME_PREFIX
:
206 /* Two name segments */
208 End
+= 1 + (2 * ACPI_NAME_SIZE
);
211 case AML_MULTI_NAME_PREFIX_OP
:
213 /* Multiple name segments, 4 chars each, count in next byte */
215 End
+= 2 + (*(End
+ 1) * ACPI_NAME_SIZE
);
220 /* Single name segment */
222 End
+= ACPI_NAME_SIZE
;
226 ParserState
->Aml
= End
;
227 return_PTR ((char *) Start
);
231 /*******************************************************************************
233 * FUNCTION: AcpiPsGetNextNamepath
235 * PARAMETERS: ParserState - Current parser state object
236 * Arg - Where the namepath will be stored
237 * ArgCount - If the namepath points to a control method
238 * the method's argument is returned here.
239 * PossibleMethodCall - Whether the namepath can possibly be the
240 * start of a method call
244 * DESCRIPTION: Get next name (if method call, return # of required args).
245 * Names are looked up in the internal namespace to determine
246 * if the name represents a control method. If a method
247 * is found, the number of arguments to the method is returned.
248 * This information is critical for parsing to continue correctly.
250 ******************************************************************************/
253 AcpiPsGetNextNamepath (
254 ACPI_WALK_STATE
*WalkState
,
255 ACPI_PARSE_STATE
*ParserState
,
256 ACPI_PARSE_OBJECT
*Arg
,
257 BOOLEAN PossibleMethodCall
)
261 ACPI_PARSE_OBJECT
*NameOp
;
262 ACPI_OPERAND_OBJECT
*MethodDesc
;
263 ACPI_NAMESPACE_NODE
*Node
;
264 UINT8
*Start
= ParserState
->Aml
;
267 ACPI_FUNCTION_TRACE (PsGetNextNamepath
);
270 Path
= AcpiPsGetNextNamestring (ParserState
);
271 AcpiPsInitOp (Arg
, AML_INT_NAMEPATH_OP
);
273 /* Null path case is allowed, just exit */
277 Arg
->Common
.Value
.Name
= Path
;
278 return_ACPI_STATUS (AE_OK
);
282 * Lookup the name in the internal namespace, starting with the current
283 * scope. We don't want to add anything new to the namespace here,
284 * however, so we use MODE_EXECUTE.
285 * Allow searching of the parent tree, but don't open a new scope -
286 * we just want to lookup the object (must be mode EXECUTE to perform
289 Status
= AcpiNsLookup (WalkState
->ScopeInfo
, Path
,
290 ACPI_TYPE_ANY
, ACPI_IMODE_EXECUTE
,
291 ACPI_NS_SEARCH_PARENT
| ACPI_NS_DONT_OPEN_SCOPE
, NULL
, &Node
);
294 * If this name is a control method invocation, we must
295 * setup the method call
297 if (ACPI_SUCCESS (Status
) &&
298 PossibleMethodCall
&&
299 (Node
->Type
== ACPI_TYPE_METHOD
))
301 /* This name is actually a control method invocation */
303 MethodDesc
= AcpiNsGetAttachedObject (Node
);
304 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE
,
305 "Control Method invocation %4.4s - %p Desc %p Path=%p\n",
306 Node
->Name
.Ascii
, Node
, MethodDesc
, Path
));
308 NameOp
= AcpiPsAllocOp (AML_INT_NAMEPATH_OP
, Start
);
311 return_ACPI_STATUS (AE_NO_MEMORY
);
314 /* Change Arg into a METHOD CALL and attach name to it */
316 AcpiPsInitOp (Arg
, AML_INT_METHODCALL_OP
);
317 NameOp
->Common
.Value
.Name
= Path
;
319 /* Point METHODCALL/NAME to the METHOD Node */
321 NameOp
->Common
.Node
= Node
;
322 AcpiPsAppendArg (Arg
, NameOp
);
326 ACPI_ERROR ((AE_INFO
,
327 "Control Method %p has no attached object",
329 return_ACPI_STATUS (AE_AML_INTERNAL
);
332 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE
,
333 "Control Method - %p Args %X\n",
334 Node
, MethodDesc
->Method
.ParamCount
));
336 /* Get the number of arguments to expect */
338 WalkState
->ArgCount
= MethodDesc
->Method
.ParamCount
;
339 return_ACPI_STATUS (AE_OK
);
343 * Special handling if the name was not found during the lookup -
344 * some NotFound cases are allowed
346 if (Status
== AE_NOT_FOUND
)
348 /* 1) NotFound is ok during load pass 1/2 (allow forward references) */
350 if ((WalkState
->ParseFlags
& ACPI_PARSE_MODE_MASK
) !=
356 /* 2) NotFound during a CondRefOf(x) is ok by definition */
358 else if (WalkState
->Op
->Common
.AmlOpcode
== AML_COND_REF_OF_OP
)
364 * 3) NotFound while building a Package is ok at this point, we
365 * may flag as an error later if slack mode is not enabled.
366 * (Some ASL code depends on allowing this behavior)
368 else if ((Arg
->Common
.Parent
) &&
369 ((Arg
->Common
.Parent
->Common
.AmlOpcode
== AML_PACKAGE_OP
) ||
370 (Arg
->Common
.Parent
->Common
.AmlOpcode
== AML_VAR_PACKAGE_OP
)))
376 /* Final exception check (may have been changed from code above) */
378 if (ACPI_FAILURE (Status
))
380 ACPI_ERROR_NAMESPACE (Path
, Status
);
382 if ((WalkState
->ParseFlags
& ACPI_PARSE_MODE_MASK
) ==
385 /* Report a control method execution error */
387 Status
= AcpiDsMethodError (Status
, WalkState
);
391 /* Save the namepath */
393 Arg
->Common
.Value
.Name
= Path
;
394 return_ACPI_STATUS (Status
);
398 /*******************************************************************************
400 * FUNCTION: AcpiPsGetNextSimpleArg
402 * PARAMETERS: ParserState - Current parser state object
403 * ArgType - The argument type (AML_*_ARG)
404 * Arg - Where the argument is returned
408 * DESCRIPTION: Get the next simple argument (constant, string, or namestring)
410 ******************************************************************************/
413 AcpiPsGetNextSimpleArg (
414 ACPI_PARSE_STATE
*ParserState
,
416 ACPI_PARSE_OBJECT
*Arg
)
420 UINT8
*Aml
= ParserState
->Aml
;
423 ACPI_FUNCTION_TRACE_U32 (PsGetNextSimpleArg
, ArgType
);
430 /* Get 1 byte from the AML stream */
432 Opcode
= AML_BYTE_OP
;
433 Arg
->Common
.Value
.Integer
= (UINT64
) *Aml
;
439 /* Get 2 bytes from the AML stream */
441 Opcode
= AML_WORD_OP
;
442 ACPI_MOVE_16_TO_64 (&Arg
->Common
.Value
.Integer
, Aml
);
448 /* Get 4 bytes from the AML stream */
450 Opcode
= AML_DWORD_OP
;
451 ACPI_MOVE_32_TO_64 (&Arg
->Common
.Value
.Integer
, Aml
);
457 /* Get 8 bytes from the AML stream */
459 Opcode
= AML_QWORD_OP
;
460 ACPI_MOVE_64_TO_64 (&Arg
->Common
.Value
.Integer
, Aml
);
466 /* Get a pointer to the string, point past the string */
468 Opcode
= AML_STRING_OP
;
469 Arg
->Common
.Value
.String
= ACPI_CAST_PTR (char, Aml
);
471 /* Find the null terminator */
482 case ARGP_NAMESTRING
:
484 AcpiPsInitOp (Arg
, AML_INT_NAMEPATH_OP
);
485 Arg
->Common
.Value
.Name
= AcpiPsGetNextNamestring (ParserState
);
490 ACPI_ERROR ((AE_INFO
, "Invalid ArgType 0x%X", ArgType
));
494 AcpiPsInitOp (Arg
, Opcode
);
495 ParserState
->Aml
+= Length
;
500 /*******************************************************************************
502 * FUNCTION: AcpiPsGetNextField
504 * PARAMETERS: ParserState - Current parser state object
506 * RETURN: A newly allocated FIELD op
508 * DESCRIPTION: Get next field (NamedField, ReservedField, or AccessField)
510 ******************************************************************************/
512 static ACPI_PARSE_OBJECT
*
514 ACPI_PARSE_STATE
*ParserState
)
517 ACPI_PARSE_OBJECT
*Field
;
518 ACPI_PARSE_OBJECT
*Arg
= NULL
;
522 UINT8 AccessAttribute
;
529 ACPI_FUNCTION_TRACE (PsGetNextField
);
532 Aml
= ParserState
->Aml
;
534 /* Determine field type */
536 switch (ACPI_GET8 (ParserState
->Aml
))
538 case AML_FIELD_OFFSET_OP
:
540 Opcode
= AML_INT_RESERVEDFIELD_OP
;
544 case AML_FIELD_ACCESS_OP
:
546 Opcode
= AML_INT_ACCESSFIELD_OP
;
550 case AML_FIELD_CONNECTION_OP
:
552 Opcode
= AML_INT_CONNECTION_OP
;
556 case AML_FIELD_EXT_ACCESS_OP
:
558 Opcode
= AML_INT_EXTACCESSFIELD_OP
;
564 Opcode
= AML_INT_NAMEDFIELD_OP
;
568 /* Allocate a new field op */
570 Field
= AcpiPsAllocOp (Opcode
, Aml
);
576 /* Decode the field type */
580 case AML_INT_NAMEDFIELD_OP
:
582 /* Get the 4-character name */
584 ACPI_MOVE_32_TO_32 (&Name
, ParserState
->Aml
);
585 AcpiPsSetName (Field
, Name
);
586 ParserState
->Aml
+= ACPI_NAME_SIZE
;
588 /* Get the length which is encoded as a package length */
590 Field
->Common
.Value
.Size
= AcpiPsGetNextPackageLength (ParserState
);
594 case AML_INT_RESERVEDFIELD_OP
:
596 /* Get the length which is encoded as a package length */
598 Field
->Common
.Value
.Size
= AcpiPsGetNextPackageLength (ParserState
);
602 case AML_INT_ACCESSFIELD_OP
:
603 case AML_INT_EXTACCESSFIELD_OP
:
606 * Get AccessType and AccessAttrib and merge into the field Op
607 * AccessType is first operand, AccessAttribute is second. stuff
608 * these bytes into the node integer value for convenience.
611 /* Get the two bytes (Type/Attribute) */
613 AccessType
= ACPI_GET8 (ParserState
->Aml
);
615 AccessAttribute
= ACPI_GET8 (ParserState
->Aml
);
618 Field
->Common
.Value
.Integer
= (UINT8
) AccessType
;
619 Field
->Common
.Value
.Integer
|= (UINT16
) (AccessAttribute
<< 8);
621 /* This opcode has a third byte, AccessLength */
623 if (Opcode
== AML_INT_EXTACCESSFIELD_OP
)
625 AccessLength
= ACPI_GET8 (ParserState
->Aml
);
628 Field
->Common
.Value
.Integer
|= (UINT32
) (AccessLength
<< 16);
633 case AML_INT_CONNECTION_OP
:
636 * Argument for Connection operator can be either a Buffer
637 * (resource descriptor), or a NameString.
639 Aml
= ParserState
->Aml
;
640 if (ACPI_GET8 (ParserState
->Aml
) == AML_BUFFER_OP
)
644 PkgEnd
= ParserState
->Aml
;
645 PkgLength
= AcpiPsGetNextPackageLength (ParserState
);
648 if (ParserState
->Aml
< PkgEnd
)
652 Arg
= AcpiPsAllocOp (AML_INT_BYTELIST_OP
, Aml
);
655 AcpiPsFreeOp (Field
);
659 /* Get the actual buffer length argument */
661 Opcode
= ACPI_GET8 (ParserState
->Aml
);
666 case AML_BYTE_OP
: /* AML_BYTEDATA_ARG */
668 BufferLength
= ACPI_GET8 (ParserState
->Aml
);
669 ParserState
->Aml
+= 1;
672 case AML_WORD_OP
: /* AML_WORDDATA_ARG */
674 BufferLength
= ACPI_GET16 (ParserState
->Aml
);
675 ParserState
->Aml
+= 2;
678 case AML_DWORD_OP
: /* AML_DWORDATA_ARG */
680 BufferLength
= ACPI_GET32 (ParserState
->Aml
);
681 ParserState
->Aml
+= 4;
690 /* Fill in bytelist data */
692 Arg
->Named
.Value
.Size
= BufferLength
;
693 Arg
->Named
.Data
= ParserState
->Aml
;
696 /* Skip to End of byte data */
698 ParserState
->Aml
= PkgEnd
;
702 Arg
= AcpiPsAllocOp (AML_INT_NAMEPATH_OP
, Aml
);
705 AcpiPsFreeOp (Field
);
709 /* Get the Namestring argument */
711 Arg
->Common
.Value
.Name
= AcpiPsGetNextNamestring (ParserState
);
714 /* Link the buffer/namestring to parent (CONNECTION_OP) */
716 AcpiPsAppendArg (Field
, Arg
);
722 /* Opcode was set in previous switch */
730 /*******************************************************************************
732 * FUNCTION: AcpiPsGetNextArg
734 * PARAMETERS: WalkState - Current state
735 * ParserState - Current parser state object
736 * ArgType - The argument type (AML_*_ARG)
737 * ReturnArg - Where the next arg is returned
739 * RETURN: Status, and an op object containing the next argument.
741 * DESCRIPTION: Get next argument (including complex list arguments that require
742 * pushing the parser stack)
744 ******************************************************************************/
748 ACPI_WALK_STATE
*WalkState
,
749 ACPI_PARSE_STATE
*ParserState
,
751 ACPI_PARSE_OBJECT
**ReturnArg
)
753 ACPI_PARSE_OBJECT
*Arg
= NULL
;
754 ACPI_PARSE_OBJECT
*Prev
= NULL
;
755 ACPI_PARSE_OBJECT
*Field
;
757 ACPI_STATUS Status
= AE_OK
;
760 ACPI_FUNCTION_TRACE_PTR (PsGetNextArg
, ParserState
);
763 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE
,
764 "Expected argument type ARGP: %s (%2.2X)\n",
765 AcpiUtGetArgumentTypeName (ArgType
), ArgType
));
774 case ARGP_NAMESTRING
:
776 /* Constants, strings, and namestrings are all the same size */
778 Arg
= AcpiPsAllocOp (AML_BYTE_OP
, ParserState
->Aml
);
781 return_ACPI_STATUS (AE_NO_MEMORY
);
784 AcpiPsGetNextSimpleArg (ParserState
, ArgType
, Arg
);
789 /* Package length, nothing returned */
791 ParserState
->PkgEnd
= AcpiPsGetNextPackageEnd (ParserState
);
796 if (ParserState
->Aml
< ParserState
->PkgEnd
)
800 while (ParserState
->Aml
< ParserState
->PkgEnd
)
802 Field
= AcpiPsGetNextField (ParserState
);
805 return_ACPI_STATUS (AE_NO_MEMORY
);
810 Prev
->Common
.Next
= Field
;
819 /* Skip to End of byte data */
821 ParserState
->Aml
= ParserState
->PkgEnd
;
827 if (ParserState
->Aml
< ParserState
->PkgEnd
)
831 Arg
= AcpiPsAllocOp (AML_INT_BYTELIST_OP
,
835 return_ACPI_STATUS (AE_NO_MEMORY
);
838 /* Fill in bytelist data */
840 Arg
->Common
.Value
.Size
= (UINT32
)
841 ACPI_PTR_DIFF (ParserState
->PkgEnd
, ParserState
->Aml
);
842 Arg
->Named
.Data
= ParserState
->Aml
;
844 /* Skip to End of byte data */
846 ParserState
->Aml
= ParserState
->PkgEnd
;
850 case ARGP_SIMPLENAME
:
851 case ARGP_NAME_OR_REF
:
853 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE
,
854 "**** SimpleName/NameOrRef: %s (%2.2X)\n",
855 AcpiUtGetArgumentTypeName (ArgType
), ArgType
));
857 Subop
= AcpiPsPeekOpcode (ParserState
);
859 AcpiPsIsLeadingChar (Subop
) ||
860 ACPI_IS_ROOT_PREFIX (Subop
) ||
861 ACPI_IS_PARENT_PREFIX (Subop
))
863 /* NullName or NameString */
865 Arg
= AcpiPsAllocOp (AML_INT_NAMEPATH_OP
, ParserState
->Aml
);
868 return_ACPI_STATUS (AE_NO_MEMORY
);
871 Status
= AcpiPsGetNextNamepath (WalkState
, ParserState
,
872 Arg
, ACPI_NOT_METHOD_CALL
);
876 /* Single complex argument, nothing returned */
878 WalkState
->ArgCount
= 1;
885 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE
,
886 "**** Target/Supername: %s (%2.2X)\n",
887 AcpiUtGetArgumentTypeName (ArgType
), ArgType
));
889 Subop
= AcpiPsPeekOpcode (ParserState
);
892 /* NULL target (zero). Convert to a NULL namepath */
894 Arg
= AcpiPsAllocOp (AML_INT_NAMEPATH_OP
, ParserState
->Aml
);
897 return_ACPI_STATUS (AE_NO_MEMORY
);
900 Status
= AcpiPsGetNextNamepath (WalkState
, ParserState
,
901 Arg
, ACPI_POSSIBLE_METHOD_CALL
);
905 /* Single complex argument, nothing returned */
907 WalkState
->ArgCount
= 1;
915 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE
,
916 "**** TermArg/DataObj: %s (%2.2X)\n",
917 AcpiUtGetArgumentTypeName (ArgType
), ArgType
));
919 /* Single complex argument, nothing returned */
921 WalkState
->ArgCount
= 1;
924 case ARGP_DATAOBJLIST
:
928 if (ParserState
->Aml
< ParserState
->PkgEnd
)
930 /* Non-empty list of variable arguments, nothing returned */
932 WalkState
->ArgCount
= ACPI_VAR_ARGS
;
938 ACPI_ERROR ((AE_INFO
, "Invalid ArgType: 0x%X", ArgType
));
939 Status
= AE_AML_OPERAND_TYPE
;
944 return_ACPI_STATUS (Status
);