summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/serial/serial-peripheral-props.yaml
blob: b4a73214d20d7b68358436a5147fb3f290347e0d (plain)
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
# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
%YAML 1.2
---
$id: http://devicetree.org/schemas/serial/serial-peripheral-props.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Common Properties for Serial-attached Devices

maintainers:
  - Rob Herring <robh@kernel.org>
  - Greg Kroah-Hartman <gregkh@linuxfoundation.org>

description:
  Devices connected over serial/UART, expressed as children of a serial
  controller, might need similar properties, e.g. for configuring the baud
  rate.

properties:
  max-speed:
    $ref: /schemas/types.yaml#/definitions/uint32
    description:
      The maximum baud rate the device operates at.
      This should only be present if the maximum is less than the slave
      device can support.  For example, a particular board has some
      signal quality issue or the host processor can't support higher
      baud rates.

  current-speed:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: |
      The current baud rate the device operates at.
      This should only be present in case a driver has no chance to know
      the baud rate of the slave device.
      Examples:
        * device supports auto-baud
        * the rate is setup by a bootloader and there is no way to reset
          the device
        * device baud rate is configured by its firmware but there is no
          way to request the actual settings

additionalProperties: true