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