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