summaryrefslogtreecommitdiff
path: root/include/arch/rm46l8lp/halcogen/het.h
blob: 68b1e0c2b0295da8252a1ab083e9efc73b1d477a (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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
/** @file het.h
*   @brief HET Driver Definition File
*   @date 11-Dec-2018
*   @version 04.07.01
*   
*/

/* 
* Copyright (C) 2009-2018 Texas Instruments Incorporated - www.ti.com  
* 
* 
*  Redistribution and use in source and binary forms, with or without 
*  modification, are permitted provided that the following conditions 
*  are met:
*
*    Redistributions of source code must retain the above copyright 
*    notice, this list of conditions and the following disclaimer.
*
*    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.
*
*    Neither the name of Texas Instruments Incorporated 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 __HET_H__
#define __HET_H__

#include "reg_het.h"
#include <string.h>

#ifdef __cplusplus
extern "C" {
#endif

/* USER CODE BEGIN (0) */
/* USER CODE END */

/** @def pwm0
*   @brief Pwm signal 0
*
*   Alias for pwm signal 0
*/
#define pwm0 0U

/** @def pwm1
*   @brief Pwm signal 1
*
*   Alias for pwm signal 1
*/
#define pwm1 1U

/** @def pwm2
*   @brief Pwm signal 2
*
*   Alias for pwm signal 2
*/
#define pwm2 2U

/** @def pwm3
*   @brief Pwm signal 3
*
*   Alias for pwm signal 3
*/
#define pwm3 3U

/** @def pwm4
*   @brief Pwm signal 4
*
*   Alias for pwm signal 4
*/
#define pwm4 4U

/** @def pwm5
*   @brief Pwm signal 5
*
*   Alias for pwm signal 5
*/
#define pwm5 5U

/** @def pwm6
*   @brief Pwm signal 6
*
*   Alias for pwm signal 6
*/
#define pwm6 6U

/** @def pwm7
*   @brief Pwm signal 7
*
*   Alias for pwm signal 7
*/
#define pwm7 7U


/** @def edge0
*   @brief Edge signal 0
*
*   Alias for edge signal 0
*/
#define edge0 0U

/** @def edge1
*   @brief Edge signal 1
*
*   Alias for edge signal 1
*/
#define edge1 1U

/** @def edge2
*   @brief Edge signal 2
*
*   Alias for edge signal 2
*/
#define edge2 2U

/** @def edge3
*   @brief Edge signal 3
*
*   Alias for edge signal 3
*/
#define edge3 3U

/** @def edge4
*   @brief Edge signal 4
*
*   Alias for edge signal 4
*/
#define edge4 4U

/** @def edge5
*   @brief Edge signal 5
*
*   Alias for edge signal 5
*/
#define edge5 5U

/** @def edge6
*   @brief Edge signal 6
*
*   Alias for edge signal 6
*/
#define edge6 6U

/** @def edge7
*   @brief Edge signal 7
*
*   Alias for edge signal 7
*/
#define edge7 7U


/** @def cap0
*   @brief Capture signal 0
*
*   Alias for capture signal 0
*/
#define cap0 0U

/** @def cap1
*   @brief Capture signal 1
*
*   Alias for capture signal 1
*/
#define cap1 1U

/** @def cap2
*   @brief Capture signal 2
*
*   Alias for capture signal 2
*/
#define cap2 2U

/** @def cap3
*   @brief Capture signal 3
*
*   Alias for capture signal 3
*/
#define cap3 3U

/** @def cap4
*   @brief Capture signal 4
*
*   Alias for capture signal 4
*/
#define cap4 4U

/** @def cap5
*   @brief Capture signal 5
*
*   Alias for capture signal 5
*/
#define cap5 5U

/** @def cap6
*   @brief Capture signal 6
*
*   Alias for capture signal 6
*/
#define cap6 6U

/** @def cap7
*   @brief Capture signal 7
*
*   Alias for capture signal 7
*/
#define cap7 7U

/** @def pwmEND_OF_DUTY
*   @brief Pwm end of duty
*
*   Alias for pwm end of duty notification
*/
#define pwmEND_OF_DUTY 2U

/** @def pwmEND_OF_PERIOD
*   @brief Pwm end of period
*
*   Alias for pwm end of period notification
*/
#define pwmEND_OF_PERIOD 4U

/** @def pwmEND_OF_BOTH
*   @brief Pwm end of duty and period
*
*   Alias for pwm end of duty and period notification
*/
#define pwmEND_OF_BOTH 6U

/* USER CODE BEGIN (1) */
/* USER CODE END */

/** @struct hetBase
*   @brief HET Register Definition
*
*   This structure is used to access the HET module registers.
*/
/** @typedef hetBASE_t
*   @brief HET Register Frame Type Definition
*
*   This type is used to access the HET Registers.
*/

enum hetPinSelect
{
    PIN_HET_0 = 0U,
    PIN_HET_1 = 1U,
    PIN_HET_2 = 2U,
    PIN_HET_3 = 3U,
    PIN_HET_4 = 4U,
    PIN_HET_5 = 5U,
    PIN_HET_6 = 6U,
    PIN_HET_7 = 7U,
    PIN_HET_8 = 8U,
    PIN_HET_9 = 9U,
    PIN_HET_10 = 10U,
    PIN_HET_11 = 11U,
    PIN_HET_12 = 12U,
    PIN_HET_13 = 13U,
    PIN_HET_14 = 14U,
    PIN_HET_15 = 15U,
    PIN_HET_16 = 16U,
    PIN_HET_17 = 17U,
    PIN_HET_18 = 18U,
    PIN_HET_19 = 19U,
    PIN_HET_20 = 20U,
    PIN_HET_21 = 21U,
    PIN_HET_22 = 22U,
    PIN_HET_23 = 23U,
    PIN_HET_24 = 24U,
    PIN_HET_25 = 25U,
    PIN_HET_26 = 26U,
    PIN_HET_27 = 27U,
    PIN_HET_28 = 28U,
    PIN_HET_29 = 29U,
    PIN_HET_30 = 30U,
    PIN_HET_31 = 31U
};


/** @struct hetSignal
*   @brief HET Signal Definition
*
*   This structure is used to define a pwm signal.
*/
/** @typedef hetSIGNAL_t
*   @brief HET Signal Type Definition
*
*   This type is used to access HET Signal Information.
*/
typedef struct hetSignal
{
	uint32 duty;   /**< Duty cycle in % of the period  */
	float64   period; /**< Period in us                   */
} hetSIGNAL_t;


/* Configuration registers */
typedef struct het_config_reg
{
    uint32 CONFIG_GCR;
    uint32 CONFIG_PFR;
    uint32 CONFIG_INTENAS;
    uint32 CONFIG_INTENAC;
    uint32 CONFIG_PRY;
    uint32 CONFIG_AND;
    uint32 CONFIG_HRSH;
    uint32 CONFIG_XOR;
    uint32 CONFIG_DIR;
    uint32 CONFIG_PDR;	
	uint32 CONFIG_PULDIS;
	uint32 CONFIG_PSL;	
	uint32 CONFIG_PCR;	
} het_config_reg_t;

/* Configuration registers initial value for HET1*/
#define HET1_DIR_CONFIGVALUE     ((uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U)

#define HET1_PDR_CONFIGVALUE     ((uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00008000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U)
								
#define HET1_PULDIS_CONFIGVALUE  ((uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U)								
								
#define HET1_PSL_CONFIGVALUE     ((uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
                                | (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00008000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U)								
								
#define HET1_HRSH_CONFIGVALUE    ((uint32)0x00008000U \
								| (uint32)0x00004000U \
								| (uint32)0x00002000U \
								| (uint32)0x00001000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000008U \
								| (uint32)0x00000004U \
								| (uint32)0x00000002U \
								| (uint32)0x00000001U)

