Cascoda SDK
Cascoda SDK for building software to run with CA-821x transceivers
cascoda_time.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019, Cascoda Ltd.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  * 1. Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * 3. Neither the name of the copyright holder nor the
13  * names of its contributors may be used to endorse or promote products
14  * derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
41 #ifndef INCLUDE_CASCODA_BM_CASCODA_TIME_H_
42 #define INCLUDE_CASCODA_BM_CASCODA_TIME_H_
43 
44 #include <stdint.h>
45 
51 uint32_t TIME_ReadAbsoluteTime(void);
52 
64 int TIME_Cmp(uint32_t aT1, uint32_t aT2);
65 
66 /*---------------------------------------------------------------------------*/
67 /* MicroSeconds Timer functions: */
68 /* Timer has to be specifically enabled (by calling BSP_MicroTimerStart()). */
69 /* 32-bit extension gives a run time of 71.582 minutes until wrap-around. */
70 /* Timer does not operate in power-down modes as no time base available. */
71 /*---------------------------------------------------------------------------*/
72 
77 void TIME_MicroTimerStart(void);
78 
83 uint32_t TIME_MicroTimerStop(void);
84 
89 uint32_t TIME_MicroTimerGet(void);
90 
91 #endif /* INCLUDE_CASCODA_BM_CASCODA_TIME_H_ */
92 
int TIME_Cmp(uint32_t aT1, uint32_t aT2)
Compare the time arguments, including the loop-around nature of the time value.
Definition: cascoda_time.c:34
uint32_t TIME_MicroTimerGet(void)
get microseconds timer while running
Definition: cascoda_time.c:51
uint32_t TIME_MicroTimerStop(void)
stop microseconds timer
Definition: cascoda_time.c:46
uint32_t TIME_ReadAbsoluteTime(void)
Get the number of milliseconds since program start.
Definition: cascoda_time.c:36
void TIME_MicroTimerStart(void)
start microseconds timer
Definition: cascoda_time.c:41