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