include/acpi/acpixf.h

   1 /******************************************************************************
   2  *
   3  * Name: acpixf.h - External interfaces to the ACPI subsystem
   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 #ifndef __ACXFACE_H__
  45 #define __ACXFACE_H__
  46
  47 /* Current ACPICA subsystem version in YYYYMMDD format */
  48
  49 #define ACPI_CA_VERSION                 0x20130517
  50
  51 #include <acpi/acconfig.h>
  52 #include <acpi/actypes.h>
  53 #include <acpi/actbl.h>
  54 #include <acpi/acbuffer.h>
  55
  56 extern u8 acpi_gbl_permanent_mmap;
  57
  58 /*
  59  * Globals that are publically available
  60  */
  61 extern u32 acpi_current_gpe_count;
  62 extern struct acpi_table_fadt acpi_gbl_FADT;
  63 extern u8 acpi_gbl_system_awake_and_running;
  64 extern u8 acpi_gbl_reduced_hardware;    /* ACPI 5.0 */
  65 extern u8 acpi_gbl_osi_data;
  66
  67 /* Runtime configuration of debug print levels */
  68
  69 extern u32 acpi_dbg_level;
  70 extern u32 acpi_dbg_layer;
  71
  72 /* ACPICA runtime options */
  73
  74 extern u8 acpi_gbl_enable_interpreter_slack;
  75 extern u8 acpi_gbl_all_methods_serialized;
  76 extern u8 acpi_gbl_create_osi_method;
  77 extern u8 acpi_gbl_use_default_register_widths;
  78 extern acpi_name acpi_gbl_trace_method_name;
  79 extern u32 acpi_gbl_trace_flags;
  80 extern bool acpi_gbl_enable_aml_debug_object;
  81 extern u8 acpi_gbl_copy_dsdt_locally;
  82 extern u8 acpi_gbl_truncate_io_addresses;
  83 extern u8 acpi_gbl_disable_auto_repair;
  84 extern u8 acpi_gbl_disable_ssdt_table_load;
  85
  86 /*
  87  * Hardware-reduced prototypes. All interfaces that use these macros will
  88  * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
  89  * is set to TRUE.
  90  */
  91 #if (!ACPI_REDUCED_HARDWARE)
  92 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
  93         prototype;
  94
  95 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
  96         prototype;
  97
  98 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
  99         prototype;
 100
 101 #else
 102 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
 103         static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
 104
 105 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
 106         static ACPI_INLINE prototype {return(AE_OK);}
 107
 108 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
 109         static ACPI_INLINE prototype {}
 110
 111 #endif                          /* !ACPI_REDUCED_HARDWARE */
 112
 113 extern u32 acpi_rsdt_forced;
 114 /*
 115  * Initialization
 116  */
 117 acpi_status
 118 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
 119                        u32 initial_table_count, u8 allow_resize);
 120
 121 acpi_status __init acpi_initialize_subsystem(void);
 122
 123 acpi_status acpi_enable_subsystem(u32 flags);
 124
 125 acpi_status acpi_initialize_objects(u32 flags);
 126
 127 acpi_status acpi_terminate(void);
 128
 129 /*
 130  * Miscellaneous global interfaces
 131  */
 132 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
 133 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
 134 #ifdef ACPI_FUTURE_USAGE
 135 acpi_status acpi_subsystem_status(void);
 136 #endif
 137
 138 #ifdef ACPI_FUTURE_USAGE
 139 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
 140 #endif
 141
 142 const char *acpi_format_exception(acpi_status exception);
 143
 144 acpi_status acpi_purge_cached_objects(void);
 145
 146 acpi_status acpi_install_interface(acpi_string interface_name);
 147
 148 acpi_status acpi_remove_interface(acpi_string interface_name);
 149
 150 u32
 151 acpi_check_address_range(acpi_adr_space_type space_id,
 152                          acpi_physical_address address,
 153                          acpi_size length, u8 warn);
 154
 155 acpi_status
 156 acpi_decode_pld_buffer(u8 *in_buffer,
 157                        acpi_size length, struct acpi_pld_info **return_buffer);
 158
 159 /*
 160  * ACPI Memory management
 161  */
 162 void *acpi_allocate(u32 size);
 163
 164 void *acpi_callocate(u32 size);
 165
 166 void acpi_free(void *address);
 167
 168 /*
 169  * ACPI table load/unload interfaces
 170  */
 171 acpi_status acpi_load_table(struct acpi_table_header *table);
 172
 173 acpi_status acpi_unload_parent_table(acpi_handle object);
 174
 175 acpi_status acpi_load_tables(void);
 176
 177 /*
 178  * ACPI table manipulation interfaces
 179  */
 180 acpi_status acpi_reallocate_root_table(void);
 181
 182 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
 183
 184 acpi_status acpi_unload_table_id(acpi_owner_id id);
 185
 186 acpi_status
 187 acpi_get_table_header(acpi_string signature,
 188                       u32 instance, struct acpi_table_header *out_table_header);
 189
 190 acpi_status
 191 acpi_get_table_with_size(acpi_string signature,
 192                u32 instance, struct acpi_table_header **out_table,
 193                acpi_size *tbl_size);
 194 acpi_status
 195 acpi_get_table(acpi_string signature,
 196                u32 instance, struct acpi_table_header **out_table);
 197
 198 acpi_status
 199 acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table);
 200
 201 acpi_status
 202 acpi_install_table_handler(acpi_table_handler handler, void *context);
 203
 204 acpi_status acpi_remove_table_handler(acpi_table_handler handler);
 205
 206 /*
 207  * Namespace and name interfaces
 208  */
 209 acpi_status
 210 acpi_walk_namespace(acpi_object_type type,
 211                     acpi_handle start_object,
 212                     u32 max_depth,
 213                     acpi_walk_callback pre_order_visit,
 214                     acpi_walk_callback post_order_visit,
 215                     void *context, void **return_value);
 216
 217 acpi_status
 218 acpi_get_devices(const char *HID,
 219                  acpi_walk_callback user_function,
 220                  void *context, void **return_value);
 221
 222 acpi_status
 223 acpi_get_name(acpi_handle object,
 224               u32 name_type, struct acpi_buffer *ret_path_ptr);
 225
 226 acpi_status
 227 acpi_get_handle(acpi_handle parent,
 228                 acpi_string pathname, acpi_handle * ret_handle);
 229
 230 acpi_status
 231 acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
 232
 233 acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
 234
 235 acpi_status
 236 acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
 237
 238 acpi_status
 239 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
 240
 241 /*
 242  * Object manipulation and enumeration
 243  */
 244 acpi_status
 245 acpi_evaluate_object(acpi_handle object,
 246                      acpi_string pathname,
 247                      struct acpi_object_list *parameter_objects,
 248                      struct acpi_buffer *return_object_buffer);
 249
 250 acpi_status
 251 acpi_evaluate_object_typed(acpi_handle object,
 252                            acpi_string pathname,
 253                            struct acpi_object_list *external_params,
 254                            struct acpi_buffer *return_buffer,
 255                            acpi_object_type return_type);
 256
 257 acpi_status
 258 acpi_get_object_info(acpi_handle object,
 259                      struct acpi_device_info **return_buffer);
 260
 261 acpi_status acpi_install_method(u8 *buffer);
 262
 263 acpi_status
 264 acpi_get_next_object(acpi_object_type type,
 265                      acpi_handle parent,
 266                      acpi_handle child, acpi_handle * out_handle);
 267
 268 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
 269
 270 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
 271
 272 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
 273
 274 /*
 275  * Handler interfaces
 276  */
 277 acpi_status
 278 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
 279
 280 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 281                                 acpi_install_global_event_handler
 282                                 (acpi_gbl_event_handler handler, void *context))
 283
 284 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 285                                  acpi_install_fixed_event_handler(u32
 286                                                                   acpi_event,
 287                                                                   acpi_event_handler
 288                                                                   handler,
 289                                                                   void
 290                                                                   *context))
 291 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 292                                  acpi_remove_fixed_event_handler(u32 acpi_event,
 293                                                                  acpi_event_handler
 294                                                                  handler))
 295 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 296                                  acpi_install_gpe_handler(acpi_handle
 297                                                           gpe_device,
 298                                                           u32 gpe_number,
 299                                                           u32 type,
 300                                                           acpi_gpe_handler
 301                                                           address,
 302                                                           void *context))
 303 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 304                                  acpi_remove_gpe_handler(acpi_handle gpe_device,
 305                                                          u32 gpe_number,
 306                                                          acpi_gpe_handler
 307                                                          address))
 308 acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type,
 309                                         acpi_notify_handler handler,
 310                                         void *context);
 311
 312 acpi_status
 313 acpi_remove_notify_handler(acpi_handle device,
 314                            u32 handler_type, acpi_notify_handler handler);
 315
 316 acpi_status
 317 acpi_install_address_space_handler(acpi_handle device,
 318                                    acpi_adr_space_type space_id,
 319                                    acpi_adr_space_handler handler,
 320                                    acpi_adr_space_setup setup, void *context);
 321
 322 acpi_status
 323 acpi_remove_address_space_handler(acpi_handle device,
 324                                   acpi_adr_space_type space_id,
 325                                   acpi_adr_space_handler handler);
 326
 327 #ifdef ACPI_FUTURE_USAGE
 328 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
 329 #endif
 330
 331 acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
 332
 333 /*
 334  * Global Lock interfaces
 335  */
 336 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 337                                 acpi_acquire_global_lock(u16 timeout,
 338                                                          u32 *handle))
 339 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 340                                 acpi_release_global_lock(u32 handle))
 341
 342 /*
 343  * Interfaces to AML mutex objects
 344  */
 345 acpi_status
 346 acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
 347
 348 acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
 349
 350 /*
 351  * Fixed Event interfaces
 352  */
 353 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 354                                 acpi_enable_event(u32 event, u32 flags))
 355
 356 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 357                                 acpi_disable_event(u32 event, u32 flags))
 358
 359 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
 360
 361 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 362                                 acpi_get_event_status(u32 event,
 363                                                       acpi_event_status
 364                                                       *event_status))
 365 /*
 366  * General Purpose Event (GPE) Interfaces
 367  */
 368 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
 369
 370 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 371                                 acpi_enable_gpe(acpi_handle gpe_device,
 372                                                 u32 gpe_number))
 373
 374 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 375                                 acpi_disable_gpe(acpi_handle gpe_device,
 376                                                  u32 gpe_number))
 377
 378 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 379                                 acpi_clear_gpe(acpi_handle gpe_device,
 380                                                u32 gpe_number))
 381
 382 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 383                                 acpi_set_gpe(acpi_handle gpe_device,
 384                                              u32 gpe_number, u8 action))
 385
 386 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 387                                 acpi_finish_gpe(acpi_handle gpe_device,
 388                                                 u32 gpe_number))
 389
 390 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 391                                 acpi_setup_gpe_for_wake(acpi_handle
 392                                                         parent_device,
 393                                                         acpi_handle gpe_device,
 394                                                         u32 gpe_number))
 395 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 396                                  acpi_set_gpe_wake_mask(acpi_handle gpe_device,
 397                                                         u32 gpe_number,
 398                                                         u8 action))
 399 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 400                                  acpi_get_gpe_status(acpi_handle gpe_device,
 401                                                      u32 gpe_number,
 402                                                      acpi_event_status
 403                                                      *event_status))
 404
 405 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
 406
 407 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
 408
 409 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 410                                 acpi_get_gpe_device(u32 gpe_index,
 411                                                     acpi_handle * gpe_device))
 412
 413 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 414                                 acpi_install_gpe_block(acpi_handle gpe_device,
 415                                                        struct
 416                                                        acpi_generic_address
 417                                                        *gpe_block_address,
 418                                                        u32 register_count,
 419                                                        u32 interrupt_number))
 420 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 421                                  acpi_remove_gpe_block(acpi_handle gpe_device))
 422
 423 /*
 424  * Resource interfaces
 425  */
 426 typedef
 427 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
 428                                            void *context);
 429
 430 acpi_status
 431 acpi_get_vendor_resource(acpi_handle device,
 432                          char *name,
 433                          struct acpi_vendor_uuid *uuid,
 434                          struct acpi_buffer *ret_buffer);
 435
 436 acpi_status
 437 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
 438
 439 #ifdef ACPI_FUTURE_USAGE
 440 acpi_status
 441 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
 442 #endif
 443
 444 acpi_status
 445 acpi_get_event_resources(acpi_handle device_handle,
 446                          struct acpi_buffer *ret_buffer);
 447
 448 acpi_status
 449 acpi_walk_resource_buffer(struct acpi_buffer *buffer,
 450                           acpi_walk_resource_callback user_function,
 451                           void *context);
 452
 453 acpi_status
 454 acpi_walk_resources(acpi_handle device,
 455                     char *name,
 456                     acpi_walk_resource_callback user_function, void *context);
 457
 458 acpi_status
 459 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
 460
 461 acpi_status
 462 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
 463
 464 acpi_status
 465 acpi_resource_to_address64(struct acpi_resource *resource,
 466                            struct acpi_resource_address64 *out);
 467
 468 acpi_status
 469 acpi_buffer_to_resource(u8 *aml_buffer,
 470                         u16 aml_buffer_length,
 471                         struct acpi_resource **resource_ptr);
 472
 473 /*
 474  * Hardware (ACPI device) interfaces
 475  */
 476 acpi_status acpi_reset(void);
 477
 478 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
 479
 480 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
 481
 482 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 483                                 acpi_read_bit_register(u32 register_id,
 484                                                        u32 *return_value))
 485
 486 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 487                                 acpi_write_bit_register(u32 register_id,
 488                                                         u32 value))
 489
 490 /*
 491  * Sleep/Wake interfaces
 492  */
 493 acpi_status
 494 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
 495
 496 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
 497
 498 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
 499
 500 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void))
 501
 502 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
 503
 504 acpi_status acpi_leave_sleep_state(u8 sleep_state);
 505
 506 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 507                                 acpi_set_firmware_waking_vector(u32
 508                                                                 physical_address))
 509
 510 #if ACPI_MACHINE_WIDTH == 64
 511 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 512                                 acpi_set_firmware_waking_vector64(u64
 513                                                                   physical_address))
 514 #endif
 515 /*
 516  * ACPI Timer interfaces
 517  */
 518 #ifdef ACPI_FUTURE_USAGE
 519 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 520                                 acpi_get_timer_resolution(u32 *resolution))
 521
 522 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
 523
 524 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 525                                 acpi_get_timer_duration(u32 start_ticks,
 526                                                         u32 end_ticks,
 527                                                         u32 *time_elapsed))
 528 #endif                          /* ACPI_FUTURE_USAGE */
 529
 530 /*
 531  * Error/Warning output
 532  */
 533 void ACPI_INTERNAL_VAR_XFACE
 534 acpi_error(const char *module_name,
 535            u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 536
 537 void ACPI_INTERNAL_VAR_XFACE
 538 acpi_exception(const char *module_name,
 539                u32 line_number,
 540                acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
 541
 542 void ACPI_INTERNAL_VAR_XFACE
 543 acpi_warning(const char *module_name,
 544              u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 545
 546 void ACPI_INTERNAL_VAR_XFACE
 547 acpi_info(const char *module_name,
 548           u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 549
 550 void ACPI_INTERNAL_VAR_XFACE
 551 acpi_bios_error(const char *module_name,
 552                 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 553
 554 void ACPI_INTERNAL_VAR_XFACE
 555 acpi_bios_warning(const char *module_name,
 556                   u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 557
 558 /*
 559  * Debug output
 560  */
 561 #ifdef ACPI_DEBUG_OUTPUT
 562
 563 void ACPI_INTERNAL_VAR_XFACE
 564 acpi_debug_print(u32 requested_debug_level,
 565                  u32 line_number,
 566                  const char *function_name,
 567                  const char *module_name,
 568                  u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
 569
 570 void ACPI_INTERNAL_VAR_XFACE
 571 acpi_debug_print_raw(u32 requested_debug_level,
 572                      u32 line_number,
 573                      const char *function_name,
 574                      const char *module_name,
 575                      u32 component_id,
 576                      const char *format, ...) ACPI_PRINTF_LIKE(6);
 577 #endif
 578
 579 #endif                          /* __ACXFACE_H__ */