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