1 /*******************************************************************************
2 *
3 * Module Name: utxfmutex - external AML mutex access functions
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/acnamesp.h>
155
156
157 #define _COMPONENT ACPI_UTILITIES
158 ACPI_MODULE_NAME ("utxfmutex")
159
160
161 /* Local prototypes */
162
163 static ACPI_STATUS
164 AcpiUtGetMutexObject (
165 ACPI_HANDLE Handle,
166 ACPI_STRING Pathname,
167 ACPI_OPERAND_OBJECT **RetObj);
168
169
170 /*******************************************************************************
171 *
172 * FUNCTION: AcpiUtGetMutexObject
173 *
174 * PARAMETERS: Handle - Mutex or prefix handle (optional)
175 * Pathname - Mutex pathname (optional)
176 * RetObj - Where the mutex object is returned
177 *
178 * RETURN: Status
179 *
180 * DESCRIPTION: Get an AML mutex object. The mutex node is pointed to by
181 * Handle:Pathname. Either Handle or Pathname can be NULL, but
182 * not both.
183 *
184 ******************************************************************************/
185
186 static ACPI_STATUS
AcpiUtGetMutexObject(ACPI_HANDLE Handle,ACPI_STRING Pathname,ACPI_OPERAND_OBJECT ** RetObj)187 AcpiUtGetMutexObject (
188 ACPI_HANDLE Handle,
189 ACPI_STRING Pathname,
190 ACPI_OPERAND_OBJECT **RetObj)
191 {
192 ACPI_NAMESPACE_NODE *MutexNode;
193 ACPI_OPERAND_OBJECT *MutexObj;
194 ACPI_STATUS Status;
195
196
197 /* Parameter validation */
198
199 if (!RetObj || (!Handle && !Pathname))
200 {
201 return (AE_BAD_PARAMETER);
202 }
203
204 /* Get a the namespace node for the mutex */
205
206 MutexNode = Handle;
207 if (Pathname != NULL)
208 {
209 Status = AcpiGetHandle (
210 Handle, Pathname, ACPI_CAST_PTR (ACPI_HANDLE, &MutexNode));
211 if (ACPI_FAILURE (Status))
212 {
213 return (Status);
214 }
215 }
216
217 /* Ensure that we actually have a Mutex object */
218
219 if (!MutexNode ||
220 (MutexNode->Type != ACPI_TYPE_MUTEX))
221 {
222 return (AE_TYPE);
223 }
224
225 /* Get the low-level mutex object */
226
227 MutexObj = AcpiNsGetAttachedObject (MutexNode);
228 if (!MutexObj)
229 {
230 return (AE_NULL_OBJECT);
231 }
232
233 *RetObj = MutexObj;
234 return (AE_OK);
235 }
236
237
238 /*******************************************************************************
239 *
240 * FUNCTION: AcpiAcquireMutex
241 *
242 * PARAMETERS: Handle - Mutex or prefix handle (optional)
243 * Pathname - Mutex pathname (optional)
244 * Timeout - Max time to wait for the lock (millisec)
245 *
246 * RETURN: Status
247 *
248 * DESCRIPTION: Acquire an AML mutex. This is a device driver interface to
249 * AML mutex objects, and allows for transaction locking between
250 * drivers and AML code. The mutex node is pointed to by
251 * Handle:Pathname. Either Handle or Pathname can be NULL, but
252 * not both.
253 *
254 ******************************************************************************/
255
256 ACPI_STATUS
AcpiAcquireMutex(ACPI_HANDLE Handle,ACPI_STRING Pathname,UINT16 Timeout)257 AcpiAcquireMutex (
258 ACPI_HANDLE Handle,
259 ACPI_STRING Pathname,
260 UINT16 Timeout)
261 {
262 ACPI_STATUS Status;
263 ACPI_OPERAND_OBJECT *MutexObj;
264
265
266 /* Get the low-level mutex associated with Handle:Pathname */
267
268 Status = AcpiUtGetMutexObject (Handle, Pathname, &MutexObj);
269 if (ACPI_FAILURE (Status))
270 {
271 return (Status);
272 }
273
274 /* Acquire the OS mutex */
275
276 Status = AcpiOsAcquireMutex (MutexObj->Mutex.OsMutex, Timeout);
277 return (Status);
278 }
279
ACPI_EXPORT_SYMBOL(AcpiAcquireMutex)280 ACPI_EXPORT_SYMBOL (AcpiAcquireMutex)
281
282
283 /*******************************************************************************
284 *
285 * FUNCTION: AcpiReleaseMutex
286 *
287 * PARAMETERS: Handle - Mutex or prefix handle (optional)
288 * Pathname - Mutex pathname (optional)
289 *
290 * RETURN: Status
291 *
292 * DESCRIPTION: Release an AML mutex. This is a device driver interface to
293 * AML mutex objects, and allows for transaction locking between
294 * drivers and AML code. The mutex node is pointed to by
295 * Handle:Pathname. Either Handle or Pathname can be NULL, but
296 * not both.
297 *
298 ******************************************************************************/
299
300 ACPI_STATUS
301 AcpiReleaseMutex (
302 ACPI_HANDLE Handle,
303 ACPI_STRING Pathname)
304 {
305 ACPI_STATUS Status;
306 ACPI_OPERAND_OBJECT *MutexObj;
307
308
309 /* Get the low-level mutex associated with Handle:Pathname */
310
311 Status = AcpiUtGetMutexObject (Handle, Pathname, &MutexObj);
312 if (ACPI_FAILURE (Status))
313 {
314 return (Status);
315 }
316
317 /* Release the OS mutex */
318
319 AcpiOsReleaseMutex (MutexObj->Mutex.OsMutex);
320 return (AE_OK);
321 }
322
323 ACPI_EXPORT_SYMBOL (AcpiReleaseMutex)
324