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