File: rtf_make_user_pair.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 (100 lines) | stat: -rw-r--r-- 3,110 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
.\" 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_make_user_pair" "3" 
.SH "NAME" 
rtf_make_user_pair \(em make a pair of RT-FIFOs act like a bidirectional FIFO 
.SH "SYNOPSIS" 
.PP 
.nf 
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
#include <rtl_fifo.h> 
 
int \fBrtf_make_user_pair\fP(unsigned int \fBN\fR, unsigned int \fBP\fR);       
.fi 
.SH "DESCRIPTION" 
.PP 
\fBrtf_make_user_pair\fP modifies the behaviour of the RT-FIFO 
\fBN\fR: user-space reads of the 
\fB/dev/rtfN\fR are now routed to RT-FIFO 
\fBP\fR.  User-space writes to 
\fB/dev/rtfN\fR continue communicating with fifo 
\fBN\fR. This essentially makes 
\fB/dev/rtfN\fR bidirectional: data sent with 
\fBrtf_put\fP to FIFO \fBP\fR will be read from 
\fB/dev/rtfN\fR; rtf_get on FIFO \fBN\fR gets 
data written to \fB/dev/rtfN\fR. 
RT-FIFO handlers are affected similarly. 
.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 
This function returns 0 on success and a negative error code on error. 
.SH "ERRORS" 
.IP "-ENODEV" 10 
\fBN\fR or \fBP\fR is greater than or equal to RTF_NO. 
.IP "-EINVAL" 10 
\fBN\fR or \fBP\fR is not a valid RT-FIFO identifier. 
.SH "NOTES" 
.PP 
This function is useful when implementing Linux character device drivers on 
top of RT-FIFOs. 
.SH "SEE ALSO" 
\fIread(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, \fIrtf_link_user_ioctl(3) (link to URL rtf_link_user_ioctl.3.html) \fR, \fIwrite(2) (link to URL ../susv2/xns/write.html) \fR 
.PP 
\(co2001 FSMLabs Inc. 
.PP 
All rights reserved. 
...\" created by instant / docbook-to-man, Wed 13 Jun 2001, 17:58