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