stimer.h

Go to the documentation of this file.

/*********************************************************************************************************
*                                               BRTOS
*                                Brazilian Real-Time Operating System
*                            Acronymous of Basic Real-Time Operating System
*
*                              
*                                  Open Source RTOS under MIT License
*
*
*
*                                     OS Soft Timers functions
*
*
*   Authors:  Carlos Henrique Barriquelo
*   Revision: 1.0
*   Date:     12/01/2013
*********************************************************************************************************/


/*****************************************************************/
/*                          OS SOFT TIMER                        */
/*****************************************************************/
#ifndef TIMERS_H
#define TIMERS_H

#include "OS_types.h"
#include "BRTOSConfig.h"
#include "BRTOS.h"

#ifdef BRTOS_TMR_EN 
#if (BRTOS_TMR_EN == 1)

#define BRTOS_MAX_TIMER_DEFAULT        8
#ifndef BRTOS_MAX_TIMER  
  #define BRTOS_MAX_TIMER BRTOS_MAX_TIMER_DEFAULT
#endif

/* config defines */ 
// do not change, unless we know what are you doing
#define TIMER_CNT             ostick_t
#define TIMER_MAX_COUNTER     (TIMER_CNT)(TICK_COUNT_OVERFLOW-1)   

/* typedefs for callback struct */  
typedef TIMER_CNT (*FCN_CALLBACK) (void);  

/* soft timer possible states:
*/
typedef enum
{
  TIMER_NOT_ALLOCATED = 0,
  TIMER_NOT_USED = 1,
  TIMER_STOPPED = 2,
  TIMER_RUNNING = 3,
  TIMER_SEARCH = 4,
} TIMER_STATE;

/* soft timer data struct
*/
typedef struct BRTOS_TIMER_S 
{
      FCN_CALLBACK       func_cb;
      TIMER_CNT          timeout;
      TIMER_STATE        state;
} BRTOS_TIMER_T;

/* soft timer typedef
*/
typedef  BRTOS_TIMER_T*  BRTOS_TIMER; 

/* soft timers list data struct 
*/

typedef struct
{    
    BRTOS_TIMER timers [BRTOS_MAX_TIMER];
    int8_t      count;
}BRTOS_TMR_T;


/* TIMER TASK prototype */  
#if (TASK_WITH_PARAMETERS == 1)
void BRTOSTimerTask(void *param);
#else
void BRTOSTimerTask(void);
#endif
 
/************* public API *********************/ 
void OSTimerInit(uint16_t timertask_stacksize, uint8_t prio);
uint8_t OSTimerSet (BRTOS_TIMER *cbp, FCN_CALLBACK cb, TIMER_CNT timeout);
TIMER_CNT OSTimerGet (BRTOS_TIMER p);
uint8_t OSTimerStart (BRTOS_TIMER p, TIMER_CNT timeout);  
uint8_t OSTimerStop (BRTOS_TIMER p, uint8_t del); 

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


#endif
#endif
/*****************************************************************/
/*                          OS SOFT TIMER EOF                    */
/*****************************************************************/

#endif