aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbnewbold <bnewbold@robocracy.org>2015-06-13 18:33:12 -0700
committerbnewbold <bnewbold@robocracy.org>2015-06-13 20:28:01 -0700
commitce9c1210356c758a7e1d322521e5eda25cecde63 (patch)
tree34ac793e4da29252a53d852ec149603a6334e19a
parent5c3136b333d9463acd98e7b92c033d163826e7d0 (diff)
downloadlibrambutan-ce9c1210356c758a7e1d322521e5eda25cecde63.tar.gz
librambutan-ce9c1210356c758a7e1d322521e5eda25cecde63.zip
stm32f2-f4: refactor header guards, doxygen comments
-rw-r--r--libmaple/stm32f2-f4/include/series/adc.h12
-rw-r--r--libmaple/stm32f2-f4/include/series/dac.h8
-rw-r--r--libmaple/stm32f2-f4/include/series/dma.h16
-rw-r--r--libmaple/stm32f2-f4/include/series/exti.h6
-rw-r--r--libmaple/stm32f2-f4/include/series/flash.h10
-rw-r--r--libmaple/stm32f2-f4/include/series/gpio.h6
-rw-r--r--libmaple/stm32f2-f4/include/series/i2c.h4
-rw-r--r--libmaple/stm32f2-f4/include/series/nvic.h8
-rw-r--r--libmaple/stm32f2-f4/include/series/pwr.h10
-rw-r--r--libmaple/stm32f2-f4/include/series/rcc.h32
-rw-r--r--libmaple/stm32f2-f4/include/series/spi.h6
-rw-r--r--libmaple/stm32f2-f4/include/series/stm32.h8
-rw-r--r--libmaple/stm32f2-f4/include/series/timer.h8
-rw-r--r--libmaple/stm32f2-f4/include/series/usart.h6
14 files changed, 70 insertions, 70 deletions
diff --git a/libmaple/stm32f2-f4/include/series/adc.h b/libmaple/stm32f2-f4/include/series/adc.h
index 95be484..5e69949 100644
--- a/libmaple/stm32f2-f4/include/series/adc.h
+++ b/libmaple/stm32f2-f4/include/series/adc.h
@@ -27,11 +27,11 @@
/**
* @file libmaple/stm32f2-f4/include/series/adc.h
* @author Marti Bolivar <mbolivar@leaflabs.com>,
- * @brief STM32F2 ADC support.
+ * @brief STM32F2-F4 ADC support.
*/
-#ifndef _LIBMAPLE_STM32F2_ADC_H_
-#define _LIBMAPLE_STM32F2_ADC_H_
+#ifndef _LIBMAPLE_STM32F2F4_ADC_H_
+#define _LIBMAPLE_STM32F2F4_ADC_H_
#include <libmaple/libmaple_types.h>
@@ -281,7 +281,7 @@ typedef struct adc_common_reg_map {
*/
/**
- * @brief STM32F2 external event selectors for regular group
+ * @brief STM32F2-F4 external event selectors for regular group
* conversion.
* @see adc_set_extsel()
*/
@@ -305,7 +305,7 @@ typedef enum adc_extsel_event {
} adc_extsel_event;
/**
- * @brief STM32F2 sample times, in ADC clock cycles.
+ * @brief STM32F2-F4 sample times, in ADC clock cycles.
*/
typedef enum adc_smp_rate {
ADC_SMPR_3, /**< 3 ADC cycles */
@@ -319,7 +319,7 @@ typedef enum adc_smp_rate {
} adc_smp_rate;
/**
- * @brief STM32F2 ADC prescalers, as divisors of PCLK2.
+ * @brief STM32F2-F4 ADC prescalers, as divisors of PCLK2.
*/
typedef enum adc_prescaler {
/** PCLK2 divided by 2 */
diff --git a/libmaple/stm32f2-f4/include/series/dac.h b/libmaple/stm32f2-f4/include/series/dac.h
index 55662ca..d5a4194 100644
--- a/libmaple/stm32f2-f4/include/series/dac.h
+++ b/libmaple/stm32f2-f4/include/series/dac.h
@@ -26,11 +26,11 @@
/**
* @file libmaple/stm32f2-f4/include/series/dac.h
- * @brief STM32F2 DAC support
+ * @brief STM32F2-F4 DAC support
*/
-#ifndef _LIBMAPLE_STM32F2_DAC_H_
-#define _LIBMAPLE_STM32F2_DAC_H_
+#ifndef _LIBMAPLE_STM32F2F4_DAC_H_
+#define _LIBMAPLE_STM32F2F4_DAC_H_
#ifdef __cplusplus
extern "C"{
@@ -42,7 +42,7 @@ extern "C"{
* Register map type
*/
-/** STM32F2 DAC register map type. */
+/** STM32F2-F4 DAC register map type. */
typedef struct dac_reg_map {
__io uint32 CR; /**< Control register */
__io uint32 SWTRIGR; /**< Software trigger register */
diff --git a/libmaple/stm32f2-f4/include/series/dma.h b/libmaple/stm32f2-f4/include/series/dma.h
index 2632ee7..472dfea 100644
--- a/libmaple/stm32f2-f4/include/series/dma.h
+++ b/libmaple/stm32f2-f4/include/series/dma.h
@@ -27,11 +27,11 @@
/**
* @file libmaple/stm32f2-f4/include/series/dma.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F2 DMA series header
+ * @brief STM32F2-F4 DMA series header
*/
-#ifndef _LIBMAPLE_STM32F2_DMA_H_
-#define _LIBMAPLE_STM32F2_DMA_H_
+#ifndef _LIBMAPLE_STM32F2F4_DMA_H_
+#define _LIBMAPLE_STM32F2F4_DMA_H_
#ifdef __cplusplus
extern "C"{
@@ -45,7 +45,7 @@ extern "C"{
*/
/**
- * @brief STM32F2 DMA register map type.
+ * @brief STM32F2-F4 DMA register map type.
*/
typedef struct dma_reg_map {
/* Isn't it nice how on F1, it's CCR1, but on F2, it's S1CR? */
@@ -119,7 +119,7 @@ typedef struct dma_reg_map {
#define DMA2_BASE ((struct dma_reg_map*)0x40026400)
/**
- * @brief STM32F2 DMA stream (i.e. tube) register map type.
+ * @brief STM32F2-F4 DMA stream (i.e. tube) register map type.
* Provides access to an individual stream's registers.
* @see dma_tube_regs()
*/
@@ -457,11 +457,11 @@ typedef enum dma_stream {
DMA_S7 = 7,
} dma_stream;
-/** STM32F2 dma_tube (=dma_stream) */
+/** STM32F2-F4 dma_tube (=dma_stream) */
#define dma_tube dma_stream
/**
- * @brief STM32F2 configuration flags for dma_tube_config.
+ * @brief STM32F2-F4 configuration flags for dma_tube_config.
* @see struct dma_tube_config
*/
typedef enum dma_cfg_flags {
@@ -503,7 +503,7 @@ typedef enum dma_cfg_flags {
} dma_cfg_flags;
/**
- * @brief STM32F2 DMA request sources.
+ * @brief STM32F2-F4 DMA request sources.
*
* IMPORTANT:
*
diff --git a/libmaple/stm32f2-f4/include/series/exti.h b/libmaple/stm32f2-f4/include/series/exti.h
index 4643fcf..ffd01b5 100644
--- a/libmaple/stm32f2-f4/include/series/exti.h
+++ b/libmaple/stm32f2-f4/include/series/exti.h
@@ -26,11 +26,11 @@
/**
* @file libmaple/stm32f1/include/series/exti.h
- * @brief STM32F2 external interrupts
+ * @brief STM32F2-F4 external interrupts
*/
-#ifndef _LIBMAPLE_STM32F2_EXTI_H_
-#define _LIBMAPLE_STM32F2_EXTI_H_
+#ifndef _LIBMAPLE_STM32F2F4_EXTI_H_
+#define _LIBMAPLE_STM32F2F4_EXTI_H_
#ifdef __cpluspus
extern "C" {
diff --git a/libmaple/stm32f2-f4/include/series/flash.h b/libmaple/stm32f2-f4/include/series/flash.h
index 35cf528..3676b0b 100644
--- a/libmaple/stm32f2-f4/include/series/flash.h
+++ b/libmaple/stm32f2-f4/include/series/flash.h
@@ -26,15 +26,15 @@
/**
* @file libmaple/stm32f2-f4/include/series/flash.h
- * @brief STM32F2 Flash header.
+ * @brief STM32F2-F4 Flash header.
*
* Provides register map, base pointer, and register bit definitions
- * for the Flash controller on the STM32F2 series, along with
+ * for the Flash controller on the STM32F2-F4 series, along with
* series-specific configuration values.
*/
-#ifndef _LIBMAPLE_STM32F2_FLASH_H_
-#define _LIBMAPLE_STM32F2_FLASH_H_
+#ifndef _LIBMAPLE_STM32F2F4_FLASH_H_
+#define _LIBMAPLE_STM32F2F4_FLASH_H_
#ifdef __cplusplus
extern "C"{
@@ -46,7 +46,7 @@ extern "C"{
* Register map
*/
-/** @brief STM32F2 Flash register map type */
+/** @brief STM32F2-F4 Flash register map type */
typedef struct flash_reg_map {
__io uint32 ACR; /**< Access control register */
__io uint32 KEYR; /**< Key register */
diff --git a/libmaple/stm32f2-f4/include/series/gpio.h b/libmaple/stm32f2-f4/include/series/gpio.h
index 1d457d8..9e4c693 100644
--- a/libmaple/stm32f2-f4/include/series/gpio.h
+++ b/libmaple/stm32f2-f4/include/series/gpio.h
@@ -26,11 +26,11 @@
/**
* @file libmaple/stm32f2-f4/include/series/gpio.h
- * @brief STM32F2 GPIO support.
+ * @brief STM32F2-F4 GPIO support.
*/
-#ifndef _LIBMAPLE_STM32F2_GPIO_H_
-#define _LIBMAPLE_STM32F2_GPIO_H_
+#ifndef _LIBMAPLE_STM32F2F4_GPIO_H_
+#define _LIBMAPLE_STM32F2F4_GPIO_H_
#ifdef __cplusplus
extern "C"{
diff --git a/libmaple/stm32f2-f4/include/series/i2c.h b/libmaple/stm32f2-f4/include/series/i2c.h
index b231256..17c0d41 100644
--- a/libmaple/stm32f2-f4/include/series/i2c.h
+++ b/libmaple/stm32f2-f4/include/series/i2c.h
@@ -26,8 +26,8 @@
* SOFTWARE.
*****************************************************************************/
-#ifndef _LIBMAPLE_STM32F2_I2C_H_
-#define _LIBMAPLE_STM32F2_I2C_H_
+#ifndef _LIBMAPLE_STM32F2F4_I2C_H_
+#define _LIBMAPLE_STM32F2F4_I2C_H_
#include <libmaple/i2c_common.h>
#include <libmaple/stm32.h>
diff --git a/libmaple/stm32f2-f4/include/series/nvic.h b/libmaple/stm32f2-f4/include/series/nvic.h
index b77b91a..9c035a2 100644
--- a/libmaple/stm32f2-f4/include/series/nvic.h
+++ b/libmaple/stm32f2-f4/include/series/nvic.h
@@ -26,18 +26,18 @@
/**
* @file libmaple/stm32f2-f4/include/series/nvic.h
- * @brief STM32F2 nested vectored interrupt controller (NVIC) header.
+ * @brief STM32F2-F4 nested vectored interrupt controller (NVIC) header.
*/
-#ifndef _LIBMAPLE_STM32F2_NVIC_H_
-#define _LIBMAPLE_STM32F2_NVIC_H_
+#ifndef _LIBMAPLE_STM32F2F4_NVIC_H_
+#define _LIBMAPLE_STM32F2F4_NVIC_H_
#ifdef __cplusplus
extern "C"{
#endif
/**
- * @brief STM32F2 interrupt vector table interrupt numbers.
+ * @brief STM32F2-F4 interrupt vector table interrupt numbers.
*/
typedef enum nvic_irq_num {
NVIC_NMI = -14, /**< Non-maskable interrupt */
diff --git a/libmaple/stm32f2-f4/include/series/pwr.h b/libmaple/stm32f2-f4/include/series/pwr.h
index aee6eff..ed30cce 100644
--- a/libmaple/stm32f2-f4/include/series/pwr.h
+++ b/libmaple/stm32f2-f4/include/series/pwr.h
@@ -27,11 +27,11 @@
/**
* @file libmaple/stm32f2-f4/include/series/pwr.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F2 Power control (PWR) support.
+ * @brief STM32F2-F4 Power control (PWR) support.
*/
-#ifndef _LIBMAPLE_STM32F2_PWR_H_
-#define _LIBMAPLE_STM32F2_PWR_H_
+#ifndef _LIBMAPLE_STM32F2F4_PWR_H_
+#define _LIBMAPLE_STM32F2F4_PWR_H_
/*
* Additional register bits
@@ -41,11 +41,11 @@
/**
* @brief Flash power down in stop mode bit.
- * Availability: STM32F2 */
+ * Availability: STM32F2-F4 */
#define PWR_CR_FPDS_BIT 9
/**
* @brief Flash power down in stop mode.
- * Availability: STM32F2 */
+ * Availability: STM32F2-F4 */
#define PWR_CR_FPDS (1U << PWR_CR_FPDS_BIT)
/* PVD level selection */
diff --git a/libmaple/stm32f2-f4/include/series/rcc.h b/libmaple/stm32f2-f4/include/series/rcc.h
index 6694cfa..797d237 100644
--- a/libmaple/stm32f2-f4/include/series/rcc.h
+++ b/libmaple/stm32f2-f4/include/series/rcc.h
@@ -26,11 +26,11 @@
/**
* @file libmaple/stm32f2-f4/include/series/rcc.h
- * @brief STM32F2 reset and clock control (RCC) support.
+ * @brief STM32F2-F4 reset and clock control (RCC) support.
*/
-#ifndef _LIBMAPLE_STM32F2_RCC_H_
-#define _LIBMAPLE_STM32F2_RCC_H_
+#ifndef _LIBMAPLE_STM32F2F4_RCC_H_
+#define _LIBMAPLE_STM32F2F4_RCC_H_
#ifdef __cplusplus
extern "C"{
@@ -42,7 +42,7 @@ extern "C"{
* Register map
*/
-/** STM32F2 RCC register map type */
+/** STM32F2-F4 RCC register map type */
typedef struct rcc_reg_map {
__io uint32 CR; /**< Clock control register */
__io uint32 PLLCFGR; /**< PLL configuration register */
@@ -738,7 +738,7 @@ typedef struct rcc_reg_map {
*/
/**
- * @brief STM32F2 clock sources.
+ * @brief STM32F2-F4 clock sources.
*/
typedef enum rcc_clk {
RCC_CLK_PLLI2S = (uint16)((offsetof(struct rcc_reg_map, CR) << 8) |
@@ -760,7 +760,7 @@ typedef enum rcc_clk {
} rcc_clk;
/**
- * @brief STM32F2 rcc_clk_id.
+ * @brief STM32F2-F4 rcc_clk_id.
*/
typedef enum rcc_clk_id {
RCC_ADC1,
@@ -827,7 +827,7 @@ typedef enum rcc_clk_id {
} rcc_clk_id;
/**
- * @brief STM32F2 PLL entry clock source
+ * @brief STM32F2-F4 PLL entry clock source
* @see rcc_configure_pll()
*/
typedef enum rcc_pllsrc {
@@ -836,7 +836,7 @@ typedef enum rcc_pllsrc {
} rcc_pllsrc;
/**
- * @brief STM32F2 Peripheral clock domains.
+ * @brief STM32F2-F4 Peripheral clock domains.
*/
typedef enum rcc_clk_domain {
RCC_APB1,
@@ -851,7 +851,7 @@ typedef enum rcc_clk_domain {
*/
/**
- * @brief STM32F2 Prescaler identifiers.
+ * @brief STM32F2-F4 Prescaler identifiers.
*/
typedef enum rcc_prescaler {
RCC_PRESCALER_MCO2,
@@ -863,7 +863,7 @@ typedef enum rcc_prescaler {
} rcc_prescaler;
/**
- * @brief STM32F2 MCO2 prescaler dividers.
+ * @brief STM32F2-F4 MCO2 prescaler dividers.
*/
typedef enum rcc_mco2_divider {
RCC_MCO2_DIV_1 = RCC_CFGR_MCO2PRE_DIV_1,
@@ -874,7 +874,7 @@ typedef enum rcc_mco2_divider {
} rcc_mco2_divider;
/**
- * @brief STM32F2 MCO1 prescaler dividers.
+ * @brief STM32F2-F4 MCO1 prescaler dividers.
*/
typedef enum rcc_mco1_divider {
RCC_MCO1_DIV_1 = RCC_CFGR_MCO1PRE_DIV_1,
@@ -885,14 +885,14 @@ typedef enum rcc_mco1_divider {
} rcc_mco1_divider;
/**
- * @brief STM32F2 RTC prescaler dividers.
+ * @brief STM32F2-F4 RTC prescaler dividers.
*/
typedef enum rcc_rtc_divider { /* FIXME [0.0.13] TODO */
RCC_RTC_DIV_TODO = 0xFFFFFFFF,
} rcc_rtc_divider;
/**
- * @brief STM32F2 AP2 prescaler dividers.
+ * @brief STM32F2-F4 AP2 prescaler dividers.
*/
typedef enum rcc_apb2_divider {
RCC_APB2_HCLK_DIV_1 = 0,
@@ -903,7 +903,7 @@ typedef enum rcc_apb2_divider {
} rcc_apb2_divider;
/**
- * @brief STM32F2 APB1 prescaler dividers.
+ * @brief STM32F2-F4 APB1 prescaler dividers.
*/
typedef enum rcc_apb1_divider {
RCC_APB1_HCLK_DIV_1 = 0,
@@ -914,7 +914,7 @@ typedef enum rcc_apb1_divider {
} rcc_apb1_divider;
/**
- * @brief STM32F2 AHB prescaler dividers.
+ * @brief STM32F2-F4 AHB prescaler dividers.
*/
typedef enum rcc_ahb_divider {
RCC_AHB_SYSCLK_DIV_1 = 0,
@@ -929,7 +929,7 @@ typedef enum rcc_ahb_divider {
} rcc_ahb_divider;
/**
- * @brief STM32F2 PLL configuration values.
+ * @brief STM32F2-F4 PLL configuration values.
* Point to one of these with the "data" field in a struct rcc_pll_cfg.
* @see struct rcc_pll_cfg.
*/
diff --git a/libmaple/stm32f2-f4/include/series/spi.h b/libmaple/stm32f2-f4/include/series/spi.h
index da66783..993ff29 100644
--- a/libmaple/stm32f2-f4/include/series/spi.h
+++ b/libmaple/stm32f2-f4/include/series/spi.h
@@ -27,11 +27,11 @@
/**
* @file libmaple/stm32f2-f4/include/series/spi.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F2 SPI/I2S series header.
+ * @brief STM32F2-F4 SPI/I2S series header.
*/
-#ifndef _LIBMAPLE_STM32F2_SPI_H_
-#define _LIBMAPLE_STM32F2_SPI_H_
+#ifndef _LIBMAPLE_STM32F2F4_SPI_H_
+#define _LIBMAPLE_STM32F2F4_SPI_H_
#include <libmaple/gpio.h> /* for gpio_af */
diff --git a/libmaple/stm32f2-f4/include/series/stm32.h b/libmaple/stm32f2-f4/include/series/stm32.h
index 48bbbbc..1bc5d76 100644
--- a/libmaple/stm32f2-f4/include/series/stm32.h
+++ b/libmaple/stm32f2-f4/include/series/stm32.h
@@ -26,11 +26,11 @@
/**
* @file libmaple/stm32f2-f4/include/series/stm32.h
- * @brief STM32F2 chip- and series-specific definitions.
+ * @brief STM32F2-F4 chip- and series-specific definitions.
*/
-#ifndef _LIBMAPLE_STM32F2_STM32_H_
-#define _LIBMAPLE_STM32F2_STM32_H_
+#ifndef _LIBMAPLE_STM32F2F4_STM32_H_
+#define _LIBMAPLE_STM32F2F4_STM32_H_
#ifdef __cplusplus
extern "C" {
@@ -57,7 +57,7 @@ extern "C" {
# define STM32_TIMER_MASK 0x3E
# define STM32_SRAM_END ((void*)0x20010000)
#else
-#warning "Unsupported or unspecified STM32F2 MCU."
+#warning "Unsupported or unspecified STM32F2-F4 MCU."
#endif
/*
diff --git a/libmaple/stm32f2-f4/include/series/timer.h b/libmaple/stm32f2-f4/include/series/timer.h
index bc39a50..781e59b 100644
--- a/libmaple/stm32f2-f4/include/series/timer.h
+++ b/libmaple/stm32f2-f4/include/series/timer.h
@@ -27,11 +27,11 @@
/**
* @file libmaple/stm32f2-f4/include/series/timer.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F2 timer support.
+ * @brief STM32F2-F4 timer support.
*/
-#ifndef _LIBMAPLE_STM32F2_TIMER_H_
-#define _LIBMAPLE_STM32F2_TIMER_H_
+#ifndef _LIBMAPLE_STM32F2F4_TIMER_H_
+#define _LIBMAPLE_STM32F2F4_TIMER_H_
#include <libmaple/libmaple_types.h>
#include <libmaple/gpio.h> /* for gpio_af */
@@ -41,7 +41,7 @@
*/
/**
- * @brief STM32F2 general purpose timer register map type
+ * @brief STM32F2-F4 general purpose timer register map type
*
* Note that not all general purpose timers have all of these
* registers. Consult your chip's reference manual for the details.
diff --git a/libmaple/stm32f2-f4/include/series/usart.h b/libmaple/stm32f2-f4/include/series/usart.h
index f2aca75..64eb01a 100644
--- a/libmaple/stm32f2-f4/include/series/usart.h
+++ b/libmaple/stm32f2-f4/include/series/usart.h
@@ -27,11 +27,11 @@
/**
* @file libmaple/stm32f2-f4/include/series/usart.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F2 USART support.
+ * @brief STM32F2-F4 USART support.
*/
-#ifndef _LIBMAPLE_STM32F2_USART_H_
-#define _LIBMAPLE_STM32F2_USART_H_
+#ifndef _LIBMAPLE_STM32F2F4_USART_H_
+#define _LIBMAPLE_STM32F2F4_USART_H_
#ifdef __cplusplus
extern "C"{