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

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

/*
9
 * Copyright (C) 2000 - 2010, 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
 * 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__

48 49
/* Current ACPICA subsystem version in YYYYMMDD format */

B
Bob Moore 已提交
50
#define ACPI_CA_VERSION                 0x20100428
51

L
Linus Torvalds 已提交
52 53 54
#include "actypes.h"
#include "actbl.h"

55 56
extern u8 acpi_gbl_permanent_mmap;

57 58 59 60 61 62 63 64 65 66
/*
 * Globals that are publically available, allowing for
 * run time configuration
 */
extern u32 acpi_dbg_level;
extern u32 acpi_dbg_layer;
extern u8 acpi_gbl_enable_interpreter_slack;
extern u8 acpi_gbl_all_methods_serialized;
extern u8 acpi_gbl_create_osi_method;
extern u8 acpi_gbl_leave_wake_gpes_disabled;
67
extern u8 acpi_gbl_use_default_register_widths;
68 69
extern acpi_name acpi_gbl_trace_method_name;
extern u32 acpi_gbl_trace_flags;
70
extern u8 acpi_gbl_enable_aml_debug_object;
71
extern u8 acpi_gbl_copy_dsdt_locally;
72 73 74 75

extern u32 acpi_current_gpe_count;
extern struct acpi_table_fadt acpi_gbl_FADT;

76
extern u32 acpi_rsdt_forced;
R
Robert Moore 已提交
77
/*
L
Linus Torvalds 已提交
78 79
 * Global interfaces
 */
80 81 82 83
acpi_status
acpi_initialize_tables(struct acpi_table_desc *initial_storage,
		       u32 initial_table_count, u8 allow_resize);

84
acpi_status __init acpi_initialize_subsystem(void);
L
Linus Torvalds 已提交
85

L
Len Brown 已提交
86
acpi_status acpi_enable_subsystem(u32 flags);
L
Linus Torvalds 已提交
87

L
Len Brown 已提交
88
acpi_status acpi_initialize_objects(u32 flags);
L
Linus Torvalds 已提交
89

L
Len Brown 已提交
90
acpi_status acpi_terminate(void);
L
Linus Torvalds 已提交
91 92

#ifdef ACPI_FUTURE_USAGE
L
Len Brown 已提交
93
acpi_status acpi_subsystem_status(void);
L
Linus Torvalds 已提交
94 95
#endif

L
Len Brown 已提交
96
acpi_status acpi_enable(void);
L
Linus Torvalds 已提交
97

L
Len Brown 已提交
98
acpi_status acpi_disable(void);
L
Linus Torvalds 已提交
99 100

#ifdef ACPI_FUTURE_USAGE
L
Len Brown 已提交
101
acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
102 103
#endif

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

L
Len Brown 已提交
106
acpi_status acpi_purge_cached_objects(void);
L
Linus Torvalds 已提交
107 108

/*
J
Joe Perches 已提交
109
 * ACPI Memory management
L
Linus Torvalds 已提交
110
 */
L
Len Brown 已提交
111
void *acpi_allocate(u32 size);
L
Linus Torvalds 已提交
112

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

L
Len Brown 已提交
115
void acpi_free(void *address);
L
Linus Torvalds 已提交
116 117 118 119

/*
 * ACPI table manipulation interfaces
 */
120 121
acpi_status acpi_reallocate_root_table(void);

122
acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
L
Linus Torvalds 已提交
123

L
Len Brown 已提交
124
acpi_status acpi_load_tables(void);
L
Linus Torvalds 已提交
125

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

128
acpi_status acpi_unload_table_id(acpi_owner_id id);
L
Linus Torvalds 已提交
129 130

acpi_status
131
acpi_get_table_header(acpi_string signature,
132
		      u32 instance,
133
		      struct acpi_table_header *out_table_header);
L
Linus Torvalds 已提交
134 135

acpi_status
136 137 138 139
acpi_get_table_with_size(acpi_string signature,
	       u32 instance, struct acpi_table_header **out_table,
	       acpi_size *tbl_size);
acpi_status
140
acpi_get_table(acpi_string signature,
141
	       u32 instance, struct acpi_table_header **out_table);
L
Linus Torvalds 已提交
142 143

acpi_status
144
acpi_get_table_by_index(u32 table_index,
145
			struct acpi_table_header **out_table);
L
Linus Torvalds 已提交
146

147 148 149 150 151
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 已提交
152 153 154 155
/*
 * Namespace and name interfaces
 */
acpi_status
L
Len Brown 已提交
156 157 158
acpi_walk_namespace(acpi_object_type type,
		    acpi_handle start_object,
		    u32 max_depth,
159 160
		    acpi_walk_callback pre_order_visit,
		    acpi_walk_callback post_order_visit,
L
Len Brown 已提交
161
		    void *context, void **return_value);
