blob: 6b4196fc1983732c20c6d056838b2f3a4f6d18a9 (
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
|
/*
Copyright (C) 2014..2017 Marco Veeneman
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 GPTM/hal_gpt_lld.h
* @brief TM4C123x/TM4C129x GPT subsystem low level driver header.
*
* @addtogroup GPT
* @{
*/
#ifndef HAL_GPT_LLD_H
#define HAL_GPT_LLD_H
#if HAL_USE_GPT || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @name Configuration options
* @{
*/
/**
* @brief GPTD1 driver enable switch.
* @details If set to @p TRUE the support for GPTD1 is included.
* @note The default is @p FALSE.
*/
#if !defined(TIVA_GPT_USE_GPT0) || defined(__DOXYGEN__)
#define TIVA_GPT_USE_GPT0 FALSE
#endif
/**
* @brief GPTD2 driver enable switch.
* @details If set to @p TRUE the support for GPTD2 is included.
* @note The default is @p FALSE.
*/
#if !defined(TIVA_GPT_USE_GPT1) || defined(__DOXYGEN__)
#define TIVA_GPT_USE_GPT1 FALSE
#endif
/**
* @brief GPTD3 driver enable switch.
* @details If set to @p TRUE the support for GPTD3 is included.
* @note The default is @p FALSE.
*/
#if !defined(TIVA_GPT_USE_GPT2) || defined(__DOXYGEN__)
#define TIVA_GPT_USE_GPT2 FALSE
#endif
/**
* @brief GPTD4 driver enable switch.
* @details If set to @p TRUE the support for GPTD4 is included.
* @note The default is @p FALSE.
*/
#if !defined(TIVA_GPT_USE_GPT3) || defined(__DOXYGEN__)
#define TIVA_GPT_USE_GPT3 FALSE
#endif
/**
* @brief GPTD5 driver enable switch.
* @details If set to @p TRUE the support for GPTD5 is included.
* @note The default is @p FALSE.
*/
#if !defined(TIVA_GPT_USE_GPT4) || defined(__DOXYGEN__)
#define TIVA_GPT_USE_GPT4 FALSE
#endif
/**
* @brief GPTD6 driver enable switch.
* @details If set to @p TRUE the support for GPTD6 is included.
* @note The default is @p FALSE.
*/
#if !defined(TIVA_GPT_USE_GPT5) || defined(__DOXYGEN__)
#define TIVA_GPT_USE_GPT5 FALSE
#endif
/**
* @brief GPTD7 driver enable switch.
* @details If set to @p TRUE the support for GPTD1 is included.
* @note The default is @p FALSE.
*/
#if !defined(TIVA_GPT_USE_WGPT0) || defined(__DOXYGEN__)
#define TIVA_GPT_USE_WGPT0 FALSE
#endif
/**
* @brief GPTD8 driver enable switch.
* @details If set to @p TRUE the support for GPTD2 is included.
* @note The default is @p FALSE.
*/
#if !defined(TIVA_GPT_USE_WGPT1) || defined(__DOXYGEN__)
#define TIVA_GPT_USE_WGPT1 FALSE
#endif
/**
* @brief GPTD9 driver enable switch.
* @details If set to @p TRUE the support for GPTD3 is included.
* @note The default is @p FALSE.
*/
#if !defined(TIVA_GPT_USE_WGPT2) || defined(__DOXYGEN__)
#define TIVA_GPT_USE_WGPT2 FALSE
#endif
/**
* @brief GPTD10 driver enable switch.
* @details If set to @p TRUE the support for GPTD4 is included.
* @note The default is @p FALSE.
*/
#if !defined(TIVA_GPT_USE_WGPT3) || defined(__DOXYGEN__)
#define TIVA_GPT_USE_WGPT3 FALSE
#endif
/**
* @brief GPTD11 driver enable switch.
* @details If set to @p TRUE the support for GPTD5 is included.
* @note The default is @p FALSE.
*/
#if !defined(TIVA_GPT_USE_WGPT4) || defined(__DOXYGEN__)
#define TIVA_GPT_USE_WGPT4 FALSE
#endif
/**
* @brief GPTD12 driver enable switch.
* @details If set to @p TRUE the support for GPTD6 is included.
* @note The default is @p FALSE.
*/
#if !defined(TIVA_GPT_USE_WGPT5) || defined(__DOXYGEN__)
#define TIVA_GPT_USE_WGPT5 FALSE
#endif
/**
* @brief GPTD1 interrupt priority level setting.
*/
#if !defined(TIVA_GPT_GPT0A_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define TIVA_GPT_GPT0A_IRQ_PRIORITY 7
#endif
/**
* @brief GPTD2 interrupt priority level setting.
*/
#if !defined(TIVA_GPT_GPT1A_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define TIVA_GPT_GPT1A_IRQ_PRIORITY 7
#endif
/**
* @brief GPTD3 interrupt priority level setting.
*/
#if !defined(TIVA_GPT_GPT2A_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define TIVA_GPT_GPT2A_IRQ_PRIORITY 7
#endif
/**
* @brief GPTD4 interrupt priority level setting.
*/
#if !defined(TIVA_GPT_GPT3A_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define TIVA_GPT_GPT3A_IRQ_PRIORITY 7
#endif
/**
* @brief GPTD5 interrupt priority level setting.
*/
#if !defined(TIVA_GPT_GPT4A_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define TIVA_GPT_GPT4A_IRQ_PRIORITY 7
#endif
/**
* @brief GPTD6 interrupt priority level setting.
*/
#if !defined(TIVA_GPT_GPT5A_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define TIVA_GPT_GPT5A_IRQ_PRIORITY 7
#endif
/**
* @brief GPTD7 interrupt priority level setting.
*/
#if !defined(TIVA_GPT_WGPT0A_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define TIVA_GPT_WGPT0A_IRQ_PRIORITY 7
#endif
/**
* @brief GPTD8 interrupt priority level setting.
*/
#if !defined(TIVA_GPT_WGPT1A_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define TIVA_GPT_WGPT1A_IRQ_PRIORITY 7
#endif
/**
* @brief GPTD9 interrupt priority level setting.
*/
#if !defined(TIVA_GPT_WGPT2A_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define TIVA_GPT_WGPT2A_IRQ_PRIORITY 7
#endif
/**
* @brief GPTD10 interrupt priority level setting.
*/
#if !defined(TIVA_GPT_WGPT3A_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define TIVA_GPT_WGPT3A_IRQ_PRIORITY 7
#endif
/**
* @brief GPTD11 interrupt priority level setting.
*/
#if !defined(TIVA_GPT_WGPT4A_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define TIVA_GPT_WGPT4A_IRQ_PRIORITY 7
#endif
/**
* @brief GPTD12 interrupt priority level setting.
*/
#if !defined(TIVA_GPT_WGPT5A_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define TIVA_GPT_WGPT5A_IRQ_PRIORITY 7
#endif
/** @} */
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if TIVA_GPT_USE_GPT0 && !TIVA_HAS_GPT0
#error "GPT0 not present in the selected device"
#endif
#if TIVA_GPT_USE_GPT1 && !TIVA_HAS_GPT1
#error "GPT1 not present in the selected device"
#endif
#if TIVA_GPT_USE_GPT2 && !TIVA_HAS_GPT2
#error "GPT2 not present in the selected device"
#endif
#if TIVA_GPT_USE_GPT3 && !TIVA_HAS_GPT3
#error "GPT3 not present in the selected device"
#endif
#if TIVA_GPT_USE_GPT4 && !TIVA_HAS_GPT4
#error "GPT4 not present in the selected device"
#endif
#if TIVA_GPT_USE_GPT5 && !TIVA_HAS_GPT5
#error "GPT5 not present in the selected device"
#endif
#if TIVA_GPT_USE_WGPT0 && !TIVA_HAS_WGPT0
#error "WGPT0 not present in the selected device"
#endif
#if TIVA_GPT_USE_WGPT1 && !TIVA_HAS_WGPT1
#error "WGPT1 not present in the selected device"
#endif
#if TIVA_GPT_USE_WGPT2 && !TIVA_HAS_WGPT2
#error "WGPT2 not present in the selected device"
#endif
#if TIVA_GPT_USE_WGPT3 && !TIVA_HAS_WGPT3
#error "WGPT3 not present in the selected device"
#endif
#if TIVA_GPT_USE_WGPT4 && !TIVA_HAS_WGPT4
#error "WGPT4 not present in the selected device"
#endif
#if TIVA_GPT_USE_WGPT5 && !TIVA_HAS_WGPT5
#error "WGPT5 not present in the selected device"
#endif
#if !TIVA_GPT_USE_GPT0 && !TIVA_GPT_USE_GPT1 && !TIVA_GPT_USE_GPT2 && \
!TIVA_GPT_USE_GPT3 && !TIVA_GPT_USE_GPT4 && !TIVA_GPT_USE_GPT5 && \
!TIVA_GPT_USE_WGPT0 && !TIVA_GPT_USE_WGPT1 && !TIVA_GPT_USE_WGPT2 && \
!TIVA_GPT_USE_WGPT3 && !TIVA_GPT_USE_WGPT4 && !TIVA_GPT_USE_WGPT5
#error "GPT driver activated but no (W)GPT peripheral assigned"
#endif
#if TIVA_GPT_USE_GPT0 && \
!OSAL_IRQ_IS_VALID_PRIORITY(TIVA_GPT_GPT0A_IRQ_PRIORITY)
#error "Invalid IRQ priority assigned to GPT0"
#endif
#if TIVA_GPT_USE_GPT1 && \
!OSAL_IRQ_IS_VALID_PRIORITY(TIVA_GPT_GPT1A_IRQ_PRIORITY)
#error "Invalid IRQ priority assigned to GPT1"
#endif
#if TIVA_GPT_USE_GPT2 && \
!OSAL_IRQ_IS_VALID_PRIORITY(TIVA_GPT_GPT2A_IRQ_PRIORITY)
#error "Invalid IRQ priority assigned to GPT2"
#endif
#if TIVA_GPT_USE_GPT3 && \
!OSAL_IRQ_IS_VALID_PRIORITY(TIVA_GPT_GPT3A_IRQ_PRIORITY)
#error "Invalid IRQ priority assigned to GPT3"
#endif
#if TIVA_GPT_USE_GPT4 && \
!OSAL_IRQ_IS_VALID_PRIORITY(TIVA_GPT_GPT4A_IRQ_PRIORITY)
#error "Invalid IRQ priority assigned to GPT4"
#endif
#if TIVA_GPT_USE_GPT5 && \
!OSAL_IRQ_IS_VALID_PRIORITY(TIVA_GPT_GPT5A_IRQ_PRIORITY)
#error "Invalid IRQ priority assigned to GPT5"
#endif
#if TIVA_GPT_USE_WGPT0 && \
!OSAL_IRQ_IS_VALID_PRIORITY(TIVA_GPT_WGPT0A_IRQ_PRIORITY)
#error "Invalid IRQ priority assigned to WGPT0"
#endif
#if TIVA_GPT_USE_WGPT1 && \
!OSAL_IRQ_IS_VALID_PRIORITY(TIVA_GPT_WGPT1A_IRQ_PRIORITY)
#error "Invalid IRQ priority assigned to WGPT1"
#endif
#if TIVA_GPT_USE_WGPT2 && \
!OSAL_IRQ_IS_VALID_PRIORITY(TIVA_GPT_WGPT2A_IRQ_PRIORITY)
#error "Invalid IRQ priority assigned to WGPT2"
#endif
#if TIVA_GPT_USE_WGPT3 && \
!OSAL_IRQ_IS_VALID_PRIORITY(TIVA_GPT_WGPT3A_IRQ_PRIORITY)
#error "Invalid IRQ priority assigned to WGPT3"
#endif
#if TIVA_GPT_USE_WGPT4 && \
!OSAL_IRQ_IS_VALID_PRIORITY(TIVA_GPT_WGPT4A_IRQ_PRIORITY)
#error "Invalid IRQ priority assigned to WGPT4"
#endif
#if TIVA_GPT_USE_WGPT5 && \
!OSAL_IRQ_IS_VALID_PRIORITY(TIVA_GPT_WGPT5A_IRQ_PRIORITY)
#error "Invalid IRQ priority assigned to WGPT5"
#endif
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief GPT frequency type.
*/
typedef uint32_t gptfreq_t;
/**
* @brief GPT counter type.
*/
typedef uint16_t gptcnt_t;
/**
* @brief Driver configuration structure.
* @note It could be empty on some architectures.
*/
typedef struct {
/**
* @brief Timer clock in Hz.
* @note The low level can use assertions in order to catch invalid
* frequency specifications.
*/
gptfreq_t frequency;
/**
* @brief Timer callback pointer.
* @note This callback is invoked on GPT counter events.
*/
gptcallback_t callback;
/* End of the mandatory fields.*/
} GPTConfig;
/**
* @brief Structure representing a GPT driver.
*/
struct GPTDriver {
/**
* @brief Driver state.
*/
gptstate_t state;
/**
* @brief Current configuration data.
*/
const GPTConfig *config;
#if defined(GPT_DRIVER_EXT_FIELDS)
GPT_DRIVER_EXT_FIELDS
#endif
/* End of the mandatory fields.*/
/**
* @brief Pointer to the GPT registers block.
*/
uint32_t gpt;
};
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/**
* @brief Changes the interval of GPT peripheral.
* @details This function changes the interval of a running GPT unit.
* @pre The GPT unit must have been activated using @p gptStart().
* @pre The GPT unit must have been running in continuous mode using
* @p gptStartContinuous().
* @post The GPT unit interval is changed to the new value.
* @note The function has effect at the next cycle start.
*
* @param[in] gptp pointer to a @p GPTDriver object
* @param[in] interval new cycle time in timer ticks
* @notapi
*/
#define gpt_lld_change_interval(gptp, interval) { \
HWREG(gptp->gpt + TIMER_O_TAILR) = interval - 1; \
}
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#if TIVA_GPT_USE_GPT0 && !defined(__DOXYGEN__)
extern GPTDriver GPTD1;
#endif
#if TIVA_GPT_USE_GPT1 && !defined(__DOXYGEN__)
extern GPTDriver GPTD2;
#endif
#if TIVA_GPT_USE_GPT2 && !defined(__DOXYGEN__)
extern GPTDriver GPTD3;
#endif
#if TIVA_GPT_USE_GPT3 && !defined(__DOXYGEN__)
extern GPTDriver GPTD4;
#endif
#if TIVA_GPT_USE_GPT4 && !defined(__DOXYGEN__)
extern GPTDriver GPTD5;
#endif
#if TIVA_GPT_USE_GPT5 && !defined(__DOXYGEN__)
extern GPTDriver GPTD6;
#endif
#if TIVA_GPT_USE_WGPT0 && !defined(__DOXYGEN__)
extern GPTDriver GPTD7;
#endif
#if TIVA_GPT_USE_WGPT1 && !defined(__DOXYGEN__)
extern GPTDriver GPTD8;
#endif
#if TIVA_GPT_USE_WGPT2 && !defined(__DOXYGEN__)
extern GPTDriver GPTD9;
#endif
#if TIVA_GPT_USE_WGPT3 && !defined(__DOXYGEN__)
extern GPTDriver GPTD10;
#endif
#if TIVA_GPT_USE_WGPT4 && !defined(__DOXYGEN__)
extern GPTDriver GPTD11;
#endif
#if TIVA_GPT_USE_WGPT5 && !defined(__DOXYGEN__)
extern GPTDriver GPTD12;
#endif
#ifdef __cplusplus
extern "C" {
#endif
void gpt_lld_init(void);
void gpt_lld_start(GPTDriver *gptp);
void gpt_lld_stop(GPTDriver *gptp);
void gpt_lld_start_timer(GPTDriver *gptp, gptcnt_t period);
void gpt_lld_stop_timer(GPTDriver *gptp);
void gpt_lld_polled_delay(GPTDriver *gptp, gptcnt_t interval);
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_GPT */
#endif /* HAL_GPT_LLD_H */
/** @} */
|
