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