root/drivers/regulator/mt6360-regulator.c
// SPDX-License-Identifier: GPL-2.0-only
//
// Copyright (C) 2020 MediaTek Inc.
//
// Author: Gene Chen <gene_chen@richtek.com>

#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/regmap.h>
#include <linux/regulator/driver.h>
#include <linux/regulator/machine.h>

#include <dt-bindings/regulator/mediatek,mt6360-regulator.h>

enum {
        MT6360_REGULATOR_BUCK1 = 0,
        MT6360_REGULATOR_BUCK2,
        MT6360_REGULATOR_LDO6,
        MT6360_REGULATOR_LDO7,
        MT6360_REGULATOR_LDO1,
        MT6360_REGULATOR_LDO2,
        MT6360_REGULATOR_LDO3,
        MT6360_REGULATOR_LDO5,
        MT6360_REGULATOR_MAX,
};

struct mt6360_irq_mapping {
        const char *name;
        irq_handler_t handler;
};

struct mt6360_regulator_desc {
        const struct regulator_desc desc;
        unsigned int mode_reg;
        unsigned int mode_mask;
        unsigned int state_reg;
        unsigned int state_mask;
        const struct mt6360_irq_mapping *irq_tables;
        int irq_table_size;
};

struct mt6360_regulator_data {
        struct device *dev;
        struct regmap *regmap;
};

static irqreturn_t mt6360_pgb_event_handler(int irq, void *data)
{
        struct regulator_dev *rdev = data;

        regulator_notifier_call_chain(rdev, REGULATOR_EVENT_FAIL, NULL);
        return IRQ_HANDLED;
}

static irqreturn_t mt6360_oc_event_handler(int irq, void *data)
{
        struct regulator_dev *rdev = data;

        regulator_notifier_call_chain(rdev, REGULATOR_EVENT_OVER_CURRENT, NULL);
        return IRQ_HANDLED;
}

static irqreturn_t mt6360_ov_event_handler(int irq, void *data)
{
        struct regulator_dev *rdev = data;

        regulator_notifier_call_chain(rdev, REGULATOR_EVENT_REGULATION_OUT, NULL);
        return IRQ_HANDLED;
}

static irqreturn_t mt6360_uv_event_handler(int irq, void *data)
{
        struct regulator_dev *rdev = data;

        regulator_notifier_call_chain(rdev, REGULATOR_EVENT_UNDER_VOLTAGE, NULL);
        return IRQ_HANDLED;
}

static const struct mt6360_irq_mapping buck1_irq_tbls[] = {
        { "buck1_pgb_evt", mt6360_pgb_event_handler },
        { "buck1_oc_evt", mt6360_oc_event_handler },
        { "buck1_ov_evt", mt6360_ov_event_handler },
        { "buck1_uv_evt", mt6360_uv_event_handler },
};

static const struct mt6360_irq_mapping buck2_irq_tbls[] = {
        { "buck2_pgb_evt", mt6360_pgb_event_handler },
        { "buck2_oc_evt", mt6360_oc_event_handler },
        { "buck2_ov_evt", mt6360_ov_event_handler },
        { "buck2_uv_evt", mt6360_uv_event_handler },
};

static const struct mt6360_irq_mapping ldo6_irq_tbls[] = {
        { "ldo6_pgb_evt", mt6360_pgb_event_handler },
        { "ldo6_oc_evt", mt6360_oc_event_handler },
};

static const struct mt6360_irq_mapping ldo7_irq_tbls[] = {
        { "ldo7_pgb_evt", mt6360_pgb_event_handler },
        { "ldo7_oc_evt", mt6360_oc_event_handler },
};

static const struct mt6360_irq_mapping ldo1_irq_tbls[] = {
        { "ldo1_pgb_evt", mt6360_pgb_event_handler },
        { "ldo1_oc_evt", mt6360_oc_event_handler },
};

static const struct mt6360_irq_mapping ldo2_irq_tbls[] = {
        { "ldo2_pgb_evt", mt6360_pgb_event_handler },
        { "ldo2_oc_evt", mt6360_oc_event_handler },
};

static const struct mt6360_irq_mapping ldo3_irq_tbls[] = {
        { "ldo3_pgb_evt", mt6360_pgb_event_handler },
        { "ldo3_oc_evt", mt6360_oc_event_handler },
};

static const struct mt6360_irq_mapping ldo5_irq_tbls[] = {
        { "ldo5_pgb_evt", mt6360_pgb_event_handler },
        { "ldo5_oc_evt", mt6360_oc_event_handler },
};

