sys/contrib/dev/acpica/nsxfname.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nsxfname - Public interfaces to the ACPI subsystem
   4  *                         ACPI Namespace oriented interfaces
   5  *              $Revision: 1.112 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
  14  * All rights reserved.
  15  *
  16  * 2. License
  17  *
  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
  21  * property rights.
  22  *
  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
  29  *
  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;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  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.
  55  *
  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
  66  * make.
  67  *
  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
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  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.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  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
  90  * PARTICULAR PURPOSE.
  91  *
  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
  99  * LIMITED REMEDY.
 100  *
 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.
 115  *
 116  *****************************************************************************/
 117
 118 #define __NSXFNAME_C__
 119
 120 #include <contrib/dev/acpica/acpi.h>
 121 #include <contrib/dev/acpica/acnamesp.h>
 122
 123
 124 #define _COMPONENT          ACPI_NAMESPACE
 125         ACPI_MODULE_NAME    ("nsxfname")
 126
 127
 128 /******************************************************************************
 129  *
 130  * FUNCTION:    AcpiGetHandle
 131  *
 132  * PARAMETERS:  Parent          - Object to search under (search scope).
 133  *              Pathname        - Pointer to an asciiz string containing the
 134  *                                name
 135  *              RetHandle       - Where the return handle is returned
 136  *
 137  * RETURN:      Status
 138  *
 139  * DESCRIPTION: This routine will search for a caller specified name in the
 140  *              name space.  The caller can restrict the search region by
 141  *              specifying a non NULL parent.  The parent value is itself a
 142  *              namespace handle.
 143  *
 144  ******************************************************************************/
 145
 146 ACPI_STATUS
 147 AcpiGetHandle (
 148     ACPI_HANDLE             Parent,
 149     ACPI_STRING             Pathname,
 150     ACPI_HANDLE             *RetHandle)
 151 {
 152     ACPI_STATUS             Status;
 153     ACPI_NAMESPACE_NODE     *Node = NULL;
 154     ACPI_NAMESPACE_NODE     *PrefixNode = NULL;
 155
 156
 157     ACPI_FUNCTION_ENTRY ();
 158
 159
 160     /* Parameter Validation */
 161
 162     if (!RetHandle || !Pathname)
 163     {
 164         return (AE_BAD_PARAMETER);
 165     }
 166
 167     /* Convert a parent handle to a prefix node */
 168
 169     if (Parent)
 170     {
 171         PrefixNode = AcpiNsMapHandleToNode (Parent);
 172         if (!PrefixNode)
 173         {
 174             return (AE_BAD_PARAMETER);
 175         }
 176     }
 177
 178     /*
 179      * Valid cases are:
 180      * 1) Fully qualified pathname
 181      * 2) Parent + Relative pathname
 182      *
 183      * Error for <null Parent + relative path>
 184      */
 185     if (AcpiNsValidRootPrefix (Pathname[0]))
 186     {
 187         /* Pathname is fully qualified (starts with '\') */
 188
 189         /* Special case for root-only, since we can't search for it */
 190
 191         if (!ACPI_STRCMP (Pathname, ACPI_NS_ROOT_PATH))
 192         {
 193             *RetHandle = AcpiNsConvertEntryToHandle (AcpiGbl_RootNode);
 194             return (AE_OK);
 195         }
 196     }
 197     else if (!PrefixNode)
 198     {
 199         /* Relative path with null prefix is disallowed */
 200
 201         return (AE_BAD_PARAMETER);
 202     }
 203
 204     /* Find the Node and convert to a handle */
 205
 206     Status = AcpiNsGetNode (PrefixNode, Pathname, ACPI_NS_NO_UPSEARCH, &Node);
 207     if (ACPI_SUCCESS (Status))
 208     {
 209         *RetHandle = AcpiNsConvertEntryToHandle (Node);
 210     }
 211
 212     return (Status);
 213 }
 214
 215 ACPI_EXPORT_SYMBOL (AcpiGetHandle)
 216
 217
 218 /******************************************************************************
 219  *
 220  * FUNCTION:    AcpiGetName
 221  *
 222  * PARAMETERS:  Handle          - Handle to be converted to a pathname
 223  *              NameType        - Full pathname or single segment
 224  *              Buffer          - Buffer for returned path
 225  *
 226  * RETURN:      Pointer to a string containing the fully qualified Name.
 227  *
 228  * DESCRIPTION: This routine returns the fully qualified name associated with
 229  *              the Handle parameter.  This and the AcpiPathnameToHandle are
 230  *              complementary functions.
 231  *
 232  ******************************************************************************/
 233
 234 ACPI_STATUS
 235 AcpiGetName (
 236     ACPI_HANDLE             Handle,
 237     UINT32                  NameType,
 238     ACPI_BUFFER             *Buffer)
 239 {
 240     ACPI_STATUS             Status;
 241     ACPI_NAMESPACE_NODE     *Node;
 242
 243
 244     /* Parameter validation */
 245
 246     if (NameType > ACPI_NAME_TYPE_MAX)
 247     {
 248         return (AE_BAD_PARAMETER);
 249     }
 250
 251     Status = AcpiUtValidateBuffer (Buffer);
 252     if (ACPI_FAILURE (Status))
 253     {
 254         return (Status);
 255     }
 256
 257     if (NameType == ACPI_FULL_PATHNAME)
 258     {
 259         /* Get the full pathname (From the namespace root) */
 260
 261         Status = AcpiNsHandleToPathname (Handle, Buffer);
 262         return (Status);
 263     }
 264
 265     /*
 266      * Wants the single segment ACPI name.
 267      * Validate handle and convert to a namespace Node
 268      */
 269     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 270     if (ACPI_FAILURE (Status))
 271     {
 272         return (Status);
 273     }
 274
 275     Node = AcpiNsMapHandleToNode (Handle);
 276     if (!Node)
 277     {
 278         Status = AE_BAD_PARAMETER;
 279         goto UnlockAndExit;
 280     }
 281
 282     /* Validate/Allocate/Clear caller buffer */
 283
 284     Status = AcpiUtInitializeBuffer (Buffer, ACPI_PATH_SEGMENT_LENGTH);
 285     if (ACPI_FAILURE (Status))
 286     {
 287         goto UnlockAndExit;
 288     }
 289
 290     /* Just copy the ACPI name from the Node and zero terminate it */
 291
 292     ACPI_STRNCPY (Buffer->Pointer, AcpiUtGetNodeName (Node),
 293                 ACPI_NAME_SIZE);
 294     ((char *) Buffer->Pointer) [ACPI_NAME_SIZE] = 0;
 295     Status = AE_OK;
 296
 297
 298 UnlockAndExit:
 299
 300     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 301     return (Status);
 302 }
 303
 304 ACPI_EXPORT_SYMBOL (AcpiGetName)
 305
 306
 307 /******************************************************************************
 308  *
 309  * FUNCTION:    AcpiGetObjectInfo
 310  *
 311  * PARAMETERS:  Handle          - Object Handle
 312  *              Buffer          - Where the info is returned
 313  *
 314  * RETURN:      Status
 315  *
 316  * DESCRIPTION: Returns information about an object as gleaned from the
 317  *              namespace node and possibly by running several standard
 318  *              control methods (Such as in the case of a device.)
 319  *
 320  ******************************************************************************/
 321
 322 ACPI_STATUS
 323 AcpiGetObjectInfo (
 324     ACPI_HANDLE             Handle,
 325     ACPI_BUFFER             *Buffer)
 326 {
 327     ACPI_STATUS             Status;
 328     ACPI_NAMESPACE_NODE     *Node;
 329     ACPI_DEVICE_INFO        *Info;
 330     ACPI_DEVICE_INFO        *ReturnInfo;
 331     ACPI_COMPATIBLE_ID_LIST *CidList = NULL;
 332     ACPI_SIZE               Size;
 333
 334
 335     /* Parameter validation */
 336
 337     if (!Handle || !Buffer)
 338     {
 339         return (AE_BAD_PARAMETER);
 340     }
 341
 342     Status = AcpiUtValidateBuffer (Buffer);
 343     if (ACPI_FAILURE (Status))
 344     {
 345         return (Status);
 346     }
 347
 348     Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_DEVICE_INFO));
 349     if (!Info)
 350     {
 351         return (AE_NO_MEMORY);
 352     }
 353
 354     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 355     if (ACPI_FAILURE (Status))
 356     {
 357         goto Cleanup;
 358     }
 359
 360     Node = AcpiNsMapHandleToNode (Handle);
 361     if (!Node)
 362     {
 363         (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 364         goto Cleanup;
 365     }
 366
 367     /* Init return structure */
 368
 369     Size = sizeof (ACPI_DEVICE_INFO);
 370
 371     Info->Type  = Node->Type;
 372     Info->Name  = Node->Name.Integer;
 373     Info->Valid = 0;
 374
 375     Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 376     if (ACPI_FAILURE (Status))
 377     {
 378         goto Cleanup;
 379     }
 380
 381     /* If not a device, we are all done */
 382
 383     if (Info->Type == ACPI_TYPE_DEVICE)
 384     {
 385         /*
 386          * Get extra info for ACPI Devices objects only:
 387          * Run the Device _HID, _UID, _CID, _STA, _ADR and _SxD methods.
 388          *
 389          * Note: none of these methods are required, so they may or may
 390          * not be present for this device.  The Info->Valid bitfield is used
 391          * to indicate which methods were found and ran successfully.
 392          */
 393
 394         /* Execute the Device._HID method */
 395
 396         Status = AcpiUtExecute_HID (Node, &Info->HardwareId);
 397         if (ACPI_SUCCESS (Status))
 398         {
 399             Info->Valid |= ACPI_VALID_HID;
 400         }
 401
 402         /* Execute the Device._UID method */
 403
 404         Status = AcpiUtExecute_UID (Node, &Info->UniqueId);
 405         if (ACPI_SUCCESS (Status))
 406         {
 407             Info->Valid |= ACPI_VALID_UID;
 408         }
 409
 410         /* Execute the Device._CID method */
 411
 412         Status = AcpiUtExecute_CID (Node, &CidList);
 413         if (ACPI_SUCCESS (Status))
 414         {
 415             Size += CidList->Size;
 416             Info->Valid |= ACPI_VALID_CID;
 417         }
 418
 419         /* Execute the Device._STA method */
 420
 421         Status = AcpiUtExecute_STA (Node, &Info->CurrentStatus);
 422         if (ACPI_SUCCESS (Status))
 423         {
 424             Info->Valid |= ACPI_VALID_STA;
 425         }
 426
 427         /* Execute the Device._ADR method */
 428
 429         Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR, Node,
 430                         &Info->Address);
 431         if (ACPI_SUCCESS (Status))
 432         {
 433             Info->Valid |= ACPI_VALID_ADR;
 434         }
 435
 436         /* Execute the Device._SxD methods */
 437
 438         Status = AcpiUtExecute_Sxds (Node, Info->HighestDstates);
 439         if (ACPI_SUCCESS (Status))
 440         {
 441             Info->Valid |= ACPI_VALID_SXDS;
 442         }
 443     }
 444
 445     /* Validate/Allocate/Clear caller buffer */
 446
 447     Status = AcpiUtInitializeBuffer (Buffer, Size);
 448     if (ACPI_FAILURE (Status))
 449     {
 450         goto Cleanup;
 451     }
 452
 453     /* Populate the return buffer */
 454
 455     ReturnInfo = Buffer->Pointer;
 456     ACPI_MEMCPY (ReturnInfo, Info, sizeof (ACPI_DEVICE_INFO));
 457
 458     if (CidList)
 459     {
 460         ACPI_MEMCPY (&ReturnInfo->CompatibilityId, CidList, CidList->Size);
 461     }
 462
 463
 464 Cleanup:
 465     ACPI_FREE (Info);
 466     if (CidList)
 467     {
 468         ACPI_FREE (CidList);
 469     }
 470     return (Status);
 471 }
 472
 473 ACPI_EXPORT_SYMBOL (AcpiGetObjectInfo)
 474