BLE lib
Fork of Nucleo_BLE_BlueNRG by
platform/inc/gp_timer.h
- Committer:
- vijaynvr
- Date:
- 2015-02-08
- Revision:
- 5:beb2c7544ce4
- Parent:
- 0:a948f5f3904c
File content as of revision 5:beb2c7544ce4:
/******************** (C) COPYRIGHT 2012 STMicroelectronics ******************** * File Name : gp_timer.h * Author : AMS - HEA&RF BU * Version : V1.0.0 * Date : 19-July-2012 * Description : General purpose timer library. ******************************************************************************** * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME. * AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT, * INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE * CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING * INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS. *******************************************************************************/ #ifndef __GP_TIMER_H__ #define __GP_TIMER_H__ #include "clock.h" /** * timer * * A structure that represents a timer. Use Timer_Set() to set the timer. * */ struct timer { #ifndef DOXYGEN_SHOULD_SKIP_THIS tClockTime start; tClockTime interval; #endif }; /** * Timer_Set * * @param[in] t Pointer to a timer structure * @param[in] interval timeout value * * This function sets the timeout value of a timer. * */ void Timer_Set(struct timer *t, tClockTime interval); /** * Timer_Reset * * @param[in] t Pointer to a timer structure * * This function resets the timer with the same interval given * with Timer_Set, starting from the time it previously expired. * */ void Timer_Reset(struct timer *t); /** * Timer_Restart * * @param[in] t Pointer to a timer structure * * This function resets the timer with the same interval given * with Timer_Set, starting from the current time. * */ void Timer_Restart(struct timer *t); /** * Timer_Expired * * @param[in] t Pointer to a timer structure * * This function returns TRUE if timer is expired, FALSE otherwise. * */ int Timer_Expired(struct timer *t); /** * Timer_Expired * * @param[in] t Pointer to a timer structure * * This function returns the time needed for expiration. * * @return Time before timer's expiration. */ tClockTime Timer_Remaining(struct timer *t); #endif /* __GP_TIMER_H__ */