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