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