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