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