1 /****************************************************************************** 2 * 3 * Module Name: exsystem - Interface to OS services 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 #include <contrib/dev/acpica/include/acinterp.h> 155 156 #define _COMPONENT ACPI_EXECUTER 157 ACPI_MODULE_NAME ("exsystem") 158 159 160 /******************************************************************************* 161 * 162 * FUNCTION: AcpiExSystemWaitSemaphore 163 * 164 * PARAMETERS: Semaphore - Semaphore to wait on 165 * Timeout - Max time to wait 166 * 167 * RETURN: Status 168 * 169 * DESCRIPTION: Implements a semaphore wait with a check to see if the 170 * semaphore is available immediately. If it is not, the 171 * interpreter is released before waiting. 172 * 173 ******************************************************************************/ 174 175 ACPI_STATUS 176 AcpiExSystemWaitSemaphore ( 177 ACPI_SEMAPHORE Semaphore, 178 UINT16 Timeout) 179 { 180 ACPI_STATUS Status; 181 182 183 ACPI_FUNCTION_TRACE (ExSystemWaitSemaphore); 184 185 186 Status = AcpiOsWaitSemaphore (Semaphore, 1, ACPI_DO_NOT_WAIT); 187 if (ACPI_SUCCESS (Status)) 188 { 189 return_ACPI_STATUS (Status); 190 } 191 192 if (Status == AE_TIME) 193 { 194 /* We must wait, so unlock the interpreter */ 195 196 AcpiExExitInterpreter (); 197 Status = AcpiOsWaitSemaphore (Semaphore, 1, Timeout); 198 199 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 200 "*** Thread awake after blocking, %s\n", 201 AcpiFormatException (Status))); 202 203 /* Reacquire the interpreter */ 204 205 AcpiExEnterInterpreter (); 206 } 207 208 return_ACPI_STATUS (Status); 209 } 210 211 212 /******************************************************************************* 213 * 214 * FUNCTION: AcpiExSystemWaitMutex 215 * 216 * PARAMETERS: Mutex - Mutex to wait on 217 * Timeout - Max time to wait 218 * 219 * RETURN: Status 220 * 221 * DESCRIPTION: Implements a mutex wait with a check to see if the 222 * mutex is available immediately. If it is not, the 223 * interpreter is released before waiting. 224 * 225 ******************************************************************************/ 226 227 ACPI_STATUS 228 AcpiExSystemWaitMutex ( 229 ACPI_MUTEX Mutex, 230 UINT16 Timeout) 231 { 232 ACPI_STATUS Status; 233 234 235 ACPI_FUNCTION_TRACE (ExSystemWaitMutex); 236 237 238 Status = AcpiOsAcquireMutex (Mutex, ACPI_DO_NOT_WAIT); 239 if (ACPI_SUCCESS (Status)) 240 { 241 return_ACPI_STATUS (Status); 242 } 243 244 if (Status == AE_TIME) 245 { 246 /* We must wait, so unlock the interpreter */ 247 248 AcpiExExitInterpreter (); 249 Status = AcpiOsAcquireMutex (Mutex, Timeout); 250 251 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 252 "*** Thread awake after blocking, %s\n", 253 AcpiFormatException (Status))); 254 255 /* Reacquire the interpreter */ 256 257 AcpiExEnterInterpreter (); 258 } 259 260 return_ACPI_STATUS (Status); 261 } 262 263 264 /******************************************************************************* 265 * 266 * FUNCTION: AcpiExSystemDoStall 267 * 268 * PARAMETERS: HowLongUs - The amount of time to stall, 269 * in microseconds 270 * 271 * RETURN: Status 272 * 273 * DESCRIPTION: Suspend running thread for specified amount of time. 274 * Note: ACPI specification requires that Stall() does not 275 * relinquish the processor, and delays longer than 100 usec 276 * should use Sleep() instead. We allow stalls up to 255 usec 277 * for compatibility with other interpreters and existing BIOSs. 278 * 279 ******************************************************************************/ 280 281 ACPI_STATUS 282 AcpiExSystemDoStall ( 283 UINT32 HowLongUs) 284 { 285 ACPI_STATUS Status = AE_OK; 286 287 288 ACPI_FUNCTION_ENTRY (); 289 290 291 if (HowLongUs > 255) 292 { 293 /* 294 * Longer than 255 microseconds, this is an error 295 * 296 * (ACPI specifies 100 usec as max, but this gives some slack in 297 * order to support existing BIOSs) 298 */ 299 ACPI_ERROR ((AE_INFO, 300 "Time parameter is too large (%u)", HowLongUs)); 301 Status = AE_AML_OPERAND_VALUE; 302 } 303 else 304 { 305 if (HowLongUs > 100) 306 { 307 ACPI_WARNING ((AE_INFO, 308 "Time parameter %u us > 100 us violating ACPI spec, please fix the firmware.", HowLongUs)); 309 } 310 AcpiOsStall (HowLongUs); 311 } 312 313 return (Status); 314 } 315 316 317 /******************************************************************************* 318 * 319 * FUNCTION: AcpiExSystemDoSleep 320 * 321 * PARAMETERS: HowLongMs - The amount of time to sleep, 322 * in milliseconds 323 * 324 * RETURN: None 325 * 326 * DESCRIPTION: Sleep the running thread for specified amount of time. 327 * 328 ******************************************************************************/ 329 330 ACPI_STATUS 331 AcpiExSystemDoSleep ( 332 UINT64 HowLongMs) 333 { 334 ACPI_FUNCTION_ENTRY (); 335 336 337 /* Since this thread will sleep, we must release the interpreter */ 338 339 AcpiExExitInterpreter (); 340 341 /* 342 * For compatibility with other ACPI implementations and to prevent 343 * accidental deep sleeps, limit the sleep time to something reasonable. 344 */ 345 if (HowLongMs > ACPI_MAX_SLEEP) 346 { 347 HowLongMs = ACPI_MAX_SLEEP; 348 } 349 350 AcpiOsSleep (HowLongMs); 351 352 /* And now we must get the interpreter again */ 353 354 AcpiExEnterInterpreter (); 355 return (AE_OK); 356 } 357 358 359 /******************************************************************************* 360 * 361 * FUNCTION: AcpiExSystemSignalEvent 362 * 363 * PARAMETERS: ObjDesc - The object descriptor for this op 364 * 365 * RETURN: Status 366 * 367 * DESCRIPTION: Provides an access point to perform synchronization operations 368 * within the AML. 369 * 370 ******************************************************************************/ 371 372 ACPI_STATUS 373 AcpiExSystemSignalEvent ( 374 ACPI_OPERAND_OBJECT *ObjDesc) 375 { 376 ACPI_STATUS Status = AE_OK; 377 378 379 ACPI_FUNCTION_TRACE (ExSystemSignalEvent); 380 381 382 if (ObjDesc) 383 { 384 Status = AcpiOsSignalSemaphore (ObjDesc->Event.OsSemaphore, 1); 385 } 386 387 return_ACPI_STATUS (Status); 388 } 389 390 391 /******************************************************************************* 392 * 393 * FUNCTION: AcpiExSystemWaitEvent 394 * 395 * PARAMETERS: TimeDesc - The 'time to delay' object descriptor 396 * ObjDesc - The object descriptor for this op 397 * 398 * RETURN: Status 399 * 400 * DESCRIPTION: Provides an access point to perform synchronization operations 401 * within the AML. This operation is a request to wait for an 402 * event. 403 * 404 ******************************************************************************/ 405 406 ACPI_STATUS 407 AcpiExSystemWaitEvent ( 408 ACPI_OPERAND_OBJECT *TimeDesc, 409 ACPI_OPERAND_OBJECT *ObjDesc) 410 { 411 ACPI_STATUS Status = AE_OK; 412 413 414 ACPI_FUNCTION_TRACE (ExSystemWaitEvent); 415 416 417 if (ObjDesc) 418 { 419 Status = AcpiExSystemWaitSemaphore (ObjDesc->Event.OsSemaphore, 420 (UINT16) TimeDesc->Integer.Value); 421 } 422 423 return_ACPI_STATUS (Status); 424 } 425 426 427 /******************************************************************************* 428 * 429 * FUNCTION: AcpiExSystemResetEvent 430 * 431 * PARAMETERS: ObjDesc - The object descriptor for this op 432 * 433 * RETURN: Status 434 * 435 * DESCRIPTION: Reset an event to a known state. 436 * 437 ******************************************************************************/ 438 439 ACPI_STATUS 440 AcpiExSystemResetEvent ( 441 ACPI_OPERAND_OBJECT *ObjDesc) 442 { 443 ACPI_STATUS Status = AE_OK; 444 ACPI_SEMAPHORE TempSemaphore; 445 446 447 ACPI_FUNCTION_ENTRY (); 448 449 450 /* 451 * We are going to simply delete the existing semaphore and 452 * create a new one! 453 */ 454 Status = AcpiOsCreateSemaphore (ACPI_NO_UNIT_LIMIT, 0, &TempSemaphore); 455 if (ACPI_SUCCESS (Status)) 456 { 457 (void) AcpiOsDeleteSemaphore (ObjDesc->Event.OsSemaphore); 458 ObjDesc->Event.OsSemaphore = TempSemaphore; 459 } 460 461 return (Status); 462 } 463