#define HET1_AND_CONFIGVALUE     ((uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U)								
								
#define HET1_XOR_CONFIGVALUE     ((uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U)								
								
#define HET1_PFR_CONFIGVALUE    (((uint32)6U << 8U) | (uint32)0U)


#define HET1_PRY_CONFIGVALUE     ((uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U)
								
#define HET1_INTENAC_CONFIGVALUE ((uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U)
								
#define HET1_INTENAS_CONFIGVALUE ((uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U \
								| (uint32)0x00000000U)

#define HET1_PCR_CONFIGVALUE     ((uint32)0x00000005U)
#define HET1_GCR_CONFIGVALUE      0x00030001U




/** 
 *  @defgroup HET HET
 *  @brief HighEnd Timer Module.
 *  
 *  The HET is a software-controlled timer with a dedicated specialized timer micromachine and a set of 30 instructions.
 *  The HET micromachine is connected to a port of up to 32 input/output (I/O) pins.
 *
 *	Related Files
 *   - reg_het.h
 *   - het.h
 *   - het.c
 *   - reg_htu.h
 *   - htu.h
 *   - std_nhet.h
 *  @addtogroup HET
 *  @{
 */
 
/* HET Interface Functions */
void hetInit(void);

/* PWM Interface Functions */
void   pwmStart(hetRAMBASE_t * hetRAM,uint32 pwm);
void   pwmStop(hetRAMBASE_t * hetRAM,uint32 pwm);
void   pwmSetDuty(hetRAMBASE_t * hetRAM,uint32 pwm, uint32 pwmDuty);
void   pwmSetSignal(hetRAMBASE_t * hetRAM,uint32 pwm, hetSIGNAL_t signal);
void   pwmGetSignal(hetRAMBASE_t * hetRAM,uint32 pwm, hetSIGNAL_t *signal);
void   pwmEnableNotification(hetBASE_t * hetREG,uint32 pwm, uint32 notification);
void   pwmDisableNotification(hetBASE_t * hetREG,uint32 pwm, uint32 notification);
void   pwmNotification(hetBASE_t * hetREG,uint32 pwm, uint32 notification);

