diff options
42 files changed, 100 insertions, 46 deletions
diff --git a/docs/ch.txt b/docs/ch.txt index 5e2fd2077..4a0ab9e0c 100644 --- a/docs/ch.txt +++ b/docs/ch.txt @@ -88,7 +88,6 @@ /**
* @defgroup Kernel Kernel
* @{
- * @file ch.h ChibiOS/RT main include file, it includes everything else.
*/
/** @} */
@@ -97,7 +96,6 @@ * @{
* In @p chconf.h are defined the required subsystems for your application.
* @ingroup Kernel
- * @file chconf.h ChibiOS/RT configuration file.
*/
/** @} */
@@ -106,8 +104,6 @@ * @{
* Non portable code templates.
* @ingroup Kernel
- * @file src/templates/chcore.c Non portable code template file.
- * @file src/templates/chcore.h Non portable macros and structures template file.
*/
/** @} */
@@ -116,7 +112,6 @@ * @{
* System types and macros.
* @ingroup Kernel
- * @file templates/chtypes.h System types and code modifiers.
*/
/** @} */
@@ -126,8 +121,6 @@ * Initialization, Locks, Interrupt Handling, Power Management, Abnormal
* Termination.
* @ingroup Kernel
- * @file sys.h System related macros and structures.
- * @file chsys.c System related code.
*/
/** @} */
@@ -136,7 +129,6 @@ * @{
* System inline-able code.
* @ingroup Kernel
- * @file inline.h Inline versions of some critical system routines.
*/
/** @} */
@@ -145,8 +137,6 @@ * @{
* Debug APIs and procedures.
* @ingroup Kernel
- * @file debug.h Debug macros and structures.
- * @file chdebug.c ChibiOS/RT Debug code.
*/
/** @} */
@@ -155,8 +145,6 @@ * @{
* ChibiOS/RT scheduler.
* @ingroup Kernel
- * @file chschd.c Scheduler code.
- * @file scheduler.h Scheduler macros and structures.
*/
/** @} */
@@ -165,8 +153,6 @@ * @{
* ChibiOS/RT thread lists and queues utilities.
* @ingroup Kernel
- * @file chlists.c Lists and queues code.
- * @file lists.h Lists and queues macros and structures.
*/
/** @} */
@@ -174,8 +160,6 @@ * @defgroup Threads Threads
* @{
* Threads creation and termination APIs.
- * @file threads.h Threads structures, macros and functions.
- * @file chthreads.c Threads code.
*/
/** @} */
@@ -183,8 +167,6 @@ * @defgroup Time Time and Virtual Timers
* @{
* Time and Virtual Timers related APIs.
- * @file include/vt.h Time macros and structures.
- * @file chvt.c Time functions.
*/
/** @} */
@@ -201,8 +183,6 @@ * instead of the system provided allocator.<br>
* In order to use the heap APIs the @p CH_USE_HEAP option must be specified
* in @p chconf.h.
- * @file include/heap.h Heap macros and structures.
- * @file chheap.c Heap functions.
*/
/** @} */
@@ -215,8 +195,6 @@ * <b>constant time</b> and reliably without memory fragmentation problems.<br>
* In order to use the Time APIs the @p CH_USE_MEMPOOLS option must be
* specified in @p chconf.h.
- * @file include/mempools.h Memory Pools macros and structures.
- * @file chmempools.c Memory Pools functions.
*/
/** @} */
@@ -243,8 +221,6 @@ * @p chconf.h.<br>
* In order to use the Semaphores APIs the @p CH_USE_SEMAPHORES
* option must be specified in @p chconf.h.<br><br>
- * @file semaphores.h Semaphores macros and structures.
- * @file chsem.c Semaphores code.
*/
/** @} */
@@ -280,8 +256,6 @@ * priority was not already equal or higher). The mechanism works with any
* number of nested mutexes and any number of involved threads. The algorithm
* complexity (worst case) is N with N equal to the number of nested mutexes.
- * @file mutexes.h Mutexes macros and structures.
- * @file chmtx.c Mutexes functions.
*/
/** @} */
@@ -295,8 +269,6 @@ * a Monitor construct.<br>
* In order to use the Condition Variables APIs the @p CH_USE_CONDVARS
* option must be specified in @p chconf.h.<br><br>
- * @file condvars.h Condition Variables macros and structures.
- * @file chcond.c Condition Variables code.
*/
/** @} */
@@ -318,8 +290,6 @@ * thread invokes a @p chEvtWaitXXX().<br>
* In order to use the Event APIs the @p CH_USE_EVENTS option must be
* specified in @p chconf.h.
- * @file events.h Events macros and structures.
- * @file chevents.c Events functions.
*/
/** @} */
@@ -341,8 +311,6 @@ * queue header).<br>
* In order to use the Messages APIs the @p CH_USE_MESSAGES option must be
* specified in @p chconf.h.
- * @file messages.h Messages macros and structures.
- * @file chmsg.c Messages functions.
*/
/** @} */
@@ -371,8 +339,6 @@ * be specified in @p chconf.h.<br>
* In order to use the half duplex queues the @p CH_USE_QUEUES_HALFDUPLEX
* option must be specified in @p chconf.h.
- * @file queues.h I/O Queues macros and structures.
- * @file chqueues.c I/O Queues code.
*/
/** @} */
@@ -389,8 +355,6 @@ * @p CH_USE_SERIAL_FULLDUPLEX option must be specified in @p chconf.h.<br>
* In order to use the serial half duplex driver the
* @p CH_USE_SERIAL_HALFDUPLEX option must be specified in @p chconf.h.
- * @file serial.h Serial Drivers macros and structures.
- * @file chserial.c Serial Drivers code.
*/
/** @} */
@@ -415,8 +379,6 @@ * from C++ as classes and objects rather the traditional "C" APIs.
*
* @ingroup utilities_library
- * @file ch.hpp C++ wrapper classes and definitions.
- * @file ch.cpp C++ wrapper code.
*/
/** @} */
@@ -429,8 +391,6 @@ * Multiple threads can listen to the same timer.
*
* @ingroup utilities_library
- * @file evtimer.c Events Generator Timer code.
- * @file evtimer.h Events Generator Timer structures and macros.
*/
/** @} */
diff --git a/readme.txt b/readme.txt index 2b57a245d..8e160341d 100644 --- a/readme.txt +++ b/readme.txt @@ -73,6 +73,12 @@ Win32-MinGW - ChibiOS/RT simulator and demo into a WIN32 process, *****************************************************************************
*** 1.1.0unstable ***
+- FIX: Modified the default value for the STM32 HSI setup it was 1, it should
+ be 0x10 (backport in stable branch).
+- FIX: Removed an obsolete constant (P_SUSPENDED) from thread.h (backport in
+ stable branch).
+- FIX: Removed unused field mp_grow in the MemoryPool structure (backport in
+ stable branch).
- NEW: Better separation between the port code and the system APIs, now an
architecture-specific "driver" contains all the port related code.
Port functions/macros are no more directly exposed as APIs to the user code.
@@ -114,12 +120,6 @@ Win32-MinGW - ChibiOS/RT simulator and demo into a WIN32 process, info they add and the size of all the images. It is possible to configure
Doxygen to have them again (and more graph types).
-*** 1.0.1 ***
-- FIX: Modified the default value for the STM32 HSI setup it was 1, it should
- be 0x10.
-- FIX: Removed an obsolete constant (P_SUSPENDED) from thread.h.
-- FIX: Removed unused field mp_grow in the MemoryPool structure.
-
*** 1.0.0 ***
- License switch, added GPL exception, see exception.txt.
- Full test cycle and test reports updated.
diff --git a/src/chcond.c b/src/chcond.c index 09979a64e..7b37e454c 100644 --- a/src/chcond.c +++ b/src/chcond.c @@ -22,6 +22,8 @@ */
/**
+ * @file chcond.c
+ * @brief Condition Variables code.
* @addtogroup CondVars
* @{
*/
diff --git a/src/chdebug.c b/src/chdebug.c index 41a0adc62..8fa67bbf7 100644 --- a/src/chdebug.c +++ b/src/chdebug.c @@ -17,6 +17,13 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/**
+ * @file chdebug.c
+ * @brief ChibiOS/RT Debug code.
+ * @addtogroup CondVars
+ * @{
+ */
+
#include <ch.h>
#ifdef CH_USE_DEBUG
@@ -72,3 +79,5 @@ void chDbgTrace(Thread *otp, Thread *ntp) { #endif /* CH_USE_TRACE */
#endif /* CH_USE_DEBUG */
+
+/** @} */
diff --git a/src/chevents.c b/src/chevents.c index 8391f3a0c..7f75fbe42 100644 --- a/src/chevents.c +++ b/src/chevents.c @@ -18,6 +18,8 @@ */
/**
+ * @file chevents.c
+ * @brief Events code.
* @addtogroup Events
* @{
*/
diff --git a/src/chheap.c b/src/chheap.c index c07212226..72be4a57f 100644 --- a/src/chheap.c +++ b/src/chheap.c @@ -18,6 +18,8 @@ */
/**
+ * @file chheap.c
+ * @brief Heap code.
* @addtogroup Heap
* @{
*/
diff --git a/src/chlists.c b/src/chlists.c index ece7e7dd9..fbd9e6a51 100644 --- a/src/chlists.c +++ b/src/chlists.c @@ -18,6 +18,8 @@ */
/**
+ * @file chlists.c
+ * @brief Lists and queues code.
* @addtogroup ThreadLists
* @{
*/
diff --git a/src/chmempools.c b/src/chmempools.c index caaa60c44..1095f1c2b 100644 --- a/src/chmempools.c +++ b/src/chmempools.c @@ -18,6 +18,8 @@ */
/**
+ * @file chmempools.c
+ * @brief Memory Pools code.
* @addtogroup MemoryPools
* @{
*/
diff --git a/src/chmsg.c b/src/chmsg.c index 71eb431ef..1afe1bc99 100644 --- a/src/chmsg.c +++ b/src/chmsg.c @@ -18,9 +18,12 @@ */
/**
+ * @file chmsg.c
+ * @brief Messages code.
* @addtogroup Messages
* @{
*/
+
#include <ch.h>
#ifdef CH_USE_MESSAGES
diff --git a/src/chmtx.c b/src/chmtx.c index 47d1d7969..3a110f595 100644 --- a/src/chmtx.c +++ b/src/chmtx.c @@ -18,6 +18,8 @@ */ /** + * @file chmtx.c + * @brief Mutexes code. * @addtogroup Mutexes * @{ */ diff --git a/src/chqueues.c b/src/chqueues.c index ed0806c6d..69067efd4 100644 --- a/src/chqueues.c +++ b/src/chqueues.c @@ -18,6 +18,8 @@ */
/**
+ * @file chqueues.c
+ * @brief I/O Queues code.
* @addtogroup IOQueues
* @{
*/
diff --git a/src/chschd.c b/src/chschd.c index 2de941f0a..c3ee0c4a8 100644 --- a/src/chschd.c +++ b/src/chschd.c @@ -18,6 +18,8 @@ */ /** + * @file chschd.c + * @brief Scheduler code. * @addtogroup Scheduler * @{ */ diff --git a/src/chsem.c b/src/chsem.c index bc7e8f1b7..bb6070dd7 100644 --- a/src/chsem.c +++ b/src/chsem.c @@ -18,6 +18,8 @@ */
/**
+ * @file chsem.c
+ * @brief Semaphores code.
* @addtogroup Semaphores
* @{
*/
diff --git a/src/chserial.c b/src/chserial.c index 91a4834ab..9a2dd4018 100644 --- a/src/chserial.c +++ b/src/chserial.c @@ -18,6 +18,8 @@ */
/**
+ * @file chserial.c
+ * @brief Serial Drivers code.
* @addtogroup Serial
* @{
*/
diff --git a/src/chsys.c b/src/chsys.c index 807e2590f..e99c2acf4 100644 --- a/src/chsys.c +++ b/src/chsys.c @@ -18,6 +18,8 @@ */ /** + * @file chsys.c + * @brief System related code. * @addtogroup System * @{ */ diff --git a/src/chthreads.c b/src/chthreads.c index dc1a6f58c..24a7aa329 100644 --- a/src/chthreads.c +++ b/src/chthreads.c @@ -18,6 +18,8 @@ */ /** + * @file chthreads.c + * @brief Threads code. * @addtogroup Threads * @{ */ diff --git a/src/chvt.c b/src/chvt.c index 63bfd219e..5f4d380c8 100644 --- a/src/chvt.c +++ b/src/chvt.c @@ -18,6 +18,8 @@ */
/**
+ * @file chvt.c
+ * @brief Time related code.
* @addtogroup Time
* @{
*/
diff --git a/src/include/ch.h b/src/include/ch.h index 6e86de81b..374941e3e 100644 --- a/src/include/ch.h +++ b/src/include/ch.h @@ -18,6 +18,8 @@ */
/**
+ * @file ch.h
+ * @brief ChibiOS/RT main include file, it includes everything else.
* @addtogroup Kernel
* @{
*/
diff --git a/src/include/condvars.h b/src/include/condvars.h index ca7d8f56b..a311ba526 100644 --- a/src/include/condvars.h +++ b/src/include/condvars.h @@ -22,6 +22,8 @@ */
/**
+ * @file condvars.h
+ * @brief Condition Variables macros and structures.
* @addtogroup CondVars
* @{
*/
diff --git a/src/include/debug.h b/src/include/debug.h index 71a2613eb..a6b4ca7c1 100644 --- a/src/include/debug.h +++ b/src/include/debug.h @@ -18,6 +18,8 @@ */
/**
+ * @file debug.h
+ * @brief Debug macros and structures.
* @addtogroup Debug
* @{
*/
diff --git a/src/include/events.h b/src/include/events.h index 53d7bd72e..5def8f065 100644 --- a/src/include/events.h +++ b/src/include/events.h @@ -18,6 +18,8 @@ */
/**
+ * @file events.h
+ * @brief Events macros and structures.
* @addtogroup Events
* @{
*/
diff --git a/src/include/heap.h b/src/include/heap.h index b8633f5cf..4c9571070 100644 --- a/src/include/heap.h +++ b/src/include/heap.h @@ -18,6 +18,8 @@ */
/**
+ * @file heap.h
+ * @brief Heap macros and structures.
* @addtogroup Heap
* @{
*/
diff --git a/src/include/inline.h b/src/include/inline.h index 379a1f216..6f99ff329 100644 --- a/src/include/inline.h +++ b/src/include/inline.h @@ -18,6 +18,8 @@ */
/**
+ * @file inline.h
+ * @brief Inline versions of some critical system routines.
* @addtogroup Inline
* @{
*/
diff --git a/src/include/lists.h b/src/include/lists.h index 81b0aa943..a86d8175e 100644 --- a/src/include/lists.h +++ b/src/include/lists.h @@ -18,6 +18,8 @@ */
/**
+ * @file lists.h
+ * @brief Lists and queues macros and structures.
* @addtogroup ThreadLists
* @{
*/
diff --git a/src/include/mempools.h b/src/include/mempools.h index 5e9406e97..7bf67c77a 100644 --- a/src/include/mempools.h +++ b/src/include/mempools.h @@ -18,6 +18,8 @@ */
/**
+ * @file mempools.h
+ * @brief Memory Pools macros and structures.
* @addtogroup MemoryPools
* @{
*/
diff --git a/src/include/messages.h b/src/include/messages.h index d4bbb9851..c74febaf5 100644 --- a/src/include/messages.h +++ b/src/include/messages.h @@ -18,6 +18,8 @@ */
/**
+ * @file messages.h
+ * @brief Messages macros and structures.
* @addtogroup Messages
* @{
*/
diff --git a/src/include/mutexes.h b/src/include/mutexes.h index 5c313e526..d3e987ddf 100644 --- a/src/include/mutexes.h +++ b/src/include/mutexes.h @@ -18,6 +18,8 @@ */
/**
+ * @file mutexes.h
+ * @brief Mutexes macros and structures.
* @addtogroup Mutexes
* @{
*/
diff --git a/src/include/queues.h b/src/include/queues.h index f634cbbce..418ff73a8 100644 --- a/src/include/queues.h +++ b/src/include/queues.h @@ -18,6 +18,8 @@ */ /** + * @file queues.h I/O + * @brief Queues macros and structures. * @addtogroup IOQueues * @{ */ diff --git a/src/include/scheduler.h b/src/include/scheduler.h index 3d2f46e5e..25df4a3bd 100644 --- a/src/include/scheduler.h +++ b/src/include/scheduler.h @@ -18,6 +18,8 @@ */ /** + * @file scheduler.h + * @brief Scheduler macros and structures. * @addtogroup Scheduler * @{ */ diff --git a/src/include/semaphores.h b/src/include/semaphores.h index da6fcb628..bb25b4609 100644 --- a/src/include/semaphores.h +++ b/src/include/semaphores.h @@ -18,6 +18,8 @@ */
/**
+ * @file semaphores.h
+ * @brief Semaphores macros and structures.
* @addtogroup Semaphores
* @{
*/
diff --git a/src/include/serial.h b/src/include/serial.h index ffe030e4b..6a6299cf3 100644 --- a/src/include/serial.h +++ b/src/include/serial.h @@ -18,6 +18,8 @@ */
/**
+ * @file serial.h
+ * @brief Serial Drivers macros and structures.
* @addtogroup Serial
* @{
*/
diff --git a/src/include/sys.h b/src/include/sys.h index 80e3a0101..f559b5f52 100644 --- a/src/include/sys.h +++ b/src/include/sys.h @@ -18,6 +18,8 @@ */
/**
+ * @file sys.h
+ * @brief System related macros and structures.
* @addtogroup System
* @{
*/
diff --git a/src/include/threads.h b/src/include/threads.h index 8d5c572e6..c3f89d99b 100644 --- a/src/include/threads.h +++ b/src/include/threads.h @@ -18,6 +18,8 @@ */ /** + * @file threads.h + * @brief Threads macros and structures. * @addtogroup Threads * @{ */ diff --git a/src/include/vt.h b/src/include/vt.h index 1e718da3a..e104bb101 100644 --- a/src/include/vt.h +++ b/src/include/vt.h @@ -18,6 +18,8 @@ */
/**
+ * @file vt.h
+ * @brief Time macros and structures.
* @addtogroup Time
* @{
*/
diff --git a/src/lib/ch.cpp b/src/lib/ch.cpp index 61a5633d4..aaf357693 100644 --- a/src/lib/ch.cpp +++ b/src/lib/ch.cpp @@ -16,6 +16,12 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/**
+ * @file ch.cpp
+ * @brief C++ wrapper code.
+ * @addtogroup CPlusPlusLibrary
+ * @{
+ */
#include <ch.hpp>
@@ -329,3 +335,5 @@ namespace chibios_rt { #endif /* CH_USE_EVENTS_TIMEOUT */
#endif /* CH_USE_EVENTS */
}
+
+/** @} */
diff --git a/src/lib/ch.hpp b/src/lib/ch.hpp index 377eed6d6..66db61dd1 100644 --- a/src/lib/ch.hpp +++ b/src/lib/ch.hpp @@ -18,6 +18,8 @@ */
/**
+ * @file ch.hpp
+ * @brief C++ wrapper classes and definitions.
* @addtogroup CPlusPlusLibrary
* @{
*/
diff --git a/src/lib/evtimer.c b/src/lib/evtimer.c index 691484336..114a9b3a6 100644 --- a/src/lib/evtimer.c +++ b/src/lib/evtimer.c @@ -18,6 +18,8 @@ */
/**
+ * @file evtimer.c
+ * @brief Events Generator Timer code.
* @addtogroup event_timer
* @{
*/
diff --git a/src/lib/evtimer.h b/src/lib/evtimer.h index cb3e4c44c..acfc97eb1 100644 --- a/src/lib/evtimer.h +++ b/src/lib/evtimer.h @@ -18,6 +18,8 @@ */
/**
+ * @file evtimer.h
+ * @brief Events Generator Timer structures and macros.
* @addtogroup event_timer
* @{
*/
diff --git a/src/templates/chconf.h b/src/templates/chconf.h index 9f7a69135..c54820f58 100644 --- a/src/templates/chconf.h +++ b/src/templates/chconf.h @@ -18,6 +18,8 @@ */
/**
+ * @file src/templates/chconf.h
+ * @brief Configuration file template.
* @addtogroup Config
* @{
*/
diff --git a/src/templates/chcore.c b/src/templates/chcore.c index 838cffe60..95aeac1c5 100644 --- a/src/templates/chcore.c +++ b/src/templates/chcore.c @@ -18,6 +18,8 @@ */
/**
+ * @file src/templates/chcore.c
+ * @brief Port related template code.
* @addtogroup Core
* @{
*/
diff --git a/src/templates/chcore.h b/src/templates/chcore.h index 8c7ed97ef..fa0edd034 100644 --- a/src/templates/chcore.h +++ b/src/templates/chcore.h @@ -18,6 +18,8 @@ */
/**
+ * @file src/templates/chcore.h
+ * @brief Port related template macros and structures.
* @addtogroup Core
* @{
*/
diff --git a/src/templates/chtypes.h b/src/templates/chtypes.h index 780b2862e..80884245f 100644 --- a/src/templates/chtypes.h +++ b/src/templates/chtypes.h @@ -18,6 +18,8 @@ */
/**
+ * @file src/templates/chtypes.h
+ * @brief System types template.
* @addtogroup Types
* @{
*/
|