0
|
1 |
/*
|
|
2 |
* timer.c
|
|
3 |
*
|
|
4 |
* Copyright(c) 1998 - 2010 Texas Instruments. All rights reserved.
|
|
5 |
* All rights reserved.
|
|
6 |
*
|
|
7 |
* This program and the accompanying materials are made available under the
|
|
8 |
* terms of the Eclipse Public License v1.0 or BSD License which accompanies
|
|
9 |
* this distribution. The Eclipse Public License is available at
|
|
10 |
* http://www.eclipse.org/legal/epl-v10.html and the BSD License is as below.
|
|
11 |
*
|
|
12 |
* Redistribution and use in source and binary forms, with or without
|
|
13 |
* modification, are permitted provided that the following conditions
|
|
14 |
* are met:
|
|
15 |
*
|
|
16 |
* * Redistributions of source code must retain the above copyright
|
|
17 |
* notice, this list of conditions and the following disclaimer.
|
|
18 |
* * Redistributions in binary form must reproduce the above copyright
|
|
19 |
* notice, this list of conditions and the following disclaimer in
|
|
20 |
* the documentation and/or other materials provided with the
|
|
21 |
* distribution.
|
|
22 |
* * Neither the name Texas Instruments nor the names of its
|
|
23 |
* contributors may be used to endorse or promote products derived
|
|
24 |
* from this software without specific prior written permission.
|
|
25 |
*
|
|
26 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
27 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
28 |
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
29 |
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
30 |
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
31 |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
32 |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
33 |
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
34 |
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
35 |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
36 |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
37 |
*/
|
|
38 |
|
|
39 |
|
|
40 |
/** \file timer.c
|
|
41 |
* \brief The timers services OS-Independent layer over the OS-API timer services which are OS-Dependent.
|
|
42 |
*
|
|
43 |
* \see timer.h, osapi.c
|
|
44 |
*/
|
|
45 |
|
|
46 |
|
|
47 |
#define __FILE_ID__ FILE_ID_0
|
|
48 |
#include "osApi.h"
|
|
49 |
#include "report.h"
|
|
50 |
#include "queue.h"
|
|
51 |
#include "context.h"
|
|
52 |
#include "timer.h"
|
|
53 |
|
|
54 |
|
|
55 |
#define EXPIRY_QUE_SIZE 64 /* support case where all timers expire during recovery or error */
|
|
56 |
|
|
57 |
/* The timer module structure (common to all timers) */
|
|
58 |
typedef struct
|
|
59 |
{
|
|
60 |
TI_HANDLE hOs;
|
|
61 |
TI_HANDLE hReport;
|
|
62 |
TI_HANDLE hContext;
|
|
63 |
TI_UINT32 uContextId; /* The ID allocated to this module on registration to context module */
|
|
64 |
TI_HANDLE hInitQueue; /* Handle of the Init-Queue */
|
|
65 |
TI_HANDLE hOperQueue; /* Handle of the Operational-Queue */
|
|
66 |
TI_BOOL bOperState; /* TRUE when the driver is in operational state (not init or recovery) */
|
|
67 |
TI_UINT32 uTwdInitCount; /* Increments on each TWD init (i.e. recovery) */
|
|
68 |
TI_UINT32 uTimersCount; /* Number of created timers */
|
|
69 |
} TTimerModule;
|
|
70 |
|
|
71 |
/* Per timer structure */
|
|
72 |
typedef struct
|
|
73 |
{
|
|
74 |
TI_HANDLE hTimerModule; /* The timer module handle (see TTimerModule, needed on expiry) */
|
|
75 |
TI_HANDLE hOsTimerObj; /* The OS-API timer object handle */
|
|
76 |
TQueNodeHdr tQueNodeHdr; /* The header used for queueing the timer */
|
|
77 |
TTimerCbFunc fExpiryCbFunc; /* The CB-function provided by the timer user for expiration */
|
|
78 |
TI_HANDLE hExpiryCbHndl; /* The CB-function handle */
|
|
79 |
TI_UINT32 uIntervalMsec; /* The timer duration in Msec */
|
|
80 |
TI_BOOL bPeriodic; /* If TRUE, restarted after each expiry */
|
|
81 |
TI_BOOL bOperStateWhenStarted; /* The bOperState value when the timer was started */
|
|
82 |
TI_UINT32 uTwdInitCountWhenStarted; /* The uTwdInitCount value when the timer was started */
|
|
83 |
} TTimerInfo;
|
|
84 |
|
|
85 |
|
|
86 |
|
|
87 |
|
|
88 |
/**
|
|
89 |
* \fn tmr_Create
|
|
90 |
* \brief Create the timer module
|
|
91 |
*
|
|
92 |
* Allocate and clear the timer module object.
|
|
93 |
*
|
|
94 |
* \note This is NOT a specific timer creation! (see tmr_CreateTimer)
|
|
95 |
* \param hOs - Handle to Os Abstraction Layer
|
|
96 |
* \return Handle of the allocated object
|
|
97 |
* \sa tmr_Destroy
|
|
98 |
*/
|
|
99 |
TI_HANDLE tmr_Create (TI_HANDLE hOs)
|
|
100 |
{
|
|
101 |
TI_HANDLE hTimerModule;
|
|
102 |
|
|
103 |
/* allocate module object */
|
|
104 |
hTimerModule = os_memoryAlloc (hOs, sizeof(TTimerModule),MemoryNormal);
|
|
105 |
|
|
106 |
if (!hTimerModule)
|
|
107 |
{
|
|
108 |
WLAN_OS_REPORT (("tmr_Create(): Allocation failed!!\n"));
|
|
109 |
return NULL;
|
|
110 |
}
|
|
111 |
|
|
112 |
os_memoryZero (hOs, hTimerModule, (sizeof(TTimerModule)));
|
|
113 |
|
|
114 |
return (hTimerModule);
|
|
115 |
}
|
|
116 |
|
|
117 |
|
|
118 |
/**
|
|
119 |
* \fn tmr_Destroy
|
|
120 |
* \brief Destroy the module.
|
|
121 |
*
|
|
122 |
* Free the module's queues and object.
|
|
123 |
*
|
|
124 |
* \note This is NOT a specific timer destruction! (see tmr_DestroyTimer)
|
|
125 |
* \param hTimerModule - The module object
|
|
126 |
* \return TI_OK on success or TI_NOK on failure
|
|
127 |
* \sa tmr_Create
|
|
128 |
*/
|
|
129 |
TI_STATUS tmr_Destroy (TI_HANDLE hTimerModule)
|
|
130 |
{
|
|
131 |
TTimerModule *pTimerModule = (TTimerModule *)hTimerModule;
|
|
132 |
|
|
133 |
/* Alert if there are still timers that were not destroyed */
|
|
134 |
if (pTimerModule->uTimersCount)
|
|
135 |
{
|
|
136 |
WLAN_OS_REPORT (("tmr_Destroy(): ERROR - Destroying Timer module but not all timers were destroyed!!\n"));
|
|
137 |
}
|
|
138 |
|
|
139 |
/* Clear queues */
|
|
140 |
tmr_ClearInitQueue (hTimerModule);
|
|
141 |
tmr_ClearOperQueue (hTimerModule);
|
|
142 |
|
|
143 |
/* Destroy the module's queues */
|
|
144 |
que_Destroy (pTimerModule->hInitQueue);
|
|
145 |
que_Destroy (pTimerModule->hOperQueue);
|
|
146 |
|
|
147 |
/* free module object */
|
|
148 |
os_memoryFree (pTimerModule->hOs, pTimerModule, sizeof(TTimerModule));
|
|
149 |
|
|
150 |
return TI_OK;
|
|
151 |
}
|
|
152 |
/**
|
|
153 |
* \fn tmr_Free
|
|
154 |
* \brief Free the memory.
|
|
155 |
*
|
|
156 |
* Free the module's queues and object.
|
|
157 |
*
|
|
158 |
* \param hTimerModule - The module object
|
|
159 |
* \return TI_OK on success or TI_NOK on failure
|
|
160 |
* \sa tmr_Create
|
|
161 |
*/
|
|
162 |
TI_STATUS tmr_Free(TI_HANDLE hTimerModule)
|
|
163 |
{
|
|
164 |
TTimerModule *pTimerModule = (TTimerModule *)hTimerModule;
|
|
165 |
|
|
166 |
/* free module object */
|
|
167 |
os_memoryFree (pTimerModule->hOs, pTimerModule, sizeof(TTimerModule));
|
|
168 |
|
|
169 |
return TI_OK;
|
|
170 |
}
|
|
171 |
|
|
172 |
|
|
173 |
/**
|
|
174 |
* \fn tmr_ClearInitQueue & tmr_ClearOperQueue
|
|
175 |
* \brief Clear Init/Operationsl queue
|
|
176 |
*
|
|
177 |
* Dequeue all queued timers.
|
|
178 |
*
|
|
179 |
* \note
|
|
180 |
* \param hTimerModule - The object
|
|
181 |
* \return void
|
|
182 |
* \sa
|
|
183 |
*/
|
|
184 |
void tmr_ClearInitQueue (TI_HANDLE hTimerModule)
|
|
185 |
{
|
|
186 |
TTimerModule *pTimerModule = (TTimerModule *)hTimerModule;
|
|
187 |
|
|
188 |
while (que_Dequeue (pTimerModule->hInitQueue) != NULL) {}
|
|
189 |
}
|
|
190 |
|
|
191 |
void tmr_ClearOperQueue (TI_HANDLE hTimerModule)
|
|
192 |
{
|
|
193 |
TTimerModule *pTimerModule = (TTimerModule *)hTimerModule;
|
|
194 |
|
|
195 |
while (que_Dequeue (pTimerModule->hOperQueue) != NULL) {}
|
|
196 |
}
|
|
197 |
|
|
198 |
|
|
199 |
/**
|
|
200 |
* \fn tmr_Init
|
|
201 |
* \brief Init required handles
|
|
202 |
*
|
|
203 |
* Init required handles and module variables, create the init-queue and
|
|
204 |
* operational-queue, and register as the context-engine client.
|
|
205 |
*
|
|
206 |
* \note
|
|
207 |
* \param hTimerModule - The queue object
|
|
208 |
* \param hOs - Handle to Os Abstraction Layer
|
|
209 |
* \param hReport - Handle to report module
|
|
210 |
* \param hContext - Handle to context module
|
|
211 |
* \return void
|
|
212 |
* \sa
|
|
213 |
*/
|
|
214 |
void tmr_Init (TI_HANDLE hTimerModule, TI_HANDLE hOs, TI_HANDLE hReport, TI_HANDLE hContext)
|
|
215 |
{
|
|
216 |
TTimerModule *pTimerModule = (TTimerModule *)hTimerModule;
|
|
217 |
TI_UINT32 uNodeHeaderOffset;
|
|
218 |
|
|
219 |
pTimerModule->hOs = hOs;
|
|
220 |
pTimerModule->hReport = hReport;
|
|
221 |
pTimerModule->hContext = hContext;
|
|
222 |
|
|
223 |
pTimerModule->bOperState = TI_FALSE;
|
|
224 |
pTimerModule->uTimersCount = 0;
|
|
225 |
pTimerModule->uTwdInitCount = 0;
|
|
226 |
|
|
227 |
/* The offset of the queue-node-header from timer structure entry is needed by the queue */
|
|
228 |
uNodeHeaderOffset = TI_FIELD_OFFSET(TTimerInfo, tQueNodeHdr);
|
|
229 |
|
|
230 |
/* Create and initialize the Init and Operational queues (for timers expiry events) */
|
|
231 |
pTimerModule->hInitQueue = que_Create (pTimerModule->hOs,
|
|
232 |
pTimerModule->hReport,
|
|
233 |
EXPIRY_QUE_SIZE,
|
|
234 |
uNodeHeaderOffset);
|
|
235 |
pTimerModule->hOperQueue = que_Create (pTimerModule->hOs,
|
|
236 |
pTimerModule->hReport,
|
|
237 |
EXPIRY_QUE_SIZE,
|
|
238 |
uNodeHeaderOffset);
|
|
239 |
|
|
240 |
/* Register to the context engine and get the client ID */
|
|
241 |
pTimerModule->uContextId = context_RegisterClient (pTimerModule->hContext,
|
|
242 |
tmr_HandleExpiry,
|
|
243 |
hTimerModule,
|
|
244 |
TI_TRUE,
|
|
245 |
"TIMER",
|
|
246 |
sizeof("TIMER"));
|
|
247 |
}
|
|
248 |
|
|
249 |
|
|
250 |
/**
|
|
251 |
* \fn tmr_UpdateDriverState
|
|
252 |
* \brief Update driver state
|
|
253 |
*
|
|
254 |
* Under critical section, update driver state (operational or not),
|
|
255 |
* and if opertional, clear init queue.
|
|
256 |
* Leave critical section and if operational state, request schedule for handling
|
|
257 |
* timer events in driver context (if any).
|
|
258 |
*
|
|
259 |
* \note
|
|
260 |
* \param hTimerModule - The timer module object
|
|
261 |
* \param bOperState - TRUE if driver state is now operational, FALSE if not.
|
|
262 |
* \return void
|
|
263 |
* \sa
|
|
264 |
*/
|
|
265 |
void tmr_UpdateDriverState (TI_HANDLE hTimerModule, TI_BOOL bOperState)
|
|
266 |
{
|
|
267 |
TTimerModule *pTimerModule = (TTimerModule *)hTimerModule;
|
|
268 |
|
|
269 |
if (bOperState == pTimerModule->bOperState)
|
|
270 |
{
|
|
271 |
TRACE1(pTimerModule->hReport, REPORT_SEVERITY_ERROR, "tmr_UpdateDriverState(): New bOperState (%d) is as current!\n", bOperState);
|
|
272 |
return;
|
|
273 |
}
|
|
274 |
|
|
275 |
/* Enter critical section */
|
|
276 |
CONTEXT_ENTER_CRITICAL_SECTION (pTimerModule->hContext);
|
|
277 |
|
|
278 |
/* Save new state (TRUE means operational). */
|
|
279 |
pTimerModule->bOperState = bOperState;
|
|
280 |
|
|
281 |
/* If new state is operational */
|
|
282 |
if (bOperState)
|
|
283 |
{
|
|
284 |
/* Increment the TWD initializations counter (for detecting recovery events). */
|
|
285 |
pTimerModule->uTwdInitCount++;
|
|
286 |
|
|
287 |
/* Empty the init queue (obsolete). */
|
|
288 |
while (que_Dequeue (pTimerModule->hInitQueue) != NULL) {}
|
|
289 |
}
|
|
290 |
|
|
291 |
/* Leave critical section */
|
|
292 |
CONTEXT_LEAVE_CRITICAL_SECTION (pTimerModule->hContext);
|
|
293 |
|
|
294 |
/* If new state is operational, request switch to driver context for handling timer events */
|
|
295 |
if (bOperState)
|
|
296 |
{
|
|
297 |
context_RequestSchedule (pTimerModule->hContext, pTimerModule->uContextId);
|
|
298 |
}
|
|
299 |
}
|
|
300 |
|
|
301 |
|
|
302 |
|
|
303 |
|
|
304 |
/**
|
|
305 |
* \fn tmr_CreateTimer
|
|
306 |
* \brief Create a new timer
|
|
307 |
*
|
|
308 |
* Create a new timer object, icluding creating a timer in the OS-API.
|
|
309 |
*
|
|
310 |
* \note This timer creation may be used only after tmr_Create() and tmr_Init() were executed!!
|
|
311 |
* \param hTimerModule - The module handle
|
|
312 |
* \return TI_HANDLE - The created timer handle
|
|
313 |
* \sa tmr_DestroyTimer
|
|
314 |
*/
|
|
315 |
TI_HANDLE tmr_CreateTimer (TI_HANDLE hTimerModule)
|
|
316 |
{
|
|
317 |
TTimerModule *pTimerModule = (TTimerModule *)hTimerModule; /* The timer module handle */
|
|
318 |
TTimerInfo *pTimerInfo; /* The created timer handle */
|
|
319 |
|
|
320 |
/* Allocate timer object */
|
|
321 |
pTimerInfo = os_memoryAlloc (pTimerModule->hOs, sizeof(TTimerInfo),MemoryNormal);
|
|
322 |
if (!pTimerInfo)
|
|
323 |
{
|
|
324 |
WLAN_OS_REPORT (("tmr_CreateTimer(): Timer allocation failed!!\n"));
|
|
325 |
return NULL;
|
|
326 |
}
|
|
327 |
os_memoryZero (pTimerModule->hOs, pTimerInfo, (sizeof(TTimerInfo)));
|
|
328 |
|
|
329 |
/* Allocate OS-API timer, providing the common expiry callback with the current timer handle */
|
|
330 |
pTimerInfo->hOsTimerObj = os_timerCreate(pTimerModule->hOs, tmr_GetExpiry, (TI_HANDLE)pTimerInfo);
|
|
331 |
if (!pTimerInfo->hOsTimerObj)
|
|
332 |
{
|
|
333 |
os_memoryFree (pTimerModule->hOs, pTimerInfo, sizeof(TTimerInfo));
|
|
334 |
WLAN_OS_REPORT (("tmr_CreateTimer(): OS-API Timer allocation failed!!\n"));
|
|
335 |
return NULL;
|
|
336 |
}
|
|
337 |
|
|
338 |
/* Save the timer module handle in the created timer object (needed for the expiry callback) */
|
|
339 |
pTimerInfo->hTimerModule = hTimerModule;
|
|
340 |
pTimerModule->uTimersCount++; /* count created timers */
|
|
341 |
|
|
342 |
/* Return the created timer handle */
|
|
343 |
return (TI_HANDLE)pTimerInfo;
|
|
344 |
}
|
|
345 |
|
|
346 |
|
|
347 |
/**
|
|
348 |
* \fn tmr_DestroyTimer
|
|
349 |
* \brief Destroy the specified timer
|
|
350 |
*
|
|
351 |
* Destroy the specified timer object, icluding the timer in the OS-API.
|
|
352 |
*
|
|
353 |
* \note This timer destruction function should be used before tmr_Destroy() is executed!!
|
|
354 |
* \param hTimerInfo - The timer handle
|
|
355 |
* \return TI_OK on success or TI_NOK on failure
|
|
356 |
* \sa tmr_CreateTimer
|
|
357 |
*/
|
|
358 |
TI_STATUS tmr_DestroyTimer (TI_HANDLE hTimerInfo)
|
|
359 |
{
|
|
360 |
TTimerInfo *pTimerInfo = (TTimerInfo *)hTimerInfo; /* The timer handle */
|
|
361 |
TTimerModule *pTimerModule = (TTimerModule *)pTimerInfo->hTimerModule; /* The timer module handle */
|
|
362 |
|
|
363 |
/* Free the OS-API timer */
|
|
364 |
os_timerDestroy (pTimerModule->hOs, pTimerInfo->hOsTimerObj);
|
|
365 |
|
|
366 |
/* Free the timer object */
|
|
367 |
os_memoryFree (pTimerModule->hOs, hTimerInfo, sizeof(TTimerInfo));
|
|
368 |
|
|
369 |
pTimerModule->uTimersCount--; /* update created timers number */
|
|
370 |
|
|
371 |
return TI_OK;
|
|
372 |
}
|
|
373 |
|
|
374 |
|
|
375 |
|
|
376 |
/**
|
|
377 |
* \fn tmr_StartTimer
|
|
378 |
* \brief Start a timer
|
|
379 |
*
|
|
380 |
* Start the specified timer running.
|
|
381 |
*
|
|
382 |
* \note Periodic-Timer may be used by applications that serve the timer expiry
|
|
383 |
* in a single context.
|
|
384 |
* If an application can't finish serving the timer expiry in a single context,
|
|
385 |
* e.g. periodic scan, then it isn't recommended to use the periodic timer service.
|
|
386 |
* If such an application uses the periodic timer then it should protect itself from cases
|
|
387 |
* where the timer expires again before the previous timer expiry processing is finished!!
|
|
388 |
* \param hTimerInfo - The specific timer handle
|
|
389 |
* \param fExpiryCbFunc - The timer's expiry callback function.
|
|
390 |
* \param hExpiryCbHndl - The client's expiry callback function handle.
|
|
391 |
* \param uIntervalMsec - The timer's duration in Msec.
|
|
392 |
* \param bPeriodic - If TRUE, the timer is restarted after expiry.
|
|
393 |
* \return void
|
|
394 |
* \sa tmr_StopTimer, tmr_GetExpiry
|
|
395 |
*/
|
|
396 |
void tmr_StartTimer (TI_HANDLE hTimerInfo,
|
|
397 |
TTimerCbFunc fExpiryCbFunc,
|
|
398 |
TI_HANDLE hExpiryCbHndl,
|
|
399 |
TI_UINT32 uIntervalMsec,
|
|
400 |
TI_BOOL bPeriodic)
|
|
401 |
{
|
|
402 |
TTimerInfo *pTimerInfo = (TTimerInfo *)hTimerInfo; /* The timer handle */
|
|
403 |
TTimerModule *pTimerModule = (TTimerModule *)pTimerInfo->hTimerModule; /* The timer module handle */
|
|
404 |
|
|
405 |
/* Save the timer parameters. */
|
|
406 |
pTimerInfo->fExpiryCbFunc = fExpiryCbFunc;
|
|
407 |
pTimerInfo->hExpiryCbHndl = hExpiryCbHndl;
|
|
408 |
pTimerInfo->uIntervalMsec = uIntervalMsec;
|
|
409 |
pTimerInfo->bPeriodic = bPeriodic;
|
|
410 |
pTimerInfo->bOperStateWhenStarted = pTimerModule->bOperState;
|
|
411 |
pTimerInfo->uTwdInitCountWhenStarted = pTimerModule->uTwdInitCount;
|
|
412 |
|
|
413 |
/* Start OS-API timer running */
|
|
414 |
os_timerStart(pTimerModule->hOs, pTimerInfo->hOsTimerObj, uIntervalMsec);
|
|
415 |
}
|
|
416 |
|
|
417 |
|
|
418 |
/**
|
|
419 |
* \fn tmr_StopTimer
|
|
420 |
* \brief Stop a running timer
|
|
421 |
*
|
|
422 |
* Stop the specified timer.
|
|
423 |
*
|
|
424 |
* \note When using this function, it must be considered that timer expiry may happen
|
|
425 |
* right before the timer is stopped, so it can't be assumed that this completely
|
|
426 |
* prevents the timer expiry event!
|
|
427 |
* \param hTimerInfo - The specific timer handle
|
|
428 |
* \return void
|
|
429 |
* \sa tmr_StartTimer
|
|
430 |
*/
|
|
431 |
void tmr_StopTimer (TI_HANDLE hTimerInfo)
|
|
432 |
{
|
|
433 |
TTimerInfo *pTimerInfo = (TTimerInfo *)hTimerInfo; /* The timer handle */
|
|
434 |
TTimerModule *pTimerModule = (TTimerModule *)pTimerInfo->hTimerModule; /* The timer module handle */
|
|
435 |
|
|
436 |
/* Stop OS-API timer running */
|
|
437 |
os_timerStop(pTimerModule->hOs, pTimerInfo->hOsTimerObj);
|
|
438 |
|
|
439 |
/* Clear periodic flag to prevent timer restart if we are in tmr_HandleExpiry context. */
|
|
440 |
pTimerInfo->bPeriodic = TI_FALSE;
|
|
441 |
}
|
|
442 |
|
|
443 |
|
|
444 |
/**
|
|
445 |
* \fn tmr_GetExpiry
|
|
446 |
* \brief Called by OS-API upon any timer expiry
|
|
447 |
*
|
|
448 |
* This is the common callback function called upon expiartion of any timer.
|
|
449 |
* It is called by the OS-API in timer expiry context and handles the transition
|
|
450 |
* to the driver's context for handling the expiry event.
|
|
451 |
*
|
|
452 |
* \note
|
|
453 |
* \param hTimerInfo - The specific timer handle
|
|
454 |
* \return void
|
|
455 |
* \sa tmr_HandleExpiry
|
|
456 |
*/
|
|
457 |
void tmr_GetExpiry (TI_HANDLE hTimerInfo)
|
|
458 |
{
|
|
459 |
TTimerInfo *pTimerInfo = (TTimerInfo *)hTimerInfo; /* The timer handle */
|
|
460 |
TTimerModule *pTimerModule = (TTimerModule *)pTimerInfo->hTimerModule; /* The timer module handle */
|
|
461 |
|
|
462 |
/* Enter critical section */
|
|
463 |
CONTEXT_ENTER_CRITICAL_SECTION (pTimerModule->hContext);
|
|
464 |
|
|
465 |
/*
|
|
466 |
* If the expired timer was started when the driver's state was Operational,
|
|
467 |
* insert it to the Operational-queue
|
|
468 |
*/
|
|
469 |
if (pTimerInfo->bOperStateWhenStarted)
|
|
470 |
{
|
|
471 |
que_Enqueue (pTimerModule->hOperQueue, hTimerInfo);
|
|
472 |
}
|
|
473 |
|
|
474 |
/*
|
|
475 |
* Else (started when driver's state was NOT-Operational), if now the state is still
|
|
476 |
* NOT Operational insert it to the Init-queue.
|
|
477 |
* (If state changed from non-operational to operational the event is ignored)
|
|
478 |
*/
|
|
479 |
else if (!pTimerModule->bOperState)
|
|
480 |
{
|
|
481 |
que_Enqueue (pTimerModule->hInitQueue, hTimerInfo);
|
|
482 |
}
|
|
483 |
|
|
484 |
/* Leave critical section */
|
|
485 |
CONTEXT_LEAVE_CRITICAL_SECTION (pTimerModule->hContext);
|
|
486 |
|
|
487 |
/* Request switch to driver context for handling timer events */
|
|
488 |
context_RequestSchedule (pTimerModule->hContext, pTimerModule->uContextId);
|
|
489 |
}
|
|
490 |
|
|
491 |
|
|
492 |
/**
|
|
493 |
* \fn tmr_HandleExpiry
|
|
494 |
* \brief Handles queued expiry events in driver context
|
|
495 |
*
|
|
496 |
* This is the Timer module's callback that is registered to the ContextEngine module to be invoked
|
|
497 |
* from the driver task (after requested by tmr_GetExpiry through context_RequestSchedule ()).
|
|
498 |
* It dequeues all expiry events from the queue that correlates to the current driver state,
|
|
499 |
* and calls their users callbacks.
|
|
500 |
*
|
|
501 |
* \note
|
|
502 |
* \param hTimerModule - The module object
|
|
503 |
* \return void
|
|
504 |
* \sa tmr_GetExpiry
|
|
505 |
*/
|
|
506 |
void tmr_HandleExpiry (TI_HANDLE hTimerModule)
|
|
507 |
{
|
|
508 |
TTimerModule *pTimerModule = (TTimerModule *)hTimerModule; /* The timer module handle */
|
|
509 |
TTimerInfo *pTimerInfo; /* The timer handle */
|
|
510 |
TI_BOOL bTwdInitOccured; /* Indicates if TWD init occured since timer start */
|
|
511 |
|
|
512 |
while (1)
|
|
513 |
{
|
|
514 |
/* Enter critical section */
|
|
515 |
CONTEXT_ENTER_CRITICAL_SECTION (pTimerModule->hContext);
|
|
516 |
|
|
517 |
/* If current driver state is Operational, dequeue timer object from Operational-queue */
|
|
518 |
if (pTimerModule->bOperState)
|
|
519 |
{
|
|
520 |
pTimerInfo = (TTimerInfo *) que_Dequeue (pTimerModule->hOperQueue);
|
|
521 |
}
|
|
522 |
|
|
523 |
/* Else (driver state is NOT-Operational), dequeue timer object from Init-queue */
|
|
524 |
else
|
|
525 |
{
|
|
526 |
pTimerInfo = (TTimerInfo *) que_Dequeue (pTimerModule->hInitQueue);
|
|
527 |
}
|
|
528 |
|
|
529 |
/* Leave critical section */
|
|
530 |
CONTEXT_LEAVE_CRITICAL_SECTION (pTimerModule->hContext);
|
|
531 |
|
|
532 |
/* If no more objects in queue, exit */
|
|
533 |
if (!pTimerInfo)
|
|
534 |
{
|
|
535 |
return; /** EXIT Point **/
|
|
536 |
}
|
|
537 |
|
|
538 |
/* If current TWD-Init-Count is different than when the timer was started, Init occured. */
|
|
539 |
bTwdInitOccured = (pTimerModule->uTwdInitCount != pTimerInfo->uTwdInitCountWhenStarted);
|
|
540 |
|
|
541 |
/* Call specific timer callback function */
|
|
542 |
pTimerInfo->fExpiryCbFunc (pTimerInfo->hExpiryCbHndl, bTwdInitOccured);
|
|
543 |
|
|
544 |
/* If the expired timer is periodic, start it again. */
|
|
545 |
if (pTimerInfo->bPeriodic)
|
|
546 |
{
|
|
547 |
tmr_StartTimer ((TI_HANDLE)pTimerInfo,
|
|
548 |
pTimerInfo->fExpiryCbFunc,
|
|
549 |
pTimerInfo->hExpiryCbHndl,
|
|
550 |
pTimerInfo->uIntervalMsec,
|
|
551 |
pTimerInfo->bPeriodic);
|
|
552 |
}
|
|
553 |
}
|
|
554 |
}
|
|
555 |
|
|
556 |
|
|
557 |
/**
|
|
558 |
* \fn tmr_PrintModule / tmr_PrintTimer
|
|
559 |
* \brief Print module / timer information
|
|
560 |
*
|
|
561 |
* Print the module's information / a specific timer information.
|
|
562 |
*
|
|
563 |
* \note
|
|
564 |
* \param The module / timer handle
|
|
565 |
* \return void
|
|
566 |
* \sa
|
|
567 |
*/
|
|
568 |
|
|
569 |
#ifdef TI_DBG
|
|
570 |
|
|
571 |
void tmr_PrintModule (TI_HANDLE hTimerModule)
|
|
572 |
{
|
|
573 |
TTimerModule *pTimerModule = (TTimerModule *)hTimerModule;
|
|
574 |
|
|
575 |
/* Print module parameters */
|
|
576 |
WLAN_OS_REPORT(("tmr_PrintModule(): uContextId=%d, bOperState=%d, uTwdInitCount=%d, uTimersCount=%d\n",
|
|
577 |
pTimerModule->uContextId, pTimerModule->bOperState,
|
|
578 |
pTimerModule->uTwdInitCount, pTimerModule->uTimersCount));
|
|
579 |
|
|
580 |
/* Print Init Queue Info */
|
|
581 |
WLAN_OS_REPORT(("tmr_PrintModule(): Init-Queue:\n"));
|
|
582 |
que_Print(pTimerModule->hInitQueue);
|
|
583 |
|
|
584 |
/* Print Operational Queue Info */
|
|
585 |
WLAN_OS_REPORT(("tmr_PrintModule(): Operational-Queue:\n"));
|
|
586 |
que_Print(pTimerModule->hOperQueue);
|
|
587 |
}
|
|
588 |
|
|
589 |
void tmr_PrintTimer (TI_HANDLE hTimerInfo)
|
|
590 |
{
|
|
591 |
TTimerInfo *pTimerInfo = (TTimerInfo *)hTimerInfo; /* The timer handle */
|
|
592 |
|
|
593 |
WLAN_OS_REPORT(("tmr_PrintTimer(): uIntervalMs=%d, bPeriodic=%d, bOperStateWhenStarted=%d, uTwdInitCountWhenStarted=%d, hOsTimerObj=0x%x, fExpiryCbFunc=0x%x\n",
|
|
594 |
pTimerInfo->uIntervalMsec, pTimerInfo->bPeriodic, pTimerInfo->bOperStateWhenStarted,
|
|
595 |
pTimerInfo->uTwdInitCountWhenStarted, pTimerInfo->hOsTimerObj, pTimerInfo->fExpiryCbFunc));
|
|
596 |
}
|
|
597 |
|
|
598 |
#endif /* TI_DBG */
|
|
599 |
|
|
600 |
|