root/drivers/phy/qualcomm/phy-qcom-eusb2-repeater.c
// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2023, Linaro Limited
 */

#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/regulator/consumer.h>
#include <linux/regmap.h>
#include <linux/of.h>
#include <linux/phy/phy.h>

/* eUSB2 status registers */
#define EUSB2_RPTR_STATUS               0x08
#define RPTR_OK                         BIT(7)

/* eUSB2 control registers */
#define EUSB2_EN_CTL1                   0x46
#define EUSB2_RPTR_EN                   BIT(7)

#define EUSB2_FORCE_EN_5                0xe8
#define F_CLK_19P2M_EN                  BIT(6)

#define EUSB2_FORCE_VAL_5               0xeD
#define V_CLK_19P2M_EN                  BIT(6)

#define EUSB2_TUNE_USB2_CROSSOVER       0x50
#define EUSB2_TUNE_IUSB2                0x51
#define EUSB2_TUNE_RES_FSDIF            0x52
#define EUSB2_TUNE_HSDISC               0x53
#define EUSB2_TUNE_SQUELCH_U            0x54
#define EUSB2_TUNE_USB2_SLEW            0x55
#define EUSB2_TUNE_USB2_EQU             0x56
#define EUSB2_TUNE_USB2_PREEM           0x57
#define EUSB2_TUNE_USB2_HS_COMP_CUR     0x58
#define EUSB2_TUNE_EUSB_SLEW            0x59
#define EUSB2_TUNE_EUSB_EQU             0x5A
#define EUSB2_TUNE_EUSB_HS_COMP_CUR     0x5B

static const int squelch_detector[] = {
        [0] = -6000,
        [1] = -5000,
        [2] = -4000,
        [3] = -3000,
        [4] = -2000,
        [5] = -1000,
        [6] = 0,
        [7] = 1000,
};

struct eusb2_repeater_init_tbl_reg {
        unsigned int reg;
        unsigned int value;
};

struct eusb2_repeater_cfg {
        const struct eusb2_repeater_init_tbl_reg *init_tbl;
        int init_tbl_num;
        const char * const *vreg_list;
        int num_vregs;
};

struct eusb2_repeater {
        struct device *dev;
        struct regmap *regmap;
        struct phy *phy;
        struct regulator_bulk_data *vregs;
        const struct eusb2_repeater_cfg *cfg;
        u32 base;
        enum phy_mode mode;
};

static const char * const pm8550b_vreg_l[] = {
        "vdd18", "vdd3",
};

static const struct eusb2_repeater_init_tbl_reg pm8550b_init_tbl[] = {
        { EUSB2_TUNE_IUSB2, 0x8 },
        { EUSB2_TUNE_SQUELCH_U, 0x3 },
        { EUSB2_TUNE_USB2_PREEM, 0x5 },
};

static const struct eusb2_repeater_init_tbl_reg smb2360_init_tbl[] = {
        { EUSB2_TUNE_IUSB2, 0x5 },
        { EUSB2_TUNE_SQUELCH_U, 0x3 },
        { EUSB2_TUNE_USB2_PREEM, 0x2 },
};

static const struct eusb2_repeater_init_tbl_reg smb2370_init_tbl[] = {
        { EUSB2_TUNE_IUSB2, 0x4 },
        { EUSB2_TUNE_SQUELCH_U, 0x3 },
        { EUSB2_TUNE_USB2_SLEW, 0x7 },
        { EUSB2_TUNE_USB2_PREEM, 0x0 },
};

static const struct eusb2_repeater_cfg pm8550b_eusb2_cfg = {
        .init_tbl       = pm8550b_init_tbl,
        .init_tbl_num   = ARRAY_SIZE(pm8550b_init_tbl),
        .vreg_list      = pm8550b_vreg_l,
        .num_vregs      = ARRAY_SIZE(pm8550b_vreg_l),
};

static const struct eusb2_repeater_cfg pmiv0104_eusb2_cfg = {
        /* No PMIC-specific init sequence, only board level tuning via DT */
        .init_tbl       = (struct eusb2_repeater_init_tbl_reg[]) {},
        .init_tbl_num   = 0,
        .vreg_list      = pm8550b_vreg_l,
        .num_vregs      = ARRAY_SIZE(pm8550b_vreg_l),
};

