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