Documentation/devicetree/bindings/spi/renesas,sh-msiof.yaml

   1 # SPDX-License-Identifier: GPL-2.0
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/spi/renesas,sh-msiof.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Renesas MSIOF SPI controller
   8
   9 maintainers:
  10   - Geert Uytterhoeven <geert+renesas@glider.be>
  11
  12 allOf:
  13   - $ref: spi-controller.yaml#
  14
  15 properties:
  16   compatible:
  17     oneOf:
  18       - items:
  19           - const: renesas,msiof-sh73a0     # SH-Mobile AG5
  20           - const: renesas,sh-mobile-msiof  # generic SH-Mobile compatible
  21                                             # device
  22       - items:
  23           - enum:
  24               - renesas,msiof-r8a7742       # RZ/G1H
  25               - renesas,msiof-r8a7743       # RZ/G1M
  26               - renesas,msiof-r8a7744       # RZ/G1N
  27               - renesas,msiof-r8a7745       # RZ/G1E
  28               - renesas,msiof-r8a77470      # RZ/G1C
  29               - renesas,msiof-r8a7790       # R-Car H2
  30               - renesas,msiof-r8a7791       # R-Car M2-W
  31               - renesas,msiof-r8a7792       # R-Car V2H
  32               - renesas,msiof-r8a7793       # R-Car M2-N
  33               - renesas,msiof-r8a7794       # R-Car E2
  34           - const: renesas,rcar-gen2-msiof  # generic R-Car Gen2 and RZ/G1
  35                                             # compatible device
  36       - items:
  37           - enum:
  38               - renesas,msiof-r8a774a1      # RZ/G2M
  39               - renesas,msiof-r8a774b1      # RZ/G2N
  40               - renesas,msiof-r8a774c0      # RZ/G2E
  41               - renesas,msiof-r8a774e1      # RZ/G2H
  42               - renesas,msiof-r8a7795       # R-Car H3
  43               - renesas,msiof-r8a7796       # R-Car M3-W
  44               - renesas,msiof-r8a77965      # R-Car M3-N
  45               - renesas,msiof-r8a77970      # R-Car V3M
  46               - renesas,msiof-r8a77980      # R-Car V3H
  47               - renesas,msiof-r8a77990      # R-Car E3
  48               - renesas,msiof-r8a77995      # R-Car D3
  49           - const: renesas,rcar-gen3-msiof  # generic R-Car Gen3 and RZ/G2
  50                                             # compatible device
  51       - items:
  52           - const: renesas,sh-msiof  # deprecated
  53
  54   reg:
  55     minItems: 1
  56     maxItems: 2
  57     oneOf:
  58       - items:
  59           - description: CPU and DMA engine registers
  60       - items:
  61           - description: CPU registers
  62           - description: DMA engine registers
  63
  64   interrupts:
  65     maxItems: 1
  66
  67   clocks:
  68     maxItems: 1
  69
  70   num-cs:
  71     description: |
  72       Total number of chip selects (default is 1).
  73       Up to 3 native chip selects are supported:
  74         0: MSIOF_SYNC
  75         1: MSIOF_SS1
  76         2: MSIOF_SS2
  77       Hardware limitations related to chip selects:
  78         - Native chip selects are always deasserted in between transfers
  79           that are part of the same message.  Use cs-gpios to work around
  80           this.
  81         - All slaves using native chip selects must use the same spi-cs-high
  82           configuration.  Use cs-gpios to work around this.
  83         - When using GPIO chip selects, at least one native chip select must
  84           be left unused, as it will be driven anyway.
  85     minimum: 1
  86     maximum: 3
  87     default: 1
  88
  89   dmas:
  90     minItems: 2
  91     maxItems: 4
  92
  93   dma-names:
  94     minItems: 2
  95     maxItems: 4
  96     items:
  97       enum: [ tx, rx ]
  98
  99   renesas,dtdl:
 100     description: delay sync signal (setup) in transmit mode.
 101     $ref: /schemas/types.yaml#/definitions/uint32
 102     enum:
 103       - 0        # no bit delay
 104       - 50       # 0.5-clock-cycle delay
 105       - 100      # 1-clock-cycle delay
 106       - 150      # 1.5-clock-cycle delay
 107       - 200      # 2-clock-cycle delay
 108
 109   renesas,syncdl:
 110     description: delay sync signal (hold) in transmit mode
 111     $ref: /schemas/types.yaml#/definitions/uint32
 112     enum:
 113       - 0        # no bit delay
 114       - 50       # 0.5-clock-cycle delay
 115       - 100      # 1-clock-cycle delay
 116       - 150      # 1.5-clock-cycle delay
 117       - 200      # 2-clock-cycle delay
 118       - 300      # 3-clock-cycle delay
 119
 120   renesas,tx-fifo-size:
 121     # deprecated for soctype-specific bindings
 122     description: |
 123       Override the default TX fifo size.  Unit is words.  Ignored if 0.
 124     $ref: /schemas/types.yaml#/definitions/uint32
 125     maxItems: 1
 126     default: 64
 127
 128   renesas,rx-fifo-size:
 129     # deprecated for soctype-specific bindings
 130     description: |
 131       Override the default RX fifo size.  Unit is words.  Ignored if 0.
 132     $ref: /schemas/types.yaml#/definitions/uint32
 133     maxItems: 1
 134     default: 64
 135
 136 required:
 137   - compatible
 138   - reg
 139   - interrupts
 140   - '#address-cells'
 141   - '#size-cells'
 142
 143 unevaluatedProperties: false
 144
 145 examples:
 146   - |
 147     #include <dt-bindings/clock/r8a7791-clock.h>
 148     #include <dt-bindings/interrupt-controller/irq.h>
 149
 150     msiof0: spi@e6e20000 {
 151         compatible = "renesas,msiof-r8a7791", "renesas,rcar-gen2-msiof";
 152         reg = <0xe6e20000 0x0064>;
 153         interrupts = <0 156 IRQ_TYPE_LEVEL_HIGH>;
 154         clocks = <&mstp0_clks R8A7791_CLK_MSIOF0>;
 155         dmas = <&dmac0 0x51>, <&dmac0 0x52>;
 156         dma-names = "tx", "rx";
 157         #address-cells = <1>;
 158         #size-cells = <0>;
 159     };