AM263Px MCU+ SDK: TimerP.h Source File

| AM263Px MCU+ SDK 26.00.00 |

TimerP.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 2018-2023 Texas Instruments Incorporated
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the
14 * distribution.
15 *
16 * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifndef TIMERP_H
34 #define TIMERP_H
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #include <stdint.h>
41 #include <kernel/dpl/SystemP.h>
42
64 typedef struct TimerP_Params_ {
65
66 uint32_t inputPreScaler;
73 uint32_t inputClkHz;
78 uint32_t periodInUsec;
84 uint32_t periodInNsec;
90 uint32_t oneshotMode;
94 uint32_t enableOverflowInt;
95 uint32_t enableDmaTrigger;
97 } TimerP_Params;
98
103 #define TIME_IN_MICRO_SECONDS (1000000U)
104
108 #define MAX_TIMER_COUNT_VALUE (0xFFFFFFFFU)
109
112 #define TIME_IN_MILLI_SECONDS (1000U)
113
116 #define TIME_IN_NANO_SECONDS (1000000000U)
117
120 #define TIMERP_SHIFT_BY_EIGHT (8U)
121
124 #define MAX_NUMBER_OF_CYCLES (0xFFFFFFFFU)
125
128 #define MAX_NUMBER_OF_COUNT (0xFFFFFFFFU)
129
134 void TimerP_Params_init(TimerP_Params *params);
135
142 void TimerP_setup(uint32_t baseAddr, TimerP_Params *params);
143
149 void TimerP_start(uint32_t baseAddr);
150
156 void TimerP_stop(uint32_t baseAddr);
157
165 uint32_t TimerP_getCount(uint32_t baseAddr);
166
174 uint32_t TimerP_getReloadCount(uint32_t baseAddr);
175
181 void TimerP_clearOverflowInt(uint32_t baseAddr);
182
183
191 uint32_t TimerP_isOverflowed(uint32_t baseAddr);
192
195 #ifdef __cplusplus
196 }
197 #endif
198
199 #endif /* TIMERP_H */
200
TimerP_setup
void TimerP_setup(uint32_t baseAddr, TimerP_Params *params)
Setup timer but does not start it.
SystemP.h
TimerP_Params::enableOverflowInt
uint32_t enableOverflowInt
Definition: TimerP.h:94
TimerP_Params::enableDmaTrigger
uint32_t enableDmaTrigger
Definition: TimerP.h:95
TimerP_clearOverflowInt
void TimerP_clearOverflowInt(uint32_t baseAddr)
Clear timer overflow interrupt.
TimerP_stop
void TimerP_stop(uint32_t baseAddr)
Stop timer.
TimerP_start
void TimerP_start(uint32_t baseAddr)
Start timer.
TimerP_Params
Parameters for TimerP_setup.
Definition: TimerP.h:64
TimerP_isOverflowed
uint32_t TimerP_isOverflowed(uint32_t baseAddr)
Check if timer is overflowed.
TimerP_getCount
uint32_t TimerP_getCount(uint32_t baseAddr)
Get timer current count.
TimerP_Params_init
void TimerP_Params_init(TimerP_Params *params)
Set default value for TimerP_Params.
TimerP_getReloadCount
uint32_t TimerP_getReloadCount(uint32_t baseAddr)
Get timer reload count.
TimerP_Params::oneshotMode
uint32_t oneshotMode
Definition: TimerP.h:90
TimerP_Params::inputClkHz
uint32_t inputClkHz
Definition: TimerP.h:73
TimerP_Params::periodInNsec
uint32_t periodInNsec
Definition: TimerP.h:84
TimerP_Params::inputPreScaler
uint32_t inputPreScaler
Definition: TimerP.h:66
TimerP_Params::periodInUsec
uint32_t periodInUsec
Definition: TimerP.h:78