1 /* 2 * timer.h 3 * 4 * Copyright(c) 1998 - 2009 Texas Instruments. All rights reserved. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name Texas Instruments nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 35 36 /** \file timer.h 37 * \brief timer module header file. 38 * 39 * \see timer.c 40 */ 41 42 #ifndef _TIMER_H_ 43 #define _TIMER_H_ 44 45 46 /* The callback function type for timer clients */ 47 typedef void (*TTimerCbFunc)(TI_HANDLE hCbHndl, TI_BOOL bTwdInitOccured); 48 49 50 /* External Functions Prototypes */ 51 /* ============================= */ 52 TI_HANDLE tmr_Create (TI_HANDLE hOs); 53 TI_STATUS tmr_Destroy (TI_HANDLE hTimerModule); 54 TI_STATUS tmr_Free (TI_HANDLE hTimerModule); 55 void tmr_ClearInitQueue (TI_HANDLE hTimerModule); 56 void tmr_ClearOperQueue (TI_HANDLE hTimerModule); 57 void tmr_Init (TI_HANDLE hTimerModule, TI_HANDLE hOs, TI_HANDLE hReport, TI_HANDLE hContext); 58 void tmr_UpdateDriverState (TI_HANDLE hTimerModule, TI_BOOL bOperState); 59 TI_HANDLE tmr_CreateTimer (TI_HANDLE hTimerModule); 60 TI_STATUS tmr_DestroyTimer (TI_HANDLE hTimerInfo); 61 void tmr_StartTimer (TI_HANDLE hTimerInfo, 62 TTimerCbFunc fExpiryCbFunc, 63 TI_HANDLE hExpiryCbHndl, 64 TI_UINT32 uIntervalMsec, 65 TI_BOOL bPeriodic); 66 void tmr_StopTimer (TI_HANDLE hTimerInfo); 67 void tmr_GetExpiry (TI_HANDLE hTimerInfo); 68 void tmr_HandleExpiry (TI_HANDLE hTimerModule); 69 70 #ifdef TI_DBG 71 void tmr_PrintModule (TI_HANDLE hTimerModule); 72 void tmr_PrintTimer (TI_HANDLE hTimerInfo); 73 #endif /* TI_DBG */ 74 75 76 #endif /* _TIMER_H_ */ 77 78 79
