zcy
/
tinySA
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved descriptions. 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1561 35acf78f-673a-0410-8e92-d51de3d6d3f4
master
gdisirio 2010-02-02 21:33:14 +00:00
parent ca20fd81f6
commit 7e9725de2f
2 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
os/kernel/include/threads.h
View File

@ -176,7 +176,7 @@ extern "C" {
void chThdExit(msg_t msg); void chThdExit(msg_t msg);
#if CH_USE_DYNAMIC #if CH_USE_DYNAMIC
Thread *chThdAddRef(Thread *tp); Thread *chThdAddRef(Thread *tp);
Thread *chThdRelease(Thread *tp); void chThdRelease(Thread *tp);
#endif #endif
#if CH_USE_WAITEXIT #if CH_USE_WAITEXIT
msg_t chThdWait(Thread *tp); msg_t chThdWait(Thread *tp);

15
os/kernel/src/chthreads.c
View File

@ -345,7 +345,8 @@ void chThdExit(msg_t msg) {
* @brief Adds a reference to a thread object. * @brief Adds a reference to a thread object.
* *
* @param[in] tp pointer to the thread * @param[in] tp pointer to the thread
* @return The same thread pointer passed as parameter. * @return The same thread pointer passed as parameter representing the
* new reference.
*/ */
Thread *chThdAddRef(Thread *tp) { Thread *chThdAddRef(Thread *tp) {
@ -357,15 +358,14 @@ Thread *chThdAddRef(Thread *tp) {
} }
/** /**
* @brief Releases a reference to a thread object. * @brief Releases a reference to a thread object.
* @details If the references counter reaches zero and the thread is in * @details If the references counter reaches zero <b>and</b> the thread
* @p THD_STATE_FINAL state then the thread's memory is returned * is in the @p THD_STATE_FINAL state then the thread's memory is
* to the proper allocator. * returned to the proper allocator.
* @note Static threads are not affected. * @note Static threads are not affected.
* *
* @param[in] tp pointer to the thread * @param[in] tp pointer to the thread
* @return The same thread pointer passed as parameter.
*/ */
Thread *chThdRelease(Thread *tp) { void chThdRelease(Thread *tp) {
trefs_t refs; trefs_t refs;
chSysLock(); chSysLock();
@ -389,7 +389,6 @@ Thread *chThdRelease(Thread *tp) {
#endif #endif
} }
} }
return tp;
} }
#endif /* CH_USE_DYNAMIC */ #endif /* CH_USE_DYNAMIC */
@ -397,7 +396,7 @@ Thread *chThdRelease(Thread *tp) {
/** /**
* @brief Blocks the execution of the invoking thread until the specified * @brief Blocks the execution of the invoking thread until the specified
* thread terminates then the exit code is returned. * thread terminates then the exit code is returned.
* @details This function waits that the specified thread terminates then * @details This function waits for the specified thread to terminate then
* decrements its reference counter, if the counter reaches zero then * decrements its reference counter, if the counter reaches zero then
* the thread working area is returned to the proper allocator.<br> * the thread working area is returned to the proper allocator.<br>
* The memory used by the exited thread is handled in different ways * The memory used by the exited thread is handled in different ways