root/drivers/mfd/mc13xxx-core.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright 2009-2010 Pengutronix
 * Uwe Kleine-Koenig <u.kleine-koenig@pengutronix.de>
 *
 * loosely based on an earlier driver that has
 * Copyright 2009 Pengutronix, Sascha Hauer <s.hauer@pengutronix.de>
 */

#include <linux/bitfield.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/of_device.h>
#include <linux/platform_device.h>
#include <linux/mfd/core.h>

#include "mc13xxx.h"

#define MC13XXX_IRQSTAT0        0
#define MC13XXX_IRQMASK0        1
#define MC13XXX_IRQSTAT1        3
#define MC13XXX_IRQMASK1        4

#define MC13XXX_REVISION        7
#define MC13XXX_REVISION_REVMETAL       (0x07 <<  0)
#define MC13XXX_REVISION_REVFULL        (0x03 <<  3)
#define MC13XXX_REVISION_ICID           (0x07 <<  6)
#define MC13XXX_REVISION_FIN            (0x03 <<  9)
#define MC13XXX_REVISION_FAB            (0x03 << 11)
#define MC13XXX_REVISION_ICIDCODE       (0x3f << 13)

#define MC34708_REVISION_REVMETAL       (0x07 <<  0)
#define MC34708_REVISION_REVFULL        (0x07 <<  3)
#define MC34708_REVISION_FIN            (0x07 <<  6)
#define MC34708_REVISION_FAB            (0x07 <<  9)

#define MC13XXX_PWRCTRL         15
#define MC13XXX_PWRCTRL_WDIRESET        (1 << 12)

#define MC13XXX_ADC1            44
#define MC13XXX_ADC1_ADEN               (1 << 0)
#define MC13XXX_ADC1_RAND               (1 << 1)
#define MC13XXX_ADC1_ADSEL              (1 << 3)
#define MC13XXX_ADC1_ASC                (1 << 20)
#define MC13XXX_ADC1_ADTRIGIGN          (1 << 21)

#define MC13XXX_ADC2            45

void mc13xxx_lock(struct mc13xxx *mc13xxx)
{
        if (!mutex_trylock(&mc13xxx->lock)) {
                dev_dbg(mc13xxx->dev, "wait for %s from %ps\n",
                                __func__, __builtin_return_address(0));

                mutex_lock(&mc13xxx->lock);
        }
        dev_dbg(mc13xxx->dev, "%s from %ps\n",
                        __func__, __builtin_return_address(0));
}
EXPORT_SYMBOL(mc13xxx_lock);

void mc13xxx_unlock(struct mc13xxx *mc13xxx)
{
        dev_dbg(mc13xxx->dev, "%s from %ps\n",
                        __func__, __builtin_return_address(0));
        mutex_unlock(&mc13xxx->lock);
}
EXPORT_SYMBOL(mc13xxx_unlock);

int mc13xxx_reg_read(struct mc13xxx *mc13xxx, unsigned int offset, u32 *val)
{
        int ret;

        ret = regmap_read(mc13xxx->regmap, offset, val);
        dev_vdbg(mc13xxx->dev, "[0x%02x] -> 0x%06x\n", offset, *val);

        return ret;
}
EXPORT_SYMBOL(mc13xxx_reg_read);

int mc13xxx_reg_write(struct mc13xxx *mc13xxx, unsigned int offset, u32 val)
{
        dev_vdbg(mc13xxx->dev, "[0x%02x] <- 0x%06x\n", offset, val);

        if (val >= BIT(24))
                return -EINVAL;

        return regmap_write(mc13xxx->regmap, offset, val);
}
EXPORT_SYMBOL(mc13xxx_reg_write);

int mc13xxx_reg_rmw(struct mc13xxx *mc13xxx, unsigned int offset,
                u32 mask, u32 val)
{
        BUG_ON(val & ~mask);
        dev_vdbg(mc13xxx->dev, "[0x%02x] <- 0x%06x (mask: 0x%06x)\n",
                        offset, val, mask);

        return regmap_update_bits(mc13xxx->regmap, offset, mask, val);
}
EXPORT_SYMBOL(mc13xxx_reg_rmw);

int mc13xxx_irq_mask(struct mc13xxx *mc13xxx, int irq)
{
        int virq = regmap_irq_get_virq(mc13xxx->irq_data, irq);

        disable_irq_nosync(virq);

        return 0;
}
EXPORT_SYMBOL(mc13xxx_irq_mask);

int mc13xxx_irq_unmask(struct mc13xxx *mc13xxx, int irq)
{
        int virq = regmap_irq_get_virq(mc13xxx->irq_data, irq);

        enable_irq(virq);

        return 0;
}
EXPORT_SYMBOL(mc13xxx_irq_unmask);

int mc13xxx_irq_status(struct mc13xxx *mc13xxx, int irq,
                int *enabled, int *pending)
{
        int ret;
        unsigned int offmask = irq < 24 ? MC13XXX_IRQMASK0 : MC13XXX_IRQMASK1;
        unsigned int offstat = irq < 24 ? MC13XXX_IRQSTAT0 : MC13XXX_IRQSTAT1;
        u32 irqbit = 1 << (irq < 24 ? irq : irq - 24);

        if (irq < 0 || irq >= ARRAY_SIZE(mc13xxx->irqs))
                return -EINVAL;

        if (enabled) {
                u32 mask;

                ret = mc13xxx_reg_read(mc13xxx, offmask, &mask);
                if (ret)
                        return ret;

                *enabled = mask & irqbit;
        }

        if (pending) {
                u32 stat;

                ret = mc13xxx_reg_read(mc13xxx, offstat, &stat);
                if (ret)
                        return ret;

                *pending = stat & irqbit;
        }

        return 0;
}
EXPORT_SYMBOL(mc13xxx_irq_status);

int mc13xxx_irq_request(struct mc13xxx *mc13xxx, int irq,
                irq_handler_t handler, const char *name, void *dev)
{
        int virq = regmap_irq_get_virq(mc13xxx->irq_data, irq);

        return devm_request_threaded_irq(mc13xxx->dev, virq, NULL, handler,
                                         IRQF_ONESHOT, name, dev);
}
EXPORT_SYMBOL(mc13xxx_irq_request);

int mc13xxx_irq_free(struct mc13xxx *mc13xxx, int irq, void *dev)
{
        int virq = regmap_irq_get_virq(mc13xxx->irq_data, irq);

        devm_free_irq(mc13xxx->dev, virq, dev);

        return 0;
}
EXPORT_SYMBOL(mc13xxx_irq_free);

static void mc13xxx_print_revision(struct mc13xxx *mc13xxx, u32 revision)
{
        dev_info(mc13xxx->dev, "%s: rev: %d.%d, "
                        "fin: %d, fab: %d, icid: %d/%d\n",
                        mc13xxx->variant->name,
                        FIELD_GET(MC13XXX_REVISION_REVFULL, revision),
                        FIELD_GET(MC13XXX_REVISION_REVMETAL, revision),
                        FIELD_GET(MC13XXX_REVISION_FIN, revision),
                        FIELD_GET(MC13XXX_REVISION_FAB, revision),
                        FIELD_GET(MC13XXX_REVISION_ICID, revision),
                        FIELD_GET(MC13XXX_REVISION_ICIDCODE, revision));
}

static void mc34708_print_revision(struct mc13xxx *mc13xxx, u32 revision)
{
        dev_info(mc13xxx->dev, "%s: rev %d.%d, fin: %d, fab: %d\n",
                        mc13xxx->variant->name,
                        FIELD_GET(MC34708_REVISION_REVFULL, revision),
                        FIELD_GET(MC34708_REVISION_REVMETAL, revision),
                        FIELD_GET(MC34708_REVISION_FIN, revision),
                        FIELD_GET(MC34708_REVISION_FAB, revision));
}

/* These are only exported for mc13xxx-i2c and mc13xxx-spi */
struct mc13xxx_variant mc13xxx_variant_mc13783 = {
        .name = "mc13783",
        .print_revision = mc13xxx_print_revision,
};
EXPORT_SYMBOL_GPL(mc13xxx_variant_mc13783);

struct mc13xxx_variant mc13xxx_variant_mc13892 = {
        .name = "mc13892",
        .print_revision = mc13xxx_print_revision,
};
EXPORT_SYMBOL_GPL(mc13xxx_variant_mc13892);

