aboutsummaryrefslogtreecommitdiff
path: root/nuttx/arch/arm/src/stm32/stm32_pwm.h
blob: c51c569504f4093d45aa8a5d26fdaf1167826615 (plain) (blame)
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
/************************************************************************************
 * arch/arm/src/stm32/stm32_pwm.h
 *
 *   Copyright (C) 2011 Gregory Nutt. All rights reserved.
 *   Author: Gregory Nutt <gnutt@nuttx.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name NuttX nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ************************************************************************************/

#ifndef __ARCH_ARM_SRC_STM32_STM32_PWM_H
#define __ARCH_ARM_SRC_STM32_STM32_PWM_H

/* The STM32 does not have dedicated PWM hardware.  Rather, pulsed output control
 * is a capabilitiy of the STM32 timers.  The logic in this file implements the
 * lower half of the standard, NuttX PWM interface using the STM32 timers.  That
 * interface is described in include/nuttx/pwm.h.
 */

/************************************************************************************
 * Included Files
 ************************************************************************************/

#include <nuttx/config.h>

#include "chip.h"

/************************************************************************************
 * Pre-processor Definitions
 ************************************************************************************/
/* Configuration ********************************************************************/
/* Timer devices may be used for different purposes.  One special purpose is
 * to generate modulated outputs for such things as motor control.  If CONFIG_STM32_TIMn
 * is defined then the CONFIG_STM32_TIMn_PWM must also be defined to indicate that
 * timer "n" is intended to be used for pulsed output signal generation.
 */

#ifndef CONFIG_STM32_TIM1
#  undef CONFIG_STM32_TIM1_PWM
#endif
#ifndef CONFIG_STM32_TIM2
#  undef CONFIG_STM32_TIM2_PWM
#endif
#ifndef CONFIG_STM32_TIM3
#  undef CONFIG_STM32_TIM3_PWM
#endif
#ifndef CONFIG_STM32_TIM4
#  undef CONFIG_STM32_TIM4_PWM
#endif
#ifndef CONFIG_STM32_TIM5
#  undef CONFIG_STM32_TIM5_PWM
#endif
#ifndef CONFIG_STM32_TIM8
#  undef CONFIG_STM32_TIM8_PWM
#endif
#ifndef CONFIG_STM32_TIM9
#  undef CONFIG_STM32_TIM9_PWM
#endif
#ifndef CONFIG_STM32_TIM10
#  undef CONFIG_STM32_TIM10_PWM
#endif
#ifndef CONFIG_STM32_TIM11
#  undef CONFIG_STM32_TIM11_PWM
#endif
#ifndef CONFIG_STM32_TIM12
#  undef CONFIG_STM32_TIM12_PWM
#endif
#ifndef CONFIG_STM32_TIM13
#  undef CONFIG_STM32_TIM13_PWM
#endif
#ifndef CONFIG_STM32_TIM14
#  undef CONFIG_STM32_TIM14_PWM
#endif

/* The basic timers (timer 6 and 7) are not capable of generating output pulses */

#undef CONFIG_STM32_TIM6_PWM
#undef CONFIG_STM32_TIM7_PWM

/* Check if PWM support for any channel is enabled. */

#if defined(CONFIG_STM32_TIM1_PWM)  || defined(CONFIG_STM32_TIM2_PWM)  || \
    defined(CONFIG_STM32_TIM3_PWM)  || defined(CONFIG_STM32_TIM4_PWM)  || \
    defined(CONFIG_STM32_TIM5_PWM)  || defined(CONFIG_STM32_TIM8_PWM)  || \
    defined(CONFIG_STM32_TIM9_PWM)  || defined(CONFIG_STM32_TIM10_PWM) || \
    defined(CONFIG_STM32_TIM11_PWM) || defined(CONFIG_STM32_TIM12_PWM) || \
    defined(CONFIG_STM32_TIM13_PWM) || defined(CONFIG_STM32_TIM14_PWM)

#include <arch/board/board.h>
#include "chip/stm32_tim.h"

/* For each timer that is enabled for PWM usage, we need the following additional
 * configuration settings:
 *
 * CONFIG_STM32_TIMx_CHANNEL - Specifies the timer output channel {1,..,4}
 * PWM_TIMx_CHn - One of the values defined in chip/stm32*_pinmap.h.  In the case
 *   where there are multiple pin selections, the correct setting must be provided
 *   in the arch/board/board.h file.
 *
 * NOTE: The STM32 timers are each capable of generating different signals on
 * each of the four channels with different duty cycles.  That capability is
 * not supported by this driver:  Only one output channel per timer.
 */

