drivers/acpi/utilities/utxface.c

   1 /******************************************************************************
   2  *
   3  * Module Name: utxface - External interfaces for "global" ACPI functions
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2008, 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 #include <acpi/acpi.h>
  45 #include <acpi/acevents.h>
  46 #include <acpi/acnamesp.h>
  47 #include <acpi/acdebug.h>
  48 #include <acpi/actables.h>
  49
  50 #define _COMPONENT          ACPI_UTILITIES
  51 ACPI_MODULE_NAME("utxface")
  52
  53 #ifndef ACPI_ASL_COMPILER
  54 /*******************************************************************************
  55  *
  56  * FUNCTION:    acpi_initialize_subsystem
  57  *
  58  * PARAMETERS:  None
  59  *
  60  * RETURN:      Status
  61  *
  62  * DESCRIPTION: Initializes all global variables.  This is the first function
  63  *              called, so any early initialization belongs here.
  64  *
  65  ******************************************************************************/
  66 acpi_status __init acpi_initialize_subsystem(void)
  67 {
  68         acpi_status status;
  69
  70         ACPI_FUNCTION_TRACE(acpi_initialize_subsystem);
  71
  72         acpi_gbl_startup_flags = ACPI_SUBSYSTEM_INITIALIZE;
  73         ACPI_DEBUG_EXEC(acpi_ut_init_stack_ptr_trace());
  74
  75         /* Initialize the OS-Dependent layer */
  76
  77         status = acpi_os_initialize();
  78         if (ACPI_FAILURE(status)) {
  79                 ACPI_EXCEPTION((AE_INFO, status, "During OSL initialization"));
  80                 return_ACPI_STATUS(status);
  81         }
  82
  83         /* Initialize all globals used by the subsystem */
  84
  85         status = acpi_ut_init_globals();
  86         if (ACPI_FAILURE(status)) {
  87                 ACPI_EXCEPTION((AE_INFO, status,
  88                                 "During initialization of globals"));
  89                 return_ACPI_STATUS(status);
  90         }
  91
  92         /* Create the default mutex objects */
  93
  94         status = acpi_ut_mutex_initialize();
  95         if (ACPI_FAILURE(status)) {
  96                 ACPI_EXCEPTION((AE_INFO, status,
  97                                 "During Global Mutex creation"));
  98                 return_ACPI_STATUS(status);
  99         }
 100
 101         /*
 102          * Initialize the namespace manager and
 103          * the root of the namespace tree
 104          */
 105         status = acpi_ns_root_initialize();
 106         if (ACPI_FAILURE(status)) {
 107                 ACPI_EXCEPTION((AE_INFO, status,
 108                                 "During Namespace initialization"));
 109                 return_ACPI_STATUS(status);
 110         }
 111
 112         /* If configured, initialize the AML debugger */
 113
 114         ACPI_DEBUGGER_EXEC(status = acpi_db_initialize());
 115         return_ACPI_STATUS(status);
 116 }
 117
 118 /*******************************************************************************
 119  *
 120  * FUNCTION:    acpi_enable_subsystem
 121  *
 122  * PARAMETERS:  Flags           - Init/enable Options
 123  *
 124  * RETURN:      Status
 125  *
 126  * DESCRIPTION: Completes the subsystem initialization including hardware.
 127  *              Puts system into ACPI mode if it isn't already.
 128  *
 129  ******************************************************************************/
 130 acpi_status acpi_enable_subsystem(u32 flags)
 131 {
 132         acpi_status status = AE_OK;
 133
 134         ACPI_FUNCTION_TRACE(acpi_enable_subsystem);
 135
 136         /* Enable ACPI mode */
 137
 138         if (!(flags & ACPI_NO_ACPI_ENABLE)) {
 139                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 140                                   "[Init] Going into ACPI mode\n"));
 141
 142                 acpi_gbl_original_mode = acpi_hw_get_mode();
 143
 144                 status = acpi_enable();
 145                 if (ACPI_FAILURE(status)) {
 146                         ACPI_WARNING((AE_INFO, "AcpiEnable failed"));
 147                         return_ACPI_STATUS(status);
 148                 }
 149         }
 150
 151         /*
 152          * Obtain a permanent mapping for the FACS. This is required for the
 153          * Global Lock and the Firmware Waking Vector
 154          */
 155         status = acpi_tb_initialize_facs();
 156         if (ACPI_FAILURE(status)) {
 157                 ACPI_WARNING((AE_INFO, "Could not map the FACS table"));
 158                 return_ACPI_STATUS(status);
 159         }
 160
 161         /*
 162          * Install the default op_region handlers. These are installed unless
 163          * other handlers have already been installed via the
 164          * install_address_space_handler interface.
 165          */
 166         if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
 167                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 168                                   "[Init] Installing default address space handlers\n"));
 169
 170                 status = acpi_ev_install_region_handlers();
 171                 if (ACPI_FAILURE(status)) {
 172                         return_ACPI_STATUS(status);
 173                 }
 174         }
 175
 176         /*
 177          * Initialize ACPI Event handling (Fixed and General Purpose)
 178          *
 179          * Note1: We must have the hardware and events initialized before we can
 180          * execute any control methods safely. Any control method can require
 181          * ACPI hardware support, so the hardware must be fully initialized before
 182          * any method execution!
 183          *
 184          * Note2: Fixed events are initialized and enabled here. GPEs are
 185          * initialized, but cannot be enabled until after the hardware is
 186          * completely initialized (SCI and global_lock activated)
 187          */
 188         if (!(flags & ACPI_NO_EVENT_INIT)) {
 189                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 190                                   "[Init] Initializing ACPI events\n"));
 191
 192                 status = acpi_ev_initialize_events();
 193                 if (ACPI_FAILURE(status)) {
 194                         return_ACPI_STATUS(status);
 195                 }
 196         }
 197
 198         /*
 199          * Install the SCI handler and Global Lock handler. This completes the
 200          * hardware initialization.
 201          */
 202         if (!(flags & ACPI_NO_HANDLER_INIT)) {
 203                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 204                                   "[Init] Installing SCI/GL handlers\n"));
 205
 206                 status = acpi_ev_install_xrupt_handlers();
 207                 if (ACPI_FAILURE(status)) {
 208                         return_ACPI_STATUS(status);
 209                 }
 210         }
 211
 212         return_ACPI_STATUS(status);
 213 }
 214
 215 ACPI_EXPORT_SYMBOL(acpi_enable_subsystem)
 216
 217 /*******************************************************************************
 218  *
 219  * FUNCTION:    acpi_initialize_objects
 220  *
 221  * PARAMETERS:  Flags           - Init/enable Options
 222  *
 223  * RETURN:      Status
 224  *
 225  * DESCRIPTION: Completes namespace initialization by initializing device
 226  *              objects and executing AML code for Regions, buffers, etc.
 227  *
 228  ******************************************************************************/
 229 acpi_status acpi_initialize_objects(u32 flags)
 230 {
 231         acpi_status status = AE_OK;
 232
 233         ACPI_FUNCTION_TRACE(acpi_initialize_objects);
 234
 235         /*
 236          * Run all _REG methods
 237          *
 238          * Note: Any objects accessed by the _REG methods will be automatically
 239          * initialized, even if they contain executable AML (see the call to
 240          * acpi_ns_initialize_objects below).
 241          */
 242         if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
 243                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 244                                   "[Init] Executing _REG OpRegion methods\n"));
 245
 246                 status = acpi_ev_initialize_op_regions();
 247                 if (ACPI_FAILURE(status)) {
 248                         return_ACPI_STATUS(status);
 249                 }
 250         }
 251
 252         /*
 253          * Initialize the objects that remain uninitialized. This runs the
 254          * executable AML that may be part of the declaration of these objects:
 255          * operation_regions, buffer_fields, Buffers, and Packages.
 256          */
 257         if (!(flags & ACPI_NO_OBJECT_INIT)) {
 258                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 259                                   "[Init] Completing Initialization of ACPI Objects\n"));
 260
 261                 status = acpi_ns_initialize_objects();
 262                 if (ACPI_FAILURE(status)) {
 263                         return_ACPI_STATUS(status);
 264                 }
 265         }
 266
 267         /*
 268          * Initialize all device objects in the namespace. This runs the device
 269          * _STA and _INI methods.
 270          */
 271         if (!(flags & ACPI_NO_DEVICE_INIT)) {
 272                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 273                                   "[Init] Initializing ACPI Devices\n"));
 274
 275                 status = acpi_ns_initialize_devices();
 276                 if (ACPI_FAILURE(status)) {
 277                         return_ACPI_STATUS(status);
 278                 }
 279         }
 280
 281         /*
 282          * Complete the GPE initialization for the GPE blocks defined in the FADT
 283          * (GPE block 0 and 1).
 284          *
 285          * Note1: This is where the _PRW methods are executed for the GPEs. These
 286          * methods can only be executed after the SCI and Global Lock handlers are
 287          * installed and initialized.
 288          *
 289          * Note2: Currently, there seems to be no need to run the _REG methods
 290          * before execution of the _PRW methods and enabling of the GPEs.
 291          */
 292         if (!(flags & ACPI_NO_EVENT_INIT)) {
 293                 status = acpi_ev_install_fadt_gpes();
 294                 if (ACPI_FAILURE(status))
 295                         return (status);
 296         }
 297
 298         /*
 299          * Empty the caches (delete the cached objects) on the assumption that
 300          * the table load filled them up more than they will be at runtime --
 301          * thus wasting non-paged memory.
 302          */
 303         status = acpi_purge_cached_objects();
 304
 305         acpi_gbl_startup_flags |= ACPI_INITIALIZED_OK;
 306         return_ACPI_STATUS(status);
 307 }
 308
 309 ACPI_EXPORT_SYMBOL(acpi_initialize_objects)
 310
 311 #endif
 312 /*******************************************************************************
 313  *
 314  * FUNCTION:    acpi_terminate
 315  *
 316  * PARAMETERS:  None
 317  *
 318  * RETURN:      Status
 319  *
 320  * DESCRIPTION: Shutdown the ACPI subsystem.  Release all resources.
 321  *
 322  ******************************************************************************/
 323 acpi_status acpi_terminate(void)
 324 {
 325         acpi_status status;
 326
 327         ACPI_FUNCTION_TRACE(acpi_terminate);
 328
 329         /* Terminate the AML Debugger if present */
 330
 331         ACPI_DEBUGGER_EXEC(acpi_gbl_db_terminate_threads = TRUE);
 332
 333         /* Shutdown and free all resources */
 334
 335         acpi_ut_subsystem_shutdown();
 336
 337         /* Free the mutex objects */
 338
 339         acpi_ut_mutex_terminate();
 340
 341 #ifdef ACPI_DEBUGGER
 342
 343         /* Shut down the debugger */
 344
 345         acpi_db_terminate();
 346 #endif
 347
 348         /* Now we can shutdown the OS-dependent layer */
 349
 350         status = acpi_os_terminate();
 351         return_ACPI_STATUS(status);
 352 }
 353
 354 ACPI_EXPORT_SYMBOL(acpi_terminate)
 355 #ifndef ACPI_ASL_COMPILER
 356 #ifdef ACPI_FUTURE_USAGE
 357 /*******************************************************************************
 358  *
 359  * FUNCTION:    acpi_subsystem_status
 360  *
 361  * PARAMETERS:  None
 362  *
 363  * RETURN:      Status of the ACPI subsystem
 364  *
 365  * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
 366  *              before making any other calls, to ensure the subsystem
 367  *              initialized successfully.
 368  *
 369  ******************************************************************************/
 370 acpi_status acpi_subsystem_status(void)
 371 {
 372
 373         if (acpi_gbl_startup_flags & ACPI_INITIALIZED_OK) {
 374                 return (AE_OK);
 375         } else {
 376                 return (AE_ERROR);
 377         }
 378 }
 379
 380 ACPI_EXPORT_SYMBOL(acpi_subsystem_status)
 381
 382 /*******************************************************************************
 383  *
 384  * FUNCTION:    acpi_get_system_info
 385  *
 386  * PARAMETERS:  out_buffer      - A buffer to receive the resources for the
 387  *                                device
 388  *
 389  * RETURN:      Status          - the status of the call
 390  *
 391  * DESCRIPTION: This function is called to get information about the current
 392  *              state of the ACPI subsystem.  It will return system information
 393  *              in the out_buffer.
 394  *
 395  *              If the function fails an appropriate status will be returned
 396  *              and the value of out_buffer is undefined.
 397  *
 398  ******************************************************************************/
 399 acpi_status acpi_get_system_info(struct acpi_buffer * out_buffer)
 400 {
 401         struct acpi_system_info *info_ptr;
 402         acpi_status status;
 403
 404         ACPI_FUNCTION_TRACE(acpi_get_system_info);
 405
 406         /* Parameter validation */
 407
 408         status = acpi_ut_validate_buffer(out_buffer);
 409         if (ACPI_FAILURE(status)) {
 410                 return_ACPI_STATUS(status);
 411         }
 412
 413         /* Validate/Allocate/Clear caller buffer */
 414
 415         status =
 416             acpi_ut_initialize_buffer(out_buffer,
 417                                       sizeof(struct acpi_system_info));
 418         if (ACPI_FAILURE(status)) {
 419                 return_ACPI_STATUS(status);
 420         }
 421
 422         /*
 423          * Populate the return buffer
 424          */
 425         info_ptr = (struct acpi_system_info *)out_buffer->pointer;
 426
 427         info_ptr->acpi_ca_version = ACPI_CA_VERSION;
 428
 429         /* System flags (ACPI capabilities) */
 430
 431         info_ptr->flags = ACPI_SYS_MODE_ACPI;
 432
 433         /* Timer resolution - 24 or 32 bits  */
 434
 435         if (acpi_gbl_FADT.flags & ACPI_FADT_32BIT_TIMER) {
 436                 info_ptr->timer_resolution = 24;
 437         } else {
 438                 info_ptr->timer_resolution = 32;
 439         }
 440
 441         /* Clear the reserved fields */
 442
 443         info_ptr->reserved1 = 0;
 444         info_ptr->reserved2 = 0;
 445
 446         /* Current debug levels */
 447
 448         info_ptr->debug_layer = acpi_dbg_layer;
 449         info_ptr->debug_level = acpi_dbg_level;
 450
 451         return_ACPI_STATUS(AE_OK);
 452 }
 453
 454 ACPI_EXPORT_SYMBOL(acpi_get_system_info)
 455
 456 /*****************************************************************************
 457  *
 458  * FUNCTION:    acpi_install_initialization_handler
 459  *
 460  * PARAMETERS:  Handler             - Callback procedure
 461  *              Function            - Not (currently) used, see below
 462  *
 463  * RETURN:      Status
 464  *
 465  * DESCRIPTION: Install an initialization handler
 466  *
 467  * TBD: When a second function is added, must save the Function also.
 468  *
 469  ****************************************************************************/
 470 acpi_status
 471 acpi_install_initialization_handler(acpi_init_handler handler, u32 function)
 472 {
 473
 474         if (!handler) {
 475                 return (AE_BAD_PARAMETER);
 476         }
 477
 478         if (acpi_gbl_init_handler) {
 479                 return (AE_ALREADY_EXISTS);
 480         }
 481
 482         acpi_gbl_init_handler = handler;
 483         return AE_OK;
 484 }
 485
 486 ACPI_EXPORT_SYMBOL(acpi_install_initialization_handler)
 487 #endif                          /*  ACPI_FUTURE_USAGE  */
 488 /*****************************************************************************
 489  *
 490  * FUNCTION:    acpi_purge_cached_objects
 491  *
 492  * PARAMETERS:  None
 493  *
 494  * RETURN:      Status
 495  *
 496  * DESCRIPTION: Empty all caches (delete the cached objects)
 497  *
 498  ****************************************************************************/
 499 acpi_status acpi_purge_cached_objects(void)
 500 {
 501         ACPI_FUNCTION_TRACE(acpi_purge_cached_objects);
 502
 503         (void)acpi_os_purge_cache(acpi_gbl_state_cache);
 504         (void)acpi_os_purge_cache(acpi_gbl_operand_cache);
 505         (void)acpi_os_purge_cache(acpi_gbl_ps_node_cache);
 506         (void)acpi_os_purge_cache(acpi_gbl_ps_node_ext_cache);
 507         return_ACPI_STATUS(AE_OK);
 508 }
 509
 510 ACPI_EXPORT_SYMBOL(acpi_purge_cached_objects)
 511 #endif