diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2011-03-02 18:56:02 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2011-03-02 18:56:02 +0000 |
| commit | f95fc666de8186937f7101c74386af0c85968ec3 (patch) | |
| tree | 88c37518fead66a1db3c31c799cc88fc367c950c /os/hal/platforms/STM32 | |
| parent | 43bb4bfedb2c8b2ed31adc4d3e262d3c975cbe66 (diff) | |
| download | ChibiOS-f95fc666de8186937f7101c74386af0c85968ec3.tar.gz ChibiOS-f95fc666de8186937f7101c74386af0c85968ec3.tar.bz2 ChibiOS-f95fc666de8186937f7101c74386af0c85968ec3.zip | |
Various documentation improvements.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2788 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/platforms/STM32')
| -rw-r--r-- | os/hal/platforms/STM32/platform.dox | 67 |
1 files changed, 42 insertions, 25 deletions
diff --git a/os/hal/platforms/STM32/platform.dox b/os/hal/platforms/STM32/platform.dox index 8edf27161..cce82c6a2 100644 --- a/os/hal/platforms/STM32/platform.dox +++ b/os/hal/platforms/STM32/platform.dox @@ -119,7 +119,7 @@ */
/**
- * @defgroup STM32_PAL STM32 GPIO Support
+ * @defgroup STM32_PAL STM32 PAL Support
* @details The STM32 PAL driver uses the GPIO peripherals.
*
* @section stm32_pal_1 Supported HW resources
@@ -189,6 +189,29 @@ */
/**
+ * @defgroup STM32_SERIAL STM32 Serial Support
+ * @details The STM32 Serial driver uses the USART/UART peripherals in a
+ * buffered, interrupt driven, implementation.
+ *
+ * @section stm32_serial_1 Supported HW resources
+ * The serial driver can support any of the following hardware resources:
+ * - USART1.
+ * - USART2.
+ * - USART3 (where present).
+ * - UART4 (where present).
+ * - UART5 (where present).
+ * .
+ * @section stm32_serial_2 STM32 Serial driver implementation features
+ * - Clock stop for reduced power usage when the driver is in stop state.
+ * - Each UART/USART can be independently enabled and programmed. Unused
+ * peripherals are left in low power mode.
+ * - Fully interrupt driven.
+ * - Programmable priority levels for each UART/USART.
+ * .
+ * @ingroup STM32_DRIVERS
+ */
+
+/**
* @defgroup STM32_SPI STM32 SPI Support
* @details The SPI driver supports the STM32 SPI peripherals using DMA
* channels for maximum performance.
@@ -214,30 +237,7 @@ */
/**
- * @defgroup STM32_SERIAL STM32 USART Support (buffered)
- * @details The STM32 Serial driver uses the USART/UART peripherals in a
- * buffered, interrupt driven, implementation.
- *
- * @section stm32_serial_1 Supported HW resources
- * The serial driver can support any of the following hardware resources:
- * - USART1.
- * - USART2.
- * - USART3 (where present).
- * - UART4 (where present).
- * - UART5 (where present).
- * .
- * @section stm32_serial_2 STM32 Serial driver implementation features
- * - Clock stop for reduced power usage when the driver is in stop state.
- * - Each UART/USART can be independently enabled and programmed. Unused
- * peripherals are left in low power mode.
- * - Fully interrupt driven.
- * - Programmable priority levels for each UART/USART.
- * .
- * @ingroup STM32_DRIVERS
- */
-
-/**
- * @defgroup STM32_UART STM32 USART Support (unbuffered)
+ * @defgroup STM32_UART STM32 UART Support
* @details The UART driver supports the STM32 USART peripherals using DMA
* channels for maximum performance.
*
@@ -246,6 +246,7 @@ * - USART1.
* - USART2.
* - USART3 (where present).
+ * - UART4 (where present).
* - DMA1.
* - DMA2 (where present).
* .
@@ -261,3 +262,19 @@ * .
* @ingroup STM32_DRIVERS
*/
+
+/**
+ * @defgroup STM32_USB STM32 USB Support
+ * @details The USB driver supports the STM32 USB peripheral.
+ *
+ * @section stm32_usb_1 Supported HW resources
+ * The USB driver can support any of the following hardware resources:
+ * - USB.
+ * .
+ * @section stm32_usb_2 STM32 USB driver implementation features
+ * - Clock stop for reduced power usage when the driver is in stop state.
+ * - Programmable interrupt priority levels.
+ * - Each endpoint programmable in Control, Bulk and Interrupt modes.
+ * .
+ * @ingroup STM32_DRIVERS
+ */
|