2 /******************************************************************************
4 * Module Name: exnames - interpreter/scanner name load/execute
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
118 #define __EXNAMES_C__
120 #include <contrib/dev/acpica/acpi.h>
121 #include <contrib/dev/acpica/acinterp.h>
122 #include <contrib/dev/acpica/amlcode.h>
124 #define _COMPONENT ACPI_EXECUTER
125 ACPI_MODULE_NAME ("exnames")
127 /* Local prototypes */
130 AcpiExAllocateNameString (
136 UINT8 **InAmlAddress,
140 /*******************************************************************************
142 * FUNCTION: AcpiExAllocateNameString
144 * PARAMETERS: PrefixCount - Count of parent levels. Special cases:
145 * (-1)==root, 0==none
146 * NumNameSegs - count of 4-character name segments
148 * RETURN: A pointer to the allocated string segment. This segment must
149 * be deleted by the caller.
151 * DESCRIPTION: Allocate a buffer for a name string. Ensure allocated name
152 * string is long enough, and set up prefix if any.
154 ******************************************************************************/
157 AcpiExAllocateNameString (
165 ACPI_FUNCTION_TRACE (ExAllocateNameString);
169 * Allow room for all \ and ^ prefixes, all segments and a MultiNamePrefix.
170 * Also, one byte for the null terminator.
171 * This may actually be somewhat longer than needed.
173 if (PrefixCount == ACPI_UINT32_MAX)
175 /* Special case for root */
177 SizeNeeded = 1 + (ACPI_NAME_SIZE * NumNameSegs) + 2 + 1;
181 SizeNeeded = PrefixCount + (ACPI_NAME_SIZE * NumNameSegs) + 2 + 1;
185 * Allocate a buffer for the name.
186 * This buffer must be deleted by the caller!
188 NameString = ACPI_ALLOCATE (SizeNeeded);
191 ACPI_ERROR ((AE_INFO,
192 "Could not allocate size %d", SizeNeeded));
196 TempPtr = NameString;
198 /* Set up Root or Parent prefixes if needed */
200 if (PrefixCount == ACPI_UINT32_MAX)
202 *TempPtr++ = AML_ROOT_PREFIX;
206 while (PrefixCount--)
208 *TempPtr++ = AML_PARENT_PREFIX;
213 /* Set up Dual or Multi prefixes if needed */
217 /* Set up multi prefixes */
219 *TempPtr++ = AML_MULTI_NAME_PREFIX_OP;
220 *TempPtr++ = (char) NumNameSegs;
222 else if (2 == NumNameSegs)
224 /* Set up dual prefixes */
226 *TempPtr++ = AML_DUAL_NAME_PREFIX;
230 * Terminate string following prefixes. AcpiExNameSegment() will
231 * append the segment(s)
235 return_PTR (NameString);
238 /*******************************************************************************
240 * FUNCTION: AcpiExNameSegment
242 * PARAMETERS: InAmlAddress - Pointer to the name in the AML code
243 * NameString - Where to return the name. The name is appended
244 * to any existing string to form a namepath
248 * DESCRIPTION: Extract an ACPI name (4 bytes) from the AML byte stream
250 ******************************************************************************/
254 UINT8 **InAmlAddress,
257 char *AmlAddress = (void *) *InAmlAddress;
258 ACPI_STATUS Status = AE_OK;
263 ACPI_FUNCTION_TRACE (ExNameSegment);
267 * If first character is a digit, then we know that we aren't looking at a
270 CharBuf[0] = *AmlAddress;
272 if ('0' <= CharBuf[0] && CharBuf[0] <= '9')
274 ACPI_ERROR ((AE_INFO, "Invalid leading digit: %c", CharBuf[0]));
275 return_ACPI_STATUS (AE_CTRL_PENDING);
278 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "Bytes from stream:\n"));
281 (Index < ACPI_NAME_SIZE) && (AcpiUtValidAcpiChar (*AmlAddress, 0));
284 CharBuf[Index] = *AmlAddress++;
285 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "%c\n", CharBuf[Index]));
289 /* Valid name segment */
293 /* Found 4 valid characters */
299 ACPI_STRCAT (NameString, CharBuf);
300 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
301 "Appended to - %s\n", NameString));
305 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
306 "No Name string - %s\n", CharBuf));
312 * First character was not a valid name character,
313 * so we are looking at something other than a name.
315 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
316 "Leading character is not alpha: %02Xh (not a name)\n",
318 Status = AE_CTRL_PENDING;
323 * Segment started with one or more valid characters, but fewer than
326 Status = AE_AML_BAD_NAME;
327 ACPI_ERROR ((AE_INFO,
328 "Bad character %02x in name, at %p",
329 *AmlAddress, AmlAddress));
332 *InAmlAddress = ACPI_CAST_PTR (UINT8, AmlAddress);
333 return_ACPI_STATUS (Status);
337 /*******************************************************************************
339 * FUNCTION: AcpiExGetNameString
341 * PARAMETERS: DataType - Object type to be associated with this
343 * InAmlAddress - Pointer to the namestring in the AML code
344 * OutNameString - Where the namestring is returned
345 * OutNameLength - Length of the returned string
347 * RETURN: Status, namestring and length
349 * DESCRIPTION: Extract a full namepath from the AML byte stream,
350 * including any prefixes.
352 ******************************************************************************/
355 AcpiExGetNameString (
356 ACPI_OBJECT_TYPE DataType,
358 char **OutNameString,
359 UINT32 *OutNameLength)
361 ACPI_STATUS Status = AE_OK;
362 UINT8 *AmlAddress = InAmlAddress;
363 char *NameString = NULL;
365 UINT32 PrefixCount = 0;
366 BOOLEAN HasPrefix = FALSE;
369 ACPI_FUNCTION_TRACE_PTR (ExGetNameString, AmlAddress);
372 if (ACPI_TYPE_LOCAL_REGION_FIELD == DataType ||
373 ACPI_TYPE_LOCAL_BANK_FIELD == DataType ||
374 ACPI_TYPE_LOCAL_INDEX_FIELD == DataType)
376 /* Disallow prefixes for types associated with FieldUnit names */
378 NameString = AcpiExAllocateNameString (0, 1);
381 Status = AE_NO_MEMORY;
385 Status = AcpiExNameSegment (&AmlAddress, NameString);
391 * DataType is not a field name.
392 * Examine first character of name for root or parent prefix operators
396 case AML_ROOT_PREFIX:
398 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "RootPrefix(\\) at %p\n",
402 * Remember that we have a RootPrefix --
403 * see comment in AcpiExAllocateNameString()
406 PrefixCount = ACPI_UINT32_MAX;
411 case AML_PARENT_PREFIX:
413 /* Increment past possibly multiple parent prefixes */
417 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "ParentPrefix (^) at %p\n",
423 } while (*AmlAddress == AML_PARENT_PREFIX);
431 /* Not a prefix character */
436 /* Examine first character of name for name segment prefix operator */
440 case AML_DUAL_NAME_PREFIX:
442 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "DualNamePrefix at %p\n",
446 NameString = AcpiExAllocateNameString (PrefixCount, 2);
449 Status = AE_NO_MEMORY;
453 /* Indicate that we processed a prefix */
457 Status = AcpiExNameSegment (&AmlAddress, NameString);
458 if (ACPI_SUCCESS (Status))
460 Status = AcpiExNameSegment (&AmlAddress, NameString);
465 case AML_MULTI_NAME_PREFIX_OP:
467 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "MultiNamePrefix at %p\n",
470 /* Fetch count of segments remaining in name path */
473 NumSegments = *AmlAddress;
475 NameString = AcpiExAllocateNameString (PrefixCount, NumSegments);
478 Status = AE_NO_MEMORY;
482 /* Indicate that we processed a prefix */
487 while (NumSegments &&
488 (Status = AcpiExNameSegment (&AmlAddress, NameString)) ==
499 /* NullName valid as of 8-12-98 ASL/AML Grammar Update */
501 if (PrefixCount == ACPI_UINT32_MAX)
503 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
504 "NameSeg is \"\\\" followed by NULL\n"));
507 /* Consume the NULL byte */
510 NameString = AcpiExAllocateNameString (PrefixCount, 0);
513 Status = AE_NO_MEMORY;
522 /* Name segment string */
524 NameString = AcpiExAllocateNameString (PrefixCount, 1);
527 Status = AE_NO_MEMORY;
531 Status = AcpiExNameSegment (&AmlAddress, NameString);
536 if (AE_CTRL_PENDING == Status && HasPrefix)
538 /* Ran out of segments after processing a prefix */
540 ACPI_ERROR ((AE_INFO,
541 "Malformed Name at %p", NameString));
542 Status = AE_AML_BAD_NAME;
545 if (ACPI_FAILURE (Status))
549 ACPI_FREE (NameString);
551 return_ACPI_STATUS (Status);
554 *OutNameString = NameString;
555 *OutNameLength = (UINT32) (AmlAddress - InAmlAddress);
557 return_ACPI_STATUS (Status);