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/reboot.h>
26 #include <linux/regmap.h>
29 #include <linux/mfd/core.h>
30 #include <linux/mfd/tps6586x.h>
32 #define TPS6586X_SUPPLYENE 0x14
33 #define SOFT_RST_BIT BIT(0)
34 #define EXITSLREQ_BIT BIT(1)
35 #define SLEEP_MODE_BIT BIT(3)
37 /* interrupt control registers */
38 #define TPS6586X_INT_ACK1 0xb5
39 #define TPS6586X_INT_ACK2 0xb6
40 #define TPS6586X_INT_ACK3 0xb7
41 #define TPS6586X_INT_ACK4 0xb8
43 /* interrupt mask registers */
44 #define TPS6586X_INT_MASK1 0xb0
45 #define TPS6586X_INT_MASK2 0xb1
46 #define TPS6586X_INT_MASK3 0xb2
47 #define TPS6586X_INT_MASK4 0xb3
48 #define TPS6586X_INT_MASK5 0xb4
51 #define TPS6586X_VERSIONCRC 0xcd
53 /* Maximum register */
54 #define TPS6586X_MAX_REGISTER TPS6586X_VERSIONCRC
56 struct tps6586x_irq_data
{
61 #define TPS6586X_IRQ(_reg, _mask) \
63 .mask_reg = (_reg) - TPS6586X_INT_MASK1, \
64 .mask_mask = (_mask), \
67 static const struct tps6586x_irq_data tps6586x_irqs
[] = {
68 [TPS6586X_INT_PLDO_0
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 0),
69 [TPS6586X_INT_PLDO_1
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 1),
70 [TPS6586X_INT_PLDO_2
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 2),
71 [TPS6586X_INT_PLDO_3
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 3),
72 [TPS6586X_INT_PLDO_4
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 4),
73 [TPS6586X_INT_PLDO_5
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 5),
74 [TPS6586X_INT_PLDO_6
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 6),
75 [TPS6586X_INT_PLDO_7
] = TPS6586X_IRQ(TPS6586X_INT_MASK1
, 1 << 7),
76 [TPS6586X_INT_COMP_DET
] = TPS6586X_IRQ(TPS6586X_INT_MASK4
, 1 << 0),
77 [TPS6586X_INT_ADC
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 1),
78 [TPS6586X_INT_PLDO_8
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 2),
79 [TPS6586X_INT_PLDO_9
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 3),
80 [TPS6586X_INT_PSM_0
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 4),
81 [TPS6586X_INT_PSM_1
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 5),
82 [TPS6586X_INT_PSM_2
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 6),
83 [TPS6586X_INT_PSM_3
] = TPS6586X_IRQ(TPS6586X_INT_MASK2
, 1 << 7),
84 [TPS6586X_INT_RTC_ALM1
] = TPS6586X_IRQ(TPS6586X_INT_MASK5
, 1 << 4),
85 [TPS6586X_INT_ACUSB_OVP
] = TPS6586X_IRQ(TPS6586X_INT_MASK5
, 0x03),
86 [TPS6586X_INT_USB_DET
] = TPS6586X_IRQ(TPS6586X_INT_MASK5
, 1 << 2),
87 [TPS6586X_INT_AC_DET
] = TPS6586X_IRQ(TPS6586X_INT_MASK5
, 1 << 3),
88 [TPS6586X_INT_BAT_DET
] = TPS6586X_IRQ(TPS6586X_INT_MASK3
, 1 << 0),
89 [TPS6586X_INT_CHG_STAT
] = TPS6586X_IRQ(TPS6586X_INT_MASK4
, 0xfc),
90 [TPS6586X_INT_CHG_TEMP
] = TPS6586X_IRQ(TPS6586X_INT_MASK3
, 0x06),
91 [TPS6586X_INT_PP
] = TPS6586X_IRQ(TPS6586X_INT_MASK3
, 0xf0),
92 [TPS6586X_INT_RESUME
] = TPS6586X_IRQ(TPS6586X_INT_MASK5
, 1 << 5),
93 [TPS6586X_INT_LOW_SYS
] = TPS6586X_IRQ(TPS6586X_INT_MASK5
, 1 << 6),
94 [TPS6586X_INT_RTC_ALM2
] = TPS6586X_IRQ(TPS6586X_INT_MASK4
, 1 << 1),
97 static const struct resource tps6586x_rtc_resources
[] = {
99 .start
= TPS6586X_INT_RTC_ALM1
,
100 .end
= TPS6586X_INT_RTC_ALM1
,
101 .flags
= IORESOURCE_IRQ
,
105 static const struct mfd_cell tps6586x_cell
[] = {
107 .name
= "tps6586x-gpio",
110 .name
= "tps6586x-regulator",
113 .name
= "tps6586x-rtc",
114 .num_resources
= ARRAY_SIZE(tps6586x_rtc_resources
),
115 .resources
= &tps6586x_rtc_resources
[0],
118 .name
= "tps6586x-onkey",
124 struct i2c_client
*client
;
125 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 int tps6586x_get_version(struct device
*dev
)
213 struct tps6586x
*tps6586x
= dev_get_drvdata(dev
);
215 return tps6586x
->version
;
217 EXPORT_SYMBOL_GPL(tps6586x_get_version
);
219 static int __remove_subdev(struct device
*dev
, void *unused
)
221 platform_device_unregister(to_platform_device(dev
));
225 static int tps6586x_remove_subdevs(struct tps6586x
*tps6586x
)
227 return device_for_each_child(tps6586x
->dev
, NULL
, __remove_subdev
);
230 static void tps6586x_irq_lock(struct irq_data
*data
)
232 struct tps6586x
*tps6586x
= irq_data_get_irq_chip_data(data
);
234 mutex_lock(&tps6586x
->irq_lock
);
237 static void tps6586x_irq_enable(struct irq_data
*irq_data
)
239 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_disable(struct irq_data
*irq_data
)
249 struct tps6586x
*tps6586x
= irq_data_get_irq_chip_data(irq_data
);
251 unsigned int __irq
= irq_data
->hwirq
;
252 const struct tps6586x_irq_data
*data
= &tps6586x_irqs
[__irq
];
254 tps6586x
->mask_reg
[data
->mask_reg
] |= data
->mask_mask
;
255 tps6586x
->irq_en
&= ~(1 << __irq
);
258 static void tps6586x_irq_sync_unlock(struct irq_data
*data
)
260 struct tps6586x
*tps6586x
= irq_data_get_irq_chip_data(data
);
263 for (i
= 0; i
< ARRAY_SIZE(tps6586x
->mask_reg
); i
++) {
265 ret
= tps6586x_write(tps6586x
->dev
,
266 TPS6586X_INT_MASK1
+ i
,
267 tps6586x
->mask_reg
[i
]);
271 mutex_unlock(&tps6586x
->irq_lock
);
274 static int tps6586x_irq_set_wake(struct irq_data
*irq_data
, unsigned int on
)
276 struct tps6586x
*tps6586x
= irq_data_get_irq_chip_data(irq_data
);
277 return irq_set_irq_wake(tps6586x
->irq
, on
);
280 static struct irq_chip tps6586x_irq_chip
= {
282 .irq_bus_lock
= tps6586x_irq_lock
,
283 .irq_bus_sync_unlock
= tps6586x_irq_sync_unlock
,
284 .irq_disable
= tps6586x_irq_disable
,
285 .irq_enable
= tps6586x_irq_enable
,
286 .irq_set_wake
= pm_sleep_ptr(tps6586x_irq_set_wake
),
289 static int tps6586x_irq_map(struct irq_domain
*h
, unsigned int virq
,
292 struct tps6586x
*tps6586x
= h
->host_data
;
294 irq_set_chip_data(virq
, tps6586x
);
295 irq_set_chip_and_handler(virq
, &tps6586x_irq_chip
, handle_simple_irq
);
296 irq_set_nested_thread(virq
, 1);
297 irq_set_noprobe(virq
);
302 static const struct irq_domain_ops tps6586x_domain_ops
= {
303 .map
= tps6586x_irq_map
,
304 .xlate
= irq_domain_xlate_twocell
,
307 static irqreturn_t
tps6586x_irq(int irq
, void *data
)
309 struct tps6586x
*tps6586x
= data
;
314 ret
= tps6586x_reads(tps6586x
->dev
, TPS6586X_INT_ACK1
,
315 sizeof(acks
), (uint8_t *)&val
);
318 dev_err(tps6586x
->dev
, "failed to read interrupt status\n");
322 acks
= le32_to_cpu(val
);
327 if (tps6586x
->irq_en
& (1 << i
))
329 irq_find_mapping(tps6586x
->irq_domain
, i
));
337 static int tps6586x_irq_init(struct tps6586x
*tps6586x
, int irq
,
343 int irq_num
= ARRAY_SIZE(tps6586x_irqs
);
347 mutex_init(&tps6586x
->irq_lock
);
348 for (i
= 0; i
< 5; i
++) {
349 tps6586x
->mask_reg
[i
] = 0xff;
350 tps6586x_write(tps6586x
->dev
, TPS6586X_INT_MASK1
+ i
, 0xff);
353 tps6586x_reads(tps6586x
->dev
, TPS6586X_INT_ACK1
, sizeof(tmp
), tmp
);
356 new_irq_base
= irq_alloc_descs(irq_base
, 0, irq_num
, -1);
357 if (new_irq_base
< 0) {
358 dev_err(tps6586x
->dev
,
359 "Failed to alloc IRQs: %d\n", new_irq_base
);
366 tps6586x
->irq_domain
= irq_domain_add_simple(tps6586x
->dev
->of_node
,
367 irq_num
, new_irq_base
, &tps6586x_domain_ops
,
369 if (!tps6586x
->irq_domain
) {
370 dev_err(tps6586x
->dev
, "Failed to create IRQ domain\n");
373 ret
= request_threaded_irq(irq
, NULL
, tps6586x_irq
, IRQF_ONESHOT
,
374 "tps6586x", tps6586x
);
377 device_init_wakeup(tps6586x
->dev
, 1);
382 static int tps6586x_add_subdevs(struct tps6586x
*tps6586x
,
383 struct tps6586x_platform_data
*pdata
)
385 struct tps6586x_subdev_info
*subdev
;
386 struct platform_device
*pdev
;
389 for (i
= 0; i
< pdata
->num_subdevs
; i
++) {
390 subdev
= &pdata
->subdevs
[i
];
392 pdev
= platform_device_alloc(subdev
->name
, subdev
->id
);
398 pdev
->dev
.parent
= tps6586x
->dev
;
399 pdev
->dev
.platform_data
= subdev
->platform_data
;
400 pdev
->dev
.of_node
= subdev
->of_node
;
402 ret
= platform_device_add(pdev
);
404 platform_device_put(pdev
);
411 tps6586x_remove_subdevs(tps6586x
);
416 static struct tps6586x_platform_data
*tps6586x_parse_dt(struct i2c_client
*client
)
418 struct device_node
*np
= client
->dev
.of_node
;
419 struct tps6586x_platform_data
*pdata
;
421 pdata
= devm_kzalloc(&client
->dev
, sizeof(*pdata
), GFP_KERNEL
);
425 pdata
->num_subdevs
= 0;
426 pdata
->subdevs
= NULL
;
427 pdata
->gpio_base
= -1;
428 pdata
->irq_base
= -1;
429 pdata
->pm_off
= of_property_read_bool(np
, "ti,system-power-controller");
434 static const struct of_device_id tps6586x_of_match
[] = {
435 { .compatible
= "ti,tps6586x", },
439 static struct tps6586x_platform_data
*tps6586x_parse_dt(struct i2c_client
*client
)
445 static bool is_volatile_reg(struct device
*dev
, unsigned int reg
)
447 /* Cache all interrupt mask register */
448 if ((reg
>= TPS6586X_INT_MASK1
) && (reg
<= TPS6586X_INT_MASK5
))
454 static const struct regmap_config tps6586x_regmap_config
= {
457 .max_register
= TPS6586X_MAX_REGISTER
,
458 .volatile_reg
= is_volatile_reg
,
459 .cache_type
= REGCACHE_MAPLE
,
462 static int tps6586x_power_off_handler(struct sys_off_data
*data
)
466 /* Put the PMIC into sleep state. This takes at least 20ms. */
467 ret
= tps6586x_clr_bits(data
->dev
, TPS6586X_SUPPLYENE
, EXITSLREQ_BIT
);
469 return notifier_from_errno(ret
);
471 ret
= tps6586x_set_bits(data
->dev
, TPS6586X_SUPPLYENE
, SLEEP_MODE_BIT
);
473 return notifier_from_errno(ret
);
476 return notifier_from_errno(-ETIME
);
479 static int tps6586x_restart_handler(struct sys_off_data
*data
)
483 /* Put the PMIC into hard reboot state. This takes at least 20ms. */
484 ret
= tps6586x_set_bits(data
->dev
, TPS6586X_SUPPLYENE
, SOFT_RST_BIT
);
486 return notifier_from_errno(ret
);
489 return notifier_from_errno(-ETIME
);
492 static void tps6586x_print_version(struct i2c_client
*client
, int version
)
501 name
= "TPS658621C/D";
518 dev_info(&client
->dev
, "Found %s, VERSIONCRC is %02x\n", name
, version
);
521 static int tps6586x_i2c_probe(struct i2c_client
*client
)
523 struct tps6586x_platform_data
*pdata
= dev_get_platdata(&client
->dev
);
524 struct tps6586x
*tps6586x
;
528 if (!pdata
&& client
->dev
.of_node
)
529 pdata
= tps6586x_parse_dt(client
);
532 dev_err(&client
->dev
, "tps6586x requires platform data\n");
536 version
= i2c_smbus_read_byte_data(client
, TPS6586X_VERSIONCRC
);
538 dev_err(&client
->dev
, "Chip ID read failed: %d\n", version
);
542 tps6586x
= devm_kzalloc(&client
->dev
, sizeof(*tps6586x
), GFP_KERNEL
);
546 tps6586x
->version
= version
;
547 tps6586x_print_version(client
, tps6586x
->version
);
549 tps6586x
->client
= client
;
550 tps6586x
->dev
= &client
->dev
;
551 i2c_set_clientdata(client
, tps6586x
);
553 tps6586x
->regmap
= devm_regmap_init_i2c(client
,
554 &tps6586x_regmap_config
);
555 if (IS_ERR(tps6586x
->regmap
)) {
556 ret
= PTR_ERR(tps6586x
->regmap
);
557 dev_err(&client
->dev
, "regmap init failed: %d\n", ret
);
563 ret
= tps6586x_irq_init(tps6586x
, client
->irq
,
566 dev_err(&client
->dev
, "IRQ init failed: %d\n", ret
);
571 ret
= mfd_add_devices(tps6586x
->dev
, -1,
572 tps6586x_cell
, ARRAY_SIZE(tps6586x_cell
),
573 NULL
, 0, tps6586x
->irq_domain
);
575 dev_err(&client
->dev
, "mfd_add_devices failed: %d\n", ret
);
579 ret
= tps6586x_add_subdevs(tps6586x
, pdata
);
581 dev_err(&client
->dev
, "add devices failed: %d\n", ret
);
586 ret
= devm_register_power_off_handler(&client
->dev
, &tps6586x_power_off_handler
,
589 dev_err(&client
->dev
, "register power off handler failed: %d\n", ret
);
593 ret
= devm_register_restart_handler(&client
->dev
, &tps6586x_restart_handler
,
596 dev_err(&client
->dev
, "register restart handler failed: %d\n", ret
);
604 mfd_remove_devices(tps6586x
->dev
);
607 free_irq(client
->irq
, tps6586x
);
611 static void tps6586x_i2c_remove(struct i2c_client
*client
)
613 struct tps6586x
*tps6586x
= i2c_get_clientdata(client
);
615 tps6586x_remove_subdevs(tps6586x
);
616 mfd_remove_devices(tps6586x
->dev
);
618 free_irq(client
->irq
, tps6586x
);
621 static int __maybe_unused
tps6586x_i2c_suspend(struct device
*dev
)
623 struct tps6586x
*tps6586x
= dev_get_drvdata(dev
);
625 if (tps6586x
->client
->irq
)
626 disable_irq(tps6586x
->client
->irq
);
631 static int __maybe_unused
tps6586x_i2c_resume(struct device
*dev
)
633 struct tps6586x
*tps6586x
= dev_get_drvdata(dev
);
635 if (tps6586x
->client
->irq
)
636 enable_irq(tps6586x
->client
->irq
);
641 static SIMPLE_DEV_PM_OPS(tps6586x_pm_ops
, tps6586x_i2c_suspend
,
642 tps6586x_i2c_resume
);
644 static const struct i2c_device_id tps6586x_id_table
[] = {
648 MODULE_DEVICE_TABLE(i2c
, tps6586x_id_table
);
650 static struct i2c_driver tps6586x_driver
= {
653 .of_match_table
= of_match_ptr(tps6586x_of_match
),
654 .pm
= &tps6586x_pm_ops
,
656 .probe
= tps6586x_i2c_probe
,
657 .remove
= tps6586x_i2c_remove
,
658 .id_table
= tps6586x_id_table
,
661 static int __init
tps6586x_init(void)
663 return i2c_add_driver(&tps6586x_driver
);
665 subsys_initcall(tps6586x_init
);
667 static void __exit
tps6586x_exit(void)
669 i2c_del_driver(&tps6586x_driver
);
671 module_exit(tps6586x_exit
);
673 MODULE_DESCRIPTION("TPS6586X core driver");
674 MODULE_AUTHOR("Mike Rapoport <mike@compulab.co.il>");