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