stm32_lock_user.h

Go to the documentation of this file.

 
#ifndef __STM32_LOCK_USER_H__
#define __STM32_LOCK_USER_H__
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#include "FreeRTOS.h"
#include "task.h"
 
#if STM32_LOCK_API != 1 /* Version of the implemented API */
    #error stm32_lock_user.h not compatible with current version of stm32_lock.h
#endif
 
#define MAX_LOCK_NESTING_LEVEL 4
 
#define LOCK_ASSERT(x)       \
    do {                     \
        if (!(x)) {          \
            __disable_irq(); \
            for (;;);        \
        }                    \
    } while (0)
 
/* Remove the following line when you have implemented your own thread-safe
 * solution. */
// #error Please implement your own thread-safe solution
 
/* Private defines -----------------------------------------------------------*/
#define LOCKING_DATA_INIT \
    {                     \
        { 0, 0, 0, 0 },   \
        0,                \
    }
 
/* Private typedef -----------------------------------------------------------*/
typedef struct {
    UBaseType_t interrupt_status[MAX_LOCK_NESTING_LEVEL];
    uint8_t nesting_level;
} LockingData_t;
 
/* Private functions ---------------------------------------------------------*/

static inline void stm32_lock_init(LockingData_t *lock) {
    LOCK_ASSERT(lock);
    for (UBaseType_t *i = lock->interrupt_status; i < (lock->interrupt_status + MAX_LOCK_NESTING_LEVEL); i++) *i = 0;
    lock->nesting_level = 0;
}

static inline void stm32_lock_acquire(LockingData_t *lock) {
    LOCK_ASSERT(lock);
    LOCK_ASSERT(lock->nesting_level < MAX_LOCK_NESTING_LEVEL);
    // As far as I can tell, the _FROM_ISR version is fine to call from either ISRs or tasks
    lock->interrupt_status[lock->nesting_level++] = taskENTER_CRITICAL_FROM_ISR();
}

static inline void stm32_lock_release(LockingData_t *lock) {
    LOCK_ASSERT(lock);
    lock->nesting_level--;
    LOCK_ASSERT(lock->nesting_level < MAX_LOCK_NESTING_LEVEL);
    taskEXIT_CRITICAL_FROM_ISR(lock->interrupt_status[lock->nesting_level]);
}
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __STM32_LOCK_USER_H__ */