File: rt_task_init.3

package info (click to toggle)
rtlinux 3.1pre3-2
  • links: PTS
  • area: non-free
  • in suites: sarge, woody
  • size: 4,892 kB
  • ctags: 4,228
  • sloc: ansic: 26,204; sh: 2,069; makefile: 1,414; perl: 855; tcl: 489; asm: 380; cpp: 42
file content (105 lines) | stat: -rw-r--r-- 3,464 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
.\" This -*- nroff -*- file has been generated from
.\" DocBook SGML with docbook-to-man on Debian GNU/Linux.
...\"
...\"	transcript compatibility for postscript use.
...\"
...\"	synopsis:  .P! <file.ps>
...\"
.de P!
\\&.
.fl			\" force out current output buffer
\\!%PB
\\!/showpage{}def
...\" the following is from Ken Flowers -- it prevents dictionary overflows
\\!/tempdict 200 dict def tempdict begin
.fl			\" prolog
.sy cat \\$1\" bring in postscript file
...\" the following line matches the tempdict above
\\!end % tempdict %
\\!PE
\\!.
.sp \\$2u	\" move below the image
..
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t 
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n  
.TH "rt_task_init" "2" 
.SH "NAME" 
rt_task_init \(em create a realtime task 
.SH "SYNOPSIS" 
.PP 
.nf 
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
\fIWARNING\fP -- 
This is an RTLinux v1.x compatibility function. 
For new programs, please see \fBpthread_create(3)\fP. 
 
#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 \fBrt_task_init\fP(RT_TASK *\fBtask\fR, void (*fn)(int \fBdata\fR), int \fBdata\fR, int \fBstack_size\fR, int \fBpriority\fR); 
.fi 
.SH "WARNING" 
.PP 
This is an RTLinux v1.x compatibility function. 
For new programs, please see \fBpthread_create(3)\fP. 
.SH "DESCRIPTION" 
.PP 
\fBrt_task_init\fP creates a realtime task.  \fBtask\fR is a structure the space for which must be provided by the application.  \fBtask\fR must be present during the lifetime of the realtime task;  thus it cannot be an automatic variable.  \fBfn\fR is the entry point of the new task.  The parent task can send a one-integer  value  data  to  the  new task.  \fBstack_size\fR is the size of the stack to be used by the  new task,  and  \fBpriority\fR is the priority to be given the task. The highest priority is 1, while  the  lowest  is  \fBRT_LOWEST_PRIORITY\fR. 
.PP 
The newly created real-time task is initially dormant.  It is normally made active by a  call  to  \fBrt_task_make_periodic\fP. 
.SH "RETURN VALUE" 
.PP 
On  success,  0 is returned.  On failure, a negative value is returned as described below. 
.SH "ERRORS" 
.IP "-EINVAL" 10 
\fBtask\fR is already in use by another task. 
.IP "-ENOMEM" 10 
space could not be allocated for the realtime task. 
.SH "AUTHOR" 
.PP 
Jerry Epplin, modified by Michael Barabanov (\fIbaraban@fsmlabs.com (link to URL mailto:baraban@fs mlabs.com) \fR) 
.SH "SEE ALSO" 
\fIrt_task_delete(3) (link to URL rt_task_delete.3.html) \fR, \fIrt_task_make_periodic(3) (link to URL rt_task_make_periodic.3.html) \fR, \fIrt_task_suspend(3) (link to URL rt_task_suspend.3.html) \fR, \fIrt_task_wait(3) (link to URL rt_task_wait.3.html) \fR, \fIpthread_create(3) (link to URL pthread_create.3.html) \fR 
.PP 
\(co1997 Jerry Epplin. 
.PP 
Modifications for RTLinux 2.x and 3.x by Michael Barabanov. \(co2001 FSMLabs Inc. 
.PP 
All rights reserved. 
...\" created by instant / docbook-to-man, Wed 13 Jun 2001, 17:57