aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/platforms/SPC563Mxx/platform.dox
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2012-12-11 10:27:10 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2012-12-11 10:27:10 +0000
commit456ddf784d7bc6fe7c88446faa8bac759078d019 (patch)
tree6aec83a3f121bc25cf14c3b7794941048aad00ac /os/hal/platforms/SPC563Mxx/platform.dox
parentbeb5f4e03ebaaa196009c41fbb4d9e2c7bc3a14d (diff)
downloadChibiOS-456ddf784d7bc6fe7c88446faa8bac759078d019.tar.gz
ChibiOS-456ddf784d7bc6fe7c88446faa8bac759078d019.tar.bz2
ChibiOS-456ddf784d7bc6fe7c88446faa8bac759078d019.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@4900 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/platforms/SPC563Mxx/platform.dox')
-rw-r--r--os/hal/platforms/SPC563Mxx/platform.dox70
1 files changed, 70 insertions, 0 deletions
diff --git a/os/hal/platforms/SPC563Mxx/platform.dox b/os/hal/platforms/SPC563Mxx/platform.dox
new file mode 100644
index 000000000..9b8eec901
--- /dev/null
+++ b/os/hal/platforms/SPC563Mxx/platform.dox
@@ -0,0 +1,70 @@
+/*
+ ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
+ 2011,2012 Giovanni Di Sirio.
+
+ This file is part of ChibiOS/RT.
+
+ ChibiOS/RT is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/RT is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @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 SPC563Mx Initialization Support
+ * @details The SPC563Mx/MPC563xM HAL support is responsible for system
+ * initialization.
+ *
+ * @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 SPC563Mx Serial Support
+ * @details The SPC563Mx/MPC563xM Serial driver uses the ESCI peripherals
+ * in a buffered, interrupt driven, implementation.
+ *
+ * @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
+ */