sys/contrib/dev/acpica-unix-20031203/namespace/nsxfname.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nsxfname - Public interfaces to the ACPI subsystem
   4  *                         ACPI Namespace oriented interfaces
   5  *              $Revision: 98 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2003, 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 "acpi.h"
 121 #include "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 placed
 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         Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 172         if (ACPI_FAILURE (Status))
 173         {
 174             return (Status);
 175         }
 176
 177         PrefixNode = AcpiNsMapHandleToNode (Parent);
 178         if (!PrefixNode)
 179         {
 180             (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 181             return (AE_BAD_PARAMETER);
 182         }
 183
 184         Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 185         if (ACPI_FAILURE (Status))
 186         {
 187             return (Status);
 188         }
 189     }
 190
 191     /* Special case for root, since we can't search for it */
 192
 193     if (ACPI_STRCMP (Pathname, ACPI_NS_ROOT_PATH) == 0)
 194     {
 195         *RetHandle = AcpiNsConvertEntryToHandle (AcpiGbl_RootNode);
 196         return (AE_OK);
 197     }
 198
 199     /*
 200      *  Find the Node and convert to a handle
 201      */
 202     Status = AcpiNsGetNodeByPath (Pathname, PrefixNode, ACPI_NS_NO_UPSEARCH,
 203                     &Node);
 204
 205     *RetHandle = NULL;
 206     if (ACPI_SUCCESS (Status))
 207     {
 208         *RetHandle = AcpiNsConvertEntryToHandle (Node);
 209     }
 210
 211     return (Status);
 212 }
 213
 214
 215 /******************************************************************************
 216  *
 217  * FUNCTION:    AcpiGetName
 218  *
 219  * PARAMETERS:  Handle          - Handle to be converted to a pathname
 220  *              NameType        - Full pathname or single segment
 221  *              Buffer          - Buffer for returned path
 222  *
 223  * RETURN:      Pointer to a string containing the fully qualified Name.
 224  *
 225  * DESCRIPTION: This routine returns the fully qualified name associated with
 226  *              the Handle parameter.  This and the AcpiPathnameToHandle are
 227  *              complementary functions.
 228  *
 229  ******************************************************************************/
 230
 231 ACPI_STATUS
 232 AcpiGetName (
 233     ACPI_HANDLE             Handle,
 234     UINT32                  NameType,
 235     ACPI_BUFFER             *Buffer)
 236 {
 237     ACPI_STATUS             Status;
 238     ACPI_NAMESPACE_NODE     *Node;
 239
 240
 241     /* Parameter validation */
 242
 243     if (NameType > ACPI_NAME_TYPE_MAX)
 244     {
 245         return (AE_BAD_PARAMETER);
 246     }
 247
 248     Status = AcpiUtValidateBuffer (Buffer);
 249     if (ACPI_FAILURE (Status))
 250     {
 251         return (Status);
 252     }
 253
 254     if (NameType == ACPI_FULL_PATHNAME)
 255     {
 256         /* Get the full pathname (From the namespace root) */
 257
 258         Status = AcpiNsHandleToPathname (Handle, Buffer);
 259         return (Status);
 260     }
 261
 262     /*
 263      * Wants the single segment ACPI name.
 264      * Validate handle and convert to a namespace Node
 265      */
 266     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 267     if (ACPI_FAILURE (Status))
 268     {
 269         return (Status);
 270     }
 271
 272     Node = AcpiNsMapHandleToNode (Handle);
 273     if (!Node)
 274     {
 275         Status = AE_BAD_PARAMETER;
 276         goto UnlockAndExit;
 277     }
 278
 279     /* Validate/Allocate/Clear caller buffer */
 280
 281     Status = AcpiUtInitializeBuffer (Buffer, ACPI_PATH_SEGMENT_LENGTH);
 282     if (ACPI_FAILURE (Status))
 283     {
 284         goto UnlockAndExit;
 285     }
 286
 287     /* Just copy the ACPI name from the Node and zero terminate it */
 288
 289     ACPI_STRNCPY (Buffer->Pointer, AcpiUtGetNodeName (Node),
 290                 ACPI_NAME_SIZE);
 291     ((char *) Buffer->Pointer) [ACPI_NAME_SIZE] = 0;
 292     Status = AE_OK;
 293
 294
 295 UnlockAndExit:
 296
 297     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 298     return (Status);
 299 }
 300
 301
 302 /******************************************************************************
 303  *
 304  * FUNCTION:    AcpiGetObjectInfo
 305  *
 306  * PARAMETERS:  Handle          - Object Handle
 307  *              Info            - Where the info is returned
 308  *
 309  * RETURN:      Status
 310  *
 311  * DESCRIPTION: Returns information about an object as gleaned from the
 312  *              namespace node and possibly by running several standard
 313  *              control methods (Such as in the case of a device.)
 314  *
 315  ******************************************************************************/
 316
 317 ACPI_STATUS
 318 AcpiGetObjectInfo (
 319     ACPI_HANDLE             Handle,
 320     ACPI_BUFFER             *Buffer)
 321 {
 322     ACPI_STATUS             Status;
 323     ACPI_NAMESPACE_NODE     *Node;
 324     ACPI_DEVICE_INFO        Info;
 325     ACPI_DEVICE_INFO        *ReturnInfo;
 326     ACPI_COMPATIBLE_ID_LIST *CidList = NULL;
 327     ACPI_SIZE               Size;
 328
 329
 330     /* Parameter validation */
 331
 332     if (!Handle || !Buffer)
 333     {
 334         return (AE_BAD_PARAMETER);
 335     }
 336
 337     Status = AcpiUtValidateBuffer (Buffer);
 338     if (ACPI_FAILURE (Status))
 339     {
 340         return (Status);
 341     }
 342
 343     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 344     if (ACPI_FAILURE (Status))
 345     {
 346         return (Status);
 347     }
 348
 349     Node = AcpiNsMapHandleToNode (Handle);
 350     if (!Node)
 351     {
 352         (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 353         return (AE_BAD_PARAMETER);
 354     }
 355
 356     /* Init return structure */
 357
 358     Size = sizeof (ACPI_DEVICE_INFO);
 359     ACPI_MEMSET (&Info, 0, Size);
 360
 361     Info.Type  = Node->Type;
 362     Info.Name  = Node->Name.Integer;
 363     Info.Valid = 0;
 364
 365     Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 366     if (ACPI_FAILURE (Status))
 367     {
 368         return (Status);
 369     }
 370
 371     /* If not a device, we are all done */
 372
 373     if (Info.Type == ACPI_TYPE_DEVICE)
 374     {
 375         /*
 376          * Get extra info for ACPI Devices objects only:
 377          * Run the Device _HID, _UID, _CID, _STA, and _ADR methods.
 378          *
 379          * Note: none of these methods are required, so they may or may
 380          * not be present for this device.  The Info.Valid bitfield is used
 381          * to indicate which methods were found and ran successfully.
 382          */
 383
 384         /* Execute the Device._HID method */
 385
 386         Status = AcpiUtExecute_HID (Node, &Info.HardwareId);
 387         if (ACPI_SUCCESS (Status))
 388         {
 389             Info.Valid |= ACPI_VALID_HID;
 390         }
 391
 392         /* Execute the Device._UID method */
 393
 394         Status = AcpiUtExecute_UID (Node, &Info.UniqueId);
 395         if (ACPI_SUCCESS (Status))
 396         {
 397             Info.Valid |= ACPI_VALID_UID;
 398         }
 399
 400         /* Execute the Device._CID method */
 401
 402         Status = AcpiUtExecute_CID (Node, &CidList);
 403         if (ACPI_SUCCESS (Status))
 404         {
 405             Size += ((ACPI_SIZE) CidList->Count - 1) *
 406                                  sizeof (ACPI_COMPATIBLE_ID);
 407             Info.Valid |= ACPI_VALID_CID;
 408         }
 409
 410         /* Execute the Device._STA method */
 411
 412         Status = AcpiUtExecute_STA (Node, &Info.CurrentStatus);
 413         if (ACPI_SUCCESS (Status))
 414         {
 415             Info.Valid |= ACPI_VALID_STA;
 416         }
 417
 418         /* Execute the Device._ADR method */
 419
 420         Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR, Node,
 421                         &Info.Address);
 422         if (ACPI_SUCCESS (Status))
 423         {
 424             Info.Valid |= ACPI_VALID_ADR;
 425         }
 426
 427         Status = AE_OK;
 428     }
 429
 430     /* Validate/Allocate/Clear caller buffer */
 431
 432     Status = AcpiUtInitializeBuffer (Buffer, Size);
 433     if (ACPI_FAILURE (Status))
 434     {
 435         goto Cleanup;
 436     }
 437
 438     /* Populate the return buffer */
 439
 440     ReturnInfo = Buffer->Pointer;
 441     ACPI_MEMCPY (ReturnInfo, &Info, sizeof (ACPI_DEVICE_INFO));
 442
 443     if (CidList)
 444     {
 445         ACPI_MEMCPY (&ReturnInfo->CompatibilityId, CidList, CidList->Size);
 446     }
 447
 448
 449 Cleanup:
 450     if (CidList)
 451     {
 452         ACPI_MEM_FREE (CidList);
 453     }
 454     return (Status);
 455 }
 456