Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Core driver for TI TPS6586x PMIC family
4 *
5 * Copyright (c) 2010 CompuLab Ltd.
6 * Mike Rapoport <mike@compulab.co.il>
7 *
8 * Based on da903x.c.
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>
13 */
14
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>
27#include <linux/of.h>
28
29#include <linux/mfd/core.h>
30#include <linux/mfd/tps6586x.h>
31
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)
36
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
42
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
49
50/* device id */
51#define TPS6586X_VERSIONCRC 0xcd
52
53/* Maximum register */
54#define TPS6586X_MAX_REGISTER TPS6586X_VERSIONCRC
55
56struct tps6586x_irq_data {
57 u8 mask_reg;
58 u8 mask_mask;
59};
60
61#define TPS6586X_IRQ(_reg, _mask) \
62 { \
63 .mask_reg = (_reg) - TPS6586X_INT_MASK1, \
64 .mask_mask = (_mask), \
65 }
66
67static 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),
95};
96
97static const struct resource tps6586x_rtc_resources[] = {
98 {
99 .start = TPS6586X_INT_RTC_ALM1,
100 .end = TPS6586X_INT_RTC_ALM1,
101 .flags = IORESOURCE_IRQ,
102 },
103};
104
105static const struct mfd_cell tps6586x_cell[] = {
106 {
107 .name = "tps6586x-gpio",
108 },
109 {
110 .name = "tps6586x-regulator",
111 },
112 {
113 .name = "tps6586x-rtc",
114 .num_resources = ARRAY_SIZE(tps6586x_rtc_resources),
115 .resources = &tps6586x_rtc_resources[0],
116 },
117 {
118 .name = "tps6586x-onkey",
119 },
120};
121
122struct tps6586x {
123 struct device *dev;
124 struct i2c_client *client;
125 struct regmap *regmap;
126 int version;
127
128 int irq;
129 struct irq_chip irq_chip;
130 struct mutex irq_lock;
131 int irq_base;
132 u32 irq_en;
133 u8 mask_reg[5];
134 struct irq_domain *irq_domain;
135};
136
137static inline struct tps6586x *dev_to_tps6586x(struct device *dev)
138{
139 return i2c_get_clientdata(to_i2c_client(dev));
140}
141
142int tps6586x_write(struct device *dev, int reg, uint8_t val)
143{
144 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
145
146 return regmap_write(tps6586x->regmap, reg, val);
147}
148EXPORT_SYMBOL_GPL(tps6586x_write);
149
150int tps6586x_writes(struct device *dev, int reg, int len, uint8_t *val)
151{
152 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
153
154 return regmap_bulk_write(tps6586x->regmap, reg, val, len);
155}
156EXPORT_SYMBOL_GPL(tps6586x_writes);
157
158int tps6586x_read(struct device *dev, int reg, uint8_t *val)
159{
160 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
161 unsigned int rval;
162 int ret;
163
164 ret = regmap_read(tps6586x->regmap, reg, &rval);
165 if (!ret)
166 *val = rval;
167 return ret;
168}
169EXPORT_SYMBOL_GPL(tps6586x_read);
170
171int tps6586x_reads(struct device *dev, int reg, int len, uint8_t *val)
172{
173 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
174
175 return regmap_bulk_read(tps6586x->regmap, reg, val, len);
176}
177EXPORT_SYMBOL_GPL(tps6586x_reads);
178
179int tps6586x_set_bits(struct device *dev, int reg, uint8_t bit_mask)
180{
181 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
182
183 return regmap_update_bits(tps6586x->regmap, reg, bit_mask, bit_mask);
184}
185EXPORT_SYMBOL_GPL(tps6586x_set_bits);
186
187int tps6586x_clr_bits(struct device *dev, int reg, uint8_t bit_mask)
188{
189 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
190
191 return regmap_update_bits(tps6586x->regmap, reg, bit_mask, 0);
192}
193EXPORT_SYMBOL_GPL(tps6586x_clr_bits);
194
195int tps6586x_update(struct device *dev, int reg, uint8_t val, uint8_t mask)
196{
197 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
198
199 return regmap_update_bits(tps6586x->regmap, reg, mask, val);
200}
201EXPORT_SYMBOL_GPL(tps6586x_update);
202
203int tps6586x_irq_get_virq(struct device *dev, int irq)
204{
205 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
206
207 return irq_create_mapping(tps6586x->irq_domain, irq);
208}
209EXPORT_SYMBOL_GPL(tps6586x_irq_get_virq);
210
211int tps6586x_get_version(struct device *dev)
212{
213 struct tps6586x *tps6586x = dev_get_drvdata(dev);
214
215 return tps6586x->version;
216}
217EXPORT_SYMBOL_GPL(tps6586x_get_version);
218
219static int __remove_subdev(struct device *dev, void *unused)
220{
221 platform_device_unregister(to_platform_device(dev));
222 return 0;
223}
224
225static int tps6586x_remove_subdevs(struct tps6586x *tps6586x)
226{
227 return device_for_each_child(tps6586x->dev, NULL, __remove_subdev);
228}
229
230static void tps6586x_irq_lock(struct irq_data *data)
231{
232 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(data);
233
234 mutex_lock(&tps6586x->irq_lock);
235}
236
237static void tps6586x_irq_enable(struct irq_data *irq_data)
238{
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];
242
243 tps6586x->mask_reg[data->mask_reg] &= ~data->mask_mask;
244 tps6586x->irq_en |= (1 << __irq);
245}
246
247static void tps6586x_irq_disable(struct irq_data *irq_data)
248{
249 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(irq_data);
250
251 unsigned int __irq = irq_data->hwirq;
252 const struct tps6586x_irq_data *data = &tps6586x_irqs[__irq];
253
254 tps6586x->mask_reg[data->mask_reg] |= data->mask_mask;
255 tps6586x->irq_en &= ~(1 << __irq);
256}
257
258static void tps6586x_irq_sync_unlock(struct irq_data *data)
259{
260 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(data);
261 int i;
262
263 for (i = 0; i < ARRAY_SIZE(tps6586x->mask_reg); i++) {
264 int ret;
265 ret = tps6586x_write(tps6586x->dev,
266 TPS6586X_INT_MASK1 + i,
267 tps6586x->mask_reg[i]);
268 WARN_ON(ret);
269 }
270
271 mutex_unlock(&tps6586x->irq_lock);
272}
273
274static int tps6586x_irq_set_wake(struct irq_data *irq_data, unsigned int on)
275{
276 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(irq_data);
277 return irq_set_irq_wake(tps6586x->irq, on);
278}
279
280static struct irq_chip tps6586x_irq_chip = {
281 .name = "tps6586x",
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),
287};
288
289static int tps6586x_irq_map(struct irq_domain *h, unsigned int virq,
290 irq_hw_number_t hw)
291{
292 struct tps6586x *tps6586x = h->host_data;
293
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);
298
299 return 0;
300}
301
302static const struct irq_domain_ops tps6586x_domain_ops = {
303 .map = tps6586x_irq_map,
304 .xlate = irq_domain_xlate_twocell,
305};
306
307static irqreturn_t tps6586x_irq(int irq, void *data)
308{
309 struct tps6586x *tps6586x = data;
310 uint32_t acks;
311 __le32 val;
312 int ret = 0;
313
314 ret = tps6586x_reads(tps6586x->dev, TPS6586X_INT_ACK1,
315 sizeof(acks), (uint8_t *)&val);
316
317 if (ret < 0) {
318 dev_err(tps6586x->dev, "failed to read interrupt status\n");
319 return IRQ_NONE;
320 }
321
322 acks = le32_to_cpu(val);
323
324 while (acks) {
325 int i = __ffs(acks);
326
327 if (tps6586x->irq_en & (1 << i))
328 handle_nested_irq(
329 irq_find_mapping(tps6586x->irq_domain, i));
330
331 acks &= ~(1 << i);
332 }
333
334 return IRQ_HANDLED;
335}
336
337static int tps6586x_irq_init(struct tps6586x *tps6586x, int irq,
338 int irq_base)
339{
340 int i, ret;
341 u8 tmp[4];
342 int new_irq_base;
343 int irq_num = ARRAY_SIZE(tps6586x_irqs);
344
345 tps6586x->irq = irq;
346
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);
351 }
352
353 tps6586x_reads(tps6586x->dev, TPS6586X_INT_ACK1, sizeof(tmp), tmp);
354
355 if (irq_base > 0) {
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);
360 return new_irq_base;
361 }
362 } else {
363 new_irq_base = 0;
364 }
365
366 tps6586x->irq_domain = irq_domain_add_simple(tps6586x->dev->of_node,
367 irq_num, new_irq_base, &tps6586x_domain_ops,
368 tps6586x);
369 if (!tps6586x->irq_domain) {
370 dev_err(tps6586x->dev, "Failed to create IRQ domain\n");
371 return -ENOMEM;
372 }
373 ret = request_threaded_irq(irq, NULL, tps6586x_irq, IRQF_ONESHOT,
374 "tps6586x", tps6586x);
375
376 if (!ret)
377 device_init_wakeup(tps6586x->dev, 1);
378
379 return ret;
380}
381
382static int tps6586x_add_subdevs(struct tps6586x *tps6586x,
383 struct tps6586x_platform_data *pdata)
384{
385 struct tps6586x_subdev_info *subdev;
386 struct platform_device *pdev;
387 int i, ret = 0;
388
389 for (i = 0; i < pdata->num_subdevs; i++) {
390 subdev = &pdata->subdevs[i];
391
392 pdev = platform_device_alloc(subdev->name, subdev->id);
393 if (!pdev) {
394 ret = -ENOMEM;
395 goto failed;
396 }
397
398 pdev->dev.parent = tps6586x->dev;
399 pdev->dev.platform_data = subdev->platform_data;
400 pdev->dev.of_node = subdev->of_node;
401
402 ret = platform_device_add(pdev);
403 if (ret) {
404 platform_device_put(pdev);
405 goto failed;
406 }
407 }
408 return 0;
409
410failed:
411 tps6586x_remove_subdevs(tps6586x);
412 return ret;
413}
414
415#ifdef CONFIG_OF
416static struct tps6586x_platform_data *tps6586x_parse_dt(struct i2c_client *client)
417{
418 struct device_node *np = client->dev.of_node;
419 struct tps6586x_platform_data *pdata;
420
421 pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
422 if (!pdata)
423 return NULL;
424
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");
430
431 return pdata;
432}
433
434static const struct of_device_id tps6586x_of_match[] = {
435 { .compatible = "ti,tps6586x", },
436 { },
437};
438#else
439static struct tps6586x_platform_data *tps6586x_parse_dt(struct i2c_client *client)
440{
441 return NULL;
442}
443#endif
444
445static bool is_volatile_reg(struct device *dev, unsigned int reg)
446{
447 /* Cache all interrupt mask register */
448 if ((reg >= TPS6586X_INT_MASK1) && (reg <= TPS6586X_INT_MASK5))
449 return false;
450
451 return true;
452}
453
454static const struct regmap_config tps6586x_regmap_config = {
455 .reg_bits = 8,
456 .val_bits = 8,
457 .max_register = TPS6586X_MAX_REGISTER,
458 .volatile_reg = is_volatile_reg,
459 .cache_type = REGCACHE_MAPLE,
460};
461
462static int tps6586x_power_off_handler(struct sys_off_data *data)
463{
464 int ret;
465
466 /* Put the PMIC into sleep state. This takes at least 20ms. */
467 ret = tps6586x_clr_bits(data->dev, TPS6586X_SUPPLYENE, EXITSLREQ_BIT);
468 if (ret)
469 return notifier_from_errno(ret);
470
471 ret = tps6586x_set_bits(data->dev, TPS6586X_SUPPLYENE, SLEEP_MODE_BIT);
472 if (ret)
473 return notifier_from_errno(ret);
474
475 mdelay(50);
476 return notifier_from_errno(-ETIME);
477}
478
479static int tps6586x_restart_handler(struct sys_off_data *data)
480{
481 int ret;
482
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);
485 if (ret)
486 return notifier_from_errno(ret);
487
488 mdelay(50);
489 return notifier_from_errno(-ETIME);
490}
491
492static void tps6586x_print_version(struct i2c_client *client, int version)
493{
494 const char *name;
495
496 switch (version) {
497 case TPS658621A:
498 name = "TPS658621A";
499 break;
500 case TPS658621CD:
501 name = "TPS658621C/D";
502 break;
503 case TPS658623:
504 name = "TPS658623";
505 break;
506 case TPS658640:
507 case TPS658640v2:
508 name = "TPS658640";
509 break;
510 case TPS658643:
511 name = "TPS658643";
512 break;
513 default:
514 name = "TPS6586X";
515 break;
516 }
517
518 dev_info(&client->dev, "Found %s, VERSIONCRC is %02x\n", name, version);
519}
520
521static int tps6586x_i2c_probe(struct i2c_client *client)
522{
523 struct tps6586x_platform_data *pdata = dev_get_platdata(&client->dev);
524 struct tps6586x *tps6586x;
525 int ret;
526 int version;
527
528 if (!pdata && client->dev.of_node)
529 pdata = tps6586x_parse_dt(client);
530
531 if (!pdata) {
532 dev_err(&client->dev, "tps6586x requires platform data\n");
533 return -ENOTSUPP;
534 }
535
536 version = i2c_smbus_read_byte_data(client, TPS6586X_VERSIONCRC);
537 if (version < 0) {
538 dev_err(&client->dev, "Chip ID read failed: %d\n", version);
539 return -EIO;
540 }
541
542 tps6586x = devm_kzalloc(&client->dev, sizeof(*tps6586x), GFP_KERNEL);
543 if (!tps6586x)
544 return -ENOMEM;
545
546 tps6586x->version = version;
547 tps6586x_print_version(client, tps6586x->version);
548
549 tps6586x->client = client;
550 tps6586x->dev = &client->dev;
551 i2c_set_clientdata(client, tps6586x);
552
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);
558 return ret;
559 }
560
561
562 if (client->irq) {
563 ret = tps6586x_irq_init(tps6586x, client->irq,
564 pdata->irq_base);
565 if (ret) {
566 dev_err(&client->dev, "IRQ init failed: %d\n", ret);
567 return ret;
568 }
569 }
570
571 ret = mfd_add_devices(tps6586x->dev, -1,
572 tps6586x_cell, ARRAY_SIZE(tps6586x_cell),
573 NULL, 0, tps6586x->irq_domain);
574 if (ret < 0) {
575 dev_err(&client->dev, "mfd_add_devices failed: %d\n", ret);
576 goto err_mfd_add;
577 }
578
579 ret = tps6586x_add_subdevs(tps6586x, pdata);
580 if (ret) {
581 dev_err(&client->dev, "add devices failed: %d\n", ret);
582 goto err_add_devs;
583 }
584
585 if (pdata->pm_off) {
586 ret = devm_register_power_off_handler(&client->dev, &tps6586x_power_off_handler,
587 NULL);
588 if (ret) {
589 dev_err(&client->dev, "register power off handler failed: %d\n", ret);
590 goto err_add_devs;
591 }
592
593 ret = devm_register_restart_handler(&client->dev, &tps6586x_restart_handler,
594 NULL);
595 if (ret) {
596 dev_err(&client->dev, "register restart handler failed: %d\n", ret);
597 goto err_add_devs;
598 }
599 }
600
601 return 0;
602
603err_add_devs:
604 mfd_remove_devices(tps6586x->dev);
605err_mfd_add:
606 if (client->irq)
607 free_irq(client->irq, tps6586x);
608 return ret;
609}
610
611static void tps6586x_i2c_remove(struct i2c_client *client)
612{
613 struct tps6586x *tps6586x = i2c_get_clientdata(client);
614
615 tps6586x_remove_subdevs(tps6586x);
616 mfd_remove_devices(tps6586x->dev);
617 if (client->irq)
618 free_irq(client->irq, tps6586x);
619}
620
621static int __maybe_unused tps6586x_i2c_suspend(struct device *dev)
622{
623 struct tps6586x *tps6586x = dev_get_drvdata(dev);
624
625 if (tps6586x->client->irq)
626 disable_irq(tps6586x->client->irq);
627
628 return 0;
629}
630
631static int __maybe_unused tps6586x_i2c_resume(struct device *dev)
632{
633 struct tps6586x *tps6586x = dev_get_drvdata(dev);
634
635 if (tps6586x->client->irq)
636 enable_irq(tps6586x->client->irq);
637
638 return 0;
639}
640
641static SIMPLE_DEV_PM_OPS(tps6586x_pm_ops, tps6586x_i2c_suspend,
642 tps6586x_i2c_resume);
643
644static const struct i2c_device_id tps6586x_id_table[] = {
645 { "tps6586x", 0 },
646 { },
647};
648MODULE_DEVICE_TABLE(i2c, tps6586x_id_table);
649
650static struct i2c_driver tps6586x_driver = {
651 .driver = {
652 .name = "tps6586x",
653 .of_match_table = of_match_ptr(tps6586x_of_match),
654 .pm = &tps6586x_pm_ops,
655 },
656 .probe = tps6586x_i2c_probe,
657 .remove = tps6586x_i2c_remove,
658 .id_table = tps6586x_id_table,
659};
660
661static int __init tps6586x_init(void)
662{
663 return i2c_add_driver(&tps6586x_driver);
664}
665subsys_initcall(tps6586x_init);
666
667static void __exit tps6586x_exit(void)
668{
669 i2c_del_driver(&tps6586x_driver);
670}
671module_exit(tps6586x_exit);
672
673MODULE_DESCRIPTION("TPS6586X core driver");
674MODULE_AUTHOR("Mike Rapoport <mike@compulab.co.il>");
1/*
2 * Core driver for TI TPS6586x PMIC family
3 *
4 * Copyright (c) 2010 CompuLab Ltd.
5 * Mike Rapoport <mike@compulab.co.il>
6 *
7 * Based on da903x.c.
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>
12 *
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.
16 */
17
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/of.h>
30
31#include <linux/mfd/core.h>
32#include <linux/mfd/tps6586x.h>
33
34#define TPS6586X_SUPPLYENE 0x14
35#define EXITSLREQ_BIT BIT(1)
36#define SLEEP_MODE_BIT BIT(3)
37
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
43
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
50
51/* device id */
52#define TPS6586X_VERSIONCRC 0xcd
53
54/* Maximum register */
55#define TPS6586X_MAX_REGISTER TPS6586X_VERSIONCRC
56
57struct tps6586x_irq_data {
58 u8 mask_reg;
59 u8 mask_mask;
60};
61
62#define TPS6586X_IRQ(_reg, _mask) \
63 { \
64 .mask_reg = (_reg) - TPS6586X_INT_MASK1, \
65 .mask_mask = (_mask), \
66 }
67
68static 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),
96};
97
98static struct resource tps6586x_rtc_resources[] = {
99 {
100 .start = TPS6586X_INT_RTC_ALM1,
101 .end = TPS6586X_INT_RTC_ALM1,
102 .flags = IORESOURCE_IRQ,
103 },
104};
105
106static const struct mfd_cell tps6586x_cell[] = {
107 {
108 .name = "tps6586x-gpio",
109 },
110 {
111 .name = "tps6586x-regulator",
112 },
113 {
114 .name = "tps6586x-rtc",
115 .num_resources = ARRAY_SIZE(tps6586x_rtc_resources),
116 .resources = &tps6586x_rtc_resources[0],
117 },
118 {
119 .name = "tps6586x-onkey",
120 },
121};
122
123struct tps6586x {
124 struct device *dev;
125 struct i2c_client *client;
126 struct regmap *regmap;
127 int version;
128
129 int irq;
130 struct irq_chip irq_chip;
131 struct mutex irq_lock;
132 int irq_base;
133 u32 irq_en;
134 u8 mask_reg[5];
135 struct irq_domain *irq_domain;
136};
137
138static inline struct tps6586x *dev_to_tps6586x(struct device *dev)
139{
140 return i2c_get_clientdata(to_i2c_client(dev));
141}
142
143int tps6586x_write(struct device *dev, int reg, uint8_t val)
144{
145 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
146
147 return regmap_write(tps6586x->regmap, reg, val);
148}
149EXPORT_SYMBOL_GPL(tps6586x_write);
150
151int tps6586x_writes(struct device *dev, int reg, int len, uint8_t *val)
152{
153 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
154
155 return regmap_bulk_write(tps6586x->regmap, reg, val, len);
156}
157EXPORT_SYMBOL_GPL(tps6586x_writes);
158
159int tps6586x_read(struct device *dev, int reg, uint8_t *val)
160{
161 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
162 unsigned int rval;
163 int ret;
164
165 ret = regmap_read(tps6586x->regmap, reg, &rval);
166 if (!ret)
167 *val = rval;
168 return ret;
169}
170EXPORT_SYMBOL_GPL(tps6586x_read);
171
172int tps6586x_reads(struct device *dev, int reg, int len, uint8_t *val)
173{
174 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
175
176 return regmap_bulk_read(tps6586x->regmap, reg, val, len);
177}
178EXPORT_SYMBOL_GPL(tps6586x_reads);
179
180int tps6586x_set_bits(struct device *dev, int reg, uint8_t bit_mask)
181{
182 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
183
184 return regmap_update_bits(tps6586x->regmap, reg, bit_mask, bit_mask);
185}
186EXPORT_SYMBOL_GPL(tps6586x_set_bits);
187
188int tps6586x_clr_bits(struct device *dev, int reg, uint8_t bit_mask)
189{
190 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
191
192 return regmap_update_bits(tps6586x->regmap, reg, bit_mask, 0);
193}
194EXPORT_SYMBOL_GPL(tps6586x_clr_bits);
195
196int tps6586x_update(struct device *dev, int reg, uint8_t val, uint8_t mask)
197{
198 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
199
200 return regmap_update_bits(tps6586x->regmap, reg, mask, val);
201}
202EXPORT_SYMBOL_GPL(tps6586x_update);
203
204int tps6586x_irq_get_virq(struct device *dev, int irq)
205{
206 struct tps6586x *tps6586x = dev_to_tps6586x(dev);
207
208 return irq_create_mapping(tps6586x->irq_domain, irq);
209}
210EXPORT_SYMBOL_GPL(tps6586x_irq_get_virq);
211
212int tps6586x_get_version(struct device *dev)
213{
214 struct tps6586x *tps6586x = dev_get_drvdata(dev);
215
216 return tps6586x->version;
217}
218EXPORT_SYMBOL_GPL(tps6586x_get_version);
219
220static int __remove_subdev(struct device *dev, void *unused)
221{
222 platform_device_unregister(to_platform_device(dev));
223 return 0;
224}
225
226static int tps6586x_remove_subdevs(struct tps6586x *tps6586x)
227{
228 return device_for_each_child(tps6586x->dev, NULL, __remove_subdev);
229}
230
231static void tps6586x_irq_lock(struct irq_data *data)
232{
233 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(data);
234
235 mutex_lock(&tps6586x->irq_lock);
236}
237
238static void tps6586x_irq_enable(struct irq_data *irq_data)
239{
240 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(irq_data);
241 unsigned int __irq = irq_data->hwirq;
242 const struct tps6586x_irq_data *data = &tps6586x_irqs[__irq];
243
244 tps6586x->mask_reg[data->mask_reg] &= ~data->mask_mask;
245 tps6586x->irq_en |= (1 << __irq);
246}
247
248static void tps6586x_irq_disable(struct irq_data *irq_data)
249{
250 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(irq_data);
251
252 unsigned int __irq = irq_data->hwirq;
253 const struct tps6586x_irq_data *data = &tps6586x_irqs[__irq];
254
255 tps6586x->mask_reg[data->mask_reg] |= data->mask_mask;
256 tps6586x->irq_en &= ~(1 << __irq);
257}
258
259static void tps6586x_irq_sync_unlock(struct irq_data *data)
260{
261 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(data);
262 int i;
263
264 for (i = 0; i < ARRAY_SIZE(tps6586x->mask_reg); i++) {
265 int ret;
266 ret = tps6586x_write(tps6586x->dev,
267 TPS6586X_INT_MASK1 + i,
268 tps6586x->mask_reg[i]);
269 WARN_ON(ret);
270 }
271
272 mutex_unlock(&tps6586x->irq_lock);
273}
274
275#ifdef CONFIG_PM_SLEEP
276static int tps6586x_irq_set_wake(struct irq_data *irq_data, unsigned int on)
277{
278 struct tps6586x *tps6586x = irq_data_get_irq_chip_data(irq_data);
279 return irq_set_irq_wake(tps6586x->irq, on);
280}
281#else
282#define tps6586x_irq_set_wake NULL
283#endif
284
285static struct irq_chip tps6586x_irq_chip = {
286 .name = "tps6586x",
287 .irq_bus_lock = tps6586x_irq_lock,
288 .irq_bus_sync_unlock = tps6586x_irq_sync_unlock,
289 .irq_disable = tps6586x_irq_disable,
290 .irq_enable = tps6586x_irq_enable,
291 .irq_set_wake = tps6586x_irq_set_wake,
292};
293
294static int tps6586x_irq_map(struct irq_domain *h, unsigned int virq,
295 irq_hw_number_t hw)
296{
297 struct tps6586x *tps6586x = h->host_data;
298
299 irq_set_chip_data(virq, tps6586x);
300 irq_set_chip_and_handler(virq, &tps6586x_irq_chip, handle_simple_irq);
301 irq_set_nested_thread(virq, 1);
302 irq_set_noprobe(virq);
303
304 return 0;
305}
306
307static const struct irq_domain_ops tps6586x_domain_ops = {
308 .map = tps6586x_irq_map,
309 .xlate = irq_domain_xlate_twocell,
310};
311
312static irqreturn_t tps6586x_irq(int irq, void *data)
313{
314 struct tps6586x *tps6586x = data;
315 u32 acks;
316 int ret = 0;
317
318 ret = tps6586x_reads(tps6586x->dev, TPS6586X_INT_ACK1,
319 sizeof(acks), (uint8_t *)&acks);
320
321 if (ret < 0) {
322 dev_err(tps6586x->dev, "failed to read interrupt status\n");
323 return IRQ_NONE;
324 }
325
326 acks = le32_to_cpu(acks);
327
328 while (acks) {
329 int i = __ffs(acks);
330
331 if (tps6586x->irq_en & (1 << i))
332 handle_nested_irq(
333 irq_find_mapping(tps6586x->irq_domain, i));
334
335 acks &= ~(1 << i);
336 }
337
338 return IRQ_HANDLED;
339}
340
341static int tps6586x_irq_init(struct tps6586x *tps6586x, int irq,
342 int irq_base)
343{
344 int i, ret;
345 u8 tmp[4];
346 int new_irq_base;
347 int irq_num = ARRAY_SIZE(tps6586x_irqs);
348
349 tps6586x->irq = irq;
350
351 mutex_init(&tps6586x->irq_lock);
352 for (i = 0; i < 5; i++) {
353 tps6586x->mask_reg[i] = 0xff;
354 tps6586x_write(tps6586x->dev, TPS6586X_INT_MASK1 + i, 0xff);
355 }
356
357 tps6586x_reads(tps6586x->dev, TPS6586X_INT_ACK1, sizeof(tmp), tmp);
358
359 if (irq_base > 0) {
360 new_irq_base = irq_alloc_descs(irq_base, 0, irq_num, -1);
361 if (new_irq_base < 0) {
362 dev_err(tps6586x->dev,
363 "Failed to alloc IRQs: %d\n", new_irq_base);
364 return new_irq_base;
365 }
366 } else {
367 new_irq_base = 0;
368 }
369
370 tps6586x->irq_domain = irq_domain_add_simple(tps6586x->dev->of_node,
371 irq_num, new_irq_base, &tps6586x_domain_ops,
372 tps6586x);
373 if (!tps6586x->irq_domain) {
374 dev_err(tps6586x->dev, "Failed to create IRQ domain\n");
375 return -ENOMEM;
376 }
377 ret = request_threaded_irq(irq, NULL, tps6586x_irq, IRQF_ONESHOT,
378 "tps6586x", tps6586x);
379
380 if (!ret)
381 device_init_wakeup(tps6586x->dev, 1);
382
383 return ret;
384}
385
386static int tps6586x_add_subdevs(struct tps6586x *tps6586x,
387 struct tps6586x_platform_data *pdata)
388{
389 struct tps6586x_subdev_info *subdev;
390 struct platform_device *pdev;
391 int i, ret = 0;
392
393 for (i = 0; i < pdata->num_subdevs; i++) {
394 subdev = &pdata->subdevs[i];
395
396 pdev = platform_device_alloc(subdev->name, subdev->id);
397 if (!pdev) {
398 ret = -ENOMEM;
399 goto failed;
400 }
401
402 pdev->dev.parent = tps6586x->dev;
403 pdev->dev.platform_data = subdev->platform_data;
404 pdev->dev.of_node = subdev->of_node;
405
406 ret = platform_device_add(pdev);
407 if (ret) {
408 platform_device_put(pdev);
409 goto failed;
410 }
411 }
412 return 0;
413
414failed:
415 tps6586x_remove_subdevs(tps6586x);
416 return ret;
417}
418
419#ifdef CONFIG_OF
420static struct tps6586x_platform_data *tps6586x_parse_dt(struct i2c_client *client)
421{
422 struct device_node *np = client->dev.of_node;
423 struct tps6586x_platform_data *pdata;
424
425 pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
426 if (!pdata) {
427 dev_err(&client->dev, "Memory allocation failed\n");
428 return NULL;
429 }
430
431 pdata->num_subdevs = 0;
432 pdata->subdevs = NULL;
433 pdata->gpio_base = -1;
434 pdata->irq_base = -1;
435 pdata->pm_off = of_property_read_bool(np, "ti,system-power-controller");
436
437 return pdata;
438}
439
440static const struct of_device_id tps6586x_of_match[] = {
441 { .compatible = "ti,tps6586x", },
442 { },
443};
444#else
445static struct tps6586x_platform_data *tps6586x_parse_dt(struct i2c_client *client)
446{
447 return NULL;
448}
449#endif
450
451static bool is_volatile_reg(struct device *dev, unsigned int reg)
452{
453 /* Cache all interrupt mask register */
454 if ((reg >= TPS6586X_INT_MASK1) && (reg <= TPS6586X_INT_MASK5))
455 return false;
456
457 return true;
458}
459
460static const struct regmap_config tps6586x_regmap_config = {
461 .reg_bits = 8,
462 .val_bits = 8,
463 .max_register = TPS6586X_MAX_REGISTER,
464 .volatile_reg = is_volatile_reg,
465 .cache_type = REGCACHE_RBTREE,
466};
467
468static struct device *tps6586x_dev;
469static void tps6586x_power_off(void)
470{
471 if (tps6586x_clr_bits(tps6586x_dev, TPS6586X_SUPPLYENE, EXITSLREQ_BIT))
472 return;
473
474 tps6586x_set_bits(tps6586x_dev, TPS6586X_SUPPLYENE, SLEEP_MODE_BIT);
475}
476
477static void tps6586x_print_version(struct i2c_client *client, int version)
478{
479 const char *name;
480
481 switch (version) {
482 case TPS658621A:
483 name = "TPS658621A";
484 break;
485 case TPS658621CD:
486 name = "TPS658621C/D";
487 break;
488 case TPS658623:
489 name = "TPS658623";
490 break;
491 case TPS658640:
492 case TPS658640v2:
493 name = "TPS658640";
494 break;
495 case TPS658643:
496 name = "TPS658643";
497 break;
498 default:
499 name = "TPS6586X";
500 break;
501 }
502
503 dev_info(&client->dev, "Found %s, VERSIONCRC is %02x\n", name, version);
504}
505
506static int tps6586x_i2c_probe(struct i2c_client *client,
507 const struct i2c_device_id *id)
508{
509 struct tps6586x_platform_data *pdata = dev_get_platdata(&client->dev);
510 struct tps6586x *tps6586x;
511 int ret;
512 int version;
513
514 if (!pdata && client->dev.of_node)
515 pdata = tps6586x_parse_dt(client);
516
517 if (!pdata) {
518 dev_err(&client->dev, "tps6586x requires platform data\n");
519 return -ENOTSUPP;
520 }
521
522 version = i2c_smbus_read_byte_data(client, TPS6586X_VERSIONCRC);
523 if (version < 0) {
524 dev_err(&client->dev, "Chip ID read failed: %d\n", version);
525 return -EIO;
526 }
527
528 tps6586x = devm_kzalloc(&client->dev, sizeof(*tps6586x), GFP_KERNEL);
529 if (!tps6586x)
530 return -ENOMEM;
531
532 tps6586x->version = version;
533 tps6586x_print_version(client, tps6586x->version);
534
535 tps6586x->client = client;
536 tps6586x->dev = &client->dev;
537 i2c_set_clientdata(client, tps6586x);
538
539 tps6586x->regmap = devm_regmap_init_i2c(client,
540 &tps6586x_regmap_config);
541 if (IS_ERR(tps6586x->regmap)) {
542 ret = PTR_ERR(tps6586x->regmap);
543 dev_err(&client->dev, "regmap init failed: %d\n", ret);
544 return ret;
545 }
546
547
548 if (client->irq) {
549 ret = tps6586x_irq_init(tps6586x, client->irq,
550 pdata->irq_base);
551 if (ret) {
552 dev_err(&client->dev, "IRQ init failed: %d\n", ret);
553 return ret;
554 }
555 }
556
557 ret = mfd_add_devices(tps6586x->dev, -1,
558 tps6586x_cell, ARRAY_SIZE(tps6586x_cell),
559 NULL, 0, tps6586x->irq_domain);
560 if (ret < 0) {
561 dev_err(&client->dev, "mfd_add_devices failed: %d\n", ret);
562 goto err_mfd_add;
563 }
564
565 ret = tps6586x_add_subdevs(tps6586x, pdata);
566 if (ret) {
567 dev_err(&client->dev, "add devices failed: %d\n", ret);
568 goto err_add_devs;
569 }
570
571 if (pdata->pm_off && !pm_power_off) {
572 tps6586x_dev = &client->dev;
573 pm_power_off = tps6586x_power_off;
574 }
575
576 return 0;
577
578err_add_devs:
579 mfd_remove_devices(tps6586x->dev);
580err_mfd_add:
581 if (client->irq)
582 free_irq(client->irq, tps6586x);
583 return ret;
584}
585
586static int tps6586x_i2c_remove(struct i2c_client *client)
587{
588 struct tps6586x *tps6586x = i2c_get_clientdata(client);
589
590 tps6586x_remove_subdevs(tps6586x);
591 mfd_remove_devices(tps6586x->dev);
592 if (client->irq)
593 free_irq(client->irq, tps6586x);
594 return 0;
595}
596
597static const struct i2c_device_id tps6586x_id_table[] = {
598 { "tps6586x", 0 },
599 { },
600};
601MODULE_DEVICE_TABLE(i2c, tps6586x_id_table);
602
603static struct i2c_driver tps6586x_driver = {
604 .driver = {
605 .name = "tps6586x",
606 .of_match_table = of_match_ptr(tps6586x_of_match),
607 },
608 .probe = tps6586x_i2c_probe,
609 .remove = tps6586x_i2c_remove,
610 .id_table = tps6586x_id_table,
611};
612
613static int __init tps6586x_init(void)
614{
615 return i2c_add_driver(&tps6586x_driver);
616}
617subsys_initcall(tps6586x_init);
618
619static void __exit tps6586x_exit(void)
620{
621 i2c_del_driver(&tps6586x_driver);
622}
623module_exit(tps6586x_exit);
624
625MODULE_DESCRIPTION("TPS6586X core driver");
626MODULE_AUTHOR("Mike Rapoport <mike@compulab.co.il>");
627MODULE_LICENSE("GPL");