diff --git a/docs/Doxyfile b/docs/Doxyfile index 4c5d517e9..800c83ca1 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -574,9 +574,10 @@ WARN_LOGFILE = # with spaces. INPUT = ../docs/src \ + ../os/kernel \ ../os/kernel/include \ ../os/kernel/src \ - ../os/ports/templates \ + ../os/kernel/templates \ ../os/ports/GCC/ARM7 \ ../os/ports/GCC/ARM7/crt0.s \ ../os/ports/GCC/ARM7/chcoreasm.s \ diff --git a/docs/src/concepts.dox b/docs/src/concepts.dox index 8a7418b53..8add4464c 100644 --- a/docs/src/concepts.dox +++ b/docs/src/concepts.dox @@ -54,7 +54,7 @@ * - Regular Interrupts. Maskable interrupt sources that cannot * preempt the kernel code and are thus able to invoke operating system APIs * from within their handlers. The interrupt handlers belonging to this class - * must be written following some rules. See the @ref System APIs group and + * must be written following some rules. See the @ref system APIs group and * @ref article_interrupts. * - Fast Interrupts. Maskable interrupt sources with the ability * to preempt the kernel code and thus have a lower latency and are less @@ -244,7 +244,7 @@ * - Interrupt Stack. * - Internal Context. * . - * See the @ref Core documentation for details, the area may change on + * See the @ref core documentation for details, the area may change on * the various ports and some structures may not be present (or be zero-sized). * * @section architecture Architectural Diagram diff --git a/docs/src/main.dox b/docs/src/main.dox index d1cba5773..58e1b4e6a 100644 --- a/docs/src/main.dox +++ b/docs/src/main.dox @@ -100,249 +100,6 @@ * ChibiOS/RT ports. */ -/** - * @defgroup Kernel Kernel - * Kernel related subsystems, - */ - -/** - * @defgroup Config Configuration - * In @p chconf.h are defined the required subsystems for your application. - * @ingroup Kernel - */ - -/** - * @defgroup Core Port Code Templates - * Non portable code templates. The function and the macros defined under this - * section are the non portable part of the kernel. - * @note The port code is not an API, the applications should not invoke it - * directly, use the equivalent system API instead. - * @ingroup Kernel - */ - -/** - * @defgroup Types Types - * System types and macros. - * @ingroup Kernel - */ - -/** - * @defgroup System System Management - * Initialization, Locks, Interrupt Handling, Power Management, Abnormal - * Termination. - * @ingroup Kernel - */ - -/** - * @defgroup Debug Debug Support - * Debug APIs and procedures. - * @ingroup Kernel - */ - -/** - * @defgroup Scheduler Low Level Scheduler - * ChibiOS/RT scheduler APIs and macros. - * @ingroup Kernel - */ - -/** - * @defgroup ThreadLists Thread Lists and Queues - * ChibiOS/RT thread lists and queues utilities. - * @ingroup Kernel - */ - -/** - * @defgroup Threads Threads - * Threads related APIs. - * @ingroup Kernel - */ - -/** - * @defgroup Time Time and Virtual Timers - * Time and Virtual Timers related APIs. - * @ingroup Kernel - */ - -/** - * @defgroup Synchronization Synchronization - * Synchronization services. - */ - -/** - * @defgroup Semaphores Semaphores - * Semaphores and threads synchronization. - *

Operation mode

- * A semaphore is a threads synchronization object, some operations - * are defined on semaphores: - * - Signal: The semaphore counter is increased and if the result - * is non-positive then a waiting thread is removed from the semaphore - * queue and made ready for execution. - * - Wait: The semaphore counter is decreased and if the result - * becomes negative the thread is queued in the semaphore and suspended. - * - Reset: The semaphore counter is reset to a non-negative value - * and all the threads in the queue are released. - * . - * Semaphores can be used as guards for mutual exclusion code zones (note that - * mutexes are recommended for this kind of use) but also have other uses, - * queues guards and counters as example.
- * Semaphores usually use FIFO queues but it is possible to make them - * order threads by priority by specifying CH_USE_SEMAPHORES_PRIORITY in - * @p chconf.h.
- * In order to use the Semaphores APIs the @p CH_USE_SEMAPHORES - * option must be specified in @p chconf.h.

