X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=Kernel%2Finclude%2Fsemaphore.h;h=db0b279b5f461632ca6e865702b83446a67e948e;hb=dd2491a82880ed9b01b5d66b1814d271921797a4;hp=0cf4b211ba609fd0bb23fbb39729a5beffc28f4a;hpb=635bc78017d8a4a16314a973e39c849b2afac795;p=tpg%2Facess2.git diff --git a/Kernel/include/semaphore.h b/Kernel/include/semaphore.h index 0cf4b211..db0b279b 100644 --- a/Kernel/include/semaphore.h +++ b/Kernel/include/semaphore.h @@ -32,7 +32,8 @@ struct sSemaphore { /** * \brief Initialise the semaphore * \param Sem Semaphore structure to initialsie - * \param Value Initial value of the semaphore + * \param InitValue Initial value of the semaphore + * \param MaxValue Maximum value for the semaphore * \param Module Module name * \param Name Symbolic name * \note Not always needed, as initialising to 0 is valid, but it is preferred @@ -43,10 +44,10 @@ struct sSemaphore { extern void Semaphore_Init(tSemaphore *Sem, int InitValue, int MaxValue, const char *Module, const char *Name); /** * \brief Acquire items from the semaphore - * \param Semaphore Semaphore structure to use + * \param Sem Semaphore structure to use * \param MaxToTake Maximum number of items to take off the list (if zero, as much as possible is taken) * \return Number of items fetched - * \retval 0 Semaphore interrupted + * \retval 0 Semaphore interrupted (signal/message) * \retval -1 Unspecified error */ extern int Semaphore_Wait(tSemaphore *Sem, int MaxToTake);