summaryrefslogtreecommitdiffstats
blob: 3a435d57ad6535d61c8eb0939d8bde19c5b6c873 (plain) (blame)
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
/*
 * Copyright (c) 2016-2017, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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.
 */
/** ============================================================================
 *  @file       TimerP.h
 *
 *  @brief      Timer interface for the RTOS Porting Interface
 *
 *  The TimerP module can be used to create a timer (that is, to mark a timer
 *  for use) and configure it to call a tickFxn when the timer expires.
 *
 *  The timer can be configured as a one-shot or a continuous mode timer.
 *  The period can be specified in timer counts or microseconds.
 *  The timer interrupt always uses the Hwi dispatcher. The Timer tickFxn runs
 *  in the context of a Hwi thread. The Timer module automatically creates a
 *  Hwi instance for the timer interrupt.
 *  ============================================================================
 */

#ifndef ti_osal_TimerP__include
#define ti_osal_TimerP__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>

/*!
 * Const used to specify any timer
 */
#define TimerP_ANY       (~(uint32_t)0u)

/*!
 * Max value of Timer period for PeriodType_COUNTS
 */
#define TimerP_MAX_PERIOD ((uint32_t)0xffffffffu)

/*!
 * Use default values as provided by the OSAL package
 */
 #define TimerP_USE_DEFAULT   (-(int32_t)1)

/*!
 *  @brief  Frequency-in-hertz struct
 */
typedef struct TimerP_FreqHz_s {
    uint32_t hi;      /*!< most significant 32-bits of frequency */
    uint32_t lo;      /*!< least significant 32-bits of frequency */
} TimerP_FreqHz;

/*!
 *  @brief    Status codes for TimerP APIs
 */
typedef enum TimerP_Status_e {
    TimerP_OK            =             0,
    TimerP_FAILURE       = (-(int32_t) 1),
    TimerP_NOT_AVAILABLE = (-(int32_t) 2),
    TimerP_BAD_INT_NUM   = (-(int32_t) 3),
    TimerP_ISR_HOOK_ERR  = (-(int32_t) 4)
} TimerP_Status;


/*!
 *  @brief  Timer period units for TimerP APIs
 */
typedef enum TimerP_PeriodType_e {
    TimerP_PeriodType_MICROSECS,  /*!< timer period is in micro seconds */
    TimerP_PeriodType_COUNTS      /*!< timer period is in counts */
} TimerP_PeriodType;

/*!
 *  @brief  Timer runtime modes for TimerP APIs
 */
typedef enum TimerP_RunMode_e {
    TimerP_RunMode_CONTINUOUS,  /*!< timer is periodic and runs continuously */
    TimerP_RunMode_ONESHOT      /*!< timer runs for a single period values and stops */
 } TimerP_RunMode;

/*!
 *  @brief  Timer start modes for TimerP APIs
 */
typedef enum TimerP_StartMode_e {
    TimerP_StartMode_AUTO,      /*!< timer starts automatically after create*/
    TimerP_StartMode_USER       /*!< timer will be started by the user */
}TimerP_StartMode;

/*!
 * @brief Timer mode for 64 bit timers (KeyStone devices)
 * @note  this is not applicable for non KeyStone devices such as AM572x etc
 */
typedef enum TimerP_Timer64Mode_e {
  TimerP_Timer64Mode_64BITGPTIMER,
  TimerP_Timer64Mode_UNCHAINED,
  TimerP_Timer64Mode_CHAINED
} TimerP_Timer64Mode;

/*!
 * @brief Timer half when 64 bit timer is split into two 32 bit timer (Keystone devices)
 * @note  this is not applicable for non KeyStone devices such as AM572x etc
 */
typedef enum TimerP_Timer64Half_e {
  TimerP_Timer64Half_LOWER,
  TimerP_Timer64Half_UPPER,
  TimerP_Timer64Half_DEFAULT
}TimerP_Timer64Half;

/*!
 *  @brief    Opaque client reference to an instance of a TimerP
 *
 *  A TimerP_Handle returned from the ::TimerP_create represents that instance.
 *  and then is used in the other instance based functions (e.g. ::TimerP_start,
 *  ::TimerP_stop, etc.).
 */
typedef  void *TimerP_Handle;

/*!
 *  @brief  Prototype for a TimerP function.
 */
typedef void (*TimerP_Fxn)(uintptr_t arg);

/*!
 *  @brief    Basic TimerP Parameters
 *
 *  Structure that contains the parameters passed into ::TimerP_create
 *  when creating a TimerP instance. The ::TimerP_Params_init function should
 *  be used to initialize the fields to default values before the application sets
 *  the fields manually. The TimerP default parameters are noted in
 *  TimerP_Params_init.
 */
