Commit 3de536a8 authored by Sean Anderson's avatar Sean Anderson Committed by Greg Kroah-Hartman
Browse files

dt-bindings: serial: uartlite: Add properties for synthesis-time parameters 



The uartlite device is a "soft" device. Many parameters, such as baud
rate, data bits, and the presence of a parity bit are configured before
synthesis and may not be changed (or discovered) at runtime. However, we
must know what these settings are in order to properly calculate the
uart timeout (and to inform the user about the actual baud of the uart).

These properties are present for out-of-tree bindings generated by
Xilinx's tools. However, they are also (mostly) present in in-tree
bindings. I chose current-speed over xlnx,baudrate primarily because it
seemed to be used by more existing bindings. Although these properties
are marked as "required", note that only current-speed is required by
the driver itself. Hopefully, this will allow for an easier transition.

Reviewed-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarSean Anderson <sean.anderson@seco.com>
Link: https://lore.kernel.org/r/20210826192154.3202269-3-sean.anderson@seco.com


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent f77529d9

Documentation/devicetree/bindings/serial/xlnx,opb-uartlite.yaml

+37 −0
Original line number Diff line number Diff line
@@ -32,13 +32,47 @@ properties: 
  clock-names:

    const: s_axi_aclk



  current-speed:

    $ref: /schemas/types.yaml#/definitions/uint32

    description:

      The fixed baud rate that the device was configured for.



  xlnx,data-bits:

    $ref: /schemas/types.yaml#/definitions/uint32

    enum: [5, 6, 7, 8]

    description:

      The fixed number of data bits that the device was configured for.



  xlnx,use-parity:

    $ref: /schemas/types.yaml#/definitions/uint32

    enum: [0, 1]

    description:

      Whether parity checking was enabled when the device was configured.



  xlnx,odd-parity:

    $ref: /schemas/types.yaml#/definitions/uint32

    enum: [0, 1]

    description:

      Whether odd parity was configured.



required:

  - compatible

  - reg

  - interrupts

  - current-speed

  - xlnx,data-bits

  - xlnx,use-parity



allOf:

  - $ref: /schemas/serial.yaml#

  - if:

      properties:

        xlnx,use-parity:

          contains:

            const: 1

    then:

      required:

        - xlnx,odd-parity



unevaluatedProperties: false
@@ -49,5 +83,8 @@ examples: 
        reg = <0x800c0000 0x10000>;

        interrupts = <0x0 0x6e 0x1>;

        port-number = <0>;

        current-speed = <115200>;

        xlnx,data-bits = <8>;

        xlnx,use-parity = <0>;

      };

...