2 * Core driver for TI TPS6586x PMIC family
4 * Copyright (c) 2010 CompuLab Ltd.
5 * Mike Rapoport <mike@compulab.co.il>
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>
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.
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/regulator/of_regulator.h>
30 #include <linux/regulator/machine.h>
32 #include <linux/mfd/core.h>
33 #include <linux/mfd/tps6586x.h>
35 #define TPS6586X_SUPPLYENE 0x14
36 #define EXITSLREQ_BIT BIT(1)
37 #define SLEEP_MODE_BIT BIT(3)
39 /* interrupt control registers */
40 #define TPS6586X_INT_ACK1 0xb5
41 #define TPS6586X_INT_ACK2 0xb6
42 #define TPS6586X_INT_ACK3 0xb7
43 #define TPS6586X_INT_ACK4 0xb8
45 /* interrupt mask registers */
46 #define TPS6586X_INT_MASK1 0xb0
47 #define TPS6586X_INT_MASK2 0xb1
48 #define TPS6586X_INT_MASK3 0xb2
49 #define TPS6586X_INT_MASK4 0xb3
50 #define TPS6586X_INT_MASK5 0xb4
53 #define TPS6586X_VERSIONCRC 0xcd
55 /* Maximum register */
56 #define TPS6586X_MAX_REGISTER (TPS6586X_VERSIONCRC + 1)
58 struct tps6586x_irq_data {
63 #define TPS6586X_IRQ(_reg, _mask) \
65 .mask_reg = (_reg) - TPS6586X_INT_MASK1, \
66 .mask_mask = (_mask), \
69 static const struct tps6586x_irq_data tps6586x_irqs[] = {
70 [TPS6586X_INT_PLDO_0] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 0),
71 [TPS6586X_INT_PLDO_1] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 1),
72 [TPS6586X_INT_PLDO_2] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 2),
73 [TPS6586X_INT_PLDO_3] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 3),
74 [TPS6586X_INT_PLDO_4] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 4),
75 [TPS6586X_INT_PLDO_5] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 5),
76 [TPS6586X_INT_PLDO_6] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 6),
77 [TPS6586X_INT_PLDO_7] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 7),
78 [TPS6586X_INT_COMP_DET] = TPS6586X_IRQ(TPS6586X_INT_MASK4, 1 << 0),
79 [TPS6586X_INT_ADC] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 1),
80 [TPS6586X_INT_PLDO_8] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 2),
81 [TPS6586X_INT_PLDO_9] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 3),
82 [TPS6586X_INT_PSM_0] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 4),
83 [TPS6586X_INT_PSM_1] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 5),
84 [TPS6586X_INT_PSM_2] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 6),
85 [TPS6586X_INT_PSM_3] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 7),
86 [TPS6586X_INT_RTC_ALM1] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 4),
87 [TPS6586X_INT_ACUSB_OVP] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 0x03),
88 [TPS6586X_INT_USB_DET] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 2),
89 [TPS6586X_INT_AC_DET] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 3),
90 [TPS6586X_INT_BAT_DET] = TPS6586X_IRQ(TPS6586X_INT_MASK3, 1 << 0),
91 [TPS6586X_INT_CHG_STAT] = TPS6586X_IRQ(TPS6586X_INT_MASK4, 0xfc),
92 [TPS6586X_INT_CHG_TEMP] = TPS6586X_IRQ(TPS6586X_INT_MASK3, 0x06),
93 [TPS6586X_INT_PP] = TPS6586X_IRQ(TPS6586X_INT_MASK3, 0xf0),
94 [TPS6586X_INT_RESUME] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 5),
95 [TPS6586X_INT_LOW_SYS] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 6),
96 [TPS6586X_INT_RTC_ALM2] = TPS6586X_IRQ(TPS6586X_INT_MASK4, 1 << 1),
99 static struct resource tps6586x_rtc_resources[] = {
101 .start = TPS6586X_INT_RTC_ALM1,
102 .end = TPS6586X_INT_RTC_ALM1,
103 .flags = IORESOURCE_IRQ,
107 static struct mfd_cell tps6586x_cell[] = {
109 .name = "tps6586x-gpio",
112 .name = "tps6586x-rtc",
113 .num_resources = ARRAY_SIZE(tps6586x_rtc_resources),
114 .resources = &tps6586x_rtc_resources[0],
117 .name = "tps6586x-onkey",
123 struct i2c_client *client;
124 struct regmap *regmap;
126 struct irq_chip irq_chip;
127 struct mutex irq_lock;
131 struct irq_domain *irq_domain;
134 static inline struct tps6586x *dev_to_tps6586x(struct device *dev)
136 return i2c_get_clientdata(to_i2c_client(dev));
139 int tps6586x_write(struct device *dev, int reg, uint8_t val)
141 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
143 return regmap_write(tps6586x->regmap, reg, val);
145 EXPORT_SYMBOL_GPL(tps6586x_write);
147 int tps6586x_writes(struct device *dev, int reg, int len, uint8_t *val)
149 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
151 return regmap_bulk_write(tps6586x->regmap, reg, val, len);
153 EXPORT_SYMBOL_GPL(tps6586x_writes);
155 int tps6586x_read(struct device *dev, int reg, uint8_t *val)
157 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
161 ret = regmap_read(tps6586x->regmap, reg, &rval);
166 EXPORT_SYMBOL_GPL(tps6586x_read);
168 int tps6586x_reads(struct device *dev, int reg, int len, uint8_t *val)
170 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
172 return regmap_bulk_read(tps6586x->regmap, reg, val, len);
174 EXPORT_SYMBOL_GPL(tps6586x_reads);
176 int tps6586x_set_bits(struct device *dev, int reg, uint8_t bit_mask)
178 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
180 return regmap_update_bits(tps6586x->regmap, reg, bit_mask, bit_mask);
182 EXPORT_SYMBOL_GPL(tps6586x_set_bits);
184 int tps6586x_clr_bits(struct device *dev, int reg, uint8_t bit_mask)
186 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
188 return regmap_update_bits(tps6586x->regmap, reg, bit_mask, 0);
190 EXPORT_SYMBOL_GPL(tps6586x_clr_bits);
192 int tps6586x_update(struct device *dev, int reg, uint8_t val, uint8_t mask)
194 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
196 return regmap_update_bits(tps6586x->regmap, reg, mask, val);
198 EXPORT_SYMBOL_GPL(tps6586x_update);
200 int tps6586x_irq_get_virq(struct device *dev, int irq)
202 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
204 return irq_create_mapping(tps6586x->irq_domain, irq);
206 EXPORT_SYMBOL_GPL(tps6586x_irq_get_virq);
208 static int __remove_subdev(struct device *dev, void *unused)
210 platform_device_unregister(to_platform_device(dev));
214 static int tps6586x_remove_subdevs(struct tps6586x *tps6586x)
216 return device_for_each_child(tps6586x->dev, NULL, __remove_subdev);
219 static void tps6586x_irq_lock(struct irq_data *data)
221 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(data);
223 mutex_lock(&tps6586x->irq_lock);
226 static void tps6586x_irq_enable(struct irq_data *irq_data)
228 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(irq_data);
229 unsigned int __irq = irq_data->hwirq;
230 const struct tps6586x_irq_data *data = &tps6586x_irqs[__irq];
232 tps6586x->mask_reg[data->mask_reg] &= ~data->mask_mask;
233 tps6586x->irq_en |= (1 << __irq);
236 static void tps6586x_irq_disable(struct irq_data *irq_data)
238 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(irq_data);
240 unsigned int __irq = irq_data->hwirq;
241 const struct tps6586x_irq_data *data = &tps6586x_irqs[__irq];
243 tps6586x->mask_reg[data->mask_reg] |= data->mask_mask;
244 tps6586x->irq_en &= ~(1 << __irq);
247 static void tps6586x_irq_sync_unlock(struct irq_data *data)
249 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(data);
252 for (i = 0; i < ARRAY_SIZE(tps6586x->mask_reg); i++) {
254 ret = tps6586x_write(tps6586x->dev,
255 TPS6586X_INT_MASK1 + i,
256 tps6586x->mask_reg[i]);
260 mutex_unlock(&tps6586x->irq_lock);
263 static struct irq_chip tps6586x_irq_chip = {
265 .irq_bus_lock = tps6586x_irq_lock,
266 .irq_bus_sync_unlock = tps6586x_irq_sync_unlock,
267 .irq_disable = tps6586x_irq_disable,
268 .irq_enable = tps6586x_irq_enable,
271 static int tps6586x_irq_map(struct irq_domain *h, unsigned int virq,
274 struct tps6586x *tps6586x = h->host_data;
276 irq_set_chip_data(virq, tps6586x);
277 irq_set_chip_and_handler(virq, &tps6586x_irq_chip, handle_simple_irq);
278 irq_set_nested_thread(virq, 1);
280 /* ARM needs us to explicitly flag the IRQ as valid
281 * and will set them noprobe when we do so. */
283 set_irq_flags(virq, IRQF_VALID);
285 irq_set_noprobe(virq);
291 static struct irq_domain_ops tps6586x_domain_ops = {
292 .map = tps6586x_irq_map,
293 .xlate = irq_domain_xlate_twocell,
296 static irqreturn_t tps6586x_irq(int irq, void *data)
298 struct tps6586x *tps6586x = data;
302 ret = tps6586x_reads(tps6586x->dev, TPS6586X_INT_ACK1,
303 sizeof(acks), (uint8_t *)&acks);
306 dev_err(tps6586x->dev, "failed to read interrupt status\n");
310 acks = le32_to_cpu(acks);
315 if (tps6586x->irq_en & (1 << i))
317 irq_find_mapping(tps6586x->irq_domain, i));
325 static int __devinit tps6586x_irq_init(struct tps6586x *tps6586x, int irq,
331 int irq_num = ARRAY_SIZE(tps6586x_irqs);
333 mutex_init(&tps6586x->irq_lock);
334 for (i = 0; i < 5; i++) {
335 tps6586x->mask_reg[i] = 0xff;
336 tps6586x_write(tps6586x->dev, TPS6586X_INT_MASK1 + i, 0xff);
339 tps6586x_reads(tps6586x->dev, TPS6586X_INT_ACK1, sizeof(tmp), tmp);
342 new_irq_base = irq_alloc_descs(irq_base, 0, irq_num, -1);
343 if (new_irq_base < 0) {
344 dev_err(tps6586x->dev,
345 "Failed to alloc IRQs: %d\n", new_irq_base);
352 tps6586x->irq_domain = irq_domain_add_simple(tps6586x->dev->of_node,
353 irq_num, new_irq_base, &tps6586x_domain_ops,
355 if (!tps6586x->irq_domain) {
356 dev_err(tps6586x->dev, "Failed to create IRQ domain\n");
359 ret = request_threaded_irq(irq, NULL, tps6586x_irq, IRQF_ONESHOT,
360 "tps6586x", tps6586x);
363 device_init_wakeup(tps6586x->dev, 1);
364 enable_irq_wake(irq);
370 static int __devinit tps6586x_add_subdevs(struct tps6586x *tps6586x,
371 struct tps6586x_platform_data *pdata)
373 struct tps6586x_subdev_info *subdev;
374 struct platform_device *pdev;
377 for (i = 0; i < pdata->num_subdevs; i++) {
378 subdev = &pdata->subdevs[i];
380 pdev = platform_device_alloc(subdev->name, subdev->id);
386 pdev->dev.parent = tps6586x->dev;
387 pdev->dev.platform_data = subdev->platform_data;
388 pdev->dev.of_node = subdev->of_node;
390 ret = platform_device_add(pdev);
392 platform_device_put(pdev);
399 tps6586x_remove_subdevs(tps6586x);
404 static struct of_regulator_match tps6586x_matches[] = {
405 { .name = "sys", .driver_data = (void *)TPS6586X_ID_SYS },
406 { .name = "sm0", .driver_data = (void *)TPS6586X_ID_SM_0 },
407 { .name = "sm1", .driver_data = (void *)TPS6586X_ID_SM_1 },
408 { .name = "sm2", .driver_data = (void *)TPS6586X_ID_SM_2 },
409 { .name = "ldo0", .driver_data = (void *)TPS6586X_ID_LDO_0 },
410 { .name = "ldo1", .driver_data = (void *)TPS6586X_ID_LDO_1 },
411 { .name = "ldo2", .driver_data = (void *)TPS6586X_ID_LDO_2 },
412 { .name = "ldo3", .driver_data = (void *)TPS6586X_ID_LDO_3 },
413 { .name = "ldo4", .driver_data = (void *)TPS6586X_ID_LDO_4 },
414 { .name = "ldo5", .driver_data = (void *)TPS6586X_ID_LDO_5 },
415 { .name = "ldo6", .driver_data = (void *)TPS6586X_ID_LDO_6 },
416 { .name = "ldo7", .driver_data = (void *)TPS6586X_ID_LDO_7 },
417 { .name = "ldo8", .driver_data = (void *)TPS6586X_ID_LDO_8 },
418 { .name = "ldo9", .driver_data = (void *)TPS6586X_ID_LDO_9 },
419 { .name = "ldo_rtc", .driver_data = (void *)TPS6586X_ID_LDO_RTC },
422 static struct tps6586x_platform_data *tps6586x_parse_dt(struct i2c_client *client)
424 const unsigned int num = ARRAY_SIZE(tps6586x_matches);
425 struct device_node *np = client->dev.of_node;
426 struct tps6586x_platform_data *pdata;
427 struct tps6586x_subdev_info *devs;
428 struct device_node *regs;
429 const char *sys_rail_name = NULL;
434 regs = of_find_node_by_name(np, "regulators");
438 err = of_regulator_match(&client->dev, regs, tps6586x_matches, num);
447 devs = devm_kzalloc(&client->dev, count * sizeof(*devs), GFP_KERNEL);
451 for (i = 0, j = 0; i < num && j < count; i++) {
452 struct regulator_init_data *reg_idata;
454 if (!tps6586x_matches[i].init_data)
457 reg_idata = tps6586x_matches[i].init_data;
458 devs[j].name = "tps6586x-regulator";
459 devs[j].platform_data = tps6586x_matches[i].init_data;
460 devs[j].id = (int)tps6586x_matches[i].driver_data;
461 if (devs[j].id == TPS6586X_ID_SYS)
462 sys_rail_name = reg_idata->constraints.name;
464 if ((devs[j].id == TPS6586X_ID_LDO_5) ||
465 (devs[j].id == TPS6586X_ID_LDO_RTC))
466 reg_idata->supply_regulator = sys_rail_name;
468 devs[j].of_node = tps6586x_matches[i].of_node;
472 pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
476 pdata->num_subdevs = count;
477 pdata->subdevs = devs;
478 pdata->gpio_base = -1;
479 pdata->irq_base = -1;
480 pdata->pm_off = of_property_read_bool(np, "ti,system-power-controller");
485 static struct of_device_id tps6586x_of_match[] = {
486 { .compatible = "ti,tps6586x", },
490 static struct tps6586x_platform_data *tps6586x_parse_dt(struct i2c_client *client)
496 static bool is_volatile_reg(struct device *dev, unsigned int reg)
498 /* Cache all interrupt mask register */
499 if ((reg >= TPS6586X_INT_MASK1) && (reg <= TPS6586X_INT_MASK5))
505 static const struct regmap_config tps6586x_regmap_config = {
508 .max_register = TPS6586X_MAX_REGISTER - 1,
509 .volatile_reg = is_volatile_reg,
510 .cache_type = REGCACHE_RBTREE,
513 static struct device *tps6586x_dev;
514 static void tps6586x_power_off(void)
516 if (tps6586x_clr_bits(tps6586x_dev, TPS6586X_SUPPLYENE, EXITSLREQ_BIT))
519 tps6586x_set_bits(tps6586x_dev, TPS6586X_SUPPLYENE, SLEEP_MODE_BIT);
522 static int __devinit tps6586x_i2c_probe(struct i2c_client *client,
523 const struct i2c_device_id *id)
525 struct tps6586x_platform_data *pdata = client->dev.platform_data;
526 struct tps6586x *tps6586x;
529 if (!pdata && client->dev.of_node)
530 pdata = tps6586x_parse_dt(client);
533 dev_err(&client->dev, "tps6586x requires platform data\n");
537 ret = i2c_smbus_read_byte_data(client, TPS6586X_VERSIONCRC);
539 dev_err(&client->dev, "Chip ID read failed: %d\n", ret);
543 dev_info(&client->dev, "VERSIONCRC is %02x\n", ret);
545 tps6586x = devm_kzalloc(&client->dev, sizeof(*tps6586x), GFP_KERNEL);
546 if (tps6586x == NULL) {
547 dev_err(&client->dev, "memory for tps6586x alloc failed\n");
551 tps6586x->client = client;
552 tps6586x->dev = &client->dev;
553 i2c_set_clientdata(client, tps6586x);
555 tps6586x->regmap = devm_regmap_init_i2c(client,
556 &tps6586x_regmap_config);
557 if (IS_ERR(tps6586x->regmap)) {
558 ret = PTR_ERR(tps6586x->regmap);
559 dev_err(&client->dev, "regmap init failed: %d\n", ret);
565 ret = tps6586x_irq_init(tps6586x, client->irq,
568 dev_err(&client->dev, "IRQ init failed: %d\n", ret);
573 ret = mfd_add_devices(tps6586x->dev, -1,
574 tps6586x_cell, ARRAY_SIZE(tps6586x_cell),
575 NULL, 0, tps6586x->irq_domain);
577 dev_err(&client->dev, "mfd_add_devices failed: %d\n", ret);
581 ret = tps6586x_add_subdevs(tps6586x, pdata);
583 dev_err(&client->dev, "add devices failed: %d\n", ret);
587 if (pdata->pm_off && !pm_power_off) {
588 tps6586x_dev = &client->dev;
589 pm_power_off = tps6586x_power_off;
595 mfd_remove_devices(tps6586x->dev);
598 free_irq(client->irq, tps6586x);
602 static int __devexit tps6586x_i2c_remove(struct i2c_client *client)
604 struct tps6586x *tps6586x = i2c_get_clientdata(client);
606 tps6586x_remove_subdevs(tps6586x);
607 mfd_remove_devices(tps6586x->dev);
609 free_irq(client->irq, tps6586x);
613 static const struct i2c_device_id tps6586x_id_table[] = {
617 MODULE_DEVICE_TABLE(i2c, tps6586x_id_table);
619 static struct i2c_driver tps6586x_driver = {
622 .owner = THIS_MODULE,
623 .of_match_table = of_match_ptr(tps6586x_of_match),
625 .probe = tps6586x_i2c_probe,
626 .remove = __devexit_p(tps6586x_i2c_remove),
627 .id_table = tps6586x_id_table,
630 static int __init tps6586x_init(void)
632 return i2c_add_driver(&tps6586x_driver);
634 subsys_initcall(tps6586x_init);
636 static void __exit tps6586x_exit(void)
638 i2c_del_driver(&tps6586x_driver);
640 module_exit(tps6586x_exit);
642 MODULE_DESCRIPTION("TPS6586X core driver");
643 MODULE_AUTHOR("Mike Rapoport <mike@compulab.co.il>");
644 MODULE_LICENSE("GPL");