aboutsummaryrefslogtreecommitdiffstats
path: root/libmaple
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-11-28 22:42:06 -0500
committerMarti Bolivar <mbolivar@leaflabs.com>2012-04-11 16:56:52 -0400
commit95e12215caec0b4dba9a1d394e6cf7210ce6c30b (patch)
tree6a3b9e3698dba5fef34bb0b9bf4d10ecfd4712f2 /libmaple
parent35d55def21b78dc9f1416a19edd98b48c53754ee (diff)
downloadlibrambutan-95e12215caec0b4dba9a1d394e6cf7210ce6c30b.tar.gz
librambutan-95e12215caec0b4dba9a1d394e6cf7210ce6c30b.zip
Move nonportable bits of libmaple/stm32.h into libmaple/stm32f1.
These go in a new family header, libmaple/stm32f1/include/family/stm32.h. While we're at it, do some reorganizing. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
Diffstat (limited to 'libmaple')
-rw-r--r--libmaple/include/libmaple/stm32.h203
-rw-r--r--libmaple/stm32f1/include/family/stm32.h100
2 files changed, 168 insertions, 135 deletions
diff --git a/libmaple/include/libmaple/stm32.h b/libmaple/include/libmaple/stm32.h
index 53a5d7a..5efb670 100644
--- a/libmaple/include/libmaple/stm32.h
+++ b/libmaple/include/libmaple/stm32.h
@@ -36,162 +36,95 @@
extern "C" {
#endif
-/*
- * User-specific configuration.
- *
- * The #defines here depend upon how libmaple is used. Because of the
- * potential for a mismatch between them and the actual libmaple
- * usage, you should try to keep their number to an absolute minimum.
- */
+/* Everything enclosed in the following __DOXYGEN_PREDEFINED_HACK
+ * conditional block must be defined in the family header. */
+#include <family/stm32.h>
#ifdef __DOXYGEN_PREDEFINED_HACK
- /** @brief APB1 clock speed, in Hz. */
- #define STM32_PCLK1
- /** @brief APB2 clock speed, in Hz. */
- #define STM32_PCLK2
-
- /** Deprecated. Use STM32_PCLK1 instead. */
- #define PCLK1
- /** Deprecated. Use STM32_PCLK2 instead. */
- #define PCLK2
+/*
+ * Clock configuration.
+ *
+ * These defines depend upon how the MCU is configured. Because of
+ * the potential for a mismatch between them and the actual clock
+ * configuration, keep their number to a minimum.
+ */
-#endif
+/**
+ * @brief APB1 clock speed, in Hz.
+ */
+#define STM32_PCLK1
-#ifndef STM32_PCLK1
-#define STM32_PCLK1 36000000U
-#endif
-#ifndef PCLK1
-#define PCLK1 STM32_PCLK1
-#endif
-#if PCLK1 != STM32_PCLK1
-#error "(Deprecated) PCLK1 differs from STM32_PCLK1"
-#endif
+/**
+ * @brief APB2 clock speed, in Hz.
+ */
+#define STM32_PCLK2
-#ifndef STM32_PCLK2
-#define STM32_PCLK2 72000000U
-#endif
-#ifndef PCLK2
-#define PCLK2 STM32_PCLK2
-#endif
-#if PCLK2 != STM32_PCLK2
-#error "(Deprecated) PCLK2 differs from STM32_PCLK2"
-#endif
+/** @brief Deprecated. Use STM32_PCLK1 instead. */
+#define PCLK1
+/** @brief Deprecated. Use STM32_PCLK2 instead. */
+#define PCLK2
/*
- * Density-specific configuration.
+ * Family- and MCU-specific values.
*/
-#ifdef __DOXYGEN_PREDEFINED_HACK
-
- /**
- * @brief Number of interrupts in the NVIC.
- *
- * This define is automatically generated whenever the proper
- * density is defined (currently, this is restricted to defining
- * one of STM32_MEDIUM_DENSITY and STM32_HIGH_DENSITY).
- */
- #define STM32_NR_INTERRUPTS
+/**
+ * @brief Number of interrupts in the vector table.
+ *
+ * This does not include Cortex-M interrupts (NMI, HardFault, etc.).
+ */
+#define STM32_NR_INTERRUPTS
- /** Deprecated. Use STM32_NR_INTERRUPTS instead. */
- #define NR_INTERRUPTS
+/**
+ * Number of GPIO ports.
+ */
+#define STM32_NR_GPIO_PORTS
-#endif
+/**
+ * @brief Multiplier to convert microseconds into loop iterations
+ * in delay_us().
+ *
+ * @see delay_us()
+ */
+#define STM32_DELAY_US_MULT
-#ifdef STM32_MEDIUM_DENSITY
- #define STM32_NR_INTERRUPTS 43
-#elif defined(STM32_HIGH_DENSITY)
- #define STM32_NR_INTERRUPTS 60
-#else
-#error "No STM32 board type defined!"
-#endif
+/**
+ * @brief Pointer to end of built-in SRAM.
+ *
+ * Points to the address which is 1 byte past the last valid
+ * SRAM address.
+ */
+#define STM32_SRAM_END
-#define NR_INTERRUPTS STM32_NR_INTERRUPTS
+#endif /* __DOXYGEN_PREDEFINED_HACK */
/*
- * MCU-specific configuration.
+ * The following are for backwards compatibility only.
*/
-#ifdef __DOXYGEN_PREDEFINED_HACK
-
- /**
- * Number of GPIO ports.
- */
- #define STM32_NR_GPIO_PORTS
-
- /**
- * @brief Multiplier to convert microseconds into loop iterations
- * in delay_us().
- *
- * @see delay_us()
- */
- #define STM32_DELAY_US_MULT
-
- /**
- * @brief Pointer to end of built-in SRAM.
- *
- * Points to the address which is 1 byte past the last valid
- * SRAM address.
- */
- #define STM32_SRAM_END
-
- /** Deprecated. Use STM32_NR_GPIO_PORTS instead. */
- #define NR_GPIO_PORTS
- /** Deprecated. Use STM32_DELAY_US_MULT instead. */
- #define DELAY_US_MULT
-
+/* PCLK1 and PCLK2 are for backwards compatibility only; don't use in
+ * new code. */
+#ifndef PCLK1
+#define PCLK1 STM32_PCLK1
#endif
-
-#if defined(MCU_STM32F103RB)
- /* e.g., LeafLabs Maple */
-
- #define STM32_NR_GPIO_PORTS 4
- #define STM32_DELAY_US_MULT 12
- #define STM32_SRAM_END ((void*)0x20005000)
-
- #define NR_GPIO_PORTS STM32_NR_GPIO_PORTS
- #define DELAY_US_MULT STM32_DELAY_US_MULT
-
-#elif defined(MCU_STM32F103ZE)
- /* e.g., LeafLabs Maple Native */
-
- #define STM32_NR_GPIO_PORTS 7
- #define STM32_DELAY_US_MULT 12
- #define STM32_SRAM_END ((void*)0x20010000)
-
- #define NR_GPIO_PORTS STM32_NR_GPIO_PORTS
- #define DELAY_US_MULT STM32_DELAY_US_MULT
-
-#elif defined(MCU_STM32F103CB)
- /* e.g., LeafLabs Maple Mini */
-
- /* This STM32_NR_GPIO_PORTS value is not, strictly speaking, true.
- * But only pins 0 and 1 exist, and they're used for OSC on the
- * Mini, so we'll live with this for now. */
- #define STM32_NR_GPIO_PORTS 3
- #define STM32_DELAY_US_MULT 12
- #define STM32_SRAM_END ((void*)0x20005000)
-
- #define NR_GPIO_PORTS STM32_NR_GPIO_PORTS
- #define DELAY_US_MULT STM32_DELAY_US_MULT
-
-#elif defined(MCU_STM32F103RE)
- /* e.g., LeafLabs Maple RET6 edition */
-
- #define STM32_NR_GPIO_PORTS 4
- #define STM32_DELAY_US_MULT 12
- #define STM32_SRAM_END ((void*)0x20010000)
-
- #define NR_GPIO_PORTS STM32_NR_GPIO_PORTS
- #define DELAY_US_MULT STM32_DELAY_US_MULT
-
-#else
-
-#error "No MCU type specified. Add something like -DMCU_STM32F103RB " \
- "to your compiler arguments (probably in a Makefile)."
-
+#if PCLK1 != STM32_PCLK1
+#error "PCLK1 (which is deprecated) differs from STM32_PCLK1."
+#endif
+#ifndef PCLK2
+#define PCLK2 STM32_PCLK2
+#endif
+#if PCLK2 != STM32_PCLK2
+#error "PCLK2 (which is deprecated) differs from STM32_PCLK2."
#endif
+/** @brief Deprecated. Use STM32_NR_INTERRUPTS instead. */
+#define NR_INTERRUPTS STM32_NR_INTERRUPTS
+/** @brief Deprecated. Use STM32_NR_GPIO_PORTS instead. */
+#define NR_GPIO_PORTS STM32_NR_GPIO_PORTS
+/** @brief Deprecated. Use STM32_DELAY_US_MULT instead. */
+#define DELAY_US_MULT STM32_DELAY_US_MULT
+
#ifdef __cplusplus
}
#endif
diff --git a/libmaple/stm32f1/include/family/stm32.h b/libmaple/stm32f1/include/family/stm32.h
new file mode 100644
index 0000000..0b77ca0
--- /dev/null
+++ b/libmaple/stm32f1/include/family/stm32.h
@@ -0,0 +1,100 @@
+/******************************************************************************
+ * The MIT License
+ *
+ * Copyright (c) 2010, 2011 LeafLabs, LLC.
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy,
+ * modify, merge, publish, distribute, sublicense, and/or sell copies
+ * of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *****************************************************************************/
+
+/**
+ * @file libmaple/stm32f1/stm32.h
+ * @brief STM32F1 chip- and family-specific definitions.
+ */
+
+#ifndef _LIBMAPLE_STM32F1_H_
+#define _LIBMAPLE_STM32F1_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*
+ * Clock configuration.
+ */
+
+#ifndef STM32_PCLK1
+#define STM32_PCLK1 36000000U
+#endif
+
+#ifndef STM32_PCLK2
+#define STM32_PCLK2 72000000U
+#endif
+
+#ifndef STM32_DELAY_US_MULT
+#define STM32_DELAY_US_MULT 12 /* FIXME: value is incorrect. */
+#endif
+
+/*
+ * Density-specific values.
+ */
+
+#ifdef STM32_MEDIUM_DENSITY
+# define STM32_NR_INTERRUPTS 43
+#elif defined(STM32_HIGH_DENSITY)
+# define STM32_NR_INTERRUPTS 60
+#else
+#error "Unsupported STM32F1 density, or no density specified. Add something " \
+ "like -DSTM32_MEDIUM_DENSITY to your compiler arguments."
+#endif
+
+/*
+ * MCU-specific values.
+ */
+
+#if defined(MCU_STM32F103RB)
+# define STM32_NR_GPIO_PORTS 4
+# define STM32_SRAM_END ((void*)0x20005000)
+
+#elif defined(MCU_STM32F103ZE)
+# define STM32_NR_GPIO_PORTS 7
+# define STM32_SRAM_END ((void*)0x20010000)
+
+#elif defined(MCU_STM32F103CB)
+ /* This STM32_NR_GPIO_PORTS is not stricly true, but only pins 0
+ * and exist, and they're used for OSC (e.g. on e.g. LeafLabs
+ * Maple Mini), so we'll live with this for now. */
+# define STM32_NR_GPIO_PORTS 3
+# define STM32_SRAM_END ((void*)0x20005000)
+
+#elif defined(MCU_STM32F103RE)
+# define STM32_NR_GPIO_PORTS 4
+# define STM32_SRAM_END ((void*)0x20010000)
+
+#else
+#error "Unrecognized STM32F1 MCU, or no MCU specified. Add something like " \
+ "-DMCU_STM32F103RB to your compiler arguments."
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif