FreeBSD/Linux Kernel Cross Reference
sys/contrib/dev/acpica/components/utilities/utmisc.c

     /*******************************************************************************
      *
      * Module Name: utmisc - common utility procedures
      *
      ******************************************************************************/
     
     /******************************************************************************
      *
      * 1. Copyright Notice
     *
     * Some or all of this work - Copyright (c) 1999 - 2022, Intel Corp.
     * All rights reserved.
     *
     * 2. License
     *
     * 2.1. This is your license from Intel Corp. under its intellectual property
     * rights. You may have additional license terms from the party that provided
     * you this software, covering your right to use that party's intellectual
     * property rights.
     *
     * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     * copy of the source code appearing in this file ("Covered Code") an
     * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     * base code distributed originally by Intel ("Original Intel Code") to copy,
     * make derivatives, distribute, use and display any portion of the Covered
     * Code in any form, with the right to sublicense such rights; and
     *
     * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     * license (with the right to sublicense), under only those claims of Intel
     * patents that are infringed by the Original Intel Code, to make, use, sell,
     * offer to sell, and import the Covered Code and derivative works thereof
     * solely to the minimum extent necessary to exercise the above copyright
     * license, and in no event shall the patent license extend to any additions
     * to or modifications of the Original Intel Code. No other license or right
     * is granted directly or by implication, estoppel or otherwise;
     *
     * The above copyright and patent license is granted only if the following
     * conditions are met:
     *
     * 3. Conditions
     *
     * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification with rights to further distribute source must include
     * the above Copyright Notice, the above License, this list of Conditions,
     * and the following Disclaimer and Export Compliance provision. In addition,
     * Licensee must cause all Covered Code to which Licensee contributes to
     * contain a file documenting the changes Licensee made to create that Covered
     * Code and the date of any change. Licensee must include in that file the
     * documentation of any changes made by any predecessor Licensee. Licensee
     * must include a prominent statement that the modification is derived,
     * directly or indirectly, from Original Intel Code.
     *
     * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification without rights to further distribute source must
     * include the following Disclaimer and Export Compliance provision in the
     * documentation and/or other materials provided with distribution. In
     * addition, Licensee may not authorize further sublicense of source of any
     * portion of the Covered Code, and must include terms to the effect that the
     * license from Licensee to its licensee is limited to the intellectual
     * property embodied in the software Licensee provides to its licensee, and
     * not to intellectual property embodied in modifications its licensee may
     * make.
     *
     * 3.3. Redistribution of Executable. Redistribution in executable form of any
     * substantial portion of the Covered Code or modification must reproduce the
     * above Copyright Notice, and the following Disclaimer and Export Compliance
     * provision in the documentation and/or other materials provided with the
     * distribution.
     *
     * 3.4. Intel retains all right, title, and interest in and to the Original
     * Intel Code.
     *
     * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     * Intel shall be used in advertising or otherwise to promote the sale, use or
     * other dealings in products derived from or relating to the Covered Code
     * without prior written authorization from Intel.
     *
     * 4. Disclaimer and Export Compliance
     *
     * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     * PARTICULAR PURPOSE.
     *
     * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     * LIMITED REMEDY.
     *
     * 4.3. Licensee shall not export, either directly or indirectly, any of this
    * software or system incorporating such software without first obtaining any
    * required license or other approval from the U. S. Department of Commerce or
    * any other agency or department of the United States Government. In the
    * event Licensee exports any such software from the United States or
    * re-exports any such software from a foreign destination, Licensee shall
    * ensure that the distribution and export/re-export of the software is in
    * compliance with all laws, regulations, orders, or other restrictions of the
    * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    * any of its subsidiaries will export/re-export any technical data, process,
    * software, or service, directly or indirectly, to any country for which the
    * United States government or any agency thereof requires an export license,
    * other governmental approval, or letter of assurance, without first obtaining
    * such license, approval or letter.
    *
    *****************************************************************************
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * following license:
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    * 1. Redistributions of source code must retain the above copyright
    *    notice, this list of conditions, and the following disclaimer,
    *    without modification.
    * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    *    substantially similar to the "NO WARRANTY" disclaimer below
    *    ("Disclaimer") and any redistribution must be conditioned upon
    *    including a substantially similar Disclaimer requirement for further
    *    binary redistribution.
    * 3. Neither the names of the above-listed copyright holders nor the names
    *    of any contributors may be used to endorse or promote products derived
    *    from this software without specific prior written permission.
    *
    * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * GNU General Public License ("GPL") version 2 as published by the Free
    * Software Foundation.
    *
    *****************************************************************************/
   
   #include <contrib/dev/acpica/include/acpi.h>
   #include <contrib/dev/acpica/include/accommon.h>
   #include <contrib/dev/acpica/include/acnamesp.h>
   
   
   #define _COMPONENT          ACPI_UTILITIES
           ACPI_MODULE_NAME    ("utmisc")
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiUtIsPciRootBridge
    *
    * PARAMETERS:  Id              - The HID/CID in string format
    *
    * RETURN:      TRUE if the Id is a match for a PCI/PCI-Express Root Bridge
    *
    * DESCRIPTION: Determine if the input ID is a PCI Root Bridge ID.
    *
    ******************************************************************************/
   
   BOOLEAN
   AcpiUtIsPciRootBridge (
       char                    *Id)
   {
   
       /*
        * Check if this is a PCI root bridge.
        * ACPI 3.0+: check for a PCI Express root also.
        */
       if (!(strcmp (Id,
           PCI_ROOT_HID_STRING)) ||
   
           !(strcmp (Id,
           PCI_EXPRESS_ROOT_HID_STRING)))
       {
           return (TRUE);
       }
   
       return (FALSE);
   }
   
   
   #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
   /*******************************************************************************
    *
    * FUNCTION:    AcpiUtIsAmlTable
    *
    * PARAMETERS:  Table               - An ACPI table
    *
    * RETURN:      TRUE if table contains executable AML; FALSE otherwise
    *
    * DESCRIPTION: Check ACPI Signature for a table that contains AML code.
    *              Currently, these are DSDT,SSDT,PSDT. All other table types are
    *              data tables that do not contain AML code.
    *
    ******************************************************************************/
   
   BOOLEAN
   AcpiUtIsAmlTable (
       ACPI_TABLE_HEADER       *Table)
   {
   
       /* These are the only tables that contain executable AML */
   
       if (ACPI_COMPARE_NAMESEG (Table->Signature, ACPI_SIG_DSDT) ||
           ACPI_COMPARE_NAMESEG (Table->Signature, ACPI_SIG_PSDT) ||
           ACPI_COMPARE_NAMESEG (Table->Signature, ACPI_SIG_SSDT) ||
           ACPI_COMPARE_NAMESEG (Table->Signature, ACPI_SIG_OSDT) ||
           ACPI_IS_OEM_SIG (Table->Signature))
       {
           return (TRUE);
       }
   
       return (FALSE);
   }
   #endif
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiUtDwordByteSwap
    *
    * PARAMETERS:  Value           - Value to be converted
    *
    * RETURN:      UINT32 integer with bytes swapped
    *
    * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
    *
    ******************************************************************************/
   
   UINT32
   AcpiUtDwordByteSwap (
       UINT32                  Value)
   {
       union
       {
           UINT32              Value;
           UINT8               Bytes[4];
       } Out;
       union
       {
           UINT32              Value;
           UINT8               Bytes[4];
       } In;
   
   
       ACPI_FUNCTION_ENTRY ();
   
   
       In.Value = Value;
   
       Out.Bytes[0] = In.Bytes[3];
       Out.Bytes[1] = In.Bytes[2];
       Out.Bytes[2] = In.Bytes[1];
       Out.Bytes[3] = In.Bytes[0];
   
       return (Out.Value);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiUtSetIntegerWidth
    *
    * PARAMETERS:  Revision            From DSDT header
    *
    * RETURN:      None
    *
    * DESCRIPTION: Set the global integer bit width based upon the revision
    *              of the DSDT. For Revision 1 and 0, Integers are 32 bits.
    *              For Revision 2 and above, Integers are 64 bits. Yes, this
    *              makes a difference.
    *
    ******************************************************************************/
   
   void
   AcpiUtSetIntegerWidth (
       UINT8                   Revision)
   {
   
       if (Revision < 2)
       {
           /* 32-bit case */
   
           AcpiGbl_IntegerBitWidth = 32;
           AcpiGbl_IntegerNybbleWidth = 8;
           AcpiGbl_IntegerByteWidth = 4;
       }
       else
       {
           /* 64-bit case (ACPI 2.0+) */
   
           AcpiGbl_IntegerBitWidth = 64;
           AcpiGbl_IntegerNybbleWidth = 16;
           AcpiGbl_IntegerByteWidth = 8;
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiUtCreateUpdateStateAndPush
    *
    * PARAMETERS:  Object          - Object to be added to the new state
    *              Action          - Increment/Decrement
    *              StateList       - List the state will be added to
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Create a new state and push it
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiUtCreateUpdateStateAndPush (
       ACPI_OPERAND_OBJECT     *Object,
       UINT16                  Action,
       ACPI_GENERIC_STATE      **StateList)
   {
       ACPI_GENERIC_STATE       *State;
   
   
       ACPI_FUNCTION_ENTRY ();
   
   
       /* Ignore null objects; these are expected */
   
       if (!Object)
       {
           return (AE_OK);
       }
   
       State = AcpiUtCreateUpdateState (Object, Action);
       if (!State)
       {
           return (AE_NO_MEMORY);
       }
   
       AcpiUtPushGenericState (StateList, State);
       return (AE_OK);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiUtWalkPackageTree
    *
    * PARAMETERS:  SourceObject        - The package to walk
    *              TargetObject        - Target object (if package is being copied)
    *              WalkCallback        - Called once for each package element
    *              Context             - Passed to the callback function
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Walk through a package, including subpackages
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiUtWalkPackageTree (
       ACPI_OPERAND_OBJECT     *SourceObject,
       void                    *TargetObject,
       ACPI_PKG_CALLBACK       WalkCallback,
       void                    *Context)
   {
       ACPI_STATUS             Status = AE_OK;
       ACPI_GENERIC_STATE      *StateList = NULL;
       ACPI_GENERIC_STATE      *State;
       ACPI_OPERAND_OBJECT     *ThisSourceObj;
       UINT32                  ThisIndex;
   
   
       ACPI_FUNCTION_TRACE (UtWalkPackageTree);
   
   
       State = AcpiUtCreatePkgState (SourceObject, TargetObject, 0);
       if (!State)
       {
           return_ACPI_STATUS (AE_NO_MEMORY);
       }
   
       while (State)
       {
           /* Get one element of the package */
   
           ThisIndex = State->Pkg.Index;
           ThisSourceObj =
               State->Pkg.SourceObject->Package.Elements[ThisIndex];
           State->Pkg.ThisTargetObj =
               &State->Pkg.SourceObject->Package.Elements[ThisIndex];
   
           /*
            * Check for:
            * 1) An uninitialized package element. It is completely
            *    legal to declare a package and leave it uninitialized
            * 2) Not an internal object - can be a namespace node instead
            * 3) Any type other than a package. Packages are handled in else
            *    case below.
            */
           if ((!ThisSourceObj) ||
               (ACPI_GET_DESCRIPTOR_TYPE (ThisSourceObj) !=
                   ACPI_DESC_TYPE_OPERAND) ||
               (ThisSourceObj->Common.Type != ACPI_TYPE_PACKAGE))
           {
               Status = WalkCallback (ACPI_COPY_TYPE_SIMPLE, ThisSourceObj,
                   State, Context);
               if (ACPI_FAILURE (Status))
               {
                   return_ACPI_STATUS (Status);
               }
   
               State->Pkg.Index++;
               while (State->Pkg.Index >=
                   State->Pkg.SourceObject->Package.Count)
               {
                   /*
                    * We've handled all of the objects at this level,  This means
                    * that we have just completed a package. That package may
                    * have contained one or more packages itself.
                    *
                    * Delete this state and pop the previous state (package).
                    */
                   AcpiUtDeleteGenericState (State);
                   State = AcpiUtPopGenericState (&StateList);
   
                   /* Finished when there are no more states */
   
                   if (!State)
                   {
                       /*
                        * We have handled all of the objects in the top level
                        * package just add the length of the package objects
                        * and exit
                        */
                       return_ACPI_STATUS (AE_OK);
                   }
   
                   /*
                    * Go back up a level and move the index past the just
                    * completed package object.
                    */
                   State->Pkg.Index++;
               }
           }
           else
           {
               /* This is a subobject of type package */
   
               Status = WalkCallback (
                   ACPI_COPY_TYPE_PACKAGE, ThisSourceObj, State, Context);
               if (ACPI_FAILURE (Status))
               {
                   return_ACPI_STATUS (Status);
               }
   
               /*
                * Push the current state and create a new one
                * The callback above returned a new target package object.
                */
               AcpiUtPushGenericState (&StateList, State);
               State = AcpiUtCreatePkgState (
                   ThisSourceObj, State->Pkg.ThisTargetObj, 0);
               if (!State)
               {
                   /* Free any stacked Update State objects */
   
                   while (StateList)
                   {
                       State = AcpiUtPopGenericState (&StateList);
                       AcpiUtDeleteGenericState (State);
                   }
                   return_ACPI_STATUS (AE_NO_MEMORY);
               }
           }
       }
   
       /* We should never get here */
   
       ACPI_ERROR ((AE_INFO,
           "State list did not terminate correctly"));
   
       return_ACPI_STATUS (AE_AML_INTERNAL);
   }
   
   
   #ifdef ACPI_DEBUG_OUTPUT
   /*******************************************************************************
    *
    * FUNCTION:    AcpiUtDisplayInitPathname
    *
    * PARAMETERS:  Type                - Object type of the node
    *              ObjHandle           - Handle whose pathname will be displayed
    *              Path                - Additional path string to be appended.
    *                                      (NULL if no extra path)
    *
    * RETURN:      ACPI_STATUS
    *
    * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
    *
    ******************************************************************************/
   
   void
   AcpiUtDisplayInitPathname (
       UINT8                   Type,
       ACPI_NAMESPACE_NODE     *ObjHandle,
       const char              *Path)
   {
       ACPI_STATUS             Status;
       ACPI_BUFFER             Buffer;
   
   
       ACPI_FUNCTION_ENTRY ();
   
   
       /* Only print the path if the appropriate debug level is enabled */
   
       if (!(AcpiDbgLevel & ACPI_LV_INIT_NAMES))
       {
           return;
       }
   
       /* Get the full pathname to the node */
   
       Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
       Status = AcpiNsHandleToPathname (ObjHandle, &Buffer, TRUE);
       if (ACPI_FAILURE (Status))
       {
           return;
       }
   
       /* Print what we're doing */
   
       switch (Type)
       {
       case ACPI_TYPE_METHOD:
   
           AcpiOsPrintf ("Executing    ");
           break;
   
       default:
   
           AcpiOsPrintf ("Initializing ");
           break;
       }
   
       /* Print the object type and pathname */
   
       AcpiOsPrintf ("%-12s  %s",
           AcpiUtGetTypeName (Type), (char *) Buffer.Pointer);
   
       /* Extra path is used to append names like _STA, _INI, etc. */
   
       if (Path)
       {
           AcpiOsPrintf (".%s", Path);
       }
       AcpiOsPrintf ("\n");
   
       ACPI_FREE (Buffer.Pointer);
   }
   #endif

Cache object: c574b0923ea18ef1cc1dfc57c5cc90b2