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