xref: /freebsd/sys/contrib/dev/acpica/components/events/evxfevnt.c (revision ca86bcf2531c7b149c95244a67853d44323e7855)
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 - 2017, 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  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #define EXPORT_ACPI_INTERFACES
153 
154 #include <contrib/dev/acpica/include/acpi.h>
155 #include <contrib/dev/acpica/include/accommon.h>
156 #include <contrib/dev/acpica/include/actables.h>
157 
158 #define _COMPONENT          ACPI_EVENTS
159         ACPI_MODULE_NAME    ("evxfevnt")
160 
161 
162 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
163 /*******************************************************************************
164  *
165  * FUNCTION:    AcpiEnable
166  *
167  * PARAMETERS:  None
168  *
169  * RETURN:      Status
170  *
171  * DESCRIPTION: Transfers the system into ACPI mode.
172  *
173  ******************************************************************************/
174 
175 ACPI_STATUS
176 AcpiEnable (
177     void)
178 {
179     ACPI_STATUS             Status = AE_OK;
180 
181 
182     ACPI_FUNCTION_TRACE (AcpiEnable);
183 
184 
185     /* ACPI tables must be present */
186 
187     if (AcpiGbl_FadtIndex == ACPI_INVALID_TABLE_INDEX)
188     {
189         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
190     }
191 
192     /* If the Hardware Reduced flag is set, machine is always in acpi mode */
193 
194     if (AcpiGbl_ReducedHardware)
195     {
196         return_ACPI_STATUS (AE_OK);
197     }
198 
199     /* Check current mode */
200 
201     if (AcpiHwGetMode() == ACPI_SYS_MODE_ACPI)
202     {
203         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
204             "System is already in ACPI mode\n"));
205     }
206     else
207     {
208         /* Transition to ACPI mode */
209 
210         Status = AcpiHwSetMode (ACPI_SYS_MODE_ACPI);
211         if (ACPI_FAILURE (Status))
212         {
213             ACPI_ERROR ((AE_INFO, "Could not transition to ACPI mode"));
214             return_ACPI_STATUS (Status);
215         }
216 
217         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
218             "Transition to ACPI mode successful\n"));
219     }
220 
221     return_ACPI_STATUS (Status);
222 }
223 
224 ACPI_EXPORT_SYMBOL (AcpiEnable)
225 
226 
227 /*******************************************************************************
228  *
229  * FUNCTION:    AcpiDisable
230  *
231  * PARAMETERS:  None
232  *
233  * RETURN:      Status
234  *
235  * DESCRIPTION: Transfers the system into LEGACY (non-ACPI) mode.
236  *
237  ******************************************************************************/
238 
239 ACPI_STATUS
240 AcpiDisable (
241     void)
242 {
243     ACPI_STATUS             Status = AE_OK;
244 
245 
246     ACPI_FUNCTION_TRACE (AcpiDisable);
247 
248 
249     /* If the Hardware Reduced flag is set, machine is always in acpi mode */
250 
251     if (AcpiGbl_ReducedHardware)
252     {
253         return_ACPI_STATUS (AE_OK);
254     }
255 
256     if (AcpiHwGetMode() == ACPI_SYS_MODE_LEGACY)
257     {
258         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
259             "System is already in legacy (non-ACPI) mode\n"));
260     }
261     else
262     {
263         /* Transition to LEGACY mode */
264 
265         Status = AcpiHwSetMode (ACPI_SYS_MODE_LEGACY);
266 
267         if (ACPI_FAILURE (Status))
268         {
269             ACPI_ERROR ((AE_INFO,
270                 "Could not exit ACPI mode to legacy mode"));
271             return_ACPI_STATUS (Status);
272         }
273 
274         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
275             "ACPI mode disabled\n"));
276     }
277 
278     return_ACPI_STATUS (Status);
279 }
280 
281 ACPI_EXPORT_SYMBOL (AcpiDisable)
282 
283 
284 /*******************************************************************************
285  *
286  * FUNCTION:    AcpiEnableEvent
287  *
288  * PARAMETERS:  Event           - The fixed eventto be enabled
289  *              Flags           - Reserved
290  *
291  * RETURN:      Status
292  *
293  * DESCRIPTION: Enable an ACPI event (fixed)
294  *
295  ******************************************************************************/
296 
297 ACPI_STATUS
298 AcpiEnableEvent (
299     UINT32                  Event,
300     UINT32                  Flags)
301 {
302     ACPI_STATUS             Status = AE_OK;
303     UINT32                  Value;
304 
305 
306     ACPI_FUNCTION_TRACE (AcpiEnableEvent);
307 
308 
309     /* Decode the Fixed Event */
310 
311     if (Event > ACPI_EVENT_MAX)
312     {
313         return_ACPI_STATUS (AE_BAD_PARAMETER);
314     }
315 
316     /*
317      * Enable the requested fixed event (by writing a one to the enable
318      * register bit)
319      */
320     Status = AcpiWriteBitRegister (
321         AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
322         ACPI_ENABLE_EVENT);
323     if (ACPI_FAILURE (Status))
324     {
325         return_ACPI_STATUS (Status);
326     }
327 
328     /* Make sure that the hardware responded */
329 
330     Status = AcpiReadBitRegister (
331         AcpiGbl_FixedEventInfo[Event].EnableRegisterId, &Value);
332     if (ACPI_FAILURE (Status))
333     {
334         return_ACPI_STATUS (Status);
335     }
336 
337     if (Value != 1)
338     {
339         ACPI_ERROR ((AE_INFO,
340             "Could not enable %s event", AcpiUtGetEventName (Event)));
341         return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
342     }
343 
344     return_ACPI_STATUS (Status);
345 }
346 
347 ACPI_EXPORT_SYMBOL (AcpiEnableEvent)
348 
349 
350 /*******************************************************************************
351  *
352  * FUNCTION:    AcpiDisableEvent
353  *
354  * PARAMETERS:  Event           - The fixed event to be disabled
355  *              Flags           - Reserved
356  *
357  * RETURN:      Status
358  *
359  * DESCRIPTION: Disable an ACPI event (fixed)
360  *
361  ******************************************************************************/
362 
363 ACPI_STATUS
364 AcpiDisableEvent (
365     UINT32                  Event,
366     UINT32                  Flags)
367 {
368     ACPI_STATUS             Status = AE_OK;
369     UINT32                  Value;
370 
371 
372     ACPI_FUNCTION_TRACE (AcpiDisableEvent);
373 
374 
375     /* Decode the Fixed Event */
376 
377     if (Event > ACPI_EVENT_MAX)
378     {
379         return_ACPI_STATUS (AE_BAD_PARAMETER);
380     }
381 
382     /*
383      * Disable the requested fixed event (by writing a zero to the enable
384      * register bit)
385      */
386     Status = AcpiWriteBitRegister (
387         AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
388         ACPI_DISABLE_EVENT);
389     if (ACPI_FAILURE (Status))
390     {
391         return_ACPI_STATUS (Status);
392     }
393 
394     Status = AcpiReadBitRegister (
395         AcpiGbl_FixedEventInfo[Event].EnableRegisterId, &Value);
396     if (ACPI_FAILURE (Status))
397     {
398         return_ACPI_STATUS (Status);
399     }
400 
401     if (Value != 0)
402     {
403         ACPI_ERROR ((AE_INFO,
404             "Could not disable %s events", AcpiUtGetEventName (Event)));
405         return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
406     }
407 
408     return_ACPI_STATUS (Status);
409 }
410 
411 ACPI_EXPORT_SYMBOL (AcpiDisableEvent)
412 
413 
414 /*******************************************************************************
415  *
416  * FUNCTION:    AcpiClearEvent
417  *
418  * PARAMETERS:  Event           - The fixed event to be cleared
419  *
420  * RETURN:      Status
421  *
422  * DESCRIPTION: Clear an ACPI event (fixed)
423  *
424  ******************************************************************************/
425 
426 ACPI_STATUS
427 AcpiClearEvent (
428     UINT32                  Event)
429 {
430     ACPI_STATUS             Status = AE_OK;
431 
432 
433     ACPI_FUNCTION_TRACE (AcpiClearEvent);
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     /*
444      * Clear the requested fixed event (By writing a one to the status
445      * register bit)
446      */
447     Status = AcpiWriteBitRegister (
448         AcpiGbl_FixedEventInfo[Event].StatusRegisterId,
449         ACPI_CLEAR_STATUS);
450 
451     return_ACPI_STATUS (Status);
452 }
453 
454 ACPI_EXPORT_SYMBOL (AcpiClearEvent)
455 
456 
457 /*******************************************************************************
458  *
459  * FUNCTION:    AcpiGetEventStatus
460  *
461  * PARAMETERS:  Event           - The fixed event
462  *              EventStatus     - Where the current status of the event will
463  *                                be returned
464  *
465  * RETURN:      Status
466  *
467  * DESCRIPTION: Obtains and returns the current status of the event
468  *
469  ******************************************************************************/
470 
471 ACPI_STATUS
472 AcpiGetEventStatus (
473     UINT32                  Event,
474     ACPI_EVENT_STATUS       *EventStatus)
475 {
476     ACPI_STATUS             Status;
477     ACPI_EVENT_STATUS       LocalEventStatus = 0;
478     UINT32                  InByte;
479 
480 
481     ACPI_FUNCTION_TRACE (AcpiGetEventStatus);
482 
483 
484     if (!EventStatus)
485     {
486         return_ACPI_STATUS (AE_BAD_PARAMETER);
487     }
488 
489     /* Decode the Fixed Event */
490 
491     if (Event > ACPI_EVENT_MAX)
492     {
493         return_ACPI_STATUS (AE_BAD_PARAMETER);
494     }
495 
496     /* Fixed event currently can be dispatched? */
497 
498     if (AcpiGbl_FixedEventHandlers[Event].Handler)
499     {
500         LocalEventStatus |= ACPI_EVENT_FLAG_HAS_HANDLER;
501     }
502 
503     /* Fixed event currently enabled? */
504 
505     Status = AcpiReadBitRegister (
506         AcpiGbl_FixedEventInfo[Event].EnableRegisterId, &InByte);
507     if (ACPI_FAILURE (Status))
508     {
509         return_ACPI_STATUS (Status);
510     }
511 
512     if (InByte)
513     {
514         LocalEventStatus |=
515             (ACPI_EVENT_FLAG_ENABLED | ACPI_EVENT_FLAG_ENABLE_SET);
516     }
517 
518     /* Fixed event currently active? */
519 
520     Status = AcpiReadBitRegister (
521         AcpiGbl_FixedEventInfo[Event].StatusRegisterId, &InByte);
522     if (ACPI_FAILURE (Status))
523     {
524         return_ACPI_STATUS (Status);
525     }
526 
527     if (InByte)
528     {
529         LocalEventStatus |= ACPI_EVENT_FLAG_STATUS_SET;
530     }
531 
532     (*EventStatus) = LocalEventStatus;
533     return_ACPI_STATUS (AE_OK);
534 }
535 
536 ACPI_EXPORT_SYMBOL (AcpiGetEventStatus)
537 
538 #endif /* !ACPI_REDUCED_HARDWARE */
539