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