riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #6698 from Lotterleben/doc_thread_h

Browse Source 
thread.h: extend doc for msg_waiters and msg_array
This commit is contained in:
Martine Lenders 2017-11-16 19:25:52 +01:00 committed by GitHub
commit 4952ffbae7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
core/include/thread.h
View File

@ -181,27 +181,31 @@ struct _thread {
kernel_pid_t pid; /**< thread's process id */ kernel_pid_t pid; /**< thread's process id */
#ifdef MODULE_CORE_THREAD_FLAGS #if defined(MODULE_CORE_THREAD_FLAGS) || defined(DOXYGEN)
thread_flags_t flags; /**< currently set flags */ thread_flags_t flags; /**< currently set flags */
#endif #endif
clist_node_t rq_entry; /**< run queue entry */ clist_node_t rq_entry; /**< run queue entry */
#if defined(MODULE_CORE_MSG) || defined(MODULE_CORE_THREAD_FLAGS) \ #if defined(MODULE_CORE_MSG) || defined(MODULE_CORE_THREAD_FLAGS) \
|| defined(MODULE_CORE_MBOX) || defined(MODULE_CORE_MBOX) || defined(DOXYGEN)
void *wait_data; /**< used by msg, mbox and thread void *wait_data; /**< used by msg, mbox and thread
flags */ flags */
#endif #endif
#if defined(MODULE_CORE_MSG) #if defined(MODULE_CORE_MSG) || defined(DOXYGEN)
list_node_t msg_waiters; /**< threads waiting on message */ list_node_t msg_waiters; /**< threads waiting for their message
cib_t msg_queue; /**< message queue */ to be delivered to this thread
msg_t *msg_array; /**< memory holding messages */ (i.e. all blocked sends) */
cib_t msg_queue; /**< index of this [thread's message queue]
(thread_t::msg_array), if any */
msg_t *msg_array; /**< memory holding messages sent
to this thread's message queue */
#endif #endif
#if defined(DEVELHELP) || defined(SCHED_TEST_STACK) \
#if defined(DEVELHELP) || defined(SCHED_TEST_STACK) || defined(MODULE_MPU_STACK_GUARD) || defined(MODULE_MPU_STACK_GUARD) || defined(DOXYGEN)
char *stack_start; /**< thread's stack start address */ char *stack_start; /**< thread's stack start address */
#endif #endif
#ifdef DEVELHELP #if defined(DEVELHELP) || defined(DOXYGEN)
const char *name; /**< thread's name */ const char *name; /**< thread's name */
int stack_size; /**< thread's stack size */ int stack_size; /**< thread's stack size */
#endif #endif