timer functions More...

Data Structures
struct	TIMERS
	user timer struct More...

Macros
#define	MAX_TIMER_CNT 8
	Number of user timer tasks. More...

#define	SYSTEM_TASK_TIC_NS ( 1000000000L / SYSTEM_TASK_HZ )
	System task in HZ. More...

#define	SYSTEM_TASK_TIC_US ( 1000000L / SYSTEM_TASK_HZ )
	System task in Microseconds. More...

#define	CLOCK_HZ SYSTEM_TASK_HZ
	Clock task in HZ defined as System task. More...

#define	CLOCK_TIC_NS SYSTEM_TASK_TIC_NS
	Clock task in Nanoseconds defined as System Task. More...

#define	CLOCK_TIC_US SYSTEM_TASK_TIC_US
	CLock task in Microseconds defined as System Task. More...

Typedefs
typedef uint16_t	clockid_t
	type of clockid_t. More...

Functions
MEMSPACE int	set_timers (void(*handler)(void), int timer)

MEMSPACE int	kill_timer (int timer)
	Delete "Kill" one user timer task. More...

MEMSPACE void	delete_all_timers (void)
	Clear ALL user timer tasks. More...

MEMSPACE void	subtract_timespec (ts_t a, ts_t b)
	subtract a-= b timespec * structures. More...

MEMSPACE char *	ts_to_str (ts_t *val)

MEMSPACE void	display_ts (ts_t *val)
	timespec structure in seconds.nanoseconds. More...

MEMSPACE void	clock_elapsed_begin (void)
	Store current struct timespec in __clock_elapsed. More...

MEMSPACE void	clock_elapsed_end (char *msg)
	Subtract and display time difference from clock_elapesed_begin(). More...

MEMSPACE void	clock_clear (void)
	clear time and timezone to 0. More...

MEMSPACE void	disable_timers (void)
	Disable all timer tasks. More...

MEMSPACE void	enable_timers (void)
	Enable timer tasks. More...

void	execute_timers (void)
	Execute all user timers at SYSTEM_HZ rate. Called by system task. More...

MEMSPACE void	clock_init (void)

void	clock_task (void)
	1000HZ timer task More...

MEMSPACE void	init_timers (void)
	Setup all timers tasksi and enable interrupts. More...

MEMSPACE int	clock_getres (clockid_t clk_id, struct timespec *res)

MEMSPACE int	clock_settime (clockid_t clk_id, const struct timespec *ts)

MEMSPACE int	clock_gettime (clockid_t clk_id, struct timespec *ts)

MEMSPACE void	disable_system_task (void)

MEMSPACE void	enable_system_task (void)

MEMSPACE void	install_timers_isr (void)

Detailed Description

timer functions

Copyright © 2015 Mike Gore, GPL License

You are free to use this code under the terms of GPL: please retain a copy of this notice in any code you use it in.

This 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.

This software 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 this program. If not, see http://www.gnu.org/licenses/.

Definition in file timer.h.

Macro Definition Documentation

◆ CLOCK_HZ

#define CLOCK_HZ SYSTEM_TASK_HZ

Clock task in HZ defined as System task.

Definition at line 52 of file timer.h.

◆ CLOCK_TIC_NS

#define CLOCK_TIC_NS SYSTEM_TASK_TIC_NS

Clock task in Nanoseconds defined as System Task.

Definition at line 54 of file timer.h.

◆ CLOCK_TIC_US

#define CLOCK_TIC_US SYSTEM_TASK_TIC_US

CLock task in Microseconds defined as System Task.

Definition at line 56 of file timer.h.

◆ MAX_TIMER_CNT

#define MAX_TIMER_CNT 8

Number of user timer tasks.

Definition at line 29 of file timer.h.

◆ SYSTEM_TASK_TIC_NS

#define SYSTEM_TASK_TIC_NS ( 1000000000L / SYSTEM_TASK_HZ )

System task in HZ.

System task in Nanoseconds.

Definition at line 47 of file timer.h.

◆ SYSTEM_TASK_TIC_US

#define SYSTEM_TASK_TIC_US ( 1000000L / SYSTEM_TASK_HZ )

System task in Microseconds.

Definition at line 49 of file timer.h.

Typedef Documentation

◆ clockid_t

typedef uint16_t clockid_t

type of clockid_t.

Definition at line 32 of file timer.h.

Function Documentation

◆ clock_clear()

MEMSPACE void clock_clear ( )

clear time and timezone to 0.

See also: clock_settime().; settimezone().

Returns: void.

Definition at line 222 of file timer.c.

Referenced by init_timers(), and main().

◆ clock_elapsed_begin()