struct mc13xxx_variant mc13xxx_variant_mc34708 = {
        .name = "mc34708",
        .print_revision = mc34708_print_revision,
};
EXPORT_SYMBOL_GPL(mc13xxx_variant_mc34708);

static const char *mc13xxx_get_chipname(struct mc13xxx *mc13xxx)
{
        return mc13xxx->variant->name;
}

int mc13xxx_get_flags(struct mc13xxx *mc13xxx)
{
        return mc13xxx->flags;
}
EXPORT_SYMBOL(mc13xxx_get_flags);

#define MC13XXX_ADC1_CHAN0_SHIFT        5
#define MC13XXX_ADC1_CHAN1_SHIFT        8
#define MC13783_ADC1_ATO_SHIFT          11
#define MC13783_ADC1_ATOX               (1 << 19)

struct mc13xxx_adcdone_data {
        struct mc13xxx *mc13xxx;
        struct completion done;
};

static irqreturn_t mc13xxx_handler_adcdone(int irq, void *data)
{
        struct mc13xxx_adcdone_data *adcdone_data = data;

        complete_all(&adcdone_data->done);

        return IRQ_HANDLED;
}

#define MC13XXX_ADC_WORKING (1 << 0)

int mc13xxx_adc_do_conversion(struct mc13xxx *mc13xxx, unsigned int mode,
                unsigned int channel, u8 ato, bool atox,
                unsigned int *sample)
{
        u32 adc0, adc1, old_adc0;
        int i, ret;
        struct mc13xxx_adcdone_data adcdone_data = {
                .mc13xxx = mc13xxx,
        };
        init_completion(&adcdone_data.done);

        dev_dbg(mc13xxx->dev, "%s\n", __func__);

        mc13xxx_lock(mc13xxx);

        if (mc13xxx->adcflags & MC13XXX_ADC_WORKING) {
                ret = -EBUSY;
                goto out;
        }

        mc13xxx->adcflags |= MC13XXX_ADC_WORKING;

        ret = mc13xxx_reg_read(mc13xxx, MC13XXX_ADC0, &old_adc0);
        if (ret)
                goto out;

        adc0 = MC13XXX_ADC0_ADINC1 | MC13XXX_ADC0_ADINC2 |
               MC13XXX_ADC0_CHRGRAWDIV;
        adc1 = MC13XXX_ADC1_ADEN | MC13XXX_ADC1_ADTRIGIGN | MC13XXX_ADC1_ASC;

        /*
         * Channels mapped through ADIN7:
         * 7  - General purpose ADIN7
         * 16 - UID
         * 17 - Die temperature
         */
        if (channel > 7 && channel < 16) {
                adc1 |= MC13XXX_ADC1_ADSEL;
        } else if (channel == 16) {
                adc0 |= MC13XXX_ADC0_ADIN7SEL_UID;
                channel = 7;
        } else if (channel == 17) {
                adc0 |= MC13XXX_ADC0_ADIN7SEL_DIE;
                channel = 7;
        }

        switch (mode) {
        case MC13XXX_ADC_MODE_TS:
                adc0 |= MC13XXX_ADC0_ADREFEN | MC13XXX_ADC0_TSMOD0 |
                        MC13XXX_ADC0_TSMOD1;
                adc1 |= 4 << MC13XXX_ADC1_CHAN1_SHIFT;
                break;

        case MC13XXX_ADC_MODE_SINGLE_CHAN:
                adc0 |= old_adc0 & MC13XXX_ADC0_CONFIG_MASK;
                adc1 |= (channel & 0x7) << MC13XXX_ADC1_CHAN0_SHIFT;
                adc1 |= MC13XXX_ADC1_RAND;
                break;

        case MC13XXX_ADC_MODE_MULT_CHAN:
                adc0 |= old_adc0 & MC13XXX_ADC0_CONFIG_MASK;
                adc1 |= 4 << MC13XXX_ADC1_CHAN1_SHIFT;
                break;

        default:
                mc13xxx_unlock(mc13xxx);
                return -EINVAL;
        }

        adc1 |= ato << MC13783_ADC1_ATO_SHIFT;
        if (atox)
                adc1 |= MC13783_ADC1_ATOX;

        dev_dbg(mc13xxx->dev, "%s: request irq\n", __func__);
        ret = mc13xxx_irq_request(mc13xxx, MC13XXX_IRQ_ADCDONE,
                        mc13xxx_handler_adcdone, __func__, &adcdone_data);
        if (ret)
                goto out;

        mc13xxx_reg_write(mc13xxx, MC13XXX_ADC0, adc0);
        mc13xxx_reg_write(mc13xxx, MC13XXX_ADC1, adc1);

        mc13xxx_unlock(mc13xxx);

        ret = wait_for_completion_interruptible_timeout(&adcdone_data.done, HZ);

        if (!ret)
                ret = -ETIMEDOUT;

        mc13xxx_lock(mc13xxx);

        mc13xxx_irq_free(mc13xxx, MC13XXX_IRQ_ADCDONE, &adcdone_data);

        if (ret > 0)
                for (i = 0; i < 4; ++i) {
                        ret = mc13xxx_reg_read(mc13xxx,
                                        MC13XXX_ADC2, &sample[i]);
                        if (ret)
                                break;
                }

        if (mode == MC13XXX_ADC_MODE_TS)
                /* restore TSMOD */
                mc13xxx_reg_write(mc13xxx, MC13XXX_ADC0, old_adc0);

        mc13xxx->adcflags &= ~MC13XXX_ADC_WORKING;
out:
        mc13xxx_unlock(mc13xxx);

        return ret;
}
EXPORT_SYMBOL_GPL(mc13xxx_adc_do_conversion);