static const struct linear_range buck_vout_ranges[] = {
        REGULATOR_LINEAR_RANGE(300000, 0x00, 0xc7, 5000),
        REGULATOR_LINEAR_RANGE(1300000, 0xc8, 0xff, 0),
};

static const struct linear_range ldo_vout_ranges1[] = {
        REGULATOR_LINEAR_RANGE(500000, 0x00, 0x09, 10000),
        REGULATOR_LINEAR_RANGE(600000, 0x0a, 0x10, 0),
        REGULATOR_LINEAR_RANGE(610000, 0x11, 0x19, 10000),
        REGULATOR_LINEAR_RANGE(700000, 0x1a, 0x20, 0),
        REGULATOR_LINEAR_RANGE(710000, 0x21, 0x29, 10000),
        REGULATOR_LINEAR_RANGE(800000, 0x2a, 0x30, 0),
        REGULATOR_LINEAR_RANGE(810000, 0x31, 0x39, 10000),
        REGULATOR_LINEAR_RANGE(900000, 0x3a, 0x40, 0),
        REGULATOR_LINEAR_RANGE(910000, 0x41, 0x49, 10000),
        REGULATOR_LINEAR_RANGE(1000000, 0x4a, 0x50, 0),
        REGULATOR_LINEAR_RANGE(1010000, 0x51, 0x59, 10000),
        REGULATOR_LINEAR_RANGE(1100000, 0x5a, 0x60, 0),
        REGULATOR_LINEAR_RANGE(1110000, 0x61, 0x69, 10000),
        REGULATOR_LINEAR_RANGE(1200000, 0x6a, 0x70, 0),
        REGULATOR_LINEAR_RANGE(1210000, 0x71, 0x79, 10000),
        REGULATOR_LINEAR_RANGE(1300000, 0x7a, 0x80, 0),
        REGULATOR_LINEAR_RANGE(1310000, 0x81, 0x89, 10000),
        REGULATOR_LINEAR_RANGE(1400000, 0x8a, 0x90, 0),
        REGULATOR_LINEAR_RANGE(1410000, 0x91, 0x99, 10000),
        REGULATOR_LINEAR_RANGE(1500000, 0x9a, 0xa0, 0),
        REGULATOR_LINEAR_RANGE(1510000, 0xa1, 0xa9, 10000),
        REGULATOR_LINEAR_RANGE(1600000, 0xaa, 0xb0, 0),
        REGULATOR_LINEAR_RANGE(1610000, 0xb1, 0xb9, 10000),
        REGULATOR_LINEAR_RANGE(1700000, 0xba, 0xc0, 0),
        REGULATOR_LINEAR_RANGE(1710000, 0xc1, 0xc9, 10000),
        REGULATOR_LINEAR_RANGE(1800000, 0xca, 0xd0, 0),
        REGULATOR_LINEAR_RANGE(1810000, 0xd1, 0xd9, 10000),
        REGULATOR_LINEAR_RANGE(1900000, 0xda, 0xe0, 0),
        REGULATOR_LINEAR_RANGE(1910000, 0xe1, 0xe9, 10000),
        REGULATOR_LINEAR_RANGE(2000000, 0xea, 0xf0, 0),
        REGULATOR_LINEAR_RANGE(2010000, 0xf1, 0xf9, 10000),
        REGULATOR_LINEAR_RANGE(2100000, 0xfa, 0xff, 0),
};

