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