rt_task_make_periodic

Name

rt_task_make_periodic -- mark a realtime task for execution.

Synopsis

       WARNING -- 
       This is an RTLinux v1.x compatibility function.
	For new programs, please see pthread_make_periodic_np(3).

       #define MODULE
       #include <linux/module.h>
       #include <linux/kernel.h>
       #include <linux/version.h>
       #include <linux/errno.h>
       #include <linux/rtf.h>
       #include <asm/rt_irq.h>

       int rt_task_make_periodic(RT_TASK *task, RTIME start_time, RTIME period);

WARNING

This is an RTLinux v1.x compatibility function. For new programs, please see pthread_make_periodic_np(3).

DESCRIPTION

rt_task_make_periodic marks a task, previously created with a call to rt_task_init, as ready for execution. The task will run at intervals specified by period; i.e., it will be marked for execution every period realtime clock ticks. The desired start time is specified by start_time; the first execution of the task will occur start_time clock ticks from the current time. If immediate execution is desired, the return value of rt_get_time can be used for start_time.

RETURN VALUE

On success, 0 is returned. On failure, a negative value is returned as described below.

ERRORS

-EINVAL: task does not refer to a valid RT_TASK structure.

AUTHOR

Jerry Epplin, modified by Michael Barabanov (baraban@fsmlabs.com)