linux/drivers/mfd/tps6586x.c
<<
>>
Prefs
   1/*
   2 * Core driver for TI TPS6586x PMIC family
   3 *
   4 * Copyright (c) 2010 CompuLab Ltd.
   5 * Mike Rapoport <mike@compulab.co.il>
   6 *
   7 * Based on da903x.c.
   8 * Copyright (C) 2008 Compulab, Ltd.
   9 * Mike Rapoport <mike@compulab.co.il>
  10 * Copyright (C) 2006-2008 Marvell International Ltd.
  11 * Eric Miao <eric.miao@marvell.com>
  12 *
  13 * This program is free software; you can redistribute it and/or modify
  14 * it under the terms of the GNU General Public License version 2 as
  15 * published by the Free Software Foundation.
  16 */
  17
  18#include <linux/interrupt.h>
  19#include <linux/irq.h>
  20#include <linux/irqdomain.h>
  21#include <linux/kernel.h>
  22#include <linux/module.h>
  23#include <linux/mutex.h>
  24#include <linux/slab.h>
  25#include <linux/err.h>
  26#include <linux/i2c.h>
  27#include <linux/platform_device.h>
  28#include <linux/regmap.h>
  29
  30#include <linux/mfd/core.h>
  31#include <linux/mfd/tps6586x.h>
  32
  33#define TPS6586X_SUPPLYENE      0x14
  34#define EXITSLREQ_BIT           BIT(1)
  35#define SLEEP_MODE_BIT          BIT(3)
  36
  37/* interrupt control registers */
  38#define TPS6586X_INT_ACK1       0xb5
  39#define TPS6586X_INT_ACK2       0xb6
  40#define TPS6586X_INT_ACK3       0xb7
  41#define TPS6586X_INT_ACK4       0xb8
  42
  43/* interrupt mask registers */
  44#define TPS6586X_INT_MASK1      0xb0
  45#define TPS6586X_INT_MASK2      0xb1
  46#define TPS6586X_INT_MASK3      0xb2
  47#define TPS6586X_INT_MASK4      0xb3
  48#define TPS6586X_INT_MASK5      0xb4
  49
  50/* device id */
  51#define TPS6586X_VERSIONCRC     0xcd
  52
  53/* Maximum register */
  54#define TPS6586X_MAX_REGISTER   (TPS6586X_VERSIONCRC + 1)
  55
  56struct tps6586x_irq_data {
  57        u8      mask_reg;
  58        u8      mask_mask;
  59};
  60
  61#define TPS6586X_IRQ(_reg, _mask)                               \
  62        {                                                       \
  63                .mask_reg = (_reg) - TPS6586X_INT_MASK1,        \
  64                .mask_mask = (_mask),                           \
  65        }
  66
  67static const struct tps6586x_irq_data tps6586x_irqs[] = {
  68        [TPS6586X_INT_PLDO_0]   = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 0),
  69        [TPS6586X_INT_PLDO_1]   = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 1),
  70        [TPS6586X_INT_PLDO_2]   = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 2),
  71        [TPS6586X_INT_PLDO_3]   = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 3),
  72        [TPS6586X_INT_PLDO_4]   = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 4),
  73        [TPS6586X_INT_PLDO_5]   = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 5),
  74        [TPS6586X_INT_PLDO_6]   = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 6),
  75        [TPS6586X_INT_PLDO_7]   = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 7),
  76        [TPS6586X_INT_COMP_DET] = TPS6586X_IRQ(TPS6586X_INT_MASK4, 1 << 0),
  77        [TPS6586X_INT_ADC]      = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 1),
  78        [TPS6586X_INT_PLDO_8]   = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 2),
  79        [TPS6586X_INT_PLDO_9]   = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 3),
  80        [TPS6586X_INT_PSM_0]    = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 4),
  81        [TPS6586X_INT_PSM_1]    = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 5),
  82        [TPS6586X_INT_PSM_2]    = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 6),
  83        [TPS6586X_INT_PSM_3]    = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 7),
  84        [TPS6586X_INT_RTC_ALM1] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 4),
  85        [TPS6586X_INT_ACUSB_OVP] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 0x03),
  86        [TPS6586X_INT_USB_DET]  = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 2),
  87        [TPS6586X_INT_AC_DET]   = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 3),
  88        [TPS6586X_INT_BAT_DET]  = TPS6586X_IRQ(TPS6586X_INT_MASK3, 1 << 0),
  89        [TPS6586X_INT_CHG_STAT] = TPS6586X_IRQ(TPS6586X_INT_MASK4, 0xfc),
  90        [TPS6586X_INT_CHG_TEMP] = TPS6586X_IRQ(TPS6586X_INT_MASK3, 0x06),
  91        [TPS6586X_INT_PP]       = TPS6586X_IRQ(TPS6586X_INT_MASK3, 0xf0),
  92        [TPS6586X_INT_RESUME]   = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 5),
  93        [TPS6586X_INT_LOW_SYS]  = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 6),
  94        [TPS6586X_INT_RTC_ALM2] = TPS6586X_IRQ(TPS6586X_INT_MASK4, 1 << 1),
  95};
  96
  97static struct resource tps6586x_rtc_resources[] = {
  98        {
  99                .start  = TPS6586X_INT_RTC_ALM1,
 100                .end    = TPS6586X_INT_RTC_ALM1,
 101                .flags  = IORESOURCE_IRQ,
 102        },
 103};
 104
 105static struct mfd_cell tps6586x_cell[] = {
 106        {
 107                .name = "tps6586x-gpio",
 108        },
 109        {
 110                .name = "tps6586x-pmic",
 111        },
 112        {
 113                .name = "tps6586x-rtc",
 114                .num_resources = ARRAY_SIZE(tps6586x_rtc_resources),
 115                .resources = &tps6586x_rtc_resources[0],
 116        },
 117        {
 118                .name = "tps6586x-onkey",
 119        },
 120};
 121
 122struct tps6586x {
 123        struct device           *dev;
 124        struct i2c_client       *client;
 125        struct regmap           *regmap;
 126
 127        struct irq_chip         irq_chip;
 128        struct mutex            irq_lock;
 129        int                     irq_base;
 130        u32                     irq_en;
 131        u8                      mask_reg[5];
 132        struct irq_domain       *irq_domain;
 133};
 134
 135static inline struct tps6586x *dev_to_tps6586x(struct device *dev)
 136{
 137        return i2c_get_clientdata(to_i2c_client(dev));
 138}
 139
 140int tps6586x_write(struct device *dev, int reg, uint8_t val)
 141{
 142        struct tps6586x *tps6586x = dev_to_tps6586x(dev);
 143
 144        return regmap_write(tps6586x->regmap, reg, val);
 145}
 146EXPORT_SYMBOL_GPL(tps6586x_write);
 147
 148int tps6586x_writes(struct device *dev, int reg, int len, uint8_t *val)
 149{
 150        struct tps6586x *tps6586x = dev_to_tps6586x(dev);
 151
 152        return regmap_bulk_write(tps6586x->regmap, reg, val, len);
 153}
 154EXPORT_SYMBOL_GPL(tps6586x_writes);
 155
 156int tps6586x_read(struct device *dev, int reg, uint8_t *val)
 157{
 158        struct tps6586x *tps6586x = dev_to_tps6586x(dev);
 159        unsigned int rval;
 160        int ret;
 161
 162        ret = regmap_read(tps6586x->regmap, reg, &rval);
 163        if (!ret)
 164                *val = rval;
 165        return ret;
 166}
 167EXPORT_SYMBOL_GPL(tps6586x_read);
 168
 169int tps6586x_reads(struct device *dev, int reg, int len, uint8_t *val)
 170{
 171        struct tps6586x *tps6586x = dev_to_tps6586x(dev);
 172
 173        return regmap_bulk_read(tps6586x->regmap, reg, val, len);
 174}
 175EXPORT_SYMBOL_GPL(tps6586x_reads);
 176
 177int tps6586x_set_bits(struct device *dev, int reg, uint8_t bit_mask)
 178{
 179        struct tps6586x *tps6586x = dev_to_tps6586x(dev);
 180
 181        return regmap_update_bits(tps6586x->regmap, reg, bit_mask, bit_mask);
 182}
 183EXPORT_SYMBOL_GPL(tps6586x_set_bits);
 184
 185int tps6586x_clr_bits(struct device *dev, int reg, uint8_t bit_mask)
 186{
 187        struct tps6586x *tps6586x = dev_to_tps6586x(dev);
 188
 189        return regmap_update_bits(tps6586x->regmap, reg, bit_mask, 0);
 190}
 191EXPORT_SYMBOL_GPL(tps6586x_clr_bits);
 192
 193int tps6586x_update(struct device *dev, int reg, uint8_t val, uint8_t mask)
 194{
 195        struct tps6586x *tps6586x = dev_to_tps6586x(dev);
 196
 197        return regmap_update_bits(tps6586x->regmap, reg, mask, val);
 198}
 199EXPORT_SYMBOL_GPL(tps6586x_update);
 200
 201int tps6586x_irq_get_virq(struct device *dev, int irq)
 202{
 203        struct tps6586x *tps6586x = dev_to_tps6586x(dev);
 204
 205        return irq_create_mapping(tps6586x->irq_domain, irq);
 206}
 207EXPORT_SYMBOL_GPL(tps6586x_irq_get_virq);
 208
 209static int __remove_subdev(struct device *dev, void *unused)
 210{
 211        platform_device_unregister(to_platform_device(dev));
 212        return 0;
 213}
 214
 215static int tps6586x_remove_subdevs(struct tps6586x *tps6586x)
 216{
 217        return device_for_each_child(tps6586x->dev, NULL, __remove_subdev);
 218}
 219
 220static void tps6586x_irq_lock(struct irq_data *data)
 221{
 222        struct tps6586x *tps6586x = irq_data_get_irq_chip_data(data);
 223
 224        mutex_lock(&tps6586x->irq_lock);
 225}
 226
 227static void tps6586x_irq_enable(struct irq_data *irq_data)
 228{
 229        struct tps6586x *tps6586x = irq_data_get_irq_chip_data(irq_data);
 230        unsigned int __irq = irq_data->hwirq;
 231        const struct tps6586x_irq_data *data = &tps6586x_irqs[__irq];
 232
 233        tps6586x->mask_reg[data->mask_reg] &= ~data->mask_mask;
 234        tps6586x->irq_en |= (1 << __irq);
 235}
 236
 237static void tps6586x_irq_disable(struct irq_data *irq_data)
 238{
 239        struct tps6586x *tps6586x = irq_data_get_irq_chip_data(irq_data);
 240
 241        unsigned int __irq = irq_data->hwirq;
 242        const struct tps6586x_irq_data *data = &tps6586x_irqs[__irq];
 243
 244        tps6586x->mask_reg[data->mask_reg] |= data->mask_mask;
 245        tps6586x->irq_en &= ~(1 << __irq);
 246}
 247
 248static void tps6586x_irq_sync_unlock(struct irq_data *data)
 249{
 250        struct tps6586x *tps6586x = irq_data_get_irq_chip_data(data);
 251        int i;
 252
 253        for (i = 0; i < ARRAY_SIZE(tps6586x->mask_reg); i++) {
 254                int ret;
 255                ret = tps6586x_write(tps6586x->dev,
 256                                            TPS6586X_INT_MASK1 + i,
 257                                            tps6586x->mask_reg[i]);
 258                WARN_ON(ret);
 259        }
 260
 261        mutex_unlock(&tps6586x->irq_lock);
 262}
 263
 264static struct irq_chip tps6586x_irq_chip = {
 265        .name = "tps6586x",
 266        .irq_bus_lock = tps6586x_irq_lock,
 267        .irq_bus_sync_unlock = tps6586x_irq_sync_unlock,
 268        .irq_disable = tps6586x_irq_disable,
 269        .irq_enable = tps6586x_irq_enable,
 270};
 271
 272static int tps6586x_irq_map(struct irq_domain *h, unsigned int virq,
 273                                irq_hw_number_t hw)
 274{
 275        struct tps6586x *tps6586x = h->host_data;
 276
 277        irq_set_chip_data(virq, tps6586x);
 278        irq_set_chip_and_handler(virq, &tps6586x_irq_chip, handle_simple_irq);
 279        irq_set_nested_thread(virq, 1);
 280
 281        /* ARM needs us to explicitly flag the IRQ as valid
 282         * and will set them noprobe when we do so. */
 283#ifdef CONFIG_ARM
 284        set_irq_flags(virq, IRQF_VALID);
 285#else
 286        irq_set_noprobe(virq);
 287#endif
 288
 289        return 0;
 290}
 291
 292static struct irq_domain_ops tps6586x_domain_ops = {
 293        .map    = tps6586x_irq_map,
 294        .xlate  = irq_domain_xlate_twocell,
 295};
 296
 297static irqreturn_t tps6586x_irq(int irq, void *data)
 298{
 299        struct tps6586x *tps6586x = data;
 300        u32 acks;
 301        int ret = 0;
 302
 303        ret = tps6586x_reads(tps6586x->dev, TPS6586X_INT_ACK1,
 304                             sizeof(acks), (uint8_t *)&acks);
 305
 306        if (ret < 0) {
 307                dev_err(tps6586x->dev, "failed to read interrupt status\n");
 308                return IRQ_NONE;
 309        }
 310
 311        acks = le32_to_cpu(acks);
 312
 313        while (acks) {
 314                int i = __ffs(acks);
 315
 316                if (tps6586x->irq_en & (1 << i))
 317                        handle_nested_irq(
 318                                irq_find_mapping(tps6586x->irq_domain, i));
 319
 320                acks &= ~(1 << i);
 321        }
 322
 323        return IRQ_HANDLED;
 324}
 325
 326static int tps6586x_irq_init(struct tps6586x *tps6586x, int irq,
 327                                       int irq_base)
 328{
 329        int i, ret;
 330        u8 tmp[4];
 331        int new_irq_base;
 332        int irq_num = ARRAY_SIZE(tps6586x_irqs);
 333
 334        mutex_init(&tps6586x->irq_lock);
 335        for (i = 0; i < 5; i++) {
 336                tps6586x->mask_reg[i] = 0xff;
 337                tps6586x_write(tps6586x->dev, TPS6586X_INT_MASK1 + i, 0xff);
 338        }
 339
 340        tps6586x_reads(tps6586x->dev, TPS6586X_INT_ACK1, sizeof(tmp), tmp);
 341
 342        if  (irq_base > 0) {
 343                new_irq_base = irq_alloc_descs(irq_base, 0, irq_num, -1);
 344                if (new_irq_base < 0) {
 345                        dev_err(tps6586x->dev,
 346                                "Failed to alloc IRQs: %d\n", new_irq_base);
 347                        return new_irq_base;
 348                }
 349        } else {
 350                new_irq_base = 0;
 351        }
 352
 353        tps6586x->irq_domain = irq_domain_add_simple(tps6586x->dev->of_node,
 354                                irq_num, new_irq_base, &tps6586x_domain_ops,
 355                                tps6586x);
 356        if (!tps6586x->irq_domain) {
 357                dev_err(tps6586x->dev, "Failed to create IRQ domain\n");
 358                return -ENOMEM;
 359        }
 360        ret = request_threaded_irq(irq, NULL, tps6586x_irq, IRQF_ONESHOT,
 361                                   "tps6586x", tps6586x);
 362
 363        if (!ret) {
 364                device_init_wakeup(tps6586x->dev, 1);
 365                enable_irq_wake(irq);
 366        }
 367
 368        return ret;
 369}
 370
 371static int tps6586x_add_subdevs(struct tps6586x *tps6586x,
 372                                          struct tps6586x_platform_data *pdata)
 373{
 374        struct tps6586x_subdev_info *subdev;
 375        struct platform_device *pdev;
 376        int i, ret = 0;
 377
 378        for (i = 0; i < pdata->num_subdevs; i++) {
 379                subdev = &pdata->subdevs[i];
 380
 381                pdev = platform_device_alloc(subdev->name, subdev->id);
 382                if (!pdev) {
 383                        ret = -ENOMEM;
 384                        goto failed;
 385                }
 386
 387                pdev->dev.parent = tps6586x->dev;
 388                pdev->dev.platform_data = subdev->platform_data;
 389                pdev->dev.of_node = subdev->of_node;
 390
 391                ret = platform_device_add(pdev);
 392                if (ret) {
 393                        platform_device_put(pdev);
 394                        goto failed;
 395                }
 396        }
 397        return 0;
 398
 399failed:
 400        tps6586x_remove_subdevs(tps6586x);
 401        return ret;
 402}
 403
 404#ifdef CONFIG_OF
 405static struct tps6586x_platform_data *tps6586x_parse_dt(struct i2c_client *client)
 406{
 407        struct device_node *np = client->dev.of_node;
 408        struct tps6586x_platform_data *pdata;
 409
 410        pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
 411        if (!pdata) {
 412                dev_err(&client->dev, "Memory allocation failed\n");
 413                return NULL;
 414        }
 415
 416        pdata->num_subdevs = 0;
 417        pdata->subdevs = NULL;
 418        pdata->gpio_base = -1;
 419        pdata->irq_base = -1;
 420        pdata->pm_off = of_property_read_bool(np, "ti,system-power-controller");
 421
 422        return pdata;
 423}
 424
 425static struct of_device_id tps6586x_of_match[] = {
 426        { .compatible = "ti,tps6586x", },
 427        { },
 428};
 429#else
 430static struct tps6586x_platform_data *tps6586x_parse_dt(struct i2c_client *client)
 431{
 432        return NULL;
 433}
 434#endif
 435
 436static bool is_volatile_reg(struct device *dev, unsigned int reg)
 437{
 438        /* Cache all interrupt mask register */
 439        if ((reg >= TPS6586X_INT_MASK1) && (reg <= TPS6586X_INT_MASK5))
 440                return false;
 441
 442        return true;
 443}
 444
 445static const struct regmap_config tps6586x_regmap_config = {
 446        .reg_bits = 8,
 447        .val_bits = 8,
 448        .max_register = TPS6586X_MAX_REGISTER - 1,
 449        .volatile_reg = is_volatile_reg,
 450        .cache_type = REGCACHE_RBTREE,
 451};
 452
 453static struct device *tps6586x_dev;
 454static void tps6586x_power_off(void)
 455{
 456        if (tps6586x_clr_bits(tps6586x_dev, TPS6586X_SUPPLYENE, EXITSLREQ_BIT))
 457                return;
 458
 459        tps6586x_set_bits(tps6586x_dev, TPS6586X_SUPPLYENE, SLEEP_MODE_BIT);
 460}
 461
 462static int tps6586x_i2c_probe(struct i2c_client *client,
 463                                        const struct i2c_device_id *id)
 464{
 465        struct tps6586x_platform_data *pdata = client->dev.platform_data;
 466        struct tps6586x *tps6586x;
 467        int ret;
 468
 469        if (!pdata && client->dev.of_node)
 470                pdata = tps6586x_parse_dt(client);
 471
 472        if (!pdata) {
 473                dev_err(&client->dev, "tps6586x requires platform data\n");
 474                return -ENOTSUPP;
 475        }
 476
 477        ret = i2c_smbus_read_byte_data(client, TPS6586X_VERSIONCRC);
 478        if (ret < 0) {
 479                dev_err(&client->dev, "Chip ID read failed: %d\n", ret);
 480                return -EIO;
 481        }
 482
 483        dev_info(&client->dev, "VERSIONCRC is %02x\n", ret);
 484
 485        tps6586x = devm_kzalloc(&client->dev, sizeof(*tps6586x), GFP_KERNEL);
 486        if (tps6586x == NULL) {
 487                dev_err(&client->dev, "memory for tps6586x alloc failed\n");
 488                return -ENOMEM;
 489        }
 490
 491        tps6586x->client = client;
 492        tps6586x->dev = &client->dev;
 493        i2c_set_clientdata(client, tps6586x);
 494
 495        tps6586x->regmap = devm_regmap_init_i2c(client,
 496                                        &tps6586x_regmap_config);
 497        if (IS_ERR(tps6586x->regmap)) {
 498                ret = PTR_ERR(tps6586x->regmap);
 499                dev_err(&client->dev, "regmap init failed: %d\n", ret);
 500                return ret;
 501        }
 502
 503
 504        if (client->irq) {
 505                ret = tps6586x_irq_init(tps6586x, client->irq,
 506                                        pdata->irq_base);
 507                if (ret) {
 508                        dev_err(&client->dev, "IRQ init failed: %d\n", ret);
 509                        return ret;
 510                }
 511        }
 512
 513        ret = mfd_add_devices(tps6586x->dev, -1,
 514                              tps6586x_cell, ARRAY_SIZE(tps6586x_cell),
 515                              NULL, 0, tps6586x->irq_domain);
 516        if (ret < 0) {
 517                dev_err(&client->dev, "mfd_add_devices failed: %d\n", ret);
 518                goto err_mfd_add;
 519        }
 520
 521        ret = tps6586x_add_subdevs(tps6586x, pdata);
 522        if (ret) {
 523                dev_err(&client->dev, "add devices failed: %d\n", ret);
 524                goto err_add_devs;
 525        }
 526
 527        if (pdata->pm_off && !pm_power_off) {
 528                tps6586x_dev = &client->dev;
 529                pm_power_off = tps6586x_power_off;
 530        }
 531
 532        return 0;
 533
 534err_add_devs:
 535        mfd_remove_devices(tps6586x->dev);
 536err_mfd_add:
 537        if (client->irq)
 538                free_irq(client->irq, tps6586x);
 539        return ret;
 540}
 541
 542static int tps6586x_i2c_remove(struct i2c_client *client)
 543{
 544        struct tps6586x *tps6586x = i2c_get_clientdata(client);
 545
 546        tps6586x_remove_subdevs(tps6586x);
 547        mfd_remove_devices(tps6586x->dev);
 548        if (client->irq)
 549                free_irq(client->irq, tps6586x);
 550        return 0;
 551}
 552
 553static const struct i2c_device_id tps6586x_id_table[] = {
 554        { "tps6586x", 0 },
 555        { },
 556};
 557MODULE_DEVICE_TABLE(i2c, tps6586x_id_table);
 558
 559static struct i2c_driver tps6586x_driver = {
 560        .driver = {
 561                .name   = "tps6586x",
 562                .owner  = THIS_MODULE,
 563                .of_match_table = of_match_ptr(tps6586x_of_match),
 564        },
 565        .probe          = tps6586x_i2c_probe,
 566        .remove         = tps6586x_i2c_remove,
 567        .id_table       = tps6586x_id_table,
 568};
 569
 570static int __init tps6586x_init(void)
 571{
 572        return i2c_add_driver(&tps6586x_driver);
 573}
 574subsys_initcall(tps6586x_init);
 575
 576static void __exit tps6586x_exit(void)
 577{
 578        i2c_del_driver(&tps6586x_driver);
 579}
 580module_exit(tps6586x_exit);
 581
 582MODULE_DESCRIPTION("TPS6586X core driver");
 583MODULE_AUTHOR("Mike Rapoport <mike@compulab.co.il>");
 584MODULE_LICENSE("GPL");
 585
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.