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 - 2014, 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__
118 #define EXPORT_ACPI_INTERFACES
121 #include "accommon.h"
122 #include "acnamesp.h"
123 #include "acparser.h"
127 #define _COMPONENT ACPI_NAMESPACE
128 ACPI_MODULE_NAME ("nsxfname")
130 /* Local prototypes */
134 ACPI_PNP_DEVICE_ID
*Dest
,
135 ACPI_PNP_DEVICE_ID
*Source
,
139 /******************************************************************************
141 * FUNCTION: AcpiGetHandle
143 * PARAMETERS: Parent - Object to search under (search scope).
144 * Pathname - Pointer to an asciiz string containing the
146 * RetHandle - Where the return handle is returned
150 * DESCRIPTION: This routine will search for a caller specified name in the
151 * name space. The caller can restrict the search region by
152 * specifying a non NULL parent. The parent value is itself a
155 ******************************************************************************/
160 ACPI_STRING Pathname
,
161 ACPI_HANDLE
*RetHandle
)
164 ACPI_NAMESPACE_NODE
*Node
= NULL
;
165 ACPI_NAMESPACE_NODE
*PrefixNode
= NULL
;
168 ACPI_FUNCTION_ENTRY ();
171 /* Parameter Validation */
173 if (!RetHandle
|| !Pathname
)
175 return (AE_BAD_PARAMETER
);
178 /* Convert a parent handle to a prefix node */
182 PrefixNode
= AcpiNsValidateHandle (Parent
);
185 return (AE_BAD_PARAMETER
);
191 * 1) Fully qualified pathname
192 * 2) Parent + Relative pathname
194 * Error for <null Parent + relative path>
196 if (ACPI_IS_ROOT_PREFIX (Pathname
[0]))
198 /* Pathname is fully qualified (starts with '\') */
200 /* Special case for root-only, since we can't search for it */
202 if (!ACPI_STRCMP (Pathname
, ACPI_NS_ROOT_PATH
))
204 *RetHandle
= ACPI_CAST_PTR (ACPI_HANDLE
, AcpiGbl_RootNode
);
208 else if (!PrefixNode
)
210 /* Relative path with null prefix is disallowed */
212 return (AE_BAD_PARAMETER
);
215 /* Find the Node and convert to a handle */
217 Status
= AcpiNsGetNode (PrefixNode
, Pathname
, ACPI_NS_NO_UPSEARCH
, &Node
);
218 if (ACPI_SUCCESS (Status
))
220 *RetHandle
= ACPI_CAST_PTR (ACPI_HANDLE
, Node
);
226 ACPI_EXPORT_SYMBOL (AcpiGetHandle
)
229 /******************************************************************************
231 * FUNCTION: AcpiGetName
233 * PARAMETERS: Handle - Handle to be converted to a pathname
234 * NameType - Full pathname or single segment
235 * Buffer - Buffer for returned path
237 * RETURN: Pointer to a string containing the fully qualified Name.
239 * DESCRIPTION: This routine returns the fully qualified name associated with
240 * the Handle parameter. This and the AcpiPathnameToHandle are
241 * complementary functions.
243 ******************************************************************************/
252 ACPI_NAMESPACE_NODE
*Node
;
256 /* Parameter validation */
258 if (NameType
> ACPI_NAME_TYPE_MAX
)
260 return (AE_BAD_PARAMETER
);
263 Status
= AcpiUtValidateBuffer (Buffer
);
264 if (ACPI_FAILURE (Status
))
269 if (NameType
== ACPI_FULL_PATHNAME
)
271 /* Get the full pathname (From the namespace root) */
273 Status
= AcpiNsHandleToPathname (Handle
, Buffer
);
278 * Wants the single segment ACPI name.
279 * Validate handle and convert to a namespace Node
281 Status
= AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE
);
282 if (ACPI_FAILURE (Status
))
287 Node
= AcpiNsValidateHandle (Handle
);
290 Status
= AE_BAD_PARAMETER
;
294 /* Validate/Allocate/Clear caller buffer */
296 Status
= AcpiUtInitializeBuffer (Buffer
, ACPI_PATH_SEGMENT_LENGTH
);
297 if (ACPI_FAILURE (Status
))
302 /* Just copy the ACPI name from the Node and zero terminate it */
304 NodeName
= AcpiUtGetNodeName (Node
);
305 ACPI_MOVE_NAME (Buffer
->Pointer
, NodeName
);
306 ((char *) Buffer
->Pointer
) [ACPI_NAME_SIZE
] = 0;
312 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
316 ACPI_EXPORT_SYMBOL (AcpiGetName
)
319 /******************************************************************************
321 * FUNCTION: AcpiNsCopyDeviceId
323 * PARAMETERS: Dest - Pointer to the destination PNP_DEVICE_ID
324 * Source - Pointer to the source PNP_DEVICE_ID
325 * StringArea - Pointer to where to copy the dest string
327 * RETURN: Pointer to the next string area
329 * DESCRIPTION: Copy a single PNP_DEVICE_ID, including the string data.
331 ******************************************************************************/
335 ACPI_PNP_DEVICE_ID
*Dest
,
336 ACPI_PNP_DEVICE_ID
*Source
,
340 /* Create the destination PNP_DEVICE_ID */
342 Dest
->String
= StringArea
;
343 Dest
->Length
= Source
->Length
;
345 /* Copy actual string and return a pointer to the next string area */
347 ACPI_MEMCPY (StringArea
, Source
->String
, Source
->Length
);
348 return (StringArea
+ Source
->Length
);
352 /******************************************************************************
354 * FUNCTION: AcpiGetObjectInfo
356 * PARAMETERS: Handle - Object Handle
357 * ReturnBuffer - Where the info is returned
361 * DESCRIPTION: Returns information about an object as gleaned from the
362 * namespace node and possibly by running several standard
363 * control methods (Such as in the case of a device.)
365 * For Device and Processor objects, run the Device _HID, _UID, _CID, _SUB,
366 * _STA, _ADR, _SxW, and _SxD methods.
368 * Note: Allocates the return buffer, must be freed by the caller.
370 ******************************************************************************/
375 ACPI_DEVICE_INFO
**ReturnBuffer
)
377 ACPI_NAMESPACE_NODE
*Node
;
378 ACPI_DEVICE_INFO
*Info
;
379 ACPI_PNP_DEVICE_ID_LIST
*CidList
= NULL
;
380 ACPI_PNP_DEVICE_ID
*Hid
= NULL
;
381 ACPI_PNP_DEVICE_ID
*Uid
= NULL
;
382 ACPI_PNP_DEVICE_ID
*Sub
= NULL
;
384 ACPI_OBJECT_TYPE Type
;
393 /* Parameter validation */
395 if (!Handle
|| !ReturnBuffer
)
397 return (AE_BAD_PARAMETER
);
400 Status
= AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE
);
401 if (ACPI_FAILURE (Status
))
406 Node
= AcpiNsValidateHandle (Handle
);
409 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
410 return (AE_BAD_PARAMETER
);
413 /* Get the namespace node data while the namespace is locked */
415 InfoSize
= sizeof (ACPI_DEVICE_INFO
);
417 Name
= Node
->Name
.Integer
;
419 if (Node
->Type
== ACPI_TYPE_METHOD
)
421 ParamCount
= Node
->Object
->Method
.ParamCount
;
424 Status
= AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
425 if (ACPI_FAILURE (Status
))
430 if ((Type
== ACPI_TYPE_DEVICE
) ||
431 (Type
== ACPI_TYPE_PROCESSOR
))
434 * Get extra info for ACPI Device/Processor objects only:
435 * Run the Device _HID, _UID, _SUB, and _CID methods.
437 * Note: none of these methods are required, so they may or may
438 * not be present for this device. The Info->Valid bitfield is used
439 * to indicate which methods were found and run successfully.
442 /* Execute the Device._HID method */
444 Status
= AcpiUtExecute_HID (Node
, &Hid
);
445 if (ACPI_SUCCESS (Status
))
447 InfoSize
+= Hid
->Length
;
448 Valid
|= ACPI_VALID_HID
;
451 /* Execute the Device._UID method */
453 Status
= AcpiUtExecute_UID (Node
, &Uid
);
454 if (ACPI_SUCCESS (Status
))
456 InfoSize
+= Uid
->Length
;
457 Valid
|= ACPI_VALID_UID
;
460 /* Execute the Device._SUB method */
462 Status
= AcpiUtExecute_SUB (Node
, &Sub
);
463 if (ACPI_SUCCESS (Status
))
465 InfoSize
+= Sub
->Length
;
466 Valid
|= ACPI_VALID_SUB
;
469 /* Execute the Device._CID method */
471 Status
= AcpiUtExecute_CID (Node
, &CidList
);
472 if (ACPI_SUCCESS (Status
))
474 /* Add size of CID strings and CID pointer array */
476 InfoSize
+= (CidList
->ListSize
- sizeof (ACPI_PNP_DEVICE_ID_LIST
));
477 Valid
|= ACPI_VALID_CID
;
482 * Now that we have the variable-length data, we can allocate the
485 Info
= ACPI_ALLOCATE_ZEROED (InfoSize
);
488 Status
= AE_NO_MEMORY
;
492 /* Get the fixed-length data */
494 if ((Type
== ACPI_TYPE_DEVICE
) ||
495 (Type
== ACPI_TYPE_PROCESSOR
))
498 * Get extra info for ACPI Device/Processor objects only:
499 * Run the _STA, _ADR and, SxW, and _SxD methods.
501 * Notes: none of these methods are required, so they may or may
502 * not be present for this device. The Info->Valid bitfield is used
503 * to indicate which methods were found and run successfully.
505 * For _STA, if the method does not exist, then (as per the ACPI
506 * specification), the returned CurrentStatus flags will indicate
507 * that the device is present/functional/enabled. Otherwise, the
508 * CurrentStatus flags reflect the value returned from _STA.
511 /* Execute the Device._STA method */
513 Status
= AcpiUtExecute_STA (Node
, &Info
->CurrentStatus
);
514 if (ACPI_SUCCESS (Status
))
516 Valid
|= ACPI_VALID_STA
;
519 /* Execute the Device._ADR method */
521 Status
= AcpiUtEvaluateNumericObject (METHOD_NAME__ADR
, Node
,
523 if (ACPI_SUCCESS (Status
))
525 Valid
|= ACPI_VALID_ADR
;
528 /* Execute the Device._SxW methods */
530 Status
= AcpiUtExecutePowerMethods (Node
,
531 AcpiGbl_LowestDstateNames
, ACPI_NUM_SxW_METHODS
,
532 Info
->LowestDstates
);
533 if (ACPI_SUCCESS (Status
))
535 Valid
|= ACPI_VALID_SXWS
;
538 /* Execute the Device._SxD methods */
540 Status
= AcpiUtExecutePowerMethods (Node
,
541 AcpiGbl_HighestDstateNames
, ACPI_NUM_SxD_METHODS
,
542 Info
->HighestDstates
);
543 if (ACPI_SUCCESS (Status
))
545 Valid
|= ACPI_VALID_SXDS
;
550 * Create a pointer to the string area of the return buffer.
551 * Point to the end of the base ACPI_DEVICE_INFO structure.
553 NextIdString
= ACPI_CAST_PTR (char, Info
->CompatibleIdList
.Ids
);
556 /* Point past the CID PNP_DEVICE_ID array */
558 NextIdString
+= ((ACPI_SIZE
) CidList
->Count
* sizeof (ACPI_PNP_DEVICE_ID
));
562 * Copy the HID, UID, SUB, and CIDs to the return buffer.
563 * The variable-length strings are copied to the reserved area
564 * at the end of the buffer.
566 * For HID and CID, check if the ID is a PCI Root Bridge.
570 NextIdString
= AcpiNsCopyDeviceId (&Info
->HardwareId
,
573 if (AcpiUtIsPciRootBridge (Hid
->String
))
575 Info
->Flags
|= ACPI_PCI_ROOT_BRIDGE
;
581 NextIdString
= AcpiNsCopyDeviceId (&Info
->UniqueId
,
587 NextIdString
= AcpiNsCopyDeviceId (&Info
->SubsystemId
,
593 Info
->CompatibleIdList
.Count
= CidList
->Count
;
594 Info
->CompatibleIdList
.ListSize
= CidList
->ListSize
;
598 for (i
= 0; i
< CidList
->Count
; i
++)
600 NextIdString
= AcpiNsCopyDeviceId (&Info
->CompatibleIdList
.Ids
[i
],
601 &CidList
->Ids
[i
], NextIdString
);
603 if (AcpiUtIsPciRootBridge (CidList
->Ids
[i
].String
))
605 Info
->Flags
|= ACPI_PCI_ROOT_BRIDGE
;
610 /* Copy the fixed-length data */
612 Info
->InfoSize
= InfoSize
;
615 Info
->ParamCount
= ParamCount
;
618 *ReturnBuffer
= Info
;
642 ACPI_EXPORT_SYMBOL (AcpiGetObjectInfo
)
645 /******************************************************************************
647 * FUNCTION: AcpiInstallMethod
649 * PARAMETERS: Buffer - An ACPI table containing one control method
653 * DESCRIPTION: Install a control method into the namespace. If the method
654 * name already exists in the namespace, it is overwritten. The
655 * input buffer must contain a valid DSDT or SSDT containing a
656 * single control method.
658 ******************************************************************************/
664 ACPI_TABLE_HEADER
*Table
= ACPI_CAST_PTR (ACPI_TABLE_HEADER
, Buffer
);
668 ACPI_NAMESPACE_NODE
*Node
;
669 ACPI_OPERAND_OBJECT
*MethodObj
;
670 ACPI_PARSE_STATE ParserState
;
677 /* Parameter validation */
681 return (AE_BAD_PARAMETER
);
684 /* Table must be a DSDT or SSDT */
686 if (!ACPI_COMPARE_NAME (Table
->Signature
, ACPI_SIG_DSDT
) &&
687 !ACPI_COMPARE_NAME (Table
->Signature
, ACPI_SIG_SSDT
))
689 return (AE_BAD_HEADER
);
692 /* First AML opcode in the table must be a control method */
694 ParserState
.Aml
= Buffer
+ sizeof (ACPI_TABLE_HEADER
);
695 Opcode
= AcpiPsPeekOpcode (&ParserState
);
696 if (Opcode
!= AML_METHOD_OP
)
698 return (AE_BAD_PARAMETER
);
701 /* Extract method information from the raw AML */
703 ParserState
.Aml
+= AcpiPsGetOpcodeSize (Opcode
);
704 ParserState
.PkgEnd
= AcpiPsGetNextPackageEnd (&ParserState
);
705 Path
= AcpiPsGetNextNamestring (&ParserState
);
706 MethodFlags
= *ParserState
.Aml
++;
707 AmlStart
= ParserState
.Aml
;
708 AmlLength
= ACPI_PTR_DIFF (ParserState
.PkgEnd
, AmlStart
);
711 * Allocate resources up-front. We don't want to have to delete a new
712 * node from the namespace if we cannot allocate memory.
714 AmlBuffer
= ACPI_ALLOCATE (AmlLength
);
717 return (AE_NO_MEMORY
);
720 MethodObj
= AcpiUtCreateInternalObject (ACPI_TYPE_METHOD
);
723 ACPI_FREE (AmlBuffer
);
724 return (AE_NO_MEMORY
);
727 /* Lock namespace for AcpiNsLookup, we may be creating a new node */
729 Status
= AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE
);
730 if (ACPI_FAILURE (Status
))
735 /* The lookup either returns an existing node or creates a new one */
737 Status
= AcpiNsLookup (NULL
, Path
, ACPI_TYPE_METHOD
, ACPI_IMODE_LOAD_PASS1
,
738 ACPI_NS_DONT_OPEN_SCOPE
| ACPI_NS_ERROR_IF_FOUND
, NULL
, &Node
);
740 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
742 if (ACPI_FAILURE (Status
)) /* NsLookup */
744 if (Status
!= AE_ALREADY_EXISTS
)
749 /* Node existed previously, make sure it is a method node */
751 if (Node
->Type
!= ACPI_TYPE_METHOD
)
758 /* Copy the method AML to the local buffer */
760 ACPI_MEMCPY (AmlBuffer
, AmlStart
, AmlLength
);
762 /* Initialize the method object with the new method's information */
764 MethodObj
->Method
.AmlStart
= AmlBuffer
;
765 MethodObj
->Method
.AmlLength
= AmlLength
;
767 MethodObj
->Method
.ParamCount
= (UINT8
)
768 (MethodFlags
& AML_METHOD_ARG_COUNT
);
770 if (MethodFlags
& AML_METHOD_SERIALIZED
)
772 MethodObj
->Method
.InfoFlags
= ACPI_METHOD_SERIALIZED
;
774 MethodObj
->Method
.SyncLevel
= (UINT8
)
775 ((MethodFlags
& AML_METHOD_SYNC_LEVEL
) >> 4);
779 * Now that it is complete, we can attach the new method object to
780 * the method Node (detaches/deletes any existing object)
782 Status
= AcpiNsAttachObject (Node
, MethodObj
, ACPI_TYPE_METHOD
);
785 * Flag indicates AML buffer is dynamic, must be deleted later.
786 * Must be set only after attach above.
788 Node
->Flags
|= ANOBJ_ALLOCATED_BUFFER
;
790 /* Remove local reference to the method object */
792 AcpiUtRemoveReference (MethodObj
);
798 ACPI_FREE (AmlBuffer
);
799 ACPI_FREE (MethodObj
);
803 ACPI_EXPORT_SYMBOL (AcpiInstallMethod
)