xref: /titanic_50/usr/src/uts/intel/io/acpica/events/evsci.c (revision 67e3a03ed4a2813074d36330f062ed6e593a4937)
1 /*******************************************************************************
2  *
3  * Module Name: evsci - System Control Interrupt configuration and
4  *                      legacy to ACPI mode state transition functions
5  *              $Revision: 1.100 $
6  *
7  ******************************************************************************/
8 
9 /******************************************************************************
10  *
11  * 1. Copyright Notice
12  *
13  * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
14  * All rights reserved.
15  *
16  * 2. License
17  *
18  * 2.1. This is your license from Intel Corp. under its intellectual property
19  * rights.  You may have additional license terms from the party that provided
20  * you this software, covering your right to use that party's intellectual
21  * property rights.
22  *
23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24  * copy of the source code appearing in this file ("Covered Code") an
25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26  * base code distributed originally by Intel ("Original Intel Code") to copy,
27  * make derivatives, distribute, use and display any portion of the Covered
28  * Code in any form, with the right to sublicense such rights; and
29  *
30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31  * license (with the right to sublicense), under only those claims of Intel
32  * patents that are infringed by the Original Intel Code, to make, use, sell,
33  * offer to sell, and import the Covered Code and derivative works thereof
34  * solely to the minimum extent necessary to exercise the above copyright
35  * license, and in no event shall the patent license extend to any additions
36  * to or modifications of the Original Intel Code.  No other license or right
37  * is granted directly or by implication, estoppel or otherwise;
38  *
39  * The above copyright and patent license is granted only if the following
40  * conditions are met:
41  *
42  * 3. Conditions
43  *
44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45  * Redistribution of source code of any substantial portion of the Covered
46  * Code or modification with rights to further distribute source must include
47  * the above Copyright Notice, the above License, this list of Conditions,
48  * and the following Disclaimer and Export Compliance provision.  In addition,
49  * Licensee must cause all Covered Code to which Licensee contributes to
50  * contain a file documenting the changes Licensee made to create that Covered
51  * Code and the date of any change.  Licensee must include in that file the
52  * documentation of any changes made by any predecessor Licensee.  Licensee
53  * must include a prominent statement that the modification is derived,
54  * directly or indirectly, from Original Intel Code.
55  *
56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57  * Redistribution of source code of any substantial portion of the Covered
58  * Code or modification without rights to further distribute source must
59  * include the following Disclaimer and Export Compliance provision in the
60  * documentation and/or other materials provided with distribution.  In
61  * addition, Licensee may not authorize further sublicense of source of any
62  * portion of the Covered Code, and must include terms to the effect that the
63  * license from Licensee to its licensee is limited to the intellectual
64  * property embodied in the software Licensee provides to its licensee, and
65  * not to intellectual property embodied in modifications its licensee may
66 
67  * make.
68  *
69  * 3.3. Redistribution of Executable. Redistribution in executable form of any
70  * substantial portion of the Covered Code or modification must reproduce the
71  * above Copyright Notice, and the following Disclaimer and Export Compliance
72  * provision in the documentation and/or other materials provided with the
73  * distribution.
74  *
75  * 3.4. Intel retains all right, title, and interest in and to the Original
76  * Intel Code.
77  *
78  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
79  * Intel shall be used in advertising or otherwise to promote the sale, use or
80  * other dealings in products derived from or relating to the Covered Code
81  * without prior written authorization from Intel.
82  *
83  * 4. Disclaimer and Export Compliance
84  *
85  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
86  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
87  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
88  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
89  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
90  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91  * PARTICULAR PURPOSE.
92  *
93  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
94  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
95  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
96  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
97  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
98  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
99  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100  * LIMITED REMEDY.
101  *
102  * 4.3. Licensee shall not export, either directly or indirectly, any of this
103  * software or system incorporating such software without first obtaining any
104  * required license or other approval from the U. S. Department of Commerce or
105  * any other agency or department of the United States Government.  In the
106  * event Licensee exports any such software from the United States or
107  * re-exports any such software from a foreign destination, Licensee shall
108  * ensure that the distribution and export/re-export of the software is in
109  * compliance with all laws, regulations, orders, or other restrictions of the
110  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
111  * any of its subsidiaries will export/re-export any technical data, process,
112  * software, or service, directly or indirectly, to any country for which the
113  * United States government or any agency thereof requires an export license,
114  * other governmental approval, or letter of assurance, without first obtaining
115  * such license, approval or letter.
116  *
117  *****************************************************************************/
118 
119 #include "acpi.h"
120 #include "acevents.h"
121 
122 
123 #define _COMPONENT          ACPI_EVENTS
124         ACPI_MODULE_NAME    ("evsci")
125 
126 /* Local prototypes */
127 
128 static UINT32 ACPI_SYSTEM_XFACE
129 AcpiEvSciXruptHandler (
130     void                    *Context);
131 
132 
133 /*******************************************************************************
134  *
135  * FUNCTION:    AcpiEvSciXruptHandler
136  *
137  * PARAMETERS:  Context   - Calling Context
138  *
139  * RETURN:      Status code indicates whether interrupt was handled.
140  *
141  * DESCRIPTION: Interrupt handler that will figure out what function or
142  *              control method to call to deal with a SCI.
143  *
144  ******************************************************************************/
145 
146 static UINT32 ACPI_SYSTEM_XFACE
147 AcpiEvSciXruptHandler (
148     void                    *Context)
149 {
150     ACPI_GPE_XRUPT_INFO     *GpeXruptList = Context;
151     UINT32                  InterruptHandled = ACPI_INTERRUPT_NOT_HANDLED;
152 
153 
154     ACPI_FUNCTION_TRACE (EvSciXruptHandler);
155 
156 
157     /*
158      * We are guaranteed by the ACPI CA initialization/shutdown code that
159      * if this interrupt handler is installed, ACPI is enabled.
160      */
161 
162     /*
163      * Fixed Events:
164      * Check for and dispatch any Fixed Events that have occurred
165      */
166     InterruptHandled |= AcpiEvFixedEventDetect ();
167 
168     /*
169      * General Purpose Events:
170      * Check for and dispatch any GPEs that have occurred
171      */
172     InterruptHandled |= AcpiEvGpeDetect (GpeXruptList);
173 
174     return_UINT32 (InterruptHandled);
175 }
176 
177 
178 /*******************************************************************************
179  *
180  * FUNCTION:    AcpiEvGpeXruptHandler
181  *
182  * PARAMETERS:  Context   - Calling Context
183  *
184  * RETURN:      Status code indicates whether interrupt was handled.
185  *
186  * DESCRIPTION: Handler for GPE Block Device interrupts
187  *
188  ******************************************************************************/
189 
190 UINT32 ACPI_SYSTEM_XFACE
191 AcpiEvGpeXruptHandler (
192     void                    *Context)
193 {
194     ACPI_GPE_XRUPT_INFO     *GpeXruptList = Context;
195     UINT32                  InterruptHandled = ACPI_INTERRUPT_NOT_HANDLED;
196 
197 
198     ACPI_FUNCTION_TRACE (EvGpeXruptHandler);
199 
200 
201     /*
202      * We are guaranteed by the ACPI CA initialization/shutdown code that
203      * if this interrupt handler is installed, ACPI is enabled.
204      */
205 
206     /*
207      * GPEs:
208      * Check for and dispatch any GPEs that have occurred
209      */
210     InterruptHandled |= AcpiEvGpeDetect (GpeXruptList);
211 
212     return_UINT32 (InterruptHandled);
213 }
214 
215 
216 /******************************************************************************
217  *
218  * FUNCTION:    AcpiEvInstallSciHandler
219  *
220  * PARAMETERS:  none
221  *
222  * RETURN:      Status
223  *
224  * DESCRIPTION: Installs SCI handler.
225  *
226  ******************************************************************************/
227 
228 UINT32
229 AcpiEvInstallSciHandler (
230     void)
231 {
232     UINT32                  Status = AE_OK;
233 
234 
235     ACPI_FUNCTION_TRACE (EvInstallSciHandler);
236 
237 
238     Status = AcpiOsInstallInterruptHandler ((UINT32) AcpiGbl_FADT->SciInt,
239                         AcpiEvSciXruptHandler, AcpiGbl_GpeXruptListHead);
240     return_ACPI_STATUS (Status);
241 }
242 
243 
244 /******************************************************************************
245  *
246  * FUNCTION:    AcpiEvRemoveSciHandler
247  *
248  * PARAMETERS:  none
249  *
250  * RETURN:      E_OK if handler uninstalled OK, E_ERROR if handler was not
251  *              installed to begin with
252  *
253  * DESCRIPTION: Remove the SCI interrupt handler.  No further SCIs will be
254  *              taken.
255  *
256  * Note:  It doesn't seem important to disable all events or set the event
257  *        enable registers to their original values.  The OS should disable
258  *        the SCI interrupt level when the handler is removed, so no more
259  *        events will come in.
260  *
261  ******************************************************************************/
262 
263 ACPI_STATUS
264 AcpiEvRemoveSciHandler (
265     void)
266 {
267     ACPI_STATUS             Status;
268 
269 
270     ACPI_FUNCTION_TRACE (EvRemoveSciHandler);
271 
272 
273     /* Just let the OS remove the handler and disable the level */
274 
275     Status = AcpiOsRemoveInterruptHandler ((UINT32) AcpiGbl_FADT->SciInt,
276                                     AcpiEvSciXruptHandler);
277 
278     return_ACPI_STATUS (Status);
279 }
280 
281 
282