[deliverable/linux.git] / Documentation / devicetree / bindings / usb / generic.txt

Generic USB Properties

Optional properties:
 - maximum-speed: tells USB controllers we want to work up to a certain
			speed. Valid arguments are "super-speed", "high-speed",
			"full-speed" and "low-speed". In case this isn't passed
			via DT, USB controllers should default to their maximum
			HW capability.
 - dr_mode: tells Dual-Role USB controllers that we want to work on a
			particular mode. Valid arguments are "host",
			"peripheral" and "otg". In case this attribute isn't
			passed via DT, USB DRD controllers should default to
			OTG.
 - otg-rev: tells usb driver the release number of the OTG and EH supplement
			with which the device and its descriptors are compliant,
			in binary-coded decimal (i.e. 2.0 is 0200H). This
			property is used if any real OTG features(HNP/SRP/ADP)
			is enabled, if ADP is required, otg-rev should be
			0x0200 or above.
 - hnp-disable: tells OTG controllers we want to disable OTG HNP, normally HNP
			is the basic function of real OTG except you want it
			to be a srp-capable only B device.
 - srp-disable: tells OTG controllers we want to disable OTG SRP, SRP is
			optional for OTG device.
 - adp-disable: tells OTG controllers we want to disable OTG ADP, ADP is
			optional for OTG device.

This is an attribute to a USB controller such as:

dwc3@4a030000 {
	compatible = "synopsys,dwc3";
	reg = <0x4a030000 0xcfff>;
	interrupts = <0 92 4>
	usb-phy = <&usb2_phy>, <&usb3,phy>;
	maximum-speed = "super-speed";
	dr_mode = "otg";
	otg-rev = <0x0200>;
	adp-disable;
};
Commit	Line	Data
1494a1f6 FB	1	Generic USB Properties
	2
	3	Optional properties:
	4	- maximum-speed: tells USB controllers we want to work up to a certain
	5	speed. Valid arguments are "super-speed", "high-speed",
	6	"full-speed" and "low-speed". In case this isn't passed
	7	via DT, USB controllers should default to their maximum
	8	HW capability.
	9	- dr_mode: tells Dual-Role USB controllers that we want to work on a
	10	particular mode. Valid arguments are "host",
	11	"peripheral" and "otg". In case this attribute isn't
	12	passed via DT, USB DRD controllers should default to
	13	OTG.
b5513ded LJ	14	- otg-rev: tells usb driver the release number of the OTG and EH supplement
	15	with which the device and its descriptors are compliant,
	16	in binary-coded decimal (i.e. 2.0 is 0200H). This
	17	property is used if any real OTG features(HNP/SRP/ADP)
	18	is enabled, if ADP is required, otg-rev should be
	19	0x0200 or above.
	20	- hnp-disable: tells OTG controllers we want to disable OTG HNP, normally HNP
	21	is the basic function of real OTG except you want it
	22	to be a srp-capable only B device.
	23	- srp-disable: tells OTG controllers we want to disable OTG SRP, SRP is
	24	optional for OTG device.
	25	- adp-disable: tells OTG controllers we want to disable OTG ADP, ADP is
	26	optional for OTG device.
1494a1f6 FB	27
	28	This is an attribute to a USB controller such as:
	29
	30	dwc3@4a030000 {
	31	compatible = "synopsys,dwc3";
	32	reg = <0x4a030000 0xcfff>;
	33	interrupts = <0 92 4>
	34	usb-phy = <&usb2_phy>, <&usb3,phy>;
	35	maximum-speed = "super-speed";
	36	dr_mode = "otg";
b5513ded LJ	37	otg-rev = <0x0200>;
b5513ded LJ	38	adp-disable;
1494a1f6	39	};