static const struct eusb2_repeater_cfg smb2360_eusb2_cfg = {
        .init_tbl       = smb2360_init_tbl,
        .init_tbl_num   = ARRAY_SIZE(smb2360_init_tbl),
        .vreg_list      = pm8550b_vreg_l,
        .num_vregs      = ARRAY_SIZE(pm8550b_vreg_l),
};

static const struct eusb2_repeater_cfg smb2370_eusb2_cfg = {
        .init_tbl       = smb2370_init_tbl,
        .init_tbl_num   = ARRAY_SIZE(smb2370_init_tbl),
        .vreg_list      = pm8550b_vreg_l,
        .num_vregs      = ARRAY_SIZE(pm8550b_vreg_l),
};

static int eusb2_repeater_init_vregs(struct eusb2_repeater *rptr)
{
        int num = rptr->cfg->num_vregs;
        struct device *dev = rptr->dev;
        int i;

        rptr->vregs = devm_kcalloc(dev, num, sizeof(*rptr->vregs), GFP_KERNEL);
        if (!rptr->vregs)
                return -ENOMEM;

        for (i = 0; i < num; i++)
                rptr->vregs[i].supply = rptr->cfg->vreg_list[i];

        return devm_regulator_bulk_get(dev, num, rptr->vregs);
}

static int eusb2_repeater_init(struct phy *phy)
{
        struct eusb2_repeater *rptr = phy_get_drvdata(phy);
        struct device_node *np = rptr->dev->of_node;
        struct regmap *regmap = rptr->regmap;
        u32 base = rptr->base;
        u32 poll_val;
        s32 dt_val;
        int ret;
        int i;
        u8 val;

        ret = regulator_bulk_enable(rptr->cfg->num_vregs, rptr->vregs);
        if (ret)
                return ret;

        regmap_write(regmap, base + EUSB2_EN_CTL1, EUSB2_RPTR_EN);

        /* Write registers from init table */
        for (int i = 0; i < rptr->cfg->init_tbl_num; i++)
                regmap_write(regmap, base + rptr->cfg->init_tbl[i].reg,
                             rptr->cfg->init_tbl[i].value);

        /* Override registers from devicetree values */
        if (!of_property_read_u8(np, "qcom,tune-usb2-preem", &val))
                regmap_write(regmap, base + EUSB2_TUNE_USB2_PREEM, val);

        if (!of_property_read_u8(np, "qcom,tune-usb2-disc-thres", &val))
                regmap_write(regmap, base + EUSB2_TUNE_HSDISC, val);

        if (!of_property_read_u8(np, "qcom,tune-usb2-amplitude", &val))
                regmap_write(regmap, base + EUSB2_TUNE_IUSB2, val);

        if (!of_property_read_u8(np, "qcom,tune-res-fsdif", &val))
                regmap_write(regmap, base + EUSB2_TUNE_RES_FSDIF, val);

        if (!of_property_read_s32(np, "qcom,squelch-detector-bp", &dt_val)) {
                for (i = 0; i < ARRAY_SIZE(squelch_detector); i++) {
                        if (squelch_detector[i] == dt_val) {
                                regmap_write(regmap, base + EUSB2_TUNE_SQUELCH_U, i);
                                break;
                        }
                }
        }

        /* Wait for status OK */
        ret = regmap_read_poll_timeout(regmap, base + EUSB2_RPTR_STATUS, poll_val,
                                       poll_val & RPTR_OK, 10, 5);
        if (ret)
                dev_err(rptr->dev, "initialization timed-out\n");

        return ret;
}

static int eusb2_repeater_set_mode(struct phy *phy,
                                   enum phy_mode mode, int submode)
{
        struct eusb2_repeater *rptr = phy_get_drvdata(phy);
        struct regmap *regmap = rptr->regmap;
        u32 base = rptr->base;

