88pm800.c

Go to the documentation of this file.

/*
 * Base driver for Marvell 88PM800
 *
 * Copyright (C) 2012 Marvell International Ltd.
 * Haojian Zhuang <[email protected]>
 * Joseph(Yossi) Hanin <[email protected]>
 * Qiao Zhou <[email protected]>
 *
 * This file is subject to the terms and conditions of the GNU General
 * Public License. See the file "COPYING" in the main directory of this
 * archive for more details.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/i2c.h>
#include <linux/mfd/core.h>
#include <linux/mfd/88pm80x.h>
#include <linux/slab.h>

#define PM800_CHIP_ID           (0x00)

/* Interrupt Registers */
#define PM800_INT_STATUS1       (0x05)
#define PM800_ONKEY_INT_STS1        (1 << 0)
#define PM800_EXTON_INT_STS1        (1 << 1)
#define PM800_CHG_INT_STS1          (1 << 2)
#define PM800_BAT_INT_STS1          (1 << 3)
#define PM800_RTC_INT_STS1          (1 << 4)
#define PM800_CLASSD_OC_INT_STS1    (1 << 5)

#define PM800_INT_STATUS2       (0x06)
#define PM800_VBAT_INT_STS2     (1 << 0)
#define PM800_VSYS_INT_STS2     (1 << 1)
#define PM800_VCHG_INT_STS2     (1 << 2)
#define PM800_TINT_INT_STS2     (1 << 3)
#define PM800_GPADC0_INT_STS2   (1 << 4)
#define PM800_TBAT_INT_STS2     (1 << 5)
#define PM800_GPADC2_INT_STS2   (1 << 6)
#define PM800_GPADC3_INT_STS2   (1 << 7)

#define PM800_INT_STATUS3       (0x07)

#define PM800_INT_STATUS4       (0x08)
#define PM800_GPIO0_INT_STS4        (1 << 0)
#define PM800_GPIO1_INT_STS4        (1 << 1)
#define PM800_GPIO2_INT_STS4        (1 << 2)
#define PM800_GPIO3_INT_STS4        (1 << 3)
#define PM800_GPIO4_INT_STS4        (1 << 4)

#define PM800_INT_ENA_1     (0x09)
#define PM800_ONKEY_INT_ENA1        (1 << 0)
#define PM800_EXTON_INT_ENA1        (1 << 1)
#define PM800_CHG_INT_ENA1          (1 << 2)
#define PM800_BAT_INT_ENA1          (1 << 3)
#define PM800_RTC_INT_ENA1          (1 << 4)
#define PM800_CLASSD_OC_INT_ENA1    (1 << 5)

#define PM800_INT_ENA_2     (0x0A)
#define PM800_VBAT_INT_ENA2     (1 << 0)
#define PM800_VSYS_INT_ENA2     (1 << 1)
#define PM800_VCHG_INT_ENA2     (1 << 2)
#define PM800_TINT_INT_ENA2     (1 << 3)

#define PM800_INT_ENA_3     (0x0B)
#define PM800_GPADC0_INT_ENA3       (1 << 0)
#define PM800_GPADC1_INT_ENA3       (1 << 1)
#define PM800_GPADC2_INT_ENA3       (1 << 2)
#define PM800_GPADC3_INT_ENA3       (1 << 3)
#define PM800_GPADC4_INT_ENA3       (1 << 4)

#define PM800_INT_ENA_4     (0x0C)
#define PM800_GPIO0_INT_ENA4        (1 << 0)
#define PM800_GPIO1_INT_ENA4        (1 << 1)
#define PM800_GPIO2_INT_ENA4        (1 << 2)
#define PM800_GPIO3_INT_ENA4        (1 << 3)
#define PM800_GPIO4_INT_ENA4        (1 << 4)

/* number of INT_ENA & INT_STATUS regs */
#define PM800_INT_REG_NUM           (4)

