1/******************************************************************************
2 *
3 * Name: acevents.h - Event subcomponent prototypes and defines
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2016, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#ifndef __ACEVENTS_H__
45#define __ACEVENTS_H__
46
47
48/*
49 * evevent
50 */
51ACPI_STATUS
52AcpiEvInitializeEvents (
53 void);
54
55ACPI_STATUS
56AcpiEvInstallXruptHandlers (
57 void);
58
59UINT32
60AcpiEvFixedEventDetect (
61 void);
62
63
64/*
65 * evmisc
66 */
67BOOLEAN
68AcpiEvIsNotifyObject (
69 ACPI_NAMESPACE_NODE *Node);
70
71UINT32
72AcpiEvGetGpeNumberIndex (
73 UINT32 GpeNumber);
74
75ACPI_STATUS
76AcpiEvQueueNotifyRequest (
77 ACPI_NAMESPACE_NODE *Node,
78 UINT32 NotifyValue);
79
80
81/*
82 * evglock - Global Lock support
83 */
84ACPI_STATUS
85AcpiEvInitGlobalLockHandler (
86 void);
87
88ACPI_HW_DEPENDENT_RETURN_OK (
89ACPI_STATUS
90AcpiEvAcquireGlobalLock(
91 UINT16 Timeout))
92
93ACPI_HW_DEPENDENT_RETURN_OK (
94ACPI_STATUS
95AcpiEvReleaseGlobalLock(
96 void))
97
98ACPI_STATUS
99AcpiEvRemoveGlobalLockHandler (
100 void);
101
102
103/*
104 * evgpe - Low-level GPE support
105 */
106UINT32
107AcpiEvGpeDetect (
108 ACPI_GPE_XRUPT_INFO *GpeXruptList);
109
110ACPI_STATUS
111AcpiEvUpdateGpeEnableMask (
112 ACPI_GPE_EVENT_INFO *GpeEventInfo);
113
114ACPI_STATUS
115AcpiEvEnableGpe (
116 ACPI_GPE_EVENT_INFO *GpeEventInfo);
117
118ACPI_STATUS
119AcpiEvMaskGpe (
120 ACPI_GPE_EVENT_INFO *GpeEventInfo,
121 BOOLEAN IsMasked);
122
123ACPI_STATUS
124AcpiEvAddGpeReference (
125 ACPI_GPE_EVENT_INFO *GpeEventInfo);
126
127ACPI_STATUS
128AcpiEvRemoveGpeReference (
129 ACPI_GPE_EVENT_INFO *GpeEventInfo);
130
131ACPI_GPE_EVENT_INFO *
132AcpiEvGetGpeEventInfo (
133 ACPI_HANDLE GpeDevice,
134 UINT32 GpeNumber);
135
136ACPI_GPE_EVENT_INFO *
137AcpiEvLowGetGpeInfo (
138 UINT32 GpeNumber,
139 ACPI_GPE_BLOCK_INFO *GpeBlock);
140
141ACPI_STATUS
142AcpiEvFinishGpe (
143 ACPI_GPE_EVENT_INFO *GpeEventInfo);
144
145
146/*
147 * evgpeblk - Upper-level GPE block support
148 */
149ACPI_STATUS
150AcpiEvCreateGpeBlock (
151 ACPI_NAMESPACE_NODE *GpeDevice,
152 UINT64 Address,
153 UINT8 SpaceId,
154 UINT32 RegisterCount,
155 UINT16 GpeBlockBaseNumber,
156 UINT32 InterruptNumber,
157 ACPI_GPE_BLOCK_INFO **ReturnGpeBlock);
158
159ACPI_STATUS
160AcpiEvInitializeGpeBlock (
161 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
162 ACPI_GPE_BLOCK_INFO *GpeBlock,
163 void *Context);
164
165ACPI_HW_DEPENDENT_RETURN_OK (
166ACPI_STATUS
167AcpiEvDeleteGpeBlock (
168 ACPI_GPE_BLOCK_INFO *GpeBlock))
169
170UINT32
171AcpiEvGpeDispatch (
172 ACPI_NAMESPACE_NODE *GpeDevice,
173 ACPI_GPE_EVENT_INFO *GpeEventInfo,
174 UINT32 GpeNumber);
175
176
177/*
178 * evgpeinit - GPE initialization and update
179 */
180ACPI_STATUS
181AcpiEvGpeInitialize (
182 void);
183
184ACPI_HW_DEPENDENT_RETURN_VOID (
185void
186AcpiEvUpdateGpes (
187 ACPI_OWNER_ID TableOwnerId))
188
189ACPI_STATUS
190AcpiEvMatchGpeMethod (
191 ACPI_HANDLE ObjHandle,
192 UINT32 Level,
193 void *Context,
194 void **ReturnValue);
195
196
197/*
198 * evgpeutil - GPE utilities
199 */
200ACPI_STATUS
201AcpiEvWalkGpeList (
202 ACPI_GPE_CALLBACK GpeWalkCallback,
203 void *Context);
204
205ACPI_STATUS
206AcpiEvGetGpeDevice (
207 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
208 ACPI_GPE_BLOCK_INFO *GpeBlock,
209 void *Context);
210
211ACPI_STATUS
212AcpiEvGetGpeXruptBlock (
213 UINT32 InterruptNumber,
214 ACPI_GPE_XRUPT_INFO **GpeXruptBlock);
215
216ACPI_STATUS
217AcpiEvDeleteGpeXrupt (
218 ACPI_GPE_XRUPT_INFO *GpeXrupt);
219
220ACPI_STATUS
221AcpiEvDeleteGpeHandlers (
222 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
223 ACPI_GPE_BLOCK_INFO *GpeBlock,
224 void *Context);
225
226
227/*
228 * evhandler - Address space handling
229 */
230ACPI_OPERAND_OBJECT *
231AcpiEvFindRegionHandler (
232 ACPI_ADR_SPACE_TYPE SpaceId,
233 ACPI_OPERAND_OBJECT *HandlerObj);
234
235BOOLEAN
236AcpiEvHasDefaultHandler (
237 ACPI_NAMESPACE_NODE *Node,
238 ACPI_ADR_SPACE_TYPE SpaceId);
239
240ACPI_STATUS
241AcpiEvInstallRegionHandlers (
242 void);
243
244ACPI_STATUS
245AcpiEvInstallSpaceHandler (
246 ACPI_NAMESPACE_NODE *Node,
247 ACPI_ADR_SPACE_TYPE SpaceId,
248 ACPI_ADR_SPACE_HANDLER Handler,
249 ACPI_ADR_SPACE_SETUP Setup,
250 void *Context);
251
252
253/*
254 * evregion - Operation region support
255 */
256ACPI_STATUS
257AcpiEvInitializeOpRegions (
258 void);
259
260ACPI_STATUS
261AcpiEvAddressSpaceDispatch (
262 ACPI_OPERAND_OBJECT *RegionObj,
263 ACPI_OPERAND_OBJECT *FieldObj,
264 UINT32 Function,
265 UINT32 RegionOffset,
266 UINT32 BitWidth,
267 UINT64 *Value);
268
269ACPI_STATUS
270AcpiEvAttachRegion (
271 ACPI_OPERAND_OBJECT *HandlerObj,
272 ACPI_OPERAND_OBJECT *RegionObj,
273 BOOLEAN AcpiNsIsLocked);
274
275void
276AcpiEvDetachRegion (
277 ACPI_OPERAND_OBJECT *RegionObj,
278 BOOLEAN AcpiNsIsLocked);
279
280void
281AcpiEvExecuteRegMethods (
282 ACPI_NAMESPACE_NODE *Node,
283 ACPI_ADR_SPACE_TYPE SpaceId,
284 UINT32 Function);
285
286ACPI_STATUS
287AcpiEvExecuteRegMethod (
288 ACPI_OPERAND_OBJECT *RegionObj,
289 UINT32 Function);
290
291
292/*
293 * evregini - Region initialization and setup
294 */
295ACPI_STATUS
296AcpiEvSystemMemoryRegionSetup (
297 ACPI_HANDLE Handle,
298 UINT32 Function,
299 void *HandlerContext,
300 void **RegionContext);
301
302ACPI_STATUS
303AcpiEvIoSpaceRegionSetup (
304 ACPI_HANDLE Handle,
305 UINT32 Function,
306 void *HandlerContext,
307 void **RegionContext);
308
309ACPI_STATUS
310AcpiEvPciConfigRegionSetup (
311 ACPI_HANDLE Handle,
312 UINT32 Function,
313 void *HandlerContext,
314 void **RegionContext);
315
316ACPI_STATUS
317AcpiEvCmosRegionSetup (
318 ACPI_HANDLE Handle,
319 UINT32 Function,
320 void *HandlerContext,
321 void **RegionContext);
322
323ACPI_STATUS
324AcpiEvPciBarRegionSetup (
325 ACPI_HANDLE Handle,
326 UINT32 Function,
327 void *HandlerContext,
328 void **RegionContext);
329
330ACPI_STATUS
331AcpiEvDefaultRegionSetup (
332 ACPI_HANDLE Handle,
333 UINT32 Function,
334 void *HandlerContext,
335 void **RegionContext);
336
337ACPI_STATUS
338AcpiEvInitializeRegion (
339 ACPI_OPERAND_OBJECT *RegionObj,
340 BOOLEAN AcpiNsLocked);
341
342
343/*
344 * evsci - SCI (System Control Interrupt) handling/dispatch
345 */
346UINT32 ACPI_SYSTEM_XFACE
347AcpiEvGpeXruptHandler (
348 void *Context);
349
350UINT32
351AcpiEvSciDispatch (
352 void);
353
354UINT32
355AcpiEvInstallSciHandler (
356 void);
357
358ACPI_STATUS
359AcpiEvRemoveAllSciHandlers (
360 void);
361
362ACPI_HW_DEPENDENT_RETURN_VOID (
363void
364AcpiEvTerminate (
365 void))
366
367#endif /* __ACEVENTS_H__ */
368