acpixf.h revision 216471 
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                 0x20101209
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;
133extern BOOLEAN              AcpiGbl_SystemAwakeAndRunning;
134
135/* Runtime configuration of debug print levels */
136
137extern UINT32               AcpiDbgLevel;
138extern UINT32               AcpiDbgLayer;
139
140/* ACPICA runtime options */
141
142extern UINT8                AcpiGbl_EnableInterpreterSlack;
143extern UINT8                AcpiGbl_AllMethodsSerialized;
144extern UINT8                AcpiGbl_CreateOsiMethod;
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 * Initialization
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
178
179/*
180 * Miscellaneous global interfaces
181 */
182ACPI_STATUS
183AcpiEnable (
184    void);
185
186ACPI_STATUS
187AcpiDisable (
188    void);
189
190ACPI_STATUS
191AcpiSubsystemStatus (
192    void);
193
194ACPI_STATUS
195AcpiGetSystemInfo (
196    ACPI_BUFFER             *RetBuffer);
197
198ACPI_STATUS
199AcpiGetStatistics (
200    ACPI_STATISTICS         *Stats);
201
202const char *
203AcpiFormatException (
204    ACPI_STATUS             Exception);
205
206ACPI_STATUS
207AcpiPurgeCachedObjects (
208    void);
209
210ACPI_STATUS
211AcpiInstallInterface (
212    ACPI_STRING             InterfaceName);
213
214ACPI_STATUS
215AcpiRemoveInterface (
216    ACPI_STRING             InterfaceName);
217
218
219/*
220 * ACPI Memory management
221 */
222void *
223AcpiAllocate (
224    UINT32                  Size);
225
226void *
227AcpiCallocate (
228    UINT32                  Size);
229
230void
231AcpiFree (
232    void                    *Address);
233
234
235/*
236 * ACPI table manipulation interfaces
237 */
238ACPI_STATUS
239AcpiReallocateRootTable (
240    void);
241
242ACPI_STATUS
243AcpiFindRootPointer (
244    ACPI_SIZE               *RsdpAddress);
245
246ACPI_STATUS
247AcpiLoadTables (
248    void);
249
250ACPI_STATUS
251AcpiGetTableHeader (
252    ACPI_STRING             Signature,
253    UINT32                  Instance,
254    ACPI_TABLE_HEADER       *OutTableHeader);
255
256ACPI_STATUS
257AcpiGetTable (
258    ACPI_STRING             Signature,
259    UINT32                  Instance,
260    ACPI_TABLE_HEADER       **OutTable);
261
262ACPI_STATUS
263AcpiGetTableByIndex (
264    UINT32                  TableIndex,
265    ACPI_TABLE_HEADER       **OutTable);
266
267ACPI_STATUS
268AcpiInstallTableHandler (
269    ACPI_TABLE_HANDLER      Handler,
270    void                    *Context);
271
272ACPI_STATUS
273AcpiRemoveTableHandler (
274    ACPI_TABLE_HANDLER      Handler);
275
276
277/*
278 * Namespace and name interfaces
279 */
280ACPI_STATUS
281AcpiWalkNamespace (
282    ACPI_OBJECT_TYPE        Type,
283    ACPI_HANDLE             StartObject,
284    UINT32                  MaxDepth,
285    ACPI_WALK_CALLBACK      PreOrderVisit,
286    ACPI_WALK_CALLBACK      PostOrderVisit,
287    void                    *Context,
288    void                    **ReturnValue);
289
290ACPI_STATUS
291AcpiGetDevices (
292    char                    *HID,
293    ACPI_WALK_CALLBACK      UserFunction,
294    void                    *Context,
295    void                    **ReturnValue);
296
297ACPI_STATUS
298AcpiGetName (
299    ACPI_HANDLE             Object,
300    UINT32                  NameType,
301    ACPI_BUFFER             *RetPathPtr);
302
303ACPI_STATUS
304AcpiGetHandle (
305    ACPI_HANDLE             Parent,
306    ACPI_STRING             Pathname,
307    ACPI_HANDLE             *RetHandle);
308
309ACPI_STATUS
310AcpiAttachData (
311    ACPI_HANDLE             Object,
312    ACPI_OBJECT_HANDLER     Handler,
313    void                    *Data);
314
315ACPI_STATUS
316AcpiDetachData (
317    ACPI_HANDLE             Object,
318    ACPI_OBJECT_HANDLER     Handler);
319
320ACPI_STATUS
321AcpiGetData (
322    ACPI_HANDLE             Object,
323    ACPI_OBJECT_HANDLER     Handler,
324    void                    **Data);
325
326ACPI_STATUS
327AcpiDebugTrace (
328    char                    *Name,
329    UINT32                  DebugLevel,
330    UINT32                  DebugLayer,
331    UINT32                  Flags);
332
333
334/*
335 * Object manipulation and enumeration
336 */
337ACPI_STATUS
338AcpiEvaluateObject (
339    ACPI_HANDLE             Object,
340    ACPI_STRING             Pathname,
341    ACPI_OBJECT_LIST        *ParameterObjects,
342    ACPI_BUFFER             *ReturnObjectBuffer);
343
344ACPI_STATUS
345AcpiEvaluateObjectTyped (
346    ACPI_HANDLE             Object,
347    ACPI_STRING             Pathname,
348    ACPI_OBJECT_LIST        *ExternalParams,
349    ACPI_BUFFER             *ReturnBuffer,
350    ACPI_OBJECT_TYPE        ReturnType);
351
352ACPI_STATUS
353AcpiGetObjectInfo (
354    ACPI_HANDLE             Object,
355    ACPI_DEVICE_INFO        **ReturnBuffer);
356
357ACPI_STATUS
358AcpiInstallMethod (
359    UINT8                   *Buffer);
360
361ACPI_STATUS
362AcpiGetNextObject (
363    ACPI_OBJECT_TYPE        Type,
364    ACPI_HANDLE             Parent,
365    ACPI_HANDLE             Child,
366    ACPI_HANDLE             *OutHandle);
367
368ACPI_STATUS
369AcpiGetType (
370    ACPI_HANDLE             Object,
371    ACPI_OBJECT_TYPE        *OutType);
372
373ACPI_STATUS
374AcpiGetParent (
375    ACPI_HANDLE             Object,
376    ACPI_HANDLE             *OutHandle);
377
378
379/*
380 * Handler interfaces
381 */
382ACPI_STATUS
383AcpiInstallInitializationHandler (
384    ACPI_INIT_HANDLER       Handler,
385    UINT32                  Function);
386
387ACPI_STATUS
388AcpiInstallGlobalEventHandler (
389    ACPI_GBL_EVENT_HANDLER  Handler,
390    void                    *Context);
391
392ACPI_STATUS
393AcpiInstallFixedEventHandler (
394    UINT32                  AcpiEvent,
395    ACPI_EVENT_HANDLER      Handler,
396    void                    *Context);
397
398ACPI_STATUS
399AcpiRemoveFixedEventHandler (
400    UINT32                  AcpiEvent,
401    ACPI_EVENT_HANDLER      Handler);
402
403ACPI_STATUS
404AcpiInstallGpeHandler (
405    ACPI_HANDLE             GpeDevice,
406    UINT32                  GpeNumber,
407    UINT32                  Type,
408    ACPI_GPE_HANDLER        Address,
409    void                    *Context);
410
411ACPI_STATUS
412AcpiRemoveGpeHandler (
413    ACPI_HANDLE             GpeDevice,
414    UINT32                  GpeNumber,
415    ACPI_GPE_HANDLER        Address);
416
417ACPI_STATUS
418AcpiInstallNotifyHandler (
419    ACPI_HANDLE             Device,
420    UINT32                  HandlerType,
421    ACPI_NOTIFY_HANDLER     Handler,
422    void                    *Context);
423
424ACPI_STATUS
425AcpiRemoveNotifyHandler (
426    ACPI_HANDLE             Device,
427    UINT32                  HandlerType,
428    ACPI_NOTIFY_HANDLER     Handler);
429
430ACPI_STATUS
431AcpiInstallAddressSpaceHandler (
432    ACPI_HANDLE             Device,
433    ACPI_ADR_SPACE_TYPE     SpaceId,
434    ACPI_ADR_SPACE_HANDLER  Handler,
435    ACPI_ADR_SPACE_SETUP    Setup,
436    void                    *Context);
437
438ACPI_STATUS
439AcpiRemoveAddressSpaceHandler (
440    ACPI_HANDLE             Device,
441    ACPI_ADR_SPACE_TYPE     SpaceId,
442    ACPI_ADR_SPACE_HANDLER  Handler);
443
444ACPI_STATUS
445AcpiInstallExceptionHandler (
446    ACPI_EXCEPTION_HANDLER  Handler);
447
448ACPI_STATUS
449AcpiInstallInterfaceHandler (
450    ACPI_INTERFACE_HANDLER  Handler);
451
452
453/*
454 * Global Lock interfaces
455 */
456ACPI_STATUS
457AcpiAcquireGlobalLock (
458    UINT16                  Timeout,
459    UINT32                  *Handle);
460
461ACPI_STATUS
462AcpiReleaseGlobalLock (
463    UINT32                  Handle);
464
465
466/*
467 * Fixed Event interfaces
468 */
469ACPI_STATUS
470AcpiEnableEvent (
471    UINT32                  Event,
472    UINT32                  Flags);
473
474ACPI_STATUS
475AcpiDisableEvent (
476    UINT32                  Event,
477    UINT32                  Flags);
478
479ACPI_STATUS
480AcpiClearEvent (
481    UINT32                  Event);
482
483ACPI_STATUS
484AcpiGetEventStatus (
485    UINT32                  Event,
486    ACPI_EVENT_STATUS       *EventStatus);
487
488
489/*
490 * General Purpose Event (GPE) Interfaces
491 */
492ACPI_STATUS
493AcpiUpdateAllGpes (
494    void);
495
496ACPI_STATUS
497AcpiEnableGpe (
498    ACPI_HANDLE             GpeDevice,
499    UINT32                  GpeNumber);
500
501ACPI_STATUS
502AcpiDisableGpe (
503    ACPI_HANDLE             GpeDevice,
504    UINT32                  GpeNumber);
505
506ACPI_STATUS
507AcpiClearGpe (
508    ACPI_HANDLE             GpeDevice,
509    UINT32                  GpeNumber);
510
511ACPI_STATUS
512AcpiSetGpe (
513    ACPI_HANDLE             GpeDevice,
514    UINT32                  GpeNumber,
515    UINT8                   Action);
516
517ACPI_STATUS
518AcpiFinishGpe (
519    ACPI_HANDLE             GpeDevice,
520    UINT32                  GpeNumber);
521
522ACPI_STATUS
523AcpiSetupGpeForWake (
524    ACPI_HANDLE             ParentDevice,
525    ACPI_HANDLE             GpeDevice,
526    UINT32                  GpeNumber);
527
528ACPI_STATUS
529AcpiSetGpeWakeMask (
530    ACPI_HANDLE             GpeDevice,
531    UINT32                  GpeNumber,
532    UINT8                   Action);
533
534ACPI_STATUS
535AcpiGetGpeStatus (
536    ACPI_HANDLE             GpeDevice,
537    UINT32                  GpeNumber,
538    ACPI_EVENT_STATUS       *EventStatus);
539
540ACPI_STATUS
541AcpiDisableAllGpes (
542    void);
543
544ACPI_STATUS
545AcpiEnableAllRuntimeGpes (
546    void);
547
548ACPI_STATUS
549AcpiGetGpeDevice (
550    UINT32                  GpeIndex,
551    ACPI_HANDLE             *GpeDevice);
552
553ACPI_STATUS
554AcpiInstallGpeBlock (
555    ACPI_HANDLE             GpeDevice,
556    ACPI_GENERIC_ADDRESS    *GpeBlockAddress,
557    UINT32                  RegisterCount,
558    UINT32                  InterruptNumber);
559
560ACPI_STATUS
561AcpiRemoveGpeBlock (
562    ACPI_HANDLE             GpeDevice);
563
564
565/*
566 * Resource interfaces
567 */
568typedef
569ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) (
570    ACPI_RESOURCE           *Resource,
571    void                    *Context);
572
573ACPI_STATUS
574AcpiGetVendorResource (
575    ACPI_HANDLE             Device,
576    char                    *Name,
577    ACPI_VENDOR_UUID        *Uuid,
578    ACPI_BUFFER             *RetBuffer);
579
580ACPI_STATUS
581AcpiGetCurrentResources (
582    ACPI_HANDLE             Device,
583    ACPI_BUFFER             *RetBuffer);
584
585ACPI_STATUS
586AcpiGetPossibleResources (
587    ACPI_HANDLE             Device,
588    ACPI_BUFFER             *RetBuffer);
589
590ACPI_STATUS
591AcpiWalkResources (
592    ACPI_HANDLE                 Device,
593    char                        *Name,
594    ACPI_WALK_RESOURCE_CALLBACK UserFunction,
595    void                        *Context);
596
597ACPI_STATUS
598AcpiSetCurrentResources (
599    ACPI_HANDLE             Device,
600    ACPI_BUFFER             *InBuffer);
601
602ACPI_STATUS
603AcpiGetIrqRoutingTable (
604    ACPI_HANDLE             Device,
605    ACPI_BUFFER             *RetBuffer);
606
607ACPI_STATUS
608AcpiResourceToAddress64 (
609    ACPI_RESOURCE           *Resource,
610    ACPI_RESOURCE_ADDRESS64 *Out);
611
612
613/*
614 * Hardware (ACPI device) interfaces
615 */
616ACPI_STATUS
617AcpiReset (
618    void);
619
620ACPI_STATUS
621AcpiRead (
622    UINT64                  *Value,
623    ACPI_GENERIC_ADDRESS    *Reg);
624
625ACPI_STATUS
626AcpiWrite (
627    UINT64                  Value,
628    ACPI_GENERIC_ADDRESS    *Reg);
629
630ACPI_STATUS
631AcpiReadBitRegister (
632    UINT32                  RegisterId,
633    UINT32                  *ReturnValue);
634
635ACPI_STATUS
636AcpiWriteBitRegister (
637    UINT32                  RegisterId,
638    UINT32                  Value);
639
640ACPI_STATUS
641AcpiGetSleepTypeData (
642    UINT8                   SleepState,
643    UINT8                   *Slp_TypA,
644    UINT8                   *Slp_TypB);
645
646ACPI_STATUS
647AcpiEnterSleepStatePrep (
648    UINT8                   SleepState);
649
650ACPI_STATUS
651AcpiEnterSleepState (
652    UINT8                   SleepState);
653
654ACPI_STATUS
655AcpiEnterSleepStateS4bios (
656    void);
657
658ACPI_STATUS
659AcpiLeaveSleepState (
660    UINT8                   SleepState)
661    ;
662ACPI_STATUS
663AcpiSetFirmwareWakingVector (
664    UINT32                  PhysicalAddress);
665
666#if ACPI_MACHINE_WIDTH == 64
667ACPI_STATUS
668AcpiSetFirmwareWakingVector64 (
669    UINT64                  PhysicalAddress);
670#endif
671
672
673/*
674 * Error/Warning output
675 */
676void ACPI_INTERNAL_VAR_XFACE
677AcpiError (
678    const char              *ModuleName,
679    UINT32                  LineNumber,
680    const char              *Format,
681    ...) ACPI_PRINTF_LIKE(3);
682
683void  ACPI_INTERNAL_VAR_XFACE
684AcpiException (
685    const char              *ModuleName,
686    UINT32                  LineNumber,
687    ACPI_STATUS             Status,
688    const char              *Format,
689    ...) ACPI_PRINTF_LIKE(4);
690
691void ACPI_INTERNAL_VAR_XFACE
692AcpiWarning (
693    const char              *ModuleName,
694    UINT32                  LineNumber,
695    const char              *Format,
696    ...) ACPI_PRINTF_LIKE(3);
697
698void ACPI_INTERNAL_VAR_XFACE
699AcpiInfo (
700    const char              *ModuleName,
701    UINT32                  LineNumber,
702    const char              *Format,
703    ...) ACPI_PRINTF_LIKE(3);
704
705
706/*
707 * Debug output
708 */
709#ifdef ACPI_DEBUG_OUTPUT
710
711void ACPI_INTERNAL_VAR_XFACE
712AcpiDebugPrint (
713    UINT32                  RequestedDebugLevel,
714    UINT32                  LineNumber,
715    const char              *FunctionName,
716    const char              *ModuleName,
717    UINT32                  ComponentId,
718    const char              *Format,
719    ...) ACPI_PRINTF_LIKE(6);
720
721void ACPI_INTERNAL_VAR_XFACE
722AcpiDebugPrintRaw (
723    UINT32                  RequestedDebugLevel,
724    UINT32                  LineNumber,
725    const char              *FunctionName,
726    const char              *ModuleName,
727    UINT32                  ComponentId,
728    const char              *Format,
729    ...) ACPI_PRINTF_LIKE(6);
730#endif
731
732#endif /* __ACXFACE_H__ */
733