Home | History | Annotate | Line # | Download | only in namespace
nsaccess.c revision 1.14.2.2
      1       1.1    jruoho /*******************************************************************************
      2       1.1    jruoho  *
      3       1.1    jruoho  * Module Name: nsaccess - Top-level functions for accessing ACPI namespace
      4       1.1    jruoho  *
      5       1.1    jruoho  ******************************************************************************/
      6       1.1    jruoho 
      7       1.3    jruoho /*
      8  1.14.2.2    martin  * Copyright (C) 2000 - 2020, Intel Corp.
      9       1.1    jruoho  * All rights reserved.
     10       1.1    jruoho  *
     11       1.3    jruoho  * Redistribution and use in source and binary forms, with or without
     12       1.3    jruoho  * modification, are permitted provided that the following conditions
     13       1.3    jruoho  * are met:
     14       1.3    jruoho  * 1. Redistributions of source code must retain the above copyright
     15       1.3    jruoho  *    notice, this list of conditions, and the following disclaimer,
     16       1.3    jruoho  *    without modification.
     17       1.3    jruoho  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     18       1.3    jruoho  *    substantially similar to the "NO WARRANTY" disclaimer below
     19       1.3    jruoho  *    ("Disclaimer") and any redistribution must be conditioned upon
     20       1.3    jruoho  *    including a substantially similar Disclaimer requirement for further
     21       1.3    jruoho  *    binary redistribution.
     22       1.3    jruoho  * 3. Neither the names of the above-listed copyright holders nor the names
     23       1.3    jruoho  *    of any contributors may be used to endorse or promote products derived
     24       1.3    jruoho  *    from this software without specific prior written permission.
     25       1.3    jruoho  *
     26       1.3    jruoho  * Alternatively, this software may be distributed under the terms of the
     27       1.3    jruoho  * GNU General Public License ("GPL") version 2 as published by the Free
     28       1.3    jruoho  * Software Foundation.
     29       1.3    jruoho  *
     30       1.3    jruoho  * NO WARRANTY
     31       1.3    jruoho  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     32       1.3    jruoho  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     33       1.3    jruoho  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
     34       1.3    jruoho  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     35       1.3    jruoho  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     36       1.3    jruoho  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     37       1.3    jruoho  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     38       1.3    jruoho  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     39       1.3    jruoho  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     40       1.3    jruoho  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     41       1.3    jruoho  * POSSIBILITY OF SUCH DAMAGES.
     42       1.3    jruoho  */
     43       1.1    jruoho 
     44       1.1    jruoho #include "acpi.h"
     45       1.1    jruoho #include "accommon.h"
     46       1.1    jruoho #include "amlcode.h"
     47       1.1    jruoho #include "acnamesp.h"
     48       1.1    jruoho #include "acdispat.h"
     49       1.1    jruoho 
     50      1.12  christos #ifdef ACPI_ASL_COMPILER
     51      1.12  christos     #include "acdisasm.h"
     52      1.12  christos #endif
     53       1.1    jruoho 
     54       1.1    jruoho #define _COMPONENT          ACPI_NAMESPACE
     55       1.1    jruoho         ACPI_MODULE_NAME    ("nsaccess")
     56       1.1    jruoho 
     57       1.1    jruoho 
     58       1.1    jruoho /*******************************************************************************
     59       1.1    jruoho  *
     60       1.1    jruoho  * FUNCTION:    AcpiNsRootInitialize
     61       1.1    jruoho  *
     62       1.1    jruoho  * PARAMETERS:  None
     63       1.1    jruoho  *
     64       1.1    jruoho  * RETURN:      Status
     65       1.1    jruoho  *
     66       1.1    jruoho  * DESCRIPTION: Allocate and initialize the default root named objects
     67       1.1    jruoho  *
     68       1.1    jruoho  * MUTEX:       Locks namespace for entire execution
     69       1.1    jruoho  *
     70       1.1    jruoho  ******************************************************************************/
     71       1.1    jruoho 
     72       1.1    jruoho ACPI_STATUS
     73       1.1    jruoho AcpiNsRootInitialize (
     74       1.1    jruoho     void)
     75       1.1    jruoho {
     76       1.1    jruoho     ACPI_STATUS                 Status;
     77       1.1    jruoho     const ACPI_PREDEFINED_NAMES *InitVal = NULL;
     78       1.1    jruoho     ACPI_NAMESPACE_NODE         *NewNode;
     79       1.1    jruoho     ACPI_OPERAND_OBJECT         *ObjDesc;
     80       1.1    jruoho     ACPI_STRING                 Val = NULL;
     81       1.1    jruoho 
     82       1.1    jruoho 
     83       1.1    jruoho     ACPI_FUNCTION_TRACE (NsRootInitialize);
     84       1.1    jruoho 
     85       1.1    jruoho 
     86       1.1    jruoho     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
     87       1.1    jruoho     if (ACPI_FAILURE (Status))
     88       1.1    jruoho     {
     89       1.1    jruoho         return_ACPI_STATUS (Status);
     90       1.1    jruoho     }
     91       1.1    jruoho 
     92       1.1    jruoho     /*
     93       1.1    jruoho      * The global root ptr is initially NULL, so a non-NULL value indicates
     94       1.1    jruoho      * that AcpiNsRootInitialize() has already been called; just return.
     95       1.1    jruoho      */
     96       1.1    jruoho     if (AcpiGbl_RootNode)
     97       1.1    jruoho     {
     98       1.1    jruoho         Status = AE_OK;
     99       1.1    jruoho         goto UnlockAndExit;
    100       1.1    jruoho     }
    101       1.1    jruoho 
    102       1.1    jruoho     /*
    103       1.1    jruoho      * Tell the rest of the subsystem that the root is initialized
    104       1.1    jruoho      * (This is OK because the namespace is locked)
    105       1.1    jruoho      */
    106       1.1    jruoho     AcpiGbl_RootNode = &AcpiGbl_RootNodeStruct;
    107       1.1    jruoho 
    108       1.1    jruoho     /* Enter the pre-defined names in the name table */
    109       1.1    jruoho 
    110       1.1    jruoho     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
    111       1.1    jruoho         "Entering predefined entries into namespace\n"));
    112       1.1    jruoho 
    113       1.1    jruoho     for (InitVal = AcpiGbl_PreDefinedNames; InitVal->Name; InitVal++)
    114       1.1    jruoho     {
    115       1.1    jruoho         /* _OSI is optional for now, will be permanent later */
    116       1.1    jruoho 
    117       1.7  christos         if (!strcmp (InitVal->Name, "_OSI") && !AcpiGbl_CreateOsiMethod)
    118       1.1    jruoho         {
    119       1.1    jruoho             continue;
    120       1.1    jruoho         }
    121       1.1    jruoho 
    122       1.9  christos         Status = AcpiNsLookup (NULL, ACPI_CAST_PTR (char, InitVal->Name),
    123       1.9  christos             InitVal->Type, ACPI_IMODE_LOAD_PASS2, ACPI_NS_NO_UPSEARCH,
    124       1.8  christos             NULL, &NewNode);
    125       1.4  christos         if (ACPI_FAILURE (Status))
    126       1.1    jruoho         {
    127       1.1    jruoho             ACPI_EXCEPTION ((AE_INFO, Status,
    128       1.1    jruoho                 "Could not create predefined name %s",
    129       1.1    jruoho                 InitVal->Name));
    130       1.4  christos             continue;
    131       1.1    jruoho         }
    132       1.1    jruoho 
    133       1.1    jruoho         /*
    134       1.1    jruoho          * Name entered successfully. If entry in PreDefinedNames[] specifies
    135       1.1    jruoho          * an initial value, create the initial value.
    136       1.1    jruoho          */
    137       1.1    jruoho         if (InitVal->Val)
    138       1.1    jruoho         {
    139       1.1    jruoho             Status = AcpiOsPredefinedOverride (InitVal, &Val);
    140       1.1    jruoho             if (ACPI_FAILURE (Status))
    141       1.1    jruoho             {
    142       1.1    jruoho                 ACPI_ERROR ((AE_INFO,
    143       1.1    jruoho                     "Could not override predefined %s",
    144       1.1    jruoho                     InitVal->Name));
    145       1.1    jruoho             }
    146       1.1    jruoho 
    147       1.1    jruoho             if (!Val)
    148       1.1    jruoho             {
    149       1.2    jruoho                 Val = __UNCONST(InitVal->Val);
    150       1.1    jruoho             }
    151       1.1    jruoho 
    152       1.1    jruoho             /*
    153       1.1    jruoho              * Entry requests an initial value, allocate a
    154       1.1    jruoho              * descriptor for it.
    155       1.1    jruoho              */
    156       1.1    jruoho             ObjDesc = AcpiUtCreateInternalObject (InitVal->Type);
    157       1.1    jruoho             if (!ObjDesc)
    158       1.1    jruoho             {
    159       1.1    jruoho                 Status = AE_NO_MEMORY;
    160       1.1    jruoho                 goto UnlockAndExit;
    161       1.1    jruoho             }
    162       1.1    jruoho 
    163       1.1    jruoho             /*
    164       1.1    jruoho              * Convert value string from table entry to
    165       1.1    jruoho              * internal representation. Only types actually
    166       1.1    jruoho              * used for initial values are implemented here.
    167       1.1    jruoho              */
    168       1.1    jruoho             switch (InitVal->Type)
    169       1.1    jruoho             {
    170       1.1    jruoho             case ACPI_TYPE_METHOD:
    171       1.4  christos 
    172       1.1    jruoho                 ObjDesc->Method.ParamCount = (UINT8) ACPI_TO_INTEGER (Val);
    173       1.1    jruoho                 ObjDesc->Common.Flags |= AOPOBJ_DATA_VALID;
    174       1.1    jruoho 
    175       1.1    jruoho #if defined (ACPI_ASL_COMPILER)
    176       1.1    jruoho 
    177       1.1    jruoho                 /* Save the parameter count for the iASL compiler */
    178       1.1    jruoho 
    179       1.1    jruoho                 NewNode->Value = ObjDesc->Method.ParamCount;
    180       1.1    jruoho #else
    181       1.1    jruoho                 /* Mark this as a very SPECIAL method */
    182       1.1    jruoho 
    183       1.3    jruoho                 ObjDesc->Method.InfoFlags = ACPI_METHOD_INTERNAL_ONLY;
    184       1.3    jruoho                 ObjDesc->Method.Dispatch.Implementation = AcpiUtOsiImplementation;
    185       1.1    jruoho #endif
    186       1.1    jruoho                 break;
    187       1.1    jruoho 
    188       1.1    jruoho             case ACPI_TYPE_INTEGER:
    189       1.1    jruoho 
    190       1.1    jruoho                 ObjDesc->Integer.Value = ACPI_TO_INTEGER (Val);
    191       1.1    jruoho                 break;
    192       1.1    jruoho 
    193       1.1    jruoho             case ACPI_TYPE_STRING:
    194       1.1    jruoho 
    195       1.1    jruoho                 /* Build an object around the static string */
    196       1.1    jruoho 
    197       1.7  christos                 ObjDesc->String.Length = (UINT32) strlen (Val);
    198       1.1    jruoho                 ObjDesc->String.Pointer = Val;
    199       1.1    jruoho                 ObjDesc->Common.Flags |= AOPOBJ_STATIC_POINTER;
    200       1.1    jruoho                 break;
    201       1.1    jruoho 
    202       1.1    jruoho             case ACPI_TYPE_MUTEX:
    203       1.1    jruoho 
    204       1.1    jruoho                 ObjDesc->Mutex.Node = NewNode;
    205       1.1    jruoho                 ObjDesc->Mutex.SyncLevel = (UINT8) (ACPI_TO_INTEGER (Val) - 1);
    206       1.1    jruoho 
    207       1.1    jruoho                 /* Create a mutex */
    208       1.1    jruoho 
    209       1.1    jruoho                 Status = AcpiOsCreateMutex (&ObjDesc->Mutex.OsMutex);
    210       1.1    jruoho                 if (ACPI_FAILURE (Status))
    211       1.1    jruoho                 {
    212       1.1    jruoho                     AcpiUtRemoveReference (ObjDesc);
    213       1.1    jruoho                     goto UnlockAndExit;
    214       1.1    jruoho                 }
    215       1.1    jruoho 
    216       1.1    jruoho                 /* Special case for ACPI Global Lock */
    217       1.1    jruoho 
    218       1.7  christos                 if (strcmp (InitVal->Name, "_GL_") == 0)
    219       1.1    jruoho                 {
    220       1.1    jruoho                     AcpiGbl_GlobalLockMutex = ObjDesc;
    221       1.1    jruoho 
    222       1.1    jruoho                     /* Create additional counting semaphore for global lock */
    223       1.1    jruoho 
    224       1.1    jruoho                     Status = AcpiOsCreateSemaphore (
    225       1.8  christos                         1, 0, &AcpiGbl_GlobalLockSemaphore);
    226       1.1    jruoho                     if (ACPI_FAILURE (Status))
    227       1.1    jruoho                     {
    228       1.1    jruoho                         AcpiUtRemoveReference (ObjDesc);
    229       1.1    jruoho                         goto UnlockAndExit;
    230       1.1    jruoho                     }
    231       1.1    jruoho                 }
    232       1.1    jruoho                 break;
    233       1.1    jruoho 
    234       1.1    jruoho             default:
    235       1.1    jruoho 
    236       1.1    jruoho                 ACPI_ERROR ((AE_INFO, "Unsupported initial type value 0x%X",
    237       1.1    jruoho                     InitVal->Type));
    238       1.1    jruoho                 AcpiUtRemoveReference (ObjDesc);
    239       1.1    jruoho                 ObjDesc = NULL;
    240       1.1    jruoho                 continue;
    241       1.1    jruoho             }
    242       1.1    jruoho 
    243       1.1    jruoho             /* Store pointer to value descriptor in the Node */
    244       1.1    jruoho 
    245       1.1    jruoho             Status = AcpiNsAttachObject (NewNode, ObjDesc,
    246       1.8  christos                 ObjDesc->Common.Type);
    247       1.1    jruoho 
    248       1.1    jruoho             /* Remove local reference to the object */
    249       1.1    jruoho 
    250       1.1    jruoho             AcpiUtRemoveReference (ObjDesc);
    251       1.1    jruoho         }
    252       1.1    jruoho     }
    253       1.1    jruoho 
    254       1.1    jruoho 
    255       1.1    jruoho UnlockAndExit:
    256       1.1    jruoho     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
    257       1.1    jruoho 
    258       1.1    jruoho     /* Save a handle to "_GPE", it is always present */
    259       1.1    jruoho 
    260       1.1    jruoho     if (ACPI_SUCCESS (Status))
    261       1.1    jruoho     {
    262       1.1    jruoho         Status = AcpiNsGetNode (NULL, "\\_GPE", ACPI_NS_NO_UPSEARCH,
    263       1.8  christos             &AcpiGbl_FadtGpeDevice);
    264       1.1    jruoho     }
    265       1.1    jruoho 
    266       1.1    jruoho     return_ACPI_STATUS (Status);
    267       1.1    jruoho }
    268       1.1    jruoho 
    269       1.1    jruoho 
    270       1.1    jruoho /*******************************************************************************
    271       1.1    jruoho  *
    272       1.1    jruoho  * FUNCTION:    AcpiNsLookup
    273       1.1    jruoho  *
    274       1.1    jruoho  * PARAMETERS:  ScopeInfo       - Current scope info block
    275       1.1    jruoho  *              Pathname        - Search pathname, in internal format
    276       1.1    jruoho  *                                (as represented in the AML stream)
    277       1.1    jruoho  *              Type            - Type associated with name
    278       1.1    jruoho  *              InterpreterMode - IMODE_LOAD_PASS2 => add name if not found
    279       1.1    jruoho  *              Flags           - Flags describing the search restrictions
    280       1.1    jruoho  *              WalkState       - Current state of the walk
    281       1.1    jruoho  *              ReturnNode      - Where the Node is placed (if found
    282       1.1    jruoho  *                                or created successfully)
    283       1.1    jruoho  *
    284       1.1    jruoho  * RETURN:      Status
    285       1.1    jruoho  *
    286       1.1    jruoho  * DESCRIPTION: Find or enter the passed name in the name space.
    287       1.1    jruoho  *              Log an error if name not found in Exec mode.
    288       1.1    jruoho  *
    289       1.1    jruoho  * MUTEX:       Assumes namespace is locked.
    290       1.1    jruoho  *
    291       1.1    jruoho  ******************************************************************************/
    292       1.1    jruoho 
    293       1.1    jruoho ACPI_STATUS
    294       1.1    jruoho AcpiNsLookup (
    295       1.1    jruoho     ACPI_GENERIC_STATE      *ScopeInfo,
    296       1.1    jruoho     char                    *Pathname,
    297       1.1    jruoho     ACPI_OBJECT_TYPE        Type,
    298       1.1    jruoho     ACPI_INTERPRETER_MODE   InterpreterMode,
    299       1.1    jruoho     UINT32                  Flags,
    300       1.1    jruoho     ACPI_WALK_STATE         *WalkState,
    301       1.1    jruoho     ACPI_NAMESPACE_NODE     **ReturnNode)
    302       1.1    jruoho {
    303       1.1    jruoho     ACPI_STATUS             Status;
    304       1.1    jruoho     char                    *Path = Pathname;
    305      1.12  christos     char                    *ExternalPath;
    306       1.1    jruoho     ACPI_NAMESPACE_NODE     *PrefixNode;
    307       1.1    jruoho     ACPI_NAMESPACE_NODE     *CurrentNode = NULL;
    308       1.1    jruoho     ACPI_NAMESPACE_NODE     *ThisNode = NULL;
    309       1.1    jruoho     UINT32                  NumSegments;
    310       1.1    jruoho     UINT32                  NumCarats;
    311       1.1    jruoho     ACPI_NAME               SimpleName;
    312       1.1    jruoho     ACPI_OBJECT_TYPE        TypeToCheckFor;
    313       1.1    jruoho     ACPI_OBJECT_TYPE        ThisSearchType;
    314       1.1    jruoho     UINT32                  SearchParentFlag = ACPI_NS_SEARCH_PARENT;
    315       1.1    jruoho     UINT32                  LocalFlags;
    316  1.14.2.1  christos     ACPI_INTERPRETER_MODE   LocalInterpreterMode;
    317       1.1    jruoho 
    318       1.1    jruoho 
    319       1.1    jruoho     ACPI_FUNCTION_TRACE (NsLookup);
    320       1.1    jruoho 
    321       1.1    jruoho 
    322       1.1    jruoho     if (!ReturnNode)
    323       1.1    jruoho     {
    324       1.1    jruoho         return_ACPI_STATUS (AE_BAD_PARAMETER);
    325       1.1    jruoho     }
    326       1.1    jruoho 
    327       1.7  christos     LocalFlags = Flags &
    328       1.7  christos         ~(ACPI_NS_ERROR_IF_FOUND | ACPI_NS_OVERRIDE_IF_FOUND |
    329       1.7  christos           ACPI_NS_SEARCH_PARENT);
    330       1.1    jruoho     *ReturnNode = ACPI_ENTRY_NOT_FOUND;
    331       1.1    jruoho     AcpiGbl_NsLookupCount++;
    332       1.1    jruoho 
    333       1.1    jruoho     if (!AcpiGbl_RootNode)
    334       1.1    jruoho     {
    335       1.1    jruoho         return_ACPI_STATUS (AE_NO_NAMESPACE);
    336       1.1    jruoho     }
    337       1.1    jruoho 
    338       1.1    jruoho     /* Get the prefix scope. A null scope means use the root scope */
    339       1.1    jruoho 
    340       1.1    jruoho     if ((!ScopeInfo) ||
    341       1.1    jruoho         (!ScopeInfo->Scope.Node))
    342       1.1    jruoho     {
    343       1.1    jruoho         ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
    344       1.1    jruoho             "Null scope prefix, using root node (%p)\n",
    345       1.1    jruoho             AcpiGbl_RootNode));
    346       1.1    jruoho 
    347       1.1    jruoho         PrefixNode = AcpiGbl_RootNode;
    348       1.1    jruoho     }
    349       1.1    jruoho     else
    350       1.1    jruoho     {
    351       1.1    jruoho         PrefixNode = ScopeInfo->Scope.Node;
    352       1.1    jruoho         if (ACPI_GET_DESCRIPTOR_TYPE (PrefixNode) != ACPI_DESC_TYPE_NAMED)
    353       1.1    jruoho         {
    354       1.1    jruoho             ACPI_ERROR ((AE_INFO, "%p is not a namespace node [%s]",
    355       1.1    jruoho                 PrefixNode, AcpiUtGetDescriptorName (PrefixNode)));
    356       1.1    jruoho             return_ACPI_STATUS (AE_AML_INTERNAL);
    357       1.1    jruoho         }
    358       1.1    jruoho 
    359       1.1    jruoho         if (!(Flags & ACPI_NS_PREFIX_IS_SCOPE))
    360       1.1    jruoho         {
    361       1.1    jruoho             /*
    362       1.1    jruoho              * This node might not be a actual "scope" node (such as a
    363       1.1    jruoho              * Device/Method, etc.)  It could be a Package or other object
    364       1.1    jruoho              * node. Backup up the tree to find the containing scope node.
    365       1.1    jruoho              */
    366       1.1    jruoho             while (!AcpiNsOpensScope (PrefixNode->Type) &&
    367       1.1    jruoho                     PrefixNode->Type != ACPI_TYPE_ANY)
    368       1.1    jruoho             {
    369       1.1    jruoho                 PrefixNode = PrefixNode->Parent;
    370       1.1    jruoho             }
    371       1.1    jruoho         }
    372       1.1    jruoho     }
    373       1.1    jruoho 
    374       1.1    jruoho     /* Save type. TBD: may be no longer necessary */
    375       1.1    jruoho 
    376       1.1    jruoho     TypeToCheckFor = Type;
    377       1.1    jruoho 
    378       1.1    jruoho     /*
    379       1.1    jruoho      * Begin examination of the actual pathname
    380       1.1    jruoho      */
    381       1.1    jruoho     if (!Pathname)
    382       1.1    jruoho     {
    383       1.1    jruoho         /* A Null NamePath is allowed and refers to the root */
    384       1.1    jruoho 
    385       1.1    jruoho         NumSegments = 0;
    386       1.1    jruoho         ThisNode = AcpiGbl_RootNode;
    387       1.2    jruoho         Path = __UNCONST("");
    388       1.1    jruoho 
    389       1.1    jruoho         ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
    390       1.1    jruoho             "Null Pathname (Zero segments), Flags=%X\n", Flags));
    391       1.1    jruoho     }
    392       1.1    jruoho     else
    393       1.1    jruoho     {
    394       1.1    jruoho         /*
    395       1.1    jruoho          * Name pointer is valid (and must be in internal name format)
    396       1.1    jruoho          *
    397       1.1    jruoho          * Check for scope prefixes:
    398       1.1    jruoho          *
    399       1.1    jruoho          * As represented in the AML stream, a namepath consists of an
    400       1.1    jruoho          * optional scope prefix followed by a name segment part.
    401       1.1    jruoho          *
    402       1.1    jruoho          * If present, the scope prefix is either a Root Prefix (in
    403       1.1    jruoho          * which case the name is fully qualified), or one or more
    404       1.1    jruoho          * Parent Prefixes (in which case the name's scope is relative
    405       1.1    jruoho          * to the current scope).
    406       1.1    jruoho          */
    407       1.1    jruoho         if (*Path == (UINT8) AML_ROOT_PREFIX)
    408       1.1    jruoho         {
    409       1.1    jruoho             /* Pathname is fully qualified, start from the root */
    410       1.1    jruoho 
    411       1.1    jruoho             ThisNode = AcpiGbl_RootNode;
    412       1.1    jruoho             SearchParentFlag = ACPI_NS_NO_UPSEARCH;
    413       1.1    jruoho 
    414       1.1    jruoho             /* Point to name segment part */
    415       1.1    jruoho 
    416       1.1    jruoho             Path++;
    417       1.1    jruoho 
    418       1.1    jruoho             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
    419       1.1    jruoho                 "Path is absolute from root [%p]\n", ThisNode));
    420       1.1    jruoho         }
    421       1.1    jruoho         else
    422       1.1    jruoho         {
    423       1.1    jruoho             /* Pathname is relative to current scope, start there */
    424       1.1    jruoho 
    425       1.1    jruoho             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
    426       1.1    jruoho                 "Searching relative to prefix scope [%4.4s] (%p)\n",
    427       1.1    jruoho                 AcpiUtGetNodeName (PrefixNode), PrefixNode));
    428       1.1    jruoho 
    429       1.1    jruoho             /*
    430       1.1    jruoho              * Handle multiple Parent Prefixes (carat) by just getting
    431       1.1    jruoho              * the parent node for each prefix instance.
    432       1.1    jruoho              */
    433       1.1    jruoho             ThisNode = PrefixNode;
    434       1.1    jruoho             NumCarats = 0;
    435       1.1    jruoho             while (*Path == (UINT8) AML_PARENT_PREFIX)
    436       1.1    jruoho             {
    437       1.1    jruoho                 /* Name is fully qualified, no search rules apply */
    438       1.1    jruoho 
    439       1.1    jruoho                 SearchParentFlag = ACPI_NS_NO_UPSEARCH;
    440       1.1    jruoho 
    441       1.1    jruoho                 /*
    442       1.1    jruoho                  * Point past this prefix to the name segment
    443       1.1    jruoho                  * part or the next Parent Prefix
    444       1.1    jruoho                  */
    445       1.1    jruoho                 Path++;
    446       1.1    jruoho 
    447       1.1    jruoho                 /* Backup to the parent node */
    448       1.1    jruoho 
    449       1.1    jruoho                 NumCarats++;
    450       1.1    jruoho                 ThisNode = ThisNode->Parent;
    451       1.1    jruoho                 if (!ThisNode)
    452       1.1    jruoho                 {
    453      1.12  christos                     /*
    454      1.12  christos                      * Current scope has no parent scope. Externalize
    455      1.12  christos                      * the internal path for error message.
    456      1.12  christos                      */
    457      1.12  christos                     Status = AcpiNsExternalizeName (ACPI_UINT32_MAX, Pathname,
    458      1.12  christos                         NULL, &ExternalPath);
    459      1.12  christos                     if (ACPI_SUCCESS (Status))
    460      1.12  christos                     {
    461      1.12  christos                         ACPI_ERROR ((AE_INFO,
    462      1.12  christos                             "%s: Path has too many parent prefixes (^)",
    463      1.12  christos                             ExternalPath));
    464      1.12  christos 
    465      1.12  christos                         ACPI_FREE (ExternalPath);
    466      1.12  christos                     }
    467       1.1    jruoho 
    468       1.1    jruoho                     return_ACPI_STATUS (AE_NOT_FOUND);
    469       1.1    jruoho                 }
    470       1.1    jruoho             }
    471       1.1    jruoho 
    472       1.1    jruoho             if (SearchParentFlag == ACPI_NS_NO_UPSEARCH)
    473       1.1    jruoho             {
    474       1.1    jruoho                 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
    475       1.1    jruoho                     "Search scope is [%4.4s], path has %u carat(s)\n",
    476       1.1    jruoho                     AcpiUtGetNodeName (ThisNode), NumCarats));
    477       1.1    jruoho             }
    478       1.1    jruoho         }
    479       1.1    jruoho 
    480       1.1    jruoho         /*
    481       1.1    jruoho          * Determine the number of ACPI name segments in this pathname.
    482       1.1    jruoho          *
    483       1.1    jruoho          * The segment part consists of either:
    484       1.1    jruoho          *  - A Null name segment (0)
    485       1.1    jruoho          *  - A DualNamePrefix followed by two 4-byte name segments
    486       1.1    jruoho          *  - A MultiNamePrefix followed by a byte indicating the
    487       1.1    jruoho          *      number of segments and the segments themselves.
    488       1.1    jruoho          *  - A single 4-byte name segment
    489       1.1    jruoho          *
    490       1.1    jruoho          * Examine the name prefix opcode, if any, to determine the number of
    491       1.1    jruoho          * segments.
    492       1.1    jruoho          */
    493       1.1    jruoho         switch (*Path)
    494       1.1    jruoho         {
    495       1.1    jruoho         case 0:
    496       1.1    jruoho             /*
    497       1.1    jruoho              * Null name after a root or parent prefixes. We already
    498       1.1    jruoho              * have the correct target node and there are no name segments.
    499       1.1    jruoho              */
    500       1.1    jruoho             NumSegments  = 0;
    501       1.1    jruoho             Type = ThisNode->Type;
    502       1.1    jruoho 
    503       1.1    jruoho             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
    504       1.1    jruoho                 "Prefix-only Pathname (Zero name segments), Flags=%X\n",
    505       1.1    jruoho                 Flags));
    506       1.1    jruoho             break;
    507       1.1    jruoho 
    508       1.1    jruoho         case AML_DUAL_NAME_PREFIX:
    509       1.1    jruoho 
    510       1.1    jruoho             /* More than one NameSeg, search rules do not apply */
    511       1.1    jruoho 
    512       1.1    jruoho             SearchParentFlag = ACPI_NS_NO_UPSEARCH;
    513       1.1    jruoho 
    514       1.1    jruoho             /* Two segments, point to first name segment */
    515       1.1    jruoho 
    516       1.1    jruoho             NumSegments = 2;
    517       1.1    jruoho             Path++;
    518       1.1    jruoho 
    519       1.1    jruoho             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
    520       1.1    jruoho                 "Dual Pathname (2 segments, Flags=%X)\n", Flags));
    521       1.1    jruoho             break;
    522       1.1    jruoho 
    523      1.11  christos         case AML_MULTI_NAME_PREFIX:
    524       1.1    jruoho 
    525       1.1    jruoho             /* More than one NameSeg, search rules do not apply */
    526       1.1    jruoho 
    527       1.1    jruoho             SearchParentFlag = ACPI_NS_NO_UPSEARCH;
    528       1.1    jruoho 
    529       1.1    jruoho             /* Extract segment count, point to first name segment */
    530       1.1    jruoho 
    531       1.1    jruoho             Path++;
    532       1.1    jruoho             NumSegments = (UINT32) (UINT8) *Path;
    533       1.1    jruoho             Path++;
    534       1.1    jruoho 
    535       1.1    jruoho             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
    536       1.1    jruoho                 "Multi Pathname (%u Segments, Flags=%X)\n",
    537       1.1    jruoho                 NumSegments, Flags));
    538       1.1    jruoho             break;
    539       1.1    jruoho 
    540       1.1    jruoho         default:
    541       1.1    jruoho             /*
    542       1.1    jruoho              * Not a Null name, no Dual or Multi prefix, hence there is
    543       1.1    jruoho              * only one name segment and Pathname is already pointing to it.
    544       1.1    jruoho              */
    545       1.1    jruoho             NumSegments = 1;
    546       1.1    jruoho 
    547       1.1    jruoho             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
    548       1.1    jruoho                 "Simple Pathname (1 segment, Flags=%X)\n", Flags));
    549       1.1    jruoho             break;
    550       1.1    jruoho         }
    551       1.1    jruoho 
    552       1.1    jruoho         ACPI_DEBUG_EXEC (AcpiNsPrintPathname (NumSegments, Path));
    553       1.1    jruoho     }
    554       1.1    jruoho 
    555       1.1    jruoho 
    556       1.1    jruoho     /*
    557       1.1    jruoho      * Search namespace for each segment of the name. Loop through and
    558       1.1    jruoho      * verify (or add to the namespace) each name segment.
    559       1.1    jruoho      *
    560       1.1    jruoho      * The object type is significant only at the last name
    561       1.1    jruoho      * segment. (We don't care about the types along the path, only
    562       1.1    jruoho      * the type of the final target object.)
    563       1.1    jruoho      */
    564       1.1    jruoho     ThisSearchType = ACPI_TYPE_ANY;
    565       1.1    jruoho     CurrentNode = ThisNode;
    566  1.14.2.1  christos 
    567       1.1    jruoho     while (NumSegments && CurrentNode)
    568       1.1    jruoho     {
    569       1.1    jruoho         NumSegments--;
    570       1.1    jruoho         if (!NumSegments)
    571       1.1    jruoho         {
    572       1.1    jruoho             /* This is the last segment, enable typechecking */
    573       1.1    jruoho 
    574       1.1    jruoho             ThisSearchType = Type;
    575       1.1    jruoho 
    576       1.1    jruoho             /*
    577       1.1    jruoho              * Only allow automatic parent search (search rules) if the caller
    578       1.1    jruoho              * requested it AND we have a single, non-fully-qualified NameSeg
    579       1.1    jruoho              */
    580       1.1    jruoho             if ((SearchParentFlag != ACPI_NS_NO_UPSEARCH) &&
    581       1.1    jruoho                 (Flags & ACPI_NS_SEARCH_PARENT))
    582       1.1    jruoho             {
    583       1.1    jruoho                 LocalFlags |= ACPI_NS_SEARCH_PARENT;
    584       1.1    jruoho             }
    585       1.1    jruoho 
    586       1.1    jruoho             /* Set error flag according to caller */
    587       1.1    jruoho 
    588       1.1    jruoho             if (Flags & ACPI_NS_ERROR_IF_FOUND)
    589       1.1    jruoho             {
    590       1.1    jruoho                 LocalFlags |= ACPI_NS_ERROR_IF_FOUND;
    591       1.1    jruoho             }
    592       1.7  christos 
    593       1.7  christos             /* Set override flag according to caller */
    594       1.7  christos 
    595       1.7  christos             if (Flags & ACPI_NS_OVERRIDE_IF_FOUND)
    596       1.7  christos             {
    597       1.7  christos                 LocalFlags |= ACPI_NS_OVERRIDE_IF_FOUND;
    598       1.7  christos             }
    599       1.1    jruoho         }
    600       1.1    jruoho 
    601  1.14.2.1  christos         /* Handle opcodes that create a new NameSeg via a full NamePath */
    602  1.14.2.1  christos 
    603  1.14.2.1  christos         LocalInterpreterMode = InterpreterMode;
    604  1.14.2.1  christos         if ((Flags & ACPI_NS_PREFIX_MUST_EXIST) && (NumSegments > 0))
    605  1.14.2.1  christos         {
    606  1.14.2.1  christos             /* Every element of the path must exist (except for the final NameSeg) */
    607  1.14.2.1  christos 
    608  1.14.2.1  christos             LocalInterpreterMode = ACPI_IMODE_EXECUTE;
    609  1.14.2.1  christos         }
    610  1.14.2.1  christos 
    611       1.1    jruoho         /* Extract one ACPI name from the front of the pathname */
    612       1.1    jruoho 
    613       1.1    jruoho         ACPI_MOVE_32_TO_32 (&SimpleName, Path);
    614       1.1    jruoho 
    615       1.1    jruoho         /* Try to find the single (4 character) ACPI name */
    616       1.1    jruoho 
    617       1.1    jruoho         Status = AcpiNsSearchAndEnter (SimpleName, WalkState, CurrentNode,
    618  1.14.2.1  christos             LocalInterpreterMode, ThisSearchType, LocalFlags, &ThisNode);
    619       1.1    jruoho         if (ACPI_FAILURE (Status))
    620       1.1    jruoho         {
    621       1.1    jruoho             if (Status == AE_NOT_FOUND)
    622       1.1    jruoho             {
    623  1.14.2.1  christos #if !defined ACPI_ASL_COMPILER /* Note: iASL reports this error by itself, not needed here */
    624  1.14.2.1  christos                 if (Flags & ACPI_NS_PREFIX_MUST_EXIST)
    625  1.14.2.1  christos                 {
    626  1.14.2.1  christos                     AcpiOsPrintf (ACPI_MSG_BIOS_ERROR
    627  1.14.2.1  christos                         "Object does not exist: %4.4s\n", &SimpleName);
    628  1.14.2.1  christos                 }
    629  1.14.2.1  christos #endif
    630       1.1    jruoho                 /* Name not found in ACPI namespace */
    631       1.1    jruoho 
    632       1.1    jruoho                 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
    633       1.1    jruoho                     "Name [%4.4s] not found in scope [%4.4s] %p\n",
    634       1.1    jruoho                     (char *) &SimpleName, (char *) &CurrentNode->Name,
    635       1.1    jruoho                     CurrentNode));
    636       1.1    jruoho             }
    637       1.1    jruoho 
    638  1.14.2.1  christos #ifdef ACPI_EXEC_APP
    639  1.14.2.1  christos             if ((Status == AE_ALREADY_EXISTS) &&
    640  1.14.2.1  christos                 (ThisNode->Flags & ANOBJ_NODE_EARLY_INIT))
    641  1.14.2.1  christos             {
    642  1.14.2.1  christos                 ThisNode->Flags &= ~ANOBJ_NODE_EARLY_INIT;
    643  1.14.2.1  christos                 Status = AE_OK;
    644  1.14.2.1  christos             }
    645  1.14.2.1  christos #endif
    646  1.14.2.1  christos 
    647      1.12  christos #ifdef ACPI_ASL_COMPILER
    648      1.12  christos             /*
    649      1.12  christos              * If this ACPI name already exists within the namespace as an
    650      1.12  christos              * external declaration, then mark the external as a conflicting
    651      1.12  christos              * declaration and proceed to process the current node as if it did
    652      1.12  christos              * not exist in the namespace. If this node is not processed as
    653      1.12  christos              * normal, then it could cause improper namespace resolution
    654      1.12  christos              * by failing to open a new scope.
    655      1.12  christos              */
    656      1.12  christos             if (AcpiGbl_DisasmFlag &&
    657      1.12  christos                 (Status == AE_ALREADY_EXISTS) &&
    658      1.12  christos                 ((ThisNode->Flags & ANOBJ_IS_EXTERNAL) ||
    659      1.12  christos                     (WalkState && WalkState->Opcode == AML_EXTERNAL_OP)))
    660      1.12  christos             {
    661      1.12  christos                 ThisNode->Flags &= ~ANOBJ_IS_EXTERNAL;
    662      1.12  christos                 ThisNode->Type = (UINT8)ThisSearchType;
    663      1.12  christos                 if (WalkState->Opcode != AML_EXTERNAL_OP)
    664      1.12  christos                 {
    665      1.12  christos                     AcpiDmMarkExternalConflict (ThisNode);
    666      1.12  christos                 }
    667      1.12  christos                 break;
    668      1.12  christos             }
    669      1.12  christos #endif
    670      1.12  christos 
    671       1.1    jruoho             *ReturnNode = ThisNode;
    672       1.1    jruoho             return_ACPI_STATUS (Status);
    673       1.1    jruoho         }
    674       1.1    jruoho 
    675       1.1    jruoho         /* More segments to follow? */
    676       1.1    jruoho 
    677       1.1    jruoho         if (NumSegments > 0)
    678       1.1    jruoho         {
    679       1.1    jruoho             /*
    680       1.1    jruoho              * If we have an alias to an object that opens a scope (such as a
    681       1.1    jruoho              * device or processor), we need to dereference the alias here so
    682       1.1    jruoho              * that we can access any children of the original node (via the
    683       1.1    jruoho              * remaining segments).
    684       1.1    jruoho              */
    685       1.1    jruoho             if (ThisNode->Type == ACPI_TYPE_LOCAL_ALIAS)
    686       1.1    jruoho             {
    687       1.1    jruoho                 if (!ThisNode->Object)
    688       1.1    jruoho                 {
    689       1.1    jruoho                     return_ACPI_STATUS (AE_NOT_EXIST);
    690       1.1    jruoho                 }
    691       1.1    jruoho 
    692       1.1    jruoho                 if (AcpiNsOpensScope (((ACPI_NAMESPACE_NODE *)
    693       1.1    jruoho                         ThisNode->Object)->Type))
    694       1.1    jruoho                 {
    695       1.1    jruoho                     ThisNode = (ACPI_NAMESPACE_NODE *) ThisNode->Object;
    696       1.1    jruoho                 }
    697       1.1    jruoho             }
    698       1.1    jruoho         }
    699       1.1    jruoho 
    700       1.1    jruoho         /* Special handling for the last segment (NumSegments == 0) */
    701       1.1    jruoho 
    702       1.1    jruoho         else
    703       1.1    jruoho         {
    704       1.1    jruoho             /*
    705       1.1    jruoho              * Sanity typecheck of the target object:
    706       1.1    jruoho              *
    707       1.1    jruoho              * If 1) This is the last segment (NumSegments == 0)
    708       1.1    jruoho              *    2) And we are looking for a specific type
    709       1.1    jruoho              *       (Not checking for TYPE_ANY)
    710       1.1    jruoho              *    3) Which is not an alias
    711       1.1    jruoho              *    4) Which is not a local type (TYPE_SCOPE)
    712       1.1    jruoho              *    5) And the type of target object is known (not TYPE_ANY)
    713       1.1    jruoho              *    6) And target object does not match what we are looking for
    714       1.1    jruoho              *
    715       1.1    jruoho              * Then we have a type mismatch. Just warn and ignore it.
    716       1.1    jruoho              */
    717       1.1    jruoho             if ((TypeToCheckFor != ACPI_TYPE_ANY)                   &&
    718       1.1    jruoho                 (TypeToCheckFor != ACPI_TYPE_LOCAL_ALIAS)           &&
    719       1.1    jruoho                 (TypeToCheckFor != ACPI_TYPE_LOCAL_METHOD_ALIAS)    &&
    720       1.1    jruoho                 (TypeToCheckFor != ACPI_TYPE_LOCAL_SCOPE)           &&
    721       1.1    jruoho                 (ThisNode->Type != ACPI_TYPE_ANY)                   &&
    722       1.1    jruoho                 (ThisNode->Type != TypeToCheckFor))
    723       1.1    jruoho             {
    724       1.1    jruoho                 /* Complain about a type mismatch */
    725       1.1    jruoho 
    726       1.1    jruoho                 ACPI_WARNING ((AE_INFO,
    727       1.1    jruoho                     "NsLookup: Type mismatch on %4.4s (%s), searching for (%s)",
    728       1.1    jruoho                     ACPI_CAST_PTR (char, &SimpleName),
    729       1.1    jruoho                     AcpiUtGetTypeName (ThisNode->Type),
    730       1.1    jruoho                     AcpiUtGetTypeName (TypeToCheckFor)));
    731       1.1    jruoho             }
    732       1.1    jruoho 
    733       1.1    jruoho             /*
    734       1.1    jruoho              * If this is the last name segment and we are not looking for a
    735       1.1    jruoho              * specific type, but the type of found object is known, use that
    736       1.1    jruoho              * type to (later) see if it opens a scope.
    737       1.1    jruoho              */
    738       1.1    jruoho             if (Type == ACPI_TYPE_ANY)
    739       1.1    jruoho             {
    740       1.1    jruoho                 Type = ThisNode->Type;
    741       1.1    jruoho             }
    742       1.1    jruoho         }
    743       1.1    jruoho 
    744       1.1    jruoho         /* Point to next name segment and make this node current */
    745       1.1    jruoho 
    746  1.14.2.1  christos         Path += ACPI_NAMESEG_SIZE;
    747       1.1    jruoho         CurrentNode = ThisNode;
    748       1.1    jruoho     }
    749       1.1    jruoho 
    750       1.1    jruoho     /* Always check if we need to open a new scope */
    751       1.1    jruoho 
    752       1.1    jruoho     if (!(Flags & ACPI_NS_DONT_OPEN_SCOPE) && (WalkState))
    753       1.1    jruoho     {
    754       1.1    jruoho         /*
    755       1.1    jruoho          * If entry is a type which opens a scope, push the new scope on the
    756       1.1    jruoho          * scope stack.
    757       1.1    jruoho          */
    758       1.1    jruoho         if (AcpiNsOpensScope (Type))
    759       1.1    jruoho         {
    760       1.1    jruoho             Status = AcpiDsScopeStackPush (ThisNode, Type, WalkState);
    761       1.1    jruoho             if (ACPI_FAILURE (Status))
    762       1.1    jruoho             {
    763       1.1    jruoho                 return_ACPI_STATUS (Status);
    764       1.1    jruoho             }
    765       1.1    jruoho         }
    766       1.1    jruoho     }
    767       1.1    jruoho 
    768  1.14.2.1  christos #ifdef ACPI_EXEC_APP
    769  1.14.2.1  christos     if (Flags & ACPI_NS_EARLY_INIT)
    770  1.14.2.1  christos     {
    771  1.14.2.1  christos         ThisNode->Flags |= ANOBJ_NODE_EARLY_INIT;
    772  1.14.2.1  christos     }
    773  1.14.2.1  christos #endif
    774  1.14.2.1  christos 
    775       1.1    jruoho     *ReturnNode = ThisNode;
    776       1.1    jruoho     return_ACPI_STATUS (AE_OK);
    777       1.1    jruoho }
    778