/** * @file mxc_lock.h * @brief Exclusive access lock utility functions. */ /****************************************************************************** * Copyright (C) 2023 Maxim Integrated Products, Inc., All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. * * Except as contained in this notice, the name of Maxim Integrated * Products, Inc. shall not be used except as stated in the Maxim Integrated * Products, Inc. Branding Policy. * * The mere transfer of this software does not imply any licenses * of trade secrets, proprietary technology, copyrights, patents, * trademarks, maskwork rights, or any other form of intellectual * property whatsoever. Maxim Integrated Products, Inc. retains all * ownership rights. * ******************************************************************************/ /* Define to prevent redundant inclusion */ #ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32670_MXC_LOCK_H_ #define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32670_MXC_LOCK_H_ // To enable disable this module #define USE_LOCK_IN_DRIVERS 0 /* **** Includes **** */ #include "mxc_device.h" #ifdef __cplusplus extern "C" { #endif #if USE_LOCK_IN_DRIVERS /** * @ingroup syscfg * @defgroup mxc_lock_utilities Exclusive Access Locks * @brief Lock functions to obtain and release a variable for exclusive * access. These functions are marked interrupt safe if they are * interrupt safe. * @{ */ /* **** Definitions **** */ /* **** Globals **** */ /* **** Function Prototypes **** */ /** * @brief Attempts to acquire the lock. * @details This in an interrupt safe function that can be used as a mutex. * The lock variable must remain in scope until the lock is * released. Will not block if another thread has already acquired * the lock. * @param lock Pointer to variable that is used for the lock. * @param value Value to be place in the lock. Can not be 0. * * @return #E_NO_ERROR if everything successful, #E_BUSY if lock is taken. */ int MXC_GetLock(uint32_t *lock, uint32_t value); /** * @brief Free the given lock. * @param[in,out] lock Pointer to the variable used for the lock. When the lock * is free, the value pointed to by @p lock is set to zero. */ void MXC_FreeLock(uint32_t *lock); /**@} end of group mxc_lock_utilities */ #else // USE_LOCK_IN_DRIVERS #define MXC_GetLock(x, y) E_NO_ERROR #define MXC_FreeLock(x) #endif // USE_LOCK_IN_DRIVERS #ifdef __cplusplus } #endif #endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32670_MXC_LOCK_H_