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