Amit Gandhi / sensen_copy_2

t

Fork of mbed-dev by mbed official

targets/TARGET_Maxim/TARGET_MAX32625/mxc/mxc_lock.h@150:02e0a0aed4ec, 2016-11-08 (annotated)

Committer:
<>
Date:
Tue Nov 08 17:45:16 2016 +0000
Revision:
150:02e0a0aed4ec
This updates the lib to the mbed lib v129

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 150:02e0a0aed4ec 1 /*******************************************************************************
<> 150:02e0a0aed4ec 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
<> 150:02e0a0aed4ec 3 *
<> 150:02e0a0aed4ec 4 * Permission is hereby granted, free of charge, to any person obtaining a
<> 150:02e0a0aed4ec 5 * copy of this software and associated documentation files (the "Software"),
<> 150:02e0a0aed4ec 6 * to deal in the Software without restriction, including without limitation
<> 150:02e0a0aed4ec 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
<> 150:02e0a0aed4ec 8 * and/or sell copies of the Software, and to permit persons to whom the
<> 150:02e0a0aed4ec 9 * Software is furnished to do so, subject to the following conditions:
<> 150:02e0a0aed4ec 10 *
<> 150:02e0a0aed4ec 11 * The above copyright notice and this permission notice shall be included
<> 150:02e0a0aed4ec 12 * in all copies or substantial portions of the Software.
<> 150:02e0a0aed4ec 13 *
<> 150:02e0a0aed4ec 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
<> 150:02e0a0aed4ec 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
<> 150:02e0a0aed4ec 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
<> 150:02e0a0aed4ec 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
<> 150:02e0a0aed4ec 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
<> 150:02e0a0aed4ec 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
<> 150:02e0a0aed4ec 20 * OTHER DEALINGS IN THE SOFTWARE.
<> 150:02e0a0aed4ec 21 *
<> 150:02e0a0aed4ec 22 * Except as contained in this notice, the name of Maxim Integrated
<> 150:02e0a0aed4ec 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
<> 150:02e0a0aed4ec 24 * Products, Inc. Branding Policy.
<> 150:02e0a0aed4ec 25 *
<> 150:02e0a0aed4ec 26 * The mere transfer of this software does not imply any licenses
<> 150:02e0a0aed4ec 27 * of trade secrets, proprietary technology, copyrights, patents,
<> 150:02e0a0aed4ec 28 * trademarks, maskwork rights, or any other form of intellectual
<> 150:02e0a0aed4ec 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
<> 150:02e0a0aed4ec 30 * ownership rights.
<> 150:02e0a0aed4ec 31 *
<> 150:02e0a0aed4ec 32 * $Date: 2016-03-11 11:46:37 -0600 (Fri, 11 Mar 2016) $
<> 150:02e0a0aed4ec 33 * $Revision: 21839 $
<> 150:02e0a0aed4ec 34 *
<> 150:02e0a0aed4ec 35 ******************************************************************************/
<> 150:02e0a0aed4ec 36
<> 150:02e0a0aed4ec 37 /**
<> 150:02e0a0aed4ec 38 * @file mxc_lock.h
<> 150:02e0a0aed4ec 39 * @brief Used to create exclusion for critical sections.
<> 150:02e0a0aed4ec 40 */
<> 150:02e0a0aed4ec 41
<> 150:02e0a0aed4ec 42 #ifndef _MXC_LOCK_H_
<> 150:02e0a0aed4ec 43 #define _MXC_LOCK_H_
<> 150:02e0a0aed4ec 44
<> 150:02e0a0aed4ec 45 #ifdef __cplusplus
<> 150:02e0a0aed4ec 46 extern "C" {
<> 150:02e0a0aed4ec 47 #endif
<> 150:02e0a0aed4ec 48
<> 150:02e0a0aed4ec 49 /***** Includes *****/
<> 150:02e0a0aed4ec 50 #include "mxc_config.h"
<> 150:02e0a0aed4ec 51
<> 150:02e0a0aed4ec 52 /***** Definitions *****/
<> 150:02e0a0aed4ec 53
<> 150:02e0a0aed4ec 54 /***** Globals *****/
<> 150:02e0a0aed4ec 55
<> 150:02e0a0aed4ec 56 /***** Function Prototypes *****/
<> 150:02e0a0aed4ec 57
<> 150:02e0a0aed4ec 58 /**
<> 150:02e0a0aed4ec 59 * @brief Attempts to acquire the lock.
<> 150:02e0a0aed4ec 60 * @param lock Pointer to variable used for the lock.
<> 150:02e0a0aed4ec 61 * @param value Value to be place in the lock. Can not be 0.
<> 150:02e0a0aed4ec 62 * @details This in an interrupt safe function that can be used as a mutex.
<> 150:02e0a0aed4ec 63 The lock variable must remain in scope until the lock is released.
<> 150:02e0a0aed4ec 64 Will not block if another thread has acquired the lock.
<> 150:02e0a0aed4ec 65 * @returns E_NO_ERROR if everything successful, E_BUSY if lock is taken.
<> 150:02e0a0aed4ec 66 */
<> 150:02e0a0aed4ec 67 __STATIC_INLINE int mxc_get_lock(uint32_t *lock, uint32_t value)
<> 150:02e0a0aed4ec 68 {
<> 150:02e0a0aed4ec 69 do {
<> 150:02e0a0aed4ec 70
<> 150:02e0a0aed4ec 71 // Return if the lock is taken by a different thread
<> 150:02e0a0aed4ec 72 if(__LDREXW((volatile unsigned long *)lock) != 0) {
<> 150:02e0a0aed4ec 73 return E_BUSY;
<> 150:02e0a0aed4ec 74 }
<> 150:02e0a0aed4ec 75
<> 150:02e0a0aed4ec 76 // Attempt to take the lock
<> 150:02e0a0aed4ec 77 } while(__STREXW(value, (volatile unsigned long *)lock) != 0);
<> 150:02e0a0aed4ec 78
<> 150:02e0a0aed4ec 79 // Do not start any other memory access until memory barrier is complete
<> 150:02e0a0aed4ec 80 __DMB();
<> 150:02e0a0aed4ec 81
<> 150:02e0a0aed4ec 82 return E_NO_ERROR;
<> 150:02e0a0aed4ec 83 }
<> 150:02e0a0aed4ec 84
<> 150:02e0a0aed4ec 85 /**
<> 150:02e0a0aed4ec 86 * @brief Free the given lock.
<> 150:02e0a0aed4ec 87 * @param lock Pointer to variable used for the lock.
<> 150:02e0a0aed4ec 88 */
<> 150:02e0a0aed4ec 89 __STATIC_INLINE void mxc_free_lock(uint32_t *lock)
<> 150:02e0a0aed4ec 90 {
<> 150:02e0a0aed4ec 91 // Ensure memory operations complete before releasing lock
<> 150:02e0a0aed4ec 92 __DMB();
<> 150:02e0a0aed4ec 93 *lock = 0;
<> 150:02e0a0aed4ec 94 }
<> 150:02e0a0aed4ec 95
<> 150:02e0a0aed4ec 96 #ifdef __cplusplus
<> 150:02e0a0aed4ec 97 }
<> 150:02e0a0aed4ec 98 #endif
<> 150:02e0a0aed4ec 99
<> 150:02e0a0aed4ec 100 #endif /* _MXC_LOCK_H_ */