Documentation/devicetree/bindings/usb/generic-ohci.yaml

   1 # SPDX-License-Identifier: GPL-2.0
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/usb/generic-ohci.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: USB OHCI Controller
   8
   9 maintainers:
  10   - Greg Kroah-Hartman <gregkh@linuxfoundation.org>
  11
  12 properties:
  13   compatible:
  14     oneOf:
  15       - items:
  16           - enum:
  17               - allwinner,sun4i-a10-ohci
  18               - allwinner,sun50i-a100-ohci
  19               - allwinner,sun50i-a64-ohci
  20               - allwinner,sun50i-h6-ohci
  21               - allwinner,sun50i-h616-ohci
  22               - allwinner,sun55i-a523-ohci
  23               - allwinner,sun5i-a13-ohci
  24               - allwinner,sun6i-a31-ohci
  25               - allwinner,sun7i-a20-ohci
  26               - allwinner,sun8i-a23-ohci
  27               - allwinner,sun8i-a83t-ohci
  28               - allwinner,sun8i-h3-ohci
  29               - allwinner,sun8i-r40-ohci
  30               - allwinner,sun8i-v3s-ohci
  31               - allwinner,sun9i-a80-ohci
  32               - allwinner,sun20i-d1-ohci
  33               - brcm,bcm3384-ohci
  34               - brcm,bcm63268-ohci
  35               - brcm,bcm6328-ohci
  36               - brcm,bcm6358-ohci
  37               - brcm,bcm6362-ohci
  38               - brcm,bcm6368-ohci
  39               - brcm,bcm7125-ohci
  40               - brcm,bcm7346-ohci
  41               - brcm,bcm7358-ohci
  42               - brcm,bcm7360-ohci
  43               - brcm,bcm7362-ohci
  44               - brcm,bcm7420-ohci
  45               - brcm,bcm7425-ohci
  46               - brcm,bcm7435-ohci
  47               - hpe,gxp-ohci
  48               - ibm,476gtr-ohci
  49               - ingenic,jz4740-ohci
  50               - rockchip,rk3588-ohci
  51               - snps,hsdk-v1.0-ohci
  52           - const: generic-ohci
  53       - enum:
  54           - generic-ohci
  55           - ti,ohci-omap3
  56       - items:
  57           - enum:
  58               - cavium,octeon-6335-ohci
  59               - nintendo,hollywood-usb-ohci
  60               - nxp,ohci-nxp
  61               - st,spear600-ohci
  62           - const: usb-ohci
  63
  64   reg:
  65     maxItems: 1
  66
  67   interrupts:
  68     maxItems: 1
  69
  70   resets:
  71     minItems: 1
  72     maxItems: 2
  73
  74   clocks:
  75     minItems: 1
  76     maxItems: 4
  77     description: |
  78       In case the Renesas R-Car Gen3 SoCs:
  79         - if a host only channel: first clock should be host.
  80         - if a USB DRD channel: first clock should be host and second
  81           one should be peripheral
  82
  83   power-domains:
  84     maxItems: 1
  85
  86   big-endian:
  87     $ref: /schemas/types.yaml#/definitions/flag
  88     description:
  89       Set this flag for HCDs with big endian descriptors and big
  90       endian registers.
  91
  92   big-endian-desc:
  93     $ref: /schemas/types.yaml#/definitions/flag
  94     description:
  95       Set this flag for HCDs with big endian descriptors.
  96
  97   big-endian-regs:
  98     $ref: /schemas/types.yaml#/definitions/flag
  99     description:
 100       Set this flag for HCDs with big endian registers.
 101
 102   remote-wakeup-connected:
 103     $ref: /schemas/types.yaml#/definitions/flag
 104     description:
 105       Remote wakeup is wired on the platform.
 106
 107   no-big-frame-no:
 108     $ref: /schemas/types.yaml#/definitions/flag
 109     description:
 110       Set if frame_no lives in bits [15:0] of HCCA
 111
 112   num-ports:
 113     $ref: /schemas/types.yaml#/definitions/uint32
 114     description:
 115       Overrides the detected port count
 116
 117   phys:
 118     minItems: 1
 119     maxItems: 3
 120
 121   phy-names:
 122     const: usb
 123
 124   iommus:
 125     maxItems: 1
 126
 127   dr_mode:
 128     enum:
 129       - host
 130       - otg
 131
 132   transceiver:
 133     $ref: /schemas/types.yaml#/definitions/phandle
 134     description:
 135       The associated ISP1301 device. Necessary for the UDC controller for
 136       connecting to the USB physical layer.
 137
 138 required:
 139   - compatible
 140   - reg
 141   - interrupts
 142
 143 allOf:
 144   - $ref: usb-hcd.yaml
 145   - if:
 146       not:
 147         properties:
 148           compatible:
 149             contains:
 150               const: nxp,ohci-nxp
 151     then:
 152       properties:
 153         transceiver: false
 154   - if:
 155       properties:
 156         compatible:
 157           contains:
 158             const: rockchip,rk3588-ohci
 159     then:
 160       properties:
 161         clocks:
 162           minItems: 4
 163     else:
 164       properties:
 165         clocks:
 166           minItems: 1
 167           maxItems: 3
 168
 169 unevaluatedProperties: false
 170
 171 examples:
 172   - |
 173       ohci0: usb@1c14400 {
 174           compatible = "allwinner,sun4i-a10-ohci", "generic-ohci";
 175           reg = <0x01c14400 0x100>;
 176           interrupts = <64>;
 177           clocks = <&usb_clk 6>, <&ahb_gates 2>;
 178           phys = <&usbphy 1>;
 179           phy-names = "usb";
 180       };
 181
 182 ...