acpixf.h revision 87031 
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, 2000, 2001, 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#include "actypes.h"
122#include "actbl.h"
123
124
125 /*
126 * Global interfaces
127 */
128
129ACPI_STATUS
130AcpiInitializeSubsystem (
131    void);
132
133ACPI_STATUS
134AcpiEnableSubsystem (
135    UINT32                  Flags);
136
137ACPI_STATUS
138AcpiTerminate (
139    void);
140
141ACPI_STATUS
142AcpiSubsystemStatus (
143    void);
144
145ACPI_STATUS
146AcpiEnable (
147    void);
148
149ACPI_STATUS
150AcpiDisable (
151    void);
152
153ACPI_STATUS
154AcpiGetSystemInfo (
155    ACPI_BUFFER             *RetBuffer);
156
157const char *
158AcpiFormatException (
159    ACPI_STATUS             Exception);
160
161ACPI_STATUS
162AcpiPurgeCachedObjects (
163    void);
164
165
166/*
167 * ACPI Memory manager
168 */
169
170void *
171AcpiAllocate (
172    UINT32                  Size);
173
174void *
175AcpiCallocate (
176    UINT32                  Size);
177
178void
179AcpiFree (
180    void                    *Address);
181
182
183/*
184 * ACPI table manipulation interfaces
185 */
186
187ACPI_STATUS
188AcpiFindRootPointer (
189    UINT32                  Flags,
190    ACPI_PHYSICAL_ADDRESS   *RsdpPhysicalAddress);
191
192ACPI_STATUS
193AcpiLoadTables (
194    void);
195
196ACPI_STATUS
197AcpiLoadTable (
198    ACPI_TABLE_HEADER       *TablePtr);
199
200ACPI_STATUS
201AcpiUnloadTable (
202    ACPI_TABLE_TYPE         TableType);
203
204ACPI_STATUS
205AcpiGetTableHeader (
206    ACPI_TABLE_TYPE         TableType,
207    UINT32                  Instance,
208    ACPI_TABLE_HEADER       *OutTableHeader);
209
210ACPI_STATUS
211AcpiGetTable (
212    ACPI_TABLE_TYPE         TableType,
213    UINT32                  Instance,
214    ACPI_BUFFER             *RetBuffer);
215
216ACPI_STATUS
217AcpiGetFirmwareTable (
218    ACPI_STRING             Signature,
219    UINT32                  Instance,
220    UINT32                  Flags,
221    ACPI_TABLE_HEADER       **TablePointer);
222
223
224/*
225 * Namespace and name interfaces
226 */
227
228ACPI_STATUS
229AcpiWalkNamespace (
230    ACPI_OBJECT_TYPE        Type,
231    ACPI_HANDLE             StartObject,
232    UINT32                  MaxDepth,
233    ACPI_WALK_CALLBACK      UserFunction,
234    void                    *Context,
235    void *                  *ReturnValue);
236
237ACPI_STATUS
238AcpiGetDevices (
239    NATIVE_CHAR             *HID,
240    ACPI_WALK_CALLBACK      UserFunction,
241    void                    *Context,
242    void                    **ReturnValue);
243
244ACPI_STATUS
245AcpiGetName (
246    ACPI_HANDLE             Handle,
247    UINT32                  NameType,
248    ACPI_BUFFER             *RetPathPtr);
249
250ACPI_STATUS
251AcpiGetHandle (
252    ACPI_HANDLE             Parent,
253    ACPI_STRING             Pathname,
254    ACPI_HANDLE             *RetHandle);
255
256ACPI_STATUS
257AcpiAttachData (
258    ACPI_HANDLE             ObjHandle,
259    ACPI_OBJECT_HANDLER     Handler,
260    void                    *Data);
261
262ACPI_STATUS
263AcpiDetachData (
264    ACPI_HANDLE             ObjHandle,
265    ACPI_OBJECT_HANDLER     Handler);
266
267ACPI_STATUS
268AcpiGetData (
269    ACPI_HANDLE             ObjHandle,
270    ACPI_OBJECT_HANDLER     Handler,
271    void                    **Data);
272
273
274/*
275 * Object manipulation and enumeration
276 */
277
278ACPI_STATUS
279AcpiEvaluateObject (
280    ACPI_HANDLE             Object,
281    ACPI_STRING             Pathname,
282    ACPI_OBJECT_LIST        *ParameterObjects,
283    ACPI_BUFFER             *ReturnObjectBuffer);
284
285ACPI_STATUS
286AcpiGetObjectInfo (
287    ACPI_HANDLE             Device,
288    ACPI_DEVICE_INFO        *Info);
289
290ACPI_STATUS
291AcpiGetNextObject (
292    ACPI_OBJECT_TYPE        Type,
293    ACPI_HANDLE             Parent,
294    ACPI_HANDLE             Child,
295    ACPI_HANDLE             *OutHandle);
296
297ACPI_STATUS
298AcpiGetType (
299    ACPI_HANDLE             Object,
300    ACPI_OBJECT_TYPE        *OutType);
301
302ACPI_STATUS
303AcpiGetParent (
304    ACPI_HANDLE             Object,
305    ACPI_HANDLE             *OutHandle);
306
307
308/*
309 * Event handler interfaces
310 */
311
312ACPI_STATUS
313AcpiInstallFixedEventHandler (
314    UINT32                  AcpiEvent,
315    ACPI_EVENT_HANDLER      Handler,
316    void                    *Context);
317
318ACPI_STATUS
319AcpiRemoveFixedEventHandler (
320    UINT32                  AcpiEvent,
321    ACPI_EVENT_HANDLER      Handler);
322
323ACPI_STATUS
324AcpiInstallNotifyHandler (
325    ACPI_HANDLE             Device,
326    UINT32                  HandlerType,
327    ACPI_NOTIFY_HANDLER     Handler,
328    void                    *Context);
329
330ACPI_STATUS
331AcpiRemoveNotifyHandler (
332    ACPI_HANDLE             Device,
333    UINT32                  HandlerType,
334    ACPI_NOTIFY_HANDLER     Handler);
335
336ACPI_STATUS
337AcpiInstallAddressSpaceHandler (
338    ACPI_HANDLE             Device,
339    ACPI_ADR_SPACE_TYPE     SpaceId,
340    ACPI_ADR_SPACE_HANDLER  Handler,
341    ACPI_ADR_SPACE_SETUP    Setup,
342    void                    *Context);
343
344ACPI_STATUS
345AcpiRemoveAddressSpaceHandler (
346    ACPI_HANDLE             Device,
347    ACPI_ADR_SPACE_TYPE     SpaceId,
348    ACPI_ADR_SPACE_HANDLER  Handler);
349
350ACPI_STATUS
351AcpiInstallGpeHandler (
352    UINT32                  GpeNumber,
353    UINT32                  Type,
354    ACPI_GPE_HANDLER        Handler,
355    void                    *Context);
356
357ACPI_STATUS
358AcpiAcquireGlobalLock (
359    void);
360
361ACPI_STATUS
362AcpiReleaseGlobalLock (
363    void);
364
365ACPI_STATUS
366AcpiRemoveGpeHandler (
367    UINT32                  GpeNumber,
368    ACPI_GPE_HANDLER        Handler);
369
370ACPI_STATUS
371AcpiEnableEvent (
372    UINT32                  AcpiEvent,
373    UINT32                  Type,
374    UINT32                  Flags);
375
376ACPI_STATUS
377AcpiDisableEvent (
378    UINT32                  AcpiEvent,
379    UINT32                  Type,
380    UINT32                  Flags);
381
382ACPI_STATUS
383AcpiClearEvent (
384    UINT32                  AcpiEvent,
385    UINT32                  Type);
386
387ACPI_STATUS
388AcpiGetEventStatus (
389    UINT32                  AcpiEvent,
390    UINT32                  Type,
391    ACPI_EVENT_STATUS       *EventStatus);
392
393/*
394 * Resource interfaces
395 */
396
397ACPI_STATUS
398AcpiGetCurrentResources(
399    ACPI_HANDLE             DeviceHandle,
400    ACPI_BUFFER             *RetBuffer);
401
402ACPI_STATUS
403AcpiGetPossibleResources(
404    ACPI_HANDLE             DeviceHandle,
405    ACPI_BUFFER             *RetBuffer);
406
407ACPI_STATUS
408AcpiSetCurrentResources (
409    ACPI_HANDLE             DeviceHandle,
410    ACPI_BUFFER             *InBuffer);
411
412ACPI_STATUS
413AcpiGetIrqRoutingTable  (
414    ACPI_HANDLE             BusDeviceHandle,
415    ACPI_BUFFER             *RetBuffer);
416
417
418/*
419 * Hardware (ACPI device) interfaces
420 */
421
422ACPI_STATUS
423AcpiSetFirmwareWakingVector (
424    ACPI_PHYSICAL_ADDRESS   PhysicalAddress);
425
426ACPI_STATUS
427AcpiGetFirmwareWakingVector (
428    ACPI_PHYSICAL_ADDRESS   *PhysicalAddress);
429
430
431ACPI_STATUS
432AcpiEnterSleepStatePrep (
433    UINT8 SleepState);
434
435ACPI_STATUS
436AcpiEnterSleepState (
437    UINT8 SleepState);
438
439ACPI_STATUS
440AcpiLeaveSleepState (
441    UINT8 SleepState);
442
443#endif /* __ACXFACE_H__ */
444