Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | |
2 | /****************************************************************************** | |
3 | * | |
4 | * Name: acpixf.h - External interfaces to the ACPI subsystem | |
5 | * | |
6 | *****************************************************************************/ | |
7 | ||
8 | /* | |
75a44ce0 | 9 | * Copyright (C) 2000 - 2008, Intel Corp. |
1da177e4 LT |
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 | ||
1da177e4 LT |
45 | #ifndef __ACXFACE_H__ |
46 | #define __ACXFACE_H__ | |
47 | ||
50df4d8b BM |
48 | /* Current ACPICA subsystem version in YYYYMMDD format */ |
49 | ||
50 | #define ACPI_CA_VERSION 0x20081031 | |
51 | ||
1da177e4 LT |
52 | #include "actypes.h" |
53 | #include "actbl.h" | |
54 | ||
889c78be LM |
55 | extern u8 acpi_gbl_permanent_mmap; |
56 | ||
50df4d8b BM |
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 | ||
44f6c012 | 73 | /* |
1da177e4 LT |
74 | * Global interfaces |
75 | */ | |
f3d2e786 BM |
76 | acpi_status |
77 | acpi_initialize_tables(struct acpi_table_desc *initial_storage, | |
78 | u32 initial_table_count, u8 allow_resize); | |
79 | ||
dd272b57 | 80 | acpi_status __init acpi_initialize_subsystem(void); |
1da177e4 | 81 | |
4be44fcd | 82 | acpi_status acpi_enable_subsystem(u32 flags); |
1da177e4 | 83 | |
4be44fcd | 84 | acpi_status acpi_initialize_objects(u32 flags); |
1da177e4 | 85 | |
4be44fcd | 86 | acpi_status acpi_terminate(void); |
1da177e4 LT |
87 | |
88 | #ifdef ACPI_FUTURE_USAGE | |
4be44fcd | 89 | acpi_status acpi_subsystem_status(void); |
1da177e4 LT |
90 | #endif |
91 | ||
4be44fcd | 92 | acpi_status acpi_enable(void); |
1da177e4 | 93 | |
4be44fcd | 94 | acpi_status acpi_disable(void); |
1da177e4 LT |
95 | |
96 | #ifdef ACPI_FUTURE_USAGE | |
4be44fcd | 97 | acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer); |
1da177e4 LT |
98 | #endif |
99 | ||
4be44fcd | 100 | const char *acpi_format_exception(acpi_status exception); |
1da177e4 | 101 | |
4be44fcd | 102 | acpi_status acpi_purge_cached_objects(void); |
1da177e4 | 103 | |
1da177e4 | 104 | /* |
aee07ba6 | 105 | * ACPI Memory management |
1da177e4 | 106 | */ |
4be44fcd | 107 | void *acpi_allocate(u32 size); |
1da177e4 | 108 | |
4be44fcd | 109 | void *acpi_callocate(u32 size); |
1da177e4 | 110 | |
4be44fcd | 111 | void acpi_free(void *address); |
1da177e4 LT |
112 | |
113 | /* | |
114 | * ACPI table manipulation interfaces | |
115 | */ | |
f3d2e786 BM |
116 | acpi_status acpi_reallocate_root_table(void); |
117 | ||
67a119f9 | 118 | acpi_status acpi_find_root_pointer(acpi_size *rsdp_address); |
1da177e4 | 119 | |
4be44fcd | 120 | acpi_status acpi_load_tables(void); |
1da177e4 | 121 | |
4be44fcd | 122 | acpi_status acpi_load_table(struct acpi_table_header *table_ptr); |
1da177e4 | 123 | |
f3d2e786 | 124 | acpi_status acpi_unload_table_id(acpi_owner_id id); |
1da177e4 LT |
125 | |
126 | acpi_status | |
f3d2e786 | 127 | acpi_get_table_header(acpi_string signature, |
67a119f9 | 128 | u32 instance, |
428f2112 | 129 | struct acpi_table_header *out_table_header); |
1da177e4 LT |
130 | |
131 | acpi_status | |
f3d2e786 | 132 | acpi_get_table(acpi_string signature, |
67a119f9 | 133 | u32 instance, struct acpi_table_header **out_table); |
1da177e4 LT |
134 | |
135 | acpi_status | |
67a119f9 | 136 | acpi_get_table_by_index(u32 table_index, |
f3d2e786 | 137 | struct acpi_table_header **out_table); |
1da177e4 | 138 | |
3e08e2d2 LM |
139 | acpi_status |
140 | acpi_install_table_handler(acpi_tbl_handler handler, void *context); | |
141 | ||
142 | acpi_status acpi_remove_table_handler(acpi_tbl_handler handler); | |
143 | ||
1da177e4 LT |
144 | /* |
145 | * Namespace and name interfaces | |
146 | */ | |
1da177e4 | 147 | acpi_status |
4be44fcd LB |
148 | acpi_walk_namespace(acpi_object_type type, |
149 | acpi_handle start_object, | |
150 | u32 max_depth, | |
151 | acpi_walk_callback user_function, | |
152 | void *context, void **return_value); | |
1da177e4 LT |
153 | |
154 | acpi_status | |
70b30fb1 | 155 | acpi_get_devices(const char *HID, |
4be44fcd LB |
156 | acpi_walk_callback user_function, |
157 | void *context, void **return_value); | |
1da177e4 LT |
158 | |
159 | acpi_status | |
4be44fcd LB |
160 | acpi_get_name(acpi_handle handle, |
161 | u32 name_type, struct acpi_buffer *ret_path_ptr); | |
1da177e4 LT |
162 | |
163 | acpi_status | |
4be44fcd LB |
164 | acpi_get_handle(acpi_handle parent, |
165 | acpi_string pathname, acpi_handle * ret_handle); | |
1da177e4 LT |
166 | |
167 | acpi_status | |
4be44fcd LB |
168 | acpi_attach_data(acpi_handle obj_handle, |
169 | acpi_object_handler handler, void *data); | |
1da177e4 LT |
170 | |
171 | acpi_status | |
4be44fcd | 172 | acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler); |
1da177e4 LT |
173 | |
174 | acpi_status | |
4be44fcd | 175 | acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data); |
1da177e4 | 176 | |
50eca3eb BM |
177 | acpi_status |
178 | acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags); | |
179 | ||
1da177e4 LT |
180 | /* |
181 | * Object manipulation and enumeration | |
182 | */ | |
1da177e4 | 183 | acpi_status |
4be44fcd LB |
184 | acpi_evaluate_object(acpi_handle object, |
185 | acpi_string pathname, | |
186 | struct acpi_object_list *parameter_objects, | |
187 | struct acpi_buffer *return_object_buffer); | |
1da177e4 LT |
188 | |
189 | #ifdef ACPI_FUTURE_USAGE | |
190 | acpi_status | |
4be44fcd LB |
191 | acpi_evaluate_object_typed(acpi_handle object, |
192 | acpi_string pathname, | |
193 | struct acpi_object_list *external_params, | |
194 | struct acpi_buffer *return_buffer, | |
195 | acpi_object_type return_type); | |
1da177e4 LT |
196 | #endif |
197 | ||
198 | acpi_status | |
4be44fcd | 199 | acpi_get_object_info(acpi_handle handle, struct acpi_buffer *return_buffer); |
1da177e4 LT |
200 | |
201 | acpi_status | |
4be44fcd LB |
202 | acpi_get_next_object(acpi_object_type type, |
203 | acpi_handle parent, | |
204 | acpi_handle child, acpi_handle * out_handle); | |
1da177e4 | 205 | |
4be44fcd | 206 | acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type); |
1da177e4 | 207 | |
0f0fe1a0 JK |
208 | acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type); |
209 | ||
4be44fcd | 210 | acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle); |
1da177e4 LT |
211 | |
212 | /* | |
ecfbbc7b | 213 | * Handler interfaces |
1da177e4 | 214 | */ |
ecfbbc7b BM |
215 | acpi_status |
216 | acpi_install_initialization_handler(acpi_init_handler handler, u32 function); | |
217 | ||
1da177e4 | 218 | acpi_status |
4be44fcd LB |
219 | acpi_install_fixed_event_handler(u32 acpi_event, |
220 | acpi_event_handler handler, void *context); | |
1da177e4 LT |
221 | |
222 | acpi_status | |
4be44fcd | 223 | acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler); |
1da177e4 LT |
224 | |
225 | acpi_status | |
4be44fcd LB |
226 | acpi_install_notify_handler(acpi_handle device, |
227 | u32 handler_type, | |
228 | acpi_notify_handler handler, void *context); | |
1da177e4 LT |
229 | |
230 | acpi_status | |
4be44fcd LB |
231 | acpi_remove_notify_handler(acpi_handle device, |
232 | u32 handler_type, acpi_notify_handler handler); | |
1da177e4 LT |
233 | |
234 | acpi_status | |
4be44fcd LB |
235 | acpi_install_address_space_handler(acpi_handle device, |
236 | acpi_adr_space_type space_id, | |
237 | acpi_adr_space_handler handler, | |
238 | acpi_adr_space_setup setup, void *context); | |
1da177e4 LT |
239 | |
240 | acpi_status | |
4be44fcd LB |
241 | acpi_remove_address_space_handler(acpi_handle device, |
242 | acpi_adr_space_type space_id, | |
243 | acpi_adr_space_handler handler); | |
1da177e4 LT |
244 | |
245 | acpi_status | |
4be44fcd LB |
246 | acpi_install_gpe_handler(acpi_handle gpe_device, |
247 | u32 gpe_number, | |
248 | u32 type, acpi_event_handler address, void *context); | |
1da177e4 | 249 | |
08ac07b8 BM |
250 | acpi_status |
251 | acpi_remove_gpe_handler(acpi_handle gpe_device, | |
252 | u32 gpe_number, acpi_event_handler address); | |
253 | ||
1da177e4 | 254 | #ifdef ACPI_FUTURE_USAGE |
4be44fcd | 255 | acpi_status acpi_install_exception_handler(acpi_exception_handler handler); |
1da177e4 LT |
256 | #endif |
257 | ||
1da177e4 LT |
258 | /* |
259 | * Event interfaces | |
260 | */ | |
4be44fcd | 261 | acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle); |
1da177e4 | 262 | |
4be44fcd | 263 | acpi_status acpi_release_global_lock(u32 handle); |
1da177e4 | 264 | |
4be44fcd | 265 | acpi_status acpi_enable_event(u32 event, u32 flags); |
1da177e4 | 266 | |
4be44fcd | 267 | acpi_status acpi_disable_event(u32 event, u32 flags); |
1da177e4 | 268 | |
4be44fcd | 269 | acpi_status acpi_clear_event(u32 event); |
1da177e4 | 270 | |
4be44fcd | 271 | acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status); |
1da177e4 | 272 | |
08ac07b8 BM |
273 | /* |
274 | * GPE Interfaces | |
275 | */ | |
4be44fcd | 276 | acpi_status acpi_set_gpe_type(acpi_handle gpe_device, u32 gpe_number, u8 type); |
1da177e4 | 277 | |
0b7084ac | 278 | acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number); |
1da177e4 | 279 | |
0b7084ac | 280 | acpi_status acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number); |
1da177e4 | 281 | |
4be44fcd | 282 | acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags); |
1da177e4 | 283 | |
1da177e4 | 284 | acpi_status |
4be44fcd LB |
285 | acpi_get_gpe_status(acpi_handle gpe_device, |
286 | u32 gpe_number, | |
287 | u32 flags, acpi_event_status * event_status); | |
1da177e4 | 288 | |
08ac07b8 BM |
289 | acpi_status acpi_disable_all_gpes(void); |
290 | ||
291 | acpi_status acpi_enable_all_runtime_gpes(void); | |
292 | ||
e97d6bf1 BM |
293 | acpi_status acpi_get_gpe_device(u32 gpe_index, acpi_handle *gpe_device); |
294 | ||
1da177e4 | 295 | acpi_status |
4be44fcd LB |
296 | acpi_install_gpe_block(acpi_handle gpe_device, |
297 | struct acpi_generic_address *gpe_block_address, | |
298 | u32 register_count, u32 interrupt_number); | |
1da177e4 | 299 | |
4be44fcd | 300 | acpi_status acpi_remove_gpe_block(acpi_handle gpe_device); |
1da177e4 LT |
301 | |
302 | /* | |
303 | * Resource interfaces | |
304 | */ | |
1da177e4 | 305 | typedef |
61686124 | 306 | acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource, |
4be44fcd | 307 | void *context); |
1da177e4 | 308 | |
c51a4de8 BM |
309 | acpi_status |
310 | acpi_get_vendor_resource(acpi_handle device_handle, | |
311 | char *name, | |
312 | struct acpi_vendor_uuid *uuid, | |
313 | struct acpi_buffer *ret_buffer); | |
314 | ||
1da177e4 | 315 | acpi_status |
4be44fcd LB |
316 | acpi_get_current_resources(acpi_handle device_handle, |
317 | struct acpi_buffer *ret_buffer); | |
1da177e4 LT |
318 | |
319 | #ifdef ACPI_FUTURE_USAGE | |
320 | acpi_status | |
4be44fcd LB |
321 | acpi_get_possible_resources(acpi_handle device_handle, |
322 | struct acpi_buffer *ret_buffer); | |
1da177e4 LT |
323 | #endif |
324 | ||
325 | acpi_status | |
4be44fcd | 326 | acpi_walk_resources(acpi_handle device_handle, |
c51a4de8 | 327 | char *name, |
61686124 | 328 | acpi_walk_resource_callback user_function, void *context); |
1da177e4 LT |
329 | |
330 | acpi_status | |
4be44fcd LB |
331 | acpi_set_current_resources(acpi_handle device_handle, |
332 | struct acpi_buffer *in_buffer); | |
1da177e4 LT |
333 | |
334 | acpi_status | |
4be44fcd LB |
335 | acpi_get_irq_routing_table(acpi_handle bus_device_handle, |
336 | struct acpi_buffer *ret_buffer); | |
1da177e4 LT |
337 | |
338 | acpi_status | |
4be44fcd LB |
339 | acpi_resource_to_address64(struct acpi_resource *resource, |
340 | struct acpi_resource_address64 *out); | |
1da177e4 LT |
341 | |
342 | /* | |
343 | * Hardware (ACPI device) interfaces | |
344 | */ | |
d3fd902d BM |
345 | acpi_status acpi_reset(void); |
346 | ||
d8c71b6d | 347 | acpi_status acpi_get_register(u32 register_id, u32 * return_value); |
1da177e4 | 348 | |
2d571b33 AS |
349 | acpi_status acpi_get_register_unlocked(u32 register_id, u32 *return_value); |
350 | ||
d8c71b6d | 351 | acpi_status acpi_set_register(u32 register_id, u32 value); |
1da177e4 LT |
352 | |
353 | acpi_status | |
d85988fa | 354 | acpi_set_firmware_waking_vector(u32 physical_address); |
1da177e4 | 355 | |
1da177e4 | 356 | acpi_status |
d85988fa | 357 | acpi_set_firmware_waking_vector64(u64 physical_address); |
1da177e4 | 358 | |
ecfbbc7b BM |
359 | acpi_status acpi_read(u32 *value, struct acpi_generic_address *reg); |
360 | ||
361 | acpi_status acpi_write(u32 value, struct acpi_generic_address *reg); | |
362 | ||
1da177e4 | 363 | acpi_status |
4be44fcd | 364 | acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b); |
1da177e4 | 365 | |
4be44fcd | 366 | acpi_status acpi_enter_sleep_state_prep(u8 sleep_state); |
1da177e4 | 367 | |
4be44fcd | 368 | acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state); |
1da177e4 | 369 | |
4be44fcd | 370 | acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void); |
1da177e4 | 371 | |
c95d47a8 RW |
372 | acpi_status acpi_leave_sleep_state_prep(u8 sleep_state); |
373 | ||
4be44fcd | 374 | acpi_status acpi_leave_sleep_state(u8 sleep_state); |
1da177e4 | 375 | |
50df4d8b BM |
376 | /* |
377 | * Debug output | |
378 | */ | |
379 | void ACPI_INTERNAL_VAR_XFACE | |
380 | acpi_error(const char *module_name, | |
381 | u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3); | |
382 | ||
383 | void ACPI_INTERNAL_VAR_XFACE | |
384 | acpi_exception(const char *module_name, | |
385 | u32 line_number, | |
386 | acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4); | |
387 | ||
388 | void ACPI_INTERNAL_VAR_XFACE | |
389 | acpi_warning(const char *module_name, | |
390 | u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3); | |
391 | ||
392 | void ACPI_INTERNAL_VAR_XFACE | |
393 | acpi_info(const char *module_name, | |
394 | u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3); | |
395 | ||
396 | #ifdef ACPI_DEBUG_OUTPUT | |
397 | ||
398 | void ACPI_INTERNAL_VAR_XFACE | |
399 | acpi_debug_print(u32 requested_debug_level, | |
400 | u32 line_number, | |
401 | const char *function_name, | |
402 | const char *module_name, | |
403 | u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6); | |
404 | ||
405 | void ACPI_INTERNAL_VAR_XFACE | |
406 | acpi_debug_print_raw(u32 requested_debug_level, | |
407 | u32 line_number, | |
408 | const char *function_name, | |
409 | const char *module_name, | |
410 | u32 component_id, | |
411 | const char *format, ...) ACPI_PRINTF_LIKE(6); | |
412 | #endif | |
413 | ||
4be44fcd | 414 | #endif /* __ACXFACE_H__ */ |