MEMSPACE void clock_elapsed_begin ( )

Store current struct timespec in __clock_elapsed.

See also: clock_gettime() POSIX function.

Returns: void

Definition at line 184 of file timer.c.

Referenced by gpib_timer_elapsed_begin().

◆ clock_elapsed_end()

MEMSPACE void clock_elapsed_end ( char * msg )

Subtract and display time difference from clock_elapesed_begin().

Notes: Accuracy is a function of timer resolution, CPU overhead and background tasks.

Parameters

[in] msg User message to proceed Time display.

Returns: void

See also: clock_gettime().; clock_elapesed_begin().

Definition at line 200 of file timer.c.

Referenced by gpib_timer_elapsed_end().

◆ clock_getres()

MEMSPACE int clock_getres	(	clockid_t	clk_id,
		struct timespec *	res
	)

◆ clock_gettime()

MEMSPACE int clock_gettime	(	clockid_t	clk_id,
		struct timespec *	ts
	)

◆ clock_init()

MEMSPACE void clock_init ( void )

◆ clock_settime()

MEMSPACE int clock_settime	(	clockid_t	clk_id,
		const struct timespec *	ts
	)

◆ clock_task()

void clock_task ( void )

1000HZ timer task

Returns: void

Definition at line 281 of file timer.c.

Referenced by init_timers().

◆ delete_all_timers()

MEMSPACE void delete_all_timers ( )

Clear ALL user timer tasks.

Returns: void

Definition at line 116 of file timer.c.

Referenced by init_timers().

◆ disable_system_task()

MEMSPACE void disable_system_task ( void )

Referenced by disable_timers().

◆ disable_timers()

MEMSPACE void disable_timers ( )

Disable all timer tasks.

Returns: void

Definition at line 237 of file timer.c.

◆ display_ts()

MEMSPACE void display_ts ( ts_t * val )

timespec structure in seconds.nanoseconds.

Parameters

[in] val timespec struct we want to display.

Returns: void.

Definition at line 167 of file timer.c.

◆ enable_system_task()

MEMSPACE void enable_system_task ( void )

Referenced by enable_timers().

◆ enable_timers()

MEMSPACE void enable_timers ( )

Enable timer tasks.

Returns: void

Definition at line 251 of file timer.c.

Referenced by init_timers().

◆ execute_timers()

void execute_timers ( )

Execute all user timers at SYSTEM_HZ rate. Called by system task.

Returns: void

Definition at line 265 of file timer.c.

◆ init_timers()

MEMSPACE void init_timers ( )

Setup all timers tasksi and enable interrupts.

See also: clock_task(); : timer_hal.c for hardware dependent interface

Returns: void

See time.c

Definition at line 299 of file timer.c.

Referenced by main().

◆ install_timers_isr()

MEMSPACE void install_timers_isr ( void )

Referenced by init_timers().

◆ kill_timer()

MEMSPACE int kill_timer ( int timer )

Delete "Kill" one user timer task.

"kill" is a common Linux term for ending a process.

Parameters

[in] timer user timer task index.

Returns: timer on success.; -1 on error.

Definition at line 99 of file timer.c.

◆ set_timers()

MEMSPACE int set_timers	(	void(*)(void)	handler,
		int	timer
	)

◆ subtract_timespec()

MEMSPACE void subtract_timespec	(	ts_t *	a,
		ts_t *	b
	)

subtract a-= b timespec * structures.

Parameters

[in]	a	timespec struct.
[in]	b	timespec struct.

Returns: void.

Definition at line 134 of file timer.c.

Referenced by clock_elapsed_end().

◆ ts_to_str()

MEMSPACE char* ts_to_str ( ts_t * val )

Definition at line 154 of file timer.c.

Referenced by clock_elapsed_end(), and display_ts().

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ CLOCK_HZ

◆ CLOCK_TIC_NS

◆ CLOCK_TIC_US

◆ MAX_TIMER_CNT

◆ SYSTEM_TASK_TIC_NS

◆ SYSTEM_TASK_TIC_US

Typedef Documentation

◆ clockid_t

Function Documentation

◆ clock_clear()

◆ clock_elapsed_begin()

◆ clock_elapsed_end()

◆ clock_getres()

◆ clock_gettime()

◆ clock_init()

◆ clock_settime()

◆ clock_task()

◆ delete_all_timers()

◆ disable_system_task()

◆ disable_timers()

◆ display_ts()

◆ enable_system_task()

◆ enable_timers()

◆ execute_timers()

◆ init_timers()

◆ install_timers_isr()

◆ kill_timer()

◆ set_timers()

◆ subtract_timespec()

◆ ts_to_str()