xref: /titanic_41/usr/src/uts/intel/io/acpica/hardware/hwacpi.c (revision 9a0e82381c494d655823a54fc713a8c2a571131c)
1 
2 /******************************************************************************
3  *
4  * Module Name: hwacpi - ACPI Hardware Initialization/Mode Interface
5  *              $Revision: 1.79 $
6  *
7  *****************************************************************************/
8 
9 /******************************************************************************
10  *
11  * 1. Copyright Notice
12  *
13  * Some or all of this work - Copyright (c) 1999 - 2008, 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  * make.
67  *
68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
69  * substantial portion of the Covered Code or modification must reproduce the
70  * above Copyright Notice, and the following Disclaimer and Export Compliance
71  * provision in the documentation and/or other materials provided with the
72  * distribution.
73  *
74  * 3.4. Intel retains all right, title, and interest in and to the Original
75  * Intel Code.
76  *
77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78  * Intel shall be used in advertising or otherwise to promote the sale, use or
79  * other dealings in products derived from or relating to the Covered Code
80  * without prior written authorization from Intel.
81  *
82  * 4. Disclaimer and Export Compliance
83  *
84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90  * PARTICULAR PURPOSE.
91  *
92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99  * LIMITED REMEDY.
100  *
101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
102  * software or system incorporating such software without first obtaining any
103  * required license or other approval from the U. S. Department of Commerce or
104  * any other agency or department of the United States Government.  In the
105  * event Licensee exports any such software from the United States or
106  * re-exports any such software from a foreign destination, Licensee shall
107  * ensure that the distribution and export/re-export of the software is in
108  * compliance with all laws, regulations, orders, or other restrictions of the
109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110  * any of its subsidiaries will export/re-export any technical data, process,
111  * software, or service, directly or indirectly, to any country for which the
112  * United States government or any agency thereof requires an export license,
113  * other governmental approval, or letter of assurance, without first obtaining
114  * such license, approval or letter.
115  *
116  *****************************************************************************/
117 
118 #define __HWACPI_C__
119 
120 #include "acpi.h"
121 
122 
123 #define _COMPONENT          ACPI_HARDWARE
124         ACPI_MODULE_NAME    ("hwacpi")
125 
126 
127 /******************************************************************************
128  *
129  * FUNCTION:    AcpiHwSetMode
130  *
131  * PARAMETERS:  Mode            - SYS_MODE_ACPI or SYS_MODE_LEGACY
132  *
133  * RETURN:      Status
134  *
135  * DESCRIPTION: Transitions the system into the requested mode.
136  *
137  ******************************************************************************/
138 
139 ACPI_STATUS
140 AcpiHwSetMode (
141     UINT32                  Mode)
142 {
143 
144     ACPI_STATUS             Status;
145     UINT32                  Retry;
146 
147 
148     ACPI_FUNCTION_TRACE (HwSetMode);
149 
150     /*
151      * ACPI 2.0 clarified that if SMI_CMD in FADT is zero,
152      * system does not support mode transition.
153      */
154     if (!AcpiGbl_FADT.SmiCommand)
155     {
156         ACPI_ERROR ((AE_INFO, "No SMI_CMD in FADT, mode transition failed"));
157         return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
158     }
159 
160     /*
161      * ACPI 2.0 clarified the meaning of ACPI_ENABLE and ACPI_DISABLE
162      * in FADT: If it is zero, enabling or disabling is not supported.
163      * As old systems may have used zero for mode transition,
164      * we make sure both the numbers are zero to determine these
165      * transitions are not supported.
166      */
167     if (!AcpiGbl_FADT.AcpiEnable && !AcpiGbl_FADT.AcpiDisable)
168     {
169         ACPI_ERROR ((AE_INFO,
170             "No ACPI mode transition supported in this system (enable/disable both zero)"));
171         return_ACPI_STATUS (AE_OK);
172     }
173 
174     switch (Mode)
175     {
176     case ACPI_SYS_MODE_ACPI:
177 
178         /* BIOS should have disabled ALL fixed and GP events */
179 
180         Status = AcpiOsWritePort (AcpiGbl_FADT.SmiCommand,
181                         (UINT32) AcpiGbl_FADT.AcpiEnable, 8);
182         ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Attempting to enable ACPI mode\n"));
183         break;
184 
185     case ACPI_SYS_MODE_LEGACY:
186 
187         /*
188          * BIOS should clear all fixed status bits and restore fixed event
189          * enable bits to default
190          */
191         Status = AcpiOsWritePort (AcpiGbl_FADT.SmiCommand,
192                     (UINT32) AcpiGbl_FADT.AcpiDisable, 8);
193         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
194                     "Attempting to enable Legacy (non-ACPI) mode\n"));
195         break;
196 
197     default:
198         return_ACPI_STATUS (AE_BAD_PARAMETER);
199     }
200 
201     if (ACPI_FAILURE (Status))
202     {
203         ACPI_EXCEPTION ((AE_INFO, Status,
204             "Could not write ACPI mode change"));
205         return_ACPI_STATUS (Status);
206     }
207 
208     /*
209      * Some hardware takes a LONG time to switch modes. Give them 3 sec to
210      * do so, but allow faster systems to proceed more quickly.
211      */
212     Retry = 3000;
213     while (Retry)
214     {
215         if (AcpiHwGetMode() == Mode)
216         {
217             ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Mode %X successfully enabled\n",
218                 Mode));
219             return_ACPI_STATUS (AE_OK);
220         }
221         AcpiOsStall(1000);
222         Retry--;
223     }
224 
225     ACPI_ERROR ((AE_INFO, "Hardware did not change modes"));
226     return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
227 }
228 
229 
230 /*******************************************************************************
231  *
232  * FUNCTION:    AcpiHwGetMode
233  *
234  * PARAMETERS:  none
235  *
236  * RETURN:      SYS_MODE_ACPI or SYS_MODE_LEGACY
237  *
238  * DESCRIPTION: Return current operating state of system.  Determined by
239  *              querying the SCI_EN bit.
240  *
241  ******************************************************************************/
242 
243 UINT32
244 AcpiHwGetMode (
245     void)
246 {
247     ACPI_STATUS             Status;
248     UINT32                  Value;
249 
250 
251     ACPI_FUNCTION_TRACE (HwGetMode);
252 
253 
254     /*
255      * ACPI 2.0 clarified that if SMI_CMD in FADT is zero,
256      * system does not support mode transition.
257      */
258     if (!AcpiGbl_FADT.SmiCommand)
259     {
260         return_UINT32 (ACPI_SYS_MODE_ACPI);
261     }
262 
263     Status = AcpiGetRegister (ACPI_BITREG_SCI_ENABLE, &Value);
264     if (ACPI_FAILURE (Status))
265     {
266         return_UINT32 (ACPI_SYS_MODE_LEGACY);
267     }
268 
269     if (Value)
270     {
271         return_UINT32 (ACPI_SYS_MODE_ACPI);
272     }
273     else
274     {
275         return_UINT32 (ACPI_SYS_MODE_LEGACY);
276     }
277 }
278