xref: /freebsd/sys/contrib/device-tree/Bindings/ufs/ufshcd-pltfrm.txt (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1* Universal Flash Storage (UFS) Host Controller
2
3UFSHC nodes are defined to describe on-chip UFS host controllers.
4Each UFS controller instance should have its own node.
5
6Required properties:
7- compatible		: must contain "jedec,ufs-1.1" or "jedec,ufs-2.0"
8
9			  For Qualcomm SoCs must contain, as below, an
10			  SoC-specific compatible along with "qcom,ufshc" and
11			  the appropriate jedec string:
12			    "qcom,msm8994-ufshc", "qcom,ufshc", "jedec,ufs-2.0"
13			    "qcom,msm8996-ufshc", "qcom,ufshc", "jedec,ufs-2.0"
14			    "qcom,msm8998-ufshc", "qcom,ufshc", "jedec,ufs-2.0"
15			    "qcom,sdm845-ufshc", "qcom,ufshc", "jedec,ufs-2.0"
16			    "qcom,sm8150-ufshc", "qcom,ufshc", "jedec,ufs-2.0"
17			    "qcom,sm8250-ufshc", "qcom,ufshc", "jedec,ufs-2.0"
18			    "qcom,sm8350-ufshc", "qcom,ufshc", "jedec,ufs-2.0"
19			    "qcom,sm8450-ufshc", "qcom,ufshc", "jedec,ufs-2.0"
20- interrupts        : <interrupt mapping for UFS host controller IRQ>
21- reg               : <registers mapping>
22
23Optional properties:
24- phys                  : phandle to UFS PHY node
25- phy-names             : the string "ufsphy" when is found in a node, along
26                          with "phys" attribute, provides phandle to UFS PHY node
27- vdd-hba-supply        : phandle to UFS host controller supply regulator node
28- vcc-supply            : phandle to VCC supply regulator node
29- vccq-supply           : phandle to VCCQ supply regulator node
30- vccq2-supply          : phandle to VCCQ2 supply regulator node
31- vcc-supply-1p8        : For embedded UFS devices, valid VCC range is 1.7-1.95V
32                          or 2.7-3.6V. This boolean property when set, specifies
33			  to use low voltage range of 1.7-1.95V. Note for external
34			  UFS cards this property is invalid and valid VCC range is
35			  always 2.7-3.6V.
36- vcc-max-microamp      : specifies max. load that can be drawn from vcc supply
37- vccq-max-microamp     : specifies max. load that can be drawn from vccq supply
38- vccq2-max-microamp    : specifies max. load that can be drawn from vccq2 supply
39
40- clocks                : List of phandle and clock specifier pairs
41- clock-names           : List of clock input name strings sorted in the same
42                          order as the clocks property.
43			  "ref_clk" indicates reference clock frequency.
44			  UFS host supplies reference clock to UFS device and UFS device
45			  specification allows host to provide one of the 4 frequencies (19.2 MHz,
46			  26 MHz, 38.4 MHz, 52MHz) for reference clock. This "ref_clk" entry is
47			  parsed and used to update the reference clock setting in device.
48			  Defaults to 26 MHz(as per specification) if not specified by host.
49- freq-table-hz		: Array of <min max> operating frequencies stored in the same
50                          order as the clocks property. If this property is not
51			  defined or a value in the array is "0" then it is assumed
52			  that the frequency is set by the parent clock or a
53			  fixed rate clock source.
54-lanes-per-direction	: number of lanes available per direction - either 1 or 2.
55			  Note that it is assume same number of lanes is used both
56			  directions at once. If not specified, default is 2 lanes per direction.
57- #reset-cells		: Must be <1> for Qualcomm UFS controllers that expose
58			  PHY reset from the UFS controller.
59- resets            : reset node register
60- reset-names       : describe reset node register, the "rst" corresponds to reset the whole UFS IP.
61- reset-gpios       : A phandle and gpio specifier denoting the GPIO connected
62		      to the RESET pin of the UFS memory device.
63
64Note: If above properties are not defined it can be assumed that the supply
65regulators or clocks are always on.
66
67Example:
68	ufshc@fc598000 {
69		compatible = "jedec,ufs-1.1";
70		reg = <0xfc598000 0x800>;
71		interrupts = <0 28 0>;
72
73		vdd-hba-supply = <&xxx_reg0>;
74		vcc-supply = <&xxx_reg1>;
75		vcc-supply-1p8;
76		vccq-supply = <&xxx_reg2>;
77		vccq2-supply = <&xxx_reg3>;
78		vcc-max-microamp = 500000;
79		vccq-max-microamp = 200000;
80		vccq2-max-microamp = 200000;
81
82		clocks = <&core 0>, <&ref 0>, <&phy 0>, <&iface 0>;
83		clock-names = "core_clk", "ref_clk", "phy_clk", "iface_clk";
84		freq-table-hz = <100000000 200000000>, <0 0>, <0 0>, <0 0>;
85		resets = <&reset 0 1>;
86		reset-names = "rst";
87		phys = <&ufsphy1>;
88		phy-names = "ufsphy";
89		#reset-cells = <1>;
90	};
91