acevents.h revision 123315 
1/******************************************************************************
2 *
3 * Name: acevents.h - Event subcomponent prototypes and defines
4 *       $Revision: 92 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2003, 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#ifndef __ACEVENTS_H__
118#define __ACEVENTS_H__
119
120
121ACPI_STATUS
122AcpiEvInitialize (
123    void);
124
125ACPI_STATUS
126AcpiEvHandlerInitialize (
127    void);
128
129
130/*
131 * Evfixed - Fixed event handling
132 */
133
134ACPI_STATUS
135AcpiEvFixedEventInitialize (
136    void);
137
138UINT32
139AcpiEvFixedEventDetect (
140    void);
141
142UINT32
143AcpiEvFixedEventDispatch (
144    UINT32                  Event);
145
146
147/*
148 * Evmisc
149 */
150
151BOOLEAN
152AcpiEvIsNotifyObject (
153    ACPI_NAMESPACE_NODE     *Node);
154
155ACPI_STATUS
156AcpiEvAcquireGlobalLock(
157    UINT16                  Timeout);
158
159ACPI_STATUS
160AcpiEvReleaseGlobalLock(
161    void);
162
163ACPI_STATUS
164AcpiEvInitGlobalLockHandler (
165    void);
166
167UINT32
168AcpiEvGetGpeNumberIndex (
169    UINT32                  GpeNumber);
170
171ACPI_STATUS
172AcpiEvQueueNotifyRequest (
173    ACPI_NAMESPACE_NODE     *Node,
174    UINT32                  NotifyValue);
175
176void ACPI_SYSTEM_XFACE
177AcpiEvNotifyDispatch (
178    void                    *Context);
179
180
181/*
182 * Evgpe - GPE handling and dispatch
183 */
184
185ACPI_STATUS
186AcpiEvWalkGpeList (
187    ACPI_GPE_CALLBACK       GpeWalkCallback);
188
189BOOLEAN
190AcpiEvValidGpeEvent (
191    ACPI_GPE_EVENT_INFO     *GpeEventInfo);
192
193ACPI_GPE_EVENT_INFO *
194AcpiEvGetGpeEventInfo (
195    ACPI_HANDLE             GpeDevice,
196    UINT32                  GpeNumber);
197
198ACPI_STATUS
199AcpiEvGpeInitialize (
200    void);
201
202ACPI_STATUS
203AcpiEvCreateGpeBlock (
204    ACPI_NAMESPACE_NODE     *GpeDevice,
205    ACPI_GENERIC_ADDRESS    *GpeBlockAddress,
206    UINT32                  RegisterCount,
207    UINT8                   GpeBlockBaseNumber,
208    UINT32                  InterruptLevel,
209    ACPI_GPE_BLOCK_INFO     **ReturnGpeBlock);
210
211ACPI_STATUS
212AcpiEvDeleteGpeBlock (
213    ACPI_GPE_BLOCK_INFO     *GpeBlock);
214
215UINT32
216AcpiEvGpeDispatch (
217    ACPI_GPE_EVENT_INFO     *GpeEventInfo,
218    UINT32                  GpeNumber);
219
220UINT32
221AcpiEvGpeDetect (
222    ACPI_GPE_XRUPT_INFO     *GpeXruptList);
223
224/*
225 * Evregion - Address Space handling
226 */
227
228ACPI_STATUS
229AcpiEvInitAddressSpaces (
230    void);
231
232ACPI_STATUS
233AcpiEvAddressSpaceDispatch (
234    ACPI_OPERAND_OBJECT    *RegionObj,
235    UINT32                  Function,
236    ACPI_PHYSICAL_ADDRESS   Address,
237    UINT32                  BitWidth,
238    void                    *Value);
239
240ACPI_STATUS
241AcpiEvInstallHandler (
242    ACPI_HANDLE             ObjHandle,
243    UINT32                  Level,
244    void                    *Context,
245    void                    **ReturnValue);
246
247ACPI_STATUS
248AcpiEvAttachRegion (
249    ACPI_OPERAND_OBJECT     *HandlerObj,
250    ACPI_OPERAND_OBJECT     *RegionObj,
251    BOOLEAN                 AcpiNsIsLocked);
252
253void
254AcpiEvDetachRegion (
255    ACPI_OPERAND_OBJECT    *RegionObj,
256    BOOLEAN                 AcpiNsIsLocked);
257
258ACPI_STATUS
259AcpiEvExecuteRegMethod (
260    ACPI_OPERAND_OBJECT    *RegionObj,
261    UINT32                  Function);
262
263ACPI_STATUS
264AcpiEvRegRun (
265    ACPI_HANDLE             ObjHandle,
266    UINT32                  Level,
267    void                    *Context,
268    void                    **ReturnValue);
269
270/*
271 * Evregini - Region initialization and setup
272 */
273
274ACPI_STATUS
275AcpiEvSystemMemoryRegionSetup (
276    ACPI_HANDLE             Handle,
277    UINT32                  Function,
278    void                    *HandlerContext,
279    void                    **RegionContext);
280
281ACPI_STATUS
282AcpiEvIoSpaceRegionSetup (
283    ACPI_HANDLE             Handle,
284    UINT32                  Function,
285    void                    *HandlerContext,
286    void                    **RegionContext);
287
288ACPI_STATUS
289AcpiEvPciConfigRegionSetup (
290    ACPI_HANDLE             Handle,
291    UINT32                  Function,
292    void                    *HandlerContext,
293    void                    **RegionContext);
294
295ACPI_STATUS
296AcpiEvCmosRegionSetup (
297    ACPI_HANDLE             Handle,
298    UINT32                  Function,
299    void                    *HandlerContext,
300    void                    **RegionContext);
301
302ACPI_STATUS
303AcpiEvPciBarRegionSetup (
304    ACPI_HANDLE             Handle,
305    UINT32                  Function,
306    void                    *HandlerContext,
307    void                    **RegionContext);
308
309ACPI_STATUS
310AcpiEvDefaultRegionSetup (
311    ACPI_HANDLE             Handle,
312    UINT32                  Function,
313    void                    *HandlerContext,
314    void                    **RegionContext);
315
316ACPI_STATUS
317AcpiEvInitializeRegion (
318    ACPI_OPERAND_OBJECT     *RegionObj,
319    BOOLEAN                 AcpiNsLocked);
320
321
322/*
323 * Evsci - SCI (System Control Interrupt) handling/dispatch
324 */
325
326UINT32 ACPI_SYSTEM_XFACE
327AcpiEvGpeXruptHandler (
328    void                    *Context);
329
330UINT32
331AcpiEvInstallSciHandler (
332    void);
333
334ACPI_STATUS
335AcpiEvRemoveSciHandler (
336    void);
337
338UINT32
339AcpiEvInitializeSCI (
340    UINT32                  ProgramSCI);
341
342void
343AcpiEvTerminate (
344    void);
345
346
347#endif  /* __ACEVENTS_H__  */
348