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 - 2015, 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 #include "acpi.h" 117 #include "accommon.h" 118 #include "acnamesp.h" 119 120 121 #define _COMPONENT ACPI_UTILITIES 122 ACPI_MODULE_NAME ("utxfmutex") 123 124 125 /* Local prototypes */ 126 127 static ACPI_STATUS 128 AcpiUtGetMutexObject ( 129 ACPI_HANDLE Handle, 130 ACPI_STRING Pathname, 131 ACPI_OPERAND_OBJECT **RetObj); 132 133 134 /******************************************************************************* 135 * 136 * FUNCTION: AcpiUtGetMutexObject 137 * 138 * PARAMETERS: Handle - Mutex or prefix handle (optional) 139 * Pathname - Mutex pathname (optional) 140 * RetObj - Where the mutex object is returned 141 * 142 * RETURN: Status 143 * 144 * DESCRIPTION: Get an AML mutex object. The mutex node is pointed to by 145 * Handle:Pathname. Either Handle or Pathname can be NULL, but 146 * not both. 147 * 148 ******************************************************************************/ 149 150 static ACPI_STATUS 151 AcpiUtGetMutexObject ( 152 ACPI_HANDLE Handle, 153 ACPI_STRING Pathname, 154 ACPI_OPERAND_OBJECT **RetObj) 155 { 156 ACPI_NAMESPACE_NODE *MutexNode; 157 ACPI_OPERAND_OBJECT *MutexObj; 158 ACPI_STATUS Status; 159 160 161 /* Parameter validation */ 162 163 if (!RetObj || (!Handle && !Pathname)) 164 { 165 return (AE_BAD_PARAMETER); 166 } 167 168 /* Get a the namespace node for the mutex */ 169 170 MutexNode = Handle; 171 if (Pathname != NULL) 172 { 173 Status = AcpiGetHandle (Handle, Pathname, 174 ACPI_CAST_PTR (ACPI_HANDLE, &MutexNode)); 175 if (ACPI_FAILURE (Status)) 176 { 177 return (Status); 178 } 179 } 180 181 /* Ensure that we actually have a Mutex object */ 182 183 if (!MutexNode || 184 (MutexNode->Type != ACPI_TYPE_MUTEX)) 185 { 186 return (AE_TYPE); 187 } 188 189 /* Get the low-level mutex object */ 190 191 MutexObj = AcpiNsGetAttachedObject (MutexNode); 192 if (!MutexObj) 193 { 194 return (AE_NULL_OBJECT); 195 } 196 197 *RetObj = MutexObj; 198 return (AE_OK); 199 } 200 201 202 /******************************************************************************* 203 * 204 * FUNCTION: AcpiAcquireMutex 205 * 206 * PARAMETERS: Handle - Mutex or prefix handle (optional) 207 * Pathname - Mutex pathname (optional) 208 * Timeout - Max time to wait for the lock (millisec) 209 * 210 * RETURN: Status 211 * 212 * DESCRIPTION: Acquire an AML mutex. This is a device driver interface to 213 * AML mutex objects, and allows for transaction locking between 214 * drivers and AML code. The mutex node is pointed to by 215 * Handle:Pathname. Either Handle or Pathname can be NULL, but 216 * not both. 217 * 218 ******************************************************************************/ 219 220 ACPI_STATUS 221 AcpiAcquireMutex ( 222 ACPI_HANDLE Handle, 223 ACPI_STRING Pathname, 224 UINT16 Timeout) 225 { 226 ACPI_STATUS Status; 227 ACPI_OPERAND_OBJECT *MutexObj; 228 229 230 /* Get the low-level mutex associated with Handle:Pathname */ 231 232 Status = AcpiUtGetMutexObject (Handle, Pathname, &MutexObj); 233 if (ACPI_FAILURE (Status)) 234 { 235 return (Status); 236 } 237 238 /* Acquire the OS mutex */ 239 240 Status = AcpiOsAcquireMutex (MutexObj->Mutex.OsMutex, Timeout); 241 return (Status); 242 } 243 244 245 /******************************************************************************* 246 * 247 * FUNCTION: AcpiReleaseMutex 248 * 249 * PARAMETERS: Handle - Mutex or prefix handle (optional) 250 * Pathname - Mutex pathname (optional) 251 * 252 * RETURN: Status 253 * 254 * DESCRIPTION: Release an AML mutex. This is a device driver interface to 255 * AML mutex objects, and allows for transaction locking between 256 * drivers and AML code. The mutex node is pointed to by 257 * Handle:Pathname. Either Handle or Pathname can be NULL, but 258 * not both. 259 * 260 ******************************************************************************/ 261 262 ACPI_STATUS 263 AcpiReleaseMutex ( 264 ACPI_HANDLE Handle, 265 ACPI_STRING Pathname) 266 { 267 ACPI_STATUS Status; 268 ACPI_OPERAND_OBJECT *MutexObj; 269 270 271 /* Get the low-level mutex associated with Handle:Pathname */ 272 273 Status = AcpiUtGetMutexObject (Handle, Pathname, &MutexObj); 274 if (ACPI_FAILURE (Status)) 275 { 276 return (Status); 277 } 278 279 /* Release the OS mutex */ 280 281 AcpiOsReleaseMutex (MutexObj->Mutex.OsMutex); 282 return (AE_OK); 283 } 284