aboutsummaryrefslogtreecommitdiffstats
path: root/libmaple/stm32.h
blob: 3b54dbc12e8b2941d5cf8902fc14a84861759f95 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/******************************************************************************
 * The MIT License
 *
 * Copyright (c) 2010 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 stm32.h
 * @brief STM32 chip-specific definitions
 */

#ifndef _STM32_H_
#define _STM32_H_

/*
 * 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.
 */

#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

#endif

#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

#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

/*
 * Density-specific configuration.
 */

#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

    /** Deprecated.  Use STM32_NR_INTERRUPTS instead. */
    #define NR_INTERRUPTS

#endif

#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

#define NR_INTERRUPTS STM32_NR_INTERRUPTS

/*
 * MCU-specific configuration.
 */

#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

#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)."

#endif

#endif  /* _STM32_H_ */