aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2012-06-20 15:55:54 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2012-06-20 15:55:54 +0000
commit8fb998f0a5bcc315fc45a3af1707551de03af63b (patch)
tree78ec510f4bbf284abce7fafa48acd43f1b33b757
parent6af0806da3d9df7ea9f6410a74ad8c864926bd7f (diff)
downloadChibiOS-8fb998f0a5bcc315fc45a3af1707551de03af63b.tar.gz
ChibiOS-8fb998f0a5bcc315fc45a3af1707551de03af63b.tar.bz2
ChibiOS-8fb998f0a5bcc315fc45a3af1707551de03af63b.zip
Documentation related fix.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@4312 35acf78f-673a-0410-8e92-d51de3d6d3f4
-rw-r--r--os/hal/platforms/STM32F2xx/platform.dox17
-rw-r--r--os/hal/platforms/STM32F4xx/platform.dox17
-rw-r--r--readme.txt2
3 files changed, 33 insertions, 3 deletions
diff --git a/os/hal/platforms/STM32F2xx/platform.dox b/os/hal/platforms/STM32F2xx/platform.dox
index a25583670..124cf8af2 100644
--- a/os/hal/platforms/STM32F2xx/platform.dox
+++ b/os/hal/platforms/STM32F2xx/platform.dox
@@ -70,6 +70,21 @@
*/
/**
+ * @defgroup STM32F2xx_CAN STM32F2xx CAN Support
+ * @details The STM32F2xx CAN driver uses the CAN peripherals.
+ *
+ * @section stm32f2xx_can_1 Supported HW resources
+ * - bxCAN1.
+ * .
+ * @section stm32f2xx_can_2 STM32F2xx CAN driver implementation features
+ * - Clock stop for reduced power usage when the driver is in stop state.
+ * - Support for bxCAN sleep mode.
+ * - Programmable bxCAN interrupts priority level.
+ * .
+ * @ingroup STM32F2xx_DRIVERS
+ */
+
+/**
* @defgroup STM32F2xx_EXT STM32F2xx EXT Support
* @details The STM32F2xx EXT driver uses the EXTI peripheral.
*
@@ -315,7 +330,7 @@
* @details This RCC helper driver is used by the other drivers in order to
* access the shared RCC resources in a consistent way.
*
- * @section stm32f1xx_rcc_1 Supported HW resources
+ * @section stm32f2xx_rcc_1 Supported HW resources
* - RCC.
* .
* @section stm32f2xx_rcc_2 STM32F2xx RCC driver implementation features
diff --git a/os/hal/platforms/STM32F4xx/platform.dox b/os/hal/platforms/STM32F4xx/platform.dox
index eee233f70..dc8698a33 100644
--- a/os/hal/platforms/STM32F4xx/platform.dox
+++ b/os/hal/platforms/STM32F4xx/platform.dox
@@ -70,6 +70,21 @@
*/
/**
+ * @defgroup STM32F2xx_CAN STM32F2xx CAN Support
+ * @details The STM32F2xx CAN driver uses the CAN peripherals.
+ *
+ * @section stm32f2xx_can_1 Supported HW resources
+ * - bxCAN1.
+ * .
+ * @section stm32f2xx_can_2 STM32F2xx CAN driver implementation features
+ * - Clock stop for reduced power usage when the driver is in stop state.
+ * - Support for bxCAN sleep mode.
+ * - Programmable bxCAN interrupts priority level.
+ * .
+ * @ingroup STM32F2xx_DRIVERS
+ */
+
+/**
* @defgroup STM32F4xx_EXT STM32F4xx EXT Support
* @details The STM32F4xx EXT driver uses the EXTI peripheral.
*
@@ -315,7 +330,7 @@
* @details This RCC helper driver is used by the other drivers in order to
* access the shared RCC resources in a consistent way.
*
- * @section stm32f1xx_rcc_1 Supported HW resources
+ * @section stm32f4xx_rcc_1 Supported HW resources
* - RCC.
* .
* @section stm32f4xx_rcc_2 STM32F4xx RCC driver implementation features
diff --git a/readme.txt b/readme.txt
index f6850f35b..f362d373c 100644
--- a/readme.txt
+++ b/readme.txt
@@ -156,7 +156,7 @@
3484947)(backported to 2.4.1).
- FIX: Fixed various minor documentation errors (bug 3484942)(backported
to 2.4.1).
-- NEW: Validated CAN driver on STM32F2/F4.
+- NEW: Validated CAN driver on STM32F2/F4 (backported to 2.4.2).
- NEW: USB implementation for STM32F105/F107/2xx/F4xx devices.
- NEW: Improved SerialUSB driver using the new queued mode, much smaller
than the previous driver.