andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improvements to the I/O section documentation. 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@998 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
gdisirio 2009-06-01 16:01:41 +00:00
parent 67f44fadd6
commit 120ed882b1
1 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/src/main.dox
View File

@ -350,10 +350,11 @@
*/ */
/** /**
* @defgroup IOQueues Physical I/O Queues * @defgroup IOQueues I/O Queues
* ChibiOS/RT supports several kinds of queues. The queues are mostly used * @brief I/O queues.
* in serial-like device drivers. The device drivers are usually designed to * @details ChibiOS/RT supports several kinds of queues. The queues are mostly
* have a lower side (lower driver, it is usually an interrupt service * 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 * routine) and an upper side (upper driver, accessed by the application
* threads).<br> * threads).<br>
* There are several kind of queues:<br> * There are several kind of queues:<br>
@ -372,11 +373,12 @@
/** /**
* @defgroup Channels Abstract I/O Channels * @defgroup Channels Abstract I/O Channels
* This module defines an abstract interface for I/O channels. Note that * @brief Abstract I/O Channels.
* no code is present, I/O channels are just abstract classes-like structures, * @details This module defines an abstract interface for I/O channels. Note
* you should look at the systems as to a set of abstract C++ classes (even if * that no code is present, I/O channels are just abstract classes-like
* implemented in C). Specific device drivers can use/extend the interfaces * structures, you should look at the systems as to a set of abstract C++
* and implement them.<br> * classes (even if implemented in C). Specific device drivers can use/extend
* the interfaces and implement them.<br>
* This system has the advantage to make the access to channels * This system has the advantage to make the access to channels
* independent from the implementation logic. As example, an I/O channel * independent from the implementation logic. As example, an I/O channel
* interface can hide the access to a serial driver, to a networking socket * interface can hide the access to a serial driver, to a networking socket
@ -386,10 +388,12 @@
/** /**
* @defgroup Serial Serial Drivers * @defgroup Serial Serial Drivers
* This module implements a generic full duplex serial driver and a generic * @brief Generic Serial Drivers.
* half duplex serial driver. It uses the I/O Queues for communication between * @details This module implements a generic full duplex serial driver. The
* the upper and the lower driver and events to notify the application about * driver implements a @p FullDuplexDriver interface and uses I/O Queues for
* incoming data, outcoming data and other I/O events. * communication between the upper and the lower driver. Event flags are used
* to notify the application about incoming data, outgoing data and other I/O
* events.<br>
* The module also contains functions that make the implementation of the * The module also contains functions that make the implementation of the
* interrupt service routines much easier.<br> * interrupt service routines much easier.<br>
* In order to use the serial full duplex driver the * In order to use the serial full duplex driver the