utxfmutex.c revision 1.1.1.1.10.2 1 1.1.1.1.10.2 tls /*******************************************************************************
2 1.1.1.1.10.2 tls *
3 1.1.1.1.10.2 tls * Module Name: utxfmutex - external AML mutex access functions
4 1.1.1.1.10.2 tls *
5 1.1.1.1.10.2 tls ******************************************************************************/
6 1.1.1.1.10.2 tls
7 1.1.1.1.10.2 tls /*
8 1.1.1.1.10.2 tls * Copyright (C) 2000 - 2013, Intel Corp.
9 1.1.1.1.10.2 tls * All rights reserved.
10 1.1.1.1.10.2 tls *
11 1.1.1.1.10.2 tls * Redistribution and use in source and binary forms, with or without
12 1.1.1.1.10.2 tls * modification, are permitted provided that the following conditions
13 1.1.1.1.10.2 tls * are met:
14 1.1.1.1.10.2 tls * 1. Redistributions of source code must retain the above copyright
15 1.1.1.1.10.2 tls * notice, this list of conditions, and the following disclaimer,
16 1.1.1.1.10.2 tls * without modification.
17 1.1.1.1.10.2 tls * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.1.1.1.10.2 tls * substantially similar to the "NO WARRANTY" disclaimer below
19 1.1.1.1.10.2 tls * ("Disclaimer") and any redistribution must be conditioned upon
20 1.1.1.1.10.2 tls * including a substantially similar Disclaimer requirement for further
21 1.1.1.1.10.2 tls * binary redistribution.
22 1.1.1.1.10.2 tls * 3. Neither the names of the above-listed copyright holders nor the names
23 1.1.1.1.10.2 tls * of any contributors may be used to endorse or promote products derived
24 1.1.1.1.10.2 tls * from this software without specific prior written permission.
25 1.1.1.1.10.2 tls *
26 1.1.1.1.10.2 tls * Alternatively, this software may be distributed under the terms of the
27 1.1.1.1.10.2 tls * GNU General Public License ("GPL") version 2 as published by the Free
28 1.1.1.1.10.2 tls * Software Foundation.
29 1.1.1.1.10.2 tls *
30 1.1.1.1.10.2 tls * NO WARRANTY
31 1.1.1.1.10.2 tls * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.1.1.1.10.2 tls * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.1.1.1.10.2 tls * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.1.1.1.10.2 tls * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.1.1.1.10.2 tls * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.1.1.1.10.2 tls * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.1.1.1.10.2 tls * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.1.1.1.10.2 tls * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.1.1.1.10.2 tls * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.1.1.1.10.2 tls * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.1.1.1.10.2 tls * POSSIBILITY OF SUCH DAMAGES.
42 1.1.1.1.10.2 tls */
43 1.1.1.1.10.2 tls
44 1.1.1.1.10.2 tls #define __UTXFMUTEX_C__
45 1.1.1.1.10.2 tls
46 1.1.1.1.10.2 tls #include "acpi.h"
47 1.1.1.1.10.2 tls #include "accommon.h"
48 1.1.1.1.10.2 tls #include "acnamesp.h"
49 1.1.1.1.10.2 tls
50 1.1.1.1.10.2 tls
51 1.1.1.1.10.2 tls #define _COMPONENT ACPI_UTILITIES
52 1.1.1.1.10.2 tls ACPI_MODULE_NAME ("utxfmutex")
53 1.1.1.1.10.2 tls
54 1.1.1.1.10.2 tls
55 1.1.1.1.10.2 tls /* Local prototypes */
56 1.1.1.1.10.2 tls
57 1.1.1.1.10.2 tls static ACPI_STATUS
58 1.1.1.1.10.2 tls AcpiUtGetMutexObject (
59 1.1.1.1.10.2 tls ACPI_HANDLE Handle,
60 1.1.1.1.10.2 tls ACPI_STRING Pathname,
61 1.1.1.1.10.2 tls ACPI_OPERAND_OBJECT **RetObj);
62 1.1.1.1.10.2 tls
63 1.1.1.1.10.2 tls
64 1.1.1.1.10.2 tls /*******************************************************************************
65 1.1.1.1.10.2 tls *
66 1.1.1.1.10.2 tls * FUNCTION: AcpiUtGetMutexObject
67 1.1.1.1.10.2 tls *
68 1.1.1.1.10.2 tls * PARAMETERS: Handle - Mutex or prefix handle (optional)
69 1.1.1.1.10.2 tls * Pathname - Mutex pathname (optional)
70 1.1.1.1.10.2 tls * RetObj - Where the mutex object is returned
71 1.1.1.1.10.2 tls *
72 1.1.1.1.10.2 tls * RETURN: Status
73 1.1.1.1.10.2 tls *
74 1.1.1.1.10.2 tls * DESCRIPTION: Get an AML mutex object. The mutex node is pointed to by
75 1.1.1.1.10.2 tls * Handle:Pathname. Either Handle or Pathname can be NULL, but
76 1.1.1.1.10.2 tls * not both.
77 1.1.1.1.10.2 tls *
78 1.1.1.1.10.2 tls ******************************************************************************/
79 1.1.1.1.10.2 tls
80 1.1.1.1.10.2 tls static ACPI_STATUS
81 1.1.1.1.10.2 tls AcpiUtGetMutexObject (
82 1.1.1.1.10.2 tls ACPI_HANDLE Handle,
83 1.1.1.1.10.2 tls ACPI_STRING Pathname,
84 1.1.1.1.10.2 tls ACPI_OPERAND_OBJECT **RetObj)
85 1.1.1.1.10.2 tls {
86 1.1.1.1.10.2 tls ACPI_NAMESPACE_NODE *MutexNode;
87 1.1.1.1.10.2 tls ACPI_OPERAND_OBJECT *MutexObj;
88 1.1.1.1.10.2 tls ACPI_STATUS Status;
89 1.1.1.1.10.2 tls
90 1.1.1.1.10.2 tls
91 1.1.1.1.10.2 tls /* Parameter validation */
92 1.1.1.1.10.2 tls
93 1.1.1.1.10.2 tls if (!RetObj || (!Handle && !Pathname))
94 1.1.1.1.10.2 tls {
95 1.1.1.1.10.2 tls return (AE_BAD_PARAMETER);
96 1.1.1.1.10.2 tls }
97 1.1.1.1.10.2 tls
98 1.1.1.1.10.2 tls /* Get a the namespace node for the mutex */
99 1.1.1.1.10.2 tls
100 1.1.1.1.10.2 tls MutexNode = Handle;
101 1.1.1.1.10.2 tls if (Pathname != NULL)
102 1.1.1.1.10.2 tls {
103 1.1.1.1.10.2 tls Status = AcpiGetHandle (Handle, Pathname,
104 1.1.1.1.10.2 tls ACPI_CAST_PTR (ACPI_HANDLE, &MutexNode));
105 1.1.1.1.10.2 tls if (ACPI_FAILURE (Status))
106 1.1.1.1.10.2 tls {
107 1.1.1.1.10.2 tls return (Status);
108 1.1.1.1.10.2 tls }
109 1.1.1.1.10.2 tls }
110 1.1.1.1.10.2 tls
111 1.1.1.1.10.2 tls /* Ensure that we actually have a Mutex object */
112 1.1.1.1.10.2 tls
113 1.1.1.1.10.2 tls if (!MutexNode ||
114 1.1.1.1.10.2 tls (MutexNode->Type != ACPI_TYPE_MUTEX))
115 1.1.1.1.10.2 tls {
116 1.1.1.1.10.2 tls return (AE_TYPE);
117 1.1.1.1.10.2 tls }
118 1.1.1.1.10.2 tls
119 1.1.1.1.10.2 tls /* Get the low-level mutex object */
120 1.1.1.1.10.2 tls
121 1.1.1.1.10.2 tls MutexObj = AcpiNsGetAttachedObject (MutexNode);
122 1.1.1.1.10.2 tls if (!MutexObj)
123 1.1.1.1.10.2 tls {
124 1.1.1.1.10.2 tls return (AE_NULL_OBJECT);
125 1.1.1.1.10.2 tls }
126 1.1.1.1.10.2 tls
127 1.1.1.1.10.2 tls *RetObj = MutexObj;
128 1.1.1.1.10.2 tls return (AE_OK);
129 1.1.1.1.10.2 tls }
130 1.1.1.1.10.2 tls
131 1.1.1.1.10.2 tls
132 1.1.1.1.10.2 tls /*******************************************************************************
133 1.1.1.1.10.2 tls *
134 1.1.1.1.10.2 tls * FUNCTION: AcpiAcquireMutex
135 1.1.1.1.10.2 tls *
136 1.1.1.1.10.2 tls * PARAMETERS: Handle - Mutex or prefix handle (optional)
137 1.1.1.1.10.2 tls * Pathname - Mutex pathname (optional)
138 1.1.1.1.10.2 tls * Timeout - Max time to wait for the lock (millisec)
139 1.1.1.1.10.2 tls *
140 1.1.1.1.10.2 tls * RETURN: Status
141 1.1.1.1.10.2 tls *
142 1.1.1.1.10.2 tls * DESCRIPTION: Acquire an AML mutex. This is a device driver interface to
143 1.1.1.1.10.2 tls * AML mutex objects, and allows for transaction locking between
144 1.1.1.1.10.2 tls * drivers and AML code. The mutex node is pointed to by
145 1.1.1.1.10.2 tls * Handle:Pathname. Either Handle or Pathname can be NULL, but
146 1.1.1.1.10.2 tls * not both.
147 1.1.1.1.10.2 tls *
148 1.1.1.1.10.2 tls ******************************************************************************/
149 1.1.1.1.10.2 tls
150 1.1.1.1.10.2 tls ACPI_STATUS
151 1.1.1.1.10.2 tls AcpiAcquireMutex (
152 1.1.1.1.10.2 tls ACPI_HANDLE Handle,
153 1.1.1.1.10.2 tls ACPI_STRING Pathname,
154 1.1.1.1.10.2 tls UINT16 Timeout)
155 1.1.1.1.10.2 tls {
156 1.1.1.1.10.2 tls ACPI_STATUS Status;
157 1.1.1.1.10.2 tls ACPI_OPERAND_OBJECT *MutexObj;
158 1.1.1.1.10.2 tls
159 1.1.1.1.10.2 tls
160 1.1.1.1.10.2 tls /* Get the low-level mutex associated with Handle:Pathname */
161 1.1.1.1.10.2 tls
162 1.1.1.1.10.2 tls Status = AcpiUtGetMutexObject (Handle, Pathname, &MutexObj);
163 1.1.1.1.10.2 tls if (ACPI_FAILURE (Status))
164 1.1.1.1.10.2 tls {
165 1.1.1.1.10.2 tls return (Status);
166 1.1.1.1.10.2 tls }
167 1.1.1.1.10.2 tls
168 1.1.1.1.10.2 tls /* Acquire the OS mutex */
169 1.1.1.1.10.2 tls
170 1.1.1.1.10.2 tls Status = AcpiOsAcquireMutex (MutexObj->Mutex.OsMutex, Timeout);
171 1.1.1.1.10.2 tls return (Status);
172 1.1.1.1.10.2 tls }
173 1.1.1.1.10.2 tls
174 1.1.1.1.10.2 tls
175 1.1.1.1.10.2 tls /*******************************************************************************
176 1.1.1.1.10.2 tls *
177 1.1.1.1.10.2 tls * FUNCTION: AcpiReleaseMutex
178 1.1.1.1.10.2 tls *
179 1.1.1.1.10.2 tls * PARAMETERS: Handle - Mutex or prefix handle (optional)
180 1.1.1.1.10.2 tls * Pathname - Mutex pathname (optional)
181 1.1.1.1.10.2 tls *
182 1.1.1.1.10.2 tls * RETURN: Status
183 1.1.1.1.10.2 tls *
184 1.1.1.1.10.2 tls * DESCRIPTION: Release an AML mutex. This is a device driver interface to
185 1.1.1.1.10.2 tls * AML mutex objects, and allows for transaction locking between
186 1.1.1.1.10.2 tls * drivers and AML code. The mutex node is pointed to by
187 1.1.1.1.10.2 tls * Handle:Pathname. Either Handle or Pathname can be NULL, but
188 1.1.1.1.10.2 tls * not both.
189 1.1.1.1.10.2 tls *
190 1.1.1.1.10.2 tls ******************************************************************************/
191 1.1.1.1.10.2 tls
192 1.1.1.1.10.2 tls ACPI_STATUS
193 1.1.1.1.10.2 tls AcpiReleaseMutex (
194 1.1.1.1.10.2 tls ACPI_HANDLE Handle,
195 1.1.1.1.10.2 tls ACPI_STRING Pathname)
196 1.1.1.1.10.2 tls {
197 1.1.1.1.10.2 tls ACPI_STATUS Status;
198 1.1.1.1.10.2 tls ACPI_OPERAND_OBJECT *MutexObj;
199 1.1.1.1.10.2 tls
200 1.1.1.1.10.2 tls
201 1.1.1.1.10.2 tls /* Get the low-level mutex associated with Handle:Pathname */
202 1.1.1.1.10.2 tls
203 1.1.1.1.10.2 tls Status = AcpiUtGetMutexObject (Handle, Pathname, &MutexObj);
204 1.1.1.1.10.2 tls if (ACPI_FAILURE (Status))
205 1.1.1.1.10.2 tls {
206 1.1.1.1.10.2 tls return (Status);
207 1.1.1.1.10.2 tls }
208 1.1.1.1.10.2 tls
209 1.1.1.1.10.2 tls /* Release the OS mutex */
210 1.1.1.1.10.2 tls
211 1.1.1.1.10.2 tls AcpiOsReleaseMutex (MutexObj->Mutex.OsMutex);
212 1.1.1.1.10.2 tls return (AE_OK);
213 1.1.1.1.10.2 tls }
214