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