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