static int mc13xxx_add_subdevice_pdata(struct mc13xxx *mc13xxx,
                const char *format, void *pdata, size_t pdata_size)
{
        char buf[30];
        const char *name = mc13xxx_get_chipname(mc13xxx);

        struct mfd_cell cell = {
                .platform_data = pdata,
                .pdata_size = pdata_size,
        };

        /* there is no asnprintf in the kernel :-( */
        if (snprintf(buf, sizeof(buf), format, name) > sizeof(buf))
                return -E2BIG;

        cell.name = kmemdup(buf, strlen(buf) + 1, GFP_KERNEL);
        if (!cell.name)
                return -ENOMEM;

        return mfd_add_devices(mc13xxx->dev, -1, &cell, 1, NULL, 0,
                               regmap_irq_get_domain(mc13xxx->irq_data));
}

static int mc13xxx_add_subdevice(struct mc13xxx *mc13xxx, const char *format)
{
        return mc13xxx_add_subdevice_pdata(mc13xxx, format, NULL, 0);
}

#ifdef CONFIG_OF
static int mc13xxx_probe_flags_dt(struct mc13xxx *mc13xxx)
{
        struct device_node *np = mc13xxx->dev->of_node;

        if (!np)
                return -ENODEV;

        if (of_property_read_bool(np, "fsl,mc13xxx-uses-adc"))
                mc13xxx->flags |= MC13XXX_USE_ADC;

        if (of_property_read_bool(np, "fsl,mc13xxx-uses-codec"))
                mc13xxx->flags |= MC13XXX_USE_CODEC;

        if (of_property_read_bool(np, "fsl,mc13xxx-uses-rtc"))
                mc13xxx->flags |= MC13XXX_USE_RTC;

        if (of_property_read_bool(np, "fsl,mc13xxx-uses-touch"))
                mc13xxx->flags |= MC13XXX_USE_TOUCHSCREEN;

        return 0;
}
#else
static inline int mc13xxx_probe_flags_dt(struct mc13xxx *mc13xxx)
{
        return -ENODEV;
}
#endif

