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