acpixf.h 12.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 - 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 */

L
Lin Ming 已提交
50
#define ACPI_CA_VERSION                 0x20101209
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 u32 acpi_gbl_enable_aml_debug_object;
70
extern u8 acpi_gbl_copy_dsdt_locally;
71
extern u8 acpi_gbl_truncate_io_addresses;
72 73 74

extern u32 acpi_current_gpe_count;
extern struct acpi_table_fadt acpi_gbl_FADT;
75
extern u8 acpi_gbl_system_awake_and_running;
76

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

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

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

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

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

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

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

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

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

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

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

109 110 111 112
acpi_status acpi_install_interface(acpi_string interface_name);

acpi_status acpi_remove_interface(acpi_string interface_name);

L
Linus Torvalds 已提交
113
/*
J
Joe Perches 已提交
114
 * ACPI Memory management
L
Linus Torvalds 已提交
115
 */
L
Len Brown 已提交
116
void *acpi_allocate(u32 size);
L
Linus Torvalds 已提交
117

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

L
Len Brown 已提交
120
void acpi_free(void *address);
L
Linus Torvalds 已提交
121 122 123 124

/*
 * ACPI table manipulation interfaces
 */
125 126
acpi_status acpi_reallocate_root_table(void);

127
acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
L
Linus Torvalds 已提交
128

L
Len Brown 已提交
129
acpi_status acpi_load_tables(void);
L
Linus Torvalds 已提交
130

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

133
acpi_status acpi_unload_table_id(acpi_owner_id id);
L
Linus Torvalds 已提交
134 135

acpi_status
136
acpi_get_table_header(acpi_string signature,
137
		      u32 instance,
138
		      struct acpi_table_header *out_table_header);
L
Linus Torvalds 已提交
139 140

acpi_status
141 142 143 144
acpi_get_table_with_size(acpi_string signature,
	       u32 instance, struct acpi_table_header **out_table,
	       acpi_size *tbl_size);
acpi_status
145
acpi_get_table(acpi_string signature,
146
	       u32 instance, struct acpi_table_header **out_table);
L
Linus Torvalds 已提交
147 148

acpi_status
149
acpi_get_table_by_index(u32 table_index,
150
			struct acpi_table_header **out_table);
L
Linus Torvalds 已提交
151

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

acpi_status
169
acpi_get_devices(const char *HID,
L
Len Brown 已提交
170 171
		 acpi_walk_callback user_function,
		 void *context, void **return_value);
L
Linus Torvalds 已提交
172 173

acpi_status
174
acpi_get_name(acpi_handle object,
L
Len Brown 已提交
175
	      u32 name_type, struct acpi_buffer *ret_path_ptr);
L
Linus Torvalds 已提交
176 177

acpi_status
L
Len Brown 已提交
178 179
acpi_get_handle(acpi_handle parent,
		acpi_string pathname, acpi_handle * ret_handle);
L
Linus Torvalds 已提交
180 181

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

184
acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
L
Linus Torvalds 已提交
185 186

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

B
Bob Moore 已提交
189 190 191
acpi_status
acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);

L
Linus Torvalds 已提交
192 193 194 195
/*
 * Object manipulation and enumeration
 */
acpi_status
L
Len Brown 已提交
196 197 198 199
acpi_evaluate_object(acpi_handle object,
		     acpi_string pathname,
		     struct acpi_object_list *parameter_objects,
		     struct acpi_buffer *return_object_buffer);
L
Linus Torvalds 已提交
200 201

acpi_status
L
Len Brown 已提交
202 203 204 205 206
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 已提交
207 208

acpi_status
209
acpi_get_object_info(acpi_handle object,
210
		     struct acpi_device_info **return_buffer);
L
Linus Torvalds 已提交
211

212 213
acpi_status acpi_install_method(u8 *buffer);

L
Linus Torvalds 已提交
214
acpi_status
L
Len Brown 已提交
215 216 217
acpi_get_next_object(acpi_object_type type,
		     acpi_handle parent,
		     acpi_handle child, acpi_handle * out_handle);
L
Linus Torvalds 已提交
218

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

221 222
acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);

L
Len Brown 已提交
223
acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
L
Linus Torvalds 已提交
224 225

/*
226
 * Handler interfaces
L
Linus Torvalds 已提交
227
 */
228 229 230
acpi_status
acpi_install_initialization_handler(acpi_init_handler handler, u32 function);

L
Lin Ming 已提交
231 232 233 234
acpi_status
acpi_install_global_event_handler(ACPI_GBL_EVENT_HANDLER handler,
				 void *context);

L
Linus Torvalds 已提交
235
acpi_status
L
Len Brown 已提交
236 237
acpi_install_fixed_event_handler(u32 acpi_event,
				 acpi_event_handler handler, void *context);
L
Linus Torvalds 已提交
238 239

acpi_status
L
Len Brown 已提交
240
acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
L
Linus Torvalds 已提交
241 242

acpi_status
L
Len Brown 已提交
243 244 245
acpi_install_notify_handler(acpi_handle device,
			    u32 handler_type,
			    acpi_notify_handler handler, void *context);
L
Linus Torvalds 已提交
246 247

acpi_status
L
Len Brown 已提交
248 249
acpi_remove_notify_handler(acpi_handle device,
			   u32 handler_type, acpi_notify_handler handler);
L
Linus Torvalds 已提交
250 251

