Merge tag 'fuse-update-4.18' of git://git.kernel.org/pub/scm/linux/kernel/git/mszered...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / connector / usb-connector.txt
1 USB Connector
2 =============
3
4 USB connector node represents physical USB connector. It should be
5 a child of USB interface controller.
6
7 Required properties:
8 - compatible: describes type of the connector, must be one of:
9     "usb-a-connector",
10     "usb-b-connector",
11     "usb-c-connector".
12
13 Optional properties:
14 - label: symbolic name for the connector,
15 - type: size of the connector, should be specified in case of USB-A, USB-B
16   non-fullsize connectors: "mini", "micro".
17
18 Required nodes:
19 - any data bus to the connector should be modeled using the OF graph bindings
20   specified in bindings/graph.txt, unless the bus is between parent node and
21   the connector. Since single connector can have multpile data buses every bus
22   has assigned OF graph port number as follows:
23     0: High Speed (HS), present in all connectors,
24     1: Super Speed (SS), present in SS capable connectors,
25     2: Sideband use (SBU), present in USB-C.
26
27 Examples
28 --------
29
30 1. Micro-USB connector with HS lines routed via controller (MUIC):
31
32 muic-max77843@66 {
33         ...
34         usb_con: connector {
35                 compatible = "usb-b-connector";
36                 label = "micro-USB";
37                 type = "micro";
38         };
39 };
40
41 2. USB-C connector attached to CC controller (s2mm005), HS lines routed
42 to companion PMIC (max77865), SS lines to USB3 PHY and SBU to DisplayPort.
43 DisplayPort video lines are routed to the connector via SS mux in USB3 PHY.
44
45 ccic: s2mm005@33 {
46         ...
47         usb_con: connector {
48                 compatible = "usb-c-connector";
49                 label = "USB-C";
50
51                 ports {
52                         #address-cells = <1>;
53                         #size-cells = <0>;
54
55                         port@0 {
56                                 reg = <0>;
57                                 usb_con_hs: endpoint {
58                                         remote-endpoint = <&max77865_usbc_hs>;
59                                 };
60                         };
61                         port@1 {
62                                 reg = <1>;
63                                 usb_con_ss: endpoint {
64                                         remote-endpoint = <&usbdrd_phy_ss>;
65                                 };
66                         };
67                         port@2 {
68                                 reg = <2>;
69                                 usb_con_sbu: endpoint {
70                                         remote-endpoint = <&dp_aux>;
71                                 };
72                         };
73                 };
74         };
75 };