xref: /linux/Documentation/devicetree/bindings/usb/generic-ehci.yaml (revision c0c9379f235df33a12ceae94370ad80c5278324d) 
1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/usb/generic-ehci.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: USB EHCI Controller
8
9maintainers:
10  - Greg Kroah-Hartman <gregkh@linuxfoundation.org>
11
12allOf:
13  - $ref: usb-hcd.yaml
14  - if:
15      properties:
16        compatible:
17          not:
18            contains:
19              const: ibm,usb-ehci-440epx
20    then:
21      properties:
22        reg:
23          maxItems: 1
24
25properties:
26  compatible:
27    oneOf:
28      - items:
29          - enum:
30              - allwinner,sun4i-a10-ehci
31              - allwinner,sun50i-a100-ehci
32              - allwinner,sun50i-a64-ehci
33              - allwinner,sun50i-h6-ehci
34              - allwinner,sun50i-h616-ehci
35              - allwinner,sun55i-a523-ehci
36              - allwinner,sun5i-a13-ehci
37              - allwinner,sun6i-a31-ehci
38              - allwinner,sun7i-a20-ehci
39              - allwinner,sun8i-a23-ehci
40              - allwinner,sun8i-a83t-ehci
41              - allwinner,sun8i-h3-ehci
42              - allwinner,sun8i-r40-ehci
43              - allwinner,sun8i-v3s-ehci
44              - allwinner,sun9i-a80-ehci
45              - allwinner,sun20i-d1-ehci
46              - aspeed,ast2400-ehci
47              - aspeed,ast2500-ehci
48              - aspeed,ast2600-ehci
49              - brcm,bcm3384-ehci
50              - brcm,bcm63268-ehci
51              - brcm,bcm6328-ehci
52              - brcm,bcm6358-ehci
53              - brcm,bcm6362-ehci
54              - brcm,bcm6368-ehci
55              - brcm,bcm7125-ehci
56              - brcm,bcm7346-ehci
57              - brcm,bcm7358-ehci
58              - brcm,bcm7360-ehci
59              - brcm,bcm7362-ehci
60              - brcm,bcm7420-ehci
61              - brcm,bcm7425-ehci
62              - brcm,bcm7435-ehci
63              - hpe,gxp-ehci
64              - ibm,476gtr-ehci
65              - nxp,lpc1850-ehci
66              - qca,ar7100-ehci
67              - rockchip,rk3588-ehci
68              - snps,hsdk-v1.0-ehci
69              - socionext,uniphier-ehci
70          - const: generic-ehci
71      - items:
72          - enum:
73              - atmel,at91sam9g45-ehci
74              - cavium,octeon-6335-ehci
75              - ibm,usb-ehci-440epx
76              - ibm,usb-ehci-460ex
77              - nintendo,hollywood-usb-ehci
78              - st,spear600-ehci
79          - const: usb-ehci
80      - enum:
81          - generic-ehci
82          - marvell,ac5-ehci
83          - marvell,armada-3700-ehci
84          - marvell,orion-ehci
85          - nuvoton,npcm750-ehci
86          - nuvoton,npcm845-ehci
87          - ti,ehci-omap
88          - usb-ehci
89          - via,vt8500-ehci
90
91  reg:
92    minItems: 1
93    maxItems: 2
94
95  interrupts:
96    maxItems: 1
97
98  resets:
99    minItems: 1
100    maxItems: 4
101
102  clocks:
103    minItems: 1
104    maxItems: 4
105    description: |
106      In case the Renesas R-Car Gen3 SoCs:
107        - if a host only channel: first clock should be host.
108        - if a USB DRD channel: first clock should be host and second
109          one should be peripheral
110
111  power-domains:
112    maxItems: 1
113
114  big-endian:
115    $ref: /schemas/types.yaml#/definitions/flag
116    description:
117      Set this flag for HCDs with big endian descriptors and big
118      endian registers.
119
120  big-endian-desc:
121    $ref: /schemas/types.yaml#/definitions/flag
122    description:
123      Set this flag for HCDs with big endian descriptors.
124
125  big-endian-regs:
126    $ref: /schemas/types.yaml#/definitions/flag
127    description:
128      Set this flag for HCDs with big endian registers.
129
130  has-transaction-translator:
131    $ref: /schemas/types.yaml#/definitions/flag
132    description:
133      Set this flag if EHCI has a Transaction Translator built into
134      the root hub.
135
136  needs-reset-on-resume:
137    $ref: /schemas/types.yaml#/definitions/flag
138    description:
139      Set this flag to force EHCI reset after resume.
140
141  spurious-oc:
142    $ref: /schemas/types.yaml#/definitions/flag
143    description:
144      Set this flag to indicate that the hardware sometimes turns on
145      the OC bit when an over-current isn't actually present.
146
147  phys:
148    minItems: 1
149    maxItems: 3
150
151  phy-names:
152    const: usb
153
154  iommus:
155    maxItems: 1
156
157  dr_mode:
158    enum:
159      - host
160      - otg
161
162required:
163  - compatible
164  - reg
165  - interrupts
166
167unevaluatedProperties: false
168
169examples:
170  - |
171    usb@e0000300 {
172        compatible = "ibm,usb-ehci-440epx", "usb-ehci";
173        interrupt-parent = <&UIC0>;
174        interrupts = <0x1a 4>;
175        reg = <0xe0000300 90>, <0xe0000390 70>;
176        big-endian;
177    };
178
179  - |
180    ehci0: usb@1c14000 {
181        compatible = "allwinner,sun4i-a10-ehci", "generic-ehci";
182        reg = <0x01c14000 0x100>;
183        interrupts = <39>;
184        clocks = <&ahb_gates 1>;
185        phys = <&usbphy 1>;
186        phy-names = "usb";
187    };
188
189...
190