include/acpi/acpixf.h

   1
   2 /******************************************************************************
   3  *
   4  * Name: acpixf.h - External interfaces to the ACPI subsystem
   5  *
   6  *****************************************************************************/
   7
   8 /*
   9  * Copyright (C) 2000 - 2012, Intel Corp.
  10  * All rights reserved.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions, and the following disclaimer,
  17  *    without modification.
  18  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  19  *    substantially similar to the "NO WARRANTY" disclaimer below
  20  *    ("Disclaimer") and any redistribution must be conditioned upon
  21  *    including a substantially similar Disclaimer requirement for further
  22  *    binary redistribution.
  23  * 3. Neither the names of the above-listed copyright holders nor the names
  24  *    of any contributors may be used to endorse or promote products derived
  25  *    from this software without specific prior written permission.
  26  *
  27  * Alternatively, this software may be distributed under the terms of the
  28  * GNU General Public License ("GPL") version 2 as published by the Free
  29  * Software Foundation.
  30  *
  31  * NO WARRANTY
  32  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  33  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  34  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  35  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  36  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  40  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  41  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  42  * POSSIBILITY OF SUCH DAMAGES.
  43  */
  44
  45 #ifndef __ACXFACE_H__
  46 #define __ACXFACE_H__
  47
  48 /* Current ACPICA subsystem version in YYYYMMDD format */
  49
  50 #define ACPI_CA_VERSION                 0x20120913
  51
  52 #include <acpi/acconfig.h>
  53 #include <acpi/actypes.h>
  54 #include <acpi/actbl.h>
  55 #include <acpi/acbuffer.h>
  56
  57 extern u8 acpi_gbl_permanent_mmap;
  58
  59 /*
  60  * Globals that are publicly available, allowing for
  61  * run time configuration
  62  */
  63 extern u32 acpi_dbg_level;
  64 extern u32 acpi_dbg_layer;
  65 extern u8 acpi_gbl_enable_interpreter_slack;
  66 extern u8 acpi_gbl_all_methods_serialized;
  67 extern u8 acpi_gbl_create_osi_method;
  68 extern u8 acpi_gbl_use_default_register_widths;
  69 extern acpi_name acpi_gbl_trace_method_name;
  70 extern u32 acpi_gbl_trace_flags;
  71 extern bool acpi_gbl_enable_aml_debug_object;
  72 extern u8 acpi_gbl_copy_dsdt_locally;
  73 extern u8 acpi_gbl_truncate_io_addresses;
  74 extern u8 acpi_gbl_disable_auto_repair;
  75
  76 /*
  77  * Hardware-reduced prototypes. All interfaces that use these macros will
  78  * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
  79  * is set to TRUE.
  80  */
  81 #if (!ACPI_REDUCED_HARDWARE)
  82 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
  83         prototype;
  84
  85 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
  86         prototype;
  87
  88 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
  89         prototype;
  90
  91 #else
  92 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
  93         static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
  94
  95 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
  96         static ACPI_INLINE prototype {return(AE_OK);}
  97
  98 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
  99         static ACPI_INLINE prototype {}
 100
 101 #endif                          /* !ACPI_REDUCED_HARDWARE */
 102
 103 extern u32 acpi_current_gpe_count;
 104 extern struct acpi_table_fadt acpi_gbl_FADT;
 105 extern u8 acpi_gbl_system_awake_and_running;
 106 extern u8 acpi_gbl_reduced_hardware;    /* ACPI 5.0 */
 107
 108 extern u32 acpi_rsdt_forced;
 109 /*
 110  * Global interfaces
 111  */
 112 acpi_status
 113 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
 114                        u32 initial_table_count, u8 allow_resize);
 115
 116 acpi_status __init acpi_initialize_subsystem(void);
 117
 118 acpi_status acpi_enable_subsystem(u32 flags);
 119
 120 acpi_status acpi_initialize_objects(u32 flags);
 121
 122 acpi_status acpi_terminate(void);
 123
 124 #ifdef ACPI_FUTURE_USAGE
 125 acpi_status acpi_subsystem_status(void);
 126 #endif
 127
 128 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
 129 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
 130
 131 #ifdef ACPI_FUTURE_USAGE
 132 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
 133 #endif
 134
 135 const char *acpi_format_exception(acpi_status exception);
 136
 137 acpi_status acpi_purge_cached_objects(void);
 138
 139 acpi_status acpi_install_interface(acpi_string interface_name);
 140
 141 acpi_status acpi_remove_interface(acpi_string interface_name);
 142
 143 u32
 144 acpi_check_address_range(acpi_adr_space_type space_id,
 145                          acpi_physical_address address,
 146                          acpi_size length, u8 warn);
 147
 148 acpi_status
 149 acpi_decode_pld_buffer(u8 *in_buffer,
 150                        acpi_size length, struct acpi_pld_info **return_buffer);
 151
 152 /*
 153  * ACPI Memory management
 154  */
 155 void *acpi_allocate(u32 size);
 156
 157 void *acpi_callocate(u32 size);
 158
 159 void acpi_free(void *address);
 160
 161 /*
 162  * ACPI table load/unload interfaces
 163  */
 164 acpi_status acpi_load_table(struct acpi_table_header *table);
 165
 166 acpi_status acpi_unload_parent_table(acpi_handle object);
 167
 168 acpi_status acpi_load_tables(void);
 169
 170 /*
 171  * ACPI table manipulation interfaces
 172  */
 173 acpi_status acpi_reallocate_root_table(void);
 174
 175 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
 176
 177 acpi_status acpi_unload_table_id(acpi_owner_id id);
 178
 179 acpi_status
 180 acpi_get_table_header(acpi_string signature,
 181                       u32 instance, struct acpi_table_header *out_table_header);
 182
 183 acpi_status
 184 acpi_get_table_with_size(acpi_string signature,
 185                u32 instance, struct acpi_table_header **out_table,
 186                acpi_size *tbl_size);
 187 acpi_status
 188 acpi_get_table(acpi_string signature,
 189                u32 instance, struct acpi_table_header **out_table);
 190
 191 acpi_status
 192 acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table);
 193
 194 acpi_status
 195 acpi_install_table_handler(acpi_tbl_handler handler, void *context);
 196
 197 acpi_status acpi_remove_table_handler(acpi_tbl_handler handler);
 198
 199 /*
 200  * Namespace and name interfaces
 201  */
 202 acpi_status
 203 acpi_walk_namespace(acpi_object_type type,
 204                     acpi_handle start_object,
 205                     u32 max_depth,
 206                     acpi_walk_callback pre_order_visit,
 207                     acpi_walk_callback post_order_visit,
 208                     void *context, void **return_value);
 209
 210 acpi_status
 211 acpi_get_devices(const char *HID,
 212                  acpi_walk_callback user_function,
 213                  void *context, void **return_value);
 214
 215 acpi_status
 216 acpi_get_name(acpi_handle object,
 217               u32 name_type, struct acpi_buffer *ret_path_ptr);
 218
 219 acpi_status
 220 acpi_get_handle(acpi_handle parent,
 221                 acpi_string pathname, acpi_handle * ret_handle);
 222
 223 acpi_status
 224 acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
 225
 226 acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
 227
 228 acpi_status
 229 acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
 230
 231 acpi_status
 232 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
 233
 234 /*
 235  * Object manipulation and enumeration
 236  */
 237 acpi_status
 238 acpi_evaluate_object(acpi_handle object,
 239                      acpi_string pathname,
 240                      struct acpi_object_list *parameter_objects,
 241                      struct acpi_buffer *return_object_buffer);
 242
 243 acpi_status
 244 acpi_evaluate_object_typed(acpi_handle object,
 245                            acpi_string pathname,
 246                            struct acpi_object_list *external_params,
 247                            struct acpi_buffer *return_buffer,
 248                            acpi_object_type return_type);
 249
 250 acpi_status
 251 acpi_get_object_info(acpi_handle object,
 252                      struct acpi_device_info **return_buffer);
 253
 254 acpi_status acpi_install_method(u8 *buffer);
 255
 256 acpi_status
 257 acpi_get_next_object(acpi_object_type type,
 258                      acpi_handle parent,
 259                      acpi_handle child, acpi_handle * out_handle);
 260
 261 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
 262
 263 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
 264
 265 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
 266
 267 /*
 268  * Handler interfaces
 269  */
 270 acpi_status
 271 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
 272
 273 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 274                                 acpi_install_global_event_handler
 275                                 (acpi_gbl_event_handler handler, void *context))
 276
 277 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 278                                  acpi_install_fixed_event_handler(u32
 279                                                                   acpi_event,
 280                                                                   acpi_event_handler
 281                                                                   handler,
 282                                                                   void
 283                                                                   *context))
 284 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 285                                  acpi_remove_fixed_event_handler(u32 acpi_event,
 286                                                                  acpi_event_handler
 287                                                                  handler))
 288 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 289                                  acpi_install_gpe_handler(acpi_handle
 290                                                           gpe_device,
 291                                                           u32 gpe_number,
 292                                                           u32 type,
 293                                                           acpi_gpe_handler
 294                                                           address,
 295                                                           void *context))
 296 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 297                                  acpi_remove_gpe_handler(acpi_handle gpe_device,
 298                                                          u32 gpe_number,
 299                                                          acpi_gpe_handler
 300                                                          address))
 301 acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type,
 302                                         acpi_notify_handler handler,
 303                                         void *context);
 304
 305 acpi_status
 306 acpi_remove_notify_handler(acpi_handle device,
 307                            u32 handler_type, acpi_notify_handler handler);
 308
 309 acpi_status
 310 acpi_install_address_space_handler(acpi_handle device,
 311                                    acpi_adr_space_type space_id,
 312                                    acpi_adr_space_handler handler,
 313                                    acpi_adr_space_setup setup, void *context);
 314
 315 acpi_status
 316 acpi_remove_address_space_handler(acpi_handle device,
 317                                   acpi_adr_space_type space_id,
 318                                   acpi_adr_space_handler handler);
 319
 320 #ifdef ACPI_FUTURE_USAGE
 321 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
 322 #endif
 323
 324 acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
 325
 326 /*
 327  * Global Lock interfaces
 328  */
 329 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 330                                 acpi_acquire_global_lock(u16 timeout,
 331                                                          u32 *handle))
 332 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 333                                 acpi_release_global_lock(u32 handle))
 334
 335 /*
 336  * Interfaces to AML mutex objects
 337  */
 338 acpi_status
 339 acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
 340
 341 acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
 342
 343 /*
 344  * Fixed Event interfaces
 345  */
 346 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 347                                 acpi_enable_event(u32 event, u32 flags))
 348
 349 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 350                                 acpi_disable_event(u32 event, u32 flags))
 351
 352 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
 353
 354 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 355                                 acpi_get_event_status(u32 event,
 356                                                       acpi_event_status
 357                                                       *event_status))
 358 /*
 359  * General Purpose Event (GPE) Interfaces
 360  */
 361 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
 362
 363 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 364                                 acpi_enable_gpe(acpi_handle gpe_device,
 365                                                 u32 gpe_number))
 366
 367 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 368                                 acpi_disable_gpe(acpi_handle gpe_device,
 369                                                  u32 gpe_number))
 370
 371 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 372                                 acpi_clear_gpe(acpi_handle gpe_device,
 373                                                u32 gpe_number))
 374
 375 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 376                                 acpi_set_gpe(acpi_handle gpe_device,
 377                                              u32 gpe_number, u8 action))
 378
 379 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 380                                 acpi_finish_gpe(acpi_handle gpe_device,
 381                                                 u32 gpe_number))
 382
 383 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 384                                 acpi_setup_gpe_for_wake(acpi_handle
 385                                                         parent_device,
 386                                                         acpi_handle gpe_device,
 387                                                         u32 gpe_number))
 388 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 389                                  acpi_set_gpe_wake_mask(acpi_handle gpe_device,
 390                                                         u32 gpe_number,
 391                                                         u8 action))
 392 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 393                                  acpi_get_gpe_status(acpi_handle gpe_device,
 394                                                      u32 gpe_number,
 395                                                      acpi_event_status
 396                                                      *event_status))
 397
 398 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
 399
 400 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
 401
 402 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 403                                 acpi_get_gpe_device(u32 gpe_index,
 404                                                     acpi_handle * gpe_device))
 405
 406 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 407                                 acpi_install_gpe_block(acpi_handle gpe_device,
 408                                                        struct
 409                                                        acpi_generic_address
 410                                                        *gpe_block_address,
 411                                                        u32 register_count,
 412                                                        u32 interrupt_number))
 413 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 414                                  acpi_remove_gpe_block(acpi_handle gpe_device))
 415
 416 /*
 417  * Resource interfaces
 418  */
 419 typedef
 420 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
 421                                            void *context);
 422
 423 acpi_status
 424 acpi_get_vendor_resource(acpi_handle device,
 425                          char *name,
 426                          struct acpi_vendor_uuid *uuid,
 427                          struct acpi_buffer *ret_buffer);
 428
 429 acpi_status
 430 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
 431
 432 #ifdef ACPI_FUTURE_USAGE
 433 acpi_status
 434 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
 435 #endif
 436
 437 acpi_status
 438 acpi_get_event_resources(acpi_handle device_handle,
 439                          struct acpi_buffer *ret_buffer);
 440
 441 acpi_status
 442 acpi_walk_resources(acpi_handle device,
 443                     char *name,
 444                     acpi_walk_resource_callback user_function, void *context);
 445
 446 acpi_status
 447 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
 448
 449 acpi_status
 450 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
 451
 452 acpi_status
 453 acpi_resource_to_address64(struct acpi_resource *resource,
 454                            struct acpi_resource_address64 *out);
 455
 456 acpi_status
 457 acpi_buffer_to_resource(u8 *aml_buffer,
 458                         u16 aml_buffer_length,
 459                         struct acpi_resource **resource_ptr);
 460
 461 /*
 462  * Hardware (ACPI device) interfaces
 463  */
 464 acpi_status acpi_reset(void);
 465
 466 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 467                                 acpi_read_bit_register(u32 register_id,
 468                                                        u32 *return_value))
 469
 470 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 471                                 acpi_write_bit_register(u32 register_id,
 472                                                         u32 value))
 473
 474 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 475                                 acpi_set_firmware_waking_vector(u32
 476                                                                 physical_address))
 477
 478 #if ACPI_MACHINE_WIDTH == 64
 479 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 480                                 acpi_set_firmware_waking_vector64(u64
 481                                                                   physical_address))
 482 #endif
 483
 484 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
 485
 486 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
 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 /*
 505  * ACPI Timer interfaces
 506  */
 507 #ifdef ACPI_FUTURE_USAGE
 508 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 509                                 acpi_get_timer_resolution(u32 *resolution))
 510
 511 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
 512
 513 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 514                                 acpi_get_timer_duration(u32 start_ticks,
 515                                                         u32 end_ticks,
 516                                                         u32 *time_elapsed))
 517 #endif                          /* ACPI_FUTURE_USAGE */
 518
 519 /*
 520  * Error/Warning output
 521  */
 522 void ACPI_INTERNAL_VAR_XFACE
 523 acpi_error(const char *module_name,
 524            u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 525
 526 void ACPI_INTERNAL_VAR_XFACE
 527 acpi_exception(const char *module_name,
 528                u32 line_number,
 529                acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
 530
 531 void ACPI_INTERNAL_VAR_XFACE
 532 acpi_warning(const char *module_name,
 533              u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 534
 535 void ACPI_INTERNAL_VAR_XFACE
 536 acpi_info(const char *module_name,
 537           u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 538
 539 void ACPI_INTERNAL_VAR_XFACE
 540 acpi_bios_error(const char *module_name,
 541                 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 542
 543 void ACPI_INTERNAL_VAR_XFACE
 544 acpi_bios_warning(const char *module_name,
 545                   u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 546
 547 /*
 548  * Debug output
 549  */
 550 #ifdef ACPI_DEBUG_OUTPUT
 551
 552 void ACPI_INTERNAL_VAR_XFACE
 553 acpi_debug_print(u32 requested_debug_level,
 554                  u32 line_number,
 555                  const char *function_name,
 556                  const char *module_name,
 557                  u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
 558
 559 void ACPI_INTERNAL_VAR_XFACE
 560 acpi_debug_print_raw(u32 requested_debug_level,
 561                      u32 line_number,
 562                      const char *function_name,
 563                      const char *module_name,
 564                      u32 component_id,
 565                      const char *format, ...) ACPI_PRINTF_LIKE(6);
 566 #endif
 567
 568 #endif                          /* __ACXFACE_H__ */