[deliverable/linux.git] / Documentation / devicetree / bindings / phy / phy-bindings.txt

This document explains only the device tree data binding. For general
information about PHY subsystem refer to Documentation/phy.txt

PHY device node
===============

Required Properties:
#phy-cells:	Number of cells in a PHY specifier;  The meaning of all those
		cells is defined by the binding for the phy node. The PHY
		provider can use the values in cells to find the appropriate
		PHY.

Optional Properties:
phy-supply:	Phandle to a regulator that provides power to the PHY. This
		regulator will be managed during the PHY power on/off sequence.

For example:

phys: phy {
    compatible = "xxx";
    reg = <...>;
    .
    .
    #phy-cells = <1>;
    .
    .
};

That node describes an IP block (PHY provider) that implements 2 different PHYs.
In order to differentiate between these 2 PHYs, an additional specifier should be
given while trying to get a reference to it.

PHY user node
=============

Required Properties:
phys : the phandle for the PHY device (used by the PHY subsystem)
phy-names : the names of the PHY corresponding to the PHYs present in the
	    *phys* phandle

Example 1:
usb1: usb_otg_ss@xxx {
    compatible = "xxx";
    reg = <xxx>;
    .
    .
    phys = <&usb2_phy>, <&usb3_phy>;
    phy-names = "usb2phy", "usb3phy";
    .
    .
};

This node represents a controller that uses two PHYs, one for usb2 and one for
usb3.

Example 2:
usb2: usb_otg_ss@xxx {
    compatible = "xxx";
    reg = <xxx>;
    .
    .
    phys = <&phys 1>;
    phy-names = "usbphy";
    .
    .
};

This node represents a controller that uses one of the PHYs of the PHY provider
device defined previously. Note that the phy handle has an additional specifier
"1" to differentiate between the two PHYs.
Commit	Line	Data
ff764963 KVA	1	This document explains only the device tree data binding. For general
	2	information about PHY subsystem refer to Documentation/phy.txt
	3
	4	PHY device node
	5	===============
	6
	7	Required Properties:
	8	#phy-cells: Number of cells in a PHY specifier; The meaning of all those
	9	cells is defined by the binding for the phy node. The PHY
	10	provider can use the values in cells to find the appropriate
	11	PHY.
	12
e9e8cf49 RQ	13	Optional Properties:
	14	phy-supply: Phandle to a regulator that provides power to the PHY. This
	15	regulator will be managed during the PHY power on/off sequence.
	16
ff764963 KVA	17	For example:
	18
	19	phys: phy {
	20	compatible = "xxx";
	21	reg = <...>;
	22	.
	23	.
	24	#phy-cells = <1>;
	25	.
	26	.
	27	};
	28
	29	That node describes an IP block (PHY provider) that implements 2 different PHYs.
24488c39	30	In order to differentiate between these 2 PHYs, an additional specifier should be
ff764963 KVA	31	given while trying to get a reference to it.
	32
	33	PHY user node
	34	=============
	35
	36	Required Properties:
	37	phys : the phandle for the PHY device (used by the PHY subsystem)
	38	phy-names : the names of the PHY corresponding to the PHYs present in the
	39	phys phandle
	40
	41	Example 1:
	42	usb1: usb_otg_ss@xxx {
	43	compatible = "xxx";
	44	reg = <xxx>;
	45	.
	46	.
	47	phys = <&usb2_phy>, <&usb3_phy>;
	48	phy-names = "usb2phy", "usb3phy";
	49	.
	50	.
	51	};
	52
	53	This node represents a controller that uses two PHYs, one for usb2 and one for
	54	usb3.
	55
	56	Example 2:
	57	usb2: usb_otg_ss@xxx {
	58	compatible = "xxx";
	59	reg = <xxx>;
	60	.
	61	.
	62	phys = <&phys 1>;
	63	phy-names = "usbphy";
	64	.
	65	.
	66	};
	67
	68	This node represents a controller that uses one of the PHYs of the PHY provider
	69	device defined previously. Note that the phy handle has an additional specifier
	70	"1" to differentiate between the two PHYs.