From f0a25b5e2b0e26e549145ff429fc707a5f7c6bb3 Mon Sep 17 00:00:00 2001
From: "Robin.Mueller" <robin.mueller.m@gmail.com>
Date: Tue, 2 Jun 2020 22:10:34 +0200
Subject: [PATCH] new timeout values for MUtexIF and SemaphIF

---
 ipc/MutexIF.h       | 17 +++++++++++++++--
 tasks/SemaphoreIF.h | 19 +++++++++++++++----
 2 files changed, 30 insertions(+), 6 deletions(-)

diff --git a/ipc/MutexIF.h b/ipc/MutexIF.h
index dcb1cf333..29e59e588 100644
--- a/ipc/MutexIF.h
+++ b/ipc/MutexIF.h
@@ -12,8 +12,21 @@
  */
 class MutexIF {
 public:
-	static const uint32_t NO_TIMEOUT; //!< Needs to be defined in implementation.
-	static const uint32_t MAX_TIMEOUT;
+	/**
+	 * @brief 	Timeout value used for polling lock attempt.
+	 * @details
+	 * If the lock is not successfull, MUTEX_TIMEOUT will be returned
+	 * immediately. Value needs to be defined in implementation.
+	 */
+	static const uint32_t POLLING;
+	/**
+	 * @brief 	Timeout value used for permanent blocking lock attempt.
+	 * @details
+	 * The task will be blocked (indefinitely) until the mutex is unlocked.
+	 * Value needs to be defined in implementation.
+	 */
+	static const uint32_t BLOCKING;
+
 	static const uint8_t INTERFACE_ID = CLASS_ID::MUTEX_IF;
 	/**
 	 * The system lacked the necessary resources (other than memory) to initialize another mutex.
diff --git a/tasks/SemaphoreIF.h b/tasks/SemaphoreIF.h
index a7c5a97b9..4fc92ebd3 100644
--- a/tasks/SemaphoreIF.h
+++ b/tasks/SemaphoreIF.h
@@ -21,10 +21,21 @@
 class SemaphoreIF {
 public:
 	virtual~ SemaphoreIF() {};
-	//! Needs to be defined in implementation. No blocking time
-	static const uint32_t NO_TIMEOUT;
-	//! Needs to be defined in implementation. Blocks indefinitely.
-	static const uint32_t MAX_TIMEOUT;
+	/**
+	 * @brief 	Timeout value used for polling lock attempt.
+	 * @details
+	 * If the lock is not successfull, MUTEX_TIMEOUT will be returned
+	 * immediately. Value needs to be defined in implementation.
+	 */
+	static const uint32_t POLLING;
+	/**
+	 * @brief 	Timeout value used for permanent blocking lock attempt.
+	 * @details
+	 * The task will be blocked (indefinitely) until the mutex is unlocked.
+	 * Value needs to be defined in implementation.
+	 */
+	static const uint32_t BLOCKING;
+
 	static const uint8_t INTERFACE_ID = CLASS_ID::SEMAPHORE_IF;
 	//! Semaphore timeout
 	static constexpr ReturnValue_t SEMAPHORE_TIMEOUT = MAKE_RETURN_CODE(1);