diff options
| author | Daniel Ramirez <javamonn@gmail.com> | 2013-12-22 15:55:40 -0600 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2013-12-22 21:46:35 -0500 |
| commit | 8224d2af2bba03ec3399faf6d0136b934f0b3fc5 (patch) | |
| tree | 5323f87c5abb9a42cebad231d08ff762cdbd20ca /c/src/lib/libbsp/arm/stm32f4/include/io.h | |
| parent | libbsp/arm: add doxygen to arm shared headers (diff) | |
| download | rtems-8224d2af2bba03ec3399faf6d0136b934f0b3fc5.tar.bz2 | |
arm_stm32f4: added new doxygen
Diffstat (limited to 'c/src/lib/libbsp/arm/stm32f4/include/io.h')
| -rw-r--r-- | c/src/lib/libbsp/arm/stm32f4/include/io.h | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/c/src/lib/libbsp/arm/stm32f4/include/io.h b/c/src/lib/libbsp/arm/stm32f4/include/io.h index b97b8c80f6..2fe7d15b27 100644 --- a/c/src/lib/libbsp/arm/stm32f4/include/io.h +++ b/c/src/lib/libbsp/arm/stm32f4/include/io.h @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup stm32f4_io + * @brief IO support. + */ + /* * Copyright (c) 2012 Sebastian Huber. All rights reserved. * @@ -23,6 +29,13 @@ extern "C" { #endif /* __cplusplus */ +/** + * @defgroup stm32f4_io IO Support + * @ingroup arm_stm32f4 + * @brief IO Support + * @{ + */ + #define STM32F4_GPIO_PIN(port, index) ((((port) << 4) | (index)) & 0xff) #define STM32F4_GPIO_PORT_OF_PIN(pin) (((pin) >> 4) & 0xf) @@ -31,6 +44,11 @@ extern "C" { #ifdef STM32F4_FAMILY_F4XXXX +/** + * @name Family F4XXXX + * @{ + */ + typedef enum { STM32F4_GPIO_MODE_INPUT, STM32F4_GPIO_MODE_OUTPUT, @@ -113,9 +131,16 @@ typedef union { #define STM32F4_GPIO_CONFIG_TERMINAL \ { { 0xff, 0xff, 0x3, 0x1, 0x3, 0x3, 0x1, 0xf, 0xf } } +/** @} */ + #endif /* STM32F4_FAMILY_F4XXXX */ #ifdef STM32F4_FAMILY_F10XXX +/** + * @name Family F10XXX + * @{ + */ + typedef enum { STM32F4_GPIO_MODE_INPUT, STM32F4_GPIO_MODE_OUTPUT_10MHz, @@ -237,6 +262,8 @@ typedef union { #define STM32F4_GPIO_CONFIG_TERMINAL \ { { 0xff, 0xff, 0x3, 0x3, 0x1, 0xff, 0x7 } } +/** @} */ + #endif /* STM32F4_FAMILY_F10XXX */ extern const stm32f4_gpio_config stm32f4_start_config_gpio []; @@ -257,6 +284,11 @@ bool stm32f4_gpio_get_input(int pin); #ifdef STM32F4_FAMILY_F4XXXX +/** + * @name Family F4XXXX + * @{ + */ + #define STM32F4_PIN_USART(port, idx, altfunc) \ { \ { \ @@ -296,9 +328,16 @@ bool stm32f4_gpio_get_input(int pin); #define STM32F4_PIN_USART6_TX_PC6 STM32F4_PIN_USART(2, 6, STM32F4_GPIO_AF_USART6) #define STM32F4_PIN_USART6_RX_PC7 STM32F4_PIN_USART(2, 7, STM32F4_GPIO_AF_USART6) +/** @} */ + #endif /* STM32F4_FAMILY_F4XXXX */ #ifdef STM32F4_FAMILY_F10XXX +/** + * @name Family F10XXX + * @{ + */ + #define STM32F4_PIN_USART_TX(port, idx, remapvalue) \ { \ { \ @@ -366,6 +405,8 @@ bool stm32f4_gpio_get_input(int pin); #define STM32F4_PIN_I2C2_SCL STM32F4_PIN_I2C(1, 10, STM32F4_GPIO_REMAP_DONT_CHANGE) #define STM32F4_PIN_I2C2_SDA STM32F4_PIN_I2C(1, 11, STM32F4_GPIO_REMAP_DONT_CHANGE) +/** @} */ + #endif /* STM32F4_FAMILY_F10XXX */ #ifdef __cplusplus |