1# SPDX-License-Identifier: GPL-2.0-only
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/connector/usb-connector.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: USB Connector
8
9maintainers:
10  - Rob Herring <robh@kernel.org>
11
12description:
13  A USB connector node represents a physical USB connector. It should be a child
14  of a USB interface controller or a separate node when it is attached to both
15  MUX and USB interface controller.
16
17properties:
18  compatible:
19    oneOf:
20      - enum:
21          - usb-a-connector
22          - usb-b-connector
23          - usb-c-connector
24
25      - items:
26          - const: gpio-usb-b-connector
27          - const: usb-b-connector
28
29      - items:
30          - const: samsung,usb-connector-11pin
31          - const: usb-b-connector
32
33  label:
34    description: Symbolic name for the connector.
35
36  type:
37    description: Size of the connector, should be specified in case of
38      non-fullsize 'usb-a-connector' or 'usb-b-connector' compatible
39      connectors.
40    $ref: /schemas/types.yaml#/definitions/string
41
42    enum:
43      - mini
44      - micro
45
46  self-powered:
47    description: Set this property if the USB device has its own power source.
48    type: boolean
49
50  # The following are optional properties for "usb-b-connector".
51  id-gpios:
52    description: An input gpio for USB ID pin.
53    maxItems: 1
54
55  vbus-gpios:
56    description: An input gpio for USB VBus pin, used to detect presence of
57      VBUS 5V.
58    maxItems: 1
59
60  vbus-supply:
61    description: A phandle to the regulator for USB VBUS if needed when host
62      mode or dual role mode is supported.
63      Particularly, if use an output GPIO to control a VBUS regulator, should
64      model it as a regulator. See bindings/regulator/fixed-regulator.yaml
65
66  # The following are optional properties for "usb-c-connector".
67  power-role:
68    description: Determines the power role that the Type C connector will
69      support. "dual" refers to Dual Role Port (DRP).
70    $ref: /schemas/types.yaml#/definitions/string
71
72    enum:
73      - source
74      - sink
75      - dual
76
77  try-power-role:
78    description: Preferred power role.
79    $ref: /schemas/types.yaml#/definitions/string
80
81    enum:
82      - source
83      - sink
84      - dual
85
86  data-role:
87    description: Data role if Type C connector supports USB data. "dual" refers
88      Dual Role Device (DRD).
89    $ref: /schemas/types.yaml#/definitions/string
90
91    enum:
92      - host
93      - device
94      - dual
95
96  typec-power-opmode:
97    description: Determines the power operation mode that the Type C connector
98      will support and will advertise through CC pins when it has no power
99      delivery support.
100      - "default" corresponds to default USB voltage and current defined by the
101        USB 2.0 and USB 3.2 specifications, 5V 500mA for USB 2.0 ports and
102        5V 900mA or 1500mA for USB 3.2 ports in single-lane or dual-lane
103        operation respectively.
104      - "1.5A" and "3.0A", 5V 1.5A and 5V 3.0A respectively, as defined in USB
105        Type-C Cable and Connector specification, when Power Delivery is not
106        supported.
107    allOf:
108      - $ref: /schemas/types.yaml#/definitions/string
109    enum:
110      - default
111      - 1.5A
112      - 3.0A
113
114  # The following are optional properties for "usb-c-connector" with power
115  # delivery support.
116  source-pdos:
117    description: An array of u32 with each entry providing supported power
118      source data object(PDO), the detailed bit definitions of PDO can be found
119      in "Universal Serial Bus Power Delivery Specification" chapter 6.4.1.2
120      Source_Capabilities Message, the order of each entry(PDO) should follow
121      the PD spec chapter 6.4.1. Required for power source and power dual role.
122      User can specify the source PDO array via PDO_FIXED/BATT/VAR/PPS_APDO()
123      defined in dt-bindings/usb/pd.h.
124    minItems: 1
125    maxItems: 7
126    $ref: /schemas/types.yaml#/definitions/uint32-array
127
128  sink-pdos:
129    description: An array of u32 with each entry providing supported power sink
130      data object(PDO), the detailed bit definitions of PDO can be found in
131      "Universal Serial Bus Power Delivery Specification" chapter 6.4.1.3
132      Sink Capabilities Message, the order of each entry(PDO) should follow the
133      PD spec chapter 6.4.1. Required for power sink and power dual role. User
134      can specify the sink PDO array via PDO_FIXED/BATT/VAR/PPS_APDO() defined
135      in dt-bindings/usb/pd.h.
136    minItems: 1
137    maxItems: 7
138    $ref: /schemas/types.yaml#/definitions/uint32-array
139
140  sink-vdos:
141    description: An array of u32 with each entry, a Vendor Defined Message Object (VDO),
142      providing additional information corresponding to the product, the detailed bit
143      definitions and the order of each VDO can be found in
144      "USB Power Delivery Specification Revision 3.0, Version 2.0 + ECNs 2020-12-10"
145      chapter 6.4.4.3.1 Discover Identity. User can specify the VDO array via
146      VDO_IDH/_CERT/_PRODUCT/_UFP/_DFP/_PCABLE/_ACABLE(1/2)/_VPD() defined in
147      dt-bindings/usb/pd.h.
148    minItems: 3
149    maxItems: 6
150    $ref: /schemas/types.yaml#/definitions/uint32-array
151
152  op-sink-microwatt:
153    description: Sink required operating power in microwatt, if source can't
154      offer the power, Capability Mismatch is set. Required for power sink and
155      power dual role.
156
157  ports:
158    description: OF graph bindings (specified in bindings/graph.txt) that model
159      any data bus to the connector unless the bus is between parent node and
160      the connector. Since a single connector can have multiple data buses every
161      bus has an assigned OF graph port number as described below.
162    type: object
163    properties:
164      port@0:
165        type: object
166        description: High Speed (HS), present in all connectors.
167
168      port@1:
169        type: object
170        description: Super Speed (SS), present in SS capable connectors.
171
172      port@2:
173        type: object
174        description: Sideband Use (SBU), present in USB-C. This describes the
175          alternate mode connection of which SBU is a part.
176
177    required:
178      - port@0
179
180  new-source-frs-typec-current:
181    description: Initial current capability of the new source when vSafe5V
182      is applied during PD3.0 Fast Role Swap. "Table 6-14 Fixed Supply PDO - Sink"
183      of "USB Power Delivery Specification Revision 3.0, Version 1.2" provides the
184      different power levels and "6.4.1.3.1.6 Fast Role Swap USB Type-C Current"
185      provides a detailed description of the field. The sink PDO from current source
186      reflects the current source's(i.e. transmitter of the FRS signal) power
187      requirement during fr swap. The current sink (i.e. receiver of the FRS signal),
188      a.k.a new source, should check if it will be able to satisfy the current source's,
189      new sink's, requirement during frswap before enabling the frs signal reception.
190      This property refers to maximum current capability that the current sink can
191      satisfy. During FRS, VBUS voltage is at 5V, as the partners are in implicit
192      contract, hence, the power level is only a function of the current capability.
193      "1" refers to default USB power level as described by "Table 6-14 Fixed Supply PDO - Sink".
194      "2" refers to 1.5A@5V.
195      "3" refers to 3.0A@5V.
196    $ref: /schemas/types.yaml#/definitions/uint32
197    enum: [1, 2, 3]
198
199required:
200  - compatible
201
202allOf:
203  - if:
204      properties:
205        compatible:
206          contains:
207            const: gpio-usb-b-connector
208    then:
209      anyOf:
210        - required:
211            - vbus-gpios
212        - required:
213            - id-gpios
214
215  - if:
216      properties:
217        compatible:
218          contains:
219            const: samsung,usb-connector-11pin
220    then:
221      properties:
222        type:
223          const: micro
224
225anyOf:
226  - not:
227      required:
228        - typec-power-opmode
229        - new-source-frs-typec-current
230
231additionalProperties: true
232
233examples:
234  # Micro-USB connector with HS lines routed via controller (MUIC).
235  - |
236    muic-max77843 {
237      usb_con1: connector {
238        compatible = "usb-b-connector";
239        label = "micro-USB";
240        type = "micro";
241      };
242    };
243
244  # USB-C connector attached to CC controller (s2mm005), HS lines routed
245  # to companion PMIC (max77865), SS lines to USB3 PHY and SBU to DisplayPort.
246  # DisplayPort video lines are routed to the connector via SS mux in USB3 PHY.
247  - |
248    ccic: s2mm005 {
249      usb_con2: connector {
250        compatible = "usb-c-connector";
251        label = "USB-C";
252
253        ports {
254          #address-cells = <1>;
255          #size-cells = <0>;
256
257          port@0 {
258            reg = <0>;
259            usb_con_hs: endpoint {
260              remote-endpoint = <&max77865_usbc_hs>;
261            };
262          };
263          port@1 {
264            reg = <1>;
265            usb_con_ss: endpoint {
266              remote-endpoint = <&usbdrd_phy_ss>;
267            };
268          };
269          port@2 {
270            reg = <2>;
271            usb_con_sbu: endpoint {
272              remote-endpoint = <&dp_aux>;
273            };
274          };
275        };
276      };
277    };
278
279  # USB-C connector attached to a typec port controller(ptn5110), which has
280  # power delivery support and enables drp.
281  - |
282    #include <dt-bindings/usb/pd.h>
283    typec: ptn5110 {
284      usb_con3: connector {
285        compatible = "usb-c-connector";
286        label = "USB-C";
287        power-role = "dual";
288        try-power-role = "sink";
289        source-pdos = <PDO_FIXED(5000, 2000, PDO_FIXED_USB_COMM)>;
290        sink-pdos = <PDO_FIXED(5000, 2000, PDO_FIXED_USB_COMM)
291                     PDO_VAR(5000, 12000, 2000)>;
292        op-sink-microwatt = <10000000>;
293      };
294    };
295
296  # USB-C connector attached to SoC and USB3 typec port controller(hd3ss3220)
297  # with SS 2:1 MUX. HS lines routed to SoC, SS lines routed to the MUX and
298  # the output of MUX is connected to the SoC.
299  - |
300    connector {
301        compatible = "usb-c-connector";
302        label = "USB-C";
303        data-role = "dual";
304
305        ports {
306                #address-cells = <1>;
307                #size-cells = <0>;
308                port@0 {
309                        reg = <0>;
310                        hs_ep: endpoint {
311                                remote-endpoint = <&usb3_hs_ep>;
312                        };
313                };
314                port@1 {
315                        reg = <1>;
316                        ss_ep: endpoint {
317                                remote-endpoint = <&hd3ss3220_in_ep>;
318                        };
319                };
320        };
321    };
322
323  # USB connector with GPIO control lines
324  - |
325    #include <dt-bindings/gpio/gpio.h>
326
327    usb {
328      connector {
329        compatible = "gpio-usb-b-connector", "usb-b-connector";
330        type = "micro";
331        id-gpios = <&pio 12 GPIO_ACTIVE_HIGH>;
332        vbus-supply = <&usb_p0_vbus>;
333      };
334    };
335
336  # Micro-USB connector with HS lines routed via controller (MUIC) and MHL
337  # lines connected to HDMI-MHL bridge (sii8620) on Samsung Exynos5433-based
338  # mobile phone
339  - |
340    muic-max77843 {
341      usb_con4: connector {
342        compatible = "samsung,usb-connector-11pin", "usb-b-connector";
343        label = "micro-USB";
344        type = "micro";
345
346        ports {
347          #address-cells = <1>;
348          #size-cells = <0>;
349
350          port@0 {
351            reg = <0>;
352            muic_to_usb: endpoint {
353              remote-endpoint = <&usb_to_muic>;
354            };
355          };
356          port@3 {
357            reg = <3>;
358            usb_con_mhl: endpoint {
359              remote-endpoint = <&sii8620_mhl>;
360            };
361          };
362        };
363      };
364    };
365