xref: /freebsd/sys/contrib/device-tree/Bindings/phy/phy-mtk-ufs.txt (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1*c66ec88fSEmmanuel VadotMediaTek Universal Flash Storage (UFS) M-PHY binding
2*c66ec88fSEmmanuel Vadot--------------------------------------------------------
3*c66ec88fSEmmanuel Vadot
4*c66ec88fSEmmanuel VadotUFS M-PHY nodes are defined to describe on-chip UFS M-PHY hardware macro.
5*c66ec88fSEmmanuel VadotEach UFS M-PHY node should have its own node.
6*c66ec88fSEmmanuel Vadot
7*c66ec88fSEmmanuel VadotTo bind UFS M-PHY with UFS host controller, the controller node should
8*c66ec88fSEmmanuel Vadotcontain a phandle reference to UFS M-PHY node.
9*c66ec88fSEmmanuel Vadot
10*c66ec88fSEmmanuel VadotRequired properties for UFS M-PHY nodes:
11*c66ec88fSEmmanuel Vadot- compatible         : Compatible list, contains the following controller:
12*c66ec88fSEmmanuel Vadot                       "mediatek,mt8183-ufsphy" for ufs phy
13*c66ec88fSEmmanuel Vadot                       persent on MT81xx chipsets.
14*c66ec88fSEmmanuel Vadot- reg                : Address and length of the UFS M-PHY register set.
15*c66ec88fSEmmanuel Vadot- #phy-cells         : This property shall be set to 0.
16*c66ec88fSEmmanuel Vadot- clocks             : List of phandle and clock specifier pairs.
17*c66ec88fSEmmanuel Vadot- clock-names        : List of clock input name strings sorted in the same
18*c66ec88fSEmmanuel Vadot                       order as the clocks property. Following clocks are
19*c66ec88fSEmmanuel Vadot                       mandatory.
20*c66ec88fSEmmanuel Vadot                       "unipro": Unipro core control clock.
21*c66ec88fSEmmanuel Vadot                       "mp": M-PHY core control clock.
22*c66ec88fSEmmanuel Vadot
23*c66ec88fSEmmanuel VadotExample:
24*c66ec88fSEmmanuel Vadot
25*c66ec88fSEmmanuel Vadot	ufsphy: phy@11fa0000 {
26*c66ec88fSEmmanuel Vadot		compatible = "mediatek,mt8183-ufsphy";
27*c66ec88fSEmmanuel Vadot		reg = <0 0x11fa0000 0 0xc000>;
28*c66ec88fSEmmanuel Vadot		#phy-cells = <0>;
29*c66ec88fSEmmanuel Vadot
30*c66ec88fSEmmanuel Vadot		clocks = <&infracfg_ao INFRACFG_AO_UNIPRO_SCK_CG>,
31*c66ec88fSEmmanuel Vadot			 <&infracfg_ao INFRACFG_AO_UFS_MP_SAP_BCLK_CG>;
32*c66ec88fSEmmanuel Vadot		clock-names = "unipro", "mp";
33*c66ec88fSEmmanuel Vadot	};
34*c66ec88fSEmmanuel Vadot
35*c66ec88fSEmmanuel Vadot	ufshci@11270000 {
36*c66ec88fSEmmanuel Vadot		...
37*c66ec88fSEmmanuel Vadot		phys = <&ufsphy>;
38*c66ec88fSEmmanuel Vadot	};
39