diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-10-26 17:39:29 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-10-26 17:39:29 +0000 |
| commit | 487a81e29725d598cf0ccdd8c9cd59c5c03634d9 (patch) | |
| tree | d0c0277547cc71dc3f258880c9d1ee5257ec1b94 /os/hal/platforms/SPC56x | |
| parent | acbea2f1f39f4e4726d3eebf90c27563002f3cf5 (diff) | |
| download | ChibiOS-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/SPC56x')
| -rw-r--r-- | os/hal/platforms/SPC56x/hal_lld.c | 2 | ||||
| -rw-r--r-- | os/hal/platforms/SPC56x/hal_lld.h | 2 | ||||
| -rw-r--r-- | os/hal/platforms/SPC56x/platform.dox | 48 | ||||
| -rw-r--r-- | os/hal/platforms/SPC56x/serial_lld.c | 2 | ||||
| -rw-r--r-- | os/hal/platforms/SPC56x/serial_lld.h | 2 |
5 files changed, 42 insertions, 14 deletions
diff --git a/os/hal/platforms/SPC56x/hal_lld.c b/os/hal/platforms/SPC56x/hal_lld.c index a855a70a2..4d4a10c41 100644 --- a/os/hal/platforms/SPC56x/hal_lld.c +++ b/os/hal/platforms/SPC56x/hal_lld.c @@ -21,7 +21,7 @@ * @file SPC56x/hal_lld.c
* @brief SPC563 HAL subsystem low level driver source.
*
- * @addtogroup SPC563_HAL
+ * @addtogroup HAL
* @{
*/
diff --git a/os/hal/platforms/SPC56x/hal_lld.h b/os/hal/platforms/SPC56x/hal_lld.h index e34fe7e3b..c61089a38 100644 --- a/os/hal/platforms/SPC56x/hal_lld.h +++ b/os/hal/platforms/SPC56x/hal_lld.h @@ -21,7 +21,7 @@ * @file SPC56x/hal_lld.h
* @brief SPC563 HAL subsystem low level driver header.
*
- * @addtogroup SPC563_HAL
+ * @addtogroup HAL
* @{
*/
diff --git a/os/hal/platforms/SPC56x/platform.dox b/os/hal/platforms/SPC56x/platform.dox index a97718c0f..3308731e9 100644 --- a/os/hal/platforms/SPC56x/platform.dox +++ b/os/hal/platforms/SPC56x/platform.dox @@ -18,24 +18,52 @@ */
/**
- * @defgroup SPC563_DRIVERS SPC563 Drivers
- * @brief SPC563 specific support.
+ * @defgroup SPC563 SPC563Mx Drivers
+ * @details This section describes all the supported drivers on the
+ * SPC563Mx/MPC563xM platform and the implementation details
+ * of the single drivers.
*
* @ingroup platforms
*/
/**
- * @defgroup SPC563_HAL SPC563 HAL Support
- * @brief HAL support.
+ * @defgroup SPC563_HAL SPC563Mx Initialization Support
+ * @details The SPC563Mx/MPC563xM HAL support is responsible for system
+ * initialization.
*
- * @ingroup SPC563_DRIVERS
+ * @section spc563_hal_1 Supported HW resources
+ * - FMPLL.
+ * - INTC.
+ * - XBAR.
+ * - CFLASH0.
+ * .
+ * @section spc563_hal_2 SPC563Mx HAL driver implementation features
+ * - FMPLL startup and stabilization.
+ * - Clock tree initialization.
+ * - Clock source selection.
+ * - Flash wait states initialization based on the selected clock options.
+ * - SYSTICK initialization based on current clock and kernel required rate.
+ * - DMA support initialization.
+ * .
+ * @ingroup SPC563
*/
/**
- * @defgroup SPC563_SERIAL SPC563 ESCI Support
- * @brief ESCI support.
- * @details The serial driver supports both the SPC563 ESCIs in asynchronous
- * mode.
+ * @defgroup SPC563_SERIAL SPC563Mx ESCI Support (buffered)
+ * @details The SPC563Mx/MPC563xM Serial driver uses the ESCI peripherals
+ * in a buffered, interrupt driven, implementation.
*
- * @ingroup SPC563_DRIVERS
+ * @section spc563_serial_1 Supported HW resources
+ * The serial driver can support any of the following hardware resources:
+ * - ESCIA.
+ * - ESCIB.
+ * .
+ * @section spc563_serial_2 SPC563Mx Serial driver implementation features
+ * - Clock stop for reduced power usage when the driver is in stop state.
+ * - Each ESCI can be independently enabled and programmed. Unused
+ * peripherals are left in low power mode.
+ * - Fully interrupt driven.
+ * - Programmable priority levels for each ESCI.
+ * .
+ * @ingroup SPC563
*/
diff --git a/os/hal/platforms/SPC56x/serial_lld.c b/os/hal/platforms/SPC56x/serial_lld.c index 363381750..74b7da68a 100644 --- a/os/hal/platforms/SPC56x/serial_lld.c +++ b/os/hal/platforms/SPC56x/serial_lld.c @@ -21,7 +21,7 @@ * @file SPC56x/serial_lld.c
* @brief SPC563 low level serial driver code.
*
- * @addtogroup SPC563_SERIAL
+ * @addtogroup SERIAL
* @{
*/
diff --git a/os/hal/platforms/SPC56x/serial_lld.h b/os/hal/platforms/SPC56x/serial_lld.h index 5dc9c8c64..3fd61ef1d 100644 --- a/os/hal/platforms/SPC56x/serial_lld.h +++ b/os/hal/platforms/SPC56x/serial_lld.h @@ -21,7 +21,7 @@ * @file SPC56x/serial_lld.h
* @brief SPC563 low level serial driver header.
*
- * @addtogroup SPC563_SERIAL
+ * @addtogroup SERIAL
* @{
*/
|