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