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