sys/contrib/dev/acpica/utxface.c

   1 /******************************************************************************
   2  *
   3  * Module Name: utxface - External interfaces for "global" ACPI functions
   4  *              $Revision: 1.125 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117
 118 #define __UTXFACE_C__
 119
 120 #include <contrib/dev/acpica/acpi.h>
 121 #include <contrib/dev/acpica/acevents.h>
 122 #include <contrib/dev/acpica/acnamesp.h>
 123 #include <contrib/dev/acpica/acdebug.h>
 124
 125 #define _COMPONENT          ACPI_UTILITIES
 126         ACPI_MODULE_NAME    ("utxface")
 127
 128
 129 /*******************************************************************************
 130  *
 131  * FUNCTION:    AcpiInitializeSubsystem
 132  *
 133  * PARAMETERS:  None
 134  *
 135  * RETURN:      Status
 136  *
 137  * DESCRIPTION: Initializes all global variables.  This is the first function
 138  *              called, so any early initialization belongs here.
 139  *
 140  ******************************************************************************/
 141
 142 ACPI_STATUS
 143 AcpiInitializeSubsystem (
 144     void)
 145 {
 146     ACPI_STATUS             Status;
 147
 148
 149     ACPI_FUNCTION_TRACE (AcpiInitializeSubsystem);
 150
 151
 152     AcpiGbl_StartupFlags = ACPI_SUBSYSTEM_INITIALIZE;
 153     ACPI_DEBUG_EXEC (AcpiUtInitStackPtrTrace ());
 154
 155     /* Initialize the OS-Dependent layer */
 156
 157     Status = AcpiOsInitialize ();
 158     if (ACPI_FAILURE (Status))
 159     {
 160         ACPI_EXCEPTION ((AE_INFO, Status, "During OSL initialization"));
 161         return_ACPI_STATUS (Status);
 162     }
 163
 164     /* Initialize all globals used by the subsystem */
 165
 166     AcpiUtInitGlobals ();
 167
 168     /* Create the default mutex objects */
 169
 170     Status = AcpiUtMutexInitialize ();
 171     if (ACPI_FAILURE (Status))
 172     {
 173         ACPI_EXCEPTION ((AE_INFO, Status, "During Global Mutex creation"));
 174         return_ACPI_STATUS (Status);
 175     }
 176
 177     /*
 178      * Initialize the namespace manager and
 179      * the root of the namespace tree
 180      */
 181     Status = AcpiNsRootInitialize ();
 182     if (ACPI_FAILURE (Status))
 183     {
 184         ACPI_EXCEPTION ((AE_INFO, Status, "During Namespace initialization"));
 185         return_ACPI_STATUS (Status);
 186     }
 187
 188     /* If configured, initialize the AML debugger */
 189
 190     ACPI_DEBUGGER_EXEC (Status = AcpiDbInitialize ());
 191     return_ACPI_STATUS (Status);
 192 }
 193
 194 ACPI_EXPORT_SYMBOL (AcpiInitializeSubsystem)
 195
 196
 197 /*******************************************************************************
 198  *
 199  * FUNCTION:    AcpiEnableSubsystem
 200  *
 201  * PARAMETERS:  Flags           - Init/enable Options
 202  *
 203  * RETURN:      Status
 204  *
 205  * DESCRIPTION: Completes the subsystem initialization including hardware.
 206  *              Puts system into ACPI mode if it isn't already.
 207  *
 208  ******************************************************************************/
 209
 210 ACPI_STATUS
 211 AcpiEnableSubsystem (
 212     UINT32                  Flags)
 213 {
 214     ACPI_STATUS             Status = AE_OK;
 215
 216
 217     ACPI_FUNCTION_TRACE (AcpiEnableSubsystem);
 218
 219
 220     /* Enable ACPI mode */
 221
 222     if (!(Flags & ACPI_NO_ACPI_ENABLE))
 223     {
 224         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Going into ACPI mode\n"));
 225
 226         AcpiGbl_OriginalMode = AcpiHwGetMode();
 227
 228         Status = AcpiEnable ();
 229         if (ACPI_FAILURE (Status))
 230         {
 231             ACPI_WARNING ((AE_INFO, "AcpiEnable failed"));
 232             return_ACPI_STATUS (Status);
 233         }
 234     }
 235
 236     /*
 237      * Install the default OpRegion handlers.  These are installed unless
 238      * other handlers have already been installed via the
 239      * InstallAddressSpaceHandler interface.
 240      */
 241     if (!(Flags & ACPI_NO_ADDRESS_SPACE_INIT))
 242     {
 243         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 244             "[Init] Installing default address space handlers\n"));
 245
 246         Status = AcpiEvInstallRegionHandlers ();
 247         if (ACPI_FAILURE (Status))
 248         {
 249             return_ACPI_STATUS (Status);
 250         }
 251     }
 252
 253     /*
 254      * Initialize ACPI Event handling (Fixed and General Purpose)
 255      *
 256      * Note1: We must have the hardware and events initialized before we can
 257      * execute any control methods safely. Any control method can require
 258      * ACPI hardware support, so the hardware must be fully initialized before
 259      * any method execution!
 260      *
 261      * Note2: Fixed events are initialized and enabled here. GPEs are
 262      * initialized, but cannot be enabled until after the hardware is
 263      * completely initialized (SCI and GlobalLock activated)
 264      */
 265     if (!(Flags & ACPI_NO_EVENT_INIT))
 266     {
 267         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 268             "[Init] Initializing ACPI events\n"));
 269
 270         Status = AcpiEvInitializeEvents ();
 271         if (ACPI_FAILURE (Status))
 272         {
 273             return_ACPI_STATUS (Status);
 274         }
 275     }
 276
 277     /*
 278      * Install the SCI handler and Global Lock handler. This completes the
 279      * hardware initialization.
 280      */
 281     if (!(Flags & ACPI_NO_HANDLER_INIT))
 282     {
 283         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 284             "[Init] Installing SCI/GL handlers\n"));
 285
 286         Status = AcpiEvInstallXruptHandlers ();
 287         if (ACPI_FAILURE (Status))
 288         {
 289             return_ACPI_STATUS (Status);
 290         }
 291     }
 292
 293     /*
 294      * Complete the GPE initialization for the GPE blocks defined in the FADT
 295      * (GPE block 0 and 1).
 296      *
 297      * Note1: This is where the _PRW methods are executed for the GPEs. These
 298      * methods can only be executed after the SCI and Global Lock handlers are
 299      * installed and initialized.
 300      *
 301      * Note2: Currently, there seems to be no need to run the _REG methods
 302      * before execution of the _PRW methods and enabling of the GPEs.
 303      */
 304     if (!(Flags & ACPI_NO_EVENT_INIT))
 305     {
 306         Status = AcpiEvInstallFadtGpes ();
 307         if (ACPI_FAILURE (Status))
 308         {
 309             return (Status);
 310         }
 311     }
 312
 313     return_ACPI_STATUS (Status);
 314 }
 315
 316 ACPI_EXPORT_SYMBOL (AcpiEnableSubsystem)
 317
 318
 319 /*******************************************************************************
 320  *
 321  * FUNCTION:    AcpiInitializeObjects
 322  *
 323  * PARAMETERS:  Flags           - Init/enable Options
 324  *
 325  * RETURN:      Status
 326  *
 327  * DESCRIPTION: Completes namespace initialization by initializing device
 328  *              objects and executing AML code for Regions, buffers, etc.
 329  *
 330  ******************************************************************************/
 331
 332 ACPI_STATUS
 333 AcpiInitializeObjects (
 334     UINT32                  Flags)
 335 {
 336     ACPI_STATUS             Status = AE_OK;
 337
 338
 339     ACPI_FUNCTION_TRACE (AcpiInitializeObjects);
 340
 341
 342     /*
 343      * Run all _REG methods
 344      *
 345      * Note: Any objects accessed by the _REG methods will be automatically
 346      * initialized, even if they contain executable AML (see the call to
 347      * AcpiNsInitializeObjects below).
 348      */
 349     if (!(Flags & ACPI_NO_ADDRESS_SPACE_INIT))
 350     {
 351         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 352             "[Init] Executing _REG OpRegion methods\n"));
 353
 354         Status = AcpiEvInitializeOpRegions ();
 355         if (ACPI_FAILURE (Status))
 356         {
 357             return_ACPI_STATUS (Status);
 358         }
 359     }
 360
 361     /*
 362      * Initialize the objects that remain uninitialized. This runs the
 363      * executable AML that may be part of the declaration of these objects:
 364      * OperationRegions, BufferFields, Buffers, and Packages.
 365      */
 366     if (!(Flags & ACPI_NO_OBJECT_INIT))
 367     {
 368         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 369             "[Init] Completing Initialization of ACPI Objects\n"));
 370
 371         Status = AcpiNsInitializeObjects ();
 372         if (ACPI_FAILURE (Status))
 373         {
 374             return_ACPI_STATUS (Status);
 375         }
 376     }
 377
 378     /*
 379      * Initialize all device objects in the namespace. This runs the device
 380      * _STA and _INI methods.
 381      */
 382     if (!(Flags & ACPI_NO_DEVICE_INIT))
 383     {
 384         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 385             "[Init] Initializing ACPI Devices\n"));
 386
 387         Status = AcpiNsInitializeDevices ();
 388         if (ACPI_FAILURE (Status))
 389         {
 390             return_ACPI_STATUS (Status);
 391         }
 392     }
 393
 394     /*
 395      * Empty the caches (delete the cached objects) on the assumption that
 396      * the table load filled them up more than they will be at runtime --
 397      * thus wasting non-paged memory.
 398      */
 399     Status = AcpiPurgeCachedObjects ();
 400
 401     AcpiGbl_StartupFlags |= ACPI_INITIALIZED_OK;
 402     return_ACPI_STATUS (Status);
 403 }
 404
 405 ACPI_EXPORT_SYMBOL (AcpiInitializeObjects)
 406
 407
 408 /*******************************************************************************
 409  *
 410  * FUNCTION:    AcpiTerminate
 411  *
 412  * PARAMETERS:  None
 413  *
 414  * RETURN:      Status
 415  *
 416  * DESCRIPTION: Shutdown the ACPI subsystem.  Release all resources.
 417  *
 418  ******************************************************************************/
 419
 420 ACPI_STATUS
 421 AcpiTerminate (
 422     void)
 423 {
 424     ACPI_STATUS         Status;
 425
 426
 427     ACPI_FUNCTION_TRACE (AcpiTerminate);
 428
 429
 430     /* Terminate the AML Debugger if present */
 431
 432     ACPI_DEBUGGER_EXEC(AcpiGbl_DbTerminateThreads = TRUE);
 433
 434     /* Shutdown and free all resources */
 435
 436     AcpiUtSubsystemShutdown ();
 437
 438
 439     /* Free the mutex objects */
 440
 441     AcpiUtMutexTerminate ();
 442
 443
 444 #ifdef ACPI_DEBUGGER
 445
 446     /* Shut down the debugger */
 447
 448     AcpiDbTerminate ();
 449 #endif
 450
 451     /* Now we can shutdown the OS-dependent layer */
 452
 453     Status = AcpiOsTerminate ();
 454     return_ACPI_STATUS (Status);
 455 }
 456
 457 ACPI_EXPORT_SYMBOL (AcpiTerminate)
 458
 459
 460 /*******************************************************************************
 461  *
 462  * FUNCTION:    AcpiSubsystemStatus
 463  *
 464  * PARAMETERS:  None
 465  *
 466  * RETURN:      Status of the ACPI subsystem
 467  *
 468  * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
 469  *              before making any other calls, to ensure the subsystem
 470  *              initialized successfully.
 471  *
 472  ******************************************************************************/
 473
 474 ACPI_STATUS
 475 AcpiSubsystemStatus (
 476     void)
 477 {
 478
 479     if (AcpiGbl_StartupFlags & ACPI_INITIALIZED_OK)
 480     {
 481         return (AE_OK);
 482     }
 483     else
 484     {
 485         return (AE_ERROR);
 486     }
 487 }
 488
 489 ACPI_EXPORT_SYMBOL (AcpiSubsystemStatus)
 490
 491
 492 /*******************************************************************************
 493  *
 494  * FUNCTION:    AcpiGetSystemInfo
 495  *
 496  * PARAMETERS:  OutBuffer       - A buffer to receive the resources for the
 497  *                                device
 498  *
 499  * RETURN:      Status          - the status of the call
 500  *
 501  * DESCRIPTION: This function is called to get information about the current
 502  *              state of the ACPI subsystem.  It will return system information
 503  *              in the OutBuffer.
 504  *
 505  *              If the function fails an appropriate status will be returned
 506  *              and the value of OutBuffer is undefined.
 507  *
 508  ******************************************************************************/
 509
 510 ACPI_STATUS
 511 AcpiGetSystemInfo (
 512     ACPI_BUFFER             *OutBuffer)
 513 {
 514     ACPI_SYSTEM_INFO        *InfoPtr;
 515     ACPI_STATUS             Status;
 516
 517
 518     ACPI_FUNCTION_TRACE (AcpiGetSystemInfo);
 519
 520
 521     /* Parameter validation */
 522
 523     Status = AcpiUtValidateBuffer (OutBuffer);
 524     if (ACPI_FAILURE (Status))
 525     {
 526         return_ACPI_STATUS (Status);
 527     }
 528
 529     /* Validate/Allocate/Clear caller buffer */
 530
 531     Status = AcpiUtInitializeBuffer (OutBuffer, sizeof (ACPI_SYSTEM_INFO));
 532     if (ACPI_FAILURE (Status))
 533     {
 534         return_ACPI_STATUS (Status);
 535     }
 536
 537     /*
 538      * Populate the return buffer
 539      */
 540     InfoPtr = (ACPI_SYSTEM_INFO *) OutBuffer->Pointer;
 541
 542     InfoPtr->AcpiCaVersion = ACPI_CA_VERSION;
 543
 544     /* System flags (ACPI capabilities) */
 545
 546     InfoPtr->Flags = ACPI_SYS_MODE_ACPI;
 547
 548     /* Timer resolution - 24 or 32 bits  */
 549
 550     if (AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER)
 551     {
 552         InfoPtr->TimerResolution = 24;
 553     }
 554     else
 555     {
 556         InfoPtr->TimerResolution = 32;
 557     }
 558
 559     /* Clear the reserved fields */
 560
 561     InfoPtr->Reserved1 = 0;
 562     InfoPtr->Reserved2 = 0;
 563
 564     /* Current debug levels */
 565
 566     InfoPtr->DebugLayer = AcpiDbgLayer;
 567     InfoPtr->DebugLevel = AcpiDbgLevel;
 568
 569     return_ACPI_STATUS (AE_OK);
 570 }
 571
 572 ACPI_EXPORT_SYMBOL (AcpiGetSystemInfo)
 573
 574
 575 /*****************************************************************************
 576  *
 577  * FUNCTION:    AcpiInstallInitializationHandler
 578  *
 579  * PARAMETERS:  Handler             - Callback procedure
 580  *              Function            - Not (currently) used, see below
 581  *
 582  * RETURN:      Status
 583  *
 584  * DESCRIPTION: Install an initialization handler
 585  *
 586  * TBD: When a second function is added, must save the Function also.
 587  *
 588  ****************************************************************************/
 589
 590 ACPI_STATUS
 591 AcpiInstallInitializationHandler (
 592     ACPI_INIT_HANDLER       Handler,
 593     UINT32                  Function)
 594 {
 595
 596     if (!Handler)
 597     {
 598         return (AE_BAD_PARAMETER);
 599     }
 600
 601     if (AcpiGbl_InitHandler)
 602     {
 603         return (AE_ALREADY_EXISTS);
 604     }
 605
 606     AcpiGbl_InitHandler = Handler;
 607     return AE_OK;
 608 }
 609
 610 ACPI_EXPORT_SYMBOL (AcpiInstallInitializationHandler)
 611
 612
 613 /*****************************************************************************
 614  *
 615  * FUNCTION:    AcpiPurgeCachedObjects
 616  *
 617  * PARAMETERS:  None
 618  *
 619  * RETURN:      Status
 620  *
 621  * DESCRIPTION: Empty all caches (delete the cached objects)
 622  *
 623  ****************************************************************************/
 624
 625 ACPI_STATUS
 626 AcpiPurgeCachedObjects (
 627     void)
 628 {
 629     ACPI_FUNCTION_TRACE (AcpiPurgeCachedObjects);
 630
 631     (void) AcpiOsPurgeCache (AcpiGbl_StateCache);
 632     (void) AcpiOsPurgeCache (AcpiGbl_OperandCache);
 633     (void) AcpiOsPurgeCache (AcpiGbl_PsNodeCache);
 634     (void) AcpiOsPurgeCache (AcpiGbl_PsNodeExtCache);
 635     return_ACPI_STATUS (AE_OK);
 636 }
 637
 638 ACPI_EXPORT_SYMBOL (AcpiPurgeCachedObjects)