- * @ingroup Synchronization - */ - -/** - * @defgroup Mutexes Mutexes - * Mutexes and threads synchronization. - *

Operation mode

- * A mutex is a threads synchronization object, some operations are defined - * on mutexes: - * - Lock: The mutex is checked, if the mutex is not owned by some - * other thread then it is locked else the current thread is queued on the - * mutex in a list ordered by priority. - * - Unlock: The mutex is released by the owner and the highest - * priority thread waiting in the queue, if any, is resumed and made owner - * of the mutex. - * . - * In order to use the Event APIs the @p CH_USE_MUTEXES option must be - * specified in @p chconf.h.
- * - *

Constraints

- * In ChibiOS/RT the Unlock operations are always performed in Lock-reverse - * order. The Unlock API does not even have a parameter, the mutex to unlock - * is taken from an internal stack of owned mutexes. - * This both improves the performance and is required by an efficient - * implementation of the priority inheritance mechanism. - * - *

The priority inversion problem

- * The mutexes in ChibiOS/RT implements the full priority - * inheritance mechanism in order handle the priority inversion problem.
- * When a thread is queued on a mutex, any thread, directly or indirectly, - * holding the mutex gains the same priority of the waiting thread (if their - * 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. - * @ingroup Synchronization - */ - -/** - * @defgroup CondVars Condition Variables - * Condition Variables and threads synchronization. - *

Operation mode

- * The condition variable is a synchronization object meant to be used inside - * a zone protected by a @p Mutex. Mutexes and CondVars together can implement - * a Monitor construct.
- * In order to use the Condition Variables APIs the @p CH_USE_CONDVARS - * option must be specified in @p chconf.h.

- * @ingroup Synchronization - */ - -/** - * @defgroup Events Event Flags - * @brief Event Flags, Event Sources and Event Listeners. - *

Operation mode

- * Each thread has a mask of pending event flags inside its Thread structure. - * Several operations are defined: - * - Wait, the invoking thread goes to sleep until a certain AND/OR - * combination of event flags becomes pending. - * - Clear, a mask of event flags is cleared from the pending events - * mask, the cleared event flags mask is returned (only the flags that were - actually pending and then cleared). - * - Signal, an event mask is directly ORed to the mask of the signaled - * thread. - * - Broadcast, each thread registered on an Event Source is signaled - * with the event flags specified in its Event Listener. - * - Dispatch, an events mask is scanned and for each bit set to one - * an associated handler function is invoked. Bit masks are scanned from bit - * zero upward. - * . - * An Event Source is a special object that can be "broadcasted" by a thread or - * an interrupt service routine. Broadcasting an Event Source has the effect - * that all the threads registered on the Event Source will be signaled with - * and events mask.
- * An unlimited number of Event Sources can exists in a system and each - * thread can listen on an unlimited number of them.

- * In order to use the Event APIs the @p CH_USE_EVENTS option must be - * specified in @p chconf.h. - * @ingroup Synchronization - */ - -/** - * @defgroup Messages Synchronous Messages - * Synchronous inter-thread messages. - *

Operation Mode

- * Synchronous messages are an easy to use and fast IPC mechanism, threads - * can both serve messages and send messages to other threads, the mechanism - * allows data to be carried in both directions. Data is not copied between - * the client and server threads but just a pointer passed so the exchange - * is very time efficient.
- * Messages are usually processed in FIFO order but it is possible to process - * them in priority order by specifying CH_USE_MESSAGES_PRIORITY - * in @p chconf.h.
- * Threads do not need to allocate space for message queues, the mechanism - * just requires two extra pointers in the @p Thread structure (the message - * queue header).
- * In order to use the Messages APIs the @p CH_USE_MESSAGES option must be - * specified in @p chconf.h. - * @ingroup Synchronization - */ - -/** - * @defgroup Mailboxes Mailboxes - * Asynchronous messages. - *

Operation mode

- * A mailbox is an asynchronous communication mechanism.
- * The following operations are possible on a mailbox: - * - Post: Posts a message on the mailbox in FIFO order. - * - Post Ahead: Posts a message on the mailbox with high priority. - * - Fetch: A message is fetched from the mailbox and removed from - * the queue. - * - Reset: The mailbox is emptied and all the stored messages lost. - * . - * A message is a variable of type msg_t that is guaranteed to have the - * same size of and be compatible with pointers (an explicit cast is needed). - * If larger messages need to be exchanged then a pointer to a structure can - * be posted in the mailbox but the posting side has no predefined way to - * know when the message has been processed. A possible approach is to - * allocate memory (from a memory pool as example) from the posting side and - * free it on the fetching side. Another approach is to set a "done" flag into - * the structure pointed by the message. - * @ingroup Synchronization - */ - -/** - * @defgroup Memory Memory Management - * Memory Management services. - */ - -/** - * @defgroup Heap Heap - * Heap Allocator related APIs. - *

Operation mode

- * The heap allocator implements a first-fit strategy and its APIs are - * functionally equivalent to the usual @p malloc() and @p free(). The main - * difference is that the heap APIs are thread safe.
- * By enabling the @p CH_USE_MALLOC_HEAP option the heap manager will use the - * runtime-provided @p malloc() and @p free() as backend for the heap APIs - * instead of the system provided allocator.
- * In order to use the heap APIs the @p CH_USE_HEAP option must be specified - * in @p chconf.h. - * @ingroup Memory - */ - -/** - * @defgroup MemoryPools Memory Pools - * Memory Pools related APIs. - *

Operation mode

- * The Memory Pools APIs allow to allocate/free fixed size objects in - * constant time and reliably without memory fragmentation problems.
- * In order to use the Time APIs the @p CH_USE_MEMPOOLS option must be - * specified in @p chconf.h. - * @ingroup Memory - */ - /** * @defgroup IO I/O Support * @brief I/O related services. @@ -375,45 +132,6 @@ * . */ -/** - * @defgroup Channels I/O Abstract Channels - * @brief Abstract I/O Channels. - * @details This module defines an abstract interface for I/O channels. Note - * that no code is present, I/O channels are just abstract classes-like - * structures, you should look at the systems as to a set of abstract C++ - * classes (even if written in C). Specific device drivers can use/extend - * the interfaces and implement them.
- * This system has the advantage to make the access to channels - * independent from the implementation logic. As example, an I/O channel - * interface can hide the access to a serial driver, to a networking socket - * and so on. - * - * @ingroup IO - */ - -/** - * @defgroup IOQueues I/O Queues - * @brief I/O queues. - * @details ChibiOS/RT supports several kinds of queues. The queues are mostly - * used in serial-like device drivers. The device drivers are usually designed - * to have a lower side (lower driver, it is usually an interrupt service - * routine) and an upper side (upper driver, accessed by the application - * threads).
- * There are several kind of queues:
- * - Input queue, unidirectional queue where the writer is the - * lower side and the reader is the upper side. - * - Output queue, unidirectional queue where the writer is the - * upper side and the reader is the lower side. - * - Full duplex queue, bidirectional queue where read and write - * operations can happen at the same time. Full duplex queues - * are implemented by pairing an input queue and an output queue together. - * . - * In order to use the I/O queues the @p CH_USE_QUEUES option must - * be specified in @p chconf.h.
- * - * @ingroup IO - */ - /** * @defgroup PAL I/O Ports Abstraction Layer (PAL) * @brief I/O Ports Abstraction Layer diff --git a/os/kernel/include/ch.h b/os/kernel/include/ch.h index 8ce6b5f44..5608147b9 100644 --- a/os/kernel/include/ch.h +++ b/os/kernel/include/ch.h @@ -20,7 +20,7 @@ /** * @file ch.h * @brief ChibiOS/RT main include file, it includes everything else. - * @addtogroup Kernel + * @addtogroup kernel_info * @{ */ diff --git a/os/kernel/include/channels.h b/os/kernel/include/channels.h index a1c538f62..83abcdb1a 100644 --- a/os/kernel/include/channels.h +++ b/os/kernel/include/channels.h @@ -20,7 +20,7 @@ /** * @file channels.h * @brief I/O channels - * @addtogroup Channels + * @addtogroup io_channels * @{ */ diff --git a/os/kernel/include/condvars.h b/os/kernel/include/condvars.h index d68637f21..9ef977059 100644 --- a/os/kernel/include/condvars.h +++ b/os/kernel/include/condvars.h @@ -24,7 +24,7 @@ /** * @file condvars.h * @brief Condition Variables macros and structures. - * @addtogroup CondVars + * @addtogroup condvars * @{ */ diff --git a/os/kernel/include/debug.h b/os/kernel/include/debug.h index 67a5d65b4..2987c3489 100644 --- a/os/kernel/include/debug.h +++ b/os/kernel/include/debug.h @@ -20,7 +20,7 @@ /** * @file debug.h * @brief Debug macros and structures. - * @addtogroup Debug + * @addtogroup debug * @{ */ diff --git a/os/kernel/include/events.h b/os/kernel/include/events.h index c8bf0c6e6..de49d1aea 100644 --- a/os/kernel/include/events.h +++ b/os/kernel/include/events.h @@ -20,7 +20,7 @@ /** * @file events.h * @brief Events macros and structures. - * @addtogroup Events + * @addtogroup events * @{ */ diff --git a/os/kernel/include/heap.h b/os/kernel/include/heap.h index 4c9571070..c98ae9c71 100644 --- a/os/kernel/include/heap.h +++ b/os/kernel/include/heap.h @@ -20,7 +20,7 @@ /** * @file heap.h * @brief Heap macros and structures. - * @addtogroup Heap + * @addtogroup heap * @{ */ diff --git a/os/kernel/include/inline.h b/os/kernel/include/inline.h index 42775d5cb..98101486c 100644 --- a/os/kernel/include/inline.h +++ b/os/kernel/include/inline.h @@ -22,7 +22,7 @@ /** * @file inline.h - * @brief Kernel inlined functions. + * @brief kernel inlined functions. */ /* diff --git a/os/kernel/include/lists.h b/os/kernel/include/lists.h index bc3fd7272..409a83475 100644 --- a/os/kernel/include/lists.h +++ b/os/kernel/include/lists.h @@ -20,7 +20,7 @@ /** * @file lists.h * @brief Thread queues/lists macros and structures. - * @addtogroup ThreadLists + * @addtogroup internals * @{ */ diff --git a/os/kernel/include/mailboxes.h b/os/kernel/include/mailboxes.h index 075806da8..9e795590b 100644 --- a/os/kernel/include/mailboxes.h +++ b/os/kernel/include/mailboxes.h @@ -20,7 +20,7 @@ /** * @file mailboxes.h * @brief Mailboxes macros and structures. - * @addtogroup Mailboxes + * @addtogroup mailboxes * @{ */ diff --git a/os/kernel/include/mempools.h b/os/kernel/include/mempools.h index 38e54b3d8..38279c388 100644 --- a/os/kernel/include/mempools.h +++ b/os/kernel/include/mempools.h @@ -20,7 +20,7 @@ /** * @file mempools.h * @brief Memory Pools macros and structures. - * @addtogroup MemoryPools + * @addtogroup pools * @{ */ diff --git a/os/kernel/include/messages.h b/os/kernel/include/messages.h index ee1449a82..bef96b411 100644 --- a/os/kernel/include/messages.h +++ b/os/kernel/include/messages.h @@ -20,7 +20,7 @@ /** * @file messages.h * @brief Messages macros and structures. - * @addtogroup Messages + * @addtogroup messages * @{ */ diff --git a/os/kernel/include/mutexes.h b/os/kernel/include/mutexes.h index 6ef6e48f4..32fcc0f6b 100644 --- a/os/kernel/include/mutexes.h +++ b/os/kernel/include/mutexes.h @@ -20,7 +20,7 @@ /** * @file mutexes.h * @brief Mutexes macros and structures. - * @addtogroup Mutexes + * @addtogroup mutexes * @{ */ diff --git a/os/kernel/include/queues.h b/os/kernel/include/queues.h index 6bd98b4f1..0a8d06d8f 100644 --- a/os/kernel/include/queues.h +++ b/os/kernel/include/queues.h @@ -20,7 +20,7 @@ /** * @file queues.h I/O * @brief Queues macros and structures. - * @addtogroup IOQueues + * @addtogroup io_queues * @{ */ diff --git a/os/kernel/include/scheduler.h b/os/kernel/include/scheduler.h index b04e302bf..235761216 100644 --- a/os/kernel/include/scheduler.h +++ b/os/kernel/include/scheduler.h @@ -20,7 +20,7 @@ /** * @file scheduler.h * @brief Scheduler macros and structures. - * @addtogroup Scheduler + * @addtogroup scheduler * @{ */ diff --git a/os/kernel/include/semaphores.h b/os/kernel/include/semaphores.h index 833fc5cd2..65dd64a9c 100644 --- a/os/kernel/include/semaphores.h +++ b/os/kernel/include/semaphores.h @@ -20,7 +20,7 @@ /** * @file semaphores.h * @brief Semaphores macros and structures. - * @addtogroup Semaphores + * @addtogroup semaphores * @{ */ diff --git a/os/kernel/include/sys.h b/os/kernel/include/sys.h index a84d33da8..beea84754 100644 --- a/os/kernel/include/sys.h +++ b/os/kernel/include/sys.h @@ -20,7 +20,7 @@ /** * @file sys.h * @brief System related macros and structures. - * @addtogroup System + * @addtogroup system * @{ */ diff --git a/os/kernel/include/threads.h b/os/kernel/include/threads.h index 07e068854..7155e9b32 100644 --- a/os/kernel/include/threads.h +++ b/os/kernel/include/threads.h @@ -20,7 +20,7 @@ /** * @file threads.h * @brief Threads macros and structures. - * @addtogroup Threads + * @addtogroup threads * @{ */ diff --git a/os/kernel/include/vt.h b/os/kernel/include/vt.h index 9fdde5576..20a64ec95 100644 --- a/os/kernel/include/vt.h +++ b/os/kernel/include/vt.h @@ -20,7 +20,7 @@ /** * @file vt.h * @brief Time macros and structures. - * @addtogroup Time + * @addtogroup time * @{ */ diff --git a/os/kernel/src/chcond.c b/os/kernel/src/chcond.c index ef58f1ddf..e991c32fc 100644 --- a/os/kernel/src/chcond.c +++ b/os/kernel/src/chcond.c @@ -24,7 +24,7 @@ /** * @file chcond.c * @brief Condition Variables code. - * @addtogroup CondVars + * @addtogroup condvars Condition Variables * @{ */ diff --git a/os/kernel/src/chdebug.c b/os/kernel/src/chdebug.c index 9a8120b29..f5e6bef7a 100644 --- a/os/kernel/src/chdebug.c +++ b/os/kernel/src/chdebug.c @@ -20,7 +20,7 @@ /** * @file chdebug.c * @brief ChibiOS/RT Debug code. - * @addtogroup Debug + * @addtogroup debug * @{ */ diff --git a/os/kernel/src/chevents.c b/os/kernel/src/chevents.c index 098adce5e..29c06d904 100644 --- a/os/kernel/src/chevents.c +++ b/os/kernel/src/chevents.c @@ -20,7 +20,7 @@ /** * @file chevents.c * @brief Events code. - * @addtogroup Events + * @addtogroup events * @{ */ #include diff --git a/os/kernel/src/chheap.c b/os/kernel/src/chheap.c index 82b1ba785..b5ad50505 100644 --- a/os/kernel/src/chheap.c +++ b/os/kernel/src/chheap.c @@ -20,7 +20,7 @@ /** * @file chheap.c * @brief Heap code. - * @addtogroup Heap + * @addtogroup heap * @{ */ diff --git a/os/kernel/src/chlists.c b/os/kernel/src/chlists.c index a2177ca63..5c5d90869 100644 --- a/os/kernel/src/chlists.c +++ b/os/kernel/src/chlists.c @@ -20,7 +20,7 @@ /** * @file chlists.c * @brief Thread queues/lists code. - * @addtogroup ThreadLists + * @addtogroup internals * @{ */ #include diff --git a/os/kernel/src/chmboxes.c b/os/kernel/src/chmboxes.c index 8a791a984..569422ca7 100644 --- a/os/kernel/src/chmboxes.c +++ b/os/kernel/src/chmboxes.c @@ -20,7 +20,7 @@ /** * @file chmboxes.c * @brief Mailboxes code. - * @addtogroup Mailboxes + * @addtogroup mailboxes * @{ */ diff --git a/os/kernel/src/chmempools.c b/os/kernel/src/chmempools.c index dd6f3d1ba..a8d7da818 100644 --- a/os/kernel/src/chmempools.c +++ b/os/kernel/src/chmempools.c @@ -20,7 +20,7 @@ /** * @file chmempools.c * @brief Memory Pools code. - * @addtogroup MemoryPools + * @addtogroup pools * @{ */ diff --git a/os/kernel/src/chmsg.c b/os/kernel/src/chmsg.c index 393ab8dad..6f1be5c47 100644 --- a/os/kernel/src/chmsg.c +++ b/os/kernel/src/chmsg.c @@ -20,7 +20,7 @@ /** * @file chmsg.c * @brief Messages code. - * @addtogroup Messages + * @addtogroup messages * @{ */ diff --git a/os/kernel/src/chmtx.c b/os/kernel/src/chmtx.c index 5fcb6fd5e..cc3c91e3e 100644 --- a/os/kernel/src/chmtx.c +++ b/os/kernel/src/chmtx.c @@ -20,7 +20,7 @@ /** * @file chmtx.c * @brief Mutexes code. - * @addtogroup Mutexes + * @addtogroup mutexes * @{ */ diff --git a/os/kernel/src/chqueues.c b/os/kernel/src/chqueues.c index a72b83696..0f78a0975 100644 --- a/os/kernel/src/chqueues.c +++ b/os/kernel/src/chqueues.c @@ -20,7 +20,7 @@ /** * @file chqueues.c * @brief I/O Queues code. - * @addtogroup IOQueues + * @addtogroup io_queues * @{ */ diff --git a/os/kernel/src/chschd.c b/os/kernel/src/chschd.c index 76464d603..af24f5cf4 100644 --- a/os/kernel/src/chschd.c +++ b/os/kernel/src/chschd.c @@ -20,7 +20,7 @@ /** * @file chschd.c * @brief Scheduler code. - * @addtogroup Scheduler + * @addtogroup scheduler * @{ */ diff --git a/os/kernel/src/chsem.c b/os/kernel/src/chsem.c index 9a8570580..4b35f479c 100644 --- a/os/kernel/src/chsem.c +++ b/os/kernel/src/chsem.c @@ -20,7 +20,7 @@ /** * @file chsem.c * @brief Semaphores code. - * @addtogroup Semaphores + * @addtogroup semaphores * @{ */ diff --git a/os/kernel/src/chsys.c b/os/kernel/src/chsys.c index 217e2f2da..8ee7375f8 100644 --- a/os/kernel/src/chsys.c +++ b/os/kernel/src/chsys.c @@ -20,7 +20,7 @@ /** * @file chsys.c * @brief System related code. - * @addtogroup System + * @addtogroup system * @{ */ diff --git a/os/kernel/src/chthreads.c b/os/kernel/src/chthreads.c index f8bb3b869..583bc7c04 100644 --- a/os/kernel/src/chthreads.c +++ b/os/kernel/src/chthreads.c @@ -20,7 +20,7 @@ /** * @file chthreads.c * @brief Threads code. - * @addtogroup Threads + * @addtogroup threads * @{ */ diff --git a/os/kernel/src/chvt.c b/os/kernel/src/chvt.c index c1d8734ec..b3cee0ce3 100644 --- a/os/kernel/src/chvt.c +++ b/os/kernel/src/chvt.c @@ -20,7 +20,7 @@ /** * @file chvt.c * @brief Time and Virtual Timers related code. - * @addtogroup Time + * @addtogroup time * @{ */ diff --git a/os/kernel/templates/chconf.h b/os/kernel/templates/chconf.h new file mode 100644 index 000000000..819d3d1d0 --- /dev/null +++ b/os/kernel/templates/chconf.h @@ -0,0 +1,378 @@ +/* + ChibiOS/RT - Copyright (C) 2006-2007 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 templates/chconf.h + * @brief Configuration file template. + * @addtogroup config + * @{ + */ + +#ifndef _CHCONF_H_ +#define _CHCONF_H_ + +/*===========================================================================*/ +/* Kernel parameters. */ +/*===========================================================================*/ + +/** + * Frequency of the system timer that drives the system ticks. This also + * defines the system tick time unit. + */ +#if !defined(CH_FREQUENCY) || defined(__DOXYGEN__) +#define CH_FREQUENCY 1000 +#endif + +/** + * This constant is the number of system ticks allowed for the threads before + * preemption occurs. This option is only meaningful if the option + * @p CH_USE_ROUNDROBIN is also active. + */ +#if !defined(CH_TIME_QUANTUM) || defined(__DOXYGEN__) +#define CH_TIME_QUANTUM 20 +#endif + +/** + * If enabled then the use of nested @p chSysLock() / @p chSysUnlock() + * operations is allowed.
+ * For performance and code size reasons the recommended setting is to leave + * this option disabled.
+ * You can use this option if you need to merge ChibiOS/RT with external + * libraries that require nested lock/unlock operations. + * @note The default is @p FALSE. + */ +#if !defined(CH_USE_NESTED_LOCKS) || defined(__DOXYGEN__) +#define CH_USE_NESTED_LOCKS FALSE +#endif + +/** + * If specified then the kernel performs the round robin scheduling algorithm + * on threads of equal priority. + * @note The default is @p TRUE. + */ +#if !defined(CH_USE_ROUNDROBIN) || defined(__DOXYGEN__) +#define CH_USE_ROUNDROBIN TRUE +#endif + +/** + * Number of RAM bytes to use as system heap. If set to zero then the whole + * available RAM is used as system heap. + * @note In order to use the whole RAM as system heap the linker script must + * provide the @p __heap_base__ and @p __heap_end__ symbols. + * @note Requires @p CH_USE_HEAP. + */ +#if !defined(CH_HEAP_SIZE) || defined(__DOXYGEN__) +#define CH_HEAP_SIZE 0 +#endif + +/*===========================================================================*/ +/* Performance options. */ +/*===========================================================================*/ + +/** + * If specified then time efficient rather than space efficient code is used + * when two possible implementations exist. + * @note This is not related to the compiler optimization options. + * @note The default is @p TRUE. + */ +#if !defined(CH_OPTIMIZE_SPEED) || defined(__DOXYGEN__) +#define CH_OPTIMIZE_SPEED TRUE +#endif + +/** + * If enabled defines a CPU register to be used as storage for the global + * @p currp variable. Caching this variable in a register can greatly + * improve both space and time efficiency of the generated code. Another side + * effect is that one less register has to be saved during the context switch + * resulting in lower RAM usage and faster code. + * @note This option is only usable with the GCC compiler and is only useful + * on processors with many registers like ARM cores. + * @note If this option is enabled then ALL the libraries linked to the + * ChibiOS/RT code must be recompiled with the GCC option @p + * -ffixed-@. + * @note This option must be enabled in the Makefile, it is listed here for + * documentation. + */ +#if defined(__DOXYGEN__) +#define CH_CURRP_REGISTER_CACHE "reg" +#endif + +/*===========================================================================*/ +/* Subsystem options. */ +/*===========================================================================*/ + +/** + * If specified then the @p chThdWait() function is included in the kernel. + * @note The default is @p TRUE. + */ +#if !defined(CH_USE_WAITEXIT) || defined(__DOXYGEN__) +#define CH_USE_WAITEXIT TRUE +#endif + +/** + * If specified then the Semaphores APIs are included in the kernel. + * @note The default is @p TRUE. + */ +#if !defined(CH_USE_SEMAPHORES) || defined(__DOXYGEN__) +#define CH_USE_SEMAPHORES TRUE +#endif + +/** + * If enabled then the threads are enqueued on semaphores by priority rather + * than FIFO order. + * @note The default is @p FALSE. Enable this if you have special requirements. + * @note Requires @p CH_USE_SEMAPHORES. + */ +#if !defined(CH_USE_SEMAPHORES_PRIORITY) || defined(__DOXYGEN__) +#define CH_USE_SEMAPHORES_PRIORITY FALSE +#endif + +/** + * If specified then the Semaphores the @p chSemWaitSignal() API is included + * in the kernel. + * @note The default is @p TRUE. + * @note Requires @p CH_USE_SEMAPHORES. + */ +#if !defined(CH_USE_SEMSW) || defined(__DOXYGEN__) +#define CH_USE_SEMSW TRUE +#endif + +/** + * If specified then the Mutexes APIs are included in the kernel. + * @note The default is @p TRUE. + */ +#if !defined(CH_USE_MUTEXES) || defined(__DOXYGEN__) +#define CH_USE_MUTEXES TRUE +#endif + +/** + * If specified then the Conditional Variables APIs are included in the kernel. + * @note The default is @p TRUE. + * @note Requires @p CH_USE_MUTEXES. + */ +#if !defined(CH_USE_CONDVARS) || defined(__DOXYGEN__) +#define CH_USE_CONDVARS TRUE +#endif + +/** + * If specified then the Conditional Variables APIs are included in the kernel. + * @note The default is @p TRUE. + * @note Requires @p CH_USE_CONDVARS. + */ +#if !defined(CH_USE_CONDVARS_TIMEOUT) || defined(__DOXYGEN__) +#define CH_USE_CONDVARS_TIMEOUT TRUE +#endif + +/** + * If specified then the Event flags APIs are included in the kernel. + * @note The default is @p TRUE. + */ +#if !defined(CH_USE_EVENTS) || defined(__DOXYGEN__) +#define CH_USE_EVENTS TRUE +#endif + +/** + * If specified then the @p chEvtWaitXXXTimeout() functions are included in + * the kernel. + * @note The default is @p TRUE. + * @note Requires @p CH_USE_EVENTS. + */ +#if !defined(CH_USE_EVENTS_TIMEOUT) || defined(__DOXYGEN__) +#define CH_USE_EVENTS_TIMEOUT TRUE +#endif + +/** + * If specified then the Synchronous Messages APIs are included in the kernel. + * @note The default is @p TRUE. + */ +#if !defined(CH_USE_MESSAGES) || defined(__DOXYGEN__) +#define CH_USE_MESSAGES TRUE +#endif + +/** + * If enabled then messages are served by priority rather than in FIFO order. + * @note The default is @p FALSE. Enable this if you have special requirements. + * @note Requires @p CH_USE_MESSAGES. + */ +#if !defined(CH_USE_MESSAGES_PRIORITY) || defined(__DOXYGEN__) +#define CH_USE_MESSAGES_PRIORITY FALSE +#endif + +/** + * If specified then the Asynchronous Messages (Mailboxes) APIs are included + * in the kernel. + * @note The default is @p TRUE. + * @note Requires @p CH_USE_SEMAPHORES. + */ +#if !defined(CH_USE_MAILBOXES) || defined(__DOXYGEN__) +#define CH_USE_MAILBOXES TRUE +#endif + +/** + * If specified then the I/O queues APIs are included in the kernel. + * @note The default is @p TRUE. + * @note Requires @p CH_USE_SEMAPHORES. + */ +#if !defined(CH_USE_QUEUES) || defined(__DOXYGEN__) +#define CH_USE_QUEUES TRUE +#endif + +/** + * If specified then the memory heap allocator APIs are included in the kernel. + * @note The default is @p TRUE. + * @note Requires @p CH_USE_MUTEXES or @p CH_USE_SEMAPHORES. + * @note Mutexes are recommended. + */ +#if !defined(CH_USE_HEAP) || defined(__DOXYGEN__) +#define CH_USE_HEAP TRUE +#endif + +/** + * If enabled enforces the use of the C-runtime @p malloc() and @p free() + * functions as backend for the system heap allocator. + * @note The default is @p FALSE. + * @note Requires @p CH_USE_HEAP. + */ +#if !defined(CH_USE_MALLOC_HEAP) || defined(__DOXYGEN__) +#define CH_USE_MALLOC_HEAP FALSE +#endif + +/** + * If specified then the memory pools allocator APIs are included in the + * kernel. + * @note The default is @p TRUE. + */ +#if !defined(CH_USE_MEMPOOLS) || defined(__DOXYGEN__) +#define CH_USE_MEMPOOLS TRUE +#endif + +/** + * If specified then the dynamic threads creation APIs are included in the + * kernel. + * @note The default is @p TRUE. + * @note Requires @p CH_USE_WAITEXIT. + */ +#if !defined(CH_USE_DYNAMIC) || defined(__DOXYGEN__) +#define CH_USE_DYNAMIC TRUE +#endif + +/*===========================================================================*/ +/* Debug options. */ +/*===========================================================================*/ + +/** + * Debug option, if enabled then the checks on the API functions input + * parameters are activated. + * @note The default is @p FALSE. + */ +#if !defined(CH_DBG_ENABLE_CHECKS) || defined(__DOXYGEN__) +#define CH_DBG_ENABLE_CHECKS FALSE +#endif + +/** + * Debug option, if enabled then all the assertions in the kernel code are + * activated. This includes consistency checks inside the kernel, runtime + * anomalies and port-defined checks. + * @note The default is @p FALSE. + */ +#if !defined(CH_DBG_ENABLE_ASSERTS) || defined(__DOXYGEN__) +#define CH_DBG_ENABLE_ASSERTS FALSE +#endif + +/** + * Debug option, if enabled the context switch circular trace buffer is + * activated. + * @note The default is @p FALSE. + */ +#if !defined(CH_DBG_ENABLE_TRACE) || defined(__DOXYGEN__) +#define CH_DBG_ENABLE_TRACE FALSE +#endif + +/** + * Debug option, if enabled a runtime stack check is performed. + * @note The stack check is performed in a architecture/port dependent way. It + * may not be implemented at all. + */ +#if !defined(CH_DBG_ENABLE_STACK_CHECK) || defined(__DOXYGEN__) +#define CH_DBG_ENABLE_STACK_CHECK FALSE +#endif + +/** + * Debug option, if enabled the threads working area is filled with a byte + * pattern when a thread is created. + */ +#if !defined(CH_DBG_FILL_THREADS) || defined(__DOXYGEN__) +#define CH_DBG_FILL_THREADS FALSE +#endif + +/** + * Debug option, if enabled a field is added to the @p Thread structure that + * counts the system ticks occurred while executing the thread. + */ +#if !defined(CH_DBG_THREADS_PROFILING) || defined(__DOXYGEN__) +#define CH_DBG_THREADS_PROFILING TRUE +#endif + +/*===========================================================================*/ +/* Kernel hooks. */ +/*===========================================================================*/ + +/** + * User fields added to the end of the @p Thread structure. + */ +#if !defined(THREAD_EXT_FIELDS) || defined(__DOXYGEN__) +#define THREAD_EXT_FIELDS \ +struct { \ + /* Add thread custom fields here.*/ \ +}; +#endif + +/** + * User initialization code added to the @p chThdInit() API. + * @note It is invoked from within @p chThdInit(). + */ +#if !defined(THREAD_EXT_INIT) || defined(__DOXYGEN__) +#define THREAD_EXT_INIT(tp) { \ + /* Add thread initialization code here.*/ \ +} +#endif + +/** + * User finalization code added to the @p chThdExit() API. + * @note It is inserted into lock zone. + */ +#if !defined(THREAD_EXT_EXIT) || defined(__DOXYGEN__) +#define THREAD_EXT_EXIT(tp) { \ + /* Add thread finalization code here.*/ \ +} +#endif + +/** + * Code inserted inside the idle thread loop immediately after an interrupt + * resumed execution. + */ +#if !defined(IDLE_LOOP_HOOK) || defined(__DOXYGEN__) +#define IDLE_LOOP_HOOK() { \ + /* Idle loop code here.*/ \ +} +#endif + +#endif /* _CHCONF_H_ */ + +/** @} */ diff --git a/os/kernel/templates/chcore.c b/os/kernel/templates/chcore.c new file mode 100644 index 000000000..cd86c4c42 --- /dev/null +++ b/os/kernel/templates/chcore.c @@ -0,0 +1,133 @@ +/* + ChibiOS/RT - Copyright (C) 2006-2007 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 templates/chcore.c + * @brief Port related template code. + * @addtogroup core + * @{ + */ + +#include + +/* + * This file is a template of the system driver functions provided by a port. + * Some of the following functions may be implemented as macros in chcore.h if + * the implementer decides that there is an advantage in doing so, as example + * because performance concerns. + */ + +/** + * @brief Port-related initialization code. + * + * @note This function is usually empty. + */ +void port_init(void){ +} + +/** + * @brief Kernel-unlock action. + * @details Usually this function just disables interrupts but may perform more + * actions. + */ +void port_lock(void) { +} + +/** + * @brief Kernel-unlock action. + * @details Usually this function just disables interrupts but may perform more + * actions. + */ +void port_unlock(void) { +} + +/** + * @brief Kernel-lock action from an interrupt handler. + * @details This function is invoked before invoking I-class APIs from + * interrupt handlers. The implementation is architecture dependent, in its + * simplest form it is void. + */ +void port_lock_from_isr(void) { +} + +/** + * @brief Kernel-unlock action from an interrupt handler. + * @details This function is invoked after invoking I-class APIs from interrupt + * handlers. The implementation is architecture dependent, in its simplest form + * it is void. + */ +void port_unlock_from_isr(void) { +} + +/** + * @brief Disables all the interrupt sources. + * + * @note Of course non maskable interrupt sources are not included. + */ +void port_disable() { +} + +/** + * @brief Disables the interrupt sources that are not supposed to preempt the kernel. + */ +void port_suspend(void) { +} + +/** + * @brief Enables all the interrupt sources. + */ +void port_enable(void) { +} + +/** + * @brief Enters an architecture-dependent halt mode. + * @details The function is meant to return when an interrupt becomes pending. + * The simplest implementation is an empty function but this will not take + * advantage of architecture-specific power saving modes. + */ +void port_wait_for_interrupt(void) { +} + +/** + * @brief Halts the system. + * @details This function is invoked by the operating system when an + * unrecoverable error is detected (as example because a programming error in + * the application code that triggers an assertion while in debug mode). + */ +void port_halt(void) { + + port_disable(); + while (TRUE) { + } +} + +/** + * @brief Performs a context switch between two threads. + * @details This is the most critical code in any port, this function + * is responsible for the context switch between 2 threads. + * + * @param otp the thread to be switched out + * @param ntp the thread to be switched in + * @note The implementation of this code affects directly the context + * switch performance so optimize here as much as you can. + */ +void port_switch(Thread *otp, Thread *ntp) { +} + +/** @} */ diff --git a/os/kernel/templates/chcore.h b/os/kernel/templates/chcore.h new file mode 100644 index 000000000..92595aee6 --- /dev/null +++ b/os/kernel/templates/chcore.h @@ -0,0 +1,159 @@ +/* + ChibiOS/RT - Copyright (C) 2006-2007 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 templates/chcore.h + * @brief Port related template macros and structures. + * @addtogroup core + * @{ + */ + +#ifndef _CHCORE_H_ +#define _CHCORE_H_ + +/** + * Unique macro for the implemented architecture. + */ +#define CH_ARCHITECTURE_XXX + +/** + * Name of the implemented architecture. + */ +#define CH_ARCHITECTURE_NAME "" + +/** + * Base type for stack alignment. + * This type is used only for stack alignment reasons thus can be anything from + * a char to a double. + */ +typedef uint8_t stkalign_t; + +/** + * @brief Interrupt saved context. + * @details This structure represents the stack frame saved during a + * preemption-capable interrupt handler. + */ +struct extctx { +}; + +/** + * @brief System saved context. + * @details This structure represents the inner stack frame during a context + * switching. + */ +struct intctx { +}; + +/** + * @brief Platform dependent part of the @p Thread structure. + * @details This structure usually contains just the saved stack pointer + * defined as a pointer to a @p intctx structure. + */ +struct context { + struct intctx *sp; +}; + +/** + * Platform dependent part of the @p chThdInit() API. + * This code usually setup the context switching frame represented by a + * @p intctx structure. + */ +#define SETUP_CONTEXT(workspace, wsize, pf, arg) { \ +} + +/** + * Stack size for the system idle thread. + * This size depends on the idle thread implementation, usually the idle + * thread should take no more space than those reserved + * by @p INT_REQUIRED_STACK. + */ +#ifndef IDLE_THREAD_STACK_SIZE +#define IDLE_THREAD_STACK_SIZE 0 +#endif + +/** + * Per-thread stack overhead for interrupts servicing, it is used in the + * calculation of the correct working area size. + * This value can be zero on those architecture where there is a separate + * interrupt stack and the stack space between @p intctx and @p extctx is + * known to be zero. + */ +#ifndef INT_REQUIRED_STACK +#define INT_REQUIRED_STACK 0 +#endif + +/** + * Enforces a correct alignment for a stack area size value. + */ +#define STACK_ALIGN(n) ((((n) - 1) | (sizeof(stkalign_t) - 1)) + 1) + +/** + * Computes the thread working area global size. + */ +#define THD_WA_SIZE(n) STACK_ALIGN(sizeof(Thread) + \ + sizeof(struct intctx) + \ + sizeof(struct extctx) + \ + (n) + (INT_REQUIRED_STACK)) + +/** + * Macro used to allocate a thread working area aligned as both position and + * size. + */ +#define WORKING_AREA(s, n) stkalign_t s[THD_WA_SIZE(n) / sizeof(stkalign_t)]; + +/** + * IRQ prologue code, inserted at the start of all IRQ handlers enabled to + * invoke system APIs. + */ +#define PORT_IRQ_PROLOGUE() + +/** + * IRQ epilogue code, inserted at the end of all IRQ handlers enabled to + * invoke system APIs. + */ +#define PORT_IRQ_EPILOGUE() + +/** + * IRQ handler function declaration. + * @note @p id can be a function name or a vector number depending on the + * port implementation. + */ +#define PORT_IRQ_HANDLER(id) void id(void) + +#ifdef __cplusplus +extern "C" { +#endif + void port_init(void); + void port_lock(void); + void port_unlock(void); + void port_lock_from_isr(void); + void port_unlock_from_isr(void); + void port_disable(void); + void port_suspend(void); + void port_enable(void); + void port_wait_for_interrupt(void); + void port_halt(void); + void port_switch(Thread *otp, Thread *ntp); +#ifdef __cplusplus +} +#endif + +#endif /* _CHCORE_H_ */ + +/** @} */ diff --git a/os/kernel/templates/chtypes.h b/os/kernel/templates/chtypes.h new file mode 100644 index 000000000..2a8e27a59 --- /dev/null +++ b/os/kernel/templates/chtypes.h @@ -0,0 +1,79 @@ +/* + ChibiOS/RT - Copyright (C) 2006-2007 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 templates/chtypes.h + * @brief System types template. + * @addtogroup types + * @{ + */ + +#ifndef _CHTYPES_H_ +#define _CHTYPES_H_ + +#define __need_NULL +#define __need_size_t +#include + +#if !defined(_STDINT_H) && !defined(__STDINT_H_) +#include +#endif + +/** Signed boolean. */ +typedef int32_t bool_t; + +/** Thread mode flags, uint8_t is ok. */ +typedef uint8_t tmode_t; + +/** Thread state, uint8_t is ok. */ +typedef uint8_t tstate_t; + +/** Priority, use the fastest unsigned type. */ +typedef uint32_t tprio_t; + +/** Message, use signed pointer equivalent.*/ +typedef int32_t msg_t; + +/** Event Id, use fastest signed.*/ +typedef int32_t eventid_t; + +/** Event Mask, recommended fastest unsigned.*/ +typedef uint32_t eventmask_t; + +/** System Time, recommended fastest unsigned.*/ +typedef uint32_t systime_t; + +/** Counter, recommended fastest signed.*/ +typedef int32_t cnt_t; + +/** Inline function modifier. */ +#define INLINE inline + +/** Packed structure modifier (within). */ +#define PACK_STRUCT_STRUCT __attribute__((packed)) + +/** Packed structure modifier (before). */ +#define PACK_STRUCT_BEGIN + +/** Packed structure modifier (after). */ +#define PACK_STRUCT_END + +#endif /* _CHTYPES_H_ */ + +/** @} */ diff --git a/test/testdyn.c b/test/testdyn.c index a7c685623..44e6ffaa4 100644 --- a/test/testdyn.c +++ b/test/testdyn.c @@ -29,8 +29,7 @@ * APIs. * *

