Documentation/devicetree/bindings/serial/fsl-imx-uart.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/serial/fsl-imx-uart.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Freescale i.MX Universal Asynchronous Receiver/Transmitter (UART)
   8
   9 maintainers:
  10   - Fabio Estevam <festevam@gmail.com>
  11
  12 properties:
  13   compatible:
  14     oneOf:
  15       - const: fsl,imx1-uart
  16       - const: fsl,imx21-uart
  17       - items:
  18           - enum:
  19               - fsl,imx25-uart
  20               - fsl,imx27-uart
  21               - fsl,imx31-uart
  22               - fsl,imx35-uart
  23               - fsl,imx50-uart
  24               - fsl,imx51-uart
  25               - fsl,imx53-uart
  26               - fsl,imx6q-uart
  27           - const: fsl,imx21-uart
  28       - items:
  29           - enum:
  30               - fsl,imx6sl-uart
  31               - fsl,imx6sll-uart
  32               - fsl,imx6sx-uart
  33           - const: fsl,imx6q-uart
  34           - const: fsl,imx21-uart
  35       - items:
  36           - enum:
  37               - fsl,imx6ul-uart
  38               - fsl,imx7d-uart
  39               - fsl,imx8mm-uart
  40               - fsl,imx8mn-uart
  41               - fsl,imx8mp-uart
  42               - fsl,imx8mq-uart
  43           - const: fsl,imx6q-uart
  44
  45   reg:
  46     maxItems: 1
  47
  48   clocks:
  49     maxItems: 2
  50
  51   clock-names:
  52     items:
  53       - const: ipg
  54       - const: per
  55
  56   dmas:
  57     items:
  58       - description: DMA controller phandle and request line for RX
  59       - description: DMA controller phandle and request line for TX
  60
  61   dma-names:
  62     items:
  63       - const: rx
  64       - const: tx
  65
  66   interrupts:
  67     items:
  68       - description: UART RX Interrupt
  69       - description: UART TX Interrupt
  70       - description: UART RTS Interrupt
  71     minItems: 1
  72
  73   wakeup-source: true
  74
  75   fsl,dte-mode:
  76     $ref: /schemas/types.yaml#/definitions/flag
  77     description: |
  78       Indicate the uart works in DTE mode. The uart works in DCE mode by default.
  79
  80   fsl,inverted-tx:
  81     $ref: /schemas/types.yaml#/definitions/flag
  82     description: |
  83       Indicate that the hardware attached to the peripheral inverts the signal
  84       transmitted, and that the peripheral should invert its output using the
  85       INVT registers.
  86
  87   fsl,inverted-rx:
  88     $ref: /schemas/types.yaml#/definitions/flag
  89     description: |
  90       Indicate that the hardware attached to the peripheral inverts the signal
  91       received, and that the peripheral should invert its input using the
  92       INVR registers.
  93
  94   fsl,dma-info:
  95     $ref: /schemas/types.yaml#/definitions/uint32-array
  96     minItems: 2
  97     maxItems: 2
  98     description: |
  99       First cell contains the size of DMA buffer chunks, second cell contains
 100       the amount of chunks used for the device. Multiplying both numbers is
 101       the total size of memory used for receiving data.
 102       When not being configured the system will use default settings, which
 103       are sensible for most use cases. If you need low latency processing on
 104       slow connections this needs to be configured appropriately.
 105
 106 required:
 107   - compatible
 108   - reg
 109   - clocks
 110   - clock-names
 111   - interrupts
 112
 113 allOf:
 114   - $ref: serial.yaml#
 115   - $ref: rs485.yaml#
 116
 117   - if:
 118       properties:
 119         compatible:
 120           contains:
 121             const: fsl,imx1-uart
 122     then:
 123       properties:
 124         interrupts:
 125           minItems: 3
 126           maxItems: 3
 127     else:
 128       properties:
 129         interrupts:
 130           maxItems: 1
 131
 132 unevaluatedProperties: false
 133
 134 examples:
 135   - |
 136     #include <dt-bindings/clock/imx5-clock.h>
 137
 138     aliases {
 139         serial0 = &uart1;
 140     };
 141
 142     uart1: serial@73fbc000 {
 143         compatible = "fsl,imx51-uart", "fsl,imx21-uart";
 144         reg = <0x73fbc000 0x4000>;
 145         interrupts = <31>;
 146         clocks = <&clks IMX5_CLK_UART1_IPG_GATE>,
 147                  <&clks IMX5_CLK_UART1_PER_GATE>;
 148         clock-names = "ipg", "per";
 149         dmas = <&sdma 18 4 1>, <&sdma 19 4 2>;
 150         dma-names = "rx", "tx";
 151         uart-has-rtscts;
 152         fsl,dte-mode;
 153     };