/* Interrupt Number in 88PM800 */
enum {
    PM800_IRQ_ONKEY,    /*EN1b0 *//*0 */
    PM800_IRQ_EXTON,    /*EN1b1 */
    PM800_IRQ_CHG,      /*EN1b2 */
    PM800_IRQ_BAT,      /*EN1b3 */
    PM800_IRQ_RTC,      /*EN1b4 */
    PM800_IRQ_CLASSD,   /*EN1b5 *//*5 */
    PM800_IRQ_VBAT,     /*EN2b0 */
    PM800_IRQ_VSYS,     /*EN2b1 */
    PM800_IRQ_VCHG,     /*EN2b2 */
    PM800_IRQ_TINT,     /*EN2b3 */
    PM800_IRQ_GPADC0,   /*EN3b0 *//*10 */
    PM800_IRQ_GPADC1,   /*EN3b1 */
    PM800_IRQ_GPADC2,   /*EN3b2 */
    PM800_IRQ_GPADC3,   /*EN3b3 */
    PM800_IRQ_GPADC4,   /*EN3b4 */
    PM800_IRQ_GPIO0,    /*EN4b0 *//*15 */
    PM800_IRQ_GPIO1,    /*EN4b1 */
    PM800_IRQ_GPIO2,    /*EN4b2 */
    PM800_IRQ_GPIO3,    /*EN4b3 */
    PM800_IRQ_GPIO4,    /*EN4b4 *//*19 */
    PM800_MAX_IRQ,
};

enum {
    /* Procida */
    PM800_CHIP_A0  = 0x60,
    PM800_CHIP_A1  = 0x61,
    PM800_CHIP_B0  = 0x62,
    PM800_CHIP_C0  = 0x63,
    PM800_CHIP_END = PM800_CHIP_C0,

    /* Make sure to update this to the last stepping */
    PM8XXX_CHIP_END = PM800_CHIP_END
};

static const struct i2c_device_id pm80x_id_table[] = {
    {"88PM800", CHIP_PM800},
    {} /* NULL terminated */
};
MODULE_DEVICE_TABLE(i2c, pm80x_id_table);

static struct resource rtc_resources[] = {
    {
     .name = "88pm80x-rtc",
     .start = PM800_IRQ_RTC,
     .end = PM800_IRQ_RTC,
     .flags = IORESOURCE_IRQ,
     },
};

static struct mfd_cell rtc_devs[] = {
    {
     .name = "88pm80x-rtc",
     .num_resources = ARRAY_SIZE(rtc_resources),
     .resources = &rtc_resources[0],
     .id = -1,
     },
};

static struct resource onkey_resources[] = {
    {
     .name = "88pm80x-onkey",
     .start = PM800_IRQ_ONKEY,
     .end = PM800_IRQ_ONKEY,
     .flags = IORESOURCE_IRQ,
     },
};

static struct mfd_cell onkey_devs[] = {
    {
     .name = "88pm80x-onkey",
     .num_resources = 1,
     .resources = &onkey_resources[0],
     .id = -1,
     },
};

static const struct regmap_irq pm800_irqs[] = {
    /* INT0 */
    [PM800_IRQ_ONKEY] = {
        .mask = PM800_ONKEY_INT_ENA1,
    },
    [PM800_IRQ_EXTON] = {
        .mask = PM800_EXTON_INT_ENA1,
    },
    [PM800_IRQ_CHG] = {
        .mask = PM800_CHG_INT_ENA1,
    },
    [PM800_IRQ_BAT] = {
        .mask = PM800_BAT_INT_ENA1,
    },
    [PM800_IRQ_RTC] = {
        .mask = PM800_RTC_INT_ENA1,
    },
    [PM800_IRQ_CLASSD] = {
        .mask = PM800_CLASSD_OC_INT_ENA1,
    },
    /* INT1 */
    [PM800_IRQ_VBAT] = {
        .reg_offset = 1,
        .mask = PM800_VBAT_INT_ENA2,
    },
    [PM800_IRQ_VSYS] = {
        .reg_offset = 1,
        .mask = PM800_VSYS_INT_ENA2,
    },
    [PM800_IRQ_VCHG] = {
        .reg_offset = 1,
        .mask = PM800_VCHG_INT_ENA2,
    },
    [PM800_IRQ_TINT] = {
        .reg_offset = 1,
        .mask = PM800_TINT_INT_ENA2,
    },
    /* INT2 */
    [PM800_IRQ_GPADC0] = {
        .reg_offset = 2,
        .mask = PM800_GPADC0_INT_ENA3,
    },
    [PM800_IRQ_GPADC1] = {
        .reg_offset = 2,
        .mask = PM800_GPADC1_INT_ENA3,
    },
    [PM800_IRQ_GPADC2] = {
        .reg_offset = 2,
        .mask = PM800_GPADC2_INT_ENA3,
    },
    [PM800_IRQ_GPADC3] = {
        .reg_offset = 2,
        .mask = PM800_GPADC3_INT_ENA3,
    },
    [PM800_IRQ_GPADC4] = {
        .reg_offset = 2,
        .mask = PM800_GPADC4_INT_ENA3,
    },
    /* INT3 */
    [PM800_IRQ_GPIO0] = {
        .reg_offset = 3,
        .mask = PM800_GPIO0_INT_ENA4,
    },
    [PM800_IRQ_GPIO1] = {
        .reg_offset = 3,
        .mask = PM800_GPIO1_INT_ENA4,
    },
    [PM800_IRQ_GPIO2] = {
        .reg_offset = 3,
        .mask = PM800_GPIO2_INT_ENA4,
    },
    [PM800_IRQ_GPIO3] = {
        .reg_offset = 3,
        .mask = PM800_GPIO3_INT_ENA4,
    },
    [PM800_IRQ_GPIO4] = {
        .reg_offset = 3,
        .mask = PM800_GPIO4_INT_ENA4,
    },
};

static int __devinit device_gpadc_init(struct pm80x_chip *chip,
                       struct pm80x_platform_data *pdata)
{
    struct pm80x_subchip *subchip = chip->subchip;
    struct regmap *map = subchip->regmap_gpadc;
    int data = 0, mask = 0, ret = 0;

    if (!map) {
        dev_warn(chip->dev,
             "Warning: gpadc regmap is not available!\n");
        return -EINVAL;
    }
    /*
     * initialize GPADC without activating it turn on GPADC
     * measurments
     */
    ret = regmap_update_bits(map,
                 PM800_GPADC_MISC_CONFIG2,
                 PM800_GPADC_MISC_GPFSM_EN,
                 PM800_GPADC_MISC_GPFSM_EN);
    if (ret < 0)
        goto out;
    /*
     * This function configures the ADC as requires for
     * CP implementation.CP does not "own" the ADC configuration
     * registers and relies on AP.
     * Reason: enable automatic ADC measurements needed
     * for CP to get VBAT and RF temperature readings.
     */
    ret = regmap_update_bits(map, PM800_GPADC_MEAS_EN1,
                 PM800_MEAS_EN1_VBAT, PM800_MEAS_EN1_VBAT);
    if (ret < 0)
        goto out;
    ret = regmap_update_bits(map, PM800_GPADC_MEAS_EN2,
                 (PM800_MEAS_EN2_RFTMP | PM800_MEAS_GP0_EN),
                 (PM800_MEAS_EN2_RFTMP | PM800_MEAS_GP0_EN));
    if (ret < 0)
        goto out;

    /*
     * the defult of PM800 is GPADC operates at 100Ks/s rate
     * and Number of GPADC slots with active current bias prior
     * to GPADC sampling = 1 slot for all GPADCs set for
     * Temprature mesurmants
     */
    mask = (PM800_GPADC_GP_BIAS_EN0 | PM800_GPADC_GP_BIAS_EN1 |
        PM800_GPADC_GP_BIAS_EN2 | PM800_GPADC_GP_BIAS_EN3);

    if (pdata && (pdata->batt_det == 0))
        data = (PM800_GPADC_GP_BIAS_EN0 | PM800_GPADC_GP_BIAS_EN1 |
            PM800_GPADC_GP_BIAS_EN2 | PM800_GPADC_GP_BIAS_EN3);
    else
        data = (PM800_GPADC_GP_BIAS_EN0 | PM800_GPADC_GP_BIAS_EN2 |
            PM800_GPADC_GP_BIAS_EN3);

    ret = regmap_update_bits(map, PM800_GP_BIAS_ENA1, mask, data);
    if (ret < 0)
        goto out;

    dev_info(chip->dev, "pm800 device_gpadc_init: Done\n");
    return 0;

out:
    dev_info(chip->dev, "pm800 device_gpadc_init: Failed!\n");
    return ret;
}

