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 - 2019, 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 0x20190816
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 */
104 ACPI_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 */
113 ACPI_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 */
120 ACPI_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 */
126 ACPI_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 */
136 ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_table_validation, TRUE);
137
138 /*
139 * Optionally enable output from the AML Debug Object.
140 */
141 ACPI_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 */
149 ACPI_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 */
157 ACPI_INIT_GLOBAL(u8, acpi_gbl_do_not_use_xsdt, FALSE);
158
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
165 * address. Default is FALSE, do not favor the 32-bit addresses.
166 */
167 ACPI_INIT_GLOBAL(u8, acpi_gbl_use32_bit_fadt_addresses, FALSE);
168
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 */
176 ACPI_INIT_GLOBAL(u8, acpi_gbl_use32_bit_facs_addresses, TRUE);
177
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 */
184 ACPI_INIT_GLOBAL(u8, acpi_gbl_truncate_io_addresses, FALSE);
185
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 */
190 ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_auto_repair, FALSE);
191
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 */
196 ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_ssdt_table_install, FALSE);
197
198 /*
199 * Optionally enable runtime namespace override.
200 */
201 ACPI_INIT_GLOBAL(u8, acpi_gbl_runtime_namespace_override, TRUE);
202
203 /*
204 * We keep track of the latest version of Windows that has been requested by
205 * the BIOS. ACPI 5.0.
206 */
207 ACPI_INIT_GLOBAL(u8, acpi_gbl_osi_data, 0);
208
209 /*
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.
213 */
214 ACPI_INIT_GLOBAL(u8, acpi_gbl_reduced_hardware, FALSE);
215
216 /*
217 * Maximum timeout for While() loop iterations before forced method abort.
218 * This mechanism is intended to prevent infinite loops during interpreter
219 * execution within a host kernel.
220 */
221 ACPI_INIT_GLOBAL(u32, acpi_gbl_max_loop_iterations, ACPI_MAX_LOOP_TIMEOUT);
222
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 */
231 ACPI_INIT_GLOBAL(u8, acpi_gbl_ignore_package_resolution_errors, FALSE);
232
233 /*
234 * This mechanism is used to trace a specified AML method. The method is
235 * traced each time it is executed.
236 */
237 ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_flags, 0);
238 ACPI_INIT_GLOBAL(const char *, acpi_gbl_trace_method_name, NULL);
239 ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_dbg_level, ACPI_TRACE_LEVEL_DEFAULT);
240 ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_dbg_layer, ACPI_TRACE_LAYER_DEFAULT);
241
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 */
247 ACPI_INIT_GLOBAL(u32, acpi_dbg_level, ACPI_DEBUG_DEFAULT);
248 ACPI_INIT_GLOBAL(u32, acpi_dbg_layer, 0);
249
250 /* Optionally enable timer output with Debug Object output */
251
252 ACPI_INIT_GLOBAL(u8, acpi_gbl_display_debug_timer, FALSE);
253
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
259 ACPI_INIT_GLOBAL(u8, acpi_gbl_method_executing, FALSE);
260 ACPI_GLOBAL(char, acpi_gbl_db_line_buf[ACPI_DB_LINE_BUFFER_SIZE]);
261 #endif
262
263 /*
264 * Other miscellaneous globals
265 */
266 ACPI_GLOBAL(struct acpi_table_fadt, acpi_gbl_FADT);
267 ACPI_GLOBAL(u32, acpi_current_gpe_count);
268 ACPI_GLOBAL(u8, acpi_gbl_system_awake_and_running);
269
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 ****************************************************************************/
278
279 /*
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
284 * is set to TRUE.
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.)
292 */
293 #if (!ACPI_REDUCED_HARDWARE)
294 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
295 ACPI_EXTERNAL_RETURN_STATUS(prototype)
296
297 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
298 ACPI_EXTERNAL_RETURN_OK(prototype)
299
300 #define ACPI_HW_DEPENDENT_RETURN_UINT32(prototype) \
301 ACPI_EXTERNAL_RETURN_UINT32(prototype)
302
303 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
304 ACPI_EXTERNAL_RETURN_VOID(prototype)
305
306 #else
307 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
308 static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
309
310 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
311 static ACPI_INLINE prototype {return(AE_OK);}
312
313 #define ACPI_HW_DEPENDENT_RETURN_UINT32(prototype) \
314 static ACPI_INLINE prototype {return(0);}
315
316 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
317 static ACPI_INLINE prototype {return;}
318
319 #endif /* !ACPI_REDUCED_HARDWARE */
320
321 /*
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.
327 */
328 #ifndef ACPI_NO_ERROR_MESSAGES
329 #define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
330 prototype;
331
332 #else
333 #define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
334 static ACPI_INLINE prototype {return;}
335
336 #endif /* ACPI_NO_ERROR_MESSAGES */
337
338 /*
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.
344 */
345 #ifdef ACPI_DEBUG_OUTPUT
346 #define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
347 prototype;
348
349 #else
350 #define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
351 static ACPI_INLINE prototype {return;}
352
353 #endif /* ACPI_DEBUG_OUTPUT */
354
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
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
395 /*****************************************************************************
396 *
397 * ACPICA public interface prototypes
398 *
399 ****************************************************************************/
400
401 /*
402 * Initialization
403 */
404 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
405 acpi_initialize_tables(struct acpi_table_desc
406 *initial_storage,
407 u32 initial_table_count,
408 u8 allow_resize))
409 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
410 acpi_initialize_subsystem(void))
411 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
412 acpi_enable_subsystem(u32 flags))
413 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
414 acpi_initialize_objects(u32 flags))
415 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
416 acpi_terminate(void))
417
418 /*
419 * Miscellaneous global interfaces
420 */
421 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
422 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
423 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_subsystem_status(void))
424
425 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
426 acpi_get_system_info(struct acpi_buffer
427 *ret_buffer))
428 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
429 acpi_get_statistics(struct acpi_statistics *stats))
430 ACPI_EXTERNAL_RETURN_PTR(const char
431 *acpi_format_exception(acpi_status exception))
432 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_purge_cached_objects(void))
433
434 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
435 acpi_install_interface(acpi_string interface_name))
436
437 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
438 acpi_remove_interface(acpi_string interface_name))
439 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_update_interfaces(u8 action))
440
441 ACPI_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))
447 ACPI_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))
452
453 /*
454 * ACPI table load/unload interfaces
455 */
456 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
457 acpi_install_table(acpi_physical_address address,
458 u8 physical))
459
460 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
461 acpi_load_table(struct acpi_table_header *table))
462
463 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
464 acpi_unload_parent_table(acpi_handle object))
465
466 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
467 acpi_load_tables(void))
468
469 /*
470 * ACPI table manipulation interfaces
471 */
472 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
473 acpi_reallocate_root_table(void))
474
475 ACPI_EXTERNAL_RETURN_STATUS(acpi_status ACPI_INIT_FUNCTION
476 acpi_find_root_pointer(acpi_physical_address
477 *rsdp_address))
478 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
479 acpi_get_table_header(acpi_string signature,
480 u32 instance,
481 struct acpi_table_header
482 *out_table_header))
483 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
484 acpi_get_table(acpi_string signature, u32 instance,
485 struct acpi_table_header
486 **out_table))
487 ACPI_EXTERNAL_RETURN_VOID(void acpi_put_table(struct acpi_table_header *table))
488
489 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
490 acpi_get_table_by_index(u32 table_index,
491 struct acpi_table_header
492 **out_table))
493 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
494 acpi_install_table_handler(acpi_table_handler
495 handler, void *context))
496 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
497 acpi_remove_table_handler(acpi_table_handler
498 handler))
499
500 /*
501 * Namespace and name interfaces
502 */
503 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
504 acpi_walk_namespace(acpi_object_type type,
505 acpi_handle start_object,
506 u32 max_depth,
507 acpi_walk_callback
508 descending_callback,
509 acpi_walk_callback
510 ascending_callback,
511 void *context,
512 void **return_value))
513 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
514 acpi_get_devices(const char *HID,
515 acpi_walk_callback user_function,
516 void *context,
517 void **return_value))
518 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
519 acpi_get_name(acpi_handle object, u32 name_type,
520 struct acpi_buffer *ret_path_ptr))
521 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
522 acpi_get_handle(acpi_handle parent,
523 acpi_string pathname,
524 acpi_handle *ret_handle))
525 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
526 acpi_attach_data(acpi_handle object,
527 acpi_object_handler handler,
528 void *data))
529 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
530 acpi_detach_data(acpi_handle object,
531 acpi_object_handler handler))
532 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
533 acpi_get_data(acpi_handle object,
534 acpi_object_handler handler,
535 void **data))
536 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
537 acpi_debug_trace(const char *name, u32 debug_level,
538 u32 debug_layer, u32 flags))
539
540 /*
541 * Object manipulation and enumeration
542 */
543 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
544 acpi_evaluate_object(acpi_handle object,
545 acpi_string pathname,
546 struct acpi_object_list
547 *parameter_objects,
548 struct acpi_buffer
549 *return_object_buffer))
550 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
551 acpi_evaluate_object_typed(acpi_handle object,
552 acpi_string pathname,
553 struct acpi_object_list
554 *external_params,
555 struct acpi_buffer
556 *return_buffer,
557 acpi_object_type
558 return_type))
559 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
560 acpi_get_object_info(acpi_handle object,
561 struct acpi_device_info
562 **return_buffer))
563 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_install_method(u8 *buffer))
564
565 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
566 acpi_get_next_object(acpi_object_type type,
567 acpi_handle parent,
568 acpi_handle child,
569 acpi_handle *out_handle))
570
571 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
572 acpi_get_type(acpi_handle object,
573 acpi_object_type *out_type))
574
575 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
576 acpi_get_parent(acpi_handle object,
577 acpi_handle *out_handle))
578
579 /*
580 * Handler interfaces
581 */
582 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
583 acpi_install_initialization_handler
584 (acpi_init_handler handler, u32 function))
585 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
586 acpi_install_sci_handler(acpi_sci_handler
587 address,
588 void *context))
589 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
590 acpi_remove_sci_handler(acpi_sci_handler
591 address))
592 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
593 acpi_install_global_event_handler
594 (acpi_gbl_event_handler handler,
595 void *context))
596 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
597 acpi_install_fixed_event_handler(u32
598 acpi_event,
599 acpi_event_handler
600 handler,
601 void
602 *context))
603 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
604 acpi_remove_fixed_event_handler(u32 acpi_event,
605 acpi_event_handler
606 handler))
607 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
608 acpi_install_gpe_handler(acpi_handle
609 gpe_device,
610 u32 gpe_number,
611 u32 type,
612 acpi_gpe_handler
613 address,
614 void *context))
615 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
616 acpi_install_gpe_raw_handler(acpi_handle
617 gpe_device,
618 u32 gpe_number,
619 u32 type,
620 acpi_gpe_handler
621 address,
622 void *context))
623 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
624 acpi_remove_gpe_handler(acpi_handle gpe_device,
625 u32 gpe_number,
626 acpi_gpe_handler
627 address))
628 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
629 acpi_install_notify_handler(acpi_handle device,
630 u32 handler_type,
631 acpi_notify_handler
632 handler,
633 void *context))
634 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
635 acpi_remove_notify_handler(acpi_handle device,
636 u32 handler_type,
637 acpi_notify_handler
638 handler))
639 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
640 acpi_install_address_space_handler(acpi_handle
641 device,
642 acpi_adr_space_type
643 space_id,
644 acpi_adr_space_handler
645 handler,
646 acpi_adr_space_setup
647 setup,
648 void *context))
649 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
650 acpi_remove_address_space_handler(acpi_handle
651 device,
652 acpi_adr_space_type
653 space_id,
654 acpi_adr_space_handler
655 handler))
656 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
657 acpi_install_exception_handler
658 (acpi_exception_handler handler))
659 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
660 acpi_install_interface_handler
661 (acpi_interface_handler handler))
662
663 /*
664 * Global Lock interfaces
665 */
666 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
667 acpi_acquire_global_lock(u16 timeout,
668 u32 *handle))
669
670 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
671 acpi_release_global_lock(u32 handle))
672
673 /*
674 * Interfaces to AML mutex objects
675 */
676 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
677 acpi_acquire_mutex(acpi_handle handle,
678 acpi_string pathname,
679 u16 timeout))
680
681 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
682 acpi_release_mutex(acpi_handle handle,
683 acpi_string pathname))
684
685 /*
686 * Fixed Event interfaces
687 */
688 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
689 acpi_enable_event(u32 event, u32 flags))
690
691 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
692 acpi_disable_event(u32 event, u32 flags))
693 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
694
695 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
696 acpi_get_event_status(u32 event,
697 acpi_event_status
698 *event_status))
699
700 /*
701 * General Purpose Event (GPE) Interfaces
702 */
703 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
704
705 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
706 acpi_enable_gpe(acpi_handle gpe_device,
707 u32 gpe_number))
708
709 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
710 acpi_disable_gpe(acpi_handle gpe_device,
711 u32 gpe_number))
712
713 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
714 acpi_clear_gpe(acpi_handle gpe_device,
715 u32 gpe_number))
716
717 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
718 acpi_set_gpe(acpi_handle gpe_device,
719 u32 gpe_number, u8 action))
720
721 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
722 acpi_finish_gpe(acpi_handle gpe_device,
723 u32 gpe_number))
724
725 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
726 acpi_mask_gpe(acpi_handle gpe_device,
727 u32 gpe_number, u8 is_masked))
728
729 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
730 acpi_mark_gpe_for_wake(acpi_handle gpe_device,
731 u32 gpe_number))
732
733 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
734 acpi_setup_gpe_for_wake(acpi_handle
735 parent_device,
736 acpi_handle gpe_device,
737 u32 gpe_number))
738 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
739 acpi_set_gpe_wake_mask(acpi_handle gpe_device,
740 u32 gpe_number,
741 u8 action))
742 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
743 acpi_get_gpe_status(acpi_handle gpe_device,
744 u32 gpe_number,
745 acpi_event_status
746 *event_status))
747 ACPI_HW_DEPENDENT_RETURN_UINT32(u32 acpi_dispatch_gpe(acpi_handle gpe_device, u32 gpe_number))
748 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
749 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
750 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_wakeup_gpes(void))
751 ACPI_HW_DEPENDENT_RETURN_UINT32(u32 acpi_any_gpe_status_set(u32 gpe_skip_number))
752 ACPI_HW_DEPENDENT_RETURN_UINT32(u32 acpi_any_fixed_event_status_set(void))
753
754 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
755 acpi_get_gpe_device(u32 gpe_index,
756 acpi_handle *gpe_device))
757
758 ACPI_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))
765 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
766 acpi_remove_gpe_block(acpi_handle gpe_device))
767
768 /*
769 * Resource interfaces
770 */
771 typedef
772 acpi_status (*acpi_walk_resource_callback) (struct acpi_resource * resource,
773 void *context);
774
775 ACPI_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))
782 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
783 acpi_get_current_resources(acpi_handle device,
784 struct acpi_buffer
785 *ret_buffer))
786 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
787 acpi_get_possible_resources(acpi_handle device,
788 struct acpi_buffer
789 *ret_buffer))
790 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
791 acpi_get_event_resources(acpi_handle device_handle,
792 struct acpi_buffer
793 *ret_buffer))
794 ACPI_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))
800 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
801 acpi_walk_resources(acpi_handle device, char *name,
802 acpi_walk_resource_callback
803 user_function, void *context))
804 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
805 acpi_set_current_resources(acpi_handle device,
806 struct acpi_buffer
807 *in_buffer))
808 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
809 acpi_get_irq_routing_table(acpi_handle device,
810 struct acpi_buffer
811 *ret_buffer))
812 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
813 acpi_resource_to_address64(struct acpi_resource
814 *resource,
815 struct
816 acpi_resource_address64
817 *out))
818 ACPI_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 */
827 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_reset(void))
828
829 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
830 acpi_read(u64 *value,
831 struct acpi_generic_address *reg))
832
833 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
834 acpi_write(u64 value,
835 struct acpi_generic_address *reg))
836
837 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
838 acpi_read_bit_register(u32 register_id,
839 u32 *return_value))
840
841 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
842 acpi_write_bit_register(u32 register_id,
843 u32 value))
844
845 /*
846 * Sleep/Wake interfaces
847 */
848 ACPI_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
853 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
854 acpi_enter_sleep_state_prep(u8 sleep_state))
855 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_enter_sleep_state(u8 sleep_state))
856
857 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void))
858
859 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
860 acpi_leave_sleep_state_prep(u8 sleep_state))
861 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_leave_sleep_state(u8 sleep_state))
862
863 ACPI_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 */
870 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
871 acpi_get_timer_resolution(u32 *resolution))
872 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
873
874 ACPI_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 */
882 ACPI_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, ...))
887 ACPI_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, ...))
893 ACPI_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, ...))
898 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(1)
899 void ACPI_INTERNAL_VAR_XFACE
900 acpi_info(const char *format, ...))
901 ACPI_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, ...))
906 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(4)
907 void ACPI_INTERNAL_VAR_XFACE
908 acpi_bios_exception(const char *module_name,
909 u32 line_number,
910 acpi_status status,
911 const char *format, ...))
912 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
913 void ACPI_INTERNAL_VAR_XFACE
914 acpi_bios_warning(const char *module_name,
915 u32 line_number,
916 const char *format, ...))
917
918 /*
919 * Debug output
920 */
921 ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
922 void ACPI_INTERNAL_VAR_XFACE
923 acpi_debug_print(u32 requested_debug_level,
924 u32 line_number,
925 const char *function_name,
926 const char *module_name,
927 u32 component_id,
928 const char *format, ...))
929 ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
930 void ACPI_INTERNAL_VAR_XFACE
931 acpi_debug_print_raw(u32 requested_debug_level,
932 u32 line_number,
933 const char *function_name,
934 const char *module_name,
935 u32 component_id,
936 const char *format, ...))
937
938 ACPI_DBG_DEPENDENT_RETURN_VOID(void
939 acpi_trace_point(acpi_trace_event_type type,
940 u8 begin,
941 u8 *aml, char *pathname))
942
943 acpi_status acpi_initialize_debugger(void);
944
945 void acpi_terminate_debugger(void);
946
947 /*
948 * Divergences
949 */
950 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
951 acpi_get_data_full(acpi_handle object,
952 acpi_object_handler handler,
953 void **data,
954 void (*callback)(void *)))
955
956 void acpi_run_debugger(char *batch_buffer);
957
958 void acpi_set_debugger_thread_id(acpi_thread_id thread_id);
959
960 #endif /* __ACXFACE_H__ */