blob: f4f12e36cb7bd59eb1e68e4f4f513ed1e4333b61 (
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
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Tries to dequeue a character from the kernel character input device.
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2015 On-Line Applications Research Corporation (OAR)
definition:
default:
attributes: null
body: null
params: []
return: int
variants: []
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:/name} if it is available.
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
uid: header-3
- role: interface-ingroup
uid: group-3
- role: constraint
uid: /constraint/directive-ctx-any
- role: constraint
uid: /constraint/directive-no-preempt
name: getchark
notes: null
params: []
return:
return: |
Returns the character least recently enqueued on the kernel character input
device as an unsigned character value.
return-values:
- description: |
The ${bsp-poll-char:/name} pointer was equal to ${/c/if/null:/name}.
value: -1
- description: |
There was no character enqueued on the kernel character input device.
value: -1
type: interface
|
