aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/platforms/SPC56x/platform.dox
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/platforms/SPC56x/platform.dox')
-rw-r--r--os/hal/platforms/SPC56x/platform.dox48
1 files changed, 38 insertions, 10 deletions
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
*/