L
Linus Torvalds 已提交
162 163

acpi_status
164
acpi_get_devices(const char *HID,
L
Len Brown 已提交
165 166
		 acpi_walk_callback user_function,
		 void *context, void **return_value);
L
Linus Torvalds 已提交
167 168

acpi_status
169
acpi_get_name(acpi_handle object,
L
Len Brown 已提交
170
	      u32 name_type, struct acpi_buffer *ret_path_ptr);
L
Linus Torvalds 已提交
171 172

acpi_status
L
Len Brown 已提交
173 174
acpi_get_handle(acpi_handle parent,
		acpi_string pathname, acpi_handle * ret_handle);
L
Linus Torvalds 已提交
175 176

acpi_status
177
acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
L
Linus Torvalds 已提交
178

179
acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
L
Linus Torvalds 已提交
180 181

acpi_status
182
acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
L
Linus Torvalds 已提交
183

B
Bob Moore 已提交
184 185 186
acpi_status
acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);

L
Linus Torvalds 已提交
187 188 189 190
/*
 * Object manipulation and enumeration
 */
acpi_status
L
Len Brown 已提交
191 192 193 194
acpi_evaluate_object(acpi_handle object,
		     acpi_string pathname,
		     struct acpi_object_list *parameter_objects,
		     struct acpi_buffer *return_object_buffer);
L
Linus Torvalds 已提交
195 196

acpi_status
L
Len Brown 已提交
197 198 199 200 201
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 已提交
202 203

acpi_status
204
acpi_get_object_info(acpi_handle object,
205
		     struct acpi_device_info **return_buffer);
L
Linus Torvalds 已提交
206

207 208
acpi_status acpi_install_method(u8 *buffer);

L
Linus Torvalds 已提交
209
acpi_status
L
Len Brown 已提交
210 211 212
acpi_get_next_object(acpi_object_type type,
		     acpi_handle parent,
		     acpi_handle child, acpi_handle * out_handle);
L
Linus Torvalds 已提交
213

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

216 217
acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);

L
Len Brown 已提交
218
acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
L
Linus Torvalds 已提交
219 220

/*
221
 * Handler interfaces
L
Linus Torvalds 已提交
222
 */
223 224 225
acpi_status
acpi_install_initialization_handler(acpi_init_handler handler, u32 function);

L
Linus Torvalds 已提交
226
acpi_status
L
Len Brown 已提交
227 228
acpi_install_fixed_event_handler(u32 acpi_event,
				 acpi_event_handler handler, void *context);
L
Linus Torvalds 已提交
229 230

acpi_status
L
Len Brown 已提交
231
acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
L
Linus Torvalds 已提交
232 233

acpi_status
L
Len Brown 已提交
234 235 236
acpi_install_notify_handler(acpi_handle device,
			    u32 handler_type,
			    acpi_notify_handler handler, void *context);
L
Linus Torvalds 已提交
237 238

acpi_status
L
Len Brown 已提交
239 240
acpi_remove_notify_handler(acpi_handle device,
			   u32 handler_type, acpi_notify_handler handler);
L
Linus Torvalds 已提交
241 242

acpi_status
L
Len Brown 已提交
243 244 245 246
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 已提交
247 248

acpi_status
L
Len Brown 已提交
249 250 251
acpi_remove_address_space_handler(acpi_handle device,
				  acpi_adr_space_type space_id,
				  acpi_adr_space_handler handler);
L
Linus Torvalds 已提交
252 253

acpi_status
L
Len Brown 已提交
254 255 256
acpi_install_gpe_handler(acpi_handle gpe_device,
			 u32 gpe_number,
			 u32 type, acpi_event_handler address, void *context);
L
Linus Torvalds 已提交
257

258 259 260 261
acpi_status
acpi_remove_gpe_handler(acpi_handle gpe_device,
			u32 gpe_number, acpi_event_handler address);

L
Linus Torvalds 已提交
262
#ifdef ACPI_FUTURE_USAGE
L
Len Brown 已提交
263
acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
L
Linus Torvalds 已提交
264 265 266 267 268
#endif

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

L
Len Brown 已提交
271
acpi_status acpi_release_global_lock(u32 handle);
L
Linus Torvalds 已提交
272

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

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

L
Len Brown 已提交
277
acpi_status acpi_clear_event(u32 event);
L
Linus Torvalds 已提交
278

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

281 282 283
/*
 * GPE Interfaces
 */
284
acpi_status acpi_set_gpe(acpi_handle gpe_device, u32 gpe_number, u8 action);
L
Linus Torvalds 已提交
285

