From d785c8a7e5e58dc2ef41afdfee47e605ef1216f5 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Sat, 7 Mar 2009 11:47:38 +0000 Subject: Documentation fixes about timeouts, improved checks in chVTSetI(). git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@812 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- src/chsem.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'src/chsem.c') 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 -- cgit v1.2.3