Objective

- * Objective of the test module is to cover 100% of the dynamic APIs code - * as a necessary step in order to assess their maturity. + * Objective of the test module is to cover 100% of the dynamic APIs code. * *

Preconditions

* The module requires the following kernel options: diff --git a/test/testevt.c b/test/testevt.c index 3eb3d71b3..eb7e9275c 100644 --- a/test/testevt.c +++ b/test/testevt.c @@ -25,11 +25,10 @@ * @page test_events Events test * *

Description

- * This module implements the test sequence for the @ref Events subsystem. + * This module implements the test sequence for the @ref events subsystem. * *

Objective

- * Objective of the test module is to cover 100% of the @ref Events subsystem - * code as a necessary step in order to assess its maturity level. + * Objective of the test module is to cover 100% of the @ref events subsystem. * *

Preconditions

* The module requires the following kernel options: diff --git a/test/testheap.c b/test/testheap.c index 3a684f415..6e68c11be 100644 --- a/test/testheap.c +++ b/test/testheap.c @@ -25,11 +25,10 @@ * @page test_heap Memory Heap test * *

Description

- * This module implements the test sequence for the @ref Heap subsystem. + * This module implements the test sequence for the @ref heap subsystem. * *

Objective

- * Objective of the test module is to cover 100% of the @ref Heap subsystem - * code as a necessary step in order to assess its maturity level. + * Objective of the test module is to cover 100% of the @ref heap subsystem. * *