/* Edge Interface Functions */
void   edgeResetCounter(hetRAMBASE_t * hetRAM,uint32 edge);
uint32 edgeGetCounter(hetRAMBASE_t * hetRAM,uint32 edge);
void   edgeEnableNotification(hetBASE_t * hetREG,uint32 edge);
void   edgeDisableNotification(hetBASE_t * hetREG,uint32 edge);
void   edgeNotification(hetBASE_t * hetREG,uint32 edge);

/* Captured Signal Interface Functions */
void capGetSignal(hetRAMBASE_t * hetRAM, uint32 cap, hetSIGNAL_t *signal);

/* Timestamp Interface Functions */
void   hetResetTimestamp(hetRAMBASE_t * hetRAM);
uint32 hetGetTimestamp(hetRAMBASE_t * hetRAM);
void het1GetConfigValue(het_config_reg_t *config_reg, config_value_type_t type);

/** @fn void hetNotification(hetBASE_t *het, uint32 offset)
*   @brief het interrupt callback
*   @param[in] het - Het module base address
*              - hetREG1: HET1 module base address pointer
*              - hetREG2: HET2 module base address pointer
*   @param[in] offset - het interrupt offset / Source number
*
*   @note This function has to be provide by the user.
*
* This is a interrupt callback that is provided by the application and is call upon
* an het interrupt.  The parameter passed to the callback is a copy of the interrupt 
* offset register which is used to decode the interrupt source.
*/
void hetNotification(hetBASE_t *het, uint32 offset);

/* USER CODE BEGIN (2) */
/* USER CODE END */

/**@}*/
#ifdef __cplusplus
}
#endif /*extern "C" */

#endif