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