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