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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
|
.. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 2015 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
.. generated. If you find something that needs to be fixed or
.. worded better please post a report or patch to an RTEMS mailing list
.. or raise a bug report:
..
.. https://www.rtems.org/bugs.html
..
.. For information on updating and regenerating please refer to the How-To
.. section in the Software Requirements Engineering chapter of the
.. RTEMS Software Engineering manual. The manual is provided as a part of
.. a release. For development sources please refer to the online
.. documentation at:
..
.. https://docs.rtems.org
.. _KernelCharacterIOSupportDirectives:
Directives
==========
This section details the directives of the Kernel Character I/O Support. A
subsection is dedicated to each of this manager's directives and lists the
calling sequence, parameters, description, return values, and notes of the
directive.
.. Generated from spec:/rtems/io/if/putc
.. raw:: latex
\clearpage
.. index:: rtems_putc()
.. _InterfaceRtemsPutc:
rtems_putc()
------------
Outputs the character to the kernel character output device.
.. rubric:: CALLING SEQUENCE:
.. code-block:: c
void rtems_putc( char c );
.. rubric:: PARAMETERS:
``c``
This parameter is the character to output.
.. rubric:: DESCRIPTION:
The directive outputs the character specified by ``c`` to the kernel character
output device using the polled character output implementation provided by
BSP_output_char. The directive performs a character translation from ``NL`` to
``CR`` followed by ``NR``.
If the kernel character output device is concurrently accessed, then
interleaved output may occur.
.. rubric:: CONSTRAINTS:
The following constraints apply to this directive:
* The directive may be called from within any runtime context.
* The directive will not cause the calling task to be preempted.
.. Generated from spec:/rtems/io/if/put-char
.. raw:: latex
\clearpage
.. index:: rtems_put_char()
.. _InterfaceRtemsPutChar:
rtems_put_char()
----------------
Puts the character using :ref:`InterfaceRtemsPutc`
.. rubric:: CALLING SEQUENCE:
.. code-block:: c
void rtems_put_char( int c, void *unused );
.. rubric:: PARAMETERS:
``c``
This parameter is the character to output.
``unused``
This parameter is an unused argument.
.. rubric:: NOTES:
The directive is provided to support the RTEMS Testing Framework.
.. rubric:: CONSTRAINTS:
The following constraints apply to this directive:
* The directive may be called from within any runtime context.
* The directive will not cause the calling task to be preempted.
.. Generated from spec:/rtems/io/if/putk
.. raw:: latex
\clearpage
.. index:: putk()
.. _InterfacePutk:
putk()
------
Outputs the characters of the string and a newline character to the kernel
character output device.
.. rubric:: CALLING SEQUENCE:
.. code-block:: c
int putk( const char *s );
.. rubric:: PARAMETERS:
``s``
This parameter is the string to output.
.. rubric:: RETURN VALUES:
Returns the number of characters output to the kernel character output device.
.. rubric:: NOTES:
The directive may be used to print debug and test information. It uses
:ref:`InterfaceRtemsPutc` to output the characters. This directive performs a
character translation from ``NL`` to ``CR`` followed by ``NR``.
If the kernel character output device is concurrently accessed, then
interleaved output may occur.
.. rubric:: CONSTRAINTS:
The following constraints apply to this directive:
* The directive may be called from within any runtime context.
* The directive will not cause the calling task to be preempted.
.. Generated from spec:/rtems/io/if/printk
.. raw:: latex
\clearpage
.. index:: printk()
.. _InterfacePrintk:
printk()
--------
Outputs the characters defined by the format string and the arguments to the
kernel character output device.
.. rubric:: CALLING SEQUENCE:
.. code-block:: c
int printk( const char *fmt, ... );
.. rubric:: PARAMETERS:
``fmt``
This parameter is a printf()-style format string.
``...``
This parameter is a list of optional parameters required by the format
string.
.. rubric:: RETURN VALUES:
Returns the number of characters output to the kernel character output device.
.. rubric:: NOTES:
The directive may be used to print debug and test information. It uses
:ref:`InterfaceRtemsPutc` to output the characters. This directive performs a
character translation from ``NL`` to ``CR`` followed by ``NR``.
If the kernel character output device is concurrently accessed, then
interleaved output may occur.
.. rubric:: CONSTRAINTS:
The following constraints apply to this directive:
* The directive may be called from within any runtime context.
* The directive will not cause the calling task to be preempted.
* Formatting of floating point numbers is not supported.
.. Generated from spec:/rtems/io/if/vprintk
.. raw:: latex
\clearpage
.. index:: vprintk()
.. _InterfaceVprintk:
vprintk()
---------
Outputs the characters defined by the format string and the variable argument
list to the kernel character output device.
.. rubric:: CALLING SEQUENCE:
.. code-block:: c
int vprintk( const char *fmt, va_list ap );
.. rubric:: PARAMETERS:
``fmt``
This parameter is a printf()-style format string.
``ap``
This parameter is the variable argument list required by the format string.
.. rubric:: RETURN VALUES:
Returns the number of characters output to the kernel character output device.
.. rubric:: NOTES:
The directive may be used to print debug and test information. It uses
:ref:`InterfaceRtemsPutc` to output the characters. This directive performs a
character translation from ``NL`` to ``CR`` followed by ``NR``.
If the kernel character output device is concurrently accessed, then
interleaved output may occur.
.. rubric:: CONSTRAINTS:
The following constraints apply to this directive:
* The directive may be called from within any runtime context.
* The directive will not cause the calling task to be preempted.
* Formatting of floating point numbers is not supported.
.. Generated from spec:/rtems/io/if/printk-printer
.. raw:: latex
\clearpage
.. index:: rtems_printk_printer()
.. _InterfaceRtemsPrintkPrinter:
rtems_printk_printer()
----------------------
Outputs the characters defined by the format string and the variable argument
list to the kernel character output device.
.. rubric:: CALLING SEQUENCE:
.. code-block:: c
int rtems_printk_printer( void *unused, const char *fmt, va_list ap );
.. rubric:: PARAMETERS:
``unused``
This parameter is an unused argument.
``fmt``
This parameter is a printf()-style format string.
``ap``
This parameter is the variable argument list required by the format string.
.. rubric:: RETURN VALUES:
Returns the number of characters output to the kernel character output device.
.. rubric:: NOTES:
The directive may be used to print debug and test information. It uses
:ref:`InterfaceRtemsPutc` to output the characters. This directive performs a
character translation from ``NL`` to ``CR`` followed by ``NR``.
If the kernel character output device is concurrently accessed, then
interleaved output may occur.
.. rubric:: CONSTRAINTS:
The following constraints apply to this directive:
* The directive may be called from within any runtime context.
* The directive will not cause the calling task to be preempted.
* Formatting of floating point numbers is not supported.
.. Generated from spec:/rtems/io/if/getchark
.. raw:: latex
\clearpage
.. index:: getchark()
.. _InterfaceGetchark:
getchark()
----------
Tries to dequeue a character from the kernel character input device.
.. rubric:: CALLING SEQUENCE:
.. code-block:: c
int getchark( void );
.. rubric:: DESCRIPTION:
The directive tries to dequeue a character from the kernel character input
device using the polled character input implementation referenced by
BSP_poll_char if it is available.
.. rubric:: RETURN VALUES:
``-1``
The BSP_poll_char pointer was equal to `NULL
<https://en.cppreference.com/w/c/types/NULL>`_.
``-1``
There was no character enqueued on the kernel character input device.
Returns the character least recently enqueued on the kernel character input
device as an unsigned character value.
.. rubric:: CONSTRAINTS:
The following constraints apply to this directive:
* The directive may be called from within any runtime context.
* The directive will not cause the calling task to be preempted.
|
