drivers/mfd/tps65910.c

   1 /*
   2  * tps65910.c  --  TI TPS6591x
   3  *
   4  * Copyright 2010 Texas Instruments Inc.
   5  *
   6  * Author: Graeme Gregory <gg@slimlogic.co.uk>
   7  * Author: Jorge Eduardo Candelaria <jedu@slimlogic.co.uk>
   8  *
   9  *  This program is free software; you can redistribute it and/or modify it
  10  *  under  the terms of the GNU General  Public License as published by the
  11  *  Free Software Foundation;  either version 2 of the License, or (at your
  12  *  option) any later version.
  13  *
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/moduleparam.h>
  18 #include <linux/init.h>
  19 #include <linux/err.h>
  20 #include <linux/slab.h>
  21 #include <linux/i2c.h>
  22 #include <linux/interrupt.h>
  23 #include <linux/irq.h>
  24 #include <linux/irqdomain.h>
  25 #include <linux/mfd/core.h>
  26 #include <linux/regmap.h>
  27 #include <linux/mfd/tps65910.h>
  28 #include <linux/of_device.h>
  29
  30 static struct resource rtc_resources[] = {
  31         {
  32                 .start  = TPS65910_IRQ_RTC_ALARM,
  33                 .end    = TPS65910_IRQ_RTC_ALARM,
  34                 .flags  = IORESOURCE_IRQ,
  35         }
  36 };
  37
  38 static struct mfd_cell tps65910s[] = {
  39         {
  40                 .name = "tps65910-gpio",
  41         },
  42         {
  43                 .name = "tps65910-pmic",
  44         },
  45         {
  46                 .name = "tps65910-rtc",
  47                 .num_resources = ARRAY_SIZE(rtc_resources),
  48                 .resources = &rtc_resources[0],
  49         },
  50         {
  51                 .name = "tps65910-power",
  52         },
  53 };
  54
  55
  56 static const struct regmap_irq tps65911_irqs[] = {
  57         /* INT_STS */
  58         [TPS65911_IRQ_PWRHOLD_F] = {
  59                 .mask = INT_MSK_PWRHOLD_F_IT_MSK_MASK,
  60                 .reg_offset = 0,
  61         },
  62         [TPS65911_IRQ_VBAT_VMHI] = {
  63                 .mask = INT_MSK_VMBHI_IT_MSK_MASK,
  64                 .reg_offset = 0,
  65         },
  66         [TPS65911_IRQ_PWRON] = {
  67                 .mask = INT_MSK_PWRON_IT_MSK_MASK,
  68                 .reg_offset = 0,
  69         },
  70         [TPS65911_IRQ_PWRON_LP] = {
  71                 .mask = INT_MSK_PWRON_LP_IT_MSK_MASK,
  72                 .reg_offset = 0,
  73         },
  74         [TPS65911_IRQ_PWRHOLD_R] = {
  75                 .mask = INT_MSK_PWRHOLD_R_IT_MSK_MASK,
  76                 .reg_offset = 0,
  77         },
  78         [TPS65911_IRQ_HOTDIE] = {
  79                 .mask = INT_MSK_HOTDIE_IT_MSK_MASK,
  80                 .reg_offset = 0,
  81         },
  82         [TPS65911_IRQ_RTC_ALARM] = {
  83                 .mask = INT_MSK_RTC_ALARM_IT_MSK_MASK,
  84                 .reg_offset = 0,
  85         },
  86         [TPS65911_IRQ_RTC_PERIOD] = {
  87                 .mask = INT_MSK_RTC_PERIOD_IT_MSK_MASK,
  88                 .reg_offset = 0,
  89         },
  90
  91         /* INT_STS2 */
  92         [TPS65911_IRQ_GPIO0_R] = {
  93                 .mask = INT_MSK2_GPIO0_R_IT_MSK_MASK,
  94                 .reg_offset = 1,
  95         },
  96         [TPS65911_IRQ_GPIO0_F] = {
  97                 .mask = INT_MSK2_GPIO0_F_IT_MSK_MASK,
  98                 .reg_offset = 1,
  99         },
 100         [TPS65911_IRQ_GPIO1_R] = {
 101                 .mask = INT_MSK2_GPIO1_R_IT_MSK_MASK,
 102                 .reg_offset = 1,
 103         },
 104         [TPS65911_IRQ_GPIO1_F] = {
 105                 .mask = INT_MSK2_GPIO1_F_IT_MSK_MASK,
 106                 .reg_offset = 1,
 107         },
 108         [TPS65911_IRQ_GPIO2_R] = {
 109                 .mask = INT_MSK2_GPIO2_R_IT_MSK_MASK,
 110                 .reg_offset = 1,
 111         },
 112         [TPS65911_IRQ_GPIO2_F] = {
 113                 .mask = INT_MSK2_GPIO2_F_IT_MSK_MASK,
 114                 .reg_offset = 1,
 115         },
 116         [TPS65911_IRQ_GPIO3_R] = {
 117                 .mask = INT_MSK2_GPIO3_R_IT_MSK_MASK,
 118                 .reg_offset = 1,
 119         },
 120         [TPS65911_IRQ_GPIO3_F] = {
 121                 .mask = INT_MSK2_GPIO3_F_IT_MSK_MASK,
 122                 .reg_offset = 1,
 123         },
 124
 125         /* INT_STS2 */
 126         [TPS65911_IRQ_GPIO4_R] = {
 127                 .mask = INT_MSK3_GPIO4_R_IT_MSK_MASK,
 128                 .reg_offset = 2,
 129         },
 130         [TPS65911_IRQ_GPIO4_F] = {
 131                 .mask = INT_MSK3_GPIO4_F_IT_MSK_MASK,
 132                 .reg_offset = 2,
 133         },
 134         [TPS65911_IRQ_GPIO5_R] = {
 135                 .mask = INT_MSK3_GPIO5_R_IT_MSK_MASK,
 136                 .reg_offset = 2,
 137         },
 138         [TPS65911_IRQ_GPIO5_F] = {
 139                 .mask = INT_MSK3_GPIO5_F_IT_MSK_MASK,
 140                 .reg_offset = 2,
 141         },
 142         [TPS65911_IRQ_WTCHDG] = {
 143                 .mask = INT_MSK3_WTCHDG_IT_MSK_MASK,
 144                 .reg_offset = 2,
 145         },
 146         [TPS65911_IRQ_VMBCH2_H] = {
 147                 .mask = INT_MSK3_VMBCH2_H_IT_MSK_MASK,
 148                 .reg_offset = 2,
 149         },
 150         [TPS65911_IRQ_VMBCH2_L] = {
 151                 .mask = INT_MSK3_VMBCH2_L_IT_MSK_MASK,
 152                 .reg_offset = 2,
 153         },
 154         [TPS65911_IRQ_PWRDN] = {
 155                 .mask = INT_MSK3_PWRDN_IT_MSK_MASK,
 156                 .reg_offset = 2,
 157         },
 158 };
 159
 160 static const struct regmap_irq tps65910_irqs[] = {
 161         /* INT_STS */
 162         [TPS65910_IRQ_VBAT_VMBDCH] = {
 163                 .mask = TPS65910_INT_MSK_VMBDCH_IT_MSK_MASK,
 164                 .reg_offset = 0,
 165         },
 166         [TPS65910_IRQ_VBAT_VMHI] = {
 167                 .mask = TPS65910_INT_MSK_VMBHI_IT_MSK_MASK,
 168                 .reg_offset = 0,
 169         },
 170         [TPS65910_IRQ_PWRON] = {
 171                 .mask = TPS65910_INT_MSK_PWRON_IT_MSK_MASK,
 172                 .reg_offset = 0,
 173         },
 174         [TPS65910_IRQ_PWRON_LP] = {
 175                 .mask = TPS65910_INT_MSK_PWRON_LP_IT_MSK_MASK,
 176                 .reg_offset = 0,
 177         },
 178         [TPS65910_IRQ_PWRHOLD] = {
 179                 .mask = TPS65910_INT_MSK_PWRHOLD_IT_MSK_MASK,
 180                 .reg_offset = 0,
 181         },
 182         [TPS65910_IRQ_HOTDIE] = {
 183                 .mask = TPS65910_INT_MSK_HOTDIE_IT_MSK_MASK,
 184                 .reg_offset = 0,
 185         },
 186         [TPS65910_IRQ_RTC_ALARM] = {
 187                 .mask = TPS65910_INT_MSK_RTC_ALARM_IT_MSK_MASK,
 188                 .reg_offset = 0,
 189         },
 190         [TPS65910_IRQ_RTC_PERIOD] = {
 191                 .mask = TPS65910_INT_MSK_RTC_PERIOD_IT_MSK_MASK,
 192                 .reg_offset = 0,
 193         },
 194
 195         /* INT_STS2 */
 196         [TPS65910_IRQ_GPIO_R] = {
 197                 .mask = TPS65910_INT_MSK2_GPIO0_F_IT_MSK_MASK,
 198                 .reg_offset = 1,
 199         },
 200         [TPS65910_IRQ_GPIO_F] = {
 201                 .mask = TPS65910_INT_MSK2_GPIO0_R_IT_MSK_MASK,
 202                 .reg_offset = 1,
 203         },
 204 };
 205
 206 static struct regmap_irq_chip tps65911_irq_chip = {
 207         .name = "tps65910",
 208         .irqs = tps65911_irqs,
 209         .num_irqs = ARRAY_SIZE(tps65911_irqs),
 210         .num_regs = 3,
 211         .irq_reg_stride = 2,
 212         .status_base = TPS65910_INT_STS,
 213         .mask_base = TPS65910_INT_MSK,
 214         .ack_base = TPS65910_INT_STS,
 215 };
 216
 217 static struct regmap_irq_chip tps65910_irq_chip = {
 218         .name = "tps65910",
 219         .irqs = tps65910_irqs,
 220         .num_irqs = ARRAY_SIZE(tps65910_irqs),
 221         .num_regs = 2,
 222         .irq_reg_stride = 2,
 223         .status_base = TPS65910_INT_STS,
 224         .mask_base = TPS65910_INT_MSK,
 225         .ack_base = TPS65910_INT_STS,
 226 };
 227
 228 static int tps65910_irq_init(struct tps65910 *tps65910, int irq,
 229                     struct tps65910_platform_data *pdata)
 230 {
 231         int ret = 0;
 232         static struct regmap_irq_chip *tps6591x_irqs_chip;
 233
 234         if (!irq) {
 235                 dev_warn(tps65910->dev, "No interrupt support, no core IRQ\n");
 236                 return -EINVAL;
 237         }
 238
 239         if (!pdata) {
 240                 dev_warn(tps65910->dev, "No interrupt support, no pdata\n");
 241                 return -EINVAL;
 242         }
 243
 244         switch (tps65910_chip_id(tps65910)) {
 245         case TPS65910:
 246                 tps6591x_irqs_chip = &tps65910_irq_chip;
 247                 break;
 248         case TPS65911:
 249                 tps6591x_irqs_chip = &tps65911_irq_chip;
 250                 break;
 251         }
 252
 253         tps65910->chip_irq = irq;
 254         ret = regmap_add_irq_chip(tps65910->regmap, tps65910->chip_irq,
 255                 IRQF_ONESHOT, pdata->irq_base,
 256                 tps6591x_irqs_chip, &tps65910->irq_data);
 257         if (ret < 0) {
 258                 dev_warn(tps65910->dev, "Failed to add irq_chip %d\n", ret);
 259                 tps65910->chip_irq = 0;
 260         }
 261         return ret;
 262 }
 263
 264 static int tps65910_irq_exit(struct tps65910 *tps65910)
 265 {
 266         if (tps65910->chip_irq > 0)
 267                 regmap_del_irq_chip(tps65910->chip_irq, tps65910->irq_data);
 268         return 0;
 269 }
 270
 271 static bool is_volatile_reg(struct device *dev, unsigned int reg)
 272 {
 273         struct tps65910 *tps65910 = dev_get_drvdata(dev);
 274
 275         /*
 276          * Caching all regulator registers.
 277          * All regualator register address range is same for
 278          * TPS65910 and TPS65911
 279          */
 280         if ((reg >= TPS65910_VIO) && (reg <= TPS65910_VDAC)) {
 281                 /* Check for non-existing register */
 282                 if (tps65910_chip_id(tps65910) == TPS65910)
 283                         if ((reg == TPS65911_VDDCTRL_OP) ||
 284                                 (reg == TPS65911_VDDCTRL_SR))
 285                                 return true;
 286                 return false;
 287         }
 288         return true;
 289 }
 290
 291 static const struct regmap_config tps65910_regmap_config = {
 292         .reg_bits = 8,
 293         .val_bits = 8,
 294         .volatile_reg = is_volatile_reg,
 295         .max_register = TPS65910_MAX_REGISTER - 1,
 296         .cache_type = REGCACHE_RBTREE,
 297 };
 298
 299 static int tps65910_ck32k_init(struct tps65910 *tps65910,
 300                                         struct tps65910_board *pmic_pdata)
 301 {
 302         int ret;
 303
 304         if (!pmic_pdata->en_ck32k_xtal)
 305                 return 0;
 306
 307         ret = tps65910_reg_clear_bits(tps65910, TPS65910_DEVCTRL,
 308                                                 DEVCTRL_CK32K_CTRL_MASK);
 309         if (ret < 0) {
 310                 dev_err(tps65910->dev, "clear ck32k_ctrl failed: %d\n", ret);
 311                 return ret;
 312         }
 313
 314         return 0;
 315 }
 316
 317 static int tps65910_sleepinit(struct tps65910 *tps65910,
 318                 struct tps65910_board *pmic_pdata)
 319 {
 320         struct device *dev = NULL;
 321         int ret = 0;
 322
 323         dev = tps65910->dev;
 324
 325         if (!pmic_pdata->en_dev_slp)
 326                 return 0;
 327
 328         /* enabling SLEEP device state */
 329         ret = tps65910_reg_set_bits(tps65910, TPS65910_DEVCTRL,
 330                                 DEVCTRL_DEV_SLP_MASK);
 331         if (ret < 0) {
 332                 dev_err(dev, "set dev_slp failed: %d\n", ret);
 333                 goto err_sleep_init;
 334         }
 335
 336         /* Return if there is no sleep keepon data. */
 337         if (!pmic_pdata->slp_keepon)
 338                 return 0;
 339
 340         if (pmic_pdata->slp_keepon->therm_keepon) {
 341                 ret = tps65910_reg_set_bits(tps65910,
 342                                 TPS65910_SLEEP_KEEP_RES_ON,
 343                                 SLEEP_KEEP_RES_ON_THERM_KEEPON_MASK);
 344                 if (ret < 0) {
 345                         dev_err(dev, "set therm_keepon failed: %d\n", ret);
 346                         goto disable_dev_slp;
 347                 }
 348         }
 349
 350         if (pmic_pdata->slp_keepon->clkout32k_keepon) {
 351                 ret = tps65910_reg_set_bits(tps65910,
 352                                 TPS65910_SLEEP_KEEP_RES_ON,
 353                                 SLEEP_KEEP_RES_ON_CLKOUT32K_KEEPON_MASK);
 354                 if (ret < 0) {
 355                         dev_err(dev, "set clkout32k_keepon failed: %d\n", ret);
 356                         goto disable_dev_slp;
 357                 }
 358         }
 359
 360         if (pmic_pdata->slp_keepon->i2chs_keepon) {
 361                 ret = tps65910_reg_set_bits(tps65910,
 362                                 TPS65910_SLEEP_KEEP_RES_ON,
 363                                 SLEEP_KEEP_RES_ON_I2CHS_KEEPON_MASK);
 364                 if (ret < 0) {
 365                         dev_err(dev, "set i2chs_keepon failed: %d\n", ret);
 366                         goto disable_dev_slp;
 367                 }
 368         }
 369
 370         return 0;
 371
 372 disable_dev_slp:
 373         tps65910_reg_clear_bits(tps65910, TPS65910_DEVCTRL,
 374                                 DEVCTRL_DEV_SLP_MASK);
 375
 376 err_sleep_init:
 377         return ret;
 378 }
 379
 380 #ifdef CONFIG_OF
 381 static struct of_device_id tps65910_of_match[] = {
 382         { .compatible = "ti,tps65910", .data = (void *)TPS65910},
 383         { .compatible = "ti,tps65911", .data = (void *)TPS65911},
 384         { },
 385 };
 386 MODULE_DEVICE_TABLE(of, tps65910_of_match);
 387
 388 static struct tps65910_board *tps65910_parse_dt(struct i2c_client *client,
 389                                                 int *chip_id)
 390 {
 391         struct device_node *np = client->dev.of_node;
 392         struct tps65910_board *board_info;
 393         unsigned int prop;
 394         const struct of_device_id *match;
 395         int ret = 0;
 396
 397         match = of_match_device(tps65910_of_match, &client->dev);
 398         if (!match) {
 399                 dev_err(&client->dev, "Failed to find matching dt id\n");
 400                 return NULL;
 401         }
 402
 403         *chip_id  = (int)match->data;
 404
 405         board_info = devm_kzalloc(&client->dev, sizeof(*board_info),
 406                         GFP_KERNEL);
 407         if (!board_info) {
 408                 dev_err(&client->dev, "Failed to allocate pdata\n");
 409                 return NULL;
 410         }
 411
 412         ret = of_property_read_u32(np, "ti,vmbch-threshold", &prop);
 413         if (!ret)
 414                 board_info->vmbch_threshold = prop;
 415         else if (*chip_id == TPS65911)
 416                 dev_warn(&client->dev, "VMBCH-Threshold not specified");
 417
 418         ret = of_property_read_u32(np, "ti,vmbch2-threshold", &prop);
 419         if (!ret)
 420                 board_info->vmbch2_threshold = prop;
 421         else if (*chip_id == TPS65911)
 422                 dev_warn(&client->dev, "VMBCH2-Threshold not specified");
 423
 424         prop = of_property_read_bool(np, "ti,en-ck32k-xtal");
 425         board_info->en_ck32k_xtal = prop;
 426
 427         board_info->irq = client->irq;
 428         board_info->irq_base = -1;
 429         board_info->pm_off = of_property_read_bool(np,
 430                         "ti,system-power-controller");
 431
 432         return board_info;
 433 }
 434 #else
 435 static inline
 436 struct tps65910_board *tps65910_parse_dt(struct i2c_client *client,
 437                                          int *chip_id)
 438 {
 439         return NULL;
 440 }
 441 #endif
 442
 443 static struct i2c_client *tps65910_i2c_client;
 444 static void tps65910_power_off(void)
 445 {
 446         struct tps65910 *tps65910;
 447
 448         tps65910 = dev_get_drvdata(&tps65910_i2c_client->dev);
 449
 450         if (tps65910_reg_set_bits(tps65910, TPS65910_DEVCTRL,
 451                         DEVCTRL_PWR_OFF_MASK) < 0)
 452                 return;
 453
 454         tps65910_reg_clear_bits(tps65910, TPS65910_DEVCTRL,
 455                         DEVCTRL_DEV_ON_MASK);
 456 }
 457
 458 static int tps65910_i2c_probe(struct i2c_client *i2c,
 459                                         const struct i2c_device_id *id)
 460 {
 461         struct tps65910 *tps65910;
 462         struct tps65910_board *pmic_plat_data;
 463         struct tps65910_board *of_pmic_plat_data = NULL;
 464         struct tps65910_platform_data *init_data;
 465         int ret = 0;
 466         int chip_id = id->driver_data;
 467
 468         pmic_plat_data = dev_get_platdata(&i2c->dev);
 469
 470         if (!pmic_plat_data && i2c->dev.of_node) {
 471                 pmic_plat_data = tps65910_parse_dt(i2c, &chip_id);
 472                 of_pmic_plat_data = pmic_plat_data;
 473         }
 474
 475         if (!pmic_plat_data)
 476                 return -EINVAL;
 477
 478         init_data = devm_kzalloc(&i2c->dev, sizeof(*init_data), GFP_KERNEL);
 479         if (init_data == NULL)
 480                 return -ENOMEM;
 481
 482         tps65910 = devm_kzalloc(&i2c->dev, sizeof(*tps65910), GFP_KERNEL);
 483         if (tps65910 == NULL)
 484                 return -ENOMEM;
 485
 486         tps65910->of_plat_data = of_pmic_plat_data;
 487         i2c_set_clientdata(i2c, tps65910);
 488         tps65910->dev = &i2c->dev;
 489         tps65910->i2c_client = i2c;
 490         tps65910->id = chip_id;
 491
 492         tps65910->regmap = devm_regmap_init_i2c(i2c, &tps65910_regmap_config);
 493         if (IS_ERR(tps65910->regmap)) {
 494                 ret = PTR_ERR(tps65910->regmap);
 495                 dev_err(&i2c->dev, "regmap initialization failed: %d\n", ret);
 496                 return ret;
 497         }
 498
 499         init_data->irq = pmic_plat_data->irq;
 500         init_data->irq_base = pmic_plat_data->irq_base;
 501
 502         tps65910_irq_init(tps65910, init_data->irq, init_data);
 503         tps65910_ck32k_init(tps65910, pmic_plat_data);
 504         tps65910_sleepinit(tps65910, pmic_plat_data);
 505
 506         if (pmic_plat_data->pm_off && !pm_power_off) {
 507                 tps65910_i2c_client = i2c;
 508                 pm_power_off = tps65910_power_off;
 509         }
 510
 511         ret = mfd_add_devices(tps65910->dev, -1,
 512                               tps65910s, ARRAY_SIZE(tps65910s),
 513                               NULL, 0,
 514                               regmap_irq_get_domain(tps65910->irq_data));
 515         if (ret < 0) {
 516                 dev_err(&i2c->dev, "mfd_add_devices failed: %d\n", ret);
 517                 return ret;
 518         }
 519
 520         return ret;
 521 }
 522
 523 static int tps65910_i2c_remove(struct i2c_client *i2c)
 524 {
 525         struct tps65910 *tps65910 = i2c_get_clientdata(i2c);
 526
 527         tps65910_irq_exit(tps65910);
 528         mfd_remove_devices(tps65910->dev);
 529
 530         return 0;
 531 }
 532
 533 static const struct i2c_device_id tps65910_i2c_id[] = {
 534        { "tps65910", TPS65910 },
 535        { "tps65911", TPS65911 },
 536        { }
 537 };
 538 MODULE_DEVICE_TABLE(i2c, tps65910_i2c_id);
 539
 540
 541 static struct i2c_driver tps65910_i2c_driver = {
 542         .driver = {
 543                    .name = "tps65910",
 544                    .owner = THIS_MODULE,
 545                    .of_match_table = of_match_ptr(tps65910_of_match),
 546         },
 547         .probe = tps65910_i2c_probe,
 548         .remove = tps65910_i2c_remove,
 549         .id_table = tps65910_i2c_id,
 550 };
 551
 552 static int __init tps65910_i2c_init(void)
 553 {
 554         return i2c_add_driver(&tps65910_i2c_driver);
 555 }
 556 /* init early so consumer devices can complete system boot */
 557 subsys_initcall(tps65910_i2c_init);
 558
 559 static void __exit tps65910_i2c_exit(void)
 560 {
 561         i2c_del_driver(&tps65910_i2c_driver);
 562 }
 563 module_exit(tps65910_i2c_exit);
 564
 565 MODULE_AUTHOR("Graeme Gregory <gg@slimlogic.co.uk>");
 566 MODULE_AUTHOR("Jorge Eduardo Candelaria <jedu@slimlogic.co.uk>");
 567 MODULE_DESCRIPTION("TPS6591x chip family multi-function driver");
 568 MODULE_LICENSE("GPL");