2 * Copyright (C) 2014 STMicroelectronics – All Rights Reserved
4 * STMicroelectronics PHY driver MiPHY365 (for SoC STiH416).
6 * Authors: Alexandre Torgue <alexandre.torgue@st.com>
7 * Lee Jones <lee.jones@linaro.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2, as
11 * published by the Free Software Foundation.
15 #include <linux/platform_device.h>
17 #include <linux/kernel.h>
18 #include <linux/module.h>
20 #include <linux/of_platform.h>
21 #include <linux/of_address.h>
22 #include <linux/clk.h>
23 #include <linux/phy/phy.h>
24 #include <linux/delay.h>
25 #include <linux/mfd/syscon.h>
26 #include <linux/regmap.h>
28 #include <dt-bindings/phy/phy-miphy365x.h>
30 #define HFC_TIMEOUT 100
32 #define SYSCFG_SELECT_SATA_MASK BIT(1)
33 #define SYSCFG_SELECT_SATA_POS 1
35 /* MiPHY365x register definitions */
36 #define RESET_REG 0x00
37 #define RST_PLL BIT(1)
38 #define RST_PLL_CAL BIT(2)
40 #define RST_MACRO BIT(7)
42 #define STATUS_REG 0x01
43 #define IDLL_RDY BIT(0)
44 #define PLL_RDY BIT(1)
45 #define DES_BIT_LOCK BIT(2)
46 #define DES_SYMBOL_LOCK BIT(3)
49 #define TERM_EN BIT(0)
51 #define DES_BIT_LOCK_EN BIT(3)
54 #define INT_CTRL_REG 0x03
56 #define BOUNDARY1_REG 0x10
57 #define SPDSEL_SEL BIT(0)
59 #define BOUNDARY3_REG 0x12
60 #define TX_SPDSEL_GEN1_VAL 0
61 #define TX_SPDSEL_GEN2_VAL 0x01
62 #define TX_SPDSEL_GEN3_VAL 0x02
63 #define RX_SPDSEL_GEN1_VAL 0
64 #define RX_SPDSEL_GEN2_VAL (0x01 << 3)
65 #define RX_SPDSEL_GEN3_VAL (0x02 << 3)
69 #define BUF_SEL_REG 0x20
70 #define CONF_GEN_SEL_GEN3 0x02
71 #define CONF_GEN_SEL_GEN2 0x01
72 #define PD_VDDTFILTER BIT(4)
74 #define TXBUF1_REG 0x21
75 #define SWING_VAL 0x04
76 #define SWING_VAL_GEN1 0x03
77 #define PREEMPH_VAL (0x3 << 5)
79 #define TXBUF2_REG 0x22
80 #define TXSLEW_VAL 0x2
81 #define TXSLEW_VAL_GEN1 0x4
83 #define RXBUF_OFFSET_CTRL_REG 0x23
85 #define RXBUF_REG 0x25
86 #define SDTHRES_VAL 0x01
87 #define EQ_ON3 (0x03 << 4)
88 #define EQ_ON1 (0x01 << 4)
90 #define COMP_CTRL1_REG 0x40
91 #define START_COMSR BIT(0)
92 #define START_COMZC BIT(1)
93 #define COMSR_DONE BIT(2)
94 #define COMZC_DONE BIT(3)
95 #define COMP_AUTO_LOAD BIT(4)
97 #define COMP_CTRL2_REG 0x41
98 #define COMP_2MHZ_RAT_GEN1 0x1e
99 #define COMP_2MHZ_RAT 0xf
101 #define COMP_CTRL3_REG 0x42
102 #define COMSR_COMP_REF 0x33
104 #define COMP_IDLL_REG 0x47
105 #define COMZC_IDLL 0x2a
107 #define PLL_CTRL1_REG 0x50
108 #define PLL_START_CAL BIT(0)
109 #define BUF_EN BIT(2)
110 #define SYNCHRO_TX BIT(3)
111 #define SSC_EN BIT(6)
112 #define CONFIG_PLL BIT(7)
114 #define PLL_CTRL2_REG 0x51
115 #define BYPASS_PLL_CAL BIT(1)
117 #define PLL_RAT_REG 0x52
119 #define PLL_SSC_STEP_MSB_REG 0x56
120 #define PLL_SSC_STEP_MSB_VAL 0x03
122 #define PLL_SSC_STEP_LSB_REG 0x57
123 #define PLL_SSC_STEP_LSB_VAL 0x63
125 #define PLL_SSC_PER_MSB_REG 0x58
126 #define PLL_SSC_PER_MSB_VAL 0
128 #define PLL_SSC_PER_LSB_REG 0x59
129 #define PLL_SSC_PER_LSB_VAL 0xf1
131 #define IDLL_TEST_REG 0x72
132 #define START_CLK_HF BIT(6)
134 #define DES_BITLOCK_REG 0x86
135 #define BIT_LOCK_LEVEL 0x01
136 #define BIT_LOCK_CNT_512 (0x03 << 5)
138 struct miphy365x_phy
{
141 bool pcie_tx_pol_inv
;
142 bool sata_tx_pol_inv
;
148 struct miphy365x_dev
{
150 struct regmap
*regmap
;
151 struct mutex miphy_mutex
;
152 struct miphy365x_phy
**phys
;
156 * These values are represented in Device tree. They are considered to be ABI
157 * and although they can be extended any existing values must not change.
159 enum miphy_sata_gen
{
165 static u8 rx_tx_spd
[] = {
166 TX_SPDSEL_GEN1_VAL
| RX_SPDSEL_GEN1_VAL
,
167 TX_SPDSEL_GEN2_VAL
| RX_SPDSEL_GEN2_VAL
,
168 TX_SPDSEL_GEN3_VAL
| RX_SPDSEL_GEN3_VAL
172 * This function selects the system configuration,
173 * either two SATA, one SATA and one PCIe, or two PCIe lanes.
175 static int miphy365x_set_path(struct miphy365x_phy
*miphy_phy
,
176 struct miphy365x_dev
*miphy_dev
)
178 bool sata
= (miphy_phy
->type
== MIPHY_TYPE_SATA
);
180 return regmap_update_bits(miphy_dev
->regmap
,
181 (unsigned int)miphy_phy
->ctrlreg
,
182 SYSCFG_SELECT_SATA_MASK
,
183 sata
<< SYSCFG_SELECT_SATA_POS
);
186 static int miphy365x_init_pcie_port(struct miphy365x_phy
*miphy_phy
,
187 struct miphy365x_dev
*miphy_dev
)
191 if (miphy_phy
->pcie_tx_pol_inv
) {
192 /* Invert Tx polarity and clear pci_txdetect_pol bit */
193 val
= TERM_EN
| PCI_EN
| DES_BIT_LOCK_EN
| TX_POL
;
194 writeb_relaxed(val
, miphy_phy
->base
+ CTRL_REG
);
195 writeb_relaxed(0x00, miphy_phy
->base
+ PCIE_REG
);
201 static inline int miphy365x_hfc_not_rdy(struct miphy365x_phy
*miphy_phy
,
202 struct miphy365x_dev
*miphy_dev
)
204 unsigned long timeout
= jiffies
+ msecs_to_jiffies(HFC_TIMEOUT
);
205 u8 mask
= IDLL_RDY
| PLL_RDY
;
209 regval
= readb_relaxed(miphy_phy
->base
+ STATUS_REG
);
210 if (!(regval
& mask
))
213 usleep_range(2000, 2500);
214 } while (time_before(jiffies
, timeout
));
216 dev_err(miphy_dev
->dev
, "HFC ready timeout!\n");
220 static inline int miphy365x_rdy(struct miphy365x_phy
*miphy_phy
,
221 struct miphy365x_dev
*miphy_dev
)
223 unsigned long timeout
= jiffies
+ msecs_to_jiffies(HFC_TIMEOUT
);
224 u8 mask
= IDLL_RDY
| PLL_RDY
;
228 regval
= readb_relaxed(miphy_phy
->base
+ STATUS_REG
);
229 if ((regval
& mask
) == mask
)
232 usleep_range(2000, 2500);
233 } while (time_before(jiffies
, timeout
));
235 dev_err(miphy_dev
->dev
, "PHY not ready timeout!\n");
239 static inline void miphy365x_set_comp(struct miphy365x_phy
*miphy_phy
,
240 struct miphy365x_dev
*miphy_dev
)
244 if (miphy_phy
->sata_gen
== SATA_GEN1
)
245 writeb_relaxed(COMP_2MHZ_RAT_GEN1
,
246 miphy_phy
->base
+ COMP_CTRL2_REG
);
248 writeb_relaxed(COMP_2MHZ_RAT
,
249 miphy_phy
->base
+ COMP_CTRL2_REG
);
251 if (miphy_phy
->sata_gen
!= SATA_GEN3
) {
252 writeb_relaxed(COMSR_COMP_REF
,
253 miphy_phy
->base
+ COMP_CTRL3_REG
);
255 * Force VCO current to value defined by address 0x5A
256 * and disable PCIe100Mref bit
257 * Enable auto load compensation for pll_i_bias
259 writeb_relaxed(BYPASS_PLL_CAL
, miphy_phy
->base
+ PLL_CTRL2_REG
);
260 writeb_relaxed(COMZC_IDLL
, miphy_phy
->base
+ COMP_IDLL_REG
);
264 * Force restart compensation and enable auto load
265 * for Comzc_Tx, Comzc_Rx and Comsr on macro
267 val
= START_COMSR
| START_COMZC
| COMP_AUTO_LOAD
;
268 writeb_relaxed(val
, miphy_phy
->base
+ COMP_CTRL1_REG
);
270 mask
= COMSR_DONE
| COMZC_DONE
;
271 while ((readb_relaxed(miphy_phy
->base
+ COMP_CTRL1_REG
) & mask
) != mask
)
275 static inline void miphy365x_set_ssc(struct miphy365x_phy
*miphy_phy
,
276 struct miphy365x_dev
*miphy_dev
)
281 * SSC Settings. SSC will be enabled through Link
285 writeb_relaxed(PLL_SSC_STEP_MSB_VAL
,
286 miphy_phy
->base
+ PLL_SSC_STEP_MSB_REG
);
287 writeb_relaxed(PLL_SSC_STEP_LSB_VAL
,
288 miphy_phy
->base
+ PLL_SSC_STEP_LSB_REG
);
289 writeb_relaxed(PLL_SSC_PER_MSB_VAL
,
290 miphy_phy
->base
+ PLL_SSC_PER_MSB_REG
);
291 writeb_relaxed(PLL_SSC_PER_LSB_VAL
,
292 miphy_phy
->base
+ PLL_SSC_PER_LSB_REG
);
294 /* SSC Settings complete */
295 if (miphy_phy
->sata_gen
== SATA_GEN1
) {
296 val
= PLL_START_CAL
| BUF_EN
| SYNCHRO_TX
| CONFIG_PLL
;
297 writeb_relaxed(val
, miphy_phy
->base
+ PLL_CTRL1_REG
);
299 val
= SSC_EN
| PLL_START_CAL
| BUF_EN
| SYNCHRO_TX
| CONFIG_PLL
;
300 writeb_relaxed(val
, miphy_phy
->base
+ PLL_CTRL1_REG
);
304 static int miphy365x_init_sata_port(struct miphy365x_phy
*miphy_phy
,
305 struct miphy365x_dev
*miphy_dev
)
311 * Force PHY macro reset, PLL calibration reset, PLL reset
312 * and assert Deserializer Reset
314 val
= RST_PLL
| RST_PLL_CAL
| RST_RX
| RST_MACRO
;
315 writeb_relaxed(val
, miphy_phy
->base
+ RESET_REG
);
317 if (miphy_phy
->sata_tx_pol_inv
)
318 writeb_relaxed(TX_POL
, miphy_phy
->base
+ CTRL_REG
);
321 * Force macro1 to use rx_lspd, tx_lspd
322 * Force Rx_Clock on first I-DLL phase
323 * Force Des in HP mode on macro, rx_lspd, tx_lspd for Gen2/3
325 writeb_relaxed(SPDSEL_SEL
, miphy_phy
->base
+ BOUNDARY1_REG
);
326 writeb_relaxed(START_CLK_HF
, miphy_phy
->base
+ IDLL_TEST_REG
);
327 val
= rx_tx_spd
[miphy_phy
->sata_gen
];
328 writeb_relaxed(val
, miphy_phy
->base
+ BOUNDARY3_REG
);
330 /* Wait for HFC_READY = 0 */
331 ret
= miphy365x_hfc_not_rdy(miphy_phy
, miphy_dev
);
335 /* Compensation Recalibration */
336 miphy365x_set_comp(miphy_phy
, miphy_dev
);
338 switch (miphy_phy
->sata_gen
) {
341 * TX Swing target 550-600mv peak to peak diff
342 * Tx Slew target 90-110ps rising/falling time
343 * Rx Eq ON3, Sigdet threshold SDTH1
345 val
= PD_VDDTFILTER
| CONF_GEN_SEL_GEN3
;
346 writeb_relaxed(val
, miphy_phy
->base
+ BUF_SEL_REG
);
347 val
= SWING_VAL
| PREEMPH_VAL
;
348 writeb_relaxed(val
, miphy_phy
->base
+ TXBUF1_REG
);
349 writeb_relaxed(TXSLEW_VAL
, miphy_phy
->base
+ TXBUF2_REG
);
350 writeb_relaxed(0x00, miphy_phy
->base
+ RXBUF_OFFSET_CTRL_REG
);
351 val
= SDTHRES_VAL
| EQ_ON3
;
352 writeb_relaxed(val
, miphy_phy
->base
+ RXBUF_REG
);
356 * conf gen sel=0x1 to program Gen2 banked registers
358 * Tx Swing target 550-600mV peak-to-peak diff
359 * Tx Slew target 90-110 ps rising/falling time
360 * RX Equalization ON1, Sigdet threshold SDTH1
362 writeb_relaxed(CONF_GEN_SEL_GEN2
,
363 miphy_phy
->base
+ BUF_SEL_REG
);
364 writeb_relaxed(SWING_VAL
, miphy_phy
->base
+ TXBUF1_REG
);
365 writeb_relaxed(TXSLEW_VAL
, miphy_phy
->base
+ TXBUF2_REG
);
366 val
= SDTHRES_VAL
| EQ_ON1
;
367 writeb_relaxed(val
, miphy_phy
->base
+ RXBUF_REG
);
371 * conf gen sel = 00b to program Gen1 banked registers
373 * Tx Swing target 500-550mV peak-to-peak diff
374 * Tx Slew target120-140 ps rising/falling time
376 writeb_relaxed(PD_VDDTFILTER
, miphy_phy
->base
+ BUF_SEL_REG
);
377 writeb_relaxed(SWING_VAL_GEN1
, miphy_phy
->base
+ TXBUF1_REG
);
378 writeb_relaxed(TXSLEW_VAL_GEN1
, miphy_phy
->base
+ TXBUF2_REG
);
384 /* Force Macro1 in partial mode & release pll cal reset */
385 writeb_relaxed(RST_RX
, miphy_phy
->base
+ RESET_REG
);
386 usleep_range(100, 150);
388 miphy365x_set_ssc(miphy_phy
, miphy_dev
);
390 /* Wait for phy_ready */
391 ret
= miphy365x_rdy(miphy_phy
, miphy_dev
);
396 * Enable macro1 to use rx_lspd & tx_lspd
397 * Release Rx_Clock on first I-DLL phase on macro1
398 * Assert deserializer reset
399 * des_bit_lock_en is set
400 * bit lock detection strength
401 * Deassert deserializer reset
403 writeb_relaxed(0x00, miphy_phy
->base
+ BOUNDARY1_REG
);
404 writeb_relaxed(0x00, miphy_phy
->base
+ IDLL_TEST_REG
);
405 writeb_relaxed(RST_RX
, miphy_phy
->base
+ RESET_REG
);
406 val
= miphy_phy
->sata_tx_pol_inv
?
407 (TX_POL
| DES_BIT_LOCK_EN
) : DES_BIT_LOCK_EN
;
408 writeb_relaxed(val
, miphy_phy
->base
+ CTRL_REG
);
410 val
= BIT_LOCK_CNT_512
| BIT_LOCK_LEVEL
;
411 writeb_relaxed(val
, miphy_phy
->base
+ DES_BITLOCK_REG
);
412 writeb_relaxed(0x00, miphy_phy
->base
+ RESET_REG
);
417 static int miphy365x_init(struct phy
*phy
)
419 struct miphy365x_phy
*miphy_phy
= phy_get_drvdata(phy
);
420 struct miphy365x_dev
*miphy_dev
= dev_get_drvdata(phy
->dev
.parent
);
423 mutex_lock(&miphy_dev
->miphy_mutex
);
425 ret
= miphy365x_set_path(miphy_phy
, miphy_dev
);
427 mutex_unlock(&miphy_dev
->miphy_mutex
);
431 /* Initialise Miphy for PCIe or SATA */
432 if (miphy_phy
->type
== MIPHY_TYPE_PCIE
)
433 ret
= miphy365x_init_pcie_port(miphy_phy
, miphy_dev
);
435 ret
= miphy365x_init_sata_port(miphy_phy
, miphy_dev
);
437 mutex_unlock(&miphy_dev
->miphy_mutex
);
442 int miphy365x_get_addr(struct device
*dev
, struct miphy365x_phy
*miphy_phy
,
445 struct device_node
*phynode
= miphy_phy
->phy
->dev
.of_node
;
448 int type
= miphy_phy
->type
;
451 ret
= of_property_read_string_index(phynode
, "reg-names", index
, &name
);
453 dev_err(dev
, "no reg-names property not found\n");
457 if (!strncmp(name
, "syscfg", 6)) {
458 taddr
= of_get_address(phynode
, index
, NULL
, NULL
);
460 dev_err(dev
, "failed to fetch syscfg address\n");
464 miphy_phy
->ctrlreg
= of_translate_address(phynode
, taddr
);
465 if (miphy_phy
->ctrlreg
== OF_BAD_ADDR
) {
466 dev_err(dev
, "failed to translate syscfg address\n");
473 if (!((!strncmp(name
, "sata", 4) && type
== MIPHY_TYPE_SATA
) ||
474 (!strncmp(name
, "pcie", 4) && type
== MIPHY_TYPE_PCIE
)))
477 miphy_phy
->base
= of_iomap(phynode
, index
);
478 if (!miphy_phy
->base
) {
479 dev_err(dev
, "Failed to map %s\n", phynode
->full_name
);
486 static struct phy
*miphy365x_xlate(struct device
*dev
,
487 struct of_phandle_args
*args
)
489 struct miphy365x_dev
*miphy_dev
= dev_get_drvdata(dev
);
490 struct miphy365x_phy
*miphy_phy
= NULL
;
491 struct device_node
*phynode
= args
->np
;
494 if (!of_device_is_available(phynode
)) {
495 dev_warn(dev
, "Requested PHY is disabled\n");
496 return ERR_PTR(-ENODEV
);
499 if (args
->args_count
!= 1) {
500 dev_err(dev
, "Invalid number of cells in 'phy' property\n");
501 return ERR_PTR(-EINVAL
);
504 for (index
= 0; index
< of_get_child_count(dev
->of_node
); index
++)
505 if (phynode
== miphy_dev
->phys
[index
]->phy
->dev
.of_node
) {
506 miphy_phy
= miphy_dev
->phys
[index
];
511 dev_err(dev
, "Failed to find appropriate phy\n");
512 return ERR_PTR(-EINVAL
);
515 miphy_phy
->type
= args
->args
[0];
517 if (!(miphy_phy
->type
== MIPHY_TYPE_SATA
||
518 miphy_phy
->type
== MIPHY_TYPE_PCIE
)) {
519 dev_err(dev
, "Unsupported device type: %d\n", miphy_phy
->type
);
520 return ERR_PTR(-EINVAL
);
523 /* Each port handles SATA and PCIE - third entry is always sysconf. */
524 for (index
= 0; index
< 3; index
++) {
525 ret
= miphy365x_get_addr(dev
, miphy_phy
, index
);
530 return miphy_phy
->phy
;
533 static struct phy_ops miphy365x_ops
= {
534 .init
= miphy365x_init
,
535 .owner
= THIS_MODULE
,
538 static int miphy365x_of_probe(struct device_node
*phynode
,
539 struct miphy365x_phy
*miphy_phy
)
541 of_property_read_u32(phynode
, "st,sata-gen", &miphy_phy
->sata_gen
);
542 if (!miphy_phy
->sata_gen
)
543 miphy_phy
->sata_gen
= SATA_GEN1
;
545 miphy_phy
->pcie_tx_pol_inv
=
546 of_property_read_bool(phynode
, "st,pcie-tx-pol-inv");
548 miphy_phy
->sata_tx_pol_inv
=
549 of_property_read_bool(phynode
, "st,sata-tx-pol-inv");
554 static int miphy365x_probe(struct platform_device
*pdev
)
556 struct device_node
*child
, *np
= pdev
->dev
.of_node
;
557 struct miphy365x_dev
*miphy_dev
;
558 struct phy_provider
*provider
;
560 int chancount
, port
= 0;
563 miphy_dev
= devm_kzalloc(&pdev
->dev
, sizeof(*miphy_dev
), GFP_KERNEL
);
567 chancount
= of_get_child_count(np
);
568 miphy_dev
->phys
= devm_kzalloc(&pdev
->dev
, sizeof(phy
) * chancount
,
570 if (!miphy_dev
->phys
)
573 miphy_dev
->regmap
= syscon_regmap_lookup_by_phandle(np
, "st,syscfg");
574 if (IS_ERR(miphy_dev
->regmap
)) {
575 dev_err(miphy_dev
->dev
, "No syscfg phandle specified\n");
576 return PTR_ERR(miphy_dev
->regmap
);
579 miphy_dev
->dev
= &pdev
->dev
;
581 dev_set_drvdata(&pdev
->dev
, miphy_dev
);
583 mutex_init(&miphy_dev
->miphy_mutex
);
585 for_each_child_of_node(np
, child
) {
586 struct miphy365x_phy
*miphy_phy
;
588 miphy_phy
= devm_kzalloc(&pdev
->dev
, sizeof(*miphy_phy
),
593 miphy_dev
->phys
[port
] = miphy_phy
;
595 phy
= devm_phy_create(&pdev
->dev
, child
, &miphy365x_ops
, NULL
);
597 dev_err(&pdev
->dev
, "failed to create PHY\n");
601 miphy_dev
->phys
[port
]->phy
= phy
;
603 ret
= miphy365x_of_probe(child
, miphy_phy
);
607 phy_set_drvdata(phy
, miphy_dev
->phys
[port
]);
611 provider
= devm_of_phy_provider_register(&pdev
->dev
, miphy365x_xlate
);
612 if (IS_ERR(provider
))
613 return PTR_ERR(provider
);
618 static const struct of_device_id miphy365x_of_match
[] = {
619 { .compatible
= "st,miphy365x-phy", },
622 MODULE_DEVICE_TABLE(of
, miphy365x_of_match
);
624 static struct platform_driver miphy365x_driver
= {
625 .probe
= miphy365x_probe
,
627 .name
= "miphy365x-phy",
628 .owner
= THIS_MODULE
,
629 .of_match_table
= miphy365x_of_match
,
632 module_platform_driver(miphy365x_driver
);
634 MODULE_AUTHOR("Alexandre Torgue <alexandre.torgue@st.com>");
635 MODULE_DESCRIPTION("STMicroelectronics miphy365x driver");
636 MODULE_LICENSE("GPL v2");