1 // SPDX-License-Identifier: GPL-2.0+
3 * Driver for UCS1002 Programmable USB Port Power Controller
5 * Copyright (C) 2019 Zodiac Inflight Innovations
7 #include <linux/bits.h>
8 #include <linux/freezer.h>
9 #include <linux/gpio/consumer.h>
10 #include <linux/i2c.h>
11 #include <linux/interrupt.h>
12 #include <linux/kernel.h>
13 #include <linux/kthread.h>
14 #include <linux/device.h>
15 #include <linux/module.h>
17 #include <linux/of_irq.h>
18 #include <linux/power_supply.h>
19 #include <linux/regmap.h>
20 #include <linux/regulator/driver.h>
21 #include <linux/regulator/of_regulator.h>
23 /* UCS1002 Registers */
24 #define UCS1002_REG_CURRENT_MEASUREMENT 0x00
27 * The Total Accumulated Charge registers store the total accumulated
28 * charge delivered from the VS source to a portable device. The total
29 * value is calculated using four registers, from 01h to 04h. The bit
30 * weighting of the registers is given in mA/hrs.
32 #define UCS1002_REG_TOTAL_ACC_CHARGE 0x01
34 /* Other Status Register */
35 #define UCS1002_REG_OTHER_STATUS 0x0f
36 # define F_ADET_PIN BIT(4)
37 # define F_CHG_ACT BIT(3)
39 /* Interrupt Status */
40 #define UCS1002_REG_INTERRUPT_STATUS 0x10
42 # define F_DISCHARGE_ERR BIT(6)
43 # define F_RESET BIT(5)
44 # define F_MIN_KEEP_OUT BIT(4)
46 # define F_OVER_VOLT BIT(2)
47 # define F_BACK_VOLT BIT(1)
48 # define F_OVER_ILIM BIT(0)
50 /* Pin Status Register */
51 #define UCS1002_REG_PIN_STATUS 0x14
52 # define UCS1002_PWR_STATE_MASK 0x03
53 # define F_PWR_EN_PIN BIT(6)
54 # define F_M2_PIN BIT(5)
55 # define F_M1_PIN BIT(4)
56 # define F_EM_EN_PIN BIT(3)
57 # define F_SEL_PIN BIT(2)
58 # define F_ACTIVE_MODE_MASK GENMASK(5, 3)
59 # define F_ACTIVE_MODE_PASSTHROUGH F_M2_PIN
60 # define F_ACTIVE_MODE_DEDICATED F_EM_EN_PIN
61 # define F_ACTIVE_MODE_BC12_DCP (F_M2_PIN | F_EM_EN_PIN)
62 # define F_ACTIVE_MODE_BC12_SDP F_M1_PIN
63 # define F_ACTIVE_MODE_BC12_CDP (F_M1_PIN | F_M2_PIN | F_EM_EN_PIN)
65 /* General Configuration Register */
66 #define UCS1002_REG_GENERAL_CFG 0x15
67 # define F_RATION_EN BIT(3)
69 /* Emulation Configuration Register */
70 #define UCS1002_REG_EMU_CFG 0x16
72 /* Switch Configuration Register */
73 #define UCS1002_REG_SWITCH_CFG 0x17
74 # define F_PIN_IGNORE BIT(7)
75 # define F_EM_EN_SET BIT(5)
76 # define F_M2_SET BIT(4)
77 # define F_M1_SET BIT(3)
78 # define F_S0_SET BIT(2)
79 # define F_PWR_EN_SET BIT(1)
80 # define F_LATCH_SET BIT(0)
81 # define V_SET_ACTIVE_MODE_MASK GENMASK(5, 3)
82 # define V_SET_ACTIVE_MODE_PASSTHROUGH F_M2_SET
83 # define V_SET_ACTIVE_MODE_DEDICATED F_EM_EN_SET
84 # define V_SET_ACTIVE_MODE_BC12_DCP (F_M2_SET | F_EM_EN_SET)
85 # define V_SET_ACTIVE_MODE_BC12_SDP F_M1_SET
86 # define V_SET_ACTIVE_MODE_BC12_CDP (F_M1_SET | F_M2_SET | F_EM_EN_SET)
88 /* Current Limit Register */
89 #define UCS1002_REG_ILIMIT 0x19
90 # define UCS1002_ILIM_SW_MASK GENMASK(3, 0)
93 #define UCS1002_REG_PRODUCT_ID 0xfd
94 # define UCS1002_PRODUCT_ID 0x4e
96 /* Manufacture name */
97 #define UCS1002_MANUFACTURER "SMSC"
100 struct power_supply *charger;
101 struct i2c_client *client;
102 struct regmap *regmap;
103 struct regulator_desc *regulator_descriptor;
104 struct regulator_dev *rdev;
107 struct delayed_work health_poll;
112 static enum power_supply_property ucs1002_props[] = {
113 POWER_SUPPLY_PROP_ONLINE,
114 POWER_SUPPLY_PROP_CHARGE_NOW,
115 POWER_SUPPLY_PROP_CURRENT_NOW,
116 POWER_SUPPLY_PROP_CURRENT_MAX,
117 POWER_SUPPLY_PROP_PRESENT, /* the presence of PED */
118 POWER_SUPPLY_PROP_MANUFACTURER,
119 POWER_SUPPLY_PROP_USB_TYPE,
120 POWER_SUPPLY_PROP_HEALTH,
123 static int ucs1002_get_online(struct ucs1002_info *info,
124 union power_supply_propval *val)
129 ret = regmap_read(info->regmap, UCS1002_REG_OTHER_STATUS, ®);
133 val->intval = !!(reg & F_CHG_ACT);
138 static int ucs1002_get_charge(struct ucs1002_info *info,
139 union power_supply_propval *val)
142 * To fit within 32 bits some values are rounded (uA/h)
144 * For Total Accumulated Charge Middle Low Byte register, addr
147 * B0: 0.01084 mA/h rounded to 11 uA/h
148 * B1: 0.02169 mA/h rounded to 22 uA/h
149 * B2: 0.04340 mA/h rounded to 43 uA/h
150 * B3: 0.08676 mA/h rounded to 87 uA/h
151 * B4: 0.17350 mA/h rounded to 173 uÁ/h
153 * For Total Accumulated Charge Low Byte register, addr 04h,
156 * B6: 0.00271 mA/h rounded to 3 uA/h
157 * B7: 0.005422 mA/h rounded to 5 uA/h
159 static const int bit_weights_uAh[BITS_PER_TYPE(u32)] = {
161 * Bit corresponding to low byte (offset 0x04)
162 * B0 B1 B2 B3 B4 B5 B6 B7
164 0, 0, 0, 0, 0, 0, 3, 5,
166 * Bit corresponding to middle low byte (offset 0x03)
167 * B0 B1 B2 B3 B4 B5 B6 B7
169 11, 22, 43, 87, 173, 347, 694, 1388,
171 * Bit corresponding to middle high byte (offset 0x02)
172 * B0 B1 B2 B3 B4 B5 B6 B7
174 2776, 5552, 11105, 22210, 44420, 88840, 177700, 355400,
176 * Bit corresponding to high byte (offset 0x01)
177 * B0 B1 B2 B3 B4 B5 B6 B7
179 710700, 1421000, 2843000, 5685000, 11371000, 22742000,
182 unsigned long total_acc_charger;
186 ret = regmap_bulk_read(info->regmap, UCS1002_REG_TOTAL_ACC_CHARGE,
191 total_acc_charger = be32_to_cpu(reg); /* BE as per offsets above */
194 for_each_set_bit(i, &total_acc_charger, ARRAY_SIZE(bit_weights_uAh))
195 val->intval += bit_weights_uAh[i];
200 static int ucs1002_get_current(struct ucs1002_info *info,
201 union power_supply_propval *val)
204 * The Current Measurement register stores the measured
205 * current value delivered to the portable device. The range
206 * is from 9.76 mA to 2.5 A.
208 static const int bit_weights_uA[BITS_PER_TYPE(u8)] = {
209 9760, 19500, 39000, 78100, 156200, 312300, 624600, 1249300,
211 unsigned long current_measurement;
215 ret = regmap_read(info->regmap, UCS1002_REG_CURRENT_MEASUREMENT, ®);
219 current_measurement = reg;
222 for_each_set_bit(i, ¤t_measurement, ARRAY_SIZE(bit_weights_uA))
223 val->intval += bit_weights_uA[i];
229 * The Current Limit register stores the maximum current used by the
230 * port switch. The range is from 500mA to 2.5 A.
232 static const u32 ucs1002_current_limit_uA[] = {
233 500000, 900000, 1000000, 1200000, 1500000, 1800000, 2000000, 2500000,
236 static int ucs1002_get_max_current(struct ucs1002_info *info,
237 union power_supply_propval *val)
242 if (info->output_disable) {
247 ret = regmap_read(info->regmap, UCS1002_REG_ILIMIT, ®);
251 val->intval = ucs1002_current_limit_uA[reg & UCS1002_ILIM_SW_MASK];
256 static int ucs1002_set_max_current(struct ucs1002_info *info, u32 val)
262 info->output_disable = true;
263 regulator_disable_regmap(info->rdev);
267 for (idx = 0; idx < ARRAY_SIZE(ucs1002_current_limit_uA); idx++) {
268 if (val == ucs1002_current_limit_uA[idx])
272 if (idx == ARRAY_SIZE(ucs1002_current_limit_uA))
275 ret = regmap_write(info->regmap, UCS1002_REG_ILIMIT, idx);
279 * Any current limit setting exceeding the one set via ILIM
280 * pin will be rejected, so we read out freshly changed limit
281 * to make sure that it took effect.
283 ret = regmap_read(info->regmap, UCS1002_REG_ILIMIT, ®);
290 info->output_disable = false;
292 if (info->rdev && info->rdev->use_count &&
293 !regulator_is_enabled_regmap(info->rdev))
294 regulator_enable_regmap(info->rdev);
299 static enum power_supply_usb_type ucs1002_usb_types[] = {
300 POWER_SUPPLY_USB_TYPE_PD,
301 POWER_SUPPLY_USB_TYPE_SDP,
302 POWER_SUPPLY_USB_TYPE_DCP,
303 POWER_SUPPLY_USB_TYPE_CDP,
304 POWER_SUPPLY_USB_TYPE_UNKNOWN,
307 static int ucs1002_set_usb_type(struct ucs1002_info *info, int val)
311 if (val < 0 || val >= ARRAY_SIZE(ucs1002_usb_types))
314 switch (ucs1002_usb_types[val]) {
315 case POWER_SUPPLY_USB_TYPE_PD:
316 mode = V_SET_ACTIVE_MODE_DEDICATED;
318 case POWER_SUPPLY_USB_TYPE_SDP:
319 mode = V_SET_ACTIVE_MODE_BC12_SDP;
321 case POWER_SUPPLY_USB_TYPE_DCP:
322 mode = V_SET_ACTIVE_MODE_BC12_DCP;
324 case POWER_SUPPLY_USB_TYPE_CDP:
325 mode = V_SET_ACTIVE_MODE_BC12_CDP;
331 return regmap_update_bits(info->regmap, UCS1002_REG_SWITCH_CFG,
332 V_SET_ACTIVE_MODE_MASK, mode);
335 static int ucs1002_get_usb_type(struct ucs1002_info *info,
336 union power_supply_propval *val)
338 enum power_supply_usb_type type;
342 ret = regmap_read(info->regmap, UCS1002_REG_PIN_STATUS, ®);
346 switch (reg & F_ACTIVE_MODE_MASK) {
348 type = POWER_SUPPLY_USB_TYPE_UNKNOWN;
350 case F_ACTIVE_MODE_DEDICATED:
351 type = POWER_SUPPLY_USB_TYPE_PD;
353 case F_ACTIVE_MODE_BC12_SDP:
354 type = POWER_SUPPLY_USB_TYPE_SDP;
356 case F_ACTIVE_MODE_BC12_DCP:
357 type = POWER_SUPPLY_USB_TYPE_DCP;
359 case F_ACTIVE_MODE_BC12_CDP:
360 type = POWER_SUPPLY_USB_TYPE_CDP;
369 static int ucs1002_get_property(struct power_supply *psy,
370 enum power_supply_property psp,
371 union power_supply_propval *val)
373 struct ucs1002_info *info = power_supply_get_drvdata(psy);
376 case POWER_SUPPLY_PROP_ONLINE:
377 return ucs1002_get_online(info, val);
378 case POWER_SUPPLY_PROP_CHARGE_NOW:
379 return ucs1002_get_charge(info, val);
380 case POWER_SUPPLY_PROP_CURRENT_NOW:
381 return ucs1002_get_current(info, val);
382 case POWER_SUPPLY_PROP_CURRENT_MAX:
383 return ucs1002_get_max_current(info, val);
384 case POWER_SUPPLY_PROP_USB_TYPE:
385 return ucs1002_get_usb_type(info, val);
386 case POWER_SUPPLY_PROP_HEALTH:
387 val->intval = info->health;
389 case POWER_SUPPLY_PROP_PRESENT:
390 val->intval = info->present;
392 case POWER_SUPPLY_PROP_MANUFACTURER:
393 val->strval = UCS1002_MANUFACTURER;
400 static int ucs1002_set_property(struct power_supply *psy,
401 enum power_supply_property psp,
402 const union power_supply_propval *val)
404 struct ucs1002_info *info = power_supply_get_drvdata(psy);
407 case POWER_SUPPLY_PROP_CURRENT_MAX:
408 return ucs1002_set_max_current(info, val->intval);
409 case POWER_SUPPLY_PROP_USB_TYPE:
410 return ucs1002_set_usb_type(info, val->intval);
416 static int ucs1002_property_is_writeable(struct power_supply *psy,
417 enum power_supply_property psp)
420 case POWER_SUPPLY_PROP_CURRENT_MAX:
421 case POWER_SUPPLY_PROP_USB_TYPE:
428 static const struct power_supply_desc ucs1002_charger_desc = {
430 .type = POWER_SUPPLY_TYPE_USB,
431 .usb_types = ucs1002_usb_types,
432 .num_usb_types = ARRAY_SIZE(ucs1002_usb_types),
433 .get_property = ucs1002_get_property,
434 .set_property = ucs1002_set_property,
435 .property_is_writeable = ucs1002_property_is_writeable,
436 .properties = ucs1002_props,
437 .num_properties = ARRAY_SIZE(ucs1002_props),
440 static void ucs1002_health_poll(struct work_struct *work)
442 struct ucs1002_info *info = container_of(work, struct ucs1002_info,
447 ret = regmap_read(info->regmap, UCS1002_REG_INTERRUPT_STATUS, ®);
451 /* bad health and no status change, just schedule us again in a while */
452 if ((reg & F_ERR) && info->health != POWER_SUPPLY_HEALTH_GOOD) {
453 schedule_delayed_work(&info->health_poll,
454 msecs_to_jiffies(2000));
459 info->health = POWER_SUPPLY_HEALTH_OVERHEAT;
460 else if (reg & (F_OVER_VOLT | F_BACK_VOLT))
461 info->health = POWER_SUPPLY_HEALTH_OVERVOLTAGE;
462 else if (reg & F_OVER_ILIM)
463 info->health = POWER_SUPPLY_HEALTH_OVERCURRENT;
464 else if (reg & (F_DISCHARGE_ERR | F_MIN_KEEP_OUT))
465 info->health = POWER_SUPPLY_HEALTH_UNSPEC_FAILURE;
467 info->health = POWER_SUPPLY_HEALTH_GOOD;
469 sysfs_notify(&info->charger->dev.kobj, NULL, "health");
472 static irqreturn_t ucs1002_charger_irq(int irq, void *data)
476 struct ucs1002_info *info = data;
478 present = info->present;
480 ret = regmap_read(info->regmap, UCS1002_REG_OTHER_STATUS, ®val);
484 /* update attached status */
485 info->present = regval & F_ADET_PIN;
487 /* notify the change */
488 if (present != info->present)
489 power_supply_changed(info->charger);
494 static irqreturn_t ucs1002_alert_irq(int irq, void *data)
496 struct ucs1002_info *info = data;
498 mod_delayed_work(system_wq, &info->health_poll, 0);
503 static int ucs1002_regulator_enable(struct regulator_dev *rdev)
505 struct ucs1002_info *info = rdev_get_drvdata(rdev);
508 * If the output is disabled due to 0 maximum current, just pretend the
509 * enable did work. The regulator will be enabled as soon as we get a
510 * a non-zero maximum current budget.
512 if (info->output_disable)
515 return regulator_enable_regmap(rdev);
518 static const struct regulator_ops ucs1002_regulator_ops = {
519 .is_enabled = regulator_is_enabled_regmap,
520 .enable = ucs1002_regulator_enable,
521 .disable = regulator_disable_regmap,
524 static const struct regulator_desc ucs1002_regulator_descriptor = {
525 .name = "ucs1002-vbus",
526 .ops = &ucs1002_regulator_ops,
527 .type = REGULATOR_VOLTAGE,
528 .owner = THIS_MODULE,
529 .enable_reg = UCS1002_REG_SWITCH_CFG,
530 .enable_mask = F_PWR_EN_SET,
531 .enable_val = F_PWR_EN_SET,
536 static int ucs1002_probe(struct i2c_client *client)
538 struct device *dev = &client->dev;
539 struct power_supply_config charger_config = {};
540 const struct regmap_config regmap_config = {
544 struct regulator_config regulator_config = {};
545 int irq_a_det, irq_alert, ret;
546 struct ucs1002_info *info;
549 info = devm_kzalloc(dev, sizeof(*info), GFP_KERNEL);
553 info->regmap = devm_regmap_init_i2c(client, ®map_config);
554 ret = PTR_ERR_OR_ZERO(info->regmap);
556 dev_err(dev, "Regmap initialization failed: %d\n", ret);
560 info->client = client;
562 irq_a_det = of_irq_get_byname(dev->of_node, "a_det");
563 irq_alert = of_irq_get_byname(dev->of_node, "alert");
565 charger_config.of_node = dev->of_node;
566 charger_config.drv_data = info;
568 ret = regmap_read(info->regmap, UCS1002_REG_PRODUCT_ID, ®val);
570 dev_err(dev, "Failed to read product ID: %d\n", ret);
574 if (regval != UCS1002_PRODUCT_ID) {
576 "Product ID does not match (0x%02x != 0x%02x)\n",
577 regval, UCS1002_PRODUCT_ID);
581 /* Enable charge rationing by default */
582 ret = regmap_update_bits(info->regmap, UCS1002_REG_GENERAL_CFG,
583 F_RATION_EN, F_RATION_EN);
585 dev_err(dev, "Failed to read general config: %d\n", ret);
590 * Ignore the M1, M2, PWR_EN, and EM_EN pin states. Set active
591 * mode selection to BC1.2 CDP.
593 ret = regmap_update_bits(info->regmap, UCS1002_REG_SWITCH_CFG,
594 V_SET_ACTIVE_MODE_MASK | F_PIN_IGNORE,
595 V_SET_ACTIVE_MODE_BC12_CDP | F_PIN_IGNORE);
597 dev_err(dev, "Failed to configure default mode: %d\n", ret);
601 * Be safe and set initial current limit to 500mA
603 ret = ucs1002_set_max_current(info, 500000);
605 dev_err(dev, "Failed to set max current default: %d\n", ret);
609 info->charger = devm_power_supply_register(dev, &ucs1002_charger_desc,
611 ret = PTR_ERR_OR_ZERO(info->charger);
613 dev_err(dev, "Failed to register power supply: %d\n", ret);
617 ret = regmap_read(info->regmap, UCS1002_REG_PIN_STATUS, ®val);
619 dev_err(dev, "Failed to read pin status: %d\n", ret);
623 info->regulator_descriptor =
624 devm_kmemdup(dev, &ucs1002_regulator_descriptor,
625 sizeof(ucs1002_regulator_descriptor),
627 if (!info->regulator_descriptor)
630 info->regulator_descriptor->enable_is_inverted = !(regval & F_SEL_PIN);
632 regulator_config.dev = dev;
633 regulator_config.of_node = dev->of_node;
634 regulator_config.regmap = info->regmap;
635 regulator_config.driver_data = info;
637 info->rdev = devm_regulator_register(dev, info->regulator_descriptor,
639 ret = PTR_ERR_OR_ZERO(info->rdev);
641 dev_err(dev, "Failed to register VBUS regulator: %d\n", ret);
645 info->health = POWER_SUPPLY_HEALTH_GOOD;
646 INIT_DELAYED_WORK(&info->health_poll, ucs1002_health_poll);
649 ret = devm_request_threaded_irq(dev, irq_a_det, NULL,
652 "ucs1002-a_det", info);
654 dev_err(dev, "Failed to request A_DET threaded irq: %d\n",
661 ret = devm_request_irq(dev, irq_alert, ucs1002_alert_irq,
662 0,"ucs1002-alert", info);
664 dev_err(dev, "Failed to request ALERT threaded irq: %d\n",
673 static const struct of_device_id ucs1002_of_match[] = {
674 { .compatible = "microchip,ucs1002", },
677 MODULE_DEVICE_TABLE(of, ucs1002_of_match);
679 static struct i2c_driver ucs1002_driver = {
682 .of_match_table = ucs1002_of_match,
684 .probe = ucs1002_probe,
686 module_i2c_driver(ucs1002_driver);
688 MODULE_DESCRIPTION("Microchip UCS1002 Programmable USB Port Power Controller");
689 MODULE_AUTHOR("Enric Balletbo Serra <enric.balletbo@collabora.com>");
690 MODULE_AUTHOR("Andrey Smirnov <andrew.smirnov@gmail.com>");
691 MODULE_LICENSE("GPL");