1 /******************************************************************************
3 * Module Name: nsxfname - Public interfaces to the ACPI subsystem
4 * ACPI Namespace oriented interfaces
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2009, 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 *****************************************************************************/
117 #define __NSXFNAME_C__
119 #include <contrib/dev/acpica/include/acpi.h>
120 #include <contrib/dev/acpica/include/accommon.h>
121 #include <contrib/dev/acpica/include/acnamesp.h>
122 #include <contrib/dev/acpica/include/acparser.h>
123 #include <contrib/dev/acpica/include/amlcode.h>
126 #define _COMPONENT ACPI_NAMESPACE
127 ACPI_MODULE_NAME ("nsxfname")
130 /******************************************************************************
132 * FUNCTION: AcpiGetHandle
134 * PARAMETERS: Parent - Object to search under (search scope).
135 * Pathname - Pointer to an asciiz string containing the
137 * RetHandle - Where the return handle is returned
141 * DESCRIPTION: This routine will search for a caller specified name in the
142 * name space. The caller can restrict the search region by
143 * specifying a non NULL parent. The parent value is itself a
146 ******************************************************************************/
151 ACPI_STRING Pathname,
152 ACPI_HANDLE *RetHandle)
155 ACPI_NAMESPACE_NODE *Node = NULL;
156 ACPI_NAMESPACE_NODE *PrefixNode = NULL;
159 ACPI_FUNCTION_ENTRY ();
162 /* Parameter Validation */
164 if (!RetHandle || !Pathname)
166 return (AE_BAD_PARAMETER);
169 /* Convert a parent handle to a prefix node */
173 PrefixNode = AcpiNsMapHandleToNode (Parent);
176 return (AE_BAD_PARAMETER);
182 * 1) Fully qualified pathname
183 * 2) Parent + Relative pathname
185 * Error for <null Parent + relative path>
187 if (AcpiNsValidRootPrefix (Pathname[0]))
189 /* Pathname is fully qualified (starts with '\') */
191 /* Special case for root-only, since we can't search for it */
193 if (!ACPI_STRCMP (Pathname, ACPI_NS_ROOT_PATH))
195 *RetHandle = AcpiNsConvertEntryToHandle (AcpiGbl_RootNode);
199 else if (!PrefixNode)
201 /* Relative path with null prefix is disallowed */
203 return (AE_BAD_PARAMETER);
206 /* Find the Node and convert to a handle */
208 Status = AcpiNsGetNode (PrefixNode, Pathname, ACPI_NS_NO_UPSEARCH, &Node);
209 if (ACPI_SUCCESS (Status))
211 *RetHandle = AcpiNsConvertEntryToHandle (Node);
217 ACPI_EXPORT_SYMBOL (AcpiGetHandle)
220 /******************************************************************************
222 * FUNCTION: AcpiGetName
224 * PARAMETERS: Handle - Handle to be converted to a pathname
225 * NameType - Full pathname or single segment
226 * Buffer - Buffer for returned path
228 * RETURN: Pointer to a string containing the fully qualified Name.
230 * DESCRIPTION: This routine returns the fully qualified name associated with
231 * the Handle parameter. This and the AcpiPathnameToHandle are
232 * complementary functions.
234 ******************************************************************************/
243 ACPI_NAMESPACE_NODE *Node;
246 /* Parameter validation */
248 if (NameType > ACPI_NAME_TYPE_MAX)
250 return (AE_BAD_PARAMETER);
253 Status = AcpiUtValidateBuffer (Buffer);
254 if (ACPI_FAILURE (Status))
259 if (NameType == ACPI_FULL_PATHNAME)
261 /* Get the full pathname (From the namespace root) */
263 Status = AcpiNsHandleToPathname (Handle, Buffer);
268 * Wants the single segment ACPI name.
269 * Validate handle and convert to a namespace Node
271 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
272 if (ACPI_FAILURE (Status))
277 Node = AcpiNsMapHandleToNode (Handle);
280 Status = AE_BAD_PARAMETER;
284 /* Validate/Allocate/Clear caller buffer */
286 Status = AcpiUtInitializeBuffer (Buffer, ACPI_PATH_SEGMENT_LENGTH);
287 if (ACPI_FAILURE (Status))
292 /* Just copy the ACPI name from the Node and zero terminate it */
294 ACPI_STRNCPY (Buffer->Pointer, AcpiUtGetNodeName (Node),
296 ((char *) Buffer->Pointer) [ACPI_NAME_SIZE] = 0;
302 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
306 ACPI_EXPORT_SYMBOL (AcpiGetName)
309 /******************************************************************************
311 * FUNCTION: AcpiGetObjectInfo
313 * PARAMETERS: Handle - Object Handle
314 * Buffer - Where the info is returned
318 * DESCRIPTION: Returns information about an object as gleaned from the
319 * namespace node and possibly by running several standard
320 * control methods (Such as in the case of a device.)
322 ******************************************************************************/
330 ACPI_NAMESPACE_NODE *Node;
331 ACPI_DEVICE_INFO *Info;
332 ACPI_DEVICE_INFO *ReturnInfo;
333 ACPI_COMPATIBLE_ID_LIST *CidList = NULL;
337 /* Parameter validation */
339 if (!Handle || !Buffer)
341 return (AE_BAD_PARAMETER);
344 Status = AcpiUtValidateBuffer (Buffer);
345 if (ACPI_FAILURE (Status))
350 Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_DEVICE_INFO));
353 return (AE_NO_MEMORY);
356 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
357 if (ACPI_FAILURE (Status))
362 Node = AcpiNsMapHandleToNode (Handle);
365 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
366 Status = AE_BAD_PARAMETER;
370 /* Init return structure */
372 Size = sizeof (ACPI_DEVICE_INFO);
374 Info->Type = Node->Type;
375 Info->Name = Node->Name.Integer;
378 if (Node->Type == ACPI_TYPE_METHOD)
380 Info->ParamCount = Node->Object->Method.ParamCount;
383 Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
384 if (ACPI_FAILURE (Status))
389 /* If not a device, we are all done */
391 if (Info->Type == ACPI_TYPE_DEVICE)
394 * Get extra info for ACPI Devices objects only:
395 * Run the Device _HID, _UID, _CID, _STA, _ADR and _SxD methods.
397 * Note: none of these methods are required, so they may or may
398 * not be present for this device. The Info->Valid bitfield is used
399 * to indicate which methods were found and ran successfully.
402 /* Execute the Device._HID method */
404 Status = AcpiUtExecute_HID (Node, &Info->HardwareId);
405 if (ACPI_SUCCESS (Status))
407 Info->Valid |= ACPI_VALID_HID;
410 /* Execute the Device._UID method */
412 Status = AcpiUtExecute_UID (Node, &Info->UniqueId);
413 if (ACPI_SUCCESS (Status))
415 Info->Valid |= ACPI_VALID_UID;
418 /* Execute the Device._CID method */
420 Status = AcpiUtExecute_CID (Node, &CidList);
421 if (ACPI_SUCCESS (Status))
423 Size += CidList->Size;
424 Info->Valid |= ACPI_VALID_CID;
427 /* Execute the Device._STA method */
429 Status = AcpiUtExecute_STA (Node, &Info->CurrentStatus);
430 if (ACPI_SUCCESS (Status))
432 Info->Valid |= ACPI_VALID_STA;
435 /* Execute the Device._ADR method */
437 Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR, Node,
439 if (ACPI_SUCCESS (Status))
441 Info->Valid |= ACPI_VALID_ADR;
444 /* Execute the Device._SxD methods */
446 Status = AcpiUtExecute_Sxds (Node, Info->HighestDstates);
447 if (ACPI_SUCCESS (Status))
449 Info->Valid |= ACPI_VALID_SXDS;
453 /* Validate/Allocate/Clear caller buffer */
455 Status = AcpiUtInitializeBuffer (Buffer, Size);
456 if (ACPI_FAILURE (Status))
461 /* Populate the return buffer */
463 ReturnInfo = Buffer->Pointer;
464 ACPI_MEMCPY (ReturnInfo, Info, sizeof (ACPI_DEVICE_INFO));
468 ACPI_MEMCPY (&ReturnInfo->CompatibilityId, CidList, CidList->Size);
481 ACPI_EXPORT_SYMBOL (AcpiGetObjectInfo)
484 /******************************************************************************
486 * FUNCTION: AcpiInstallMethod
488 * PARAMETERS: Buffer - An ACPI table containing one control method
492 * DESCRIPTION: Install a control method into the namespace. If the method
493 * name already exists in the namespace, it is overwritten. The
494 * input buffer must contain a valid DSDT or SSDT containing a
495 * single control method.
497 ******************************************************************************/
503 ACPI_TABLE_HEADER *Table = ACPI_CAST_PTR (ACPI_TABLE_HEADER, Buffer);
507 ACPI_NAMESPACE_NODE *Node;
508 ACPI_OPERAND_OBJECT *MethodObj;
509 ACPI_PARSE_STATE ParserState;
516 /* Parameter validation */
520 return (AE_BAD_PARAMETER);
523 /* Table must be a DSDT or SSDT */
525 if (!ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_DSDT) &&
526 !ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_SSDT))
528 return (AE_BAD_HEADER);
531 /* First AML opcode in the table must be a control method */
533 ParserState.Aml = Buffer + sizeof (ACPI_TABLE_HEADER);
534 Opcode = AcpiPsPeekOpcode (&ParserState);
535 if (Opcode != AML_METHOD_OP)
537 return (AE_BAD_PARAMETER);
540 /* Extract method information from the raw AML */
542 ParserState.Aml += AcpiPsGetOpcodeSize (Opcode);
543 ParserState.PkgEnd = AcpiPsGetNextPackageEnd (&ParserState);
544 Path = AcpiPsGetNextNamestring (&ParserState);
545 MethodFlags = *ParserState.Aml++;
546 AmlStart = ParserState.Aml;
547 AmlLength = ACPI_PTR_DIFF (ParserState.PkgEnd, AmlStart);
550 * Allocate resources up-front. We don't want to have to delete a new
551 * node from the namespace if we cannot allocate memory.
553 AmlBuffer = ACPI_ALLOCATE (AmlLength);
556 return (AE_NO_MEMORY);
559 MethodObj = AcpiUtCreateInternalObject (ACPI_TYPE_METHOD);
562 ACPI_FREE (AmlBuffer);
563 return (AE_NO_MEMORY);
566 /* Lock namespace for AcpiNsLookup, we may be creating a new node */
568 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
569 if (ACPI_FAILURE (Status))
574 /* The lookup either returns an existing node or creates a new one */
576 Status = AcpiNsLookup (NULL, Path, ACPI_TYPE_METHOD, ACPI_IMODE_LOAD_PASS1,
577 ACPI_NS_DONT_OPEN_SCOPE | ACPI_NS_ERROR_IF_FOUND, NULL, &Node);
579 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
581 if (ACPI_FAILURE (Status)) /* NsLookup */
583 if (Status != AE_ALREADY_EXISTS)
588 /* Node existed previously, make sure it is a method node */
590 if (Node->Type != ACPI_TYPE_METHOD)
597 /* Copy the method AML to the local buffer */
599 ACPI_MEMCPY (AmlBuffer, AmlStart, AmlLength);
601 /* Initialize the method object with the new method's information */
603 MethodObj->Method.AmlStart = AmlBuffer;
604 MethodObj->Method.AmlLength = AmlLength;
606 MethodObj->Method.ParamCount = (UINT8)
607 (MethodFlags & AML_METHOD_ARG_COUNT);
609 MethodObj->Method.MethodFlags = (UINT8)
610 (MethodFlags & ~AML_METHOD_ARG_COUNT);
612 if (MethodFlags & AML_METHOD_SERIALIZED)
614 MethodObj->Method.SyncLevel = (UINT8)
615 ((MethodFlags & AML_METHOD_SYNC_LEVEL) >> 4);
619 * Now that it is complete, we can attach the new method object to
620 * the method Node (detaches/deletes any existing object)
622 Status = AcpiNsAttachObject (Node, MethodObj,
626 * Flag indicates AML buffer is dynamic, must be deleted later.
627 * Must be set only after attach above.
629 Node->Flags |= ANOBJ_ALLOCATED_BUFFER;
631 /* Remove local reference to the method object */
633 AcpiUtRemoveReference (MethodObj);
639 ACPI_FREE (AmlBuffer);
640 ACPI_FREE (MethodObj);
644 ACPI_EXPORT_SYMBOL (AcpiInstallMethod)