Preconditions

* The module requires the following kernel options: diff --git a/test/testmbox.c b/test/testmbox.c index a485c3a4e..96cf543ce 100644 --- a/test/testmbox.c +++ b/test/testmbox.c @@ -25,13 +25,12 @@ * @page test_mbox Mailboxes test * *

Description

- * This module implements the test sequence for the @ref Mailboxes subsystem. + * This module implements the test sequence for the @ref mailboxes subsystem. * *

Objective

- * Objective of the test module is to cover 100% of the @ref Mailboxes - * subsystem code as a necessary step in order to assess its maturity - * level.
- * Note that the @ref Mailboxes subsystem depends on the @ref Semaphores + * Objective of the test module is to cover 100% of the @ref mailboxes + * subsystem code.
+ * Note that the @ref mailboxes subsystem depends on the @ref semaphores * subsystem that has to met its testing objectives as well. * *

Preconditions

diff --git a/test/testmsg.c b/test/testmsg.c index a44686ba6..015639d16 100644 --- a/test/testmsg.c +++ b/test/testmsg.c @@ -25,11 +25,11 @@ * @page test_msg Messages test * *

Description

- * This module implements the test sequence for the @ref Messages subsystem. + * This module implements the test sequence for the @ref messages subsystem. * *

Objective

