Back to home page

Quest Cross Reference

 
 

    


Warning, cross-references for /kernel/drivers/acpica/nsnames.c need to be fixed.

0001 /*******************************************************************************
0002  *
0003  * Module Name: nsnames - Name manipulation and search
0004  *
0005  ******************************************************************************/
0006 
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights.  You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code.  No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision.  In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change.  Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee.  Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution.  In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government.  In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************/
0115 
0116 #define __NSNAMES_C__
0117 
0118 #include "acpi.h"
0119 #include "accommon.h"
0120 #include "amlcode.h"
0121 #include "acnamesp.h"
0122 
0123 
0124 #define _COMPONENT          ACPI_NAMESPACE
0125         ACPI_MODULE_NAME    ("nsnames")
0126 
0127 
0128 /*******************************************************************************
0129  *
0130  * FUNCTION:    AcpiNsBuildExternalPath
0131  *
0132  * PARAMETERS:  Node            - NS node whose pathname is needed
0133  *              Size            - Size of the pathname
0134  *              *NameBuffer     - Where to return the pathname
0135  *
0136  * RETURN:      Status
0137  *              Places the pathname into the NameBuffer, in external format
0138  *              (name segments separated by path separators)
0139  *
0140  * DESCRIPTION: Generate a full pathaname
0141  *
0142  ******************************************************************************/
0143 
0144 ACPI_STATUS
0145 AcpiNsBuildExternalPath (
0146     ACPI_NAMESPACE_NODE     *Node,
0147     ACPI_SIZE               Size,
0148     char                    *NameBuffer)
0149 {
0150     ACPI_SIZE               Index;
0151     ACPI_NAMESPACE_NODE     *ParentNode;
0152 
0153 
0154     ACPI_FUNCTION_ENTRY ();
0155 
0156 
0157     /* Special case for root */
0158 
0159     Index = Size - 1;
0160     if (Index < ACPI_NAME_SIZE)
0161     {
0162         NameBuffer[0] = AML_ROOT_PREFIX;
0163         NameBuffer[1] = 0;
0164         return (AE_OK);
0165     }
0166 
0167     /* Store terminator byte, then build name backwards */
0168 
0169     ParentNode = Node;
0170     NameBuffer[Index] = 0;
0171 
0172     while ((Index > ACPI_NAME_SIZE) && (ParentNode != AcpiGbl_RootNode))
0173     {
0174         Index -= ACPI_NAME_SIZE;
0175 
0176         /* Put the name into the buffer */
0177 
0178         ACPI_MOVE_32_TO_32 ((NameBuffer + Index), &ParentNode->Name);
0179         ParentNode = AcpiNsGetParentNode (ParentNode);
0180 
0181         /* Prefix name with the path separator */
0182 
0183         Index--;
0184         NameBuffer[Index] = ACPI_PATH_SEPARATOR;
0185     }
0186 
0187     /* Overwrite final separator with the root prefix character */
0188 
0189     NameBuffer[Index] = AML_ROOT_PREFIX;
0190 
0191     if (Index != 0)
0192     {
0193         ACPI_ERROR ((AE_INFO,
0194             "Could not construct external pathname; index=%X, size=%X, Path=%s",
0195             (UINT32) Index, (UINT32) Size, &NameBuffer[Size]));
0196 
0197         return (AE_BAD_PARAMETER);
0198     }
0199 
0200     return (AE_OK);
0201 }
0202 
0203 
0204 /*******************************************************************************
0205  *
0206  * FUNCTION:    AcpiNsGetExternalPathname
0207  *
0208  * PARAMETERS:  Node            - Namespace node whose pathname is needed
0209  *
0210  * RETURN:      Pointer to storage containing the fully qualified name of
0211  *              the node, In external format (name segments separated by path
0212  *              separators.)
0213  *
0214  * DESCRIPTION: Used to obtain the full pathname to a namespace node, usually
0215  *              for error and debug statements.
0216  *
0217  ******************************************************************************/
0218 
0219 char *
0220 AcpiNsGetExternalPathname (
0221     ACPI_NAMESPACE_NODE     *Node)
0222 {
0223     ACPI_STATUS             Status;
0224     char                    *NameBuffer;
0225     ACPI_SIZE               Size;
0226 
0227 
0228     ACPI_FUNCTION_TRACE_PTR (NsGetExternalPathname, Node);
0229 
0230 
0231     /* Calculate required buffer size based on depth below root */
0232 
0233     Size = AcpiNsGetPathnameLength (Node);
0234     if (!Size)
0235     {
0236         return_PTR (NULL);
0237     }
0238 
0239     /* Allocate a buffer to be returned to caller */
0240 
0241     NameBuffer = ACPI_ALLOCATE_ZEROED (Size);
0242     if (!NameBuffer)
0243     {
0244         ACPI_ERROR ((AE_INFO, "Could not allocate %u bytes", (UINT32) Size));
0245         return_PTR (NULL);
0246     }
0247 
0248     /* Build the path in the allocated buffer */
0249 
0250     Status = AcpiNsBuildExternalPath (Node, Size, NameBuffer);
0251     if (ACPI_FAILURE (Status))
0252     {
0253         ACPI_FREE (NameBuffer);
0254         return_PTR (NULL);
0255     }
0256 
0257     return_PTR (NameBuffer);
0258 }
0259 
0260 
0261 /*******************************************************************************
0262  *
0263  * FUNCTION:    AcpiNsGetPathnameLength
0264  *
0265  * PARAMETERS:  Node        - Namespace node
0266  *
0267  * RETURN:      Length of path, including prefix
0268  *
0269  * DESCRIPTION: Get the length of the pathname string for this node
0270  *
0271  ******************************************************************************/
0272 
0273 ACPI_SIZE
0274 AcpiNsGetPathnameLength (
0275     ACPI_NAMESPACE_NODE     *Node)
0276 {
0277     ACPI_SIZE               Size;
0278     ACPI_NAMESPACE_NODE     *NextNode;
0279 
0280 
0281     ACPI_FUNCTION_ENTRY ();
0282 
0283 
0284     /*
0285      * Compute length of pathname as 5 * number of name segments.
0286      * Go back up the parent tree to the root
0287      */
0288     Size = 0;
0289     NextNode = Node;
0290 
0291     while (NextNode && (NextNode != AcpiGbl_RootNode))
0292     {
0293         if (ACPI_GET_DESCRIPTOR_TYPE (NextNode) != ACPI_DESC_TYPE_NAMED)
0294         {
0295             ACPI_ERROR ((AE_INFO,
0296                 "Invalid Namespace Node (%p) while traversing namespace",
0297                 NextNode));
0298             return 0;
0299         }
0300         Size += ACPI_PATH_SEGMENT_LENGTH;
0301         NextNode = AcpiNsGetParentNode (NextNode);
0302     }
0303 
0304     if (!Size)
0305     {
0306         Size = 1; /* Root node case */
0307     }
0308 
0309     return (Size + 1);  /* +1 for null string terminator */
0310 }
0311 
0312 
0313 /*******************************************************************************
0314  *
0315  * FUNCTION:    AcpiNsHandleToPathname
0316  *
0317  * PARAMETERS:  TargetHandle            - Handle of named object whose name is
0318  *                                        to be found
0319  *              Buffer                  - Where the pathname is returned
0320  *
0321  * RETURN:      Status, Buffer is filled with pathname if status is AE_OK
0322  *
0323  * DESCRIPTION: Build and return a full namespace pathname
0324  *
0325  ******************************************************************************/
0326 
0327 ACPI_STATUS
0328 AcpiNsHandleToPathname (
0329     ACPI_HANDLE             TargetHandle,
0330     ACPI_BUFFER             *Buffer)
0331 {
0332     ACPI_STATUS             Status;
0333     ACPI_NAMESPACE_NODE     *Node;
0334     ACPI_SIZE               RequiredSize;
0335 
0336 
0337     ACPI_FUNCTION_TRACE_PTR (NsHandleToPathname, TargetHandle);
0338 
0339 
0340     Node = AcpiNsMapHandleToNode (TargetHandle);
0341     if (!Node)
0342     {
0343         return_ACPI_STATUS (AE_BAD_PARAMETER);
0344     }
0345 
0346     /* Determine size required for the caller buffer */
0347 
0348     RequiredSize = AcpiNsGetPathnameLength (Node);
0349     if (!RequiredSize)
0350     {
0351         return_ACPI_STATUS (AE_BAD_PARAMETER);
0352     }
0353 
0354     /* Validate/Allocate/Clear caller buffer */
0355 
0356     Status = AcpiUtInitializeBuffer (Buffer, RequiredSize);
0357     if (ACPI_FAILURE (Status))
0358     {
0359         return_ACPI_STATUS (Status);
0360     }
0361 
0362     /* Build the path in the caller buffer */
0363 
0364     Status = AcpiNsBuildExternalPath (Node, RequiredSize, Buffer->Pointer);
0365     if (ACPI_FAILURE (Status))
0366     {
0367         return_ACPI_STATUS (Status);
0368     }
0369 
0370     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%s [%X]\n",
0371         (char *) Buffer->Pointer, (UINT32) RequiredSize));
0372     return_ACPI_STATUS (AE_OK);
0373 }
0374 
0375