Merge tag 'objtool-core-2023-04-27' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-block.git] / include / acpi / acpixf.h
CommitLineData
95857638 1/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
1da177e4
LT
2/******************************************************************************
3 *
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
5 *
612c2932 6 * Copyright (C) 2000 - 2023, Intel Corp.
1da177e4 7 *
95857638 8 *****************************************************************************/
1da177e4 9
1da177e4
LT
10#ifndef __ACXFACE_H__
11#define __ACXFACE_H__
12
50df4d8b
BM
13/* Current ACPICA subsystem version in YYYYMMDD format */
14
df228665 15#define ACPI_CA_VERSION 0x20230331
50df4d8b 16
a1ce3928
DH
17#include <acpi/acconfig.h>
18#include <acpi/actypes.h>
19#include <acpi/actbl.h>
d8dc91b7 20#include <acpi/acbuffer.h>
1da177e4 21
1011080d
BM
22/*****************************************************************************
23 *
24 * Macros used for ACPICA globals and configuration
25 *
26 ****************************************************************************/
27
50df4d8b 28/*
1011080d 29 * Ensure that global variables are defined and initialized only once.
3035ff70 30 *
1011080d
BM
31 * The use of these macros allows for a single list of globals (here)
32 * in order to simplify maintenance of the code.
50df4d8b 33 */
3035ff70
LZ
34#ifdef DEFINE_ACPI_GLOBALS
35#define ACPI_GLOBAL(type,name) \
36 extern type name; \
37 type name
3e8214e5 38
3035ff70
LZ
39#define ACPI_INIT_GLOBAL(type,name,value) \
40 type name=value
3e8214e5 41
3035ff70
LZ
42#else
43#ifndef ACPI_GLOBAL
44#define ACPI_GLOBAL(type,name) \
45 extern type name
46#endif
3e8214e5 47
3035ff70
LZ
48#ifndef ACPI_INIT_GLOBAL
49#define ACPI_INIT_GLOBAL(type,name,value) \
50 extern type name
51#endif
52#endif
50df4d8b 53
33620c54 54/*
1011080d
BM
55 * These macros configure the various ACPICA interfaces. They are
56 * useful for generating stub inline functions for features that are
57 * configured out of the current kernel or ACPICA application.
33620c54 58 */
8b9c1152
LZ
59#ifndef ACPI_EXTERNAL_RETURN_STATUS
60#define ACPI_EXTERNAL_RETURN_STATUS(prototype) \
33620c54 61 prototype;
8b9c1152 62#endif
33620c54 63
8b9c1152
LZ
64#ifndef ACPI_EXTERNAL_RETURN_OK
65#define ACPI_EXTERNAL_RETURN_OK(prototype) \
33620c54 66 prototype;
8b9c1152 67#endif
33620c54 68
8b9c1152
LZ
69#ifndef ACPI_EXTERNAL_RETURN_VOID
70#define ACPI_EXTERNAL_RETURN_VOID(prototype) \
33620c54 71 prototype;
8b9c1152 72#endif
33620c54 73
8b9c1152
LZ
74#ifndef ACPI_EXTERNAL_RETURN_UINT32
75#define ACPI_EXTERNAL_RETURN_UINT32(prototype) \
76 prototype;
77#endif
33620c54 78
8b9c1152
LZ
79#ifndef ACPI_EXTERNAL_RETURN_PTR
80#define ACPI_EXTERNAL_RETURN_PTR(prototype) \
81 prototype;
82#endif
33620c54 83
3035ff70
LZ
84/*****************************************************************************
85 *
1011080d 86 * Public globals and runtime configuration options
3035ff70
LZ
87 *
88 ****************************************************************************/
33620c54 89
44f6c012 90/*
1011080d 91 * Enable "slack mode" of the AML interpreter? Default is FALSE, and the
3035ff70
LZ
92 * interpreter strictly follows the ACPI specification. Setting to TRUE
93 * allows the interpreter to ignore certain errors and/or bad AML constructs.
94 *
95 * Currently, these features are enabled by this flag:
96 *
97 * 1) Allow "implicit return" of last value in a control method
98 * 2) Allow access beyond the end of an operation region
99 * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
100 * 4) Allow ANY object type to be a source operand for the Store() operator
101 * 5) Allow unresolved references (invalid target name) in package objects
102 * 6) Enable warning messages for behavior that is not ACPI spec compliant
1da177e4 103 */
3035ff70 104ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_interpreter_slack, FALSE);
1da177e4 105
3035ff70
LZ
106/*
107 * Automatically serialize all methods that create named objects? Default
108 * is TRUE, meaning that all non_serialized methods are scanned once at
109 * table load time to determine those that create named objects. Methods
110 * that create named objects are marked Serialized in order to prevent
111 * possible run-time problems if they are entered by more than one thread.
112 */
113ACPI_INIT_GLOBAL(u8, acpi_gbl_auto_serialize_methods, TRUE);
1da177e4 114
75c8044f 115/*
3035ff70
LZ
116 * Create the predefined _OSI method in the namespace? Default is TRUE
117 * because ACPICA is fully compatible with other ACPI implementations.
118 * Changing this will revert ACPICA (and machine ASL) to pre-OSI behavior.
75c8044f 119 */
3035ff70 120ACPI_INIT_GLOBAL(u8, acpi_gbl_create_osi_method, TRUE);
1da177e4 121
3035ff70
LZ
122/*
123 * Optionally use default values for the ACPI register widths. Set this to
124 * TRUE to use the defaults, if an FADT contains incorrect widths/lengths.
125 */
126ACPI_INIT_GLOBAL(u8, acpi_gbl_use_default_register_widths, TRUE);
1da177e4 127
47d68c7f 128/*
023e2ee1
LZ
129 * Whether or not to validate (map) an entire table to verify
130 * checksum/duplication in early stage before install. Set this to TRUE to
131 * allow early table validation before install it to the table manager.
132 * Note that enabling this option causes errors to happen in some OSPMs
133 * during early initialization stages. Default behavior is to allow such
134 * validation.
47d68c7f 135 */
023e2ee1 136ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_table_validation, TRUE);
47d68c7f 137
3035ff70
LZ
138/*
139 * Optionally enable output from the AML Debug Object.
140 */
141ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_aml_debug_object, FALSE);
9187a415 142
3035ff70
LZ
143/*
144 * Optionally copy the entire DSDT to local memory (instead of simply
145 * mapping it.) There are some BIOSs that corrupt or replace the original
146 * DSDT, creating the need for this option. Default is FALSE, do not copy
147 * the DSDT.
148 */
149ACPI_INIT_GLOBAL(u8, acpi_gbl_copy_dsdt_locally, FALSE);
1da177e4 150
3035ff70
LZ
151/*
152 * Optionally ignore an XSDT if present and use the RSDT instead.
153 * Although the ACPI specification requires that an XSDT be used instead
154 * of the RSDT, the XSDT has been found to be corrupt or ill-formed on
155 * some machines. Default behavior is to use the XSDT if present.
156 */
157ACPI_INIT_GLOBAL(u8, acpi_gbl_do_not_use_xsdt, FALSE);
1da177e4 158
3035ff70
LZ
159/*
160 * Optionally use 32-bit FADT addresses if and when there is a conflict
161 * (address mismatch) between the 32-bit and 64-bit versions of the
162 * address. Although ACPICA adheres to the ACPI specification which
163 * requires the use of the corresponding 64-bit address if it is non-zero,
164 * some machines have been found to have a corrupted non-zero 64-bit
0ea61381 165 * address. Default is FALSE, do not favor the 32-bit addresses.
3035ff70 166 */
0ea61381 167ACPI_INIT_GLOBAL(u8, acpi_gbl_use32_bit_fadt_addresses, FALSE);
b0ed7a91 168
c04e1fb4
LZ
169/*
170 * Optionally use 32-bit FACS table addresses.
171 * It is reported that some platforms fail to resume from system suspending
172 * if 64-bit FACS table address is selected:
173 * https://bugzilla.kernel.org/show_bug.cgi?id=74021
174 * Default is TRUE, favor the 32-bit addresses.
175 */
176ACPI_INIT_GLOBAL(u8, acpi_gbl_use32_bit_facs_addresses, TRUE);
177
3035ff70
LZ
178/*
179 * Optionally truncate I/O addresses to 16 bits. Provides compatibility
180 * with other ACPI implementations. NOTE: During ACPICA initialization,
181 * this value is set to TRUE if any Windows OSI strings have been
182 * requested by the BIOS.
183 */
184ACPI_INIT_GLOBAL(u8, acpi_gbl_truncate_io_addresses, FALSE);
b0ed7a91 185
3035ff70
LZ
186/*
187 * Disable runtime checking and repair of values returned by control methods.
188 * Use only if the repair is causing a problem on a particular machine.
189 */
190ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_auto_repair, FALSE);
2cf9f5bc 191
3035ff70
LZ
192/*
193 * Optionally do not install any SSDTs from the RSDT/XSDT during initialization.
194 * This can be useful for debugging ACPI problems on some machines.
195 */
196ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_ssdt_table_install, FALSE);
f654c0fe 197
8ea98655
BM
198/*
199 * Optionally enable runtime namespace override.
200 */
201ACPI_INIT_GLOBAL(u8, acpi_gbl_runtime_namespace_override, TRUE);
202
3035ff70
LZ
203/*
204 * We keep track of the latest version of Windows that has been requested by
fea79bc0 205 * the BIOS. ACPI 5.0.
3035ff70
LZ
206 */
207ACPI_INIT_GLOBAL(u8, acpi_gbl_osi_data, 0);
be030a57 208
1da177e4 209/*
3a2f3a33
LZ
210 * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
211 * that the ACPI hardware is no longer required. A flag in the FADT indicates
212 * a reduced HW machine, and that flag is duplicated here for convenience.
1da177e4 213 */
3a2f3a33 214ACPI_INIT_GLOBAL(u8, acpi_gbl_reduced_hardware, FALSE);
f3d2e786 215
066118ff 216/*
164a08ce 217 * Maximum timeout for While() loop iterations before forced method abort.
066118ff
BM
218 * This mechanism is intended to prevent infinite loops during interpreter
219 * execution within a host kernel.
220 */
164a08ce 221ACPI_INIT_GLOBAL(u32, acpi_gbl_max_loop_iterations, ACPI_MAX_LOOP_TIMEOUT);
066118ff 222
34f206fd
BM
223/*
224 * Optionally ignore AE_NOT_FOUND errors from named reference package elements
225 * during DSDT/SSDT table loading. This reduces error "noise" in platforms
226 * whose firmware is carrying around a bunch of unused package objects that
227 * refer to non-existent named objects. However, If the AML actually tries to
228 * use such a package, the unresolved element(s) will be replaced with NULL
229 * elements.
230 */
231ACPI_INIT_GLOBAL(u8, acpi_gbl_ignore_package_resolution_errors, FALSE);
232
3a2f3a33
LZ
233/*
234 * This mechanism is used to trace a specified AML method. The method is
235 * traced each time it is executed.
236 */
237ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_flags, 0);
ab6c5733
LZ
238ACPI_INIT_GLOBAL(const char *, acpi_gbl_trace_method_name, NULL);
239ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_dbg_level, ACPI_TRACE_LEVEL_DEFAULT);
240ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_dbg_layer, ACPI_TRACE_LAYER_DEFAULT);
1da177e4 241
3a2f3a33
LZ
242/*
243 * Runtime configuration of debug output control masks. We want the debug
244 * switches statically initialized so they are already set when the debugger
245 * is entered.
246 */
247ACPI_INIT_GLOBAL(u32, acpi_dbg_level, ACPI_DEBUG_DEFAULT);
248ACPI_INIT_GLOBAL(u32, acpi_dbg_layer, 0);
1da177e4 249
5e568304
BM
250/* Optionally enable timer output with Debug Object output */
251
252ACPI_INIT_GLOBAL(u8, acpi_gbl_display_debug_timer, FALSE);
253
f8d31489
LZ
254/*
255 * Debugger command handshake globals. Host OSes need to access these
256 * variables to implement their own command handshake mechanism.
257 */
258#ifdef ACPI_DEBUGGER
259ACPI_INIT_GLOBAL(u8, acpi_gbl_method_executing, FALSE);
260ACPI_GLOBAL(char, acpi_gbl_db_line_buf[ACPI_DB_LINE_BUFFER_SIZE]);
261#endif
262
f60d8181 263/*
1011080d 264 * Other miscellaneous globals
f60d8181 265 */
3a2f3a33 266ACPI_GLOBAL(struct acpi_table_fadt, acpi_gbl_FADT);
1011080d 267ACPI_GLOBAL(u32, acpi_current_gpe_count);
3a2f3a33 268ACPI_GLOBAL(u8, acpi_gbl_system_awake_and_running);
f60d8181 269
1011080d
BM
270/*****************************************************************************
271 *
272 * ACPICA public interface configuration.
273 *
274 * Interfaces that are configured out of the ACPICA build are replaced
275 * by inlined stubs by default.
276 *
277 ****************************************************************************/
1da177e4 278
33620c54 279/*
1011080d
BM
280 * Hardware-reduced prototypes (default: Not hardware reduced).
281 *
282 * All ACPICA hardware-related interfaces that use these macros will be
283 * configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
33620c54 284 * is set to TRUE.
1011080d
BM
285 *
286 * Note: This static build option for reduced hardware is intended to
287 * reduce ACPICA code size if desired or necessary. However, even if this
288 * option is not specified, the runtime behavior of ACPICA is dependent
289 * on the actual FADT reduced hardware flag (HW_REDUCED_ACPI). If set,
290 * the flag will enable similar behavior -- ACPICA will not attempt
291 * to access any ACPI-relate hardware (SCI, GPEs, Fixed Events, etc.)
33620c54
BM
292 */
293#if (!ACPI_REDUCED_HARDWARE)
294#define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
8b9c1152 295 ACPI_EXTERNAL_RETURN_STATUS(prototype)
1da177e4 296
33620c54 297#define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
8b9c1152 298 ACPI_EXTERNAL_RETURN_OK(prototype)
1da177e4 299
6921de89
RW
300#define ACPI_HW_DEPENDENT_RETURN_UINT32(prototype) \
301 ACPI_EXTERNAL_RETURN_UINT32(prototype)
302
33620c54 303#define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
8b9c1152 304 ACPI_EXTERNAL_RETURN_VOID(prototype)
cd27d79f 305
33620c54
BM
306#else
307#define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
308 static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
1da177e4 309
33620c54
BM
310#define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
311 static ACPI_INLINE prototype {return(AE_OK);}
1da177e4 312
6921de89
RW
313#define ACPI_HW_DEPENDENT_RETURN_UINT32(prototype) \
314 static ACPI_INLINE prototype {return(0);}
315
33620c54 316#define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
c26f3c90 317 static ACPI_INLINE prototype {return;}
3e08e2d2 318
33620c54 319#endif /* !ACPI_REDUCED_HARDWARE */
3e08e2d2 320
1da177e4 321/*
1011080d
BM
322 * Error message prototypes (default: error messages enabled).
323 *
324 * All interfaces related to error and warning messages
325 * will be configured out of the ACPICA build if the
326 * ACPI_NO_ERROR_MESSAGE flag is defined.
1da177e4 327 */
407e22af
LZ
328#ifndef ACPI_NO_ERROR_MESSAGES
329#define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
330 prototype;
1da177e4 331
407e22af
LZ
332#else
333#define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
334 static ACPI_INLINE prototype {return;}
1da177e4 335
407e22af 336#endif /* ACPI_NO_ERROR_MESSAGES */
1da177e4 337
1ce28c32 338/*
1011080d
BM
339 * Debugging output prototypes (default: no debug output).
340 *
341 * All interfaces related to debug output messages
342 * will be configured out of the ACPICA build unless the
343 * ACPI_DEBUG_OUTPUT flag is defined.
1ce28c32
LZ
344 */
345#ifdef ACPI_DEBUG_OUTPUT
346#define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
347 prototype;
1da177e4 348
1ce28c32
LZ
349#else
350#define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
351 static ACPI_INLINE prototype {return;}
1da177e4 352
1ce28c32 353#endif /* ACPI_DEBUG_OUTPUT */
1da177e4 354
2e70da4c
LZ
355/*
356 * Application prototypes
357 *
358 * All interfaces used by application will be configured
359 * out of the ACPICA build unless the ACPI_APPLICATION
360 * flag is defined.
361 */
362#ifdef ACPI_APPLICATION
363#define ACPI_APP_DEPENDENT_RETURN_VOID(prototype) \
364 prototype;
365
366#else
367#define ACPI_APP_DEPENDENT_RETURN_VOID(prototype) \
368 static ACPI_INLINE prototype {return;}
369
370#endif /* ACPI_APPLICATION */
371
8a2a2501
LZ
372/*
373 * Debugger prototypes
374 *
375 * All interfaces used by debugger will be configured
376 * out of the ACPICA build unless the ACPI_DEBUGGER
377 * flag is defined.
378 */
379#ifdef ACPI_DEBUGGER
380#define ACPI_DBR_DEPENDENT_RETURN_OK(prototype) \
381 ACPI_EXTERNAL_RETURN_OK(prototype)
382
383#define ACPI_DBR_DEPENDENT_RETURN_VOID(prototype) \
384 ACPI_EXTERNAL_RETURN_VOID(prototype)
385
386#else
387#define ACPI_DBR_DEPENDENT_RETURN_OK(prototype) \
388 static ACPI_INLINE prototype {return(AE_OK);}
389
390#define ACPI_DBR_DEPENDENT_RETURN_VOID(prototype) \
391 static ACPI_INLINE prototype {return;}
392
393#endif /* ACPI_DEBUGGER */
394
1011080d
BM
395/*****************************************************************************
396 *
397 * ACPICA public interface prototypes
398 *
399 ****************************************************************************/
7c2e1771 400
44f6c012 401/*
75c8044f 402 * Initialization
1da177e4 403 */
2368b1a1 404ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
8b9c1152
LZ
405 acpi_initialize_tables(struct acpi_table_desc
406 *initial_storage,
407 u32 initial_table_count,
408 u8 allow_resize))
2368b1a1
LZ
409ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
410 acpi_initialize_subsystem(void))
411ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
412 acpi_enable_subsystem(u32 flags))
413ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
414 acpi_initialize_objects(u32 flags))
415ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
416 acpi_terminate(void))
50eca3eb 417
1da177e4 418/*
75c8044f 419 * Miscellaneous global interfaces
1da177e4 420 */
33620c54
BM
421ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
422ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
8b9c1152 423ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_subsystem_status(void))
1da177e4 424
8b9c1152
LZ
425ACPI_EXTERNAL_RETURN_STATUS(acpi_status
426 acpi_get_system_info(struct acpi_buffer
427 *ret_buffer))
8b9c1152
LZ
428ACPI_EXTERNAL_RETURN_STATUS(acpi_status
429 acpi_get_statistics(struct acpi_statistics *stats))
430ACPI_EXTERNAL_RETURN_PTR(const char
431 *acpi_format_exception(acpi_status exception))
432ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_purge_cached_objects(void))
433
434ACPI_EXTERNAL_RETURN_STATUS(acpi_status
435 acpi_install_interface(acpi_string interface_name))
436
437ACPI_EXTERNAL_RETURN_STATUS(acpi_status
438 acpi_remove_interface(acpi_string interface_name))
439ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_update_interfaces(u8 action))
440
441ACPI_EXTERNAL_RETURN_UINT32(u32
442 acpi_check_address_range(acpi_adr_space_type
443 space_id,
444 acpi_physical_address
445 address, acpi_size length,
446 u8 warn))
447ACPI_EXTERNAL_RETURN_STATUS(acpi_status
448 acpi_decode_pld_buffer(u8 *in_buffer,
449 acpi_size length,
450 struct acpi_pld_info
451 **return_buffer))
1da177e4 452
1da177e4 453/*
f60d8181 454 * ACPI table load/unload interfaces
1da177e4 455 */
2368b1a1 456ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
5d6e5966 457 acpi_install_table(struct acpi_table_header *table))
1da177e4 458
5d6e5966
JC
459ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
460 acpi_install_physical_table(acpi_physical_address
461 address))
8b9c1152 462ACPI_EXTERNAL_RETURN_STATUS(acpi_status
1770093c
NV
463 acpi_load_table(struct acpi_table_header *table,
464 u32 *table_idx))
b2f7ddcf 465
42d939fa
BM
466ACPI_EXTERNAL_RETURN_STATUS(acpi_status
467 acpi_unload_table(u32 table_index))
468
8b9c1152
LZ
469ACPI_EXTERNAL_RETURN_STATUS(acpi_status
470 acpi_unload_parent_table(acpi_handle object))
2368b1a1
LZ
471
472ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
473 acpi_load_tables(void))
1da177e4 474
f60d8181
BM
475/*
476 * ACPI table manipulation interfaces
477 */
2368b1a1
LZ
478ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
479 acpi_reallocate_root_table(void))
8b9c1152 480
2368b1a1 481ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
f5c1e1c5
LZ
482 acpi_find_root_pointer(acpi_physical_address
483 *rsdp_address))
8b9c1152 484ACPI_EXTERNAL_RETURN_STATUS(acpi_status
f254e3c5
LZ
485 acpi_get_table_header(acpi_string signature,
486 u32 instance,
487 struct acpi_table_header
488 *out_table_header))
8b9c1152
LZ
489ACPI_EXTERNAL_RETURN_STATUS(acpi_status
490 acpi_get_table(acpi_string signature, u32 instance,
491 struct acpi_table_header
492 **out_table))
174cc718
LZ
493ACPI_EXTERNAL_RETURN_VOID(void acpi_put_table(struct acpi_table_header *table))
494
8b9c1152 495ACPI_EXTERNAL_RETURN_STATUS(acpi_status
174cc718
LZ
496 acpi_get_table_by_index(u32 table_index,
497 struct acpi_table_header
498 **out_table))
8b9c1152
LZ
499ACPI_EXTERNAL_RETURN_STATUS(acpi_status
500 acpi_install_table_handler(acpi_table_handler
501 handler, void *context))
502ACPI_EXTERNAL_RETURN_STATUS(acpi_status
503 acpi_remove_table_handler(acpi_table_handler
504 handler))
1da177e4 505
1da177e4
LT
506/*
507 * Namespace and name interfaces
508 */
8b9c1152
LZ
509ACPI_EXTERNAL_RETURN_STATUS(acpi_status
510 acpi_walk_namespace(acpi_object_type type,
511 acpi_handle start_object,
512 u32 max_depth,
513 acpi_walk_callback
514 descending_callback,
515 acpi_walk_callback
516 ascending_callback,
517 void *context,
518 void **return_value))
519ACPI_EXTERNAL_RETURN_STATUS(acpi_status
520 acpi_get_devices(const char *HID,
521 acpi_walk_callback user_function,
522 void *context,
523 void **return_value))
524ACPI_EXTERNAL_RETURN_STATUS(acpi_status
525 acpi_get_name(acpi_handle object, u32 name_type,
526 struct acpi_buffer *ret_path_ptr))
527ACPI_EXTERNAL_RETURN_STATUS(acpi_status
528 acpi_get_handle(acpi_handle parent,
91fdb91c 529 const char *pathname,
f5c1e1c5 530 acpi_handle *ret_handle))
8b9c1152
LZ
531ACPI_EXTERNAL_RETURN_STATUS(acpi_status
532 acpi_attach_data(acpi_handle object,
533 acpi_object_handler handler,
534 void *data))
535ACPI_EXTERNAL_RETURN_STATUS(acpi_status
536 acpi_detach_data(acpi_handle object,
537 acpi_object_handler handler))
538ACPI_EXTERNAL_RETURN_STATUS(acpi_status
539 acpi_get_data(acpi_handle object,
540 acpi_object_handler handler,
541 void **data))
542ACPI_EXTERNAL_RETURN_STATUS(acpi_status
ab6c5733 543 acpi_debug_trace(const char *name, u32 debug_level,
8b9c1152 544 u32 debug_layer, u32 flags))
0f0fe1a0 545
1da177e4
LT
546/*
547 * Object manipulation and enumeration
548 */
8b9c1152
LZ
549ACPI_EXTERNAL_RETURN_STATUS(acpi_status
550 acpi_evaluate_object(acpi_handle object,
551 acpi_string pathname,
552 struct acpi_object_list
553 *parameter_objects,
554 struct acpi_buffer
555 *return_object_buffer))
556ACPI_EXTERNAL_RETURN_STATUS(acpi_status
557 acpi_evaluate_object_typed(acpi_handle object,
558 acpi_string pathname,
559 struct acpi_object_list
560 *external_params,
561 struct acpi_buffer
562 *return_buffer,
563 acpi_object_type
564 return_type))
565ACPI_EXTERNAL_RETURN_STATUS(acpi_status
566 acpi_get_object_info(acpi_handle object,
567 struct acpi_device_info
568 **return_buffer))
569ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_install_method(u8 *buffer))
570
571ACPI_EXTERNAL_RETURN_STATUS(acpi_status
572 acpi_get_next_object(acpi_object_type type,
573 acpi_handle parent,
574 acpi_handle child,
f5c1e1c5 575 acpi_handle *out_handle))
8b9c1152
LZ
576
577ACPI_EXTERNAL_RETURN_STATUS(acpi_status
578 acpi_get_type(acpi_handle object,
f5c1e1c5 579 acpi_object_type *out_type))
8b9c1152
LZ
580
581ACPI_EXTERNAL_RETURN_STATUS(acpi_status
582 acpi_get_parent(acpi_handle object,
f5c1e1c5 583 acpi_handle *out_handle))
1da177e4
LT
584
585/*
ecfbbc7b 586 * Handler interfaces
1da177e4 587 */
8b9c1152
LZ
588ACPI_EXTERNAL_RETURN_STATUS(acpi_status
589 acpi_install_initialization_handler
590 (acpi_init_handler handler, u32 function))
33620c54 591ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
7a9d74e7
HG
592 acpi_install_sci_handler(acpi_sci_handler
593 address,
594 void *context))
a2fd4b4b 595ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
7a9d74e7
HG
596 acpi_remove_sci_handler(acpi_sci_handler
597 address))
33620c54 598ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
7a9d74e7
HG
599 acpi_install_global_event_handler
600 (acpi_gbl_event_handler handler,
601 void *context))
33620c54 602ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
7a9d74e7
HG
603 acpi_install_fixed_event_handler(u32
604 acpi_event,
33620c54 605 acpi_event_handler
7a9d74e7
HG
606 handler,
607 void
608 *context))
0d0988af 609ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
7a9d74e7
HG
610 acpi_remove_fixed_event_handler(u32 acpi_event,
611 acpi_event_handler
612 handler))
33620c54 613ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
7a9d74e7
HG
614 acpi_install_gpe_handler(acpi_handle
615 gpe_device,
33620c54 616 u32 gpe_number,
7a9d74e7 617 u32 type,
33620c54 618 acpi_gpe_handler
7a9d74e7 619 address,
8b9c1152 620 void *context))
7a9d74e7
HG
621ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
622 acpi_install_gpe_raw_handler(acpi_handle
623 gpe_device,
624 u32 gpe_number,
625 u32 type,
626 acpi_gpe_handler
627 address,
628 void *context))
629ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
630 acpi_remove_gpe_handler(acpi_handle gpe_device,
631 u32 gpe_number,
632 acpi_gpe_handler
633 address))
8b9c1152 634ACPI_EXTERNAL_RETURN_STATUS(acpi_status
7a9d74e7 635 acpi_install_notify_handler(acpi_handle device,
8b9c1152
LZ
636 u32 handler_type,
637 acpi_notify_handler
7a9d74e7
HG
638 handler,
639 void *context))
640ACPI_EXTERNAL_RETURN_STATUS(acpi_status
641 acpi_remove_notify_handler(acpi_handle device,
642 u32 handler_type,
643 acpi_notify_handler
644 handler))
645ACPI_EXTERNAL_RETURN_STATUS(acpi_status
646 acpi_install_address_space_handler(acpi_handle
8b9c1152
LZ
647 device,
648 acpi_adr_space_type
649 space_id,
650 acpi_adr_space_handler
7a9d74e7
HG
651 handler,
652 acpi_adr_space_setup
653 setup,
654 void *context))
54c516ae
HG
655ACPI_EXTERNAL_RETURN_STATUS(acpi_status
656 acpi_install_address_space_handler_no_reg
657 (acpi_handle device, acpi_adr_space_type space_id,
658 acpi_adr_space_handler handler,
659 acpi_adr_space_setup setup,
660 void *context))
661ACPI_EXTERNAL_RETURN_STATUS(acpi_status
662 acpi_execute_reg_methods(acpi_handle device,
663 acpi_adr_space_type
664 space_id))
7a9d74e7
HG
665ACPI_EXTERNAL_RETURN_STATUS(acpi_status
666 acpi_remove_address_space_handler(acpi_handle
667 device,
668 acpi_adr_space_type
669 space_id,
670 acpi_adr_space_handler
671 handler))
672ACPI_EXTERNAL_RETURN_STATUS(acpi_status
673 acpi_install_exception_handler
674 (acpi_exception_handler handler))
675ACPI_EXTERNAL_RETURN_STATUS(acpi_status
676 acpi_install_interface_handler
677 (acpi_interface_handler handler))
b0ed7a91 678
1da177e4 679/*
ffef6827 680 * Global Lock interfaces
1da177e4 681 */
33620c54
BM
682ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
683 acpi_acquire_global_lock(u16 timeout,
684 u32 *handle))
cd27d79f 685
33620c54
BM
686ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
687 acpi_release_global_lock(u32 handle))
1da177e4 688
ffef6827
LM
689/*
690 * Interfaces to AML mutex objects
691 */
8b9c1152
LZ
692ACPI_EXTERNAL_RETURN_STATUS(acpi_status
693 acpi_acquire_mutex(acpi_handle handle,
694 acpi_string pathname,
695 u16 timeout))
ffef6827 696
8b9c1152
LZ
697ACPI_EXTERNAL_RETURN_STATUS(acpi_status
698 acpi_release_mutex(acpi_handle handle,
699 acpi_string pathname))
ffef6827
LM
700
701/*
702 * Fixed Event interfaces
703 */
33620c54
BM
704ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
705 acpi_enable_event(u32 event, u32 flags))
1da177e4 706
33620c54
BM
707ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
708 acpi_disable_event(u32 event, u32 flags))
33620c54 709ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
1da177e4 710
33620c54
BM
711ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
712 acpi_get_event_status(u32 event,
713 acpi_event_status
714 *event_status))
cd27d79f 715
08ac07b8 716/*
ffef6827 717 * General Purpose Event (GPE) Interfaces
08ac07b8 718 */
33620c54
BM
719ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
720
721ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
722 acpi_enable_gpe(acpi_handle gpe_device,
723 u32 gpe_number))
724
725ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
726 acpi_disable_gpe(acpi_handle gpe_device,
727 u32 gpe_number))
728
729ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
730 acpi_clear_gpe(acpi_handle gpe_device,
731 u32 gpe_number))
732
733ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
734 acpi_set_gpe(acpi_handle gpe_device,
735 u32 gpe_number, u8 action))
736
737ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
738 acpi_finish_gpe(acpi_handle gpe_device,
739 u32 gpe_number))
740
2af52c2b
LZ
741ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
742 acpi_mask_gpe(acpi_handle gpe_device,
743 u32 gpe_number, u8 is_masked))
744
c12f07d1
RW
745ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
746 acpi_mark_gpe_for_wake(acpi_handle gpe_device,
747 u32 gpe_number))
748
33620c54
BM
749ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
750 acpi_setup_gpe_for_wake(acpi_handle
751 parent_device,
752 acpi_handle gpe_device,
753 u32 gpe_number))
754ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
755 acpi_set_gpe_wake_mask(acpi_handle gpe_device,
756 u32 gpe_number,
757 u8 action))
758ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
759 acpi_get_gpe_status(acpi_handle gpe_device,
760 u32 gpe_number,
761 acpi_event_status
762 *event_status))
6921de89 763ACPI_HW_DEPENDENT_RETURN_UINT32(u32 acpi_dispatch_gpe(acpi_handle gpe_device, u32 gpe_number))
33620c54 764ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
33620c54 765ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
e0fa975d 766ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_wakeup_gpes(void))
0ce792d6 767ACPI_HW_DEPENDENT_RETURN_UINT32(u32 acpi_any_gpe_status_set(u32 gpe_skip_number))
63fb9623 768ACPI_HW_DEPENDENT_RETURN_UINT32(u32 acpi_any_fixed_event_status_set(void))
33620c54
BM
769
770ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
771 acpi_get_gpe_device(u32 gpe_index,
f5c1e1c5 772 acpi_handle *gpe_device))
33620c54
BM
773
774ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
775 acpi_install_gpe_block(acpi_handle gpe_device,
776 struct
777 acpi_generic_address
778 *gpe_block_address,
779 u32 register_count,
780 u32 interrupt_number))
781ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
782 acpi_remove_gpe_block(acpi_handle gpe_device))
a2100801 783
1da177e4
LT
784/*
785 * Resource interfaces
786 */
1da177e4 787typedef
f5c1e1c5
LZ
788acpi_status (*acpi_walk_resource_callback) (struct acpi_resource * resource,
789 void *context);
1da177e4 790
8b9c1152
LZ
791ACPI_EXTERNAL_RETURN_STATUS(acpi_status
792 acpi_get_vendor_resource(acpi_handle device,
793 char *name,
794 struct acpi_vendor_uuid
795 *uuid,
796 struct acpi_buffer
797 *ret_buffer))
798ACPI_EXTERNAL_RETURN_STATUS(acpi_status
799 acpi_get_current_resources(acpi_handle device,
800 struct acpi_buffer
801 *ret_buffer))
8b9c1152
LZ
802ACPI_EXTERNAL_RETURN_STATUS(acpi_status
803 acpi_get_possible_resources(acpi_handle device,
804 struct acpi_buffer
805 *ret_buffer))
8b9c1152
LZ
806ACPI_EXTERNAL_RETURN_STATUS(acpi_status
807 acpi_get_event_resources(acpi_handle device_handle,
808 struct acpi_buffer
809 *ret_buffer))
810ACPI_EXTERNAL_RETURN_STATUS(acpi_status
811 acpi_walk_resource_buffer(struct acpi_buffer
812 *buffer,
813 acpi_walk_resource_callback
814 user_function,
815 void *context))
816ACPI_EXTERNAL_RETURN_STATUS(acpi_status
817 acpi_walk_resources(acpi_handle device, char *name,
818 acpi_walk_resource_callback
819 user_function, void *context))
820ACPI_EXTERNAL_RETURN_STATUS(acpi_status
821 acpi_set_current_resources(acpi_handle device,
822 struct acpi_buffer
823 *in_buffer))
824ACPI_EXTERNAL_RETURN_STATUS(acpi_status
825 acpi_get_irq_routing_table(acpi_handle device,
826 struct acpi_buffer
827 *ret_buffer))
828ACPI_EXTERNAL_RETURN_STATUS(acpi_status
829 acpi_resource_to_address64(struct acpi_resource
830 *resource,
831 struct
832 acpi_resource_address64
833 *out))
834ACPI_EXTERNAL_RETURN_STATUS(acpi_status
835 acpi_buffer_to_resource(u8 *aml_buffer,
836 u16 aml_buffer_length,
837 struct acpi_resource
838 **resource_ptr))
0e243178 839
1da177e4
LT
840/*
841 * Hardware (ACPI device) interfaces
842 */
8b9c1152 843ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_reset(void))
d3fd902d 844
8b9c1152
LZ
845ACPI_EXTERNAL_RETURN_STATUS(acpi_status
846 acpi_read(u64 *value,
847 struct acpi_generic_address *reg))
739dcbb9 848
8b9c1152
LZ
849ACPI_EXTERNAL_RETURN_STATUS(acpi_status
850 acpi_write(u64 value,
851 struct acpi_generic_address *reg))
739dcbb9 852
33620c54
BM
853ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
854 acpi_read_bit_register(u32 register_id,
855 u32 *return_value))
1da177e4 856
33620c54
BM
857ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
858 acpi_write_bit_register(u32 register_id,
859 u32 value))
1da177e4 860
33620c54
BM
861/*
862 * Sleep/Wake interfaces
863 */
8b9c1152
LZ
864ACPI_EXTERNAL_RETURN_STATUS(acpi_status
865 acpi_get_sleep_type_data(u8 sleep_state,
866 u8 *slp_typ_a,
867 u8 *slp_typ_b))
1da177e4 868
8b9c1152
LZ
869ACPI_EXTERNAL_RETURN_STATUS(acpi_status
870 acpi_enter_sleep_state_prep(u8 sleep_state))
871ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_enter_sleep_state(u8 sleep_state))
1da177e4 872
40bce100 873ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void))
1da177e4 874
8b9c1152
LZ
875ACPI_EXTERNAL_RETURN_STATUS(acpi_status
876 acpi_leave_sleep_state_prep(u8 sleep_state))
877ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_leave_sleep_state(u8 sleep_state))
1da177e4 878
739dcbb9 879ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
e3e9b577 880 acpi_set_firmware_waking_vector
aca2a5d3
LZ
881 (acpi_physical_address physical_address,
882 acpi_physical_address physical_address64))
d08310fe
BM
883/*
884 * ACPI Timer interfaces
885 */
33620c54
BM
886ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
887 acpi_get_timer_resolution(u32 *resolution))
33620c54 888ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
d08310fe 889
33620c54
BM
890ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
891 acpi_get_timer_duration(u32 start_ticks,
892 u32 end_ticks,
893 u32 *time_elapsed))
d08310fe 894
50df4d8b 895/*
b74be611 896 * Error/Warning output
50df4d8b 897 */
407e22af
LZ
898ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
899 void ACPI_INTERNAL_VAR_XFACE
900 acpi_error(const char *module_name,
901 u32 line_number,
902 const char *format, ...))
903ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(4)
904 void ACPI_INTERNAL_VAR_XFACE
905 acpi_exception(const char *module_name,
906 u32 line_number,
907 acpi_status status,
908 const char *format, ...))
909ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
910 void ACPI_INTERNAL_VAR_XFACE
911 acpi_warning(const char *module_name,
912 u32 line_number,
913 const char *format, ...))
05fb04b5 914ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(1)
407e22af 915 void ACPI_INTERNAL_VAR_XFACE
05fb04b5 916 acpi_info(const char *format, ...))
407e22af
LZ
917ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
918 void ACPI_INTERNAL_VAR_XFACE
919 acpi_bios_error(const char *module_name,
920 u32 line_number,
921 const char *format, ...))
f13c274d
BM
922ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(4)
923 void ACPI_INTERNAL_VAR_XFACE
924 acpi_bios_exception(const char *module_name,
925 u32 line_number,
926 acpi_status status,
927 const char *format, ...))
407e22af
LZ
928ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
929 void ACPI_INTERNAL_VAR_XFACE
930 acpi_bios_warning(const char *module_name,
931 u32 line_number,
932 const char *format, ...))
62cdd141 933
b74be611
BM
934/*
935 * Debug output
936 */
1ce28c32
LZ
937ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
938 void ACPI_INTERNAL_VAR_XFACE
939 acpi_debug_print(u32 requested_debug_level,
940 u32 line_number,
941 const char *function_name,
942 const char *module_name,
943 u32 component_id,
944 const char *format, ...))
945ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
946 void ACPI_INTERNAL_VAR_XFACE
947 acpi_debug_print_raw(u32 requested_debug_level,
948 u32 line_number,
949 const char *function_name,
950 const char *module_name,
951 u32 component_id,
952 const char *format, ...))
bab04824
LZ
953
954ACPI_DBG_DEPENDENT_RETURN_VOID(void
955 acpi_trace_point(acpi_trace_event_type type,
956 u8 begin,
957 u8 *aml, char *pathname))
f5c1e1c5
LZ
958
959acpi_status acpi_initialize_debugger(void);
f8fb4c38
LZ
960
961void acpi_terminate_debugger(void);
50df4d8b 962
0dedb3c4
LZ
963/*
964 * Divergences
965 */
a8278efd
LZ
966ACPI_EXTERNAL_RETURN_STATUS(acpi_status
967 acpi_get_data_full(acpi_handle object,
968 acpi_object_handler handler,
969 void **data,
970 void (*callback)(void *)))
50df4d8b 971
f8d31489
LZ
972void acpi_run_debugger(char *batch_buffer);
973
f988f24e
LZ
974void acpi_set_debugger_thread_id(acpi_thread_id thread_id);
975
4be44fcd 976#endif /* __ACXFACE_H__ */