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 Optional properties for usb-c-connector:
  19 - power-role: should be one of "source", "sink" or "dual"(DRP) if typec
  20   connector has power support.
  21 - try-power-role: preferred power role if "dual"(DRP) can support Try.SNK
  22   or Try.SRC, should be "sink" for Try.SNK or "source" for Try.SRC.
  23 - data-role: should be one of "host", "device", "dual"(DRD) if typec
  24   connector supports USB data.
  25
  26 Required properties for usb-c-connector with power delivery support:
  27 - source-pdos: An array of u32 with each entry providing supported power
  28   source data object(PDO), the detailed bit definitions of PDO can be found
  29   in "Universal Serial Bus Power Delivery Specification" chapter 6.4.1.2
  30   Source_Capabilities Message, the order of each entry(PDO) should follow
  31   the PD spec chapter 6.4.1. Required for power source and power dual role.
  32   User can specify the source PDO array via PDO_FIXED/BATT/VAR/PPS_APDO()
  33   defined in dt-bindings/usb/pd.h.
  34 - sink-pdos: An array of u32 with each entry providing supported power
  35   sink data object(PDO), the detailed bit definitions of PDO can be found
  36   in "Universal Serial Bus Power Delivery Specification" chapter 6.4.1.3
  37   Sink Capabilities Message, the order of each entry(PDO) should follow
  38   the PD spec chapter 6.4.1. Required for power sink and power dual role.
  39   User can specify the sink PDO array via PDO_FIXED/BATT/VAR/PPS_APDO() defined
  40   in dt-bindings/usb/pd.h.
  41 - op-sink-microwatt: Sink required operating power in microwatt, if source
  42   can't offer the power, Capability Mismatch is set. Required for power
  43   sink and power dual role.
  44
  45 Required nodes:
  46 - any data bus to the connector should be modeled using the OF graph bindings
  47   specified in bindings/graph.txt, unless the bus is between parent node and
  48   the connector. Since single connector can have multpile data buses every bus
  49   has assigned OF graph port number as follows:
  50     0: High Speed (HS), present in all connectors,
  51     1: Super Speed (SS), present in SS capable connectors,
  52     2: Sideband use (SBU), present in USB-C.
  53
  54 Examples
  55 --------
  56
  57 1. Micro-USB connector with HS lines routed via controller (MUIC):
  58
  59 muic-max77843@66 {
  60         ...
  61         usb_con: connector {
  62                 compatible = "usb-b-connector";
  63                 label = "micro-USB";
  64                 type = "micro";
  65         };
  66 };
  67
  68 2. USB-C connector attached to CC controller (s2mm005), HS lines routed
  69 to companion PMIC (max77865), SS lines to USB3 PHY and SBU to DisplayPort.
  70 DisplayPort video lines are routed to the connector via SS mux in USB3 PHY.
  71
  72 ccic: s2mm005@33 {
  73         ...
  74         usb_con: connector {
  75                 compatible = "usb-c-connector";
  76                 label = "USB-C";
  77
  78                 ports {
  79                         #address-cells = <1>;
  80                         #size-cells = <0>;
  81
  82                         port@0 {
  83                                 reg = <0>;
  84                                 usb_con_hs: endpoint {
  85                                         remote-endpoint = <&max77865_usbc_hs>;
  86                                 };
  87                         };
  88                         port@1 {
  89                                 reg = <1>;
  90                                 usb_con_ss: endpoint {
  91                                         remote-endpoint = <&usbdrd_phy_ss>;
  92                                 };
  93                         };
  94                         port@2 {
  95                                 reg = <2>;
  96                                 usb_con_sbu: endpoint {
  97                                         remote-endpoint = <&dp_aux>;
  98                                 };
  99                         };
 100                 };
 101         };
 102 };
 103
 104 3. USB-C connector attached to a typec port controller(ptn5110), which has
 105 power delivery support and enables drp.
 106
 107 typec: ptn5110@50 {
 108         ...
 109         usb_con: connector {
 110                 compatible = "usb-c-connector";
 111                 label = "USB-C";
 112                 power-role = "dual";
 113                 try-power-role = "sink";
 114                 source-pdos = <PDO_FIXED(5000, 2000, PDO_FIXED_USB_COMM)>;
 115                 sink-pdos = <PDO_FIXED(5000, 2000, PDO_FIXED_USB_COMM)
 116                              PDO_VAR(5000, 12000, 2000)>;
 117                 op-sink-microwatt = <10000000>;
 118         };
 119 };