acpixf.h 11.7 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
 * 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                 0x20090320
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 67 68 69 70 71 72
/*
 * 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;
extern acpi_name acpi_gbl_trace_method_name;
extern u32 acpi_gbl_trace_flags;

extern u32 acpi_current_gpe_count;
extern struct acpi_table_fadt acpi_gbl_FADT;

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

81
acpi_status __init acpi_initialize_subsystem(void);
L
Linus Torvalds 已提交
82

L
Len Brown 已提交
83
acpi_status acpi_enable_subsystem(u32 flags);
L
Linus Torvalds 已提交
84

L
Len Brown 已提交
85
acpi_status acpi_initialize_objects(u32 flags);
L
Linus Torvalds 已提交
86

L
Len Brown 已提交
87
acpi_status acpi_terminate(void);
L
Linus Torvalds 已提交
88 89

#ifdef ACPI_FUTURE_USAGE
L
Len Brown 已提交
90
acpi_status acpi_subsystem_status(void);
L
Linus Torvalds 已提交
91 92
#endif

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

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

#ifdef ACPI_FUTURE_USAGE
L
Len Brown 已提交
98
acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
99 100
#endif

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

L
Len Brown 已提交
103
acpi_status acpi_purge_cached_objects(void);
L
Linus Torvalds 已提交
104 105

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

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

L
Len Brown 已提交
112
void acpi_free(void *address);
L
Linus Torvalds 已提交
113 114 115 116

/*
 * ACPI table manipulation interfaces
 */
117 118
acpi_status acpi_reallocate_root_table(void);

119
acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
L
Linus Torvalds 已提交
120

L
Len Brown 已提交
121
acpi_status acpi_load_tables(void);
L
Linus Torvalds 已提交
122

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

125
acpi_status acpi_unload_table_id(acpi_owner_id id);
L
Linus Torvalds 已提交
126 127

acpi_status
128
acpi_get_table_header(acpi_string signature,
129
		      u32 instance,
130
		      struct acpi_table_header *out_table_header);
L
Linus Torvalds 已提交
131 132

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

acpi_status
141
acpi_get_table_by_index(u32 table_index,
142
			struct acpi_table_header **out_table);
L
Linus Torvalds 已提交
143

144 145 146 147 148
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 已提交
149 150 151 152
/*
 * Namespace and name interfaces
 */
acpi_status
L
Len Brown 已提交
153 154 155 156 157
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 已提交
158 159

acpi_status
160
acpi_get_devices(const char *HID,
L
Len Brown 已提交
161 162
		 acpi_walk_callback user_function,
		 void *context, void **return_value);
L
Linus Torvalds 已提交
163 164

acpi_status
L
Len Brown 已提交
165 166
acpi_get_name(acpi_handle handle,
	      u32 name_type, struct acpi_buffer *ret_path_ptr);
L
Linus Torvalds 已提交
167 168

acpi_status
L
Len Brown 已提交
169 170
acpi_get_handle(acpi_handle parent,
		acpi_string pathname, acpi_handle * ret_handle);
L
Linus Torvalds 已提交
171 172

acpi_status
L
Len Brown 已提交
173 174
acpi_attach_data(acpi_handle obj_handle,
		 acpi_object_handler handler, void *data);
L
Linus Torvalds 已提交
175 176

acpi_status
L
Len Brown 已提交
177
acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler);
L
Linus Torvalds 已提交
178 179

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

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

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

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

acpi_status
L
Len Brown 已提交
202
acpi_get_object_info(acpi_handle handle, struct acpi_buffer *return_buffer);
L
Linus Torvalds 已提交
203 204

acpi_status
L
Len Brown 已提交
205 206 207
acpi_get_next_object(acpi_object_type type,
		     acpi_handle parent,
		     acpi_handle child, acpi_handle * out_handle);
L
Linus Torvalds 已提交
208

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

211 212
acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);

L
Len Brown 已提交
213
acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
L
Linus Torvalds 已提交
214 215

/*
216
 * Handler interfaces
L
Linus Torvalds 已提交
217
 */
218 219 220
acpi_status
acpi_install_initialization_handler(acpi_init_handler handler, u32 function);

L
Linus Torvalds 已提交
221
acpi_status
L
Len Brown 已提交
222 223
acpi_install_fixed_event_handler(u32 acpi_event,
				 acpi_event_handler handler, void *context);
L
Linus Torvalds 已提交
224 225

acpi_status
L
Len Brown 已提交
226
acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
L
Linus Torvalds 已提交
227 228

acpi_status
L
Len Brown 已提交
229 230 231
acpi_install_notify_handler(acpi_handle device,
			    u32 handler_type,
			    acpi_notify_handler handler, void *context);
L
Linus Torvalds 已提交
232 233

