1a159c266SJung-uk Kim /****************************************************************************** 2a159c266SJung-uk Kim * 3a159c266SJung-uk Kim * Module Name: exmutex - ASL Mutex Acquire/Release functions 4a159c266SJung-uk Kim * 5a159c266SJung-uk Kim *****************************************************************************/ 6a159c266SJung-uk Kim 70d84335fSJung-uk Kim /****************************************************************************** 80d84335fSJung-uk Kim * 90d84335fSJung-uk Kim * 1. Copyright Notice 100d84335fSJung-uk Kim * 11*804fe266SJung-uk Kim * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp. 12a159c266SJung-uk Kim * All rights reserved. 13a159c266SJung-uk Kim * 140d84335fSJung-uk Kim * 2. License 150d84335fSJung-uk Kim * 160d84335fSJung-uk Kim * 2.1. This is your license from Intel Corp. under its intellectual property 170d84335fSJung-uk Kim * rights. You may have additional license terms from the party that provided 180d84335fSJung-uk Kim * you this software, covering your right to use that party's intellectual 190d84335fSJung-uk Kim * property rights. 200d84335fSJung-uk Kim * 210d84335fSJung-uk Kim * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 220d84335fSJung-uk Kim * copy of the source code appearing in this file ("Covered Code") an 230d84335fSJung-uk Kim * irrevocable, perpetual, worldwide license under Intel's copyrights in the 240d84335fSJung-uk Kim * base code distributed originally by Intel ("Original Intel Code") to copy, 250d84335fSJung-uk Kim * make derivatives, distribute, use and display any portion of the Covered 260d84335fSJung-uk Kim * Code in any form, with the right to sublicense such rights; and 270d84335fSJung-uk Kim * 280d84335fSJung-uk Kim * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 290d84335fSJung-uk Kim * license (with the right to sublicense), under only those claims of Intel 300d84335fSJung-uk Kim * patents that are infringed by the Original Intel Code, to make, use, sell, 310d84335fSJung-uk Kim * offer to sell, and import the Covered Code and derivative works thereof 320d84335fSJung-uk Kim * solely to the minimum extent necessary to exercise the above copyright 330d84335fSJung-uk Kim * license, and in no event shall the patent license extend to any additions 340d84335fSJung-uk Kim * to or modifications of the Original Intel Code. No other license or right 350d84335fSJung-uk Kim * is granted directly or by implication, estoppel or otherwise; 360d84335fSJung-uk Kim * 370d84335fSJung-uk Kim * The above copyright and patent license is granted only if the following 380d84335fSJung-uk Kim * conditions are met: 390d84335fSJung-uk Kim * 400d84335fSJung-uk Kim * 3. Conditions 410d84335fSJung-uk Kim * 420d84335fSJung-uk Kim * 3.1. Redistribution of Source with Rights to Further Distribute Source. 430d84335fSJung-uk Kim * Redistribution of source code of any substantial portion of the Covered 440d84335fSJung-uk Kim * Code or modification with rights to further distribute source must include 450d84335fSJung-uk Kim * the above Copyright Notice, the above License, this list of Conditions, 460d84335fSJung-uk Kim * and the following Disclaimer and Export Compliance provision. In addition, 470d84335fSJung-uk Kim * Licensee must cause all Covered Code to which Licensee contributes to 480d84335fSJung-uk Kim * contain a file documenting the changes Licensee made to create that Covered 490d84335fSJung-uk Kim * Code and the date of any change. Licensee must include in that file the 500d84335fSJung-uk Kim * documentation of any changes made by any predecessor Licensee. Licensee 510d84335fSJung-uk Kim * must include a prominent statement that the modification is derived, 520d84335fSJung-uk Kim * directly or indirectly, from Original Intel Code. 530d84335fSJung-uk Kim * 540d84335fSJung-uk Kim * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 550d84335fSJung-uk Kim * Redistribution of source code of any substantial portion of the Covered 560d84335fSJung-uk Kim * Code or modification without rights to further distribute source must 570d84335fSJung-uk Kim * include the following Disclaimer and Export Compliance provision in the 580d84335fSJung-uk Kim * documentation and/or other materials provided with distribution. In 590d84335fSJung-uk Kim * addition, Licensee may not authorize further sublicense of source of any 600d84335fSJung-uk Kim * portion of the Covered Code, and must include terms to the effect that the 610d84335fSJung-uk Kim * license from Licensee to its licensee is limited to the intellectual 620d84335fSJung-uk Kim * property embodied in the software Licensee provides to its licensee, and 630d84335fSJung-uk Kim * not to intellectual property embodied in modifications its licensee may 640d84335fSJung-uk Kim * make. 650d84335fSJung-uk Kim * 660d84335fSJung-uk Kim * 3.3. Redistribution of Executable. Redistribution in executable form of any 670d84335fSJung-uk Kim * substantial portion of the Covered Code or modification must reproduce the 680d84335fSJung-uk Kim * above Copyright Notice, and the following Disclaimer and Export Compliance 690d84335fSJung-uk Kim * provision in the documentation and/or other materials provided with the 700d84335fSJung-uk Kim * distribution. 710d84335fSJung-uk Kim * 720d84335fSJung-uk Kim * 3.4. Intel retains all right, title, and interest in and to the Original 730d84335fSJung-uk Kim * Intel Code. 740d84335fSJung-uk Kim * 750d84335fSJung-uk Kim * 3.5. Neither the name Intel nor any other trademark owned or controlled by 760d84335fSJung-uk Kim * Intel shall be used in advertising or otherwise to promote the sale, use or 770d84335fSJung-uk Kim * other dealings in products derived from or relating to the Covered Code 780d84335fSJung-uk Kim * without prior written authorization from Intel. 790d84335fSJung-uk Kim * 800d84335fSJung-uk Kim * 4. Disclaimer and Export Compliance 810d84335fSJung-uk Kim * 820d84335fSJung-uk Kim * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 830d84335fSJung-uk Kim * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 840d84335fSJung-uk Kim * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 850d84335fSJung-uk Kim * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 860d84335fSJung-uk Kim * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 870d84335fSJung-uk Kim * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 880d84335fSJung-uk Kim * PARTICULAR PURPOSE. 890d84335fSJung-uk Kim * 900d84335fSJung-uk Kim * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 910d84335fSJung-uk Kim * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 920d84335fSJung-uk Kim * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 930d84335fSJung-uk Kim * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 940d84335fSJung-uk Kim * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 950d84335fSJung-uk Kim * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 960d84335fSJung-uk Kim * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 970d84335fSJung-uk Kim * LIMITED REMEDY. 980d84335fSJung-uk Kim * 990d84335fSJung-uk Kim * 4.3. Licensee shall not export, either directly or indirectly, any of this 1000d84335fSJung-uk Kim * software or system incorporating such software without first obtaining any 1010d84335fSJung-uk Kim * required license or other approval from the U. S. Department of Commerce or 1020d84335fSJung-uk Kim * any other agency or department of the United States Government. In the 1030d84335fSJung-uk Kim * event Licensee exports any such software from the United States or 1040d84335fSJung-uk Kim * re-exports any such software from a foreign destination, Licensee shall 1050d84335fSJung-uk Kim * ensure that the distribution and export/re-export of the software is in 1060d84335fSJung-uk Kim * compliance with all laws, regulations, orders, or other restrictions of the 1070d84335fSJung-uk Kim * U.S. Export Administration Regulations. Licensee agrees that neither it nor 1080d84335fSJung-uk Kim * any of its subsidiaries will export/re-export any technical data, process, 1090d84335fSJung-uk Kim * software, or service, directly or indirectly, to any country for which the 1100d84335fSJung-uk Kim * United States government or any agency thereof requires an export license, 1110d84335fSJung-uk Kim * other governmental approval, or letter of assurance, without first obtaining 1120d84335fSJung-uk Kim * such license, approval or letter. 1130d84335fSJung-uk Kim * 1140d84335fSJung-uk Kim ***************************************************************************** 1150d84335fSJung-uk Kim * 1160d84335fSJung-uk Kim * Alternatively, you may choose to be licensed under the terms of the 1170d84335fSJung-uk Kim * following license: 1180d84335fSJung-uk Kim * 119a159c266SJung-uk Kim * Redistribution and use in source and binary forms, with or without 120a159c266SJung-uk Kim * modification, are permitted provided that the following conditions 121a159c266SJung-uk Kim * are met: 122a159c266SJung-uk Kim * 1. Redistributions of source code must retain the above copyright 123a159c266SJung-uk Kim * notice, this list of conditions, and the following disclaimer, 124a159c266SJung-uk Kim * without modification. 125a159c266SJung-uk Kim * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126a159c266SJung-uk Kim * substantially similar to the "NO WARRANTY" disclaimer below 127a159c266SJung-uk Kim * ("Disclaimer") and any redistribution must be conditioned upon 128a159c266SJung-uk Kim * including a substantially similar Disclaimer requirement for further 129a159c266SJung-uk Kim * binary redistribution. 130a159c266SJung-uk Kim * 3. Neither the names of the above-listed copyright holders nor the names 131a159c266SJung-uk Kim * of any contributors may be used to endorse or promote products derived 132a159c266SJung-uk Kim * from this software without specific prior written permission. 133a159c266SJung-uk Kim * 1340d84335fSJung-uk Kim * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1350d84335fSJung-uk Kim * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1360d84335fSJung-uk Kim * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1370d84335fSJung-uk Kim * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1380d84335fSJung-uk Kim * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 1390d84335fSJung-uk Kim * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 1400d84335fSJung-uk Kim * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 1410d84335fSJung-uk Kim * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 1420d84335fSJung-uk Kim * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 1430d84335fSJung-uk Kim * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 1440d84335fSJung-uk Kim * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 1450d84335fSJung-uk Kim * 1460d84335fSJung-uk Kim * Alternatively, you may choose to be licensed under the terms of the 147a159c266SJung-uk Kim * GNU General Public License ("GPL") version 2 as published by the Free 148a159c266SJung-uk Kim * Software Foundation. 149a159c266SJung-uk Kim * 1500d84335fSJung-uk Kim *****************************************************************************/ 151a159c266SJung-uk Kim 152a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acpi.h> 153a159c266SJung-uk Kim #include <contrib/dev/acpica/include/accommon.h> 154a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acinterp.h> 155a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acevents.h> 156a159c266SJung-uk Kim 157a159c266SJung-uk Kim #define _COMPONENT ACPI_EXECUTER 158a159c266SJung-uk Kim ACPI_MODULE_NAME ("exmutex") 159a159c266SJung-uk Kim 160a159c266SJung-uk Kim /* Local prototypes */ 161a159c266SJung-uk Kim 162a159c266SJung-uk Kim static void 163a159c266SJung-uk Kim AcpiExLinkMutex ( 164a159c266SJung-uk Kim ACPI_OPERAND_OBJECT *ObjDesc, 165a159c266SJung-uk Kim ACPI_THREAD_STATE *Thread); 166a159c266SJung-uk Kim 167a159c266SJung-uk Kim 168a159c266SJung-uk Kim /******************************************************************************* 169a159c266SJung-uk Kim * 170a159c266SJung-uk Kim * FUNCTION: AcpiExUnlinkMutex 171a159c266SJung-uk Kim * 172a159c266SJung-uk Kim * PARAMETERS: ObjDesc - The mutex to be unlinked 173a159c266SJung-uk Kim * 174a159c266SJung-uk Kim * RETURN: None 175a159c266SJung-uk Kim * 176a159c266SJung-uk Kim * DESCRIPTION: Remove a mutex from the "AcquiredMutex" list 177a159c266SJung-uk Kim * 178a159c266SJung-uk Kim ******************************************************************************/ 179a159c266SJung-uk Kim 180a159c266SJung-uk Kim void 181a159c266SJung-uk Kim AcpiExUnlinkMutex ( 182a159c266SJung-uk Kim ACPI_OPERAND_OBJECT *ObjDesc) 183a159c266SJung-uk Kim { 184a159c266SJung-uk Kim ACPI_THREAD_STATE *Thread = ObjDesc->Mutex.OwnerThread; 185a159c266SJung-uk Kim 186a159c266SJung-uk Kim 187a159c266SJung-uk Kim if (!Thread) 188a159c266SJung-uk Kim { 189a159c266SJung-uk Kim return; 190a159c266SJung-uk Kim } 191a159c266SJung-uk Kim 192a159c266SJung-uk Kim /* Doubly linked list */ 193a159c266SJung-uk Kim 194a159c266SJung-uk Kim if (ObjDesc->Mutex.Next) 195a159c266SJung-uk Kim { 196a159c266SJung-uk Kim (ObjDesc->Mutex.Next)->Mutex.Prev = ObjDesc->Mutex.Prev; 197a159c266SJung-uk Kim } 198a159c266SJung-uk Kim 199a159c266SJung-uk Kim if (ObjDesc->Mutex.Prev) 200a159c266SJung-uk Kim { 201a159c266SJung-uk Kim (ObjDesc->Mutex.Prev)->Mutex.Next = ObjDesc->Mutex.Next; 202a159c266SJung-uk Kim 203a159c266SJung-uk Kim /* 204a159c266SJung-uk Kim * Migrate the previous sync level associated with this mutex to 205a159c266SJung-uk Kim * the previous mutex on the list so that it may be preserved. 206a159c266SJung-uk Kim * This handles the case where several mutexes have been acquired 207a159c266SJung-uk Kim * at the same level, but are not released in opposite order. 208a159c266SJung-uk Kim */ 209a159c266SJung-uk Kim (ObjDesc->Mutex.Prev)->Mutex.OriginalSyncLevel = 210a159c266SJung-uk Kim ObjDesc->Mutex.OriginalSyncLevel; 211a159c266SJung-uk Kim } 212a159c266SJung-uk Kim else 213a159c266SJung-uk Kim { 214a159c266SJung-uk Kim Thread->AcquiredMutexList = ObjDesc->Mutex.Next; 215a159c266SJung-uk Kim } 216a159c266SJung-uk Kim } 217a159c266SJung-uk Kim 218a159c266SJung-uk Kim 219a159c266SJung-uk Kim /******************************************************************************* 220a159c266SJung-uk Kim * 221a159c266SJung-uk Kim * FUNCTION: AcpiExLinkMutex 222a159c266SJung-uk Kim * 223a159c266SJung-uk Kim * PARAMETERS: ObjDesc - The mutex to be linked 224a159c266SJung-uk Kim * Thread - Current executing thread object 225a159c266SJung-uk Kim * 226a159c266SJung-uk Kim * RETURN: None 227a159c266SJung-uk Kim * 228a159c266SJung-uk Kim * DESCRIPTION: Add a mutex to the "AcquiredMutex" list for this walk 229a159c266SJung-uk Kim * 230a159c266SJung-uk Kim ******************************************************************************/ 231a159c266SJung-uk Kim 232a159c266SJung-uk Kim static void 233a159c266SJung-uk Kim AcpiExLinkMutex ( 234a159c266SJung-uk Kim ACPI_OPERAND_OBJECT *ObjDesc, 235a159c266SJung-uk Kim ACPI_THREAD_STATE *Thread) 236a159c266SJung-uk Kim { 237a159c266SJung-uk Kim ACPI_OPERAND_OBJECT *ListHead; 238a159c266SJung-uk Kim 239a159c266SJung-uk Kim 240a159c266SJung-uk Kim ListHead = Thread->AcquiredMutexList; 241a159c266SJung-uk Kim 242a159c266SJung-uk Kim /* This object will be the first object in the list */ 243a159c266SJung-uk Kim 244a159c266SJung-uk Kim ObjDesc->Mutex.Prev = NULL; 245a159c266SJung-uk Kim ObjDesc->Mutex.Next = ListHead; 246a159c266SJung-uk Kim 247a159c266SJung-uk Kim /* Update old first object to point back to this object */ 248a159c266SJung-uk Kim 249a159c266SJung-uk Kim if (ListHead) 250a159c266SJung-uk Kim { 251a159c266SJung-uk Kim ListHead->Mutex.Prev = ObjDesc; 252a159c266SJung-uk Kim } 253a159c266SJung-uk Kim 254a159c266SJung-uk Kim /* Update list head */ 255a159c266SJung-uk Kim 256a159c266SJung-uk Kim Thread->AcquiredMutexList = ObjDesc; 257a159c266SJung-uk Kim } 258a159c266SJung-uk Kim 259a159c266SJung-uk Kim 260a159c266SJung-uk Kim /******************************************************************************* 261a159c266SJung-uk Kim * 262a159c266SJung-uk Kim * FUNCTION: AcpiExAcquireMutexObject 263a159c266SJung-uk Kim * 264a159c266SJung-uk Kim * PARAMETERS: Timeout - Timeout in milliseconds 265a159c266SJung-uk Kim * ObjDesc - Mutex object 266a159c266SJung-uk Kim * ThreadId - Current thread state 267a159c266SJung-uk Kim * 268a159c266SJung-uk Kim * RETURN: Status 269a159c266SJung-uk Kim * 270a159c266SJung-uk Kim * DESCRIPTION: Acquire an AML mutex, low-level interface. Provides a common 271a159c266SJung-uk Kim * path that supports multiple acquires by the same thread. 272a159c266SJung-uk Kim * 273a159c266SJung-uk Kim * MUTEX: Interpreter must be locked 274a159c266SJung-uk Kim * 275a159c266SJung-uk Kim * NOTE: This interface is called from three places: 276a159c266SJung-uk Kim * 1) From AcpiExAcquireMutex, via an AML Acquire() operator 277a159c266SJung-uk Kim * 2) From AcpiExAcquireGlobalLock when an AML Field access requires the 278a159c266SJung-uk Kim * global lock 279a159c266SJung-uk Kim * 3) From the external interface, AcpiAcquireGlobalLock 280a159c266SJung-uk Kim * 281a159c266SJung-uk Kim ******************************************************************************/ 282a159c266SJung-uk Kim 283a159c266SJung-uk Kim ACPI_STATUS 284a159c266SJung-uk Kim AcpiExAcquireMutexObject ( 285a159c266SJung-uk Kim UINT16 Timeout, 286a159c266SJung-uk Kim ACPI_OPERAND_OBJECT *ObjDesc, 287a159c266SJung-uk Kim ACPI_THREAD_ID ThreadId) 288a159c266SJung-uk Kim { 289a159c266SJung-uk Kim ACPI_STATUS Status; 290a159c266SJung-uk Kim 291a159c266SJung-uk Kim 292a159c266SJung-uk Kim ACPI_FUNCTION_TRACE_PTR (ExAcquireMutexObject, ObjDesc); 293a159c266SJung-uk Kim 294a159c266SJung-uk Kim 295a159c266SJung-uk Kim if (!ObjDesc) 296a159c266SJung-uk Kim { 297a159c266SJung-uk Kim return_ACPI_STATUS (AE_BAD_PARAMETER); 298a159c266SJung-uk Kim } 299a159c266SJung-uk Kim 300a159c266SJung-uk Kim /* Support for multiple acquires by the owning thread */ 301a159c266SJung-uk Kim 302a159c266SJung-uk Kim if (ObjDesc->Mutex.ThreadId == ThreadId) 303a159c266SJung-uk Kim { 304a159c266SJung-uk Kim /* 305a159c266SJung-uk Kim * The mutex is already owned by this thread, just increment the 306a159c266SJung-uk Kim * acquisition depth 307a159c266SJung-uk Kim */ 308a159c266SJung-uk Kim ObjDesc->Mutex.AcquisitionDepth++; 309a159c266SJung-uk Kim return_ACPI_STATUS (AE_OK); 310a159c266SJung-uk Kim } 311a159c266SJung-uk Kim 312a159c266SJung-uk Kim /* Acquire the mutex, wait if necessary. Special case for Global Lock */ 313a159c266SJung-uk Kim 314a159c266SJung-uk Kim if (ObjDesc == AcpiGbl_GlobalLockMutex) 315a159c266SJung-uk Kim { 316a159c266SJung-uk Kim Status = AcpiEvAcquireGlobalLock (Timeout); 317a159c266SJung-uk Kim } 318a159c266SJung-uk Kim else 319a159c266SJung-uk Kim { 320f8146b88SJung-uk Kim Status = AcpiExSystemWaitMutex (ObjDesc->Mutex.OsMutex, Timeout); 321a159c266SJung-uk Kim } 322a159c266SJung-uk Kim 323a159c266SJung-uk Kim if (ACPI_FAILURE (Status)) 324a159c266SJung-uk Kim { 325a159c266SJung-uk Kim /* Includes failure from a timeout on TimeDesc */ 326a159c266SJung-uk Kim 327a159c266SJung-uk Kim return_ACPI_STATUS (Status); 328a159c266SJung-uk Kim } 329a159c266SJung-uk Kim 330a159c266SJung-uk Kim /* Acquired the mutex: update mutex object */ 331a159c266SJung-uk Kim 332a159c266SJung-uk Kim ObjDesc->Mutex.ThreadId = ThreadId; 333a159c266SJung-uk Kim ObjDesc->Mutex.AcquisitionDepth = 1; 334a159c266SJung-uk Kim ObjDesc->Mutex.OriginalSyncLevel = 0; 335a159c266SJung-uk Kim ObjDesc->Mutex.OwnerThread = NULL; /* Used only for AML Acquire() */ 336a159c266SJung-uk Kim 337a159c266SJung-uk Kim return_ACPI_STATUS (AE_OK); 338a159c266SJung-uk Kim } 339a159c266SJung-uk Kim 340a159c266SJung-uk Kim 341a159c266SJung-uk Kim /******************************************************************************* 342a159c266SJung-uk Kim * 343a159c266SJung-uk Kim * FUNCTION: AcpiExAcquireMutex 344a159c266SJung-uk Kim * 345a159c266SJung-uk Kim * PARAMETERS: TimeDesc - Timeout integer 346a159c266SJung-uk Kim * ObjDesc - Mutex object 347a159c266SJung-uk Kim * WalkState - Current method execution state 348a159c266SJung-uk Kim * 349a159c266SJung-uk Kim * RETURN: Status 350a159c266SJung-uk Kim * 351a159c266SJung-uk Kim * DESCRIPTION: Acquire an AML mutex 352a159c266SJung-uk Kim * 353a159c266SJung-uk Kim ******************************************************************************/ 354a159c266SJung-uk Kim 355a159c266SJung-uk Kim ACPI_STATUS 356a159c266SJung-uk Kim AcpiExAcquireMutex ( 357a159c266SJung-uk Kim ACPI_OPERAND_OBJECT *TimeDesc, 358a159c266SJung-uk Kim ACPI_OPERAND_OBJECT *ObjDesc, 359a159c266SJung-uk Kim ACPI_WALK_STATE *WalkState) 360a159c266SJung-uk Kim { 361a159c266SJung-uk Kim ACPI_STATUS Status; 362a159c266SJung-uk Kim 363a159c266SJung-uk Kim 364a159c266SJung-uk Kim ACPI_FUNCTION_TRACE_PTR (ExAcquireMutex, ObjDesc); 365a159c266SJung-uk Kim 366a159c266SJung-uk Kim 367a159c266SJung-uk Kim if (!ObjDesc) 368a159c266SJung-uk Kim { 369a159c266SJung-uk Kim return_ACPI_STATUS (AE_BAD_PARAMETER); 370a159c266SJung-uk Kim } 371a159c266SJung-uk Kim 372a159c266SJung-uk Kim /* Must have a valid thread state struct */ 373a159c266SJung-uk Kim 374a159c266SJung-uk Kim if (!WalkState->Thread) 375a159c266SJung-uk Kim { 376a159c266SJung-uk Kim ACPI_ERROR ((AE_INFO, 377a159c266SJung-uk Kim "Cannot acquire Mutex [%4.4s], null thread info", 378a159c266SJung-uk Kim AcpiUtGetNodeName (ObjDesc->Mutex.Node))); 379a159c266SJung-uk Kim return_ACPI_STATUS (AE_AML_INTERNAL); 380a159c266SJung-uk Kim } 381a159c266SJung-uk Kim 382a159c266SJung-uk Kim /* 383f8146b88SJung-uk Kim * Current sync level must be less than or equal to the sync level 384f8146b88SJung-uk Kim * of the mutex. This mechanism provides some deadlock prevention. 385a159c266SJung-uk Kim */ 386a159c266SJung-uk Kim if (WalkState->Thread->CurrentSyncLevel > ObjDesc->Mutex.SyncLevel) 387a159c266SJung-uk Kim { 388a159c266SJung-uk Kim ACPI_ERROR ((AE_INFO, 389f8146b88SJung-uk Kim "Cannot acquire Mutex [%4.4s], " 390f8146b88SJung-uk Kim "current SyncLevel is too large (%u)", 391a159c266SJung-uk Kim AcpiUtGetNodeName (ObjDesc->Mutex.Node), 392a159c266SJung-uk Kim WalkState->Thread->CurrentSyncLevel)); 393a159c266SJung-uk Kim return_ACPI_STATUS (AE_AML_MUTEX_ORDER); 394a159c266SJung-uk Kim } 395a159c266SJung-uk Kim 396f8146b88SJung-uk Kim ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 397f8146b88SJung-uk Kim "Acquiring: Mutex SyncLevel %u, Thread SyncLevel %u, " 398f8146b88SJung-uk Kim "Depth %u TID %p\n", 399f8146b88SJung-uk Kim ObjDesc->Mutex.SyncLevel, WalkState->Thread->CurrentSyncLevel, 400f8146b88SJung-uk Kim ObjDesc->Mutex.AcquisitionDepth, WalkState->Thread)); 401f8146b88SJung-uk Kim 402a159c266SJung-uk Kim Status = AcpiExAcquireMutexObject ((UINT16) TimeDesc->Integer.Value, 403a159c266SJung-uk Kim ObjDesc, WalkState->Thread->ThreadId); 404f8146b88SJung-uk Kim 405a159c266SJung-uk Kim if (ACPI_SUCCESS (Status) && ObjDesc->Mutex.AcquisitionDepth == 1) 406a159c266SJung-uk Kim { 407a159c266SJung-uk Kim /* Save Thread object, original/current sync levels */ 408a159c266SJung-uk Kim 409a159c266SJung-uk Kim ObjDesc->Mutex.OwnerThread = WalkState->Thread; 410f8146b88SJung-uk Kim ObjDesc->Mutex.OriginalSyncLevel = 411f8146b88SJung-uk Kim WalkState->Thread->CurrentSyncLevel; 412f8146b88SJung-uk Kim WalkState->Thread->CurrentSyncLevel = 413f8146b88SJung-uk Kim ObjDesc->Mutex.SyncLevel; 414a159c266SJung-uk Kim 415a159c266SJung-uk Kim /* Link the mutex to the current thread for force-unlock at method exit */ 416a159c266SJung-uk Kim 417a159c266SJung-uk Kim AcpiExLinkMutex (ObjDesc, WalkState->Thread); 418a159c266SJung-uk Kim } 419a159c266SJung-uk Kim 420f8146b88SJung-uk Kim ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 421f8146b88SJung-uk Kim "Acquired: Mutex SyncLevel %u, Thread SyncLevel %u, Depth %u\n", 422f8146b88SJung-uk Kim ObjDesc->Mutex.SyncLevel, WalkState->Thread->CurrentSyncLevel, 423f8146b88SJung-uk Kim ObjDesc->Mutex.AcquisitionDepth)); 424f8146b88SJung-uk Kim 425a159c266SJung-uk Kim return_ACPI_STATUS (Status); 426a159c266SJung-uk Kim } 427a159c266SJung-uk Kim 428a159c266SJung-uk Kim 429a159c266SJung-uk Kim /******************************************************************************* 430a159c266SJung-uk Kim * 431a159c266SJung-uk Kim * FUNCTION: AcpiExReleaseMutexObject 432a159c266SJung-uk Kim * 433a159c266SJung-uk Kim * PARAMETERS: ObjDesc - The object descriptor for this op 434a159c266SJung-uk Kim * 435a159c266SJung-uk Kim * RETURN: Status 436a159c266SJung-uk Kim * 437a159c266SJung-uk Kim * DESCRIPTION: Release a previously acquired Mutex, low level interface. 438a159c266SJung-uk Kim * Provides a common path that supports multiple releases (after 439a159c266SJung-uk Kim * previous multiple acquires) by the same thread. 440a159c266SJung-uk Kim * 441a159c266SJung-uk Kim * MUTEX: Interpreter must be locked 442a159c266SJung-uk Kim * 443a159c266SJung-uk Kim * NOTE: This interface is called from three places: 444a159c266SJung-uk Kim * 1) From AcpiExReleaseMutex, via an AML Acquire() operator 445a159c266SJung-uk Kim * 2) From AcpiExReleaseGlobalLock when an AML Field access requires the 446a159c266SJung-uk Kim * global lock 447a159c266SJung-uk Kim * 3) From the external interface, AcpiReleaseGlobalLock 448a159c266SJung-uk Kim * 449a159c266SJung-uk Kim ******************************************************************************/ 450a159c266SJung-uk Kim 451a159c266SJung-uk Kim ACPI_STATUS 452a159c266SJung-uk Kim AcpiExReleaseMutexObject ( 453a159c266SJung-uk Kim ACPI_OPERAND_OBJECT *ObjDesc) 454a159c266SJung-uk Kim { 455a159c266SJung-uk Kim ACPI_STATUS Status = AE_OK; 456a159c266SJung-uk Kim 457a159c266SJung-uk Kim 458a159c266SJung-uk Kim ACPI_FUNCTION_TRACE (ExReleaseMutexObject); 459a159c266SJung-uk Kim 460a159c266SJung-uk Kim 461a159c266SJung-uk Kim if (ObjDesc->Mutex.AcquisitionDepth == 0) 462a159c266SJung-uk Kim { 4638ef1a331SJung-uk Kim return_ACPI_STATUS (AE_NOT_ACQUIRED); 464a159c266SJung-uk Kim } 465a159c266SJung-uk Kim 466a159c266SJung-uk Kim /* Match multiple Acquires with multiple Releases */ 467a159c266SJung-uk Kim 468a159c266SJung-uk Kim ObjDesc->Mutex.AcquisitionDepth--; 469a159c266SJung-uk Kim if (ObjDesc->Mutex.AcquisitionDepth != 0) 470a159c266SJung-uk Kim { 471a159c266SJung-uk Kim /* Just decrement the depth and return */ 472a159c266SJung-uk Kim 473a159c266SJung-uk Kim return_ACPI_STATUS (AE_OK); 474a159c266SJung-uk Kim } 475a159c266SJung-uk Kim 476a159c266SJung-uk Kim if (ObjDesc->Mutex.OwnerThread) 477a159c266SJung-uk Kim { 478a159c266SJung-uk Kim /* Unlink the mutex from the owner's list */ 479a159c266SJung-uk Kim 480a159c266SJung-uk Kim AcpiExUnlinkMutex (ObjDesc); 481a159c266SJung-uk Kim ObjDesc->Mutex.OwnerThread = NULL; 482a159c266SJung-uk Kim } 483a159c266SJung-uk Kim 484a159c266SJung-uk Kim /* Release the mutex, special case for Global Lock */ 485a159c266SJung-uk Kim 486a159c266SJung-uk Kim if (ObjDesc == AcpiGbl_GlobalLockMutex) 487a159c266SJung-uk Kim { 488a159c266SJung-uk Kim Status = AcpiEvReleaseGlobalLock (); 489a159c266SJung-uk Kim } 490a159c266SJung-uk Kim else 491a159c266SJung-uk Kim { 492a159c266SJung-uk Kim AcpiOsReleaseMutex (ObjDesc->Mutex.OsMutex); 493a159c266SJung-uk Kim } 494a159c266SJung-uk Kim 495a159c266SJung-uk Kim /* Clear mutex info */ 496a159c266SJung-uk Kim 497a159c266SJung-uk Kim ObjDesc->Mutex.ThreadId = 0; 498a159c266SJung-uk Kim return_ACPI_STATUS (Status); 499a159c266SJung-uk Kim } 500a159c266SJung-uk Kim 501a159c266SJung-uk Kim 502a159c266SJung-uk Kim /******************************************************************************* 503a159c266SJung-uk Kim * 504a159c266SJung-uk Kim * FUNCTION: AcpiExReleaseMutex 505a159c266SJung-uk Kim * 506a159c266SJung-uk Kim * PARAMETERS: ObjDesc - The object descriptor for this op 507a159c266SJung-uk Kim * WalkState - Current method execution state 508a159c266SJung-uk Kim * 509a159c266SJung-uk Kim * RETURN: Status 510a159c266SJung-uk Kim * 511a159c266SJung-uk Kim * DESCRIPTION: Release a previously acquired Mutex. 512a159c266SJung-uk Kim * 513a159c266SJung-uk Kim ******************************************************************************/ 514a159c266SJung-uk Kim 515a159c266SJung-uk Kim ACPI_STATUS 516a159c266SJung-uk Kim AcpiExReleaseMutex ( 517a159c266SJung-uk Kim ACPI_OPERAND_OBJECT *ObjDesc, 518a159c266SJung-uk Kim ACPI_WALK_STATE *WalkState) 519a159c266SJung-uk Kim { 520a159c266SJung-uk Kim UINT8 PreviousSyncLevel; 521a159c266SJung-uk Kim ACPI_THREAD_STATE *OwnerThread; 522f8146b88SJung-uk Kim ACPI_STATUS Status = AE_OK; 523a159c266SJung-uk Kim 524a159c266SJung-uk Kim 525a159c266SJung-uk Kim ACPI_FUNCTION_TRACE (ExReleaseMutex); 526a159c266SJung-uk Kim 527a159c266SJung-uk Kim 528a159c266SJung-uk Kim if (!ObjDesc) 529a159c266SJung-uk Kim { 530a159c266SJung-uk Kim return_ACPI_STATUS (AE_BAD_PARAMETER); 531a159c266SJung-uk Kim } 532a159c266SJung-uk Kim 533a159c266SJung-uk Kim OwnerThread = ObjDesc->Mutex.OwnerThread; 534a159c266SJung-uk Kim 535a159c266SJung-uk Kim /* The mutex must have been previously acquired in order to release it */ 536a159c266SJung-uk Kim 537a159c266SJung-uk Kim if (!OwnerThread) 538a159c266SJung-uk Kim { 539a159c266SJung-uk Kim ACPI_ERROR ((AE_INFO, 540a159c266SJung-uk Kim "Cannot release Mutex [%4.4s], not acquired", 541a159c266SJung-uk Kim AcpiUtGetNodeName (ObjDesc->Mutex.Node))); 542a159c266SJung-uk Kim return_ACPI_STATUS (AE_AML_MUTEX_NOT_ACQUIRED); 543a159c266SJung-uk Kim } 544a159c266SJung-uk Kim 545a159c266SJung-uk Kim /* Must have a valid thread ID */ 546a159c266SJung-uk Kim 547a159c266SJung-uk Kim if (!WalkState->Thread) 548a159c266SJung-uk Kim { 549a159c266SJung-uk Kim ACPI_ERROR ((AE_INFO, 550a159c266SJung-uk Kim "Cannot release Mutex [%4.4s], null thread info", 551a159c266SJung-uk Kim AcpiUtGetNodeName (ObjDesc->Mutex.Node))); 552a159c266SJung-uk Kim return_ACPI_STATUS (AE_AML_INTERNAL); 553a159c266SJung-uk Kim } 554a159c266SJung-uk Kim 555a159c266SJung-uk Kim /* 556a159c266SJung-uk Kim * The Mutex is owned, but this thread must be the owner. 557a159c266SJung-uk Kim * Special case for Global Lock, any thread can release 558a159c266SJung-uk Kim */ 559a159c266SJung-uk Kim if ((OwnerThread->ThreadId != WalkState->Thread->ThreadId) && 560a159c266SJung-uk Kim (ObjDesc != AcpiGbl_GlobalLockMutex)) 561a159c266SJung-uk Kim { 562a159c266SJung-uk Kim ACPI_ERROR ((AE_INFO, 563a159c266SJung-uk Kim "Thread %u cannot release Mutex [%4.4s] acquired by thread %u", 564a159c266SJung-uk Kim (UINT32) WalkState->Thread->ThreadId, 565a159c266SJung-uk Kim AcpiUtGetNodeName (ObjDesc->Mutex.Node), 566a159c266SJung-uk Kim (UINT32) OwnerThread->ThreadId)); 567a159c266SJung-uk Kim return_ACPI_STATUS (AE_AML_NOT_OWNER); 568a159c266SJung-uk Kim } 569a159c266SJung-uk Kim 570a159c266SJung-uk Kim /* 571a159c266SJung-uk Kim * The sync level of the mutex must be equal to the current sync level. In 572a159c266SJung-uk Kim * other words, the current level means that at least one mutex at that 573a159c266SJung-uk Kim * level is currently being held. Attempting to release a mutex of a 574a159c266SJung-uk Kim * different level can only mean that the mutex ordering rule is being 575a159c266SJung-uk Kim * violated. This behavior is clarified in ACPI 4.0 specification. 576a159c266SJung-uk Kim */ 577a159c266SJung-uk Kim if (ObjDesc->Mutex.SyncLevel != OwnerThread->CurrentSyncLevel) 578a159c266SJung-uk Kim { 579a159c266SJung-uk Kim ACPI_ERROR ((AE_INFO, 580f8146b88SJung-uk Kim "Cannot release Mutex [%4.4s], SyncLevel mismatch: " 581f8146b88SJung-uk Kim "mutex %u current %u", 582a159c266SJung-uk Kim AcpiUtGetNodeName (ObjDesc->Mutex.Node), 583a159c266SJung-uk Kim ObjDesc->Mutex.SyncLevel, WalkState->Thread->CurrentSyncLevel)); 584a159c266SJung-uk Kim return_ACPI_STATUS (AE_AML_MUTEX_ORDER); 585a159c266SJung-uk Kim } 586a159c266SJung-uk Kim 587a159c266SJung-uk Kim /* 588a159c266SJung-uk Kim * Get the previous SyncLevel from the head of the acquired mutex list. 589a159c266SJung-uk Kim * This handles the case where several mutexes at the same level have been 590a159c266SJung-uk Kim * acquired, but are not released in reverse order. 591a159c266SJung-uk Kim */ 592a159c266SJung-uk Kim PreviousSyncLevel = 593a159c266SJung-uk Kim OwnerThread->AcquiredMutexList->Mutex.OriginalSyncLevel; 594a159c266SJung-uk Kim 595f8146b88SJung-uk Kim ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 596f8146b88SJung-uk Kim "Releasing: Object SyncLevel %u, Thread SyncLevel %u, " 597f8146b88SJung-uk Kim "Prev SyncLevel %u, Depth %u TID %p\n", 598f8146b88SJung-uk Kim ObjDesc->Mutex.SyncLevel, WalkState->Thread->CurrentSyncLevel, 599f8146b88SJung-uk Kim PreviousSyncLevel, ObjDesc->Mutex.AcquisitionDepth, 600f8146b88SJung-uk Kim WalkState->Thread)); 601f8146b88SJung-uk Kim 602a159c266SJung-uk Kim Status = AcpiExReleaseMutexObject (ObjDesc); 603a159c266SJung-uk Kim if (ACPI_FAILURE (Status)) 604a159c266SJung-uk Kim { 605a159c266SJung-uk Kim return_ACPI_STATUS (Status); 606a159c266SJung-uk Kim } 607a159c266SJung-uk Kim 608a159c266SJung-uk Kim if (ObjDesc->Mutex.AcquisitionDepth == 0) 609a159c266SJung-uk Kim { 610a159c266SJung-uk Kim /* Restore the previous SyncLevel */ 611a159c266SJung-uk Kim 612a159c266SJung-uk Kim OwnerThread->CurrentSyncLevel = PreviousSyncLevel; 613a159c266SJung-uk Kim } 614a159c266SJung-uk Kim 615f8146b88SJung-uk Kim ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 616f8146b88SJung-uk Kim "Released: Object SyncLevel %u, Thread SyncLevel, %u, " 617f8146b88SJung-uk Kim "Prev SyncLevel %u, Depth %u\n", 618f8146b88SJung-uk Kim ObjDesc->Mutex.SyncLevel, WalkState->Thread->CurrentSyncLevel, 619f8146b88SJung-uk Kim PreviousSyncLevel, ObjDesc->Mutex.AcquisitionDepth)); 620f8146b88SJung-uk Kim 621a159c266SJung-uk Kim return_ACPI_STATUS (Status); 622a159c266SJung-uk Kim } 623a159c266SJung-uk Kim 624a159c266SJung-uk Kim 625a159c266SJung-uk Kim /******************************************************************************* 626a159c266SJung-uk Kim * 627a159c266SJung-uk Kim * FUNCTION: AcpiExReleaseAllMutexes 628a159c266SJung-uk Kim * 629a159c266SJung-uk Kim * PARAMETERS: Thread - Current executing thread object 630a159c266SJung-uk Kim * 631a159c266SJung-uk Kim * RETURN: Status 632a159c266SJung-uk Kim * 633a159c266SJung-uk Kim * DESCRIPTION: Release all mutexes held by this thread 634a159c266SJung-uk Kim * 635a159c266SJung-uk Kim * NOTE: This function is called as the thread is exiting the interpreter. 636a159c266SJung-uk Kim * Mutexes are not released when an individual control method is exited, but 637a159c266SJung-uk Kim * only when the parent thread actually exits the interpreter. This allows one 638a159c266SJung-uk Kim * method to acquire a mutex, and a different method to release it, as long as 639a159c266SJung-uk Kim * this is performed underneath a single parent control method. 640a159c266SJung-uk Kim * 641a159c266SJung-uk Kim ******************************************************************************/ 642a159c266SJung-uk Kim 643a159c266SJung-uk Kim void 644a159c266SJung-uk Kim AcpiExReleaseAllMutexes ( 645a159c266SJung-uk Kim ACPI_THREAD_STATE *Thread) 646a159c266SJung-uk Kim { 647a159c266SJung-uk Kim ACPI_OPERAND_OBJECT *Next = Thread->AcquiredMutexList; 648a159c266SJung-uk Kim ACPI_OPERAND_OBJECT *ObjDesc; 649a159c266SJung-uk Kim 650a159c266SJung-uk Kim 651f8146b88SJung-uk Kim ACPI_FUNCTION_TRACE (ExReleaseAllMutexes); 652a159c266SJung-uk Kim 653a159c266SJung-uk Kim 654a159c266SJung-uk Kim /* Traverse the list of owned mutexes, releasing each one */ 655a159c266SJung-uk Kim 656a159c266SJung-uk Kim while (Next) 657a159c266SJung-uk Kim { 658a159c266SJung-uk Kim ObjDesc = Next; 6598ef1a331SJung-uk Kim ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 660f8146b88SJung-uk Kim "Mutex [%4.4s] force-release, SyncLevel %u Depth %u\n", 661f8146b88SJung-uk Kim ObjDesc->Mutex.Node->Name.Ascii, ObjDesc->Mutex.SyncLevel, 662f8146b88SJung-uk Kim ObjDesc->Mutex.AcquisitionDepth)); 6638ef1a331SJung-uk Kim 664a159c266SJung-uk Kim /* Release the mutex, special case for Global Lock */ 665a159c266SJung-uk Kim 666a159c266SJung-uk Kim if (ObjDesc == AcpiGbl_GlobalLockMutex) 667a159c266SJung-uk Kim { 668a159c266SJung-uk Kim /* Ignore errors */ 669a159c266SJung-uk Kim 670a159c266SJung-uk Kim (void) AcpiEvReleaseGlobalLock (); 671a159c266SJung-uk Kim } 672a159c266SJung-uk Kim else 673a159c266SJung-uk Kim { 674a159c266SJung-uk Kim AcpiOsReleaseMutex (ObjDesc->Mutex.OsMutex); 675a159c266SJung-uk Kim } 676a159c266SJung-uk Kim 677a159c266SJung-uk Kim /* Update Thread SyncLevel (Last mutex is the important one) */ 678a159c266SJung-uk Kim 679a159c266SJung-uk Kim Thread->CurrentSyncLevel = ObjDesc->Mutex.OriginalSyncLevel; 680f8146b88SJung-uk Kim 681f8146b88SJung-uk Kim /* Mark mutex unowned */ 682f8146b88SJung-uk Kim 683f8146b88SJung-uk Kim Next = ObjDesc->Mutex.Next; 684f8146b88SJung-uk Kim 685f8146b88SJung-uk Kim ObjDesc->Mutex.Prev = NULL; 686f8146b88SJung-uk Kim ObjDesc->Mutex.Next = NULL; 687f8146b88SJung-uk Kim ObjDesc->Mutex.AcquisitionDepth = 0; 688f8146b88SJung-uk Kim ObjDesc->Mutex.OwnerThread = NULL; 689f8146b88SJung-uk Kim ObjDesc->Mutex.ThreadId = 0; 690a159c266SJung-uk Kim } 691f8146b88SJung-uk Kim 692f8146b88SJung-uk Kim return_VOID; 693a159c266SJung-uk Kim } 694