1450d6964Smyers /*******************************************************************************
2450d6964Smyers  *
3450d6964Smyers  * Module Name: utmutex - local mutex support
4450d6964Smyers  *
5450d6964Smyers  ******************************************************************************/
6450d6964Smyers 
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi  *
9*35786f68SRobert Mustacchi  * 1. Copyright Notice
10*35786f68SRobert Mustacchi  *
11*35786f68SRobert Mustacchi  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12450d6964Smyers  * All rights reserved.
13450d6964Smyers  *
14*35786f68SRobert Mustacchi  * 2. License
15*35786f68SRobert Mustacchi  *
16*35786f68SRobert Mustacchi  * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi  * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi  * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi  * property rights.
20*35786f68SRobert Mustacchi  *
21*35786f68SRobert Mustacchi  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi  * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi  * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi  * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi  * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi  *
28*35786f68SRobert Mustacchi  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi  * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi  * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi  * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi  * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi  * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi  * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi  * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi  *
37*35786f68SRobert Mustacchi  * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi  * conditions are met:
39*35786f68SRobert Mustacchi  *
40*35786f68SRobert Mustacchi  * 3. Conditions
41*35786f68SRobert Mustacchi  *
42*35786f68SRobert Mustacchi  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi  * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi  * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi  * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi  * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi  * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi  * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi  * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi  * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi  * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi  * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi  *
54*35786f68SRobert Mustacchi  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi  * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi  * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi  * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi  * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi  * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi  * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi  * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi  * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi  * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi  * make.
65*35786f68SRobert Mustacchi  *
66*35786f68SRobert Mustacchi  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi  * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi  * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi  * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi  * distribution.
71*35786f68SRobert Mustacchi  *
72*35786f68SRobert Mustacchi  * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi  * Intel Code.
74*35786f68SRobert Mustacchi  *
75*35786f68SRobert Mustacchi  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi  * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi  * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi  * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi  *
80*35786f68SRobert Mustacchi  * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi  *
82*35786f68SRobert Mustacchi  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi  * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi  *
90*35786f68SRobert Mustacchi  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi  * LIMITED REMEDY.
98*35786f68SRobert Mustacchi  *
99*35786f68SRobert Mustacchi  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi  * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi  * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi  * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi  * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi  * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi  * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi  * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi  * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi  * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi  * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi  * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi  * such license, approval or letter.
113*35786f68SRobert Mustacchi  *
114*35786f68SRobert Mustacchi  *****************************************************************************
115*35786f68SRobert Mustacchi  *
116*35786f68SRobert Mustacchi  * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi  * following license:
118*35786f68SRobert Mustacchi  *
11926f3cdf0SGordon Ross  * Redistribution and use in source and binary forms, with or without
12026f3cdf0SGordon Ross  * modification, are permitted provided that the following conditions
12126f3cdf0SGordon Ross  * are met:
12226f3cdf0SGordon Ross  * 1. Redistributions of source code must retain the above copyright
12326f3cdf0SGordon Ross  *    notice, this list of conditions, and the following disclaimer,
12426f3cdf0SGordon Ross  *    without modification.
12526f3cdf0SGordon Ross  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12626f3cdf0SGordon Ross  *    substantially similar to the "NO WARRANTY" disclaimer below
12726f3cdf0SGordon Ross  *    ("Disclaimer") and any redistribution must be conditioned upon
12826f3cdf0SGordon Ross  *    including a substantially similar Disclaimer requirement for further
12926f3cdf0SGordon Ross  *    binary redistribution.
13026f3cdf0SGordon Ross  * 3. Neither the names of the above-listed copyright holders nor the names
13126f3cdf0SGordon Ross  *    of any contributors may be used to endorse or promote products derived
13226f3cdf0SGordon Ross  *    from this software without specific prior written permission.
13326f3cdf0SGordon Ross  *
13426f3cdf0SGordon Ross  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13526f3cdf0SGordon Ross  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
13726f3cdf0SGordon Ross  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi  *
146*35786f68SRobert Mustacchi  * Alternatively, you may choose to be licensed under the terms of the
147*35786f68SRobert Mustacchi  * GNU General Public License ("GPL") version 2 as published by the Free
148*35786f68SRobert Mustacchi  * Software Foundation.
149*35786f68SRobert Mustacchi  *
150*35786f68SRobert Mustacchi  *****************************************************************************/
151450d6964Smyers 
152450d6964Smyers #include "acpi.h"
153aa2aa9a6SDana Myers #include "accommon.h"
154450d6964Smyers 
155450d6964Smyers #define _COMPONENT          ACPI_UTILITIES
156450d6964Smyers         ACPI_MODULE_NAME    ("utmutex")
157450d6964Smyers 
158450d6964Smyers /* Local prototypes */
159450d6964Smyers 
160450d6964Smyers static ACPI_STATUS
161450d6964Smyers AcpiUtCreateMutex (
162450d6964Smyers     ACPI_MUTEX_HANDLE       MutexId);
163450d6964Smyers 
16426f3cdf0SGordon Ross static void
165450d6964Smyers AcpiUtDeleteMutex (
166450d6964Smyers     ACPI_MUTEX_HANDLE       MutexId);
167450d6964Smyers 
168450d6964Smyers 
169450d6964Smyers /*******************************************************************************
170450d6964Smyers  *
171450d6964Smyers  * FUNCTION:    AcpiUtMutexInitialize
172450d6964Smyers  *
173450d6964Smyers  * PARAMETERS:  None.
174450d6964Smyers  *
175450d6964Smyers  * RETURN:      Status
176450d6964Smyers  *
177aa2aa9a6SDana Myers  * DESCRIPTION: Create the system mutex objects. This includes mutexes,
178aa2aa9a6SDana Myers  *              spin locks, and reader/writer locks.
179450d6964Smyers  *
180450d6964Smyers  ******************************************************************************/
181450d6964Smyers 
182450d6964Smyers ACPI_STATUS
AcpiUtMutexInitialize(void)183450d6964Smyers AcpiUtMutexInitialize (
184450d6964Smyers     void)
185450d6964Smyers {
186450d6964Smyers     UINT32                  i;
187450d6964Smyers     ACPI_STATUS             Status;
188450d6964Smyers 
189450d6964Smyers 
19027f7c583Smyers     ACPI_FUNCTION_TRACE (UtMutexInitialize);
191450d6964Smyers 
192450d6964Smyers 
193aa2aa9a6SDana Myers     /* Create each of the predefined mutex objects */
194aa2aa9a6SDana Myers 
19527f7c583Smyers     for (i = 0; i < ACPI_NUM_MUTEX; i++)
196450d6964Smyers     {
197450d6964Smyers         Status = AcpiUtCreateMutex (i);
198450d6964Smyers         if (ACPI_FAILURE (Status))
199450d6964Smyers         {
200450d6964Smyers             return_ACPI_STATUS (Status);
201450d6964Smyers         }
202450d6964Smyers     }
203450d6964Smyers 
2047b1019a6SJerry Jelinek     /* Create the spinlocks for use at interrupt level or for speed */
20527f7c583Smyers 
206450d6964Smyers     Status = AcpiOsCreateLock (&AcpiGbl_GpeLock);
20727f7c583Smyers     if (ACPI_FAILURE (Status))
20827f7c583Smyers     {
20927f7c583Smyers         return_ACPI_STATUS (Status);
21027f7c583Smyers     }
21127f7c583Smyers 
21227f7c583Smyers     Status = AcpiOsCreateLock (&AcpiGbl_HardwareLock);
213aa2aa9a6SDana Myers     if (ACPI_FAILURE (Status))
214aa2aa9a6SDana Myers     {
215aa2aa9a6SDana Myers         return_ACPI_STATUS (Status);
216aa2aa9a6SDana Myers     }
217aa2aa9a6SDana Myers 
2187b1019a6SJerry Jelinek     Status = AcpiOsCreateLock (&AcpiGbl_ReferenceCountLock);
2197b1019a6SJerry Jelinek     if (ACPI_FAILURE (Status))
2207b1019a6SJerry Jelinek     {
2217b1019a6SJerry Jelinek         return_ACPI_STATUS (Status);
2227b1019a6SJerry Jelinek     }
2237b1019a6SJerry Jelinek 
22426f3cdf0SGordon Ross     /* Mutex for _OSI support */
2257b1019a6SJerry Jelinek 
22626f3cdf0SGordon Ross     Status = AcpiOsCreateMutex (&AcpiGbl_OsiMutex);
22726f3cdf0SGordon Ross     if (ACPI_FAILURE (Status))
22826f3cdf0SGordon Ross     {
22926f3cdf0SGordon Ross         return_ACPI_STATUS (Status);
23026f3cdf0SGordon Ross     }
23126f3cdf0SGordon Ross 
232aa2aa9a6SDana Myers     /* Create the reader/writer lock for namespace access */
233aa2aa9a6SDana Myers 
234aa2aa9a6SDana Myers     Status = AcpiUtCreateRwLock (&AcpiGbl_NamespaceRwLock);
2357b1019a6SJerry Jelinek     if (ACPI_FAILURE (Status))
2367b1019a6SJerry Jelinek     {
2377b1019a6SJerry Jelinek         return_ACPI_STATUS (Status);
2387b1019a6SJerry Jelinek     }
2397b1019a6SJerry Jelinek 
240450d6964Smyers     return_ACPI_STATUS (Status);
241450d6964Smyers }
242450d6964Smyers 
243450d6964Smyers 
244450d6964Smyers /*******************************************************************************
245450d6964Smyers  *
246450d6964Smyers  * FUNCTION:    AcpiUtMutexTerminate
247450d6964Smyers  *
248450d6964Smyers  * PARAMETERS:  None.
249450d6964Smyers  *
250450d6964Smyers  * RETURN:      None.
251450d6964Smyers  *
252aa2aa9a6SDana Myers  * DESCRIPTION: Delete all of the system mutex objects. This includes mutexes,
253aa2aa9a6SDana Myers  *              spin locks, and reader/writer locks.
254450d6964Smyers  *
255450d6964Smyers  ******************************************************************************/
256450d6964Smyers 
257450d6964Smyers void
AcpiUtMutexTerminate(void)258450d6964Smyers AcpiUtMutexTerminate (
259450d6964Smyers     void)
260450d6964Smyers {
261450d6964Smyers     UINT32                  i;
262450d6964Smyers 
263450d6964Smyers 
26427f7c583Smyers     ACPI_FUNCTION_TRACE (UtMutexTerminate);
265450d6964Smyers 
266450d6964Smyers 
267aa2aa9a6SDana Myers     /* Delete each predefined mutex object */
268aa2aa9a6SDana Myers 
26927f7c583Smyers     for (i = 0; i < ACPI_NUM_MUTEX; i++)
270450d6964Smyers     {
27126f3cdf0SGordon Ross         AcpiUtDeleteMutex (i);
272450d6964Smyers     }
273450d6964Smyers 
27426f3cdf0SGordon Ross     AcpiOsDeleteMutex (AcpiGbl_OsiMutex);
27526f3cdf0SGordon Ross 
27627f7c583Smyers     /* Delete the spinlocks */
27727f7c583Smyers 
278450d6964Smyers     AcpiOsDeleteLock (AcpiGbl_GpeLock);
27927f7c583Smyers     AcpiOsDeleteLock (AcpiGbl_HardwareLock);
2807b1019a6SJerry Jelinek     AcpiOsDeleteLock (AcpiGbl_ReferenceCountLock);
281aa2aa9a6SDana Myers 
282aa2aa9a6SDana Myers     /* Delete the reader/writer lock */
283aa2aa9a6SDana Myers 
284aa2aa9a6SDana Myers     AcpiUtDeleteRwLock (&AcpiGbl_NamespaceRwLock);
285450d6964Smyers     return_VOID;
286450d6964Smyers }
287450d6964Smyers 
288450d6964Smyers 
289450d6964Smyers /*******************************************************************************
290450d6964Smyers  *
291450d6964Smyers  * FUNCTION:    AcpiUtCreateMutex
292450d6964Smyers  *
293450d6964Smyers  * PARAMETERS:  MutexID         - ID of the mutex to be created
294450d6964Smyers  *
295450d6964Smyers  * RETURN:      Status
296450d6964Smyers  *
297450d6964Smyers  * DESCRIPTION: Create a mutex object.
298450d6964Smyers  *
299450d6964Smyers  ******************************************************************************/
300450d6964Smyers 
301450d6964Smyers static ACPI_STATUS
AcpiUtCreateMutex(ACPI_MUTEX_HANDLE MutexId)302450d6964Smyers AcpiUtCreateMutex (
303450d6964Smyers     ACPI_MUTEX_HANDLE       MutexId)
304450d6964Smyers {
305450d6964Smyers     ACPI_STATUS             Status = AE_OK;
306450d6964Smyers 
307450d6964Smyers 
30827f7c583Smyers     ACPI_FUNCTION_TRACE_U32 (UtCreateMutex, MutexId);
309450d6964Smyers 
310450d6964Smyers 
311450d6964Smyers     if (!AcpiGbl_MutexInfo[MutexId].Mutex)
312450d6964Smyers     {
31327f7c583Smyers         Status = AcpiOsCreateMutex (&AcpiGbl_MutexInfo[MutexId].Mutex);
314450d6964Smyers         AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED;
315450d6964Smyers         AcpiGbl_MutexInfo[MutexId].UseCount = 0;
316450d6964Smyers     }
317450d6964Smyers 
318450d6964Smyers     return_ACPI_STATUS (Status);
319450d6964Smyers }
320450d6964Smyers 
321450d6964Smyers 
322450d6964Smyers /*******************************************************************************
323450d6964Smyers  *
324450d6964Smyers  * FUNCTION:    AcpiUtDeleteMutex
325450d6964Smyers  *
326450d6964Smyers  * PARAMETERS:  MutexID         - ID of the mutex to be deleted
327450d6964Smyers  *
328450d6964Smyers  * RETURN:      Status
329450d6964Smyers  *
330450d6964Smyers  * DESCRIPTION: Delete a mutex object.
331450d6964Smyers  *
332450d6964Smyers  ******************************************************************************/
333450d6964Smyers 
33426f3cdf0SGordon Ross static void
AcpiUtDeleteMutex(ACPI_MUTEX_HANDLE MutexId)335450d6964Smyers AcpiUtDeleteMutex (
336450d6964Smyers     ACPI_MUTEX_HANDLE       MutexId)
337450d6964Smyers {
338450d6964Smyers 
33927f7c583Smyers     ACPI_FUNCTION_TRACE_U32 (UtDeleteMutex, MutexId);
340450d6964Smyers 
341450d6964Smyers 
34227f7c583Smyers     AcpiOsDeleteMutex (AcpiGbl_MutexInfo[MutexId].Mutex);
343450d6964Smyers 
344450d6964Smyers     AcpiGbl_MutexInfo[MutexId].Mutex = NULL;
345450d6964Smyers     AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED;
3467b1019a6SJerry Jelinek 
3477b1019a6SJerry Jelinek     return_VOID;
348450d6964Smyers }
349450d6964Smyers 
350450d6964Smyers 
351450d6964Smyers /*******************************************************************************
352450d6964Smyers  *
353450d6964Smyers  * FUNCTION:    AcpiUtAcquireMutex
354450d6964Smyers  *
355450d6964Smyers  * PARAMETERS:  MutexID         - ID of the mutex to be acquired
356450d6964Smyers  *
357450d6964Smyers  * RETURN:      Status
358450d6964Smyers  *
359450d6964Smyers  * DESCRIPTION: Acquire a mutex object.
360450d6964Smyers  *
361450d6964Smyers  ******************************************************************************/
362450d6964Smyers 
363450d6964Smyers ACPI_STATUS
AcpiUtAcquireMutex(ACPI_MUTEX_HANDLE MutexId)364450d6964Smyers AcpiUtAcquireMutex (
365450d6964Smyers     ACPI_MUTEX_HANDLE       MutexId)
366450d6964Smyers {
367450d6964Smyers     ACPI_STATUS             Status;
36827f7c583Smyers     ACPI_THREAD_ID          ThisThreadId;
369450d6964Smyers 
370450d6964Smyers 
37127f7c583Smyers     ACPI_FUNCTION_NAME (UtAcquireMutex);
372450d6964Smyers 
373450d6964Smyers 
37427f7c583Smyers     if (MutexId > ACPI_MAX_MUTEX)
375450d6964Smyers     {
376450d6964Smyers         return (AE_BAD_PARAMETER);
377450d6964Smyers     }
378450d6964Smyers 
379450d6964Smyers     ThisThreadId = AcpiOsGetThreadId ();
380450d6964Smyers 
381450d6964Smyers #ifdef ACPI_MUTEX_DEBUG
382450d6964Smyers     {
383450d6964Smyers         UINT32                  i;
384450d6964Smyers         /*
385450d6964Smyers          * Mutex debug code, for internal debugging only.
386450d6964Smyers          *
3877b1019a6SJerry Jelinek          * Deadlock prevention. Check if this thread owns any mutexes of value
3887b1019a6SJerry Jelinek          * greater than or equal to this one. If so, the thread has violated
3897b1019a6SJerry Jelinek          * the mutex ordering rule. This indicates a coding error somewhere in
390450d6964Smyers          * the ACPI subsystem code.
391450d6964Smyers          */
392db2bae30SDana Myers         for (i = MutexId; i < ACPI_NUM_MUTEX; i++)
393450d6964Smyers         {
394186507a7Smyers             if (AcpiGbl_MutexInfo[i].ThreadId == ThisThreadId)
395450d6964Smyers             {
396450d6964Smyers                 if (i == MutexId)
397450d6964Smyers                 {
39830082d0cSmyers                     ACPI_ERROR ((AE_INFO,
39926f3cdf0SGordon Ross                         "Mutex [%s] already acquired by this thread [%u]",
400aa2aa9a6SDana Myers                         AcpiUtGetMutexName (MutexId),
40126f3cdf0SGordon Ross                         (UINT32) ThisThreadId));
402450d6964Smyers 
403450d6964Smyers                     return (AE_ALREADY_ACQUIRED);
404450d6964Smyers                 }
405450d6964Smyers 
40630082d0cSmyers                 ACPI_ERROR ((AE_INFO,
40726f3cdf0SGordon Ross                     "Invalid acquire order: Thread %u owns [%s], wants [%s]",
40826f3cdf0SGordon Ross                     (UINT32) ThisThreadId, AcpiUtGetMutexName (i),
409450d6964Smyers                     AcpiUtGetMutexName (MutexId)));
410450d6964Smyers 
411450d6964Smyers                 return (AE_ACQUIRE_DEADLOCK);
412450d6964Smyers             }
413450d6964Smyers         }
414450d6964Smyers     }
415450d6964Smyers #endif
416450d6964Smyers 
417450d6964Smyers     ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX,
41826f3cdf0SGordon Ross         "Thread %u attempting to acquire Mutex [%s]\n",
41926f3cdf0SGordon Ross         (UINT32) ThisThreadId, AcpiUtGetMutexName (MutexId)));
420450d6964Smyers 
4217b1019a6SJerry Jelinek     Status = AcpiOsAcquireMutex (
4227b1019a6SJerry Jelinek         AcpiGbl_MutexInfo[MutexId].Mutex, ACPI_WAIT_FOREVER);
423450d6964Smyers     if (ACPI_SUCCESS (Status))
424450d6964Smyers     {
4257b1019a6SJerry Jelinek         ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX,
4267b1019a6SJerry Jelinek             "Thread %u acquired Mutex [%s]\n",
42726f3cdf0SGordon Ross             (UINT32) ThisThreadId, AcpiUtGetMutexName (MutexId)));
428450d6964Smyers 
429450d6964Smyers         AcpiGbl_MutexInfo[MutexId].UseCount++;
430450d6964Smyers         AcpiGbl_MutexInfo[MutexId].ThreadId = ThisThreadId;
431450d6964Smyers     }
432450d6964Smyers     else
433450d6964Smyers     {
43430082d0cSmyers         ACPI_EXCEPTION ((AE_INFO, Status,
435*35786f68SRobert Mustacchi             "Thread %u could not acquire Mutex [%s] (0x%X)",
436*35786f68SRobert Mustacchi             (UINT32) ThisThreadId, AcpiUtGetMutexName (MutexId), MutexId));
437450d6964Smyers     }
438450d6964Smyers 
439450d6964Smyers     return (Status);
440450d6964Smyers }
441450d6964Smyers 
442450d6964Smyers 
443450d6964Smyers /*******************************************************************************
444450d6964Smyers  *
445450d6964Smyers  * FUNCTION:    AcpiUtReleaseMutex
446450d6964Smyers  *
447450d6964Smyers  * PARAMETERS:  MutexID         - ID of the mutex to be released
448450d6964Smyers  *
449450d6964Smyers  * RETURN:      Status
450450d6964Smyers  *
451450d6964Smyers  * DESCRIPTION: Release a mutex object.
452450d6964Smyers  *
453450d6964Smyers  ******************************************************************************/
454450d6964Smyers 
455450d6964Smyers ACPI_STATUS
AcpiUtReleaseMutex(ACPI_MUTEX_HANDLE MutexId)456450d6964Smyers AcpiUtReleaseMutex (
457450d6964Smyers     ACPI_MUTEX_HANDLE       MutexId)
458450d6964Smyers {
45927f7c583Smyers     ACPI_FUNCTION_NAME (UtReleaseMutex);
460450d6964Smyers 
461450d6964Smyers 
46226f3cdf0SGordon Ross     ACPI_DEBUG_PRINT ((ACPI_DB_MUTEX, "Thread %u releasing Mutex [%s]\n",
4637b1019a6SJerry Jelinek         (UINT32) AcpiOsGetThreadId (), AcpiUtGetMutexName (MutexId)));
464450d6964Smyers 
46527f7c583Smyers     if (MutexId > ACPI_MAX_MUTEX)
466450d6964Smyers     {
467450d6964Smyers         return (AE_BAD_PARAMETER);
468450d6964Smyers     }
469450d6964Smyers 
470450d6964Smyers     /*
471450d6964Smyers      * Mutex must be acquired in order to release it!
472450d6964Smyers      */
473450d6964Smyers     if (AcpiGbl_MutexInfo[MutexId].ThreadId == ACPI_MUTEX_NOT_ACQUIRED)
474450d6964Smyers     {
47530082d0cSmyers         ACPI_ERROR ((AE_INFO,
476*35786f68SRobert Mustacchi             "Mutex [%s] (0x%X) is not acquired, cannot release",
477*35786f68SRobert Mustacchi             AcpiUtGetMutexName (MutexId), MutexId));
478450d6964Smyers 
479450d6964Smyers         return (AE_NOT_ACQUIRED);
480450d6964Smyers     }
481450d6964Smyers 
482450d6964Smyers #ifdef ACPI_MUTEX_DEBUG
483450d6964Smyers     {
484450d6964Smyers         UINT32                  i;
485450d6964Smyers         /*
486450d6964Smyers          * Mutex debug code, for internal debugging only.
487450d6964Smyers          *
4887b1019a6SJerry Jelinek          * Deadlock prevention. Check if this thread owns any mutexes of value
4897b1019a6SJerry Jelinek          * greater than this one. If so, the thread has violated the mutex
4907b1019a6SJerry Jelinek          * ordering rule. This indicates a coding error somewhere in
491450d6964Smyers          * the ACPI subsystem code.
492450d6964Smyers          */
493db2bae30SDana Myers         for (i = MutexId; i < ACPI_NUM_MUTEX; i++)
494450d6964Smyers         {
4957b1019a6SJerry Jelinek             if (AcpiGbl_MutexInfo[i].ThreadId == AcpiOsGetThreadId ())
496450d6964Smyers             {
497450d6964Smyers                 if (i == MutexId)
498450d6964Smyers                 {
499450d6964Smyers                     continue;
500450d6964Smyers                 }
501450d6964Smyers 
50230082d0cSmyers                 ACPI_ERROR ((AE_INFO,
50330082d0cSmyers                     "Invalid release order: owns [%s], releasing [%s]",
504450d6964Smyers                     AcpiUtGetMutexName (i), AcpiUtGetMutexName (MutexId)));
505450d6964Smyers 
506450d6964Smyers                 return (AE_RELEASE_DEADLOCK);
507450d6964Smyers             }
508450d6964Smyers         }
509450d6964Smyers     }
510450d6964Smyers #endif
511450d6964Smyers 
512450d6964Smyers     /* Mark unlocked FIRST */
513450d6964Smyers 
514450d6964Smyers     AcpiGbl_MutexInfo[MutexId].ThreadId = ACPI_MUTEX_NOT_ACQUIRED;
515450d6964Smyers 
51627f7c583Smyers     AcpiOsReleaseMutex (AcpiGbl_MutexInfo[MutexId].Mutex);
51727f7c583Smyers     return (AE_OK);
518450d6964Smyers }
519