From f95fc666de8186937f7101c74386af0c85968ec3 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Wed, 2 Mar 2011 18:56:02 +0000 Subject: Various documentation improvements. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2788 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/hal/platforms/AT91SAM7/platform.dox | 44 +++++++++++----------- os/hal/platforms/AVR/platform.dox | 2 +- os/hal/platforms/LPC11xx/platform.dox | 42 ++++++++++----------- os/hal/platforms/LPC13xx/platform.dox | 42 ++++++++++----------- os/hal/platforms/LPC214x/platform.dox | 42 ++++++++++----------- os/hal/platforms/MSP430/platform.dox | 4 +- os/hal/platforms/SPC56x/platform.dox | 2 +- os/hal/platforms/STM32/platform.dox | 67 +++++++++++++++++++++------------- os/hal/platforms/STM8L/platform.dox | 4 +- os/hal/platforms/STM8S/platform.dox | 42 ++++++++++----------- 10 files changed, 154 insertions(+), 137 deletions(-) (limited to 'os/hal/platforms') diff --git a/os/hal/platforms/AT91SAM7/platform.dox b/os/hal/platforms/AT91SAM7/platform.dox index af4816486..4c87192f0 100644 --- a/os/hal/platforms/AT91SAM7/platform.dox +++ b/os/hal/platforms/AT91SAM7/platform.dox @@ -42,7 +42,7 @@ */ /** - * @defgroup AT91SAM7_MAC AT91SAM7 EMAC Support + * @defgroup AT91SAM7_MAC AT91SAM7 MAC Support * @details The AT91SAM7 MAC driver supports the EMAC peripheral. * * @section at91sam7_mac_1 Supported HW resources @@ -62,7 +62,7 @@ */ /** - * @defgroup AT91SAM7_PAL AT91SAM7 PIO Support + * @defgroup AT91SAM7_PAL AT91SAM7 PAL Support * @details The AT91SAM7 PAL driver supports the PIO peripherals. * * @section at91sam7_pal_1 Supported HW resources @@ -99,26 +99,7 @@ */ /** - * @defgroup AT91SAM7_SPI AT91SAM7 SPI Support - * @details The SPI driver supports the AT91SAM7 SPI peripherals using DMA - * channels for maximum performance. - * - * @section at91sam7_spi_1 Supported HW resources - * - SPI1. - * - SPI2. - * . - * @section at91sam7_spi_2 AT91SAM7 SPI driver implementation features - * - Clock stop for reduced power usage when the driver is in stop state. - * - Each SPI can be independently enabled and programmed. Unused - * peripherals are left in low power mode. - * - Programmable interrupt priority levels for each SPI. - * - DMA is used for receiving and transmitting. - * . - * @ingroup AT91SAM7 - */ - -/** - * @defgroup AT91SAM7_SERIAL AT91SAM7 USART Support (buffered) + * @defgroup AT91SAM7_SERIAL AT91SAM7 Serial Support * @details The AT91SAM7 Serial driver uses the USART/UART peripherals in a * buffered, interrupt driven, implementation. * @@ -137,3 +118,22 @@ * . * @ingroup AT91SAM7 */ + +/** + * @defgroup AT91SAM7_SPI AT91SAM7 SPI Support + * @details The SPI driver supports the AT91SAM7 SPI peripherals using DMA + * channels for maximum performance. + * + * @section at91sam7_spi_1 Supported HW resources + * - SPI1. + * - SPI2. + * . + * @section at91sam7_spi_2 AT91SAM7 SPI driver implementation features + * - Clock stop for reduced power usage when the driver is in stop state. + * - Each SPI can be independently enabled and programmed. Unused + * peripherals are left in low power mode. + * - Programmable interrupt priority levels for each SPI. + * - DMA is used for receiving and transmitting. + * . + * @ingroup AT91SAM7 + */ diff --git a/os/hal/platforms/AVR/platform.dox b/os/hal/platforms/AVR/platform.dox index 9b8cf3e6b..9b497b724 100644 --- a/os/hal/platforms/AVR/platform.dox +++ b/os/hal/platforms/AVR/platform.dox @@ -35,7 +35,7 @@ */ /** - * @defgroup AVR_SERIAL AVR USART Support (buffered) + * @defgroup AVR_SERIAL AVR Serial Support * @details The AVR Serial driver uses the USART peripherals in a * buffered, interrupt driven, implementation. * diff --git a/os/hal/platforms/LPC11xx/platform.dox b/os/hal/platforms/LPC11xx/platform.dox index 19dd542ae..ec9ac59af 100644 --- a/os/hal/platforms/LPC11xx/platform.dox +++ b/os/hal/platforms/LPC11xx/platform.dox @@ -43,7 +43,7 @@ */ /** - * @defgroup LPC11xx_PAL LPC11xx GPIO Support + * @defgroup LPC11xx_PAL LPC11xx PAL Support * @details The LPC11xx PAL driver uses the GPIO peripherals. * * @section lpc11xx_pal_1 Supported HW resources @@ -79,7 +79,26 @@ */ /** - * @defgroup LPC11xx_SPI LPC11xx SSP Support + * @defgroup LPC11xx_SERIAL LPC11xx Serial Support + * @details The LPC11xx Serial driver uses the UART peripheral in a + * buffered, interrupt driven, implementation. The serial driver + * also takes advantage of the LPC11xx UARTs deep hardware buffers. + * + * @section lpc11xx_serial_1 Supported HW resources + * The serial driver can support any of the following hardware resources: + * - UART. + * . + * @section lpc11xx_serial_2 LPC11xx Serial driver implementation features + * - Clock stop for reduced power usage when the driver is in stop state. + * - Fully interrupt driven. + * - Programmable priority level. + * - Takes advantage of the input and output FIFOs. + * . + * @ingroup LPC11xx + */ + +/** + * @defgroup LPC11xx_SPI LPC11xx SPI Support * @details The SPI driver supports the LPC11xx SSP peripherals in an interrupt * driven implementation. * @note Being the SPI a fast peripheral, much care must be taken to @@ -100,22 +119,3 @@ * . * @ingroup LPC11xx */ - -/** - * @defgroup LPC11xx_SERIAL LPC11xx UART Support (buffered) - * @details The LPC11xx Serial driver uses the UART peripheral in a - * buffered, interrupt driven, implementation. The serial driver - * also takes advantage of the LPC11xx UARTs deep hardware buffers. - * - * @section lpc11xx_serial_1 Supported HW resources - * The serial driver can support any of the following hardware resources: - * - UART. - * . - * @section lpc11xx_serial_2 LPC11xx Serial driver implementation features - * - Clock stop for reduced power usage when the driver is in stop state. - * - Fully interrupt driven. - * - Programmable priority level. - * - Takes advantage of the input and output FIFOs. - * . - * @ingroup LPC11xx - */ diff --git a/os/hal/platforms/LPC13xx/platform.dox b/os/hal/platforms/LPC13xx/platform.dox index 7b1e09a60..54b90b6dd 100644 --- a/os/hal/platforms/LPC13xx/platform.dox +++ b/os/hal/platforms/LPC13xx/platform.dox @@ -43,7 +43,7 @@ */ /** - * @defgroup LPC13xx_PAL LPC13xx GPIO Support + * @defgroup LPC13xx_PAL LPC13xx PAL Support * @details The LPC13xx PAL driver uses the GPIO peripherals. * * @section lpc13xx_pal_1 Supported HW resources @@ -79,7 +79,26 @@ */ /** - * @defgroup LPC13xx_SPI LPC13xx SSP Support + * @defgroup LPC13xx_SERIAL LPC13xx Serial Support + * @details The LPC13xx Serial driver uses the UART peripheral in a + * buffered, interrupt driven, implementation. The serial driver + * also takes advantage of the LPC13xx UARTs deep hardware buffers. + * + * @section lpc13xx_serial_1 Supported HW resources + * The serial driver can support any of the following hardware resources: + * - UART. + * . + * @section lpc13xx_serial_2 LPC13xx Serial driver implementation features + * - Clock stop for reduced power usage when the driver is in stop state. + * - Fully interrupt driven. + * - Programmable priority level. + * - Takes advantage of the input and output FIFOs. + * . + * @ingroup LPC13xx + */ + +/** + * @defgroup LPC13xx_SPI LPC13xx SPI Support * @details The SPI driver supports the LPC13xx SSP peripherals in an interrupt * driven implementation. * @note Being the SPI a fast peripheral, much care must be taken to @@ -100,22 +119,3 @@ * . * @ingroup LPC13xx */ - -/** - * @defgroup LPC13xx_SERIAL LPC13xx UART Support (buffered) - * @details The LPC13xx Serial driver uses the UART peripheral in a - * buffered, interrupt driven, implementation. The serial driver - * also takes advantage of the LPC13xx UARTs deep hardware buffers. - * - * @section lpc13xx_serial_1 Supported HW resources - * The serial driver can support any of the following hardware resources: - * - UART. - * . - * @section lpc13xx_serial_2 LPC13xx Serial driver implementation features - * - Clock stop for reduced power usage when the driver is in stop state. - * - Fully interrupt driven. - * - Programmable priority level. - * - Takes advantage of the input and output FIFOs. - * . - * @ingroup LPC13xx - */ diff --git a/os/hal/platforms/LPC214x/platform.dox b/os/hal/platforms/LPC214x/platform.dox index b07cce8c6..0c1835ba7 100644 --- a/os/hal/platforms/LPC214x/platform.dox +++ b/os/hal/platforms/LPC214x/platform.dox @@ -43,7 +43,7 @@ */ /** - * @defgroup LPC214x_PAL LPC214x FIO Support + * @defgroup LPC214x_PAL LPC214x PAL Support * @details The LPC214x PAL driver uses the FIO peripherals. * * @section lpc214x_pal_1 Supported HW resources @@ -74,26 +74,7 @@ */ /** - * @defgroup LPC214x_SPI LPC214x SSP Support - * @details The SPI driver supports the LPC214x SSP peripheral in an interrupt - * driven implementation. - * @note Being the SPI a fast peripheral, much care must be taken to - * not saturate the CPU bandwidth with an excessive IRQ rate. The - * maximum transfer bit rate is likely limited by the IRQ - * handling. - * - * @section lpc214x_spi_1 Supported HW resources - * - SSP (SPI0). - * . - * @section lpc214x_spi_2 LPC214x SPI driver implementation features - * - Clock stop for reduced power usage when the driver is in stop state. - * - Programmable interrupt priority level. - * . - * @ingroup LPC214x - */ - -/** - * @defgroup LPC214x_SERIAL LPC214x UART Support (buffered) + * @defgroup LPC214x_SERIAL LPC214x Serial Support * @details The LPC214x Serial driver uses the UART peripherals in a * buffered, interrupt driven, implementation. The serial driver * also takes advantage of the LPC214x UARTs deep hardware buffers. @@ -112,6 +93,25 @@ * @ingroup LPC214x */ +/** + * @defgroup LPC214x_SPI LPC214x SPI Support + * @details The SPI driver supports the LPC214x SSP peripheral in an interrupt + * driven implementation. + * @note Being the SPI a fast peripheral, much care must be taken to + * not saturate the CPU bandwidth with an excessive IRQ rate. The + * maximum transfer bit rate is likely limited by the IRQ + * handling. + * + * @section lpc214x_spi_1 Supported HW resources + * - SSP (SPI0). + * . + * @section lpc214x_spi_2 LPC214x SPI driver implementation features + * - Clock stop for reduced power usage when the driver is in stop state. + * - Programmable interrupt priority level. + * . + * @ingroup LPC214x + */ + /** * @defgroup LPC214x_VIC LPC214x VIC Support * @details This VIC helper driver is used by the other drivers in order to diff --git a/os/hal/platforms/MSP430/platform.dox b/os/hal/platforms/MSP430/platform.dox index ec6bbd535..25d263fa7 100644 --- a/os/hal/platforms/MSP430/platform.dox +++ b/os/hal/platforms/MSP430/platform.dox @@ -41,7 +41,7 @@ */ /** - * @defgroup MSP430_PAL MSP430 PORT Support + * @defgroup MSP430_PAL MSP430 PAL Support * @details The MSP430 PAL driver uses the PORT peripherals. * * @section msp430_pal_1 Supported HW resources @@ -79,7 +79,7 @@ */ /** - * @defgroup MSP430_SERIAL MSP430 USART Support (buffered) + * @defgroup MSP430_SERIAL MSP430 Serial Support * @details The MSP430 Serial driver uses the USART peripherals in a * buffered, interrupt driven, implementation. * diff --git a/os/hal/platforms/SPC56x/platform.dox b/os/hal/platforms/SPC56x/platform.dox index 3308731e9..397e92ad0 100644 --- a/os/hal/platforms/SPC56x/platform.dox +++ b/os/hal/platforms/SPC56x/platform.dox @@ -49,7 +49,7 @@ */ /** - * @defgroup SPC563_SERIAL SPC563Mx ESCI Support (buffered) + * @defgroup SPC563_SERIAL SPC563Mx Serial Support * @details The SPC563Mx/MPC563xM Serial driver uses the ESCI peripherals * in a buffered, interrupt driven, implementation. * 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 @@ -188,6 +188,29 @@ * @ingroup STM32_DRIVERS */ +/** + * @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 @@ -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 + */ diff --git a/os/hal/platforms/STM8L/platform.dox b/os/hal/platforms/STM8L/platform.dox index b1b74251e..ec0bf1cf7 100644 --- a/os/hal/platforms/STM8L/platform.dox +++ b/os/hal/platforms/STM8L/platform.dox @@ -41,7 +41,7 @@ */ /** - * @defgroup STM8L_PAL STM8L GPIO Support + * @defgroup STM8L_PAL STM8L PAL Support * @details The STM8L PAL driver uses the GPIO peripherals. * * @section stm8l_pal_1 Supported HW resources @@ -84,7 +84,7 @@ */ /** - * @defgroup STM8L_SERIAL STM8L USART Support (buffered) + * @defgroup STM8L_SERIAL STM8L Serial Support * @details The STM8L Serial driver uses the USART1 peripheral in a * buffered, interrupt driven, implementation. * diff --git a/os/hal/platforms/STM8S/platform.dox b/os/hal/platforms/STM8S/platform.dox index d05bb4af6..a8e356c6e 100644 --- a/os/hal/platforms/STM8S/platform.dox +++ b/os/hal/platforms/STM8S/platform.dox @@ -40,7 +40,7 @@ */ /** - * @defgroup STM8S_PAL STM8S GPIO Support + * @defgroup STM8S_PAL STM8S PAL Support * @details The STM8S PAL driver uses the GPIO peripherals. * * @section stm8s_pal_1 Supported HW resources @@ -83,26 +83,7 @@ */ /** - * @defgroup STM8S_SPI STM8S SPI Support - * @details The SPI driver supports the STM8S SPI peripheral in an interrupt - * driven implementation. - * @note Being the SPI a fast peripheral, much care must be taken to - * not saturate the CPU bandwidth with an excessive IRQ rate. The - * maximum transfer bit rate is likely limited by the IRQ - * handling. - * - * @section stm8s_spi_1 Supported HW resources - * - SPI. - * . - * @section stm8s_spi_2 STM8S SPI driver implementation features - * - Clock stop for reduced power usage when the driver is in stop state. - * - Fully interrupt driven. - * . - * @ingroup STM8S - */ - -/** - * @defgroup STM8S_SERIAL STM8S UART Support (buffered) + * @defgroup STM8S_SERIAL STM8S Serial Support * @details The STM8S Serial driver uses the UART peripherals in a * buffered, interrupt driven, implementation. * @@ -120,3 +101,22 @@ * . * @ingroup STM8S */ + +/** + * @defgroup STM8S_SPI STM8S SPI Support + * @details The SPI driver supports the STM8S SPI peripheral in an interrupt + * driven implementation. + * @note Being the SPI a fast peripheral, much care must be taken to + * not saturate the CPU bandwidth with an excessive IRQ rate. The + * maximum transfer bit rate is likely limited by the IRQ + * handling. + * + * @section stm8s_spi_1 Supported HW resources + * - SPI. + * . + * @section stm8s_spi_2 STM8S SPI driver implementation features + * - Clock stop for reduced power usage when the driver is in stop state. + * - Fully interrupt driven. + * . + * @ingroup STM8S + */ -- cgit v1.2.3