1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2# Copyright (c) 2020 MediaTek
3%YAML 1.2
4---
5$id: http://devicetree.org/schemas/usb/mediatek,mtk-xhci.yaml#
6$schema: http://devicetree.org/meta-schemas/core.yaml#
7
8title: MediaTek USB3 xHCI
9
10maintainers:
11  - Chunfeng Yun <chunfeng.yun@mediatek.com>
12
13allOf:
14  - $ref: "usb-xhci.yaml"
15
16description: |
17  There are two scenarios:
18  case 1: only supports xHCI driver;
19  case 2: supports dual-role mode, and the host is based on xHCI driver.
20
21properties:
22  # common properties for both case 1 and case 2
23  compatible:
24    items:
25      - enum:
26          - mediatek,mt2701-xhci
27          - mediatek,mt2712-xhci
28          - mediatek,mt7622-xhci
29          - mediatek,mt7623-xhci
30          - mediatek,mt7629-xhci
31          - mediatek,mt7986-xhci
32          - mediatek,mt8173-xhci
33          - mediatek,mt8183-xhci
34          - mediatek,mt8186-xhci
35          - mediatek,mt8188-xhci
36          - mediatek,mt8192-xhci
37          - mediatek,mt8195-xhci
38          - mediatek,mt8365-xhci
39      - const: mediatek,mtk-xhci
40
41  reg:
42    minItems: 1
43    items:
44      - description: the registers of xHCI MAC
45      - description: the registers of IP Port Control
46
47  reg-names:
48    minItems: 1
49    items:
50      - const: mac
51      - const: ippc  # optional, only needed for case 1.
52
53  interrupts:
54    description:
55      use "interrupts-extended" when the interrupts are connected to the
56      separate interrupt controllers
57    minItems: 1
58    items:
59      - description: xHCI host controller interrupt
60      - description: optional, wakeup interrupt used to support runtime PM
61
62  interrupt-names:
63    minItems: 1
64    items:
65      - const: host
66      - const: wakeup
67
68  power-domains:
69    description: A phandle to USB power domain node to control USB's MTCMOS
70    maxItems: 1
71
72  clocks:
73    minItems: 1
74    items:
75      - description: Controller clock used by normal mode
76      - description: Reference clock used by low power mode etc
77      - description: Mcu bus clock for register access
78      - description: DMA bus clock for data transfer
79      - description: controller clock
80
81  clock-names:
82    minItems: 1
83    items:
84      - const: sys_ck  # required, the following ones are optional
85      - const: ref_ck
86      - const: mcu_ck
87      - const: dma_ck
88      - const: xhci_ck
89
90  assigned-clocks:
91    minItems: 1
92    maxItems: 5
93
94  assigned-clock-parents:
95    minItems: 1
96    maxItems: 5
97
98  phys:
99    description:
100      List of all PHYs used on this HCD, it's better to keep PHYs in order
101      as the hardware layout
102    minItems: 1
103    items:
104      - description: USB2/HS PHY    # required, others are optional
105      - description: USB3/SS(P) PHY
106      - description: USB2/HS PHY
107      - description: USB3/SS(P) PHY
108      - description: USB2/HS PHY
109      - description: USB3/SS(P) PHY
110      - description: USB2/HS PHY
111      - description: USB3/SS(P) PHY
112      - description: USB2/HS PHY
113
114  vusb33-supply:
115    description: Regulator of USB AVDD3.3v
116
117  vbus-supply:
118    description: Regulator of USB VBUS5v
119
120  resets:
121    maxItems: 1
122
123  usb3-lpm-capable: true
124
125  usb2-lpm-disable: true
126
127  imod-interval-ns:
128    description:
129      Interrupt moderation interval value, it is 8 times as much as that
130      defined in the xHCI spec on MTK's controller.
131    default: 5000
132
133  # the following properties are only used for case 1
134  wakeup-source:
135    description: enable USB remote wakeup, see power/wakeup-source.txt
136    type: boolean
137
138  mediatek,syscon-wakeup:
139    $ref: /schemas/types.yaml#/definitions/phandle-array
140    maxItems: 1
141    description:
142      A phandle to syscon used to access the register of the USB wakeup glue
143      layer between xHCI and SPM, the field should always be 3 cells long.
144    items:
145      items:
146        - description:
147            The first cell represents a phandle to syscon
148        - description:
149            The second cell represents the register base address of the glue
150            layer in syscon
151        - description: |
152            The third cell represents the hardware version of the glue layer,
153            1 - used by mt8173 etc, revision 1 without following IPM rule;
154            2 - used by mt2712 etc, revision 2 following IPM rule;
155            101 - used by mt8183, specific 1.01;
156            102 - used by mt8192, specific 1.02;
157            103 - used by mt8195, IP0, specific 1.03;
158            104 - used by mt8195, IP1, specific 1.04;
159            105 - used by mt8195, IP2, specific 1.05;
160            106 - used by mt8195, IP3, specific 1.06;
161          enum: [1, 2, 101, 102, 103, 104, 105, 106]
162
163  mediatek,u3p-dis-msk:
164    $ref: /schemas/types.yaml#/definitions/uint32
165    description: The mask to disable u3ports, bit0 for u3port0,
166      bit1 for u3port1, ... etc
167
168  mediatek,u2p-dis-msk:
169    $ref: /schemas/types.yaml#/definitions/uint32
170    description: The mask to disable u2ports, bit0 for u2port0,
171      bit1 for u2port1, ... etc
172
173  "#address-cells":
174    const: 1
175
176  "#size-cells":
177    const: 0
178
179patternProperties:
180  "@[0-9a-f]{1}$":
181    type: object
182    description: The hard wired USB devices.
183
184dependencies:
185  wakeup-source: [ 'mediatek,syscon-wakeup' ]
186
187required:
188  - compatible
189  - reg
190  - reg-names
191  - interrupts
192  - clocks
193  - clock-names
194
195additionalProperties: false
196
197examples:
198  - |
199    #include <dt-bindings/clock/mt8173-clk.h>
200    #include <dt-bindings/interrupt-controller/arm-gic.h>
201    #include <dt-bindings/interrupt-controller/irq.h>
202    #include <dt-bindings/phy/phy.h>
203    #include <dt-bindings/power/mt8173-power.h>
204
205    usb@11270000 {
206        compatible = "mediatek,mt8173-xhci", "mediatek,mtk-xhci";
207        reg = <0x11270000 0x1000>, <0x11280700 0x0100>;
208        reg-names = "mac", "ippc";
209        interrupts = <GIC_SPI 115 IRQ_TYPE_LEVEL_LOW>;
210        power-domains = <&scpsys MT8173_POWER_DOMAIN_USB>;
211        clocks = <&topckgen CLK_TOP_USB30_SEL>, <&clk26m>;
212        clock-names = "sys_ck", "ref_ck";
213        phys = <&u3port0 PHY_TYPE_USB3>, <&u2port1 PHY_TYPE_USB2>;
214        vusb33-supply = <&mt6397_vusb_reg>;
215        vbus-supply = <&usb_p1_vbus>;
216        imod-interval-ns = <10000>;
217        mediatek,syscon-wakeup = <&pericfg 0x400 1>;
218        wakeup-source;
219        usb3-lpm-capable;
220    };
221...
222