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