aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/platforms/AT91SAM7/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/AT91SAM7/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/AT91SAM7/platform.dox')
-rw-r--r--os/hal/platforms/AT91SAM7/platform.dox30
1 files changed, 14 insertions, 16 deletions
diff --git a/os/hal/platforms/AT91SAM7/platform.dox b/os/hal/platforms/AT91SAM7/platform.dox
index 9e1736256..af4816486 100644
--- a/os/hal/platforms/AT91SAM7/platform.dox
+++ b/os/hal/platforms/AT91SAM7/platform.dox
@@ -19,21 +19,21 @@
/**
* @defgroup AT91SAM7 AT91SAM7 Drivers
- * @brief AT91SAM7 specific support.
+ * @details This section describes all the supported drivers on the AT91SAM7
+ * platform and the implementation details of the single drivers.
*
* @ingroup platforms
*/
/**
- * @defgroup AT91SAM7_HAL AT91SAM7 HAL Support
- * @brief HAL support.
+ * @defgroup AT91SAM7_HAL AT91SAM7 Initialization Support
* @details The AT91SAM7 HAL support is responsible for system initialization.
*
* @section at91sam7_hal_1 Supported HW resources
* - MC.
* - PMC.
* .
- * @section at91sam7_hal_2 STM32 HAL driver implementation features
+ * @section at91sam7_hal_2 AT91SAM7 HAL driver implementation features
* - PLLs startup and stabilization.
* - Clock source selection.
* - Flash wait states.
@@ -43,8 +43,7 @@
/**
* @defgroup AT91SAM7_MAC AT91SAM7 EMAC Support
- * @brief EMAC+PHY peripheral support.
- * @details This driver supports the AT91SAM7 EMAC peripheral.
+ * @details The AT91SAM7 MAC driver supports the EMAC peripheral.
*
* @section at91sam7_mac_1 Supported HW resources
* - EMAC.
@@ -54,17 +53,17 @@
/**
* @defgroup AT91SAM7_MII AT91SAM7 MII Support
- * @brief PHY peripheral support.
* @details This driver supports the AT91SAM7 EMAC peripheral communicating
* with an external PHY transceiver. The driver currently supports
- * the Micrel KS8721 PHY and the Davicom DV9161 modules.
+ * the Micrel KS8721 PHY and the Davicom DV9161 modules. This driver
+ * is used internally by the MAC driver.
*
* @ingroup AT91SAM7
*/
/**
* @defgroup AT91SAM7_PAL AT91SAM7 PIO Support
- * @brief I/O Ports peripherals support.
+ * @details The AT91SAM7 PAL driver supports the PIO peripherals.
*
* @section at91sam7_pal_1 Supported HW resources
* - PIOA.
@@ -91,8 +90,8 @@
* Any attempt to setup an invalid mode is ignored.
*
* @section at91sam7_pal_4 Suboptimal behavior
- * The STM32 PIO is less than optimal in several areas, the limitations should
- * be taken in account while using the PAL driver:
+ * The AT91SAM7 PIO is less than optimal in several areas, the limitations
+ * should be taken in account while using the PAL driver:
* - Pad/port toggling operations are not atomic.
* - Pad/group mode setup is not atomic.
* .
@@ -101,9 +100,8 @@
/**
* @defgroup AT91SAM7_SPI AT91SAM7 SPI Support
- * @brief SPI peripheral support.
- * @details The SPI driver supports the AT91SAM7 SPIs using DMA channels for
- * improved performance.
+ * @details The SPI driver supports the AT91SAM7 SPI peripherals using DMA
+ * channels for maximum performance.
*
* @section at91sam7_spi_1 Supported HW resources
* - SPI1.
@@ -121,8 +119,8 @@
/**
* @defgroup AT91SAM7_SERIAL AT91SAM7 USART Support (buffered)
- * @brief USART peripherals support.
- * @details The serial driver supports the AT91SAM7 USART peripherals.
+ * @details The AT91SAM7 Serial driver uses the USART/UART peripherals in a
+ * buffered, interrupt driven, implementation.
*
* @section at91sam7_serial_1 Supported HW resources
* The serial driver can support any of the following hardware resources: