Add Richtek RT9471 3A battery charger support

From: ChiYuan Huang <[email protected]>

Add support for the RT9471 3A 1-Cell Li+ battery charger.

The RT9471 is a highly-integrated 3A switch mode battery charger with low impedance power path to better optimize the charging efficiency.

Co-developed-by Alina Yu <[email protected]>

Signed-off-by Alina Yu <[email protected]>

Signed-off-by ChiYuan Huang <[email protected]>

---
Since v4:
- Remove the line for the owner field in driver.

Since v2:
- Fix checkpatch error about 'foo * bar' to 'foo *bar' in psy_device_to_chip function.
- Specify the member name directly for the use of linear range.

---

 drivers/power/supply/Kconfig  |  16 +
 drivers/power/supply/Makefile |   1 +
 drivers/power/supply/rt9471.c | 952 ++++++++++++++++++++++++++++++++++++++++++
 drivers/power/supply/rt9471.h |  76 ++++
 4 files changed, 1045 insertions(+)
 create mode 100644 drivers/power/supply/rt9471.c
 create mode 100644 drivers/power/supply/rt9471.h

[...]

drivers/power/supply/rt9471.c new file +71 -0

+static inline int rt9471_set_hiz(struct rt9471_chip *chip, int enable)
+{
+	return regmap_field_write(chip->rm_fields[F_HZ], enable);
+}
+
+static inline int rt9471_set_ichg(struct rt9471_chip *chip, int microamp)
+{
+	return rt9471_set_value_by_field_range(chip, F_ICHG_REG,
+					       RT9471_RANGE_ICHG, microamp);
+}
+
+static inline int rt9471_get_ichg(struct rt9471_chip *chip, int *microamp)
+{
+	return rt9471_get_value_by_field_range(chip, F_ICHG_REG,
+					       RT9471_RANGE_ICHG, microamp);
+}
+
+static inline int rt9471_set_cv(struct rt9471_chip *chip, int microvolt)
+{
+	return rt9471_set_value_by_field_range(chip, F_VBAT_REG,
+					       RT9471_RANGE_VCHG, microvolt);
+}
+
+static inline int rt9471_get_cv(struct rt9471_chip *chip, int *microamp)
+{
+	return rt9471_get_value_by_field_range(chip, F_VBAT_REG,
+					       RT9471_RANGE_VCHG, microamp);
+}
+
+static inline int rt9471_set_mivr(struct rt9471_chip *chip, int microvolt)
+{
+	return rt9471_set_value_by_field_range(chip, F_MIVR,
+					       RT9471_RANGE_MIVR, microvolt);
+}
+
+static inline int rt9471_get_mivr(struct rt9471_chip *chip, int *microvolt)
+{
+	return rt9471_get_value_by_field_range(chip, F_MIVR,
+					       RT9471_RANGE_MIVR, microvolt);
+}
+
+static inline int rt9471_set_aicr(struct rt9471_chip *chip, int microamp)
+{
+	return rt9471_set_value_by_field_range(chip, F_AICR, RT9471_RANGE_AICR,
+					       microamp);
+}
+
+static inline int rt9471_get_aicr(struct rt9471_chip *chip, int *microamp)
+{
+	return rt9471_get_value_by_field_range(chip, F_AICR, RT9471_RANGE_AICR,
+					       microamp);
+}
+
+static inline int rt9471_set_iprechg(struct rt9471_chip *chip, int microamp)
+{
+	return rt9471_set_value_by_field_range(chip, F_IPRE_CHG,
+					       RT9471_RANGE_IPRE, microamp);
+}
+
+static inline int rt9471_get_iprechg(struct rt9471_chip *chip, int *microamp)
+{
+	return rt9471_get_value_by_field_range(chip, F_IPRE_CHG,
+					       RT9471_RANGE_IPRE, microamp);
+}
+
+static inline int rt9471_set_ieoc(struct rt9471_chip *chip, int microamp)
+{
+	return rt9471_set_value_by_field_range(chip, F_IEOC_CHG,
+					       RT9471_RANGE_IEOC, microamp);
+}
+

[...]

drivers/power/supply/rt9471.h new file +66 -0

new file mode 100644
index 00000000..f3d8e23
@@ -0,0 +1,76 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+/* Copyright (C) 2022 Richtek Technology Corp. */
+
+#ifndef __RT9471_CHARGER_H
+#define __RT9471_CHARGER_H
+
+#define RT9471_IRQ_BC12_DONE	0
+#define RT9471_IRQ_DETACH	1
+#define RT9471_IRQ_RECHG	2
+#define RT9471_IRQ_CHG_DONE	3
+#define RT9471_IRQ_BG_CHG	4
+#define RT9471_IRQ_IE0C		5
+#define RT9471_IRQ_CHG_RDY	6
+#define RT9471_IRQ_VBUS_GD	7
+#define RT9471_IRQ_CHG_BATOV	9
+#define RT9471_IRQ_CHG_SYSOV	10
+#define RT9471_IRQ_CHG_TOUT	11
+#define RT9471_IRQ_CHG_BUSUV	12
+#define RT9471_IRQ_CHG_THREG	13
+#define RT9471_IRQ_CHG_AICR	14
+#define RT9471_IRQ_CHG_MIVR	15
+#define RT9471_IRQ_SYS_SHORT	16
+#define RT9471_IRQ_SYS_MIN	17
+#define RT9471_IRQ_AICC_DONE	18
+#define RT9471_IRQ_PE_DONE	19
+#define RT9471_IRQ_JEITA_COLD	20
+#define RT9471_IRQ_JEITA_COOL	21
+#define RT9471_IRQ_JEITA_WARM	22
+#define RT9471_IRQ_JEITA_HOT	23
+#define RT9471_IRQ_OTG_FAULT	24
+#define RT9471_IRQ_OTG_LBP	25
+#define RT9471_IRQ_OTG_CC	26
+#define RT9471_IRQ_WDT		29
+#define RT9471_IRQ_VAC_OV	30
+#define RT9471_IRQ_OTP		31
+
+#define RT9471_REG_OTGCFG	0x00
+#define RT9471_REG_TOP		0x01
+#define RT9471_REG_FUNC		0x02
+#define RT9471_REG_IBUS		0x03
+#define RT9471_REG_VBUS		0x04
+#define RT9471_REG_PRECHG	0x05
+#define RT9471_REG_VCHG		0x07
+#define RT9471_REG_ICHG		0x08
+#define RT9471_REG_CHGTMR	0x09
+#define RT9471_REG_EOC		0x0A
+#define RT9471_REG_INFO		0x0B
+#define RT9471_REG_JEITA	0x0C
+#define RT9471_REG_PUMP_EXP	0x0D
+#define	RT9471_REG_DPDMDET	0x0E
+#define RT9471_REG_ICSTAT	0x0F
+#define	RT9471_REG_STAT0	0x10
+#define RT9471_REG_STAT1	0x11
+#define RT9471_REG_STAT2	0x12
+#define RT9471_REG_IRQ0		0x20
+#define RT9471_REG_MASK0	0x30
+
+#define RT9471_OTGCV_MASK	GENMASK(7, 6)
+#define RT9471_OTGCC_MASK	BIT(0)
+#define RT9471_OTGEN_MASK	BIT(1)
+#define RT9471_CHGFAULT_MASK	GENMASK(4, 1)
+
+/* Device ID */
+#define RT9470_DEVID		0x09
+#define RT9470D_DEVID		0x0A
+#define RT9471_DEVID		0x0D

Signature · 1 line

2.7.4

Hi,

Quoted 14 lines · cy_huang

From: ChiYuan Huang <[email protected]>

Add support for the RT9471 3A 1-Cell Li+ battery charger.

The RT9471 is a highly-integrated 3A switch mode battery charger with low impedance power path to better optimize the charging efficiency.

Co-developed-by Alina Yu <[email protected]>

Signed-off-by Alina Yu <[email protected]>

Signed-off-by ChiYuan Huang <[email protected]>

---
Since v4:
- Remove the line for the owner field in driver.

Quoted 5 lines

Since v2:
- Fix checkpatch error about 'foo * bar' to 'foo *bar' in psy_device_to_chip function.
- Specify the member name directly for the use of linear range.

---

Thanks, driver looks mostly good.

Quoted 84 lines

 drivers/power/supply/Kconfig  |  16 +
 drivers/power/supply/Makefile |   1 +
 drivers/power/supply/rt9471.c | 952 ++++++++++++++++++++++++++++++++++++++++++
 drivers/power/supply/rt9471.h |  76 ++++
 4 files changed, 1045 insertions(+)
 create mode 100644 drivers/power/supply/rt9471.c
 create mode 100644 drivers/power/supply/rt9471.h

[...]

drivers/power/supply/rt9471.c new file +75 -0

+static inline int rt9471_set_hiz(struct rt9471_chip *chip, int enable)
+{
+     return regmap_field_write(chip->rm_fields[F_HZ], enable);
+}
+
+static inline int rt9471_set_ichg(struct rt9471_chip *chip, int microamp)
+{
+     return rt9471_set_value_by_field_range(chip, F_ICHG_REG,
+                                            RT9471_RANGE_ICHG, microamp);
+}
+
+static inline int rt9471_get_ichg(struct rt9471_chip *chip, int *microamp)
+{
+     return rt9471_get_value_by_field_range(chip, F_ICHG_REG,
+                                            RT9471_RANGE_ICHG, microamp);
+}
+
+static inline int rt9471_set_cv(struct rt9471_chip *chip, int microvolt)
+{
+     return rt9471_set_value_by_field_range(chip, F_VBAT_REG,
+                                            RT9471_RANGE_VCHG, microvolt);
+}
+
+static inline int rt9471_get_cv(struct rt9471_chip *chip, int *microamp)
+{
+     return rt9471_get_value_by_field_range(chip, F_VBAT_REG,
+                                            RT9471_RANGE_VCHG, microamp);
+}
+
+static inline int rt9471_set_mivr(struct rt9471_chip *chip, int microvolt)
+{
+     return rt9471_set_value_by_field_range(chip, F_MIVR,
+                                            RT9471_RANGE_MIVR, microvolt);
+}
+
+static inline int rt9471_get_mivr(struct rt9471_chip *chip, int *microvolt)
+{
+     return rt9471_get_value_by_field_range(chip, F_MIVR,
+                                            RT9471_RANGE_MIVR, microvolt);
+}
+
+static inline int rt9471_set_aicr(struct rt9471_chip *chip, int microamp)
+{
+     return rt9471_set_value_by_field_range(chip, F_AICR, RT9471_RANGE_AICR,
+                                            microamp);
+}
+
+static inline int rt9471_get_aicr(struct rt9471_chip *chip, int *microamp)
+{
+     return rt9471_get_value_by_field_range(chip, F_AICR, RT9471_RANGE_AICR,
+                                            microamp);
+}
+
+static inline int rt9471_set_iprechg(struct rt9471_chip *chip, int microamp)
+{
+     return rt9471_set_value_by_field_range(chip, F_IPRE_CHG,
+                                            RT9471_RANGE_IPRE, microamp);
+}
+
+static inline int rt9471_get_iprechg(struct rt9471_chip *chip, int *microamp)
+{
+     return rt9471_get_value_by_field_range(chip, F_IPRE_CHG,
+                                            RT9471_RANGE_IPRE, microamp);
+}
+
+static inline int rt9471_set_ieoc(struct rt9471_chip *chip, int microamp)
+{
+     return rt9471_set_value_by_field_range(chip, F_IEOC_CHG,
+                                            RT9471_RANGE_IEOC, microamp);
+}
+
+static inline int rt9471_get_ieoc(struct rt9471_chip *chip, int *microamp)
+{
+     return rt9471_get_value_by_field_range(chip, F_IEOC_CHG,
+                                            RT9471_RANGE_IEOC, microamp);

drivers/power/supply/rt9471.c line 236

Quoted 6 lines

drivers/power/supply/rt9471.c new file +6 -0

+}
+
+static inline int rt9471_set_chg_enable(struct rt9471_chip *chip, int enable)
+{
+     return regmap_field_write(chip->rm_fields[F_CHG_EN], !!enable);
+}

Please drop these one line wrappers.

Quoted 74 lines

[...]

drivers/power/supply/rt9471.h new file +66 -0

new file mode 100644
index 00000000..f3d8e23
@@ -0,0 +1,76 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+/* Copyright (C) 2022 Richtek Technology Corp. */
+
+#ifndef __RT9471_CHARGER_H
+#define __RT9471_CHARGER_H
+
+#define RT9471_IRQ_BC12_DONE 0
+#define RT9471_IRQ_DETACH    1
+#define RT9471_IRQ_RECHG     2
+#define RT9471_IRQ_CHG_DONE  3
+#define RT9471_IRQ_BG_CHG    4
+#define RT9471_IRQ_IE0C              5
+#define RT9471_IRQ_CHG_RDY   6
+#define RT9471_IRQ_VBUS_GD   7
+#define RT9471_IRQ_CHG_BATOV 9
+#define RT9471_IRQ_CHG_SYSOV 10
+#define RT9471_IRQ_CHG_TOUT  11
+#define RT9471_IRQ_CHG_BUSUV 12
+#define RT9471_IRQ_CHG_THREG 13
+#define RT9471_IRQ_CHG_AICR  14
+#define RT9471_IRQ_CHG_MIVR  15
+#define RT9471_IRQ_SYS_SHORT 16
+#define RT9471_IRQ_SYS_MIN   17
+#define RT9471_IRQ_AICC_DONE 18
+#define RT9471_IRQ_PE_DONE   19
+#define RT9471_IRQ_JEITA_COLD        20
+#define RT9471_IRQ_JEITA_COOL        21
+#define RT9471_IRQ_JEITA_WARM        22
+#define RT9471_IRQ_JEITA_HOT 23
+#define RT9471_IRQ_OTG_FAULT 24
+#define RT9471_IRQ_OTG_LBP   25
+#define RT9471_IRQ_OTG_CC    26
+#define RT9471_IRQ_WDT               29
+#define RT9471_IRQ_VAC_OV    30
+#define RT9471_IRQ_OTP               31
+
+#define RT9471_REG_OTGCFG    0x00
+#define RT9471_REG_TOP               0x01
+#define RT9471_REG_FUNC              0x02
+#define RT9471_REG_IBUS              0x03
+#define RT9471_REG_VBUS              0x04
+#define RT9471_REG_PRECHG    0x05
+#define RT9471_REG_VCHG              0x07
+#define RT9471_REG_ICHG              0x08
+#define RT9471_REG_CHGTMR    0x09
+#define RT9471_REG_EOC               0x0A
+#define RT9471_REG_INFO              0x0B
+#define RT9471_REG_JEITA     0x0C
+#define RT9471_REG_PUMP_EXP  0x0D
+#define      RT9471_REG_DPDMDET      0x0E
+#define RT9471_REG_ICSTAT    0x0F
+#define      RT9471_REG_STAT0        0x10
+#define RT9471_REG_STAT1     0x11
+#define RT9471_REG_STAT2     0x12
+#define RT9471_REG_IRQ0              0x20
+#define RT9471_REG_MASK0     0x30
+
+#define RT9471_OTGCV_MASK    GENMASK(7, 6)
+#define RT9471_OTGCC_MASK    BIT(0)
+#define RT9471_OTGEN_MASK    BIT(1)
+#define RT9471_CHGFAULT_MASK GENMASK(4, 1)
+
+/* Device ID */
+#define RT9470_DEVID         0x09
+#define RT9470D_DEVID                0x0A
+#define RT9471_DEVID         0x0D

drivers/power/supply/rt9471.h line 76

Quoted 10 lines

drivers/power/supply/rt9471.h new file +10 -0

+#define RT9471D_DEVID                0x0E
+
+#define RT9471_NUM_IRQ_REGS  4
+#define RT9471_OTGCV_MINUV   4850000
+#define RT9471_OTGCV_STEPUV  150000
+#define RT9471_NUM_VOTG              4
+#define RT9471_VCHG_MAXUV    4700000
+#define RT9471_ICHG_MAXUA    3150000
+
+#endif /* __RT9471_CHARGER_H */

Please merge this into rt9471.c

Quoted 3 lines

--
2.7.4

From: ChiYuan Huang <[email protected]>

Document the settings exported by rt9471 charger driver through sysfs entries:
- sysoff_enable
- charge_term_enable
- port_detect_enable

Signed-off-by ChiYuan Huang <[email protected]>

---
 Documentation/ABI/testing/sysfs-class-power | 44 +++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

Documentation/ABI/testing/sysfs-class-power +4 -0

index a9ce63c..1f8afe5 100644
@@ -768,3 +768,47 @@ Description:
 
 		Access: Read
 		Valid values: 1-31
+
+What:		/sys/class/power_supply/rt9471-*/sysoff_enable
+Date:		Sep 2022
+KernelVersion:	6.1

Documentation/ABI/testing/sysfs-class-power +4 -0

+What:		/sys/class/power_supply/rt9471-*/charge_term_enable
+Date:		Sep 2022
+KernelVersion:	6.1
+Contact:	ChiYuan Huang <[email protected]>

Documentation/ABI/testing/sysfs-class-power +4 -0

+What:		/sys/class/power_supply/rt9471-*/port_detect_enable
+Date:		Sep 2022
+KernelVersion:	6.1
+Contact:	ChiYuan Huang <[email protected]>

Quoted 7 lines · cy_huang

From: ChiYuan Huang <[email protected]>

Document the settings exported by rt9471 charger driver through sysfs entries:
- sysoff_enable
- charge_term_enable
- port_detect_enable

Quoted 4 lines

Signed-off-by ChiYuan Huang <[email protected]>

---
 Documentation/ABI/testing/sysfs-class-power | 44 +++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

Quoted 13 lines

Documentation/ABI/testing/sysfs-class-power +4 -0

index a9ce63c..1f8afe5 100644
@@ -768,3 +768,47 @@ Description:
 
 		Access: Read
 		Valid values: 1-31
+
+What:		/sys/class/power_supply/rt9471-*/sysoff_enable
+Date:		Sep 2022
+KernelVersion:	6.1

Documentation/ABI/testing/sysfs-class-power Description: · line 784

Quoted 10 lines

Documentation/ABI/testing/sysfs-class-power +10 -0

+Contact:	ChiYuan Huang <[email protected]>
+Description:
+		This entry allows enabling the sysoff mode of rt9471 charger devices.
+		If enabled and the input is removed, the internal battery FET is turned
+		off to reduce the leakage from the BAT pin. See device datasheet for details.
+
+		Access: Read, Write
+		Valid values:
+		- 1: enabled
+		- 0: disabled

This is not a very good description of what the control does. When do you expect users to control this?

Quoted 4 lines

Documentation/ABI/testing/sysfs-class-power +4 -0

+What:		/sys/class/power_supply/rt9471-*/charge_term_enable
+Date:		Sep 2022
+KernelVersion:	6.1
+Contact:	ChiYuan Huang <[email protected]>

Documentation/ABI/testing/sysfs-class-power Description: · line 799

Quoted 10 lines

Documentation/ABI/testing/sysfs-class-power +10 -0

+Description:
+		This entry allows enabling the charge termination function of rt9471 charger
+		devices. If enabled, the battery charging current, and the battery voltage
+		reachs charge termination condition, the internal battery FET will be turned off
+		to optimize the battery life. See device datasheet for details.
+
+		Access: Read, Write
+		Valid values:
+		- 1: enabled
+		- 0: disabled

Just write 0 to .../charge_term_current to disable it. No need for a custom property.

Quoted 4 lines

Documentation/ABI/testing/sysfs-class-power +4 -0

+What:		/sys/class/power_supply/rt9471-*/port_detect_enable
+Date:		Sep 2022
+KernelVersion:	6.1
+Contact:	ChiYuan Huang <[email protected]>

Documentation/ABI/testing/sysfs-class-power Description: · line 814

