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