mirror of
https://github.com/ByteWelder/Tactility.git
synced 2026-02-18 10:53:17 +00:00
88 lines
1.6 KiB
C++
88 lines
1.6 KiB
C++
/**
|
|
* @file mutex.h
|
|
* Mutex
|
|
*/
|
|
#pragma once
|
|
|
|
#include "CoreTypes.h"
|
|
#include "Thread.h"
|
|
|
|
#ifdef ESP_PLATFORM
|
|
#include "freertos/FreeRTOS.h"
|
|
#include "freertos/semphr.h"
|
|
#else
|
|
#include "FreeRTOS.h"
|
|
#include "semphr.h"
|
|
#endif
|
|
|
|
namespace tt {
|
|
|
|
typedef enum {
|
|
MutexTypeNormal,
|
|
MutexTypeRecursive,
|
|
} MutexType;
|
|
|
|
/**
|
|
* Wrapper for FreeRTOS xSemaphoreCreateMutex and xSemaphoreCreateRecursiveMutex
|
|
* Can be used in IRQ mode (within ISR context)
|
|
*/
|
|
class Mutex {
|
|
private:
|
|
SemaphoreHandle_t semaphore;
|
|
MutexType type;
|
|
public:
|
|
explicit Mutex(MutexType type = MutexTypeNormal);
|
|
~Mutex();
|
|
|
|
TtStatus acquire(uint32_t timeout) const;
|
|
TtStatus release() const;
|
|
ThreadId getOwner() const;
|
|
};
|
|
|
|
/** Allocate Mutex
|
|
*
|
|
* @param[in] type The mutex type
|
|
*
|
|
* @return pointer to Mutex instance
|
|
*/
|
|
|
|
[[deprecated("use class")]]
|
|
Mutex* tt_mutex_alloc(MutexType type);
|
|
|
|
/** Free Mutex
|
|
*
|
|
* @param mutex The Mutex instance
|
|
*/
|
|
[[deprecated("use class")]]
|
|
void tt_mutex_free(Mutex* mutex);
|
|
|
|
/** Acquire mutex
|
|
*
|
|
* @param mutex The Mutex instance
|
|
* @param[in] timeout The timeout
|
|
*
|
|
* @return The status.
|
|
*/
|
|
[[deprecated("use class")]]
|
|
TtStatus tt_mutex_acquire(Mutex* mutex, uint32_t timeout);
|
|
|
|
/** Release mutex
|
|
*
|
|
* @param mutex The Mutex instance
|
|
*
|
|
* @return The status.
|
|
*/
|
|
[[deprecated("use class")]]
|
|
TtStatus tt_mutex_release(Mutex* mutex);
|
|
|
|
/** Get mutex owner thread id
|
|
*
|
|
* @param mutex The Mutex instance
|
|
*
|
|
* @return The thread identifier.
|
|
*/
|
|
[[deprecated("use class")]]
|
|
ThreadId tt_mutex_get_owner(Mutex* mutex);
|
|
|
|
} // namespace
|