xref: /titanic_41/usr/src/uts/intel/sys/acpi/acevents.h (revision 414388d7cb2ee98771e2ac7c2338c460abd44304)
1 /******************************************************************************
2  *
3  * Name: acevents.h - Event subcomponent prototypes and defines
4  *       $Revision: 103 $
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
13  * All rights 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 
121 /*
122  * evevent
123  */
124 ACPI_STATUS
125 AcpiEvInitializeEvents (
126     void);
127 
128 ACPI_STATUS
129 AcpiEvInstallXruptHandlers (
130     void);
131 
132 UINT32
133 AcpiEvFixedEventDetect (
134     void);
135 
136 
137 /*
138  * evmisc
139  */
140 BOOLEAN
141 AcpiEvIsNotifyObject (
142     ACPI_NAMESPACE_NODE     *Node);
143 
144 ACPI_STATUS
145 AcpiEvAcquireGlobalLock(
146     UINT16                  Timeout);
147 
148 ACPI_STATUS
149 AcpiEvReleaseGlobalLock(
150     void);
151 
152 ACPI_STATUS
153 AcpiEvInitGlobalLockHandler (
154     void);
155 
156 UINT32
157 AcpiEvGetGpeNumberIndex (
158     UINT32                  GpeNumber);
159 
160 ACPI_STATUS
161 AcpiEvQueueNotifyRequest (
162     ACPI_NAMESPACE_NODE     *Node,
163     UINT32                  NotifyValue);
164 
165 
166 /*
167  * evgpe - GPE handling and dispatch
168  */
169 ACPI_STATUS
170 AcpiEvUpdateGpeEnableMasks (
171     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
172     UINT8                   Type);
173 
174 ACPI_STATUS
175 AcpiEvEnableGpe (
176     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
177     BOOLEAN                 WriteToHardware);
178 
179 ACPI_STATUS
180 AcpiEvDisableGpe (
181     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
182 
183 ACPI_GPE_EVENT_INFO *
184 AcpiEvGetGpeEventInfo (
185     ACPI_HANDLE             GpeDevice,
186     UINT32                  GpeNumber);
187 
188 
189 /*
190  * evgpeblk
191  */
192 BOOLEAN
193 AcpiEvValidGpeEvent (
194     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
195 
196 ACPI_STATUS
197 AcpiEvWalkGpeList (
198     ACPI_GPE_CALLBACK       GpeWalkCallback);
199 
200 ACPI_STATUS
201 AcpiEvDeleteGpeHandlers (
202     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
203     ACPI_GPE_BLOCK_INFO     *GpeBlock);
204 
205 ACPI_STATUS
206 AcpiEvCreateGpeBlock (
207     ACPI_NAMESPACE_NODE     *GpeDevice,
208     ACPI_GENERIC_ADDRESS    *GpeBlockAddress,
209     UINT32                  RegisterCount,
210     UINT8                   GpeBlockBaseNumber,
211     UINT32                  InterruptNumber,
212     ACPI_GPE_BLOCK_INFO     **ReturnGpeBlock);
213 
214 ACPI_STATUS
215 AcpiEvDeleteGpeBlock (
216     ACPI_GPE_BLOCK_INFO     *GpeBlock);
217 
218 UINT32
219 AcpiEvGpeDispatch (
220     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
221     UINT32                  GpeNumber);
222 
223 UINT32
224 AcpiEvGpeDetect (
225     ACPI_GPE_XRUPT_INFO     *GpeXruptList);
226 
227 ACPI_STATUS
228 AcpiEvSetGpeType (
229     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
230     UINT8                   Type);
231 
232 ACPI_STATUS
233 AcpiEvCheckForWakeOnlyGpe (
234     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
235 
236 ACPI_STATUS
237 AcpiEvGpeInitialize (
238     void);
239 
240 
241 /*
242  * evregion - Address Space handling
243  */
244 ACPI_STATUS
245 AcpiEvInstallRegionHandlers (
246     void);
247 
248 ACPI_STATUS
249 AcpiEvInitializeOpRegions (
250     void);
251 
252 ACPI_STATUS
253 AcpiEvAddressSpaceDispatch (
254     ACPI_OPERAND_OBJECT    *RegionObj,
255     UINT32                  Function,
256     ACPI_PHYSICAL_ADDRESS   Address,
257     UINT32                  BitWidth,
258     void                    *Value);
259 
260 ACPI_STATUS
261 AcpiEvAttachRegion (
262     ACPI_OPERAND_OBJECT     *HandlerObj,
263     ACPI_OPERAND_OBJECT     *RegionObj,
264     BOOLEAN                 AcpiNsIsLocked);
265 
266 void
267 AcpiEvDetachRegion (
268     ACPI_OPERAND_OBJECT    *RegionObj,
269     BOOLEAN                 AcpiNsIsLocked);
270 
271 ACPI_STATUS
272 AcpiEvInstallSpaceHandler (
273     ACPI_NAMESPACE_NODE     *Node,
274     ACPI_ADR_SPACE_TYPE     SpaceId,
275     ACPI_ADR_SPACE_HANDLER  Handler,
276     ACPI_ADR_SPACE_SETUP    Setup,
277     void                    *Context);
278 
279 ACPI_STATUS
280 AcpiEvExecuteRegMethods (
281     ACPI_NAMESPACE_NODE     *Node,
282     ACPI_ADR_SPACE_TYPE     SpaceId);
283 
284 ACPI_STATUS
285 AcpiEvExecuteRegMethod (
286     ACPI_OPERAND_OBJECT    *RegionObj,
287     UINT32                  Function);
288 
289 
290 /*
291  * evregini - Region initialization and setup
292  */
293 ACPI_STATUS
294 AcpiEvSystemMemoryRegionSetup (
295     ACPI_HANDLE             Handle,
296     UINT32                  Function,
297     void                    *HandlerContext,
298     void                    **RegionContext);
299 
300 ACPI_STATUS
301 AcpiEvIoSpaceRegionSetup (
302     ACPI_HANDLE             Handle,
303     UINT32                  Function,
304     void                    *HandlerContext,
305     void                    **RegionContext);
306 
307 ACPI_STATUS
308 AcpiEvPciConfigRegionSetup (
309     ACPI_HANDLE             Handle,
310     UINT32                  Function,
311     void                    *HandlerContext,
312     void                    **RegionContext);
313 
314 ACPI_STATUS
315 AcpiEvCmosRegionSetup (
316     ACPI_HANDLE             Handle,
317     UINT32                  Function,
318     void                    *HandlerContext,
319     void                    **RegionContext);
320 
321 ACPI_STATUS
322 AcpiEvPciBarRegionSetup (
323     ACPI_HANDLE             Handle,
324     UINT32                  Function,
325     void                    *HandlerContext,
326     void                    **RegionContext);
327 
328 ACPI_STATUS
329 AcpiEvDefaultRegionSetup (
330     ACPI_HANDLE             Handle,
331     UINT32                  Function,
332     void                    *HandlerContext,
333     void                    **RegionContext);
334 
335 ACPI_STATUS
336 AcpiEvInitializeRegion (
337     ACPI_OPERAND_OBJECT     *RegionObj,
338     BOOLEAN                 AcpiNsLocked);
339 
340 
341 /*
342  * evsci - SCI (System Control Interrupt) handling/dispatch
343  */
344 UINT32 ACPI_SYSTEM_XFACE
345 AcpiEvGpeXruptHandler (
346     void                    *Context);
347 
348 UINT32
349 AcpiEvInstallSciHandler (
350     void);
351 
352 ACPI_STATUS
353 AcpiEvRemoveSciHandler (
354     void);
355 
356 UINT32
357 AcpiEvInitializeSCI (
358     UINT32                  ProgramSCI);
359 
360 void
361 AcpiEvTerminate (
362     void);
363 
364 
365 #endif  /* __ACEVENTS_H__  */
366