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>
11 #include <asm/global_data.h>
13 #include <asm/arch/sys_proto.h>
16 #include <linux/bitops.h>
17 #include <linux/delay.h>
18 #include <linux/err.h>
20 /* PLLCTRL Registers */
21 #define PLL_STATUS 0x00000004
22 #define PLL_GO 0x00000008
23 #define PLL_CONFIGURATION1 0x0000000C
24 #define PLL_CONFIGURATION2 0x00000010
25 #define PLL_CONFIGURATION3 0x00000014
26 #define PLL_CONFIGURATION4 0x00000020
28 #define PLL_REGM_MASK 0x001FFE00
29 #define PLL_REGM_SHIFT 9
30 #define PLL_REGM_F_MASK 0x0003FFFF
31 #define PLL_REGM_F_SHIFT 0
32 #define PLL_REGN_MASK 0x000001FE
33 #define PLL_REGN_SHIFT 1
34 #define PLL_SELFREQDCO_MASK 0x0000000E
35 #define PLL_SELFREQDCO_SHIFT 1
36 #define PLL_SD_MASK 0x0003FC00
37 #define PLL_SD_SHIFT 10
38 #define SET_PLL_GO 0x1
39 #define PLL_TICOPWDN BIT(16)
40 #define PLL_LDOPWDN BIT(15)
44 /* Software rest for the SATA PLL (in CTRL_CORE_SMA_SW_0 register)*/
45 #define SATA_PLL_SOFT_RESET (1<<18)
47 /* PHY POWER CONTROL Register */
48 #define PIPE3_PHY_PWRCTL_CLK_CMD_MASK GENMASK(21, 14)
49 #define PIPE3_PHY_PWRCTL_CLK_CMD_SHIFT 14
51 #define PIPE3_PHY_PWRCTL_CLK_FREQ_MASK GENMASK(31, 22)
52 #define PIPE3_PHY_PWRCTL_CLK_FREQ_SHIFT 22
54 #define PIPE3_PHY_RX_POWERON (0x1 << PIPE3_PHY_PWRCTL_CLK_CMD_SHIFT)
55 #define PIPE3_PHY_TX_POWERON (0x2 << PIPE3_PHY_PWRCTL_CLK_CMD_SHIFT)
57 /* PHY RX Registers */
58 #define PIPE3_PHY_RX_ANA_PROGRAMMABILITY 0x0000000C
59 #define INTERFACE_MASK GENMASK(31, 27)
60 #define INTERFACE_SHIFT 27
61 #define INTERFACE_MODE_USBSS BIT(4)
62 #define INTERFACE_MODE_SATA_1P5 BIT(3)
63 #define INTERFACE_MODE_SATA_3P0 BIT(2)
64 #define INTERFACE_MODE_PCIE BIT(0)
66 #define LOSD_MASK GENMASK(17, 14)
68 #define MEM_PLLDIV GENMASK(6, 5)
70 #define PIPE3_PHY_RX_TRIM 0x0000001C
71 #define MEM_DLL_TRIM_SEL_MASK GENMASK(31, 30)
72 #define MEM_DLL_TRIM_SHIFT 30
74 #define PIPE3_PHY_RX_DLL 0x00000024
75 #define MEM_DLL_PHINT_RATE_MASK GENMASK(31, 30)
76 #define MEM_DLL_PHINT_RATE_SHIFT 30
78 #define PIPE3_PHY_RX_DIGITAL_MODES 0x00000028
79 #define MEM_HS_RATE_MASK GENMASK(28, 27)
80 #define MEM_HS_RATE_SHIFT 27
81 #define MEM_OVRD_HS_RATE BIT(26)
82 #define MEM_OVRD_HS_RATE_SHIFT 26
83 #define MEM_CDR_FASTLOCK BIT(23)
84 #define MEM_CDR_FASTLOCK_SHIFT 23
85 #define MEM_CDR_LBW_MASK GENMASK(22, 21)
86 #define MEM_CDR_LBW_SHIFT 21
87 #define MEM_CDR_STEPCNT_MASK GENMASK(20, 19)
88 #define MEM_CDR_STEPCNT_SHIFT 19
89 #define MEM_CDR_STL_MASK GENMASK(18, 16)
90 #define MEM_CDR_STL_SHIFT 16
91 #define MEM_CDR_THR_MASK GENMASK(15, 13)
92 #define MEM_CDR_THR_SHIFT 13
93 #define MEM_CDR_THR_MODE BIT(12)
94 #define MEM_CDR_THR_MODE_SHIFT 12
95 #define MEM_CDR_2NDO_SDM_MODE BIT(11)
96 #define MEM_CDR_2NDO_SDM_MODE_SHIFT 11
98 #define PIPE3_PHY_RX_EQUALIZER 0x00000038
99 #define MEM_EQLEV_MASK GENMASK(31, 16)
100 #define MEM_EQLEV_SHIFT 16
101 #define MEM_EQFTC_MASK GENMASK(15, 11)
102 #define MEM_EQFTC_SHIFT 11
103 #define MEM_EQCTL_MASK GENMASK(10, 7)
104 #define MEM_EQCTL_SHIFT 7
105 #define MEM_OVRD_EQLEV BIT(2)
106 #define MEM_OVRD_EQLEV_SHIFT 2
107 #define MEM_OVRD_EQFTC BIT(1)
108 #define MEM_OVRD_EQFTC_SHIFT 1
110 #define SATA_PHY_RX_IO_AND_A2D_OVERRIDES 0x44
111 #define MEM_CDR_LOS_SOURCE_MASK GENMASK(10, 9)
112 #define MEM_CDR_LOS_SOURCE_SHIFT 9
114 #define PLL_IDLE_TIME 100 /* in milliseconds */
115 #define PLL_LOCK_TIME 100 /* in milliseconds */
117 enum pipe3_mode { PIPE3_MODE_PCIE = 1,
121 struct pipe3_settings {
130 u8 dig_2ndo_sdm_mode;
143 void __iomem *pll_ctrl_base;
144 void __iomem *phy_rx;
145 void __iomem *power_reg;
146 void __iomem *pll_reset_reg;
147 struct pipe3_dpll_map *dpll_map;
148 enum pipe3_mode mode;
149 struct pipe3_settings settings;
152 struct pipe3_dpll_params {
160 struct pipe3_dpll_map {
162 struct pipe3_dpll_params params;
166 enum pipe3_mode mode;
167 struct pipe3_dpll_map *dpll_map;
168 struct pipe3_settings settings;
171 static inline u32 omap_pipe3_readl(void __iomem *addr, unsigned offset)
173 return readl(addr + offset);
176 static inline void omap_pipe3_writel(void __iomem *addr, unsigned offset,
179 writel(data, addr + offset);
182 static struct pipe3_dpll_params *omap_pipe3_get_dpll_params(struct omap_pipe3
186 struct pipe3_dpll_map *dpll_map = pipe3->dpll_map;
188 rate = get_sys_clk_freq();
190 for (; dpll_map->rate; dpll_map++) {
191 if (rate == dpll_map->rate)
192 return &dpll_map->params;
195 printf("%s: No DPLL configuration for %u Hz SYS CLK\n",
200 static int omap_pipe3_wait_lock(struct omap_pipe3 *pipe3)
203 int timeout = PLL_LOCK_TIME;
207 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_STATUS);
212 if (!(val & PLL_LOCK)) {
213 printf("%s: DPLL failed to lock\n", __func__);
220 static int omap_pipe3_dpll_program(struct omap_pipe3 *pipe3)
223 struct pipe3_dpll_params *dpll_params;
225 dpll_params = omap_pipe3_get_dpll_params(pipe3);
227 printf("%s: Invalid DPLL parameters\n", __func__);
231 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_CONFIGURATION1);
232 val &= ~PLL_REGN_MASK;
233 val |= dpll_params->n << PLL_REGN_SHIFT;
234 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_CONFIGURATION1, val);
236 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_CONFIGURATION2);
237 val &= ~(PLL_SELFREQDCO_MASK | PLL_IDLE);
238 val |= dpll_params->freq << PLL_SELFREQDCO_SHIFT;
239 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_CONFIGURATION2, val);
241 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_CONFIGURATION1);
242 val &= ~PLL_REGM_MASK;
243 val |= dpll_params->m << PLL_REGM_SHIFT;
244 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_CONFIGURATION1, val);
246 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_CONFIGURATION4);
247 val &= ~PLL_REGM_F_MASK;
248 val |= dpll_params->mf << PLL_REGM_F_SHIFT;
249 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_CONFIGURATION4, val);
251 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_CONFIGURATION3);
253 val |= dpll_params->sd << PLL_SD_SHIFT;
254 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_CONFIGURATION3, val);
256 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_GO, SET_PLL_GO);
258 return omap_pipe3_wait_lock(pipe3);
261 static void omap_control_pipe3_power(struct omap_pipe3 *pipe3, int on)
265 val = readl(pipe3->power_reg);
267 rate = get_sys_clk_freq();
271 val &= ~(PIPE3_PHY_PWRCTL_CLK_CMD_MASK |
272 PIPE3_PHY_PWRCTL_CLK_FREQ_MASK);
273 val |= rate << PIPE3_PHY_PWRCTL_CLK_FREQ_SHIFT;
274 writel(val, pipe3->power_reg);
276 /* Power up TX before RX for SATA & USB */
277 val |= PIPE3_PHY_TX_POWERON;
278 writel(val, pipe3->power_reg);
280 val |= PIPE3_PHY_RX_POWERON;
281 writel(val, pipe3->power_reg);
283 val &= ~PIPE3_PHY_PWRCTL_CLK_CMD_MASK;
284 writel(val, pipe3->power_reg);
288 static void ti_pipe3_calibrate(struct omap_pipe3 *phy)
291 struct pipe3_settings *s = &phy->settings;
293 val = omap_pipe3_readl(phy->phy_rx, PIPE3_PHY_RX_ANA_PROGRAMMABILITY);
294 val &= ~(INTERFACE_MASK | LOSD_MASK | MEM_PLLDIV);
295 val = (s->ana_interface << INTERFACE_SHIFT | s->ana_losd << LOSD_SHIFT);
296 omap_pipe3_writel(phy->phy_rx, PIPE3_PHY_RX_ANA_PROGRAMMABILITY, val);
298 val = omap_pipe3_readl(phy->phy_rx, PIPE3_PHY_RX_DIGITAL_MODES);
299 val &= ~(MEM_HS_RATE_MASK | MEM_OVRD_HS_RATE | MEM_CDR_FASTLOCK |
300 MEM_CDR_LBW_MASK | MEM_CDR_STEPCNT_MASK | MEM_CDR_STL_MASK |
301 MEM_CDR_THR_MASK | MEM_CDR_THR_MODE | MEM_CDR_2NDO_SDM_MODE);
302 val |= s->dig_hs_rate << MEM_HS_RATE_SHIFT |
303 s->dig_ovrd_hs_rate << MEM_OVRD_HS_RATE_SHIFT |
304 s->dig_fastlock << MEM_CDR_FASTLOCK_SHIFT |
305 s->dig_lbw << MEM_CDR_LBW_SHIFT |
306 s->dig_stepcnt << MEM_CDR_STEPCNT_SHIFT |
307 s->dig_stl << MEM_CDR_STL_SHIFT |
308 s->dig_thr << MEM_CDR_THR_SHIFT |
309 s->dig_thr_mode << MEM_CDR_THR_MODE_SHIFT |
310 s->dig_2ndo_sdm_mode << MEM_CDR_2NDO_SDM_MODE_SHIFT;
311 omap_pipe3_writel(phy->phy_rx, PIPE3_PHY_RX_DIGITAL_MODES, val);
313 val = omap_pipe3_readl(phy->phy_rx, PIPE3_PHY_RX_TRIM);
314 val &= ~MEM_DLL_TRIM_SEL_MASK;
315 val |= s->dll_trim_sel << MEM_DLL_TRIM_SHIFT;
316 omap_pipe3_writel(phy->phy_rx, PIPE3_PHY_RX_TRIM, val);
318 val = omap_pipe3_readl(phy->phy_rx, PIPE3_PHY_RX_DLL);
319 val &= ~MEM_DLL_PHINT_RATE_MASK;
320 val |= s->dll_phint_rate << MEM_DLL_PHINT_RATE_SHIFT;
321 omap_pipe3_writel(phy->phy_rx, PIPE3_PHY_RX_DLL, val);
323 val = omap_pipe3_readl(phy->phy_rx, PIPE3_PHY_RX_EQUALIZER);
324 val &= ~(MEM_EQLEV_MASK | MEM_EQFTC_MASK | MEM_EQCTL_MASK |
325 MEM_OVRD_EQLEV | MEM_OVRD_EQFTC);
326 val |= s->eq_lev << MEM_EQLEV_SHIFT |
327 s->eq_ftc << MEM_EQFTC_SHIFT |
328 s->eq_ctl << MEM_EQCTL_SHIFT |
329 s->eq_ovrd_lev << MEM_OVRD_EQLEV_SHIFT |
330 s->eq_ovrd_ftc << MEM_OVRD_EQFTC_SHIFT;
331 omap_pipe3_writel(phy->phy_rx, PIPE3_PHY_RX_EQUALIZER, val);
333 if (phy->mode == PIPE3_MODE_SATA) {
334 val = omap_pipe3_readl(phy->phy_rx,
335 SATA_PHY_RX_IO_AND_A2D_OVERRIDES);
336 val &= ~MEM_CDR_LOS_SOURCE_MASK;
337 omap_pipe3_writel(phy->phy_rx, SATA_PHY_RX_IO_AND_A2D_OVERRIDES,
342 static int pipe3_init(struct phy *phy)
346 struct omap_pipe3 *pipe3 = dev_get_priv(phy->dev);
348 /* Program the DPLL only if not locked */
349 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_STATUS);
350 if (!(val & PLL_LOCK)) {
351 ret = omap_pipe3_dpll_program(pipe3);
355 ti_pipe3_calibrate(pipe3);
357 /* else just bring it out of IDLE mode */
358 val = omap_pipe3_readl(pipe3->pll_ctrl_base,
360 if (val & PLL_IDLE) {
362 omap_pipe3_writel(pipe3->pll_ctrl_base,
363 PLL_CONFIGURATION2, val);
364 ret = omap_pipe3_wait_lock(pipe3);
372 static int pipe3_power_on(struct phy *phy)
374 struct omap_pipe3 *pipe3 = dev_get_priv(phy->dev);
376 /* Power up the PHY */
377 omap_control_pipe3_power(pipe3, 1);
382 static int pipe3_power_off(struct phy *phy)
384 struct omap_pipe3 *pipe3 = dev_get_priv(phy->dev);
386 /* Power down the PHY */
387 omap_control_pipe3_power(pipe3, 0);
392 static int pipe3_exit(struct phy *phy)
395 int timeout = PLL_IDLE_TIME;
396 struct omap_pipe3 *pipe3 = dev_get_priv(phy->dev);
398 pipe3_power_off(phy);
400 /* Put DPLL in IDLE mode */
401 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_CONFIGURATION2);
403 omap_pipe3_writel(pipe3->pll_ctrl_base, PLL_CONFIGURATION2, val);
405 /* wait for LDO and Oscillator to power down */
408 val = omap_pipe3_readl(pipe3->pll_ctrl_base, PLL_STATUS);
409 if ((val & PLL_TICOPWDN) && (val & PLL_LDOPWDN))
413 if (!(val & PLL_TICOPWDN) || !(val & PLL_LDOPWDN)) {
414 pr_err("%s: Failed to power down DPLL: PLL_STATUS 0x%x\n",
419 if (pipe3->pll_reset_reg) {
420 val = readl(pipe3->pll_reset_reg);
421 writel(val | SATA_PLL_SOFT_RESET, pipe3->pll_reset_reg);
423 writel(val & ~SATA_PLL_SOFT_RESET, pipe3->pll_reset_reg);
429 static void *get_reg(struct udevice *dev, const char *name)
431 struct udevice *syscon;
432 struct regmap *regmap;
437 err = uclass_get_device_by_phandle(UCLASS_SYSCON, dev,
440 pr_err("unable to find syscon device for %s (%d)\n",
445 regmap = syscon_get_regmap(syscon);
446 if (IS_ERR(regmap)) {
447 pr_err("unable to find regmap for %s (%ld)\n",
448 name, PTR_ERR(regmap));
452 cell = fdt_getprop(gd->fdt_blob, dev_of_offset(dev), name,
454 if (len < 2*sizeof(fdt32_t)) {
455 pr_err("offset not available for %s\n", name);
459 base = regmap_get_range(regmap, 0);
463 return fdtdec_get_number(cell + 1, 1) + base;
466 static int pipe3_phy_probe(struct udevice *dev)
470 struct omap_pipe3 *pipe3 = dev_get_priv(dev);
471 struct pipe3_data *data;
474 addr = devfdt_get_addr_size_index(dev, 0, &sz);
475 if (addr == FDT_ADDR_T_NONE) {
476 pr_err("missing phy_rx address\n");
480 pipe3->phy_rx = map_physmem(addr, sz, MAP_NOCACHE);
481 if (!pipe3->phy_rx) {
482 pr_err("unable to remap phy_rx\n");
487 addr = devfdt_get_addr_size_index(dev, 2, &sz);
488 if (addr == FDT_ADDR_T_NONE) {
489 pr_err("missing pll ctrl address\n");
493 pipe3->pll_ctrl_base = map_physmem(addr, sz, MAP_NOCACHE);
494 if (!pipe3->pll_ctrl_base) {
495 pr_err("unable to remap pll ctrl\n");
499 pipe3->power_reg = get_reg(dev, "syscon-phy-power");
500 if (!pipe3->power_reg)
503 data = (struct pipe3_data *)dev_get_driver_data(dev);
504 pipe3->mode = data->mode;
505 pipe3->dpll_map = data->dpll_map;
506 pipe3->settings = data->settings;
508 if (pipe3->mode == PIPE3_MODE_SATA) {
509 pipe3->pll_reset_reg = get_reg(dev, "syscon-pllreset");
510 if (!pipe3->pll_reset_reg)
517 static struct pipe3_dpll_map dpll_map_sata[] = {
518 {12000000, {625, 4, 4, 6, 0} }, /* 12 MHz */
519 {16800000, {625, 6, 4, 7, 0} }, /* 16.8 MHz */
520 {19200000, {625, 7, 4, 6, 0} }, /* 19.2 MHz */
521 {20000000, {750, 9, 4, 6, 0} }, /* 20 MHz */
522 {26000000, {750, 12, 4, 6, 0} }, /* 26 MHz */
523 {38400000, {625, 15, 4, 6, 0} }, /* 38.4 MHz */
524 { }, /* Terminator */
527 static struct pipe3_dpll_map dpll_map_usb[] = {
528 {12000000, {1250, 5, 4, 20, 0} }, /* 12 MHz */
529 {16800000, {3125, 20, 4, 20, 0} }, /* 16.8 MHz */
530 {19200000, {1172, 8, 4, 20, 65537} }, /* 19.2 MHz */
531 {20000000, {1000, 7, 4, 10, 0} }, /* 20 MHz */
532 {26000000, {1250, 12, 4, 20, 0} }, /* 26 MHz */
533 {38400000, {3125, 47, 4, 20, 92843} }, /* 38.4 MHz */
534 { }, /* Terminator */
537 static struct pipe3_data data_usb = {
538 .mode = PIPE3_MODE_USBSS,
539 .dpll_map = dpll_map_usb,
541 /* DRA75x TRM Table 26-17. Preferred USB3_PHY_RX SCP Register Settings */
542 .ana_interface = INTERFACE_MODE_USBSS,
550 .dig_2ndo_sdm_mode = 0,
552 .dig_ovrd_hs_rate = 1,
554 .dll_phint_rate = 0x3,
563 static struct pipe3_data data_sata = {
564 .mode = PIPE3_MODE_SATA,
565 .dpll_map = dpll_map_sata,
567 /* DRA75x TRM Table 26-9. Preferred SATA_PHY_RX SCP Register Settings */
568 .ana_interface = INTERFACE_MODE_SATA_3P0,
576 .dig_2ndo_sdm_mode = 0,
577 .dig_hs_rate = 0, /* Not in TRM preferred settings */
578 .dig_ovrd_hs_rate = 0, /* Not in TRM preferred settings */
580 .dll_phint_rate = 0x2, /* for 1.5 GHz DPLL clock */
589 static const struct udevice_id pipe3_phy_ids[] = {
590 { .compatible = "ti,phy-pipe3-sata", .data = (ulong)&data_sata },
591 { .compatible = "ti,omap-usb3", .data = (ulong)&data_usb},
595 static struct phy_ops pipe3_phy_ops = {
597 .power_on = pipe3_power_on,
598 .power_off = pipe3_power_off,
602 U_BOOT_DRIVER(pipe3_phy) = {
605 .of_match = pipe3_phy_ids,
606 .ops = &pipe3_phy_ops,
607 .probe = pipe3_phy_probe,
608 .priv_auto = sizeof(struct omap_pipe3),