acevents.h revision 216471 
1/******************************************************************************
2 *
3 * Name: acevents.h - Event subcomponent prototypes and defines
4 *
5 *****************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights.  You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code.  No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision.  In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change.  Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee.  Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution.  In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government.  In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************/
115
116#ifndef __ACEVENTS_H__
117#define __ACEVENTS_H__
118
119
120/*
121 * evevent
122 */
123ACPI_STATUS
124AcpiEvInitializeEvents (
125    void);
126
127ACPI_STATUS
128AcpiEvInstallXruptHandlers (
129    void);
130
131UINT32
132AcpiEvFixedEventDetect (
133    void);
134
135
136/*
137 * evmisc
138 */
139BOOLEAN
140AcpiEvIsNotifyObject (
141    ACPI_NAMESPACE_NODE     *Node);
142
143ACPI_STATUS
144AcpiEvAcquireGlobalLock(
145    UINT16                  Timeout);
146
147ACPI_STATUS
148AcpiEvReleaseGlobalLock(
149    void);
150
151ACPI_STATUS
152AcpiEvInitGlobalLockHandler (
153    void);
154
155UINT32
156AcpiEvGetGpeNumberIndex (
157    UINT32                  GpeNumber);
158
159ACPI_STATUS
160AcpiEvQueueNotifyRequest (
161    ACPI_NAMESPACE_NODE     *Node,
162    UINT32                  NotifyValue);
163
164
165/*
166 * evgpe - Low-level GPE support
167 */
168UINT32
169AcpiEvGpeDetect (
170    ACPI_GPE_XRUPT_INFO     *GpeXruptList);
171
172ACPI_STATUS
173AcpiEvUpdateGpeEnableMask (
174    ACPI_GPE_EVENT_INFO     *GpeEventInfo);
175
176ACPI_STATUS
177AcpiEvEnableGpe (
178    ACPI_GPE_EVENT_INFO     *GpeEventInfo);
179
180ACPI_STATUS
181AcpiEvAddGpeReference (
182    ACPI_GPE_EVENT_INFO     *GpeEventInfo);
183
184ACPI_STATUS
185AcpiEvRemoveGpeReference (
186    ACPI_GPE_EVENT_INFO     *GpeEventInfo);
187
188ACPI_GPE_EVENT_INFO *
189AcpiEvGetGpeEventInfo (
190    ACPI_HANDLE             GpeDevice,
191    UINT32                  GpeNumber);
192
193ACPI_GPE_EVENT_INFO *
194AcpiEvLowGetGpeInfo (
195    UINT32                  GpeNumber,
196    ACPI_GPE_BLOCK_INFO     *GpeBlock);
197
198ACPI_STATUS
199AcpiEvFinishGpe (
200    ACPI_GPE_EVENT_INFO     *GpeEventInfo);
201
202
203/*
204 * evgpeblk - Upper-level GPE block support
205 */
206ACPI_STATUS
207AcpiEvCreateGpeBlock (
208    ACPI_NAMESPACE_NODE     *GpeDevice,
209    ACPI_GENERIC_ADDRESS    *GpeBlockAddress,
210    UINT32                  RegisterCount,
211    UINT8                   GpeBlockBaseNumber,
212    UINT32                  InterruptNumber,
213    ACPI_GPE_BLOCK_INFO     **ReturnGpeBlock);
214
215ACPI_STATUS
216AcpiEvInitializeGpeBlock (
217    ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
218    ACPI_GPE_BLOCK_INFO     *GpeBlock,
219    void                    *Context);
220
221ACPI_STATUS
222AcpiEvDeleteGpeBlock (
223    ACPI_GPE_BLOCK_INFO     *GpeBlock);
224
225UINT32
226AcpiEvGpeDispatch (
227    ACPI_NAMESPACE_NODE     *GpeDevice,
228    ACPI_GPE_EVENT_INFO     *GpeEventInfo,
229    UINT32                  GpeNumber);
230
231/*
232 * evgpeinit - GPE initialization and update
233 */
234ACPI_STATUS
235AcpiEvGpeInitialize (
236    void);
237
238void
239AcpiEvUpdateGpes (
240    ACPI_OWNER_ID           TableOwnerId);
241
242ACPI_STATUS
243AcpiEvMatchGpeMethod (
244    ACPI_HANDLE             ObjHandle,
245    UINT32                  Level,
246    void                    *Context,
247    void                    **ReturnValue);
248
249/*
250 * evgpeutil - GPE utilities
251 */
252ACPI_STATUS
253AcpiEvWalkGpeList (
254    ACPI_GPE_CALLBACK       GpeWalkCallback,
255    void                    *Context);
256
257BOOLEAN
258AcpiEvValidGpeEvent (
259    ACPI_GPE_EVENT_INFO     *GpeEventInfo);
260
261ACPI_STATUS
262AcpiEvGetGpeDevice (
263    ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
264    ACPI_GPE_BLOCK_INFO     *GpeBlock,
265    void                    *Context);
266
267ACPI_GPE_XRUPT_INFO *
268AcpiEvGetGpeXruptBlock (
269    UINT32                  InterruptNumber);
270
271ACPI_STATUS
272AcpiEvDeleteGpeXrupt (
273    ACPI_GPE_XRUPT_INFO     *GpeXrupt);
274
275ACPI_STATUS
276AcpiEvDeleteGpeHandlers (
277    ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
278    ACPI_GPE_BLOCK_INFO     *GpeBlock,
279    void                    *Context);
280
281
282/*
283 * evregion - Address Space handling
284 */
285ACPI_STATUS
286AcpiEvInstallRegionHandlers (
287    void);
288
289ACPI_STATUS
290AcpiEvInitializeOpRegions (
291    void);
292
293ACPI_STATUS
294AcpiEvAddressSpaceDispatch (
295    ACPI_OPERAND_OBJECT    *RegionObj,
296    UINT32                  Function,
297    UINT32                  RegionOffset,
298    UINT32                  BitWidth,
299    UINT64                  *Value);
300
301ACPI_STATUS
302AcpiEvAttachRegion (
303    ACPI_OPERAND_OBJECT     *HandlerObj,
304    ACPI_OPERAND_OBJECT     *RegionObj,
305    BOOLEAN                 AcpiNsIsLocked);
306
307void
308AcpiEvDetachRegion (
309    ACPI_OPERAND_OBJECT    *RegionObj,
310    BOOLEAN                 AcpiNsIsLocked);
311
312ACPI_STATUS
313AcpiEvInstallSpaceHandler (
314    ACPI_NAMESPACE_NODE     *Node,
315    ACPI_ADR_SPACE_TYPE     SpaceId,
316    ACPI_ADR_SPACE_HANDLER  Handler,
317    ACPI_ADR_SPACE_SETUP    Setup,
318    void                    *Context);
319
320ACPI_STATUS
321AcpiEvExecuteRegMethods (
322    ACPI_NAMESPACE_NODE     *Node,
323    ACPI_ADR_SPACE_TYPE     SpaceId);
324
325ACPI_STATUS
326AcpiEvExecuteRegMethod (
327    ACPI_OPERAND_OBJECT    *RegionObj,
328    UINT32                  Function);
329
330
331/*
332 * evregini - Region initialization and setup
333 */
334ACPI_STATUS
335AcpiEvSystemMemoryRegionSetup (
336    ACPI_HANDLE             Handle,
337    UINT32                  Function,
338    void                    *HandlerContext,
339    void                    **RegionContext);
340
341ACPI_STATUS
342AcpiEvIoSpaceRegionSetup (
343    ACPI_HANDLE             Handle,
344    UINT32                  Function,
345    void                    *HandlerContext,
346    void                    **RegionContext);
347
348ACPI_STATUS
349AcpiEvPciConfigRegionSetup (
350    ACPI_HANDLE             Handle,
351    UINT32                  Function,
352    void                    *HandlerContext,
353    void                    **RegionContext);
354
355ACPI_STATUS
356AcpiEvCmosRegionSetup (
357    ACPI_HANDLE             Handle,
358    UINT32                  Function,
359    void                    *HandlerContext,
360    void                    **RegionContext);
361
362ACPI_STATUS
363AcpiEvPciBarRegionSetup (
364    ACPI_HANDLE             Handle,
365    UINT32                  Function,
366    void                    *HandlerContext,
367    void                    **RegionContext);
368
369ACPI_STATUS
370AcpiEvDefaultRegionSetup (
371    ACPI_HANDLE             Handle,
372    UINT32                  Function,
373    void                    *HandlerContext,
374    void                    **RegionContext);
375
376ACPI_STATUS
377AcpiEvInitializeRegion (
378    ACPI_OPERAND_OBJECT     *RegionObj,
379    BOOLEAN                 AcpiNsLocked);
380
381
382/*
383 * evsci - SCI (System Control Interrupt) handling/dispatch
384 */
385UINT32 ACPI_SYSTEM_XFACE
386AcpiEvGpeXruptHandler (
387    void                    *Context);
388
389UINT32
390AcpiEvInstallSciHandler (
391    void);
392
393ACPI_STATUS
394AcpiEvRemoveSciHandler (
395    void);
396
397UINT32
398AcpiEvInitializeSCI (
399    UINT32                  ProgramSCI);
400
401void
402AcpiEvTerminate (
403    void);
404
405
406#endif  /* __ACEVENTS_H__  */
407