- * Objective of the test module is to cover 100% of the @ref Messages - * subsystem code as a necessary step in order to assess its maturity level. + * Objective of the test module is to cover 100% of the @ref messages + * subsystem code. * *

Preconditions

* The module requires the following kernel options: diff --git a/test/testmtx.c b/test/testmtx.c index 6027aca7e..368b98fd9 100644 --- a/test/testmtx.c +++ b/test/testmtx.c @@ -25,14 +25,13 @@ * @page test_mtx Mutexes test * *

Description

- * This module implements the test sequence for the @ref Mutexes and - * @ref CondVars subsystems.
+ * This module implements the test sequence for the @ref mutexes and + * @ref condvars subsystems.
* Tests on those subsystems are particularly critical because the system-wide * implications of the Priority Inheritance mechanism. * *

Objective

- * Objective of the test module is to cover 100% of the subsystem code - * as a necessary step in order to assess their maturity level. + * Objective of the test module is to cover 100% of the subsystems code. * *

Preconditions

* The module requires the following kernel options: diff --git a/test/testpools.c b/test/testpools.c index ce6716444..97356126e 100644 --- a/test/testpools.c +++ b/test/testpools.c @@ -25,11 +25,10 @@ * @page test_pools Memory Pools test * *

Description

- * This module implements the test sequence for the @ref MemoryPools subsystem. + * This module implements the test sequence for the @ref pools subsystem. * *

