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
41 # define F_DISCHARGE_ERR BIT(6)
42 # define F_RESET BIT(5)
43 # define F_MIN_KEEP_OUT BIT(4)
45 # define F_OVER_VOLT BIT(2)
46 # define F_BACK_VOLT BIT(1)
47 # define F_OVER_ILIM BIT(0)
49 /* Pin Status Register */
50 #define UCS1002_REG_PIN_STATUS 0x14
51 # define UCS1002_PWR_STATE_MASK 0x03
52 # define F_PWR_EN_PIN BIT(6)
53 # define F_M2_PIN BIT(5)
54 # define F_M1_PIN BIT(4)
55 # define F_EM_EN_PIN BIT(3)
56 # define F_SEL_PIN BIT(2)
57 # define F_ACTIVE_MODE_MASK GENMASK(5, 3)
58 # define F_ACTIVE_MODE_PASSTHROUGH F_M2_PIN
59 # define F_ACTIVE_MODE_DEDICATED F_EM_EN_PIN
60 # define F_ACTIVE_MODE_BC12_DCP (F_M2_PIN | F_EM_EN_PIN)
61 # define F_ACTIVE_MODE_BC12_SDP F_M1_PIN
62 # define F_ACTIVE_MODE_BC12_CDP (F_M1_PIN | F_M2_PIN | F_EM_EN_PIN)
64 /* General Configuration Register */
65 #define UCS1002_REG_GENERAL_CFG 0x15
66 # define F_RATION_EN BIT(3)
68 /* Emulation Configuration Register */
69 #define UCS1002_REG_EMU_CFG 0x16
71 /* Switch Configuration Register */
72 #define UCS1002_REG_SWITCH_CFG 0x17
73 # define F_PIN_IGNORE BIT(7)
74 # define F_EM_EN_SET BIT(5)
75 # define F_M2_SET BIT(4)
76 # define F_M1_SET BIT(3)
77 # define F_S0_SET BIT(2)
78 # define F_PWR_EN_SET BIT(1)
79 # define F_LATCH_SET BIT(0)
80 # define V_SET_ACTIVE_MODE_MASK GENMASK(5, 3)
81 # define V_SET_ACTIVE_MODE_PASSTHROUGH F_M2_SET
82 # define V_SET_ACTIVE_MODE_DEDICATED F_EM_EN_SET
83 # define V_SET_ACTIVE_MODE_BC12_DCP (F_M2_SET | F_EM_EN_SET)
84 # define V_SET_ACTIVE_MODE_BC12_SDP F_M1_SET
85 # define V_SET_ACTIVE_MODE_BC12_CDP (F_M1_SET | F_M2_SET | F_EM_EN_SET)
87 /* Current Limit Register */
88 #define UCS1002_REG_ILIMIT 0x19
89 # define UCS1002_ILIM_SW_MASK GENMASK(3, 0)
92 #define UCS1002_REG_PRODUCT_ID 0xfd
93 # define UCS1002_PRODUCT_ID 0x4e
95 /* Manufacture name */
96 #define UCS1002_MANUFACTURER "SMSC"
99 struct power_supply
*charger
;
100 struct i2c_client
*client
;
101 struct regmap
*regmap
;
102 struct regulator_desc
*regulator_descriptor
;
106 static enum power_supply_property ucs1002_props
[] = {
107 POWER_SUPPLY_PROP_ONLINE
,
108 POWER_SUPPLY_PROP_CHARGE_NOW
,
109 POWER_SUPPLY_PROP_CURRENT_NOW
,
110 POWER_SUPPLY_PROP_CURRENT_MAX
,
111 POWER_SUPPLY_PROP_PRESENT
, /* the presence of PED */
112 POWER_SUPPLY_PROP_MANUFACTURER
,
113 POWER_SUPPLY_PROP_USB_TYPE
,
114 POWER_SUPPLY_PROP_HEALTH
,
117 static int ucs1002_get_online(struct ucs1002_info
*info
,
118 union power_supply_propval
*val
)
123 ret
= regmap_read(info
->regmap
, UCS1002_REG_OTHER_STATUS
, ®
);
127 val
->intval
= !!(reg
& F_CHG_ACT
);
132 static int ucs1002_get_charge(struct ucs1002_info
*info
,
133 union power_supply_propval
*val
)
136 * To fit within 32 bits some values are rounded (uA/h)
138 * For Total Accumulated Charge Middle Low Byte register, addr
141 * B0: 0.01084 mA/h rounded to 11 uA/h
142 * B1: 0.02169 mA/h rounded to 22 uA/h
143 * B2: 0.04340 mA/h rounded to 43 uA/h
144 * B3: 0.08676 mA/h rounded to 87 uA/h
145 * B4: 0.17350 mA/h rounded to 173 uÁ/h
147 * For Total Accumulated Charge Low Byte register, addr 04h,
150 * B6: 0.00271 mA/h rounded to 3 uA/h
151 * B7: 0.005422 mA/h rounded to 5 uA/h
153 static const int bit_weights_uAh
[BITS_PER_TYPE(u32
)] = {
155 * Bit corresponding to low byte (offset 0x04)
156 * B0 B1 B2 B3 B4 B5 B6 B7
158 0, 0, 0, 0, 0, 0, 3, 5,
160 * Bit corresponding to middle low byte (offset 0x03)
161 * B0 B1 B2 B3 B4 B5 B6 B7
163 11, 22, 43, 87, 173, 347, 694, 1388,
165 * Bit corresponding to middle high byte (offset 0x02)
166 * B0 B1 B2 B3 B4 B5 B6 B7
168 2776, 5552, 11105, 22210, 44420, 88840, 177700, 355400,
170 * Bit corresponding to high byte (offset 0x01)
171 * B0 B1 B2 B3 B4 B5 B6 B7
173 710700, 1421000, 2843000, 5685000, 11371000, 22742000,
176 unsigned long total_acc_charger
;
180 ret
= regmap_bulk_read(info
->regmap
, UCS1002_REG_TOTAL_ACC_CHARGE
,
185 total_acc_charger
= be32_to_cpu(reg
); /* BE as per offsets above */
188 for_each_set_bit(i
, &total_acc_charger
, ARRAY_SIZE(bit_weights_uAh
))
189 val
->intval
+= bit_weights_uAh
[i
];
194 static int ucs1002_get_current(struct ucs1002_info
*info
,
195 union power_supply_propval
*val
)
198 * The Current Measurement register stores the measured
199 * current value delivered to the portable device. The range
200 * is from 9.76 mA to 2.5 A.
202 static const int bit_weights_uA
[BITS_PER_TYPE(u8
)] = {
203 9760, 19500, 39000, 78100, 156200, 312300, 624600, 1249300,
205 unsigned long current_measurement
;
209 ret
= regmap_read(info
->regmap
, UCS1002_REG_CURRENT_MEASUREMENT
, ®
);
213 current_measurement
= reg
;
216 for_each_set_bit(i
, ¤t_measurement
, ARRAY_SIZE(bit_weights_uA
))
217 val
->intval
+= bit_weights_uA
[i
];
223 * The Current Limit register stores the maximum current used by the
224 * port switch. The range is from 500mA to 2.5 A.
226 static const u32 ucs1002_current_limit_uA
[] = {
227 500000, 900000, 1000000, 1200000, 1500000, 1800000, 2000000, 2500000,
230 static int ucs1002_get_max_current(struct ucs1002_info
*info
,
231 union power_supply_propval
*val
)
236 ret
= regmap_read(info
->regmap
, UCS1002_REG_ILIMIT
, ®
);
240 val
->intval
= ucs1002_current_limit_uA
[reg
& UCS1002_ILIM_SW_MASK
];
245 static int ucs1002_set_max_current(struct ucs1002_info
*info
, u32 val
)
250 for (idx
= 0; idx
< ARRAY_SIZE(ucs1002_current_limit_uA
); idx
++) {
251 if (val
== ucs1002_current_limit_uA
[idx
])
255 if (idx
== ARRAY_SIZE(ucs1002_current_limit_uA
))
258 ret
= regmap_write(info
->regmap
, UCS1002_REG_ILIMIT
, idx
);
262 * Any current limit setting exceeding the one set via ILIM
263 * pin will be rejected, so we read out freshly changed limit
264 * to make sure that it took effect.
266 ret
= regmap_read(info
->regmap
, UCS1002_REG_ILIMIT
, ®
);
276 static enum power_supply_usb_type ucs1002_usb_types
[] = {
277 POWER_SUPPLY_USB_TYPE_PD
,
278 POWER_SUPPLY_USB_TYPE_SDP
,
279 POWER_SUPPLY_USB_TYPE_DCP
,
280 POWER_SUPPLY_USB_TYPE_CDP
,
281 POWER_SUPPLY_USB_TYPE_UNKNOWN
,
284 static int ucs1002_set_usb_type(struct ucs1002_info
*info
, int val
)
288 if (val
< 0 || val
>= ARRAY_SIZE(ucs1002_usb_types
))
291 switch (ucs1002_usb_types
[val
]) {
292 case POWER_SUPPLY_USB_TYPE_PD
:
293 mode
= V_SET_ACTIVE_MODE_DEDICATED
;
295 case POWER_SUPPLY_USB_TYPE_SDP
:
296 mode
= V_SET_ACTIVE_MODE_BC12_SDP
;
298 case POWER_SUPPLY_USB_TYPE_DCP
:
299 mode
= V_SET_ACTIVE_MODE_BC12_DCP
;
301 case POWER_SUPPLY_USB_TYPE_CDP
:
302 mode
= V_SET_ACTIVE_MODE_BC12_CDP
;
308 return regmap_update_bits(info
->regmap
, UCS1002_REG_SWITCH_CFG
,
309 V_SET_ACTIVE_MODE_MASK
, mode
);
312 static int ucs1002_get_usb_type(struct ucs1002_info
*info
,
313 union power_supply_propval
*val
)
315 enum power_supply_usb_type type
;
319 ret
= regmap_read(info
->regmap
, UCS1002_REG_PIN_STATUS
, ®
);
323 switch (reg
& F_ACTIVE_MODE_MASK
) {
325 type
= POWER_SUPPLY_USB_TYPE_UNKNOWN
;
327 case F_ACTIVE_MODE_DEDICATED
:
328 type
= POWER_SUPPLY_USB_TYPE_PD
;
330 case F_ACTIVE_MODE_BC12_SDP
:
331 type
= POWER_SUPPLY_USB_TYPE_SDP
;
333 case F_ACTIVE_MODE_BC12_DCP
:
334 type
= POWER_SUPPLY_USB_TYPE_DCP
;
336 case F_ACTIVE_MODE_BC12_CDP
:
337 type
= POWER_SUPPLY_USB_TYPE_CDP
;
346 static int ucs1002_get_health(struct ucs1002_info
*info
,
347 union power_supply_propval
*val
)
352 ret
= regmap_read(info
->regmap
, UCS1002_REG_INTERRUPT_STATUS
, ®
);
357 health
= POWER_SUPPLY_HEALTH_OVERHEAT
;
358 else if (reg
& (F_OVER_VOLT
| F_BACK_VOLT
))
359 health
= POWER_SUPPLY_HEALTH_OVERVOLTAGE
;
360 else if (reg
& F_OVER_ILIM
)
361 health
= POWER_SUPPLY_HEALTH_OVERCURRENT
;
362 else if (reg
& (F_DISCHARGE_ERR
| F_MIN_KEEP_OUT
))
363 health
= POWER_SUPPLY_HEALTH_UNSPEC_FAILURE
;
365 health
= POWER_SUPPLY_HEALTH_GOOD
;
367 val
->intval
= health
;
372 static int ucs1002_get_property(struct power_supply
*psy
,
373 enum power_supply_property psp
,
374 union power_supply_propval
*val
)
376 struct ucs1002_info
*info
= power_supply_get_drvdata(psy
);
379 case POWER_SUPPLY_PROP_ONLINE
:
380 return ucs1002_get_online(info
, val
);
381 case POWER_SUPPLY_PROP_CHARGE_NOW
:
382 return ucs1002_get_charge(info
, val
);
383 case POWER_SUPPLY_PROP_CURRENT_NOW
:
384 return ucs1002_get_current(info
, val
);
385 case POWER_SUPPLY_PROP_CURRENT_MAX
:
386 return ucs1002_get_max_current(info
, val
);
387 case POWER_SUPPLY_PROP_USB_TYPE
:
388 return ucs1002_get_usb_type(info
, val
);
389 case POWER_SUPPLY_PROP_HEALTH
:
390 return ucs1002_get_health(info
, val
);
391 case POWER_SUPPLY_PROP_PRESENT
:
392 val
->intval
= info
->present
;
394 case POWER_SUPPLY_PROP_MANUFACTURER
:
395 val
->strval
= UCS1002_MANUFACTURER
;
402 static int ucs1002_set_property(struct power_supply
*psy
,
403 enum power_supply_property psp
,
404 const union power_supply_propval
*val
)
406 struct ucs1002_info
*info
= power_supply_get_drvdata(psy
);
409 case POWER_SUPPLY_PROP_CURRENT_MAX
:
410 return ucs1002_set_max_current(info
, val
->intval
);
411 case POWER_SUPPLY_PROP_USB_TYPE
:
412 return ucs1002_set_usb_type(info
, val
->intval
);
418 static int ucs1002_property_is_writeable(struct power_supply
*psy
,
419 enum power_supply_property psp
)
422 case POWER_SUPPLY_PROP_CURRENT_MAX
:
423 case POWER_SUPPLY_PROP_USB_TYPE
:
430 static const struct power_supply_desc ucs1002_charger_desc
= {
432 .type
= POWER_SUPPLY_TYPE_USB
,
433 .usb_types
= ucs1002_usb_types
,
434 .num_usb_types
= ARRAY_SIZE(ucs1002_usb_types
),
435 .get_property
= ucs1002_get_property
,
436 .set_property
= ucs1002_set_property
,
437 .property_is_writeable
= ucs1002_property_is_writeable
,
438 .properties
= ucs1002_props
,
439 .num_properties
= ARRAY_SIZE(ucs1002_props
),
442 static irqreturn_t
ucs1002_charger_irq(int irq
, void *data
)
446 struct ucs1002_info
*info
= data
;
448 present
= info
->present
;
450 ret
= regmap_read(info
->regmap
, UCS1002_REG_OTHER_STATUS
, ®val
);
454 /* update attached status */
455 info
->present
= regval
& F_ADET_PIN
;
457 /* notify the change */
458 if (present
!= info
->present
)
459 power_supply_changed(info
->charger
);
464 static irqreturn_t
ucs1002_alert_irq(int irq
, void *data
)
466 struct ucs1002_info
*info
= data
;
468 power_supply_changed(info
->charger
);
473 static const struct regulator_ops ucs1002_regulator_ops
= {
474 .is_enabled
= regulator_is_enabled_regmap
,
475 .enable
= regulator_enable_regmap
,
476 .disable
= regulator_disable_regmap
,
479 static const struct regulator_desc ucs1002_regulator_descriptor
= {
480 .name
= "ucs1002-vbus",
481 .ops
= &ucs1002_regulator_ops
,
482 .type
= REGULATOR_VOLTAGE
,
483 .owner
= THIS_MODULE
,
484 .enable_reg
= UCS1002_REG_SWITCH_CFG
,
485 .enable_mask
= F_PWR_EN_SET
,
486 .enable_val
= F_PWR_EN_SET
,
491 static int ucs1002_probe(struct i2c_client
*client
,
492 const struct i2c_device_id
*dev_id
)
494 struct device
*dev
= &client
->dev
;
495 struct power_supply_config charger_config
= {};
496 const struct regmap_config regmap_config
= {
500 struct regulator_config regulator_config
= {};
501 int irq_a_det
, irq_alert
, ret
;
502 struct regulator_dev
*rdev
;
503 struct ucs1002_info
*info
;
506 info
= devm_kzalloc(dev
, sizeof(*info
), GFP_KERNEL
);
510 info
->regmap
= devm_regmap_init_i2c(client
, ®map_config
);
511 ret
= PTR_ERR_OR_ZERO(info
->regmap
);
513 dev_err(dev
, "Regmap initialization failed: %d\n", ret
);
517 info
->client
= client
;
519 irq_a_det
= of_irq_get_byname(dev
->of_node
, "a_det");
520 irq_alert
= of_irq_get_byname(dev
->of_node
, "alert");
522 charger_config
.of_node
= dev
->of_node
;
523 charger_config
.drv_data
= info
;
525 ret
= regmap_read(info
->regmap
, UCS1002_REG_PRODUCT_ID
, ®val
);
527 dev_err(dev
, "Failed to read product ID: %d\n", ret
);
531 if (regval
!= UCS1002_PRODUCT_ID
) {
533 "Product ID does not match (0x%02x != 0x%02x)\n",
534 regval
, UCS1002_PRODUCT_ID
);
538 /* Enable charge rationing by default */
539 ret
= regmap_update_bits(info
->regmap
, UCS1002_REG_GENERAL_CFG
,
540 F_RATION_EN
, F_RATION_EN
);
542 dev_err(dev
, "Failed to read general config: %d\n", ret
);
547 * Ignore the M1, M2, PWR_EN, and EM_EN pin states. Set active
548 * mode selection to BC1.2 CDP.
550 ret
= regmap_update_bits(info
->regmap
, UCS1002_REG_SWITCH_CFG
,
551 V_SET_ACTIVE_MODE_MASK
| F_PIN_IGNORE
,
552 V_SET_ACTIVE_MODE_BC12_CDP
| F_PIN_IGNORE
);
554 dev_err(dev
, "Failed to configure default mode: %d\n", ret
);
558 * Be safe and set initial current limit to 500mA
560 ret
= ucs1002_set_max_current(info
, 500000);
562 dev_err(dev
, "Failed to set max current default: %d\n", ret
);
566 info
->charger
= devm_power_supply_register(dev
, &ucs1002_charger_desc
,
568 ret
= PTR_ERR_OR_ZERO(info
->charger
);
570 dev_err(dev
, "Failed to register power supply: %d\n", ret
);
574 ret
= regmap_read(info
->regmap
, UCS1002_REG_PIN_STATUS
, ®val
);
576 dev_err(dev
, "Failed to read pin status: %d\n", ret
);
580 info
->regulator_descriptor
=
581 devm_kmemdup(dev
, &ucs1002_regulator_descriptor
,
582 sizeof(ucs1002_regulator_descriptor
),
584 if (!info
->regulator_descriptor
)
587 info
->regulator_descriptor
->enable_is_inverted
= !(regval
& F_SEL_PIN
);
589 regulator_config
.dev
= dev
;
590 regulator_config
.of_node
= dev
->of_node
;
591 regulator_config
.regmap
= info
->regmap
;
593 rdev
= devm_regulator_register(dev
, info
->regulator_descriptor
,
595 ret
= PTR_ERR_OR_ZERO(rdev
);
597 dev_err(dev
, "Failed to register VBUS regulator: %d\n", ret
);
602 ret
= devm_request_threaded_irq(dev
, irq_a_det
, NULL
,
605 "ucs1002-a_det", info
);
607 dev_err(dev
, "Failed to request A_DET threaded irq: %d\n",
614 ret
= devm_request_threaded_irq(dev
, irq_alert
, NULL
,
617 "ucs1002-alert", info
);
619 dev_err(dev
, "Failed to request ALERT threaded irq: %d\n",
628 static const struct of_device_id ucs1002_of_match
[] = {
629 { .compatible
= "microchip,ucs1002", },
632 MODULE_DEVICE_TABLE(of
, ucs1002_of_match
);
634 static struct i2c_driver ucs1002_driver
= {
637 .of_match_table
= ucs1002_of_match
,
639 .probe
= ucs1002_probe
,
641 module_i2c_driver(ucs1002_driver
);
643 MODULE_DESCRIPTION("Microchip UCS1002 Programmable USB Port Power Controller");
644 MODULE_AUTHOR("Enric Balletbo Serra <enric.balletbo@collabora.com>");
645 MODULE_AUTHOR("Andrey Smirnov <andrew.smirnov@gmail.com>");
646 MODULE_LICENSE("GPL");