timer.h File Reference

timer support function More...

Data Structures
struct	timeval
struct	T_TimeOutTimer
struct	T_SchedulerRecord

Macros
#define	RES_USECONDS   1 /* mikro seconds */
#define	RES_10USECONDS   10 /* 10 mikro seconds */
#define	RES_100USECONDS   100 /* 100 mikro seconds */
#define	RES_MSECONDS   1000 /* milli seconds */
#define	RES_10MSECONDS   10000 /* 10 milli seconds */
#define	RES_100MSECONDS   100000 /* 100 milli seconds */
#define	RES_SECONDS   1000000 /* seconds */
#define	GetTimeStamp()    RecentEpoch
#define	TR_CONTROL_ACTIVE   0x0001
#define	TIMER_RANGE_ERROR_STRING   TimerMessages[0]
#define	TIMER_NOT_RUNNING   TimerMessages[1]

Typedefs
typedef void(*	T_TimerEventHandler) (uint32_t *)

Functions
time_t	GetSystemTimerRes (void)
FUNC_RETURN	ResetTimeOutTimer (T_TimeOutTimer *tot, char symbol, time_t period, char *text)
int	tv_elapsed (timeval *t, time_t s, time_t u, uint16_t retrigger)
	check if given time has elapsed More...
void	tv_interval (timeval *e, timeval *t1, timeval *t2)
	compute elapsed time More...
void	SetupSystemTime (int32_t cpuint, int port, time_t resolution)
	Setup System Time. More...
void	StartSystemTimer (void)
	start system timer More...
void	StopSystemTimer (void)
	stop system timer More...
void	RegisterTimerEvent (T_TimerEventHandler EventHandlerFunc, time_t sec, time_t usec)
	register a new timer event More...

Variables
timeval	RecentEpoch
const char *	TimerMessages []
	TIMER_HANDLER_INTERRUPT
	timer interrupt function More...