acpi_status
L
Len Brown 已提交
252 253 254 255
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 已提交
256 257

acpi_status
L
Len Brown 已提交
258 259 260
acpi_remove_address_space_handler(acpi_handle device,
				  acpi_adr_space_type space_id,
				  acpi_adr_space_handler handler);
L
Linus Torvalds 已提交
261 262

acpi_status
L
Len Brown 已提交
263 264
acpi_install_gpe_handler(acpi_handle gpe_device,
			 u32 gpe_number,
265
			 u32 type, acpi_gpe_handler address, void *context);
L
Linus Torvalds 已提交
266

267 268
acpi_status
acpi_remove_gpe_handler(acpi_handle gpe_device,
269
			u32 gpe_number, acpi_gpe_handler address);
270

L
Linus Torvalds 已提交
271
#ifdef ACPI_FUTURE_USAGE
L
Len Brown 已提交
272
acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
L
Linus Torvalds 已提交
273 274
#endif

275 276
acpi_status acpi_install_interface_handler(acpi_interface_handler handler);

L
Linus Torvalds 已提交
277 278 279
/*
 * Event interfaces
 */
L
Len Brown 已提交
280
acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle);
L
Linus Torvalds 已提交
281

L
Len Brown 已提交
282
acpi_status acpi_release_global_lock(u32 handle);
L
Linus Torvalds 已提交
283

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

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

L
Len Brown 已提交
288
acpi_status acpi_clear_event(u32 event);
L
Linus Torvalds 已提交
289

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

292 293 294
/*
 * GPE Interfaces
 */
295
acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number);
L
Linus Torvalds 已提交
296

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

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

L
Lin Ming 已提交
301 302 303 304
acpi_status
acpi_setup_gpe_for_wake(acpi_handle parent_device,
			acpi_handle gpe_device, u32 gpe_number);

305
acpi_status acpi_set_gpe_wake_mask(acpi_handle gpe_device, u32 gpe_number, u8 action);
306

L
Linus Torvalds 已提交
307
acpi_status
L
Len Brown 已提交
308
acpi_get_gpe_status(acpi_handle gpe_device,
309
		    u32 gpe_number, acpi_event_status *event_status);
L
Linus Torvalds 已提交
310

311 312 313 314
acpi_status acpi_disable_all_gpes(void);

acpi_status acpi_enable_all_runtime_gpes(void);

315 316
acpi_status acpi_get_gpe_device(u32 gpe_index, acpi_handle *gpe_device);

L
Linus Torvalds 已提交
317
acpi_status
L
Len Brown 已提交
318 319 320
acpi_install_gpe_block(acpi_handle gpe_device,
		       struct acpi_generic_address *gpe_block_address,
		       u32 register_count, u32 interrupt_number);
L
Linus Torvalds 已提交
321

L
Len Brown 已提交
322
acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
L
Linus Torvalds 已提交
323

324
acpi_status acpi_update_all_gpes(void);
325

L
Linus Torvalds 已提交
326 327 328 329
/*
 * Resource interfaces
 */
typedef
B
Bob Moore 已提交
330
acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
L
Len Brown 已提交
331
					   void *context);
L
Linus Torvalds 已提交
332

B
Bob Moore 已提交
333
acpi_status
334
acpi_get_vendor_resource(acpi_handle device,
B
Bob Moore 已提交
335 336 337 338
			 char *name,
			 struct acpi_vendor_uuid *uuid,
			 struct acpi_buffer *ret_buffer);

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

#ifdef ACPI_FUTURE_USAGE
acpi_status
344
acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
345 346 347
#endif

acpi_status
348
acpi_walk_resources(acpi_handle device,
B
Bob Moore 已提交
349
		    char *name,
B
Bob Moore 已提交
350
		    acpi_walk_resource_callback user_function, void *context);
L
Linus Torvalds 已提交
351 352

acpi_status
353
acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
L
Linus Torvalds 已提交
354 355

acpi_status
356
acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
357 358

acpi_status
L
Len Brown 已提交
359 360
acpi_resource_to_address64(struct acpi_resource *resource,
			   struct acpi_resource_address64 *out);
L
Linus Torvalds 已提交
361 362 363 364

/*
 * Hardware (ACPI device) interfaces
 */
365 366
acpi_status acpi_reset(void);

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

369
acpi_status acpi_write_bit_register(u32 register_id, u32 value);
L
Linus Torvalds 已提交
370

371
acpi_status acpi_set_firmware_waking_vector(u32 physical_address);
L
Linus Torvalds 已提交
372

373 374 375
#if ACPI_MACHINE_WIDTH == 64
acpi_status acpi_set_firmware_waking_vector64(u64 physical_address);
#endif
L
Linus Torvalds 已提交
376

377
acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
378

379
acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
380

L
Linus Torvalds 已提交
381
acpi_status
L
Len Brown 已提交
382
acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
L
Linus Torvalds 已提交
383

L
Len Brown 已提交
384
acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
L
Linus Torvalds 已提交
385

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

L
Len Brown 已提交
388
acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
L
Linus Torvalds 已提交
389

390 391
acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);

L
Len Brown 已提交
392
acpi_status acpi_leave_sleep_state(u8 sleep_state);
L
Linus Torvalds 已提交
393

394
/*
395
 * Error/Warning output
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
 */
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);

414 415 416
/*
 * Debug output
 */
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
#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 已提交
435
#endif				/* __ACXFACE_H__ */