bleapputil_timers.h

Go to the documentation of this file.

/******************************************************************************

@file  bleapputil_timers.h

@brief This file contains the BLE App Util timers APIs.

Group: WCS, BTS
$Target Device: DEVICES $

******************************************************************************
$License: BSD3 2025 $
******************************************************************************
$Release Name: PACKAGE NAME $
$Release Date: PACKAGE RELEASE DATE $
*****************************************************************************/

#ifndef BLEAPPUTIL_TIMERS_H
#define BLEAPPUTIL_TIMERS_H

#ifdef __cplusplus
extern "C"
{
#endif

/*********************************************************************
 * INCLUDES
 */

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

/*********************************************************************
 * MACROS
 */

#define TIMER_SEC_TO_MS(sec)        sec*1000
#define TIMER_MINUTES_TO_MS(min)    TIMER_SEC_TO_MS(min*60)
#define TIMER_HOURS_TO_MS(hour)     TIMER_MINUTES_TO_MS(hour*60)
#define TIMER_DAYS_TO_MS(day)       TIMER_HOURS_TO_MS(day*24)

// Invalid Timer Handle value
#define BLEAPPUTIL_TIMER_INVALID_HANDLE        0xFF

/*********************************************************************
 * TYPEDEFS
 */

typedef enum
{
    BLEAPPUTIL_TIMER_TIMEOUT,
    BLEAPPUTIL_TIMER_ABORTED
}BLEAppUtil_timerTermReason_e;

typedef uint8_t BLEAppUtil_timerHandle;

typedef void (*BLEAppUtil_timerCB_t)(BLEAppUtil_timerHandle timerHandle, BLEAppUtil_timerTermReason_e reason, void *pData);

/*********************************************************************
 * GLOBAL VARIABLES
 */

/*********************************************************************
 * FUNCTIONS
 */

/*********************************************************************
 * @fn      BLEAppUtil_startTimer
 *
 * @brief   Start a timer instance
 *
 * @param   timerCB     - callback function that will be called when the timer expired
 * @param   timeInMS    - the time to set in the timer
 * @param   isPeriodic  - a flag that indicates if the timer is periodic or not
 * @param   pData       - the data to pass to the timer callback
 *
 * @return  Returns the timer handle
 */
BLEAppUtil_timerHandle BLEAppUtil_startTimer(BLEAppUtil_timerCB_t timerCB, uint32_t timeInMS, bool isPeriodic, void *pData);

/*********************************************************************
 * @fn      BLEAppUtil_abortTimer
 *
 * @brief   Abort a timer instance
 *
 * @param   timerHandle - the handle of the timer to abort
 *
 * @return  None
 */
int32_t BLEAppUtil_abortTimer(BLEAppUtil_timerHandle timerHandle);

/*********************************************************************
 * @fn      BLEAppUtil_reschedulePeriodicTimer
 *
 * @brief   Restart a timer instance
 *
 * @param   timerHandle - the handle of the timer to reschedule
 * @param   timeInMS    - the new time
 * @param   pData       - the data to pass to the timer callback
 *
 * @return  None
 */
int32_t BLEAppUtil_reschedulePeriodicTimer(BLEAppUtil_timerHandle timerHandle, uint32_t time, void *pData);

/*********************************************************************
*********************************************************************/

#ifdef __cplusplus
}
#endif

#endif /* BLEAPPUTIL_TIMERS_H */