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