diff options
author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-01-11 11:28:32 +0000 |
---|---|---|
committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-01-11 11:28:32 +0000 |
commit | 382151cf63ff5ef3144fc38bb87490d33da7b2d3 (patch) | |
tree | a1ebbe48fe92cc5fa9f6a0493812269820747b9d /src/chsem.c | |
parent | 36c9110259212470667c7cc95bb99ca577945d87 (diff) | |
download | ChibiOS-382151cf63ff5ef3144fc38bb87490d33da7b2d3.tar.gz ChibiOS-382151cf63ff5ef3144fc38bb87490d33da7b2d3.tar.bz2 ChibiOS-382151cf63ff5ef3144fc38bb87490d33da7b2d3.zip |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@619 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'src/chsem.c')
-rw-r--r-- | src/chsem.c | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/src/chsem.c b/src/chsem.c index d29e97268..094a30d4e 100644 --- a/src/chsem.c +++ b/src/chsem.c @@ -27,7 +27,7 @@ #ifdef CH_USE_SEMAPHORES
/**
* Initializes a semaphore with the specified counter value.
- * @param sp pointer to a \p Semaphore structure
+ * @param sp pointer to a @p Semaphore structure
* @param n initial value of the semaphore counter. Must be non-negative.
* @note Can be called with interrupts disabled or enabled.
*/
@@ -40,11 +40,11 @@ void chSemInit(Semaphore *sp, cnt_t n) { /**
* Performs a reset operation on the semaphore.
- * @param sp pointer to a \p Semaphore structure
+ * @param sp pointer to a @p Semaphore structure
* @param n the new value of the semaphore counter. The value must be non-negative.
* @note The released threads can recognize they were waked up by a reset
- * instead than a signal because the \p chSemWait() will return
- * \p RDY_RESET instead of \p RDY_OK.
+ * instead than a signal because the @p chSemWait() will return
+ * @p RDY_RESET instead of @p RDY_OK.
*/
void chSemReset(Semaphore *sp, cnt_t n) {
@@ -58,11 +58,11 @@ void chSemReset(Semaphore *sp, cnt_t n) { /**
* Performs a reset operation on the semaphore.
- * @param sp pointer to a \p Semaphore structure
+ * @param sp pointer to a @p Semaphore structure
* @param n the new value of the semaphore counter. The value must be non-negative.
* @note The released threads can recognize they were waked up by a reset
- * instead than a signal because the \p chSemWait() will return
- * \p RDY_RESET instead of \p RDY_OK.
+ * instead than a signal because the @p chSemWait() will return
+ * @p RDY_RESET instead of @p RDY_OK.
* @note This function does not reschedule.
*/
void chSemResetI(Semaphore *sp, cnt_t n) {
@@ -77,9 +77,9 @@ void chSemResetI(Semaphore *sp, cnt_t n) { /**
* Performs a wait operation on a semaphore.
- * @param sp pointer to a \p Semaphore structure
+ * @param sp pointer to a @p Semaphore structure
* @retval RDY_OK if the semaphore was signaled or not taken.
- * @retval RDY_RESET if the semaphore was reset using \p chSemReset().
+ * @retval RDY_RESET if the semaphore was reset using @p chSemReset().
*/
msg_t chSemWait(Semaphore *sp) {
msg_t msg;
@@ -94,9 +94,9 @@ msg_t chSemWait(Semaphore *sp) { /**
* Performs a wait operation on a semaphore.
- * @param sp pointer to a \p Semaphore structure
+ * @param sp pointer to a @p Semaphore structure
* @retval RDY_OK if the semaphore was signaled or not taken.
- * @retval RDY_RESET if the semaphore was reset using \p chSemReset().
+ * @retval RDY_RESET if the semaphore was reset using @p chSemReset().
* @note This function must be called with interrupts disabled.
* @note This function cannot be called by an interrupt handler.
*/
@@ -114,14 +114,14 @@ msg_t chSemWaitS(Semaphore *sp) { #ifdef CH_USE_SEMAPHORES_TIMEOUT
/**
* Performs a wait operation on a semaphore with timeout specification.
- * @param sp pointer to a \p Semaphore structure
+ * @param sp pointer to a @p Semaphore structure
* @param time the number of ticks before the operation fails
* @retval RDY_OK if the semaphore was signaled or not taken.
- * @retval RDY_RESET if the semaphore was reset using \p chSemReset().
+ * @retval RDY_RESET if the semaphore was reset using @p chSemReset().
* @retval RDY_TIMEOUT if the semaphore was not signaled or reset within the
* specified timeout.
- * @note The function is available only if the \p CH_USE_SEMAPHORES_TIMEOUT
- * option is enabled in \p chconf.h.
+ * @note The function is available only if the @p CH_USE_SEMAPHORES_TIMEOUT
+ * option is enabled in @p chconf.h.
*/
msg_t chSemWaitTimeout(Semaphore *sp, systime_t time) {
msg_t msg;
@@ -136,14 +136,14 @@ msg_t chSemWaitTimeout(Semaphore *sp, systime_t time) { /**
* Performs a wait operation on a semaphore with timeout specification.
- * @param sp pointer to a \p Semaphore structure
+ * @param sp pointer to a @p Semaphore structure
* @param time the number of ticks before the operation fails
* @retval RDY_OK if the semaphore was signaled or not taken.
- * @retval RDY_RESET if the semaphore was reset using \p chSemReset().
+ * @retval RDY_RESET if the semaphore was reset using @p chSemReset().
* @retval RDY_TIMEOUT if the semaphore was not signaled or reset within the specified
* timeout.
- * @note The function is available only if the \p CH_USE_SEMAPHORES_TIMEOUT
- * option is enabled in \p chconf.h.
+ * @note The function is available only if the @p CH_USE_SEMAPHORES_TIMEOUT
+ * option is enabled in @p chconf.h.
*/
msg_t chSemWaitTimeoutS(Semaphore *sp, systime_t time) {
@@ -158,9 +158,9 @@ msg_t chSemWaitTimeoutS(Semaphore *sp, systime_t time) { /**
* Performs a signal operation on a semaphore.
- * @param sp pointer to a \p Semaphore structure
- * @note The function is available only if the \p CH_USE_SEMAPHORES
- * option is enabled in \p chconf.h.
+ * @param sp pointer to a @p Semaphore structure
+ * @note The function is available only if the @p CH_USE_SEMAPHORES
+ * option is enabled in @p chconf.h.
*/
void chSemSignal(Semaphore *sp) {
@@ -174,9 +174,9 @@ void chSemSignal(Semaphore *sp) { /**
* Performs a signal operation on a semaphore.
- * @param sp pointer to a \p Semaphore structure
- * @note The function is available only if the \p CH_USE_SEMAPHORES
- * option is enabled in \p chconf.h.
+ * @param sp pointer to a @p Semaphore structure
+ * @note The function is available only if the @p CH_USE_SEMAPHORES
+ * option is enabled in @p chconf.h.
* @note This function does not reschedule.
*/
void chSemSignalI(Semaphore *sp) {
@@ -193,12 +193,12 @@ void chSemSignalI(Semaphore *sp) { #ifdef CH_USE_SEMSW
/**
* Performs atomic signal and wait operations on two semaphores.
- * @param sps pointer to a \p Semaphore structure to be signaled
- * @param spw pointer to a \p Semaphore structure to be wait on
+ * @param sps pointer to a @p Semaphore structure to be signaled
+ * @param spw pointer to a @p Semaphore structure to be wait on
* @retval RDY_OK if the semaphore was signaled or not taken.
- * @retval RDY_RESET if the semaphore was reset using \p chSemReset().
- * @note The function is available only if the \p CH_USE_SEMSW
- * option is enabled in \p chconf.h.
+ * @retval RDY_RESET if the semaphore was reset using @p chSemReset().
+ * @note The function is available only if the @p CH_USE_SEMSW
+ * option is enabled in @p chconf.h.
*/
msg_t chSemSignalWait(Semaphore *sps, Semaphore *spw) {
msg_t msg;
|