1 /*

     2  * timer.h

     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 

    41 /** \file   timer.h 

    42  *  \brief  timer module header file.                                  

    43  *

    44  *  \see    timer.c

    45  */

    46 

    47 #ifndef _TIMER_H_

    48 #define _TIMER_H_

    49 

    50 

    51 /* The callback function type for timer clients */

    52 typedef void (*TTimerCbFunc)(TI_HANDLE hCbHndl, TI_BOOL bTwdInitOccured);

    53 

    54 

    55 /* External Functions Prototypes */

    56 /* ============================= */

    57 TI_HANDLE tmr_Create (TI_HANDLE hOs);

    58 TI_STATUS tmr_Destroy (TI_HANDLE hTimerModule);

    59 TI_STATUS tmr_Free (TI_HANDLE hTimerModule);

    60 void      tmr_ClearInitQueue (TI_HANDLE hTimerModule);

    61 void      tmr_ClearOperQueue (TI_HANDLE hTimerModule);

    62 void      tmr_Init (TI_HANDLE hTimerModule, TI_HANDLE hOs, TI_HANDLE hReport, TI_HANDLE hContext);

    63 void      tmr_UpdateDriverState (TI_HANDLE hTimerModule, TI_BOOL bOperState);

    64 TI_HANDLE tmr_CreateTimer (TI_HANDLE hTimerModule);

    65 TI_STATUS tmr_DestroyTimer (TI_HANDLE hTimerInfo);

    66 void      tmr_StartTimer (TI_HANDLE     hTimerInfo,

    67                           TTimerCbFunc  fExpiryCbFunc,

    68                           TI_HANDLE     hExpiryCbHndl,

    69                           TI_UINT32     uIntervalMsec,

    70                           TI_BOOL       bPeriodic);

    71 void      tmr_StopTimer (TI_HANDLE hTimerInfo);

    72 void      tmr_GetExpiry (TI_HANDLE hTimerInfo);

    73 void      tmr_HandleExpiry (TI_HANDLE hTimerModule);

    74 

    75 #ifdef TI_DBG

    76 void      tmr_PrintModule (TI_HANDLE hTimerModule);

    77 void      tmr_PrintTimer (TI_HANDLE hTimerInfo);

    78 #endif /* TI_DBG */

    79 

    80 

    81 #endif  /* _TIMER_H_ */

    82 

    83