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