1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * AXP20x PMIC USB power supply status driver
5 * Copyright (C) 2015 Hans de Goede <hdegoede@redhat.com>
6 * Copyright (C) 2014 Bruno Prémont <bonbons@linux-vserver.org>
9 #include <linux/bitops.h>
10 #include <linux/device.h>
11 #include <linux/devm-helpers.h>
12 #include <linux/init.h>
13 #include <linux/interrupt.h>
14 #include <linux/kernel.h>
15 #include <linux/mfd/axp20x.h>
16 #include <linux/module.h>
18 #include <linux/of_device.h>
19 #include <linux/platform_device.h>
21 #include <linux/power_supply.h>
22 #include <linux/regmap.h>
23 #include <linux/slab.h>
24 #include <linux/iio/consumer.h>
25 #include <linux/workqueue.h>
27 #define DRVNAME "axp20x-usb-power-supply"
29 #define AXP20X_PWR_STATUS_VBUS_PRESENT BIT(5)
30 #define AXP20X_PWR_STATUS_VBUS_USED BIT(4)
32 #define AXP20X_USB_STATUS_VBUS_VALID BIT(2)
34 #define AXP20X_VBUS_PATH_SEL BIT(7)
35 #define AXP20X_VBUS_PATH_SEL_OFFSET 7
37 #define AXP20X_VBUS_VHOLD_uV(b) (4000000 + (((b) >> 3) & 7) * 100000)
38 #define AXP20X_VBUS_VHOLD_MASK GENMASK(5, 3)
39 #define AXP20X_VBUS_VHOLD_OFFSET 3
40 #define AXP20X_VBUS_CLIMIT_MASK 3
41 #define AXP20X_VBUS_CLIMIT_900mA 0
42 #define AXP20X_VBUS_CLIMIT_500mA 1
43 #define AXP20X_VBUS_CLIMIT_100mA 2
44 #define AXP20X_VBUS_CLIMIT_NONE 3
46 #define AXP813_VBUS_CLIMIT_900mA 0
47 #define AXP813_VBUS_CLIMIT_1500mA 1
48 #define AXP813_VBUS_CLIMIT_2000mA 2
49 #define AXP813_VBUS_CLIMIT_2500mA 3
51 #define AXP20X_ADC_EN1_VBUS_CURR BIT(2)
52 #define AXP20X_ADC_EN1_VBUS_VOLT BIT(3)
54 #define AXP20X_VBUS_MON_VBUS_VALID BIT(3)
56 #define AXP813_BC_EN BIT(0)
59 * Note do not raise the debounce time, we must report Vusb high within
60 * 100ms otherwise we get Vbus errors in musb.
62 #define DEBOUNCE_TIME msecs_to_jiffies(50)
64 struct axp20x_usb_power {
65 struct regmap *regmap;
66 struct power_supply *supply;
67 enum axp20x_variants axp20x_id;
68 struct iio_channel *vbus_v;
69 struct iio_channel *vbus_i;
70 struct delayed_work vbus_detect;
71 unsigned int old_status;
73 unsigned int num_irqs;
77 static bool axp20x_usb_vbus_needs_polling(struct axp20x_usb_power *power)
80 * Polling is only necessary while VBUS is offline. While online, a
81 * present->absent transition implies an online->offline transition
82 * and will trigger the VBUS_REMOVAL IRQ.
84 if (power->axp20x_id >= AXP221_ID && !power->online)
90 static irqreturn_t axp20x_usb_power_irq(int irq, void *devid)
92 struct axp20x_usb_power *power = devid;
94 power_supply_changed(power->supply);
96 mod_delayed_work(system_power_efficient_wq, &power->vbus_detect, DEBOUNCE_TIME);
101 static void axp20x_usb_power_poll_vbus(struct work_struct *work)
103 struct axp20x_usb_power *power =
104 container_of(work, struct axp20x_usb_power, vbus_detect.work);
108 ret = regmap_read(power->regmap, AXP20X_PWR_INPUT_STATUS, &val);
112 val &= (AXP20X_PWR_STATUS_VBUS_PRESENT | AXP20X_PWR_STATUS_VBUS_USED);
113 if (val != power->old_status)
114 power_supply_changed(power->supply);
116 power->old_status = val;
117 power->online = val & AXP20X_PWR_STATUS_VBUS_USED;
120 if (axp20x_usb_vbus_needs_polling(power))
121 mod_delayed_work(system_power_efficient_wq, &power->vbus_detect, DEBOUNCE_TIME);
124 static int axp20x_get_current_max(struct axp20x_usb_power *power, int *val)
127 int ret = regmap_read(power->regmap, AXP20X_VBUS_IPSOUT_MGMT, &v);
132 switch (v & AXP20X_VBUS_CLIMIT_MASK) {
133 case AXP20X_VBUS_CLIMIT_100mA:
134 if (power->axp20x_id == AXP221_ID)
135 *val = -1; /* No 100mA limit */
139 case AXP20X_VBUS_CLIMIT_500mA:
142 case AXP20X_VBUS_CLIMIT_900mA:
145 case AXP20X_VBUS_CLIMIT_NONE:
153 static int axp813_get_current_max(struct axp20x_usb_power *power, int *val)
156 int ret = regmap_read(power->regmap, AXP20X_VBUS_IPSOUT_MGMT, &v);
161 switch (v & AXP20X_VBUS_CLIMIT_MASK) {
162 case AXP813_VBUS_CLIMIT_900mA:
165 case AXP813_VBUS_CLIMIT_1500mA:
168 case AXP813_VBUS_CLIMIT_2000mA:
171 case AXP813_VBUS_CLIMIT_2500mA:
178 static int axp20x_usb_power_get_property(struct power_supply *psy,
179 enum power_supply_property psp, union power_supply_propval *val)
181 struct axp20x_usb_power *power = power_supply_get_drvdata(psy);
182 unsigned int input, v;
186 case POWER_SUPPLY_PROP_VOLTAGE_MIN:
187 ret = regmap_read(power->regmap, AXP20X_VBUS_IPSOUT_MGMT, &v);
191 val->intval = AXP20X_VBUS_VHOLD_uV(v);
193 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
194 if (IS_ENABLED(CONFIG_AXP20X_ADC)) {
195 ret = iio_read_channel_processed(power->vbus_v,
201 * IIO framework gives mV but Power Supply framework
208 ret = axp20x_read_variable_width(power->regmap,
209 AXP20X_VBUS_V_ADC_H, 12);
213 val->intval = ret * 1700; /* 1 step = 1.7 mV */
215 case POWER_SUPPLY_PROP_CURRENT_MAX:
216 if (power->axp20x_id == AXP813_ID)
217 return axp813_get_current_max(power, &val->intval);
218 return axp20x_get_current_max(power, &val->intval);
219 case POWER_SUPPLY_PROP_CURRENT_NOW:
220 if (IS_ENABLED(CONFIG_AXP20X_ADC)) {
221 ret = iio_read_channel_processed(power->vbus_i,
227 * IIO framework gives mA but Power Supply framework
234 ret = axp20x_read_variable_width(power->regmap,
235 AXP20X_VBUS_I_ADC_H, 12);
239 val->intval = ret * 375; /* 1 step = 0.375 mA */
245 /* All the properties below need the input-status reg value */
246 ret = regmap_read(power->regmap, AXP20X_PWR_INPUT_STATUS, &input);
251 case POWER_SUPPLY_PROP_HEALTH:
252 if (!(input & AXP20X_PWR_STATUS_VBUS_PRESENT)) {
253 val->intval = POWER_SUPPLY_HEALTH_UNKNOWN;
257 val->intval = POWER_SUPPLY_HEALTH_GOOD;
259 if (power->axp20x_id == AXP202_ID) {
260 ret = regmap_read(power->regmap,
261 AXP20X_USB_OTG_STATUS, &v);
265 if (!(v & AXP20X_USB_STATUS_VBUS_VALID))
267 POWER_SUPPLY_HEALTH_UNSPEC_FAILURE;
270 case POWER_SUPPLY_PROP_PRESENT:
271 val->intval = !!(input & AXP20X_PWR_STATUS_VBUS_PRESENT);
273 case POWER_SUPPLY_PROP_ONLINE:
274 val->intval = !!(input & AXP20X_PWR_STATUS_VBUS_USED);
283 static int axp813_usb_power_set_online(struct axp20x_usb_power *power,
286 int val = !intval << AXP20X_VBUS_PATH_SEL_OFFSET;
288 return regmap_update_bits(power->regmap,
289 AXP20X_VBUS_IPSOUT_MGMT,
290 AXP20X_VBUS_PATH_SEL, val);
293 static int axp20x_usb_power_set_voltage_min(struct axp20x_usb_power *power,
307 val = (intval - 4000000) / 100000;
308 return regmap_update_bits(power->regmap,
309 AXP20X_VBUS_IPSOUT_MGMT,
310 AXP20X_VBUS_VHOLD_MASK,
311 val << AXP20X_VBUS_VHOLD_OFFSET);
319 static int axp813_usb_power_set_current_max(struct axp20x_usb_power *power,
326 return regmap_update_bits(power->regmap,
327 AXP20X_VBUS_IPSOUT_MGMT,
328 AXP20X_VBUS_CLIMIT_MASK,
329 AXP813_VBUS_CLIMIT_900mA);
333 val = (intval - 1000000) / 500000;
334 return regmap_update_bits(power->regmap,
335 AXP20X_VBUS_IPSOUT_MGMT,
336 AXP20X_VBUS_CLIMIT_MASK, val);
344 static int axp20x_usb_power_set_current_max(struct axp20x_usb_power *power,
351 if (power->axp20x_id == AXP221_ID)
356 val = (900000 - intval) / 400000;
357 return regmap_update_bits(power->regmap,
358 AXP20X_VBUS_IPSOUT_MGMT,
359 AXP20X_VBUS_CLIMIT_MASK, val);
367 static int axp20x_usb_power_set_property(struct power_supply *psy,
368 enum power_supply_property psp,
369 const union power_supply_propval *val)
371 struct axp20x_usb_power *power = power_supply_get_drvdata(psy);
374 case POWER_SUPPLY_PROP_ONLINE:
375 if (power->axp20x_id != AXP813_ID)
377 return axp813_usb_power_set_online(power, val->intval);
379 case POWER_SUPPLY_PROP_VOLTAGE_MIN:
380 return axp20x_usb_power_set_voltage_min(power, val->intval);
382 case POWER_SUPPLY_PROP_CURRENT_MAX:
383 if (power->axp20x_id == AXP813_ID)
384 return axp813_usb_power_set_current_max(power,
386 return axp20x_usb_power_set_current_max(power, val->intval);
395 static int axp20x_usb_power_prop_writeable(struct power_supply *psy,
396 enum power_supply_property psp)
398 struct axp20x_usb_power *power = power_supply_get_drvdata(psy);
401 * The VBUS path select flag works differently on AXP288 and newer:
402 * - On AXP20x and AXP22x, the flag enables VBUS (ignoring N_VBUSEN).
403 * - On AXP288 and AXP8xx, the flag disables VBUS (ignoring N_VBUSEN).
404 * We only expose the control on variants where it can be used to force
405 * the VBUS input offline.
407 if (psp == POWER_SUPPLY_PROP_ONLINE)
408 return power->axp20x_id == AXP813_ID;
410 return psp == POWER_SUPPLY_PROP_VOLTAGE_MIN ||
411 psp == POWER_SUPPLY_PROP_CURRENT_MAX;
414 static enum power_supply_property axp20x_usb_power_properties[] = {
415 POWER_SUPPLY_PROP_HEALTH,
416 POWER_SUPPLY_PROP_PRESENT,
417 POWER_SUPPLY_PROP_ONLINE,
418 POWER_SUPPLY_PROP_VOLTAGE_MIN,
419 POWER_SUPPLY_PROP_VOLTAGE_NOW,
420 POWER_SUPPLY_PROP_CURRENT_MAX,
421 POWER_SUPPLY_PROP_CURRENT_NOW,
424 static enum power_supply_property axp22x_usb_power_properties[] = {
425 POWER_SUPPLY_PROP_HEALTH,
426 POWER_SUPPLY_PROP_PRESENT,
427 POWER_SUPPLY_PROP_ONLINE,
428 POWER_SUPPLY_PROP_VOLTAGE_MIN,
429 POWER_SUPPLY_PROP_CURRENT_MAX,
432 static const struct power_supply_desc axp20x_usb_power_desc = {
433 .name = "axp20x-usb",
434 .type = POWER_SUPPLY_TYPE_USB,
435 .properties = axp20x_usb_power_properties,
436 .num_properties = ARRAY_SIZE(axp20x_usb_power_properties),
437 .property_is_writeable = axp20x_usb_power_prop_writeable,
438 .get_property = axp20x_usb_power_get_property,
439 .set_property = axp20x_usb_power_set_property,
442 static const struct power_supply_desc axp22x_usb_power_desc = {
443 .name = "axp20x-usb",
444 .type = POWER_SUPPLY_TYPE_USB,
445 .properties = axp22x_usb_power_properties,
446 .num_properties = ARRAY_SIZE(axp22x_usb_power_properties),
447 .property_is_writeable = axp20x_usb_power_prop_writeable,
448 .get_property = axp20x_usb_power_get_property,
449 .set_property = axp20x_usb_power_set_property,
452 static const char * const axp20x_irq_names[] = {
459 static const char * const axp22x_irq_names[] = {
465 const struct power_supply_desc *power_desc;
466 const char * const *irq_names;
467 unsigned int num_irq_names;
468 enum axp20x_variants axp20x_id;
471 static const struct axp_data axp202_data = {
472 .power_desc = &axp20x_usb_power_desc,
473 .irq_names = axp20x_irq_names,
474 .num_irq_names = ARRAY_SIZE(axp20x_irq_names),
475 .axp20x_id = AXP202_ID,
478 static const struct axp_data axp221_data = {
479 .power_desc = &axp22x_usb_power_desc,
480 .irq_names = axp22x_irq_names,
481 .num_irq_names = ARRAY_SIZE(axp22x_irq_names),
482 .axp20x_id = AXP221_ID,
485 static const struct axp_data axp223_data = {
486 .power_desc = &axp22x_usb_power_desc,
487 .irq_names = axp22x_irq_names,
488 .num_irq_names = ARRAY_SIZE(axp22x_irq_names),
489 .axp20x_id = AXP223_ID,
492 static const struct axp_data axp813_data = {
493 .power_desc = &axp22x_usb_power_desc,
494 .irq_names = axp22x_irq_names,
495 .num_irq_names = ARRAY_SIZE(axp22x_irq_names),
496 .axp20x_id = AXP813_ID,
499 #ifdef CONFIG_PM_SLEEP
500 static int axp20x_usb_power_suspend(struct device *dev)
502 struct axp20x_usb_power *power = dev_get_drvdata(dev);
506 * Allow wake via VBUS_PLUGIN only.
508 * As nested threaded IRQs are not automatically disabled during
509 * suspend, we must explicitly disable the remainder of the IRQs.
511 if (device_may_wakeup(&power->supply->dev))
512 enable_irq_wake(power->irqs[i++]);
513 while (i < power->num_irqs)
514 disable_irq(power->irqs[i++]);
519 static int axp20x_usb_power_resume(struct device *dev)
521 struct axp20x_usb_power *power = dev_get_drvdata(dev);
524 if (device_may_wakeup(&power->supply->dev))
525 disable_irq_wake(power->irqs[i++]);
526 while (i < power->num_irqs)
527 enable_irq(power->irqs[i++]);
529 mod_delayed_work(system_power_efficient_wq, &power->vbus_detect, DEBOUNCE_TIME);
535 static SIMPLE_DEV_PM_OPS(axp20x_usb_power_pm_ops, axp20x_usb_power_suspend,
536 axp20x_usb_power_resume);
538 static int configure_iio_channels(struct platform_device *pdev,
539 struct axp20x_usb_power *power)
541 power->vbus_v = devm_iio_channel_get(&pdev->dev, "vbus_v");
542 if (IS_ERR(power->vbus_v)) {
543 if (PTR_ERR(power->vbus_v) == -ENODEV)
544 return -EPROBE_DEFER;
545 return PTR_ERR(power->vbus_v);
548 power->vbus_i = devm_iio_channel_get(&pdev->dev, "vbus_i");
549 if (IS_ERR(power->vbus_i)) {
550 if (PTR_ERR(power->vbus_i) == -ENODEV)
551 return -EPROBE_DEFER;
552 return PTR_ERR(power->vbus_i);
558 static int configure_adc_registers(struct axp20x_usb_power *power)
560 /* Enable vbus voltage and current measurement */
561 return regmap_update_bits(power->regmap, AXP20X_ADC_EN1,
562 AXP20X_ADC_EN1_VBUS_CURR |
563 AXP20X_ADC_EN1_VBUS_VOLT,
564 AXP20X_ADC_EN1_VBUS_CURR |
565 AXP20X_ADC_EN1_VBUS_VOLT);
568 static int axp20x_usb_power_probe(struct platform_device *pdev)
570 struct axp20x_dev *axp20x = dev_get_drvdata(pdev->dev.parent);
571 struct power_supply_config psy_cfg = {};
572 struct axp20x_usb_power *power;
573 const struct axp_data *axp_data;
576 if (!of_device_is_available(pdev->dev.of_node))
580 dev_err(&pdev->dev, "Parent drvdata not set\n");
584 axp_data = of_device_get_match_data(&pdev->dev);
586 power = devm_kzalloc(&pdev->dev,
587 struct_size(power, irqs, axp_data->num_irq_names),
592 platform_set_drvdata(pdev, power);
594 power->axp20x_id = axp_data->axp20x_id;
595 power->regmap = axp20x->regmap;
596 power->num_irqs = axp_data->num_irq_names;
598 ret = devm_delayed_work_autocancel(&pdev->dev, &power->vbus_detect,
599 axp20x_usb_power_poll_vbus);
603 if (power->axp20x_id == AXP202_ID) {
604 /* Enable vbus valid checking */
605 ret = regmap_update_bits(power->regmap, AXP20X_VBUS_MON,
606 AXP20X_VBUS_MON_VBUS_VALID,
607 AXP20X_VBUS_MON_VBUS_VALID);
611 if (IS_ENABLED(CONFIG_AXP20X_ADC))
612 ret = configure_iio_channels(pdev, power);
614 ret = configure_adc_registers(power);
620 if (power->axp20x_id == AXP813_ID) {
621 /* Enable USB Battery Charging specification detection */
622 ret = regmap_update_bits(axp20x->regmap, AXP288_BC_GLOBAL,
623 AXP813_BC_EN, AXP813_BC_EN);
628 psy_cfg.of_node = pdev->dev.of_node;
629 psy_cfg.drv_data = power;
631 power->supply = devm_power_supply_register(&pdev->dev,
632 axp_data->power_desc,
634 if (IS_ERR(power->supply))
635 return PTR_ERR(power->supply);
637 /* Request irqs after registering, as irqs may trigger immediately */
638 for (i = 0; i < axp_data->num_irq_names; i++) {
639 irq = platform_get_irq_byname(pdev, axp_data->irq_names[i]);
641 dev_err(&pdev->dev, "No IRQ for %s: %d\n",
642 axp_data->irq_names[i], irq);
645 power->irqs[i] = regmap_irq_get_virq(axp20x->regmap_irqc, irq);
646 ret = devm_request_any_context_irq(&pdev->dev, power->irqs[i],
647 axp20x_usb_power_irq, 0,
650 dev_err(&pdev->dev, "Error requesting %s IRQ: %d\n",
651 axp_data->irq_names[i], ret);
656 if (axp20x_usb_vbus_needs_polling(power))
657 queue_delayed_work(system_power_efficient_wq, &power->vbus_detect, 0);
662 static const struct of_device_id axp20x_usb_power_match[] = {
664 .compatible = "x-powers,axp202-usb-power-supply",
665 .data = &axp202_data,
667 .compatible = "x-powers,axp221-usb-power-supply",
668 .data = &axp221_data,
670 .compatible = "x-powers,axp223-usb-power-supply",
671 .data = &axp223_data,
673 .compatible = "x-powers,axp813-usb-power-supply",
674 .data = &axp813_data,
675 }, { /* sentinel */ }
677 MODULE_DEVICE_TABLE(of, axp20x_usb_power_match);
679 static struct platform_driver axp20x_usb_power_driver = {
680 .probe = axp20x_usb_power_probe,
683 .of_match_table = axp20x_usb_power_match,
684 .pm = &axp20x_usb_power_pm_ops,
688 module_platform_driver(axp20x_usb_power_driver);
690 MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
691 MODULE_DESCRIPTION("AXP20x PMIC USB power supply status driver");
692 MODULE_LICENSE("GPL");