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 static int __ufs_qcom_phy_init_vreg(struct phy *, struct ufs_qcom_phy_vreg *,
27 static int ufs_qcom_phy_init_vreg(struct phy *, struct ufs_qcom_phy_vreg *,
29 static int ufs_qcom_phy_base_init(struct platform_device *pdev,
30 struct ufs_qcom_phy *phy_common);
32 int ufs_qcom_phy_calibrate(struct ufs_qcom_phy *ufs_qcom_phy,
33 struct ufs_qcom_phy_calibration *tbl_A,
35 struct ufs_qcom_phy_calibration *tbl_B,
36 int tbl_size_B, bool is_rate_B)
42 dev_err(ufs_qcom_phy->dev, "%s: tbl_A is NULL", __func__);
47 for (i = 0; i < tbl_size_A; i++)
48 writel_relaxed(tbl_A[i].cfg_value,
49 ufs_qcom_phy->mmio + tbl_A[i].reg_offset);
52 * In case we would like to work in rate B, we need
53 * to override a registers that were configured in rate A table
54 * with registers of rate B table.
59 dev_err(ufs_qcom_phy->dev, "%s: tbl_B is NULL",
65 for (i = 0; i < tbl_size_B; i++)
66 writel_relaxed(tbl_B[i].cfg_value,
67 ufs_qcom_phy->mmio + tbl_B[i].reg_offset);
70 /* flush buffered writes */
76 EXPORT_SYMBOL_GPL(ufs_qcom_phy_calibrate);
78 struct phy *ufs_qcom_phy_generic_probe(struct platform_device *pdev,
79 struct ufs_qcom_phy *common_cfg,
80 const struct phy_ops *ufs_qcom_phy_gen_ops,
81 struct ufs_qcom_phy_specific_ops *phy_spec_ops)
84 struct device *dev = &pdev->dev;
85 struct phy *generic_phy = NULL;
86 struct phy_provider *phy_provider;
88 err = ufs_qcom_phy_base_init(pdev, common_cfg);
90 dev_err(dev, "%s: phy base init failed %d\n", __func__, err);
94 phy_provider = devm_of_phy_provider_register(dev, of_phy_simple_xlate);
95 if (IS_ERR(phy_provider)) {
96 err = PTR_ERR(phy_provider);
97 dev_err(dev, "%s: failed to register phy %d\n", __func__, err);
101 generic_phy = devm_phy_create(dev, NULL, ufs_qcom_phy_gen_ops);
102 if (IS_ERR(generic_phy)) {
103 err = PTR_ERR(generic_phy);
104 dev_err(dev, "%s: failed to create phy %d\n", __func__, err);
109 common_cfg->phy_spec_ops = phy_spec_ops;
110 common_cfg->dev = dev;
115 EXPORT_SYMBOL_GPL(ufs_qcom_phy_generic_probe);
118 * This assumes the embedded phy structure inside generic_phy is of type
119 * struct ufs_qcom_phy. In order to function properly it's crucial
120 * to keep the embedded struct "struct ufs_qcom_phy common_cfg"
121 * as the first inside generic_phy.
123 struct ufs_qcom_phy *get_ufs_qcom_phy(struct phy *generic_phy)
125 return (struct ufs_qcom_phy *)phy_get_drvdata(generic_phy);
127 EXPORT_SYMBOL_GPL(get_ufs_qcom_phy);
130 int ufs_qcom_phy_base_init(struct platform_device *pdev,
131 struct ufs_qcom_phy *phy_common)
133 struct device *dev = &pdev->dev;
134 struct resource *res;
137 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "phy_mem");
138 phy_common->mmio = devm_ioremap_resource(dev, res);
139 if (IS_ERR((void const *)phy_common->mmio)) {
140 err = PTR_ERR((void const *)phy_common->mmio);
141 phy_common->mmio = NULL;
142 dev_err(dev, "%s: ioremap for phy_mem resource failed %d\n",
147 /* "dev_ref_clk_ctrl_mem" is optional resource */
148 res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
149 "dev_ref_clk_ctrl_mem");
150 phy_common->dev_ref_clk_ctrl_mmio = devm_ioremap_resource(dev, res);
151 if (IS_ERR((void const *)phy_common->dev_ref_clk_ctrl_mmio))
152 phy_common->dev_ref_clk_ctrl_mmio = NULL;
157 static int __ufs_qcom_phy_clk_get(struct phy *phy,
158 const char *name, struct clk **clk_out, bool err_print)
162 struct ufs_qcom_phy *ufs_qcom_phy = get_ufs_qcom_phy(phy);
163 struct device *dev = ufs_qcom_phy->dev;
165 clk = devm_clk_get(dev, name);
169 dev_err(dev, "failed to get %s err %d", name, err);
178 int ufs_qcom_phy_clk_get(struct phy *phy,
179 const char *name, struct clk **clk_out)
181 return __ufs_qcom_phy_clk_get(phy, name, clk_out, true);
185 ufs_qcom_phy_init_clks(struct phy *generic_phy,
186 struct ufs_qcom_phy *phy_common)
190 err = ufs_qcom_phy_clk_get(generic_phy, "tx_iface_clk",
191 &phy_common->tx_iface_clk);
195 err = ufs_qcom_phy_clk_get(generic_phy, "rx_iface_clk",
196 &phy_common->rx_iface_clk);
200 err = ufs_qcom_phy_clk_get(generic_phy, "ref_clk_src",
201 &phy_common->ref_clk_src);
206 * "ref_clk_parent" is optional hence don't abort init if it's not
209 __ufs_qcom_phy_clk_get(generic_phy, "ref_clk_parent",
210 &phy_common->ref_clk_parent, false);
212 err = ufs_qcom_phy_clk_get(generic_phy, "ref_clk",
213 &phy_common->ref_clk);
218 EXPORT_SYMBOL_GPL(ufs_qcom_phy_init_clks);
221 ufs_qcom_phy_init_vregulators(struct phy *generic_phy,
222 struct ufs_qcom_phy *phy_common)
226 err = ufs_qcom_phy_init_vreg(generic_phy, &phy_common->vdda_pll,
231 err = ufs_qcom_phy_init_vreg(generic_phy, &phy_common->vdda_phy,
237 /* vddp-ref-clk-* properties are optional */
238 __ufs_qcom_phy_init_vreg(generic_phy, &phy_common->vddp_ref_clk,
239 "vddp-ref-clk", true);
243 EXPORT_SYMBOL_GPL(ufs_qcom_phy_init_vregulators);
245 static int __ufs_qcom_phy_init_vreg(struct phy *phy,
246 struct ufs_qcom_phy_vreg *vreg, const char *name, bool optional)
249 struct ufs_qcom_phy *ufs_qcom_phy = get_ufs_qcom_phy(phy);
250 struct device *dev = ufs_qcom_phy->dev;
252 char prop_name[MAX_PROP_NAME];
254 vreg->name = kstrdup(name, GFP_KERNEL);
260 vreg->reg = devm_regulator_get(dev, name);
261 if (IS_ERR(vreg->reg)) {
262 err = PTR_ERR(vreg->reg);
265 dev_err(dev, "failed to get %s, %d\n", name, err);
270 snprintf(prop_name, MAX_PROP_NAME, "%s-max-microamp", name);
271 err = of_property_read_u32(dev->of_node,
272 prop_name, &vreg->max_uA);
273 if (err && err != -EINVAL) {
274 dev_err(dev, "%s: failed to read %s\n",
275 __func__, prop_name);
277 } else if (err == -EINVAL || !vreg->max_uA) {
278 if (regulator_count_voltages(vreg->reg) > 0) {
279 dev_err(dev, "%s: %s is mandatory\n",
280 __func__, prop_name);
285 snprintf(prop_name, MAX_PROP_NAME, "%s-always-on", name);
286 if (of_get_property(dev->of_node, prop_name, NULL))
287 vreg->is_always_on = true;
289 vreg->is_always_on = false;
292 if (!strcmp(name, "vdda-pll")) {
293 vreg->max_uV = VDDA_PLL_MAX_UV;
294 vreg->min_uV = VDDA_PLL_MIN_UV;
295 } else if (!strcmp(name, "vdda-phy")) {
296 vreg->max_uV = VDDA_PHY_MAX_UV;
297 vreg->min_uV = VDDA_PHY_MIN_UV;
298 } else if (!strcmp(name, "vddp-ref-clk")) {
299 vreg->max_uV = VDDP_REF_CLK_MAX_UV;
300 vreg->min_uV = VDDP_REF_CLK_MIN_UV;
309 static int ufs_qcom_phy_init_vreg(struct phy *phy,
310 struct ufs_qcom_phy_vreg *vreg, const char *name)
312 return __ufs_qcom_phy_init_vreg(phy, vreg, name, false);
316 int ufs_qcom_phy_cfg_vreg(struct phy *phy,
317 struct ufs_qcom_phy_vreg *vreg, bool on)
320 struct regulator *reg = vreg->reg;
321 const char *name = vreg->name;
324 struct ufs_qcom_phy *ufs_qcom_phy = get_ufs_qcom_phy(phy);
325 struct device *dev = ufs_qcom_phy->dev;
329 if (regulator_count_voltages(reg) > 0) {
330 min_uV = on ? vreg->min_uV : 0;
331 ret = regulator_set_voltage(reg, min_uV, vreg->max_uV);
333 dev_err(dev, "%s: %s set voltage failed, err=%d\n",
334 __func__, name, ret);
337 uA_load = on ? vreg->max_uA : 0;
338 ret = regulator_set_load(reg, uA_load);
341 * regulator_set_load() returns new regulator
346 dev_err(dev, "%s: %s set optimum mode(uA_load=%d) failed, err=%d\n",
347 __func__, name, uA_load, ret);
356 int ufs_qcom_phy_enable_vreg(struct phy *phy,
357 struct ufs_qcom_phy_vreg *vreg)
359 struct ufs_qcom_phy *ufs_qcom_phy = get_ufs_qcom_phy(phy);
360 struct device *dev = ufs_qcom_phy->dev;
363 if (!vreg || vreg->enabled)
366 ret = ufs_qcom_phy_cfg_vreg(phy, vreg, true);
368 dev_err(dev, "%s: ufs_qcom_phy_cfg_vreg() failed, err=%d\n",
373 ret = regulator_enable(vreg->reg);
375 dev_err(dev, "%s: enable failed, err=%d\n",
380 vreg->enabled = true;
385 int ufs_qcom_phy_enable_ref_clk(struct phy *generic_phy)
388 struct ufs_qcom_phy *phy = get_ufs_qcom_phy(generic_phy);
390 if (phy->is_ref_clk_enabled)
394 * reference clock is propagated in a daisy-chained manner from
395 * source to phy, so ungate them at each stage.
397 ret = clk_prepare_enable(phy->ref_clk_src);
399 dev_err(phy->dev, "%s: ref_clk_src enable failed %d\n",
405 * "ref_clk_parent" is optional clock hence make sure that clk reference
406 * is available before trying to enable the clock.
408 if (phy->ref_clk_parent) {
409 ret = clk_prepare_enable(phy->ref_clk_parent);
411 dev_err(phy->dev, "%s: ref_clk_parent enable failed %d\n",
413 goto out_disable_src;
417 ret = clk_prepare_enable(phy->ref_clk);
419 dev_err(phy->dev, "%s: ref_clk enable failed %d\n",
421 goto out_disable_parent;
424 phy->is_ref_clk_enabled = true;
428 if (phy->ref_clk_parent)
429 clk_disable_unprepare(phy->ref_clk_parent);
431 clk_disable_unprepare(phy->ref_clk_src);
435 EXPORT_SYMBOL_GPL(ufs_qcom_phy_enable_ref_clk);
438 int ufs_qcom_phy_disable_vreg(struct phy *phy,
439 struct ufs_qcom_phy_vreg *vreg)
441 struct ufs_qcom_phy *ufs_qcom_phy = get_ufs_qcom_phy(phy);
442 struct device *dev = ufs_qcom_phy->dev;
445 if (!vreg || !vreg->enabled || vreg->is_always_on)
448 ret = regulator_disable(vreg->reg);
451 /* ignore errors on applying disable config */
452 ufs_qcom_phy_cfg_vreg(phy, vreg, false);
453 vreg->enabled = false;
455 dev_err(dev, "%s: %s disable failed, err=%d\n",
456 __func__, vreg->name, ret);
462 void ufs_qcom_phy_disable_ref_clk(struct phy *generic_phy)
464 struct ufs_qcom_phy *phy = get_ufs_qcom_phy(generic_phy);
466 if (phy->is_ref_clk_enabled) {
467 clk_disable_unprepare(phy->ref_clk);
469 * "ref_clk_parent" is optional clock hence make sure that clk
470 * reference is available before trying to disable the clock.
472 if (phy->ref_clk_parent)
473 clk_disable_unprepare(phy->ref_clk_parent);
474 clk_disable_unprepare(phy->ref_clk_src);
475 phy->is_ref_clk_enabled = false;
478 EXPORT_SYMBOL_GPL(ufs_qcom_phy_disable_ref_clk);
480 #define UFS_REF_CLK_EN (1 << 5)
482 static void ufs_qcom_phy_dev_ref_clk_ctrl(struct phy *generic_phy, bool enable)
484 struct ufs_qcom_phy *phy = get_ufs_qcom_phy(generic_phy);
486 if (phy->dev_ref_clk_ctrl_mmio &&
487 (enable ^ phy->is_dev_ref_clk_enabled)) {
488 u32 temp = readl_relaxed(phy->dev_ref_clk_ctrl_mmio);
491 temp |= UFS_REF_CLK_EN;
493 temp &= ~UFS_REF_CLK_EN;
496 * If we are here to disable this clock immediately after
497 * entering into hibern8, we need to make sure that device
498 * ref_clk is active atleast 1us after the hibern8 enter.
503 writel_relaxed(temp, phy->dev_ref_clk_ctrl_mmio);
504 /* ensure that ref_clk is enabled/disabled before we return */
507 * If we call hibern8 exit after this, we need to make sure that
508 * device ref_clk is stable for atleast 1us before the hibern8
514 phy->is_dev_ref_clk_enabled = enable;
518 void ufs_qcom_phy_enable_dev_ref_clk(struct phy *generic_phy)
520 ufs_qcom_phy_dev_ref_clk_ctrl(generic_phy, true);
522 EXPORT_SYMBOL_GPL(ufs_qcom_phy_enable_dev_ref_clk);
524 void ufs_qcom_phy_disable_dev_ref_clk(struct phy *generic_phy)
526 ufs_qcom_phy_dev_ref_clk_ctrl(generic_phy, false);
528 EXPORT_SYMBOL_GPL(ufs_qcom_phy_disable_dev_ref_clk);
530 /* Turn ON M-PHY RMMI interface clocks */
531 int ufs_qcom_phy_enable_iface_clk(struct phy *generic_phy)
533 struct ufs_qcom_phy *phy = get_ufs_qcom_phy(generic_phy);
536 if (phy->is_iface_clk_enabled)
539 ret = clk_prepare_enable(phy->tx_iface_clk);
541 dev_err(phy->dev, "%s: tx_iface_clk enable failed %d\n",
545 ret = clk_prepare_enable(phy->rx_iface_clk);
547 clk_disable_unprepare(phy->tx_iface_clk);
548 dev_err(phy->dev, "%s: rx_iface_clk enable failed %d. disabling also tx_iface_clk\n",
552 phy->is_iface_clk_enabled = true;
557 EXPORT_SYMBOL_GPL(ufs_qcom_phy_enable_iface_clk);
559 /* Turn OFF M-PHY RMMI interface clocks */
560 void ufs_qcom_phy_disable_iface_clk(struct phy *generic_phy)
562 struct ufs_qcom_phy *phy = get_ufs_qcom_phy(generic_phy);
564 if (phy->is_iface_clk_enabled) {
565 clk_disable_unprepare(phy->tx_iface_clk);
566 clk_disable_unprepare(phy->rx_iface_clk);
567 phy->is_iface_clk_enabled = false;
570 EXPORT_SYMBOL_GPL(ufs_qcom_phy_disable_iface_clk);
572 int ufs_qcom_phy_start_serdes(struct phy *generic_phy)
574 struct ufs_qcom_phy *ufs_qcom_phy = get_ufs_qcom_phy(generic_phy);
577 if (!ufs_qcom_phy->phy_spec_ops->start_serdes) {
578 dev_err(ufs_qcom_phy->dev, "%s: start_serdes() callback is not supported\n",
582 ufs_qcom_phy->phy_spec_ops->start_serdes(ufs_qcom_phy);
587 EXPORT_SYMBOL_GPL(ufs_qcom_phy_start_serdes);
589 int ufs_qcom_phy_set_tx_lane_enable(struct phy *generic_phy, u32 tx_lanes)
591 struct ufs_qcom_phy *ufs_qcom_phy = get_ufs_qcom_phy(generic_phy);
594 if (!ufs_qcom_phy->phy_spec_ops->set_tx_lane_enable) {
595 dev_err(ufs_qcom_phy->dev, "%s: set_tx_lane_enable() callback is not supported\n",
599 ufs_qcom_phy->phy_spec_ops->set_tx_lane_enable(ufs_qcom_phy,
605 EXPORT_SYMBOL_GPL(ufs_qcom_phy_set_tx_lane_enable);
607 void ufs_qcom_phy_save_controller_version(struct phy *generic_phy,
608 u8 major, u16 minor, u16 step)
610 struct ufs_qcom_phy *ufs_qcom_phy = get_ufs_qcom_phy(generic_phy);
612 ufs_qcom_phy->host_ctrl_rev_major = major;
613 ufs_qcom_phy->host_ctrl_rev_minor = minor;
614 ufs_qcom_phy->host_ctrl_rev_step = step;
616 EXPORT_SYMBOL_GPL(ufs_qcom_phy_save_controller_version);
618 int ufs_qcom_phy_calibrate_phy(struct phy *generic_phy, bool is_rate_B)
620 struct ufs_qcom_phy *ufs_qcom_phy = get_ufs_qcom_phy(generic_phy);
623 if (!ufs_qcom_phy->phy_spec_ops->calibrate_phy) {
624 dev_err(ufs_qcom_phy->dev, "%s: calibrate_phy() callback is not supported\n",
628 ret = ufs_qcom_phy->phy_spec_ops->
629 calibrate_phy(ufs_qcom_phy, is_rate_B);
631 dev_err(ufs_qcom_phy->dev, "%s: calibrate_phy() failed %d\n",
637 EXPORT_SYMBOL_GPL(ufs_qcom_phy_calibrate_phy);
639 int ufs_qcom_phy_remove(struct phy *generic_phy,
640 struct ufs_qcom_phy *ufs_qcom_phy)
642 phy_power_off(generic_phy);
644 kfree(ufs_qcom_phy->vdda_pll.name);
645 kfree(ufs_qcom_phy->vdda_phy.name);
649 EXPORT_SYMBOL_GPL(ufs_qcom_phy_remove);
651 int ufs_qcom_phy_exit(struct phy *generic_phy)
653 struct ufs_qcom_phy *ufs_qcom_phy = get_ufs_qcom_phy(generic_phy);
655 if (ufs_qcom_phy->is_powered_on)
656 phy_power_off(generic_phy);
660 EXPORT_SYMBOL_GPL(ufs_qcom_phy_exit);
662 int ufs_qcom_phy_is_pcs_ready(struct phy *generic_phy)
664 struct ufs_qcom_phy *ufs_qcom_phy = get_ufs_qcom_phy(generic_phy);
666 if (!ufs_qcom_phy->phy_spec_ops->is_physical_coding_sublayer_ready) {
667 dev_err(ufs_qcom_phy->dev, "%s: is_physical_coding_sublayer_ready() callback is not supported\n",
672 return ufs_qcom_phy->phy_spec_ops->
673 is_physical_coding_sublayer_ready(ufs_qcom_phy);
675 EXPORT_SYMBOL_GPL(ufs_qcom_phy_is_pcs_ready);
677 int ufs_qcom_phy_power_on(struct phy *generic_phy)
679 struct ufs_qcom_phy *phy_common = get_ufs_qcom_phy(generic_phy);
680 struct device *dev = phy_common->dev;
683 err = ufs_qcom_phy_enable_vreg(generic_phy, &phy_common->vdda_phy);
685 dev_err(dev, "%s enable vdda_phy failed, err=%d\n",
690 phy_common->phy_spec_ops->power_control(phy_common, true);
692 /* vdda_pll also enables ref clock LDOs so enable it first */
693 err = ufs_qcom_phy_enable_vreg(generic_phy, &phy_common->vdda_pll);
695 dev_err(dev, "%s enable vdda_pll failed, err=%d\n",
697 goto out_disable_phy;
700 err = ufs_qcom_phy_enable_ref_clk(generic_phy);
702 dev_err(dev, "%s enable phy ref clock failed, err=%d\n",
704 goto out_disable_pll;
707 /* enable device PHY ref_clk pad rail */
708 if (phy_common->vddp_ref_clk.reg) {
709 err = ufs_qcom_phy_enable_vreg(generic_phy,
710 &phy_common->vddp_ref_clk);
712 dev_err(dev, "%s enable vddp_ref_clk failed, err=%d\n",
714 goto out_disable_ref_clk;
718 phy_common->is_powered_on = true;
722 ufs_qcom_phy_disable_ref_clk(generic_phy);
724 ufs_qcom_phy_disable_vreg(generic_phy, &phy_common->vdda_pll);
726 ufs_qcom_phy_disable_vreg(generic_phy, &phy_common->vdda_phy);
730 EXPORT_SYMBOL_GPL(ufs_qcom_phy_power_on);
732 int ufs_qcom_phy_power_off(struct phy *generic_phy)
734 struct ufs_qcom_phy *phy_common = get_ufs_qcom_phy(generic_phy);
736 phy_common->phy_spec_ops->power_control(phy_common, false);
738 if (phy_common->vddp_ref_clk.reg)
739 ufs_qcom_phy_disable_vreg(generic_phy,
740 &phy_common->vddp_ref_clk);
741 ufs_qcom_phy_disable_ref_clk(generic_phy);
743 ufs_qcom_phy_disable_vreg(generic_phy, &phy_common->vdda_pll);
744 ufs_qcom_phy_disable_vreg(generic_phy, &phy_common->vdda_phy);
745 phy_common->is_powered_on = false;
749 EXPORT_SYMBOL_GPL(ufs_qcom_phy_power_off);