typedef struct TimerP_Params_s {
    char    *name;        /*!< Name of the timer instance. Memory must
                             persist for the life of the clock instance.
                             This can be used for debugging purposes, or
                             set to NULL if not needed. */
    uint32_t periodType;  /*!< Period type, default micro seconds */
    int32_t  extfreqLo;   /*!< least siginificant 32-bits of ext frequency
                               set to 0 to use internal clk freq  */
    int32_t  extfreqHi;   /*!< most siginificant 32-bits of ext frequency
                               set to 0 to use internal clk freq  */
    int32_t  intfreqLo;   /*!< least siginificant 32-bits of int frequency
                               set to 0 to use default internal clk freq  */
    int32_t  intfreqHi;   /*!< most siginificant 32-bits of int frequency
                               set to 0 to use default internal clk freq  */
    uint32_t startMode;   /*!< timer start mode */
    uint32_t runMode;     /*!< timer run mode */
    uint32_t period;      /*!< Period of a tick */
    TimerP_Timer64Mode timerMode; /*!< timer mode for 64bit timer */
    TimerP_Timer64Half timerHalf; /*!< timer half for 64bit timer */

    int32_t  intNum;      /*!< Hwi Interrupt number to be used by Timer */
#if defined (_TMS320C6X)
    int32_t  eventId;     /*!< Hwi event Id to be used by the Timer */
#endif
    void*    arg;         /*!< Argument passed into the timer function. */
} TimerP_Params;

/*!
 *  @brief  Function to create a timer object.
 *
 *  @param  id       Timer Id
 *
 *  @param  tickFxn  Function that runs upon timer expiry
 *
 *  @param  params    Pointer to the instance configuration parameters. NULL
 *                    denotes to use the default parameters. The TimerP default
 *                    parameters are noted in ::TimerP_Params_init.
 *
 *  @return A TimerP_Handle on success or a NULL on an error.  This handle can
 *          be passed to TimerP_start()
 */
extern TimerP_Handle TimerP_create(int32_t        id,
                                   TimerP_Fxn     tickFxn,
                                   const TimerP_Params *params);

/*!
 *  @brief  Function to delete a timer.
 *
 *  @param  handle  A TimerP_Handle returned from ::TimerP_create
 *
 *  @return Status of the function.
 *    - TimerP_OK: Deleted the timer instance
 *    - TimerP_FAILURE: Timed out waiting to delete the timer object.
 */
extern TimerP_Status TimerP_delete(TimerP_Handle handle);

/*!
 *  @brief  Function to set timer period specified in micro seconds
 *  A best-effort method will be used to set the period register.
 *  There might be a slight rounding error based on resolution of
 *  timer period register. If the timer frequency cannot support
 *  the requested period, i.e. the timer period register cannot
 *  support the requested period, then this function returns false.
 *  TimerP_setPeriodMicroSecs() invokes TimerP_stop() prior to setting
 *  the period and leaves the timer in the stopped state.
 *
 *  @param  handle  A TimerP_Handle returned from ::TimerP_create
 *
 *  @param  microsecs  time in micro seconds
 *
 *  @return Status of the function.
 *    - TimerP_OK: Deleted the timer instance
 *    - TimerP_FAILURE: Timed out waiting to delete the timer object.
 */
extern TimerP_Status TimerP_setPeriodMicroSecs(TimerP_Handle handle, uint32_t microsecs);

/*!
 *  @brief  Initialize params structure to default values.
 *
 *  The default parameters are:
 *   - name: NULL
 *   - arg: 0
 *
 *  @param params  Pointer to the instance configuration parameters.
 */
extern void TimerP_Params_init(TimerP_Params *params);

/*!
 *  @brief  Function to start a timer.
 *
 *  @param  handle  A TimerP_Handle returned from ::TimerP_create
 *
 *  @return Status of the functions
 *    - TimerP_OK: Scheduled the timer function successfully
 *    - TimerP_FAILURE: The API failed.
 */
extern TimerP_Status TimerP_start(TimerP_Handle handle);

/*!
 *  @brief  Function to stop a timer.
 *
 *  @param  handle  A TimerP_Handle returned from ::TimerP_create
 *
 *  @return Status of the functions
 *    - TimerP_OK: Scheduled the timer function successfully
 *    - TimerP_FAILURE: The API failed.
 */
extern TimerP_Status TimerP_stop(TimerP_Handle handle);

/*!
 *  @brief  Function to clear the interrupt of the timer.
 *
 *  @param  handle  A TimerP_Handle returned from ::TimerP_create
 *
 *  @return Status of the function
 *    - TimerP_OK: Clear the interrupt of the timer function successfully.
 *
 */
extern TimerP_Status TimerP_ClearInterrupt(TimerP_Handle handle);

/*
 *  @brief  Function to return current time in units of micro-secs
 *
 *  @return Current time in units of micro-secs
 *
 * Note: This API is not supported for J7/OMAPL13x platforms and
 *       result in link errors if used in the application
 */
extern uint64_t TimerP_getTimeInUsecs(void);

#ifdef __cplusplus
}
#endif

#endif /* ti_osal_ClockP__include */