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