drivers/acpi/acpica/utxface.c

   1 /******************************************************************************
   2  *
   3  * Module Name: utxface - External interfaces, miscellaneous utility functions
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2013, Intel Corp.
   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/export.h>
  45 #include <acpi/acpi.h>
  46 #include "accommon.h"
  47 #include "acdebug.h"
  48
  49 #define _COMPONENT          ACPI_UTILITIES
  50 ACPI_MODULE_NAME("utxface")
  51
  52 /*******************************************************************************
  53  *
  54  * FUNCTION:    acpi_terminate
  55  *
  56  * PARAMETERS:  None
  57  *
  58  * RETURN:      Status
  59  *
  60  * DESCRIPTION: Shutdown the ACPICA subsystem and release all resources.
  61  *
  62  ******************************************************************************/
  63 acpi_status acpi_terminate(void)
  64 {
  65         acpi_status status;
  66
  67         ACPI_FUNCTION_TRACE(acpi_terminate);
  68
  69         /* Just exit if subsystem is already shutdown */
  70
  71         if (acpi_gbl_shutdown) {
  72                 ACPI_ERROR((AE_INFO, "ACPI Subsystem is already terminated"));
  73                 return_ACPI_STATUS(AE_OK);
  74         }
  75
  76         /* Subsystem appears active, go ahead and shut it down */
  77
  78         acpi_gbl_shutdown = TRUE;
  79         acpi_gbl_startup_flags = 0;
  80         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Shutting down ACPI Subsystem\n"));
  81
  82         /* Terminate the AML Debugger if present */
  83
  84         ACPI_DEBUGGER_EXEC(acpi_gbl_db_terminate_threads = TRUE);
  85
  86         /* Shutdown and free all resources */
  87
  88         acpi_ut_subsystem_shutdown();
  89
  90         /* Free the mutex objects */
  91
  92         acpi_ut_mutex_terminate();
  93
  94 #ifdef ACPI_DEBUGGER
  95
  96         /* Shut down the debugger */
  97
  98         acpi_db_terminate();
  99 #endif
 100
 101         /* Now we can shutdown the OS-dependent layer */
 102
 103         status = acpi_os_terminate();
 104         return_ACPI_STATUS(status);
 105 }
 106
 107 ACPI_EXPORT_SYMBOL(acpi_terminate)
 108
 109 #ifndef ACPI_ASL_COMPILER
 110 #ifdef ACPI_FUTURE_USAGE
 111 /*******************************************************************************
 112  *
 113  * FUNCTION:    acpi_subsystem_status
 114  *
 115  * PARAMETERS:  None
 116  *
 117  * RETURN:      Status of the ACPI subsystem
 118  *
 119  * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
 120  *              before making any other calls, to ensure the subsystem
 121  *              initialized successfully.
 122  *
 123  ******************************************************************************/
 124 acpi_status acpi_subsystem_status(void)
 125 {
 126
 127         if (acpi_gbl_startup_flags & ACPI_INITIALIZED_OK) {
 128                 return (AE_OK);
 129         } else {
 130                 return (AE_ERROR);
 131         }
 132 }
 133
 134 ACPI_EXPORT_SYMBOL(acpi_subsystem_status)
 135
 136 /*******************************************************************************
 137  *
 138  * FUNCTION:    acpi_get_system_info
 139  *
 140  * PARAMETERS:  out_buffer      - A buffer to receive the resources for the
 141  *                                device
 142  *
 143  * RETURN:      status          - the status of the call
 144  *
 145  * DESCRIPTION: This function is called to get information about the current
 146  *              state of the ACPI subsystem. It will return system information
 147  *              in the out_buffer.
 148  *
 149  *              If the function fails an appropriate status will be returned
 150  *              and the value of out_buffer is undefined.
 151  *
 152  ******************************************************************************/
 153 acpi_status acpi_get_system_info(struct acpi_buffer * out_buffer)
 154 {
 155         struct acpi_system_info *info_ptr;
 156         acpi_status status;
 157
 158         ACPI_FUNCTION_TRACE(acpi_get_system_info);
 159
 160         /* Parameter validation */
 161
 162         status = acpi_ut_validate_buffer(out_buffer);
 163         if (ACPI_FAILURE(status)) {
 164                 return_ACPI_STATUS(status);
 165         }
 166
 167         /* Validate/Allocate/Clear caller buffer */
 168
 169         status =
 170             acpi_ut_initialize_buffer(out_buffer,
 171                                       sizeof(struct acpi_system_info));
 172         if (ACPI_FAILURE(status)) {
 173                 return_ACPI_STATUS(status);
 174         }
 175
 176         /*
 177          * Populate the return buffer
 178          */
 179         info_ptr = (struct acpi_system_info *)out_buffer->pointer;
 180
 181         info_ptr->acpi_ca_version = ACPI_CA_VERSION;
 182
 183         /* System flags (ACPI capabilities) */
 184
 185         info_ptr->flags = ACPI_SYS_MODE_ACPI;
 186
 187         /* Timer resolution - 24 or 32 bits  */
 188
 189         if (acpi_gbl_FADT.flags & ACPI_FADT_32BIT_TIMER) {
 190                 info_ptr->timer_resolution = 24;
 191         } else {
 192                 info_ptr->timer_resolution = 32;
 193         }
 194
 195         /* Clear the reserved fields */
 196
 197         info_ptr->reserved1 = 0;
 198         info_ptr->reserved2 = 0;
 199
 200         /* Current debug levels */
 201
 202         info_ptr->debug_layer = acpi_dbg_layer;
 203         info_ptr->debug_level = acpi_dbg_level;
 204
 205         return_ACPI_STATUS(AE_OK);
 206 }
 207
 208 ACPI_EXPORT_SYMBOL(acpi_get_system_info)
 209
 210 /*****************************************************************************
 211  *
 212  * FUNCTION:    acpi_install_initialization_handler
 213  *
 214  * PARAMETERS:  handler             - Callback procedure
 215  *              function            - Not (currently) used, see below
 216  *
 217  * RETURN:      Status
 218  *
 219  * DESCRIPTION: Install an initialization handler
 220  *
 221  * TBD: When a second function is added, must save the Function also.
 222  *
 223  ****************************************************************************/
 224 acpi_status
 225 acpi_install_initialization_handler(acpi_init_handler handler, u32 function)
 226 {
 227
 228         if (!handler) {
 229                 return (AE_BAD_PARAMETER);
 230         }
 231
 232         if (acpi_gbl_init_handler) {
 233                 return (AE_ALREADY_EXISTS);
 234         }
 235
 236         acpi_gbl_init_handler = handler;
 237         return (AE_OK);
 238 }
 239
 240 ACPI_EXPORT_SYMBOL(acpi_install_initialization_handler)
 241 #endif                          /*  ACPI_FUTURE_USAGE  */
 242
 243 /*****************************************************************************
 244  *
 245  * FUNCTION:    acpi_purge_cached_objects
 246  *
 247  * PARAMETERS:  None
 248  *
 249  * RETURN:      Status
 250  *
 251  * DESCRIPTION: Empty all caches (delete the cached objects)
 252  *
 253  ****************************************************************************/
 254 acpi_status acpi_purge_cached_objects(void)
 255 {
 256         ACPI_FUNCTION_TRACE(acpi_purge_cached_objects);
 257
 258         (void)acpi_os_purge_cache(acpi_gbl_state_cache);
 259         (void)acpi_os_purge_cache(acpi_gbl_operand_cache);
 260         (void)acpi_os_purge_cache(acpi_gbl_ps_node_cache);
 261         (void)acpi_os_purge_cache(acpi_gbl_ps_node_ext_cache);
 262
 263         return_ACPI_STATUS(AE_OK);
 264 }
 265
 266 ACPI_EXPORT_SYMBOL(acpi_purge_cached_objects)
 267
 268 /*****************************************************************************
 269  *
 270  * FUNCTION:    acpi_install_interface
 271  *
 272  * PARAMETERS:  interface_name      - The interface to install
 273  *
 274  * RETURN:      Status
 275  *
 276  * DESCRIPTION: Install an _OSI interface to the global list
 277  *
 278  ****************************************************************************/
 279 acpi_status acpi_install_interface(acpi_string interface_name)
 280 {
 281         acpi_status status;
 282         struct acpi_interface_info *interface_info;
 283
 284         /* Parameter validation */
 285
 286         if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
 287                 return (AE_BAD_PARAMETER);
 288         }
 289
 290         (void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
 291
 292         /* Check if the interface name is already in the global list */
 293
 294         interface_info = acpi_ut_get_interface(interface_name);
 295         if (interface_info) {
 296                 /*
 297                  * The interface already exists in the list. This is OK if the
 298                  * interface has been marked invalid -- just clear the bit.
 299                  */
 300                 if (interface_info->flags & ACPI_OSI_INVALID) {
 301                         interface_info->flags &= ~ACPI_OSI_INVALID;
 302                         status = AE_OK;
 303                 } else {
 304                         status = AE_ALREADY_EXISTS;
 305                 }
 306         } else {
 307                 /* New interface name, install into the global list */
 308
 309                 status = acpi_ut_install_interface(interface_name);
 310         }
 311
 312         acpi_os_release_mutex(acpi_gbl_osi_mutex);
 313         return (status);
 314 }
 315
 316 ACPI_EXPORT_SYMBOL(acpi_install_interface)
 317
 318 /*****************************************************************************
 319  *
 320  * FUNCTION:    acpi_remove_interface
 321  *
 322  * PARAMETERS:  interface_name      - The interface to remove
 323  *
 324  * RETURN:      Status
 325  *
 326  * DESCRIPTION: Remove an _OSI interface from the global list
 327  *
 328  ****************************************************************************/
 329 acpi_status acpi_remove_interface(acpi_string interface_name)
 330 {
 331         acpi_status status;
 332
 333         /* Parameter validation */
 334
 335         if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
 336                 return (AE_BAD_PARAMETER);
 337         }
 338
 339         (void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
 340
 341         status = acpi_ut_remove_interface(interface_name);
 342
 343         acpi_os_release_mutex(acpi_gbl_osi_mutex);
 344         return (status);
 345 }
 346
 347 ACPI_EXPORT_SYMBOL(acpi_remove_interface)
 348
 349 /*****************************************************************************
 350  *
 351  * FUNCTION:    acpi_install_interface_handler
 352  *
 353  * PARAMETERS:  handler             - The _OSI interface handler to install
 354  *                                    NULL means "remove existing handler"
 355  *
 356  * RETURN:      Status
 357  *
 358  * DESCRIPTION: Install a handler for the predefined _OSI ACPI method.
 359  *              invoked during execution of the internal implementation of
 360  *              _OSI. A NULL handler simply removes any existing handler.
 361  *
 362  ****************************************************************************/
 363 acpi_status acpi_install_interface_handler(acpi_interface_handler handler)
 364 {
 365         acpi_status status = AE_OK;
 366
 367         (void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
 368
 369         if (handler && acpi_gbl_interface_handler) {
 370                 status = AE_ALREADY_EXISTS;
 371         } else {
 372                 acpi_gbl_interface_handler = handler;
 373         }
 374
 375         acpi_os_release_mutex(acpi_gbl_osi_mutex);
 376         return (status);
 377 }
 378
 379 ACPI_EXPORT_SYMBOL(acpi_install_interface_handler)
 380
 381 /*****************************************************************************
 382  *
 383  * FUNCTION:    acpi_check_address_range
 384  *
 385  * PARAMETERS:  space_id            - Address space ID
 386  *              address             - Start address
 387  *              length              - Length
 388  *              warn                - TRUE if warning on overlap desired
 389  *
 390  * RETURN:      Count of the number of conflicts detected.
 391  *
 392  * DESCRIPTION: Check if the input address range overlaps any of the
 393  *              ASL operation region address ranges.
 394  *
 395  ****************************************************************************/
 396 u32
 397 acpi_check_address_range(acpi_adr_space_type space_id,
 398                          acpi_physical_address address,
 399                          acpi_size length, u8 warn)
 400 {
 401         u32 overlaps;
 402         acpi_status status;
 403
 404         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
 405         if (ACPI_FAILURE(status)) {
 406                 return (0);
 407         }
 408
 409         overlaps = acpi_ut_check_address_range(space_id, address,
 410                                                (u32)length, warn);
 411
 412         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 413         return (overlaps);
 414 }
 415
 416 ACPI_EXPORT_SYMBOL(acpi_check_address_range)
 417 #endif                          /* !ACPI_ASL_COMPILER */
 418 /*******************************************************************************
 419  *
 420  * FUNCTION:    acpi_decode_pld_buffer
 421  *
 422  * PARAMETERS:  in_buffer           - Buffer returned by _PLD method
 423  *              length              - Length of the in_buffer
 424  *              return_buffer       - Where the decode buffer is returned
 425  *
 426  * RETURN:      Status and the decoded _PLD buffer. User must deallocate
 427  *              the buffer via ACPI_FREE.
 428  *
 429  * DESCRIPTION: Decode the bit-packed buffer returned by the _PLD method into
 430  *              a local struct that is much more useful to an ACPI driver.
 431  *
 432  ******************************************************************************/
 433 acpi_status
 434 acpi_decode_pld_buffer(u8 *in_buffer,
 435                        acpi_size length, struct acpi_pld_info ** return_buffer)
 436 {
 437         struct acpi_pld_info *pld_info;
 438         u32 *buffer = ACPI_CAST_PTR(u32, in_buffer);
 439         u32 dword;
 440
 441         /* Parameter validation */
 442
 443         if (!in_buffer || !return_buffer || (length < 16)) {
 444                 return (AE_BAD_PARAMETER);
 445         }
 446
 447         pld_info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pld_info));
 448         if (!pld_info) {
 449                 return (AE_NO_MEMORY);
 450         }
 451
 452         /* First 32-bit DWord */
 453
 454         ACPI_MOVE_32_TO_32(&dword, &buffer[0]);
 455         pld_info->revision = ACPI_PLD_GET_REVISION(&dword);
 456         pld_info->ignore_color = ACPI_PLD_GET_IGNORE_COLOR(&dword);
 457         pld_info->color = ACPI_PLD_GET_COLOR(&dword);
 458
 459         /* Second 32-bit DWord */
 460
 461         ACPI_MOVE_32_TO_32(&dword, &buffer[1]);
 462         pld_info->width = ACPI_PLD_GET_WIDTH(&dword);
 463         pld_info->height = ACPI_PLD_GET_HEIGHT(&dword);
 464
 465         /* Third 32-bit DWord */
 466
 467         ACPI_MOVE_32_TO_32(&dword, &buffer[2]);
 468         pld_info->user_visible = ACPI_PLD_GET_USER_VISIBLE(&dword);
 469         pld_info->dock = ACPI_PLD_GET_DOCK(&dword);
 470         pld_info->lid = ACPI_PLD_GET_LID(&dword);
 471         pld_info->panel = ACPI_PLD_GET_PANEL(&dword);
 472         pld_info->vertical_position = ACPI_PLD_GET_VERTICAL(&dword);
 473         pld_info->horizontal_position = ACPI_PLD_GET_HORIZONTAL(&dword);
 474         pld_info->shape = ACPI_PLD_GET_SHAPE(&dword);
 475         pld_info->group_orientation = ACPI_PLD_GET_ORIENTATION(&dword);
 476         pld_info->group_token = ACPI_PLD_GET_TOKEN(&dword);
 477         pld_info->group_position = ACPI_PLD_GET_POSITION(&dword);
 478         pld_info->bay = ACPI_PLD_GET_BAY(&dword);
 479
 480         /* Fourth 32-bit DWord */
 481
 482         ACPI_MOVE_32_TO_32(&dword, &buffer[3]);
 483         pld_info->ejectable = ACPI_PLD_GET_EJECTABLE(&dword);
 484         pld_info->ospm_eject_required = ACPI_PLD_GET_OSPM_EJECT(&dword);
 485         pld_info->cabinet_number = ACPI_PLD_GET_CABINET(&dword);
 486         pld_info->card_cage_number = ACPI_PLD_GET_CARD_CAGE(&dword);
 487         pld_info->reference = ACPI_PLD_GET_REFERENCE(&dword);
 488         pld_info->rotation = ACPI_PLD_GET_ROTATION(&dword);
 489         pld_info->order = ACPI_PLD_GET_ORDER(&dword);
 490
 491         if (length >= ACPI_PLD_BUFFER_SIZE) {
 492
 493                 /* Fifth 32-bit DWord (Revision 2 of _PLD) */
 494
 495                 ACPI_MOVE_32_TO_32(&dword, &buffer[4]);
 496                 pld_info->vertical_offset = ACPI_PLD_GET_VERT_OFFSET(&dword);
 497                 pld_info->horizontal_offset = ACPI_PLD_GET_HORIZ_OFFSET(&dword);
 498         }
 499
 500         *return_buffer = pld_info;
 501         return (AE_OK);
 502 }
 503
 504 ACPI_EXPORT_SYMBOL(acpi_decode_pld_buffer)