2 * Copyright (c) 2013-2015, Linux Foundation. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 and
6 * only version 2 as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
15 #include "phy-qcom-ufs-i.h"
17 #define MAX_PROP_NAME 32
18 #define VDDA_PHY_MIN_UV 1000000
19 #define VDDA_PHY_MAX_UV 1000000
20 #define VDDA_PLL_MIN_UV 1800000
21 #define VDDA_PLL_MAX_UV 1800000
22 #define VDDP_REF_CLK_MIN_UV 1200000
23 #define VDDP_REF_CLK_MAX_UV 1200000
25 int ufs_qcom_phy_calibrate(struct ufs_qcom_phy
*ufs_qcom_phy
,
26 struct ufs_qcom_phy_calibration
*tbl_A
,
28 struct ufs_qcom_phy_calibration
*tbl_B
,
29 int tbl_size_B
, bool is_rate_B
)
35 dev_err(ufs_qcom_phy
->dev
, "%s: tbl_A is NULL", __func__
);
40 for (i
= 0; i
< tbl_size_A
; i
++)
41 writel_relaxed(tbl_A
[i
].cfg_value
,
42 ufs_qcom_phy
->mmio
+ tbl_A
[i
].reg_offset
);
45 * In case we would like to work in rate B, we need
46 * to override a registers that were configured in rate A table
47 * with registers of rate B table.
52 dev_err(ufs_qcom_phy
->dev
, "%s: tbl_B is NULL",
58 for (i
= 0; i
< tbl_size_B
; i
++)
59 writel_relaxed(tbl_B
[i
].cfg_value
,
60 ufs_qcom_phy
->mmio
+ tbl_B
[i
].reg_offset
);
63 /* flush buffered writes */
69 EXPORT_SYMBOL_GPL(ufs_qcom_phy_calibrate
);
72 * This assumes the embedded phy structure inside generic_phy is of type
73 * struct ufs_qcom_phy. In order to function properly it's crucial
74 * to keep the embedded struct "struct ufs_qcom_phy common_cfg"
75 * as the first inside generic_phy.
77 struct ufs_qcom_phy
*get_ufs_qcom_phy(struct phy
*generic_phy
)
79 return (struct ufs_qcom_phy
*)phy_get_drvdata(generic_phy
);
81 EXPORT_SYMBOL_GPL(get_ufs_qcom_phy
);
84 int ufs_qcom_phy_base_init(struct platform_device
*pdev
,
85 struct ufs_qcom_phy
*phy_common
)
87 struct device
*dev
= &pdev
->dev
;
91 res
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, "phy_mem");
92 phy_common
->mmio
= devm_ioremap_resource(dev
, res
);
93 if (IS_ERR((void const *)phy_common
->mmio
)) {
94 err
= PTR_ERR((void const *)phy_common
->mmio
);
95 phy_common
->mmio
= NULL
;
96 dev_err(dev
, "%s: ioremap for phy_mem resource failed %d\n",
101 /* "dev_ref_clk_ctrl_mem" is optional resource */
102 res
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
,
103 "dev_ref_clk_ctrl_mem");
104 phy_common
->dev_ref_clk_ctrl_mmio
= devm_ioremap_resource(dev
, res
);
105 if (IS_ERR((void const *)phy_common
->dev_ref_clk_ctrl_mmio
))
106 phy_common
->dev_ref_clk_ctrl_mmio
= NULL
;
111 struct phy
*ufs_qcom_phy_generic_probe(struct platform_device
*pdev
,
112 struct ufs_qcom_phy
*common_cfg
,
113 const struct phy_ops
*ufs_qcom_phy_gen_ops
,
114 struct ufs_qcom_phy_specific_ops
*phy_spec_ops
)
117 struct device
*dev
= &pdev
->dev
;
118 struct phy
*generic_phy
= NULL
;
119 struct phy_provider
*phy_provider
;
121 err
= ufs_qcom_phy_base_init(pdev
, common_cfg
);
123 dev_err(dev
, "%s: phy base init failed %d\n", __func__
, err
);
127 phy_provider
= devm_of_phy_provider_register(dev
, of_phy_simple_xlate
);
128 if (IS_ERR(phy_provider
)) {
129 err
= PTR_ERR(phy_provider
);
130 dev_err(dev
, "%s: failed to register phy %d\n", __func__
, err
);
134 generic_phy
= devm_phy_create(dev
, NULL
, ufs_qcom_phy_gen_ops
);
135 if (IS_ERR(generic_phy
)) {
136 err
= PTR_ERR(generic_phy
);
137 dev_err(dev
, "%s: failed to create phy %d\n", __func__
, err
);
142 common_cfg
->phy_spec_ops
= phy_spec_ops
;
143 common_cfg
->dev
= dev
;
148 EXPORT_SYMBOL_GPL(ufs_qcom_phy_generic_probe
);
150 static int ufs_qcom_phy_get_reset(struct ufs_qcom_phy
*phy_common
)
152 struct reset_control
*reset
;
154 if (phy_common
->ufs_reset
)
157 reset
= devm_reset_control_get_exclusive_by_index(phy_common
->dev
, 0);
159 return PTR_ERR(reset
);
161 phy_common
->ufs_reset
= reset
;
165 static int __ufs_qcom_phy_clk_get(struct device
*dev
,
166 const char *name
, struct clk
**clk_out
, bool err_print
)
171 clk
= devm_clk_get(dev
, name
);
175 dev_err(dev
, "failed to get %s err %d", name
, err
);
183 static int ufs_qcom_phy_clk_get(struct device
*dev
,
184 const char *name
, struct clk
**clk_out
)
186 return __ufs_qcom_phy_clk_get(dev
, name
, clk_out
, true);
189 int ufs_qcom_phy_init_clks(struct ufs_qcom_phy
*phy_common
)
193 if (of_device_is_compatible(phy_common
->dev
->of_node
,
194 "qcom,msm8996-ufs-phy-qmp-14nm"))
197 err
= ufs_qcom_phy_clk_get(phy_common
->dev
, "tx_iface_clk",
198 &phy_common
->tx_iface_clk
);
202 err
= ufs_qcom_phy_clk_get(phy_common
->dev
, "rx_iface_clk",
203 &phy_common
->rx_iface_clk
);
208 err
= ufs_qcom_phy_clk_get(phy_common
->dev
, "ref_clk_src",
209 &phy_common
->ref_clk_src
);
214 * "ref_clk_parent" is optional hence don't abort init if it's not
217 __ufs_qcom_phy_clk_get(phy_common
->dev
, "ref_clk_parent",
218 &phy_common
->ref_clk_parent
, false);
220 err
= ufs_qcom_phy_clk_get(phy_common
->dev
, "ref_clk",
221 &phy_common
->ref_clk
);
226 EXPORT_SYMBOL_GPL(ufs_qcom_phy_init_clks
);
228 static int ufs_qcom_phy_init_vreg(struct device
*dev
,
229 struct ufs_qcom_phy_vreg
*vreg
,
234 char prop_name
[MAX_PROP_NAME
];
237 vreg
->reg
= devm_regulator_get(dev
, name
);
238 if (IS_ERR(vreg
->reg
)) {
239 err
= PTR_ERR(vreg
->reg
);
240 dev_err(dev
, "failed to get %s, %d\n", name
, err
);
245 snprintf(prop_name
, MAX_PROP_NAME
, "%s-max-microamp", name
);
246 err
= of_property_read_u32(dev
->of_node
,
247 prop_name
, &vreg
->max_uA
);
248 if (err
&& err
!= -EINVAL
) {
249 dev_err(dev
, "%s: failed to read %s\n",
250 __func__
, prop_name
);
252 } else if (err
== -EINVAL
|| !vreg
->max_uA
) {
253 if (regulator_count_voltages(vreg
->reg
) > 0) {
254 dev_err(dev
, "%s: %s is mandatory\n",
255 __func__
, prop_name
);
262 if (!strcmp(name
, "vdda-pll")) {
263 vreg
->max_uV
= VDDA_PLL_MAX_UV
;
264 vreg
->min_uV
= VDDA_PLL_MIN_UV
;
265 } else if (!strcmp(name
, "vdda-phy")) {
266 vreg
->max_uV
= VDDA_PHY_MAX_UV
;
267 vreg
->min_uV
= VDDA_PHY_MIN_UV
;
268 } else if (!strcmp(name
, "vddp-ref-clk")) {
269 vreg
->max_uV
= VDDP_REF_CLK_MAX_UV
;
270 vreg
->min_uV
= VDDP_REF_CLK_MIN_UV
;
277 int ufs_qcom_phy_init_vregulators(struct ufs_qcom_phy
*phy_common
)
281 err
= ufs_qcom_phy_init_vreg(phy_common
->dev
, &phy_common
->vdda_pll
,
286 err
= ufs_qcom_phy_init_vreg(phy_common
->dev
, &phy_common
->vdda_phy
,
292 err
= ufs_qcom_phy_init_vreg(phy_common
->dev
, &phy_common
->vddp_ref_clk
,
298 EXPORT_SYMBOL_GPL(ufs_qcom_phy_init_vregulators
);
300 static int ufs_qcom_phy_cfg_vreg(struct device
*dev
,
301 struct ufs_qcom_phy_vreg
*vreg
, bool on
)
304 struct regulator
*reg
= vreg
->reg
;
305 const char *name
= vreg
->name
;
309 if (regulator_count_voltages(reg
) > 0) {
310 min_uV
= on
? vreg
->min_uV
: 0;
311 ret
= regulator_set_voltage(reg
, min_uV
, vreg
->max_uV
);
313 dev_err(dev
, "%s: %s set voltage failed, err=%d\n",
314 __func__
, name
, ret
);
317 uA_load
= on
? vreg
->max_uA
: 0;
318 ret
= regulator_set_load(reg
, uA_load
);
321 * regulator_set_load() returns new regulator
326 dev_err(dev
, "%s: %s set optimum mode(uA_load=%d) failed, err=%d\n",
327 __func__
, name
, uA_load
, ret
);
335 static int ufs_qcom_phy_enable_vreg(struct device
*dev
,
336 struct ufs_qcom_phy_vreg
*vreg
)
340 if (!vreg
|| vreg
->enabled
)
343 ret
= ufs_qcom_phy_cfg_vreg(dev
, vreg
, true);
345 dev_err(dev
, "%s: ufs_qcom_phy_cfg_vreg() failed, err=%d\n",
350 ret
= regulator_enable(vreg
->reg
);
352 dev_err(dev
, "%s: enable failed, err=%d\n",
357 vreg
->enabled
= true;
362 static int ufs_qcom_phy_enable_ref_clk(struct ufs_qcom_phy
*phy
)
366 if (phy
->is_ref_clk_enabled
)
370 * reference clock is propagated in a daisy-chained manner from
371 * source to phy, so ungate them at each stage.
373 ret
= clk_prepare_enable(phy
->ref_clk_src
);
375 dev_err(phy
->dev
, "%s: ref_clk_src enable failed %d\n",
381 * "ref_clk_parent" is optional clock hence make sure that clk reference
382 * is available before trying to enable the clock.
384 if (phy
->ref_clk_parent
) {
385 ret
= clk_prepare_enable(phy
->ref_clk_parent
);
387 dev_err(phy
->dev
, "%s: ref_clk_parent enable failed %d\n",
389 goto out_disable_src
;
393 ret
= clk_prepare_enable(phy
->ref_clk
);
395 dev_err(phy
->dev
, "%s: ref_clk enable failed %d\n",
397 goto out_disable_parent
;
400 phy
->is_ref_clk_enabled
= true;
404 if (phy
->ref_clk_parent
)
405 clk_disable_unprepare(phy
->ref_clk_parent
);
407 clk_disable_unprepare(phy
->ref_clk_src
);
412 static int ufs_qcom_phy_disable_vreg(struct device
*dev
,
413 struct ufs_qcom_phy_vreg
*vreg
)
417 if (!vreg
|| !vreg
->enabled
)
420 ret
= regulator_disable(vreg
->reg
);
423 /* ignore errors on applying disable config */
424 ufs_qcom_phy_cfg_vreg(dev
, vreg
, false);
425 vreg
->enabled
= false;
427 dev_err(dev
, "%s: %s disable failed, err=%d\n",
428 __func__
, vreg
->name
, ret
);
434 static void ufs_qcom_phy_disable_ref_clk(struct ufs_qcom_phy
*phy
)
436 if (phy
->is_ref_clk_enabled
) {
437 clk_disable_unprepare(phy
->ref_clk
);
439 * "ref_clk_parent" is optional clock hence make sure that clk
440 * reference is available before trying to disable the clock.
442 if (phy
->ref_clk_parent
)
443 clk_disable_unprepare(phy
->ref_clk_parent
);
444 clk_disable_unprepare(phy
->ref_clk_src
);
445 phy
->is_ref_clk_enabled
= false;
449 /* Turn ON M-PHY RMMI interface clocks */
450 static int ufs_qcom_phy_enable_iface_clk(struct ufs_qcom_phy
*phy
)
454 if (phy
->is_iface_clk_enabled
)
457 ret
= clk_prepare_enable(phy
->tx_iface_clk
);
459 dev_err(phy
->dev
, "%s: tx_iface_clk enable failed %d\n",
463 ret
= clk_prepare_enable(phy
->rx_iface_clk
);
465 clk_disable_unprepare(phy
->tx_iface_clk
);
466 dev_err(phy
->dev
, "%s: rx_iface_clk enable failed %d. disabling also tx_iface_clk\n",
470 phy
->is_iface_clk_enabled
= true;
476 /* Turn OFF M-PHY RMMI interface clocks */
477 static void ufs_qcom_phy_disable_iface_clk(struct ufs_qcom_phy
*phy
)
479 if (phy
->is_iface_clk_enabled
) {
480 clk_disable_unprepare(phy
->tx_iface_clk
);
481 clk_disable_unprepare(phy
->rx_iface_clk
);
482 phy
->is_iface_clk_enabled
= false;
486 static int ufs_qcom_phy_start_serdes(struct ufs_qcom_phy
*ufs_qcom_phy
)
490 if (!ufs_qcom_phy
->phy_spec_ops
->start_serdes
) {
491 dev_err(ufs_qcom_phy
->dev
, "%s: start_serdes() callback is not supported\n",
495 ufs_qcom_phy
->phy_spec_ops
->start_serdes(ufs_qcom_phy
);
501 int ufs_qcom_phy_set_tx_lane_enable(struct phy
*generic_phy
, u32 tx_lanes
)
503 struct ufs_qcom_phy
*ufs_qcom_phy
= get_ufs_qcom_phy(generic_phy
);
506 if (!ufs_qcom_phy
->phy_spec_ops
->set_tx_lane_enable
) {
507 dev_err(ufs_qcom_phy
->dev
, "%s: set_tx_lane_enable() callback is not supported\n",
511 ufs_qcom_phy
->phy_spec_ops
->set_tx_lane_enable(ufs_qcom_phy
,
517 EXPORT_SYMBOL_GPL(ufs_qcom_phy_set_tx_lane_enable
);
519 void ufs_qcom_phy_save_controller_version(struct phy
*generic_phy
,
520 u8 major
, u16 minor
, u16 step
)
522 struct ufs_qcom_phy
*ufs_qcom_phy
= get_ufs_qcom_phy(generic_phy
);
524 ufs_qcom_phy
->host_ctrl_rev_major
= major
;
525 ufs_qcom_phy
->host_ctrl_rev_minor
= minor
;
526 ufs_qcom_phy
->host_ctrl_rev_step
= step
;
528 EXPORT_SYMBOL_GPL(ufs_qcom_phy_save_controller_version
);
530 static int ufs_qcom_phy_is_pcs_ready(struct ufs_qcom_phy
*ufs_qcom_phy
)
532 if (!ufs_qcom_phy
->phy_spec_ops
->is_physical_coding_sublayer_ready
) {
533 dev_err(ufs_qcom_phy
->dev
, "%s: is_physical_coding_sublayer_ready() callback is not supported\n",
538 return ufs_qcom_phy
->phy_spec_ops
->
539 is_physical_coding_sublayer_ready(ufs_qcom_phy
);
542 int ufs_qcom_phy_power_on(struct phy
*generic_phy
)
544 struct ufs_qcom_phy
*phy_common
= get_ufs_qcom_phy(generic_phy
);
545 struct device
*dev
= phy_common
->dev
;
546 bool is_rate_B
= false;
549 err
= ufs_qcom_phy_get_reset(phy_common
);
553 err
= reset_control_assert(phy_common
->ufs_reset
);
557 if (phy_common
->mode
== PHY_MODE_UFS_HS_B
)
560 err
= phy_common
->phy_spec_ops
->calibrate(phy_common
, is_rate_B
);
564 err
= reset_control_deassert(phy_common
->ufs_reset
);
566 dev_err(dev
, "Failed to assert UFS PHY reset");
570 err
= ufs_qcom_phy_start_serdes(phy_common
);
574 err
= ufs_qcom_phy_is_pcs_ready(phy_common
);
578 err
= ufs_qcom_phy_enable_vreg(dev
, &phy_common
->vdda_phy
);
580 dev_err(dev
, "%s enable vdda_phy failed, err=%d\n",
585 phy_common
->phy_spec_ops
->power_control(phy_common
, true);
587 /* vdda_pll also enables ref clock LDOs so enable it first */
588 err
= ufs_qcom_phy_enable_vreg(dev
, &phy_common
->vdda_pll
);
590 dev_err(dev
, "%s enable vdda_pll failed, err=%d\n",
592 goto out_disable_phy
;
595 err
= ufs_qcom_phy_enable_iface_clk(phy_common
);
597 dev_err(dev
, "%s enable phy iface clock failed, err=%d\n",
599 goto out_disable_pll
;
602 err
= ufs_qcom_phy_enable_ref_clk(phy_common
);
604 dev_err(dev
, "%s enable phy ref clock failed, err=%d\n",
606 goto out_disable_iface_clk
;
609 /* enable device PHY ref_clk pad rail */
610 if (phy_common
->vddp_ref_clk
.reg
) {
611 err
= ufs_qcom_phy_enable_vreg(dev
,
612 &phy_common
->vddp_ref_clk
);
614 dev_err(dev
, "%s enable vddp_ref_clk failed, err=%d\n",
616 goto out_disable_ref_clk
;
623 ufs_qcom_phy_disable_ref_clk(phy_common
);
624 out_disable_iface_clk
:
625 ufs_qcom_phy_disable_iface_clk(phy_common
);
627 ufs_qcom_phy_disable_vreg(dev
, &phy_common
->vdda_pll
);
629 ufs_qcom_phy_disable_vreg(dev
, &phy_common
->vdda_phy
);
633 EXPORT_SYMBOL_GPL(ufs_qcom_phy_power_on
);
635 int ufs_qcom_phy_power_off(struct phy
*generic_phy
)
637 struct ufs_qcom_phy
*phy_common
= get_ufs_qcom_phy(generic_phy
);
639 phy_common
->phy_spec_ops
->power_control(phy_common
, false);
641 if (phy_common
->vddp_ref_clk
.reg
)
642 ufs_qcom_phy_disable_vreg(phy_common
->dev
,
643 &phy_common
->vddp_ref_clk
);
644 ufs_qcom_phy_disable_ref_clk(phy_common
);
645 ufs_qcom_phy_disable_iface_clk(phy_common
);
647 ufs_qcom_phy_disable_vreg(phy_common
->dev
, &phy_common
->vdda_pll
);
648 ufs_qcom_phy_disable_vreg(phy_common
->dev
, &phy_common
->vdda_phy
);
649 reset_control_assert(phy_common
->ufs_reset
);
652 EXPORT_SYMBOL_GPL(ufs_qcom_phy_power_off
);
654 MODULE_AUTHOR("Yaniv Gardi <ygardi@codeaurora.org>");
655 MODULE_AUTHOR("Vivek Gautam <vivek.gautam@codeaurora.org>");
656 MODULE_DESCRIPTION("Universal Flash Storage (UFS) QCOM PHY");
657 MODULE_LICENSE("GPL v2");