1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2014 STMicroelectronics
5 * STMicroelectronics PHY driver MiPHY28lp (for SoC STiH407).
7 * Author: Alexandre Torgue <alexandre.torgue@st.com>
10 #include <linux/platform_device.h>
12 #include <linux/kernel.h>
13 #include <linux/module.h>
15 #include <linux/of_platform.h>
16 #include <linux/of_address.h>
17 #include <linux/clk.h>
18 #include <linux/phy/phy.h>
19 #include <linux/delay.h>
20 #include <linux/mfd/syscon.h>
21 #include <linux/regmap.h>
22 #include <linux/reset.h>
24 #include <dt-bindings/phy/phy.h>
27 #define MIPHY_CONF_RESET 0x00
28 #define RST_APPLI_SW BIT(0)
29 #define RST_CONF_SW BIT(1)
30 #define RST_MACRO_SW BIT(2)
32 #define MIPHY_RESET 0x01
33 #define RST_PLL_SW BIT(0)
34 #define RST_COMP_SW BIT(2)
36 #define MIPHY_STATUS_1 0x02
37 #define PHY_RDY BIT(0)
38 #define HFC_RDY BIT(1)
39 #define HFC_PLL BIT(2)
41 #define MIPHY_CONTROL 0x04
42 #define TERM_EN_SW BIT(2)
43 #define DIS_LINK_RST BIT(3)
44 #define AUTO_RST_RX BIT(4)
45 #define PX_RX_POL BIT(5)
47 #define MIPHY_BOUNDARY_SEL 0x0a
49 #define SSC_SEL BIT(4)
50 #define GENSEL_SEL BIT(0)
52 #define MIPHY_BOUNDARY_1 0x0b
53 #define MIPHY_BOUNDARY_2 0x0c
54 #define SSC_EN_SW BIT(2)
56 #define MIPHY_PLL_CLKREF_FREQ 0x0d
57 #define MIPHY_SPEED 0x0e
58 #define TX_SPDSEL_80DEC 0
59 #define TX_SPDSEL_40DEC 1
60 #define TX_SPDSEL_20DEC 2
61 #define RX_SPDSEL_80DEC 0
62 #define RX_SPDSEL_40DEC (1 << 2)
63 #define RX_SPDSEL_20DEC (2 << 2)
65 #define MIPHY_CONF 0x0f
66 #define MIPHY_CTRL_TEST_SEL 0x20
67 #define MIPHY_CTRL_TEST_1 0x21
68 #define MIPHY_CTRL_TEST_2 0x22
69 #define MIPHY_CTRL_TEST_3 0x23
70 #define MIPHY_CTRL_TEST_4 0x24
71 #define MIPHY_FEEDBACK_TEST 0x25
72 #define MIPHY_DEBUG_BUS 0x26
73 #define MIPHY_DEBUG_STATUS_MSB 0x27
74 #define MIPHY_DEBUG_STATUS_LSB 0x28
75 #define MIPHY_PWR_RAIL_1 0x29
76 #define MIPHY_PWR_RAIL_2 0x2a
77 #define MIPHY_SYNCHAR_CONTROL 0x30
79 #define MIPHY_COMP_FSM_1 0x3a
80 #define COMP_START BIT(6)
82 #define MIPHY_COMP_FSM_6 0x3f
83 #define COMP_DONE BIT(7)
85 #define MIPHY_COMP_POSTP 0x42
86 #define MIPHY_TX_CTRL_1 0x49
87 #define TX_REG_STEP_0V 0
88 #define TX_REG_STEP_P_25MV 1
89 #define TX_REG_STEP_P_50MV 2
90 #define TX_REG_STEP_N_25MV 7
91 #define TX_REG_STEP_N_50MV 6
92 #define TX_REG_STEP_N_75MV 5
94 #define MIPHY_TX_CTRL_2 0x4a
95 #define TX_SLEW_SW_40_PS 0
96 #define TX_SLEW_SW_80_PS 1
97 #define TX_SLEW_SW_120_PS 2
99 #define MIPHY_TX_CTRL_3 0x4b
100 #define MIPHY_TX_CAL_MAN 0x4e
101 #define TX_SLEW_CAL_MAN_EN BIT(0)
103 #define MIPHY_TST_BIAS_BOOST_2 0x62
104 #define MIPHY_BIAS_BOOST_1 0x63
105 #define MIPHY_BIAS_BOOST_2 0x64
106 #define MIPHY_RX_DESBUFF_FDB_2 0x67
107 #define MIPHY_RX_DESBUFF_FDB_3 0x68
108 #define MIPHY_SIGDET_COMPENS1 0x69
109 #define MIPHY_SIGDET_COMPENS2 0x6a
110 #define MIPHY_JITTER_PERIOD 0x6b
111 #define MIPHY_JITTER_AMPLITUDE_1 0x6c
112 #define MIPHY_JITTER_AMPLITUDE_2 0x6d
113 #define MIPHY_JITTER_AMPLITUDE_3 0x6e
114 #define MIPHY_RX_K_GAIN 0x78
115 #define MIPHY_RX_BUFFER_CTRL 0x7a
116 #define VGA_GAIN BIT(0)
117 #define EQ_DC_GAIN BIT(2)
118 #define EQ_BOOST_GAIN BIT(3)
120 #define MIPHY_RX_VGA_GAIN 0x7b
121 #define MIPHY_RX_EQU_GAIN_1 0x7f
122 #define MIPHY_RX_EQU_GAIN_2 0x80
123 #define MIPHY_RX_EQU_GAIN_3 0x81
124 #define MIPHY_RX_CAL_CTRL_1 0x97
125 #define MIPHY_RX_CAL_CTRL_2 0x98
127 #define MIPHY_RX_CAL_OFFSET_CTRL 0x99
128 #define CAL_OFFSET_VGA_64 (0x03 << 0)
129 #define CAL_OFFSET_THRESHOLD_64 (0x03 << 2)
130 #define VGA_OFFSET_POLARITY BIT(4)
131 #define OFFSET_COMPENSATION_EN BIT(6)
133 #define MIPHY_RX_CAL_VGA_STEP 0x9a
134 #define MIPHY_RX_CAL_EYE_MIN 0x9d
135 #define MIPHY_RX_CAL_OPT_LENGTH 0x9f
136 #define MIPHY_RX_LOCK_CTRL_1 0xc1
137 #define MIPHY_RX_LOCK_SETTINGS_OPT 0xc2
138 #define MIPHY_RX_LOCK_STEP 0xc4
140 #define MIPHY_RX_SIGDET_SLEEP_OA 0xc9
141 #define MIPHY_RX_SIGDET_SLEEP_SEL 0xca
142 #define MIPHY_RX_SIGDET_WAIT_SEL 0xcb
143 #define MIPHY_RX_SIGDET_DATA_SEL 0xcc
144 #define EN_ULTRA_LOW_POWER BIT(0)
145 #define EN_FIRST_HALF BIT(1)
146 #define EN_SECOND_HALF BIT(2)
147 #define EN_DIGIT_SIGNAL_CHECK BIT(3)
149 #define MIPHY_RX_POWER_CTRL_1 0xcd
150 #define MIPHY_RX_POWER_CTRL_2 0xce
151 #define MIPHY_PLL_CALSET_CTRL 0xd3
152 #define MIPHY_PLL_CALSET_1 0xd4
153 #define MIPHY_PLL_CALSET_2 0xd5
154 #define MIPHY_PLL_CALSET_3 0xd6
155 #define MIPHY_PLL_CALSET_4 0xd7
156 #define MIPHY_PLL_SBR_1 0xe3
157 #define SET_NEW_CHANGE BIT(1)
159 #define MIPHY_PLL_SBR_2 0xe4
160 #define MIPHY_PLL_SBR_3 0xe5
161 #define MIPHY_PLL_SBR_4 0xe6
162 #define MIPHY_PLL_COMMON_MISC_2 0xe9
163 #define START_ACT_FILT BIT(6)
165 #define MIPHY_PLL_SPAREIN 0xeb
168 * On STiH407 the glue logic can be different among MiPHY devices; for example:
169 * MiPHY0: OSC_FORCE_EXT means:
170 * 0: 30MHz crystal clk - 1: 100MHz ext clk routed through MiPHY1
171 * MiPHY1: OSC_FORCE_EXT means:
172 * 1: 30MHz crystal clk - 0: 100MHz ext clk routed through MiPHY1
173 * Some devices have not the possibility to check if the osc is ready.
175 #define MIPHY_OSC_FORCE_EXT BIT(3)
176 #define MIPHY_OSC_RDY BIT(5)
178 #define MIPHY_CTRL_MASK 0x0f
179 #define MIPHY_CTRL_DEFAULT 0
180 #define MIPHY_CTRL_SYNC_D_EN BIT(2)
182 /* SATA / PCIe defines */
183 #define SATA_CTRL_MASK 0x07
184 #define PCIE_CTRL_MASK 0xff
185 #define SATA_CTRL_SELECT_SATA 1
186 #define SATA_CTRL_SELECT_PCIE 0
187 #define SYSCFG_PCIE_PCIE_VAL 0x80
188 #define SATA_SPDMODE 1
190 #define MIPHY_SATA_BANK_NB 3
191 #define MIPHY_PCIE_BANK_NB 2
201 struct miphy28lp_phy {
203 struct miphy28lp_dev *phydev;
205 void __iomem *pipebase;
213 struct reset_control *miphy_rst;
217 /* Sysconfig registers offsets needed to configure the device */
218 u32 syscfg_reg[SYSCFG_REG_MAX];
222 struct miphy28lp_dev {
224 struct regmap *regmap;
225 struct mutex miphy_mutex;
226 struct miphy28lp_phy **phys;
230 struct miphy_initval {
235 enum miphy_sata_gen { SATA_GEN1, SATA_GEN2, SATA_GEN3 };
237 static char *PHY_TYPE_name[] = { "sata-up", "pcie-up", "", "usb3-up" };
248 static struct pll_ratio sata_pll_ratio = {
257 static struct pll_ratio pcie_pll_ratio = {
266 static struct pll_ratio usb3_pll_ratio = {
275 struct miphy28lp_pll_gen {
291 static struct miphy28lp_pll_gen sata_pll_gen[] = {
294 .speed = TX_SPDSEL_80DEC | RX_SPDSEL_80DEC,
295 .bias_boost_1 = 0x00,
296 .bias_boost_2 = 0xae,
299 .rx_buff_ctrl = EQ_BOOST_GAIN | EQ_DC_GAIN | VGA_GAIN,
301 .rx_equ_gain_1 = 0x7d,
302 .rx_equ_gain_2 = 0x56,
303 .rx_equ_gain_3 = 0x00,
307 .speed = TX_SPDSEL_40DEC | RX_SPDSEL_40DEC,
308 .bias_boost_1 = 0x00,
309 .bias_boost_2 = 0xae,
312 .rx_buff_ctrl = EQ_BOOST_GAIN | EQ_DC_GAIN | VGA_GAIN,
314 .rx_equ_gain_1 = 0x7d,
315 .rx_equ_gain_2 = 0x56,
316 .rx_equ_gain_3 = 0x00,
320 .speed = TX_SPDSEL_20DEC | RX_SPDSEL_20DEC,
321 .bias_boost_1 = 0x00,
322 .bias_boost_2 = 0xae,
325 .rx_buff_ctrl = EQ_BOOST_GAIN | EQ_DC_GAIN | VGA_GAIN,
327 .rx_equ_gain_1 = 0x7d,
328 .rx_equ_gain_2 = 0x56,
329 .rx_equ_gain_3 = 0x00,
333 static struct miphy28lp_pll_gen pcie_pll_gen[] = {
336 .speed = TX_SPDSEL_40DEC | RX_SPDSEL_40DEC,
337 .bias_boost_1 = 0x00,
338 .bias_boost_2 = 0xa5,
339 .tx_ctrl_1 = TX_REG_STEP_N_25MV,
343 .rx_buff_ctrl = EQ_BOOST_GAIN | EQ_DC_GAIN | VGA_GAIN,
345 .rx_equ_gain_1 = 0x79,
346 .rx_equ_gain_2 = 0x56,
350 .speed = TX_SPDSEL_20DEC | RX_SPDSEL_20DEC,
351 .bias_boost_1 = 0x00,
352 .bias_boost_2 = 0xa5,
353 .tx_ctrl_1 = TX_REG_STEP_N_25MV,
357 .rx_buff_ctrl = EQ_BOOST_GAIN | EQ_DC_GAIN | VGA_GAIN,
359 .rx_equ_gain_1 = 0x78,
360 .rx_equ_gain_2 = 0x07,
364 static inline void miphy28lp_set_reset(struct miphy28lp_phy *miphy_phy)
366 void __iomem *base = miphy_phy->base;
369 /* Putting Macro in reset */
370 writeb_relaxed(RST_APPLI_SW, base + MIPHY_CONF_RESET);
372 val = RST_APPLI_SW | RST_CONF_SW;
373 writeb_relaxed(val, base + MIPHY_CONF_RESET);
375 writeb_relaxed(RST_APPLI_SW, base + MIPHY_CONF_RESET);
377 /* Bringing the MIPHY-CPU registers out of reset */
378 if (miphy_phy->type == PHY_TYPE_PCIE) {
379 val = AUTO_RST_RX | TERM_EN_SW;
380 writeb_relaxed(val, base + MIPHY_CONTROL);
382 val = AUTO_RST_RX | TERM_EN_SW | DIS_LINK_RST;
383 writeb_relaxed(val, base + MIPHY_CONTROL);
387 static inline void miphy28lp_pll_calibration(struct miphy28lp_phy *miphy_phy,
388 struct pll_ratio *pll_ratio)
390 void __iomem *base = miphy_phy->base;
393 /* Applying PLL Settings */
394 writeb_relaxed(0x1d, base + MIPHY_PLL_SPAREIN);
395 writeb_relaxed(pll_ratio->clk_ref, base + MIPHY_PLL_CLKREF_FREQ);
398 writeb_relaxed(pll_ratio->calset_1, base + MIPHY_PLL_CALSET_1);
399 writeb_relaxed(pll_ratio->calset_2, base + MIPHY_PLL_CALSET_2);
400 writeb_relaxed(pll_ratio->calset_3, base + MIPHY_PLL_CALSET_3);
401 writeb_relaxed(pll_ratio->calset_4, base + MIPHY_PLL_CALSET_4);
402 writeb_relaxed(pll_ratio->cal_ctrl, base + MIPHY_PLL_CALSET_CTRL);
404 writeb_relaxed(TX_SEL, base + MIPHY_BOUNDARY_SEL);
406 val = (0x68 << 1) | TX_SLEW_CAL_MAN_EN;
407 writeb_relaxed(val, base + MIPHY_TX_CAL_MAN);
409 val = VGA_OFFSET_POLARITY | CAL_OFFSET_THRESHOLD_64 | CAL_OFFSET_VGA_64;
411 if (miphy_phy->type != PHY_TYPE_SATA)
412 val |= OFFSET_COMPENSATION_EN;
414 writeb_relaxed(val, base + MIPHY_RX_CAL_OFFSET_CTRL);
416 if (miphy_phy->type == PHY_TYPE_USB3) {
417 writeb_relaxed(0x00, base + MIPHY_CONF);
418 writeb_relaxed(0x70, base + MIPHY_RX_LOCK_STEP);
419 writeb_relaxed(EN_FIRST_HALF, base + MIPHY_RX_SIGDET_SLEEP_OA);
420 writeb_relaxed(EN_FIRST_HALF, base + MIPHY_RX_SIGDET_SLEEP_SEL);
421 writeb_relaxed(EN_FIRST_HALF, base + MIPHY_RX_SIGDET_WAIT_SEL);
423 val = EN_DIGIT_SIGNAL_CHECK | EN_FIRST_HALF;
424 writeb_relaxed(val, base + MIPHY_RX_SIGDET_DATA_SEL);
429 static inline void miphy28lp_sata_config_gen(struct miphy28lp_phy *miphy_phy)
431 void __iomem *base = miphy_phy->base;
434 for (i = 0; i < ARRAY_SIZE(sata_pll_gen); i++) {
435 struct miphy28lp_pll_gen *gen = &sata_pll_gen[i];
437 /* Banked settings */
438 writeb_relaxed(gen->bank, base + MIPHY_CONF);
439 writeb_relaxed(gen->speed, base + MIPHY_SPEED);
440 writeb_relaxed(gen->bias_boost_1, base + MIPHY_BIAS_BOOST_1);
441 writeb_relaxed(gen->bias_boost_2, base + MIPHY_BIAS_BOOST_2);
443 /* TX buffer Settings */
444 writeb_relaxed(gen->tx_ctrl_2, base + MIPHY_TX_CTRL_2);
445 writeb_relaxed(gen->tx_ctrl_3, base + MIPHY_TX_CTRL_3);
447 /* RX Buffer Settings */
448 writeb_relaxed(gen->rx_buff_ctrl, base + MIPHY_RX_BUFFER_CTRL);
449 writeb_relaxed(gen->rx_vga_gain, base + MIPHY_RX_VGA_GAIN);
450 writeb_relaxed(gen->rx_equ_gain_1, base + MIPHY_RX_EQU_GAIN_1);
451 writeb_relaxed(gen->rx_equ_gain_2, base + MIPHY_RX_EQU_GAIN_2);
452 writeb_relaxed(gen->rx_equ_gain_3, base + MIPHY_RX_EQU_GAIN_3);
456 static inline void miphy28lp_pcie_config_gen(struct miphy28lp_phy *miphy_phy)
458 void __iomem *base = miphy_phy->base;
461 for (i = 0; i < ARRAY_SIZE(pcie_pll_gen); i++) {
462 struct miphy28lp_pll_gen *gen = &pcie_pll_gen[i];
464 /* Banked settings */
465 writeb_relaxed(gen->bank, base + MIPHY_CONF);
466 writeb_relaxed(gen->speed, base + MIPHY_SPEED);
467 writeb_relaxed(gen->bias_boost_1, base + MIPHY_BIAS_BOOST_1);
468 writeb_relaxed(gen->bias_boost_2, base + MIPHY_BIAS_BOOST_2);
470 /* TX buffer Settings */
471 writeb_relaxed(gen->tx_ctrl_1, base + MIPHY_TX_CTRL_1);
472 writeb_relaxed(gen->tx_ctrl_2, base + MIPHY_TX_CTRL_2);
473 writeb_relaxed(gen->tx_ctrl_3, base + MIPHY_TX_CTRL_3);
475 writeb_relaxed(gen->rx_k_gain, base + MIPHY_RX_K_GAIN);
477 /* RX Buffer Settings */
478 writeb_relaxed(gen->rx_buff_ctrl, base + MIPHY_RX_BUFFER_CTRL);
479 writeb_relaxed(gen->rx_vga_gain, base + MIPHY_RX_VGA_GAIN);
480 writeb_relaxed(gen->rx_equ_gain_1, base + MIPHY_RX_EQU_GAIN_1);
481 writeb_relaxed(gen->rx_equ_gain_2, base + MIPHY_RX_EQU_GAIN_2);
485 static inline int miphy28lp_wait_compensation(struct miphy28lp_phy *miphy_phy)
487 unsigned long finish = jiffies + 5 * HZ;
490 /* Waiting for Compensation to complete */
492 val = readb_relaxed(miphy_phy->base + MIPHY_COMP_FSM_6);
494 if (time_after_eq(jiffies, finish))
497 } while (!(val & COMP_DONE));
503 static inline int miphy28lp_compensation(struct miphy28lp_phy *miphy_phy,
504 struct pll_ratio *pll_ratio)
506 void __iomem *base = miphy_phy->base;
508 /* Poll for HFC ready after reset release */
509 /* Compensation measurement */
510 writeb_relaxed(RST_PLL_SW | RST_COMP_SW, base + MIPHY_RESET);
512 writeb_relaxed(0x00, base + MIPHY_PLL_COMMON_MISC_2);
513 writeb_relaxed(pll_ratio->clk_ref, base + MIPHY_PLL_CLKREF_FREQ);
514 writeb_relaxed(COMP_START, base + MIPHY_COMP_FSM_1);
516 if (miphy_phy->type == PHY_TYPE_PCIE)
517 writeb_relaxed(RST_PLL_SW, base + MIPHY_RESET);
519 writeb_relaxed(0x00, base + MIPHY_RESET);
520 writeb_relaxed(START_ACT_FILT, base + MIPHY_PLL_COMMON_MISC_2);
521 writeb_relaxed(SET_NEW_CHANGE, base + MIPHY_PLL_SBR_1);
523 /* TX compensation offset to re-center TX impedance */
524 writeb_relaxed(0x00, base + MIPHY_COMP_POSTP);
526 if (miphy_phy->type == PHY_TYPE_PCIE)
527 return miphy28lp_wait_compensation(miphy_phy);
532 static inline void miphy28_usb3_miphy_reset(struct miphy28lp_phy *miphy_phy)
534 void __iomem *base = miphy_phy->base;
538 writeb_relaxed(RST_APPLI_SW, base + MIPHY_CONF_RESET);
539 writeb_relaxed(0x00, base + MIPHY_CONF_RESET);
540 writeb_relaxed(RST_COMP_SW, base + MIPHY_RESET);
542 val = RST_COMP_SW | RST_PLL_SW;
543 writeb_relaxed(val, base + MIPHY_RESET);
545 writeb_relaxed(0x00, base + MIPHY_PLL_COMMON_MISC_2);
546 writeb_relaxed(0x1e, base + MIPHY_PLL_CLKREF_FREQ);
547 writeb_relaxed(COMP_START, base + MIPHY_COMP_FSM_1);
548 writeb_relaxed(RST_PLL_SW, base + MIPHY_RESET);
549 writeb_relaxed(0x00, base + MIPHY_RESET);
550 writeb_relaxed(START_ACT_FILT, base + MIPHY_PLL_COMMON_MISC_2);
551 writeb_relaxed(0x00, base + MIPHY_CONF);
552 writeb_relaxed(0x00, base + MIPHY_BOUNDARY_1);
553 writeb_relaxed(0x00, base + MIPHY_TST_BIAS_BOOST_2);
554 writeb_relaxed(0x00, base + MIPHY_CONF);
555 writeb_relaxed(SET_NEW_CHANGE, base + MIPHY_PLL_SBR_1);
556 writeb_relaxed(0xa5, base + MIPHY_DEBUG_BUS);
557 writeb_relaxed(0x00, base + MIPHY_CONF);
560 static void miphy_sata_tune_ssc(struct miphy28lp_phy *miphy_phy)
562 void __iomem *base = miphy_phy->base;
565 /* Compensate Tx impedance to avoid out of range values */
567 * Enable the SSC on PLL for all banks
568 * SSC Modulation @ 31 KHz and 4000 ppm modulation amp
570 val = readb_relaxed(base + MIPHY_BOUNDARY_2);
572 writeb_relaxed(val, base + MIPHY_BOUNDARY_2);
574 val = readb_relaxed(base + MIPHY_BOUNDARY_SEL);
576 writeb_relaxed(val, base + MIPHY_BOUNDARY_SEL);
578 for (val = 0; val < MIPHY_SATA_BANK_NB; val++) {
579 writeb_relaxed(val, base + MIPHY_CONF);
581 /* Add value to each reference clock cycle */
582 /* and define the period length of the SSC */
583 writeb_relaxed(0x3c, base + MIPHY_PLL_SBR_2);
584 writeb_relaxed(0x6c, base + MIPHY_PLL_SBR_3);
585 writeb_relaxed(0x81, base + MIPHY_PLL_SBR_4);
587 /* Clear any previous request */
588 writeb_relaxed(0x00, base + MIPHY_PLL_SBR_1);
590 /* requests the PLL to take in account new parameters */
591 writeb_relaxed(SET_NEW_CHANGE, base + MIPHY_PLL_SBR_1);
593 /* To be sure there is no other pending requests */
594 writeb_relaxed(0x00, base + MIPHY_PLL_SBR_1);
598 static void miphy_pcie_tune_ssc(struct miphy28lp_phy *miphy_phy)
600 void __iomem *base = miphy_phy->base;
603 /* Compensate Tx impedance to avoid out of range values */
605 * Enable the SSC on PLL for all banks
606 * SSC Modulation @ 31 KHz and 4000 ppm modulation amp
608 val = readb_relaxed(base + MIPHY_BOUNDARY_2);
610 writeb_relaxed(val, base + MIPHY_BOUNDARY_2);
612 val = readb_relaxed(base + MIPHY_BOUNDARY_SEL);
614 writeb_relaxed(val, base + MIPHY_BOUNDARY_SEL);
616 for (val = 0; val < MIPHY_PCIE_BANK_NB; val++) {
617 writeb_relaxed(val, base + MIPHY_CONF);
619 /* Validate Step component */
620 writeb_relaxed(0x69, base + MIPHY_PLL_SBR_3);
621 writeb_relaxed(0x21, base + MIPHY_PLL_SBR_4);
623 /* Validate Period component */
624 writeb_relaxed(0x3c, base + MIPHY_PLL_SBR_2);
625 writeb_relaxed(0x21, base + MIPHY_PLL_SBR_4);
627 /* Clear any previous request */
628 writeb_relaxed(0x00, base + MIPHY_PLL_SBR_1);
630 /* requests the PLL to take in account new parameters */
631 writeb_relaxed(SET_NEW_CHANGE, base + MIPHY_PLL_SBR_1);
633 /* To be sure there is no other pending requests */
634 writeb_relaxed(0x00, base + MIPHY_PLL_SBR_1);
638 static inline void miphy_tune_tx_impedance(struct miphy28lp_phy *miphy_phy)
640 /* Compensate Tx impedance to avoid out of range values */
641 writeb_relaxed(0x02, miphy_phy->base + MIPHY_COMP_POSTP);
644 static inline int miphy28lp_configure_sata(struct miphy28lp_phy *miphy_phy)
646 void __iomem *base = miphy_phy->base;
650 /* Putting Macro in reset */
651 miphy28lp_set_reset(miphy_phy);
653 /* PLL calibration */
654 miphy28lp_pll_calibration(miphy_phy, &sata_pll_ratio);
656 /* Banked settings Gen1/Gen2/Gen3 */
657 miphy28lp_sata_config_gen(miphy_phy);
660 /* Input bridge enable, manual input bridge control */
661 writeb_relaxed(0x21, base + MIPHY_RX_POWER_CTRL_1);
663 /* Macro out of reset */
664 writeb_relaxed(0x00, base + MIPHY_CONF_RESET);
666 /* Poll for HFC ready after reset release */
667 /* Compensation measurement */
668 err = miphy28lp_compensation(miphy_phy, &sata_pll_ratio);
672 if (miphy_phy->px_rx_pol_inv) {
673 /* Invert Rx polarity */
674 val = readb_relaxed(miphy_phy->base + MIPHY_CONTROL);
676 writeb_relaxed(val, miphy_phy->base + MIPHY_CONTROL);
680 miphy_sata_tune_ssc(miphy_phy);
682 if (miphy_phy->tx_impedance)
683 miphy_tune_tx_impedance(miphy_phy);
688 static inline int miphy28lp_configure_pcie(struct miphy28lp_phy *miphy_phy)
690 void __iomem *base = miphy_phy->base;
693 /* Putting Macro in reset */
694 miphy28lp_set_reset(miphy_phy);
696 /* PLL calibration */
697 miphy28lp_pll_calibration(miphy_phy, &pcie_pll_ratio);
699 /* Banked settings Gen1/Gen2 */
700 miphy28lp_pcie_config_gen(miphy_phy);
703 /* Input bridge enable, manual input bridge control */
704 writeb_relaxed(0x21, base + MIPHY_RX_POWER_CTRL_1);
706 /* Macro out of reset */
707 writeb_relaxed(0x00, base + MIPHY_CONF_RESET);
709 /* Poll for HFC ready after reset release */
710 /* Compensation measurement */
711 err = miphy28lp_compensation(miphy_phy, &pcie_pll_ratio);
716 miphy_pcie_tune_ssc(miphy_phy);
718 if (miphy_phy->tx_impedance)
719 miphy_tune_tx_impedance(miphy_phy);
725 static inline void miphy28lp_configure_usb3(struct miphy28lp_phy *miphy_phy)
727 void __iomem *base = miphy_phy->base;
730 /* Putting Macro in reset */
731 miphy28lp_set_reset(miphy_phy);
733 /* PLL calibration */
734 miphy28lp_pll_calibration(miphy_phy, &usb3_pll_ratio);
736 /* Writing The Speed Rate */
737 writeb_relaxed(0x00, base + MIPHY_CONF);
739 val = RX_SPDSEL_20DEC | TX_SPDSEL_20DEC;
740 writeb_relaxed(val, base + MIPHY_SPEED);
742 /* RX Channel compensation and calibration */
743 writeb_relaxed(0x1c, base + MIPHY_RX_LOCK_SETTINGS_OPT);
744 writeb_relaxed(0x51, base + MIPHY_RX_CAL_CTRL_1);
745 writeb_relaxed(0x70, base + MIPHY_RX_CAL_CTRL_2);
747 val = OFFSET_COMPENSATION_EN | VGA_OFFSET_POLARITY |
748 CAL_OFFSET_THRESHOLD_64 | CAL_OFFSET_VGA_64;
749 writeb_relaxed(val, base + MIPHY_RX_CAL_OFFSET_CTRL);
750 writeb_relaxed(0x22, base + MIPHY_RX_CAL_VGA_STEP);
751 writeb_relaxed(0x0e, base + MIPHY_RX_CAL_OPT_LENGTH);
753 val = EQ_DC_GAIN | VGA_GAIN;
754 writeb_relaxed(val, base + MIPHY_RX_BUFFER_CTRL);
755 writeb_relaxed(0x78, base + MIPHY_RX_EQU_GAIN_1);
756 writeb_relaxed(0x1b, base + MIPHY_SYNCHAR_CONTROL);
758 /* TX compensation offset to re-center TX impedance */
759 writeb_relaxed(0x02, base + MIPHY_COMP_POSTP);
761 /* Enable GENSEL_SEL and SSC */
762 /* TX_SEL=0 swing preemp forced by pipe registres */
763 val = SSC_SEL | GENSEL_SEL;
764 writeb_relaxed(val, base + MIPHY_BOUNDARY_SEL);
766 /* MIPHY Bias boost */
767 writeb_relaxed(0x00, base + MIPHY_BIAS_BOOST_1);
768 writeb_relaxed(0xa7, base + MIPHY_BIAS_BOOST_2);
771 writeb_relaxed(SSC_EN_SW, base + MIPHY_BOUNDARY_2);
773 /* MIPHY TX control */
774 writeb_relaxed(0x00, base + MIPHY_CONF);
776 /* Validate Step component */
777 writeb_relaxed(0x5a, base + MIPHY_PLL_SBR_3);
778 writeb_relaxed(0xa0, base + MIPHY_PLL_SBR_4);
780 /* Validate Period component */
781 writeb_relaxed(0x3c, base + MIPHY_PLL_SBR_2);
782 writeb_relaxed(0xa1, base + MIPHY_PLL_SBR_4);
784 /* Clear any previous request */
785 writeb_relaxed(0x00, base + MIPHY_PLL_SBR_1);
787 /* requests the PLL to take in account new parameters */
788 writeb_relaxed(0x02, base + MIPHY_PLL_SBR_1);
790 /* To be sure there is no other pending requests */
791 writeb_relaxed(0x00, base + MIPHY_PLL_SBR_1);
793 /* Rx PI controller settings */
794 writeb_relaxed(0xca, base + MIPHY_RX_K_GAIN);
796 /* MIPHY RX input bridge control */
797 /* INPUT_BRIDGE_EN_SW=1, manual input bridge control[0]=1 */
798 writeb_relaxed(0x21, base + MIPHY_RX_POWER_CTRL_1);
799 writeb_relaxed(0x29, base + MIPHY_RX_POWER_CTRL_1);
800 writeb_relaxed(0x1a, base + MIPHY_RX_POWER_CTRL_2);
802 /* MIPHY Reset for usb3 */
803 miphy28_usb3_miphy_reset(miphy_phy);
806 static inline int miphy_is_ready(struct miphy28lp_phy *miphy_phy)
808 unsigned long finish = jiffies + 5 * HZ;
809 u8 mask = HFC_PLL | HFC_RDY;
813 * For PCIe and USB3 check only that PLL and HFC are ready
814 * For SATA check also that phy is ready!
816 if (miphy_phy->type == PHY_TYPE_SATA)
820 val = readb_relaxed(miphy_phy->base + MIPHY_STATUS_1);
821 if ((val & mask) != mask)
825 } while (!time_after_eq(jiffies, finish));
830 static int miphy_osc_is_ready(struct miphy28lp_phy *miphy_phy)
832 struct miphy28lp_dev *miphy_dev = miphy_phy->phydev;
833 unsigned long finish = jiffies + 5 * HZ;
836 if (!miphy_phy->osc_rdy)
839 if (!miphy_phy->syscfg_reg[SYSCFG_STATUS])
843 regmap_read(miphy_dev->regmap,
844 miphy_phy->syscfg_reg[SYSCFG_STATUS], &val);
846 if ((val & MIPHY_OSC_RDY) != MIPHY_OSC_RDY)
850 } while (!time_after_eq(jiffies, finish));
855 static int miphy28lp_get_resource_byname(struct device_node *child,
856 char *rname, struct resource *res)
860 index = of_property_match_string(child, "reg-names", rname);
864 return of_address_to_resource(child, index, res);
867 static int miphy28lp_get_one_addr(struct device *dev,
868 struct device_node *child, char *rname,
874 ret = miphy28lp_get_resource_byname(child, rname, &res);
876 *base = devm_ioremap(dev, res.start, resource_size(&res));
878 dev_err(dev, "failed to ioremap %s address region\n"
887 /* MiPHY reset and sysconf setup */
888 static int miphy28lp_setup(struct miphy28lp_phy *miphy_phy, u32 miphy_val)
891 struct miphy28lp_dev *miphy_dev = miphy_phy->phydev;
893 if (!miphy_phy->syscfg_reg[SYSCFG_CTRL])
896 err = reset_control_assert(miphy_phy->miphy_rst);
898 dev_err(miphy_dev->dev, "unable to bring out of miphy reset\n");
902 if (miphy_phy->osc_force_ext)
903 miphy_val |= MIPHY_OSC_FORCE_EXT;
905 regmap_update_bits(miphy_dev->regmap,
906 miphy_phy->syscfg_reg[SYSCFG_CTRL],
907 MIPHY_CTRL_MASK, miphy_val);
909 err = reset_control_deassert(miphy_phy->miphy_rst);
911 dev_err(miphy_dev->dev, "unable to bring out of miphy reset\n");
915 return miphy_osc_is_ready(miphy_phy);
918 static int miphy28lp_init_sata(struct miphy28lp_phy *miphy_phy)
920 struct miphy28lp_dev *miphy_dev = miphy_phy->phydev;
921 int err, sata_conf = SATA_CTRL_SELECT_SATA;
923 if ((!miphy_phy->syscfg_reg[SYSCFG_SATA]) ||
924 (!miphy_phy->syscfg_reg[SYSCFG_PCI]) ||
928 dev_info(miphy_dev->dev, "sata-up mode, addr 0x%p\n", miphy_phy->base);
930 /* Configure the glue-logic */
931 sata_conf |= ((miphy_phy->sata_gen - SATA_GEN1) << SATA_SPDMODE);
933 regmap_update_bits(miphy_dev->regmap,
934 miphy_phy->syscfg_reg[SYSCFG_SATA],
935 SATA_CTRL_MASK, sata_conf);
937 regmap_update_bits(miphy_dev->regmap, miphy_phy->syscfg_reg[SYSCFG_PCI],
938 PCIE_CTRL_MASK, SATA_CTRL_SELECT_PCIE);
940 /* MiPHY path and clocking init */
941 err = miphy28lp_setup(miphy_phy, MIPHY_CTRL_DEFAULT);
944 dev_err(miphy_dev->dev, "SATA phy setup failed\n");
948 /* initialize miphy */
949 miphy28lp_configure_sata(miphy_phy);
951 return miphy_is_ready(miphy_phy);
954 static int miphy28lp_init_pcie(struct miphy28lp_phy *miphy_phy)
956 struct miphy28lp_dev *miphy_dev = miphy_phy->phydev;
959 if ((!miphy_phy->syscfg_reg[SYSCFG_SATA]) ||
960 (!miphy_phy->syscfg_reg[SYSCFG_PCI])
961 || (!miphy_phy->base) || (!miphy_phy->pipebase))
964 dev_info(miphy_dev->dev, "pcie-up mode, addr 0x%p\n", miphy_phy->base);
966 /* Configure the glue-logic */
967 regmap_update_bits(miphy_dev->regmap,
968 miphy_phy->syscfg_reg[SYSCFG_SATA],
969 SATA_CTRL_MASK, SATA_CTRL_SELECT_PCIE);
971 regmap_update_bits(miphy_dev->regmap, miphy_phy->syscfg_reg[SYSCFG_PCI],
972 PCIE_CTRL_MASK, SYSCFG_PCIE_PCIE_VAL);
974 /* MiPHY path and clocking init */
975 err = miphy28lp_setup(miphy_phy, MIPHY_CTRL_DEFAULT);
978 dev_err(miphy_dev->dev, "PCIe phy setup failed\n");
982 /* initialize miphy */
983 err = miphy28lp_configure_pcie(miphy_phy);
987 /* PIPE Wrapper Configuration */
988 writeb_relaxed(0x68, miphy_phy->pipebase + 0x104); /* Rise_0 */
989 writeb_relaxed(0x61, miphy_phy->pipebase + 0x105); /* Rise_1 */
990 writeb_relaxed(0x68, miphy_phy->pipebase + 0x108); /* Fall_0 */
991 writeb_relaxed(0x61, miphy_phy->pipebase + 0x109); /* Fall-1 */
992 writeb_relaxed(0x68, miphy_phy->pipebase + 0x10c); /* Threshold_0 */
993 writeb_relaxed(0x60, miphy_phy->pipebase + 0x10d); /* Threshold_1 */
995 /* Wait for phy_ready */
996 return miphy_is_ready(miphy_phy);
999 static int miphy28lp_init_usb3(struct miphy28lp_phy *miphy_phy)
1001 struct miphy28lp_dev *miphy_dev = miphy_phy->phydev;
1004 if ((!miphy_phy->base) || (!miphy_phy->pipebase))
1007 dev_info(miphy_dev->dev, "usb3-up mode, addr 0x%p\n", miphy_phy->base);
1009 /* MiPHY path and clocking init */
1010 err = miphy28lp_setup(miphy_phy, MIPHY_CTRL_SYNC_D_EN);
1012 dev_err(miphy_dev->dev, "USB3 phy setup failed\n");
1016 /* initialize miphy */
1017 miphy28lp_configure_usb3(miphy_phy);
1019 /* PIPE Wrapper Configuration */
1020 writeb_relaxed(0x68, miphy_phy->pipebase + 0x23);
1021 writeb_relaxed(0x61, miphy_phy->pipebase + 0x24);
1022 writeb_relaxed(0x68, miphy_phy->pipebase + 0x26);
1023 writeb_relaxed(0x61, miphy_phy->pipebase + 0x27);
1024 writeb_relaxed(0x18, miphy_phy->pipebase + 0x29);
1025 writeb_relaxed(0x61, miphy_phy->pipebase + 0x2a);
1027 /* pipe Wrapper usb3 TX swing de-emph margin PREEMPH[7:4], SWING[3:0] */
1028 writeb_relaxed(0X67, miphy_phy->pipebase + 0x68);
1029 writeb_relaxed(0x0d, miphy_phy->pipebase + 0x69);
1030 writeb_relaxed(0X67, miphy_phy->pipebase + 0x6a);
1031 writeb_relaxed(0X0d, miphy_phy->pipebase + 0x6b);
1032 writeb_relaxed(0X67, miphy_phy->pipebase + 0x6c);
1033 writeb_relaxed(0X0d, miphy_phy->pipebase + 0x6d);
1034 writeb_relaxed(0X67, miphy_phy->pipebase + 0x6e);
1035 writeb_relaxed(0X0d, miphy_phy->pipebase + 0x6f);
1037 return miphy_is_ready(miphy_phy);
1040 static int miphy28lp_init(struct phy *phy)
1042 struct miphy28lp_phy *miphy_phy = phy_get_drvdata(phy);
1043 struct miphy28lp_dev *miphy_dev = miphy_phy->phydev;
1046 mutex_lock(&miphy_dev->miphy_mutex);
1048 switch (miphy_phy->type) {
1051 ret = miphy28lp_init_sata(miphy_phy);
1054 ret = miphy28lp_init_pcie(miphy_phy);
1057 ret = miphy28lp_init_usb3(miphy_phy);
1064 mutex_unlock(&miphy_dev->miphy_mutex);
1069 static int miphy28lp_get_addr(struct miphy28lp_phy *miphy_phy)
1071 struct miphy28lp_dev *miphy_dev = miphy_phy->phydev;
1072 struct device_node *phynode = miphy_phy->phy->dev.of_node;
1075 if ((miphy_phy->type != PHY_TYPE_SATA) &&
1076 (miphy_phy->type != PHY_TYPE_PCIE) &&
1077 (miphy_phy->type != PHY_TYPE_USB3)) {
1081 err = miphy28lp_get_one_addr(miphy_dev->dev, phynode,
1082 PHY_TYPE_name[miphy_phy->type - PHY_TYPE_SATA],
1087 if ((miphy_phy->type == PHY_TYPE_PCIE) ||
1088 (miphy_phy->type == PHY_TYPE_USB3)) {
1089 err = miphy28lp_get_one_addr(miphy_dev->dev, phynode, "pipew",
1090 &miphy_phy->pipebase);
1098 static struct phy *miphy28lp_xlate(struct device *dev,
1099 struct of_phandle_args *args)
1101 struct miphy28lp_dev *miphy_dev = dev_get_drvdata(dev);
1102 struct miphy28lp_phy *miphy_phy = NULL;
1103 struct device_node *phynode = args->np;
1106 if (args->args_count != 1) {
1107 dev_err(dev, "Invalid number of cells in 'phy' property\n");
1108 return ERR_PTR(-EINVAL);
1111 for (index = 0; index < miphy_dev->nphys; index++)
1112 if (phynode == miphy_dev->phys[index]->phy->dev.of_node) {
1113 miphy_phy = miphy_dev->phys[index];
1118 dev_err(dev, "Failed to find appropriate phy\n");
1119 return ERR_PTR(-EINVAL);
1122 miphy_phy->type = args->args[0];
1124 ret = miphy28lp_get_addr(miphy_phy);
1126 return ERR_PTR(ret);
1128 return miphy_phy->phy;
1131 static const struct phy_ops miphy28lp_ops = {
1132 .init = miphy28lp_init,
1133 .owner = THIS_MODULE,
1136 static int miphy28lp_probe_resets(struct device_node *node,
1137 struct miphy28lp_phy *miphy_phy)
1139 struct miphy28lp_dev *miphy_dev = miphy_phy->phydev;
1142 miphy_phy->miphy_rst =
1143 of_reset_control_get_shared(node, "miphy-sw-rst");
1145 if (IS_ERR(miphy_phy->miphy_rst)) {
1146 dev_err(miphy_dev->dev,
1147 "miphy soft reset control not defined\n");
1148 return PTR_ERR(miphy_phy->miphy_rst);
1151 err = reset_control_deassert(miphy_phy->miphy_rst);
1153 dev_err(miphy_dev->dev, "unable to bring out of miphy reset\n");
1160 static int miphy28lp_of_probe(struct device_node *np,
1161 struct miphy28lp_phy *miphy_phy)
1166 miphy_phy->osc_force_ext =
1167 of_property_read_bool(np, "st,osc-force-ext");
1169 miphy_phy->osc_rdy = of_property_read_bool(np, "st,osc-rdy");
1171 miphy_phy->px_rx_pol_inv =
1172 of_property_read_bool(np, "st,px_rx_pol_inv");
1174 miphy_phy->ssc = of_property_read_bool(np, "st,ssc-on");
1176 miphy_phy->tx_impedance =
1177 of_property_read_bool(np, "st,tx-impedance-comp");
1179 of_property_read_u32(np, "st,sata-gen", &miphy_phy->sata_gen);
1180 if (!miphy_phy->sata_gen)
1181 miphy_phy->sata_gen = SATA_GEN1;
1183 for (i = 0; i < SYSCFG_REG_MAX; i++) {
1184 if (!of_property_read_u32_index(np, "st,syscfg", i, &ctrlreg))
1185 miphy_phy->syscfg_reg[i] = ctrlreg;
1191 static int miphy28lp_probe(struct platform_device *pdev)
1193 struct device_node *child, *np = pdev->dev.of_node;
1194 struct miphy28lp_dev *miphy_dev;
1195 struct phy_provider *provider;
1199 miphy_dev = devm_kzalloc(&pdev->dev, sizeof(*miphy_dev), GFP_KERNEL);
1203 miphy_dev->nphys = of_get_child_count(np);
1204 miphy_dev->phys = devm_kcalloc(&pdev->dev, miphy_dev->nphys,
1205 sizeof(*miphy_dev->phys), GFP_KERNEL);
1206 if (!miphy_dev->phys)
1209 miphy_dev->regmap = syscon_regmap_lookup_by_phandle(np, "st,syscfg");
1210 if (IS_ERR(miphy_dev->regmap)) {
1211 dev_err(miphy_dev->dev, "No syscfg phandle specified\n");
1212 return PTR_ERR(miphy_dev->regmap);
1215 miphy_dev->dev = &pdev->dev;
1217 dev_set_drvdata(&pdev->dev, miphy_dev);
1219 mutex_init(&miphy_dev->miphy_mutex);
1221 for_each_child_of_node(np, child) {
1222 struct miphy28lp_phy *miphy_phy;
1224 miphy_phy = devm_kzalloc(&pdev->dev, sizeof(*miphy_phy),
1231 miphy_dev->phys[port] = miphy_phy;
1233 phy = devm_phy_create(&pdev->dev, child, &miphy28lp_ops);
1235 dev_err(&pdev->dev, "failed to create PHY\n");
1240 miphy_dev->phys[port]->phy = phy;
1241 miphy_dev->phys[port]->phydev = miphy_dev;
1243 ret = miphy28lp_of_probe(child, miphy_phy);
1247 ret = miphy28lp_probe_resets(child, miphy_dev->phys[port]);
1251 phy_set_drvdata(phy, miphy_dev->phys[port]);
1256 provider = devm_of_phy_provider_register(&pdev->dev, miphy28lp_xlate);
1257 return PTR_ERR_OR_ZERO(provider);
1263 static const struct of_device_id miphy28lp_of_match[] = {
1264 {.compatible = "st,miphy28lp-phy", },
1268 MODULE_DEVICE_TABLE(of, miphy28lp_of_match);
1270 static struct platform_driver miphy28lp_driver = {
1271 .probe = miphy28lp_probe,
1273 .name = "miphy28lp-phy",
1274 .of_match_table = miphy28lp_of_match,
1278 module_platform_driver(miphy28lp_driver);
1280 MODULE_AUTHOR("Alexandre Torgue <alexandre.torgue@st.com>");
1281 MODULE_DESCRIPTION("STMicroelectronics miphy28lp driver");
1282 MODULE_LICENSE("GPL v2");