#ifdef CONFIG_STM32_TIM1_PWM
#  if !defined(CONFIG_STM32_TIM1_CHANNEL)
#    error "CONFIG_STM32_TIM1_CHANNEL must be provided"
#  elif CONFIG_STM32_TIM1_CHANNEL == 1
#    define PWM_TIM1_PINCFG GPIO_TIM1_CH1OUT
#  elif CONFIG_STM32_TIM1_CHANNEL == 2
#    define PWM_TIM1_PINCFG GPIO_TIM1_CH2OUT
#  elif CONFIG_STM32_TIM1_CHANNEL == 3
#    define PWM_TIM1_PINCFG GPIO_TIM1_CH3OUT
#  elif CONFIG_STM32_TIM1_CHANNEL == 4
#    define PWM_TIM1_PINCFG GPIO_TIM1_CH4OUT
#  else
#    error "Unsupported value of CONFIG_STM32_TIM1_CHANNEL"
#  endif
#endif

#ifdef CONFIG_STM32_TIM2_PWM
#  if !defined(CONFIG_STM32_TIM2_CHANNEL)
#    error "CONFIG_STM32_TIM2_CHANNEL must be provided"
#  elif CONFIG_STM32_TIM2_CHANNEL == 1
#    define PWM_TIM2_PINCFG GPIO_TIM2_CH1OUT
#  elif CONFIG_STM32_TIM2_CHANNEL == 2
#    define PWM_TIM2_PINCFG GPIO_TIM2_CH2OUT
#  elif CONFIG_STM32_TIM2_CHANNEL == 3
#    define PWM_TIM2_PINCFG GPIO_TIM2_CH3OUT
#  elif CONFIG_STM32_TIM2_CHANNEL == 4
#    define PWM_TIM2_PINCFG GPIO_TIM2_CH4OUT
#  else
#    error "Unsupported value of CONFIG_STM32_TIM2_CHANNEL"
#  endif
#endif

#ifdef CONFIG_STM32_TIM3_PWM
#  if !defined(CONFIG_STM32_TIM3_CHANNEL)
#    error "CONFIG_STM32_TIM3_CHANNEL must be provided"
#  elif CONFIG_STM32_TIM3_CHANNEL == 1
#    define PWM_TIM3_PINCFG GPIO_TIM3_CH1OUT
#  elif CONFIG_STM32_TIM3_CHANNEL == 2
#    define PWM_TIM3_PINCFG GPIO_TIM3_CH2OUT
#  elif CONFIG_STM32_TIM3_CHANNEL == 3
#    define PWM_TIM3_PINCFG GPIO_TIM3_CH3OUT
#  elif CONFIG_STM32_TIM3_CHANNEL == 4
#    define PWM_TIM3_PINCFG GPIO_TIM3_CH4OUT
#  else
#    error "Unsupported value of CONFIG_STM32_TIM3_CHANNEL"
#  endif
#endif

#ifdef CONFIG_STM32_TIM4_PWM
#  if !defined(CONFIG_STM32_TIM4_CHANNEL)
#    error "CONFIG_STM32_TIM4_CHANNEL must be provided"
#  elif CONFIG_STM32_TIM4_CHANNEL == 1
#    define PWM_TIM4_PINCFG GPIO_TIM4_CH1OUT
#  elif CONFIG_STM32_TIM4_CHANNEL == 2
#    define PWM_TIM4_PINCFG GPIO_TIM4_CH2OUT
#  elif CONFIG_STM32_TIM4_CHANNEL == 3
#    define PWM_TIM4_PINCFG GPIO_TIM4_CH3OUT
#  elif CONFIG_STM32_TIM4_CHANNEL == 4
#    define PWM_TIM4_PINCFG GPIO_TIM4_CH4OUT
#  else
#    error "Unsupported value of CONFIG_STM32_TIM4_CHANNEL"
#  endif
#endif