static const struct linear_range ldo_vout_ranges2[] = {
        REGULATOR_LINEAR_RANGE(1200000, 0x00, 0x09, 10000),
        REGULATOR_LINEAR_RANGE(1300000, 0x0a, 0x10, 0),
        REGULATOR_LINEAR_RANGE(1310000, 0x11, 0x19, 10000),
        REGULATOR_LINEAR_RANGE(1400000, 0x1a, 0x1f, 0),
        REGULATOR_LINEAR_RANGE(1500000, 0x20, 0x29, 10000),
        REGULATOR_LINEAR_RANGE(1600000, 0x2a, 0x2f, 0),
        REGULATOR_LINEAR_RANGE(1700000, 0x30, 0x39, 10000),
        REGULATOR_LINEAR_RANGE(1800000, 0x3a, 0x40, 0),
        REGULATOR_LINEAR_RANGE(1810000, 0x41, 0x49, 10000),
        REGULATOR_LINEAR_RANGE(1900000, 0x4a, 0x4f, 0),
        REGULATOR_LINEAR_RANGE(2000000, 0x50, 0x59, 10000),
        REGULATOR_LINEAR_RANGE(2100000, 0x5a, 0x60, 0),
        REGULATOR_LINEAR_RANGE(2110000, 0x61, 0x69, 10000),
        REGULATOR_LINEAR_RANGE(2200000, 0x6a, 0x6f, 0),
        REGULATOR_LINEAR_RANGE(2500000, 0x70, 0x79, 10000),
        REGULATOR_LINEAR_RANGE(2600000, 0x7a, 0x7f, 0),
        REGULATOR_LINEAR_RANGE(2700000, 0x80, 0x89, 10000),
        REGULATOR_LINEAR_RANGE(2800000, 0x8a, 0x90, 0),
        REGULATOR_LINEAR_RANGE(2810000, 0x91, 0x99, 10000),
        REGULATOR_LINEAR_RANGE(2900000, 0x9a, 0xa0, 0),
        REGULATOR_LINEAR_RANGE(2910000, 0xa1, 0xa9, 10000),
        REGULATOR_LINEAR_RANGE(3000000, 0xaa, 0xb0, 0),
        REGULATOR_LINEAR_RANGE(3010000, 0xb1, 0xb9, 10000),
        REGULATOR_LINEAR_RANGE(3100000, 0xba, 0xc0, 0),
        REGULATOR_LINEAR_RANGE(3110000, 0xc1, 0xc9, 10000),
        REGULATOR_LINEAR_RANGE(3200000, 0xca, 0xcf, 0),
        REGULATOR_LINEAR_RANGE(3300000, 0xd0, 0xd9, 10000),
        REGULATOR_LINEAR_RANGE(3400000, 0xda, 0xe0, 0),
        REGULATOR_LINEAR_RANGE(3410000, 0xe1, 0xe9, 10000),
        REGULATOR_LINEAR_RANGE(3500000, 0xea, 0xf0, 0),
        REGULATOR_LINEAR_RANGE(3510000, 0xf1, 0xf9, 10000),
        REGULATOR_LINEAR_RANGE(3600000, 0xfa, 0xff, 0),
};

static const struct linear_range ldo_vout_ranges3[] = {
        REGULATOR_LINEAR_RANGE(2700000, 0x00, 0x09, 10000),
        REGULATOR_LINEAR_RANGE(2800000, 0x0a, 0x10, 0),
        REGULATOR_LINEAR_RANGE(2810000, 0x11, 0x19, 10000),
        REGULATOR_LINEAR_RANGE(2900000, 0x1a, 0x20, 0),
        REGULATOR_LINEAR_RANGE(2910000, 0x21, 0x29, 10000),
        REGULATOR_LINEAR_RANGE(3000000, 0x2a, 0x30, 0),
        REGULATOR_LINEAR_RANGE(3010000, 0x31, 0x39, 10000),
        REGULATOR_LINEAR_RANGE(3100000, 0x3a, 0x40, 0),
        REGULATOR_LINEAR_RANGE(3110000, 0x41, 0x49, 10000),
        REGULATOR_LINEAR_RANGE(3200000, 0x4a, 0x4f, 0),
        REGULATOR_LINEAR_RANGE(3300000, 0x50, 0x59, 10000),
        REGULATOR_LINEAR_RANGE(3400000, 0x5a, 0x60, 0),
        REGULATOR_LINEAR_RANGE(3410000, 0x61, 0x69, 10000),
        REGULATOR_LINEAR_RANGE(3500000, 0x6a, 0x70, 0),
        REGULATOR_LINEAR_RANGE(3510000, 0x71, 0x79, 10000),
        REGULATOR_LINEAR_RANGE(3600000, 0x7a, 0x7f, 0),
};

static int mt6360_regulator_set_mode(struct regulator_dev *rdev,
                                     unsigned int mode)
{
        const struct mt6360_regulator_desc *rdesc = (struct mt6360_regulator_desc *)rdev->desc;
        struct regmap *regmap = rdev_get_regmap(rdev);
        int shift = ffs(rdesc->mode_mask) - 1;
        unsigned int val;
        int ret;

        switch (mode) {
        case REGULATOR_MODE_NORMAL:
                val = MT6360_OPMODE_NORMAL;
                break;
        case REGULATOR_MODE_STANDBY:
                val = MT6360_OPMODE_ULP;
                break;
        case REGULATOR_MODE_IDLE:
                val = MT6360_OPMODE_LP;
                break;
        default:
                return -EINVAL;
        }

        ret = regmap_update_bits(regmap, rdesc->mode_reg, rdesc->mode_mask, val << shift);
        if (ret) {
                dev_err(&rdev->dev, "%s: fail (%d)\n", __func__, ret);
                return ret;
        }

        return 0;
}

