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