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