static int __devinit device_irq_init_800(struct pm80x_chip *chip)
{
    struct regmap *map = chip->regmap;
    unsigned long flags = IRQF_TRIGGER_FALLING | IRQF_ONESHOT;
    int data, mask, ret = -EINVAL;

    if (!map || !chip->irq) {
        dev_err(chip->dev, "incorrect parameters\n");
        return -EINVAL;
    }

    /*
     * irq_mode defines the way of clearing interrupt. it's read-clear by
     * default.
     */
    mask =
        PM800_WAKEUP2_INV_INT | PM800_WAKEUP2_INT_CLEAR |
        PM800_WAKEUP2_INT_MASK;

    data = PM800_WAKEUP2_INT_CLEAR;
    ret = regmap_update_bits(map, PM800_WAKEUP2, mask, data);

    if (ret < 0)
        goto out;

    ret =
        regmap_add_irq_chip(chip->regmap, chip->irq, flags, -1,
                chip->regmap_irq_chip, &chip->irq_data);

out:
    return ret;
}

static void device_irq_exit_800(struct pm80x_chip *chip)
{
    regmap_del_irq_chip(chip->irq, chip->irq_data);
}

static struct regmap_irq_chip pm800_irq_chip = {
    .name = "88pm800",
    .irqs = pm800_irqs,
    .num_irqs = ARRAY_SIZE(pm800_irqs),

    .num_regs = 4,
    .status_base = PM800_INT_STATUS1,
    .mask_base = PM800_INT_ENA_1,
    .ack_base = PM800_INT_STATUS1,
};

static int pm800_pages_init(struct pm80x_chip *chip)
{
    struct pm80x_subchip *subchip;
    struct i2c_client *client = chip->client;

    subchip = chip->subchip;
    /* PM800 block power: i2c addr 0x31 */
    if (subchip->power_page_addr) {
        subchip->power_page =
            i2c_new_dummy(client->adapter, subchip->power_page_addr);
        subchip->regmap_power =
            devm_regmap_init_i2c(subchip->power_page,
                     &pm80x_regmap_config);
        i2c_set_clientdata(subchip->power_page, chip);
    } else
        dev_info(chip->dev,
             "PM800 block power 0x31: No power_page_addr\n");

    /* PM800 block GPADC: i2c addr 0x32 */
    if (subchip->gpadc_page_addr) {
        subchip->gpadc_page = i2c_new_dummy(client->adapter,
                            subchip->gpadc_page_addr);
        subchip->regmap_gpadc =
            devm_regmap_init_i2c(subchip->gpadc_page,
                     &pm80x_regmap_config);
        i2c_set_clientdata(subchip->gpadc_page, chip);
    } else
        dev_info(chip->dev,
             "PM800 block GPADC 0x32: No gpadc_page_addr\n");

    return 0;
}

static void pm800_pages_exit(struct pm80x_chip *chip)
{
    struct pm80x_subchip *subchip;

    regmap_exit(chip->regmap);
    i2c_unregister_device(chip->client);

    subchip = chip->subchip;
    if (subchip->power_page) {
        regmap_exit(subchip->regmap_power);
        i2c_unregister_device(subchip->power_page);
    }
    if (subchip->gpadc_page) {
        regmap_exit(subchip->regmap_gpadc);
        i2c_unregister_device(subchip->gpadc_page);
    }
}

static int __devinit device_800_init(struct pm80x_chip *chip,
                     struct pm80x_platform_data *pdata)
{
    int ret, pmic_id;
    unsigned int val;

    ret = regmap_read(chip->regmap, PM800_CHIP_ID, &val);
    if (ret < 0) {
        dev_err(chip->dev, "Failed to read CHIP ID: %d\n", ret);
        goto out;
    }

    pmic_id = val & PM80X_VERSION_MASK;

    if ((pmic_id >= PM800_CHIP_A0) && (pmic_id <= PM800_CHIP_END)) {
        chip->version = val;
        dev_info(chip->dev,
             "88PM80x:Marvell 88PM800 (ID:0x%x) detected\n", val);
    } else {
        dev_err(chip->dev,
            "Failed to detect Marvell 88PM800:ChipID[0x%x]\n", val);
        ret = -EINVAL;
        goto out;
    }

    /*
     * alarm wake up bit will be clear in device_irq_init(),
     * read before that
     */
    ret = regmap_read(chip->regmap, PM800_RTC_CONTROL, &val);
    if (ret < 0) {
        dev_err(chip->dev, "Failed to read RTC register: %d\n", ret);
        goto out;
    }
    if (val & PM800_ALARM_WAKEUP) {
        if (pdata && pdata->rtc)
            pdata->rtc->rtc_wakeup = 1;
    }

