blob: 2b3a37fd13bcbf23afb318411b7c5c7c84c306ff (
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
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
|
/*
ChibiOS/RT - Copyright (C) 2006-2013 Giovanni Di Sirio
LPC11xx PWM driver - Copyright (C) 2013 Marcin Jokel
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @file LPC11xx/pwm_lld.h
* @brief LPC11xx PWM subsystem low level driver header.
*
* @addtogroup PWM
* @{
*/
#ifndef _PWM_LLD_H_
#define _PWM_LLD_H_
#if HAL_USE_PWM || defined(__DOXYGEN__)
/*===========================================================================*/
/* Unsupported modes and specific modes */
/*===========================================================================*/
#undef PWM_OUTPUT_ACTIVE_HIGH
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
#define IR_MR0INT (1 << 0)
#define IR_MR1INT (1 << 1)
#define IR_MR2INT (1 << 2)
#define IR_MR3INT (1 << 3)
#define IR_CR0INT (1 << 4)
#define IR_CR1INT (1 << 5)
#define IR_CR2INT (1 << 6)
#define IR_CR3INT (1 << 7)
#define MCR_MR3I (1 << 9)
#define MCR_MR3R (1 << 10)
#define MCR_MR3S (1 << 11)
/**
* @brief Number of PWM channels per PWM driver.
*/
#define PWM_CHANNELS 2
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @name Configuration options
* @{
*/
/**
* @brief PWMD1 driver enable switch.
* @details If set to @p TRUE the support for PWMD1 is included.
* @note The default is @p TRUE.
*/
#if !defined(LPC11xx_PWM_USE_CT16B0) || defined(__DOXYGEN__)
#define LPC11xx_PWM_USE_CT16B0 FALSE
#endif
/**
* @brief PWMD2 driver enable switch.
* @details If set to @p TRUE the support for PWMD2 is included.
* @note The default is @p TRUE.
*/
#if !defined(LPC11xx_PWM_USE_CT16B1) || defined(__DOXYGEN__)
#define LPC11xx_PWM_USE_CT16B1 FALSE
#endif
/**
* @brief PWMD3 driver enable switch.
* @details If set to @p TRUE the support for PWMD3 is included.
* @note The default is @p TRUE.
*/
#if !defined(LPC11xx_PWM_USE_CT32B0) || defined(__DOXYGEN__)
#define LPC11xx_PWM_USE_CT32B0 FALSE
#endif
/**
* @brief PWMD4 driver enable switch.
* @details If set to @p TRUE the support for PWMD4 is included.
* @note The default is @p TRUE.
*/
#if !defined(LPC11xx_PWM_USE_CT32B1) || defined(__DOXYGEN__)
#define LPC11xx_PWM_USE_CT32B1 FALSE
#endif
/**
* @brief PWMD1 Channel 0 driver enable switch.
* @details If set to @p TRUE PWMD1 Channel 0 is enabled.
* @note The default is @p FALSE.
*/
#if !defined(LPC11xx_PWM_USE_CT16B0_CH0) || defined(__DOXYGEN__)
#define LPC11xx_PWM_USE_CT16B0_CH0 FALSE
#endif
/**
* @brief PWMD1 Channel 1 driver enable switch.
* @details If set to @p TRUE PWMD1 Channel 1 is enabled.
* @note The default is @p FALSE.
*/
#if !defined(LPC11xx_PWM_USE_CT16B0_CH1) || defined(__DOXYGEN__)
#define LPC11xx_PWM_USE_CT16B0_CH1 FALSE
#endif
/**
* @brief PWMD2 Channel 0 driver enable switch.
* @details If set to @p TRUE PWMD2 Channel 0 is enabled.
* @note The default is @p FALSE.
*/
#if !defined(LPC11xx_PWM_USE_CT16B1_CH0) || defined(__DOXYGEN__)
#define LPC11xx_PWM_USE_CT16B1_CH0 FALSE
#endif
/**
* @brief PWMD2 Channel 1 driver enable switch.
* @details If set to @p TRUE PWMD2 Channel 1 is enabled.
* @note The default is @p FALSE.
*/
#if !defined(LPC11xx_PWM_USE_CT16B1_CH1) || defined(__DOXYGEN__)
#define LPC11xx_PWM_USE_CT16B1_CH1 FALSE
#endif
/**
* @brief PWMD3 Channel 0 driver enable switch.
* @details If set to @p TRUE PWMD3 Channel 0 is enabled.
* @note The default is @p FALSE.
*/
#if !defined(LPC11xx_PWM_USE_CT32B0_CH0) || defined(__DOXYGEN__)
#define LPC11xx_PWM_USE_CT32B0_CH0 FALSE
#endif
/**
* @brief PWMD3 Channel 1 driver enable switch.
* @details If set to @p TRUE PWMD3 Channel 1 is enabled.
* @note The default is @p FALSE.
*/
#if !defined(LPC11xx_PWM_USE_CT32B0_CH1) || defined(__DOXYGEN__)
#define LPC11xx_PWM_USE_CT32B0_CH1 FALSE
#endif
/**
* @brief PWMD4 Channel 0 driver enable switch.
* @details If set to @p TRUE PWMD4 Channel 0 is enabled.
* @note The default is @p FALSE.
*/
#if !defined(LPC11xx_PWM_USE_CT32B1_CH0) || defined(__DOXYGEN__)
#define LPC11xx_PWM_USE_CT32B1_CH0 FALSE
#endif
/**
* @brief PWMD4 Channel 1 driver enable switch.
* @details If set to @p TRUE PWMD4 Channel 1 is enabled.
* @note The default is @p FALSE.
*/
#if !defined(LPC11xx_PWM_USE_CT32B1_CH1) || defined(__DOXYGEN__)
#define LPC11xx_PWM_USE_CT32B1_CH1 FALSE
#endif
/**
* @brief PWMD1 interrupt priority level setting.
*/
#if !defined(LPC11xx_PWM_CT16B0_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define LPC11xx_PWM_CT16B0_IRQ_PRIORITY 3
#endif
/**
* @brief PWMD2 interrupt priority level setting.
*/
#if !defined(LPC11xx_PWM_CT16B1_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define LPC11xx_PWM_CT16B1_IRQ_PRIORITY 3
#endif
/**
* @brief PWMD3 interrupt priority level setting.
*/
#if !defined(LPC11xx_PWM_CT32B0_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define LPC11xx_PWM_CT32B0_IRQ_PRIORITY 3
#endif
/**
* @brief PWMD4 interrupt priority level setting.
*/
#if !defined(LPC11xx_PWM_CT32B1_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define LPC11xx_PWM_CT32B1_IRQ_PRIORITY 3
#endif
/*===========================================================================*/
/* Configuration checks. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief PWM mode type.
*/
typedef uint32_t pwmmode_t;
/**
* @brief PWM channel type.
*/
typedef uint8_t pwmchannel_t;
/**
* @brief PWM counter type.
*/
typedef uint16_t pwmcnt_t;
/**
* @brief PWM driver channel configuration structure.
*/
typedef struct {
/**
* @brief Channel active logic level.
*/
pwmmode_t mode;
/**
* @brief Channel callback pointer.
* @note This callback is invoked on the channel compare event. If set to
* @p NULL then the callback is disabled.
*/
pwmcallback_t callback;
/* End of the mandatory fields.*/
} PWMChannelConfig;
/**
* @brief PWM driver configuration structure.
*/
typedef struct {
/**
* @brief Timer clock in Hz.
* @note The low level can use assertions in order to catch invalid
* frequency specifications.
*/
uint32_t frequency;
/**
* @brief PWM period in ticks.
* @note The low level can use assertions in order to catch invalid
* period specifications.
*/
pwmcnt_t period;
/**
* @brief Periodic callback pointer.
* @note This callback is invoked on PWM counter reset. If set to
* @p NULL then the callback is disabled.
*/
pwmcallback_t callback;
/**
* @brief Channels configurations.
*/
PWMChannelConfig channels[PWM_CHANNELS];
/* End of the mandatory fields.*/
} PWMConfig;
/**
* @brief Structure representing a PWM driver.
*/
struct PWMDriver {
/**
* @brief Driver state.
*/
pwmstate_t state;
/**
* @brief Current driver configuration data.
*/
const PWMConfig *config;
/**
* @brief Current PWM period in ticks.
*/
pwmcnt_t period;
#if defined(PWM_DRIVER_EXT_FIELDS)
PWM_DRIVER_EXT_FIELDS
#endif
/* End of the mandatory fields.*/
/**
* @brief Timer base clock.
*/
uint32_t clock;
/**
* @brief Pointer to the TIMx registers block.
*/
LPC_TMR_TypeDef *tim;
};
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/**
* @brief Changes the period the PWM peripheral.
* @details This function changes the period of a PWM unit that has already
* been activated using @p pwmStart().
* @pre The PWM unit must have been activated using @p pwmStart().
* @post The PWM unit period is changed to the new value.
* @note The function has effect at the next cycle start.
* @note If a period is specified that is shorter than the pulse width
* programmed in one of the channels then the behavior is not
* guaranteed.
*
* @param[in] pwmp pointer to a @p PWMDriver object
* @param[in] period new cycle time in ticks
*
* @notapi
*/
#define pwm_lld_change_period(pwmp, period) \
((pwmp)->tim->MR3 = (period))
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#if LPC11xx_PWM_USE_CT16B0 && !defined(__DOXYGEN__)
extern PWMDriver PWMD1;
#endif
#if LPC11xx_PWM_USE_CT16B1 && !defined(__DOXYGEN__)
extern PWMDriver PWMD2;
#endif
#if LPC11xx_PWM_USE_CT32B0 && !defined(__DOXYGEN__)
extern PWMDriver PWMD3;
#endif
#if LPC11xx_PWM_USE_CT32B1 && !defined(__DOXYGEN__)
extern PWMDriver PWMD4;
#endif
#ifdef __cplusplus
extern "C" {
#endif
void pwm_lld_init(void);
void pwm_lld_start(PWMDriver *pwmp);
void pwm_lld_stop(PWMDriver *pwmp);
void pwm_lld_enable_channel(PWMDriver *pwmp,
pwmchannel_t channel,
pwmcnt_t width);
void pwm_lld_disable_channel(PWMDriver *pwmp, pwmchannel_t channel);
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_PWM */
#endif /* _PWM_LLD_H_ */
/** @} */
|
