timer.h

Go to the documentation of this file.

 
#ifndef ECU_TIMER_H_
#define ECU_TIMER_H_
 
/*------------------------------------------------------------*/
/*------------------------- INCLUDES -------------------------*/
/*------------------------------------------------------------*/
 
/* STDLib. */
#include <limits.h>
#include <stdbool.h>
#include <stddef.h>
 
/* Linked list of timers. */
#include "ecu/dlist.h"
 
/*------------------------------------------------------------*/
/*---------------------- DEFINES AND MACROS ------------------*/
/*------------------------------------------------------------*/
 
#define ECU_TIMER_OBJ_UNUSED \
    ((void *)0)
 
#define ECU_TICK_MAX \
    (UINT_MAX)
 
/*------------------------------------------------------------*/
/*------------------------- TIMER TYPES ----------------------*/
/*------------------------------------------------------------*/
 
typedef unsigned int ecu_tick_t;
 
enum ecu_timer_type_e
{
    ECU_TIMER_TYPE_ONE_SHOT, 
    ECU_TIMER_TYPE_PERIODIC, 
    /********************/
    ECU_TIMER_TYPES_COUNT 
};
 
/*------------------------------------------------------------*/
/*--------------------------- TIMER --------------------------*/
/*------------------------------------------------------------*/
 
struct ecu_timer
{
    struct ecu_dnode dnode;
 
    ecu_tick_t expiration;
 
    ecu_tick_t period;
 
    enum ecu_timer_type_e type;
 
    bool (*callback)(struct ecu_timer *me, void *obj);
 
    void *obj;
};
 
struct ecu_tlist
{
    ecu_tick_t current;
 
    bool overflowed;
 
    struct ecu_dlist timers;
 
    struct ecu_dlist wraparounds;
};
 
/*------------------------------------------------------------*/
/*------------------- TIMER MEMBER FUNCTIONS -----------------*/
/*------------------------------------------------------------*/
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern void ecu_timer_ctor(struct ecu_timer *me,
                           bool (*callback)(struct ecu_timer *me, void *obj),
                           void *obj);
extern bool ecu_timer_active(const struct ecu_timer *me);
 
extern void ecu_timer_disarm(struct ecu_timer *me);
 
extern ecu_tick_t ecu_timer_period(const struct ecu_timer *me);
 
extern void ecu_timer_set(struct ecu_timer *me,
                          ecu_tick_t period,
                          enum ecu_timer_type_e type);
 
extern enum ecu_timer_type_e ecu_timer_type(const struct ecu_timer *me);
/*------------------------------------------------------------*/
/*-------------------- TLIST MEMBER FUNCTIONS ----------------*/
/*------------------------------------------------------------*/
 
extern void ecu_tlist_ctor(struct ecu_tlist *me);
extern void ecu_tlist_service(struct ecu_tlist *me, ecu_tick_t elapsed);
 
extern void ecu_tlist_timer_arm(struct ecu_tlist *me,
                                struct ecu_timer *timer,
                                ecu_tick_t period,
                                enum ecu_timer_type_e type);
 
extern void ecu_tlist_timer_rearm(struct ecu_tlist *me, struct ecu_timer *timer);
#ifdef __cplusplus
}
#endif
 
#endif /* ECU_TIMER_H_ */