286 287
acpi_status
acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number, u8 gpe_type);
L
Linus Torvalds 已提交
288

289 290
acpi_status
acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number, u8 gpe_type);
L
Linus Torvalds 已提交
291

292
acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number);
L
Linus Torvalds 已提交
293 294

acpi_status
L
Len Brown 已提交
295
acpi_get_gpe_status(acpi_handle gpe_device,
296
		    u32 gpe_number, acpi_event_status *event_status);
L
Linus Torvalds 已提交
297

298 299 300 301
acpi_status acpi_disable_all_gpes(void);

acpi_status acpi_enable_all_runtime_gpes(void);

302 303
acpi_status acpi_get_gpe_device(u32 gpe_index, acpi_handle *gpe_device);

L
Linus Torvalds 已提交
304
acpi_status
L
Len Brown 已提交
305 306 307
acpi_install_gpe_block(acpi_handle gpe_device,
		       struct acpi_generic_address *gpe_block_address,
		       u32 register_count, u32 interrupt_number);
L
Linus Torvalds 已提交
308

L
Len Brown 已提交
309
acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
L
Linus Torvalds 已提交
310 311 312 313 314

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

B
Bob Moore 已提交
318
acpi_status
319
acpi_get_vendor_resource(acpi_handle device,
B
Bob Moore 已提交
320 321 322 323
			 char *name,
			 struct acpi_vendor_uuid *uuid,
			 struct acpi_buffer *ret_buffer);

L
Linus Torvalds 已提交
324
acpi_status
325
acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
326 327 328

#ifdef ACPI_FUTURE_USAGE
acpi_status
329
acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
330 331 332
#endif

acpi_status
333
acpi_walk_resources(acpi_handle device,
B
Bob Moore 已提交
334
		    char *name,
B
Bob Moore 已提交
335
		    acpi_walk_resource_callback user_function, void *context);
L
Linus Torvalds 已提交
336 337

acpi_status
338
acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
L
Linus Torvalds 已提交
339 340

acpi_status
341
acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
342 343

acpi_status
L
Len Brown 已提交
344 345
acpi_resource_to_address64(struct acpi_resource *resource,
			   struct acpi_resource_address64 *out);
L
Linus Torvalds 已提交
346 347 348 349

/*
 * Hardware (ACPI device) interfaces
 */
350 351
acpi_status acpi_reset(void);

352
acpi_status acpi_read_bit_register(u32 register_id, u32 *return_value);
L
Linus Torvalds 已提交
353

354
acpi_status acpi_write_bit_register(u32 register_id, u32 value);
L
Linus Torvalds 已提交
355

356
acpi_status acpi_set_firmware_waking_vector(u32 physical_address);
L
Linus Torvalds 已提交
357

358 359 360
#if ACPI_MACHINE_WIDTH == 64
acpi_status acpi_set_firmware_waking_vector64(u64 physical_address);
#endif
L
Linus Torvalds 已提交
361

362
acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
363

364
acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
365

L
Linus Torvalds 已提交
366
acpi_status
L
Len Brown 已提交
367
acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
L
Linus Torvalds 已提交
368

L
Len Brown 已提交
369
acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
L
Linus Torvalds 已提交
370

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

L
Len Brown 已提交
373
acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
L
Linus Torvalds 已提交
374

375 376
acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);

L
Len Brown 已提交
377
acpi_status acpi_leave_sleep_state(u8 sleep_state);
L
Linus Torvalds 已提交
378

379
/*
380
 * Error/Warning output
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
 */
void ACPI_INTERNAL_VAR_XFACE
acpi_error(const char *module_name,
	   u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);

void ACPI_INTERNAL_VAR_XFACE
acpi_exception(const char *module_name,
	       u32 line_number,
	       acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);

void ACPI_INTERNAL_VAR_XFACE
acpi_warning(const char *module_name,
	     u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);

void ACPI_INTERNAL_VAR_XFACE
acpi_info(const char *module_name,
	  u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);

399 400 401
/*
 * Debug output
 */
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
#ifdef ACPI_DEBUG_OUTPUT

void ACPI_INTERNAL_VAR_XFACE
acpi_debug_print(u32 requested_debug_level,
		 u32 line_number,
		 const char *function_name,
		 const char *module_name,
		 u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);

void ACPI_INTERNAL_VAR_XFACE
acpi_debug_print_raw(u32 requested_debug_level,
		     u32 line_number,
		     const char *function_name,
		     const char *module_name,
		     u32 component_id,
		     const char *format, ...) ACPI_PRINTF_LIKE(6);
#endif

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