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                 0x20130725
  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 acpi_status acpi_update_interfaces(u8 action);
 151
 152 u32
 153 acpi_check_address_range(acpi_adr_space_type space_id,
 154                          acpi_physical_address address,
 155                          acpi_size length, u8 warn);
 156
 157 acpi_status
 158 acpi_decode_pld_buffer(u8 *in_buffer,
 159                        acpi_size length, struct acpi_pld_info **return_buffer);
 160
 161 /*
 162  * ACPI Memory management
 163  */
 164 void *acpi_allocate(u32 size);
 165
 166 void *acpi_callocate(u32 size);
 167
 168 void acpi_free(void *address);
 169
 170 /*
 171  * ACPI table load/unload interfaces
 172  */
 173 acpi_status acpi_load_table(struct acpi_table_header *table);
 174
 175 acpi_status acpi_unload_parent_table(acpi_handle object);
 176
 177 acpi_status acpi_load_tables(void);
 178
 179 /*
 180  * ACPI table manipulation interfaces
 181  */
 182 acpi_status acpi_reallocate_root_table(void);
 183
 184 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
 185
 186 acpi_status acpi_unload_table_id(acpi_owner_id id);
 187
 188 acpi_status
 189 acpi_get_table_header(acpi_string signature,
 190                       u32 instance, struct acpi_table_header *out_table_header);
 191
 192 acpi_status
 193 acpi_get_table_with_size(acpi_string signature,
 194                u32 instance, struct acpi_table_header **out_table,
 195                acpi_size *tbl_size);
 196 acpi_status
 197 acpi_get_table(acpi_string signature,
 198                u32 instance, struct acpi_table_header **out_table);
 199
 200 acpi_status
 201 acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table);
 202
 203 acpi_status
 204 acpi_install_table_handler(acpi_table_handler handler, void *context);
 205
 206 acpi_status acpi_remove_table_handler(acpi_table_handler handler);
 207
 208 /*
 209  * Namespace and name interfaces
 210  */
 211 acpi_status
 212 acpi_walk_namespace(acpi_object_type type,
 213                     acpi_handle start_object,
 214                     u32 max_depth,
 215                     acpi_walk_callback descending_callback,
 216                     acpi_walk_callback ascending_callback,
 217                     void *context, void **return_value);
 218
 219 acpi_status
 220 acpi_get_devices(const char *HID,
 221                  acpi_walk_callback user_function,
 222                  void *context, void **return_value);
 223
 224 acpi_status
 225 acpi_get_name(acpi_handle object,
 226               u32 name_type, struct acpi_buffer *ret_path_ptr);
 227
 228 acpi_status
 229 acpi_get_handle(acpi_handle parent,
 230                 acpi_string pathname, acpi_handle * ret_handle);
 231
 232 acpi_status
 233 acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
 234
 235 acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
 236
 237 acpi_status
 238 acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
 239
 240 acpi_status
 241 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
 242
 243 /*
 244  * Object manipulation and enumeration
 245  */
 246 acpi_status
 247 acpi_evaluate_object(acpi_handle object,
 248                      acpi_string pathname,
 249                      struct acpi_object_list *parameter_objects,
 250                      struct acpi_buffer *return_object_buffer);
 251
 252 acpi_status
 253 acpi_evaluate_object_typed(acpi_handle object,
 254                            acpi_string pathname,
 255                            struct acpi_object_list *external_params,
 256                            struct acpi_buffer *return_buffer,
 257                            acpi_object_type return_type);
 258
 259 acpi_status
 260 acpi_get_object_info(acpi_handle object,
 261                      struct acpi_device_info **return_buffer);
 262
 263 acpi_status acpi_install_method(u8 *buffer);
 264
 265 acpi_status
 266 acpi_get_next_object(acpi_object_type type,
 267                      acpi_handle parent,
 268                      acpi_handle child, acpi_handle * out_handle);
 269
 270 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
 271
 272 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
 273
 274 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
 275
 276 /*
 277  * Handler interfaces
 278  */
 279 acpi_status
 280 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
 281
 282 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 283                                 acpi_install_global_event_handler
 284                                 (acpi_gbl_event_handler handler, void *context))
 285
 286 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 287                                  acpi_install_fixed_event_handler(u32
 288                                                                   acpi_event,
 289                                                                   acpi_event_handler
 290                                                                   handler,
 291                                                                   void
 292                                                                   *context))
 293 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 294                                  acpi_remove_fixed_event_handler(u32 acpi_event,
 295                                                                  acpi_event_handler
 296                                                                  handler))
 297 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 298                                  acpi_install_gpe_handler(acpi_handle
 299                                                           gpe_device,
 300                                                           u32 gpe_number,
 301                                                           u32 type,
 302                                                           acpi_gpe_handler
 303                                                           address,
 304                                                           void *context))
 305 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 306                                  acpi_remove_gpe_handler(acpi_handle gpe_device,
 307                                                          u32 gpe_number,
 308                                                          acpi_gpe_handler
 309                                                          address))
 310 acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type,
 311                                         acpi_notify_handler handler,
 312                                         void *context);
 313
 314 acpi_status
 315 acpi_remove_notify_handler(acpi_handle device,
 316                            u32 handler_type, acpi_notify_handler handler);
 317
 318 acpi_status
 319 acpi_install_address_space_handler(acpi_handle device,
 320                                    acpi_adr_space_type space_id,
 321                                    acpi_adr_space_handler handler,
 322                                    acpi_adr_space_setup setup, void *context);
 323
 324 acpi_status
 325 acpi_remove_address_space_handler(acpi_handle device,
 326                                   acpi_adr_space_type space_id,
 327                                   acpi_adr_space_handler handler);
 328
 329 #ifdef ACPI_FUTURE_USAGE
 330 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
 331 #endif
 332
 333 acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
 334
 335 /*
 336  * Global Lock interfaces
 337  */
 338 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 339                                 acpi_acquire_global_lock(u16 timeout,
 340                                                          u32 *handle))
 341 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 342                                 acpi_release_global_lock(u32 handle))
 343
 344 /*
 345  * Interfaces to AML mutex objects
 346  */
 347 acpi_status
 348 acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
 349
 350 acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
 351
 352 /*
 353  * Fixed Event interfaces
 354  */
 355 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 356                                 acpi_enable_event(u32 event, u32 flags))
 357
 358 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 359                                 acpi_disable_event(u32 event, u32 flags))
 360
 361 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
 362
 363 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 364                                 acpi_get_event_status(u32 event,
 365                                                       acpi_event_status
 366                                                       *event_status))
 367 /*
 368  * General Purpose Event (GPE) Interfaces
 369  */
 370 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
 371
 372 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 373                                 acpi_enable_gpe(acpi_handle gpe_device,
 374                                                 u32 gpe_number))
 375
 376 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 377                                 acpi_disable_gpe(acpi_handle gpe_device,
 378                                                  u32 gpe_number))
 379
 380 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 381                                 acpi_clear_gpe(acpi_handle gpe_device,
 382                                                u32 gpe_number))
 383
 384 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 385                                 acpi_set_gpe(acpi_handle gpe_device,
 386                                              u32 gpe_number, u8 action))
 387
 388 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 389                                 acpi_finish_gpe(acpi_handle gpe_device,
 390                                                 u32 gpe_number))
 391
 392 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 393                                 acpi_setup_gpe_for_wake(acpi_handle
 394                                                         parent_device,
 395                                                         acpi_handle gpe_device,
 396                                                         u32 gpe_number))
 397 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 398                                  acpi_set_gpe_wake_mask(acpi_handle gpe_device,
 399                                                         u32 gpe_number,
 400                                                         u8 action))
 401 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 402                                  acpi_get_gpe_status(acpi_handle gpe_device,
 403                                                      u32 gpe_number,
 404                                                      acpi_event_status
 405                                                      *event_status))
 406
 407 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
 408
 409 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
 410
 411 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 412                                 acpi_get_gpe_device(u32 gpe_index,
 413                                                     acpi_handle * gpe_device))
 414
 415 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 416                                 acpi_install_gpe_block(acpi_handle gpe_device,
 417                                                        struct
 418                                                        acpi_generic_address
 419                                                        *gpe_block_address,
 420                                                        u32 register_count,
 421                                                        u32 interrupt_number))
 422 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 423                                  acpi_remove_gpe_block(acpi_handle gpe_device))
 424
 425 /*
 426  * Resource interfaces
 427  */
 428 typedef
 429 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
 430                                            void *context);
 431
 432 acpi_status
 433 acpi_get_vendor_resource(acpi_handle device,
 434                          char *name,
 435                          struct acpi_vendor_uuid *uuid,
 436                          struct acpi_buffer *ret_buffer);
 437
 438 acpi_status
 439 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
 440
 441 #ifdef ACPI_FUTURE_USAGE
 442 acpi_status
 443 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
 444 #endif
 445
 446 acpi_status
 447 acpi_get_event_resources(acpi_handle device_handle,
 448                          struct acpi_buffer *ret_buffer);
 449
 450 acpi_status
 451 acpi_walk_resource_buffer(struct acpi_buffer *buffer,
 452                           acpi_walk_resource_callback user_function,
 453                           void *context);
 454
 455 acpi_status
 456 acpi_walk_resources(acpi_handle device,
 457                     char *name,
 458                     acpi_walk_resource_callback user_function, void *context);
 459
 460 acpi_status
 461 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
 462
 463 acpi_status
 464 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
 465
 466 acpi_status
 467 acpi_resource_to_address64(struct acpi_resource *resource,
 468                            struct acpi_resource_address64 *out);
 469
 470 acpi_status
 471 acpi_buffer_to_resource(u8 *aml_buffer,
 472                         u16 aml_buffer_length,
 473                         struct acpi_resource **resource_ptr);
 474
 475 /*
 476  * Hardware (ACPI device) interfaces
 477  */
 478 acpi_status acpi_reset(void);
 479
 480 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
 481
 482 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
 483
 484 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 485                                 acpi_read_bit_register(u32 register_id,
 486                                                        u32 *return_value))
 487
 488 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 489                                 acpi_write_bit_register(u32 register_id,
 490                                                         u32 value))
 491
 492 /*
 493  * Sleep/Wake interfaces
 494  */
 495 acpi_status
 496 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
 497
 498 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
 499
 500 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
 501
 502 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void))
 503
 504 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
 505
 506 acpi_status acpi_leave_sleep_state(u8 sleep_state);
 507
 508 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 509                                 acpi_set_firmware_waking_vector(u32
 510                                                                 physical_address))
 511
 512 #if ACPI_MACHINE_WIDTH == 64
 513 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 514                                 acpi_set_firmware_waking_vector64(u64
 515                                                                   physical_address))
 516 #endif
 517 /*
 518  * ACPI Timer interfaces
 519  */
 520 #ifdef ACPI_FUTURE_USAGE
 521 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 522                                 acpi_get_timer_resolution(u32 *resolution))
 523
 524 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
 525
 526 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 527                                 acpi_get_timer_duration(u32 start_ticks,
 528                                                         u32 end_ticks,
 529                                                         u32 *time_elapsed))
 530 #endif                          /* ACPI_FUTURE_USAGE */
 531
 532 /*
 533  * Error/Warning output
 534  */
 535 void ACPI_INTERNAL_VAR_XFACE
 536 acpi_error(const char *module_name,
 537            u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 538
 539 void ACPI_INTERNAL_VAR_XFACE
 540 acpi_exception(const char *module_name,
 541                u32 line_number,
 542                acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
 543
 544 void ACPI_INTERNAL_VAR_XFACE
 545 acpi_warning(const char *module_name,
 546              u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 547
 548 void ACPI_INTERNAL_VAR_XFACE
 549 acpi_info(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_error(const char *module_name,
 554                 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 555
 556 void ACPI_INTERNAL_VAR_XFACE
 557 acpi_bios_warning(const char *module_name,
 558                   u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 559
 560 /*
 561  * Debug output
 562  */
 563 #ifdef ACPI_DEBUG_OUTPUT
 564
 565 void ACPI_INTERNAL_VAR_XFACE
 566 acpi_debug_print(u32 requested_debug_level,
 567                  u32 line_number,
 568                  const char *function_name,
 569                  const char *module_name,
 570                  u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
 571
 572 void ACPI_INTERNAL_VAR_XFACE
 573 acpi_debug_print_raw(u32 requested_debug_level,
 574                      u32 line_number,
 575                      const char *function_name,
 576                      const char *module_name,
 577                      u32 component_id,
 578                      const char *format, ...) ACPI_PRINTF_LIKE(6);
 579 #endif
 580
 581 #endif                          /* __ACXFACE_H__ */