acevents.h revision 1.1 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 */
123 ACPI_STATUS
124 AcpiEvInitializeEvents (
125 void);
126
127 ACPI_STATUS
128 AcpiEvInstallXruptHandlers (
129 void);
130
131 ACPI_STATUS
132 AcpiEvInstallFadtGpes (
133 void);
134
135 UINT32
136 AcpiEvFixedEventDetect (
137 void);
138
139
140 /*
141 * evmisc
142 */
143 BOOLEAN
144 AcpiEvIsNotifyObject (
145 ACPI_NAMESPACE_NODE *Node);
146
147 ACPI_STATUS
148 AcpiEvAcquireGlobalLock(
149 UINT16 Timeout);
150
151 ACPI_STATUS
152 AcpiEvReleaseGlobalLock(
153 void);
154
155 ACPI_STATUS
156 AcpiEvInitGlobalLockHandler (
157 void);
158
159 UINT32
160 AcpiEvGetGpeNumberIndex (
161 UINT32 GpeNumber);
162
163 ACPI_STATUS
164 AcpiEvQueueNotifyRequest (
165 ACPI_NAMESPACE_NODE *Node,
166 UINT32 NotifyValue);
167
168
169 /*
170 * evgpe - Low-level GPE support
171 */
172 UINT32
173 AcpiEvGpeDetect (
174 ACPI_GPE_XRUPT_INFO *GpeXruptList);
175
176 ACPI_STATUS
177 AcpiEvUpdateGpeEnableMasks (
178 ACPI_GPE_EVENT_INFO *GpeEventInfo);
179
180 ACPI_STATUS
181 AcpiEvEnableGpe (
182 ACPI_GPE_EVENT_INFO *GpeEventInfo);
183
184 ACPI_STATUS
185 AcpiEvDisableGpe (
186 ACPI_GPE_EVENT_INFO *GpeEventInfo);
187
188 ACPI_GPE_EVENT_INFO *
189 AcpiEvGetGpeEventInfo (
190 ACPI_HANDLE GpeDevice,
191 UINT32 GpeNumber);
192
193 ACPI_GPE_EVENT_INFO *
194 AcpiEvLowGetGpeInfo (
195 UINT32 GpeNumber,
196 ACPI_GPE_BLOCK_INFO *GpeBlock);
197
198
199 /*
200 * evgpeblk - Upper-level GPE block support
201 */
202 ACPI_STATUS
203 AcpiEvCreateGpeBlock (
204 ACPI_NAMESPACE_NODE *GpeDevice,
205 ACPI_GENERIC_ADDRESS *GpeBlockAddress,
206 UINT32 RegisterCount,
207 UINT8 GpeBlockBaseNumber,
208 UINT32 InterruptNumber,
209 ACPI_GPE_BLOCK_INFO **ReturnGpeBlock);
210
211 ACPI_STATUS
212 AcpiEvInitializeGpeBlock (
213 ACPI_NAMESPACE_NODE *GpeDevice,
214 ACPI_GPE_BLOCK_INFO *GpeBlock);
215
216 ACPI_STATUS
217 AcpiEvDeleteGpeBlock (
218 ACPI_GPE_BLOCK_INFO *GpeBlock);
219
220 UINT32
221 AcpiEvGpeDispatch (
222 ACPI_GPE_EVENT_INFO *GpeEventInfo,
223 UINT32 GpeNumber);
224
225 /*
226 * evgpeinit - GPE initialization and update
227 */
228 ACPI_STATUS
229 AcpiEvGpeInitialize (
230 void);
231
232 void
233 AcpiEvUpdateGpes (
234 ACPI_OWNER_ID TableOwnerId);
235
236 ACPI_STATUS
237 AcpiEvMatchGpeMethod (
238 ACPI_HANDLE ObjHandle,
239 UINT32 Level,
240 void *Context,
241 void **ReturnValue);
242
243 ACPI_STATUS
244 AcpiEvMatchPrwAndGpe (
245 ACPI_HANDLE ObjHandle,
246 UINT32 Level,
247 void *Context,
248 void **ReturnValue);
249
250 /*
251 * evgpeutil - GPE utilities
252 */
253 ACPI_STATUS
254 AcpiEvWalkGpeList (
255 ACPI_GPE_CALLBACK GpeWalkCallback,
256 void *Context);
257
258 BOOLEAN
259 AcpiEvValidGpeEvent (
260 ACPI_GPE_EVENT_INFO *GpeEventInfo);
261
262 ACPI_GPE_XRUPT_INFO *
263 AcpiEvGetGpeXruptBlock (
264 UINT32 InterruptNumber);
265
266 ACPI_STATUS
267 AcpiEvDeleteGpeXrupt (
268 ACPI_GPE_XRUPT_INFO *GpeXrupt);
269
270 ACPI_STATUS
271 AcpiEvDeleteGpeHandlers (
272 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
273 ACPI_GPE_BLOCK_INFO *GpeBlock,
274 void *Context);
275
276
277 /*
278 * evregion - Address Space handling
279 */
280 ACPI_STATUS
281 AcpiEvInstallRegionHandlers (
282 void);
283
284 ACPI_STATUS
285 AcpiEvInitializeOpRegions (
286 void);
287
288 ACPI_STATUS
289 AcpiEvAddressSpaceDispatch (
290 ACPI_OPERAND_OBJECT *RegionObj,
291 UINT32 Function,
292 UINT32 RegionOffset,
293 UINT32 BitWidth,
294 UINT64 *Value);
295
296 ACPI_STATUS
297 AcpiEvAttachRegion (
298 ACPI_OPERAND_OBJECT *HandlerObj,
299 ACPI_OPERAND_OBJECT *RegionObj,
300 BOOLEAN AcpiNsIsLocked);
301
302 void
303 AcpiEvDetachRegion (
304 ACPI_OPERAND_OBJECT *RegionObj,
305 BOOLEAN AcpiNsIsLocked);
306
307 ACPI_STATUS
308 AcpiEvInstallSpaceHandler (
309 ACPI_NAMESPACE_NODE *Node,
310 ACPI_ADR_SPACE_TYPE SpaceId,
311 ACPI_ADR_SPACE_HANDLER Handler,
312 ACPI_ADR_SPACE_SETUP Setup,
313 void *Context);
314
315 ACPI_STATUS
316 AcpiEvExecuteRegMethods (
317 ACPI_NAMESPACE_NODE *Node,
318 ACPI_ADR_SPACE_TYPE SpaceId);
319
320 ACPI_STATUS
321 AcpiEvExecuteRegMethod (
322 ACPI_OPERAND_OBJECT *RegionObj,
323 UINT32 Function);
324
325
326 /*
327 * evregini - Region initialization and setup
328 */
329 ACPI_STATUS
330 AcpiEvSystemMemoryRegionSetup (
331 ACPI_HANDLE Handle,
332 UINT32 Function,
333 void *HandlerContext,
334 void **RegionContext);
335
336 ACPI_STATUS
337 AcpiEvIoSpaceRegionSetup (
338 ACPI_HANDLE Handle,
339 UINT32 Function,
340 void *HandlerContext,
341 void **RegionContext);
342
343 ACPI_STATUS
344 AcpiEvPciConfigRegionSetup (
345 ACPI_HANDLE Handle,
346 UINT32 Function,
347 void *HandlerContext,
348 void **RegionContext);
349
350 ACPI_STATUS
351 AcpiEvCmosRegionSetup (
352 ACPI_HANDLE Handle,
353 UINT32 Function,
354 void *HandlerContext,
355 void **RegionContext);
356
357 ACPI_STATUS
358 AcpiEvPciBarRegionSetup (
359 ACPI_HANDLE Handle,
360 UINT32 Function,
361 void *HandlerContext,
362 void **RegionContext);
363
364 ACPI_STATUS
365 AcpiEvDefaultRegionSetup (
366 ACPI_HANDLE Handle,
367 UINT32 Function,
368 void *HandlerContext,
369 void **RegionContext);
370
371 ACPI_STATUS
372 AcpiEvInitializeRegion (
373 ACPI_OPERAND_OBJECT *RegionObj,
374 BOOLEAN AcpiNsLocked);
375
376
377 /*
378 * evsci - SCI (System Control Interrupt) handling/dispatch
379 */
380 UINT32 ACPI_SYSTEM_XFACE
381 AcpiEvGpeXruptHandler (
382 void *Context);
383
384 UINT32
385 AcpiEvInstallSciHandler (
386 void);
387
388 ACPI_STATUS
389 AcpiEvRemoveSciHandler (
390 void);
391
392 UINT32
393 AcpiEvInitializeSCI (
394 UINT32 ProgramSCI);
395
396 void
397 AcpiEvTerminate (
398 void);
399
400
401 #endif /* __ACEVENTS_H__ */
402