acpixf.h revision 67754 
150479Speter
226236Swpaul/******************************************************************************
380029Sobrien *
480029Sobrien * Name: acxface.h - External interfaces to the ACPI subsystem
526236Swpaul *
6139103Sru *****************************************************************************/
734131Sbde
826236Swpaul/******************************************************************************
926236Swpaul *
1026236Swpaul * 1. Copyright Notice
11113091Sobrien *
1280029Sobrien * Some or all of this work - Copyright (c) 1999, Intel Corp.  All rights
1326236Swpaul * reserved.
14201390Sed *
15201390Sed * 2. License
1631779Sbde *
1731779Sbde * 2.1. This is your license from Intel Corp. under its intellectual property
1826236Swpaul * rights.  You may have additional license terms from the party that provided
1926236Swpaul * you this software, covering your right to use that party's intellectual
2026236Swpaul * property rights.
2180029Sobrien *
22231118Sdim * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
2326236Swpaul * copy of the source code appearing in this file ("Covered Code") an
2426236Swpaul * irrevocable, perpetual, worldwide license under Intel's copyrights in the
2526236Swpaul * base code distributed originally by Intel ("Original Intel Code") to copy,
2635910Sbde * make derivatives, distribute, use and display any portion of the Covered
2726236Swpaul * Code in any form, with the right to sublicense such rights; and
2826236Swpaul *
2926236Swpaul * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
3026236Swpaul * license (with the right to sublicense), under only those claims of Intel
3126236Swpaul * patents that are infringed by the Original Intel Code, to make, use, sell,
3226236Swpaul * offer to sell, and import the Covered Code and derivative works thereof
3326236Swpaul * solely to the minimum extent necessary to exercise the above copyright
3426236Swpaul * 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 * Global interfaces
126 */
127
128ACPI_STATUS
129AcpiInitializeSubsystem (
130    void);
131
132ACPI_STATUS
133AcpiEnableSubsystem (
134    UINT32                  Flags);
135
136ACPI_STATUS
137AcpiTerminate (
138    void);
139
140ACPI_STATUS
141AcpiEnable (
142    void);
143
144ACPI_STATUS
145AcpiDisable (
146    void);
147
148ACPI_STATUS
149AcpiGetSystemInfo(
150    ACPI_BUFFER             *RetBuffer);
151
152ACPI_STATUS
153AcpiFormatException (
154    ACPI_STATUS             Exception,
155    ACPI_BUFFER             *OutBuffer);
156
157
158/*
159 * ACPI table manipulation interfaces
160 */
161
162ACPI_STATUS
163AcpiFindRootPointer (
164    void                    **RsdpPhysicalAddress);
165
166ACPI_STATUS
167AcpiLoadTables (
168    void                    *RsdpPhysicalAddress);
169
170ACPI_STATUS
171AcpiLoadTable (
172    ACPI_TABLE_HEADER       *TablePtr);
173
174ACPI_STATUS
175AcpiUnloadTable (
176    ACPI_TABLE_TYPE         TableType);
177
178ACPI_STATUS
179AcpiGetTableHeader (
180    ACPI_TABLE_TYPE         TableType,
181    UINT32                  Instance,
182    ACPI_TABLE_HEADER       *OutTableHeader);
183
184ACPI_STATUS
185AcpiGetTable (
186    ACPI_TABLE_TYPE         TableType,
187    UINT32                  Instance,
188    ACPI_BUFFER             *RetBuffer);
189
190
191/*
192 * Namespace and name interfaces
193 */
194
195ACPI_STATUS
196AcpiWalkNamespace (
197    ACPI_OBJECT_TYPE        Type,
198    ACPI_HANDLE             StartObject,
199    UINT32                  MaxDepth,
200    WALK_CALLBACK           UserFunction,
201    void                    *Context,
202    void *                  *ReturnValue);
203
204
205ACPI_STATUS
206AcpiGetDevices (
207    NATIVE_CHAR             *HID,
208    WALK_CALLBACK           UserFunction,
209    void                    *Context,
210    void                    **ReturnValue);
211
212ACPI_STATUS
213AcpiGetName (
214    ACPI_HANDLE             Handle,
215    UINT32                  NameType,
216    ACPI_BUFFER             *RetPathPtr);
217
218ACPI_STATUS
219AcpiGetHandle (
220    ACPI_HANDLE             Parent,
221    ACPI_STRING             Pathname,
222    ACPI_HANDLE             *RetHandle);
223
224
225/*
226 * Object manipulation and enumeration
227 */
228
229ACPI_STATUS
230AcpiEvaluateObject (
231    ACPI_HANDLE             Object,
232    ACPI_STRING             Pathname,
233    ACPI_OBJECT_LIST        *ParameterObjects,
234    ACPI_BUFFER             *ReturnObjectBuffer);
235
236ACPI_STATUS
237AcpiGetObjectInfo (
238    ACPI_HANDLE             Device,
239    ACPI_DEVICE_INFO        *Info);
240
241ACPI_STATUS
242AcpiGetNextObject (
243    ACPI_OBJECT_TYPE        Type,
244    ACPI_HANDLE             Parent,
245    ACPI_HANDLE             Child,
246    ACPI_HANDLE             *OutHandle);
247
248ACPI_STATUS
249AcpiGetType (
250    ACPI_HANDLE             Object,
251    ACPI_OBJECT_TYPE        *OutType);
252
253ACPI_STATUS
254AcpiGetParent (
255    ACPI_HANDLE             Object,
256    ACPI_HANDLE             *OutHandle);
257
258
259/*
260 * AcpiEvent handler interfaces
261 */
262
263ACPI_STATUS
264AcpiInstallFixedEventHandler (
265    UINT32                  AcpiEvent,
266    FIXED_EVENT_HANDLER     Handler,
267    void                    *Context);
268
269ACPI_STATUS
270AcpiRemoveFixedEventHandler (
271    UINT32                  AcpiEvent,
272    FIXED_EVENT_HANDLER     Handler);
273
274ACPI_STATUS
275AcpiInstallNotifyHandler (
276    ACPI_HANDLE             Device,
277    UINT32                  HandlerType,
278    NOTIFY_HANDLER          Handler,
279    void                    *Context);
280
281ACPI_STATUS
282AcpiRemoveNotifyHandler (
283    ACPI_HANDLE             Device,
284    UINT32                  HandlerType,
285    NOTIFY_HANDLER          Handler);
286
287ACPI_STATUS
288AcpiInstallAddressSpaceHandler (
289    ACPI_HANDLE             Device,
290    ACPI_ADDRESS_SPACE_TYPE SpaceId,
291    ADDRESS_SPACE_HANDLER   Handler,
292    ADDRESS_SPACE_SETUP     Setup,
293    void                    *Context);
294
295ACPI_STATUS
296AcpiRemoveAddressSpaceHandler (
297    ACPI_HANDLE             Device,
298    ACPI_ADDRESS_SPACE_TYPE SpaceId,
299    ADDRESS_SPACE_HANDLER   Handler);
300
301ACPI_STATUS
302AcpiInstallGpeHandler (
303    UINT32                  GpeNumber,
304    UINT32                  Type,
305    GPE_HANDLER             Handler,
306    void                    *Context);
307
308ACPI_STATUS
309AcpiAcquireGlobalLock (
310    void);
311
312ACPI_STATUS
313AcpiReleaseGlobalLock (
314    void);
315
316ACPI_STATUS
317AcpiRemoveGpeHandler (
318    UINT32                  GpeNumber,
319    GPE_HANDLER             Handler);
320
321ACPI_STATUS
322AcpiEnableEvent (
323    UINT32                  AcpiEvent,
324    UINT32                  Type);
325
326ACPI_STATUS
327AcpiDisableEvent (
328    UINT32                  AcpiEvent,
329    UINT32                  Type);
330
331ACPI_STATUS
332AcpiClearEvent (
333    UINT32                  AcpiEvent,
334    UINT32                  Type);
335
336ACPI_STATUS
337AcpiGetEventStatus (
338    UINT32                  AcpiEvent,
339    UINT32                  Type,
340    ACPI_EVENT_STATUS       *EventStatus);
341
342/*
343 * Resource interfaces
344 */
345
346ACPI_STATUS
347AcpiGetCurrentResources(
348    ACPI_HANDLE             DeviceHandle,
349    ACPI_BUFFER             *RetBuffer);
350
351ACPI_STATUS
352AcpiGetPossibleResources(
353    ACPI_HANDLE             DeviceHandle,
354    ACPI_BUFFER             *RetBuffer);
355
356ACPI_STATUS
357AcpiSetCurrentResources (
358    ACPI_HANDLE             DeviceHandle,
359    ACPI_BUFFER             *InBuffer);
360
361ACPI_STATUS
362AcpiGetIrqRoutingTable  (
363    ACPI_HANDLE             BusDeviceHandle,
364    ACPI_BUFFER             *RetBuffer);
365
366
367/*
368 * Hardware (ACPI device) interfaces
369 */
370
371ACPI_STATUS
372AcpiSetFirmwareWakingVector (
373    void                    *PhysicalAddress);
374
375ACPI_STATUS
376AcpiGetFirmwareWakingVector (
377    void                    **PhysicalAddress);
378
379ACPI_STATUS
380AcpiGetProcessorThrottlingInfo (
381    ACPI_HANDLE             ProcessorHandle,
382    ACPI_BUFFER             *UserBuffer);
383
384ACPI_STATUS
385AcpiSetProcessorThrottlingState (
386    ACPI_HANDLE             ProcessorHandle,
387    UINT32                  ThrottleState);
388
389ACPI_STATUS
390AcpiGetProcessorThrottlingState (
391    ACPI_HANDLE             ProcessorHandle,
392    UINT32                  *ThrottleState);
393
394ACPI_STATUS
395AcpiGetProcessorCxInfo (
396    ACPI_HANDLE             ProcessorHandle,
397    ACPI_BUFFER             *UserBuffer);
398
399ACPI_STATUS
400AcpiSetProcessorSleepState (
401    ACPI_HANDLE             ProcessorHandle,
402    UINT32                  CxState);
403
404ACPI_STATUS
405AcpiProcessorSleep (
406    ACPI_HANDLE             ProcessorHandle,
407    UINT32                  *PmTimerTicks);
408
409
410#endif /* __ACXFACE_H__ */
411