acpixf.h 13.3 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 - 2011, 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                 0x20120111
51

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

55 56
extern u8 acpi_gbl_permanent_mmap;

57
/*
L
Lucas De Marchi 已提交
58
 * Globals that are publicly available, allowing for
59 60 61 62 63 64 65
 * 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;
66
extern u8 acpi_gbl_use_default_register_widths;
67 68
extern acpi_name acpi_gbl_trace_method_name;
extern u32 acpi_gbl_trace_flags;
69
extern bool acpi_gbl_enable_aml_debug_object;
70
extern u8 acpi_gbl_copy_dsdt_locally;
71
extern u8 acpi_gbl_truncate_io_addresses;
72
extern u8 acpi_gbl_disable_auto_repair;
73 74 75

extern u32 acpi_current_gpe_count;
extern struct acpi_table_fadt acpi_gbl_FADT;
76
extern u8 acpi_gbl_system_awake_and_running;
77
extern u8 acpi_gbl_reduced_hardware;	/* ACPI 5.0 */
78

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

87
acpi_status __init acpi_initialize_subsystem(void);
L
Linus Torvalds 已提交
88

L
Len Brown 已提交
89
acpi_status acpi_enable_subsystem(u32 flags);
L
Linus Torvalds 已提交
90

L
Len Brown 已提交
91
acpi_status acpi_initialize_objects(u32 flags);
L
Linus Torvalds 已提交
92

L
Len Brown 已提交
93
acpi_status acpi_terminate(void);
L
Linus Torvalds 已提交
94 95

#ifdef ACPI_FUTURE_USAGE
L
Len Brown 已提交
96
acpi_status acpi_subsystem_status(void);
L
Linus Torvalds 已提交
97 98
#endif

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

L
Len Brown 已提交
101
acpi_status acpi_disable(void);
L
Linus Torvalds 已提交
102 103

#ifdef ACPI_FUTURE_USAGE
L
Len Brown 已提交
104
acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
105 106
#endif

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

L
Len Brown 已提交
109
acpi_status acpi_purge_cached_objects(void);
L
Linus Torvalds 已提交
110

111 112 113 114
acpi_status acpi_install_interface(acpi_string interface_name);

acpi_status acpi_remove_interface(acpi_string interface_name);

115 116 117 118 119
u32
acpi_check_address_range(acpi_adr_space_type space_id,
			 acpi_physical_address address,
			 acpi_size length, u8 warn);

L
Linus Torvalds 已提交
120
/*
J
Joe Perches 已提交
121
 * ACPI Memory management
L
Linus Torvalds 已提交
122
 */
L
Len Brown 已提交
123
void *acpi_allocate(u32 size);
L
Linus Torvalds 已提交
124

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

L
Len Brown 已提交
127
void acpi_free(void *address);
L
Linus Torvalds 已提交
128 129 130 131

/*
 * ACPI table manipulation interfaces
 */
132 133
acpi_status acpi_reallocate_root_table(void);

134
acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
L
Linus Torvalds 已提交
135

L
Len Brown 已提交
136
acpi_status acpi_load_tables(void);
L
Linus Torvalds 已提交
137

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

140
acpi_status acpi_unload_table_id(acpi_owner_id id);
L
Linus Torvalds 已提交
141 142

acpi_status
143
acpi_get_table_header(acpi_string signature,
144
		      u32 instance,
145
		      struct acpi_table_header *out_table_header);
L
Linus Torvalds 已提交
146 147

acpi_status
148 149 150 151
acpi_get_table_with_size(acpi_string signature,
	       u32 instance, struct acpi_table_header **out_table,
	       acpi_size *tbl_size);
acpi_status
152
acpi_get_table(acpi_string signature,
153
	       u32 instance, struct acpi_table_header **out_table);
L
Linus Torvalds 已提交
154 155

acpi_status
156
acpi_get_table_by_index(u32 table_index,
157
			struct acpi_table_header **out_table);
L
Linus Torvalds 已提交
158

159 160 161 162 163
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 已提交
164 165 166 167
/*
 * Namespace and name interfaces
 */
acpi_status
L
Len Brown 已提交
168 169 170
acpi_walk_namespace(acpi_object_type type,
		    acpi_handle start_object,
		    u32 max_depth,
171 172
		    acpi_walk_callback pre_order_visit,
		    acpi_walk_callback post_order_visit,
L
Len Brown 已提交
173
		    void *context, void **return_value);
L
Linus Torvalds 已提交
174 175

acpi_status
176
acpi_get_devices(const char *HID,
L
Len Brown 已提交
177 178
		 acpi_walk_callback user_function,
		 void *context, void **return_value);
L
Linus Torvalds 已提交
179 180

acpi_status
181
acpi_get_name(acpi_handle object,
L
Len Brown 已提交
182
	      u32 name_type, struct acpi_buffer *ret_path_ptr);
