1 // SPDX-License-Identifier: GPL-2.0+
3 * Power supply driver for the RICOH RN5T618 power management chip family
5 * Copyright (C) 2020 Andreas Kemnade
8 #include <linux/kernel.h>
9 #include <linux/device.h>
10 #include <linux/bitops.h>
11 #include <linux/errno.h>
12 #include <linux/iio/consumer.h>
13 #include <linux/init.h>
14 #include <linux/interrupt.h>
15 #include <linux/module.h>
16 #include <linux/mfd/rn5t618.h>
17 #include <linux/of_device.h>
18 #include <linux/platform_device.h>
19 #include <linux/power_supply.h>
20 #include <linux/regmap.h>
21 #include <linux/slab.h>
23 #define CHG_STATE_ADP_INPUT 0x40
24 #define CHG_STATE_USB_INPUT 0x80
25 #define CHG_STATE_MASK 0x1f
26 #define CHG_STATE_CHG_OFF 0
27 #define CHG_STATE_CHG_READY_VADP 1
28 #define CHG_STATE_CHG_TRICKLE 2
29 #define CHG_STATE_CHG_RAPID 3
30 #define CHG_STATE_CHG_COMPLETE 4
31 #define CHG_STATE_SUSPEND 5
32 #define CHG_STATE_VCHG_OVER_VOL 6
33 #define CHG_STATE_BAT_ERROR 7
34 #define CHG_STATE_NO_BAT 8
35 #define CHG_STATE_BAT_OVER_VOL 9
36 #define CHG_STATE_BAT_TEMP_ERR 10
37 #define CHG_STATE_DIE_ERR 11
38 #define CHG_STATE_DIE_SHUTDOWN 12
39 #define CHG_STATE_NO_BAT2 13
40 #define CHG_STATE_CHG_READY_VUSB 14
42 #define GCHGDET_TYPE_MASK 0x30
43 #define GCHGDET_TYPE_SDP 0x00
44 #define GCHGDET_TYPE_CDP 0x10
45 #define GCHGDET_TYPE_DCP 0x20
50 * Formula seems accurate for battery current, but for USB current around 70mA
51 * per step was seen on Kobo Clara HD but all sources show the same formula
52 * also fur USB current. To avoid accidentially unwanted high currents we stick
55 #define TO_CUR_REG(x) ((x) / 100000 - 1)
56 #define FROM_CUR_REG(x) ((((x) & 0x1f) + 1) * 100000)
57 #define CHG_MIN_CUR 100000
58 #define CHG_MAX_CUR 1800000
59 #define ADP_MAX_CUR 2500000
60 #define USB_MAX_CUR 1400000
63 struct rn5t618_power_info {
64 struct rn5t618 *rn5t618;
65 struct platform_device *pdev;
66 struct power_supply *battery;
67 struct power_supply *usb;
68 struct power_supply *adp;
69 struct iio_channel *channel_vusb;
70 struct iio_channel *channel_vadp;
74 static enum power_supply_usb_type rn5t618_usb_types[] = {
75 POWER_SUPPLY_USB_TYPE_SDP,
76 POWER_SUPPLY_USB_TYPE_DCP,
77 POWER_SUPPLY_USB_TYPE_CDP,
78 POWER_SUPPLY_USB_TYPE_UNKNOWN
81 static enum power_supply_property rn5t618_usb_props[] = {
82 /* input current limit is not very accurate */
83 POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT,
84 POWER_SUPPLY_PROP_VOLTAGE_NOW,
85 POWER_SUPPLY_PROP_STATUS,
86 POWER_SUPPLY_PROP_USB_TYPE,
87 POWER_SUPPLY_PROP_ONLINE,
90 static enum power_supply_property rn5t618_adp_props[] = {
91 /* input current limit is not very accurate */
92 POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT,
93 POWER_SUPPLY_PROP_VOLTAGE_NOW,
94 POWER_SUPPLY_PROP_STATUS,
95 POWER_SUPPLY_PROP_ONLINE,
99 static enum power_supply_property rn5t618_battery_props[] = {
100 POWER_SUPPLY_PROP_STATUS,
101 POWER_SUPPLY_PROP_PRESENT,
102 POWER_SUPPLY_PROP_VOLTAGE_NOW,
103 POWER_SUPPLY_PROP_CURRENT_NOW,
104 POWER_SUPPLY_PROP_CAPACITY,
105 POWER_SUPPLY_PROP_TEMP,
106 POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
107 POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
108 POWER_SUPPLY_PROP_TECHNOLOGY,
109 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
110 POWER_SUPPLY_PROP_CHARGE_FULL,
111 POWER_SUPPLY_PROP_CHARGE_NOW,
114 static int rn5t618_battery_read_doublereg(struct rn5t618_power_info *info,
122 /* Prevent races when registers are changing. */
123 for (i = 0; i < 3; i++) {
124 ret = regmap_bulk_read(info->rn5t618->regmap,
125 reg, data, sizeof(data));
142 static int rn5t618_decode_status(unsigned int status)
144 switch (status & CHG_STATE_MASK) {
145 case CHG_STATE_CHG_OFF:
146 case CHG_STATE_SUSPEND:
147 case CHG_STATE_VCHG_OVER_VOL:
148 case CHG_STATE_DIE_SHUTDOWN:
149 return POWER_SUPPLY_STATUS_DISCHARGING;
151 case CHG_STATE_CHG_TRICKLE:
152 case CHG_STATE_CHG_RAPID:
153 return POWER_SUPPLY_STATUS_CHARGING;
155 case CHG_STATE_CHG_COMPLETE:
156 return POWER_SUPPLY_STATUS_FULL;
159 return POWER_SUPPLY_STATUS_NOT_CHARGING;
163 static int rn5t618_battery_status(struct rn5t618_power_info *info,
164 union power_supply_propval *val)
169 ret = regmap_read(info->rn5t618->regmap, RN5T618_CHGSTATE, &v);
173 val->intval = POWER_SUPPLY_STATUS_UNKNOWN;
175 if (v & 0xc0) { /* USB or ADP plugged */
176 val->intval = rn5t618_decode_status(v);
178 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
183 static int rn5t618_battery_present(struct rn5t618_power_info *info,
184 union power_supply_propval *val)
189 ret = regmap_read(info->rn5t618->regmap, RN5T618_CHGSTATE, &v);
194 if ((v == CHG_STATE_NO_BAT) || (v == CHG_STATE_NO_BAT2))
202 static int rn5t618_battery_voltage_now(struct rn5t618_power_info *info,
203 union power_supply_propval *val)
208 ret = rn5t618_battery_read_doublereg(info, RN5T618_VOLTAGE_1, &res);
212 val->intval = res * 2 * 2500 / 4095 * 1000;
217 static int rn5t618_battery_current_now(struct rn5t618_power_info *info,
218 union power_supply_propval *val)
223 ret = rn5t618_battery_read_doublereg(info, RN5T618_CC_AVEREG1, &res);
227 /* current is negative when discharging */
228 val->intval = sign_extend32(res, 13) * 1000;
233 static int rn5t618_battery_capacity(struct rn5t618_power_info *info,
234 union power_supply_propval *val)
239 ret = regmap_read(info->rn5t618->regmap, RN5T618_SOC, &v);
248 static int rn5t618_battery_temp(struct rn5t618_power_info *info,
249 union power_supply_propval *val)
254 ret = rn5t618_battery_read_doublereg(info, RN5T618_TEMP_1, &res);
258 val->intval = sign_extend32(res, 11) * 10 / 16;
263 static int rn5t618_battery_tte(struct rn5t618_power_info *info,
264 union power_supply_propval *val)
269 ret = rn5t618_battery_read_doublereg(info, RN5T618_TT_EMPTY_H, &res);
276 val->intval = res * 60;
281 static int rn5t618_battery_ttf(struct rn5t618_power_info *info,
282 union power_supply_propval *val)
287 ret = rn5t618_battery_read_doublereg(info, RN5T618_TT_FULL_H, &res);
294 val->intval = res * 60;
299 static int rn5t618_battery_set_current_limit(struct rn5t618_power_info *info,
300 const union power_supply_propval *val)
302 if (val->intval < CHG_MIN_CUR)
305 if (val->intval >= CHG_MAX_CUR)
308 return regmap_update_bits(info->rn5t618->regmap,
310 0x1F, TO_CUR_REG(val->intval));
313 static int rn5t618_battery_get_current_limit(struct rn5t618_power_info *info,
314 union power_supply_propval *val)
319 ret = regmap_read(info->rn5t618->regmap, RN5T618_CHGISET,
324 val->intval = FROM_CUR_REG(regval);
329 static int rn5t618_battery_charge_full(struct rn5t618_power_info *info,
330 union power_supply_propval *val)
335 ret = rn5t618_battery_read_doublereg(info, RN5T618_FA_CAP_H, &res);
339 val->intval = res * 1000;
344 static int rn5t618_battery_charge_now(struct rn5t618_power_info *info,
345 union power_supply_propval *val)
350 ret = rn5t618_battery_read_doublereg(info, RN5T618_RE_CAP_H, &res);
354 val->intval = res * 1000;
359 static int rn5t618_battery_get_property(struct power_supply *psy,
360 enum power_supply_property psp,
361 union power_supply_propval *val)
364 struct rn5t618_power_info *info = power_supply_get_drvdata(psy);
367 case POWER_SUPPLY_PROP_STATUS:
368 ret = rn5t618_battery_status(info, val);
370 case POWER_SUPPLY_PROP_PRESENT:
371 ret = rn5t618_battery_present(info, val);
373 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
374 ret = rn5t618_battery_voltage_now(info, val);
376 case POWER_SUPPLY_PROP_CURRENT_NOW:
377 ret = rn5t618_battery_current_now(info, val);
379 case POWER_SUPPLY_PROP_CAPACITY:
380 ret = rn5t618_battery_capacity(info, val);
382 case POWER_SUPPLY_PROP_TEMP:
383 ret = rn5t618_battery_temp(info, val);
385 case POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW:
386 ret = rn5t618_battery_tte(info, val);
388 case POWER_SUPPLY_PROP_TIME_TO_FULL_NOW:
389 ret = rn5t618_battery_ttf(info, val);
391 case POWER_SUPPLY_PROP_TECHNOLOGY:
392 val->intval = POWER_SUPPLY_TECHNOLOGY_LION;
394 case POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT:
395 ret = rn5t618_battery_get_current_limit(info, val);
397 case POWER_SUPPLY_PROP_CHARGE_FULL:
398 ret = rn5t618_battery_charge_full(info, val);
400 case POWER_SUPPLY_PROP_CHARGE_NOW:
401 ret = rn5t618_battery_charge_now(info, val);
410 static int rn5t618_battery_set_property(struct power_supply *psy,
411 enum power_supply_property psp,
412 const union power_supply_propval *val)
414 struct rn5t618_power_info *info = power_supply_get_drvdata(psy);
417 case POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT:
418 return rn5t618_battery_set_current_limit(info, val);
424 static int rn5t618_battery_property_is_writeable(struct power_supply *psy,
425 enum power_supply_property psp)
428 case POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT:
435 static int rn5t618_adp_get_property(struct power_supply *psy,
436 enum power_supply_property psp,
437 union power_supply_propval *val)
439 struct rn5t618_power_info *info = power_supply_get_drvdata(psy);
440 unsigned int chgstate;
445 ret = regmap_read(info->rn5t618->regmap, RN5T618_CHGSTATE, &chgstate);
449 online = !!(chgstate & CHG_STATE_ADP_INPUT);
452 case POWER_SUPPLY_PROP_ONLINE:
453 val->intval = online;
455 case POWER_SUPPLY_PROP_STATUS:
457 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
460 val->intval = rn5t618_decode_status(chgstate);
461 if (val->intval != POWER_SUPPLY_STATUS_CHARGING)
462 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
465 case POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT:
466 ret = regmap_read(info->rn5t618->regmap,
467 RN5T618_REGISET1, ®val);
471 val->intval = FROM_CUR_REG(regval);
473 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
474 if (!info->channel_vadp)
477 ret = iio_read_channel_processed_scale(info->channel_vadp, &val->intval, 1000);
489 static int rn5t618_adp_set_property(struct power_supply *psy,
490 enum power_supply_property psp,
491 const union power_supply_propval *val)
493 struct rn5t618_power_info *info = power_supply_get_drvdata(psy);
497 case POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT:
498 if (val->intval > ADP_MAX_CUR)
501 if (val->intval < CHG_MIN_CUR)
504 ret = regmap_write(info->rn5t618->regmap, RN5T618_REGISET1,
505 TO_CUR_REG(val->intval));
517 static int rn5t618_adp_property_is_writeable(struct power_supply *psy,
518 enum power_supply_property psp)
521 case POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT:
528 static int rc5t619_usb_get_type(struct rn5t618_power_info *info,
529 union power_supply_propval *val)
534 ret = regmap_read(info->rn5t618->regmap, RN5T618_GCHGDET, ®val);
538 switch (regval & GCHGDET_TYPE_MASK) {
539 case GCHGDET_TYPE_SDP:
540 val->intval = POWER_SUPPLY_USB_TYPE_SDP;
542 case GCHGDET_TYPE_CDP:
543 val->intval = POWER_SUPPLY_USB_TYPE_CDP;
545 case GCHGDET_TYPE_DCP:
546 val->intval = POWER_SUPPLY_USB_TYPE_DCP;
549 val->intval = POWER_SUPPLY_USB_TYPE_UNKNOWN;
555 static int rn5t618_usb_get_property(struct power_supply *psy,
556 enum power_supply_property psp,
557 union power_supply_propval *val)
559 struct rn5t618_power_info *info = power_supply_get_drvdata(psy);
560 unsigned int chgstate;
565 ret = regmap_read(info->rn5t618->regmap, RN5T618_CHGSTATE, &chgstate);
569 online = !!(chgstate & CHG_STATE_USB_INPUT);
572 case POWER_SUPPLY_PROP_ONLINE:
573 val->intval = online;
575 case POWER_SUPPLY_PROP_STATUS:
577 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
580 val->intval = rn5t618_decode_status(chgstate);
581 if (val->intval != POWER_SUPPLY_STATUS_CHARGING)
582 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
585 case POWER_SUPPLY_PROP_USB_TYPE:
586 if (!online || (info->rn5t618->variant != RC5T619))
589 return rc5t619_usb_get_type(info, val);
590 case POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT:
591 ret = regmap_read(info->rn5t618->regmap, RN5T618_CHGCTL1,
598 ret = regmap_read(info->rn5t618->regmap,
604 val->intval = FROM_CUR_REG(regval);
607 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
608 if (!info->channel_vusb)
611 ret = iio_read_channel_processed_scale(info->channel_vusb, &val->intval, 1000);
623 static int rn5t618_usb_set_property(struct power_supply *psy,
624 enum power_supply_property psp,
625 const union power_supply_propval *val)
627 struct rn5t618_power_info *info = power_supply_get_drvdata(psy);
631 case POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT:
632 if (val->intval > USB_MAX_CUR)
635 if (val->intval < CHG_MIN_CUR)
638 ret = regmap_write(info->rn5t618->regmap, RN5T618_REGISET2,
639 0xE0 | TO_CUR_REG(val->intval));
651 static int rn5t618_usb_property_is_writeable(struct power_supply *psy,
652 enum power_supply_property psp)
655 case POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT:
662 static const struct power_supply_desc rn5t618_battery_desc = {
663 .name = "rn5t618-battery",
664 .type = POWER_SUPPLY_TYPE_BATTERY,
665 .properties = rn5t618_battery_props,
666 .num_properties = ARRAY_SIZE(rn5t618_battery_props),
667 .get_property = rn5t618_battery_get_property,
668 .set_property = rn5t618_battery_set_property,
669 .property_is_writeable = rn5t618_battery_property_is_writeable,
672 static const struct power_supply_desc rn5t618_adp_desc = {
673 .name = "rn5t618-adp",
674 .type = POWER_SUPPLY_TYPE_MAINS,
675 .properties = rn5t618_adp_props,
676 .num_properties = ARRAY_SIZE(rn5t618_adp_props),
677 .get_property = rn5t618_adp_get_property,
678 .set_property = rn5t618_adp_set_property,
679 .property_is_writeable = rn5t618_adp_property_is_writeable,
682 static const struct power_supply_desc rn5t618_usb_desc = {
683 .name = "rn5t618-usb",
684 .type = POWER_SUPPLY_TYPE_USB,
685 .usb_types = rn5t618_usb_types,
686 .num_usb_types = ARRAY_SIZE(rn5t618_usb_types),
687 .properties = rn5t618_usb_props,
688 .num_properties = ARRAY_SIZE(rn5t618_usb_props),
689 .get_property = rn5t618_usb_get_property,
690 .set_property = rn5t618_usb_set_property,
691 .property_is_writeable = rn5t618_usb_property_is_writeable,
694 static irqreturn_t rn5t618_charger_irq(int irq, void *data)
696 struct device *dev = data;
697 struct rn5t618_power_info *info = dev_get_drvdata(dev);
699 unsigned int ctrl, stat1, stat2, err;
701 regmap_read(info->rn5t618->regmap, RN5T618_CHGERR_IRR, &err);
702 regmap_read(info->rn5t618->regmap, RN5T618_CHGCTRL_IRR, &ctrl);
703 regmap_read(info->rn5t618->regmap, RN5T618_CHGSTAT_IRR1, &stat1);
704 regmap_read(info->rn5t618->regmap, RN5T618_CHGSTAT_IRR2, &stat2);
706 regmap_write(info->rn5t618->regmap, RN5T618_CHGERR_IRR, 0);
707 regmap_write(info->rn5t618->regmap, RN5T618_CHGCTRL_IRR, 0);
708 regmap_write(info->rn5t618->regmap, RN5T618_CHGSTAT_IRR1, 0);
709 regmap_write(info->rn5t618->regmap, RN5T618_CHGSTAT_IRR2, 0);
711 dev_dbg(dev, "chgerr: %x chgctrl: %x chgstat: %x chgstat2: %x\n",
712 err, ctrl, stat1, stat2);
714 power_supply_changed(info->usb);
715 power_supply_changed(info->adp);
716 power_supply_changed(info->battery);
721 static int rn5t618_power_probe(struct platform_device *pdev)
725 struct power_supply_config psy_cfg = {};
726 struct rn5t618_power_info *info;
728 info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
733 info->rn5t618 = dev_get_drvdata(pdev->dev.parent);
736 platform_set_drvdata(pdev, info);
738 info->channel_vusb = devm_iio_channel_get(&pdev->dev, "vusb");
739 if (IS_ERR(info->channel_vusb)) {
740 if (PTR_ERR(info->channel_vusb) == -ENODEV)
741 return -EPROBE_DEFER;
742 return PTR_ERR(info->channel_vusb);
745 info->channel_vadp = devm_iio_channel_get(&pdev->dev, "vadp");
746 if (IS_ERR(info->channel_vadp)) {
747 if (PTR_ERR(info->channel_vadp) == -ENODEV)
748 return -EPROBE_DEFER;
749 return PTR_ERR(info->channel_vadp);
752 ret = regmap_read(info->rn5t618->regmap, RN5T618_CONTROL, &v);
756 if (!(v & FG_ENABLE)) {
757 /* E.g. the vendor kernels of various Kobo and Tolino Ebook
758 * readers disable the fuel gauge on shutdown. If a kernel
759 * without fuel gauge support is booted after that, the fuel
760 * gauge will get decalibrated.
762 dev_info(&pdev->dev, "Fuel gauge not enabled, enabling now\n");
763 dev_info(&pdev->dev, "Expect imprecise results\n");
764 regmap_update_bits(info->rn5t618->regmap, RN5T618_CONTROL,
765 FG_ENABLE, FG_ENABLE);
768 psy_cfg.drv_data = info;
769 info->battery = devm_power_supply_register(&pdev->dev,
770 &rn5t618_battery_desc,
772 if (IS_ERR(info->battery)) {
773 ret = PTR_ERR(info->battery);
774 dev_err(&pdev->dev, "failed to register battery: %d\n", ret);
778 info->adp = devm_power_supply_register(&pdev->dev,
781 if (IS_ERR(info->adp)) {
782 ret = PTR_ERR(info->adp);
783 dev_err(&pdev->dev, "failed to register adp: %d\n", ret);
787 info->usb = devm_power_supply_register(&pdev->dev,
790 if (IS_ERR(info->usb)) {
791 ret = PTR_ERR(info->usb);
792 dev_err(&pdev->dev, "failed to register usb: %d\n", ret);
796 if (info->rn5t618->irq_data)
797 info->irq = regmap_irq_get_virq(info->rn5t618->irq_data,
803 ret = devm_request_threaded_irq(&pdev->dev, info->irq, NULL,
810 dev_err(&pdev->dev, "request IRQ:%d fail\n",
819 static struct platform_driver rn5t618_power_driver = {
821 .name = "rn5t618-power",
823 .probe = rn5t618_power_probe,
826 module_platform_driver(rn5t618_power_driver);
827 MODULE_ALIAS("platform:rn5t618-power");
828 MODULE_DESCRIPTION("Power supply driver for RICOH RN5T618");
829 MODULE_LICENSE("GPL");