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
|
.\" 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 "rtf_put" "3"
.SH "NAME"
rtf_put \(em write data to a realtime fifo
.SH "SYNOPSIS"
.PP
.nf
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
#include <rtl_fifo.h>
int \fBrtf_put\fP(unsigned int \fBfifo\fR, char * \fBbuf\fR, int \fBcount\fR);
.fi
.SH "DESCRIPTION"
.PP
\fBrtf_put\fP writes a block of data to a realtime fifo (RT-FIFO) previously created with a call to \fBrtf_create(3)\fP. \fBfifo\fR is the ID with which the RT-FIFO was created. \fBbuf\fR is the block of data to be filled with the received bytes, while \fBcount\fR is the size of the block in bytes. This mechanism is available only to realtime tasks; Linux processes use a \fBwrite(2)\fP to the corresponding fifo device to enqueue data to a fifo. Similarly, Linux processes use \fBread(2)\fP or similar functions to read the data previously written via \fBrtf_put\fP by a realtime task.
.PP
The RT-FIFO is a mechanism, implemented as a character device, to communicate between realtime tasks and ordinary Linux processes. The rtf_* functions are used by the realtime tasks; Linux processes use standard character device access functions such as \fBread(2)\fP, \fBwrite(2\fP) and \fBselect(2)\fP.
.SH "RETURN VALUE"
.PP
On success, \fBcount\fR is returned. On failure, a
negative value is returned as described below.
.SH "ERRORS"
.IP "-ENODEV" 10
\fBfifo\fR is greater than or equal to RTF_NO.
.IP "-EINVAL" 10
\fBfifo\fR is not a valid RT-FIFO identifier.
.IP "-ENOSPC" 10
insufficient space is available in the RT-FIFO for \fBcount\fR bytes.
.SH "Notes"
.PP
\fBrtf_put\fP is available in PSC, the user-level
real-time signal library. It can be called from handlers installed via
\fIrtlinux_sigaction(3) (link to URL rtlinux_sigaction.3.html) \fR.
.SH "SEE ALSO"
\fIUNIX spec read(2) (link to URL ../susv2/xns/read.html) \fR, \fIrtf_create(3) (link to URL rtf_create.3.html) \fR, \fIrtf_create_handler(3) (link to URL rtf_create_handler.3.html) \fR, \fIrtf_destroy(3) (link to URL rtf_destroy.3.html) \fR, \fIrtf_get(3) (link to URL rtf_get.3.html) \fR, \fIUNIX spec write(2) (link to URL ../susv2/xns/write.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:58
|
