]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - source/components/namespace/nsxfname.c
Import ACPICA 20121114.
[FreeBSD/FreeBSD.git] / source / components / namespace / nsxfname.c
1 /******************************************************************************
2  *
3  * Module Name: nsxfname - Public interfaces to the ACPI subsystem
4  *                         ACPI Namespace oriented interfaces
5  *
6  *****************************************************************************/
7
8 /*
9  * Copyright (C) 2000 - 2012, Intel Corp.
10  * All rights reserved.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
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.
26  *
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.
30  *
31  * NO WARRANTY
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.
43  */
44
45 #define __NSXFNAME_C__
46
47 #include "acpi.h"
48 #include "accommon.h"
49 #include "acnamesp.h"
50 #include "acparser.h"
51 #include "amlcode.h"
52
53
54 #define _COMPONENT          ACPI_NAMESPACE
55         ACPI_MODULE_NAME    ("nsxfname")
56
57 /* Local prototypes */
58
59 static char *
60 AcpiNsCopyDeviceId (
61     ACPI_PNP_DEVICE_ID      *Dest,
62     ACPI_PNP_DEVICE_ID      *Source,
63     char                    *StringArea);
64
65
66 /******************************************************************************
67  *
68  * FUNCTION:    AcpiGetHandle
69  *
70  * PARAMETERS:  Parent          - Object to search under (search scope).
71  *              Pathname        - Pointer to an asciiz string containing the
72  *                                name
73  *              RetHandle       - Where the return handle is returned
74  *
75  * RETURN:      Status
76  *
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
80  *              namespace handle.
81  *
82  ******************************************************************************/
83
84 ACPI_STATUS
85 AcpiGetHandle (
86     ACPI_HANDLE             Parent,
87     ACPI_STRING             Pathname,
88     ACPI_HANDLE             *RetHandle)
89 {
90     ACPI_STATUS             Status;
91     ACPI_NAMESPACE_NODE     *Node = NULL;
92     ACPI_NAMESPACE_NODE     *PrefixNode = NULL;
93
94
95     ACPI_FUNCTION_ENTRY ();
96
97
98     /* Parameter Validation */
99
100     if (!RetHandle || !Pathname)
101     {
102         return (AE_BAD_PARAMETER);
103     }
104
105     /* Convert a parent handle to a prefix node */
106
107     if (Parent)
108     {
109         PrefixNode = AcpiNsValidateHandle (Parent);
110         if (!PrefixNode)
111         {
112             return (AE_BAD_PARAMETER);
113         }
114     }
115
116     /*
117      * Valid cases are:
118      * 1) Fully qualified pathname
119      * 2) Parent + Relative pathname
120      *
121      * Error for <null Parent + relative path>
122      */
123     if (AcpiNsValidRootPrefix (Pathname[0]))
124     {
125         /* Pathname is fully qualified (starts with '\') */
126
127         /* Special case for root-only, since we can't search for it */
128
129         if (!ACPI_STRCMP (Pathname, ACPI_NS_ROOT_PATH))
130         {
131             *RetHandle = ACPI_CAST_PTR (ACPI_HANDLE, AcpiGbl_RootNode);
132             return (AE_OK);
133         }
134     }
135     else if (!PrefixNode)
136     {
137         /* Relative path with null prefix is disallowed */
138
139         return (AE_BAD_PARAMETER);
140     }
141
142     /* Find the Node and convert to a handle */
143
144     Status = AcpiNsGetNode (PrefixNode, Pathname, ACPI_NS_NO_UPSEARCH, &Node);
145     if (ACPI_SUCCESS (Status))
146     {
147         *RetHandle = ACPI_CAST_PTR (ACPI_HANDLE, Node);
148     }
149
150     return (Status);
151 }
152
153 ACPI_EXPORT_SYMBOL (AcpiGetHandle)
154
155
156 /******************************************************************************
157  *
158  * FUNCTION:    AcpiGetName
159  *
160  * PARAMETERS:  Handle          - Handle to be converted to a pathname
161  *              NameType        - Full pathname or single segment
162  *              Buffer          - Buffer for returned path
163  *
164  * RETURN:      Pointer to a string containing the fully qualified Name.
165  *
166  * DESCRIPTION: This routine returns the fully qualified name associated with
167  *              the Handle parameter. This and the AcpiPathnameToHandle are
168  *              complementary functions.
169  *
170  ******************************************************************************/
171
172 ACPI_STATUS
173 AcpiGetName (
174     ACPI_HANDLE             Handle,
175     UINT32                  NameType,
176     ACPI_BUFFER             *Buffer)
177 {
178     ACPI_STATUS             Status;
179     ACPI_NAMESPACE_NODE     *Node;
180
181
182     /* Parameter validation */
183
184     if (NameType > ACPI_NAME_TYPE_MAX)
185     {
186         return (AE_BAD_PARAMETER);
187     }
188
189     Status = AcpiUtValidateBuffer (Buffer);
190     if (ACPI_FAILURE (Status))
191     {
192         return (Status);
193     }
194
195     if (NameType == ACPI_FULL_PATHNAME)
196     {
197         /* Get the full pathname (From the namespace root) */
198
199         Status = AcpiNsHandleToPathname (Handle, Buffer);
200         return (Status);
201     }
202
203     /*
204      * Wants the single segment ACPI name.
205      * Validate handle and convert to a namespace Node
206      */
207     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
208     if (ACPI_FAILURE (Status))
209     {
210         return (Status);
211     }
212
213     Node = AcpiNsValidateHandle (Handle);
214     if (!Node)
215     {
216         Status = AE_BAD_PARAMETER;
217         goto UnlockAndExit;
218     }
219
220     /* Validate/Allocate/Clear caller buffer */
221
222     Status = AcpiUtInitializeBuffer (Buffer, ACPI_PATH_SEGMENT_LENGTH);
223     if (ACPI_FAILURE (Status))
224     {
225         goto UnlockAndExit;
226     }
227
228     /* Just copy the ACPI name from the Node and zero terminate it */
229
230     ACPI_MOVE_NAME (Buffer->Pointer, AcpiUtGetNodeName (Node));
231     ((char *) Buffer->Pointer) [ACPI_NAME_SIZE] = 0;
232     Status = AE_OK;
233
234
235 UnlockAndExit:
236
237     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
238     return (Status);
239 }
240
241 ACPI_EXPORT_SYMBOL (AcpiGetName)
242
243
244 /******************************************************************************
245  *
246  * FUNCTION:    AcpiNsCopyDeviceId
247  *
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
251  *
252  * RETURN:      Pointer to the next string area
253  *
254  * DESCRIPTION: Copy a single PNP_DEVICE_ID, including the string data.
255  *
256  ******************************************************************************/
257
258 static char *
259 AcpiNsCopyDeviceId (
260     ACPI_PNP_DEVICE_ID      *Dest,
261     ACPI_PNP_DEVICE_ID      *Source,
262     char                    *StringArea)
263 {
264
265     /* Create the destination PNP_DEVICE_ID */
266
267     Dest->String = StringArea;
268     Dest->Length = Source->Length;
269
270     /* Copy actual string and return a pointer to the next string area */
271
272     ACPI_MEMCPY (StringArea, Source->String, Source->Length);
273     return (StringArea + Source->Length);
274 }
275
276
277 /******************************************************************************
278  *
279  * FUNCTION:    AcpiGetObjectInfo
280  *
281  * PARAMETERS:  Handle              - Object Handle
282  *              ReturnBuffer        - Where the info is returned
283  *
284  * RETURN:      Status
285  *
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.)
289  *
290  * For Device and Processor objects, run the Device _HID, _UID, _CID, _SUB,
291  * _STA, _ADR, _SxW, and _SxD methods.
292  *
293  * Note: Allocates the return buffer, must be freed by the caller.
294  *
295  ******************************************************************************/
296
297 ACPI_STATUS
298 AcpiGetObjectInfo (
299     ACPI_HANDLE             Handle,
300     ACPI_DEVICE_INFO        **ReturnBuffer)
301 {
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;
308     char                    *NextIdString;
309     ACPI_OBJECT_TYPE        Type;
310     ACPI_NAME               Name;
311     UINT8                   ParamCount= 0;
312     UINT8                   Valid = 0;
313     UINT32                  InfoSize;
314     UINT32                  i;
315     ACPI_STATUS             Status;
316
317
318     /* Parameter validation */
319
320     if (!Handle || !ReturnBuffer)
321     {
322         return (AE_BAD_PARAMETER);
323     }
324
325     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
326     if (ACPI_FAILURE (Status))
327     {
328         return (Status);
329     }
330
331     Node = AcpiNsValidateHandle (Handle);
332     if (!Node)
333     {
334         (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
335         return (AE_BAD_PARAMETER);
336     }
337
338     /* Get the namespace node data while the namespace is locked */
339
340     InfoSize = sizeof (ACPI_DEVICE_INFO);
341     Type = Node->Type;
342     Name = Node->Name.Integer;
343
344     if (Node->Type == ACPI_TYPE_METHOD)
345     {
346         ParamCount = Node->Object->Method.ParamCount;
347     }
348
349     Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
350     if (ACPI_FAILURE (Status))
351     {
352         return (Status);
353     }
354
355     if ((Type == ACPI_TYPE_DEVICE) ||
356         (Type == ACPI_TYPE_PROCESSOR))
357     {
358         /*
359          * Get extra info for ACPI Device/Processor objects only:
360          * Run the Device _HID, _UID, _SUB, and _CID methods.
361          *
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.
365          */
366
367         /* Execute the Device._HID method */
368
369         Status = AcpiUtExecute_HID (Node, &Hid);
370         if (ACPI_SUCCESS (Status))
371         {
372             InfoSize += Hid->Length;
373             Valid |= ACPI_VALID_HID;
374         }
375
376         /* Execute the Device._UID method */
377
378         Status = AcpiUtExecute_UID (Node, &Uid);
379         if (ACPI_SUCCESS (Status))
380         {
381             InfoSize += Uid->Length;
382             Valid |= ACPI_VALID_UID;
383         }
384
385         /* Execute the Device._SUB method */
386
387         Status = AcpiUtExecute_SUB (Node, &Sub);
388         if (ACPI_SUCCESS (Status))
389         {
390             InfoSize += Sub->Length;
391             Valid |= ACPI_VALID_SUB;
392         }
393
394         /* Execute the Device._CID method */
395
396         Status = AcpiUtExecute_CID (Node, &CidList);
397         if (ACPI_SUCCESS (Status))
398         {
399             /* Add size of CID strings and CID pointer array */
400
401             InfoSize += (CidList->ListSize - sizeof (ACPI_PNP_DEVICE_ID_LIST));
402             Valid |= ACPI_VALID_CID;
403         }
404     }
405
406     /*
407      * Now that we have the variable-length data, we can allocate the
408      * return buffer
409      */
410     Info = ACPI_ALLOCATE_ZEROED (InfoSize);
411     if (!Info)
412     {
413         Status = AE_NO_MEMORY;
414         goto Cleanup;
415     }
416
417     /* Get the fixed-length data */
418
419     if ((Type == ACPI_TYPE_DEVICE) ||
420         (Type == ACPI_TYPE_PROCESSOR))
421     {
422         /*
423          * Get extra info for ACPI Device/Processor objects only:
424          * Run the _STA, _ADR and, SxW, and _SxD methods.
425          *
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.
429          */
430
431         /* Execute the Device._STA method */
432
433         Status = AcpiUtExecute_STA (Node, &Info->CurrentStatus);
434         if (ACPI_SUCCESS (Status))
435         {
436             Valid |= ACPI_VALID_STA;
437         }
438
439         /* Execute the Device._ADR method */
440
441         Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR, Node,
442                     &Info->Address);
443         if (ACPI_SUCCESS (Status))
444         {
445             Valid |= ACPI_VALID_ADR;
446         }
447
448         /* Execute the Device._SxW methods */
449
450         Status = AcpiUtExecutePowerMethods (Node,
451                     AcpiGbl_LowestDstateNames, ACPI_NUM_SxW_METHODS,
452                     Info->LowestDstates);
453         if (ACPI_SUCCESS (Status))
454         {
455             Valid |= ACPI_VALID_SXWS;
456         }
457
458         /* Execute the Device._SxD methods */
459
460         Status = AcpiUtExecutePowerMethods (Node,
461                     AcpiGbl_HighestDstateNames, ACPI_NUM_SxD_METHODS,
462                     Info->HighestDstates);
463         if (ACPI_SUCCESS (Status))
464         {
465             Valid |= ACPI_VALID_SXDS;
466         }
467     }
468
469     /*
470      * Create a pointer to the string area of the return buffer.
471      * Point to the end of the base ACPI_DEVICE_INFO structure.
472      */
473     NextIdString = ACPI_CAST_PTR (char, Info->CompatibleIdList.Ids);
474     if (CidList)
475     {
476         /* Point past the CID PNP_DEVICE_ID array */
477
478         NextIdString += ((ACPI_SIZE) CidList->Count * sizeof (ACPI_PNP_DEVICE_ID));
479     }
480
481     /*
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.
485      *
486      * For HID and CID, check if the ID is a PCI Root Bridge.
487      */
488     if (Hid)
489     {
490         NextIdString = AcpiNsCopyDeviceId (&Info->HardwareId,
491             Hid, NextIdString);
492
493         if (AcpiUtIsPciRootBridge (Hid->String))
494         {
495             Info->Flags |= ACPI_PCI_ROOT_BRIDGE;
496         }
497     }
498
499     if (Uid)
500     {
501         NextIdString = AcpiNsCopyDeviceId (&Info->UniqueId,
502             Uid, NextIdString);
503     }
504
505     if (Sub)
506     {
507         NextIdString = AcpiNsCopyDeviceId (&Info->SubsystemId,
508             Sub, NextIdString);
509     }
510
511     if (CidList)
512     {
513         Info->CompatibleIdList.Count = CidList->Count;
514         Info->CompatibleIdList.ListSize = CidList->ListSize;
515
516         /* Copy each CID */
517
518         for (i = 0; i < CidList->Count; i++)
519         {
520             NextIdString = AcpiNsCopyDeviceId (&Info->CompatibleIdList.Ids[i],
521                 &CidList->Ids[i], NextIdString);
522
523             if (AcpiUtIsPciRootBridge (CidList->Ids[i].String))
524             {
525                 Info->Flags |= ACPI_PCI_ROOT_BRIDGE;
526             }
527         }
528     }
529
530     /* Copy the fixed-length data */
531
532     Info->InfoSize = InfoSize;
533     Info->Type = Type;
534     Info->Name = Name;
535     Info->ParamCount = ParamCount;
536     Info->Valid = Valid;
537
538     *ReturnBuffer = Info;
539     Status = AE_OK;
540
541
542 Cleanup:
543     if (Hid)
544     {
545         ACPI_FREE (Hid);
546     }
547     if (Uid)
548     {
549         ACPI_FREE (Uid);
550     }
551     if (Sub)
552     {
553         ACPI_FREE (Sub);
554     }
555     if (CidList)
556     {
557         ACPI_FREE (CidList);
558     }
559     return (Status);
560 }
561
562 ACPI_EXPORT_SYMBOL (AcpiGetObjectInfo)
563
564
565 /******************************************************************************
566  *
567  * FUNCTION:    AcpiInstallMethod
568  *
569  * PARAMETERS:  Buffer         - An ACPI table containing one control method
570  *
571  * RETURN:      Status
572  *
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.
577  *
578  ******************************************************************************/
579
580 ACPI_STATUS
581 AcpiInstallMethod (
582     UINT8                   *Buffer)
583 {
584     ACPI_TABLE_HEADER       *Table = ACPI_CAST_PTR (ACPI_TABLE_HEADER, Buffer);
585     UINT8                   *AmlBuffer;
586     UINT8                   *AmlStart;
587     char                    *Path;
588     ACPI_NAMESPACE_NODE     *Node;
589     ACPI_OPERAND_OBJECT     *MethodObj;
590     ACPI_PARSE_STATE        ParserState;
591     UINT32                  AmlLength;
592     UINT16                  Opcode;
593     UINT8                   MethodFlags;
594     ACPI_STATUS             Status;
595
596
597     /* Parameter validation */
598
599     if (!Buffer)
600     {
601         return (AE_BAD_PARAMETER);
602     }
603
604     /* Table must be a DSDT or SSDT */
605
606     if (!ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_DSDT) &&
607         !ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_SSDT))
608     {
609         return (AE_BAD_HEADER);
610     }
611
612     /* First AML opcode in the table must be a control method */
613
614     ParserState.Aml = Buffer + sizeof (ACPI_TABLE_HEADER);
615     Opcode = AcpiPsPeekOpcode (&ParserState);
616     if (Opcode != AML_METHOD_OP)
617     {
618         return (AE_BAD_PARAMETER);
619     }
620
621     /* Extract method information from the raw AML */
622
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);
629
630     /*
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.
633      */
634     AmlBuffer = ACPI_ALLOCATE (AmlLength);
635     if (!AmlBuffer)
636     {
637         return (AE_NO_MEMORY);
638     }
639
640     MethodObj = AcpiUtCreateInternalObject (ACPI_TYPE_METHOD);
641     if (!MethodObj)
642     {
643         ACPI_FREE (AmlBuffer);
644         return (AE_NO_MEMORY);
645     }
646
647     /* Lock namespace for AcpiNsLookup, we may be creating a new node */
648
649     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
650     if (ACPI_FAILURE (Status))
651     {
652         goto ErrorExit;
653     }
654
655     /* The lookup either returns an existing node or creates a new one */
656
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);
659
660     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
661
662     if (ACPI_FAILURE (Status)) /* NsLookup */
663     {
664         if (Status != AE_ALREADY_EXISTS)
665         {
666             goto ErrorExit;
667         }
668
669         /* Node existed previously, make sure it is a method node */
670
671         if (Node->Type != ACPI_TYPE_METHOD)
672         {
673             Status = AE_TYPE;
674             goto ErrorExit;
675         }
676     }
677
678     /* Copy the method AML to the local buffer */
679
680     ACPI_MEMCPY (AmlBuffer, AmlStart, AmlLength);
681
682     /* Initialize the method object with the new method's information */
683
684     MethodObj->Method.AmlStart = AmlBuffer;
685     MethodObj->Method.AmlLength = AmlLength;
686
687     MethodObj->Method.ParamCount = (UINT8)
688         (MethodFlags & AML_METHOD_ARG_COUNT);
689
690     if (MethodFlags & AML_METHOD_SERIALIZED)
691     {
692         MethodObj->Method.InfoFlags = ACPI_METHOD_SERIALIZED;
693
694         MethodObj->Method.SyncLevel = (UINT8)
695             ((MethodFlags & AML_METHOD_SYNC_LEVEL) >> 4);
696     }
697
698     /*
699      * Now that it is complete, we can attach the new method object to
700      * the method Node (detaches/deletes any existing object)
701      */
702     Status = AcpiNsAttachObject (Node, MethodObj, ACPI_TYPE_METHOD);
703
704     /*
705      * Flag indicates AML buffer is dynamic, must be deleted later.
706      * Must be set only after attach above.
707      */
708     Node->Flags |= ANOBJ_ALLOCATED_BUFFER;
709
710     /* Remove local reference to the method object */
711
712     AcpiUtRemoveReference (MethodObj);
713     return (Status);
714
715
716 ErrorExit:
717
718     ACPI_FREE (AmlBuffer);
719     ACPI_FREE (MethodObj);
720     return (Status);
721 }
722
723 ACPI_EXPORT_SYMBOL (AcpiInstallMethod)