aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/platforms/AVR/platform.dox
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-10-26 17:39:29 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-10-26 17:39:29 +0000
commit487a81e29725d598cf0ccdd8c9cd59c5c03634d9 (patch)
treed0c0277547cc71dc3f258880c9d1ee5257ec1b94 /os/hal/platforms/AVR/platform.dox
parentacbea2f1f39f4e4726d3eebf90c27563002f3cf5 (diff)
downloadChibiOS-487a81e29725d598cf0ccdd8c9cd59c5c03634d9.tar.gz
ChibiOS-487a81e29725d598cf0ccdd8c9cd59c5c03634d9.tar.bz2
ChibiOS-487a81e29725d598cf0ccdd8c9cd59c5c03634d9.zip
Documentation related changes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2293 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/platforms/AVR/platform.dox')
-rw-r--r--os/hal/platforms/AVR/platform.dox25
1 files changed, 18 insertions, 7 deletions
diff --git a/os/hal/platforms/AVR/platform.dox b/os/hal/platforms/AVR/platform.dox
index b14441ebc..9b8cf3e6b 100644
--- a/os/hal/platforms/AVR/platform.dox
+++ b/os/hal/platforms/AVR/platform.dox
@@ -19,23 +19,34 @@
/**
* @defgroup AVR_DRIVERS AVR Drivers
- * @brief AVR specific support.
+ * @details This section describes all the supported drivers on the AVR
+ * platform and the implementation details of the single drivers.
*
* @ingroup platforms
*/
/**
- * @defgroup AVR_HAL AVR HAL Support
- * @brief HAL support.
+ * @defgroup AVR_HAL AVR Initialization Support
+ * @details On the AVR platform the HAL driver is a stub and does not perform
+ * any platform-specific initialization, it still performs the
+ * initialization of the other drivers.
*
* @ingroup AVR_DRIVERS
*/
/**
- * @defgroup AVR_SERIAL AVR USART Support
- * @brief USART support.
- * @details The serial driver supports both the AVR USARTs in asynchronous
- * mode.
+ * @defgroup AVR_SERIAL AVR USART Support (buffered)
+ * @details The AVR Serial driver uses the USART peripherals in a
+ * buffered, interrupt driven, implementation.
*
+ * @section avr_serial_1 Supported HW resources
+ * The serial driver can support any of the following hardware resources:
+ * - USART0.
+ * - USART1.
+ * .
+ * @section avr_serial_2 AVR Serial driver implementation features
+ * - Each USART can be independently enabled and programmed.
+ * - Fully interrupt driven.
+ * .
* @ingroup AVR_DRIVERS
*/