1 // SPDX-License-Identifier: GPL-2.0-only
3 * Core driver for TI TPS6586x PMIC family
5 * Copyright (c) 2010 CompuLab Ltd.
6 * Mike Rapoport <mike@compulab.co.il>
9 * Copyright (C) 2008 Compulab, Ltd.
10 * Mike Rapoport <mike@compulab.co.il>
11 * Copyright (C) 2006-2008 Marvell International Ltd.
12 * Eric Miao <eric.miao@marvell.com>
15 #include <linux/interrupt.h>
16 #include <linux/irq.h>
17 #include <linux/irqdomain.h>
18 #include <linux/kernel.h>
19 #include <linux/module.h>
20 #include <linux/mutex.h>
21 #include <linux/slab.h>
22 #include <linux/err.h>
23 #include <linux/i2c.h>
24 #include <linux/platform_device.h>
25 #include <linux/regmap.h>
28 #include <linux/mfd/core.h>
29 #include <linux/mfd/tps6586x.h>
31 #define TPS6586X_SUPPLYENE 0x14
32 #define EXITSLREQ_BIT BIT(1)
33 #define SLEEP_MODE_BIT BIT(3)
35 /* interrupt control registers */
36 #define TPS6586X_INT_ACK1 0xb5
37 #define TPS6586X_INT_ACK2 0xb6
38 #define TPS6586X_INT_ACK3 0xb7
39 #define TPS6586X_INT_ACK4 0xb8
41 /* interrupt mask registers */
42 #define TPS6586X_INT_MASK1 0xb0
43 #define TPS6586X_INT_MASK2 0xb1
44 #define TPS6586X_INT_MASK3 0xb2
45 #define TPS6586X_INT_MASK4 0xb3
46 #define TPS6586X_INT_MASK5 0xb4
49 #define TPS6586X_VERSIONCRC 0xcd
51 /* Maximum register */
52 #define TPS6586X_MAX_REGISTER TPS6586X_VERSIONCRC
54 struct tps6586x_irq_data
{
59 #define TPS6586X_IRQ(_reg, _mask) \
61 .mask_reg = (_reg) - TPS6586X_INT_MASK1, \
62 .mask_mask = (_mask), \
65 static const struct tps6586x_irq_data tps6586x_irqs
[] = {
66 [TPS6586X_INT_PLDO_0
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 0),
67 [TPS6586X_INT_PLDO_1
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 1),
68 [TPS6586X_INT_PLDO_2
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 2),
69 [TPS6586X_INT_PLDO_3
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 3),
70 [TPS6586X_INT_PLDO_4
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 4),
71 [TPS6586X_INT_PLDO_5
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 5),
72 [TPS6586X_INT_PLDO_6
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 6),
73 [TPS6586X_INT_PLDO_7
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 7),
74 [TPS6586X_INT_COMP_DET
] = TPS6586X_IRQ(TPS6586X_INT_MASK4
, 1 << 0),
75 [TPS6586X_INT_ADC
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 1),
76 [TPS6586X_INT_PLDO_8
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 2),
77 [TPS6586X_INT_PLDO_9
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 3),
78 [TPS6586X_INT_PSM_0
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 4),
79 [TPS6586X_INT_PSM_1
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 5),
80 [TPS6586X_INT_PSM_2
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 6),
81 [TPS6586X_INT_PSM_3
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 7),
82 [TPS6586X_INT_RTC_ALM1
] = TPS6586X_IRQ(TPS6586X_INT_MASK5
, 1 << 4),
83 [TPS6586X_INT_ACUSB_OVP
] = TPS6586X_IRQ(TPS6586X_INT_MASK5
, 0x03),
84 [TPS6586X_INT_USB_DET
] = TPS6586X_IRQ(TPS6586X_INT_MASK5
, 1 << 2),
85 [TPS6586X_INT_AC_DET
] = TPS6586X_IRQ(TPS6586X_INT_MASK5
, 1 << 3),
86 [TPS6586X_INT_BAT_DET
] = TPS6586X_IRQ(TPS6586X_INT_MASK3
, 1 << 0),
87 [TPS6586X_INT_CHG_STAT
] = TPS6586X_IRQ(TPS6586X_INT_MASK4
, 0xfc),
88 [TPS6586X_INT_CHG_TEMP
] = TPS6586X_IRQ(TPS6586X_INT_MASK3
, 0x06),
89 [TPS6586X_INT_PP
] = TPS6586X_IRQ(TPS6586X_INT_MASK3
, 0xf0),
90 [TPS6586X_INT_RESUME
] = TPS6586X_IRQ(TPS6586X_INT_MASK5
, 1 << 5),
91 [TPS6586X_INT_LOW_SYS
] = TPS6586X_IRQ(TPS6586X_INT_MASK5
, 1 << 6),
92 [TPS6586X_INT_RTC_ALM2
] = TPS6586X_IRQ(TPS6586X_INT_MASK4
, 1 << 1),
95 static const struct resource tps6586x_rtc_resources
[] = {
97 .start
= TPS6586X_INT_RTC_ALM1
,
98 .end
= TPS6586X_INT_RTC_ALM1
,
99 .flags
= IORESOURCE_IRQ
,
103 static const struct mfd_cell tps6586x_cell
[] = {
105 .name
= "tps6586x-gpio",
108 .name
= "tps6586x-regulator",
111 .name
= "tps6586x-rtc",
112 .num_resources
= ARRAY_SIZE(tps6586x_rtc_resources
),
113 .resources
= &tps6586x_rtc_resources
[0],
116 .name
= "tps6586x-onkey",
122 struct i2c_client
*client
;
123 struct regmap
*regmap
;
127 struct irq_chip irq_chip
;
128 struct mutex irq_lock
;
132 struct irq_domain
*irq_domain
;
135 static inline struct tps6586x
*dev_to_tps6586x(struct device
*dev
)
137 return i2c_get_clientdata(to_i2c_client(dev
));
140 int tps6586x_write(struct device
*dev
, int reg
, uint8_t val
)
142 struct tps6586x
*tps6586x
= dev_to_tps6586x(dev
);
144 return regmap_write(tps6586x
->regmap
, reg
, val
);
146 EXPORT_SYMBOL_GPL(tps6586x_write
);
148 int tps6586x_writes(struct device
*dev
, int reg
, int len
, uint8_t *val
)
150 struct tps6586x
*tps6586x
= dev_to_tps6586x(dev
);
152 return regmap_bulk_write(tps6586x
->regmap
, reg
, val
, len
);
154 EXPORT_SYMBOL_GPL(tps6586x_writes
);
156 int tps6586x_read(struct device
*dev
, int reg
, uint8_t *val
)
158 struct tps6586x
*tps6586x
= dev_to_tps6586x(dev
);
162 ret
= regmap_read(tps6586x
->regmap
, reg
, &rval
);
167 EXPORT_SYMBOL_GPL(tps6586x_read
);
169 int tps6586x_reads(struct device
*dev
, int reg
, int len
, uint8_t *val
)
171 struct tps6586x
*tps6586x
= dev_to_tps6586x(dev
);
173 return regmap_bulk_read(tps6586x
->regmap
, reg
, val
, len
);
175 EXPORT_SYMBOL_GPL(tps6586x_reads
);
177 int tps6586x_set_bits(struct device
*dev
, int reg
, uint8_t bit_mask
)
179 struct tps6586x
*tps6586x
= dev_to_tps6586x(dev
);
181 return regmap_update_bits(tps6586x
->regmap
, reg
, bit_mask
, bit_mask
);
183 EXPORT_SYMBOL_GPL(tps6586x_set_bits
);
185 int tps6586x_clr_bits(struct device
*dev
, int reg
, uint8_t bit_mask
)
187 struct tps6586x
*tps6586x
= dev_to_tps6586x(dev
);
189 return regmap_update_bits(tps6586x
->regmap
, reg
, bit_mask
, 0);
191 EXPORT_SYMBOL_GPL(tps6586x_clr_bits
);
193 int tps6586x_update(struct device
*dev
, int reg
, uint8_t val
, uint8_t mask
)
195 struct tps6586x
*tps6586x
= dev_to_tps6586x(dev
);
197 return regmap_update_bits(tps6586x
->regmap
, reg
, mask
, val
);
199 EXPORT_SYMBOL_GPL(tps6586x_update
);
201 int tps6586x_irq_get_virq(struct device
*dev
, int irq
)
203 struct tps6586x
*tps6586x
= dev_to_tps6586x(dev
);
205 return irq_create_mapping(tps6586x
->irq_domain
, irq
);
207 EXPORT_SYMBOL_GPL(tps6586x_irq_get_virq
);
209 int tps6586x_get_version(struct device
*dev
)
211 struct tps6586x
*tps6586x
= dev_get_drvdata(dev
);
213 return tps6586x
->version
;
215 EXPORT_SYMBOL_GPL(tps6586x_get_version
);
217 static int __remove_subdev(struct device
*dev
, void *unused
)
219 platform_device_unregister(to_platform_device(dev
));
223 static int tps6586x_remove_subdevs(struct tps6586x
*tps6586x
)
225 return device_for_each_child(tps6586x
->dev
, NULL
, __remove_subdev
);
228 static void tps6586x_irq_lock(struct irq_data
*data
)
230 struct tps6586x
*tps6586x
= irq_data_get_irq_chip_data(data
);
232 mutex_lock(&tps6586x
->irq_lock
);
235 static void tps6586x_irq_enable(struct irq_data
*irq_data
)
237 struct tps6586x
*tps6586x
= irq_data_get_irq_chip_data(irq_data
);
238 unsigned int __irq
= irq_data
->hwirq
;
239 const struct tps6586x_irq_data
*data
= &tps6586x_irqs
[__irq
];
241 tps6586x
->mask_reg
[data
->mask_reg
] &= ~data
->mask_mask
;
242 tps6586x
->irq_en
|= (1 << __irq
);
245 static void tps6586x_irq_disable(struct irq_data
*irq_data
)
247 struct tps6586x
*tps6586x
= irq_data_get_irq_chip_data(irq_data
);
249 unsigned int __irq
= irq_data
->hwirq
;
250 const struct tps6586x_irq_data
*data
= &tps6586x_irqs
[__irq
];
252 tps6586x
->mask_reg
[data
->mask_reg
] |= data
->mask_mask
;
253 tps6586x
->irq_en
&= ~(1 << __irq
);
256 static void tps6586x_irq_sync_unlock(struct irq_data
*data
)
258 struct tps6586x
*tps6586x
= irq_data_get_irq_chip_data(data
);
261 for (i
= 0; i
< ARRAY_SIZE(tps6586x
->mask_reg
); i
++) {
263 ret
= tps6586x_write(tps6586x
->dev
,
264 TPS6586X_INT_MASK1
+ i
,
265 tps6586x
->mask_reg
[i
]);
269 mutex_unlock(&tps6586x
->irq_lock
);
272 #ifdef CONFIG_PM_SLEEP
273 static int tps6586x_irq_set_wake(struct irq_data
*irq_data
, unsigned int on
)
275 struct tps6586x
*tps6586x
= irq_data_get_irq_chip_data(irq_data
);
276 return irq_set_irq_wake(tps6586x
->irq
, on
);
279 #define tps6586x_irq_set_wake NULL
282 static struct irq_chip tps6586x_irq_chip
= {
284 .irq_bus_lock
= tps6586x_irq_lock
,
285 .irq_bus_sync_unlock
= tps6586x_irq_sync_unlock
,
286 .irq_disable
= tps6586x_irq_disable
,
287 .irq_enable
= tps6586x_irq_enable
,
288 .irq_set_wake
= tps6586x_irq_set_wake
,
291 static int tps6586x_irq_map(struct irq_domain
*h
, unsigned int virq
,
294 struct tps6586x
*tps6586x
= h
->host_data
;
296 irq_set_chip_data(virq
, tps6586x
);
297 irq_set_chip_and_handler(virq
, &tps6586x_irq_chip
, handle_simple_irq
);
298 irq_set_nested_thread(virq
, 1);
299 irq_set_noprobe(virq
);
304 static const struct irq_domain_ops tps6586x_domain_ops
= {
305 .map
= tps6586x_irq_map
,
306 .xlate
= irq_domain_xlate_twocell
,
309 static irqreturn_t
tps6586x_irq(int irq
, void *data
)
311 struct tps6586x
*tps6586x
= data
;
316 ret
= tps6586x_reads(tps6586x
->dev
, TPS6586X_INT_ACK1
,
317 sizeof(acks
), (uint8_t *)&val
);
320 dev_err(tps6586x
->dev
, "failed to read interrupt status\n");
324 acks
= le32_to_cpu(val
);
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
);
427 pdata
->num_subdevs
= 0;
428 pdata
->subdevs
= NULL
;
429 pdata
->gpio_base
= -1;
430 pdata
->irq_base
= -1;
431 pdata
->pm_off
= of_property_read_bool(np
, "ti,system-power-controller");
436 static const struct of_device_id tps6586x_of_match
[] = {
437 { .compatible
= "ti,tps6586x", },
441 static struct tps6586x_platform_data
*tps6586x_parse_dt(struct i2c_client
*client
)
447 static bool is_volatile_reg(struct device
*dev
, unsigned int reg
)
449 /* Cache all interrupt mask register */
450 if ((reg
>= TPS6586X_INT_MASK1
) && (reg
<= TPS6586X_INT_MASK5
))
456 static const struct regmap_config tps6586x_regmap_config
= {
459 .max_register
= TPS6586X_MAX_REGISTER
,
460 .volatile_reg
= is_volatile_reg
,
461 .cache_type
= REGCACHE_RBTREE
,
464 static struct device
*tps6586x_dev
;
465 static void tps6586x_power_off(void)
467 if (tps6586x_clr_bits(tps6586x_dev
, TPS6586X_SUPPLYENE
, EXITSLREQ_BIT
))
470 tps6586x_set_bits(tps6586x_dev
, TPS6586X_SUPPLYENE
, SLEEP_MODE_BIT
);
473 static void tps6586x_print_version(struct i2c_client
*client
, int version
)
482 name
= "TPS658621C/D";
499 dev_info(&client
->dev
, "Found %s, VERSIONCRC is %02x\n", name
, version
);
502 static int tps6586x_i2c_probe(struct i2c_client
*client
,
503 const struct i2c_device_id
*id
)
505 struct tps6586x_platform_data
*pdata
= dev_get_platdata(&client
->dev
);
506 struct tps6586x
*tps6586x
;
510 if (!pdata
&& client
->dev
.of_node
)
511 pdata
= tps6586x_parse_dt(client
);
514 dev_err(&client
->dev
, "tps6586x requires platform data\n");
518 version
= i2c_smbus_read_byte_data(client
, TPS6586X_VERSIONCRC
);
520 dev_err(&client
->dev
, "Chip ID read failed: %d\n", version
);
524 tps6586x
= devm_kzalloc(&client
->dev
, sizeof(*tps6586x
), GFP_KERNEL
);
528 tps6586x
->version
= version
;
529 tps6586x_print_version(client
, tps6586x
->version
);
531 tps6586x
->client
= client
;
532 tps6586x
->dev
= &client
->dev
;
533 i2c_set_clientdata(client
, tps6586x
);
535 tps6586x
->regmap
= devm_regmap_init_i2c(client
,
536 &tps6586x_regmap_config
);
537 if (IS_ERR(tps6586x
->regmap
)) {
538 ret
= PTR_ERR(tps6586x
->regmap
);
539 dev_err(&client
->dev
, "regmap init failed: %d\n", ret
);
545 ret
= tps6586x_irq_init(tps6586x
, client
->irq
,
548 dev_err(&client
->dev
, "IRQ init failed: %d\n", ret
);
553 ret
= mfd_add_devices(tps6586x
->dev
, -1,
554 tps6586x_cell
, ARRAY_SIZE(tps6586x_cell
),
555 NULL
, 0, tps6586x
->irq_domain
);
557 dev_err(&client
->dev
, "mfd_add_devices failed: %d\n", ret
);
561 ret
= tps6586x_add_subdevs(tps6586x
, pdata
);
563 dev_err(&client
->dev
, "add devices failed: %d\n", ret
);
567 if (pdata
->pm_off
&& !pm_power_off
) {
568 tps6586x_dev
= &client
->dev
;
569 pm_power_off
= tps6586x_power_off
;
575 mfd_remove_devices(tps6586x
->dev
);
578 free_irq(client
->irq
, tps6586x
);
582 static int tps6586x_i2c_remove(struct i2c_client
*client
)
584 struct tps6586x
*tps6586x
= i2c_get_clientdata(client
);
586 tps6586x_remove_subdevs(tps6586x
);
587 mfd_remove_devices(tps6586x
->dev
);
589 free_irq(client
->irq
, tps6586x
);
593 static int __maybe_unused
tps6586x_i2c_suspend(struct device
*dev
)
595 struct tps6586x
*tps6586x
= dev_get_drvdata(dev
);
597 if (tps6586x
->client
->irq
)
598 disable_irq(tps6586x
->client
->irq
);
603 static int __maybe_unused
tps6586x_i2c_resume(struct device
*dev
)
605 struct tps6586x
*tps6586x
= dev_get_drvdata(dev
);
607 if (tps6586x
->client
->irq
)
608 enable_irq(tps6586x
->client
->irq
);
613 static SIMPLE_DEV_PM_OPS(tps6586x_pm_ops
, tps6586x_i2c_suspend
,
614 tps6586x_i2c_resume
);
616 static const struct i2c_device_id tps6586x_id_table
[] = {
620 MODULE_DEVICE_TABLE(i2c
, tps6586x_id_table
);
622 static struct i2c_driver tps6586x_driver
= {
625 .of_match_table
= of_match_ptr(tps6586x_of_match
),
626 .pm
= &tps6586x_pm_ops
,
628 .probe
= tps6586x_i2c_probe
,
629 .remove
= tps6586x_i2c_remove
,
630 .id_table
= tps6586x_id_table
,
633 static int __init
tps6586x_init(void)
635 return i2c_add_driver(&tps6586x_driver
);
637 subsys_initcall(tps6586x_init
);
639 static void __exit
tps6586x_exit(void)
641 i2c_del_driver(&tps6586x_driver
);
643 module_exit(tps6586x_exit
);
645 MODULE_DESCRIPTION("TPS6586X core driver");
646 MODULE_AUTHOR("Mike Rapoport <mike@compulab.co.il>");
647 MODULE_LICENSE("GPL");