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