static unsigned int mt6360_regulator_get_mode(struct regulator_dev *rdev)
{
        const struct mt6360_regulator_desc *rdesc = (struct mt6360_regulator_desc *)rdev->desc;
        struct regmap *regmap = rdev_get_regmap(rdev);
        int shift = ffs(rdesc->mode_mask) - 1;
        unsigned int val;
        int ret;

        ret = regmap_read(regmap, rdesc->mode_reg, &val);
        if (ret)
                return ret;

        val &= rdesc->mode_mask;
        val >>= shift;

        switch (val) {
        case MT6360_OPMODE_LP:
                return REGULATOR_MODE_IDLE;
        case MT6360_OPMODE_ULP:
                return REGULATOR_MODE_STANDBY;
        case MT6360_OPMODE_NORMAL:
                return REGULATOR_MODE_NORMAL;
        default:
                return -EINVAL;
        }
}

static int mt6360_regulator_get_status(struct regulator_dev *rdev)
{
        const struct mt6360_regulator_desc *rdesc = (struct mt6360_regulator_desc *)rdev->desc;
        struct regmap *regmap = rdev_get_regmap(rdev);
        unsigned int val;
        int ret;

        ret = regmap_read(regmap, rdesc->state_reg, &val);
        if (ret)
                return ret;

        if (val & rdesc->state_mask)
                return REGULATOR_STATUS_ON;

        return REGULATOR_STATUS_OFF;
}

static const struct regulator_ops mt6360_regulator_ops = {
        .list_voltage = regulator_list_voltage_linear_range,
        .enable = regulator_enable_regmap,
        .disable = regulator_disable_regmap,
        .is_enabled = regulator_is_enabled_regmap,
        .set_voltage_sel = regulator_set_voltage_sel_regmap,
        .get_voltage_sel = regulator_get_voltage_sel_regmap,
        .set_mode = mt6360_regulator_set_mode,
        .get_mode = mt6360_regulator_get_mode,
        .get_status = mt6360_regulator_get_status,
};

static unsigned int mt6360_regulator_of_map_mode(unsigned int hw_mode)
{
        switch (hw_mode) {
        case MT6360_OPMODE_NORMAL:
                return REGULATOR_MODE_NORMAL;
        case MT6360_OPMODE_LP:
                return REGULATOR_MODE_IDLE;
        case MT6360_OPMODE_ULP:
                return REGULATOR_MODE_STANDBY;
        default:
                return REGULATOR_MODE_INVALID;
        }
}

#define MT6360_REGULATOR_DESC(match, _name, _sname, ereg, emask, vreg,  \
                              vmask, mreg, mmask, streg, stmask,        \
                              vranges, vcnts, offon_delay, irq_tbls)    \
{                                                                       \
        .desc = {                                                       \
                .name = #_name,                                         \
                .supply_name = #_sname,                                 \
                .id =  MT6360_REGULATOR_##_name,                        \
                .of_match = of_match_ptr(match),                        \
                .regulators_node = of_match_ptr("regulator"),           \
                .of_map_mode = mt6360_regulator_of_map_mode,            \
                .owner = THIS_MODULE,                                   \
                .ops = &mt6360_regulator_ops,                           \
                .type = REGULATOR_VOLTAGE,                              \
                .vsel_reg = vreg,                                       \
                .vsel_mask = vmask,                                     \
                .enable_reg = ereg,                                     \
                .enable_mask = emask,                                   \
                .linear_ranges = vranges,                               \
                .n_linear_ranges = ARRAY_SIZE(vranges),                 \
                .n_voltages = vcnts,                                    \
                .off_on_delay = offon_delay,                            \
        },                                                              \
        .mode_reg = mreg,                                               \
        .mode_mask = mmask,                                             \
        .state_reg = streg,                                             \
        .state_mask = stmask,                                           \
        .irq_tables = irq_tbls,                                         \
        .irq_table_size = ARRAY_SIZE(irq_tbls),                         \
}

