Documentation/devicetree/bindings/serial/renesas,sci-serial.txt

   1 * Renesas SH-Mobile Serial Communication Interface
   2
   3 Required properties:
   4
   5   - compatible: Must contain one or more of the following:
   6
   7     - "renesas,scif-r7s72100" for R7S72100 (RZ/A1H) SCIF compatible UART.
   8     - "renesas,scif-r7s9210" for R7S9210 (RZ/A2) SCIF compatible UART.
   9     - "renesas,scifa-r8a73a4" for R8A73A4 (R-Mobile APE6) SCIFA compatible UART.
  10     - "renesas,scifb-r8a73a4" for R8A73A4 (R-Mobile APE6) SCIFB compatible UART.
  11     - "renesas,scifa-r8a7740" for R8A7740 (R-Mobile A1) SCIFA compatible UART.
  12     - "renesas,scifb-r8a7740" for R8A7740 (R-Mobile A1) SCIFB compatible UART.
  13     - "renesas,scif-r8a7743" for R8A7743 (RZ/G1M) SCIF compatible UART.
  14     - "renesas,scifa-r8a7743" for R8A7743 (RZ/G1M) SCIFA compatible UART.
  15     - "renesas,scifb-r8a7743" for R8A7743 (RZ/G1M) SCIFB compatible UART.
  16     - "renesas,hscif-r8a7743" for R8A7743 (RZ/G1M) HSCIF compatible UART.
  17     - "renesas,scif-r8a7744" for R8A7744 (RZ/G1N) SCIF compatible UART.
  18     - "renesas,scifa-r8a7744" for R8A7744 (RZ/G1N) SCIFA compatible UART.
  19     - "renesas,scifb-r8a7744" for R8A7744 (RZ/G1N) SCIFB compatible UART.
  20     - "renesas,hscif-r8a7744" for R8A7744 (RZ/G1N) HSCIF compatible UART.
  21     - "renesas,scif-r8a7745" for R8A7745 (RZ/G1E) SCIF compatible UART.
  22     - "renesas,scifa-r8a7745" for R8A7745 (RZ/G1E) SCIFA compatible UART.
  23     - "renesas,scifb-r8a7745" for R8A7745 (RZ/G1E) SCIFB compatible UART.
  24     - "renesas,hscif-r8a7745" for R8A7745 (RZ/G1E) HSCIF compatible UART.
  25     - "renesas,scif-r8a77470" for R8A77470 (RZ/G1C) SCIF compatible UART.
  26     - "renesas,hscif-r8a77470" for R8A77470 (RZ/G1C) HSCIF compatible UART.
  27     - "renesas,scif-r8a774a1" for R8A774A1 (RZ/G2M) SCIF compatible UART.
  28     - "renesas,hscif-r8a774a1" for R8A774A1 (RZ/G2M) HSCIF compatible UART.
  29     - "renesas,scif-r8a774b1" for R8A774B1 (RZ/G2N) SCIF compatible UART.
  30     - "renesas,hscif-r8a774b1" for R8A774B1 (RZ/G2N) HSCIF compatible UART.
  31     - "renesas,scif-r8a774c0" for R8A774C0 (RZ/G2E) SCIF compatible UART.
  32     - "renesas,hscif-r8a774c0" for R8A774C0 (RZ/G2E) HSCIF compatible UART.
  33     - "renesas,scif-r8a7778" for R8A7778 (R-Car M1) SCIF compatible UART.
  34     - "renesas,hscif-r8a7778" for R8A7778 (R-Car M1) HSCIF compatible UART.
  35     - "renesas,scif-r8a7779" for R8A7779 (R-Car H1) SCIF compatible UART.
  36     - "renesas,hscif-r8a7779" for R8A7779 (R-Car H1) HSCIF compatible UART.
  37     - "renesas,scif-r8a7790" for R8A7790 (R-Car H2) SCIF compatible UART.
  38     - "renesas,scifa-r8a7790" for R8A7790 (R-Car H2) SCIFA compatible UART.
  39     - "renesas,scifb-r8a7790" for R8A7790 (R-Car H2) SCIFB compatible UART.
  40     - "renesas,hscif-r8a7790" for R8A7790 (R-Car H2) HSCIF compatible UART.
  41     - "renesas,scif-r8a7791" for R8A7791 (R-Car M2-W) SCIF compatible UART.
  42     - "renesas,scifa-r8a7791" for R8A7791 (R-Car M2-W) SCIFA compatible UART.
  43     - "renesas,scifb-r8a7791" for R8A7791 (R-Car M2-W) SCIFB compatible UART.
  44     - "renesas,hscif-r8a7791" for R8A7791 (R-Car M2-W) HSCIF compatible UART.
  45     - "renesas,scif-r8a7792" for R8A7792 (R-Car V2H) SCIF compatible UART.
  46     - "renesas,hscif-r8a7792" for R8A7792 (R-Car V2H) HSCIF compatible UART.
  47     - "renesas,scif-r8a7793" for R8A7793 (R-Car M2-N) SCIF compatible UART.
  48     - "renesas,scifa-r8a7793" for R8A7793 (R-Car M2-N) SCIFA compatible UART.
  49     - "renesas,scifb-r8a7793" for R8A7793 (R-Car M2-N) SCIFB compatible UART.
  50     - "renesas,hscif-r8a7793" for R8A7793 (R-Car M2-N) HSCIF compatible UART.
  51     - "renesas,scif-r8a7794" for R8A7794 (R-Car E2) SCIF compatible UART.
  52     - "renesas,scifa-r8a7794" for R8A7794 (R-Car E2) SCIFA compatible UART.
  53     - "renesas,scifb-r8a7794" for R8A7794 (R-Car E2) SCIFB compatible UART.
  54     - "renesas,hscif-r8a7794" for R8A7794 (R-Car E2) HSCIF compatible UART.
  55     - "renesas,scif-r8a7795" for R8A7795 (R-Car H3) SCIF compatible UART.
  56     - "renesas,hscif-r8a7795" for R8A7795 (R-Car H3) HSCIF compatible UART.
  57     - "renesas,scif-r8a7796" for R8A77960 (R-Car M3-W) SCIF compatible UART.
  58     - "renesas,hscif-r8a7796" for R8A77960 (R-Car M3-W) HSCIF compatible UART.
  59     - "renesas,scif-r8a77961" for R8A77961 (R-Car M3-W+) SCIF compatible UART.
  60     - "renesas,hscif-r8a77961" for R8A77961 (R-Car M3-W+) HSCIF compatible UART.
  61     - "renesas,scif-r8a77965" for R8A77965 (R-Car M3-N) SCIF compatible UART.
  62     - "renesas,hscif-r8a77965" for R8A77965 (R-Car M3-N) HSCIF compatible UART.
  63     - "renesas,scif-r8a77970" for R8A77970 (R-Car V3M) SCIF compatible UART.
  64     - "renesas,hscif-r8a77970" for R8A77970 (R-Car V3M) HSCIF compatible UART.
  65     - "renesas,scif-r8a77980" for R8A77980 (R-Car V3H) SCIF compatible UART.
  66     - "renesas,hscif-r8a77980" for R8A77980 (R-Car V3H) HSCIF compatible UART.
  67     - "renesas,scif-r8a77990" for R8A77990 (R-Car E3) SCIF compatible UART.
  68     - "renesas,hscif-r8a77990" for R8A77990 (R-Car E3) HSCIF compatible UART.
  69     - "renesas,scif-r8a77995" for R8A77995 (R-Car D3) SCIF compatible UART.
  70     - "renesas,hscif-r8a77995" for R8A77995 (R-Car D3) HSCIF compatible UART.
  71     - "renesas,scifa-sh73a0" for SH73A0 (SH-Mobile AG5) SCIFA compatible UART.
  72     - "renesas,scifb-sh73a0" for SH73A0 (SH-Mobile AG5) SCIFB compatible UART.
  73     - "renesas,rcar-gen1-scif" for R-Car Gen1 SCIF compatible UART,
  74     - "renesas,rcar-gen2-scif" for R-Car Gen2 and RZ/G1 SCIF compatible UART,
  75     - "renesas,rcar-gen3-scif" for R-Car Gen3 and RZ/G2 SCIF compatible UART,
  76     - "renesas,rcar-gen2-scifa" for R-Car Gen2 and RZ/G1 SCIFA compatible UART,
  77     - "renesas,rcar-gen2-scifb" for R-Car Gen2 and RZ/G1 SCIFB compatible UART,
  78     - "renesas,rcar-gen1-hscif" for R-Car Gen1 HSCIF compatible UART,
  79     - "renesas,rcar-gen2-hscif" for R-Car Gen2 and RZ/G1 HSCIF compatible UART,
  80     - "renesas,rcar-gen3-hscif" for R-Car Gen3 and RZ/G2 HSCIF compatible UART,
  81     - "renesas,scif" for generic SCIF compatible UART.
  82     - "renesas,scifa" for generic SCIFA compatible UART.
  83     - "renesas,scifb" for generic SCIFB compatible UART.
  84     - "renesas,hscif" for generic HSCIF compatible UART.
  85     - "renesas,sci" for generic SCI compatible UART.
  86
  87     When compatible with the generic version, nodes must list the
  88     SoC-specific version corresponding to the platform first, followed by the
  89     family-specific and/or generic versions.
  90
  91   - reg: Base address and length of the I/O registers used by the UART.
  92   - interrupts: Must contain one or more interrupt-specifiers for the SCIx.
  93                 If a single interrupt is expressed, then all events are
  94                 multiplexed into this single interrupt.
  95
  96                 If multiple interrupts are provided by the hardware, the order
  97                 in which the interrupts are listed must match order below. Note
  98                 that some HW interrupt events may be muxed together resulting
  99                 in duplicate entries.
 100                 The interrupt order is as follows:
 101                   1. Error (ERI)
 102                   2. Receive buffer full (RXI)
 103                   3. Transmit buffer empty (TXI)
 104                   4. Break (BRI)
 105                   5. Data Ready (DRI)
 106                   6. Transmit End (TEI)
 107
 108   - clocks: Must contain a phandle and clock-specifier pair for each entry
 109     in clock-names.
 110   - clock-names: Must contain "fck" for the SCIx UART functional clock.
 111     Apart from the divided functional clock, there may be other possible
 112     sources for the sampling clock, depending on SCIx variant.
 113     On (H)SCI(F) and some SCIFA, an additional clock may be specified:
 114       - "hsck" for the optional external clock input (on HSCIF),
 115       - "sck" for the optional external clock input (on other variants).
 116     On UARTs equipped with a Baud Rate Generator for External Clock (BRG)
 117     (some SCIF and HSCIF), additional clocks may be specified:
 118       - "brg_int" for the optional internal clock source for the frequency
 119         divider (typically the (AXI or SHwy) bus clock),
 120       - "scif_clk" for the optional external clock source for the frequency
 121         divider (SCIF_CLK).
 122
 123 Note: Each enabled SCIx UART may have an optional "serialN" alias in the
 124 "aliases" node.
 125
 126 Optional properties:
 127   - dmas: Must contain a list of two references to DMA specifiers, one for
 128           transmission, and one for reception.
 129   - dma-names: Must contain a list of two DMA names, "tx" and "rx".
 130   - {cts,dsr,dcd,rng,rts,dtr}-gpios: Specify GPIOs for modem lines, cfr. the
 131     generic serial DT bindings in serial.txt.
 132   - uart-has-rtscts: Indicates dedicated lines for RTS/CTS hardware flow
 133     control, cfr. the generic serial DT bindings in serial.txt.
 134
 135 Example:
 136         aliases {
 137                 serial0 = &scifa0;
 138         };
 139
 140         scifa0: serial@e6c40000 {
 141                 compatible = "renesas,scifa-r8a7790",
 142                              "renesas,rcar-gen2-scifa", "renesas,scifa";
 143                 reg = <0 0xe6c40000 0 64>;
 144                 interrupt-parent = <&gic>;
 145                 interrupts = <0 144 IRQ_TYPE_LEVEL_HIGH>;
 146                 clocks = <&mstp2_clks R8A7790_CLK_SCIFA0>;
 147                 clock-names = "fck";
 148                 dmas = <&dmac0 0x21>, <&dmac0 0x22>;
 149                 dma-names = "tx", "rx";
 150         };