xWRL6432 MMWAVE-L-SDK  05.01.00.04
TimerP.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018-2021 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 
61 typedef struct TimerP_Params_ {
62 
63  uint32_t inputPreScaler;
68  uint32_t inputClkHz;
73  uint32_t periodInUsec;
78  uint32_t oneshotMode;
79  uint32_t enableOverflowInt;
82 
89 
96 void TimerP_setup(uint32_t baseAddr, TimerP_Params *params);
97 
103 void TimerP_start(uint32_t baseAddr);
104 
110 void TimerP_stop(uint32_t baseAddr);
111 
119 uint32_t TimerP_getCount(uint32_t baseAddr);
120 
128 uint32_t TimerP_getReloadCount(uint32_t baseAddr);
129 
135 void TimerP_clearOverflowInt(uint32_t baseAddr);
136 
137 
145 uint32_t TimerP_isOverflowed(uint32_t baseAddr);
146 
149 #ifdef __cplusplus
150 }
151 #endif
152 
153 #endif /* TIMERP_H */
154 
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:79
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:61
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:78
TimerP_Params::inputClkHz
uint32_t inputClkHz
Definition: TimerP.h:68
TimerP_Params::inputPreScaler
uint32_t inputPreScaler
Definition: TimerP.h:63
TimerP_Params::periodInUsec
uint32_t periodInUsec
Definition: TimerP.h:73