mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_Maxim/TARGET_MAX32620C/mxc/mxc_lock.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
186:707f6e361f3e 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Anna Bridge 186:707f6e361f3e 1 /**
Anna Bridge 186:707f6e361f3e 2 * @file
Anna Bridge 186:707f6e361f3e 3 * @brief Exclusive access lock utility functions.
Anna Bridge 186:707f6e361f3e 4 */
Anna Bridge 186:707f6e361f3e 5 /* ****************************************************************************
Anna Bridge 186:707f6e361f3e 6 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
Anna Bridge 186:707f6e361f3e 7 *
Anna Bridge 186:707f6e361f3e 8 * Permission is hereby granted, free of charge, to any person obtaining a
Anna Bridge 186:707f6e361f3e 9 * copy of this software and associated documentation files (the "Software"),
Anna Bridge 186:707f6e361f3e 10 * to deal in the Software without restriction, including without limitation
Anna Bridge 186:707f6e361f3e 11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
Anna Bridge 186:707f6e361f3e 12 * and/or sell copies of the Software, and to permit persons to whom the
Anna Bridge 186:707f6e361f3e 13 * Software is furnished to do so, subject to the following conditions:
Anna Bridge 186:707f6e361f3e 14 *
Anna Bridge 186:707f6e361f3e 15 * The above copyright notice and this permission notice shall be included
Anna Bridge 186:707f6e361f3e 16 * in all copies or substantial portions of the Software.
Anna Bridge 186:707f6e361f3e 17 *
Anna Bridge 186:707f6e361f3e 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Anna Bridge 186:707f6e361f3e 19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Anna Bridge 186:707f6e361f3e 20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Anna Bridge 186:707f6e361f3e 21 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
Anna Bridge 186:707f6e361f3e 22 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Anna Bridge 186:707f6e361f3e 23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Anna Bridge 186:707f6e361f3e 24 * OTHER DEALINGS IN THE SOFTWARE.
Anna Bridge 186:707f6e361f3e 25 *
Anna Bridge 186:707f6e361f3e 26 * Except as contained in this notice, the name of Maxim Integrated
Anna Bridge 186:707f6e361f3e 27 * Products, Inc. shall not be used except as stated in the Maxim Integrated
Anna Bridge 186:707f6e361f3e 28 * Products, Inc. Branding Policy.
Anna Bridge 186:707f6e361f3e 29 *
Anna Bridge 186:707f6e361f3e 30 * The mere transfer of this software does not imply any licenses
Anna Bridge 186:707f6e361f3e 31 * of trade secrets, proprietary technology, copyrights, patents,
Anna Bridge 186:707f6e361f3e 32 * trademarks, maskwork rights, or any other form of intellectual
Anna Bridge 186:707f6e361f3e 33 * property whatsoever. Maxim Integrated Products, Inc. retains all
Anna Bridge 186:707f6e361f3e 34 * ownership rights.
Anna Bridge 186:707f6e361f3e 35 *
Anna Bridge 186:707f6e361f3e 36 * $Date: 2017-02-27 14:38:42 -0600 (Mon, 27 Feb 2017) $
Anna Bridge 186:707f6e361f3e 37 * $Revision: 26655 $
Anna Bridge 186:707f6e361f3e 38 *
Anna Bridge 186:707f6e361f3e 39 *************************************************************************** */
Anna Bridge 186:707f6e361f3e 40
Anna Bridge 186:707f6e361f3e 41 /* Define to prevent redundant inclusion */
Anna Bridge 186:707f6e361f3e 42 #ifndef _MXC_LOCK_H_
Anna Bridge 186:707f6e361f3e 43 #define _MXC_LOCK_H_
Anna Bridge 186:707f6e361f3e 44
Anna Bridge 186:707f6e361f3e 45 /* **** Includes **** */
Anna Bridge 186:707f6e361f3e 46 #include "mxc_config.h"
Anna Bridge 186:707f6e361f3e 47
Anna Bridge 186:707f6e361f3e 48 #ifdef __cplusplus
Anna Bridge 186:707f6e361f3e 49 extern "C" {
Anna Bridge 186:707f6e361f3e 50 #endif
Anna Bridge 186:707f6e361f3e 51
Anna Bridge 186:707f6e361f3e 52 /**
Anna Bridge 186:707f6e361f3e 53 * @ingroup syscfg
Anna Bridge 186:707f6e361f3e 54 * @defgroup mxc_lock_utilities Exclusive Access Locks
Anna Bridge 186:707f6e361f3e 55 * @brief Lock functions to obtain and release a variable for exclusive
Anna Bridge 186:707f6e361f3e 56 * access. These functions are marked interrupt safe if they are
Anna Bridge 186:707f6e361f3e 57 * interrupt safe.
Anna Bridge 186:707f6e361f3e 58 * @{
Anna Bridge 186:707f6e361f3e 59 */
Anna Bridge 186:707f6e361f3e 60
Anna Bridge 186:707f6e361f3e 61 /* **** Definitions **** */
Anna Bridge 186:707f6e361f3e 62
Anna Bridge 186:707f6e361f3e 63 /* **** Globals **** */
Anna Bridge 186:707f6e361f3e 64
Anna Bridge 186:707f6e361f3e 65 /* **** Function Prototypes **** */
Anna Bridge 186:707f6e361f3e 66
Anna Bridge 186:707f6e361f3e 67 /**
Anna Bridge 186:707f6e361f3e 68 * @brief Attempts to acquire the lock.
Anna Bridge 186:707f6e361f3e 69 * @details This in an interrupt safe function that can be used as a mutex.
Anna Bridge 186:707f6e361f3e 70 * The lock variable must remain in scope until the lock is
Anna Bridge 186:707f6e361f3e 71 * released. Will not block if another thread has already acquired
Anna Bridge 186:707f6e361f3e 72 * the lock.
Anna Bridge 186:707f6e361f3e 73 * @param lock Pointer to variable that is used for the lock.
Anna Bridge 186:707f6e361f3e 74 * @param value Value to be place in the lock. Can not be 0.
Anna Bridge 186:707f6e361f3e 75 *
Anna Bridge 186:707f6e361f3e 76 * @return #E_NO_ERROR if everything successful, #E_BUSY if lock is taken.
Anna Bridge 186:707f6e361f3e 77 */
Anna Bridge 186:707f6e361f3e 78 int mxc_get_lock(uint32_t *lock, uint32_t value);
Anna Bridge 186:707f6e361f3e 79
Anna Bridge 186:707f6e361f3e 80 /**
Anna Bridge 186:707f6e361f3e 81 * @brief Free the given lock.
Anna Bridge 186:707f6e361f3e 82 * @param[in,out] lock Pointer to the variable used for the lock. When the lock
Anna Bridge 186:707f6e361f3e 83 * is free, the value pointed to by @p lock is set to zero.
Anna Bridge 186:707f6e361f3e 84 */
Anna Bridge 186:707f6e361f3e 85 void mxc_free_lock(uint32_t *lock);
Anna Bridge 186:707f6e361f3e 86
Anna Bridge 186:707f6e361f3e 87 /**@} end of group mxc_lock_utilities */
Anna Bridge 186:707f6e361f3e 88
Anna Bridge 186:707f6e361f3e 89 #ifdef __cplusplus
Anna Bridge 186:707f6e361f3e 90 }
Anna Bridge 186:707f6e361f3e 91 #endif
Anna Bridge 186:707f6e361f3e 92
Anna Bridge 186:707f6e361f3e 93 #endif /* _MXC_LOCK_H_ */