    ret = device_gpadc_init(chip, pdata);
    if (ret < 0) {
        dev_err(chip->dev, "[%s]Failed to init gpadc\n", __func__);
        goto out;
    }

    chip->regmap_irq_chip = &pm800_irq_chip;

    ret = device_irq_init_800(chip);
    if (ret < 0) {
        dev_err(chip->dev, "[%s]Failed to init pm800 irq\n", __func__);
        goto out;
    }

    ret =
        mfd_add_devices(chip->dev, 0, &onkey_devs[0],
                ARRAY_SIZE(onkey_devs), &onkey_resources[0], 0,
                NULL);
    if (ret < 0) {
        dev_err(chip->dev, "Failed to add onkey subdev\n");
        goto out_dev;
    } else
        dev_info(chip->dev, "[%s]:Added mfd onkey_devs\n", __func__);

    if (pdata && pdata->rtc) {
        rtc_devs[0].platform_data = pdata->rtc;
        rtc_devs[0].pdata_size = sizeof(struct pm80x_rtc_pdata);
        ret = mfd_add_devices(chip->dev, 0, &rtc_devs[0],
                      ARRAY_SIZE(rtc_devs), NULL, 0, NULL);
        if (ret < 0) {
            dev_err(chip->dev, "Failed to add rtc subdev\n");
            goto out_dev;
        } else
            dev_info(chip->dev,
                 "[%s]:Added mfd rtc_devs\n", __func__);
    }

    return 0;
out_dev:
    mfd_remove_devices(chip->dev);
    device_irq_exit_800(chip);
out:
    return ret;
}

static int __devinit pm800_probe(struct i2c_client *client,
                 const struct i2c_device_id *id)
{
    int ret = 0;
    struct pm80x_chip *chip;
    struct pm80x_platform_data *pdata = client->dev.platform_data;
    struct pm80x_subchip *subchip;

    ret = pm80x_init(client, id);
    if (ret) {
        dev_err(&client->dev, "pm800_init fail\n");
        goto out_init;
    }

    chip = i2c_get_clientdata(client);

    /* init subchip for PM800 */
    subchip =
        devm_kzalloc(&client->dev, sizeof(struct pm80x_subchip),
             GFP_KERNEL);
    if (!subchip) {
        ret = -ENOMEM;
        goto err_subchip_alloc;
    }

    subchip->power_page_addr = pdata->power_page_addr;
    subchip->gpadc_page_addr = pdata->gpadc_page_addr;
    chip->subchip = subchip;

    ret = device_800_init(chip, pdata);
    if (ret) {
        dev_err(chip->dev, "%s id 0x%x failed!\n", __func__, chip->id);
        goto err_800_init;
    }

    ret = pm800_pages_init(chip);
    if (ret) {
        dev_err(&client->dev, "pm800_pages_init failed!\n");
        goto err_page_init;
    }

    if (pdata->plat_config)
        pdata->plat_config(chip, pdata);

err_page_init:
    mfd_remove_devices(chip->dev);
    device_irq_exit_800(chip);
err_800_init:
    devm_kfree(&client->dev, subchip);
err_subchip_alloc:
    pm80x_deinit(client);
out_init:
    return ret;
}

static int __devexit pm800_remove(struct i2c_client *client)
{
    struct pm80x_chip *chip = i2c_get_clientdata(client);

    mfd_remove_devices(chip->dev);
    device_irq_exit_800(chip);

    pm800_pages_exit(chip);
    devm_kfree(&client->dev, chip->subchip);

    pm80x_deinit(client);

    return 0;
}

static struct i2c_driver pm800_driver = {
    .driver = {
        .name = "88PM80X",
        .owner = THIS_MODULE,
        .pm = &pm80x_pm_ops,
        },
    .probe = pm800_probe,
    .remove = __devexit_p(pm800_remove),
    .id_table = pm80x_id_table,
};

static int __init pm800_i2c_init(void)
{
    return i2c_add_driver(&pm800_driver);
}
subsys_initcall(pm800_i2c_init);

static void __exit pm800_i2c_exit(void)
{
    i2c_del_driver(&pm800_driver);
}
module_exit(pm800_i2c_exit);

MODULE_DESCRIPTION("PMIC Driver for Marvell 88PM800");
MODULE_AUTHOR("Qiao Zhou <[email protected]>");
MODULE_LICENSE("GPL");