Quoted 10 lines

Documentation/ABI/testing/sysfs-class-power +10 -0

+Description:
+		This entry allows enabling the USB BC12 port detect function of rt9471 charger
+		devices. If enabled and VBUS is inserted, device will start to do the BC12
+		port detect and report the usb port type when port detect is done. See
+		datasheet for details.
+
+		Access: Read, Write
+		Valid values:
+		- 1: enabled
+		- 0: disabled

Why would one want to disable this?
Can't the driver just enable it unconditionally?

-- Sebastian

Hi,

Quoted 8 lines · Sebastian Reichel

Quoted 7 lines · cy_huang

From: ChiYuan Huang <[email protected]>

Document the settings exported by rt9471 charger driver through sysfs entries:
- sysoff_enable
- charge_term_enable
- port_detect_enable

Quoted 4 lines

Quoted 4 lines

Signed-off-by ChiYuan Huang <[email protected]>

---
 Documentation/ABI/testing/sysfs-class-power | 44 +++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

I forgot to mention: custom driver properties are described in their own files, see Documentation/ABI/testing/sysfs-class-power-*. But are to be avoided if possible. So first of all I want to make sure you actually need any of these.

-- Sebastian

Quoted 26 lines

Quoted 13 lines

Documentation/ABI/testing/sysfs-class-power +4 -0

index a9ce63c..1f8afe5 100644
@@ -768,3 +768,47 @@ Description:
 
            Access: Read
            Valid values: 1-31
+
+What:              /sys/class/power_supply/rt9471-*/sysoff_enable
+Date:              Sep 2022
+KernelVersion:     6.1

Documentation/ABI/testing/sysfs-class-power Description: · line 784

Quoted 10 lines

Documentation/ABI/testing/sysfs-class-power +10 -0

+Contact:   ChiYuan Huang <[email protected]>
+Description:
+           This entry allows enabling the sysoff mode of rt9471 charger devices.
+           If enabled and the input is removed, the internal battery FET is turned
+           off to reduce the leakage from the BAT pin. See device datasheet for details.
+
+           Access: Read, Write
+           Valid values:
+           - 1: enabled
+           - 0: disabled

This is not a very good description of what the control does. When do you expect users to control this?

Quoted 10 lines

Quoted 10 lines

Documentation/ABI/testing/sysfs-class-power +9 -0

+What:              /sys/class/power_supply/rt9471-*/charge_term_enable
+Date:              Sep 2022
+KernelVersion:     6.1
+Contact:   ChiYuan Huang <[email protected]>
+Description:
+           This entry allows enabling the charge termination function of rt9471 charger
+           devices. If enabled, the battery charging current, and the battery voltage
+           reachs charge termination condition, the internal battery FET will be turned off
+           to optimize the battery life. See device datasheet for details.

Quoted 8 lines

Documentation/ABI/testing/sysfs-class-power Description: · line 784

Quoted 5 lines

Documentation/ABI/testing/sysfs-class-power +5 -0

+
+           Access: Read, Write
+           Valid values:
+           - 1: enabled
+           - 0: disabled

Just write 0 to .../charge_term_current to disable it. No need for a custom property.

Quoted 10 lines

Quoted 10 lines

Documentation/ABI/testing/sysfs-class-power +9 -0

+What:              /sys/class/power_supply/rt9471-*/port_detect_enable
+Date:              Sep 2022
+KernelVersion:     6.1
+Contact:   ChiYuan Huang <[email protected]>
+Description:
+           This entry allows enabling the USB BC12 port detect function of rt9471 charger
+           devices. If enabled and VBUS is inserted, device will start to do the BC12
+           port detect and report the usb port type when port detect is done. See
+           datasheet for details.

Quoted 8 lines

Documentation/ABI/testing/sysfs-class-power Description: · line 784

Quoted 5 lines

Documentation/ABI/testing/sysfs-class-power +5 -0

+
+           Access: Read, Write
+           Valid values:
+           - 1: enabled
+           - 0: disabled

Why would one want to disable this?
Can't the driver just enable it unconditionally?

Quoted 2 lines

-- Sebastian