rkhtmr.h

Go to the documentation of this file.

/*
 *  --------------------------------------------------------------------------
 *
 *                                Framework RKH
 *                                -------------
 *
 *            State-machine framework for reactive embedded systems
 *
 *                      Copyright (C) 2010 Leandro Francucci.
 *          All rights reserved. Protected by international copyright laws.
 *
 *
 *  RKH is free software: you can redistribute it and/or modify it under the
 *  terms of the GNU General Public License as published by the Free Software
 *  Foundation, either version 3 of the License, or (at your option) any
 *  later version.
 *
 *  RKH is distributed in the hope that it will be useful, but WITHOUT ANY
 *  WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 *  more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with RKH, see copying.txt file.
 *
 *  Contact information:
 *  RKH web site:   http://sourceforge.net/projects/rkh-reactivesys/
 *  e-mail:         francuccilea@gmail.com
 *  ---------------------------------------------------------------------------
 */

/* -------------------------- Development history -------------------------- */
/*
 *  2015.10.24  LeFr  v2.4.05  Initial version
 */

/* -------------------------------- Authors -------------------------------- */
/*
 *  LeFr  Leandro Francucci  francuccilea@gmail.com
 */

/* --------------------------------- Notes --------------------------------- */
/* --------------------------------- Module -------------------------------- */
#ifndef __RKHTMR_H__
#define __RKHTMR_H__

/* ----------------------------- Include files ----------------------------- */
#include "rkhitl.h"

/* ---------------------- External C language linkage ---------------------- */
#ifdef __cplusplus
extern "C" {
#endif

/* --------------------------------- Macros -------------------------------- */
#if defined(RKH_USE_TRC_SENDER)

    #define RKH_TIM_TICK(_sender)     rkh_tmr_tick(_sender)
#else
    #define RKH_TIM_TICK(dummy_)      rkh_tmr_tick()
#endif

#if RKH_CFG_TMR_HOOK_EN == RKH_ENABLED
    #define RKH_TMR_INIT(t_, e_, th_) \
        rkh_tmr_init_((t_), (e_), (th_))
#else
    #define RKH_TMR_INIT(t_, e_, th_) \
        rkh_tmr_init_((t_), (e_))
#endif

#define RKH_TMR_ONESHOT(t, sma, itick) \
    (t)->period = 0; \
    rkh_tmr_start(t, sma, itick)

#define RKH_TMR_PERIODIC(t, sma, itick, per) \
    (t)->period = (per); \
    rkh_tmr_start((t), (sma), (itick))

/* -------------------------------- Constants ------------------------------ */
/* ------------------------------- Data types ------------------------------ */
typedef void (*RKH_THK_T)(void *t);

#if RKH_CFG_TMR_SIZEOF_NTIMER == 8
typedef rui8_t RKH_TNT_T;
#elif RKH_CFG_TMR_SIZEOF_NTIMER == 16
typedef rui16_t RKH_TNT_T;
#elif RKH_CFG_TMR_SIZEOF_NTIMER == 32
typedef rui32_t RKH_TNT_T;
#else
typedef rui8_t RKH_TNT_T;
#endif

typedef struct RKH_TINFO_T
{
    rui16_t nexp;       
    rui16_t nstart;     
    rui16_t nstop;      
} RKH_TINFO_T;

typedef struct RKH_TMR_T RKH_TMR_T;

struct RKH_TMR_T
{
    RKH_EVT_T *evt;

    RKH_TMR_T *tnext;

    const struct RKH_SMA_T *sma;

    RKH_TNT_T ntick;

    RKH_TNT_T period;

    rui8_t used;

#if RKH_CFG_TMR_HOOK_EN == RKH_ENABLED
    RKH_THK_T timhk;
#endif

#if RKH_CFG_TMR_GET_INFO_EN == RKH_ENABLED
    RKH_TINFO_T info;
#endif
};

/* -------------------------- External variables --------------------------- */
/* -------------------------- Function prototypes -------------------------- */
#if RKH_CFG_TMR_HOOK_EN == RKH_ENABLED

    void rkh_tmr_init_(RKH_TMR_T *t, const RKH_EVT_T *e, RKH_THK_T thk);
#else
    void rkh_tmr_init_(RKH_TMR_T *t, const RKH_EVT_T *e);
#endif

void rkh_tmr_start(RKH_TMR_T *t,   const struct RKH_SMA_T *sma,
                   RKH_TNT_T itick);

void rkh_tmr_stop(RKH_TMR_T *t);

void rkh_tmr_get_info(RKH_TMR_T *t, RKH_TINFO_T *info);

void rkh_tmr_clear_info(RKH_TMR_T *t);

#if defined(RKH_USE_TRC_SENDER)

void rkh_tmr_tick(const void *const sender);
#else
void rkh_tmr_tick(void);
#endif

/* -------------------- External C language linkage end -------------------- */
#ifdef __cplusplus
}
#endif

/* ------------------------------ Module end ------------------------------- */
#endif

/* ------------------------------ End of file ------------------------------ */