From 76b6b659291973e23b6ecbe8459baeac0577f1d8 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Sun, 23 Nov 2014 17:14:56 +0000 Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7527 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/rt/dox/rt.dox | 183 ++++++++++++++++++++++++++++++++++++++++++ os/rt/include/chthreads.h | 2 + os/rt/rt.dox | 173 --------------------------------------- os/rt/src/chcond.c | 2 +- os/rt/src/chstats.c | 3 + os/rt/src/chsys.c | 2 + os/rt/src/chthreads.c | 4 +- os/rt/templates/meta/module.c | 81 +++++++++++++++++++ os/rt/templates/meta/module.h | 77 ++++++++++++++++++ os/rt/templates/module.c | 81 ------------------- os/rt/templates/module.h | 77 ------------------ 11 files changed, 352 insertions(+), 333 deletions(-) create mode 100644 os/rt/dox/rt.dox delete mode 100644 os/rt/rt.dox create mode 100644 os/rt/templates/meta/module.c create mode 100644 os/rt/templates/meta/module.h delete mode 100644 os/rt/templates/module.c delete mode 100644 os/rt/templates/module.h (limited to 'os') diff --git a/os/rt/dox/rt.dox b/os/rt/dox/rt.dox new file mode 100644 index 000000000..5d198727f --- /dev/null +++ b/os/rt/dox/rt.dox @@ -0,0 +1,183 @@ +/* + ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010, + 2011,2012,2013,2014 Giovanni Di Sirio. + + This file is part of ChibiOS/RT. + + ChibiOS/RT is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + ChibiOS/RT is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +*/ + +/** + * @defgroup kernel RT Kernel + * @details The kernel is the portable part of ChibiOS/RT, this section + * documents the various kernel subsystems. + */ + +/** + * @defgroup kernel_info Version Numbers and Identification + * @ingroup kernel + */ + +/** + * @defgroup config Configuration + * @ingroup kernel + */ + +/** + * @defgroup types Types + * @details The system types are defined into the port layer, please refer to + * the core port implementation section. + * @ingroup kernel + */ + +/** + * @defgroup base Base Kernel Services + * @details Base kernel services, the base subsystems are always included in + * the OS builds. + * @ingroup kernel + */ + +/** + * @defgroup system System Management + * @ingroup base + */ + +/** + * @defgroup scheduler Scheduler + * @ingroup base + */ + +/** + * @defgroup threads Threads + * @ingroup base + */ + +/** + * @defgroup time Time and Virtual Timers + * @ingroup base + */ + +/** + * @defgroup synchronization Synchronization + * @details Synchronization services. + * @ingroup kernel + */ + +/** + * @defgroup semaphores Counting Semaphores + * @ingroup synchronization + */ + +/** + * @defgroup binary_semaphores Binary Semaphores + * @ingroup synchronization + */ + +/** + * @defgroup mutexes Mutexes + * @ingroup synchronization + */ + +/** + * @defgroup condvars Condition Variables + * @ingroup synchronization + */ + +/** + * @defgroup events Event Flags + * @ingroup synchronization + */ + +/** + * @defgroup messages Synchronous Messages + * @ingroup synchronization + */ + +/** + * @defgroup mailboxes Mailboxes + * @ingroup synchronization + */ + +/** + * @defgroup io_queues I/O Queues + * @ingroup synchronization + */ + +/** + * @defgroup memory Memory Management + * @details Memory Management services. + * @ingroup kernel + */ + +/** + * @defgroup memcore Core Memory Manager + * @ingroup memory + */ + +/** + * @defgroup heaps Heaps + * @ingroup memory + */ + +/** + * @defgroup pools Memory Pools + * @ingroup memory + */ + +/** + * @defgroup dynamic_threads Dynamic Threads + * @ingroup memory + */ + + /** + * @defgroup streams Streams and Files + * @details Stream and Files interfaces. + * @ingroup kernel + */ + +/** + * @defgroup data_streams Abstract Sequential Streams + * @ingroup streams + */ + +/** + * @defgroup data_files Abstract File Streams + * @ingroup streams + */ + +/** + * @defgroup registry Registry + * @ingroup kernel + */ + +/** + * @defgroup debug Debug + * @ingroup kernel + */ + +/** + * @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/rt.dox b/os/rt/rt.dox deleted file mode 100644 index bb872d1ed..000000000 --- a/os/rt/rt.dox +++ /dev/null @@ -1,173 +0,0 @@ -/* - ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010, - 2011,2012,2013,2014 Giovanni Di Sirio. - - This file is part of ChibiOS/RT. - - ChibiOS/RT is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - ChibiOS/RT is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . -*/ - -/** - * @defgroup kernel Kernel - * @details The kernel is the portable part of ChibiOS/RT, this section - * documents the various kernel subsystems. - */ - -/** - * @defgroup kernel_info Version Numbers and Identification - * @ingroup kernel - */ - -/** - * @defgroup config Configuration - * @ingroup kernel - */ - -/** - * @defgroup types Types - * @details The system types are defined into the port layer, please refer to - * the core port implementation section. - * @ingroup kernel - */ - -/** - * @defgroup base Base Kernel Services - * @details Base kernel services, the base subsystems are always included in - * the OS builds. - * @ingroup kernel - */ - -/** - * @defgroup system System Management - * @ingroup base - */ - -/** - * @defgroup scheduler Scheduler - * @ingroup base - */ - -/** - * @defgroup threads Threads - * @ingroup base - */ - -/** - * @defgroup time Time and Virtual Timers - * @ingroup base - */ - -/** - * @defgroup synchronization Synchronization - * @details Synchronization services. - * @ingroup kernel - */ - -/** - * @defgroup semaphores Counting Semaphores - * @ingroup synchronization - */ - -/** - * @defgroup binary_semaphores Binary Semaphores - * @ingroup synchronization - */ - -/** - * @defgroup mutexes Mutexes - * @ingroup synchronization - */ - -/** - * @defgroup condvars Condition Variables - * @ingroup synchronization - */ - -/** - * @defgroup events Event Flags - * @ingroup synchronization - */ - -/** - * @defgroup messages Synchronous Messages - * @ingroup synchronization - */ - -/** - * @defgroup mailboxes Mailboxes - * @ingroup synchronization - */ - -/** - * @defgroup io_queues I/O Queues - * @ingroup synchronization - */ - -/** - * @defgroup memory Memory Management - * @details Memory Management services. - * @ingroup kernel - */ - -/** - * @defgroup memcore Core Memory Manager - * @ingroup memory - */ - -/** - * @defgroup heaps Heaps - * @ingroup memory - */ - -/** - * @defgroup pools Memory Pools - * @ingroup memory - */ - -/** - * @defgroup dynamic_threads Dynamic Threads - * @ingroup memory - */ - - /** - * @defgroup streams Streams and Files - * @details Stream and Files interfaces. - * @ingroup kernel - */ - -/** - * @defgroup data_streams Abstract Sequential Streams - * @ingroup streams - */ - -/** - * @defgroup data_files Abstract File Streams - * @ingroup streams - */ - -/** - * @defgroup registry Registry - * @ingroup kernel - */ - -/** - * @defgroup debug Debug - * @ingroup kernel - */ - -/** - * @defgroup internals Internals - * @ingroup kernel - */ - 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/meta/module.c b/os/rt/templates/meta/module.c new file mode 100644 index 000000000..0e6e186fd --- /dev/null +++ b/os/rt/templates/meta/module.c @@ -0,0 +1,81 @@ +/* + ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010, + 2011,2012,2013,2014 Giovanni Di Sirio. + + This file is part of ChibiOS/RT. + + ChibiOS/RT is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + ChibiOS/RT is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +*/ + +/** + * @file chXxx.c + * @brief XXX module code. + * + * @addtogroup XXX + * @{ + */ + +#include "ch.h" + +#if CH_CFG_USE_XXX || defined(__DOXYGEN__) + +/*===========================================================================*/ +/* Module local definitions. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Module exported variables. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Module local types. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Module local variables. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Module local functions. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Module exported functions. */ +/*===========================================================================*/ + +/** + * @brief XXX Module initialization. + * @note This function is implicitly invoked on system initialization, + * there is no need to explicitly initialize the module. + * + * @notapi + */ +void _xxx_init(void) { + +} + +/** + * @brief Initializes a @p xxx_t object. + * + * @param[out] xxxp pointer to the @p xxx_t object + * + * @init + */ +void chXxxObjectInit(xxx_t *xxxp) { + +} + +#endif /* CH_CFG_USE_XXX */ + +/** @} */ diff --git a/os/rt/templates/meta/module.h b/os/rt/templates/meta/module.h new file mode 100644 index 000000000..6bd8a2c4d --- /dev/null +++ b/os/rt/templates/meta/module.h @@ -0,0 +1,77 @@ +/* + ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010, + 2011,2012,2013,2014 Giovanni Di Sirio. + + This file is part of ChibiOS/RT. + + ChibiOS/RT is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + ChibiOS/RT is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +*/ + +/** + * @file chXxx.h + * @brief XXX Module macros and structures. + * + * @addtogroup XXX + * @{ + */ + +#ifndef _CHXXX_H_ +#define _CHXXX_H_ + +#include "ch.h" + +#if CH_CFG_USE_XXX || defined(__DOXYGEN__) + +/*===========================================================================*/ +/* Module constants. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Module pre-compile time settings. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Derived constants and error checks. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Module data structures and types. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Module macros. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* External declarations. */ +/*===========================================================================*/ + +#ifdef __cplusplus +extern "C" { +#endif + void chXxxInit(void); + void chXxxObjectInit(xxx_t *xxxp); +#ifdef __cplusplus +} +#endif + +/*===========================================================================*/ +/* Module inline functions. */ +/*===========================================================================*/ + +#endif /* CH_CFG_USE_XXX */ + +#endif /* _CHXXX_H_ */ + +/** @} */ diff --git a/os/rt/templates/module.c b/os/rt/templates/module.c deleted file mode 100644 index 0e6e186fd..000000000 --- a/os/rt/templates/module.c +++ /dev/null @@ -1,81 +0,0 @@ -/* - ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010, - 2011,2012,2013,2014 Giovanni Di Sirio. - - This file is part of ChibiOS/RT. - - ChibiOS/RT is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - ChibiOS/RT is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . -*/ - -/** - * @file chXxx.c - * @brief XXX module code. - * - * @addtogroup XXX - * @{ - */ - -#include "ch.h" - -#if CH_CFG_USE_XXX || defined(__DOXYGEN__) - -/*===========================================================================*/ -/* Module local definitions. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module exported variables. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module local types. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module local variables. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module local functions. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module exported functions. */ -/*===========================================================================*/ - -/** - * @brief XXX Module initialization. - * @note This function is implicitly invoked on system initialization, - * there is no need to explicitly initialize the module. - * - * @notapi - */ -void _xxx_init(void) { - -} - -/** - * @brief Initializes a @p xxx_t object. - * - * @param[out] xxxp pointer to the @p xxx_t object - * - * @init - */ -void chXxxObjectInit(xxx_t *xxxp) { - -} - -#endif /* CH_CFG_USE_XXX */ - -/** @} */ diff --git a/os/rt/templates/module.h b/os/rt/templates/module.h deleted file mode 100644 index 6bd8a2c4d..000000000 --- a/os/rt/templates/module.h +++ /dev/null @@ -1,77 +0,0 @@ -/* - ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010, - 2011,2012,2013,2014 Giovanni Di Sirio. - - This file is part of ChibiOS/RT. - - ChibiOS/RT is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - ChibiOS/RT is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . -*/ - -/** - * @file chXxx.h - * @brief XXX Module macros and structures. - * - * @addtogroup XXX - * @{ - */ - -#ifndef _CHXXX_H_ -#define _CHXXX_H_ - -#include "ch.h" - -#if CH_CFG_USE_XXX || defined(__DOXYGEN__) - -/*===========================================================================*/ -/* Module constants. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module pre-compile time settings. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Derived constants and error checks. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module data structures and types. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module macros. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* External declarations. */ -/*===========================================================================*/ - -#ifdef __cplusplus -extern "C" { -#endif - void chXxxInit(void); - void chXxxObjectInit(xxx_t *xxxp); -#ifdef __cplusplus -} -#endif - -/*===========================================================================*/ -/* Module inline functions. */ -/*===========================================================================*/ - -#endif /* CH_CFG_USE_XXX */ - -#endif /* _CHXXX_H_ */ - -/** @} */ -- cgit v1.2.3