File: rtf_create.3.html

package info (click to toggle)
rtlinux 3.1pre3-3
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 4,896 kB
  • ctags: 4,228
  • sloc: ansic: 26,204; sh: 2,069; makefile: 1,414; perl: 855; tcl: 489; asm: 380; cpp: 42
file content (218 lines) | stat: -rw-r--r-- 3,200 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
<HTML
><HEAD
><TITLE
>rtf_create</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.64
"></HEAD
><BODY
CLASS="REFENTRY"
><H1
><A
NAME="AEN1"
>rtf_create</A
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5"
></A
><H2
>Name</H2
>rtf_create&nbsp;--&nbsp;create a realtime fifo</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN8"
></A
><H2
>Synopsis</H2
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>       #include &#60;rtl_fifo.h&#62;

       int <TT
CLASS="FUNCTION"
>rtf_create</TT
>(unsigned int <TT
CLASS="PARAMETER"
><I
>fifo</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>size</I
></TT
>);</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN13"
></A
><H2
>DESCRIPTION</H2
><P
><TT
CLASS="FUNCTION"
>rtf_create</TT
> creates a realtime fifo (RT-FIFO) of size <TT
CLASS="PARAMETER"
><I
>size</I
></TT
> and assigns it the identifier <TT
CLASS="PARAMETER"
><I
>fifo</I
></TT
>.  <TT
CLASS="PARAMETER"
><I
>fifo</I
></TT
> is a value unique within the system, and must be less than RTF_NO.</P
><P
>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 <TT
CLASS="FUNCTION"
>read(3)</TT
>, <TT
CLASS="FUNCTION"
>write(3)</TT
>, and <TT
CLASS="FUNCTION"
>select(3)</TT
>.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN24"
></A
><H2
>RETURN VALUE</H2
><P
>On success, 0 is returned.  On failure, a negative value is returned as described below.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN27"
></A
><H2
>ERRORS</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>-ENODEV</DT
><DD
><P
><TT
CLASS="PARAMETER"
><I
>fifo</I
></TT
> is greater than or equal to RTF_NO.</P
></DD
><DT
>-EBUSY</DT
><DD
><P
><TT
CLASS="PARAMETER"
><I
>fifo</I
></TT
> is already in use.  Choose a different ID.</P
></DD
><DT
>-ENOMEM</DT
><DD
><P
><TT
CLASS="PARAMETER"
><I
>size</I
></TT
> bytes could not be allocated for the RT-FIFO.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN45"
></A
><H2
>NOTES</H2
><P
>This function should only be used in the Linux <TT
CLASS="FUNCTION"
>init_module()</TT
> context or in user space via PSC library (please see below).
RT-FIFOs created in <TT
CLASS="FUNCTION"
>init_module()</TT
> should be destroyed with <TT
CLASS="FUNCTION"
>rtf_destroy()</TT
> in <TT
CLASS="FUNCTION"
>cleanup_module</TT
>.</P
><P
><TT
CLASS="FUNCTION"
>rtf_create</TT
> is a system call made available by PSC, 
the user-level real-time signal library.  It can be called from user space,
but not from PSC handlers.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN54"
></A
><H2
>SEE ALSO</H2
><A
HREF="rtf_create_handler.3.html"
TARGET="_top"
>rtf_create_handler(3)</A
>, <A
HREF="rtf_destroy.3.html"
TARGET="_top"
>rtf_destroy(3)</A
>, <A
HREF="rtf_get.3.html"
TARGET="_top"
>rtf_get(3)</A
>, <A
HREF="rtf_put.3.html"
TARGET="_top"
>rtf_put(3)</A
><P
>1997 Jerry Epplin.</P
><P
>Modifications for RTLinux 2.x and 3.x by Michael Barabanov. 2001 FSMLabs Inc.</P
><P
>All rights reserved.</P
></DIV
></BODY
></HTML
>