summaryrefslogtreecommitdiffstats
path: root/spec/dev/grlib/if/apbuart-inbyte-nonblocking.yml
blob: 698730b3ef959ddb3a3bbe3ce8353b1c97622cfd (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Clears all errors and tries to get one character from the receiver FIFO.
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
definition:
  default:
    attributes: null
    body: null
    params:
    - ${apbuart:/name} *${.:/params[0]/name}
    return: int
  variants: []
description: null
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
  uid: apbuart-header-2
- role: interface-ingroup
  uid: apbuart
name: apbuart_inbyte_nonblocking
notes: null
params:
- description: |
    is the pointer to the APBUART register block.
  dir: null
  name: regs
return:
  return: |
    Returns the first character of the receiver FIFO if it was non-empty.
  return-values:
  - description: |
      The receiver FIFO was empty.
    value: '-1'
type: interface