Objective

- * Objective of the test module is to cover 100% of the @ref MemoryPools - * code as a necessary step in order to assess its maturity level.
+ * Objective of the test module is to cover 100% of the @ref pools code. * *

Preconditions

* The module requires the following kernel options: diff --git a/test/testqueues.c b/test/testqueues.c index fe79712eb..aff42334c 100644 --- a/test/testqueues.c +++ b/test/testqueues.c @@ -25,15 +25,14 @@ * @page test_queues I/O Queues test * *

Description

- * This module implements the test sequence for the @ref IOQueues subsystem. + * This module implements the test sequence for the @ref io_queues subsystem. * The tests are performed by inserting and removing data from queues and by * checking both the queues status and the correct sequence of the extracted * data. * *

Objective

- * Objective of the test module is to cover 100% of the @ref IOQueues code - * as a necessary step in order to assess its maturity level.
- * Note that the @ref IOQueues subsystem depends on the @ref Semaphores + * Objective of the test module is to cover 100% of the @ref io_queues code.
+ * Note that the @ref io_queues subsystem depends on the @ref semaphores * subsystem that has to met its testing objectives as well. * *

Preconditions

diff --git a/test/testsem.c b/test/testsem.c index 46c6a7941..77025fc71 100644 --- a/test/testsem.c +++ b/test/testsem.c @@ -25,11 +25,10 @@ * @page test_sem Semaphores test * *

Description

- * This module implements the test sequence for the @ref Semaphores subsystem. + * This module implements the test sequence for the @ref semaphores subsystem. * *

Objective

- * Objective of the test module is to cover 100% of the @ref Semaphores - * code as a necessary step in order to assess its maturity level.
+ * Objective of the test module is to cover 100% of the @ref semaphores code. * *

Preconditions

* The module requires the following kernel options: diff --git a/test/testthd.c b/test/testthd.c index 2758e5223..bc9b40cd1 100644 --- a/test/testthd.c +++ b/test/testthd.c @@ -25,15 +25,14 @@ * @page test_threads Threads and Scheduler test * *

Description

- * This module implements the test sequence for the @ref Scheduler, - * @ref Threads and @ref Time subsystems.
+ * This module implements the test sequence for the @ref scheduler, + * @ref threads and @ref time subsystems.
* Note that the tests on those subsystems are formally required but most of * their functionality is already demonstrated because the test suite itself * depends on them, anyway double check is good. * *

Objective

- * Objective of the test module is to cover 100% of the subsystems code - * as a necessary step in order to assess their maturity level. + * Objective of the test module is to cover 100% of the subsystems code. * *

Preconditions

* None.