1 /******************************************************************************
3 * Module Name: nsxfname - Public interfaces to the ACPI subsystem
4 * ACPI Namespace oriented interfaces
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2012, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 #define __NSXFNAME_C__
54 #define _COMPONENT ACPI_NAMESPACE
55 ACPI_MODULE_NAME ("nsxfname")
57 /* Local prototypes */
61 ACPI_PNP_DEVICE_ID *Dest,
62 ACPI_PNP_DEVICE_ID *Source,
66 /******************************************************************************
68 * FUNCTION: AcpiGetHandle
70 * PARAMETERS: Parent - Object to search under (search scope).
71 * Pathname - Pointer to an asciiz string containing the
73 * RetHandle - Where the return handle is returned
77 * DESCRIPTION: This routine will search for a caller specified name in the
78 * name space. The caller can restrict the search region by
79 * specifying a non NULL parent. The parent value is itself a
82 ******************************************************************************/
88 ACPI_HANDLE *RetHandle)
91 ACPI_NAMESPACE_NODE *Node = NULL;
92 ACPI_NAMESPACE_NODE *PrefixNode = NULL;
95 ACPI_FUNCTION_ENTRY ();
98 /* Parameter Validation */
100 if (!RetHandle || !Pathname)
102 return (AE_BAD_PARAMETER);
105 /* Convert a parent handle to a prefix node */
109 PrefixNode = AcpiNsValidateHandle (Parent);
112 return (AE_BAD_PARAMETER);
118 * 1) Fully qualified pathname
119 * 2) Parent + Relative pathname
121 * Error for <null Parent + relative path>
123 if (AcpiNsValidRootPrefix (Pathname[0]))
125 /* Pathname is fully qualified (starts with '\') */
127 /* Special case for root-only, since we can't search for it */
129 if (!ACPI_STRCMP (Pathname, ACPI_NS_ROOT_PATH))
131 *RetHandle = ACPI_CAST_PTR (ACPI_HANDLE, AcpiGbl_RootNode);
135 else if (!PrefixNode)
137 /* Relative path with null prefix is disallowed */
139 return (AE_BAD_PARAMETER);
142 /* Find the Node and convert to a handle */
144 Status = AcpiNsGetNode (PrefixNode, Pathname, ACPI_NS_NO_UPSEARCH, &Node);
145 if (ACPI_SUCCESS (Status))
147 *RetHandle = ACPI_CAST_PTR (ACPI_HANDLE, Node);
153 ACPI_EXPORT_SYMBOL (AcpiGetHandle)
156 /******************************************************************************
158 * FUNCTION: AcpiGetName
160 * PARAMETERS: Handle - Handle to be converted to a pathname
161 * NameType - Full pathname or single segment
162 * Buffer - Buffer for returned path
164 * RETURN: Pointer to a string containing the fully qualified Name.
166 * DESCRIPTION: This routine returns the fully qualified name associated with
167 * the Handle parameter. This and the AcpiPathnameToHandle are
168 * complementary functions.
170 ******************************************************************************/
179 ACPI_NAMESPACE_NODE *Node;
182 /* Parameter validation */
184 if (NameType > ACPI_NAME_TYPE_MAX)
186 return (AE_BAD_PARAMETER);
189 Status = AcpiUtValidateBuffer (Buffer);
190 if (ACPI_FAILURE (Status))
195 if (NameType == ACPI_FULL_PATHNAME)
197 /* Get the full pathname (From the namespace root) */
199 Status = AcpiNsHandleToPathname (Handle, Buffer);
204 * Wants the single segment ACPI name.
205 * Validate handle and convert to a namespace Node
207 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
208 if (ACPI_FAILURE (Status))
213 Node = AcpiNsValidateHandle (Handle);
216 Status = AE_BAD_PARAMETER;
220 /* Validate/Allocate/Clear caller buffer */
222 Status = AcpiUtInitializeBuffer (Buffer, ACPI_PATH_SEGMENT_LENGTH);
223 if (ACPI_FAILURE (Status))
228 /* Just copy the ACPI name from the Node and zero terminate it */
230 ACPI_MOVE_NAME (Buffer->Pointer, AcpiUtGetNodeName (Node));
231 ((char *) Buffer->Pointer) [ACPI_NAME_SIZE] = 0;
237 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
241 ACPI_EXPORT_SYMBOL (AcpiGetName)
244 /******************************************************************************
246 * FUNCTION: AcpiNsCopyDeviceId
248 * PARAMETERS: Dest - Pointer to the destination PNP_DEVICE_ID
249 * Source - Pointer to the source PNP_DEVICE_ID
250 * StringArea - Pointer to where to copy the dest string
252 * RETURN: Pointer to the next string area
254 * DESCRIPTION: Copy a single PNP_DEVICE_ID, including the string data.
256 ******************************************************************************/
260 ACPI_PNP_DEVICE_ID *Dest,
261 ACPI_PNP_DEVICE_ID *Source,
265 /* Create the destination PNP_DEVICE_ID */
267 Dest->String = StringArea;
268 Dest->Length = Source->Length;
270 /* Copy actual string and return a pointer to the next string area */
272 ACPI_MEMCPY (StringArea, Source->String, Source->Length);
273 return (StringArea + Source->Length);
277 /******************************************************************************
279 * FUNCTION: AcpiGetObjectInfo
281 * PARAMETERS: Handle - Object Handle
282 * ReturnBuffer - Where the info is returned
286 * DESCRIPTION: Returns information about an object as gleaned from the
287 * namespace node and possibly by running several standard
288 * control methods (Such as in the case of a device.)
290 * For Device and Processor objects, run the Device _HID, _UID, _CID, _SUB,
291 * _STA, _ADR, _SxW, and _SxD methods.
293 * Note: Allocates the return buffer, must be freed by the caller.
295 ******************************************************************************/
300 ACPI_DEVICE_INFO **ReturnBuffer)
302 ACPI_NAMESPACE_NODE *Node;
303 ACPI_DEVICE_INFO *Info;
304 ACPI_PNP_DEVICE_ID_LIST *CidList = NULL;
305 ACPI_PNP_DEVICE_ID *Hid = NULL;
306 ACPI_PNP_DEVICE_ID *Uid = NULL;
307 ACPI_PNP_DEVICE_ID *Sub = NULL;
309 ACPI_OBJECT_TYPE Type;
318 /* Parameter validation */
320 if (!Handle || !ReturnBuffer)
322 return (AE_BAD_PARAMETER);
325 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
326 if (ACPI_FAILURE (Status))
331 Node = AcpiNsValidateHandle (Handle);
334 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
335 return (AE_BAD_PARAMETER);
338 /* Get the namespace node data while the namespace is locked */
340 InfoSize = sizeof (ACPI_DEVICE_INFO);
342 Name = Node->Name.Integer;
344 if (Node->Type == ACPI_TYPE_METHOD)
346 ParamCount = Node->Object->Method.ParamCount;
349 Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
350 if (ACPI_FAILURE (Status))
355 if ((Type == ACPI_TYPE_DEVICE) ||
356 (Type == ACPI_TYPE_PROCESSOR))
359 * Get extra info for ACPI Device/Processor objects only:
360 * Run the Device _HID, _UID, _SUB, and _CID methods.
362 * Note: none of these methods are required, so they may or may
363 * not be present for this device. The Info->Valid bitfield is used
364 * to indicate which methods were found and run successfully.
367 /* Execute the Device._HID method */
369 Status = AcpiUtExecute_HID (Node, &Hid);
370 if (ACPI_SUCCESS (Status))
372 InfoSize += Hid->Length;
373 Valid |= ACPI_VALID_HID;
376 /* Execute the Device._UID method */
378 Status = AcpiUtExecute_UID (Node, &Uid);
379 if (ACPI_SUCCESS (Status))
381 InfoSize += Uid->Length;
382 Valid |= ACPI_VALID_UID;
385 /* Execute the Device._SUB method */
387 Status = AcpiUtExecute_SUB (Node, &Sub);
388 if (ACPI_SUCCESS (Status))
390 InfoSize += Sub->Length;
391 Valid |= ACPI_VALID_SUB;
394 /* Execute the Device._CID method */
396 Status = AcpiUtExecute_CID (Node, &CidList);
397 if (ACPI_SUCCESS (Status))
399 /* Add size of CID strings and CID pointer array */
401 InfoSize += (CidList->ListSize - sizeof (ACPI_PNP_DEVICE_ID_LIST));
402 Valid |= ACPI_VALID_CID;
407 * Now that we have the variable-length data, we can allocate the
410 Info = ACPI_ALLOCATE_ZEROED (InfoSize);
413 Status = AE_NO_MEMORY;
417 /* Get the fixed-length data */
419 if ((Type == ACPI_TYPE_DEVICE) ||
420 (Type == ACPI_TYPE_PROCESSOR))
423 * Get extra info for ACPI Device/Processor objects only:
424 * Run the _STA, _ADR and, SxW, and _SxD methods.
426 * Note: none of these methods are required, so they may or may
427 * not be present for this device. The Info->Valid bitfield is used
428 * to indicate which methods were found and run successfully.
431 /* Execute the Device._STA method */
433 Status = AcpiUtExecute_STA (Node, &Info->CurrentStatus);
434 if (ACPI_SUCCESS (Status))
436 Valid |= ACPI_VALID_STA;
439 /* Execute the Device._ADR method */
441 Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR, Node,
443 if (ACPI_SUCCESS (Status))
445 Valid |= ACPI_VALID_ADR;
448 /* Execute the Device._SxW methods */
450 Status = AcpiUtExecutePowerMethods (Node,
451 AcpiGbl_LowestDstateNames, ACPI_NUM_SxW_METHODS,
452 Info->LowestDstates);
453 if (ACPI_SUCCESS (Status))
455 Valid |= ACPI_VALID_SXWS;
458 /* Execute the Device._SxD methods */
460 Status = AcpiUtExecutePowerMethods (Node,
461 AcpiGbl_HighestDstateNames, ACPI_NUM_SxD_METHODS,
462 Info->HighestDstates);
463 if (ACPI_SUCCESS (Status))
465 Valid |= ACPI_VALID_SXDS;
470 * Create a pointer to the string area of the return buffer.
471 * Point to the end of the base ACPI_DEVICE_INFO structure.
473 NextIdString = ACPI_CAST_PTR (char, Info->CompatibleIdList.Ids);
476 /* Point past the CID PNP_DEVICE_ID array */
478 NextIdString += ((ACPI_SIZE) CidList->Count * sizeof (ACPI_PNP_DEVICE_ID));
482 * Copy the HID, UID, SUB, and CIDs to the return buffer.
483 * The variable-length strings are copied to the reserved area
484 * at the end of the buffer.
486 * For HID and CID, check if the ID is a PCI Root Bridge.
490 NextIdString = AcpiNsCopyDeviceId (&Info->HardwareId,
493 if (AcpiUtIsPciRootBridge (Hid->String))
495 Info->Flags |= ACPI_PCI_ROOT_BRIDGE;
501 NextIdString = AcpiNsCopyDeviceId (&Info->UniqueId,
507 NextIdString = AcpiNsCopyDeviceId (&Info->SubsystemId,
513 Info->CompatibleIdList.Count = CidList->Count;
514 Info->CompatibleIdList.ListSize = CidList->ListSize;
518 for (i = 0; i < CidList->Count; i++)
520 NextIdString = AcpiNsCopyDeviceId (&Info->CompatibleIdList.Ids[i],
521 &CidList->Ids[i], NextIdString);
523 if (AcpiUtIsPciRootBridge (CidList->Ids[i].String))
525 Info->Flags |= ACPI_PCI_ROOT_BRIDGE;
530 /* Copy the fixed-length data */
532 Info->InfoSize = InfoSize;
535 Info->ParamCount = ParamCount;
538 *ReturnBuffer = Info;
562 ACPI_EXPORT_SYMBOL (AcpiGetObjectInfo)
565 /******************************************************************************
567 * FUNCTION: AcpiInstallMethod
569 * PARAMETERS: Buffer - An ACPI table containing one control method
573 * DESCRIPTION: Install a control method into the namespace. If the method
574 * name already exists in the namespace, it is overwritten. The
575 * input buffer must contain a valid DSDT or SSDT containing a
576 * single control method.
578 ******************************************************************************/
584 ACPI_TABLE_HEADER *Table = ACPI_CAST_PTR (ACPI_TABLE_HEADER, Buffer);
588 ACPI_NAMESPACE_NODE *Node;
589 ACPI_OPERAND_OBJECT *MethodObj;
590 ACPI_PARSE_STATE ParserState;
597 /* Parameter validation */
601 return (AE_BAD_PARAMETER);
604 /* Table must be a DSDT or SSDT */
606 if (!ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_DSDT) &&
607 !ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_SSDT))
609 return (AE_BAD_HEADER);
612 /* First AML opcode in the table must be a control method */
614 ParserState.Aml = Buffer + sizeof (ACPI_TABLE_HEADER);
615 Opcode = AcpiPsPeekOpcode (&ParserState);
616 if (Opcode != AML_METHOD_OP)
618 return (AE_BAD_PARAMETER);
621 /* Extract method information from the raw AML */
623 ParserState.Aml += AcpiPsGetOpcodeSize (Opcode);
624 ParserState.PkgEnd = AcpiPsGetNextPackageEnd (&ParserState);
625 Path = AcpiPsGetNextNamestring (&ParserState);
626 MethodFlags = *ParserState.Aml++;
627 AmlStart = ParserState.Aml;
628 AmlLength = ACPI_PTR_DIFF (ParserState.PkgEnd, AmlStart);
631 * Allocate resources up-front. We don't want to have to delete a new
632 * node from the namespace if we cannot allocate memory.
634 AmlBuffer = ACPI_ALLOCATE (AmlLength);
637 return (AE_NO_MEMORY);
640 MethodObj = AcpiUtCreateInternalObject (ACPI_TYPE_METHOD);
643 ACPI_FREE (AmlBuffer);
644 return (AE_NO_MEMORY);
647 /* Lock namespace for AcpiNsLookup, we may be creating a new node */
649 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
650 if (ACPI_FAILURE (Status))
655 /* The lookup either returns an existing node or creates a new one */
657 Status = AcpiNsLookup (NULL, Path, ACPI_TYPE_METHOD, ACPI_IMODE_LOAD_PASS1,
658 ACPI_NS_DONT_OPEN_SCOPE | ACPI_NS_ERROR_IF_FOUND, NULL, &Node);
660 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
662 if (ACPI_FAILURE (Status)) /* NsLookup */
664 if (Status != AE_ALREADY_EXISTS)
669 /* Node existed previously, make sure it is a method node */
671 if (Node->Type != ACPI_TYPE_METHOD)
678 /* Copy the method AML to the local buffer */
680 ACPI_MEMCPY (AmlBuffer, AmlStart, AmlLength);
682 /* Initialize the method object with the new method's information */
684 MethodObj->Method.AmlStart = AmlBuffer;
685 MethodObj->Method.AmlLength = AmlLength;
687 MethodObj->Method.ParamCount = (UINT8)
688 (MethodFlags & AML_METHOD_ARG_COUNT);
690 if (MethodFlags & AML_METHOD_SERIALIZED)
692 MethodObj->Method.InfoFlags = ACPI_METHOD_SERIALIZED;
694 MethodObj->Method.SyncLevel = (UINT8)
695 ((MethodFlags & AML_METHOD_SYNC_LEVEL) >> 4);
699 * Now that it is complete, we can attach the new method object to
700 * the method Node (detaches/deletes any existing object)
702 Status = AcpiNsAttachObject (Node, MethodObj, ACPI_TYPE_METHOD);
705 * Flag indicates AML buffer is dynamic, must be deleted later.
706 * Must be set only after attach above.
708 Node->Flags |= ANOBJ_ALLOCATED_BUFFER;
710 /* Remove local reference to the method object */
712 AcpiUtRemoveReference (MethodObj);
718 ACPI_FREE (AmlBuffer);
719 ACPI_FREE (MethodObj);
723 ACPI_EXPORT_SYMBOL (AcpiInstallMethod)