2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2005, R. Byron Moore
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.
54 acpi_status
acpi_initialize_subsystem(void);
56 acpi_status
acpi_enable_subsystem(u32 flags
);
58 acpi_status
acpi_initialize_objects(u32 flags
);
60 acpi_status
acpi_terminate(void);
62 #ifdef ACPI_FUTURE_USAGE
63 acpi_status
acpi_subsystem_status(void);
66 acpi_status
acpi_enable(void);
68 acpi_status
acpi_disable(void);
70 #ifdef ACPI_FUTURE_USAGE
71 acpi_status
acpi_get_system_info(struct acpi_buffer
*ret_buffer
);
74 const char *acpi_format_exception(acpi_status exception
);
76 acpi_status
acpi_purge_cached_objects(void);
78 #ifdef ACPI_FUTURE_USAGE
80 acpi_install_initialization_handler(acpi_init_handler handler
, u32 function
);
84 * ACPI Memory managment
86 void *acpi_allocate(u32 size
);
88 void *acpi_callocate(u32 size
);
90 void acpi_free(void *address
);
93 * ACPI table manipulation interfaces
96 acpi_find_root_pointer(u32 flags
, struct acpi_pointer
*rsdp_address
);
98 acpi_status
acpi_load_tables(void);
100 #ifdef ACPI_FUTURE_USAGE
101 acpi_status
acpi_load_table(struct acpi_table_header
*table_ptr
);
103 acpi_status
acpi_unload_table(acpi_table_type table_type
);
106 acpi_get_table_header(acpi_table_type table_type
,
107 u32 instance
, struct acpi_table_header
*out_table_header
);
108 #endif /* ACPI_FUTURE_USAGE */
111 acpi_get_table(acpi_table_type table_type
,
112 u32 instance
, struct acpi_buffer
*ret_buffer
);
115 acpi_get_firmware_table(acpi_string signature
,
117 u32 flags
, struct acpi_table_header
**table_pointer
);
120 * Namespace and name interfaces
123 acpi_walk_namespace(acpi_object_type type
,
124 acpi_handle start_object
,
126 acpi_walk_callback user_function
,
127 void *context
, void **return_value
);
130 acpi_get_devices(char *HID
,
131 acpi_walk_callback user_function
,
132 void *context
, void **return_value
);
135 acpi_get_name(acpi_handle handle
,
136 u32 name_type
, struct acpi_buffer
*ret_path_ptr
);
139 acpi_get_handle(acpi_handle parent
,
140 acpi_string pathname
, acpi_handle
* ret_handle
);
143 acpi_attach_data(acpi_handle obj_handle
,
144 acpi_object_handler handler
, void *data
);
147 acpi_detach_data(acpi_handle obj_handle
, acpi_object_handler handler
);
150 acpi_get_data(acpi_handle obj_handle
, acpi_object_handler handler
, void **data
);
153 * Object manipulation and enumeration
156 acpi_evaluate_object(acpi_handle object
,
157 acpi_string pathname
,
158 struct acpi_object_list
*parameter_objects
,
159 struct acpi_buffer
*return_object_buffer
);
161 #ifdef ACPI_FUTURE_USAGE
163 acpi_evaluate_object_typed(acpi_handle object
,
164 acpi_string pathname
,
165 struct acpi_object_list
*external_params
,
166 struct acpi_buffer
*return_buffer
,
167 acpi_object_type return_type
);
171 acpi_get_object_info(acpi_handle handle
, struct acpi_buffer
*return_buffer
);
174 acpi_get_next_object(acpi_object_type type
,
176 acpi_handle child
, acpi_handle
* out_handle
);
178 acpi_status
acpi_get_type(acpi_handle object
, acpi_object_type
* out_type
);
180 acpi_status
acpi_get_parent(acpi_handle object
, acpi_handle
* out_handle
);
183 * Event handler interfaces
186 acpi_install_fixed_event_handler(u32 acpi_event
,
187 acpi_event_handler handler
, void *context
);
190 acpi_remove_fixed_event_handler(u32 acpi_event
, acpi_event_handler handler
);
193 acpi_install_notify_handler(acpi_handle device
,
195 acpi_notify_handler handler
, void *context
);
198 acpi_remove_notify_handler(acpi_handle device
,
199 u32 handler_type
, acpi_notify_handler handler
);
202 acpi_install_address_space_handler(acpi_handle device
,
203 acpi_adr_space_type space_id
,
204 acpi_adr_space_handler handler
,
205 acpi_adr_space_setup setup
, void *context
);
208 acpi_remove_address_space_handler(acpi_handle device
,
209 acpi_adr_space_type space_id
,
210 acpi_adr_space_handler handler
);
213 acpi_install_gpe_handler(acpi_handle gpe_device
,
215 u32 type
, acpi_event_handler address
, void *context
);
217 #ifdef ACPI_FUTURE_USAGE
218 acpi_status
acpi_install_exception_handler(acpi_exception_handler handler
);
224 acpi_status
acpi_acquire_global_lock(u16 timeout
, u32
* handle
);
226 acpi_status
acpi_release_global_lock(u32 handle
);
229 acpi_remove_gpe_handler(acpi_handle gpe_device
,
230 u32 gpe_number
, acpi_event_handler address
);
232 acpi_status
acpi_enable_event(u32 event
, u32 flags
);
234 acpi_status
acpi_disable_event(u32 event
, u32 flags
);
236 acpi_status
acpi_clear_event(u32 event
);
238 #ifdef ACPI_FUTURE_USAGE
239 acpi_status
acpi_get_event_status(u32 event
, acpi_event_status
* event_status
);
240 #endif /* ACPI_FUTURE_USAGE */
242 acpi_status
acpi_set_gpe_type(acpi_handle gpe_device
, u32 gpe_number
, u8 type
);
244 acpi_status
acpi_enable_gpe(acpi_handle gpe_device
, u32 gpe_number
, u32 flags
);
246 acpi_status
acpi_disable_gpe(acpi_handle gpe_device
, u32 gpe_number
, u32 flags
);
248 acpi_status
acpi_clear_gpe(acpi_handle gpe_device
, u32 gpe_number
, u32 flags
);
250 #ifdef ACPI_FUTURE_USAGE
252 acpi_get_gpe_status(acpi_handle gpe_device
,
254 u32 flags
, acpi_event_status
* event_status
);
255 #endif /* ACPI_FUTURE_USAGE */
258 acpi_install_gpe_block(acpi_handle gpe_device
,
259 struct acpi_generic_address
*gpe_block_address
,
260 u32 register_count
, u32 interrupt_number
);
262 acpi_status
acpi_remove_gpe_block(acpi_handle gpe_device
);
265 * Resource interfaces
268 acpi_status(*ACPI_WALK_RESOURCE_CALLBACK
) (struct acpi_resource
* resource
,
272 acpi_get_current_resources(acpi_handle device_handle
,
273 struct acpi_buffer
*ret_buffer
);
275 #ifdef ACPI_FUTURE_USAGE
277 acpi_get_possible_resources(acpi_handle device_handle
,
278 struct acpi_buffer
*ret_buffer
);
282 acpi_walk_resources(acpi_handle device_handle
,
284 ACPI_WALK_RESOURCE_CALLBACK user_function
, void *context
);
287 acpi_set_current_resources(acpi_handle device_handle
,
288 struct acpi_buffer
*in_buffer
);
291 acpi_get_irq_routing_table(acpi_handle bus_device_handle
,
292 struct acpi_buffer
*ret_buffer
);
295 acpi_resource_to_address64(struct acpi_resource
*resource
,
296 struct acpi_resource_address64
*out
);
299 * Hardware (ACPI device) interfaces
301 acpi_status
acpi_get_register(u32 register_id
, u32
* return_value
, u32 flags
);
303 acpi_status
acpi_set_register(u32 register_id
, u32 value
, u32 flags
);
306 acpi_set_firmware_waking_vector(acpi_physical_address physical_address
);
308 #ifdef ACPI_FUTURE_USAGE
310 acpi_get_firmware_waking_vector(acpi_physical_address
* physical_address
);
314 acpi_get_sleep_type_data(u8 sleep_state
, u8
* slp_typ_a
, u8
* slp_typ_b
);
316 acpi_status
acpi_enter_sleep_state_prep(u8 sleep_state
);
318 acpi_status asmlinkage
acpi_enter_sleep_state(u8 sleep_state
);
320 acpi_status asmlinkage
acpi_enter_sleep_state_s4bios(void);
322 acpi_status
acpi_leave_sleep_state(u8 sleep_state
);
324 #endif /* __ACXFACE_H__ */