Detailed Description

                          _         _             _
                       __| |    ___(_) ____ _ __ | |_
                      / _` |   / __| |/ _` | '_ \| __|
                     | (_| | _ \__ \ | (_| | | | | |_
                      \__,_|(_) ___/_|\__, |_| |_|\__|
                     Signalprocessing |___/ Technology

Author

D.SignT GmbH & Co. KG, Claus Hermbusche

Version

2.91

Date

2019-04-17

Macro Definition Documentation

#define RES_USECONDS   1 /* mikro seconds */

#define RES_10USECONDS   10 /* 10 mikro seconds */

#define RES_100USECONDS   100 /* 100 mikro seconds */

#define RES_MSECONDS   1000 /* milli seconds */

Examples:

Blocksend.c, Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SNTPTest.c, and Telnet.c.

#define RES_10MSECONDS   10000 /* 10 milli seconds */

Examples:

SMTP.c.

#define RES_100MSECONDS   100000 /* 100 milli seconds */

#define RES_SECONDS   1000000 /* seconds */

Examples:

Blocksend.c, Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, SNTPTest.c, and Telnet.c.

#define GetTimeStamp

(

)

RecentEpoch

Examples:

Blocksend.c, Chat.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, and Telnet.c.

#define TR_CONTROL_ACTIVE   0x0001

#define TIMER_RANGE_ERROR_STRING   TimerMessages[0]

Examples:

BoardSpecific.c.

#define TIMER_NOT_RUNNING   TimerMessages[1]

Typedef Documentation

typedef void(* T_TimerEventHandler) (uint32_t *)

Function Documentation

time_t GetSystemTimerRes

(

void

)

Examples:

Blocksend.c, Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, SNTPTest.c, and Telnet.c.

{
    return (usec_inc);
}

FUNC_RETURN ResetTimeOutTimer	(	T_TimeOutTimer *	tot,
		char	symbol,
		time_t	period,
		char *	text
	)

Examples:

SMTP.c.

{
    /***************************************************************************
     assign initialization parameters
    ***************************************************************************/
    tot-> Symbol = symbol;
    tot-> Period = period;
    tot-> Text   = text;
    if ((text!=NULL) && *text)
        tot-> Length = strlen(text)-1;
    else
        tot-> Length = 0;

    /***************************************************************************
     limit text length
    ***************************************************************************/
    if (tot-> Length < CPRINTF_PROGRESS_COL)
    {
        tot-> Length = CPRINTF_PROGRESS_COL - tot-> Length;
    }
    else
    {
        tot-> Length = CPRINTF_PROGRESS_COL;
    }

    /***************************************************************************
     reset time stamp
    ***************************************************************************/
    tot-> Timer  = GetTimeStamp();
    return(FR_OK);
}

int tv_elapsed	(	timeval *	t,
		time_t	s,
		time_t	u,
		uint16_t	retrigger
	)

Use this function to determine if a certain period of time has elapsed since a given time stamp. The desired time period can be specified in micro second or seconds or a combination of both.

Parameters

t	- timestamp
s	- seconds
u	- micro seconds
retrigger	- if true (1) timeval *t is updated to current time stamp

Returns

TRUE - time elapsed

FALSE - time not elapsed

Examples:

Blocksend.c, Ping2.c, SMTP.c, and SNTPTest.c.

{
    /***************************************************************************
      locals
    ***************************************************************************/
    timeval e;
    time_t sec = s + (u/1000000);
    time_t usec = u - ((u/1000000)*1000000);

    if ( SystemTimerRunning == 0 )
    {
        prg_exit (TIMER_NOT_RUNNING);
    } // if

    /***************************************************************************
     tv_interval() requires RecentEpoch > t. If the RecentEpoch was modified
     (e.g. by NTP service or manual setting), prevent tv_interval() being called
     and return TRUE to force update
    ***************************************************************************/
    if ( RecentEpoch.tv_sec < t->tv_sec )
    {
        if (retrigger) *t = RecentEpoch;
        return (TRUE);
    } // if

    tv_interval (&e, t, &RecentEpoch);

    if ( ( e.tv_sec >= sec ) && (e.tv_usec >= usec) )
    {
        if (retrigger) *t = RecentEpoch;
        return (TRUE);
    } // if

    return (FALSE);
}

void tv_interval	(	timeval *	e,
		timeval *	t1,
		timeval *	t2
	)

tv_interval() computes the elapsed time between two time values. All time values have micro seconds resolution. A carry-over is taken into account.

Parameters

e	- elapsed time [OUT]
t1	- start time [IN]
t2	- end time [IN]

Returns

-

Note

precondition t2 > t1

Examples:

Blocksend.c, Chat.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, and Telnet.c.

{
    /***************************************************************************
      locals
    ***************************************************************************/
    time_t t;
    time_t carry = (time_t)0;

    /***************************************************************************
      compute seconds
    ***************************************************************************/
    t= t2->tv_sec - t1->tv_sec;

    /***************************************************************************
      check for carry
    ***************************************************************************/
    if ( t2->tv_usec < t1->tv_usec )
    {
        /***********************************************************************
          correct seconds, carry micro seconds
        ***********************************************************************/
        t--;
        carry = 1000000;
    }

    /***************************************************************************
      write back seconds
    ***************************************************************************/
    e->tv_sec = t;

    /***************************************************************************
      build time difference in micro seconds
    ***************************************************************************/
    t = carry + t2->tv_usec-t1->tv_usec;

    /***************************************************************************
      write back micro seconds
    ***************************************************************************/
    e->tv_usec = t;

}

void SetupSystemTime	(	int32_t	cpuint,
		int	port,
		time_t	resolution
	)

The system time in this application starts at compile date (see BUILD_XXX macros). For higher precision time use NTP protocol or a Real Time Clock.

Parameters

cpuint	- cpu interrupt to use
port	- timer to use
resolution	- timer resolution

Returns

-

Examples:

Blocksend.c, Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, SNTPTest.c, and Telnet.c.

{
    /***************************************************************************
      locals
    ***************************************************************************/
    struct tm *local_time;          /* structure to hold time and date        */

    /***************************************************************************
      range checking
    ***************************************************************************/
    if ( resolution > RES_SECONDS )
    {
        prg_exit (TIMER_RANGE_ERROR_STRING);
    } // if

    /***************************************************************************
      save desired resolution
    ***************************************************************************/
    usec_inc = resolution;

    /***************************************************************************
     initialize local time (use BUILD_ macros from Common.h)
    ***************************************************************************/
    local_time = localtime (NULL);
    local_time->tm_year = BUILD_YEAR-1900;
    local_time->tm_mon = BUILD_MONTH-1;
    local_time->tm_mday = BUILD_DAY;
    local_time->tm_hour = BUILD_HOUR;
    local_time->tm_min = BUILD_MINUTE;
    local_time->tm_sec = BUILD_SECOND;
    RecentEpoch.tv_sec = mktime (local_time);
    local_time = localtime ((const time_t *)&RecentEpoch);

    /***************************************************************************
      initialize Timer to desired clock period
    ***************************************************************************/
    if (BoardInitializeTimer (TimerClock, port, usec_inc))
    {
        prg_exit (TIMER_RANGE_ERROR_STRING);
    }

    /***************************************************************************
     plug in interrupt handler
    ***************************************************************************/
    BoardPlugTimerHandler (cpuint, port, TIMER_HANDLER_FUNCTION);
}

void StartSystemTimer

(

void

)

Parameters

-

Returns

-

Examples:

Blocksend.c, Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, SNTPTest.c, and Telnet.c.

{
    BoardStartTimer (SYSTEM_TIMER);
    SystemTimerRunning = 1;
}

void StopSystemTimer

(

void

)

Parameters

-

Returns

-

Examples:

BoardSpecific.c.

{
    BoardStopTimer (SYSTEM_TIMER);
    SystemTimerRunning = 0;
}

void RegisterTimerEvent	(	T_TimerEventHandler	EventHandlerFunc,
		time_t	sec,
		time_t	usec
	)

Parameters

EventHandlerFunc	- event handler callback function
sec	- seconds the timer is fired
usec	- micro seconds the timer is fired

{
    /***************************************************************************
     locals
    ***************************************************************************/
    T_SchedulerRecord *pNewRecord, *pActiveRecord;

    /***************************************************************************
     Create a new task record
    ***************************************************************************/
    pNewRecord = (T_SchedulerRecord *)calloc(1,sizeof(T_SchedulerRecord));
    if(pNewRecord != NULL)
    {
        pNewRecord->id = ++gTaskId;        /* assign unique ID                */
        pNewRecord->sec = sec;             /* seconds to fire the timer       */
        pNewRecord->usec = usec;           /* micro seconds to fire the timer */
        pNewRecord->control = TR_CONTROL_ACTIVE; /* switch event to active    */

        /***********************************************************************
         Assign the event handler function to the task
        ***********************************************************************/
        pNewRecord->EventHandler = EventHandlerFunc;

        if(gpSchedulerHead == NULL)
        {
            /*******************************************************************
             first record in the event list
            *******************************************************************/
            gpSchedulerHead = pNewRecord;
        }
        else
        {
            /*******************************************************************
             Move to the last event in the list
            *******************************************************************/
            pActiveRecord = gpSchedulerHead;
            while(pActiveRecord->pNext != NULL)
            {
                pActiveRecord = pActiveRecord->pNext;
            }

            /*******************************************************************
             Append the new event to the end of the list
            *******************************************************************/
            pActiveRecord->pNext = pNewRecord;
        }
    }
}

Variable Documentation

timeval RecentEpoch

Examples:

Send.c, SMTP.c, SNTPTest.c, and Telnet.c.

const char* TimerMessages[]

TIMER_HANDLER_INTERRUPT

Parameters

-

Returns

nothing

Note

uses global variable RecentEpoch