From 1421a2fd6ca461a96c4be653ea7b925834963433 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Fri, 28 Aug 2009 17:43:57 +0000 Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1118 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- docs/src/main.dox | 78 ++++++++++++++++++------------------- os/io/platforms/AT91SAM7X/pal_lld.c | 2 +- os/io/platforms/AT91SAM7X/pal_lld.h | 2 +- 3 files changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/src/main.dox b/docs/src/main.dox index 56fcd252a..d1cba5773 100644 --- a/docs/src/main.dox +++ b/docs/src/main.dox @@ -375,6 +375,45 @@ * . */ +/** + * @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 @@ -439,45 +478,6 @@ * @ingroup PAL */ -/** - * @defgroup Channels Abstract I/O 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 SERIAL Serial Driver * @brief Generic Serial Drivers. diff --git a/os/io/platforms/AT91SAM7X/pal_lld.c b/os/io/platforms/AT91SAM7X/pal_lld.c index 6c8b26cda..0bfde1f68 100644 --- a/os/io/platforms/AT91SAM7X/pal_lld.c +++ b/os/io/platforms/AT91SAM7X/pal_lld.c @@ -18,7 +18,7 @@ */ /** - * @file os/ports/GCC/ARM7/AT91SAM7X/pal_lld.c + * @file AT91SAM7X/pal_lld.c * @brief AT91SAM7X PIO low level driver code * @addtogroup AT91SAM7X_PAL * @{ diff --git a/os/io/platforms/AT91SAM7X/pal_lld.h b/os/io/platforms/AT91SAM7X/pal_lld.h index c00007fc3..7f86e12a8 100644 --- a/os/io/platforms/AT91SAM7X/pal_lld.h +++ b/os/io/platforms/AT91SAM7X/pal_lld.h @@ -18,7 +18,7 @@ */ /** - * @file os/ports/GCC/ARM7/AT91SAM7X/pal_lld.h + * @file AT91SAM7X/pal_lld.h * @brief AT91SAM7X PIO low level driver header * @addtogroup AT91SAM7X_PAL * @{ -- cgit v1.2.3