2 * phy-ti-pipe3 - PIPE3 PHY driver.
4 * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * Author: Kishon Vijay Abraham I <kishon@ti.com>
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
19 #include <linux/module.h>
20 #include <linux/platform_device.h>
21 #include <linux/slab.h>
22 #include <linux/phy/phy.h>
24 #include <linux/clk.h>
25 #include <linux/err.h>
27 #include <linux/pm_runtime.h>
28 #include <linux/delay.h>
29 #include <linux/phy/omap_control_phy.h>
30 #include <linux/of_platform.h>
31 #include <linux/mfd/syscon.h>
32 #include <linux/regmap.h>
34 #define PLL_STATUS 0x00000004
35 #define PLL_GO 0x00000008
36 #define PLL_CONFIGURATION1 0x0000000C
37 #define PLL_CONFIGURATION2 0x00000010
38 #define PLL_CONFIGURATION3 0x00000014
39 #define PLL_CONFIGURATION4 0x00000020
41 #define PLL_REGM_MASK 0x001FFE00
42 #define PLL_REGM_SHIFT 0x9
43 #define PLL_REGM_F_MASK 0x0003FFFF
44 #define PLL_REGM_F_SHIFT 0x0
45 #define PLL_REGN_MASK 0x000001FE
46 #define PLL_REGN_SHIFT 0x1
47 #define PLL_SELFREQDCO_MASK 0x0000000E
48 #define PLL_SELFREQDCO_SHIFT 0x1
49 #define PLL_SD_MASK 0x0003FC00
50 #define PLL_SD_SHIFT 10
51 #define SET_PLL_GO 0x1
52 #define PLL_LDOPWDN BIT(15)
53 #define PLL_TICOPWDN BIT(16)
57 #define SATA_PLL_SOFT_RESET BIT(18)
59 #define PIPE3_PHY_PWRCTL_CLK_CMD_MASK 0x003FC000
60 #define PIPE3_PHY_PWRCTL_CLK_CMD_SHIFT 14
62 #define PIPE3_PHY_PWRCTL_CLK_FREQ_MASK 0xFFC00000
63 #define PIPE3_PHY_PWRCTL_CLK_FREQ_SHIFT 22
65 #define PIPE3_PHY_TX_RX_POWERON 0x3
66 #define PIPE3_PHY_TX_RX_POWEROFF 0x0
68 #define PCIE_PCS_MASK 0xFF0000
69 #define PCIE_PCS_DELAY_COUNT_SHIFT 0x10
72 * This is an Empirical value that works, need to confirm the actual
73 * value required for the PIPE3PHY_PLL_CONFIGURATION2.PLL_IDLE status
74 * to be correctly reflected in the PIPE3PHY_PLL_STATUS register.
76 #define PLL_IDLE_TIME 100 /* in milliseconds */
77 #define PLL_LOCK_TIME 100 /* in milliseconds */
79 struct pipe3_dpll_params
{
87 struct pipe3_dpll_map
{
89 struct pipe3_dpll_params params
;
93 void __iomem
*pll_ctrl_base
;
95 struct device
*control_dev
;
100 struct pipe3_dpll_map
*dpll_map
;
101 struct regmap
*phy_power_syscon
; /* ctrl. reg. acces */
102 struct regmap
*pcs_syscon
; /* ctrl. reg. acces */
103 struct regmap
*dpll_reset_syscon
; /* ctrl. reg. acces */
104 unsigned int dpll_reset_reg
; /* reg. index within syscon */
105 unsigned int power_reg
; /* power reg. index within syscon */
106 unsigned int pcie_pcs_reg
; /* pcs reg. index in syscon */
107 bool sata_refclk_enabled
;
110 static struct pipe3_dpll_map dpll_map_usb
[] = {
111 {12000000, {1250, 5, 4, 20, 0} }, /* 12 MHz */
112 {16800000, {3125, 20, 4, 20, 0} }, /* 16.8 MHz */
113 {19200000, {1172, 8, 4, 20, 65537} }, /* 19.2 MHz */
114 {20000000, {1000, 7, 4, 10, 0} }, /* 20 MHz */
115 {26000000, {1250, 12, 4, 20, 0} }, /* 26 MHz */
116 {38400000, {3125, 47, 4, 20, 92843} }, /* 38.4 MHz */
117 { }, /* Terminator */
120 static struct pipe3_dpll_map dpll_map_sata
[] = {
121 {12000000, {1000, 7, 4, 6, 0} }, /* 12 MHz */
122 {16800000, {714, 7, 4, 6, 0} }, /* 16.8 MHz */
123 {19200000, {625, 7, 4, 6, 0} }, /* 19.2 MHz */
124 {20000000, {600, 7, 4, 6, 0} }, /* 20 MHz */
125 {26000000, {461, 7, 4, 6, 0} }, /* 26 MHz */
126 {38400000, {312, 7, 4, 6, 0} }, /* 38.4 MHz */
127 { }, /* Terminator */
130 static inline u32
ti_pipe3_readl(void __iomem
*addr
, unsigned offset
)
132 return __raw_readl(addr
+ offset
);
135 static inline void ti_pipe3_writel(void __iomem
*addr
, unsigned offset
,
138 __raw_writel(data
, addr
+ offset
);
141 static struct pipe3_dpll_params
*ti_pipe3_get_dpll_params(struct ti_pipe3
*phy
)
144 struct pipe3_dpll_map
*dpll_map
= phy
->dpll_map
;
146 rate
= clk_get_rate(phy
->sys_clk
);
148 for (; dpll_map
->rate
; dpll_map
++) {
149 if (rate
== dpll_map
->rate
)
150 return &dpll_map
->params
;
153 dev_err(phy
->dev
, "No DPLL configuration for %lu Hz SYS CLK\n", rate
);
158 static int ti_pipe3_enable_clocks(struct ti_pipe3
*phy
);
159 static void ti_pipe3_disable_clocks(struct ti_pipe3
*phy
);
161 static int ti_pipe3_power_off(struct phy
*x
)
165 struct ti_pipe3
*phy
= phy_get_drvdata(x
);
167 if (!phy
->phy_power_syscon
) {
168 omap_control_phy_power(phy
->control_dev
, 0);
172 val
= PIPE3_PHY_TX_RX_POWEROFF
<< PIPE3_PHY_PWRCTL_CLK_CMD_SHIFT
;
174 ret
= regmap_update_bits(phy
->phy_power_syscon
, phy
->power_reg
,
175 PIPE3_PHY_PWRCTL_CLK_CMD_MASK
, val
);
179 static int ti_pipe3_power_on(struct phy
*x
)
185 struct ti_pipe3
*phy
= phy_get_drvdata(x
);
187 if (!phy
->phy_power_syscon
) {
188 omap_control_phy_power(phy
->control_dev
, 1);
192 rate
= clk_get_rate(phy
->sys_clk
);
194 dev_err(phy
->dev
, "Invalid clock rate\n");
197 rate
= rate
/ 1000000;
198 mask
= OMAP_CTRL_PIPE3_PHY_PWRCTL_CLK_CMD_MASK
|
199 OMAP_CTRL_PIPE3_PHY_PWRCTL_CLK_FREQ_MASK
;
200 val
= PIPE3_PHY_TX_RX_POWERON
<< PIPE3_PHY_PWRCTL_CLK_CMD_SHIFT
;
201 val
|= rate
<< OMAP_CTRL_PIPE3_PHY_PWRCTL_CLK_FREQ_SHIFT
;
203 ret
= regmap_update_bits(phy
->phy_power_syscon
, phy
->power_reg
,
208 static int ti_pipe3_dpll_wait_lock(struct ti_pipe3
*phy
)
211 unsigned long timeout
;
213 timeout
= jiffies
+ msecs_to_jiffies(PLL_LOCK_TIME
);
216 val
= ti_pipe3_readl(phy
->pll_ctrl_base
, PLL_STATUS
);
219 } while (!time_after(jiffies
, timeout
));
221 dev_err(phy
->dev
, "DPLL failed to lock\n");
225 static int ti_pipe3_dpll_program(struct ti_pipe3
*phy
)
228 struct pipe3_dpll_params
*dpll_params
;
230 dpll_params
= ti_pipe3_get_dpll_params(phy
);
234 val
= ti_pipe3_readl(phy
->pll_ctrl_base
, PLL_CONFIGURATION1
);
235 val
&= ~PLL_REGN_MASK
;
236 val
|= dpll_params
->n
<< PLL_REGN_SHIFT
;
237 ti_pipe3_writel(phy
->pll_ctrl_base
, PLL_CONFIGURATION1
, val
);
239 val
= ti_pipe3_readl(phy
->pll_ctrl_base
, PLL_CONFIGURATION2
);
240 val
&= ~PLL_SELFREQDCO_MASK
;
241 val
|= dpll_params
->freq
<< PLL_SELFREQDCO_SHIFT
;
242 ti_pipe3_writel(phy
->pll_ctrl_base
, PLL_CONFIGURATION2
, val
);
244 val
= ti_pipe3_readl(phy
->pll_ctrl_base
, PLL_CONFIGURATION1
);
245 val
&= ~PLL_REGM_MASK
;
246 val
|= dpll_params
->m
<< PLL_REGM_SHIFT
;
247 ti_pipe3_writel(phy
->pll_ctrl_base
, PLL_CONFIGURATION1
, val
);
249 val
= ti_pipe3_readl(phy
->pll_ctrl_base
, PLL_CONFIGURATION4
);
250 val
&= ~PLL_REGM_F_MASK
;
251 val
|= dpll_params
->mf
<< PLL_REGM_F_SHIFT
;
252 ti_pipe3_writel(phy
->pll_ctrl_base
, PLL_CONFIGURATION4
, val
);
254 val
= ti_pipe3_readl(phy
->pll_ctrl_base
, PLL_CONFIGURATION3
);
256 val
|= dpll_params
->sd
<< PLL_SD_SHIFT
;
257 ti_pipe3_writel(phy
->pll_ctrl_base
, PLL_CONFIGURATION3
, val
);
259 ti_pipe3_writel(phy
->pll_ctrl_base
, PLL_GO
, SET_PLL_GO
);
261 return ti_pipe3_dpll_wait_lock(phy
);
264 static int ti_pipe3_init(struct phy
*x
)
266 struct ti_pipe3
*phy
= phy_get_drvdata(x
);
270 ti_pipe3_enable_clocks(phy
);
272 * Set pcie_pcs register to 0x96 for proper functioning of phy
273 * as recommended in AM572x TRM SPRUHZ6, section 18.5.2.2, table
276 if (of_device_is_compatible(phy
->dev
->of_node
, "ti,phy-pipe3-pcie")) {
277 if (!phy
->pcs_syscon
) {
278 omap_control_pcie_pcs(phy
->control_dev
, 0x96);
282 val
= 0x96 << OMAP_CTRL_PCIE_PCS_DELAY_COUNT_SHIFT
;
283 ret
= regmap_update_bits(phy
->pcs_syscon
, phy
->pcie_pcs_reg
,
288 /* Bring it out of IDLE if it is IDLE */
289 val
= ti_pipe3_readl(phy
->pll_ctrl_base
, PLL_CONFIGURATION2
);
290 if (val
& PLL_IDLE
) {
292 ti_pipe3_writel(phy
->pll_ctrl_base
, PLL_CONFIGURATION2
, val
);
293 ret
= ti_pipe3_dpll_wait_lock(phy
);
296 /* SATA has issues if re-programmed when locked */
297 val
= ti_pipe3_readl(phy
->pll_ctrl_base
, PLL_STATUS
);
298 if ((val
& PLL_LOCK
) && of_device_is_compatible(phy
->dev
->of_node
,
299 "ti,phy-pipe3-sata"))
302 /* Program the DPLL */
303 ret
= ti_pipe3_dpll_program(phy
);
305 ti_pipe3_disable_clocks(phy
);
312 static int ti_pipe3_exit(struct phy
*x
)
314 struct ti_pipe3
*phy
= phy_get_drvdata(x
);
316 unsigned long timeout
;
318 /* If dpll_reset_syscon is not present we wont power down SATA DPLL
321 if (of_device_is_compatible(phy
->dev
->of_node
, "ti,phy-pipe3-sata") &&
322 !phy
->dpll_reset_syscon
)
325 /* PCIe doesn't have internal DPLL */
326 if (!of_device_is_compatible(phy
->dev
->of_node
, "ti,phy-pipe3-pcie")) {
327 /* Put DPLL in IDLE mode */
328 val
= ti_pipe3_readl(phy
->pll_ctrl_base
, PLL_CONFIGURATION2
);
330 ti_pipe3_writel(phy
->pll_ctrl_base
, PLL_CONFIGURATION2
, val
);
332 /* wait for LDO and Oscillator to power down */
333 timeout
= jiffies
+ msecs_to_jiffies(PLL_IDLE_TIME
);
336 val
= ti_pipe3_readl(phy
->pll_ctrl_base
, PLL_STATUS
);
337 if ((val
& PLL_TICOPWDN
) && (val
& PLL_LDOPWDN
))
339 } while (!time_after(jiffies
, timeout
));
341 if (!(val
& PLL_TICOPWDN
) || !(val
& PLL_LDOPWDN
)) {
342 dev_err(phy
->dev
, "Failed to power down: PLL_STATUS 0x%x\n",
348 /* i783: SATA needs control bit toggle after PLL unlock */
349 if (of_device_is_compatible(phy
->dev
->of_node
, "ti,phy-pipe3-sata")) {
350 regmap_update_bits(phy
->dpll_reset_syscon
, phy
->dpll_reset_reg
,
351 SATA_PLL_SOFT_RESET
, SATA_PLL_SOFT_RESET
);
352 regmap_update_bits(phy
->dpll_reset_syscon
, phy
->dpll_reset_reg
,
353 SATA_PLL_SOFT_RESET
, 0);
356 ti_pipe3_disable_clocks(phy
);
360 static const struct phy_ops ops
= {
361 .init
= ti_pipe3_init
,
362 .exit
= ti_pipe3_exit
,
363 .power_on
= ti_pipe3_power_on
,
364 .power_off
= ti_pipe3_power_off
,
365 .owner
= THIS_MODULE
,
368 static const struct of_device_id ti_pipe3_id_table
[];
370 static int ti_pipe3_get_clk(struct ti_pipe3
*phy
)
373 struct device
*dev
= phy
->dev
;
374 struct device_node
*node
= dev
->of_node
;
376 phy
->refclk
= devm_clk_get(dev
, "refclk");
377 if (IS_ERR(phy
->refclk
)) {
378 dev_err(dev
, "unable to get refclk\n");
379 /* older DTBs have missing refclk in SATA PHY
380 * so don't bail out in case of SATA PHY.
382 if (!of_device_is_compatible(node
, "ti,phy-pipe3-sata"))
383 return PTR_ERR(phy
->refclk
);
386 if (!of_device_is_compatible(node
, "ti,phy-pipe3-sata")) {
387 phy
->wkupclk
= devm_clk_get(dev
, "wkupclk");
388 if (IS_ERR(phy
->wkupclk
)) {
389 dev_err(dev
, "unable to get wkupclk\n");
390 return PTR_ERR(phy
->wkupclk
);
393 phy
->wkupclk
= ERR_PTR(-ENODEV
);
396 if (!of_device_is_compatible(node
, "ti,phy-pipe3-pcie") ||
397 phy
->phy_power_syscon
) {
398 phy
->sys_clk
= devm_clk_get(dev
, "sysclk");
399 if (IS_ERR(phy
->sys_clk
)) {
400 dev_err(dev
, "unable to get sysclk\n");
405 if (of_device_is_compatible(node
, "ti,phy-pipe3-pcie")) {
406 clk
= devm_clk_get(dev
, "dpll_ref");
408 dev_err(dev
, "unable to get dpll ref clk\n");
411 clk_set_rate(clk
, 1500000000);
413 clk
= devm_clk_get(dev
, "dpll_ref_m2");
415 dev_err(dev
, "unable to get dpll ref m2 clk\n");
418 clk_set_rate(clk
, 100000000);
420 clk
= devm_clk_get(dev
, "phy-div");
422 dev_err(dev
, "unable to get phy-div clk\n");
425 clk_set_rate(clk
, 100000000);
427 phy
->div_clk
= devm_clk_get(dev
, "div-clk");
428 if (IS_ERR(phy
->div_clk
)) {
429 dev_err(dev
, "unable to get div-clk\n");
430 return PTR_ERR(phy
->div_clk
);
433 phy
->div_clk
= ERR_PTR(-ENODEV
);
439 static int ti_pipe3_get_sysctrl(struct ti_pipe3
*phy
)
441 struct device
*dev
= phy
->dev
;
442 struct device_node
*node
= dev
->of_node
;
443 struct device_node
*control_node
;
444 struct platform_device
*control_pdev
;
446 phy
->phy_power_syscon
= syscon_regmap_lookup_by_phandle(node
,
448 if (IS_ERR(phy
->phy_power_syscon
)) {
450 "can't get syscon-phy-power, using control device\n");
451 phy
->phy_power_syscon
= NULL
;
453 if (of_property_read_u32_index(node
,
454 "syscon-phy-power", 1,
456 dev_err(dev
, "couldn't get power reg. offset\n");
461 if (!phy
->phy_power_syscon
) {
462 control_node
= of_parse_phandle(node
, "ctrl-module", 0);
464 dev_err(dev
, "Failed to get control device phandle\n");
468 control_pdev
= of_find_device_by_node(control_node
);
470 dev_err(dev
, "Failed to get control device\n");
474 phy
->control_dev
= &control_pdev
->dev
;
477 if (of_device_is_compatible(node
, "ti,phy-pipe3-pcie")) {
478 phy
->pcs_syscon
= syscon_regmap_lookup_by_phandle(node
,
480 if (IS_ERR(phy
->pcs_syscon
)) {
482 "can't get syscon-pcs, using omap control\n");
483 phy
->pcs_syscon
= NULL
;
485 if (of_property_read_u32_index(node
,
487 &phy
->pcie_pcs_reg
)) {
489 "couldn't get pcie pcs reg. offset\n");
495 if (of_device_is_compatible(node
, "ti,phy-pipe3-sata")) {
496 phy
->dpll_reset_syscon
= syscon_regmap_lookup_by_phandle(node
,
498 if (IS_ERR(phy
->dpll_reset_syscon
)) {
500 "can't get syscon-pllreset, sata dpll won't idle\n");
501 phy
->dpll_reset_syscon
= NULL
;
503 if (of_property_read_u32_index(node
,
504 "syscon-pllreset", 1,
505 &phy
->dpll_reset_reg
)) {
507 "couldn't get pllreset reg. offset\n");
516 static int ti_pipe3_get_pll_base(struct ti_pipe3
*phy
)
518 struct resource
*res
;
519 const struct of_device_id
*match
;
520 struct device
*dev
= phy
->dev
;
521 struct device_node
*node
= dev
->of_node
;
522 struct platform_device
*pdev
= to_platform_device(dev
);
524 if (of_device_is_compatible(node
, "ti,phy-pipe3-pcie"))
527 match
= of_match_device(ti_pipe3_id_table
, dev
);
531 phy
->dpll_map
= (struct pipe3_dpll_map
*)match
->data
;
532 if (!phy
->dpll_map
) {
533 dev_err(dev
, "no DPLL data\n");
537 res
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
,
539 phy
->pll_ctrl_base
= devm_ioremap_resource(dev
, res
);
540 if (IS_ERR(phy
->pll_ctrl_base
))
541 return PTR_ERR(phy
->pll_ctrl_base
);
546 static int ti_pipe3_probe(struct platform_device
*pdev
)
548 struct ti_pipe3
*phy
;
549 struct phy
*generic_phy
;
550 struct phy_provider
*phy_provider
;
551 struct device_node
*node
= pdev
->dev
.of_node
;
552 struct device
*dev
= &pdev
->dev
;
555 phy
= devm_kzalloc(dev
, sizeof(*phy
), GFP_KERNEL
);
561 ret
= ti_pipe3_get_pll_base(phy
);
565 ret
= ti_pipe3_get_sysctrl(phy
);
569 ret
= ti_pipe3_get_clk(phy
);
573 platform_set_drvdata(pdev
, phy
);
574 pm_runtime_enable(dev
);
577 * Prevent auto-disable of refclk for SATA PHY due to Errata i783
579 if (of_device_is_compatible(node
, "ti,phy-pipe3-sata")) {
580 if (!IS_ERR(phy
->refclk
)) {
581 clk_prepare_enable(phy
->refclk
);
582 phy
->sata_refclk_enabled
= true;
586 generic_phy
= devm_phy_create(dev
, NULL
, &ops
);
587 if (IS_ERR(generic_phy
))
588 return PTR_ERR(generic_phy
);
590 phy_set_drvdata(generic_phy
, phy
);
592 ti_pipe3_power_off(generic_phy
);
594 phy_provider
= devm_of_phy_provider_register(dev
, of_phy_simple_xlate
);
595 if (IS_ERR(phy_provider
))
596 return PTR_ERR(phy_provider
);
601 static int ti_pipe3_remove(struct platform_device
*pdev
)
603 pm_runtime_disable(&pdev
->dev
);
608 static int ti_pipe3_enable_clocks(struct ti_pipe3
*phy
)
612 if (!IS_ERR(phy
->refclk
)) {
613 ret
= clk_prepare_enable(phy
->refclk
);
615 dev_err(phy
->dev
, "Failed to enable refclk %d\n", ret
);
620 if (!IS_ERR(phy
->wkupclk
)) {
621 ret
= clk_prepare_enable(phy
->wkupclk
);
623 dev_err(phy
->dev
, "Failed to enable wkupclk %d\n", ret
);
628 if (!IS_ERR(phy
->div_clk
)) {
629 ret
= clk_prepare_enable(phy
->div_clk
);
631 dev_err(phy
->dev
, "Failed to enable div_clk %d\n", ret
);
632 goto disable_wkupclk
;
639 if (!IS_ERR(phy
->wkupclk
))
640 clk_disable_unprepare(phy
->wkupclk
);
643 if (!IS_ERR(phy
->refclk
))
644 clk_disable_unprepare(phy
->refclk
);
649 static void ti_pipe3_disable_clocks(struct ti_pipe3
*phy
)
651 if (!IS_ERR(phy
->wkupclk
))
652 clk_disable_unprepare(phy
->wkupclk
);
653 if (!IS_ERR(phy
->refclk
)) {
654 clk_disable_unprepare(phy
->refclk
);
656 * SATA refclk needs an additional disable as we left it
657 * on in probe to avoid Errata i783
659 if (phy
->sata_refclk_enabled
) {
660 clk_disable_unprepare(phy
->refclk
);
661 phy
->sata_refclk_enabled
= false;
665 if (!IS_ERR(phy
->div_clk
))
666 clk_disable_unprepare(phy
->div_clk
);
669 static const struct of_device_id ti_pipe3_id_table
[] = {
671 .compatible
= "ti,phy-usb3",
672 .data
= dpll_map_usb
,
675 .compatible
= "ti,omap-usb3",
676 .data
= dpll_map_usb
,
679 .compatible
= "ti,phy-pipe3-sata",
680 .data
= dpll_map_sata
,
683 .compatible
= "ti,phy-pipe3-pcie",
687 MODULE_DEVICE_TABLE(of
, ti_pipe3_id_table
);
689 static struct platform_driver ti_pipe3_driver
= {
690 .probe
= ti_pipe3_probe
,
691 .remove
= ti_pipe3_remove
,
694 .of_match_table
= ti_pipe3_id_table
,
698 module_platform_driver(ti_pipe3_driver
);
700 MODULE_ALIAS("platform:ti_pipe3");
701 MODULE_AUTHOR("Texas Instruments Inc.");
702 MODULE_DESCRIPTION("TI PIPE3 phy driver");
703 MODULE_LICENSE("GPL v2");