xref: /freebsd/sys/contrib/device-tree/Bindings/serial/serial-peripheral-props.yaml (revision b2d2a78ad80ec68d4a17f5aef97d21686cb1e29b)
1*b2d2a78aSEmmanuel Vadot# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
2*b2d2a78aSEmmanuel Vadot%YAML 1.2
3*b2d2a78aSEmmanuel Vadot---
4*b2d2a78aSEmmanuel Vadot$id: http://devicetree.org/schemas/serial/serial-peripheral-props.yaml#
5*b2d2a78aSEmmanuel Vadot$schema: http://devicetree.org/meta-schemas/core.yaml#
6*b2d2a78aSEmmanuel Vadot
7*b2d2a78aSEmmanuel Vadottitle: Common Properties for Serial-attached Devices
8*b2d2a78aSEmmanuel Vadot
9*b2d2a78aSEmmanuel Vadotmaintainers:
10*b2d2a78aSEmmanuel Vadot  - Rob Herring <robh@kernel.org>
11*b2d2a78aSEmmanuel Vadot  - Greg Kroah-Hartman <gregkh@linuxfoundation.org>
12*b2d2a78aSEmmanuel Vadot
13*b2d2a78aSEmmanuel Vadotdescription:
14*b2d2a78aSEmmanuel Vadot  Devices connected over serial/UART, expressed as children of a serial
15*b2d2a78aSEmmanuel Vadot  controller, might need similar properties, e.g. for configuring the baud
16*b2d2a78aSEmmanuel Vadot  rate.
17*b2d2a78aSEmmanuel Vadot
18*b2d2a78aSEmmanuel Vadotproperties:
19*b2d2a78aSEmmanuel Vadot  max-speed:
20*b2d2a78aSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/uint32
21*b2d2a78aSEmmanuel Vadot    description:
22*b2d2a78aSEmmanuel Vadot      The maximum baud rate the device operates at.
23*b2d2a78aSEmmanuel Vadot      This should only be present if the maximum is less than the slave
24*b2d2a78aSEmmanuel Vadot      device can support.  For example, a particular board has some
25*b2d2a78aSEmmanuel Vadot      signal quality issue or the host processor can't support higher
26*b2d2a78aSEmmanuel Vadot      baud rates.
27*b2d2a78aSEmmanuel Vadot
28*b2d2a78aSEmmanuel Vadot  current-speed:
29*b2d2a78aSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/uint32
30*b2d2a78aSEmmanuel Vadot    description: |
31*b2d2a78aSEmmanuel Vadot      The current baud rate the device operates at.
32*b2d2a78aSEmmanuel Vadot      This should only be present in case a driver has no chance to know
33*b2d2a78aSEmmanuel Vadot      the baud rate of the slave device.
34*b2d2a78aSEmmanuel Vadot      Examples:
35*b2d2a78aSEmmanuel Vadot        * device supports auto-baud
36*b2d2a78aSEmmanuel Vadot        * the rate is setup by a bootloader and there is no way to reset
37*b2d2a78aSEmmanuel Vadot          the device
38*b2d2a78aSEmmanuel Vadot        * device baud rate is configured by its firmware but there is no
39*b2d2a78aSEmmanuel Vadot          way to request the actual settings
40*b2d2a78aSEmmanuel Vadot
41*b2d2a78aSEmmanuel VadotadditionalProperties: true
42