sys/contrib/dev/acpica/source/components/utilities/utxfinit.c

   1 /******************************************************************************
   2  *
   3  * Module Name: utxfinit - External interfaces for ACPICA initialization
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2016, Intel Corp.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #define EXPORT_ACPI_INTERFACES
  45
  46 #include "acpi.h"
  47 #include "accommon.h"
  48 #include "acevents.h"
  49 #include "acnamesp.h"
  50 #include "acdebug.h"
  51 #include "actables.h"
  52
  53 #define _COMPONENT          ACPI_UTILITIES
  54         ACPI_MODULE_NAME    ("utxfinit")
  55
  56 /* For AcpiExec only */
  57 void
  58 AeDoObjectOverrides (
  59     void);
  60
  61
  62 /*******************************************************************************
  63  *
  64  * FUNCTION:    AcpiInitializeSubsystem
  65  *
  66  * PARAMETERS:  None
  67  *
  68  * RETURN:      Status
  69  *
  70  * DESCRIPTION: Initializes all global variables. This is the first function
  71  *              called, so any early initialization belongs here.
  72  *
  73  ******************************************************************************/
  74
  75 ACPI_STATUS
  76 AcpiInitializeSubsystem (
  77     void)
  78 {
  79     ACPI_STATUS             Status;
  80
  81
  82     ACPI_FUNCTION_TRACE (AcpiInitializeSubsystem);
  83
  84
  85     AcpiGbl_StartupFlags = ACPI_SUBSYSTEM_INITIALIZE;
  86     ACPI_DEBUG_EXEC (AcpiUtInitStackPtrTrace ());
  87
  88     /* Initialize the OS-Dependent layer */
  89
  90     Status = AcpiOsInitialize ();
  91     if (ACPI_FAILURE (Status))
  92     {
  93         ACPI_EXCEPTION ((AE_INFO, Status, "During OSL initialization"));
  94         return_ACPI_STATUS (Status);
  95     }
  96
  97     /* Initialize all globals used by the subsystem */
  98
  99     Status = AcpiUtInitGlobals ();
 100     if (ACPI_FAILURE (Status))
 101     {
 102         ACPI_EXCEPTION ((AE_INFO, Status, "During initialization of globals"));
 103         return_ACPI_STATUS (Status);
 104     }
 105
 106     /* Create the default mutex objects */
 107
 108     Status = AcpiUtMutexInitialize ();
 109     if (ACPI_FAILURE (Status))
 110     {
 111         ACPI_EXCEPTION ((AE_INFO, Status, "During Global Mutex creation"));
 112         return_ACPI_STATUS (Status);
 113     }
 114
 115     /*
 116      * Initialize the namespace manager and
 117      * the root of the namespace tree
 118      */
 119     Status = AcpiNsRootInitialize ();
 120     if (ACPI_FAILURE (Status))
 121     {
 122         ACPI_EXCEPTION ((AE_INFO, Status, "During Namespace initialization"));
 123         return_ACPI_STATUS (Status);
 124     }
 125
 126     /* Initialize the global OSI interfaces list with the static names */
 127
 128     Status = AcpiUtInitializeInterfaces ();
 129     if (ACPI_FAILURE (Status))
 130     {
 131         ACPI_EXCEPTION ((AE_INFO, Status, "During OSI interfaces initialization"));
 132         return_ACPI_STATUS (Status);
 133     }
 134
 135     if (!AcpiGbl_OverrideDefaultRegionHandlers)
 136     {
 137         /*
 138          * Install the default operation region handlers. These are the
 139          * handlers that are defined by the ACPI specification to be
 140          * "always accessible" -- namely, SystemMemory, SystemIO, and
 141          * PCI_Config. This also means that no _REG methods need to be
 142          * run for these address spaces. We need to have these handlers
 143          * installed before any AML code can be executed, especially any
 144          * module-level code (11/2015).
 145          */
 146         Status = AcpiEvInstallRegionHandlers ();
 147         if (ACPI_FAILURE (Status))
 148         {
 149             ACPI_EXCEPTION ((AE_INFO, Status, "During Region initialization"));
 150             return_ACPI_STATUS (Status);
 151         }
 152     }
 153
 154     return_ACPI_STATUS (AE_OK);
 155 }
 156
 157 ACPI_EXPORT_SYMBOL_INIT (AcpiInitializeSubsystem)
 158
 159
 160 /*******************************************************************************
 161  *
 162  * FUNCTION:    AcpiEnableSubsystem
 163  *
 164  * PARAMETERS:  Flags               - Init/enable Options
 165  *
 166  * RETURN:      Status
 167  *
 168  * DESCRIPTION: Completes the subsystem initialization including hardware.
 169  *              Puts system into ACPI mode if it isn't already.
 170  *
 171  ******************************************************************************/
 172
 173 ACPI_STATUS
 174 AcpiEnableSubsystem (
 175     UINT32                  Flags)
 176 {
 177     ACPI_STATUS             Status = AE_OK;
 178
 179
 180     ACPI_FUNCTION_TRACE (AcpiEnableSubsystem);
 181
 182
 183     /*
 184      * The early initialization phase is complete. The namespace is loaded,
 185      * and we can now support address spaces other than Memory, I/O, and
 186      * PCI_Config.
 187      */
 188     AcpiGbl_EarlyInitialization = FALSE;
 189
 190     if (AcpiGbl_OverrideDefaultRegionHandlers)
 191     {
 192         /*
 193          * Install the default operation region handlers. These are the
 194          * handlers that are defined by the ACPI specification to be
 195          * "always accessible" -- namely, SystemMemory, SystemIO, and
 196          * PCI_Config. This also means that no _REG methods need to be
 197          * run for these address spaces. We need to have these handlers
 198          * installed before any AML code can be executed, especially any
 199          * module-level code (11/2015).
 200          */
 201         Status = AcpiEvInstallRegionHandlers ();
 202         if (ACPI_FAILURE (Status))
 203         {
 204             ACPI_EXCEPTION ((AE_INFO, Status, "During Region initialization"));
 205             return_ACPI_STATUS (Status);
 206         }
 207     }
 208
 209
 210 #if (!ACPI_REDUCED_HARDWARE)
 211
 212     /* Enable ACPI mode */
 213
 214     if (!(Flags & ACPI_NO_ACPI_ENABLE))
 215     {
 216         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Going into ACPI mode\n"));
 217
 218         AcpiGbl_OriginalMode = AcpiHwGetMode();
 219
 220         Status = AcpiEnable ();
 221         if (ACPI_FAILURE (Status))
 222         {
 223             ACPI_WARNING ((AE_INFO, "AcpiEnable failed"));
 224             return_ACPI_STATUS (Status);
 225         }
 226     }
 227
 228     /*
 229      * Obtain a permanent mapping for the FACS. This is required for the
 230      * Global Lock and the Firmware Waking Vector
 231      */
 232     if (!(Flags & ACPI_NO_FACS_INIT))
 233     {
 234         Status = AcpiTbInitializeFacs ();
 235         if (ACPI_FAILURE (Status))
 236         {
 237             ACPI_WARNING ((AE_INFO, "Could not map the FACS table"));
 238             return_ACPI_STATUS (Status);
 239         }
 240     }
 241
 242     /*
 243      * Initialize ACPI Event handling (Fixed and General Purpose)
 244      *
 245      * Note1: We must have the hardware and events initialized before we can
 246      * execute any control methods safely. Any control method can require
 247      * ACPI hardware support, so the hardware must be fully initialized before
 248      * any method execution!
 249      *
 250      * Note2: Fixed events are initialized and enabled here. GPEs are
 251      * initialized, but cannot be enabled until after the hardware is
 252      * completely initialized (SCI and GlobalLock activated) and the various
 253      * initialization control methods are run (_REG, _STA, _INI) on the
 254      * entire namespace.
 255      */
 256     if (!(Flags & ACPI_NO_EVENT_INIT))
 257     {
 258         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 259             "[Init] Initializing ACPI events\n"));
 260
 261         Status = AcpiEvInitializeEvents ();
 262         if (ACPI_FAILURE (Status))
 263         {
 264             return_ACPI_STATUS (Status);
 265         }
 266     }
 267
 268     /*
 269      * Install the SCI handler and Global Lock handler. This completes the
 270      * hardware initialization.
 271      */
 272     if (!(Flags & ACPI_NO_HANDLER_INIT))
 273     {
 274         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 275             "[Init] Installing SCI/GL handlers\n"));
 276
 277         Status = AcpiEvInstallXruptHandlers ();
 278         if (ACPI_FAILURE (Status))
 279         {
 280             return_ACPI_STATUS (Status);
 281         }
 282     }
 283
 284 #endif /* !ACPI_REDUCED_HARDWARE */
 285
 286     return_ACPI_STATUS (Status);
 287 }
 288
 289 ACPI_EXPORT_SYMBOL_INIT (AcpiEnableSubsystem)
 290
 291
 292 /*******************************************************************************
 293  *
 294  * FUNCTION:    AcpiInitializeObjects
 295  *
 296  * PARAMETERS:  Flags               - Init/enable Options
 297  *
 298  * RETURN:      Status
 299  *
 300  * DESCRIPTION: Completes namespace initialization by initializing device
 301  *              objects and executing AML code for Regions, buffers, etc.
 302  *
 303  ******************************************************************************/
 304
 305 ACPI_STATUS
 306 AcpiInitializeObjects (
 307     UINT32                  Flags)
 308 {
 309     ACPI_STATUS             Status = AE_OK;
 310
 311
 312     ACPI_FUNCTION_TRACE (AcpiInitializeObjects);
 313
 314
 315     /*
 316      * Run all _REG methods
 317      *
 318      * Note: Any objects accessed by the _REG methods will be automatically
 319      * initialized, even if they contain executable AML (see the call to
 320      * AcpiNsInitializeObjects below).
 321      */
 322     if (!(Flags & ACPI_NO_ADDRESS_SPACE_INIT))
 323     {
 324         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 325             "[Init] Executing _REG OpRegion methods\n"));
 326
 327         Status = AcpiEvInitializeOpRegions ();
 328         if (ACPI_FAILURE (Status))
 329         {
 330             return_ACPI_STATUS (Status);
 331         }
 332     }
 333
 334 #ifdef ACPI_EXEC_APP
 335     /*
 336      * This call implements the "initialization file" option for AcpiExec.
 337      * This is the precise point that we want to perform the overrides.
 338      */
 339     AeDoObjectOverrides ();
 340 #endif
 341
 342     /*
 343      * Execute any module-level code that was detected during the table load
 344      * phase. Although illegal since ACPI 2.0, there are many machines that
 345      * contain this type of code. Each block of detected executable AML code
 346      * outside of any control method is wrapped with a temporary control
 347      * method object and placed on a global list. The methods on this list
 348      * are executed below.
 349      *
 350      * This case executes the module-level code for all tables only after
 351      * all of the tables have been loaded. It is a legacy option and is
 352      * not compatible with other ACPI implementations. See AcpiNsLoadTable.
 353      */
 354     if (AcpiGbl_GroupModuleLevelCode)
 355     {
 356         AcpiNsExecModuleCodeList ();
 357     }
 358
 359     /*
 360      * Initialize the objects that remain uninitialized. This runs the
 361      * executable AML that may be part of the declaration of these objects:
 362      * OperationRegions, BufferFields, Buffers, and Packages.
 363      */
 364     if (!(Flags & ACPI_NO_OBJECT_INIT))
 365     {
 366         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 367             "[Init] Completing Initialization of ACPI Objects\n"));
 368
 369         Status = AcpiNsInitializeObjects ();
 370         if (ACPI_FAILURE (Status))
 371         {
 372             return_ACPI_STATUS (Status);
 373         }
 374     }
 375
 376     /*
 377      * Initialize all device objects in the namespace. This runs the device
 378      * _STA and _INI methods.
 379      */
 380     if (!(Flags & ACPI_NO_DEVICE_INIT))
 381     {
 382         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 383             "[Init] Initializing ACPI Devices\n"));
 384
 385         Status = AcpiNsInitializeDevices ();
 386         if (ACPI_FAILURE (Status))
 387         {
 388             return_ACPI_STATUS (Status);
 389         }
 390     }
 391
 392     /*
 393      * Empty the caches (delete the cached objects) on the assumption that
 394      * the table load filled them up more than they will be at runtime --
 395      * thus wasting non-paged memory.
 396      */
 397     Status = AcpiPurgeCachedObjects ();
 398
 399     AcpiGbl_StartupFlags |= ACPI_INITIALIZED_OK;
 400     return_ACPI_STATUS (Status);
 401 }
 402
 403 ACPI_EXPORT_SYMBOL_INIT (AcpiInitializeObjects)