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 - 2011, 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                 0x20120111
  51
  52 #include "actypes.h"
  53 #include "actbl.h"
  54
  55 extern u8 acpi_gbl_permanent_mmap;
  56
  57 /*
  58  * Globals that are publicly available, allowing for
  59  * run time configuration
  60  */
  61 extern u32 acpi_dbg_level;
  62 extern u32 acpi_dbg_layer;
  63 extern u8 acpi_gbl_enable_interpreter_slack;
  64 extern u8 acpi_gbl_all_methods_serialized;
  65 extern u8 acpi_gbl_create_osi_method;
  66 extern u8 acpi_gbl_use_default_register_widths;
  67 extern acpi_name acpi_gbl_trace_method_name;
  68 extern u32 acpi_gbl_trace_flags;
  69 extern bool acpi_gbl_enable_aml_debug_object;
  70 extern u8 acpi_gbl_copy_dsdt_locally;
  71 extern u8 acpi_gbl_truncate_io_addresses;
  72 extern u8 acpi_gbl_disable_auto_repair;
  73
  74 extern u32 acpi_current_gpe_count;
  75 extern struct acpi_table_fadt acpi_gbl_FADT;
  76 extern u8 acpi_gbl_system_awake_and_running;
  77 extern u8 acpi_gbl_reduced_hardware;    /* ACPI 5.0 */
  78
  79 extern u32 acpi_rsdt_forced;
  80 /*
  81  * Global interfaces
  82  */
  83 acpi_status
  84 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
  85                        u32 initial_table_count, u8 allow_resize);
  86
  87 acpi_status __init acpi_initialize_subsystem(void);
  88
  89 acpi_status acpi_enable_subsystem(u32 flags);
  90
  91 acpi_status acpi_initialize_objects(u32 flags);
  92
  93 acpi_status acpi_terminate(void);
  94
  95 #ifdef ACPI_FUTURE_USAGE
  96 acpi_status acpi_subsystem_status(void);
  97 #endif
  98
  99 acpi_status acpi_enable(void);
 100
 101 acpi_status acpi_disable(void);
 102
 103 #ifdef ACPI_FUTURE_USAGE
 104 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
 105 #endif
 106
 107 const char *acpi_format_exception(acpi_status exception);
 108
 109 acpi_status acpi_purge_cached_objects(void);
 110
 111 acpi_status acpi_install_interface(acpi_string interface_name);
 112
 113 acpi_status acpi_remove_interface(acpi_string interface_name);
 114
 115 u32
 116 acpi_check_address_range(acpi_adr_space_type space_id,
 117                          acpi_physical_address address,
 118                          acpi_size length, u8 warn);
 119
 120 /*
 121  * ACPI Memory management
 122  */
 123 void *acpi_allocate(u32 size);
 124
 125 void *acpi_callocate(u32 size);
 126
 127 void acpi_free(void *address);
 128
 129 /*
 130  * ACPI table manipulation interfaces
 131  */
 132 acpi_status acpi_reallocate_root_table(void);
 133
 134 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
 135
 136 acpi_status acpi_load_tables(void);
 137
 138 acpi_status acpi_load_table(struct acpi_table_header *table_ptr);
 139
 140 acpi_status acpi_unload_table_id(acpi_owner_id id);
 141
 142 acpi_status
 143 acpi_get_table_header(acpi_string signature,
 144                       u32 instance,
 145                       struct acpi_table_header *out_table_header);
 146
 147 acpi_status
 148 acpi_get_table_with_size(acpi_string signature,
 149                u32 instance, struct acpi_table_header **out_table,
 150                acpi_size *tbl_size);
 151 acpi_status
 152 acpi_get_table(acpi_string signature,
 153                u32 instance, struct acpi_table_header **out_table);
 154
 155 acpi_status
 156 acpi_get_table_by_index(u32 table_index,
 157                         struct acpi_table_header **out_table);
 158
 159 acpi_status
 160 acpi_install_table_handler(acpi_tbl_handler handler, void *context);
 161
 162 acpi_status acpi_remove_table_handler(acpi_tbl_handler handler);
 163
 164 /*
 165  * Namespace and name interfaces
 166  */
 167 acpi_status
 168 acpi_walk_namespace(acpi_object_type type,
 169                     acpi_handle start_object,
 170                     u32 max_depth,
 171                     acpi_walk_callback pre_order_visit,
 172                     acpi_walk_callback post_order_visit,
 173                     void *context, void **return_value);
 174
 175 acpi_status
 176 acpi_get_devices(const char *HID,
 177                  acpi_walk_callback user_function,
 178                  void *context, void **return_value);
 179
 180 acpi_status
 181 acpi_get_name(acpi_handle object,
 182               u32 name_type, struct acpi_buffer *ret_path_ptr);
 183
 184 acpi_status
 185 acpi_get_handle(acpi_handle parent,
 186                 acpi_string pathname, acpi_handle * ret_handle);
 187
 188 acpi_status
 189 acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
 190
 191 acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
 192
 193 acpi_status
 194 acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
 195
 196 acpi_status
 197 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
 198
 199 /*
 200  * Object manipulation and enumeration
 201  */
 202 acpi_status
 203 acpi_evaluate_object(acpi_handle object,
 204                      acpi_string pathname,
 205                      struct acpi_object_list *parameter_objects,
 206                      struct acpi_buffer *return_object_buffer);
 207
 208 acpi_status
 209 acpi_evaluate_object_typed(acpi_handle object,
 210                            acpi_string pathname,
 211                            struct acpi_object_list *external_params,
 212                            struct acpi_buffer *return_buffer,
 213                            acpi_object_type return_type);
 214
 215 acpi_status
 216 acpi_get_object_info(acpi_handle object,
 217                      struct acpi_device_info **return_buffer);
 218
 219 acpi_status acpi_install_method(u8 *buffer);
 220
 221 acpi_status
 222 acpi_get_next_object(acpi_object_type type,
 223                      acpi_handle parent,
 224                      acpi_handle child, acpi_handle * out_handle);
 225
 226 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
 227
 228 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
 229
 230 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
 231
 232 /*
 233  * Handler interfaces
 234  */
 235 acpi_status
 236 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
 237
 238 acpi_status
 239 acpi_install_global_event_handler(ACPI_GBL_EVENT_HANDLER handler,
 240                                  void *context);
 241
 242 acpi_status
 243 acpi_install_fixed_event_handler(u32 acpi_event,
 244                                  acpi_event_handler handler, void *context);
 245
 246 acpi_status
 247 acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
 248
 249 acpi_status
 250 acpi_install_notify_handler(acpi_handle device,
 251                             u32 handler_type,
 252                             acpi_notify_handler handler, void *context);
 253
 254 acpi_status
 255 acpi_remove_notify_handler(acpi_handle device,
 256                            u32 handler_type, acpi_notify_handler handler);
 257
 258 acpi_status
 259 acpi_install_address_space_handler(acpi_handle device,
 260                                    acpi_adr_space_type space_id,
 261                                    acpi_adr_space_handler handler,
 262                                    acpi_adr_space_setup setup, void *context);
 263
 264 acpi_status
 265 acpi_remove_address_space_handler(acpi_handle device,
 266                                   acpi_adr_space_type space_id,
 267                                   acpi_adr_space_handler handler);
 268
 269 acpi_status
 270 acpi_install_gpe_handler(acpi_handle gpe_device,
 271                          u32 gpe_number,
 272                          u32 type, acpi_gpe_handler address, void *context);
 273
 274 acpi_status
 275 acpi_remove_gpe_handler(acpi_handle gpe_device,
 276                         u32 gpe_number, acpi_gpe_handler address);
 277
 278 #ifdef ACPI_FUTURE_USAGE
 279 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
 280 #endif
 281
 282 acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
 283
 284 /*
 285  * Global Lock interfaces
 286  */
 287 acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle);
 288
 289 acpi_status acpi_release_global_lock(u32 handle);
 290
 291 /*
 292  * Interfaces to AML mutex objects
 293  */
 294 acpi_status
 295 acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
 296
 297 acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
 298
 299 /*
 300  * Fixed Event interfaces
 301  */
 302 acpi_status acpi_enable_event(u32 event, u32 flags);
 303
 304 acpi_status acpi_disable_event(u32 event, u32 flags);
 305
 306 acpi_status acpi_clear_event(u32 event);
 307
 308 acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status);
 309
 310 /*
 311  * General Purpose Event (GPE) Interfaces
 312  */
 313 acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number);
 314
 315 acpi_status acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number);
 316
 317 acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number);
 318
 319 acpi_status
 320 acpi_setup_gpe_for_wake(acpi_handle parent_device,
 321                         acpi_handle gpe_device, u32 gpe_number);
 322
 323 acpi_status acpi_set_gpe_wake_mask(acpi_handle gpe_device, u32 gpe_number, u8 action);
 324
 325 acpi_status
 326 acpi_get_gpe_status(acpi_handle gpe_device,
 327                     u32 gpe_number, acpi_event_status *event_status);
 328
 329 acpi_status acpi_disable_all_gpes(void);
 330
 331 acpi_status acpi_enable_all_runtime_gpes(void);
 332
 333 acpi_status acpi_get_gpe_device(u32 gpe_index, acpi_handle *gpe_device);
 334
 335 acpi_status
 336 acpi_install_gpe_block(acpi_handle gpe_device,
 337                        struct acpi_generic_address *gpe_block_address,
 338                        u32 register_count, u32 interrupt_number);
 339
 340 acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
 341
 342 acpi_status acpi_update_all_gpes(void);
 343
 344 /*
 345  * Resource interfaces
 346  */
 347 typedef
 348 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
 349                                            void *context);
 350
 351 acpi_status
 352 acpi_get_vendor_resource(acpi_handle device,
 353                          char *name,
 354                          struct acpi_vendor_uuid *uuid,
 355                          struct acpi_buffer *ret_buffer);
 356
 357 acpi_status
 358 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
 359
 360 #ifdef ACPI_FUTURE_USAGE
 361 acpi_status
 362 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
 363 #endif
 364
 365 acpi_status
 366 acpi_get_event_resources(acpi_handle device_handle,
 367                          struct acpi_buffer *ret_buffer);
 368
 369 acpi_status
 370 acpi_walk_resources(acpi_handle device,
 371                     char *name,
 372                     acpi_walk_resource_callback user_function, void *context);
 373
 374 acpi_status
 375 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
 376
 377 acpi_status
 378 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
 379
 380 acpi_status
 381 acpi_resource_to_address64(struct acpi_resource *resource,
 382                            struct acpi_resource_address64 *out);
 383
 384 acpi_status
 385 acpi_buffer_to_resource(u8 *aml_buffer,
 386                         u16 aml_buffer_length,
 387                         struct acpi_resource **resource_ptr);
 388
 389 /*
 390  * Hardware (ACPI device) interfaces
 391  */
 392 acpi_status acpi_reset(void);
 393
 394 acpi_status acpi_read_bit_register(u32 register_id, u32 *return_value);
 395
 396 acpi_status acpi_write_bit_register(u32 register_id, u32 value);
 397
 398 acpi_status acpi_set_firmware_waking_vector(u32 physical_address);
 399
 400 #if ACPI_MACHINE_WIDTH == 64
 401 acpi_status acpi_set_firmware_waking_vector64(u64 physical_address);
 402 #endif
 403
 404 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
 405
 406 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
 407
 408 acpi_status
 409 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
 410
 411 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
 412
 413 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
 414
 415 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
 416
 417 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
 418
 419 acpi_status acpi_leave_sleep_state(u8 sleep_state);
 420
 421 /*
 422  * Error/Warning output
 423  */
 424 void ACPI_INTERNAL_VAR_XFACE
 425 acpi_error(const char *module_name,
 426            u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 427
 428 void ACPI_INTERNAL_VAR_XFACE
 429 acpi_exception(const char *module_name,
 430                u32 line_number,
 431                acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
 432
 433 void ACPI_INTERNAL_VAR_XFACE
 434 acpi_warning(const char *module_name,
 435              u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 436
 437 void ACPI_INTERNAL_VAR_XFACE
 438 acpi_info(const char *module_name,
 439           u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 440
 441 /*
 442  * Debug output
 443  */
 444 #ifdef ACPI_DEBUG_OUTPUT
 445
 446 void ACPI_INTERNAL_VAR_XFACE
 447 acpi_debug_print(u32 requested_debug_level,
 448                  u32 line_number,
 449                  const char *function_name,
 450                  const char *module_name,
 451                  u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
 452
 453 void ACPI_INTERNAL_VAR_XFACE
 454 acpi_debug_print_raw(u32 requested_debug_level,
 455                      u32 line_number,
 456                      const char *function_name,
 457                      const char *module_name,
 458                      u32 component_id,
 459                      const char *format, ...) ACPI_PRINTF_LIKE(6);
 460 #endif
 461
 462 #endif                          /* __ACXFACE_H__ */