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
|
/**
* @file os_timer.h
* @author ALLWINNERTECH IOT WLAN Team
*/
/*
* Copyright (C) 2017 ALLWINNERTECH TECHNOLOGY CO., LTD. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
* 3. Neither the name of ALLWINNERTECH TECHNOLOGY CO., LTD. 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 _KERNEL_OS_FREERTOS_OS_TIMER_H_
#define _KERNEL_OS_FREERTOS_OS_TIMER_H_
#include "_os_common.h"
#include "timers.h"
#ifdef __cplusplus
extern "C" {
#endif
#if (defined(configUSE_TIMER_ID_AS_CALLBACK_ARG) && configUSE_TIMER_ID_AS_CALLBACK_ARG == 1)
#define OS_TIMER_USE_FREERTOS_ORIG_CALLBACK 0
#else
#define OS_TIMER_USE_FREERTOS_ORIG_CALLBACK 1
#endif
/**
* @brief Timer type definition
* - one shot timer: Timer will be in the dormant state after it expires.
* - periodic timer: Timer will auto-reload after it expires.
*/
typedef enum {
OS_TIMER_ONCE = 0, /* one shot timer */
OS_TIMER_PERIODIC = 1 /* periodic timer */
} OS_TimerType;
/** @brief Timer expire callback function definition */
typedef void (*OS_TimerCallback_t)(void *arg);
/** @brief Timer handle definition */
typedef TimerHandle_t OS_TimerHandle_t;
#if OS_TIMER_USE_FREERTOS_ORIG_CALLBACK
/**
* @brief Timer expire callback data definition
*/
typedef struct OS_TimerCallbackData {
OS_TimerCallback_t callback; /* Timer expire callback function */
void *argument; /* Argument of timer expire callback function */
} OS_TimerCallbackData_t;
#endif
/**
* @brief Timer object definition
*/
typedef struct OS_Timer {
TimerHandle_t handle;
#if OS_TIMER_USE_FREERTOS_ORIG_CALLBACK
OS_TimerCallbackData_t *priv; /* private data for internally usage */
#endif
} OS_Timer_t;
OS_Status OS_TimerCreate(OS_Timer_t *timer, OS_TimerType type,
OS_TimerCallback_t cb, void *arg, OS_Time_t periodMS);
OS_Status OS_TimerDelete(OS_Timer_t *timer);
OS_Status OS_TimerStart(OS_Timer_t *timer);
OS_Status OS_TimerChangePeriod(OS_Timer_t *timer, OS_Time_t periodMS);
OS_Status OS_TimerStop(OS_Timer_t *timer);
/**
* @brief Check whether the timer object is valid or not
* @param[in] timer Pointer to the timer object
* @return 1 on valid, 0 on invalid
*/
static __always_inline int OS_TimerIsValid(OS_Timer_t *timer)
{
return (timer->handle != OS_INVALID_HANDLE);
}
/**
* @brief Set the timer object to invalid state
* @param[in] timer Pointer to the timer object
* @return None
*/
static __always_inline void OS_TimerSetInvalid(OS_Timer_t *timer)
{
timer->handle = OS_INVALID_HANDLE;
}
/**
* @brief Check whether the timer is active or not
*
* A timer is inactive when it is in one of the following cases:
* - The timer has been created, but not started.
* - The timer is a one shot timer that has not been restarted since it
* expired.
*
* @param[in] timer Pointer to the timer object
* @return 1 on active, 0 on inactive
*/
static __always_inline int OS_TimerIsActive(OS_Timer_t *timer)
{
return (xTimerIsTimerActive(timer->handle) != pdFALSE);
}
#ifdef __cplusplus
}
#endif
#endif /* _KERNEL_OS_FREERTOS_OS_TIMER_H_ */
|
