1 /******************************************************************************
3 * Module Name: psargs - Parse AML opcode arguments
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
119 #include <contrib/dev/acpica/acpi.h>
120 #include <contrib/dev/acpica/acparser.h>
121 #include <contrib/dev/acpica/amlcode.h>
122 #include <contrib/dev/acpica/acnamesp.h>
123 #include <contrib/dev/acpica/acdispat.h>
125 #define _COMPONENT ACPI_PARSER
126 ACPI_MODULE_NAME ("psargs")
128 /* Local prototypes */
131 AcpiPsGetNextPackageLength (
132 ACPI_PARSE_STATE *ParserState);
134 static ACPI_PARSE_OBJECT *
136 ACPI_PARSE_STATE *ParserState);
139 /*******************************************************************************
141 * FUNCTION: AcpiPsGetNextPackageLength
143 * PARAMETERS: ParserState - Current parser state object
145 * RETURN: Decoded package length. On completion, the AML pointer points
146 * past the length byte or bytes.
148 * DESCRIPTION: Decode and return a package length field.
149 * Note: Largest package length is 28 bits, from ACPI specification
151 ******************************************************************************/
154 AcpiPsGetNextPackageLength (
155 ACPI_PARSE_STATE *ParserState)
157 UINT8 *Aml = ParserState->Aml;
158 UINT32 PackageLength = 0;
159 ACPI_NATIVE_UINT ByteCount;
160 UINT8 ByteZeroMask = 0x3F; /* Default [0:5] */
163 ACPI_FUNCTION_TRACE (PsGetNextPackageLength);
167 * Byte 0 bits [6:7] contain the number of additional bytes
168 * used to encode the package length, either 0,1,2, or 3
170 ByteCount = (Aml[0] >> 6);
171 ParserState->Aml += (ByteCount + 1);
173 /* Get bytes 3, 2, 1 as needed */
178 * Final bit positions for the package length bytes:
184 PackageLength |= (Aml[ByteCount] << ((ByteCount << 3) - 4));
186 ByteZeroMask = 0x0F; /* Use bits [0:3] of byte 0 */
190 /* Byte 0 is a special case, either bits [0:3] or [0:5] are used */
192 PackageLength |= (Aml[0] & ByteZeroMask);
193 return_UINT32 (PackageLength);
197 /*******************************************************************************
199 * FUNCTION: AcpiPsGetNextPackageEnd
201 * PARAMETERS: ParserState - Current parser state object
203 * RETURN: Pointer to end-of-package +1
205 * DESCRIPTION: Get next package length and return a pointer past the end of
206 * the package. Consumes the package length field
208 ******************************************************************************/
211 AcpiPsGetNextPackageEnd (
212 ACPI_PARSE_STATE *ParserState)
214 UINT8 *Start = ParserState->Aml;
215 UINT32 PackageLength;
218 ACPI_FUNCTION_TRACE (PsGetNextPackageEnd);
221 /* Function below updates ParserState->Aml */
223 PackageLength = AcpiPsGetNextPackageLength (ParserState);
225 return_PTR (Start + PackageLength); /* end of package */
229 /*******************************************************************************
231 * FUNCTION: AcpiPsGetNextNamestring
233 * PARAMETERS: ParserState - Current parser state object
235 * RETURN: Pointer to the start of the name string (pointer points into
238 * DESCRIPTION: Get next raw namestring within the AML stream. Handles all name
239 * prefix characters. Set parser state to point past the string.
240 * (Name is consumed from the AML.)
242 ******************************************************************************/
245 AcpiPsGetNextNamestring (
246 ACPI_PARSE_STATE *ParserState)
248 UINT8 *Start = ParserState->Aml;
249 UINT8 *End = ParserState->Aml;
252 ACPI_FUNCTION_TRACE (PsGetNextNamestring);
255 /* Point past any namestring prefix characters (backslash or carat) */
257 while (AcpiPsIsPrefixChar (*End))
262 /* Decode the path prefix character */
277 case AML_DUAL_NAME_PREFIX:
279 /* Two name segments */
281 End += 1 + (2 * ACPI_NAME_SIZE);
284 case AML_MULTI_NAME_PREFIX_OP:
286 /* Multiple name segments, 4 chars each, count in next byte */
288 End += 2 + (*(End + 1) * ACPI_NAME_SIZE);
293 /* Single name segment */
295 End += ACPI_NAME_SIZE;
299 ParserState->Aml = End;
300 return_PTR ((char *) Start);
304 /*******************************************************************************
306 * FUNCTION: AcpiPsGetNextNamepath
308 * PARAMETERS: ParserState - Current parser state object
309 * Arg - Where the namepath will be stored
310 * ArgCount - If the namepath points to a control method
311 * the method's argument is returned here.
312 * PossibleMethodCall - Whether the namepath can possibly be the
313 * start of a method call
317 * DESCRIPTION: Get next name (if method call, return # of required args).
318 * Names are looked up in the internal namespace to determine
319 * if the name represents a control method. If a method
320 * is found, the number of arguments to the method is returned.
321 * This information is critical for parsing to continue correctly.
323 ******************************************************************************/
326 AcpiPsGetNextNamepath (
327 ACPI_WALK_STATE *WalkState,
328 ACPI_PARSE_STATE *ParserState,
329 ACPI_PARSE_OBJECT *Arg,
330 BOOLEAN PossibleMethodCall)
333 ACPI_PARSE_OBJECT *NameOp;
335 ACPI_OPERAND_OBJECT *MethodDesc;
336 ACPI_NAMESPACE_NODE *Node;
337 ACPI_GENERIC_STATE ScopeInfo;
340 ACPI_FUNCTION_TRACE (PsGetNextNamepath);
343 Path = AcpiPsGetNextNamestring (ParserState);
344 AcpiPsInitOp (Arg, AML_INT_NAMEPATH_OP);
346 /* Null path case is allowed, just exit */
350 Arg->Common.Value.Name = Path;
351 return_ACPI_STATUS (AE_OK);
354 /* Setup search scope info */
356 ScopeInfo.Scope.Node = NULL;
357 Node = ParserState->StartNode;
360 ScopeInfo.Scope.Node = Node;
364 * Lookup the name in the internal namespace. We don't want to add
365 * anything new to the namespace here, however, so we use MODE_EXECUTE.
366 * Allow searching of the parent tree, but don't open a new scope -
367 * we just want to lookup the object (must be mode EXECUTE to perform
370 Status = AcpiNsLookup (&ScopeInfo, Path, ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
371 ACPI_NS_SEARCH_PARENT | ACPI_NS_DONT_OPEN_SCOPE, NULL, &Node);
374 * If this name is a control method invocation, we must
375 * setup the method call
377 if (ACPI_SUCCESS (Status) &&
378 PossibleMethodCall &&
379 (Node->Type == ACPI_TYPE_METHOD))
381 /* This name is actually a control method invocation */
383 MethodDesc = AcpiNsGetAttachedObject (Node);
384 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
385 "Control Method - %p Desc %p Path=%p\n", Node, MethodDesc, Path));
387 NameOp = AcpiPsAllocOp (AML_INT_NAMEPATH_OP);
390 return_ACPI_STATUS (AE_NO_MEMORY);
393 /* Change Arg into a METHOD CALL and attach name to it */
395 AcpiPsInitOp (Arg, AML_INT_METHODCALL_OP);
396 NameOp->Common.Value.Name = Path;
398 /* Point METHODCALL/NAME to the METHOD Node */
400 NameOp->Common.Node = Node;
401 AcpiPsAppendArg (Arg, NameOp);
405 ACPI_ERROR ((AE_INFO,
406 "Control Method %p has no attached object",
408 return_ACPI_STATUS (AE_AML_INTERNAL);
411 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
412 "Control Method - %p Args %X\n",
413 Node, MethodDesc->Method.ParamCount));
415 /* Get the number of arguments to expect */
417 WalkState->ArgCount = MethodDesc->Method.ParamCount;
418 return_ACPI_STATUS (AE_OK);
422 * Special handling if the name was not found during the lookup -
423 * some NotFound cases are allowed
425 if (Status == AE_NOT_FOUND)
427 /* 1) NotFound is ok during load pass 1/2 (allow forward references) */
429 if ((WalkState->ParseFlags & ACPI_PARSE_MODE_MASK) !=
435 /* 2) NotFound during a CondRefOf(x) is ok by definition */
437 else if (WalkState->Op->Common.AmlOpcode == AML_COND_REF_OF_OP)
443 * 3) NotFound while building a Package is ok at this point, we
444 * may flag as an error later if slack mode is not enabled.
445 * (Some ASL code depends on allowing this behavior)
447 else if ((Arg->Common.Parent) &&
448 ((Arg->Common.Parent->Common.AmlOpcode == AML_PACKAGE_OP) ||
449 (Arg->Common.Parent->Common.AmlOpcode == AML_VAR_PACKAGE_OP)))
455 /* Final exception check (may have been changed from code above) */
457 if (ACPI_FAILURE (Status))
459 ACPI_ERROR_NAMESPACE (Path, Status);
461 if ((WalkState->ParseFlags & ACPI_PARSE_MODE_MASK) ==
464 /* Report a control method execution error */
466 Status = AcpiDsMethodError (Status, WalkState);
470 /* Save the namepath */
472 Arg->Common.Value.Name = Path;
473 return_ACPI_STATUS (Status);
477 /*******************************************************************************
479 * FUNCTION: AcpiPsGetNextSimpleArg
481 * PARAMETERS: ParserState - Current parser state object
482 * ArgType - The argument type (AML_*_ARG)
483 * Arg - Where the argument is returned
487 * DESCRIPTION: Get the next simple argument (constant, string, or namestring)
489 ******************************************************************************/
492 AcpiPsGetNextSimpleArg (
493 ACPI_PARSE_STATE *ParserState,
495 ACPI_PARSE_OBJECT *Arg)
499 UINT8 *Aml = ParserState->Aml;
502 ACPI_FUNCTION_TRACE_U32 (PsGetNextSimpleArg, ArgType);
509 /* Get 1 byte from the AML stream */
511 Opcode = AML_BYTE_OP;
512 Arg->Common.Value.Integer = (ACPI_INTEGER) *Aml;
519 /* Get 2 bytes from the AML stream */
521 Opcode = AML_WORD_OP;
522 ACPI_MOVE_16_TO_64 (&Arg->Common.Value.Integer, Aml);
529 /* Get 4 bytes from the AML stream */
531 Opcode = AML_DWORD_OP;
532 ACPI_MOVE_32_TO_64 (&Arg->Common.Value.Integer, Aml);
539 /* Get 8 bytes from the AML stream */
541 Opcode = AML_QWORD_OP;
542 ACPI_MOVE_64_TO_64 (&Arg->Common.Value.Integer, Aml);
549 /* Get a pointer to the string, point past the string */
551 Opcode = AML_STRING_OP;
552 Arg->Common.Value.String = ACPI_CAST_PTR (char, Aml);
554 /* Find the null terminator */
566 case ARGP_NAMESTRING:
568 AcpiPsInitOp (Arg, AML_INT_NAMEPATH_OP);
569 Arg->Common.Value.Name = AcpiPsGetNextNamestring (ParserState);
575 ACPI_ERROR ((AE_INFO, "Invalid ArgType %X", ArgType));
579 AcpiPsInitOp (Arg, Opcode);
580 ParserState->Aml += Length;
585 /*******************************************************************************
587 * FUNCTION: AcpiPsGetNextField
589 * PARAMETERS: ParserState - Current parser state object
591 * RETURN: A newly allocated FIELD op
593 * DESCRIPTION: Get next field (NamedField, ReservedField, or AccessField)
595 ******************************************************************************/
597 static ACPI_PARSE_OBJECT *
599 ACPI_PARSE_STATE *ParserState)
601 UINT32 AmlOffset = (UINT32)
602 ACPI_PTR_DIFF (ParserState->Aml,
603 ParserState->AmlStart);
604 ACPI_PARSE_OBJECT *Field;
609 ACPI_FUNCTION_TRACE (PsGetNextField);
612 /* Determine field type */
614 switch (ACPI_GET8 (ParserState->Aml))
618 Opcode = AML_INT_NAMEDFIELD_OP;
623 Opcode = AML_INT_RESERVEDFIELD_OP;
629 Opcode = AML_INT_ACCESSFIELD_OP;
634 /* Allocate a new field op */
636 Field = AcpiPsAllocOp (Opcode);
642 Field->Common.AmlOffset = AmlOffset;
644 /* Decode the field type */
648 case AML_INT_NAMEDFIELD_OP:
650 /* Get the 4-character name */
652 ACPI_MOVE_32_TO_32 (&Name, ParserState->Aml);
653 AcpiPsSetName (Field, Name);
654 ParserState->Aml += ACPI_NAME_SIZE;
656 /* Get the length which is encoded as a package length */
658 Field->Common.Value.Size = AcpiPsGetNextPackageLength (ParserState);
662 case AML_INT_RESERVEDFIELD_OP:
664 /* Get the length which is encoded as a package length */
666 Field->Common.Value.Size = AcpiPsGetNextPackageLength (ParserState);
670 case AML_INT_ACCESSFIELD_OP:
673 * Get AccessType and AccessAttrib and merge into the field Op
674 * AccessType is first operand, AccessAttribute is second
676 Field->Common.Value.Integer = (((UINT32) ACPI_GET8 (ParserState->Aml) << 8));
678 Field->Common.Value.Integer |= ACPI_GET8 (ParserState->Aml);
684 /* Opcode was set in previous switch */
692 /*******************************************************************************
694 * FUNCTION: AcpiPsGetNextArg
696 * PARAMETERS: WalkState - Current state
697 * ParserState - Current parser state object
698 * ArgType - The argument type (AML_*_ARG)
699 * ReturnArg - Where the next arg is returned
701 * RETURN: Status, and an op object containing the next argument.
703 * DESCRIPTION: Get next argument (including complex list arguments that require
704 * pushing the parser stack)
706 ******************************************************************************/
710 ACPI_WALK_STATE *WalkState,
711 ACPI_PARSE_STATE *ParserState,
713 ACPI_PARSE_OBJECT **ReturnArg)
715 ACPI_PARSE_OBJECT *Arg = NULL;
716 ACPI_PARSE_OBJECT *Prev = NULL;
717 ACPI_PARSE_OBJECT *Field;
719 ACPI_STATUS Status = AE_OK;
722 ACPI_FUNCTION_TRACE_PTR (PsGetNextArg, ParserState);
732 case ARGP_NAMESTRING:
734 /* Constants, strings, and namestrings are all the same size */
736 Arg = AcpiPsAllocOp (AML_BYTE_OP);
739 return_ACPI_STATUS (AE_NO_MEMORY);
741 AcpiPsGetNextSimpleArg (ParserState, ArgType, Arg);
747 /* Package length, nothing returned */
749 ParserState->PkgEnd = AcpiPsGetNextPackageEnd (ParserState);
755 if (ParserState->Aml < ParserState->PkgEnd)
759 while (ParserState->Aml < ParserState->PkgEnd)
761 Field = AcpiPsGetNextField (ParserState);
764 return_ACPI_STATUS (AE_NO_MEMORY);
769 Prev->Common.Next = Field;
778 /* Skip to End of byte data */
780 ParserState->Aml = ParserState->PkgEnd;
787 if (ParserState->Aml < ParserState->PkgEnd)
791 Arg = AcpiPsAllocOp (AML_INT_BYTELIST_OP);
794 return_ACPI_STATUS (AE_NO_MEMORY);
797 /* Fill in bytelist data */
799 Arg->Common.Value.Size = (UINT32)
800 ACPI_PTR_DIFF (ParserState->PkgEnd, ParserState->Aml);
801 Arg->Named.Data = ParserState->Aml;
803 /* Skip to End of byte data */
805 ParserState->Aml = ParserState->PkgEnd;
812 case ARGP_SIMPLENAME:
814 Subop = AcpiPsPeekOpcode (ParserState);
816 AcpiPsIsLeadingChar (Subop) ||
817 AcpiPsIsPrefixChar (Subop))
819 /* NullName or NameString */
821 Arg = AcpiPsAllocOp (AML_INT_NAMEPATH_OP);
824 return_ACPI_STATUS (AE_NO_MEMORY);
827 Status = AcpiPsGetNextNamepath (WalkState, ParserState, Arg, 0);
831 /* Single complex argument, nothing returned */
833 WalkState->ArgCount = 1;
841 /* Single complex argument, nothing returned */
843 WalkState->ArgCount = 1;
847 case ARGP_DATAOBJLIST:
851 if (ParserState->Aml < ParserState->PkgEnd)
853 /* Non-empty list of variable arguments, nothing returned */
855 WalkState->ArgCount = ACPI_VAR_ARGS;
862 ACPI_ERROR ((AE_INFO, "Invalid ArgType: %X", ArgType));
863 Status = AE_AML_OPERAND_TYPE;
868 return_ACPI_STATUS (Status);