acpixf.h 9.9 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8

/******************************************************************************
 *
 * Name: acpixf.h - External interfaces to the ACPI subsystem
 *
 *****************************************************************************/

/*
L
Len Brown 已提交
9
 * Copyright (C) 2000 - 2008, Intel Corp.
L
Linus Torvalds 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef __ACXFACE_H__
#define __ACXFACE_H__

#include "actypes.h"
#include "actbl.h"

51 52
extern u8 acpi_gbl_permanent_mmap;

R
Robert Moore 已提交
53
/*
L
Linus Torvalds 已提交
54 55
 * Global interfaces
 */
56 57 58 59
acpi_status
acpi_initialize_tables(struct acpi_table_desc *initial_storage,
		       u32 initial_table_count, u8 allow_resize);

60
acpi_status __init acpi_initialize_subsystem(void);
L
Linus Torvalds 已提交
61

L
Len Brown 已提交
62
acpi_status acpi_enable_subsystem(u32 flags);
L
Linus Torvalds 已提交
63

L
Len Brown 已提交
64
acpi_status acpi_initialize_objects(u32 flags);
L
Linus Torvalds 已提交
65

L
Len Brown 已提交
66
acpi_status acpi_terminate(void);
L
Linus Torvalds 已提交
67 68

#ifdef ACPI_FUTURE_USAGE
L
Len Brown 已提交
69
acpi_status acpi_subsystem_status(void);
L
Linus Torvalds 已提交
70 71
#endif

L
Len Brown 已提交
72
acpi_status acpi_enable(void);
L
Linus Torvalds 已提交
73

L
Len Brown 已提交
74
acpi_status acpi_disable(void);
L
Linus Torvalds 已提交
75 76

#ifdef ACPI_FUTURE_USAGE
L
Len Brown 已提交
77
acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
78 79
#endif

L
Len Brown 已提交
80
const char *acpi_format_exception(acpi_status exception);
L
Linus Torvalds 已提交
81

L
Len Brown 已提交
82
acpi_status acpi_purge_cached_objects(void);
L
Linus Torvalds 已提交
83 84

/*
J
Joe Perches 已提交
85
 * ACPI Memory management
L
Linus Torvalds 已提交
86
 */
L
Len Brown 已提交
87
void *acpi_allocate(u32 size);
L
Linus Torvalds 已提交
88

L
Len Brown 已提交
89
void *acpi_callocate(u32 size);
L
Linus Torvalds 已提交
90

L
Len Brown 已提交
91
void acpi_free(void *address);
L
Linus Torvalds 已提交
92 93 94 95

/*
 * ACPI table manipulation interfaces
 */
96 97
acpi_status acpi_reallocate_root_table(void);

98
acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
L
Linus Torvalds 已提交
99

L
Len Brown 已提交
100
acpi_status acpi_load_tables(void);
L
Linus Torvalds 已提交
101

L
Len Brown 已提交
102
acpi_status acpi_load_table(struct acpi_table_header *table_ptr);
L
Linus Torvalds 已提交
103

104
acpi_status acpi_unload_table_id(acpi_owner_id id);
L
Linus Torvalds 已提交
105 106

acpi_status
107
acpi_get_table_header(acpi_string signature,
108
		      u32 instance,
109
		      struct acpi_table_header *out_table_header);
L
Linus Torvalds 已提交
110 111

acpi_status
112
acpi_get_table(acpi_string signature,
113
	       u32 instance, struct acpi_table_header **out_table);
L
Linus Torvalds 已提交
114 115

acpi_status
116
acpi_get_table_by_index(u32 table_index,
117
			struct acpi_table_header **out_table);
L
Linus Torvalds 已提交
118

119 120 121 122 123
acpi_status
acpi_install_table_handler(acpi_tbl_handler handler, void *context);

acpi_status acpi_remove_table_handler(acpi_tbl_handler handler);

L
Linus Torvalds 已提交
124 125 126 127
/*
 * Namespace and name interfaces
 */
acpi_status
L
Len Brown 已提交
128 129 130 131 132
acpi_walk_namespace(acpi_object_type type,
		    acpi_handle start_object,
		    u32 max_depth,
		    acpi_walk_callback user_function,
		    void *context, void **return_value);
L
Linus Torvalds 已提交
133 134

acpi_status
135
acpi_get_devices(const char *HID,
L
Len Brown 已提交
136 137
		 acpi_walk_callback user_function,
		 void *context, void **return_value);
L
Linus Torvalds 已提交
138 139

acpi_status
L
Len Brown 已提交
140 141
acpi_get_name(acpi_handle handle,
	      u32 name_type, struct acpi_buffer *ret_path_ptr);
L
Linus Torvalds 已提交
142 143

acpi_status
L
Len Brown 已提交
144 145
acpi_get_handle(acpi_handle parent,
		acpi_string pathname, acpi_handle * ret_handle);
