xref: /freebsd/sys/contrib/dev/acpica/components/hardware/hwacpi.c (revision 147972555f2c70f64cc54182dc18326456e46b92)
1 
2 /******************************************************************************
3  *
4  * Module Name: hwacpi - ACPI Hardware Initialization/Mode Interface
5  *
6  *****************************************************************************/
7 
8 /*
9  * Copyright (C) 2000 - 2012, Intel Corp.
10  * All rights reserved.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions, and the following disclaimer,
17  *    without modification.
18  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19  *    substantially similar to the "NO WARRANTY" disclaimer below
20  *    ("Disclaimer") and any redistribution must be conditioned upon
21  *    including a substantially similar Disclaimer requirement for further
22  *    binary redistribution.
23  * 3. Neither the names of the above-listed copyright holders nor the names
24  *    of any contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * Alternatively, this software may be distributed under the terms of the
28  * GNU General Public License ("GPL") version 2 as published by the Free
29  * Software Foundation.
30  *
31  * NO WARRANTY
32  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42  * POSSIBILITY OF SUCH DAMAGES.
43  */
44 
45 #define __HWACPI_C__
46 
47 #include <contrib/dev/acpica/include/acpi.h>
48 #include <contrib/dev/acpica/include/accommon.h>
49 
50 
51 #define _COMPONENT          ACPI_HARDWARE
52         ACPI_MODULE_NAME    ("hwacpi")
53 
54 
55 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
56 /******************************************************************************
57  *
58  * FUNCTION:    AcpiHwSetMode
59  *
60  * PARAMETERS:  Mode            - SYS_MODE_ACPI or SYS_MODE_LEGACY
61  *
62  * RETURN:      Status
63  *
64  * DESCRIPTION: Transitions the system into the requested mode.
65  *
66  ******************************************************************************/
67 
68 ACPI_STATUS
69 AcpiHwSetMode (
70     UINT32                  Mode)
71 {
72 
73     ACPI_STATUS             Status;
74     UINT32                  Retry;
75 
76 
77     ACPI_FUNCTION_TRACE (HwSetMode);
78 
79     /*
80      * ACPI 2.0 clarified that if SMI_CMD in FADT is zero,
81      * system does not support mode transition.
82      */
83     if (!AcpiGbl_FADT.SmiCommand)
84     {
85         ACPI_ERROR ((AE_INFO, "No SMI_CMD in FADT, mode transition failed"));
86         return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
87     }
88 
89     /*
90      * ACPI 2.0 clarified the meaning of ACPI_ENABLE and ACPI_DISABLE
91      * in FADT: If it is zero, enabling or disabling is not supported.
92      * As old systems may have used zero for mode transition,
93      * we make sure both the numbers are zero to determine these
94      * transitions are not supported.
95      */
96     if (!AcpiGbl_FADT.AcpiEnable && !AcpiGbl_FADT.AcpiDisable)
97     {
98         ACPI_ERROR ((AE_INFO,
99             "No ACPI mode transition supported in this system "
100             "(enable/disable both zero)"));
101         return_ACPI_STATUS (AE_OK);
102     }
103 
104     switch (Mode)
105     {
106     case ACPI_SYS_MODE_ACPI:
107 
108         /* BIOS should have disabled ALL fixed and GP events */
109 
110         Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand,
111                         (UINT32) AcpiGbl_FADT.AcpiEnable, 8);
112         ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Attempting to enable ACPI mode\n"));
113         break;
114 
115     case ACPI_SYS_MODE_LEGACY:
116 
117         /*
118          * BIOS should clear all fixed status bits and restore fixed event
119          * enable bits to default
120          */
121         Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand,
122                     (UINT32) AcpiGbl_FADT.AcpiDisable, 8);
123         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
124                     "Attempting to enable Legacy (non-ACPI) mode\n"));
125         break;
126 
127     default:
128         return_ACPI_STATUS (AE_BAD_PARAMETER);
129     }
130 
131     if (ACPI_FAILURE (Status))
132     {
133         ACPI_EXCEPTION ((AE_INFO, Status,
134             "Could not write ACPI mode change"));
135         return_ACPI_STATUS (Status);
136     }
137 
138     /*
139      * Some hardware takes a LONG time to switch modes. Give them 3 sec to
140      * do so, but allow faster systems to proceed more quickly.
141      */
142     Retry = 3000;
143     while (Retry)
144     {
145         if (AcpiHwGetMode() == Mode)
146         {
147             ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Mode %X successfully enabled\n",
148                 Mode));
149             return_ACPI_STATUS (AE_OK);
150         }
151         AcpiOsStall(1000);
152         Retry--;
153     }
154 
155     ACPI_ERROR ((AE_INFO, "Hardware did not change modes"));
156     return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
157 }
158 
159 
160 /*******************************************************************************
161  *
162  * FUNCTION:    AcpiHwGetMode
163  *
164  * PARAMETERS:  none
165  *
166  * RETURN:      SYS_MODE_ACPI or SYS_MODE_LEGACY
167  *
168  * DESCRIPTION: Return current operating state of system.  Determined by
169  *              querying the SCI_EN bit.
170  *
171  ******************************************************************************/
172 
173 UINT32
174 AcpiHwGetMode (
175     void)
176 {
177     ACPI_STATUS             Status;
178     UINT32                  Value;
179 
180 
181     ACPI_FUNCTION_TRACE (HwGetMode);
182 
183 
184     /*
185      * ACPI 2.0 clarified that if SMI_CMD in FADT is zero,
186      * system does not support mode transition.
187      */
188     if (!AcpiGbl_FADT.SmiCommand)
189     {
190         return_UINT32 (ACPI_SYS_MODE_ACPI);
191     }
192 
193     Status = AcpiReadBitRegister (ACPI_BITREG_SCI_ENABLE, &Value);
194     if (ACPI_FAILURE (Status))
195     {
196         return_UINT32 (ACPI_SYS_MODE_LEGACY);
197     }
198 
199     if (Value)
200     {
201         return_UINT32 (ACPI_SYS_MODE_ACPI);
202     }
203     else
204     {
205         return_UINT32 (ACPI_SYS_MODE_LEGACY);
206     }
207 }
208 
209 #endif /* !ACPI_REDUCED_HARDWARE */
210