diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2011-03-01 13:49:53 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2011-03-01 13:49:53 +0000 |
| commit | eed6999aaf3a4579121b5e70d3a84ef620f896eb (patch) | |
| tree | ffbad9ef7d792ecfb7205ec3876d26b0dd9f2d75 /os/hal/dox/uart.dox | |
| parent | a5138f8fac4b576c67e70e00453982492055ef15 (diff) | |
| download | ChibiOS-eed6999aaf3a4579121b5e70d3a84ef620f896eb.tar.gz ChibiOS-eed6999aaf3a4579121b5e70d3a84ef620f896eb.tar.bz2 ChibiOS-eed6999aaf3a4579121b5e70d3a84ef620f896eb.zip | |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2784 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/dox/uart.dox')
| -rw-r--r-- | os/hal/dox/uart.dox | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/os/hal/dox/uart.dox b/os/hal/dox/uart.dox index 192ce4d91..53339046d 100644 --- a/os/hal/dox/uart.dox +++ b/os/hal/dox/uart.dox @@ -19,26 +19,27 @@ /**
* @defgroup UART UART Driver
- * @brief Generic UART Driver.
+ * @brief Generic UART Driver.
* @details This driver abstracts a generic UART peripheral, the API is
- * designed to be:
- * - Unbuffered and copy-less, transfers are always directly performed
- * from/to the application-level buffers without extra copy operations.
- * - Asynchronous, the API is always non blocking.
- * - Callbacks capable, operations completion and other events are notified
- * via callbacks.
- * .
- * Special hardware features like deep hardware buffers, DMA transfers
- * are hidden to the user but fully supportable by the low level
- * implementations.<br>
- * This driver model is best used where communication events are meant to
- * drive an higher level state machine, as example:
- * - RS485 drivers.
- * - Multipoint network drivers.
- * - Serial protocol decoders.
- * .
- * If your application requires a synchronoyus buffered driver then the
- * @ref SERIAL should be used instead.
+ * designed to be:
+ * - Unbuffered and copy-less, transfers are always directly performed
+ * from/to the application-level buffers without extra copy
+ * operations.
+ * - Asynchronous, the API is always non blocking.
+ * - Callbacks capable, operations completion and other events are
+ * notified using callbacks.
+ * .
+ * Special hardware features like deep hardware buffers, DMA transfers
+ * are hidden to the user but fully supportable by the low level
+ * implementations.<br>
+ * This driver model is best used where communication events are
+ * meant to drive an higher level state machine, as example:
+ * - RS485 drivers.
+ * - Multipoint network drivers.
+ * - Serial protocol decoders.
+ * .
+ * If your application requires a synchronoyus buffered driver then
+ * the @ref SERIAL should be used instead.
* @pre In order to use the UART driver the @p HAL_USE_UART option
* must be enabled in @p halconf.h.
*
|