2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2008, 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.
51 extern u32 acpi_rsdt_forced
;
56 acpi_initialize_tables(struct acpi_table_desc
*initial_storage
,
57 u32 initial_table_count
, u8 allow_resize
);
59 acpi_status __init
acpi_initialize_subsystem(void);
61 acpi_status
acpi_enable_subsystem(u32 flags
);
63 acpi_status
acpi_initialize_objects(u32 flags
);
65 acpi_status
acpi_terminate(void);
67 #ifdef ACPI_FUTURE_USAGE
68 acpi_status
acpi_subsystem_status(void);
71 acpi_status
acpi_enable(void);
73 acpi_status
acpi_disable(void);
75 #ifdef ACPI_FUTURE_USAGE
76 acpi_status
acpi_get_system_info(struct acpi_buffer
*ret_buffer
);
79 const char *acpi_format_exception(acpi_status exception
);
81 acpi_status
acpi_purge_cached_objects(void);
83 #ifdef ACPI_FUTURE_USAGE
85 acpi_install_initialization_handler(acpi_init_handler handler
, u32 function
);
89 * ACPI Memory management
91 void *acpi_allocate(u32 size
);
93 void *acpi_callocate(u32 size
);
95 void acpi_free(void *address
);
98 * ACPI table manipulation interfaces
100 acpi_status
acpi_reallocate_root_table(void);
102 acpi_status
acpi_find_root_pointer(acpi_size
*rsdp_address
);
104 acpi_status
acpi_load_tables(void);
106 acpi_status
acpi_load_table(struct acpi_table_header
*table_ptr
);
108 acpi_status
acpi_unload_table_id(acpi_owner_id id
);
111 acpi_get_table_header(acpi_string signature
,
113 struct acpi_table_header
*out_table_header
);
116 acpi_get_table(acpi_string signature
,
117 u32 instance
, struct acpi_table_header
**out_table
);
120 acpi_get_table_by_index(u32 table_index
,
121 struct acpi_table_header
**out_table
);
124 acpi_install_table_handler(acpi_tbl_handler handler
, void *context
);
126 acpi_status
acpi_remove_table_handler(acpi_tbl_handler handler
);
129 * Namespace and name interfaces
132 acpi_walk_namespace(acpi_object_type type
,
133 acpi_handle start_object
,
135 acpi_walk_callback user_function
,
136 void *context
, void **return_value
);
139 acpi_get_devices(const char *HID
,
140 acpi_walk_callback user_function
,
141 void *context
, void **return_value
);
144 acpi_get_name(acpi_handle handle
,
145 u32 name_type
, struct acpi_buffer
*ret_path_ptr
);
148 acpi_get_handle(acpi_handle parent
,
149 acpi_string pathname
, acpi_handle
* ret_handle
);
152 acpi_attach_data(acpi_handle obj_handle
,
153 acpi_object_handler handler
, void *data
);
156 acpi_detach_data(acpi_handle obj_handle
, acpi_object_handler handler
);
159 acpi_get_data(acpi_handle obj_handle
, acpi_object_handler handler
, void **data
);
162 acpi_debug_trace(char *name
, u32 debug_level
, u32 debug_layer
, u32 flags
);
165 * Object manipulation and enumeration
168 acpi_evaluate_object(acpi_handle object
,
169 acpi_string pathname
,
170 struct acpi_object_list
*parameter_objects
,
171 struct acpi_buffer
*return_object_buffer
);
173 #ifdef ACPI_FUTURE_USAGE
175 acpi_evaluate_object_typed(acpi_handle object
,
176 acpi_string pathname
,
177 struct acpi_object_list
*external_params
,
178 struct acpi_buffer
*return_buffer
,
179 acpi_object_type return_type
);
183 acpi_get_object_info(acpi_handle handle
, struct acpi_buffer
*return_buffer
);
186 acpi_get_next_object(acpi_object_type type
,
188 acpi_handle child
, acpi_handle
* out_handle
);
190 acpi_status
acpi_get_type(acpi_handle object
, acpi_object_type
* out_type
);
192 acpi_status
acpi_get_id(acpi_handle object
, acpi_owner_id
* out_type
);
194 acpi_status
acpi_get_parent(acpi_handle object
, acpi_handle
* out_handle
);
197 * Event handler interfaces
200 acpi_install_fixed_event_handler(u32 acpi_event
,
201 acpi_event_handler handler
, void *context
);
204 acpi_remove_fixed_event_handler(u32 acpi_event
, acpi_event_handler handler
);
207 acpi_install_notify_handler(acpi_handle device
,
209 acpi_notify_handler handler
, void *context
);
212 acpi_remove_notify_handler(acpi_handle device
,
213 u32 handler_type
, acpi_notify_handler handler
);
216 acpi_install_address_space_handler(acpi_handle device
,
217 acpi_adr_space_type space_id
,
218 acpi_adr_space_handler handler
,
219 acpi_adr_space_setup setup
, void *context
);
222 acpi_remove_address_space_handler(acpi_handle device
,
223 acpi_adr_space_type space_id
,
224 acpi_adr_space_handler handler
);
227 acpi_install_gpe_handler(acpi_handle gpe_device
,
229 u32 type
, acpi_event_handler address
, void *context
);
231 #ifdef ACPI_FUTURE_USAGE
232 acpi_status
acpi_install_exception_handler(acpi_exception_handler handler
);
238 acpi_status
acpi_acquire_global_lock(u16 timeout
, u32
* handle
);
240 acpi_status
acpi_release_global_lock(u32 handle
);
243 acpi_remove_gpe_handler(acpi_handle gpe_device
,
244 u32 gpe_number
, acpi_event_handler address
);
246 acpi_status
acpi_enable_event(u32 event
, u32 flags
);
248 acpi_status
acpi_disable_event(u32 event
, u32 flags
);
250 acpi_status
acpi_clear_event(u32 event
);
252 acpi_status
acpi_get_event_status(u32 event
, acpi_event_status
* event_status
);
254 acpi_status
acpi_set_gpe_type(acpi_handle gpe_device
, u32 gpe_number
, u8 type
);
256 acpi_status
acpi_enable_gpe(acpi_handle gpe_device
, u32 gpe_number
);
258 acpi_status
acpi_disable_gpe(acpi_handle gpe_device
, u32 gpe_number
);
260 acpi_status
acpi_clear_gpe(acpi_handle gpe_device
, u32 gpe_number
, u32 flags
);
263 acpi_get_gpe_status(acpi_handle gpe_device
,
265 u32 flags
, acpi_event_status
* event_status
);
268 acpi_install_gpe_block(acpi_handle gpe_device
,
269 struct acpi_generic_address
*gpe_block_address
,
270 u32 register_count
, u32 interrupt_number
);
272 acpi_status
acpi_remove_gpe_block(acpi_handle gpe_device
);
275 * Resource interfaces
278 acpi_status(*acpi_walk_resource_callback
) (struct acpi_resource
* resource
,
282 acpi_get_vendor_resource(acpi_handle device_handle
,
284 struct acpi_vendor_uuid
*uuid
,
285 struct acpi_buffer
*ret_buffer
);
288 acpi_get_current_resources(acpi_handle device_handle
,
289 struct acpi_buffer
*ret_buffer
);
291 #ifdef ACPI_FUTURE_USAGE
293 acpi_get_possible_resources(acpi_handle device_handle
,
294 struct acpi_buffer
*ret_buffer
);
298 acpi_walk_resources(acpi_handle device_handle
,
300 acpi_walk_resource_callback user_function
, void *context
);
303 acpi_set_current_resources(acpi_handle device_handle
,
304 struct acpi_buffer
*in_buffer
);
307 acpi_get_irq_routing_table(acpi_handle bus_device_handle
,
308 struct acpi_buffer
*ret_buffer
);
311 acpi_resource_to_address64(struct acpi_resource
*resource
,
312 struct acpi_resource_address64
*out
);
315 * Hardware (ACPI device) interfaces
317 acpi_status
acpi_get_register(u32 register_id
, u32
* return_value
);
319 acpi_status
acpi_get_register_unlocked(u32 register_id
, u32
*return_value
);
321 acpi_status
acpi_set_register(u32 register_id
, u32 value
);
324 acpi_set_firmware_waking_vector(acpi_physical_address physical_address
);
326 #ifdef ACPI_FUTURE_USAGE
328 acpi_get_firmware_waking_vector(acpi_physical_address
* physical_address
);
332 acpi_get_sleep_type_data(u8 sleep_state
, u8
* slp_typ_a
, u8
* slp_typ_b
);
334 acpi_status
acpi_enter_sleep_state_prep(u8 sleep_state
);
336 acpi_status asmlinkage
acpi_enter_sleep_state(u8 sleep_state
);
338 acpi_status asmlinkage
acpi_enter_sleep_state_s4bios(void);
340 acpi_status
acpi_leave_sleep_state_prep(u8 sleep_state
);
342 acpi_status
acpi_leave_sleep_state(u8 sleep_state
);
344 #endif /* __ACXFACE_H__ */