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>
31 #include <linux/mfd/core.h>
32 #include <linux/mfd/tps6586x.h>
34 #define TPS6586X_SUPPLYENE 0x14
35 #define EXITSLREQ_BIT BIT(1)
36 #define SLEEP_MODE_BIT BIT(3)
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
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
52 #define TPS6586X_VERSIONCRC 0xcd
54 /* Maximum register */
55 #define TPS6586X_MAX_REGISTER (TPS6586X_VERSIONCRC + 1)
57 struct tps6586x_irq_data {
62 #define TPS6586X_IRQ(_reg, _mask) \
64 .mask_reg = (_reg) - TPS6586X_INT_MASK1, \
65 .mask_mask = (_mask), \
68 static 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),
98 static struct resource tps6586x_rtc_resources[] = {
100 .start = TPS6586X_INT_RTC_ALM1,
101 .end = TPS6586X_INT_RTC_ALM1,
102 .flags = IORESOURCE_IRQ,
106 static struct mfd_cell tps6586x_cell[] = {
108 .name = "tps6586x-gpio",
111 .name = "tps6586x-regulator",
114 .name = "tps6586x-rtc",
115 .num_resources = ARRAY_SIZE(tps6586x_rtc_resources),
116 .resources = &tps6586x_rtc_resources[0],
119 .name = "tps6586x-onkey",
125 struct i2c_client *client;
126 struct regmap *regmap;
129 struct irq_chip irq_chip;
130 struct mutex irq_lock;
134 struct irq_domain *irq_domain;
137 static inline struct tps6586x *dev_to_tps6586x(struct device *dev)
139 return i2c_get_clientdata(to_i2c_client(dev));
142 int tps6586x_write(struct device *dev, int reg, uint8_t val)
144 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
146 return regmap_write(tps6586x->regmap, reg, val);
148 EXPORT_SYMBOL_GPL(tps6586x_write);
150 int tps6586x_writes(struct device *dev, int reg, int len, uint8_t *val)
152 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
154 return regmap_bulk_write(tps6586x->regmap, reg, val, len);
156 EXPORT_SYMBOL_GPL(tps6586x_writes);
158 int tps6586x_read(struct device *dev, int reg, uint8_t *val)
160 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
164 ret = regmap_read(tps6586x->regmap, reg, &rval);
169 EXPORT_SYMBOL_GPL(tps6586x_read);
171 int tps6586x_reads(struct device *dev, int reg, int len, uint8_t *val)
173 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
175 return regmap_bulk_read(tps6586x->regmap, reg, val, len);
177 EXPORT_SYMBOL_GPL(tps6586x_reads);
179 int tps6586x_set_bits(struct device *dev, int reg, uint8_t bit_mask)
181 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
183 return regmap_update_bits(tps6586x->regmap, reg, bit_mask, bit_mask);
185 EXPORT_SYMBOL_GPL(tps6586x_set_bits);
187 int tps6586x_clr_bits(struct device *dev, int reg, uint8_t bit_mask)
189 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
191 return regmap_update_bits(tps6586x->regmap, reg, bit_mask, 0);
193 EXPORT_SYMBOL_GPL(tps6586x_clr_bits);
195 int tps6586x_update(struct device *dev, int reg, uint8_t val, uint8_t mask)
197 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
199 return regmap_update_bits(tps6586x->regmap, reg, mask, val);
201 EXPORT_SYMBOL_GPL(tps6586x_update);
203 int tps6586x_irq_get_virq(struct device *dev, int irq)
205 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
207 return irq_create_mapping(tps6586x->irq_domain, irq);
209 EXPORT_SYMBOL_GPL(tps6586x_irq_get_virq);
211 static int __remove_subdev(struct device *dev, void *unused)
213 platform_device_unregister(to_platform_device(dev));
217 static int tps6586x_remove_subdevs(struct tps6586x *tps6586x)
219 return device_for_each_child(tps6586x->dev, NULL, __remove_subdev);
222 static void tps6586x_irq_lock(struct irq_data *data)
224 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(data);
226 mutex_lock(&tps6586x->irq_lock);
229 static void tps6586x_irq_enable(struct irq_data *irq_data)
231 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(irq_data);
232 unsigned int __irq = irq_data->hwirq;
233 const struct tps6586x_irq_data *data = &tps6586x_irqs[__irq];
235 tps6586x->mask_reg[data->mask_reg] &= ~data->mask_mask;
236 tps6586x->irq_en |= (1 << __irq);
239 static void tps6586x_irq_disable(struct irq_data *irq_data)
241 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(irq_data);
243 unsigned int __irq = irq_data->hwirq;
244 const struct tps6586x_irq_data *data = &tps6586x_irqs[__irq];
246 tps6586x->mask_reg[data->mask_reg] |= data->mask_mask;
247 tps6586x->irq_en &= ~(1 << __irq);
250 static void tps6586x_irq_sync_unlock(struct irq_data *data)
252 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(data);
255 for (i = 0; i < ARRAY_SIZE(tps6586x->mask_reg); i++) {
257 ret = tps6586x_write(tps6586x->dev,
258 TPS6586X_INT_MASK1 + i,
259 tps6586x->mask_reg[i]);
263 mutex_unlock(&tps6586x->irq_lock);
266 #ifdef CONFIG_PM_SLEEP
267 static int tps6586x_irq_set_wake(struct irq_data *irq_data, unsigned int on)
269 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(irq_data);
270 return irq_set_irq_wake(tps6586x->irq, on);
273 #define tps6586x_irq_set_wake NULL
276 static struct irq_chip tps6586x_irq_chip = {
278 .irq_bus_lock = tps6586x_irq_lock,
279 .irq_bus_sync_unlock = tps6586x_irq_sync_unlock,
280 .irq_disable = tps6586x_irq_disable,
281 .irq_enable = tps6586x_irq_enable,
282 .irq_set_wake = tps6586x_irq_set_wake,
285 static int tps6586x_irq_map(struct irq_domain *h, unsigned int virq,
288 struct tps6586x *tps6586x = h->host_data;
290 irq_set_chip_data(virq, tps6586x);
291 irq_set_chip_and_handler(virq, &tps6586x_irq_chip, handle_simple_irq);
292 irq_set_nested_thread(virq, 1);
294 /* ARM needs us to explicitly flag the IRQ as valid
295 * and will set them noprobe when we do so. */
297 set_irq_flags(virq, IRQF_VALID);
299 irq_set_noprobe(virq);
305 static struct irq_domain_ops tps6586x_domain_ops = {
306 .map = tps6586x_irq_map,
307 .xlate = irq_domain_xlate_twocell,
310 static irqreturn_t tps6586x_irq(int irq, void *data)
312 struct tps6586x *tps6586x = data;
316 ret = tps6586x_reads(tps6586x->dev, TPS6586X_INT_ACK1,
317 sizeof(acks), (uint8_t *)&acks);
320 dev_err(tps6586x->dev, "failed to read interrupt status\n");
324 acks = le32_to_cpu(acks);
329 if (tps6586x->irq_en & (1 << i))
331 irq_find_mapping(tps6586x->irq_domain, i));
339 static int tps6586x_irq_init(struct tps6586x *tps6586x, int irq,
345 int irq_num = ARRAY_SIZE(tps6586x_irqs);
349 mutex_init(&tps6586x->irq_lock);
350 for (i = 0; i < 5; i++) {
351 tps6586x->mask_reg[i] = 0xff;
352 tps6586x_write(tps6586x->dev, TPS6586X_INT_MASK1 + i, 0xff);
355 tps6586x_reads(tps6586x->dev, TPS6586X_INT_ACK1, sizeof(tmp), tmp);
358 new_irq_base = irq_alloc_descs(irq_base, 0, irq_num, -1);
359 if (new_irq_base < 0) {
360 dev_err(tps6586x->dev,
361 "Failed to alloc IRQs: %d\n", new_irq_base);
368 tps6586x->irq_domain = irq_domain_add_simple(tps6586x->dev->of_node,
369 irq_num, new_irq_base, &tps6586x_domain_ops,
371 if (!tps6586x->irq_domain) {
372 dev_err(tps6586x->dev, "Failed to create IRQ domain\n");
375 ret = request_threaded_irq(irq, NULL, tps6586x_irq, IRQF_ONESHOT,
376 "tps6586x", tps6586x);
379 device_init_wakeup(tps6586x->dev, 1);
384 static int tps6586x_add_subdevs(struct tps6586x *tps6586x,
385 struct tps6586x_platform_data *pdata)
387 struct tps6586x_subdev_info *subdev;
388 struct platform_device *pdev;
391 for (i = 0; i < pdata->num_subdevs; i++) {
392 subdev = &pdata->subdevs[i];
394 pdev = platform_device_alloc(subdev->name, subdev->id);
400 pdev->dev.parent = tps6586x->dev;
401 pdev->dev.platform_data = subdev->platform_data;
402 pdev->dev.of_node = subdev->of_node;
404 ret = platform_device_add(pdev);
406 platform_device_put(pdev);
413 tps6586x_remove_subdevs(tps6586x);
418 static struct tps6586x_platform_data *tps6586x_parse_dt(struct i2c_client *client)
420 struct device_node *np = client->dev.of_node;
421 struct tps6586x_platform_data *pdata;
423 pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
425 dev_err(&client->dev, "Memory allocation failed\n");
429 pdata->num_subdevs = 0;
430 pdata->subdevs = NULL;
431 pdata->gpio_base = -1;
432 pdata->irq_base = -1;
433 pdata->pm_off = of_property_read_bool(np, "ti,system-power-controller");
438 static struct of_device_id tps6586x_of_match[] = {
439 { .compatible = "ti,tps6586x", },
443 static struct tps6586x_platform_data *tps6586x_parse_dt(struct i2c_client *client)
449 static bool is_volatile_reg(struct device *dev, unsigned int reg)
451 /* Cache all interrupt mask register */
452 if ((reg >= TPS6586X_INT_MASK1) && (reg <= TPS6586X_INT_MASK5))
458 static const struct regmap_config tps6586x_regmap_config = {
461 .max_register = TPS6586X_MAX_REGISTER - 1,
462 .volatile_reg = is_volatile_reg,
463 .cache_type = REGCACHE_RBTREE,
466 static struct device *tps6586x_dev;
467 static void tps6586x_power_off(void)
469 if (tps6586x_clr_bits(tps6586x_dev, TPS6586X_SUPPLYENE, EXITSLREQ_BIT))
472 tps6586x_set_bits(tps6586x_dev, TPS6586X_SUPPLYENE, SLEEP_MODE_BIT);
475 static int tps6586x_i2c_probe(struct i2c_client *client,
476 const struct i2c_device_id *id)
478 struct tps6586x_platform_data *pdata = dev_get_platdata(&client->dev);
479 struct tps6586x *tps6586x;
482 if (!pdata && client->dev.of_node)
483 pdata = tps6586x_parse_dt(client);
486 dev_err(&client->dev, "tps6586x requires platform data\n");
490 ret = i2c_smbus_read_byte_data(client, TPS6586X_VERSIONCRC);
492 dev_err(&client->dev, "Chip ID read failed: %d\n", ret);
496 dev_info(&client->dev, "VERSIONCRC is %02x\n", ret);
498 tps6586x = devm_kzalloc(&client->dev, sizeof(*tps6586x), GFP_KERNEL);
499 if (tps6586x == NULL) {
500 dev_err(&client->dev, "memory for tps6586x alloc failed\n");
504 tps6586x->client = client;
505 tps6586x->dev = &client->dev;
506 i2c_set_clientdata(client, tps6586x);
508 tps6586x->regmap = devm_regmap_init_i2c(client,
509 &tps6586x_regmap_config);
510 if (IS_ERR(tps6586x->regmap)) {
511 ret = PTR_ERR(tps6586x->regmap);
512 dev_err(&client->dev, "regmap init failed: %d\n", ret);
518 ret = tps6586x_irq_init(tps6586x, client->irq,
521 dev_err(&client->dev, "IRQ init failed: %d\n", ret);
526 ret = mfd_add_devices(tps6586x->dev, -1,
527 tps6586x_cell, ARRAY_SIZE(tps6586x_cell),
528 NULL, 0, tps6586x->irq_domain);
530 dev_err(&client->dev, "mfd_add_devices failed: %d\n", ret);
534 ret = tps6586x_add_subdevs(tps6586x, pdata);
536 dev_err(&client->dev, "add devices failed: %d\n", ret);
540 if (pdata->pm_off && !pm_power_off) {
541 tps6586x_dev = &client->dev;
542 pm_power_off = tps6586x_power_off;
548 mfd_remove_devices(tps6586x->dev);
551 free_irq(client->irq, tps6586x);
555 static int tps6586x_i2c_remove(struct i2c_client *client)
557 struct tps6586x *tps6586x = i2c_get_clientdata(client);
559 tps6586x_remove_subdevs(tps6586x);
560 mfd_remove_devices(tps6586x->dev);
562 free_irq(client->irq, tps6586x);
566 static const struct i2c_device_id tps6586x_id_table[] = {
570 MODULE_DEVICE_TABLE(i2c, tps6586x_id_table);
572 static struct i2c_driver tps6586x_driver = {
575 .owner = THIS_MODULE,
576 .of_match_table = of_match_ptr(tps6586x_of_match),
578 .probe = tps6586x_i2c_probe,
579 .remove = tps6586x_i2c_remove,
580 .id_table = tps6586x_id_table,
583 static int __init tps6586x_init(void)
585 return i2c_add_driver(&tps6586x_driver);
587 subsys_initcall(tps6586x_init);
589 static void __exit tps6586x_exit(void)
591 i2c_del_driver(&tps6586x_driver);
593 module_exit(tps6586x_exit);
595 MODULE_DESCRIPTION("TPS6586X core driver");
596 MODULE_AUTHOR("Mike Rapoport <mike@compulab.co.il>");
597 MODULE_LICENSE("GPL");