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