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