static const struct mt6360_regulator_desc mt6360_regulator_descs[] =  {
        MT6360_REGULATOR_DESC("buck1", BUCK1, BUCK1_VIN,
                              0x117, 0x40, 0x110, 0xff, 0x117, 0x30, 0x117, 0x04,
                              buck_vout_ranges, 256, 0, buck1_irq_tbls),
        MT6360_REGULATOR_DESC("buck2", BUCK2, BUCK2_VIN,
                              0x127, 0x40, 0x120, 0xff, 0x127, 0x30, 0x127, 0x04,
                              buck_vout_ranges, 256, 0, buck2_irq_tbls),
        MT6360_REGULATOR_DESC("ldo6", LDO6, LDO_VIN3,
                              0x137, 0x40, 0x13B, 0xff, 0x137, 0x30, 0x137, 0x04,
                              ldo_vout_ranges1, 256, 0, ldo6_irq_tbls),
        MT6360_REGULATOR_DESC("ldo7", LDO7, LDO_VIN3,
                              0x131, 0x40, 0x135, 0xff, 0x131, 0x30, 0x131, 0x04,
                              ldo_vout_ranges1, 256, 0, ldo7_irq_tbls),
        MT6360_REGULATOR_DESC("ldo1", LDO1, LDO_VIN1,
                              0x217, 0x40, 0x21B, 0xff, 0x217, 0x30, 0x217, 0x04,
                              ldo_vout_ranges2, 256, 0, ldo1_irq_tbls),
        MT6360_REGULATOR_DESC("ldo2", LDO2, LDO_VIN1,
                              0x211, 0x40, 0x215, 0xff, 0x211, 0x30, 0x211, 0x04,
                              ldo_vout_ranges2, 256, 0, ldo2_irq_tbls),
        MT6360_REGULATOR_DESC("ldo3", LDO3, LDO_VIN1,
                              0x205, 0x40, 0x209, 0xff, 0x205, 0x30, 0x205, 0x04,
                              ldo_vout_ranges2, 256, 100, ldo3_irq_tbls),
        MT6360_REGULATOR_DESC("ldo5", LDO5, LDO_VIN2,
                              0x20B, 0x40, 0x20F, 0x7f, 0x20B, 0x30, 0x20B, 0x04,
                              ldo_vout_ranges3, 128, 100, ldo5_irq_tbls),
};

static int mt6360_regulator_irq_register(struct platform_device *pdev,
                                         struct regulator_dev *rdev,
                                         const struct mt6360_irq_mapping *tbls,
                                         int tbl_size)
{
        int i, irq, ret;

        for (i = 0; i < tbl_size; i++) {
                const struct mt6360_irq_mapping *irq_desc = tbls + i;

                irq = platform_get_irq_byname(pdev, irq_desc->name);
                if (irq < 0)
                        return irq;

                ret = devm_request_threaded_irq(&pdev->dev, irq, NULL, irq_desc->handler, 0,
                                                irq_desc->name, rdev);
                if (ret) {
                        dev_err(&pdev->dev, "Fail to request %s irq\n", irq_desc->name);
                        return ret;
                }
        }

        return 0;
}

static int mt6360_regulator_probe(struct platform_device *pdev)
{
        struct mt6360_regulator_data *mrd;
        struct regulator_config config = {};
        int i, ret;

        mrd = devm_kzalloc(&pdev->dev, sizeof(*mrd), GFP_KERNEL);
        if (!mrd)
                return -ENOMEM;

        mrd->dev = &pdev->dev;

        mrd->regmap = dev_get_regmap(pdev->dev.parent, NULL);
        if (!mrd->regmap) {
                dev_err(&pdev->dev, "Failed to get parent regmap\n");
                return -ENODEV;
        }

        config.dev = pdev->dev.parent;
        config.driver_data = mrd;
        config.regmap = mrd->regmap;

        for (i = 0; i < ARRAY_SIZE(mt6360_regulator_descs); i++) {
                const struct mt6360_regulator_desc *rdesc = mt6360_regulator_descs + i;
                struct regulator_dev *rdev;

                rdev = devm_regulator_register(&pdev->dev, &rdesc->desc, &config);
                if (IS_ERR(rdev)) {
                        dev_err(&pdev->dev, "Failed to register  %d regulator\n", i);
                        return PTR_ERR(rdev);
                }

                ret = mt6360_regulator_irq_register(pdev, rdev, rdesc->irq_tables,
                                                    rdesc->irq_table_size);
                if (ret) {
                        dev_err(&pdev->dev, "Failed to register  %d regulator irqs\n", i);
                        return ret;
                }
        }

        return 0;
}

static const struct platform_device_id mt6360_regulator_id_table[] = {
        { "mt6360-regulator", 0 },
        {},
};
MODULE_DEVICE_TABLE(platform, mt6360_regulator_id_table);

static struct platform_driver mt6360_regulator_driver = {
        .driver = {
                .name = "mt6360-regulator",
                .probe_type = PROBE_PREFER_ASYNCHRONOUS,
        },
        .probe = mt6360_regulator_probe,
        .id_table = mt6360_regulator_id_table,
};
module_platform_driver(mt6360_regulator_driver);

MODULE_AUTHOR("Gene Chen <gene_chen@richtek.com>");
MODULE_DESCRIPTION("MT6360 Regulator Driver");
MODULE_LICENSE("GPL v2");