        switch (mode) {
        case PHY_MODE_USB_HOST:
                /*
                 * CM.Lx is prohibited when repeater is already into Lx state as
                 * per eUSB 1.2 Spec. Below implement software workaround until
                 * PHY and controller is fixing seen observation.
                 */
                regmap_write(regmap, base + EUSB2_FORCE_EN_5, F_CLK_19P2M_EN);
                regmap_write(regmap, base + EUSB2_FORCE_VAL_5, V_CLK_19P2M_EN);
                break;
        case PHY_MODE_USB_DEVICE:
                /*
                 * In device mode clear host mode related workaround as there
                 * is no repeater reset available, and enable/disable of
                 * repeater doesn't clear previous value due to shared
                 * regulators (say host <-> device mode switch).
                 */
                regmap_write(regmap, base + EUSB2_FORCE_EN_5, 0);
                regmap_write(regmap, base + EUSB2_FORCE_VAL_5, 0);
                break;
        default:
                return -EINVAL;
        }

        return 0;
}

static int eusb2_repeater_exit(struct phy *phy)
{
        struct eusb2_repeater *rptr = phy_get_drvdata(phy);

        return regulator_bulk_disable(rptr->cfg->num_vregs, rptr->vregs);
}

static const struct phy_ops eusb2_repeater_ops = {
        .init           = eusb2_repeater_init,
        .exit           = eusb2_repeater_exit,
        .set_mode       = eusb2_repeater_set_mode,
        .owner          = THIS_MODULE,
};

static int eusb2_repeater_probe(struct platform_device *pdev)
{
        struct eusb2_repeater *rptr;
        struct device *dev = &pdev->dev;
        struct phy_provider *phy_provider;
        struct device_node *np = dev->of_node;
        u32 res;
        int ret;

        rptr = devm_kzalloc(dev, sizeof(*rptr), GFP_KERNEL);
        if (!rptr)
                return -ENOMEM;

        rptr->dev = dev;
        dev_set_drvdata(dev, rptr);

        rptr->cfg = of_device_get_match_data(dev);
        if (!rptr->cfg)
                return -EINVAL;

        rptr->regmap = dev_get_regmap(dev->parent, NULL);
        if (!rptr->regmap)
                return -ENODEV;

        ret = of_property_read_u32(np, "reg", &res);
        if (ret < 0)
                return ret;

        rptr->base = res;

        ret = eusb2_repeater_init_vregs(rptr);
        if (ret < 0) {
                dev_err(dev, "unable to get supplies\n");
                return ret;
        }

        rptr->phy = devm_phy_create(dev, np, &eusb2_repeater_ops);
        if (IS_ERR(rptr->phy)) {
                dev_err(dev, "failed to create PHY: %d\n", ret);
                return PTR_ERR(rptr->phy);
        }

        phy_set_drvdata(rptr->phy, rptr);

        phy_provider = devm_of_phy_provider_register(dev, of_phy_simple_xlate);
        if (IS_ERR(phy_provider))
                return PTR_ERR(phy_provider);

        return 0;
}

static void eusb2_repeater_remove(struct platform_device *pdev)
{
        struct eusb2_repeater *rptr = platform_get_drvdata(pdev);

        if (!rptr)
                return;

        eusb2_repeater_exit(rptr->phy);
}

static const struct of_device_id eusb2_repeater_of_match_table[] = {
        {
                .compatible = "qcom,pm8550b-eusb2-repeater",
                .data = &pm8550b_eusb2_cfg,
        },
        {
                .compatible = "qcom,pmiv0104-eusb2-repeater",
                .data = &pmiv0104_eusb2_cfg,
        },
        {
                .compatible = "qcom,smb2360-eusb2-repeater",
                .data = &smb2360_eusb2_cfg,
        },
        {
                .compatible = "qcom,smb2370-eusb2-repeater",
                .data = &smb2370_eusb2_cfg,
        },
        { },
};
MODULE_DEVICE_TABLE(of, eusb2_repeater_of_match_table);

static struct platform_driver eusb2_repeater_driver = {
        .probe          = eusb2_repeater_probe,
        .remove         = eusb2_repeater_remove,
        .driver = {
                .name   = "qcom-eusb2-repeater",
                .of_match_table = eusb2_repeater_of_match_table,
        },
};

module_platform_driver(eusb2_repeater_driver);

MODULE_DESCRIPTION("Qualcomm PMIC eUSB2 Repeater driver");
MODULE_LICENSE("GPL");