acpica/utilities/utxfmutex.c

0001 /*******************************************************************************
0002  *
0003  * Module Name: utxfmutex - external AML mutex access functions
0004  *
0005  ******************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acnamesp.h"
0155
0156
0157 #define _COMPONENT          ACPI_UTILITIES
0158         ACPI_MODULE_NAME    ("utxfmutex")
0159
0160
0161 /* Local prototypes */
0162
0163 static ACPI_STATUS
0164 AcpiUtGetMutexObject (
0165     ACPI_HANDLE             Handle,
0166     ACPI_STRING             Pathname,
0167     ACPI_OPERAND_OBJECT     **RetObj);
0168
0169
0170 /*******************************************************************************
0171  *
0172  * FUNCTION:    AcpiUtGetMutexObject
0173  *
0174  * PARAMETERS:  Handle              - Mutex or prefix handle (optional)
0175  *              Pathname            - Mutex pathname (optional)
0176  *              RetObj              - Where the mutex object is returned
0177  *
0178  * RETURN:      Status
0179  *
0180  * DESCRIPTION: Get an AML mutex object. The mutex node is pointed to by
0181  *              Handle:Pathname. Either Handle or Pathname can be NULL, but
0182  *              not both.
0183  *
0184  ******************************************************************************/
0185
0186 static ACPI_STATUS
0187 AcpiUtGetMutexObject (
0188     ACPI_HANDLE             Handle,
0189     ACPI_STRING             Pathname,
0190     ACPI_OPERAND_OBJECT     **RetObj)
0191 {
0192     ACPI_NAMESPACE_NODE     *MutexNode;
0193     ACPI_OPERAND_OBJECT     *MutexObj;
0194     ACPI_STATUS             Status;
0195
0196
0197     /* Parameter validation */
0198
0199     if (!RetObj || (!Handle && !Pathname))
0200     {
0201         return (AE_BAD_PARAMETER);
0202     }
0203
0204     /* Get a the namespace node for the mutex */
0205
0206     MutexNode = Handle;
0207     if (Pathname != NULL)
0208     {
0209         Status = AcpiGetHandle (
0210             Handle, Pathname, ACPI_CAST_PTR (ACPI_HANDLE, &MutexNode));
0211         if (ACPI_FAILURE (Status))
0212         {
0213             return (Status);
0214         }
0215     }
0216
0217     /* Ensure that we actually have a Mutex object */
0218
0219     if (!MutexNode ||
0220         (MutexNode->Type != ACPI_TYPE_MUTEX))
0221     {
0222         return (AE_TYPE);
0223     }
0224
0225     /* Get the low-level mutex object */
0226
0227     MutexObj = AcpiNsGetAttachedObject (MutexNode);
0228     if (!MutexObj)
0229     {
0230         return (AE_NULL_OBJECT);
0231     }
0232
0233     *RetObj = MutexObj;
0234     return (AE_OK);
0235 }
0236
0237
0238 /*******************************************************************************
0239  *
0240  * FUNCTION:    AcpiAcquireMutex
0241  *
0242  * PARAMETERS:  Handle              - Mutex or prefix handle (optional)
0243  *              Pathname            - Mutex pathname (optional)
0244  *              Timeout             - Max time to wait for the lock (millisec)
0245  *
0246  * RETURN:      Status
0247  *
0248  * DESCRIPTION: Acquire an AML mutex. This is a device driver interface to
0249  *              AML mutex objects, and allows for transaction locking between
0250  *              drivers and AML code. The mutex node is pointed to by
0251  *              Handle:Pathname. Either Handle or Pathname can be NULL, but
0252  *              not both.
0253  *
0254  ******************************************************************************/
0255
0256 ACPI_STATUS
0257 AcpiAcquireMutex (
0258     ACPI_HANDLE             Handle,
0259     ACPI_STRING             Pathname,
0260     UINT16                  Timeout)
0261 {
0262     ACPI_STATUS             Status;
0263     ACPI_OPERAND_OBJECT     *MutexObj;
0264
0265
0266     /* Get the low-level mutex associated with Handle:Pathname */
0267
0268     Status = AcpiUtGetMutexObject (Handle, Pathname, &MutexObj);
0269     if (ACPI_FAILURE (Status))
0270     {
0271         return (Status);
0272     }
0273
0274     /* Acquire the OS mutex */
0275
0276     Status = AcpiOsAcquireMutex (MutexObj->Mutex.OsMutex, Timeout);
0277     return (Status);
0278 }
0279
0280 ACPI_EXPORT_SYMBOL (AcpiAcquireMutex)
0281
0282
0283 /*******************************************************************************
0284  *
0285  * FUNCTION:    AcpiReleaseMutex
0286  *
0287  * PARAMETERS:  Handle              - Mutex or prefix handle (optional)
0288  *              Pathname            - Mutex pathname (optional)
0289  *
0290  * RETURN:      Status
0291  *
0292  * DESCRIPTION: Release an AML mutex. This is a device driver interface to
0293  *              AML mutex objects, and allows for transaction locking between
0294  *              drivers and AML code. The mutex node is pointed to by
0295  *              Handle:Pathname. Either Handle or Pathname can be NULL, but
0296  *              not both.
0297  *
0298  ******************************************************************************/
0299
0300 ACPI_STATUS
0301 AcpiReleaseMutex (
0302     ACPI_HANDLE             Handle,
0303     ACPI_STRING             Pathname)
0304 {
0305     ACPI_STATUS             Status;
0306     ACPI_OPERAND_OBJECT     *MutexObj;
0307
0308
0309     /* Get the low-level mutex associated with Handle:Pathname */
0310
0311     Status = AcpiUtGetMutexObject (Handle, Pathname, &MutexObj);
0312     if (ACPI_FAILURE (Status))
0313     {
0314         return (Status);
0315     }
0316
0317     /* Release the OS mutex */
0318
0319     AcpiOsReleaseMutex (MutexObj->Mutex.OsMutex);
0320     return (AE_OK);
0321 }
0322
0323 ACPI_EXPORT_SYMBOL (AcpiReleaseMutex)