acpixf.h revision 80062 
1213688Smm
2213688Smm/******************************************************************************
3213688Smm *
4213688Smm * Name: acpixf.h - External interfaces to the ACPI subsystem
5213688Smm *
6213688Smm *****************************************************************************/
7213688Smm
8213688Smm/******************************************************************************
9213688Smm *
10213688Smm * 1. Copyright Notice
11213688Smm *
12213688Smm * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp.
13213688Smm * All rights reserved.
14213688Smm *
15213688Smm * 2. License
16213688Smm *
17213688Smm * 2.1. This is your license from Intel Corp. under its intellectual property
18213688Smm * rights.  You may have additional license terms from the party that provided
19213688Smm * you this software, covering your right to use that party's intellectual
20213688Smm * property rights.
21213688Smm *
22213688Smm * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23213688Smm * copy of the source code appearing in this file ("Covered Code") an
24213688Smm * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25213688Smm * base code distributed originally by Intel ("Original Intel Code") to copy,
26213688Smm * make derivatives, distribute, use and display any portion of the Covered
27213688Smm * Code in any form, with the right to sublicense such rights; and
28213688Smm *
29213688Smm * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30213688Smm * license (with the right to sublicense), under only those claims of Intel
31213688Smm * 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
161
162/*
163 * ACPI Memory manager
164 */
165
166void *
167AcpiAllocate (
168    UINT32                  Size);
169
170void *
171AcpiCallocate (
172    UINT32                  Size);
173
174void
175AcpiFree (
176    void                    *Address);
177
178
179/*
180 * ACPI table manipulation interfaces
181 */
182
183ACPI_STATUS
184AcpiFindRootPointer (
185    UINT32                  Flags,
186    ACPI_PHYSICAL_ADDRESS   *RsdpPhysicalAddress);
187
188ACPI_STATUS
189AcpiLoadTables (
190    void);
191
192ACPI_STATUS
193AcpiLoadTable (
194    ACPI_TABLE_HEADER       *TablePtr);
195
196ACPI_STATUS
197AcpiUnloadTable (
198    ACPI_TABLE_TYPE         TableType);
199
200ACPI_STATUS
201AcpiGetTableHeader (
202    ACPI_TABLE_TYPE         TableType,
203    UINT32                  Instance,
204    ACPI_TABLE_HEADER       *OutTableHeader);
205
206ACPI_STATUS
207AcpiGetTable (
208    ACPI_TABLE_TYPE         TableType,
209    UINT32                  Instance,
210    ACPI_BUFFER             *RetBuffer);
211
212ACPI_STATUS
213AcpiGetFirmwareTable (
214    ACPI_STRING             Signature,
215    UINT32                  Instance,
216    UINT32                  Flags,
217    ACPI_TABLE_HEADER       **TablePointer);
218
219
220/*
221 * Namespace and name interfaces
222 */
223
224ACPI_STATUS
225AcpiWalkNamespace (
226    ACPI_OBJECT_TYPE        Type,
227    ACPI_HANDLE             StartObject,
228    UINT32                  MaxDepth,
229    ACPI_WALK_CALLBACK      UserFunction,
230    void                    *Context,
231    void *                  *ReturnValue);
232
233ACPI_STATUS
234AcpiGetDevices (
235    NATIVE_CHAR             *HID,
236    ACPI_WALK_CALLBACK      UserFunction,
237    void                    *Context,
238    void                    **ReturnValue);
239
240ACPI_STATUS
241AcpiGetName (
242    ACPI_HANDLE             Handle,
243    UINT32                  NameType,
244    ACPI_BUFFER             *RetPathPtr);
245
246ACPI_STATUS
247AcpiGetHandle (
248    ACPI_HANDLE             Parent,
249    ACPI_STRING             Pathname,
250    ACPI_HANDLE             *RetHandle);
251
252
253/*
254 * Object manipulation and enumeration
255 */
256
257ACPI_STATUS
258AcpiEvaluateObject (
259    ACPI_HANDLE             Object,
260    ACPI_STRING             Pathname,
261    ACPI_OBJECT_LIST        *ParameterObjects,
262    ACPI_BUFFER             *ReturnObjectBuffer);
263
264ACPI_STATUS
265AcpiGetObjectInfo (
266    ACPI_HANDLE             Device,
267    ACPI_DEVICE_INFO        *Info);
268
269ACPI_STATUS
270AcpiGetNextObject (
271    ACPI_OBJECT_TYPE        Type,
272    ACPI_HANDLE             Parent,
273    ACPI_HANDLE             Child,
274    ACPI_HANDLE             *OutHandle);
275
276ACPI_STATUS
277AcpiGetType (
278    ACPI_HANDLE             Object,
279    ACPI_OBJECT_TYPE        *OutType);
280
281ACPI_STATUS
282AcpiGetParent (
283    ACPI_HANDLE             Object,
284    ACPI_HANDLE             *OutHandle);
285
286
287/*
288 * Event handler interfaces
289 */
290
291ACPI_STATUS
292AcpiInstallFixedEventHandler (
293    UINT32                  AcpiEvent,
294    ACPI_EVENT_HANDLER      Handler,
295    void                    *Context);
296
297ACPI_STATUS
298AcpiRemoveFixedEventHandler (
299    UINT32                  AcpiEvent,
300    ACPI_EVENT_HANDLER      Handler);
301
302ACPI_STATUS
303AcpiInstallNotifyHandler (
304    ACPI_HANDLE             Device,
305    UINT32                  HandlerType,
306    ACPI_NOTIFY_HANDLER     Handler,
307    void                    *Context);
308
309ACPI_STATUS
310AcpiRemoveNotifyHandler (
311    ACPI_HANDLE             Device,
312    UINT32                  HandlerType,
313    ACPI_NOTIFY_HANDLER     Handler);
314
315ACPI_STATUS
316AcpiInstallAddressSpaceHandler (
317    ACPI_HANDLE             Device,
318    ACPI_ADR_SPACE_TYPE     SpaceId,
319    ACPI_ADR_SPACE_HANDLER  Handler,
320    ACPI_ADR_SPACE_SETUP    Setup,
321    void                    *Context);
322
323ACPI_STATUS
324AcpiRemoveAddressSpaceHandler (
325    ACPI_HANDLE             Device,
326    ACPI_ADR_SPACE_TYPE     SpaceId,
327    ACPI_ADR_SPACE_HANDLER  Handler);
328
329ACPI_STATUS
330AcpiInstallGpeHandler (
331    UINT32                  GpeNumber,
332    UINT32                  Type,
333    ACPI_GPE_HANDLER        Handler,
334    void                    *Context);
335
336ACPI_STATUS
337AcpiAcquireGlobalLock (
338    void);
339
340ACPI_STATUS
341AcpiReleaseGlobalLock (
342    void);
343
344ACPI_STATUS
345AcpiRemoveGpeHandler (
346    UINT32                  GpeNumber,
347    ACPI_GPE_HANDLER        Handler);
348
349ACPI_STATUS
350AcpiEnableEvent (
351    UINT32                  AcpiEvent,
352    UINT32                  Type);
353
354ACPI_STATUS
355AcpiDisableEvent (
356    UINT32                  AcpiEvent,
357    UINT32                  Type);
358
359ACPI_STATUS
360AcpiClearEvent (
361    UINT32                  AcpiEvent,
362    UINT32                  Type);
363
364ACPI_STATUS
365AcpiGetEventStatus (
366    UINT32                  AcpiEvent,
367    UINT32                  Type,
368    ACPI_EVENT_STATUS       *EventStatus);
369
370/*
371 * Resource interfaces
372 */
373
374ACPI_STATUS
375AcpiGetCurrentResources(
376    ACPI_HANDLE             DeviceHandle,
377    ACPI_BUFFER             *RetBuffer);
378
379ACPI_STATUS
380AcpiGetPossibleResources(
381    ACPI_HANDLE             DeviceHandle,
382    ACPI_BUFFER             *RetBuffer);
383
384ACPI_STATUS
385AcpiSetCurrentResources (
386    ACPI_HANDLE             DeviceHandle,
387    ACPI_BUFFER             *InBuffer);
388
389ACPI_STATUS
390AcpiGetIrqRoutingTable  (
391    ACPI_HANDLE             BusDeviceHandle,
392    ACPI_BUFFER             *RetBuffer);
393
394
395/*
396 * Hardware (ACPI device) interfaces
397 */
398
399ACPI_STATUS
400AcpiSetFirmwareWakingVector (
401    ACPI_PHYSICAL_ADDRESS   PhysicalAddress);
402
403ACPI_STATUS
404AcpiGetFirmwareWakingVector (
405    ACPI_PHYSICAL_ADDRESS   *PhysicalAddress);
406
407ACPI_STATUS
408AcpiEnterSleepState (
409    UINT8 SleepState);
410
411ACPI_STATUS
412AcpiGetProcessorThrottlingInfo (
413    ACPI_HANDLE             ProcessorHandle,
414    ACPI_BUFFER             *UserBuffer);
415
416ACPI_STATUS
417AcpiSetProcessorThrottlingState (
418    ACPI_HANDLE             ProcessorHandle,
419    UINT32                  ThrottleState);
420
421ACPI_STATUS
422AcpiGetProcessorThrottlingState (
423    ACPI_HANDLE             ProcessorHandle,
424    UINT32                  *ThrottleState);
425
426ACPI_STATUS
427AcpiGetProcessorCxInfo (
428    ACPI_HANDLE             ProcessorHandle,
429    ACPI_BUFFER             *UserBuffer);
430
431ACPI_STATUS
432AcpiSetProcessorSleepState (
433    ACPI_HANDLE             ProcessorHandle,
434    UINT32                  CxState);
435
436ACPI_STATUS
437AcpiProcessorSleep (
438    ACPI_HANDLE             ProcessorHandle,
439    UINT32                  *PmTimerTicks);
440
441
442#endif /* __ACXFACE_H__ */
443