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