xref: /openbmc/linux/include/acpi/acpixf.h (revision 0da85d1e)
1 /******************************************************************************
2  *
3  * Name: acpixf.h - External interfaces to the ACPI subsystem
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2015, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43 
44 #ifndef __ACXFACE_H__
45 #define __ACXFACE_H__
46 
47 /* Current ACPICA subsystem version in YYYYMMDD format */
48 
49 #define ACPI_CA_VERSION                 0x20150410
50 
51 #include <acpi/acconfig.h>
52 #include <acpi/actypes.h>
53 #include <acpi/actbl.h>
54 #include <acpi/acbuffer.h>
55 
56 /*****************************************************************************
57  *
58  * Macros used for ACPICA globals and configuration
59  *
60  ****************************************************************************/
61 
62 /*
63  * Ensure that global variables are defined and initialized only once.
64  *
65  * The use of these macros allows for a single list of globals (here)
66  * in order to simplify maintenance of the code.
67  */
68 #ifdef DEFINE_ACPI_GLOBALS
69 #define ACPI_GLOBAL(type,name) \
70 	extern type name; \
71 	type name
72 
73 #define ACPI_INIT_GLOBAL(type,name,value) \
74 	type name=value
75 
76 #else
77 #ifndef ACPI_GLOBAL
78 #define ACPI_GLOBAL(type,name) \
79 	extern type name
80 #endif
81 
82 #ifndef ACPI_INIT_GLOBAL
83 #define ACPI_INIT_GLOBAL(type,name,value) \
84 	extern type name
85 #endif
86 #endif
87 
88 /*
89  * These macros configure the various ACPICA interfaces. They are
90  * useful for generating stub inline functions for features that are
91  * configured out of the current kernel or ACPICA application.
92  */
93 #ifndef ACPI_EXTERNAL_RETURN_STATUS
94 #define ACPI_EXTERNAL_RETURN_STATUS(prototype) \
95 	prototype;
96 #endif
97 
98 #ifndef ACPI_EXTERNAL_RETURN_OK
99 #define ACPI_EXTERNAL_RETURN_OK(prototype) \
100 	prototype;
101 #endif
102 
103 #ifndef ACPI_EXTERNAL_RETURN_VOID
104 #define ACPI_EXTERNAL_RETURN_VOID(prototype) \
105 	prototype;
106 #endif
107 
108 #ifndef ACPI_EXTERNAL_RETURN_UINT32
109 #define ACPI_EXTERNAL_RETURN_UINT32(prototype) \
110 	prototype;
111 #endif
112 
113 #ifndef ACPI_EXTERNAL_RETURN_PTR
114 #define ACPI_EXTERNAL_RETURN_PTR(prototype) \
115 	prototype;
116 #endif
117 
118 /*****************************************************************************
119  *
120  * Public globals and runtime configuration options
121  *
122  ****************************************************************************/
123 
124 /*
125  * Enable "slack mode" of the AML interpreter?  Default is FALSE, and the
126  * interpreter strictly follows the ACPI specification. Setting to TRUE
127  * allows the interpreter to ignore certain errors and/or bad AML constructs.
128  *
129  * Currently, these features are enabled by this flag:
130  *
131  * 1) Allow "implicit return" of last value in a control method
132  * 2) Allow access beyond the end of an operation region
133  * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
134  * 4) Allow ANY object type to be a source operand for the Store() operator
135  * 5) Allow unresolved references (invalid target name) in package objects
136  * 6) Enable warning messages for behavior that is not ACPI spec compliant
137  */
138 ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_interpreter_slack, FALSE);
139 
140 /*
141  * Automatically serialize all methods that create named objects? Default
142  * is TRUE, meaning that all non_serialized methods are scanned once at
143  * table load time to determine those that create named objects. Methods
144  * that create named objects are marked Serialized in order to prevent
145  * possible run-time problems if they are entered by more than one thread.
146  */
147 ACPI_INIT_GLOBAL(u8, acpi_gbl_auto_serialize_methods, TRUE);
148 
149 /*
150  * Create the predefined _OSI method in the namespace? Default is TRUE
151  * because ACPICA is fully compatible with other ACPI implementations.
152  * Changing this will revert ACPICA (and machine ASL) to pre-OSI behavior.
153  */
154 ACPI_INIT_GLOBAL(u8, acpi_gbl_create_osi_method, TRUE);
155 
156 /*
157  * Optionally use default values for the ACPI register widths. Set this to
158  * TRUE to use the defaults, if an FADT contains incorrect widths/lengths.
159  */
160 ACPI_INIT_GLOBAL(u8, acpi_gbl_use_default_register_widths, TRUE);
161 
162 /*
163  * Whether or not to verify the table checksum before installation. Set
164  * this to TRUE to verify the table checksum before install it to the table
165  * manager. Note that enabling this option causes errors to happen in some
166  * OSPMs during early initialization stages. Default behavior is to do such
167  * verification.
168  */
169 ACPI_INIT_GLOBAL(u8, acpi_gbl_verify_table_checksum, TRUE);
170 
171 /*
172  * Optionally enable output from the AML Debug Object.
173  */
174 ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_aml_debug_object, FALSE);
175 
176 /*
177  * Optionally copy the entire DSDT to local memory (instead of simply
178  * mapping it.) There are some BIOSs that corrupt or replace the original
179  * DSDT, creating the need for this option. Default is FALSE, do not copy
180  * the DSDT.
181  */
182 ACPI_INIT_GLOBAL(u8, acpi_gbl_copy_dsdt_locally, FALSE);
183 
184 /*
185  * Optionally ignore an XSDT if present and use the RSDT instead.
186  * Although the ACPI specification requires that an XSDT be used instead
187  * of the RSDT, the XSDT has been found to be corrupt or ill-formed on
188  * some machines. Default behavior is to use the XSDT if present.
189  */
190 ACPI_INIT_GLOBAL(u8, acpi_gbl_do_not_use_xsdt, FALSE);
191 
192 /*
193  * Optionally use 32-bit FADT addresses if and when there is a conflict
194  * (address mismatch) between the 32-bit and 64-bit versions of the
195  * address. Although ACPICA adheres to the ACPI specification which
196  * requires the use of the corresponding 64-bit address if it is non-zero,
197  * some machines have been found to have a corrupted non-zero 64-bit
198  * address. Default is TRUE, favor the 32-bit addresses.
199  */
200 ACPI_INIT_GLOBAL(u8, acpi_gbl_use32_bit_fadt_addresses, TRUE);
201 
202 /*
203  * Optionally truncate I/O addresses to 16 bits. Provides compatibility
204  * with other ACPI implementations. NOTE: During ACPICA initialization,
205  * this value is set to TRUE if any Windows OSI strings have been
206  * requested by the BIOS.
207  */
208 ACPI_INIT_GLOBAL(u8, acpi_gbl_truncate_io_addresses, FALSE);
209 
210 /*
211  * Disable runtime checking and repair of values returned by control methods.
212  * Use only if the repair is causing a problem on a particular machine.
213  */
214 ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_auto_repair, FALSE);
215 
216 /*
217  * Optionally do not install any SSDTs from the RSDT/XSDT during initialization.
218  * This can be useful for debugging ACPI problems on some machines.
219  */
220 ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_ssdt_table_install, FALSE);
221 
222 /*
223  * We keep track of the latest version of Windows that has been requested by
224  * the BIOS. ACPI 5.0.
225  */
226 ACPI_INIT_GLOBAL(u8, acpi_gbl_osi_data, 0);
227 
228 /*
229  * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
230  * that the ACPI hardware is no longer required. A flag in the FADT indicates
231  * a reduced HW machine, and that flag is duplicated here for convenience.
232  */
233 ACPI_INIT_GLOBAL(u8, acpi_gbl_reduced_hardware, FALSE);
234 
235 /*
236  * This mechanism is used to trace a specified AML method. The method is
237  * traced each time it is executed.
238  */
239 ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_flags, 0);
240 ACPI_INIT_GLOBAL(acpi_name, acpi_gbl_trace_method_name, 0);
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 /*
251  * Other miscellaneous globals
252  */
253 ACPI_GLOBAL(struct acpi_table_fadt, acpi_gbl_FADT);
254 ACPI_GLOBAL(u32, acpi_current_gpe_count);
255 ACPI_GLOBAL(u8, acpi_gbl_system_awake_and_running);
256 
257 /*****************************************************************************
258  *
259  * ACPICA public interface configuration.
260  *
261  * Interfaces that are configured out of the ACPICA build are replaced
262  * by inlined stubs by default.
263  *
264  ****************************************************************************/
265 
266 /*
267  * Hardware-reduced prototypes (default: Not hardware reduced).
268  *
269  * All ACPICA hardware-related interfaces that use these macros will be
270  * configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
271  * is set to TRUE.
272  *
273  * Note: This static build option for reduced hardware is intended to
274  * reduce ACPICA code size if desired or necessary. However, even if this
275  * option is not specified, the runtime behavior of ACPICA is dependent
276  * on the actual FADT reduced hardware flag (HW_REDUCED_ACPI). If set,
277  * the flag will enable similar behavior -- ACPICA will not attempt
278  * to access any ACPI-relate hardware (SCI, GPEs, Fixed Events, etc.)
279  */
280 #if (!ACPI_REDUCED_HARDWARE)
281 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
282 	ACPI_EXTERNAL_RETURN_STATUS(prototype)
283 
284 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
285 	ACPI_EXTERNAL_RETURN_OK(prototype)
286 
287 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
288 	ACPI_EXTERNAL_RETURN_VOID(prototype)
289 
290 #else
291 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
292 	static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
293 
294 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
295 	static ACPI_INLINE prototype {return(AE_OK);}
296 
297 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
298 	static ACPI_INLINE prototype {return;}
299 
300 #endif				/* !ACPI_REDUCED_HARDWARE */
301 
302 /*
303  * Error message prototypes (default: error messages enabled).
304  *
305  * All interfaces related to error and warning messages
306  * will be configured out of the ACPICA build if the
307  * ACPI_NO_ERROR_MESSAGE flag is defined.
308  */
309 #ifndef ACPI_NO_ERROR_MESSAGES
310 #define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
311 	prototype;
312 
313 #else
314 #define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
315 	static ACPI_INLINE prototype {return;}
316 
317 #endif				/* ACPI_NO_ERROR_MESSAGES */
318 
319 /*
320  * Debugging output prototypes (default: no debug output).
321  *
322  * All interfaces related to debug output messages
323  * will be configured out of the ACPICA build unless the
324  * ACPI_DEBUG_OUTPUT flag is defined.
325  */
326 #ifdef ACPI_DEBUG_OUTPUT
327 #define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
328 	prototype;
329 
330 #else
331 #define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
332 	static ACPI_INLINE prototype {return;}
333 
334 #endif				/* ACPI_DEBUG_OUTPUT */
335 
336 /*
337  * Application prototypes
338  *
339  * All interfaces used by application will be configured
340  * out of the ACPICA build unless the ACPI_APPLICATION
341  * flag is defined.
342  */
343 #ifdef ACPI_APPLICATION
344 #define ACPI_APP_DEPENDENT_RETURN_VOID(prototype) \
345 	prototype;
346 
347 #else
348 #define ACPI_APP_DEPENDENT_RETURN_VOID(prototype) \
349 	static ACPI_INLINE prototype {return;}
350 
351 #endif				/* ACPI_APPLICATION */
352 
353 /*****************************************************************************
354  *
355  * ACPICA public interface prototypes
356  *
357  ****************************************************************************/
358 
359 /*
360  * Initialization
361  */
362 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
363 			    acpi_initialize_tables(struct acpi_table_desc
364 						   *initial_storage,
365 						   u32 initial_table_count,
366 						   u8 allow_resize))
367 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_initialize_subsystem(void))
368 
369 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_enable_subsystem(u32 flags))
370 
371 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
372 			    acpi_initialize_objects(u32 flags))
373 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_terminate(void))
374 
375 /*
376  * Miscellaneous global interfaces
377  */
378 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
379 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
380 #ifdef ACPI_FUTURE_USAGE
381 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_subsystem_status(void))
382 #endif
383 
384 #ifdef ACPI_FUTURE_USAGE
385 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
386 			    acpi_get_system_info(struct acpi_buffer
387 						 *ret_buffer))
388 #endif
389 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
390 			     acpi_get_statistics(struct acpi_statistics *stats))
391 ACPI_EXTERNAL_RETURN_PTR(const char
392 			  *acpi_format_exception(acpi_status exception))
393 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_purge_cached_objects(void))
394 
395 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
396 			    acpi_install_interface(acpi_string interface_name))
397 
398 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
399 			    acpi_remove_interface(acpi_string interface_name))
400 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_update_interfaces(u8 action))
401 
402 ACPI_EXTERNAL_RETURN_UINT32(u32
403 			    acpi_check_address_range(acpi_adr_space_type
404 						     space_id,
405 						     acpi_physical_address
406 						     address, acpi_size length,
407 						     u8 warn))
408 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
409 			     acpi_decode_pld_buffer(u8 *in_buffer,
410 						    acpi_size length,
411 						    struct acpi_pld_info
412 						    **return_buffer))
413 
414 /*
415  * ACPI table load/unload interfaces
416  */
417 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
418 			    acpi_install_table(acpi_physical_address address,
419 					       u8 physical))
420 
421 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
422 			    acpi_load_table(struct acpi_table_header *table))
423 
424 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
425 			    acpi_unload_parent_table(acpi_handle object))
426 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_load_tables(void))
427 
428 /*
429  * ACPI table manipulation interfaces
430  */
431 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_reallocate_root_table(void))
432 
433 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
434 			    acpi_find_root_pointer(acpi_physical_address *
435 						   rsdp_address))
436 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
437 			     acpi_get_table_header(acpi_string signature,
438 						   u32 instance,
439 						   struct acpi_table_header
440 						   *out_table_header))
441 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
442 			     acpi_get_table(acpi_string signature, u32 instance,
443 					    struct acpi_table_header
444 					    **out_table))
445 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
446 			     acpi_get_table_by_index(u32 table_index,
447 						     struct acpi_table_header
448 						     **out_table))
449 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
450 			     acpi_install_table_handler(acpi_table_handler
451 							handler, void *context))
452 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
453 			     acpi_remove_table_handler(acpi_table_handler
454 						       handler))
455 
456 /*
457  * Namespace and name interfaces
458  */
459 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
460 			    acpi_walk_namespace(acpi_object_type type,
461 						acpi_handle start_object,
462 						u32 max_depth,
463 						acpi_walk_callback
464 						descending_callback,
465 						acpi_walk_callback
466 						ascending_callback,
467 						void *context,
468 						void **return_value))
469 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
470 			     acpi_get_devices(const char *HID,
471 					      acpi_walk_callback user_function,
472 					      void *context,
473 					      void **return_value))
474 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
475 			     acpi_get_name(acpi_handle object, u32 name_type,
476 					   struct acpi_buffer *ret_path_ptr))
477 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
478 			     acpi_get_handle(acpi_handle parent,
479 					     acpi_string pathname,
480 					     acpi_handle * ret_handle))
481 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
482 			     acpi_attach_data(acpi_handle object,
483 					      acpi_object_handler handler,
484 					      void *data))
485 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
486 			     acpi_detach_data(acpi_handle object,
487 					      acpi_object_handler handler))
488 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
489 			     acpi_get_data(acpi_handle object,
490 					   acpi_object_handler handler,
491 					   void **data))
492 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
493 			     acpi_debug_trace(char *name, u32 debug_level,
494 					      u32 debug_layer, u32 flags))
495 
496 /*
497  * Object manipulation and enumeration
498  */
499 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
500 			    acpi_evaluate_object(acpi_handle object,
501 						 acpi_string pathname,
502 						 struct acpi_object_list
503 						 *parameter_objects,
504 						 struct acpi_buffer
505 						 *return_object_buffer))
506 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
507 			     acpi_evaluate_object_typed(acpi_handle object,
508 							acpi_string pathname,
509 							struct acpi_object_list
510 							*external_params,
511 							struct acpi_buffer
512 							*return_buffer,
513 							acpi_object_type
514 							return_type))
515 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
516 			     acpi_get_object_info(acpi_handle object,
517 						  struct acpi_device_info
518 						  **return_buffer))
519 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_install_method(u8 *buffer))
520 
521 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
522 			    acpi_get_next_object(acpi_object_type type,
523 						 acpi_handle parent,
524 						 acpi_handle child,
525 						 acpi_handle * out_handle))
526 
527 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
528 			    acpi_get_type(acpi_handle object,
529 					  acpi_object_type * out_type))
530 
531 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
532 			    acpi_get_parent(acpi_handle object,
533 					    acpi_handle * out_handle))
534 
535 /*
536  * Handler interfaces
537  */
538 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
539 			    acpi_install_initialization_handler
540 			    (acpi_init_handler handler, u32 function))
541 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
542 				 acpi_install_sci_handler(acpi_sci_handler
543 							  address,
544 							  void *context))
545 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
546 				 acpi_remove_sci_handler(acpi_sci_handler
547 							 address))
548 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
549 				 acpi_install_global_event_handler
550 				 (acpi_gbl_event_handler handler,
551 				  void *context))
552 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
553 				 acpi_install_fixed_event_handler(u32
554 								  acpi_event,
555 								  acpi_event_handler
556 								  handler,
557 								  void
558 								  *context))
559 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
560 				 acpi_remove_fixed_event_handler(u32 acpi_event,
561 								 acpi_event_handler
562 								 handler))
563 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
564 				 acpi_install_gpe_handler(acpi_handle
565 							  gpe_device,
566 							  u32 gpe_number,
567 							  u32 type,
568 							  acpi_gpe_handler
569 							  address,
570 							  void *context))
571 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
572 				 acpi_install_gpe_raw_handler(acpi_handle
573 							      gpe_device,
574 							      u32 gpe_number,
575 							      u32 type,
576 							      acpi_gpe_handler
577 							      address,
578 							      void *context))
579 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
580 				 acpi_remove_gpe_handler(acpi_handle gpe_device,
581 							 u32 gpe_number,
582 							 acpi_gpe_handler
583 							 address))
584 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
585 			     acpi_install_notify_handler(acpi_handle device,
586 							 u32 handler_type,
587 							 acpi_notify_handler
588 							 handler,
589 							 void *context))
590 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
591 			     acpi_remove_notify_handler(acpi_handle device,
592 							u32 handler_type,
593 							acpi_notify_handler
594 							handler))
595 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
596 			     acpi_install_address_space_handler(acpi_handle
597 								device,
598 								acpi_adr_space_type
599 								space_id,
600 								acpi_adr_space_handler
601 								handler,
602 								acpi_adr_space_setup
603 								setup,
604 								void *context))
605 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
606 			     acpi_remove_address_space_handler(acpi_handle
607 							       device,
608 							       acpi_adr_space_type
609 							       space_id,
610 							       acpi_adr_space_handler
611 							       handler))
612 #ifdef ACPI_FUTURE_USAGE
613 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
614 			     acpi_install_exception_handler
615 			     (acpi_exception_handler handler))
616 #endif
617 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
618 			     acpi_install_interface_handler
619 			     (acpi_interface_handler handler))
620 
621 /*
622  * Global Lock interfaces
623  */
624 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
625 				acpi_acquire_global_lock(u16 timeout,
626 							 u32 *handle))
627 
628 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
629 				acpi_release_global_lock(u32 handle))
630 
631 /*
632  * Interfaces to AML mutex objects
633  */
634 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
635 			    acpi_acquire_mutex(acpi_handle handle,
636 					       acpi_string pathname,
637 					       u16 timeout))
638 
639 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
640 			    acpi_release_mutex(acpi_handle handle,
641 					       acpi_string pathname))
642 
643 /*
644  * Fixed Event interfaces
645  */
646 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
647 				acpi_enable_event(u32 event, u32 flags))
648 
649 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
650 				acpi_disable_event(u32 event, u32 flags))
651 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
652 
653 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
654 				acpi_get_event_status(u32 event,
655 						      acpi_event_status
656 						      *event_status))
657 
658 /*
659  * General Purpose Event (GPE) Interfaces
660  */
661 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
662 
663 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
664 				acpi_enable_gpe(acpi_handle gpe_device,
665 						u32 gpe_number))
666 
667 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
668 				acpi_disable_gpe(acpi_handle gpe_device,
669 						 u32 gpe_number))
670 
671 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
672 				acpi_clear_gpe(acpi_handle gpe_device,
673 					       u32 gpe_number))
674 
675 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
676 				acpi_set_gpe(acpi_handle gpe_device,
677 					     u32 gpe_number, u8 action))
678 
679 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
680 				acpi_finish_gpe(acpi_handle gpe_device,
681 						u32 gpe_number))
682 
683 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
684 				acpi_mark_gpe_for_wake(acpi_handle gpe_device,
685 						       u32 gpe_number))
686 
687 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
688 				acpi_setup_gpe_for_wake(acpi_handle
689 							parent_device,
690 							acpi_handle gpe_device,
691 							u32 gpe_number))
692 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
693 				 acpi_set_gpe_wake_mask(acpi_handle gpe_device,
694 							u32 gpe_number,
695 							u8 action))
696 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
697 				 acpi_get_gpe_status(acpi_handle gpe_device,
698 						     u32 gpe_number,
699 						     acpi_event_status
700 						     *event_status))
701 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
702 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
703 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_wakeup_gpes(void))
704 
705 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
706 				acpi_get_gpe_device(u32 gpe_index,
707 						    acpi_handle * gpe_device))
708 
709 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
710 				acpi_install_gpe_block(acpi_handle gpe_device,
711 						       struct
712 						       acpi_generic_address
713 						       *gpe_block_address,
714 						       u32 register_count,
715 						       u32 interrupt_number))
716 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
717 				 acpi_remove_gpe_block(acpi_handle gpe_device))
718 
719 /*
720  * Resource interfaces
721  */
722 typedef
723 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
724 					   void *context);
725 
726 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
727 			    acpi_get_vendor_resource(acpi_handle device,
728 						     char *name,
729 						     struct acpi_vendor_uuid
730 						     *uuid,
731 						     struct acpi_buffer
732 						     *ret_buffer))
733 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
734 			     acpi_get_current_resources(acpi_handle device,
735 							struct acpi_buffer
736 							*ret_buffer))
737 #ifdef ACPI_FUTURE_USAGE
738 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
739 			     acpi_get_possible_resources(acpi_handle device,
740 							 struct acpi_buffer
741 							 *ret_buffer))
742 #endif
743 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
744 			     acpi_get_event_resources(acpi_handle device_handle,
745 						      struct acpi_buffer
746 						      *ret_buffer))
747 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
748 			     acpi_walk_resource_buffer(struct acpi_buffer
749 						       *buffer,
750 						       acpi_walk_resource_callback
751 						       user_function,
752 						       void *context))
753 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
754 			     acpi_walk_resources(acpi_handle device, char *name,
755 						 acpi_walk_resource_callback
756 						 user_function, void *context))
757 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
758 			     acpi_set_current_resources(acpi_handle device,
759 							struct acpi_buffer
760 							*in_buffer))
761 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
762 			     acpi_get_irq_routing_table(acpi_handle device,
763 							struct acpi_buffer
764 							*ret_buffer))
765 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
766 			     acpi_resource_to_address64(struct acpi_resource
767 							*resource,
768 							struct
769 							acpi_resource_address64
770 							*out))
771 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
772 			     acpi_buffer_to_resource(u8 *aml_buffer,
773 						     u16 aml_buffer_length,
774 						     struct acpi_resource
775 						     **resource_ptr))
776 
777 /*
778  * Hardware (ACPI device) interfaces
779  */
780 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_reset(void))
781 
782 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
783 			    acpi_read(u64 *value,
784 				      struct acpi_generic_address *reg))
785 
786 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
787 			    acpi_write(u64 value,
788 				       struct acpi_generic_address *reg))
789 
790 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
791 				acpi_read_bit_register(u32 register_id,
792 						       u32 *return_value))
793 
794 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
795 				acpi_write_bit_register(u32 register_id,
796 							u32 value))
797 
798 /*
799  * Sleep/Wake interfaces
800  */
801 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
802 			    acpi_get_sleep_type_data(u8 sleep_state,
803 						     u8 *slp_typ_a,
804 						     u8 *slp_typ_b))
805 
806 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
807 			    acpi_enter_sleep_state_prep(u8 sleep_state))
808 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_enter_sleep_state(u8 sleep_state))
809 
810 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void))
811 
812 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
813 			    acpi_leave_sleep_state_prep(u8 sleep_state))
814 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_leave_sleep_state(u8 sleep_state))
815 
816 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
817 				acpi_set_firmware_waking_vector(u32
818 								physical_address))
819 #if ACPI_MACHINE_WIDTH == 64
820 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
821 				acpi_set_firmware_waking_vector64(u64
822 								  physical_address))
823 #endif
824 /*
825  * ACPI Timer interfaces
826  */
827 #ifdef ACPI_FUTURE_USAGE
828 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
829 				acpi_get_timer_resolution(u32 *resolution))
830 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
831 
832 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
833 				acpi_get_timer_duration(u32 start_ticks,
834 							u32 end_ticks,
835 							u32 *time_elapsed))
836 #endif				/* ACPI_FUTURE_USAGE */
837 
838 /*
839  * Error/Warning output
840  */
841 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
842 			       void ACPI_INTERNAL_VAR_XFACE
843 			       acpi_error(const char *module_name,
844 					  u32 line_number,
845 					  const char *format, ...))
846 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(4)
847 				void ACPI_INTERNAL_VAR_XFACE
848 				acpi_exception(const char *module_name,
849 					       u32 line_number,
850 					       acpi_status status,
851 					       const char *format, ...))
852 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
853 				void ACPI_INTERNAL_VAR_XFACE
854 				acpi_warning(const char *module_name,
855 					     u32 line_number,
856 					     const char *format, ...))
857 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
858 				void ACPI_INTERNAL_VAR_XFACE
859 				acpi_info(const char *module_name,
860 					  u32 line_number,
861 					  const char *format, ...))
862 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
863 				void ACPI_INTERNAL_VAR_XFACE
864 				acpi_bios_error(const char *module_name,
865 						u32 line_number,
866 						const char *format, ...))
867 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
868 				void ACPI_INTERNAL_VAR_XFACE
869 				acpi_bios_warning(const char *module_name,
870 						  u32 line_number,
871 						  const char *format, ...))
872 
873 /*
874  * Debug output
875  */
876 ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
877 			       void ACPI_INTERNAL_VAR_XFACE
878 			       acpi_debug_print(u32 requested_debug_level,
879 						u32 line_number,
880 						const char *function_name,
881 						const char *module_name,
882 						u32 component_id,
883 						const char *format, ...))
884 ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
885 				void ACPI_INTERNAL_VAR_XFACE
886 				acpi_debug_print_raw(u32 requested_debug_level,
887 						     u32 line_number,
888 						     const char *function_name,
889 						     const char *module_name,
890 						     u32 component_id,
891 						     const char *format, ...))
892 ACPI_APP_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(1)
893 				void ACPI_INTERNAL_VAR_XFACE
894 				acpi_log_error(const char *format, ...))
895 
896 /*
897  * Divergences
898  */
899 ACPI_GLOBAL(u8, acpi_gbl_permanent_mmap);
900 
901 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
902 			    acpi_get_table_with_size(acpi_string signature,
903 						     u32 instance,
904 						     struct acpi_table_header
905 						     **out_table,
906 						     acpi_size *tbl_size))
907 
908 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
909 			    acpi_get_data_full(acpi_handle object,
910 					       acpi_object_handler handler,
911 					       void **data,
912 					       void (*callback)(void *)))
913 
914 #endif				/* __ACXFACE_H__ */
915