xref: /titanic_50/usr/src/uts/intel/sys/acpi/acevents.h (revision 40b706cf0ea54322e61c57be046ae27fde135222)
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 - 2009, 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 - GPE handling and dispatch
171  */
172 ACPI_STATUS
173 AcpiEvUpdateGpeEnableMasks (
174     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
175     UINT8                   Type);
176 
177 ACPI_STATUS
178 AcpiEvEnableGpe (
179     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
180     BOOLEAN                 WriteToHardware);
181 
182 ACPI_STATUS
183 AcpiEvDisableGpe (
184     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
185 
186 ACPI_GPE_EVENT_INFO *
187 AcpiEvGetGpeEventInfo (
188     ACPI_HANDLE             GpeDevice,
189     UINT32                  GpeNumber);
190 
191 
192 /*
193  * evgpeblk
194  */
195 BOOLEAN
196 AcpiEvValidGpeEvent (
197     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
198 
199 ACPI_STATUS
200 AcpiEvWalkGpeList (
201     ACPI_GPE_CALLBACK       GpeWalkCallback,
202     void                    *Context);
203 
204 ACPI_STATUS
205 AcpiEvDeleteGpeHandlers (
206     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
207     ACPI_GPE_BLOCK_INFO     *GpeBlock,
208     void                    *Context);
209 
210 ACPI_STATUS
211 AcpiEvCreateGpeBlock (
212     ACPI_NAMESPACE_NODE     *GpeDevice,
213     ACPI_GENERIC_ADDRESS    *GpeBlockAddress,
214     UINT32                  RegisterCount,
215     UINT8                   GpeBlockBaseNumber,
216     UINT32                  InterruptNumber,
217     ACPI_GPE_BLOCK_INFO     **ReturnGpeBlock);
218 
219 ACPI_STATUS
220 AcpiEvInitializeGpeBlock (
221     ACPI_NAMESPACE_NODE     *GpeDevice,
222     ACPI_GPE_BLOCK_INFO     *GpeBlock);
223 
224 ACPI_STATUS
225 AcpiEvDeleteGpeBlock (
226     ACPI_GPE_BLOCK_INFO     *GpeBlock);
227 
228 UINT32
229 AcpiEvGpeDispatch (
230     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
231     UINT32                  GpeNumber);
232 
233 UINT32
234 AcpiEvGpeDetect (
235     ACPI_GPE_XRUPT_INFO     *GpeXruptList);
236 
237 ACPI_STATUS
238 AcpiEvSetGpeType (
239     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
240     UINT8                   Type);
241 
242 ACPI_STATUS
243 AcpiEvCheckForWakeOnlyGpe (
244     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
245 
246 ACPI_STATUS
247 AcpiEvGpeInitialize (
248     void);
249 
250 
251 /*
252  * evregion - Address Space handling
253  */
254 ACPI_STATUS
255 AcpiEvInstallRegionHandlers (
256     void);
257 
258 ACPI_STATUS
259 AcpiEvInitializeOpRegions (
260     void);
261 
262 ACPI_STATUS
263 AcpiEvAddressSpaceDispatch (
264     ACPI_OPERAND_OBJECT    *RegionObj,
265     UINT32                  Function,
266     UINT32                  RegionOffset,
267     UINT32                  BitWidth,
268     ACPI_INTEGER            *Value);
269 
270 ACPI_STATUS
271 AcpiEvAttachRegion (
272     ACPI_OPERAND_OBJECT     *HandlerObj,
273     ACPI_OPERAND_OBJECT     *RegionObj,
274     BOOLEAN                 AcpiNsIsLocked);
275 
276 void
277 AcpiEvDetachRegion (
278     ACPI_OPERAND_OBJECT    *RegionObj,
279     BOOLEAN                 AcpiNsIsLocked);
280 
281 ACPI_STATUS
282 AcpiEvInstallSpaceHandler (
283     ACPI_NAMESPACE_NODE     *Node,
284     ACPI_ADR_SPACE_TYPE     SpaceId,
285     ACPI_ADR_SPACE_HANDLER  Handler,
286     ACPI_ADR_SPACE_SETUP    Setup,
287     void                    *Context);
288 
289 ACPI_STATUS
290 AcpiEvExecuteRegMethods (
291     ACPI_NAMESPACE_NODE     *Node,
292     ACPI_ADR_SPACE_TYPE     SpaceId);
293 
294 ACPI_STATUS
295 AcpiEvExecuteRegMethod (
296     ACPI_OPERAND_OBJECT    *RegionObj,
297     UINT32                  Function);
298 
299 
300 /*
301  * evregini - Region initialization and setup
302  */
303 ACPI_STATUS
304 AcpiEvSystemMemoryRegionSetup (
305     ACPI_HANDLE             Handle,
306     UINT32                  Function,
307     void                    *HandlerContext,
308     void                    **RegionContext);
309 
310 ACPI_STATUS
311 AcpiEvIoSpaceRegionSetup (
312     ACPI_HANDLE             Handle,
313     UINT32                  Function,
314     void                    *HandlerContext,
315     void                    **RegionContext);
316 
317 ACPI_STATUS
318 AcpiEvPciConfigRegionSetup (
319     ACPI_HANDLE             Handle,
320     UINT32                  Function,
321     void                    *HandlerContext,
322     void                    **RegionContext);
323 
324 ACPI_STATUS
325 AcpiEvCmosRegionSetup (
326     ACPI_HANDLE             Handle,
327     UINT32                  Function,
328     void                    *HandlerContext,
329     void                    **RegionContext);
330 
331 ACPI_STATUS
332 AcpiEvPciBarRegionSetup (
333     ACPI_HANDLE             Handle,
334     UINT32                  Function,
335     void                    *HandlerContext,
336     void                    **RegionContext);
337 
338 ACPI_STATUS
339 AcpiEvDefaultRegionSetup (
340     ACPI_HANDLE             Handle,
341     UINT32                  Function,
342     void                    *HandlerContext,
343     void                    **RegionContext);
344 
345 ACPI_STATUS
346 AcpiEvInitializeRegion (
347     ACPI_OPERAND_OBJECT     *RegionObj,
348     BOOLEAN                 AcpiNsLocked);
349 
350 
351 /*
352  * evsci - SCI (System Control Interrupt) handling/dispatch
353  */
354 UINT32 ACPI_SYSTEM_XFACE
355 AcpiEvGpeXruptHandler (
356     void                    *Context);
357 
358 UINT32
359 AcpiEvInstallSciHandler (
360     void);
361 
362 ACPI_STATUS
363 AcpiEvRemoveSciHandler (
364     void);
365 
366 UINT32
367 AcpiEvInitializeSCI (
368     UINT32                  ProgramSCI);
369 
370 void
371 AcpiEvTerminate (
372     void);
373 
374 
375 #endif  /* __ACEVENTS_H__  */
376