xref: /OK3568_Linux_fs/kernel/drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun 
3*4882a593Smuzhiyun #include <linux/clk.h>
4*4882a593Smuzhiyun #include <linux/err.h>
5*4882a593Smuzhiyun #include <linux/io.h>
6*4882a593Smuzhiyun #include <linux/module.h>
7*4882a593Smuzhiyun #include <linux/of_device.h>
8*4882a593Smuzhiyun #include <linux/phy/phy.h>
9*4882a593Smuzhiyun #include <linux/platform_device.h>
10*4882a593Smuzhiyun #include <linux/delay.h>
11*4882a593Smuzhiyun #include <linux/regmap.h>
12*4882a593Smuzhiyun #include <linux/mfd/syscon.h>
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun /* USB QSCRATCH Hardware registers */
15*4882a593Smuzhiyun #define QSCRATCH_GENERAL_CFG		(0x08)
16*4882a593Smuzhiyun #define HSUSB_PHY_CTRL_REG		(0x10)
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun /* PHY_CTRL_REG */
19*4882a593Smuzhiyun #define HSUSB_CTRL_DMSEHV_CLAMP		BIT(24)
20*4882a593Smuzhiyun #define HSUSB_CTRL_USB2_SUSPEND		BIT(23)
21*4882a593Smuzhiyun #define HSUSB_CTRL_UTMI_CLK_EN		BIT(21)
22*4882a593Smuzhiyun #define HSUSB_CTRL_UTMI_OTG_VBUS_VALID	BIT(20)
23*4882a593Smuzhiyun #define HSUSB_CTRL_USE_CLKCORE		BIT(18)
24*4882a593Smuzhiyun #define HSUSB_CTRL_DPSEHV_CLAMP		BIT(17)
25*4882a593Smuzhiyun #define HSUSB_CTRL_COMMONONN		BIT(11)
26*4882a593Smuzhiyun #define HSUSB_CTRL_ID_HV_CLAMP		BIT(9)
27*4882a593Smuzhiyun #define HSUSB_CTRL_OTGSESSVLD_CLAMP	BIT(8)
28*4882a593Smuzhiyun #define HSUSB_CTRL_CLAMP_EN		BIT(7)
29*4882a593Smuzhiyun #define HSUSB_CTRL_RETENABLEN		BIT(1)
30*4882a593Smuzhiyun #define HSUSB_CTRL_POR			BIT(0)
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun /* QSCRATCH_GENERAL_CFG */
33*4882a593Smuzhiyun #define HSUSB_GCFG_XHCI_REV		BIT(2)
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun /* USB QSCRATCH Hardware registers */
36*4882a593Smuzhiyun #define SSUSB_PHY_CTRL_REG		(0x00)
37*4882a593Smuzhiyun #define SSUSB_PHY_PARAM_CTRL_1		(0x04)
38*4882a593Smuzhiyun #define SSUSB_PHY_PARAM_CTRL_2		(0x08)
39*4882a593Smuzhiyun #define CR_PROTOCOL_DATA_IN_REG		(0x0c)
40*4882a593Smuzhiyun #define CR_PROTOCOL_DATA_OUT_REG	(0x10)
41*4882a593Smuzhiyun #define CR_PROTOCOL_CAP_ADDR_REG	(0x14)
42*4882a593Smuzhiyun #define CR_PROTOCOL_CAP_DATA_REG	(0x18)
43*4882a593Smuzhiyun #define CR_PROTOCOL_READ_REG		(0x1c)
44*4882a593Smuzhiyun #define CR_PROTOCOL_WRITE_REG		(0x20)
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun /* PHY_CTRL_REG */
47*4882a593Smuzhiyun #define SSUSB_CTRL_REF_USE_PAD		BIT(28)
48*4882a593Smuzhiyun #define SSUSB_CTRL_TEST_POWERDOWN	BIT(27)
49*4882a593Smuzhiyun #define SSUSB_CTRL_LANE0_PWR_PRESENT	BIT(24)
50*4882a593Smuzhiyun #define SSUSB_CTRL_SS_PHY_EN		BIT(8)
51*4882a593Smuzhiyun #define SSUSB_CTRL_SS_PHY_RESET		BIT(7)
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun /* SSPHY control registers - Does this need 0x30? */
54*4882a593Smuzhiyun #define SSPHY_CTRL_RX_OVRD_IN_HI(lane)	(0x1006 + 0x100 * (lane))
55*4882a593Smuzhiyun #define SSPHY_CTRL_TX_OVRD_DRV_LO(lane)	(0x1002 + 0x100 * (lane))
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun /* SSPHY SoC version specific values */
58*4882a593Smuzhiyun #define SSPHY_RX_EQ_VALUE		4 /* Override value for rx_eq */
59*4882a593Smuzhiyun /* Override value for transmit preemphasis */
60*4882a593Smuzhiyun #define SSPHY_TX_DEEMPH_3_5DB		23
61*4882a593Smuzhiyun /* Override value for mpll */
62*4882a593Smuzhiyun #define SSPHY_MPLL_VALUE		0
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun /* QSCRATCH PHY_PARAM_CTRL1 fields */
65*4882a593Smuzhiyun #define PHY_PARAM_CTRL1_TX_FULL_SWING_MASK	GENMASK(26, 19)
66*4882a593Smuzhiyun #define PHY_PARAM_CTRL1_TX_DEEMPH_6DB_MASK	GENMASK(19, 13)
67*4882a593Smuzhiyun #define PHY_PARAM_CTRL1_TX_DEEMPH_3_5DB_MASK	GENMASK(13, 7)
68*4882a593Smuzhiyun #define PHY_PARAM_CTRL1_LOS_BIAS_MASK		GENMASK(7, 2)
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun #define PHY_PARAM_CTRL1_MASK				\
71*4882a593Smuzhiyun 		(PHY_PARAM_CTRL1_TX_FULL_SWING_MASK |	\
72*4882a593Smuzhiyun 		 PHY_PARAM_CTRL1_TX_DEEMPH_6DB_MASK |	\
73*4882a593Smuzhiyun 		 PHY_PARAM_CTRL1_TX_DEEMPH_3_5DB_MASK |	\
74*4882a593Smuzhiyun 		 PHY_PARAM_CTRL1_LOS_BIAS_MASK)
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun #define PHY_PARAM_CTRL1_TX_FULL_SWING(x)	\
77*4882a593Smuzhiyun 		(((x) << 20) & PHY_PARAM_CTRL1_TX_FULL_SWING_MASK)
78*4882a593Smuzhiyun #define PHY_PARAM_CTRL1_TX_DEEMPH_6DB(x)	\
79*4882a593Smuzhiyun 		(((x) << 14) & PHY_PARAM_CTRL1_TX_DEEMPH_6DB_MASK)
80*4882a593Smuzhiyun #define PHY_PARAM_CTRL1_TX_DEEMPH_3_5DB(x)	\
81*4882a593Smuzhiyun 		(((x) <<  8) & PHY_PARAM_CTRL1_TX_DEEMPH_3_5DB_MASK)
82*4882a593Smuzhiyun #define PHY_PARAM_CTRL1_LOS_BIAS(x)	\
83*4882a593Smuzhiyun 		(((x) <<  3) & PHY_PARAM_CTRL1_LOS_BIAS_MASK)
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun /* RX OVRD IN HI bits */
86*4882a593Smuzhiyun #define RX_OVRD_IN_HI_RX_RESET_OVRD		BIT(13)
87*4882a593Smuzhiyun #define RX_OVRD_IN_HI_RX_RX_RESET		BIT(12)
88*4882a593Smuzhiyun #define RX_OVRD_IN_HI_RX_EQ_OVRD		BIT(11)
89*4882a593Smuzhiyun #define RX_OVRD_IN_HI_RX_EQ_MASK		GENMASK(10, 7)
90*4882a593Smuzhiyun #define RX_OVRD_IN_HI_RX_EQ(x)			((x) << 8)
91*4882a593Smuzhiyun #define RX_OVRD_IN_HI_RX_EQ_EN_OVRD		BIT(7)
92*4882a593Smuzhiyun #define RX_OVRD_IN_HI_RX_EQ_EN			BIT(6)
93*4882a593Smuzhiyun #define RX_OVRD_IN_HI_RX_LOS_FILTER_OVRD	BIT(5)
94*4882a593Smuzhiyun #define RX_OVRD_IN_HI_RX_LOS_FILTER_MASK	GENMASK(4, 2)
95*4882a593Smuzhiyun #define RX_OVRD_IN_HI_RX_RATE_OVRD		BIT(2)
96*4882a593Smuzhiyun #define RX_OVRD_IN_HI_RX_RATE_MASK		GENMASK(2, 0)
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun /* TX OVRD DRV LO register bits */
99*4882a593Smuzhiyun #define TX_OVRD_DRV_LO_AMPLITUDE_MASK		GENMASK(6, 0)
100*4882a593Smuzhiyun #define TX_OVRD_DRV_LO_PREEMPH_MASK		GENMASK(13, 6)
101*4882a593Smuzhiyun #define TX_OVRD_DRV_LO_PREEMPH(x)		((x) << 7)
102*4882a593Smuzhiyun #define TX_OVRD_DRV_LO_EN			BIT(14)
103*4882a593Smuzhiyun 
104*4882a593Smuzhiyun /* MPLL bits */
105*4882a593Smuzhiyun #define SSPHY_MPLL_MASK				GENMASK(8, 5)
106*4882a593Smuzhiyun #define SSPHY_MPLL(x)				((x) << 5)
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun /* SS CAP register bits */
109*4882a593Smuzhiyun #define SS_CR_CAP_ADDR_REG			BIT(0)
110*4882a593Smuzhiyun #define SS_CR_CAP_DATA_REG			BIT(0)
111*4882a593Smuzhiyun #define SS_CR_READ_REG				BIT(0)
112*4882a593Smuzhiyun #define SS_CR_WRITE_REG				BIT(0)
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun struct usb_phy {
115*4882a593Smuzhiyun 	void __iomem		*base;
116*4882a593Smuzhiyun 	struct device		*dev;
117*4882a593Smuzhiyun 	struct clk		*xo_clk;
118*4882a593Smuzhiyun 	struct clk		*ref_clk;
119*4882a593Smuzhiyun 	u32			rx_eq;
120*4882a593Smuzhiyun 	u32			tx_deamp_3_5db;
121*4882a593Smuzhiyun 	u32			mpll;
122*4882a593Smuzhiyun };
123*4882a593Smuzhiyun 
124*4882a593Smuzhiyun struct phy_drvdata {
125*4882a593Smuzhiyun 	struct phy_ops	ops;
126*4882a593Smuzhiyun 	u32		clk_rate;
127*4882a593Smuzhiyun };
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun /**
130*4882a593Smuzhiyun  * Write register and read back masked value to confirm it is written
131*4882a593Smuzhiyun  *
132*4882a593Smuzhiyun  * @base - QCOM DWC3 PHY base virtual address.
133*4882a593Smuzhiyun  * @offset - register offset.
134*4882a593Smuzhiyun  * @mask - register bitmask specifying what should be updated
135*4882a593Smuzhiyun  * @val - value to write.
136*4882a593Smuzhiyun  */
usb_phy_write_readback(struct usb_phy * phy_dwc3,u32 offset,const u32 mask,u32 val)137*4882a593Smuzhiyun static inline void usb_phy_write_readback(struct usb_phy *phy_dwc3,
138*4882a593Smuzhiyun 					  u32 offset,
139*4882a593Smuzhiyun 					  const u32 mask, u32 val)
140*4882a593Smuzhiyun {
141*4882a593Smuzhiyun 	u32 write_val, tmp = readl(phy_dwc3->base + offset);
142*4882a593Smuzhiyun 
143*4882a593Smuzhiyun 	tmp &= ~mask;		/* retain other bits */
144*4882a593Smuzhiyun 	write_val = tmp | val;
145*4882a593Smuzhiyun 
146*4882a593Smuzhiyun 	writel(write_val, phy_dwc3->base + offset);
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun 	/* Read back to see if val was written */
149*4882a593Smuzhiyun 	tmp = readl(phy_dwc3->base + offset);
150*4882a593Smuzhiyun 	tmp &= mask;		/* clear other bits */
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun 	if (tmp != val)
153*4882a593Smuzhiyun 		dev_err(phy_dwc3->dev, "write: %x to QSCRATCH: %x FAILED\n", val, offset);
154*4882a593Smuzhiyun }
155*4882a593Smuzhiyun 
wait_for_latch(void __iomem * addr)156*4882a593Smuzhiyun static int wait_for_latch(void __iomem *addr)
157*4882a593Smuzhiyun {
158*4882a593Smuzhiyun 	u32 retry = 10;
159*4882a593Smuzhiyun 
160*4882a593Smuzhiyun 	while (true) {
161*4882a593Smuzhiyun 		if (!readl(addr))
162*4882a593Smuzhiyun 			break;
163*4882a593Smuzhiyun 
164*4882a593Smuzhiyun 		if (--retry == 0)
165*4882a593Smuzhiyun 			return -ETIMEDOUT;
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun 		usleep_range(10, 20);
168*4882a593Smuzhiyun 	}
169*4882a593Smuzhiyun 
170*4882a593Smuzhiyun 	return 0;
171*4882a593Smuzhiyun }
172*4882a593Smuzhiyun 
173*4882a593Smuzhiyun /**
174*4882a593Smuzhiyun  * Write SSPHY register
175*4882a593Smuzhiyun  *
176*4882a593Smuzhiyun  * @base - QCOM DWC3 PHY base virtual address.
177*4882a593Smuzhiyun  * @addr - SSPHY address to write.
178*4882a593Smuzhiyun  * @val - value to write.
179*4882a593Smuzhiyun  */
usb_ss_write_phycreg(struct usb_phy * phy_dwc3,u32 addr,u32 val)180*4882a593Smuzhiyun static int usb_ss_write_phycreg(struct usb_phy *phy_dwc3,
181*4882a593Smuzhiyun 				u32 addr, u32 val)
182*4882a593Smuzhiyun {
183*4882a593Smuzhiyun 	int ret;
184*4882a593Smuzhiyun 
185*4882a593Smuzhiyun 	writel(addr, phy_dwc3->base + CR_PROTOCOL_DATA_IN_REG);
186*4882a593Smuzhiyun 	writel(SS_CR_CAP_ADDR_REG,
187*4882a593Smuzhiyun 	       phy_dwc3->base + CR_PROTOCOL_CAP_ADDR_REG);
188*4882a593Smuzhiyun 
189*4882a593Smuzhiyun 	ret = wait_for_latch(phy_dwc3->base + CR_PROTOCOL_CAP_ADDR_REG);
190*4882a593Smuzhiyun 	if (ret)
191*4882a593Smuzhiyun 		goto err_wait;
192*4882a593Smuzhiyun 
193*4882a593Smuzhiyun 	writel(val, phy_dwc3->base + CR_PROTOCOL_DATA_IN_REG);
194*4882a593Smuzhiyun 	writel(SS_CR_CAP_DATA_REG,
195*4882a593Smuzhiyun 	       phy_dwc3->base + CR_PROTOCOL_CAP_DATA_REG);
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun 	ret = wait_for_latch(phy_dwc3->base + CR_PROTOCOL_CAP_DATA_REG);
198*4882a593Smuzhiyun 	if (ret)
199*4882a593Smuzhiyun 		goto err_wait;
200*4882a593Smuzhiyun 
201*4882a593Smuzhiyun 	writel(SS_CR_WRITE_REG, phy_dwc3->base + CR_PROTOCOL_WRITE_REG);
202*4882a593Smuzhiyun 
203*4882a593Smuzhiyun 	ret = wait_for_latch(phy_dwc3->base + CR_PROTOCOL_WRITE_REG);
204*4882a593Smuzhiyun 
205*4882a593Smuzhiyun err_wait:
206*4882a593Smuzhiyun 	if (ret)
207*4882a593Smuzhiyun 		dev_err(phy_dwc3->dev, "timeout waiting for latch\n");
208*4882a593Smuzhiyun 	return ret;
209*4882a593Smuzhiyun }
210*4882a593Smuzhiyun 
211*4882a593Smuzhiyun /**
212*4882a593Smuzhiyun  * Read SSPHY register.
213*4882a593Smuzhiyun  *
214*4882a593Smuzhiyun  * @base - QCOM DWC3 PHY base virtual address.
215*4882a593Smuzhiyun  * @addr - SSPHY address to read.
216*4882a593Smuzhiyun  */
usb_ss_read_phycreg(struct usb_phy * phy_dwc3,u32 addr,u32 * val)217*4882a593Smuzhiyun static int usb_ss_read_phycreg(struct usb_phy *phy_dwc3,
218*4882a593Smuzhiyun 			       u32 addr, u32 *val)
219*4882a593Smuzhiyun {
220*4882a593Smuzhiyun 	int ret;
221*4882a593Smuzhiyun 
222*4882a593Smuzhiyun 	writel(addr, phy_dwc3->base + CR_PROTOCOL_DATA_IN_REG);
223*4882a593Smuzhiyun 	writel(SS_CR_CAP_ADDR_REG,
224*4882a593Smuzhiyun 	       phy_dwc3->base + CR_PROTOCOL_CAP_ADDR_REG);
225*4882a593Smuzhiyun 
226*4882a593Smuzhiyun 	ret = wait_for_latch(phy_dwc3->base + CR_PROTOCOL_CAP_ADDR_REG);
227*4882a593Smuzhiyun 	if (ret)
228*4882a593Smuzhiyun 		goto err_wait;
229*4882a593Smuzhiyun 
230*4882a593Smuzhiyun 	/*
231*4882a593Smuzhiyun 	 * Due to hardware bug, first read of SSPHY register might be
232*4882a593Smuzhiyun 	 * incorrect. Hence as workaround, SW should perform SSPHY register
233*4882a593Smuzhiyun 	 * read twice, but use only second read and ignore first read.
234*4882a593Smuzhiyun 	 */
235*4882a593Smuzhiyun 	writel(SS_CR_READ_REG, phy_dwc3->base + CR_PROTOCOL_READ_REG);
236*4882a593Smuzhiyun 
237*4882a593Smuzhiyun 	ret = wait_for_latch(phy_dwc3->base + CR_PROTOCOL_READ_REG);
238*4882a593Smuzhiyun 	if (ret)
239*4882a593Smuzhiyun 		goto err_wait;
240*4882a593Smuzhiyun 
241*4882a593Smuzhiyun 	/* throwaway read */
242*4882a593Smuzhiyun 	readl(phy_dwc3->base + CR_PROTOCOL_DATA_OUT_REG);
243*4882a593Smuzhiyun 
244*4882a593Smuzhiyun 	writel(SS_CR_READ_REG, phy_dwc3->base + CR_PROTOCOL_READ_REG);
245*4882a593Smuzhiyun 
246*4882a593Smuzhiyun 	ret = wait_for_latch(phy_dwc3->base + CR_PROTOCOL_READ_REG);
247*4882a593Smuzhiyun 	if (ret)
248*4882a593Smuzhiyun 		goto err_wait;
249*4882a593Smuzhiyun 
250*4882a593Smuzhiyun 	*val = readl(phy_dwc3->base + CR_PROTOCOL_DATA_OUT_REG);
251*4882a593Smuzhiyun 
252*4882a593Smuzhiyun err_wait:
253*4882a593Smuzhiyun 	return ret;
254*4882a593Smuzhiyun }
255*4882a593Smuzhiyun 
qcom_ipq806x_usb_hs_phy_init(struct phy * phy)256*4882a593Smuzhiyun static int qcom_ipq806x_usb_hs_phy_init(struct phy *phy)
257*4882a593Smuzhiyun {
258*4882a593Smuzhiyun 	struct usb_phy *phy_dwc3 = phy_get_drvdata(phy);
259*4882a593Smuzhiyun 	int ret;
260*4882a593Smuzhiyun 	u32 val;
261*4882a593Smuzhiyun 
262*4882a593Smuzhiyun 	ret = clk_prepare_enable(phy_dwc3->xo_clk);
263*4882a593Smuzhiyun 	if (ret)
264*4882a593Smuzhiyun 		return ret;
265*4882a593Smuzhiyun 
266*4882a593Smuzhiyun 	ret = clk_prepare_enable(phy_dwc3->ref_clk);
267*4882a593Smuzhiyun 	if (ret) {
268*4882a593Smuzhiyun 		clk_disable_unprepare(phy_dwc3->xo_clk);
269*4882a593Smuzhiyun 		return ret;
270*4882a593Smuzhiyun 	}
271*4882a593Smuzhiyun 
272*4882a593Smuzhiyun 	/*
273*4882a593Smuzhiyun 	 * HSPHY Initialization: Enable UTMI clock, select 19.2MHz fsel
274*4882a593Smuzhiyun 	 * enable clamping, and disable RETENTION (power-on default is ENABLED)
275*4882a593Smuzhiyun 	 */
276*4882a593Smuzhiyun 	val = HSUSB_CTRL_DPSEHV_CLAMP | HSUSB_CTRL_DMSEHV_CLAMP |
277*4882a593Smuzhiyun 		HSUSB_CTRL_RETENABLEN  | HSUSB_CTRL_COMMONONN |
278*4882a593Smuzhiyun 		HSUSB_CTRL_OTGSESSVLD_CLAMP | HSUSB_CTRL_ID_HV_CLAMP |
279*4882a593Smuzhiyun 		HSUSB_CTRL_DPSEHV_CLAMP | HSUSB_CTRL_UTMI_OTG_VBUS_VALID |
280*4882a593Smuzhiyun 		HSUSB_CTRL_UTMI_CLK_EN | HSUSB_CTRL_CLAMP_EN | 0x70;
281*4882a593Smuzhiyun 
282*4882a593Smuzhiyun 	/* use core clock if external reference is not present */
283*4882a593Smuzhiyun 	if (!phy_dwc3->xo_clk)
284*4882a593Smuzhiyun 		val |= HSUSB_CTRL_USE_CLKCORE;
285*4882a593Smuzhiyun 
286*4882a593Smuzhiyun 	writel(val, phy_dwc3->base + HSUSB_PHY_CTRL_REG);
287*4882a593Smuzhiyun 	usleep_range(2000, 2200);
288*4882a593Smuzhiyun 
289*4882a593Smuzhiyun 	/* Disable (bypass) VBUS and ID filters */
290*4882a593Smuzhiyun 	writel(HSUSB_GCFG_XHCI_REV, phy_dwc3->base + QSCRATCH_GENERAL_CFG);
291*4882a593Smuzhiyun 
292*4882a593Smuzhiyun 	return 0;
293*4882a593Smuzhiyun }
294*4882a593Smuzhiyun 
qcom_ipq806x_usb_hs_phy_exit(struct phy * phy)295*4882a593Smuzhiyun static int qcom_ipq806x_usb_hs_phy_exit(struct phy *phy)
296*4882a593Smuzhiyun {
297*4882a593Smuzhiyun 	struct usb_phy *phy_dwc3 = phy_get_drvdata(phy);
298*4882a593Smuzhiyun 
299*4882a593Smuzhiyun 	clk_disable_unprepare(phy_dwc3->ref_clk);
300*4882a593Smuzhiyun 	clk_disable_unprepare(phy_dwc3->xo_clk);
301*4882a593Smuzhiyun 
302*4882a593Smuzhiyun 	return 0;
303*4882a593Smuzhiyun }
304*4882a593Smuzhiyun 
qcom_ipq806x_usb_ss_phy_init(struct phy * phy)305*4882a593Smuzhiyun static int qcom_ipq806x_usb_ss_phy_init(struct phy *phy)
306*4882a593Smuzhiyun {
307*4882a593Smuzhiyun 	struct usb_phy *phy_dwc3 = phy_get_drvdata(phy);
308*4882a593Smuzhiyun 	int ret;
309*4882a593Smuzhiyun 	u32 data;
310*4882a593Smuzhiyun 
311*4882a593Smuzhiyun 	ret = clk_prepare_enable(phy_dwc3->xo_clk);
312*4882a593Smuzhiyun 	if (ret)
313*4882a593Smuzhiyun 		return ret;
314*4882a593Smuzhiyun 
315*4882a593Smuzhiyun 	ret = clk_prepare_enable(phy_dwc3->ref_clk);
316*4882a593Smuzhiyun 	if (ret) {
317*4882a593Smuzhiyun 		clk_disable_unprepare(phy_dwc3->xo_clk);
318*4882a593Smuzhiyun 		return ret;
319*4882a593Smuzhiyun 	}
320*4882a593Smuzhiyun 
321*4882a593Smuzhiyun 	/* reset phy */
322*4882a593Smuzhiyun 	data = readl(phy_dwc3->base + SSUSB_PHY_CTRL_REG);
323*4882a593Smuzhiyun 	writel(data | SSUSB_CTRL_SS_PHY_RESET,
324*4882a593Smuzhiyun 	       phy_dwc3->base + SSUSB_PHY_CTRL_REG);
325*4882a593Smuzhiyun 	usleep_range(2000, 2200);
326*4882a593Smuzhiyun 	writel(data, phy_dwc3->base + SSUSB_PHY_CTRL_REG);
327*4882a593Smuzhiyun 
328*4882a593Smuzhiyun 	/* clear REF_PAD if we don't have XO clk */
329*4882a593Smuzhiyun 	if (!phy_dwc3->xo_clk)
330*4882a593Smuzhiyun 		data &= ~SSUSB_CTRL_REF_USE_PAD;
331*4882a593Smuzhiyun 	else
332*4882a593Smuzhiyun 		data |= SSUSB_CTRL_REF_USE_PAD;
333*4882a593Smuzhiyun 
334*4882a593Smuzhiyun 	writel(data, phy_dwc3->base + SSUSB_PHY_CTRL_REG);
335*4882a593Smuzhiyun 
336*4882a593Smuzhiyun 	/* wait for ref clk to become stable, this can take up to 30ms */
337*4882a593Smuzhiyun 	msleep(30);
338*4882a593Smuzhiyun 
339*4882a593Smuzhiyun 	data |= SSUSB_CTRL_SS_PHY_EN | SSUSB_CTRL_LANE0_PWR_PRESENT;
340*4882a593Smuzhiyun 	writel(data, phy_dwc3->base + SSUSB_PHY_CTRL_REG);
341*4882a593Smuzhiyun 
342*4882a593Smuzhiyun 	/*
343*4882a593Smuzhiyun 	 * WORKAROUND: There is SSPHY suspend bug due to which USB enumerates
344*4882a593Smuzhiyun 	 * in HS mode instead of SS mode. Workaround it by asserting
345*4882a593Smuzhiyun 	 * LANE0.TX_ALT_BLOCK.EN_ALT_BUS to enable TX to use alt bus mode
346*4882a593Smuzhiyun 	 */
347*4882a593Smuzhiyun 	ret = usb_ss_read_phycreg(phy_dwc3, 0x102D, &data);
348*4882a593Smuzhiyun 	if (ret)
349*4882a593Smuzhiyun 		goto err_phy_trans;
350*4882a593Smuzhiyun 
351*4882a593Smuzhiyun 	data |= (1 << 7);
352*4882a593Smuzhiyun 	ret = usb_ss_write_phycreg(phy_dwc3, 0x102D, data);
353*4882a593Smuzhiyun 	if (ret)
354*4882a593Smuzhiyun 		goto err_phy_trans;
355*4882a593Smuzhiyun 
356*4882a593Smuzhiyun 	ret = usb_ss_read_phycreg(phy_dwc3, 0x1010, &data);
357*4882a593Smuzhiyun 	if (ret)
358*4882a593Smuzhiyun 		goto err_phy_trans;
359*4882a593Smuzhiyun 
360*4882a593Smuzhiyun 	data &= ~0xff0;
361*4882a593Smuzhiyun 	data |= 0x20;
362*4882a593Smuzhiyun 	ret = usb_ss_write_phycreg(phy_dwc3, 0x1010, data);
363*4882a593Smuzhiyun 	if (ret)
364*4882a593Smuzhiyun 		goto err_phy_trans;
365*4882a593Smuzhiyun 
366*4882a593Smuzhiyun 	/*
367*4882a593Smuzhiyun 	 * Fix RX Equalization setting as follows
368*4882a593Smuzhiyun 	 * LANE0.RX_OVRD_IN_HI. RX_EQ_EN set to 0
369*4882a593Smuzhiyun 	 * LANE0.RX_OVRD_IN_HI.RX_EQ_EN_OVRD set to 1
370*4882a593Smuzhiyun 	 * LANE0.RX_OVRD_IN_HI.RX_EQ set based on SoC version
371*4882a593Smuzhiyun 	 * LANE0.RX_OVRD_IN_HI.RX_EQ_OVRD set to 1
372*4882a593Smuzhiyun 	 */
373*4882a593Smuzhiyun 	ret = usb_ss_read_phycreg(phy_dwc3, SSPHY_CTRL_RX_OVRD_IN_HI(0), &data);
374*4882a593Smuzhiyun 	if (ret)
375*4882a593Smuzhiyun 		goto err_phy_trans;
376*4882a593Smuzhiyun 
377*4882a593Smuzhiyun 	data &= ~RX_OVRD_IN_HI_RX_EQ_EN;
378*4882a593Smuzhiyun 	data |= RX_OVRD_IN_HI_RX_EQ_EN_OVRD;
379*4882a593Smuzhiyun 	data &= ~RX_OVRD_IN_HI_RX_EQ_MASK;
380*4882a593Smuzhiyun 	data |= RX_OVRD_IN_HI_RX_EQ(phy_dwc3->rx_eq);
381*4882a593Smuzhiyun 	data |= RX_OVRD_IN_HI_RX_EQ_OVRD;
382*4882a593Smuzhiyun 	ret = usb_ss_write_phycreg(phy_dwc3,
383*4882a593Smuzhiyun 				   SSPHY_CTRL_RX_OVRD_IN_HI(0), data);
384*4882a593Smuzhiyun 	if (ret)
385*4882a593Smuzhiyun 		goto err_phy_trans;
386*4882a593Smuzhiyun 
387*4882a593Smuzhiyun 	/*
388*4882a593Smuzhiyun 	 * Set EQ and TX launch amplitudes as follows
389*4882a593Smuzhiyun 	 * LANE0.TX_OVRD_DRV_LO.PREEMPH set based on SoC version
390*4882a593Smuzhiyun 	 * LANE0.TX_OVRD_DRV_LO.AMPLITUDE set to 110
391*4882a593Smuzhiyun 	 * LANE0.TX_OVRD_DRV_LO.EN set to 1.
392*4882a593Smuzhiyun 	 */
393*4882a593Smuzhiyun 	ret = usb_ss_read_phycreg(phy_dwc3,
394*4882a593Smuzhiyun 				  SSPHY_CTRL_TX_OVRD_DRV_LO(0), &data);
395*4882a593Smuzhiyun 	if (ret)
396*4882a593Smuzhiyun 		goto err_phy_trans;
397*4882a593Smuzhiyun 
398*4882a593Smuzhiyun 	data &= ~TX_OVRD_DRV_LO_PREEMPH_MASK;
399*4882a593Smuzhiyun 	data |= TX_OVRD_DRV_LO_PREEMPH(phy_dwc3->tx_deamp_3_5db);
400*4882a593Smuzhiyun 	data &= ~TX_OVRD_DRV_LO_AMPLITUDE_MASK;
401*4882a593Smuzhiyun 	data |= 0x6E;
402*4882a593Smuzhiyun 	data |= TX_OVRD_DRV_LO_EN;
403*4882a593Smuzhiyun 	ret = usb_ss_write_phycreg(phy_dwc3,
404*4882a593Smuzhiyun 				   SSPHY_CTRL_TX_OVRD_DRV_LO(0), data);
405*4882a593Smuzhiyun 	if (ret)
406*4882a593Smuzhiyun 		goto err_phy_trans;
407*4882a593Smuzhiyun 
408*4882a593Smuzhiyun 	data = 0;
409*4882a593Smuzhiyun 	data &= ~SSPHY_MPLL_MASK;
410*4882a593Smuzhiyun 	data |= SSPHY_MPLL(phy_dwc3->mpll);
411*4882a593Smuzhiyun 	usb_ss_write_phycreg(phy_dwc3, 0x30, data);
412*4882a593Smuzhiyun 
413*4882a593Smuzhiyun 	/*
414*4882a593Smuzhiyun 	 * Set the QSCRATCH PHY_PARAM_CTRL1 parameters as follows
415*4882a593Smuzhiyun 	 * TX_FULL_SWING [26:20] amplitude to 110
416*4882a593Smuzhiyun 	 * TX_DEEMPH_6DB [19:14] to 32
417*4882a593Smuzhiyun 	 * TX_DEEMPH_3_5DB [13:8] set based on SoC version
418*4882a593Smuzhiyun 	 * LOS_BIAS [7:3] to 9
419*4882a593Smuzhiyun 	 */
420*4882a593Smuzhiyun 	data = readl(phy_dwc3->base + SSUSB_PHY_PARAM_CTRL_1);
421*4882a593Smuzhiyun 
422*4882a593Smuzhiyun 	data &= ~PHY_PARAM_CTRL1_MASK;
423*4882a593Smuzhiyun 
424*4882a593Smuzhiyun 	data |= PHY_PARAM_CTRL1_TX_FULL_SWING(0x6e) |
425*4882a593Smuzhiyun 		PHY_PARAM_CTRL1_TX_DEEMPH_6DB(0x20) |
426*4882a593Smuzhiyun 		PHY_PARAM_CTRL1_TX_DEEMPH_3_5DB(phy_dwc3->tx_deamp_3_5db) |
427*4882a593Smuzhiyun 		PHY_PARAM_CTRL1_LOS_BIAS(0x9);
428*4882a593Smuzhiyun 
429*4882a593Smuzhiyun 	usb_phy_write_readback(phy_dwc3, SSUSB_PHY_PARAM_CTRL_1,
430*4882a593Smuzhiyun 			       PHY_PARAM_CTRL1_MASK, data);
431*4882a593Smuzhiyun 
432*4882a593Smuzhiyun err_phy_trans:
433*4882a593Smuzhiyun 	return ret;
434*4882a593Smuzhiyun }
435*4882a593Smuzhiyun 
qcom_ipq806x_usb_ss_phy_exit(struct phy * phy)436*4882a593Smuzhiyun static int qcom_ipq806x_usb_ss_phy_exit(struct phy *phy)
437*4882a593Smuzhiyun {
438*4882a593Smuzhiyun 	struct usb_phy *phy_dwc3 = phy_get_drvdata(phy);
439*4882a593Smuzhiyun 
440*4882a593Smuzhiyun 	/* Sequence to put SSPHY in low power state:
441*4882a593Smuzhiyun 	 * 1. Clear REF_PHY_EN in PHY_CTRL_REG
442*4882a593Smuzhiyun 	 * 2. Clear REF_USE_PAD in PHY_CTRL_REG
443*4882a593Smuzhiyun 	 * 3. Set TEST_POWERED_DOWN in PHY_CTRL_REG to enable PHY retention
444*4882a593Smuzhiyun 	 */
445*4882a593Smuzhiyun 	usb_phy_write_readback(phy_dwc3, SSUSB_PHY_CTRL_REG,
446*4882a593Smuzhiyun 			       SSUSB_CTRL_SS_PHY_EN, 0x0);
447*4882a593Smuzhiyun 	usb_phy_write_readback(phy_dwc3, SSUSB_PHY_CTRL_REG,
448*4882a593Smuzhiyun 			       SSUSB_CTRL_REF_USE_PAD, 0x0);
449*4882a593Smuzhiyun 	usb_phy_write_readback(phy_dwc3, SSUSB_PHY_CTRL_REG,
450*4882a593Smuzhiyun 			       SSUSB_CTRL_TEST_POWERDOWN, 0x0);
451*4882a593Smuzhiyun 
452*4882a593Smuzhiyun 	clk_disable_unprepare(phy_dwc3->ref_clk);
453*4882a593Smuzhiyun 	clk_disable_unprepare(phy_dwc3->xo_clk);
454*4882a593Smuzhiyun 
455*4882a593Smuzhiyun 	return 0;
456*4882a593Smuzhiyun }
457*4882a593Smuzhiyun 
458*4882a593Smuzhiyun static const struct phy_drvdata qcom_ipq806x_usb_hs_drvdata = {
459*4882a593Smuzhiyun 	.ops = {
460*4882a593Smuzhiyun 		.init		= qcom_ipq806x_usb_hs_phy_init,
461*4882a593Smuzhiyun 		.exit		= qcom_ipq806x_usb_hs_phy_exit,
462*4882a593Smuzhiyun 		.owner		= THIS_MODULE,
463*4882a593Smuzhiyun 	},
464*4882a593Smuzhiyun 	.clk_rate = 60000000,
465*4882a593Smuzhiyun };
466*4882a593Smuzhiyun 
467*4882a593Smuzhiyun static const struct phy_drvdata qcom_ipq806x_usb_ss_drvdata = {
468*4882a593Smuzhiyun 	.ops = {
469*4882a593Smuzhiyun 		.init		= qcom_ipq806x_usb_ss_phy_init,
470*4882a593Smuzhiyun 		.exit		= qcom_ipq806x_usb_ss_phy_exit,
471*4882a593Smuzhiyun 		.owner		= THIS_MODULE,
472*4882a593Smuzhiyun 	},
473*4882a593Smuzhiyun 	.clk_rate = 125000000,
474*4882a593Smuzhiyun };
475*4882a593Smuzhiyun 
476*4882a593Smuzhiyun static const struct of_device_id qcom_ipq806x_usb_phy_table[] = {
477*4882a593Smuzhiyun 	{ .compatible = "qcom,ipq806x-usb-phy-hs",
478*4882a593Smuzhiyun 	  .data = &qcom_ipq806x_usb_hs_drvdata },
479*4882a593Smuzhiyun 	{ .compatible = "qcom,ipq806x-usb-phy-ss",
480*4882a593Smuzhiyun 	  .data = &qcom_ipq806x_usb_ss_drvdata },
481*4882a593Smuzhiyun 	{ /* Sentinel */ }
482*4882a593Smuzhiyun };
483*4882a593Smuzhiyun MODULE_DEVICE_TABLE(of, qcom_ipq806x_usb_phy_table);
484*4882a593Smuzhiyun 
qcom_ipq806x_usb_phy_probe(struct platform_device * pdev)485*4882a593Smuzhiyun static int qcom_ipq806x_usb_phy_probe(struct platform_device *pdev)
486*4882a593Smuzhiyun {
487*4882a593Smuzhiyun 	struct resource *res;
488*4882a593Smuzhiyun 	resource_size_t size;
489*4882a593Smuzhiyun 	struct phy *generic_phy;
490*4882a593Smuzhiyun 	struct usb_phy *phy_dwc3;
491*4882a593Smuzhiyun 	const struct phy_drvdata *data;
492*4882a593Smuzhiyun 	struct phy_provider *phy_provider;
493*4882a593Smuzhiyun 
494*4882a593Smuzhiyun 	phy_dwc3 = devm_kzalloc(&pdev->dev, sizeof(*phy_dwc3), GFP_KERNEL);
495*4882a593Smuzhiyun 	if (!phy_dwc3)
496*4882a593Smuzhiyun 		return -ENOMEM;
497*4882a593Smuzhiyun 
498*4882a593Smuzhiyun 	data = of_device_get_match_data(&pdev->dev);
499*4882a593Smuzhiyun 
500*4882a593Smuzhiyun 	phy_dwc3->dev = &pdev->dev;
501*4882a593Smuzhiyun 
502*4882a593Smuzhiyun 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
503*4882a593Smuzhiyun 	if (!res)
504*4882a593Smuzhiyun 		return -EINVAL;
505*4882a593Smuzhiyun 	size = resource_size(res);
506*4882a593Smuzhiyun 	phy_dwc3->base = devm_ioremap(phy_dwc3->dev, res->start, size);
507*4882a593Smuzhiyun 
508*4882a593Smuzhiyun 	if (!phy_dwc3->base) {
509*4882a593Smuzhiyun 		dev_err(phy_dwc3->dev, "failed to map reg\n");
510*4882a593Smuzhiyun 		return -ENOMEM;
511*4882a593Smuzhiyun 	}
512*4882a593Smuzhiyun 
513*4882a593Smuzhiyun 	phy_dwc3->ref_clk = devm_clk_get(phy_dwc3->dev, "ref");
514*4882a593Smuzhiyun 	if (IS_ERR(phy_dwc3->ref_clk)) {
515*4882a593Smuzhiyun 		dev_dbg(phy_dwc3->dev, "cannot get reference clock\n");
516*4882a593Smuzhiyun 		return PTR_ERR(phy_dwc3->ref_clk);
517*4882a593Smuzhiyun 	}
518*4882a593Smuzhiyun 
519*4882a593Smuzhiyun 	clk_set_rate(phy_dwc3->ref_clk, data->clk_rate);
520*4882a593Smuzhiyun 
521*4882a593Smuzhiyun 	phy_dwc3->xo_clk = devm_clk_get(phy_dwc3->dev, "xo");
522*4882a593Smuzhiyun 	if (IS_ERR(phy_dwc3->xo_clk)) {
523*4882a593Smuzhiyun 		dev_dbg(phy_dwc3->dev, "cannot get TCXO clock\n");
524*4882a593Smuzhiyun 		phy_dwc3->xo_clk = NULL;
525*4882a593Smuzhiyun 	}
526*4882a593Smuzhiyun 
527*4882a593Smuzhiyun 	/* Parse device node to probe HSIO settings */
528*4882a593Smuzhiyun 	if (device_property_read_u32(&pdev->dev, "qcom,rx-eq",
529*4882a593Smuzhiyun 				     &phy_dwc3->rx_eq))
530*4882a593Smuzhiyun 		phy_dwc3->rx_eq = SSPHY_RX_EQ_VALUE;
531*4882a593Smuzhiyun 
532*4882a593Smuzhiyun 	if (device_property_read_u32(&pdev->dev, "qcom,tx-deamp_3_5db",
533*4882a593Smuzhiyun 				     &phy_dwc3->tx_deamp_3_5db))
534*4882a593Smuzhiyun 		phy_dwc3->tx_deamp_3_5db = SSPHY_TX_DEEMPH_3_5DB;
535*4882a593Smuzhiyun 
536*4882a593Smuzhiyun 	if (device_property_read_u32(&pdev->dev, "qcom,mpll", &phy_dwc3->mpll))
537*4882a593Smuzhiyun 		phy_dwc3->mpll = SSPHY_MPLL_VALUE;
538*4882a593Smuzhiyun 
539*4882a593Smuzhiyun 	generic_phy = devm_phy_create(phy_dwc3->dev, pdev->dev.of_node, &data->ops);
540*4882a593Smuzhiyun 
541*4882a593Smuzhiyun 	if (IS_ERR(generic_phy))
542*4882a593Smuzhiyun 		return PTR_ERR(generic_phy);
543*4882a593Smuzhiyun 
544*4882a593Smuzhiyun 	phy_set_drvdata(generic_phy, phy_dwc3);
545*4882a593Smuzhiyun 	platform_set_drvdata(pdev, phy_dwc3);
546*4882a593Smuzhiyun 
547*4882a593Smuzhiyun 	phy_provider = devm_of_phy_provider_register(phy_dwc3->dev,
548*4882a593Smuzhiyun 						     of_phy_simple_xlate);
549*4882a593Smuzhiyun 
550*4882a593Smuzhiyun 	if (IS_ERR(phy_provider))
551*4882a593Smuzhiyun 		return PTR_ERR(phy_provider);
552*4882a593Smuzhiyun 
553*4882a593Smuzhiyun 	return 0;
554*4882a593Smuzhiyun }
555*4882a593Smuzhiyun 
556*4882a593Smuzhiyun static struct platform_driver qcom_ipq806x_usb_phy_driver = {
557*4882a593Smuzhiyun 	.probe		= qcom_ipq806x_usb_phy_probe,
558*4882a593Smuzhiyun 	.driver		= {
559*4882a593Smuzhiyun 		.name	= "qcom-ipq806x-usb-phy",
560*4882a593Smuzhiyun 		.of_match_table = qcom_ipq806x_usb_phy_table,
561*4882a593Smuzhiyun 	},
562*4882a593Smuzhiyun };
563*4882a593Smuzhiyun 
564*4882a593Smuzhiyun module_platform_driver(qcom_ipq806x_usb_phy_driver);
565*4882a593Smuzhiyun 
566*4882a593Smuzhiyun MODULE_ALIAS("platform:phy-qcom-ipq806x-usb");
567*4882a593Smuzhiyun MODULE_LICENSE("GPL v2");
568*4882a593Smuzhiyun MODULE_AUTHOR("Andy Gross <agross@codeaurora.org>");
569*4882a593Smuzhiyun MODULE_AUTHOR("Ivan T. Ivanov <iivanov@mm-sol.com>");
570*4882a593Smuzhiyun MODULE_DESCRIPTION("DesignWare USB3 QCOM PHY driver");
571