xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/events/evxfevnt.c (revision 6c4a44e36ba846c54467103f884d65dfa13e7fcb)
1 /******************************************************************************
2  *
3  * Module Name: evxfevnt - External Interfaces, ACPI event disable/enable
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2012, 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 
117 #define __EVXFEVNT_C__
118 
119 #include "acpi.h"
120 #include "accommon.h"
121 #include "actables.h"
122 
123 #define _COMPONENT          ACPI_EVENTS
124         ACPI_MODULE_NAME    ("evxfevnt")
125 
126 
127 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
128 /*******************************************************************************
129  *
130  * FUNCTION:    AcpiEnable
131  *
132  * PARAMETERS:  None
133  *
134  * RETURN:      Status
135  *
136  * DESCRIPTION: Transfers the system into ACPI mode.
137  *
138  ******************************************************************************/
139 
140 ACPI_STATUS
141 AcpiEnable (
142     void)
143 {
144     ACPI_STATUS             Status = AE_OK;
145 
146 
147     ACPI_FUNCTION_TRACE (AcpiEnable);
148 
149 
150     /* ACPI tables must be present */
151 
152     if (!AcpiTbTablesLoaded ())
153     {
154         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
155     }
156 
157     /* Check current mode */
158 
159     if (AcpiHwGetMode() == ACPI_SYS_MODE_ACPI)
160     {
161         ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "System is already in ACPI mode\n"));
162     }
163     else
164     {
165         /* Transition to ACPI mode */
166 
167         Status = AcpiHwSetMode (ACPI_SYS_MODE_ACPI);
168         if (ACPI_FAILURE (Status))
169         {
170             ACPI_ERROR ((AE_INFO, "Could not transition to ACPI mode"));
171             return_ACPI_STATUS (Status);
172         }
173 
174         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
175             "Transition to ACPI mode successful\n"));
176     }
177 
178     return_ACPI_STATUS (Status);
179 }
180 
181 ACPI_EXPORT_SYMBOL (AcpiEnable)
182 
183 
184 /*******************************************************************************
185  *
186  * FUNCTION:    AcpiDisable
187  *
188  * PARAMETERS:  None
189  *
190  * RETURN:      Status
191  *
192  * DESCRIPTION: Transfers the system into LEGACY (non-ACPI) mode.
193  *
194  ******************************************************************************/
195 
196 ACPI_STATUS
197 AcpiDisable (
198     void)
199 {
200     ACPI_STATUS             Status = AE_OK;
201 
202 
203     ACPI_FUNCTION_TRACE (AcpiDisable);
204 
205 
206     if (AcpiHwGetMode() == ACPI_SYS_MODE_LEGACY)
207     {
208         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
209             "System is already in legacy (non-ACPI) mode\n"));
210     }
211     else
212     {
213         /* Transition to LEGACY mode */
214 
215         Status = AcpiHwSetMode (ACPI_SYS_MODE_LEGACY);
216 
217         if (ACPI_FAILURE (Status))
218         {
219             ACPI_ERROR ((AE_INFO,
220                 "Could not exit ACPI mode to legacy mode"));
221             return_ACPI_STATUS (Status);
222         }
223 
224         ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "ACPI mode disabled\n"));
225     }
226 
227     return_ACPI_STATUS (Status);
228 }
229 
230 ACPI_EXPORT_SYMBOL (AcpiDisable)
231 
232 
233 /*******************************************************************************
234  *
235  * FUNCTION:    AcpiEnableEvent
236  *
237  * PARAMETERS:  Event           - The fixed eventto be enabled
238  *              Flags           - Reserved
239  *
240  * RETURN:      Status
241  *
242  * DESCRIPTION: Enable an ACPI event (fixed)
243  *
244  ******************************************************************************/
245 
246 ACPI_STATUS
247 AcpiEnableEvent (
248     UINT32                  Event,
249     UINT32                  Flags)
250 {
251     ACPI_STATUS             Status = AE_OK;
252     UINT32                  Value;
253 
254 
255     ACPI_FUNCTION_TRACE (AcpiEnableEvent);
256 
257 
258     /* Decode the Fixed Event */
259 
260     if (Event > ACPI_EVENT_MAX)
261     {
262         return_ACPI_STATUS (AE_BAD_PARAMETER);
263     }
264 
265     /*
266      * Enable the requested fixed event (by writing a one to the enable
267      * register bit)
268      */
269     Status = AcpiWriteBitRegister (
270                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
271                 ACPI_ENABLE_EVENT);
272     if (ACPI_FAILURE (Status))
273     {
274         return_ACPI_STATUS (Status);
275     }
276 
277     /* Make sure that the hardware responded */
278 
279     Status = AcpiReadBitRegister (
280                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId, &Value);
281     if (ACPI_FAILURE (Status))
282     {
283         return_ACPI_STATUS (Status);
284     }
285 
286     if (Value != 1)
287     {
288         ACPI_ERROR ((AE_INFO,
289             "Could not enable %s event", AcpiUtGetEventName (Event)));
290         return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
291     }
292 
293     return_ACPI_STATUS (Status);
294 }
295 
296 ACPI_EXPORT_SYMBOL (AcpiEnableEvent)
297 
298 
299 /*******************************************************************************
300  *
301  * FUNCTION:    AcpiDisableEvent
302  *
303  * PARAMETERS:  Event           - The fixed event to be disabled
304  *              Flags           - Reserved
305  *
306  * RETURN:      Status
307  *
308  * DESCRIPTION: Disable an ACPI event (fixed)
309  *
310  ******************************************************************************/
311 
312 ACPI_STATUS
313 AcpiDisableEvent (
314     UINT32                  Event,
315     UINT32                  Flags)
316 {
317     ACPI_STATUS             Status = AE_OK;
318     UINT32                  Value;
319 
320 
321     ACPI_FUNCTION_TRACE (AcpiDisableEvent);
322 
323 
324     /* Decode the Fixed Event */
325 
326     if (Event > ACPI_EVENT_MAX)
327     {
328         return_ACPI_STATUS (AE_BAD_PARAMETER);
329     }
330 
331     /*
332      * Disable the requested fixed event (by writing a zero to the enable
333      * register bit)
334      */
335     Status = AcpiWriteBitRegister (
336                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
337                 ACPI_DISABLE_EVENT);
338     if (ACPI_FAILURE (Status))
339     {
340         return_ACPI_STATUS (Status);
341     }
342 
343     Status = AcpiReadBitRegister (
344                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId, &Value);
345     if (ACPI_FAILURE (Status))
346     {
347         return_ACPI_STATUS (Status);
348     }
349 
350     if (Value != 0)
351     {
352         ACPI_ERROR ((AE_INFO,
353             "Could not disable %s events", AcpiUtGetEventName (Event)));
354         return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
355     }
356 
357     return_ACPI_STATUS (Status);
358 }
359 
360 ACPI_EXPORT_SYMBOL (AcpiDisableEvent)
361 
362 
363 /*******************************************************************************
364  *
365  * FUNCTION:    AcpiClearEvent
366  *
367  * PARAMETERS:  Event           - The fixed event to be cleared
368  *
369  * RETURN:      Status
370  *
371  * DESCRIPTION: Clear an ACPI event (fixed)
372  *
373  ******************************************************************************/
374 
375 ACPI_STATUS
376 AcpiClearEvent (
377     UINT32                  Event)
378 {
379     ACPI_STATUS             Status = AE_OK;
380 
381 
382     ACPI_FUNCTION_TRACE (AcpiClearEvent);
383 
384 
385     /* Decode the Fixed Event */
386 
387     if (Event > ACPI_EVENT_MAX)
388     {
389         return_ACPI_STATUS (AE_BAD_PARAMETER);
390     }
391 
392     /*
393      * Clear the requested fixed event (By writing a one to the status
394      * register bit)
395      */
396     Status = AcpiWriteBitRegister (
397                 AcpiGbl_FixedEventInfo[Event].StatusRegisterId,
398                 ACPI_CLEAR_STATUS);
399 
400     return_ACPI_STATUS (Status);
401 }
402 
403 ACPI_EXPORT_SYMBOL (AcpiClearEvent)
404 
405 
406 /*******************************************************************************
407  *
408  * FUNCTION:    AcpiGetEventStatus
409  *
410  * PARAMETERS:  Event           - The fixed event
411  *              EventStatus     - Where the current status of the event will
412  *                                be returned
413  *
414  * RETURN:      Status
415  *
416  * DESCRIPTION: Obtains and returns the current status of the event
417  *
418  ******************************************************************************/
419 
420 ACPI_STATUS
421 AcpiGetEventStatus (
422     UINT32                  Event,
423     ACPI_EVENT_STATUS       *EventStatus)
424 {
425     ACPI_STATUS             Status = AE_OK;
426 
427 
428     ACPI_FUNCTION_TRACE (AcpiGetEventStatus);
429 
430 
431     if (!EventStatus)
432     {
433         return_ACPI_STATUS (AE_BAD_PARAMETER);
434     }
435 
436     /* Decode the Fixed Event */
437 
438     if (Event > ACPI_EVENT_MAX)
439     {
440         return_ACPI_STATUS (AE_BAD_PARAMETER);
441     }
442 
443     /* Get the status of the requested fixed event */
444 
445     Status = AcpiReadBitRegister (
446                 AcpiGbl_FixedEventInfo[Event].StatusRegisterId, EventStatus);
447 
448     return_ACPI_STATUS (Status);
449 }
450 
451 ACPI_EXPORT_SYMBOL (AcpiGetEventStatus)
452 
453 #endif /* !ACPI_REDUCED_HARDWARE */
454