int mc13xxx_common_init(struct device *dev)
{
        struct mc13xxx_platform_data *pdata = dev_get_platdata(dev);
        struct mc13xxx *mc13xxx = dev_get_drvdata(dev);
        u32 revision;
        int i, ret;

        mc13xxx->dev = dev;

        ret = mc13xxx_reg_read(mc13xxx, MC13XXX_REVISION, &revision);
        if (ret)
                return ret;

        mc13xxx->variant->print_revision(mc13xxx, revision);

        ret = mc13xxx_reg_rmw(mc13xxx, MC13XXX_PWRCTRL,
                        MC13XXX_PWRCTRL_WDIRESET, MC13XXX_PWRCTRL_WDIRESET);
        if (ret)
                return ret;

        for (i = 0; i < ARRAY_SIZE(mc13xxx->irqs); i++) {
                mc13xxx->irqs[i].reg_offset = i / MC13XXX_IRQ_PER_REG;
                mc13xxx->irqs[i].mask = BIT(i % MC13XXX_IRQ_PER_REG);
        }

        mc13xxx->irq_chip.name = dev_name(dev);
        mc13xxx->irq_chip.status_base = MC13XXX_IRQSTAT0;
        mc13xxx->irq_chip.mask_base = MC13XXX_IRQMASK0;
        mc13xxx->irq_chip.ack_base = MC13XXX_IRQSTAT0;
        mc13xxx->irq_chip.irq_reg_stride = MC13XXX_IRQSTAT1 - MC13XXX_IRQSTAT0;
        mc13xxx->irq_chip.init_ack_masked = true;
        mc13xxx->irq_chip.use_ack = true;
        mc13xxx->irq_chip.num_regs = MC13XXX_IRQ_REG_CNT;
        mc13xxx->irq_chip.irqs = mc13xxx->irqs;
        mc13xxx->irq_chip.num_irqs = ARRAY_SIZE(mc13xxx->irqs);

        ret = regmap_add_irq_chip(mc13xxx->regmap, mc13xxx->irq, IRQF_ONESHOT,
                                  0, &mc13xxx->irq_chip, &mc13xxx->irq_data);
        if (ret)
                return ret;

        mutex_init(&mc13xxx->lock);

        if (mc13xxx_probe_flags_dt(mc13xxx) < 0 && pdata)
                mc13xxx->flags = pdata->flags;

        if (pdata) {
                mc13xxx_add_subdevice_pdata(mc13xxx, "%s-regulator",
                        &pdata->regulators, sizeof(pdata->regulators));
                mc13xxx_add_subdevice_pdata(mc13xxx, "%s-led",
                                pdata->leds, sizeof(*pdata->leds));
                mc13xxx_add_subdevice_pdata(mc13xxx, "%s-pwrbutton",
                                pdata->buttons, sizeof(*pdata->buttons));
                if (mc13xxx->flags & MC13XXX_USE_CODEC)
                        mc13xxx_add_subdevice_pdata(mc13xxx, "%s-codec",
                                pdata->codec, sizeof(*pdata->codec));
                if (mc13xxx->flags & MC13XXX_USE_TOUCHSCREEN)
                        mc13xxx_add_subdevice_pdata(mc13xxx, "%s-ts",
                                &pdata->touch, sizeof(pdata->touch));
        } else {
                mc13xxx_add_subdevice(mc13xxx, "%s-regulator");
                mc13xxx_add_subdevice(mc13xxx, "%s-led");
                mc13xxx_add_subdevice(mc13xxx, "%s-pwrbutton");
                if (mc13xxx->flags & MC13XXX_USE_CODEC)
                        mc13xxx_add_subdevice(mc13xxx, "%s-codec");
                if (mc13xxx->flags & MC13XXX_USE_TOUCHSCREEN)
                        mc13xxx_add_subdevice(mc13xxx, "%s-ts");
        }

        if (mc13xxx->flags & MC13XXX_USE_ADC)
                mc13xxx_add_subdevice(mc13xxx, "%s-adc");

        if (mc13xxx->flags & MC13XXX_USE_RTC)
                mc13xxx_add_subdevice(mc13xxx, "%s-rtc");

        return 0;
}
EXPORT_SYMBOL_GPL(mc13xxx_common_init);

void mc13xxx_common_exit(struct device *dev)
{
        struct mc13xxx *mc13xxx = dev_get_drvdata(dev);

        mfd_remove_devices(dev);
        regmap_del_irq_chip(mc13xxx->irq, mc13xxx->irq_data);
        mutex_destroy(&mc13xxx->lock);
}
EXPORT_SYMBOL_GPL(mc13xxx_common_exit);

MODULE_DESCRIPTION("Core driver for Freescale MC13XXX PMIC");
MODULE_AUTHOR("Uwe Kleine-Koenig <u.kleine-koenig@pengutronix.de>");
MODULE_LICENSE("GPL v2");