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/kernel.h>
21 #include <linux/module.h>
22 #include <linux/mutex.h>
23 #include <linux/slab.h>
24 #include <linux/gpio.h>
25 #include <linux/i2c.h>
27 #include <linux/mfd/core.h>
28 #include <linux/mfd/tps6586x.h>
30 /* GPIO control registers */
31 #define TPS6586X_GPIOSET1 0x5d
32 #define TPS6586X_GPIOSET2 0x5e
34 /* interrupt control registers */
35 #define TPS6586X_INT_ACK1 0xb5
36 #define TPS6586X_INT_ACK2 0xb6
37 #define TPS6586X_INT_ACK3 0xb7
38 #define TPS6586X_INT_ACK4 0xb8
40 /* interrupt mask registers */
41 #define TPS6586X_INT_MASK1 0xb0
42 #define TPS6586X_INT_MASK2 0xb1
43 #define TPS6586X_INT_MASK3 0xb2
44 #define TPS6586X_INT_MASK4 0xb3
45 #define TPS6586X_INT_MASK5 0xb4
48 #define TPS6586X_VERSIONCRC 0xcd
49 #define TPS658621A_VERSIONCRC 0x15
50 #define TPS658621C_VERSIONCRC 0x2c
52 struct tps6586x_irq_data {
57 #define TPS6586X_IRQ(_reg, _mask) \
59 .mask_reg = (_reg) - TPS6586X_INT_MASK1, \
60 .mask_mask = (_mask), \
63 static const struct tps6586x_irq_data tps6586x_irqs[] = {
64 [TPS6586X_INT_PLDO_0] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 0),
65 [TPS6586X_INT_PLDO_1] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 1),
66 [TPS6586X_INT_PLDO_2] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 2),
67 [TPS6586X_INT_PLDO_3] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 3),
68 [TPS6586X_INT_PLDO_4] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 4),
69 [TPS6586X_INT_PLDO_5] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 5),
70 [TPS6586X_INT_PLDO_6] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 6),
71 [TPS6586X_INT_PLDO_7] = TPS6586X_IRQ(TPS6586X_INT_MASK1, 1 << 7),
72 [TPS6586X_INT_COMP_DET] = TPS6586X_IRQ(TPS6586X_INT_MASK4, 1 << 0),
73 [TPS6586X_INT_ADC] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 1),
74 [TPS6586X_INT_PLDO_8] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 2),
75 [TPS6586X_INT_PLDO_9] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 3),
76 [TPS6586X_INT_PSM_0] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 4),
77 [TPS6586X_INT_PSM_1] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 5),
78 [TPS6586X_INT_PSM_2] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 6),
79 [TPS6586X_INT_PSM_3] = TPS6586X_IRQ(TPS6586X_INT_MASK2, 1 << 7),
80 [TPS6586X_INT_RTC_ALM1] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 4),
81 [TPS6586X_INT_ACUSB_OVP] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 0x03),
82 [TPS6586X_INT_USB_DET] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 2),
83 [TPS6586X_INT_AC_DET] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 3),
84 [TPS6586X_INT_BAT_DET] = TPS6586X_IRQ(TPS6586X_INT_MASK3, 1 << 0),
85 [TPS6586X_INT_CHG_STAT] = TPS6586X_IRQ(TPS6586X_INT_MASK4, 0xfc),
86 [TPS6586X_INT_CHG_TEMP] = TPS6586X_IRQ(TPS6586X_INT_MASK3, 0x06),
87 [TPS6586X_INT_PP] = TPS6586X_IRQ(TPS6586X_INT_MASK3, 0xf0),
88 [TPS6586X_INT_RESUME] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 5),
89 [TPS6586X_INT_LOW_SYS] = TPS6586X_IRQ(TPS6586X_INT_MASK5, 1 << 6),
90 [TPS6586X_INT_RTC_ALM2] = TPS6586X_IRQ(TPS6586X_INT_MASK4, 1 << 1),
96 struct i2c_client *client;
98 struct gpio_chip gpio;
99 struct irq_chip irq_chip;
100 struct mutex irq_lock;
107 static inline int __tps6586x_read(struct i2c_client *client,
108 int reg, uint8_t *val)
112 ret = i2c_smbus_read_byte_data(client, reg);
114 dev_err(&client->dev, "failed reading at 0x%02x\n", reg);
123 static inline int __tps6586x_reads(struct i2c_client *client, int reg,
124 int len, uint8_t *val)
128 ret = i2c_smbus_read_i2c_block_data(client, reg, len, val);
130 dev_err(&client->dev, "failed reading from 0x%02x\n", reg);
137 static inline int __tps6586x_write(struct i2c_client *client,
138 int reg, uint8_t val)
142 ret = i2c_smbus_write_byte_data(client, reg, val);
144 dev_err(&client->dev, "failed writing 0x%02x to 0x%02x\n",
152 static inline int __tps6586x_writes(struct i2c_client *client, int reg,
153 int len, uint8_t *val)
157 ret = i2c_smbus_write_i2c_block_data(client, reg, len, val);
159 dev_err(&client->dev, "failed writings to 0x%02x\n", reg);
166 int tps6586x_write(struct device *dev, int reg, uint8_t val)
168 return __tps6586x_write(to_i2c_client(dev), reg, val);
170 EXPORT_SYMBOL_GPL(tps6586x_write);
172 int tps6586x_writes(struct device *dev, int reg, int len, uint8_t *val)
174 return __tps6586x_writes(to_i2c_client(dev), reg, len, val);
176 EXPORT_SYMBOL_GPL(tps6586x_writes);
178 int tps6586x_read(struct device *dev, int reg, uint8_t *val)
180 return __tps6586x_read(to_i2c_client(dev), reg, val);
182 EXPORT_SYMBOL_GPL(tps6586x_read);
184 int tps6586x_reads(struct device *dev, int reg, int len, uint8_t *val)
186 return __tps6586x_reads(to_i2c_client(dev), reg, len, val);
188 EXPORT_SYMBOL_GPL(tps6586x_reads);
190 int tps6586x_set_bits(struct device *dev, int reg, uint8_t bit_mask)
192 struct tps6586x *tps6586x = dev_get_drvdata(dev);
196 mutex_lock(&tps6586x->lock);
198 ret = __tps6586x_read(to_i2c_client(dev), reg, ®_val);
202 if ((reg_val & bit_mask) == 0) {
204 ret = __tps6586x_write(to_i2c_client(dev), reg, reg_val);
207 mutex_unlock(&tps6586x->lock);
210 EXPORT_SYMBOL_GPL(tps6586x_set_bits);
212 int tps6586x_clr_bits(struct device *dev, int reg, uint8_t bit_mask)
214 struct tps6586x *tps6586x = dev_get_drvdata(dev);
218 mutex_lock(&tps6586x->lock);
220 ret = __tps6586x_read(to_i2c_client(dev), reg, ®_val);
224 if (reg_val & bit_mask) {
225 reg_val &= ~bit_mask;
226 ret = __tps6586x_write(to_i2c_client(dev), reg, reg_val);
229 mutex_unlock(&tps6586x->lock);
232 EXPORT_SYMBOL_GPL(tps6586x_clr_bits);
234 int tps6586x_update(struct device *dev, int reg, uint8_t val, uint8_t mask)
236 struct tps6586x *tps6586x = dev_get_drvdata(dev);
240 mutex_lock(&tps6586x->lock);
242 ret = __tps6586x_read(tps6586x->client, reg, ®_val);
246 if ((reg_val & mask) != val) {
247 reg_val = (reg_val & ~mask) | val;
248 ret = __tps6586x_write(tps6586x->client, reg, reg_val);
251 mutex_unlock(&tps6586x->lock);
254 EXPORT_SYMBOL_GPL(tps6586x_update);
256 static int tps6586x_gpio_get(struct gpio_chip *gc, unsigned offset)
258 struct tps6586x *tps6586x = container_of(gc, struct tps6586x, gpio);
262 ret = __tps6586x_read(tps6586x->client, TPS6586X_GPIOSET2, &val);
266 return !!(val & (1 << offset));
270 static void tps6586x_gpio_set(struct gpio_chip *chip, unsigned offset,
273 struct tps6586x *tps6586x = container_of(chip, struct tps6586x, gpio);
275 __tps6586x_write(tps6586x->client, TPS6586X_GPIOSET2,
279 static int tps6586x_gpio_output(struct gpio_chip *gc, unsigned offset,
282 struct tps6586x *tps6586x = container_of(gc, struct tps6586x, gpio);
285 tps6586x_gpio_set(gc, offset, value);
287 val = 0x1 << (offset * 2);
288 mask = 0x3 << (offset * 2);
290 return tps6586x_update(tps6586x->dev, TPS6586X_GPIOSET1, val, mask);
293 static void tps6586x_gpio_init(struct tps6586x *tps6586x, int gpio_base)
300 tps6586x->gpio.owner = THIS_MODULE;
301 tps6586x->gpio.label = tps6586x->client->name;
302 tps6586x->gpio.dev = tps6586x->dev;
303 tps6586x->gpio.base = gpio_base;
304 tps6586x->gpio.ngpio = 4;
305 tps6586x->gpio.can_sleep = 1;
307 /* FIXME: add handling of GPIOs as dedicated inputs */
308 tps6586x->gpio.direction_output = tps6586x_gpio_output;
309 tps6586x->gpio.set = tps6586x_gpio_set;
310 tps6586x->gpio.get = tps6586x_gpio_get;
312 ret = gpiochip_add(&tps6586x->gpio);
314 dev_warn(tps6586x->dev, "GPIO registration failed: %d\n", ret);
317 static int __remove_subdev(struct device *dev, void *unused)
319 platform_device_unregister(to_platform_device(dev));
323 static int tps6586x_remove_subdevs(struct tps6586x *tps6586x)
325 return device_for_each_child(tps6586x->dev, NULL, __remove_subdev);
328 static void tps6586x_irq_lock(unsigned int irq)
330 struct tps6586x *tps6586x = get_irq_chip_data(irq);
332 mutex_lock(&tps6586x->irq_lock);
335 static void tps6586x_irq_enable(unsigned int irq)
337 struct tps6586x *tps6586x = get_irq_chip_data(irq);
338 unsigned int __irq = irq - tps6586x->irq_base;
339 const struct tps6586x_irq_data *data = &tps6586x_irqs[__irq];
341 tps6586x->mask_reg[data->mask_reg] &= ~data->mask_mask;
342 tps6586x->irq_en |= (1 << __irq);
345 static void tps6586x_irq_disable(unsigned int irq)
347 struct tps6586x *tps6586x = get_irq_chip_data(irq);
349 unsigned int __irq = irq - tps6586x->irq_base;
350 const struct tps6586x_irq_data *data = &tps6586x_irqs[__irq];
352 tps6586x->mask_reg[data->mask_reg] |= data->mask_mask;
353 tps6586x->irq_en &= ~(1 << __irq);
356 static void tps6586x_irq_sync_unlock(unsigned int irq)
358 struct tps6586x *tps6586x = get_irq_chip_data(irq);
361 for (i = 0; i < ARRAY_SIZE(tps6586x->mask_reg); i++) {
362 if (tps6586x->mask_reg[i] != tps6586x->mask_cache[i]) {
363 if (!WARN_ON(tps6586x_write(tps6586x->dev,
364 TPS6586X_INT_MASK1 + i,
365 tps6586x->mask_reg[i])))
366 tps6586x->mask_cache[i] = tps6586x->mask_reg[i];
370 mutex_unlock(&tps6586x->irq_lock);
373 static irqreturn_t tps6586x_irq(int irq, void *data)
375 struct tps6586x *tps6586x = data;
379 ret = tps6586x_reads(tps6586x->dev, TPS6586X_INT_ACK1,
380 sizeof(acks), (uint8_t *)&acks);
383 dev_err(tps6586x->dev, "failed to read interrupt status\n");
387 acks = le32_to_cpu(acks);
392 if (tps6586x->irq_en & (1 << i))
393 handle_nested_irq(tps6586x->irq_base + i);
401 static int __devinit tps6586x_irq_init(struct tps6586x *tps6586x, int irq,
408 dev_warn(tps6586x->dev, "No interrupt support on IRQ base\n");
412 mutex_init(&tps6586x->irq_lock);
413 for (i = 0; i < 5; i++) {
414 tps6586x->mask_cache[i] = 0xff;
415 tps6586x->mask_reg[i] = 0xff;
416 tps6586x_write(tps6586x->dev, TPS6586X_INT_MASK1 + i, 0xff);
419 tps6586x_reads(tps6586x->dev, TPS6586X_INT_ACK1, sizeof(tmp), tmp);
421 tps6586x->irq_base = irq_base;
423 tps6586x->irq_chip.name = "tps6586x";
424 tps6586x->irq_chip.enable = tps6586x_irq_enable;
425 tps6586x->irq_chip.disable = tps6586x_irq_disable;
426 tps6586x->irq_chip.bus_lock = tps6586x_irq_lock;
427 tps6586x->irq_chip.bus_sync_unlock = tps6586x_irq_sync_unlock;
429 for (i = 0; i < ARRAY_SIZE(tps6586x_irqs); i++) {
430 int __irq = i + tps6586x->irq_base;
431 set_irq_chip_data(__irq, tps6586x);
432 set_irq_chip_and_handler(__irq, &tps6586x->irq_chip,
434 set_irq_nested_thread(__irq, 1);
436 set_irq_flags(__irq, IRQF_VALID);
440 ret = request_threaded_irq(irq, NULL, tps6586x_irq, IRQF_ONESHOT,
441 "tps6586x", tps6586x);
444 device_init_wakeup(tps6586x->dev, 1);
445 enable_irq_wake(irq);
451 static int __devinit tps6586x_add_subdevs(struct tps6586x *tps6586x,
452 struct tps6586x_platform_data *pdata)
454 struct tps6586x_subdev_info *subdev;
455 struct platform_device *pdev;
458 for (i = 0; i < pdata->num_subdevs; i++) {
459 subdev = &pdata->subdevs[i];
461 pdev = platform_device_alloc(subdev->name, subdev->id);
467 pdev->dev.parent = tps6586x->dev;
468 pdev->dev.platform_data = subdev->platform_data;
470 ret = platform_device_add(pdev);
472 platform_device_put(pdev);
479 tps6586x_remove_subdevs(tps6586x);
483 static int __devinit tps6586x_i2c_probe(struct i2c_client *client,
484 const struct i2c_device_id *id)
486 struct tps6586x_platform_data *pdata = client->dev.platform_data;
487 struct tps6586x *tps6586x;
491 dev_err(&client->dev, "tps6586x requires platform data\n");
495 ret = i2c_smbus_read_byte_data(client, TPS6586X_VERSIONCRC);
497 dev_err(&client->dev, "Chip ID read failed: %d\n", ret);
501 if ((ret != TPS658621A_VERSIONCRC) &&
502 (ret != TPS658621C_VERSIONCRC)) {
503 dev_err(&client->dev, "Unsupported chip ID: %x\n", ret);
507 tps6586x = kzalloc(sizeof(struct tps6586x), GFP_KERNEL);
508 if (tps6586x == NULL)
511 tps6586x->client = client;
512 tps6586x->dev = &client->dev;
513 i2c_set_clientdata(client, tps6586x);
515 mutex_init(&tps6586x->lock);
518 ret = tps6586x_irq_init(tps6586x, client->irq,
521 dev_err(&client->dev, "IRQ init failed: %d\n", ret);
526 ret = tps6586x_add_subdevs(tps6586x, pdata);
528 dev_err(&client->dev, "add devices failed: %d\n", ret);
532 tps6586x_gpio_init(tps6586x, pdata->gpio_base);
538 free_irq(client->irq, tps6586x);
544 static int __devexit tps6586x_i2c_remove(struct i2c_client *client)
546 struct tps6586x *tps6586x = i2c_get_clientdata(client);
547 struct tps6586x_platform_data *pdata = client->dev.platform_data;
551 free_irq(client->irq, tps6586x);
553 if (pdata->gpio_base) {
554 ret = gpiochip_remove(&tps6586x->gpio);
556 dev_err(&client->dev, "Can't remove gpio chip: %d\n",
560 tps6586x_remove_subdevs(tps6586x);
565 static const struct i2c_device_id tps6586x_id_table[] = {
569 MODULE_DEVICE_TABLE(i2c, tps6586x_id_table);
571 static struct i2c_driver tps6586x_driver = {
574 .owner = THIS_MODULE,
576 .probe = tps6586x_i2c_probe,
577 .remove = __devexit_p(tps6586x_i2c_remove),
578 .id_table = tps6586x_id_table,
581 static int __init tps6586x_init(void)
583 return i2c_add_driver(&tps6586x_driver);
585 subsys_initcall(tps6586x_init);
587 static void __exit tps6586x_exit(void)
589 i2c_del_driver(&tps6586x_driver);
591 module_exit(tps6586x_exit);
593 MODULE_DESCRIPTION("TPS6586X core driver");
594 MODULE_AUTHOR("Mike Rapoport <mike@compulab.co.il>");
595 MODULE_LICENSE("GPL");