1 /****************************************************************************** 2 * 3 * Module Name: hwacpi - ACPI Hardware Initialization/Mode Interface 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2023, 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 #include <contrib/dev/acpica/include/acpi.h> 153 #include <contrib/dev/acpica/include/accommon.h> 154 155 156 #define _COMPONENT ACPI_HARDWARE 157 ACPI_MODULE_NAME ("hwacpi") 158 159 160 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */ 161 /****************************************************************************** 162 * 163 * FUNCTION: AcpiHwSetMode 164 * 165 * PARAMETERS: Mode - SYS_MODE_ACPI or SYS_MODE_LEGACY 166 * 167 * RETURN: Status 168 * 169 * DESCRIPTION: Transitions the system into the requested mode. 170 * 171 ******************************************************************************/ 172 173 ACPI_STATUS 174 AcpiHwSetMode ( 175 UINT32 Mode) 176 { 177 178 ACPI_STATUS Status; 179 UINT32 Retry; 180 181 182 ACPI_FUNCTION_TRACE (HwSetMode); 183 184 185 /* If the Hardware Reduced flag is set, machine is always in acpi mode */ 186 187 if (AcpiGbl_ReducedHardware) 188 { 189 return_ACPI_STATUS (AE_OK); 190 } 191 192 /* 193 * ACPI 2.0 clarified that if SMI_CMD in FADT is zero, 194 * system does not support mode transition. 195 */ 196 if (!AcpiGbl_FADT.SmiCommand) 197 { 198 ACPI_ERROR ((AE_INFO, "No SMI_CMD in FADT, mode transition failed")); 199 return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE); 200 } 201 202 /* 203 * ACPI 2.0 clarified the meaning of ACPI_ENABLE and ACPI_DISABLE 204 * in FADT: If it is zero, enabling or disabling is not supported. 205 * As old systems may have used zero for mode transition, 206 * we make sure both the numbers are zero to determine these 207 * transitions are not supported. 208 */ 209 if (!AcpiGbl_FADT.AcpiEnable && !AcpiGbl_FADT.AcpiDisable) 210 { 211 ACPI_ERROR ((AE_INFO, 212 "No ACPI mode transition supported in this system " 213 "(enable/disable both zero)")); 214 return_ACPI_STATUS (AE_OK); 215 } 216 217 switch (Mode) 218 { 219 case ACPI_SYS_MODE_ACPI: 220 221 /* BIOS should have disabled ALL fixed and GP events */ 222 223 Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand, 224 (UINT32) AcpiGbl_FADT.AcpiEnable, 8); 225 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Attempting to enable ACPI mode\n")); 226 break; 227 228 case ACPI_SYS_MODE_LEGACY: 229 /* 230 * BIOS should clear all fixed status bits and restore fixed event 231 * enable bits to default 232 */ 233 Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand, 234 (UINT32) AcpiGbl_FADT.AcpiDisable, 8); 235 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 236 "Attempting to enable Legacy (non-ACPI) mode\n")); 237 break; 238 239 default: 240 241 return_ACPI_STATUS (AE_BAD_PARAMETER); 242 } 243 244 if (ACPI_FAILURE (Status)) 245 { 246 ACPI_EXCEPTION ((AE_INFO, Status, 247 "Could not write ACPI mode change")); 248 return_ACPI_STATUS (Status); 249 } 250 251 /* 252 * Some hardware takes a LONG time to switch modes. Give them 3 sec to 253 * do so, but allow faster systems to proceed more quickly. 254 */ 255 Retry = 3000; 256 while (Retry) 257 { 258 if (AcpiHwGetMode () == Mode) 259 { 260 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 261 "Mode %X successfully enabled\n", Mode)); 262 return_ACPI_STATUS (AE_OK); 263 } 264 AcpiOsStall (ACPI_USEC_PER_MSEC); 265 Retry--; 266 } 267 268 ACPI_ERROR ((AE_INFO, "Hardware did not change modes")); 269 return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE); 270 } 271 272 273 /******************************************************************************* 274 * 275 * FUNCTION: AcpiHwGetMode 276 * 277 * PARAMETERS: none 278 * 279 * RETURN: SYS_MODE_ACPI or SYS_MODE_LEGACY 280 * 281 * DESCRIPTION: Return current operating state of system. Determined by 282 * querying the SCI_EN bit. 283 * 284 ******************************************************************************/ 285 286 UINT32 287 AcpiHwGetMode ( 288 void) 289 { 290 ACPI_STATUS Status; 291 UINT32 Value; 292 293 294 ACPI_FUNCTION_TRACE (HwGetMode); 295 296 297 /* If the Hardware Reduced flag is set, machine is always in acpi mode */ 298 299 if (AcpiGbl_ReducedHardware) 300 { 301 return_UINT32 (ACPI_SYS_MODE_ACPI); 302 } 303 304 /* 305 * ACPI 2.0 clarified that if SMI_CMD in FADT is zero, 306 * system does not support mode transition. 307 */ 308 if (!AcpiGbl_FADT.SmiCommand) 309 { 310 return_UINT32 (ACPI_SYS_MODE_ACPI); 311 } 312 313 Status = AcpiReadBitRegister (ACPI_BITREG_SCI_ENABLE, &Value); 314 if (ACPI_FAILURE (Status)) 315 { 316 return_UINT32 (ACPI_SYS_MODE_LEGACY); 317 } 318 319 if (Value) 320 { 321 return_UINT32 (ACPI_SYS_MODE_ACPI); 322 } 323 else 324 { 325 return_UINT32 (ACPI_SYS_MODE_LEGACY); 326 } 327 } 328 329 #endif /* !ACPI_REDUCED_HARDWARE */ 330