Documentation/devicetree/bindings/usb/ci-hdrc-usb2.txt

   1 * USB2 ChipIdea USB controller for ci13xxx
   2
   3 Required properties:
   4 - compatible: should be one of:
   5         "fsl,imx23-usb"
   6         "fsl,imx27-usb"
   7         "fsl,imx28-usb"
   8         "fsl,imx6q-usb"
   9         "fsl,imx6sl-usb"
  10         "fsl,imx6sx-usb"
  11         "fsl,imx6ul-usb"
  12         "fsl,imx7d-usb"
  13         "lsi,zevio-usb"
  14         "qcom,ci-hdrc"
  15         "chipidea,usb2"
  16         "xlnx,zynq-usb-2.20a"
  17 - reg: base address and length of the registers
  18 - interrupts: interrupt for the USB controller
  19
  20 Recommended properies:
  21 - phy_type: the type of the phy connected to the core. Should be one
  22   of "utmi", "utmi_wide", "ulpi", "serial" or "hsic". Without this
  23   property the PORTSC register won't be touched.
  24 - dr_mode: One of "host", "peripheral" or "otg". Defaults to "otg"
  25
  26 Deprecated properties:
  27 - usb-phy:      phandle for the PHY device. Use "phys" instead.
  28 - fsl,usbphy: phandle of usb phy that connects to the port. Use "phys" instead.
  29
  30 Optional properties:
  31 - clocks: reference to the USB clock
  32 - phys: reference to the USB PHY
  33 - phy-names: should be "usb-phy"
  34 - vbus-supply: reference to the VBUS regulator
  35 - maximum-speed: limit the maximum connection speed to "full-speed".
  36 - tpl-support: TPL (Targeted Peripheral List) feature for targeted hosts
  37 - itc-setting: interrupt threshold control register control, the setting
  38   should be aligned with ITC bits at register USBCMD.
  39 - ahb-burst-config: it is vendor dependent, the required value should be
  40   aligned with AHBBRST at SBUSCFG, the range is from 0x0 to 0x7. This
  41   property is used to change AHB burst configuration, check the chipidea
  42   spec for meaning of each value. If this property is not existed, it
  43   will use the reset value.
  44 - tx-burst-size-dword: it is vendor dependent, the tx burst size in dword
  45   (4 bytes), This register represents the maximum length of a the burst
  46   in 32-bit words while moving data from system memory to the USB
  47   bus, the value of this property will only take effect if property
  48   "ahb-burst-config" is set to 0, if this property is missing the reset
  49   default of the hardware implementation will be used.
  50 - rx-burst-size-dword: it is vendor dependent, the rx burst size in dword
  51   (4 bytes), This register represents the maximum length of a the burst
  52   in 32-bit words while moving data from the USB bus to system memory,
  53   the value of this property will only take effect if property
  54   "ahb-burst-config" is set to 0, if this property is missing the reset
  55   default of the hardware implementation will be used.
  56 - extcon: phandles to external connector devices. First phandle should point to
  57   external connector, which provide "USB" cable events, the second should point
  58   to external connector device, which provide "USB-HOST" cable events. If one
  59   of the external connector devices is not required, empty <0> phandle should
  60   be specified.
  61 - phy-clkgate-delay-us: the delay time (us) between putting the PHY into
  62   low power mode and gating the PHY clock.
  63 - non-zero-ttctrl-ttha: after setting this property, the value of register
  64   ttctrl.ttha will be 0x7f; if not, the value will be 0x0, this is the default
  65   value. It needs to be very carefully for setting this property, it is
  66   recommended that consult with your IC engineer before setting this value.
  67   On the most of chipidea platforms, the "usage_tt" flag at RTL is 0, so this
  68   property only affects siTD.
  69   If this property is not set, the max packet size is 1023 bytes, and if
  70   the total of packet size for pervious transactions are more than 256 bytes,
  71   it can't accept any transactions within this frame. The use case is single
  72   transaction, but higher frame rate.
  73   If this property is set, the max packet size is 188 bytes, it can handle
  74   more transactions than above case, it can accept transactions until it
  75   considers the left room size within frame is less than 188 bytes, software
  76   needs to make sure it does not send more than 90%
  77   maximum_periodic_data_per_frame. The use case is multiple transactions, but
  78   less frame rate.
  79 - mux-controls: The mux control for toggling host/device output of this
  80   controller. It's expected that a mux state of 0 indicates device mode and a
  81   mux state of 1 indicates host mode.
  82 - mux-control-names: Shall be "usb_switch" if mux-controls is specified.
  83 - pinctrl-names: Names for optional pin modes in "default", "host", "device".
  84   In case of HSIC-mode, "idle" and "active" pin modes are mandatory. In this
  85   case, the "idle" state needs to pull down the data and strobe pin
  86   and the "active" state needs to pull up the strobe pin.
  87 - pinctrl-n: alternate pin modes
  88
  89 i.mx specific properties
  90 - fsl,usbmisc: phandler of non-core register device, with one
  91   argument that indicate usb controller index
  92 - disable-over-current: disable over current detect
  93 - over-current-active-low: over current signal polarity is active low.
  94 - over-current-active-high: over current signal polarity is active high.
  95   It's recommended to specify the over current polarity.
  96 - power-active-high: power signal polarity is active high
  97 - external-vbus-divider: enables off-chip resistor divider for Vbus
  98
  99 Example:
 100
 101         usb@f7ed0000 {
 102                 compatible = "chipidea,usb2";
 103                 reg = <0xf7ed0000 0x10000>;
 104                 interrupts = <GIC_SPI 11 IRQ_TYPE_LEVEL_HIGH>;
 105                 clocks = <&chip CLKID_USB0>;
 106                 phys = <&usb_phy0>;
 107                 phy-names = "usb-phy";
 108                 vbus-supply = <&reg_usb0_vbus>;
 109                 itc-setting = <0x4>; /* 4 micro-frames */
 110                  /* Incremental burst of unspecified length */
 111                 ahb-burst-config = <0x0>;
 112                 tx-burst-size-dword = <0x10>; /* 64 bytes */
 113                 rx-burst-size-dword = <0x10>;
 114                 extcon = <0>, <&usb_id>;
 115                 phy-clkgate-delay-us = <400>;
 116                 mux-controls = <&usb_switch>;
 117                 mux-control-names = "usb_switch";
 118         };
 119
 120 Example for HSIC:
 121
 122         usb@2184400 {
 123                 compatible = "fsl,imx6q-usb", "fsl,imx27-usb";
 124                 reg = <0x02184400 0x200>;
 125                 interrupts = <0 41 IRQ_TYPE_LEVEL_HIGH>;
 126                 clocks = <&clks IMX6QDL_CLK_USBOH3>;
 127                 fsl,usbphy = <&usbphynop1>;
 128                 fsl,usbmisc = <&usbmisc 2>;
 129                 phy_type = "hsic";
 130                 dr_mode = "host";
 131                 ahb-burst-config = <0x0>;
 132                 tx-burst-size-dword = <0x10>;
 133                 rx-burst-size-dword = <0x10>;
 134                 pinctrl-names = "idle", "active";
 135                 pinctrl-0 = <&pinctrl_usbh2_idle>;
 136                 pinctrl-1 = <&pinctrl_usbh2_active>;
 137                 #address-cells = <1>;
 138                 #size-cells = <0>;
 139
 140                 usbnet: smsc@1 {
 141                         compatible = "usb424,9730";
 142                         reg = <1>;
 143                 };
 144         };