acpi_status
L
Len Brown 已提交
234 235
acpi_remove_notify_handler(acpi_handle device,
			   u32 handler_type, acpi_notify_handler handler);
L
Linus Torvalds 已提交
236 237

acpi_status
L
Len Brown 已提交
238 239 240 241
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 已提交
242 243

acpi_status
L
Len Brown 已提交
244 245 246
acpi_remove_address_space_handler(acpi_handle device,
				  acpi_adr_space_type space_id,
				  acpi_adr_space_handler handler);
L
Linus Torvalds 已提交
247 248

acpi_status
L
Len Brown 已提交
249 250 251
acpi_install_gpe_handler(acpi_handle gpe_device,
			 u32 gpe_number,
			 u32 type, acpi_event_handler address, void *context);
L
Linus Torvalds 已提交
252

253 254 255 256
acpi_status
acpi_remove_gpe_handler(acpi_handle gpe_device,
			u32 gpe_number, acpi_event_handler address);

L
Linus Torvalds 已提交
257
#ifdef ACPI_FUTURE_USAGE
L
Len Brown 已提交
258
acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
L
Linus Torvalds 已提交
259 260 261 262 263
#endif

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

L
Len Brown 已提交
266
acpi_status acpi_release_global_lock(u32 handle);
L
Linus Torvalds 已提交
267

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

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

L
Len Brown 已提交
272
acpi_status acpi_clear_event(u32 event);
L
Linus Torvalds 已提交
273

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

276 277 278
/*
 * GPE Interfaces
 */
L
Len Brown 已提交
279
acpi_status acpi_set_gpe_type(acpi_handle gpe_device, u32 gpe_number, u8 type);
L
Linus Torvalds 已提交
280

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

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

L
Len Brown 已提交
285
acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
L
Linus Torvalds 已提交
286 287

acpi_status
L
Len Brown 已提交
288 289 290
acpi_get_gpe_status(acpi_handle gpe_device,
		    u32 gpe_number,
		    u32 flags, acpi_event_status * event_status);
L
Linus Torvalds 已提交
291

292 293 294 295
acpi_status acpi_disable_all_gpes(void);

acpi_status acpi_enable_all_runtime_gpes(void);

296 297
acpi_status acpi_get_gpe_device(u32 gpe_index, acpi_handle *gpe_device);

L
Linus Torvalds 已提交
298
acpi_status
L
Len Brown 已提交
299 300 301
acpi_install_gpe_block(acpi_handle gpe_device,
		       struct acpi_generic_address *gpe_block_address,
		       u32 register_count, u32 interrupt_number);
L
Linus Torvalds 已提交
302

L
Len Brown 已提交
303
acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
L
Linus Torvalds 已提交
304 305 306 307 308

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

B
Bob Moore 已提交
312 313 314 315 316 317
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 已提交
318
acpi_status
L
Len Brown 已提交
319 320
acpi_get_current_resources(acpi_handle device_handle,
			   struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
321 322 323

#ifdef ACPI_FUTURE_USAGE
acpi_status
L
Len Brown 已提交
324 325
acpi_get_possible_resources(acpi_handle device_handle,
			    struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
326 327 328
#endif

acpi_status
L
Len Brown 已提交
329
acpi_walk_resources(acpi_handle device_handle,
B
Bob Moore 已提交
330
		    char *name,
B
Bob Moore 已提交
331
		    acpi_walk_resource_callback user_function, void *context);
L
Linus Torvalds 已提交
332 333

acpi_status
L
Len Brown 已提交
334 335
acpi_set_current_resources(acpi_handle device_handle,
			   struct acpi_buffer *in_buffer);
L
Linus Torvalds 已提交
336 337

acpi_status
L
Len Brown 已提交
338 339
acpi_get_irq_routing_table(acpi_handle bus_device_handle,
			   struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
340 341

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

/*
 * Hardware (ACPI device) interfaces
 */
348 349
acpi_status acpi_reset(void);

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

352
acpi_status acpi_write_bit_register(u32 register_id, u32 value);
L
Linus Torvalds 已提交
353

354
acpi_status acpi_set_firmware_waking_vector(u32 physical_address);
L
Linus Torvalds 已提交
355

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

360 361 362 363
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 已提交
364
acpi_status
L
Len Brown 已提交
365
acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
L
Linus Torvalds 已提交
366

L
Len Brown 已提交
367
acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
L
Linus Torvalds 已提交
368

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

L
Len Brown 已提交
371
acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
L
Linus Torvalds 已提交
372

373 374
acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);

L
Len Brown 已提交
375
acpi_status acpi_leave_sleep_state(u8 sleep_state);
L
Linus Torvalds 已提交
376

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
/*
 * Debug output
 */
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);

#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 已提交
415
#endif				/* __ACXFACE_H__ */