xref: /linux/Documentation/devicetree/bindings/usb/generic-ehci.yaml (revision 4ae68b26c3ab5a82aa271e6e9fc9b1a06e1d6b40)
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-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              - rockchip,rk3588-ehci
65              - snps,hsdk-v1.0-ehci
66              - socionext,uniphier-ehci
67          - const: generic-ehci
68      - items:
69          - enum:
70              - cavium,octeon-6335-ehci
71              - ibm,usb-ehci-440epx
72              - ibm,usb-ehci-460ex
73              - nintendo,hollywood-usb-ehci
74              - st,spear600-ehci
75          - const: usb-ehci
76      - enum:
77          - generic-ehci
78          - marvell,armada-3700-ehci
79          - marvell,orion-ehci
80          - nuvoton,npcm750-ehci
81          - nuvoton,npcm845-ehci
82          - ti,ehci-omap
83          - usb-ehci
84
85  reg:
86    minItems: 1
87    maxItems: 2
88
89  interrupts:
90    maxItems: 1
91
92  resets:
93    minItems: 1
94    maxItems: 4
95
96  clocks:
97    minItems: 1
98    maxItems: 4
99    description: |
100      In case the Renesas R-Car Gen3 SoCs:
101        - if a host only channel: first clock should be host.
102        - if a USB DRD channel: first clock should be host and second
103          one should be peripheral
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
161unevaluatedProperties: false
162
163examples:
164  - |
165    usb@e0000300 {
166        compatible = "ibm,usb-ehci-440epx", "usb-ehci";
167        interrupt-parent = <&UIC0>;
168        interrupts = <0x1a 4>;
169        reg = <0xe0000300 90>, <0xe0000390 70>;
170        big-endian;
171    };
172
173  - |
174    ehci0: usb@1c14000 {
175        compatible = "allwinner,sun4i-a10-ehci", "generic-ehci";
176        reg = <0x01c14000 0x100>;
177        interrupts = <39>;
178        clocks = <&ahb_gates 1>;
179        phys = <&usbphy 1>;
180        phy-names = "usb";
181    };
182
183...
184