1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2017 Texas Instruments Incorporated - http://www.ti.com/
4 * Written by Jean-Jacques Hiblot <jjhiblot@ti.com>
10 #include <generic-phy.h>
12 #include <asm/arch/sys_proto.h>
15 #include <linux/bitops.h>
16 #include <linux/delay.h>
17 #include <linux/err.h>
19 /* PLLCTRL Registers */
20 #define PLL_STATUS 0x00000004
21 #define PLL_GO 0x00000008
22 #define PLL_CONFIGURATION1 0x0000000C
23 #define PLL_CONFIGURATION2 0x00000010
24 #define PLL_CONFIGURATION3 0x00000014
25 #define PLL_CONFIGURATION4 0x00000020
27 #define PLL_REGM_MASK 0x001FFE00
28 #define PLL_REGM_SHIFT 9
29 #define PLL_REGM_F_MASK 0x0003FFFF
30 #define PLL_REGM_F_SHIFT 0
31 #define PLL_REGN_MASK 0x000001FE
32 #define PLL_REGN_SHIFT 1
33 #define PLL_SELFREQDCO_MASK 0x0000000E
34 #define PLL_SELFREQDCO_SHIFT 1
35 #define PLL_SD_MASK 0x0003FC00
36 #define PLL_SD_SHIFT 10
37 #define SET_PLL_GO 0x1
38 #define PLL_TICOPWDN BIT(16)
39 #define PLL_LDOPWDN BIT(15)
43 /* Software rest for the SATA PLL (in CTRL_CORE_SMA_SW_0 register)*/
44 #define SATA_PLL_SOFT_RESET (1<<18)
46 /* PHY POWER CONTROL Register */
47 #define PIPE3_PHY_PWRCTL_CLK_CMD_MASK GENMASK(21, 14)
48 #define PIPE3_PHY_PWRCTL_CLK_CMD_SHIFT 14
50 #define PIPE3_PHY_PWRCTL_CLK_FREQ_MASK GENMASK(31, 22)
51 #define PIPE3_PHY_PWRCTL_CLK_FREQ_SHIFT 22
53 #define PIPE3_PHY_RX_POWERON (0x1 << PIPE3_PHY_PWRCTL_CLK_CMD_SHIFT)
54 #define PIPE3_PHY_TX_POWERON (0x2 << PIPE3_PHY_PWRCTL_CLK_CMD_SHIFT)
56 /* PHY RX Registers */
57 #define PIPE3_PHY_RX_ANA_PROGRAMMABILITY 0x0000000C
58 #define INTERFACE_MASK GENMASK(31, 27)
59 #define INTERFACE_SHIFT 27
60 #define INTERFACE_MODE_USBSS BIT(4)
61 #define INTERFACE_MODE_SATA_1P5 BIT(3)
62 #define INTERFACE_MODE_SATA_3P0 BIT(2)
63 #define INTERFACE_MODE_PCIE BIT(0)
65 #define LOSD_MASK GENMASK(17, 14)
67 #define MEM_PLLDIV GENMASK(6, 5)
69 #define PIPE3_PHY_RX_TRIM 0x0000001C
70 #define MEM_DLL_TRIM_SEL_MASK GENMASK(31, 30)
71 #define MEM_DLL_TRIM_SHIFT 30
73 #define PIPE3_PHY_RX_DLL 0x00000024
74 #define MEM_DLL_PHINT_RATE_MASK GENMASK(31, 30)
75 #define MEM_DLL_PHINT_RATE_SHIFT 30
77 #define PIPE3_PHY_RX_DIGITAL_MODES 0x00000028
78 #define MEM_HS_RATE_MASK GENMASK(28, 27)
79 #define MEM_HS_RATE_SHIFT 27
80 #define MEM_OVRD_HS_RATE BIT(26)
81 #define MEM_OVRD_HS_RATE_SHIFT 26
82 #define MEM_CDR_FASTLOCK BIT(23)
83 #define MEM_CDR_FASTLOCK_SHIFT 23
84 #define MEM_CDR_LBW_MASK GENMASK(22, 21)
85 #define MEM_CDR_LBW_SHIFT 21
86 #define MEM_CDR_STEPCNT_MASK GENMASK(20, 19)
87 #define MEM_CDR_STEPCNT_SHIFT 19
88 #define MEM_CDR_STL_MASK GENMASK(18, 16)
89 #define MEM_CDR_STL_SHIFT 16
90 #define MEM_CDR_THR_MASK GENMASK(15, 13)
91 #define MEM_CDR_THR_SHIFT 13
92 #define MEM_CDR_THR_MODE BIT(12)
93 #define MEM_CDR_THR_MODE_SHIFT 12
94 #define MEM_CDR_2NDO_SDM_MODE BIT(11)
95 #define MEM_CDR_2NDO_SDM_MODE_SHIFT 11
97 #define PIPE3_PHY_RX_EQUALIZER 0x00000038
98 #define MEM_EQLEV_MASK GENMASK(31, 16)
99 #define MEM_EQLEV_SHIFT 16
100 #define MEM_EQFTC_MASK GENMASK(15, 11)
101 #define MEM_EQFTC_SHIFT 11
102 #define MEM_EQCTL_MASK GENMASK(10, 7)
103 #define MEM_EQCTL_SHIFT 7
104 #define MEM_OVRD_EQLEV BIT(2)
105 #define MEM_OVRD_EQLEV_SHIFT 2
106 #define MEM_OVRD_EQFTC BIT(1)
107 #define MEM_OVRD_EQFTC_SHIFT 1
109 #define SATA_PHY_RX_IO_AND_A2D_OVERRIDES 0x44
110 #define MEM_CDR_LOS_SOURCE_MASK GENMASK(10, 9)
111 #define MEM_CDR_LOS_SOURCE_SHIFT 9
113 #define PLL_IDLE_TIME 100 /* in milliseconds */
114 #define PLL_LOCK_TIME 100 /* in milliseconds */
116 enum pipe3_mode { PIPE3_MODE_PCIE = 1,
120 struct pipe3_settings {
129 u8 dig_2ndo_sdm_mode;
142 void __iomem *pll_ctrl_base;
143 void __iomem *phy_rx;
144 void __iomem *power_reg;
145 void __iomem *pll_reset_reg;
146 struct pipe3_dpll_map *dpll_map;
147 enum pipe3_mode mode;
148 struct pipe3_settings settings;
151 struct pipe3_dpll_params {
159 struct pipe3_dpll_map {
161 struct pipe3_dpll_params params;
165 enum pipe3_mode mode;
166 struct pipe3_dpll_map *dpll_map;
167 struct pipe3_settings settings;
170 static inline u32 omap_pipe3_readl(void __iomem *addr, unsigned offset)
172 return readl(addr + offset);
175 static inline void omap_pipe3_writel(void __iomem *addr, unsigned offset,
178 writel(data, addr + offset);
181 static struct pipe3_dpll_params *omap_pipe3_get_dpll_params(struct omap_pipe3
185 struct pipe3_dpll_map *dpll_map = pipe3->dpll_map;
187 rate = get_sys_clk_freq();
189 for (; dpll_map->rate; dpll_map++) {
190 if (rate == dpll_map->rate)
191 return &dpll_map->params;
194 printf("%s: No DPLL configuration for %u Hz SYS CLK\n",
199 static int omap_pipe3_wait_lock(struct omap_pipe3 *pipe3)
202 int timeout = PLL_LOCK_TIME;
206 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_STATUS);
211 if (!(val & PLL_LOCK)) {
212 printf("%s: DPLL failed to lock\n", __func__);
219 static int omap_pipe3_dpll_program(struct omap_pipe3 *pipe3)
222 struct pipe3_dpll_params *dpll_params;
224 dpll_params = omap_pipe3_get_dpll_params(pipe3);
226 printf("%s: Invalid DPLL parameters\n", __func__);
230 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_CONFIGURATION1);
231 val &= ~PLL_REGN_MASK;
232 val |= dpll_params->n << PLL_REGN_SHIFT;
233 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_CONFIGURATION1, val);
235 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_CONFIGURATION2);
236 val &= ~(PLL_SELFREQDCO_MASK | PLL_IDLE);
237 val |= dpll_params->freq << PLL_SELFREQDCO_SHIFT;
238 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_CONFIGURATION2, val);
240 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_CONFIGURATION1);
241 val &= ~PLL_REGM_MASK;
242 val |= dpll_params->m << PLL_REGM_SHIFT;
243 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_CONFIGURATION1, val);
245 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_CONFIGURATION4);
246 val &= ~PLL_REGM_F_MASK;
247 val |= dpll_params->mf << PLL_REGM_F_SHIFT;
248 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_CONFIGURATION4, val);
250 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_CONFIGURATION3);
252 val |= dpll_params->sd << PLL_SD_SHIFT;
253 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_CONFIGURATION3, val);
255 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_GO, SET_PLL_GO);
257 return omap_pipe3_wait_lock(pipe3);
260 static void omap_control_pipe3_power(struct omap_pipe3 *pipe3, int on)
264 val = readl(pipe3->power_reg);
266 rate = get_sys_clk_freq();
270 val &= ~(PIPE3_PHY_PWRCTL_CLK_CMD_MASK |
271 PIPE3_PHY_PWRCTL_CLK_FREQ_MASK);
272 val |= rate << PIPE3_PHY_PWRCTL_CLK_FREQ_SHIFT;
273 writel(val, pipe3->power_reg);
275 /* Power up TX before RX for SATA & USB */
276 val |= PIPE3_PHY_TX_POWERON;
277 writel(val, pipe3->power_reg);
279 val |= PIPE3_PHY_RX_POWERON;
280 writel(val, pipe3->power_reg);
282 val &= ~PIPE3_PHY_PWRCTL_CLK_CMD_MASK;
283 writel(val, pipe3->power_reg);
287 static void ti_pipe3_calibrate(struct omap_pipe3 *phy)
290 struct pipe3_settings *s = &phy->settings;
292 val = omap_pipe3_readl(phy->phy_rx, PIPE3_PHY_RX_ANA_PROGRAMMABILITY);
293 val &= ~(INTERFACE_MASK | LOSD_MASK | MEM_PLLDIV);
294 val = (s->ana_interface << INTERFACE_SHIFT | s->ana_losd << LOSD_SHIFT);
295 omap_pipe3_writel(phy->phy_rx, PIPE3_PHY_RX_ANA_PROGRAMMABILITY, val);
297 val = omap_pipe3_readl(phy->phy_rx, PIPE3_PHY_RX_DIGITAL_MODES);
298 val &= ~(MEM_HS_RATE_MASK | MEM_OVRD_HS_RATE | MEM_CDR_FASTLOCK |
299 MEM_CDR_LBW_MASK | MEM_CDR_STEPCNT_MASK | MEM_CDR_STL_MASK |
300 MEM_CDR_THR_MASK | MEM_CDR_THR_MODE | MEM_CDR_2NDO_SDM_MODE);
301 val |= s->dig_hs_rate << MEM_HS_RATE_SHIFT |
302 s->dig_ovrd_hs_rate << MEM_OVRD_HS_RATE_SHIFT |
303 s->dig_fastlock << MEM_CDR_FASTLOCK_SHIFT |
304 s->dig_lbw << MEM_CDR_LBW_SHIFT |
305 s->dig_stepcnt << MEM_CDR_STEPCNT_SHIFT |
306 s->dig_stl << MEM_CDR_STL_SHIFT |
307 s->dig_thr << MEM_CDR_THR_SHIFT |
308 s->dig_thr_mode << MEM_CDR_THR_MODE_SHIFT |
309 s->dig_2ndo_sdm_mode << MEM_CDR_2NDO_SDM_MODE_SHIFT;
310 omap_pipe3_writel(phy->phy_rx, PIPE3_PHY_RX_DIGITAL_MODES, val);
312 val = omap_pipe3_readl(phy->phy_rx, PIPE3_PHY_RX_TRIM);
313 val &= ~MEM_DLL_TRIM_SEL_MASK;
314 val |= s->dll_trim_sel << MEM_DLL_TRIM_SHIFT;
315 omap_pipe3_writel(phy->phy_rx, PIPE3_PHY_RX_TRIM, val);
317 val = omap_pipe3_readl(phy->phy_rx, PIPE3_PHY_RX_DLL);
318 val &= ~MEM_DLL_PHINT_RATE_MASK;
319 val |= s->dll_phint_rate << MEM_DLL_PHINT_RATE_SHIFT;
320 omap_pipe3_writel(phy->phy_rx, PIPE3_PHY_RX_DLL, val);
322 val = omap_pipe3_readl(phy->phy_rx, PIPE3_PHY_RX_EQUALIZER);
323 val &= ~(MEM_EQLEV_MASK | MEM_EQFTC_MASK | MEM_EQCTL_MASK |
324 MEM_OVRD_EQLEV | MEM_OVRD_EQFTC);
325 val |= s->eq_lev << MEM_EQLEV_SHIFT |
326 s->eq_ftc << MEM_EQFTC_SHIFT |
327 s->eq_ctl << MEM_EQCTL_SHIFT |
328 s->eq_ovrd_lev << MEM_OVRD_EQLEV_SHIFT |
329 s->eq_ovrd_ftc << MEM_OVRD_EQFTC_SHIFT;
330 omap_pipe3_writel(phy->phy_rx, PIPE3_PHY_RX_EQUALIZER, val);
332 if (phy->mode == PIPE3_MODE_SATA) {
333 val = omap_pipe3_readl(phy->phy_rx,
334 SATA_PHY_RX_IO_AND_A2D_OVERRIDES);
335 val &= ~MEM_CDR_LOS_SOURCE_MASK;
336 omap_pipe3_writel(phy->phy_rx, SATA_PHY_RX_IO_AND_A2D_OVERRIDES,
341 static int pipe3_init(struct phy *phy)
345 struct omap_pipe3 *pipe3 = dev_get_priv(phy->dev);
347 /* Program the DPLL only if not locked */
348 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_STATUS);
349 if (!(val & PLL_LOCK)) {
350 ret = omap_pipe3_dpll_program(pipe3);
354 ti_pipe3_calibrate(pipe3);
356 /* else just bring it out of IDLE mode */
357 val = omap_pipe3_readl(pipe3->pll_ctrl_base,
359 if (val & PLL_IDLE) {
361 omap_pipe3_writel(pipe3->pll_ctrl_base,
362 PLL_CONFIGURATION2, val);
363 ret = omap_pipe3_wait_lock(pipe3);
371 static int pipe3_power_on(struct phy *phy)
373 struct omap_pipe3 *pipe3 = dev_get_priv(phy->dev);
375 /* Power up the PHY */
376 omap_control_pipe3_power(pipe3, 1);
381 static int pipe3_power_off(struct phy *phy)
383 struct omap_pipe3 *pipe3 = dev_get_priv(phy->dev);
385 /* Power down the PHY */
386 omap_control_pipe3_power(pipe3, 0);
391 static int pipe3_exit(struct phy *phy)
394 int timeout = PLL_IDLE_TIME;
395 struct omap_pipe3 *pipe3 = dev_get_priv(phy->dev);
397 pipe3_power_off(phy);
399 /* Put DPLL in IDLE mode */
400 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_CONFIGURATION2);
402 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_CONFIGURATION2, val);
404 /* wait for LDO and Oscillator to power down */
407 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_STATUS);
408 if ((val & PLL_TICOPWDN) && (val & PLL_LDOPWDN))
412 if (!(val & PLL_TICOPWDN) || !(val & PLL_LDOPWDN)) {
413 pr_err("%s: Failed to power down DPLL: PLL_STATUS 0x%x\n",
418 if (pipe3->pll_reset_reg) {
419 val = readl(pipe3->pll_reset_reg);
420 writel(val | SATA_PLL_SOFT_RESET, pipe3->pll_reset_reg);
422 writel(val & ~SATA_PLL_SOFT_RESET, pipe3->pll_reset_reg);
428 static void *get_reg(struct udevice *dev, const char *name)
430 struct udevice *syscon;
431 struct regmap *regmap;
436 err = uclass_get_device_by_phandle(UCLASS_SYSCON, dev,
439 pr_err("unable to find syscon device for %s (%d)\n",
444 regmap = syscon_get_regmap(syscon);
445 if (IS_ERR(regmap)) {
446 pr_err("unable to find regmap for %s (%ld)\n",
447 name, PTR_ERR(regmap));
451 cell = fdt_getprop(gd->fdt_blob, dev_of_offset(dev), name,
453 if (len < 2*sizeof(fdt32_t)) {
454 pr_err("offset not available for %s\n", name);
458 base = regmap_get_range(regmap, 0);
462 return fdtdec_get_number(cell + 1, 1) + base;
465 static int pipe3_phy_probe(struct udevice *dev)
469 struct omap_pipe3 *pipe3 = dev_get_priv(dev);
470 struct pipe3_data *data;
473 addr = devfdt_get_addr_size_index(dev, 0, &sz);
474 if (addr == FDT_ADDR_T_NONE) {
475 pr_err("missing phy_rx address\n");
479 pipe3->phy_rx = map_physmem(addr, sz, MAP_NOCACHE);
480 if (!pipe3->phy_rx) {
481 pr_err("unable to remap phy_rx\n");
486 addr = devfdt_get_addr_size_index(dev, 2, &sz);
487 if (addr == FDT_ADDR_T_NONE) {
488 pr_err("missing pll ctrl address\n");
492 pipe3->pll_ctrl_base = map_physmem(addr, sz, MAP_NOCACHE);
493 if (!pipe3->pll_ctrl_base) {
494 pr_err("unable to remap pll ctrl\n");
498 pipe3->power_reg = get_reg(dev, "syscon-phy-power");
499 if (!pipe3->power_reg)
502 data = (struct pipe3_data *)dev_get_driver_data(dev);
503 pipe3->mode = data->mode;
504 pipe3->dpll_map = data->dpll_map;
505 pipe3->settings = data->settings;
507 if (pipe3->mode == PIPE3_MODE_SATA) {
508 pipe3->pll_reset_reg = get_reg(dev, "syscon-pllreset");
509 if (!pipe3->pll_reset_reg)
516 static struct pipe3_dpll_map dpll_map_sata[] = {
517 {12000000, {625, 4, 4, 6, 0} }, /* 12 MHz */
518 {16800000, {625, 6, 4, 7, 0} }, /* 16.8 MHz */
519 {19200000, {625, 7, 4, 6, 0} }, /* 19.2 MHz */
520 {20000000, {750, 9, 4, 6, 0} }, /* 20 MHz */
521 {26000000, {750, 12, 4, 6, 0} }, /* 26 MHz */
522 {38400000, {625, 15, 4, 6, 0} }, /* 38.4 MHz */
523 { }, /* Terminator */
526 static struct pipe3_dpll_map dpll_map_usb[] = {
527 {12000000, {1250, 5, 4, 20, 0} }, /* 12 MHz */
528 {16800000, {3125, 20, 4, 20, 0} }, /* 16.8 MHz */
529 {19200000, {1172, 8, 4, 20, 65537} }, /* 19.2 MHz */
530 {20000000, {1000, 7, 4, 10, 0} }, /* 20 MHz */
531 {26000000, {1250, 12, 4, 20, 0} }, /* 26 MHz */
532 {38400000, {3125, 47, 4, 20, 92843} }, /* 38.4 MHz */
533 { }, /* Terminator */
536 static struct pipe3_data data_usb = {
537 .mode = PIPE3_MODE_USBSS,
538 .dpll_map = dpll_map_usb,
540 /* DRA75x TRM Table 26-17. Preferred USB3_PHY_RX SCP Register Settings */
541 .ana_interface = INTERFACE_MODE_USBSS,
549 .dig_2ndo_sdm_mode = 0,
551 .dig_ovrd_hs_rate = 1,
553 .dll_phint_rate = 0x3,
562 static struct pipe3_data data_sata = {
563 .mode = PIPE3_MODE_SATA,
564 .dpll_map = dpll_map_sata,
566 /* DRA75x TRM Table 26-9. Preferred SATA_PHY_RX SCP Register Settings */
567 .ana_interface = INTERFACE_MODE_SATA_3P0,
575 .dig_2ndo_sdm_mode = 0,
576 .dig_hs_rate = 0, /* Not in TRM preferred settings */
577 .dig_ovrd_hs_rate = 0, /* Not in TRM preferred settings */
579 .dll_phint_rate = 0x2, /* for 1.5 GHz DPLL clock */
588 static const struct udevice_id pipe3_phy_ids[] = {
589 { .compatible = "ti,phy-pipe3-sata", .data = (ulong)&data_sata },
590 { .compatible = "ti,omap-usb3", .data = (ulong)&data_usb},
594 static struct phy_ops pipe3_phy_ops = {
596 .power_on = pipe3_power_on,
597 .power_off = pipe3_power_off,
601 U_BOOT_DRIVER(pipe3_phy) = {
604 .of_match = pipe3_phy_ids,
605 .ops = &pipe3_phy_ops,
606 .probe = pipe3_phy_probe,
607 .priv_auto = sizeof(struct omap_pipe3),