#ifdef CONFIG_STM32_TIM5_PWM
#  if !defined(CONFIG_STM32_TIM5_CHANNEL)
#    error "CONFIG_STM32_TIM5_CHANNEL must be provided"
#  elif CONFIG_STM32_TIM5_CHANNEL == 1
#    define PWM_TIM5_PINCFG GPIO_TIM5_CH1OUT
#  elif CONFIG_STM32_TIM5_CHANNEL == 2
#    define PWM_TIM5_PINCFG GPIO_TIM5_CH2OUT
#  elif CONFIG_STM32_TIM5_CHANNEL == 3
#    define PWM_TIM5_PINCFG GPIO_TIM5_CH3OUT
#  elif CONFIG_STM32_TIM5_CHANNEL == 4
#    define PWM_TIM5_PINCFG GPIO_TIM5_CH4OUT
#  else
#    error "Unsupported value of CONFIG_STM32_TIM5_CHANNEL"
#  endif
#endif

#ifdef CONFIG_STM32_TIM8_PWM
#  if !defined(CONFIG_STM32_TIM8_CHANNEL)
#    error "CONFIG_STM32_TIM8_CHANNEL must be provided"
#  elif CONFIG_STM32_TIM8_CHANNEL == 1
#    define PWM_TIM8_PINCFG GPIO_TIM8_CH1OUT
#  elif CONFIG_STM32_TIM8_CHANNEL == 2
#    define PWM_TIM8_PINCFG GPIO_TIM8_CH2OUT
#  elif CONFIG_STM32_TIM8_CHANNEL == 3
#    define PWM_TIM8_PINCFG GPIO_TIM8_CH3OUT
#  elif CONFIG_STM32_TIM8_CHANNEL == 4
#    define PWM_TIM8_PINCFG GPIO_TIM8_CH4OUT
#  else
#    error "Unsupported value of CONFIG_STM32_TIM8_CHANNEL"
#  endif
#endif

#ifdef CONFIG_STM32_TIM9_PWM
#  if !defined(CONFIG_STM32_TIM9_CHANNEL)
#    error "CONFIG_STM32_TIM9_CHANNEL must be provided"
#  elif CONFIG_STM32_TIM9_CHANNEL == 1
#    define PWM_TIM9_PINCFG GPIO_TIM9_CH1OUT
#  elif CONFIG_STM32_TIM9_CHANNEL == 2
#    define PWM_TIM9_PINCFG GPIO_TIM9_CH2OUT
#  elif CONFIG_STM32_TIM9_CHANNEL == 3
#    define PWM_TIM9_PINCFG GPIO_TIM9_CH3OUT
#  elif CONFIG_STM32_TIM9_CHANNEL == 4
#    define PWM_TIM9_PINCFG GPIO_TIM9_CH4OUT
#  else
#    error "Unsupported value of CONFIG_STM32_TIM9_CHANNEL"
#  endif
#endif

#ifdef CONFIG_STM32_TIM10_PWM
#  if !defined(CONFIG_STM32_TIM10_CHANNEL)
#    error "CONFIG_STM32_TIM10_CHANNEL must be provided"
#  elif CONFIG_STM32_TIM10_CHANNEL == 1
#    define PWM_TIM10_PINCFG GPIO_TIM10_CH1OUT
#  elif CONFIG_STM32_TIM10_CHANNEL == 2
#    define PWM_TIM10_PINCFG GPIO_TIM10_CH2OUT
#  elif CONFIG_STM32_TIM10_CHANNEL == 3
#    define PWM_TIM10_PINCFG GPIO_TIM10_CH3OUT
#  elif CONFIG_STM32_TIM10_CHANNEL == 4
#    define PWM_TIM10_PINCFG GPIO_TIM10_CH4OUT
#  else
#    error "Unsupported value of CONFIG_STM32_TIM10_CHANNEL"
#  endif
#endif

#ifdef CONFIG_STM32_TIM11_PWM
#  if !defined(CONFIG_STM32_TIM11_CHANNEL)
#    error "CONFIG_STM32_TIM11_CHANNEL must be provided"
#  elif CONFIG_STM32_TIM11_CHANNEL == 1
#    define PWM_TIM11_PINCFG GPIO_TIM11_CH1OUT
#  elif CONFIG_STM32_TIM11_CHANNEL == 2
#    define PWM_TIM11_PINCFG GPIO_TIM11_CH2OUT
#  elif CONFIG_STM32_TIM11_CHANNEL == 3
#    define PWM_TIM11_PINCFG GPIO_TIM11_CH3OUT
#  elif CONFIG_STM32_TIM11_CHANNEL == 4
#    define PWM_TIM11_PINCFG GPIO_TIM11_CH4OUT
#  else
#    error "Unsupported value of CONFIG_STM32_TIM11_CHANNEL"
#  endif
#endif