L
Linus Torvalds 已提交
183 184

acpi_status
L
Len Brown 已提交
185 186
acpi_get_handle(acpi_handle parent,
		acpi_string pathname, acpi_handle * ret_handle);
L
Linus Torvalds 已提交
187 188

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

191
acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
L
Linus Torvalds 已提交
192 193

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

B
Bob Moore 已提交
196 197 198
acpi_status
acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);

L
Linus Torvalds 已提交
199 200 201 202
/*
 * Object manipulation and enumeration
 */
acpi_status
L
Len Brown 已提交
203 204 205 206
acpi_evaluate_object(acpi_handle object,
		     acpi_string pathname,
		     struct acpi_object_list *parameter_objects,
		     struct acpi_buffer *return_object_buffer);
L
Linus Torvalds 已提交
207 208

acpi_status
L
Len Brown 已提交
209 210 211 212 213
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 已提交
214 215

acpi_status
216
acpi_get_object_info(acpi_handle object,
217
		     struct acpi_device_info **return_buffer);
L
Linus Torvalds 已提交
218

219 220
acpi_status acpi_install_method(u8 *buffer);

L
Linus Torvalds 已提交
221
acpi_status
L
Len Brown 已提交
222 223 224
acpi_get_next_object(acpi_object_type type,
		     acpi_handle parent,
		     acpi_handle child, acpi_handle * out_handle);
L
Linus Torvalds 已提交
225

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

228 229
acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);

L
Len Brown 已提交
230
acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
L
Linus Torvalds 已提交
231 232

/*
233
 * Handler interfaces
L
Linus Torvalds 已提交
234
 */
235 236 237
acpi_status
acpi_install_initialization_handler(acpi_init_handler handler, u32 function);

L
Lin Ming 已提交
238 239 240 241
acpi_status
acpi_install_global_event_handler(ACPI_GBL_EVENT_HANDLER handler,
				 void *context);

L
Linus Torvalds 已提交
242
acpi_status
L
Len Brown 已提交
243 244
acpi_install_fixed_event_handler(u32 acpi_event,
				 acpi_event_handler handler, void *context);
L
Linus Torvalds 已提交
245 246

acpi_status
L
Len Brown 已提交
247
acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
L
Linus Torvalds 已提交
248 249

acpi_status
L
Len Brown 已提交
250 251 252
acpi_install_notify_handler(acpi_handle device,
			    u32 handler_type,
			    acpi_notify_handler handler, void *context);
L
Linus Torvalds 已提交
253 254

acpi_status
L
Len Brown 已提交
255 256
acpi_remove_notify_handler(acpi_handle device,
			   u32 handler_type, acpi_notify_handler handler);
L
Linus Torvalds 已提交
257 258

acpi_status
L
Len Brown 已提交
259 260 261 262
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 已提交
263 264

acpi_status
L
Len Brown 已提交
265 266 267
acpi_remove_address_space_handler(acpi_handle device,
				  acpi_adr_space_type space_id,
				  acpi_adr_space_handler handler);
L
Linus Torvalds 已提交
268 269

acpi_status
L
Len Brown 已提交
270 271
acpi_install_gpe_handler(acpi_handle gpe_device,
			 u32 gpe_number,
272
			 u32 type, acpi_gpe_handler address, void *context);
L
Linus Torvalds 已提交
273

274 275
acpi_status
acpi_remove_gpe_handler(acpi_handle gpe_device,
276
			u32 gpe_number, acpi_gpe_handler address);
277

L
Linus Torvalds 已提交
278
#ifdef ACPI_FUTURE_USAGE
L
Len Brown 已提交
279
acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
L
Linus Torvalds 已提交
280 281
#endif

282 283
acpi_status acpi_install_interface_handler(acpi_interface_handler handler);

L
Linus Torvalds 已提交
284
/*
285
 * Global Lock interfaces
L
Linus Torvalds 已提交
286
 */
L
Len Brown 已提交
287
acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle);
L
Linus Torvalds 已提交
288

L
Len Brown 已提交
289
acpi_status acpi_release_global_lock(u32 handle);
L
Linus Torvalds 已提交
290

291 292 293 294 295 296 297 298 299 300 301
/*
 * Interfaces to AML mutex objects
 */
acpi_status
acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);

acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);

/*
 * Fixed Event interfaces
 */
L
Len Brown 已提交
302
acpi_status acpi_enable_event(u32 event, u32 flags);
L
Linus Torvalds 已提交
303

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

L
Len Brown 已提交
306
acpi_status acpi_clear_event(u32 event);
L
Linus Torvalds 已提交
307

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

310
/*
311
 * General Purpose Event (GPE) Interfaces
312
 */
313
acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number);
L
Linus Torvalds 已提交
314

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

