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