#ifdef CONFIG_STM32_TIM12_PWM
#  if !defined(CONFIG_STM32_TIM12_CHANNEL)
#    error "CONFIG_STM32_TIM12_CHANNEL must be provided"
#  elif CONFIG_STM32_TIM12_CHANNEL == 1
#    define PWM_TIM12_PINCFG GPIO_TIM12_CH1OUT
#  elif CONFIG_STM32_TIM12_CHANNEL == 2
#    define PWM_TIM12_PINCFG GPIO_TIM12_CH2OUT
#  elif CONFIG_STM32_TIM12_CHANNEL == 3
#    define PWM_TIM12_PINCFG GPIO_TIM12_CH3OUT
#  elif CONFIG_STM32_TIM12_CHANNEL == 4
#    define PWM_TIM12_PINCFG GPIO_TIM12_CH4OUT
#  else
#    error "Unsupported value of CONFIG_STM32_TIM12_CHANNEL"
#  endif
#endif

#ifdef CONFIG_STM32_TIM13_PWM
#  if !defined(CONFIG_STM32_TIM13_CHANNEL)
#    error "CONFIG_STM32_TIM13_CHANNEL must be provided"
#  elif CONFIG_STM32_TIM13_CHANNEL == 1
#    define PWM_TIM13_PINCFG GPIO_TIM13_CH1OUT
#  elif CONFIG_STM32_TIM13_CHANNEL == 2
#    define PWM_TIM13_PINCFG GPIO_TIM13_CH2OUT
#  elif CONFIG_STM32_TIM13_CHANNEL == 3
#    define PWM_TIM13_PINCFG GPIO_TIM13_CH3OUT
#  elif CONFIG_STM32_TIM13_CHANNEL == 4
#    define PWM_TIM13_PINCFG GPIO_TIM13_CH4OUT
#  else
#    error "Unsupported value of CONFIG_STM32_TIM13_CHANNEL"
#  endif
#endif

#ifdef CONFIG_STM32_TIM14_PWM
#  if !defined(CONFIG_STM32_TIM14_CHANNEL)
#    error "CONFIG_STM32_TIM14_CHANNEL must be provided"
#  elif CONFIG_STM32_TIM14_CHANNEL == 1
#    define PWM_TIM14_PINCFG GPIO_TIM14_CH1OUT
#  elif CONFIG_STM32_TIM14_CHANNEL == 2
#    define PWM_TIM14_PINCFG GPIO_TIM14_CH2OUT
#  elif CONFIG_STM32_TIM14_CHANNEL == 3
#    define PWM_TIM14_PINCFG GPIO_TIM14_CH3OUT
#  elif CONFIG_STM32_TIM14_CHANNEL == 4
#    define PWM_TIM14_PINCFG GPIO_TIM14_CH4OUT
#  else
#    error "Unsupported value of CONFIG_STM32_TIM14_CHANNEL"
#  endif
#endif

/************************************************************************************
 * Public Types
 ************************************************************************************/

/************************************************************************************
 * Public Data
 ************************************************************************************/

#ifndef __ASSEMBLY__

#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
extern "C" {
#else
#define EXTERN extern
#endif

/************************************************************************************
 * Public Functions
 ************************************************************************************/

/************************************************************************************
 * Name: stm32_pwminitialize
 *
 * Description:
 *   Initialize one timer for use with the upper_level PWM driver.
 *
 * Input Parameters:
 *   timer - A number identifying the timer use.  The number of valid timer
 *     IDs varies with the STM32 MCU and MCU family but is somewhere in
 *     the range of {1,..,14}.
 *
 * Returned Value:
 *   On success, a pointer to the STM32 lower half PWM driver is returned.
 *   NULL is returned on any failure.
 *
 ************************************************************************************/

EXTERN FAR struct pwm_lowerhalf_s *stm32_pwminitialize(int timer);

#undef EXTERN
#if defined(__cplusplus)
}
#endif

#endif /* __ASSEMBLY__ */
#endif /* CONFIG_STM32_TIMx_PWM */
#endif /* __ARCH_ARM_SRC_STM32_STM32_PWM_H */