diff options
Diffstat (limited to 'os')
| -rw-r--r-- | os/rt/dox/rt.dox (renamed from os/rt/rt.dox) | 16 | ||||
| -rw-r--r-- | os/rt/include/chthreads.h | 2 | ||||
| -rw-r--r-- | os/rt/src/chcond.c | 2 | ||||
| -rw-r--r-- | os/rt/src/chstats.c | 3 | ||||
| -rw-r--r-- | os/rt/src/chsys.c | 2 | ||||
| -rw-r--r-- | os/rt/src/chthreads.c | 4 | ||||
| -rw-r--r-- | os/rt/templates/meta/module.c (renamed from os/rt/templates/module.c) | 0 | ||||
| -rw-r--r-- | os/rt/templates/meta/module.h (renamed from os/rt/templates/module.h) | 0 |
8 files changed, 24 insertions, 5 deletions
diff --git a/os/rt/rt.dox b/os/rt/dox/rt.dox index bb872d1ed..5d198727f 100644 --- a/os/rt/rt.dox +++ b/os/rt/dox/rt.dox @@ -19,7 +19,7 @@ */
/**
- * @defgroup kernel Kernel
+ * @defgroup kernel RT Kernel
* @details The kernel is the portable part of ChibiOS/RT, this section
* documents the various kernel subsystems.
*/
@@ -167,7 +167,17 @@ */
/**
- * @defgroup internals Internals
+ * @defgroup time_measurement Time Measurement
* @ingroup kernel
*/
-
+
+/**
+ * @defgroup statistics Statistics
+ * @ingroup kernel
+ */
+
+/**
+ * @defgroup core Port Layer
+ * @ingroup kernel
+ */
+
\ No newline at end of file diff --git a/os/rt/include/chthreads.h b/os/rt/include/chthreads.h index fa093b09c..4c23fbec2 100644 --- a/os/rt/include/chthreads.h +++ b/os/rt/include/chthreads.h @@ -335,6 +335,8 @@ static inline bool chThdShouldTerminateX(void) { * @brief Resumes a thread created with @p chThdCreateI().
*
* @param[in] tp pointer to the thread
+ * @return The pointer to the @p thread_t structure allocated for
+ * the thread into the working space area.
*
* @iclass
*/
diff --git a/os/rt/src/chcond.c b/os/rt/src/chcond.c index cd6ab1d43..a9bf3cc6c 100644 --- a/os/rt/src/chcond.c +++ b/os/rt/src/chcond.c @@ -25,7 +25,7 @@ * @file chcond.c
* @brief Condition Variables code.
*
- * @addtogroup condition variables Condition Variables
+ * @addtogroup condvars
* @details This module implements the Condition Variables mechanism. Condition
* variables are an extensions to the mutex subsystem and cannot
* work alone.
diff --git a/os/rt/src/chstats.c b/os/rt/src/chstats.c index 45d8e8bd2..3c8d9ba04 100644 --- a/os/rt/src/chstats.c +++ b/os/rt/src/chstats.c @@ -78,6 +78,9 @@ void _stats_increase_irq(void) { /**
* @brief Updates context switch related statistics.
+ *
+ * @param[in] ntp the thread to be switched in
+ * @param[in] otp the thread to be switched out
*/
void _stats_ctxswc(thread_t *ntp, thread_t *otp) {
diff --git a/os/rt/src/chsys.c b/os/rt/src/chsys.c index b5c83b95a..2a60e6d69 100644 --- a/os/rt/src/chsys.c +++ b/os/rt/src/chsys.c @@ -159,6 +159,8 @@ void chSysInit(void) { * in debug mode.
* @note Can be invoked from any system state.
*
+ * @param[in] reason pointer to an error string
+ *
* @special
*/
void chSysHalt(const char *reason) {
diff --git a/os/rt/src/chthreads.c b/os/rt/src/chthreads.c index 61b0755f2..1c9508362 100644 --- a/os/rt/src/chthreads.c +++ b/os/rt/src/chthreads.c @@ -176,7 +176,7 @@ void _thread_memfill(uint8_t *startp, uint8_t *endp, uint8_t v) { * @iclass
*/
thread_t *chThdCreateI(void *wsp, size_t size,
- tprio_t prio, tfunc_t pf, void *arg) {
+ tprio_t prio, tfunc_t pf, void *arg) {
/* The thread structure is laid out in the lower part of the thread
workspace.*/
thread_t *tp = wsp;
@@ -227,6 +227,8 @@ thread_t *chThdCreateStatic(void *wsp, size_t size, * @brief Resumes a thread created with @p chThdCreateI().
*
* @param[in] tp pointer to the thread
+ * @return The pointer to the @p thread_t structure allocated for
+ * the thread into the working space area.
*
* @api
*/
diff --git a/os/rt/templates/module.c b/os/rt/templates/meta/module.c index 0e6e186fd..0e6e186fd 100644 --- a/os/rt/templates/module.c +++ b/os/rt/templates/meta/module.c diff --git a/os/rt/templates/module.h b/os/rt/templates/meta/module.h index 6bd8a2c4d..6bd8a2c4d 100644 --- a/os/rt/templates/module.h +++ b/os/rt/templates/meta/module.h |