2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2010, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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.
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.
48 /* Current ACPICA subsystem version in YYYYMMDD format */
50 #define ACPI_CA_VERSION 0x20100304
55 extern u8 acpi_gbl_permanent_mmap
;
58 * Globals that are publically available, allowing for
59 * run time configuration
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 extern u8 acpi_gbl_enable_aml_debug_object
;
71 extern u8 acpi_gbl_copy_dsdt_locally
;
73 extern u32 acpi_current_gpe_count
;
74 extern struct acpi_table_fadt acpi_gbl_FADT
;
76 extern u32 acpi_rsdt_forced
;
81 acpi_initialize_tables(struct acpi_table_desc
*initial_storage
,
82 u32 initial_table_count
, u8 allow_resize
);
84 acpi_status __init
acpi_initialize_subsystem(void);
86 acpi_status
acpi_enable_subsystem(u32 flags
);
88 acpi_status
acpi_initialize_objects(u32 flags
);
90 acpi_status
acpi_terminate(void);
92 #ifdef ACPI_FUTURE_USAGE
93 acpi_status
acpi_subsystem_status(void);
96 acpi_status
acpi_enable(void);
98 acpi_status
acpi_disable(void);
100 #ifdef ACPI_FUTURE_USAGE
101 acpi_status
acpi_get_system_info(struct acpi_buffer
*ret_buffer
);
104 const char *acpi_format_exception(acpi_status exception
);
106 acpi_status
acpi_purge_cached_objects(void);
109 * ACPI Memory management
111 void *acpi_allocate(u32 size
);
113 void *acpi_callocate(u32 size
);
115 void acpi_free(void *address
);
118 * ACPI table manipulation interfaces
120 acpi_status
acpi_reallocate_root_table(void);
122 acpi_status
acpi_find_root_pointer(acpi_size
*rsdp_address
);
124 acpi_status
acpi_load_tables(void);
126 acpi_status
acpi_load_table(struct acpi_table_header
*table_ptr
);
128 acpi_status
acpi_unload_table_id(acpi_owner_id id
);
131 acpi_get_table_header(acpi_string signature
,
133 struct acpi_table_header
*out_table_header
);
136 acpi_get_table_with_size(acpi_string signature
,
137 u32 instance
, struct acpi_table_header
**out_table
,
138 acpi_size
*tbl_size
);
140 acpi_get_table(acpi_string signature
,
141 u32 instance
, struct acpi_table_header
**out_table
);
144 acpi_get_table_by_index(u32 table_index
,
145 struct acpi_table_header
**out_table
);
148 acpi_install_table_handler(acpi_tbl_handler handler
, void *context
);
150 acpi_status
acpi_remove_table_handler(acpi_tbl_handler handler
);
153 * Namespace and name interfaces
156 acpi_walk_namespace(acpi_object_type type
,
157 acpi_handle start_object
,
159 acpi_walk_callback pre_order_visit
,
160 acpi_walk_callback post_order_visit
,
161 void *context
, void **return_value
);
164 acpi_get_devices(const char *HID
,
165 acpi_walk_callback user_function
,
166 void *context
, void **return_value
);
169 acpi_get_name(acpi_handle handle
,
170 u32 name_type
, struct acpi_buffer
*ret_path_ptr
);
173 acpi_get_handle(acpi_handle parent
,
174 acpi_string pathname
, acpi_handle
* ret_handle
);
177 acpi_attach_data(acpi_handle obj_handle
,
178 acpi_object_handler handler
, void *data
);
181 acpi_detach_data(acpi_handle obj_handle
, acpi_object_handler handler
);
184 acpi_get_data(acpi_handle obj_handle
, acpi_object_handler handler
, void **data
);
187 acpi_debug_trace(char *name
, u32 debug_level
, u32 debug_layer
, u32 flags
);
190 * Object manipulation and enumeration
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
);
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
);
206 acpi_get_object_info(acpi_handle handle
,
207 struct acpi_device_info
**return_buffer
);
209 acpi_status
acpi_install_method(u8
*buffer
);
212 acpi_get_next_object(acpi_object_type type
,
214 acpi_handle child
, acpi_handle
* out_handle
);
216 acpi_status
acpi_get_type(acpi_handle object
, acpi_object_type
* out_type
);
218 acpi_status
acpi_get_id(acpi_handle object
, acpi_owner_id
* out_type
);
220 acpi_status
acpi_get_parent(acpi_handle object
, acpi_handle
* out_handle
);
226 acpi_install_initialization_handler(acpi_init_handler handler
, u32 function
);
229 acpi_install_fixed_event_handler(u32 acpi_event
,
230 acpi_event_handler handler
, void *context
);
233 acpi_remove_fixed_event_handler(u32 acpi_event
, acpi_event_handler handler
);
236 acpi_install_notify_handler(acpi_handle device
,
238 acpi_notify_handler handler
, void *context
);
241 acpi_remove_notify_handler(acpi_handle device
,
242 u32 handler_type
, acpi_notify_handler handler
);
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
);
251 acpi_remove_address_space_handler(acpi_handle device
,
252 acpi_adr_space_type space_id
,
253 acpi_adr_space_handler handler
);
256 acpi_install_gpe_handler(acpi_handle gpe_device
,
258 u32 type
, acpi_event_handler address
, void *context
);
261 acpi_remove_gpe_handler(acpi_handle gpe_device
,
262 u32 gpe_number
, acpi_event_handler address
);
264 #ifdef ACPI_FUTURE_USAGE
265 acpi_status
acpi_install_exception_handler(acpi_exception_handler handler
);
271 acpi_status
acpi_acquire_global_lock(u16 timeout
, u32
* handle
);
273 acpi_status
acpi_release_global_lock(u32 handle
);
275 acpi_status
acpi_enable_event(u32 event
, u32 flags
);
277 acpi_status
acpi_disable_event(u32 event
, u32 flags
);
279 acpi_status
acpi_clear_event(u32 event
);
281 acpi_status
acpi_get_event_status(u32 event
, acpi_event_status
* event_status
);
286 acpi_status
acpi_set_gpe(acpi_handle gpe_device
, u32 gpe_number
, u8 action
);
289 acpi_enable_gpe(acpi_handle gpe_device
, u32 gpe_number
, u8 gpe_type
);
292 acpi_disable_gpe(acpi_handle gpe_device
, u32 gpe_number
, u8 gpe_type
);
294 acpi_status
acpi_clear_gpe(acpi_handle gpe_device
, u32 gpe_number
);
297 acpi_get_gpe_status(acpi_handle gpe_device
,
298 u32 gpe_number
, acpi_event_status
*event_status
);
300 acpi_status
acpi_disable_all_gpes(void);
302 acpi_status
acpi_enable_all_runtime_gpes(void);
304 acpi_status
acpi_get_gpe_device(u32 gpe_index
, acpi_handle
*gpe_device
);
307 acpi_install_gpe_block(acpi_handle gpe_device
,
308 struct acpi_generic_address
*gpe_block_address
,
309 u32 register_count
, u32 interrupt_number
);
311 acpi_status
acpi_remove_gpe_block(acpi_handle gpe_device
);
314 * Resource interfaces
317 acpi_status(*acpi_walk_resource_callback
) (struct acpi_resource
* resource
,
321 acpi_get_vendor_resource(acpi_handle device_handle
,
323 struct acpi_vendor_uuid
*uuid
,
324 struct acpi_buffer
*ret_buffer
);
327 acpi_get_current_resources(acpi_handle device_handle
,
328 struct acpi_buffer
*ret_buffer
);
330 #ifdef ACPI_FUTURE_USAGE
332 acpi_get_possible_resources(acpi_handle device_handle
,
333 struct acpi_buffer
*ret_buffer
);
337 acpi_walk_resources(acpi_handle device_handle
,
339 acpi_walk_resource_callback user_function
, void *context
);
342 acpi_set_current_resources(acpi_handle device_handle
,
343 struct acpi_buffer
*in_buffer
);
346 acpi_get_irq_routing_table(acpi_handle bus_device_handle
,
347 struct acpi_buffer
*ret_buffer
);
350 acpi_resource_to_address64(struct acpi_resource
*resource
,
351 struct acpi_resource_address64
*out
);
354 * Hardware (ACPI device) interfaces
356 acpi_status
acpi_reset(void);
358 acpi_status
acpi_read_bit_register(u32 register_id
, u32
*return_value
);
360 acpi_status
acpi_write_bit_register(u32 register_id
, u32 value
);
362 acpi_status
acpi_set_firmware_waking_vector(u32 physical_address
);
364 #if ACPI_MACHINE_WIDTH == 64
365 acpi_status
acpi_set_firmware_waking_vector64(u64 physical_address
);
368 acpi_status
acpi_read(u64
*value
, struct acpi_generic_address
*reg
);
370 acpi_status
acpi_write(u64 value
, struct acpi_generic_address
*reg
);
373 acpi_get_sleep_type_data(u8 sleep_state
, u8
* slp_typ_a
, u8
* slp_typ_b
);
375 acpi_status
acpi_enter_sleep_state_prep(u8 sleep_state
);
377 acpi_status asmlinkage
acpi_enter_sleep_state(u8 sleep_state
);
379 acpi_status asmlinkage
acpi_enter_sleep_state_s4bios(void);
381 acpi_status
acpi_leave_sleep_state_prep(u8 sleep_state
);
383 acpi_status
acpi_leave_sleep_state(u8 sleep_state
);
386 * Error/Warning output
388 void ACPI_INTERNAL_VAR_XFACE
389 acpi_error(const char *module_name
,
390 u32 line_number
, const char *format
, ...) ACPI_PRINTF_LIKE(3);
392 void ACPI_INTERNAL_VAR_XFACE
393 acpi_exception(const char *module_name
,
395 acpi_status status
, const char *format
, ...) ACPI_PRINTF_LIKE(4);
397 void ACPI_INTERNAL_VAR_XFACE
398 acpi_warning(const char *module_name
,
399 u32 line_number
, const char *format
, ...) ACPI_PRINTF_LIKE(3);
401 void ACPI_INTERNAL_VAR_XFACE
402 acpi_info(const char *module_name
,
403 u32 line_number
, const char *format
, ...) ACPI_PRINTF_LIKE(3);
408 #ifdef ACPI_DEBUG_OUTPUT
410 void ACPI_INTERNAL_VAR_XFACE
411 acpi_debug_print(u32 requested_debug_level
,
413 const char *function_name
,
414 const char *module_name
,
415 u32 component_id
, const char *format
, ...) ACPI_PRINTF_LIKE(6);
417 void ACPI_INTERNAL_VAR_XFACE
418 acpi_debug_print_raw(u32 requested_debug_level
,
420 const char *function_name
,
421 const char *module_name
,
423 const char *format
, ...) ACPI_PRINTF_LIKE(6);
426 #endif /* __ACXFACE_H__ */