1/******************************************************************************
2 *
3 * Name: acpixf.h - External interfaces to the ACPI subsystem
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2019, 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 0x20190405
50
51#include "acconfig.h"
52#include "actypes.h"
53#include "actbl.h"
54#include "acbuffer.h"
55
56
57/*****************************************************************************
58 *
59 * Macros used for ACPICA globals and configuration
60 *
61 ****************************************************************************/
62
63/*
64 * Ensure that global variables are defined and initialized only once.
65 *
66 * The use of these macros allows for a single list of globals (here)
67 * in order to simplify maintenance of the code.
68 */
69#ifdef DEFINE_ACPI_GLOBALS
70#define ACPI_GLOBAL(type,name) \
71 extern type name; \
72 type name
73
74#define ACPI_INIT_GLOBAL(type,name,value) \
75 type name=value
76
77#else
78#ifndef ACPI_GLOBAL
79#define ACPI_GLOBAL(type,name) \
80 extern type name
81#endif
82
83#ifndef ACPI_INIT_GLOBAL
84#define ACPI_INIT_GLOBAL(type,name,value) \
85 extern type name
86#endif
87#endif
88
89/*
90 * These macros configure the various ACPICA interfaces. They are
91 * useful for generating stub inline functions for features that are
92 * configured out of the current kernel or ACPICA application.
93 */
94#ifndef ACPI_EXTERNAL_RETURN_STATUS
95#define ACPI_EXTERNAL_RETURN_STATUS(Prototype) \
96 Prototype;
97#endif
98
99#ifndef ACPI_EXTERNAL_RETURN_OK
100#define ACPI_EXTERNAL_RETURN_OK(Prototype) \
101 Prototype;
102#endif
103
104#ifndef ACPI_EXTERNAL_RETURN_VOID
105#define ACPI_EXTERNAL_RETURN_VOID(Prototype) \
106 Prototype;
107#endif
108
109#ifndef ACPI_EXTERNAL_RETURN_UINT32
110#define ACPI_EXTERNAL_RETURN_UINT32(Prototype) \
111 Prototype;
112#endif
113
114#ifndef ACPI_EXTERNAL_RETURN_PTR
115#define ACPI_EXTERNAL_RETURN_PTR(Prototype) \
116 Prototype;
117#endif
118
119
120/*****************************************************************************
121 *
122 * Public globals and runtime configuration options
123 *
124 ****************************************************************************/
125
126/*
127 * Enable "slack mode" of the AML interpreter? Default is FALSE, and the
128 * interpreter strictly follows the ACPI specification. Setting to TRUE
129 * allows the interpreter to ignore certain errors and/or bad AML constructs.
130 *
131 * Currently, these features are enabled by this flag:
132 *
133 * 1) Allow "implicit return" of last value in a control method
134 * 2) Allow access beyond the end of an operation region
135 * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
136 * 4) Allow ANY object type to be a source operand for the Store() operator
137 * 5) Allow unresolved references (invalid target name) in package objects
138 * 6) Enable warning messages for behavior that is not ACPI spec compliant
139 */
140ACPI_INIT_GLOBAL (UINT8, AcpiGbl_EnableInterpreterSlack, FALSE);
141
142/*
143 * Automatically serialize all methods that create named objects? Default
144 * is TRUE, meaning that all NonSerialized methods are scanned once at
145 * table load time to determine those that create named objects. Methods
146 * that create named objects are marked Serialized in order to prevent
147 * possible run-time problems if they are entered by more than one thread.
148 */
149ACPI_INIT_GLOBAL (UINT8, AcpiGbl_AutoSerializeMethods, TRUE);
150
151/*
152 * Create the predefined _OSI method in the namespace? Default is TRUE
153 * because ACPICA is fully compatible with other ACPI implementations.
154 * Changing this will revert ACPICA (and machine ASL) to pre-OSI behavior.
155 */
156ACPI_INIT_GLOBAL (UINT8, AcpiGbl_CreateOsiMethod, TRUE);
157
158/*
159 * Optionally use default values for the ACPI register widths. Set this to
160 * TRUE to use the defaults, if an FADT contains incorrect widths/lengths.
161 */
162ACPI_INIT_GLOBAL (UINT8, AcpiGbl_UseDefaultRegisterWidths, TRUE);
163
164/*
165 * Whether or not to validate (map) an entire table to verify
166 * checksum/duplication in early stage before install. Set this to TRUE to
167 * allow early table validation before install it to the table manager.
168 * Note that enabling this option causes errors to happen in some OSPMs
169 * during early initialization stages. Default behavior is to allow such
170 * validation.
171 */
172ACPI_INIT_GLOBAL (UINT8, AcpiGbl_EnableTableValidation, TRUE);
173
174/*
175 * Optionally enable output from the AML Debug Object.
176 */
177ACPI_INIT_GLOBAL (_Bool, AcpiGbl_EnableAmlDebugObject, FALSE);
178
179/*
180 * Optionally copy the entire DSDT to local memory (instead of simply
181 * mapping it.) There are some BIOSs that corrupt or replace the original
182 * DSDT, creating the need for this option. Default is FALSE, do not copy
183 * the DSDT.
184 */
185ACPI_INIT_GLOBAL (UINT8, AcpiGbl_CopyDsdtLocally, FALSE);
186
187/*
188 * Optionally ignore an XSDT if present and use the RSDT instead.
189 * Although the ACPI specification requires that an XSDT be used instead
190 * of the RSDT, the XSDT has been found to be corrupt or ill-formed on
191 * some machines. Default behavior is to use the XSDT if present.
192 */
193ACPI_INIT_GLOBAL (UINT8, AcpiGbl_DoNotUseXsdt, FALSE);
194
195/*
196 * Optionally use 32-bit FADT addresses if and when there is a conflict
197 * (address mismatch) between the 32-bit and 64-bit versions of the
198 * address. Although ACPICA adheres to the ACPI specification which
199 * requires the use of the corresponding 64-bit address if it is non-zero,
200 * some machines have been found to have a corrupted non-zero 64-bit
201 * address. Default is FALSE, do not favor the 32-bit addresses.
202 */
203ACPI_INIT_GLOBAL (UINT8, AcpiGbl_Use32BitFadtAddresses, FALSE);
204
205/*
206 * Optionally use 32-bit FACS table addresses.
207 * It is reported that some platforms fail to resume from system suspending
208 * if 64-bit FACS table address is selected:
209 * https://bugzilla.kernel.org/show_bug.cgi?id=74021
210 * Default is TRUE, favor the 32-bit addresses.
211 */
212ACPI_INIT_GLOBAL (UINT8, AcpiGbl_Use32BitFacsAddresses, TRUE);
213
214/*
215 * Optionally truncate I/O addresses to 16 bits. Provides compatibility
216 * with other ACPI implementations. NOTE: During ACPICA initialization,
217 * this value is set to TRUE if any Windows OSI strings have been
218 * requested by the BIOS.
219 */
220ACPI_INIT_GLOBAL (UINT8, AcpiGbl_TruncateIoAddresses, FALSE);
221
222/*
223 * Disable runtime checking and repair of values returned by control methods.
224 * Use only if the repair is causing a problem on a particular machine.
225 */
226ACPI_INIT_GLOBAL (UINT8, AcpiGbl_DisableAutoRepair, FALSE);
227
228/*
229 * Optionally do not install any SSDTs from the RSDT/XSDT during initialization.
230 * This can be useful for debugging ACPI problems on some machines.
231 */
232ACPI_INIT_GLOBAL (UINT8, AcpiGbl_DisableSsdtTableInstall, FALSE);
233
234/*
235 * Optionally enable runtime namespace override.
236 */
237ACPI_INIT_GLOBAL (UINT8, AcpiGbl_RuntimeNamespaceOverride, TRUE);
238
239/*
240 * We keep track of the latest version of Windows that has been requested by
241 * the BIOS. ACPI 5.0.
242 */
243ACPI_INIT_GLOBAL (UINT8, AcpiGbl_OsiData, 0);
244
245/*
246 * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
247 * that the ACPI hardware is no longer required. A flag in the FADT indicates
248 * a reduced HW machine, and that flag is duplicated here for convenience.
249 */
250ACPI_INIT_GLOBAL (BOOLEAN, AcpiGbl_ReducedHardware, FALSE);
251
252/*
253 * Maximum timeout for While() loop iterations before forced method abort.
254 * This mechanism is intended to prevent infinite loops during interpreter
255 * execution within a host kernel.
256 */
257ACPI_INIT_GLOBAL (UINT32, AcpiGbl_MaxLoopIterations, ACPI_MAX_LOOP_TIMEOUT);
258
259/*
260 * Optionally ignore AE_NOT_FOUND errors from named reference package elements
261 * during DSDT/SSDT table loading. This reduces error "noise" in platforms
262 * whose firmware is carrying around a bunch of unused package objects that
263 * refer to non-existent named objects. However, If the AML actually tries to
264 * use such a package, the unresolved element(s) will be replaced with NULL
265 * elements.
266 */
267ACPI_INIT_GLOBAL (BOOLEAN, AcpiGbl_IgnorePackageResolutionErrors, FALSE);
268
269/*
270 * This mechanism is used to trace a specified AML method. The method is
271 * traced each time it is executed.
272 */
273ACPI_INIT_GLOBAL (UINT32, AcpiGbl_TraceFlags, 0);
274ACPI_INIT_GLOBAL (const char *, AcpiGbl_TraceMethodName, NULL);
275ACPI_INIT_GLOBAL (UINT32, AcpiGbl_TraceDbgLevel, ACPI_TRACE_LEVEL_DEFAULT);
276ACPI_INIT_GLOBAL (UINT32, AcpiGbl_TraceDbgLayer, ACPI_TRACE_LAYER_DEFAULT);
277
278/*
279 * Runtime configuration of debug output control masks. We want the debug
280 * switches statically initialized so they are already set when the debugger
281 * is entered.
282 */
283#if defined(ACPI_DEBUG_OUTPUT) && defined(ACPI_DEBUG_TRACE)
284ACPI_INIT_GLOBAL (UINT32, AcpiDbgLevel, ACPI_DEBUG_DEFAULT);
285#else
286ACPI_INIT_GLOBAL (UINT32, AcpiDbgLevel, ACPI_NORMAL_DEFAULT);
287#endif
288ACPI_INIT_GLOBAL (UINT32, AcpiDbgLayer, ACPI_COMPONENT_DEFAULT);
289
290/* Optionally enable timer output with Debug Object output */
291
292ACPI_INIT_GLOBAL (UINT8, AcpiGbl_DisplayDebugTimer, FALSE);
293
294/*
295 * Debugger command handshake globals. Host OSes need to access these
296 * variables to implement their own command handshake mechanism.
297 */
298#ifdef ACPI_DEBUGGER
299ACPI_INIT_GLOBAL (BOOLEAN, AcpiGbl_MethodExecuting, FALSE);
300ACPI_GLOBAL (char, AcpiGbl_DbLineBuf[ACPI_DB_LINE_BUFFER_SIZE]);
301#endif
302
303/*
304 * Other miscellaneous globals
305 */
306ACPI_GLOBAL (ACPI_TABLE_FADT, AcpiGbl_FADT);
307ACPI_GLOBAL (UINT32, AcpiCurrentGpeCount);
308ACPI_GLOBAL (BOOLEAN, AcpiGbl_SystemAwakeAndRunning);
309
310
311/*****************************************************************************
312 *
313 * ACPICA public interface configuration.
314 *
315 * Interfaces that are configured out of the ACPICA build are replaced
316 * by inlined stubs by default.
317 *
318 ****************************************************************************/
319
320/*
321 * Hardware-reduced prototypes (default: Not hardware reduced).
322 *
323 * All ACPICA hardware-related interfaces that use these macros will be
324 * configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
325 * is set to TRUE.
326 *
327 * Note: This static build option for reduced hardware is intended to
328 * reduce ACPICA code size if desired or necessary. However, even if this
329 * option is not specified, the runtime behavior of ACPICA is dependent
330 * on the actual FADT reduced hardware flag (HW_REDUCED_ACPI). If set,
331 * the flag will enable similar behavior -- ACPICA will not attempt
332 * to access any ACPI-relate hardware (SCI, GPEs, Fixed Events, etc.)
333 */
334#if (!ACPI_REDUCED_HARDWARE)
335#define ACPI_HW_DEPENDENT_RETURN_STATUS(Prototype) \
336 ACPI_EXTERNAL_RETURN_STATUS(Prototype)
337
338#define ACPI_HW_DEPENDENT_RETURN_OK(Prototype) \
339 ACPI_EXTERNAL_RETURN_OK(Prototype)
340
341#define ACPI_HW_DEPENDENT_RETURN_VOID(Prototype) \
342 ACPI_EXTERNAL_RETURN_VOID(Prototype)
343
344#else
345#define ACPI_HW_DEPENDENT_RETURN_STATUS(Prototype) \
346 static ACPI_INLINE Prototype {return(AE_NOT_CONFIGURED);}
347
348#define ACPI_HW_DEPENDENT_RETURN_OK(Prototype) \
349 static ACPI_INLINE Prototype {return(AE_OK);}
350
351#define ACPI_HW_DEPENDENT_RETURN_VOID(Prototype) \
352 static ACPI_INLINE Prototype {return;}
353
354#endif /* !ACPI_REDUCED_HARDWARE */
355
356
357/*
358 * Error message prototypes (default: error messages enabled).
359 *
360 * All interfaces related to error and warning messages
361 * will be configured out of the ACPICA build if the
362 * ACPI_NO_ERROR_MESSAGE flag is defined.
363 */
364#ifndef ACPI_NO_ERROR_MESSAGES
365#define ACPI_MSG_DEPENDENT_RETURN_VOID(Prototype) \
366 Prototype;
367
368#else
369#define ACPI_MSG_DEPENDENT_RETURN_VOID(Prototype) \
370 static ACPI_INLINE Prototype {return;}
371
372#endif /* ACPI_NO_ERROR_MESSAGES */
373
374
375/*
376 * Debugging output prototypes (default: no debug output).
377 *
378 * All interfaces related to debug output messages
379 * will be configured out of the ACPICA build unless the
380 * ACPI_DEBUG_OUTPUT flag is defined.
381 */
382#ifdef ACPI_DEBUG_OUTPUT
383#define ACPI_DBG_DEPENDENT_RETURN_VOID(Prototype) \
384 Prototype;
385
386#else
387#define ACPI_DBG_DEPENDENT_RETURN_VOID(Prototype) \
388 static ACPI_INLINE Prototype {return;}
389
390#endif /* ACPI_DEBUG_OUTPUT */
391
392
393/*
394 * Application prototypes
395 *
396 * All interfaces used by application will be configured
397 * out of the ACPICA build unless the ACPI_APPLICATION
398 * flag is defined.
399 */
400#ifdef ACPI_APPLICATION
401#define ACPI_APP_DEPENDENT_RETURN_VOID(Prototype) \
402 Prototype;
403
404#else
405#define ACPI_APP_DEPENDENT_RETURN_VOID(Prototype) \
406 static ACPI_INLINE Prototype {return;}
407
408#endif /* ACPI_APPLICATION */
409
410
411/*
412 * Debugger prototypes
413 *
414 * All interfaces used by debugger will be configured
415 * out of the ACPICA build unless the ACPI_DEBUGGER
416 * flag is defined.
417 */
418#ifdef ACPI_DEBUGGER
419#define ACPI_DBR_DEPENDENT_RETURN_OK(Prototype) \
420 ACPI_EXTERNAL_RETURN_OK(Prototype)
421
422#define ACPI_DBR_DEPENDENT_RETURN_VOID(Prototype) \
423 ACPI_EXTERNAL_RETURN_VOID(Prototype)
424
425#else
426#define ACPI_DBR_DEPENDENT_RETURN_OK(Prototype) \
427 static ACPI_INLINE Prototype {return(AE_OK);}
428
429#define ACPI_DBR_DEPENDENT_RETURN_VOID(Prototype) \
430 static ACPI_INLINE Prototype {return;}
431
432#endif /* ACPI_DEBUGGER */
433
434
435/*****************************************************************************
436 *
437 * ACPICA public interface prototypes
438 *
439 ****************************************************************************/
440
441/*
442 * Initialization
443 */
444ACPI_EXTERNAL_RETURN_STATUS (
445ACPI_STATUS ACPI_INIT_FUNCTION
446AcpiInitializeTables (
447 ACPI_TABLE_DESC *InitialStorage,
448 UINT32 InitialTableCount,
449 BOOLEAN AllowResize))
450
451ACPI_EXTERNAL_RETURN_STATUS (
452ACPI_STATUS ACPI_INIT_FUNCTION
453AcpiInitializeSubsystem (
454 void))
455
456ACPI_EXTERNAL_RETURN_STATUS (
457ACPI_STATUS ACPI_INIT_FUNCTION
458AcpiEnableSubsystem (
459 UINT32 Flags))
460
461ACPI_EXTERNAL_RETURN_STATUS (
462ACPI_STATUS ACPI_INIT_FUNCTION
463AcpiInitializeObjects (
464 UINT32 Flags))
465
466ACPI_EXTERNAL_RETURN_STATUS (
467ACPI_STATUS ACPI_INIT_FUNCTION
468AcpiTerminate (
469 void))
470
471
472/*
473 * Miscellaneous global interfaces
474 */
475ACPI_HW_DEPENDENT_RETURN_STATUS (
476ACPI_STATUS
477AcpiEnable (
478 void))
479
480ACPI_HW_DEPENDENT_RETURN_STATUS (
481ACPI_STATUS
482AcpiDisable (
483 void))
484
485ACPI_EXTERNAL_RETURN_STATUS (
486ACPI_STATUS
487AcpiSubsystemStatus (
488 void))
489
490ACPI_EXTERNAL_RETURN_STATUS (
491ACPI_STATUS
492AcpiGetSystemInfo (
493 ACPI_BUFFER *RetBuffer))
494
495ACPI_EXTERNAL_RETURN_STATUS (
496ACPI_STATUS
497AcpiGetStatistics (
498 ACPI_STATISTICS *Stats))
499
500ACPI_EXTERNAL_RETURN_PTR (
501const char *
502AcpiFormatException (
503 ACPI_STATUS Exception))
504
505ACPI_EXTERNAL_RETURN_STATUS (
506ACPI_STATUS
507AcpiPurgeCachedObjects (
508 void))
509
510ACPI_EXTERNAL_RETURN_STATUS (
511ACPI_STATUS
512AcpiInstallInterface (
513 ACPI_STRING InterfaceName))
514
515ACPI_EXTERNAL_RETURN_STATUS (
516ACPI_STATUS
517AcpiRemoveInterface (
518 ACPI_STRING InterfaceName))
519
520ACPI_EXTERNAL_RETURN_STATUS (
521ACPI_STATUS
522AcpiUpdateInterfaces (
523 UINT8 Action))
524
525ACPI_EXTERNAL_RETURN_UINT32 (
526UINT32
527AcpiCheckAddressRange (
528 ACPI_ADR_SPACE_TYPE SpaceId,
529 ACPI_PHYSICAL_ADDRESS Address,
530 ACPI_SIZE Length,
531 BOOLEAN Warn))
532
533ACPI_EXTERNAL_RETURN_STATUS (
534ACPI_STATUS
535AcpiDecodePldBuffer (
536 UINT8 *InBuffer,
537 ACPI_SIZE Length,
538 ACPI_PLD_INFO **ReturnBuffer))
539
540
541/*
542 * ACPI table load/unload interfaces
543 */
544ACPI_EXTERNAL_RETURN_STATUS (
545ACPI_STATUS ACPI_INIT_FUNCTION
546AcpiInstallTable (
547 ACPI_PHYSICAL_ADDRESS Address,
548 BOOLEAN Physical))
549
550ACPI_EXTERNAL_RETURN_STATUS (
551ACPI_STATUS
552AcpiLoadTable (
553 ACPI_TABLE_HEADER *Table))
554
555ACPI_EXTERNAL_RETURN_STATUS (
556ACPI_STATUS
557AcpiUnloadParentTable (
558 ACPI_HANDLE Object))
559
560ACPI_EXTERNAL_RETURN_STATUS (
561ACPI_STATUS ACPI_INIT_FUNCTION
562AcpiLoadTables (
563 void))
564
565
566/*
567 * ACPI table manipulation interfaces
568 */
569ACPI_EXTERNAL_RETURN_STATUS (
570ACPI_STATUS ACPI_INIT_FUNCTION
571AcpiReallocateRootTable (
572 void))
573
574ACPI_EXTERNAL_RETURN_STATUS (
575ACPI_STATUS ACPI_INIT_FUNCTION
576AcpiFindRootPointer (
577 ACPI_PHYSICAL_ADDRESS *RsdpAddress))
578
579ACPI_EXTERNAL_RETURN_STATUS (
580ACPI_STATUS
581AcpiGetTableHeader (
582 ACPI_CONST_STRING Signature,
583 UINT32 Instance,
584 ACPI_TABLE_HEADER *OutTableHeader))
585
586ACPI_EXTERNAL_RETURN_STATUS (
587ACPI_STATUS
588AcpiGetTable (
589 ACPI_CONST_STRING Signature,
590 UINT32 Instance,
591 ACPI_TABLE_HEADER **OutTable))
592
593ACPI_EXTERNAL_RETURN_VOID (
594void
595AcpiPutTable (
596 ACPI_TABLE_HEADER *Table))
597
598ACPI_EXTERNAL_RETURN_STATUS (
599ACPI_STATUS
600AcpiGetTableByIndex (
601 UINT32 TableIndex,
602 ACPI_TABLE_HEADER **OutTable))
603
604ACPI_EXTERNAL_RETURN_STATUS (
605ACPI_STATUS
606AcpiInstallTableHandler (
607 ACPI_TABLE_HANDLER Handler,
608 void *Context))
609
610ACPI_EXTERNAL_RETURN_STATUS (
611ACPI_STATUS
612AcpiRemoveTableHandler (
613 ACPI_TABLE_HANDLER Handler))
614
615
616/*
617 * Namespace and name interfaces
618 */
619ACPI_EXTERNAL_RETURN_STATUS (
620ACPI_STATUS
621AcpiWalkNamespace (
622 ACPI_OBJECT_TYPE Type,
623 ACPI_HANDLE StartObject,
624 UINT32 MaxDepth,
625 ACPI_WALK_CALLBACK DescendingCallback,
626 ACPI_WALK_CALLBACK AscendingCallback,
627 void *Context,
628 void **ReturnValue))
629
630ACPI_EXTERNAL_RETURN_STATUS (
631ACPI_STATUS
632AcpiGetDevices (
633 char *HID,
634 ACPI_WALK_CALLBACK UserFunction,
635 void *Context,
636 void **ReturnValue))
637
638ACPI_EXTERNAL_RETURN_STATUS (
639ACPI_STATUS
640AcpiGetName (
641 ACPI_HANDLE Object,
642 UINT32 NameType,
643 ACPI_BUFFER *RetPathPtr))
644
645ACPI_EXTERNAL_RETURN_STATUS (
646ACPI_STATUS
647AcpiGetHandle (
648 ACPI_HANDLE Parent,
649 ACPI_CONST_STRING Pathname,
650 ACPI_HANDLE *RetHandle))
651
652ACPI_EXTERNAL_RETURN_STATUS (
653ACPI_STATUS
654AcpiAttachData (
655 ACPI_HANDLE Object,
656 ACPI_OBJECT_HANDLER Handler,
657 void *Data))
658
659ACPI_EXTERNAL_RETURN_STATUS (
660ACPI_STATUS
661AcpiDetachData (
662 ACPI_HANDLE Object,
663 ACPI_OBJECT_HANDLER Handler))
664
665ACPI_EXTERNAL_RETURN_STATUS (
666ACPI_STATUS
667AcpiGetData (
668 ACPI_HANDLE Object,
669 ACPI_OBJECT_HANDLER Handler,
670 void **Data))
671
672ACPI_EXTERNAL_RETURN_STATUS (
673ACPI_STATUS
674AcpiDebugTrace (
675 const char *Name,
676 UINT32 DebugLevel,
677 UINT32 DebugLayer,
678 UINT32 Flags))
679
680
681/*
682 * Object manipulation and enumeration
683 */
684ACPI_EXTERNAL_RETURN_STATUS (
685ACPI_STATUS
686AcpiEvaluateObject (
687 ACPI_HANDLE Object,
688 ACPI_CONST_STRING Pathname,
689 ACPI_OBJECT_LIST *ParameterObjects,
690 ACPI_BUFFER *ReturnObjectBuffer))
691
692ACPI_EXTERNAL_RETURN_STATUS (
693ACPI_STATUS
694AcpiEvaluateObjectTyped (
695 ACPI_HANDLE Object,
696 ACPI_CONST_STRING Pathname,
697 ACPI_OBJECT_LIST *ExternalParams,
698 ACPI_BUFFER *ReturnBuffer,
699 ACPI_OBJECT_TYPE ReturnType))
700
701ACPI_EXTERNAL_RETURN_STATUS (
702ACPI_STATUS
703AcpiGetObjectInfo (
704 ACPI_HANDLE Object,
705 ACPI_DEVICE_INFO **ReturnBuffer))
706
707ACPI_EXTERNAL_RETURN_STATUS (
708ACPI_STATUS
709AcpiInstallMethod (
710 UINT8 *Buffer))
711
712ACPI_EXTERNAL_RETURN_STATUS (
713ACPI_STATUS
714AcpiGetNextObject (
715 ACPI_OBJECT_TYPE Type,
716 ACPI_HANDLE Parent,
717 ACPI_HANDLE Child,
718 ACPI_HANDLE *OutHandle))
719
720ACPI_EXTERNAL_RETURN_STATUS (
721ACPI_STATUS
722AcpiGetType (
723 ACPI_HANDLE Object,
724 ACPI_OBJECT_TYPE *OutType))
725
726ACPI_EXTERNAL_RETURN_STATUS (
727ACPI_STATUS
728AcpiGetParent (
729 ACPI_HANDLE Object,
730 ACPI_HANDLE *OutHandle))
731
732
733/*
734 * Handler interfaces
735 */
736ACPI_EXTERNAL_RETURN_STATUS (
737ACPI_STATUS
738AcpiInstallInitializationHandler (
739 ACPI_INIT_HANDLER Handler,
740 UINT32 Function))
741
742ACPI_HW_DEPENDENT_RETURN_STATUS (
743ACPI_STATUS
744AcpiInstallSciHandler (
745 ACPI_SCI_HANDLER Address,
746 void *Context))
747
748ACPI_HW_DEPENDENT_RETURN_STATUS (
749ACPI_STATUS
750AcpiRemoveSciHandler (
751 ACPI_SCI_HANDLER Address))
752
753ACPI_HW_DEPENDENT_RETURN_STATUS (
754ACPI_STATUS
755AcpiInstallGlobalEventHandler (
756 ACPI_GBL_EVENT_HANDLER Handler,
757 void *Context))
758
759ACPI_HW_DEPENDENT_RETURN_STATUS (
760ACPI_STATUS
761AcpiInstallFixedEventHandler (
762 UINT32 AcpiEvent,
763 ACPI_EVENT_HANDLER Handler,
764 void *Context))
765
766ACPI_HW_DEPENDENT_RETURN_STATUS (
767ACPI_STATUS
768AcpiRemoveFixedEventHandler (
769 UINT32 AcpiEvent,
770 ACPI_EVENT_HANDLER Handler))
771
772ACPI_HW_DEPENDENT_RETURN_STATUS (
773ACPI_STATUS
774AcpiInstallGpeHandler (
775 ACPI_HANDLE GpeDevice,
776 UINT32 GpeNumber,
777 UINT32 Type,
778 ACPI_GPE_HANDLER Address,
779 void *Context))
780
781ACPI_HW_DEPENDENT_RETURN_STATUS (
782ACPI_STATUS
783AcpiInstallGpeRawHandler (
784 ACPI_HANDLE GpeDevice,
785 UINT32 GpeNumber,
786 UINT32 Type,
787 ACPI_GPE_HANDLER Address,
788 void *Context))
789
790ACPI_HW_DEPENDENT_RETURN_STATUS (
791ACPI_STATUS
792AcpiRemoveGpeHandler (
793 ACPI_HANDLE GpeDevice,
794 UINT32 GpeNumber,
795 ACPI_GPE_HANDLER Address))
796
797ACPI_EXTERNAL_RETURN_STATUS (
798ACPI_STATUS
799AcpiInstallNotifyHandler (
800 ACPI_HANDLE Device,
801 UINT32 HandlerType,
802 ACPI_NOTIFY_HANDLER Handler,
803 void *Context))
804
805ACPI_EXTERNAL_RETURN_STATUS (
806ACPI_STATUS
807AcpiRemoveNotifyHandler (
808 ACPI_HANDLE Device,
809 UINT32 HandlerType,
810 ACPI_NOTIFY_HANDLER Handler))
811
812ACPI_EXTERNAL_RETURN_STATUS (
813ACPI_STATUS
814AcpiInstallAddressSpaceHandler (
815 ACPI_HANDLE Device,
816 ACPI_ADR_SPACE_TYPE SpaceId,
817 ACPI_ADR_SPACE_HANDLER Handler,
818 ACPI_ADR_SPACE_SETUP Setup,
819 void *Context))
820
821ACPI_EXTERNAL_RETURN_STATUS (
822ACPI_STATUS
823AcpiRemoveAddressSpaceHandler (
824 ACPI_HANDLE Device,
825 ACPI_ADR_SPACE_TYPE SpaceId,
826 ACPI_ADR_SPACE_HANDLER Handler))
827
828ACPI_EXTERNAL_RETURN_STATUS (
829ACPI_STATUS
830AcpiInstallExceptionHandler (
831 ACPI_EXCEPTION_HANDLER Handler))
832
833ACPI_EXTERNAL_RETURN_STATUS (
834ACPI_STATUS
835AcpiInstallInterfaceHandler (
836 ACPI_INTERFACE_HANDLER Handler))
837
838
839/*
840 * Global Lock interfaces
841 */
842ACPI_HW_DEPENDENT_RETURN_STATUS (
843ACPI_STATUS
844AcpiAcquireGlobalLock (
845 UINT16 Timeout,
846 UINT32 *Handle))
847
848ACPI_HW_DEPENDENT_RETURN_STATUS (
849ACPI_STATUS
850AcpiReleaseGlobalLock (
851 UINT32 Handle))
852
853
854/*
855 * Interfaces to AML mutex objects
856 */
857ACPI_EXTERNAL_RETURN_STATUS (
858ACPI_STATUS
859AcpiAcquireMutex (
860 ACPI_HANDLE Handle,
861 ACPI_STRING Pathname,
862 UINT16 Timeout))
863
864ACPI_EXTERNAL_RETURN_STATUS (
865ACPI_STATUS
866AcpiReleaseMutex (
867 ACPI_HANDLE Handle,
868 ACPI_STRING Pathname))
869
870
871/*
872 * Fixed Event interfaces
873 */
874ACPI_HW_DEPENDENT_RETURN_STATUS (
875ACPI_STATUS
876AcpiEnableEvent (
877 UINT32 Event,
878 UINT32 Flags))
879
880ACPI_HW_DEPENDENT_RETURN_STATUS (
881ACPI_STATUS
882AcpiDisableEvent (
883 UINT32 Event,
884 UINT32 Flags))
885
886ACPI_HW_DEPENDENT_RETURN_STATUS (
887ACPI_STATUS
888AcpiClearEvent (
889 UINT32 Event))
890
891ACPI_HW_DEPENDENT_RETURN_STATUS (
892ACPI_STATUS
893AcpiGetEventStatus (
894 UINT32 Event,
895 ACPI_EVENT_STATUS *EventStatus))
896
897
898/*
899 * General Purpose Event (GPE) Interfaces
900 */
901ACPI_HW_DEPENDENT_RETURN_STATUS (
902ACPI_STATUS
903AcpiUpdateAllGpes (
904 void))
905
906ACPI_HW_DEPENDENT_RETURN_STATUS (
907ACPI_STATUS
908AcpiEnableGpe (
909 ACPI_HANDLE GpeDevice,
910 UINT32 GpeNumber))
911
912ACPI_HW_DEPENDENT_RETURN_STATUS (
913ACPI_STATUS
914AcpiDisableGpe (
915 ACPI_HANDLE GpeDevice,
916 UINT32 GpeNumber))
917
918ACPI_HW_DEPENDENT_RETURN_STATUS (
919ACPI_STATUS
920AcpiClearGpe (
921 ACPI_HANDLE GpeDevice,
922 UINT32 GpeNumber))
923
924ACPI_HW_DEPENDENT_RETURN_STATUS (
925ACPI_STATUS
926AcpiSetGpe (
927 ACPI_HANDLE GpeDevice,
928 UINT32 GpeNumber,
929 UINT8 Action))
930
931ACPI_HW_DEPENDENT_RETURN_STATUS (
932ACPI_STATUS
933AcpiFinishGpe (
934 ACPI_HANDLE GpeDevice,
935 UINT32 GpeNumber))
936
937ACPI_HW_DEPENDENT_RETURN_STATUS (
938ACPI_STATUS
939AcpiMaskGpe (
940 ACPI_HANDLE GpeDevice,
941 UINT32 GpeNumber,
942 BOOLEAN IsMasked))
943
944ACPI_HW_DEPENDENT_RETURN_STATUS (
945ACPI_STATUS
946AcpiMarkGpeForWake (
947 ACPI_HANDLE GpeDevice,
948 UINT32 GpeNumber))
949
950ACPI_HW_DEPENDENT_RETURN_STATUS (
951ACPI_STATUS
952AcpiSetupGpeForWake (
953 ACPI_HANDLE ParentDevice,
954 ACPI_HANDLE GpeDevice,
955 UINT32 GpeNumber))
956
957ACPI_HW_DEPENDENT_RETURN_STATUS (
958ACPI_STATUS
959AcpiSetGpeWakeMask (
960 ACPI_HANDLE GpeDevice,
961 UINT32 GpeNumber,
962 UINT8 Action))
963
964ACPI_HW_DEPENDENT_RETURN_STATUS (
965ACPI_STATUS
966AcpiGetGpeStatus (
967 ACPI_HANDLE GpeDevice,
968 UINT32 GpeNumber,
969 ACPI_EVENT_STATUS *EventStatus))
970
971ACPI_HW_DEPENDENT_RETURN_STATUS (
972ACPI_STATUS
973AcpiDisableAllGpes (
974 void))
975
976ACPI_HW_DEPENDENT_RETURN_STATUS (
977ACPI_STATUS
978AcpiEnableAllRuntimeGpes (
979 void))
980
981ACPI_HW_DEPENDENT_RETURN_STATUS (
982ACPI_STATUS
983AcpiEnableAllWakeupGpes (
984 void))
985
986ACPI_HW_DEPENDENT_RETURN_STATUS (
987ACPI_STATUS
988AcpiGetGpeDevice (
989 UINT32 GpeIndex,
990 ACPI_HANDLE *GpeDevice))
991
992ACPI_HW_DEPENDENT_RETURN_STATUS (
993ACPI_STATUS
994AcpiInstallGpeBlock (
995 ACPI_HANDLE GpeDevice,
996 ACPI_GENERIC_ADDRESS *GpeBlockAddress,
997 UINT32 RegisterCount,
998 UINT32 InterruptNumber))
999
1000ACPI_HW_DEPENDENT_RETURN_STATUS (
1001ACPI_STATUS
1002AcpiRemoveGpeBlock (
1003 ACPI_HANDLE GpeDevice))
1004
1005
1006/*
1007 * Resource interfaces
1008 */
1009typedef
1010ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) (
1011 ACPI_RESOURCE *Resource,
1012 void *Context);
1013
1014ACPI_EXTERNAL_RETURN_STATUS (
1015ACPI_STATUS
1016AcpiGetVendorResource (
1017 ACPI_HANDLE Device,
1018 char *Name,
1019 ACPI_VENDOR_UUID *Uuid,
1020 ACPI_BUFFER *RetBuffer))
1021
1022ACPI_EXTERNAL_RETURN_STATUS (
1023ACPI_STATUS
1024AcpiGetCurrentResources (
1025 ACPI_HANDLE Device,
1026 ACPI_BUFFER *RetBuffer))
1027
1028ACPI_EXTERNAL_RETURN_STATUS (
1029ACPI_STATUS
1030AcpiGetPossibleResources (
1031 ACPI_HANDLE Device,
1032 ACPI_BUFFER *RetBuffer))
1033
1034ACPI_EXTERNAL_RETURN_STATUS (
1035ACPI_STATUS
1036AcpiGetEventResources (
1037 ACPI_HANDLE DeviceHandle,
1038 ACPI_BUFFER *RetBuffer))
1039
1040ACPI_EXTERNAL_RETURN_STATUS (
1041ACPI_STATUS
1042AcpiWalkResourceBuffer (
1043 ACPI_BUFFER *Buffer,
1044 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
1045 void *Context))
1046
1047ACPI_EXTERNAL_RETURN_STATUS (
1048ACPI_STATUS
1049AcpiWalkResources (
1050 ACPI_HANDLE Device,
1051 const char *Name,
1052 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
1053 void *Context))
1054
1055ACPI_EXTERNAL_RETURN_STATUS (
1056ACPI_STATUS
1057AcpiSetCurrentResources (
1058 ACPI_HANDLE Device,
1059 ACPI_BUFFER *InBuffer))
1060
1061ACPI_EXTERNAL_RETURN_STATUS (
1062ACPI_STATUS
1063AcpiGetIrqRoutingTable (
1064 ACPI_HANDLE Device,
1065 ACPI_BUFFER *RetBuffer))
1066
1067ACPI_EXTERNAL_RETURN_STATUS (
1068ACPI_STATUS
1069AcpiResourceToAddress64 (
1070 ACPI_RESOURCE *Resource,
1071 ACPI_RESOURCE_ADDRESS64 *Out))
1072
1073ACPI_EXTERNAL_RETURN_STATUS (
1074ACPI_STATUS
1075AcpiBufferToResource (
1076 UINT8 *AmlBuffer,
1077 UINT16 AmlBufferLength,
1078 ACPI_RESOURCE **ResourcePtr))
1079
1080
1081/*
1082 * Hardware (ACPI device) interfaces
1083 */
1084ACPI_EXTERNAL_RETURN_STATUS (
1085ACPI_STATUS
1086AcpiReset (
1087 void))
1088
1089ACPI_EXTERNAL_RETURN_STATUS (
1090ACPI_STATUS
1091AcpiRead (
1092 UINT64 *Value,
1093 ACPI_GENERIC_ADDRESS *Reg))
1094
1095ACPI_EXTERNAL_RETURN_STATUS (
1096ACPI_STATUS
1097AcpiWrite (
1098 UINT64 Value,
1099 ACPI_GENERIC_ADDRESS *Reg))
1100
1101ACPI_HW_DEPENDENT_RETURN_STATUS (
1102ACPI_STATUS
1103AcpiReadBitRegister (
1104 UINT32 RegisterId,
1105 UINT32 *ReturnValue))
1106
1107ACPI_HW_DEPENDENT_RETURN_STATUS (
1108ACPI_STATUS
1109AcpiWriteBitRegister (
1110 UINT32 RegisterId,
1111 UINT32 Value))
1112
1113
1114/*
1115 * Sleep/Wake interfaces
1116 */
1117ACPI_EXTERNAL_RETURN_STATUS (
1118ACPI_STATUS
1119AcpiGetSleepTypeData (
1120 UINT8 SleepState,
1121 UINT8 *Slp_TypA,
1122 UINT8 *Slp_TypB))
1123
1124ACPI_EXTERNAL_RETURN_STATUS (
1125ACPI_STATUS
1126AcpiEnterSleepStatePrep (
1127 UINT8 SleepState))
1128
1129ACPI_EXTERNAL_RETURN_STATUS (
1130ACPI_STATUS
1131AcpiEnterSleepState (
1132 UINT8 SleepState))
1133
1134ACPI_HW_DEPENDENT_RETURN_STATUS (
1135ACPI_STATUS
1136AcpiEnterSleepStateS4bios (
1137 void))
1138
1139ACPI_EXTERNAL_RETURN_STATUS (
1140ACPI_STATUS
1141AcpiLeaveSleepStatePrep (
1142 UINT8 SleepState))
1143
1144ACPI_EXTERNAL_RETURN_STATUS (
1145ACPI_STATUS
1146AcpiLeaveSleepState (
1147 UINT8 SleepState))
1148
1149ACPI_HW_DEPENDENT_RETURN_STATUS (
1150ACPI_STATUS
1151AcpiSetFirmwareWakingVector (
1152 ACPI_PHYSICAL_ADDRESS PhysicalAddress,
1153 ACPI_PHYSICAL_ADDRESS PhysicalAddress64))
1154
1155
1156/*
1157 * ACPI Timer interfaces
1158 */
1159ACPI_HW_DEPENDENT_RETURN_STATUS (
1160ACPI_STATUS
1161AcpiGetTimerResolution (
1162 UINT32 *Resolution))
1163
1164ACPI_HW_DEPENDENT_RETURN_STATUS (
1165ACPI_STATUS
1166AcpiGetTimer (
1167 UINT32 *Ticks))
1168
1169ACPI_HW_DEPENDENT_RETURN_STATUS (
1170ACPI_STATUS
1171AcpiGetTimerDuration (
1172 UINT32 StartTicks,
1173 UINT32 EndTicks,
1174 UINT32 *TimeElapsed))
1175
1176
1177/*
1178 * Error/Warning output
1179 */
1180ACPI_MSG_DEPENDENT_RETURN_VOID (
1181ACPI_PRINTF_LIKE(3)
1182void ACPI_INTERNAL_VAR_XFACE
1183AcpiError (
1184 const char *ModuleName,
1185 UINT32 LineNumber,
1186 const char *Format,
1187 ...))
1188
1189ACPI_MSG_DEPENDENT_RETURN_VOID (
1190ACPI_PRINTF_LIKE(4)
1191void ACPI_INTERNAL_VAR_XFACE
1192AcpiException (
1193 const char *ModuleName,
1194 UINT32 LineNumber,
1195 ACPI_STATUS Status,
1196 const char *Format,
1197 ...))
1198
1199ACPI_MSG_DEPENDENT_RETURN_VOID (
1200ACPI_PRINTF_LIKE(3)
1201void ACPI_INTERNAL_VAR_XFACE
1202AcpiWarning (
1203 const char *ModuleName,
1204 UINT32 LineNumber,
1205 const char *Format,
1206 ...))
1207
1208ACPI_MSG_DEPENDENT_RETURN_VOID (
1209ACPI_PRINTF_LIKE(1)
1210void ACPI_INTERNAL_VAR_XFACE
1211AcpiInfo (
1212 const char *Format,
1213 ...))
1214
1215ACPI_MSG_DEPENDENT_RETURN_VOID (
1216ACPI_PRINTF_LIKE(3)
1217void ACPI_INTERNAL_VAR_XFACE
1218AcpiBiosError (
1219 const char *ModuleName,
1220 UINT32 LineNumber,
1221 const char *Format,
1222 ...))
1223
1224ACPI_MSG_DEPENDENT_RETURN_VOID (
1225ACPI_PRINTF_LIKE(4)
1226void ACPI_INTERNAL_VAR_XFACE
1227AcpiBiosException (
1228 const char *ModuleName,
1229 UINT32 LineNumber,
1230 ACPI_STATUS Status,
1231 const char *Format,
1232 ...))
1233
1234ACPI_MSG_DEPENDENT_RETURN_VOID (
1235ACPI_PRINTF_LIKE(3)
1236void ACPI_INTERNAL_VAR_XFACE
1237AcpiBiosWarning (
1238 const char *ModuleName,
1239 UINT32 LineNumber,
1240 const char *Format,
1241 ...))
1242
1243
1244/*
1245 * Debug output
1246 */
1247ACPI_DBG_DEPENDENT_RETURN_VOID (
1248ACPI_PRINTF_LIKE(6)
1249void ACPI_INTERNAL_VAR_XFACE
1250AcpiDebugPrint (
1251 UINT32 RequestedDebugLevel,
1252 UINT32 LineNumber,
1253 const char *FunctionName,
1254 const char *ModuleName,
1255 UINT32 ComponentId,
1256 const char *Format,
1257 ...))
1258
1259ACPI_DBG_DEPENDENT_RETURN_VOID (
1260ACPI_PRINTF_LIKE(6)
1261void ACPI_INTERNAL_VAR_XFACE
1262AcpiDebugPrintRaw (
1263 UINT32 RequestedDebugLevel,
1264 UINT32 LineNumber,
1265 const char *FunctionName,
1266 const char *ModuleName,
1267 UINT32 ComponentId,
1268 const char *Format,
1269 ...))
1270
1271ACPI_DBG_DEPENDENT_RETURN_VOID (
1272void
1273AcpiTracePoint (
1274 ACPI_TRACE_EVENT_TYPE Type,
1275 BOOLEAN Begin,
1276 UINT8 *Aml,
1277 char *Pathname))
1278
1279ACPI_STATUS
1280AcpiInitializeDebugger (
1281 void);
1282
1283void
1284AcpiTerminateDebugger (
1285 void);
1286
1287void
1288AcpiRunDebugger (
1289 char *BatchBuffer);
1290
1291void
1292AcpiSetDebuggerThreadId (
1293 ACPI_THREAD_ID ThreadId);
1294
1295#endif /* __ACXFACE_H__ */
1296