317
acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number);
L
Linus Torvalds 已提交
318

L
Lin Ming 已提交
319 320 321 322
acpi_status
acpi_setup_gpe_for_wake(acpi_handle parent_device,
			acpi_handle gpe_device, u32 gpe_number);

323
acpi_status acpi_set_gpe_wake_mask(acpi_handle gpe_device, u32 gpe_number, u8 action);
324

L
Linus Torvalds 已提交
325
acpi_status
L
Len Brown 已提交
326
acpi_get_gpe_status(acpi_handle gpe_device,
327
		    u32 gpe_number, acpi_event_status *event_status);
L
Linus Torvalds 已提交
328

329 330 331 332
acpi_status acpi_disable_all_gpes(void);

acpi_status acpi_enable_all_runtime_gpes(void);

333 334
acpi_status acpi_get_gpe_device(u32 gpe_index, acpi_handle *gpe_device);

L
Linus Torvalds 已提交
335
acpi_status
L
Len Brown 已提交
336 337 338
acpi_install_gpe_block(acpi_handle gpe_device,
		       struct acpi_generic_address *gpe_block_address,
		       u32 register_count, u32 interrupt_number);
L
Linus Torvalds 已提交
339

L
Len Brown 已提交
340
acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
L
Linus Torvalds 已提交
341

342
acpi_status acpi_update_all_gpes(void);
343

L
Linus Torvalds 已提交
344 345 346 347
/*
 * Resource interfaces
 */
typedef
B
Bob Moore 已提交
348
acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
L
Len Brown 已提交
349
					   void *context);
L
Linus Torvalds 已提交
350

B
Bob Moore 已提交
351
acpi_status
352
acpi_get_vendor_resource(acpi_handle device,
B
Bob Moore 已提交
353 354 355 356
			 char *name,
			 struct acpi_vendor_uuid *uuid,
			 struct acpi_buffer *ret_buffer);

L
Linus Torvalds 已提交
357
acpi_status
358
acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
359 360 361

#ifdef ACPI_FUTURE_USAGE
acpi_status
362
acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
363 364
#endif

365 366 367 368
acpi_status
acpi_get_event_resources(acpi_handle device_handle,
			 struct acpi_buffer *ret_buffer);

L
Linus Torvalds 已提交
369
acpi_status
370
acpi_walk_resources(acpi_handle device,
B
Bob Moore 已提交
371
		    char *name,
B
Bob Moore 已提交
372
		    acpi_walk_resource_callback user_function, void *context);
L
Linus Torvalds 已提交
373 374

acpi_status
375
acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
L
Linus Torvalds 已提交
376 377

acpi_status
378
acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
379 380

acpi_status
L
Len Brown 已提交
381 382
acpi_resource_to_address64(struct acpi_resource *resource,
			   struct acpi_resource_address64 *out);
L
Linus Torvalds 已提交
383

384 385 386 387 388
acpi_status
acpi_buffer_to_resource(u8 *aml_buffer,
			u16 aml_buffer_length,
			struct acpi_resource **resource_ptr);

L
Linus Torvalds 已提交
389 390 391
/*
 * Hardware (ACPI device) interfaces
 */
392 393
acpi_status acpi_reset(void);

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

396
acpi_status acpi_write_bit_register(u32 register_id, u32 value);
L
Linus Torvalds 已提交
397

398
acpi_status acpi_set_firmware_waking_vector(u32 physical_address);
L
Linus Torvalds 已提交
399

400 401 402
#if ACPI_MACHINE_WIDTH == 64
acpi_status acpi_set_firmware_waking_vector64(u64 physical_address);
#endif
L
Linus Torvalds 已提交
403

404
acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
405

406
acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
407

L
Linus Torvalds 已提交
408
acpi_status
L
Len Brown 已提交
409
acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
L
Linus Torvalds 已提交
410

L
Len Brown 已提交
411
acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
L
Linus Torvalds 已提交
412

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

L
Len Brown 已提交
415
acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
L
Linus Torvalds 已提交
416

417 418
acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);

L
Len Brown 已提交
419
acpi_status acpi_leave_sleep_state(u8 sleep_state);
L
Linus Torvalds 已提交
420

421 422 423 424 425 426 427 428 429 430 431 432
/*
 * ACPI Timer interfaces
 */
#ifdef ACPI_FUTURE_USAGE
acpi_status acpi_get_timer_resolution(u32 *resolution);

acpi_status acpi_get_timer(u32 *ticks);

acpi_status
acpi_get_timer_duration(u32 start_ticks, u32 end_ticks, u32 *time_elapsed);
#endif				/* ACPI_FUTURE_USAGE */

433
/*
434
 * Error/Warning output
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
 */
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);

453 454 455
/*
 * Debug output
 */
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
#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 已提交
474
#endif				/* __ACXFACE_H__ */