acpixf.h revision 210976 
1
2/******************************************************************************
3 *
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights.  You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code.  No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision.  In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change.  Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee.  Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution.  In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government.  In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
116
117
118#ifndef __ACXFACE_H__
119#define __ACXFACE_H__
120
121/* Current ACPICA subsystem version in YYYYMMDD format */
122
123#define ACPI_CA_VERSION                 0x20100806
124
125#include <contrib/dev/acpica/include/actypes.h>
126#include <contrib/dev/acpica/include/actbl.h>
127
128/*
129 * Globals that are publically available
130 */
131extern UINT32               AcpiCurrentGpeCount;
132extern ACPI_TABLE_FADT      AcpiGbl_FADT;
133
134/* Runtime configuration of debug print levels */
135
136extern UINT32               AcpiDbgLevel;
137extern UINT32               AcpiDbgLayer;
138
139/* ACPICA runtime options */
140
141extern UINT8                AcpiGbl_EnableInterpreterSlack;
142extern UINT8                AcpiGbl_AllMethodsSerialized;
143extern UINT8                AcpiGbl_CreateOsiMethod;
144extern UINT8                AcpiGbl_LeaveWakeGpesDisabled;
145extern UINT8                AcpiGbl_UseDefaultRegisterWidths;
146extern ACPI_NAME            AcpiGbl_TraceMethodName;
147extern UINT32               AcpiGbl_TraceFlags;
148extern UINT8                AcpiGbl_EnableAmlDebugObject;
149extern UINT8                AcpiGbl_CopyDsdtLocally;
150extern UINT8                AcpiGbl_TruncateIoAddresses;
151
152
153/*
154 * Global interfaces
155 */
156ACPI_STATUS
157AcpiInitializeTables (
158    ACPI_TABLE_DESC         *InitialStorage,
159    UINT32                  InitialTableCount,
160    BOOLEAN                 AllowResize);
161
162ACPI_STATUS
163AcpiInitializeSubsystem (
164    void);
165
166ACPI_STATUS
167AcpiEnableSubsystem (
168    UINT32                  Flags);
169
170ACPI_STATUS
171AcpiInitializeObjects (
172    UINT32                  Flags);
173
174ACPI_STATUS
175AcpiTerminate (
176    void);
177
178ACPI_STATUS
179AcpiSubsystemStatus (
180    void);
181
182ACPI_STATUS
183AcpiEnable (
184    void);
185
186ACPI_STATUS
187AcpiDisable (
188    void);
189
190ACPI_STATUS
191AcpiGetSystemInfo (
192    ACPI_BUFFER             *RetBuffer);
193
194ACPI_STATUS
195AcpiGetStatistics (
196    ACPI_STATISTICS         *Stats);
197
198const char *
199AcpiFormatException (
200    ACPI_STATUS             Exception);
201
202ACPI_STATUS
203AcpiPurgeCachedObjects (
204    void);
205
206ACPI_STATUS
207AcpiInstallInterface (
208    ACPI_STRING             InterfaceName);
209
210ACPI_STATUS
211AcpiRemoveInterface (
212    ACPI_STRING             InterfaceName);
213
214/*
215 * ACPI Memory management
216 */
217void *
218AcpiAllocate (
219    UINT32                  Size);
220
221void *
222AcpiCallocate (
223    UINT32                  Size);
224
225void
226AcpiFree (
227    void                    *Address);
228
229
230/*
231 * ACPI table manipulation interfaces
232 */
233ACPI_STATUS
234AcpiReallocateRootTable (
235    void);
236
237ACPI_STATUS
238AcpiFindRootPointer (
239    ACPI_SIZE               *RsdpAddress);
240
241ACPI_STATUS
242AcpiLoadTables (
243    void);
244
245ACPI_STATUS
246AcpiGetTableHeader (
247    ACPI_STRING             Signature,
248    UINT32                  Instance,
249    ACPI_TABLE_HEADER       *OutTableHeader);
250
251ACPI_STATUS
252AcpiGetTable (
253    ACPI_STRING             Signature,
254    UINT32                  Instance,
255    ACPI_TABLE_HEADER       **OutTable);
256
257ACPI_STATUS
258AcpiGetTableByIndex (
259    UINT32                  TableIndex,
260    ACPI_TABLE_HEADER       **OutTable);
261
262ACPI_STATUS
263AcpiInstallTableHandler (
264    ACPI_TABLE_HANDLER      Handler,
265    void                    *Context);
266
267ACPI_STATUS
268AcpiRemoveTableHandler (
269    ACPI_TABLE_HANDLER      Handler);
270
271
272/*
273 * Namespace and name interfaces
274 */
275ACPI_STATUS
276AcpiWalkNamespace (
277    ACPI_OBJECT_TYPE        Type,
278    ACPI_HANDLE             StartObject,
279    UINT32                  MaxDepth,
280    ACPI_WALK_CALLBACK      PreOrderVisit,
281    ACPI_WALK_CALLBACK      PostOrderVisit,
282    void                    *Context,
283    void                    **ReturnValue);
284
285ACPI_STATUS
286AcpiGetDevices (
287    char                    *HID,
288    ACPI_WALK_CALLBACK      UserFunction,
289    void                    *Context,
290    void                    **ReturnValue);
291
292ACPI_STATUS
293AcpiGetName (
294    ACPI_HANDLE             Object,
295    UINT32                  NameType,
296    ACPI_BUFFER             *RetPathPtr);
297
298ACPI_STATUS
299AcpiGetHandle (
300    ACPI_HANDLE             Parent,
301    ACPI_STRING             Pathname,
302    ACPI_HANDLE             *RetHandle);
303
304ACPI_STATUS
305AcpiAttachData (
306    ACPI_HANDLE             Object,
307    ACPI_OBJECT_HANDLER     Handler,
308    void                    *Data);
309
310ACPI_STATUS
311AcpiDetachData (
312    ACPI_HANDLE             Object,
313    ACPI_OBJECT_HANDLER     Handler);
314
315ACPI_STATUS
316AcpiGetData (
317    ACPI_HANDLE             Object,
318    ACPI_OBJECT_HANDLER     Handler,
319    void                    **Data);
320
321ACPI_STATUS
322AcpiDebugTrace (
323    char                    *Name,
324    UINT32                  DebugLevel,
325    UINT32                  DebugLayer,
326    UINT32                  Flags);
327
328
329/*
330 * Object manipulation and enumeration
331 */
332ACPI_STATUS
333AcpiEvaluateObject (
334    ACPI_HANDLE             Object,
335    ACPI_STRING             Pathname,
336    ACPI_OBJECT_LIST        *ParameterObjects,
337    ACPI_BUFFER             *ReturnObjectBuffer);
338
339ACPI_STATUS
340AcpiEvaluateObjectTyped (
341    ACPI_HANDLE             Object,
342    ACPI_STRING             Pathname,
343    ACPI_OBJECT_LIST        *ExternalParams,
344    ACPI_BUFFER             *ReturnBuffer,
345    ACPI_OBJECT_TYPE        ReturnType);
346
347ACPI_STATUS
348AcpiGetObjectInfo (
349    ACPI_HANDLE             Object,
350    ACPI_DEVICE_INFO        **ReturnBuffer);
351
352ACPI_STATUS
353AcpiInstallMethod (
354    UINT8                   *Buffer);
355
356ACPI_STATUS
357AcpiGetNextObject (
358    ACPI_OBJECT_TYPE        Type,
359    ACPI_HANDLE             Parent,
360    ACPI_HANDLE             Child,
361    ACPI_HANDLE             *OutHandle);
362
363ACPI_STATUS
364AcpiGetType (
365    ACPI_HANDLE             Object,
366    ACPI_OBJECT_TYPE        *OutType);
367
368ACPI_STATUS
369AcpiGetParent (
370    ACPI_HANDLE             Object,
371    ACPI_HANDLE             *OutHandle);
372
373
374/*
375 * Handler interfaces
376 */
377ACPI_STATUS
378AcpiInstallInitializationHandler (
379    ACPI_INIT_HANDLER       Handler,
380    UINT32                  Function);
381
382ACPI_STATUS
383AcpiInstallFixedEventHandler (
384    UINT32                  AcpiEvent,
385    ACPI_EVENT_HANDLER      Handler,
386    void                    *Context);
387
388ACPI_STATUS
389AcpiRemoveFixedEventHandler (
390    UINT32                  AcpiEvent,
391    ACPI_EVENT_HANDLER      Handler);
392
393ACPI_STATUS
394AcpiInstallNotifyHandler (
395    ACPI_HANDLE             Device,
396    UINT32                  HandlerType,
397    ACPI_NOTIFY_HANDLER     Handler,
398    void                    *Context);
399
400ACPI_STATUS
401AcpiRemoveNotifyHandler (
402    ACPI_HANDLE             Device,
403    UINT32                  HandlerType,
404    ACPI_NOTIFY_HANDLER     Handler);
405
406ACPI_STATUS
407AcpiInstallAddressSpaceHandler (
408    ACPI_HANDLE             Device,
409    ACPI_ADR_SPACE_TYPE     SpaceId,
410    ACPI_ADR_SPACE_HANDLER  Handler,
411    ACPI_ADR_SPACE_SETUP    Setup,
412    void                    *Context);
413
414ACPI_STATUS
415AcpiRemoveAddressSpaceHandler (
416    ACPI_HANDLE             Device,
417    ACPI_ADR_SPACE_TYPE     SpaceId,
418    ACPI_ADR_SPACE_HANDLER  Handler);
419
420ACPI_STATUS
421AcpiInstallGpeHandler (
422    ACPI_HANDLE             GpeDevice,
423    UINT32                  GpeNumber,
424    UINT32                  Type,
425    ACPI_EVENT_HANDLER      Address,
426    void                    *Context);
427
428ACPI_STATUS
429AcpiRemoveGpeHandler (
430    ACPI_HANDLE             GpeDevice,
431    UINT32                  GpeNumber,
432    ACPI_EVENT_HANDLER      Address);
433
434ACPI_STATUS
435AcpiInstallExceptionHandler (
436    ACPI_EXCEPTION_HANDLER  Handler);
437
438ACPI_STATUS
439AcpiInstallInterfaceHandler (
440    ACPI_INTERFACE_HANDLER  Handler);
441
442
443/*
444 * Event interfaces
445 */
446ACPI_STATUS
447AcpiAcquireGlobalLock (
448    UINT16                  Timeout,
449    UINT32                  *Handle);
450
451ACPI_STATUS
452AcpiReleaseGlobalLock (
453    UINT32                  Handle);
454
455ACPI_STATUS
456AcpiEnableEvent (
457    UINT32                  Event,
458    UINT32                  Flags);
459
460ACPI_STATUS
461AcpiDisableEvent (
462    UINT32                  Event,
463    UINT32                  Flags);
464
465ACPI_STATUS
466AcpiClearEvent (
467    UINT32                  Event);
468
469ACPI_STATUS
470AcpiGetEventStatus (
471    UINT32                  Event,
472    ACPI_EVENT_STATUS       *EventStatus);
473
474
475/*
476 * GPE Interfaces
477 */
478ACPI_STATUS
479AcpiSetGpe (
480    ACPI_HANDLE             GpeDevice,
481    UINT32                  GpeNumber,
482    UINT8                   Action);
483
484ACPI_STATUS
485AcpiEnableGpe (
486    ACPI_HANDLE             GpeDevice,
487    UINT32                  GpeNumber);
488
489ACPI_STATUS
490AcpiDisableGpe (
491    ACPI_HANDLE             GpeDevice,
492    UINT32                  GpeNumber);
493
494ACPI_STATUS
495AcpiClearGpe (
496    ACPI_HANDLE             GpeDevice,
497    UINT32                  GpeNumber);
498
499ACPI_STATUS
500AcpiGpeWakeup (
501    ACPI_HANDLE             GpeDevice,
502    UINT32                  GpeNumber,
503    UINT8                   Action);
504
505ACPI_STATUS
506AcpiGetGpeStatus (
507    ACPI_HANDLE             GpeDevice,
508    UINT32                  GpeNumber,
509    ACPI_EVENT_STATUS       *EventStatus);
510
511ACPI_STATUS
512AcpiDisableAllGpes (
513    void);
514
515ACPI_STATUS
516AcpiEnableAllRuntimeGpes (
517    void);
518
519ACPI_STATUS
520AcpiGetGpeDevice (
521    UINT32                  GpeIndex,
522    ACPI_HANDLE             *GpeDevice);
523
524ACPI_STATUS
525AcpiInstallGpeBlock (
526    ACPI_HANDLE             GpeDevice,
527    ACPI_GENERIC_ADDRESS    *GpeBlockAddress,
528    UINT32                  RegisterCount,
529    UINT32                  InterruptNumber);
530
531ACPI_STATUS
532AcpiRemoveGpeBlock (
533    ACPI_HANDLE             GpeDevice);
534
535
536/*
537 * Resource interfaces
538 */
539typedef
540ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) (
541    ACPI_RESOURCE           *Resource,
542    void                    *Context);
543
544ACPI_STATUS
545AcpiGetVendorResource (
546    ACPI_HANDLE             Device,
547    char                    *Name,
548    ACPI_VENDOR_UUID        *Uuid,
549    ACPI_BUFFER             *RetBuffer);
550
551ACPI_STATUS
552AcpiGetCurrentResources (
553    ACPI_HANDLE             Device,
554    ACPI_BUFFER             *RetBuffer);
555
556ACPI_STATUS
557AcpiGetPossibleResources (
558    ACPI_HANDLE             Device,
559    ACPI_BUFFER             *RetBuffer);
560
561ACPI_STATUS
562AcpiWalkResources (
563    ACPI_HANDLE                 Device,
564    char                        *Name,
565    ACPI_WALK_RESOURCE_CALLBACK UserFunction,
566    void                        *Context);
567
568ACPI_STATUS
569AcpiSetCurrentResources (
570    ACPI_HANDLE             Device,
571    ACPI_BUFFER             *InBuffer);
572
573ACPI_STATUS
574AcpiGetIrqRoutingTable (
575    ACPI_HANDLE             Device,
576    ACPI_BUFFER             *RetBuffer);
577
578ACPI_STATUS
579AcpiResourceToAddress64 (
580    ACPI_RESOURCE           *Resource,
581    ACPI_RESOURCE_ADDRESS64 *Out);
582
583
584/*
585 * Hardware (ACPI device) interfaces
586 */
587ACPI_STATUS
588AcpiReset (
589    void);
590
591ACPI_STATUS
592AcpiRead (
593    UINT64                  *Value,
594    ACPI_GENERIC_ADDRESS    *Reg);
595
596ACPI_STATUS
597AcpiWrite (
598    UINT64                  Value,
599    ACPI_GENERIC_ADDRESS    *Reg);
600
601ACPI_STATUS
602AcpiReadBitRegister (
603    UINT32                  RegisterId,
604    UINT32                  *ReturnValue);
605
606ACPI_STATUS
607AcpiWriteBitRegister (
608    UINT32                  RegisterId,
609    UINT32                  Value);
610
611ACPI_STATUS
612AcpiGetSleepTypeData (
613    UINT8                   SleepState,
614    UINT8                   *Slp_TypA,
615    UINT8                   *Slp_TypB);
616
617ACPI_STATUS
618AcpiEnterSleepStatePrep (
619    UINT8                   SleepState);
620
621ACPI_STATUS
622AcpiEnterSleepState (
623    UINT8                   SleepState);
624
625ACPI_STATUS
626AcpiEnterSleepStateS4bios (
627    void);
628
629ACPI_STATUS
630AcpiLeaveSleepState (
631    UINT8                   SleepState)
632    ;
633ACPI_STATUS
634AcpiSetFirmwareWakingVector (
635    UINT32                  PhysicalAddress);
636
637#if ACPI_MACHINE_WIDTH == 64
638ACPI_STATUS
639AcpiSetFirmwareWakingVector64 (
640    UINT64                  PhysicalAddress);
641#endif
642
643
644/*
645 * Error/Warning output
646 */
647void ACPI_INTERNAL_VAR_XFACE
648AcpiError (
649    const char              *ModuleName,
650    UINT32                  LineNumber,
651    const char              *Format,
652    ...) ACPI_PRINTF_LIKE(3);
653
654void  ACPI_INTERNAL_VAR_XFACE
655AcpiException (
656    const char              *ModuleName,
657    UINT32                  LineNumber,
658    ACPI_STATUS             Status,
659    const char              *Format,
660    ...) ACPI_PRINTF_LIKE(4);
661
662void ACPI_INTERNAL_VAR_XFACE
663AcpiWarning (
664    const char              *ModuleName,
665    UINT32                  LineNumber,
666    const char              *Format,
667    ...) ACPI_PRINTF_LIKE(3);
668
669void ACPI_INTERNAL_VAR_XFACE
670AcpiInfo (
671    const char              *ModuleName,
672    UINT32                  LineNumber,
673    const char              *Format,
674    ...) ACPI_PRINTF_LIKE(3);
675
676
677/*
678 * Debug output
679 */
680#ifdef ACPI_DEBUG_OUTPUT
681
682void ACPI_INTERNAL_VAR_XFACE
683AcpiDebugPrint (
684    UINT32                  RequestedDebugLevel,
685    UINT32                  LineNumber,
686    const char              *FunctionName,
687    const char              *ModuleName,
688    UINT32                  ComponentId,
689    const char              *Format,
690    ...) ACPI_PRINTF_LIKE(6);
691
692void ACPI_INTERNAL_VAR_XFACE
693AcpiDebugPrintRaw (
694    UINT32                  RequestedDebugLevel,
695    UINT32                  LineNumber,
696    const char              *FunctionName,
697    const char              *ModuleName,
698    UINT32                  ComponentId,
699    const char              *Format,
700    ...) ACPI_PRINTF_LIKE(6);
701#endif
702
703#endif /* __ACXFACE_H__ */
704