acevents.h revision 69450 
1/******************************************************************************
2 *
3 * Name: acevents.h - Event subcomponent prototypes and defines
4 *       $Revision: 60 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999, Intel Corp.  All rights
13 * 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
125
126/*
127 * AcpiEvfixed - Fixed event handling
128 */
129
130ACPI_STATUS
131AcpiEvFixedEventInitialize (
132    void);
133
134UINT32
135AcpiEvFixedEventDetect (
136    void);
137
138UINT32
139AcpiEvFixedEventDispatch (
140    UINT32                  AcpiEvent);
141
142
143/*
144 * AcpiEvglock - Global Lock support
145 */
146
147ACPI_STATUS
148AcpiEvAcquireGlobalLock(
149    void);
150
151void
152AcpiEvReleaseGlobalLock(
153    void);
154
155ACPI_STATUS
156AcpiEvInitGlobalLockHandler (
157    void);
158
159
160/*
161 * AcpiEvgpe - GPE handling and dispatch
162 */
163
164ACPI_STATUS
165AcpiEvGpeInitialize (
166    void);
167
168ACPI_STATUS
169AcpiEvInitGpeControlMethods (
170    void);
171
172UINT32
173AcpiEvGpeDispatch (
174    UINT32                  GpeNumber);
175
176UINT32
177AcpiEvGpeDetect (
178    void);
179
180
181/*
182 * AcpiEvnotify - Device Notify handling and dispatch
183 */
184
185void
186AcpiEvNotifyDispatch (
187    ACPI_HANDLE             Device,
188    UINT32                  NotifyValue);
189
190
191/*
192 * AcpiEvregion - Address Space handling
193 */
194
195ACPI_STATUS
196AcpiEvInstallDefaultAddressSpaceHandlers (
197    void);
198
199ACPI_STATUS
200AcpiEvAddressSpaceDispatch (
201    ACPI_OPERAND_OBJECT    *RegionObj,
202    UINT32                  Function,
203    ACPI_PHYSICAL_ADDRESS   Address,
204    UINT32                  BitWidth,
205    UINT32                  *Value);
206
207
208ACPI_STATUS
209AcpiEvAddrHandlerHelper (
210    ACPI_HANDLE             ObjHandle,
211    UINT32                  Level,
212    void                    *Context,
213    void                    **ReturnValue);
214
215void
216AcpiEvDisassociateRegionFromHandler(
217    ACPI_OPERAND_OBJECT    *RegionObj);
218
219
220ACPI_STATUS
221AcpiEvAssociateRegionAndHandler (
222    ACPI_OPERAND_OBJECT     *HandlerObj,
223    ACPI_OPERAND_OBJECT     *RegionObj,
224    BOOLEAN                 AcpiNsIsLocked);
225
226
227/*
228 * AcpiEvregini - Region initialization and setup
229 */
230
231ACPI_STATUS
232AcpiEvSystemMemoryRegionSetup (
233    ACPI_HANDLE             Handle,
234    UINT32                  Function,
235    void                    *HandlerContext,
236    void                    **RegionContext);
237
238ACPI_STATUS
239AcpiEvIoSpaceRegionSetup (
240    ACPI_HANDLE             Handle,
241    UINT32                  Function,
242    void                    *HandlerContext,
243    void                    **RegionContext);
244
245ACPI_STATUS
246AcpiEvPciConfigRegionSetup (
247    ACPI_HANDLE             Handle,
248    UINT32                  Function,
249    void                    *HandlerContext,
250    void                    **RegionContext);
251
252ACPI_STATUS
253AcpiEvDefaultRegionSetup (
254    ACPI_HANDLE             Handle,
255    UINT32                  Function,
256    void                    *HandlerContext,
257    void                    **RegionContext);
258
259ACPI_STATUS
260AcpiEvInitializeRegion (
261    ACPI_OPERAND_OBJECT     *RegionObj,
262    BOOLEAN                 AcpiNsLocked);
263
264
265/*
266 * Evsci - SCI (System Control Interrupt) handling/dispatch
267 */
268
269UINT32
270AcpiEvInstallSciHandler (
271    void);
272
273ACPI_STATUS
274AcpiEvRemoveSciHandler (
275    void);
276
277UINT32
278AcpiEvInitializeSCI (
279    UINT32                  ProgramSCI);
280
281void
282AcpiEvRestoreAcpiState (
283    void);
284
285void
286AcpiEvTerminate (
287    void);
288
289
290/* Debug support */
291
292#ifdef ACPI_DEBUG
293
294UINT32
295AcpiEvSciCount (
296    UINT32                  AcpiEvent);
297
298#define DEBUG_INCREMENT_EVENT_COUNT(a)   AcpiGbl_EventCount[a]++;
299
300#else
301
302#define DEBUG_INCREMENT_EVENT_COUNT(a)
303#endif
304
305
306#endif  /* __ACEVENTS_H__  */
307