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