summaryrefslogtreecommitdiffstats
path: root/spec/rtems/io/if/group-3.yml
blob: 62104133d39c4449b465b8e18422be99b07e7aeb (plain) (blame)
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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  The kernel character input/output support is an extension of the
  ${group:/name} to output characters to the kernel character output device and
  receive characters from the kernel character input device using a polled and
  non-blocking implementation.
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
description: |
  The directives may be used to print debug and test information.  The kernel
  character input/output support should work even if no Console Driver is
  configured, see ${/acfg/if/appl-needs-console-driver:/name}.  The kernel
  character input and output device is provided by the ${/glossary/bsp:/term}.
  Applications may change the device.
enabled-by: true
identifier: RTEMSAPIKernelCharIO
index-entries: []
interface-type: group
links:
- role: interface-placement
  uid: header-3
- role: interface-ingroup
  uid: group
- role: placement-order
  uid: bsp-output-char-function-type
- role: placement-order
  uid: bsp-output-char
- role: placement-order
  uid: putc
- role: placement-order
  uid: put-char
- role: placement-order
  uid: putk
- role: placement-order
  uid: printk
- role: placement-order
  uid: vprintk
- role: placement-order
  uid: printk-printer
- role: placement-order
  uid: bsp-polling-getchar-function-type
- role: placement-order
  uid: bsp-poll-char
- role: placement-order
  uid: getchark
name: Kernel Character I/O Support
text: |
  The ${group:/name} shall provide an interface group containing functions to
  input and output characters to a ${/glossary/bsp:/term} defined device using
  a polled and non-blocking implementation.
type: interface