drivers/acpi/components/utilities/utmisc.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: utmisc - common utility procedures
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #include "acpi.h"
 117 #include "accommon.h"
 118 #include "acnamesp.h"
 119
 120
 121 #define _COMPONENT          ACPI_UTILITIES
 122         ACPI_MODULE_NAME    ("utmisc")
 123
 124
 125 /*******************************************************************************
 126  *
 127  * FUNCTION:    AcpiUtIsPciRootBridge
 128  *
 129  * PARAMETERS:  Id              - The HID/CID in string format
 130  *
 131  * RETURN:      TRUE if the Id is a match for a PCI/PCI-Express Root Bridge
 132  *
 133  * DESCRIPTION: Determine if the input ID is a PCI Root Bridge ID.
 134  *
 135  ******************************************************************************/
 136
 137 BOOLEAN
 138 AcpiUtIsPciRootBridge (
 139     char                    *Id)
 140 {
 141
 142     /*
 143      * Check if this is a PCI root bridge.
 144      * ACPI 3.0+: check for a PCI Express root also.
 145      */
 146     if (!(ACPI_STRCMP (Id,
 147             PCI_ROOT_HID_STRING)) ||
 148
 149         !(ACPI_STRCMP (Id,
 150             PCI_EXPRESS_ROOT_HID_STRING)))
 151     {
 152         return (TRUE);
 153     }
 154
 155     return (FALSE);
 156 }
 157
 158
 159 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP)
 160 /*******************************************************************************
 161  *
 162  * FUNCTION:    AcpiUtIsAmlTable
 163  *
 164  * PARAMETERS:  Table               - An ACPI table
 165  *
 166  * RETURN:      TRUE if table contains executable AML; FALSE otherwise
 167  *
 168  * DESCRIPTION: Check ACPI Signature for a table that contains AML code.
 169  *              Currently, these are DSDT,SSDT,PSDT. All other table types are
 170  *              data tables that do not contain AML code.
 171  *
 172  ******************************************************************************/
 173
 174 BOOLEAN
 175 AcpiUtIsAmlTable (
 176     ACPI_TABLE_HEADER       *Table)
 177 {
 178
 179     /* These are the only tables that contain executable AML */
 180
 181     if (ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_DSDT) ||
 182         ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_PSDT) ||
 183         ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_SSDT))
 184     {
 185         return (TRUE);
 186     }
 187
 188     return (FALSE);
 189 }
 190 #endif
 191
 192
 193 /*******************************************************************************
 194  *
 195  * FUNCTION:    AcpiUtDwordByteSwap
 196  *
 197  * PARAMETERS:  Value           - Value to be converted
 198  *
 199  * RETURN:      UINT32 integer with bytes swapped
 200  *
 201  * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
 202  *
 203  ******************************************************************************/
 204
 205 UINT32
 206 AcpiUtDwordByteSwap (
 207     UINT32                  Value)
 208 {
 209     union
 210     {
 211         UINT32              Value;
 212         UINT8               Bytes[4];
 213     } Out;
 214     union
 215     {
 216         UINT32              Value;
 217         UINT8               Bytes[4];
 218     } In;
 219
 220
 221     ACPI_FUNCTION_ENTRY ();
 222
 223
 224     In.Value = Value;
 225
 226     Out.Bytes[0] = In.Bytes[3];
 227     Out.Bytes[1] = In.Bytes[2];
 228     Out.Bytes[2] = In.Bytes[1];
 229     Out.Bytes[3] = In.Bytes[0];
 230
 231     return (Out.Value);
 232 }
 233
 234
 235 /*******************************************************************************
 236  *
 237  * FUNCTION:    AcpiUtSetIntegerWidth
 238  *
 239  * PARAMETERS:  Revision            From DSDT header
 240  *
 241  * RETURN:      None
 242  *
 243  * DESCRIPTION: Set the global integer bit width based upon the revision
 244  *              of the DSDT. For Revision 1 and 0, Integers are 32 bits.
 245  *              For Revision 2 and above, Integers are 64 bits. Yes, this
 246  *              makes a difference.
 247  *
 248  ******************************************************************************/
 249
 250 void
 251 AcpiUtSetIntegerWidth (
 252     UINT8                   Revision)
 253 {
 254
 255     if (Revision < 2)
 256     {
 257         /* 32-bit case */
 258
 259         AcpiGbl_IntegerBitWidth    = 32;
 260         AcpiGbl_IntegerNybbleWidth = 8;
 261         AcpiGbl_IntegerByteWidth   = 4;
 262     }
 263     else
 264     {
 265         /* 64-bit case (ACPI 2.0+) */
 266
 267         AcpiGbl_IntegerBitWidth    = 64;
 268         AcpiGbl_IntegerNybbleWidth = 16;
 269         AcpiGbl_IntegerByteWidth   = 8;
 270     }
 271 }
 272
 273
 274 /*******************************************************************************
 275  *
 276  * FUNCTION:    AcpiUtCreateUpdateStateAndPush
 277  *
 278  * PARAMETERS:  Object          - Object to be added to the new state
 279  *              Action          - Increment/Decrement
 280  *              StateList       - List the state will be added to
 281  *
 282  * RETURN:      Status
 283  *
 284  * DESCRIPTION: Create a new state and push it
 285  *
 286  ******************************************************************************/
 287
 288 ACPI_STATUS
 289 AcpiUtCreateUpdateStateAndPush (
 290     ACPI_OPERAND_OBJECT     *Object,
 291     UINT16                  Action,
 292     ACPI_GENERIC_STATE      **StateList)
 293 {
 294     ACPI_GENERIC_STATE       *State;
 295
 296
 297     ACPI_FUNCTION_ENTRY ();
 298
 299
 300     /* Ignore null objects; these are expected */
 301
 302     if (!Object)
 303     {
 304         return (AE_OK);
 305     }
 306
 307     State = AcpiUtCreateUpdateState (Object, Action);
 308     if (!State)
 309     {
 310         return (AE_NO_MEMORY);
 311     }
 312
 313     AcpiUtPushGenericState (StateList, State);
 314     return (AE_OK);
 315 }
 316
 317
 318 /*******************************************************************************
 319  *
 320  * FUNCTION:    AcpiUtWalkPackageTree
 321  *
 322  * PARAMETERS:  SourceObject        - The package to walk
 323  *              TargetObject        - Target object (if package is being copied)
 324  *              WalkCallback        - Called once for each package element
 325  *              Context             - Passed to the callback function
 326  *
 327  * RETURN:      Status
 328  *
 329  * DESCRIPTION: Walk through a package
 330  *
 331  ******************************************************************************/
 332
 333 ACPI_STATUS
 334 AcpiUtWalkPackageTree (
 335     ACPI_OPERAND_OBJECT     *SourceObject,
 336     void                    *TargetObject,
 337     ACPI_PKG_CALLBACK       WalkCallback,
 338     void                    *Context)
 339 {
 340     ACPI_STATUS             Status = AE_OK;
 341     ACPI_GENERIC_STATE      *StateList = NULL;
 342     ACPI_GENERIC_STATE      *State;
 343     UINT32                  ThisIndex;
 344     ACPI_OPERAND_OBJECT     *ThisSourceObj;
 345
 346
 347     ACPI_FUNCTION_TRACE (UtWalkPackageTree);
 348
 349
 350     State = AcpiUtCreatePkgState (SourceObject, TargetObject, 0);
 351     if (!State)
 352     {
 353         return_ACPI_STATUS (AE_NO_MEMORY);
 354     }
 355
 356     while (State)
 357     {
 358         /* Get one element of the package */
 359
 360         ThisIndex     = State->Pkg.Index;
 361         ThisSourceObj = (ACPI_OPERAND_OBJECT *)
 362                         State->Pkg.SourceObject->Package.Elements[ThisIndex];
 363
 364         /*
 365          * Check for:
 366          * 1) An uninitialized package element. It is completely
 367          *    legal to declare a package and leave it uninitialized
 368          * 2) Not an internal object - can be a namespace node instead
 369          * 3) Any type other than a package. Packages are handled in else
 370          *    case below.
 371          */
 372         if ((!ThisSourceObj) ||
 373             (ACPI_GET_DESCRIPTOR_TYPE (ThisSourceObj) != ACPI_DESC_TYPE_OPERAND) ||
 374             (ThisSourceObj->Common.Type != ACPI_TYPE_PACKAGE))
 375         {
 376             Status = WalkCallback (ACPI_COPY_TYPE_SIMPLE, ThisSourceObj,
 377                                     State, Context);
 378             if (ACPI_FAILURE (Status))
 379             {
 380                 return_ACPI_STATUS (Status);
 381             }
 382
 383             State->Pkg.Index++;
 384             while (State->Pkg.Index >= State->Pkg.SourceObject->Package.Count)
 385             {
 386                 /*
 387                  * We've handled all of the objects at this level,  This means
 388                  * that we have just completed a package. That package may
 389                  * have contained one or more packages itself.
 390                  *
 391                  * Delete this state and pop the previous state (package).
 392                  */
 393                 AcpiUtDeleteGenericState (State);
 394                 State = AcpiUtPopGenericState (&StateList);
 395
 396                 /* Finished when there are no more states */
 397
 398                 if (!State)
 399                 {
 400                     /*
 401                      * We have handled all of the objects in the top level
 402                      * package just add the length of the package objects
 403                      * and exit
 404                      */
 405                     return_ACPI_STATUS (AE_OK);
 406                 }
 407
 408                 /*
 409                  * Go back up a level and move the index past the just
 410                  * completed package object.
 411                  */
 412                 State->Pkg.Index++;
 413             }
 414         }
 415         else
 416         {
 417             /* This is a subobject of type package */
 418
 419             Status = WalkCallback (ACPI_COPY_TYPE_PACKAGE, ThisSourceObj,
 420                                         State, Context);
 421             if (ACPI_FAILURE (Status))
 422             {
 423                 return_ACPI_STATUS (Status);
 424             }
 425
 426             /*
 427              * Push the current state and create a new one
 428              * The callback above returned a new target package object.
 429              */
 430             AcpiUtPushGenericState (&StateList, State);
 431             State = AcpiUtCreatePkgState (ThisSourceObj,
 432                                             State->Pkg.ThisTargetObj, 0);
 433             if (!State)
 434             {
 435                 /* Free any stacked Update State objects */
 436
 437                 while (StateList)
 438                 {
 439                     State = AcpiUtPopGenericState (&StateList);
 440                     AcpiUtDeleteGenericState (State);
 441                 }
 442                 return_ACPI_STATUS (AE_NO_MEMORY);
 443             }
 444         }
 445     }
 446
 447     /* We should never get here */
 448
 449     return_ACPI_STATUS (AE_AML_INTERNAL);
 450 }
 451
 452
 453 #ifdef ACPI_DEBUG_OUTPUT
 454 /*******************************************************************************
 455  *
 456  * FUNCTION:    AcpiUtDisplayInitPathname
 457  *
 458  * PARAMETERS:  Type                - Object type of the node
 459  *              ObjHandle           - Handle whose pathname will be displayed
 460  *              Path                - Additional path string to be appended.
 461  *                                      (NULL if no extra path)
 462  *
 463  * RETURN:      ACPI_STATUS
 464  *
 465  * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
 466  *
 467  ******************************************************************************/
 468
 469 void
 470 AcpiUtDisplayInitPathname (
 471     UINT8                   Type,
 472     ACPI_NAMESPACE_NODE     *ObjHandle,
 473     char                    *Path)
 474 {
 475     ACPI_STATUS             Status;
 476     ACPI_BUFFER             Buffer;
 477
 478
 479     ACPI_FUNCTION_ENTRY ();
 480
 481
 482     /* Only print the path if the appropriate debug level is enabled */
 483
 484     if (!(AcpiDbgLevel & ACPI_LV_INIT_NAMES))
 485     {
 486         return;
 487     }
 488
 489     /* Get the full pathname to the node */
 490
 491     Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
 492     Status = AcpiNsHandleToPathname (ObjHandle, &Buffer);
 493     if (ACPI_FAILURE (Status))
 494     {
 495         return;
 496     }
 497
 498     /* Print what we're doing */
 499
 500     switch (Type)
 501     {
 502     case ACPI_TYPE_METHOD:
 503
 504         AcpiOsPrintf ("Executing    ");
 505         break;
 506
 507     default:
 508
 509         AcpiOsPrintf ("Initializing ");
 510         break;
 511     }
 512
 513     /* Print the object type and pathname */
 514
 515     AcpiOsPrintf ("%-12s  %s",
 516         AcpiUtGetTypeName (Type), (char *) Buffer.Pointer);
 517
 518     /* Extra path is used to append names like _STA, _INI, etc. */
 519
 520     if (Path)
 521     {
 522         AcpiOsPrintf (".%s", Path);
 523     }
 524     AcpiOsPrintf ("\n");
 525
 526     ACPI_FREE (Buffer.Pointer);
 527 }
 528 #endif