L
Linus Torvalds 已提交
146 147

acpi_status
L
Len Brown 已提交
148 149
acpi_attach_data(acpi_handle obj_handle,
		 acpi_object_handler handler, void *data);
L
Linus Torvalds 已提交
150 151

acpi_status
L
Len Brown 已提交
152
acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler);
L
Linus Torvalds 已提交
153 154

acpi_status
L
Len Brown 已提交
155
acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data);
L
Linus Torvalds 已提交
156

B
Bob Moore 已提交
157 158 159
acpi_status
acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);

L
Linus Torvalds 已提交
160 161 162 163
/*
 * Object manipulation and enumeration
 */
acpi_status
L
Len Brown 已提交
164 165 166 167
acpi_evaluate_object(acpi_handle object,
		     acpi_string pathname,
		     struct acpi_object_list *parameter_objects,
		     struct acpi_buffer *return_object_buffer);
L
Linus Torvalds 已提交
168 169 170

#ifdef ACPI_FUTURE_USAGE
acpi_status
L
Len Brown 已提交
171 172 173 174 175
acpi_evaluate_object_typed(acpi_handle object,
			   acpi_string pathname,
			   struct acpi_object_list *external_params,
			   struct acpi_buffer *return_buffer,
			   acpi_object_type return_type);
L
Linus Torvalds 已提交
176 177 178
#endif

acpi_status
L
Len Brown 已提交
179
acpi_get_object_info(acpi_handle handle, struct acpi_buffer *return_buffer);
L
Linus Torvalds 已提交
180 181

acpi_status
L
Len Brown 已提交
182 183 184
acpi_get_next_object(acpi_object_type type,
		     acpi_handle parent,
		     acpi_handle child, acpi_handle * out_handle);
L
Linus Torvalds 已提交
185

L
Len Brown 已提交
186
acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
L
Linus Torvalds 已提交
187

188 189
acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);

L
Len Brown 已提交
190
acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
L
Linus Torvalds 已提交
191 192

/*
193
 * Handler interfaces
L
Linus Torvalds 已提交
194
 */
195 196 197
acpi_status
acpi_install_initialization_handler(acpi_init_handler handler, u32 function);

L
Linus Torvalds 已提交
198
acpi_status
L
Len Brown 已提交
199 200
acpi_install_fixed_event_handler(u32 acpi_event,
				 acpi_event_handler handler, void *context);
L
Linus Torvalds 已提交
201 202

acpi_status
L
Len Brown 已提交
203
acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
L
Linus Torvalds 已提交
204 205

acpi_status
L
Len Brown 已提交
206 207 208
acpi_install_notify_handler(acpi_handle device,
			    u32 handler_type,
			    acpi_notify_handler handler, void *context);
L
Linus Torvalds 已提交
209 210

acpi_status
L
Len Brown 已提交
211 212
acpi_remove_notify_handler(acpi_handle device,
			   u32 handler_type, acpi_notify_handler handler);
L
Linus Torvalds 已提交
213 214

acpi_status
L
Len Brown 已提交
215 216 217 218
acpi_install_address_space_handler(acpi_handle device,
				   acpi_adr_space_type space_id,
				   acpi_adr_space_handler handler,
				   acpi_adr_space_setup setup, void *context);
L
Linus Torvalds 已提交
219 220

acpi_status
L
Len Brown 已提交
221 222 223
acpi_remove_address_space_handler(acpi_handle device,
				  acpi_adr_space_type space_id,
				  acpi_adr_space_handler handler);
L
Linus Torvalds 已提交
224 225

acpi_status
L
Len Brown 已提交
226 227 228
acpi_install_gpe_handler(acpi_handle gpe_device,
			 u32 gpe_number,
			 u32 type, acpi_event_handler address, void *context);
L
Linus Torvalds 已提交
229

230 231 232 233
acpi_status
acpi_remove_gpe_handler(acpi_handle gpe_device,
			u32 gpe_number, acpi_event_handler address);

L
Linus Torvalds 已提交
234
#ifdef ACPI_FUTURE_USAGE
L
Len Brown 已提交
235
acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
L
Linus Torvalds 已提交
236 237 238 239 240
#endif

/*
 * Event interfaces
 */
L
Len Brown 已提交
241
acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle);
L
Linus Torvalds 已提交
242

L
Len Brown 已提交
243
acpi_status acpi_release_global_lock(u32 handle);
L
Linus Torvalds 已提交
244

L
Len Brown 已提交
245
acpi_status acpi_enable_event(u32 event, u32 flags);
L
Linus Torvalds 已提交
246

L
Len Brown 已提交
247
acpi_status acpi_disable_event(u32 event, u32 flags);
L
Linus Torvalds 已提交
248

