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