]> git.karo-electronics.de Git - karo-tx-linux.git/blob - Documentation/devicetree/bindings/usb/ci-hdrc-usb2.txt
doc: dt-binding: ci-hdrc-usb2: improve property description
[karo-tx-linux.git] / 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,imx27-usb"
6         "lsi,zevio-usb"
7         "qcom,ci-hdrc"
8         "chipidea,usb2"
9         "xlnx,zynq-usb-2.20a"
10 - reg: base address and length of the registers
11 - interrupts: interrupt for the USB controller
12
13 Recommended properies:
14 - phy_type: the type of the phy connected to the core. Should be one
15   of "utmi", "utmi_wide", "ulpi", "serial" or "hsic". Without this
16   property the PORTSC register won't be touched.
17 - dr_mode: One of "host", "peripheral" or "otg". Defaults to "otg"
18
19 Deprecated properties:
20 - usb-phy:      phandle for the PHY device. Use "phys" instead.
21 - fsl,usbphy: phandle of usb phy that connects to the port. Use "phys" instead.
22
23 Optional properties:
24 - clocks: reference to the USB clock
25 - phys: reference to the USB PHY
26 - phy-names: should be "usb-phy"
27 - vbus-supply: reference to the VBUS regulator
28 - maximum-speed: limit the maximum connection speed to "full-speed".
29 - tpl-support: TPL (Targeted Peripheral List) feature for targeted hosts
30 - fsl,usbmisc: (FSL only) phandler of non-core register device, with one
31   argument that indicate usb controller index
32 - disable-over-current: (FSL only) disable over current detect
33 - external-vbus-divider: (FSL only) enables off-chip resistor divider for Vbus
34 - itc-setting: interrupt threshold control register control, the setting
35   should be aligned with ITC bits at register USBCMD.
36 - ahb-burst-config: it is vendor dependent, the required value should be
37   aligned with AHBBRST at SBUSCFG, the range is from 0x0 to 0x7. This
38   property is used to change AHB burst configuration, check the chipidea
39   spec for meaning of each value. If this property is not existed, it
40   will use the reset value.
41 - tx-burst-size-dword: it is vendor dependent, the tx burst size in dword
42   (4 bytes), This register represents the maximum length of a the burst
43   in 32-bit words while moving data from system memory to the USB
44   bus, the value of this property will only take effect if property
45   "ahb-burst-config" is set to 0, if this property is missing the reset
46   default of the hardware implementation will be used.
47 - rx-burst-size-dword: it is vendor dependent, the rx burst size in dword
48   (4 bytes), This register represents the maximum length of a the burst
49   in 32-bit words while moving data from the USB bus to system memory,
50   the value of this property will only take effect if property
51   "ahb-burst-config" is set to 0, if this property is missing the reset
52   default of the hardware implementation will be used.
53 - extcon: phandles to external connector devices. First phandle should point to
54   external connector, which provide "USB" cable events, the second should point
55   to external connector device, which provide "USB-HOST" cable events. If one
56   of the external connector devices is not required, empty <0> phandle should
57   be specified.
58 - phy-clkgate-delay-us: the delay time (us) between putting the PHY into
59   low power mode and gating the PHY clock.
60
61 Example:
62
63         usb@f7ed0000 {
64                 compatible = "chipidea,usb2";
65                 reg = <0xf7ed0000 0x10000>;
66                 interrupts = <GIC_SPI 11 IRQ_TYPE_LEVEL_HIGH>;
67                 clocks = <&chip CLKID_USB0>;
68                 phys = <&usb_phy0>;
69                 phy-names = "usb-phy";
70                 vbus-supply = <&reg_usb0_vbus>;
71                 gadget-itc-setting = <0x4>; /* 4 micro-frames */
72                  /* Incremental burst of unspecified length */
73                 ahb-burst-config = <0x0>;
74                 tx-burst-size-dword = <0x10>; /* 64 bytes */
75                 rx-burst-size-dword = <0x10>;
76                 extcon = <0>, <&usb_id>;
77                 phy-clkgate-delay-us = <400>;
78         };