L
Len Brown 已提交
249
acpi_status acpi_clear_event(u32 event);
L
Linus Torvalds 已提交
250

L
Len Brown 已提交
251
acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status);
L
Linus Torvalds 已提交
252

253 254 255
/*
 * GPE Interfaces
 */
L
Len Brown 已提交
256
acpi_status acpi_set_gpe_type(acpi_handle gpe_device, u32 gpe_number, u8 type);
L
Linus Torvalds 已提交
257

258
acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number);
L
Linus Torvalds 已提交
259

260
acpi_status acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number);
L
Linus Torvalds 已提交
261

L
Len Brown 已提交
262
acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
L
Linus Torvalds 已提交
263 264

acpi_status
L
Len Brown 已提交
265 266 267
acpi_get_gpe_status(acpi_handle gpe_device,
		    u32 gpe_number,
		    u32 flags, acpi_event_status * event_status);
L
Linus Torvalds 已提交
268

269 270 271 272
acpi_status acpi_disable_all_gpes(void);

acpi_status acpi_enable_all_runtime_gpes(void);

273 274
acpi_status acpi_get_gpe_device(u32 gpe_index, acpi_handle *gpe_device);

L
Linus Torvalds 已提交
275
acpi_status
L
Len Brown 已提交
276 277 278
acpi_install_gpe_block(acpi_handle gpe_device,
		       struct acpi_generic_address *gpe_block_address,
		       u32 register_count, u32 interrupt_number);
L
Linus Torvalds 已提交
279

L
Len Brown 已提交
280
acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
L
Linus Torvalds 已提交
281 282 283 284 285

/*
 * Resource interfaces
 */
typedef
B
Bob Moore 已提交
286
acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
L
Len Brown 已提交
287
					   void *context);
L
Linus Torvalds 已提交
288

B
Bob Moore 已提交
289 290 291 292 293 294
acpi_status
acpi_get_vendor_resource(acpi_handle device_handle,
			 char *name,
			 struct acpi_vendor_uuid *uuid,
			 struct acpi_buffer *ret_buffer);

L
Linus Torvalds 已提交
295
acpi_status
L
Len Brown 已提交
296 297
acpi_get_current_resources(acpi_handle device_handle,
			   struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
298 299 300

#ifdef ACPI_FUTURE_USAGE
acpi_status
L
Len Brown 已提交
301 302
acpi_get_possible_resources(acpi_handle device_handle,
			    struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
303 304 305
#endif

acpi_status
L
Len Brown 已提交
306
acpi_walk_resources(acpi_handle device_handle,
B
Bob Moore 已提交
307
		    char *name,
B
Bob Moore 已提交
308
		    acpi_walk_resource_callback user_function, void *context);
L
Linus Torvalds 已提交
309 310

acpi_status
L
Len Brown 已提交
311 312
acpi_set_current_resources(acpi_handle device_handle,
			   struct acpi_buffer *in_buffer);
L
Linus Torvalds 已提交
313 314

acpi_status
L
Len Brown 已提交
315 316
acpi_get_irq_routing_table(acpi_handle bus_device_handle,
			   struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
317 318

acpi_status
L
Len Brown 已提交
319 320
acpi_resource_to_address64(struct acpi_resource *resource,
			   struct acpi_resource_address64 *out);
L
Linus Torvalds 已提交
321 322 323 324

/*
 * Hardware (ACPI device) interfaces
 */
325
acpi_status acpi_get_register(u32 register_id, u32 * return_value);
L
Linus Torvalds 已提交
326

327 328
acpi_status acpi_get_register_unlocked(u32 register_id, u32 *return_value);

329
acpi_status acpi_set_register(u32 register_id, u32 value);
L
Linus Torvalds 已提交
330 331

acpi_status
332
acpi_set_firmware_waking_vector(u32 physical_address);
L
Linus Torvalds 已提交
333 334

acpi_status
335
acpi_set_firmware_waking_vector64(u64 physical_address);
L
Linus Torvalds 已提交
336

337 338 339 340
acpi_status acpi_read(u32 *value, struct acpi_generic_address *reg);

acpi_status acpi_write(u32 value, struct acpi_generic_address *reg);

L
Linus Torvalds 已提交
341
acpi_status
L
Len Brown 已提交
342
acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
L
Linus Torvalds 已提交
343

L
Len Brown 已提交
344
acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
L
Linus Torvalds 已提交
345

L
Len Brown 已提交
346
acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
L
Linus Torvalds 已提交
347

L
Len Brown 已提交
348
acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
L
Linus Torvalds 已提交
349

350 351
acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);

L
Len Brown 已提交
352
acpi_status acpi_leave_sleep_state(u8 sleep_state);
L
Linus Torvalds 已提交
353

L
Len Brown 已提交
354
#endif				/* __ACXFACE_H__ */