Pileus Git - ~andy/linux/blob - drivers/acpi/acpica/tbxface.c

   1 /******************************************************************************
   2  *
   3  * Module Name: tbxface - ACPI table-oriented external interfaces
   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 #define EXPORT_ACPI_INTERFACES
  45
  46 #include <acpi/acpi.h>
  47 #include "accommon.h"
  48 #include "actables.h"
  49
  50 #define _COMPONENT          ACPI_TABLES
  51 ACPI_MODULE_NAME("tbxface")
  52
  53 /*******************************************************************************
  54  *
  55  * FUNCTION:    acpi_allocate_root_table
  56  *
  57  * PARAMETERS:  initial_table_count - Size of initial_table_array, in number of
  58  *                                    struct acpi_table_desc structures
  59  *
  60  * RETURN:      Status
  61  *
  62  * DESCRIPTION: Allocate a root table array. Used by iASL compiler and
  63  *              acpi_initialize_tables.
  64  *
  65  ******************************************************************************/
  66 acpi_status acpi_allocate_root_table(u32 initial_table_count)
  67 {
  68
  69         acpi_gbl_root_table_list.max_table_count = initial_table_count;
  70         acpi_gbl_root_table_list.flags = ACPI_ROOT_ALLOW_RESIZE;
  71
  72         return (acpi_tb_resize_root_table_list());
  73 }
  74
  75 /*******************************************************************************
  76  *
  77  * FUNCTION:    acpi_initialize_tables
  78  *
  79  * PARAMETERS:  initial_table_array - Pointer to an array of pre-allocated
  80  *                                    struct acpi_table_desc structures. If NULL, the
  81  *                                    array is dynamically allocated.
  82  *              initial_table_count - Size of initial_table_array, in number of
  83  *                                    struct acpi_table_desc structures
  84  *              allow_resize        - Flag to tell Table Manager if resize of
  85  *                                    pre-allocated array is allowed. Ignored
  86  *                                    if initial_table_array is NULL.
  87  *
  88  * RETURN:      Status
  89  *
  90  * DESCRIPTION: Initialize the table manager, get the RSDP and RSDT/XSDT.
  91  *
  92  * NOTE:        Allows static allocation of the initial table array in order
  93  *              to avoid the use of dynamic memory in confined environments
  94  *              such as the kernel boot sequence where it may not be available.
  95  *
  96  *              If the host OS memory managers are initialized, use NULL for
  97  *              initial_table_array, and the table will be dynamically allocated.
  98  *
  99  ******************************************************************************/
 100
 101 acpi_status __init
 102 acpi_initialize_tables(struct acpi_table_desc * initial_table_array,
 103                        u32 initial_table_count, u8 allow_resize)
 104 {
 105         acpi_physical_address rsdp_address;
 106         acpi_status status;
 107
 108         ACPI_FUNCTION_TRACE(acpi_initialize_tables);
 109
 110         /*
 111          * Setup the Root Table Array and allocate the table array
 112          * if requested
 113          */
 114         if (!initial_table_array) {
 115                 status = acpi_allocate_root_table(initial_table_count);
 116                 if (ACPI_FAILURE(status)) {
 117                         return_ACPI_STATUS(status);
 118                 }
 119         } else {
 120                 /* Root Table Array has been statically allocated by the host */
 121
 122                 ACPI_MEMSET(initial_table_array, 0,
 123                             (acpi_size) initial_table_count *
 124                             sizeof(struct acpi_table_desc));
 125
 126                 acpi_gbl_root_table_list.tables = initial_table_array;
 127                 acpi_gbl_root_table_list.max_table_count = initial_table_count;
 128                 acpi_gbl_root_table_list.flags = ACPI_ROOT_ORIGIN_UNKNOWN;
 129                 if (allow_resize) {
 130                         acpi_gbl_root_table_list.flags |=
 131                             ACPI_ROOT_ALLOW_RESIZE;
 132                 }
 133         }
 134
 135         /* Get the address of the RSDP */
 136
 137         rsdp_address = acpi_os_get_root_pointer();
 138         if (!rsdp_address) {
 139                 return_ACPI_STATUS(AE_NOT_FOUND);
 140         }
 141
 142         /*
 143          * Get the root table (RSDT or XSDT) and extract all entries to the local
 144          * Root Table Array. This array contains the information of the RSDT/XSDT
 145          * in a common, more useable format.
 146          */
 147         status = acpi_tb_parse_root_table(rsdp_address);
 148         return_ACPI_STATUS(status);
 149 }
 150
 151 /*******************************************************************************
 152  *
 153  * FUNCTION:    acpi_reallocate_root_table
 154  *
 155  * PARAMETERS:  None
 156  *
 157  * RETURN:      Status
 158  *
 159  * DESCRIPTION: Reallocate Root Table List into dynamic memory. Copies the
 160  *              root list from the previously provided scratch area. Should
 161  *              be called once dynamic memory allocation is available in the
 162  *              kernel.
 163  *
 164  ******************************************************************************/
 165 acpi_status acpi_reallocate_root_table(void)
 166 {
 167         acpi_status status;
 168
 169         ACPI_FUNCTION_TRACE(acpi_reallocate_root_table);
 170
 171         /*
 172          * Only reallocate the root table if the host provided a static buffer
 173          * for the table array in the call to acpi_initialize_tables.
 174          */
 175         if (acpi_gbl_root_table_list.flags & ACPI_ROOT_ORIGIN_ALLOCATED) {
 176                 return_ACPI_STATUS(AE_SUPPORT);
 177         }
 178
 179         acpi_gbl_root_table_list.flags |= ACPI_ROOT_ALLOW_RESIZE;
 180
 181         status = acpi_tb_resize_root_table_list();
 182         return_ACPI_STATUS(status);
 183 }
 184
 185 /*******************************************************************************
 186  *
 187  * FUNCTION:    acpi_get_table_header
 188  *
 189  * PARAMETERS:  signature           - ACPI signature of needed table
 190  *              instance            - Which instance (for SSDTs)
 191  *              out_table_header    - The pointer to the table header to fill
 192  *
 193  * RETURN:      Status and pointer to mapped table header
 194  *
 195  * DESCRIPTION: Finds an ACPI table header.
 196  *
 197  * NOTE:        Caller is responsible in unmapping the header with
 198  *              acpi_os_unmap_memory
 199  *
 200  ******************************************************************************/
 201 acpi_status
 202 acpi_get_table_header(char *signature,
 203                       u32 instance, struct acpi_table_header *out_table_header)
 204 {
 205        u32 i;
 206        u32 j;
 207         struct acpi_table_header *header;
 208
 209         /* Parameter validation */
 210
 211         if (!signature || !out_table_header) {
 212                 return (AE_BAD_PARAMETER);
 213         }
 214
 215         /* Walk the root table list */
 216
 217         for (i = 0, j = 0; i < acpi_gbl_root_table_list.current_table_count;
 218              i++) {
 219                 if (!ACPI_COMPARE_NAME
 220                     (&(acpi_gbl_root_table_list.tables[i].signature),
 221                      signature)) {
 222                         continue;
 223                 }
 224
 225                 if (++j < instance) {
 226                         continue;
 227                 }
 228
 229                 if (!acpi_gbl_root_table_list.tables[i].pointer) {
 230                         if ((acpi_gbl_root_table_list.tables[i].flags &
 231                              ACPI_TABLE_ORIGIN_MASK) ==
 232                             ACPI_TABLE_ORIGIN_MAPPED) {
 233                                 header =
 234                                     acpi_os_map_memory(acpi_gbl_root_table_list.
 235                                                        tables[i].address,
 236                                                        sizeof(struct
 237                                                               acpi_table_header));
 238                                 if (!header) {
 239                                         return (AE_NO_MEMORY);
 240                                 }
 241                                 ACPI_MEMCPY(out_table_header, header,
 242                                             sizeof(struct acpi_table_header));
 243                                 acpi_os_unmap_memory(header,
 244                                                      sizeof(struct
 245                                                             acpi_table_header));
 246                         } else {
 247                                 return (AE_NOT_FOUND);
 248                         }
 249                 } else {
 250                         ACPI_MEMCPY(out_table_header,
 251                                     acpi_gbl_root_table_list.tables[i].pointer,
 252                                     sizeof(struct acpi_table_header));
 253                 }
 254                 return (AE_OK);
 255         }
 256
 257         return (AE_NOT_FOUND);
 258 }
 259
 260 ACPI_EXPORT_SYMBOL(acpi_get_table_header)
 261
 262 /*******************************************************************************
 263  *
 264  * FUNCTION:    acpi_unload_table_id
 265  *
 266  * PARAMETERS:  id            - Owner ID of the table to be removed.
 267  *
 268  * RETURN:      Status
 269  *
 270  * DESCRIPTION: This routine is used to force the unload of a table (by id)
 271  *
 272  ******************************************************************************/
 273 acpi_status acpi_unload_table_id(acpi_owner_id id)
 274 {
 275         int i;
 276         acpi_status status = AE_NOT_EXIST;
 277
 278         ACPI_FUNCTION_TRACE(acpi_unload_table_id);
 279
 280         /* Find table in the global table list */
 281         for (i = 0; i < acpi_gbl_root_table_list.current_table_count; ++i) {
 282                 if (id != acpi_gbl_root_table_list.tables[i].owner_id) {
 283                         continue;
 284                 }
 285                 /*
 286                  * Delete all namespace objects owned by this table. Note that these
 287                  * objects can appear anywhere in the namespace by virtue of the AML
 288                  * "Scope" operator. Thus, we need to track ownership by an ID, not
 289                  * simply a position within the hierarchy
 290                  */
 291                 acpi_tb_delete_namespace_by_owner(i);
 292                 status = acpi_tb_release_owner_id(i);
 293                 acpi_tb_set_table_loaded_flag(i, FALSE);
 294                 break;
 295         }
 296         return_ACPI_STATUS(status);
 297 }
 298
 299 ACPI_EXPORT_SYMBOL(acpi_unload_table_id)
 300
 301 /*******************************************************************************
 302  *
 303  * FUNCTION:    acpi_get_table_with_size
 304  *
 305  * PARAMETERS:  signature           - ACPI signature of needed table
 306  *              instance            - Which instance (for SSDTs)
 307  *              out_table           - Where the pointer to the table is returned
 308  *
 309  * RETURN:      Status and pointer to the requested table
 310  *
 311  * DESCRIPTION: Finds and verifies an ACPI table. Table must be in the
 312  *              RSDT/XSDT.
 313  *
 314  ******************************************************************************/
 315 acpi_status
 316 acpi_get_table_with_size(char *signature,
 317                u32 instance, struct acpi_table_header **out_table,
 318                acpi_size *tbl_size)
 319 {
 320        u32 i;
 321        u32 j;
 322         acpi_status status;
 323
 324         /* Parameter validation */
 325
 326         if (!signature || !out_table) {
 327                 return (AE_BAD_PARAMETER);
 328         }
 329
 330         /* Walk the root table list */
 331
 332         for (i = 0, j = 0; i < acpi_gbl_root_table_list.current_table_count;
 333              i++) {
 334                 if (!ACPI_COMPARE_NAME
 335                     (&(acpi_gbl_root_table_list.tables[i].signature),
 336                      signature)) {
 337                         continue;
 338                 }
 339
 340                 if (++j < instance) {
 341                         continue;
 342                 }
 343
 344                 status =
 345                     acpi_tb_verify_table(&acpi_gbl_root_table_list.tables[i]);
 346                 if (ACPI_SUCCESS(status)) {
 347                         *out_table = acpi_gbl_root_table_list.tables[i].pointer;
 348                         *tbl_size = acpi_gbl_root_table_list.tables[i].length;
 349                 }
 350
 351                 if (!acpi_gbl_permanent_mmap) {
 352                         acpi_gbl_root_table_list.tables[i].pointer = NULL;
 353                 }
 354
 355                 return (status);
 356         }
 357
 358         return (AE_NOT_FOUND);
 359 }
 360 ACPI_EXPORT_SYMBOL(acpi_get_table_with_size)
 361
 362 acpi_status
 363 acpi_get_table(char *signature,
 364                u32 instance, struct acpi_table_header **out_table)
 365 {
 366         acpi_size tbl_size;
 367
 368         return acpi_get_table_with_size(signature,
 369                        instance, out_table, &tbl_size);
 370 }
 371 ACPI_EXPORT_SYMBOL(acpi_get_table)
 372
 373 /*******************************************************************************
 374  *
 375  * FUNCTION:    acpi_get_table_by_index
 376  *
 377  * PARAMETERS:  table_index         - Table index
 378  *              table               - Where the pointer to the table is returned
 379  *
 380  * RETURN:      Status and pointer to the requested table
 381  *
 382  * DESCRIPTION: Obtain a table by an index into the global table list. Used
 383  *              internally also.
 384  *
 385  ******************************************************************************/
 386 acpi_status
 387 acpi_get_table_by_index(u32 table_index, struct acpi_table_header **table)
 388 {
 389         acpi_status status;
 390
 391         ACPI_FUNCTION_TRACE(acpi_get_table_by_index);
 392
 393         /* Parameter validation */
 394
 395         if (!table) {
 396                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 397         }
 398
 399         (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
 400
 401         /* Validate index */
 402
 403         if (table_index >= acpi_gbl_root_table_list.current_table_count) {
 404                 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
 405                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 406         }
 407
 408         if (!acpi_gbl_root_table_list.tables[table_index].pointer) {
 409
 410                 /* Table is not mapped, map it */
 411
 412                 status =
 413                     acpi_tb_verify_table(&acpi_gbl_root_table_list.
 414                                          tables[table_index]);
 415                 if (ACPI_FAILURE(status)) {
 416                         (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
 417                         return_ACPI_STATUS(status);
 418                 }
 419         }
 420
 421         *table = acpi_gbl_root_table_list.tables[table_index].pointer;
 422         (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
 423         return_ACPI_STATUS(AE_OK);
 424 }
 425
 426 ACPI_EXPORT_SYMBOL(acpi_get_table_by_index)
 427
 428
 429 /*******************************************************************************
 430  *
 431  * FUNCTION:    acpi_install_table_handler
 432  *
 433  * PARAMETERS:  handler         - Table event handler
 434  *              context         - Value passed to the handler on each event
 435  *
 436  * RETURN:      Status
 437  *
 438  * DESCRIPTION: Install a global table event handler.
 439  *
 440  ******************************************************************************/
 441 acpi_status
 442 acpi_install_table_handler(acpi_table_handler handler, void *context)
 443 {
 444         acpi_status status;
 445
 446         ACPI_FUNCTION_TRACE(acpi_install_table_handler);
 447
 448         if (!handler) {
 449                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 450         }
 451
 452         status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
 453         if (ACPI_FAILURE(status)) {
 454                 return_ACPI_STATUS(status);
 455         }
 456
 457         /* Don't allow more than one handler */
 458
 459         if (acpi_gbl_table_handler) {
 460                 status = AE_ALREADY_EXISTS;
 461                 goto cleanup;
 462         }
 463
 464         /* Install the handler */
 465
 466         acpi_gbl_table_handler = handler;
 467         acpi_gbl_table_handler_context = context;
 468
 469 cleanup:
 470         (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
 471         return_ACPI_STATUS(status);
 472 }
 473
 474 ACPI_EXPORT_SYMBOL(acpi_install_table_handler)
 475
 476 /*******************************************************************************
 477  *
 478  * FUNCTION:    acpi_remove_table_handler
 479  *
 480  * PARAMETERS:  handler         - Table event handler that was installed
 481  *                                previously.
 482  *
 483  * RETURN:      Status
 484  *
 485  * DESCRIPTION: Remove a table event handler
 486  *
 487  ******************************************************************************/
 488 acpi_status acpi_remove_table_handler(acpi_table_handler handler)
 489 {
 490         acpi_status status;
 491
 492         ACPI_FUNCTION_TRACE(acpi_remove_table_handler);
 493
 494         status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
 495         if (ACPI_FAILURE(status)) {
 496                 return_ACPI_STATUS(status);
 497         }
 498
 499         /* Make sure that the installed handler is the same */
 500
 501         if (!handler || handler != acpi_gbl_table_handler) {
 502                 status = AE_BAD_PARAMETER;
 503                 goto cleanup;
 504         }
 505
 506         /* Remove the handler */
 507
 508         acpi_gbl_table_handler = NULL;
 509
 510 cleanup:
 511         (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
 512         return_ACPI_STATUS(status);
 513 }
 514
 515 ACPI_EXPORT_SYMBOL(acpi_remove_table_handler)