aboutsummaryrefslogtreecommitdiffstats
path: root/src/chsem.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/chsem.c')
-rw-r--r--src/chsem.c5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/chsem.c b/src/chsem.c
index 774611ea6..b682db108 100644
--- a/src/chsem.c
+++ b/src/chsem.c
@@ -132,7 +132,10 @@ msg_t chSemWaitS(Semaphore *sp) {
* @brief Performs a wait operation on a semaphore with timeout specification.
*
* @param sp pointer to a @p Semaphore structure
- * @param time the number of ticks before the operation fails
+ * @param time the number of ticks before the operation timeouts,
+ * the following special values are allowed:
+ * - @a TIME_ZERO immediate timeout.
+ * - @a TIME_INFINITE no timeout.
* @retval RDY_OK if the semaphore was signaled or not taken.
* @retval RDY_RESET if the semaphore was reset using @p chSemReset().
* @retval RDY_TIMEOUT if the semaphore was not signaled or reset within the