[PATCH v2 0/3] Add optional properties to MAX17040

[PATCH v2 0/3] Add optional properties to MAX17040

[Svyatoslav Ryhel]

Extend properties supported by max17040 fuel gauge if it is accompanied
by different devices.

If max17040 is coupled with a charger, pass charger status since it should
match and max17040 has no dedicated status detection ability.

max17040_get_online can be reused for PRESENT property since if it is
online it must be present.

Finally, max17040 may be coupled with a dedicated thermal sensor which
monitors battery temperature so lets add support for iio channel to match
hw setup.

---
Changes from v1:
- documentation dropped monitored-battery and power-supplies (inherited
  from inclusion)
- dropped passing charger health as battery health
- dropped patch for simple battery cell support
- switched iio_read_channel_raw to iio_read_channel_processed_scale
- switched iio_channel_get to devm_iio_channel_get
- re-organized implementation of temp channel (implemented in way 
  *_get_optional functions usually act)
---

Svyatoslav Ryhel (3):
  dt-bindings: power: supply: maxim,max17040: update properties
  power: max17040: pass status property from supplier
  power: max17040: get thermal data from adc if available

 .../bindings/power/supply/maxim,max17040.yaml | 31 +++++++++++++++++++
 drivers/power/supply/max17040_battery.c       | 27 ++++++++++++++++
 2 files changed, 58 insertions(+)

-- 
2.39.2

[PATCH v2 1/3] dt-bindings: power: supply: maxim,max17040: update properties

[Svyatoslav Ryhel]

Add status and temperature properties.

Signed-off-by: Svyatoslav Ryhel <clamor95@gmail.com>
---
 .../bindings/power/supply/maxim,max17040.yaml | 31 +++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/Documentation/devicetree/bindings/power/supply/maxim,max17040.yaml b/Documentation/devicetree/bindings/power/supply/maxim,max17040.yaml
index 2627cd3eed83..4bccf25a111c 100644
--- a/Documentation/devicetree/bindings/power/supply/maxim,max17040.yaml
+++ b/Documentation/devicetree/bindings/power/supply/maxim,max17040.yaml
@@ -55,6 +55,14 @@ properties:
   interrupts:
     maxItems: 1
 
+  io-channels:
+    items:
+      - description: battery temperature
+
+  io-channel-names:
+    items:
+      - const: temp
+
   wakeup-source:
     type: boolean
     description: |
@@ -95,3 +103,26 @@ examples:
         wakeup-source;
       };
     };
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    i2c0 {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      fuel-gauge@36 {
+        compatible = "maxim,max17043";
+        reg = <0x36>;
+
+        interrupt-parent = <&gpio>;
+        interrupts = <144 IRQ_TYPE_EDGE_FALLING>;
+
+        monitored-battery = <&battery>;
+        power-supplies = <&charger>;
+
+        io-channels = <&adc 8>;
+        io-channel-names = "temp";
+
+        maxim,alert-low-soc-level = <10>;
+        wakeup-source;
+      };
+    };
-- 
2.39.2

Re: [PATCH v2 1/3] dt-bindings: power: supply: maxim,max17040: update properties

[Krzysztof Kozlowski]

On 30/07/2023 19:26, Svyatoslav Ryhel wrote:
> Add status and temperature properties.
> 
> Signed-off-by: Svyatoslav Ryhel <clamor95@gmail.com>
> ---
>  .../bindings/power/supply/maxim,max17040.yaml | 31 +++++++++++++++++++
>  1 file changed, 31 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/power/supply/maxim,max17040.yaml b/Documentation/devicetree/bindings/power/supply/maxim,max17040.yaml
> index 2627cd3eed83..4bccf25a111c 100644
> --- a/Documentation/devicetree/bindings/power/supply/maxim,max17040.yaml
> +++ b/Documentation/devicetree/bindings/power/supply/maxim,max17040.yaml
> @@ -55,6 +55,14 @@ properties:
>    interrupts:
>      maxItems: 1
>  
> +  io-channels:
> +    items:
> +      - description: battery temperature
> +
> +  io-channel-names:
> +    items:
> +      - const: temp
> +
>    wakeup-source:
>      type: boolean
>      description: |
> @@ -95,3 +103,26 @@ examples:
>          wakeup-source;
>        };
>      };
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    i2c0 {

Just i2c

With above:

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>


Best regards,
Krzysztof

[PATCH v2 2/3] power: max17040: pass status property from supplier

[Svyatoslav Ryhel]

Optionally pass status property from supplier if has support
for it. If cell is online assume it is present as well.

Signed-off-by: Svyatoslav Ryhel <clamor95@gmail.com>
---
 drivers/power/supply/max17040_battery.c | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/drivers/power/supply/max17040_battery.c b/drivers/power/supply/max17040_battery.c
index d1075959dd46..3301e8a4b16c 100644
--- a/drivers/power/supply/max17040_battery.c
+++ b/drivers/power/supply/max17040_battery.c
@@ -389,6 +389,7 @@ static int max17040_get_property(struct power_supply *psy,
 
 	switch (psp) {
 	case POWER_SUPPLY_PROP_ONLINE:
+	case POWER_SUPPLY_PROP_PRESENT:
 		val->intval = max17040_get_online(chip);
 		break;
 	case POWER_SUPPLY_PROP_VOLTAGE_NOW:
@@ -400,6 +401,9 @@ static int max17040_get_property(struct power_supply *psy,
 	case POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN:
 		val->intval = chip->low_soc_alert;
 		break;
+	case POWER_SUPPLY_PROP_STATUS:
+		power_supply_get_property_from_supplier(psy, psp, val);
+		break;
 	default:
 		return -EINVAL;
 	}
@@ -415,9 +419,11 @@ static const struct regmap_config max17040_regmap = {
 
 static enum power_supply_property max17040_battery_props[] = {
 	POWER_SUPPLY_PROP_ONLINE,
+	POWER_SUPPLY_PROP_PRESENT,
 	POWER_SUPPLY_PROP_VOLTAGE_NOW,
 	POWER_SUPPLY_PROP_CAPACITY,
 	POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN,
+	POWER_SUPPLY_PROP_STATUS,
 };
 
 static const struct power_supply_desc max17040_battery_desc = {
-- 
2.39.2

[PATCH v2 3/3] power: max17040: get thermal data from adc if available

[Svyatoslav Ryhel]

Since fuel gauge does not support thermal monitoring,
some vendors may couple this fuel gauge with thermal/adc
sensor to monitor battery cell exact temperature.

Add this feature by adding optional iio thermal channel.

Signed-off-by: Svyatoslav Ryhel <clamor95@gmail.com>
---
 drivers/power/supply/max17040_battery.c | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/drivers/power/supply/max17040_battery.c b/drivers/power/supply/max17040_battery.c
index 3301e8a4b16c..54db20637c87 100644
--- a/drivers/power/supply/max17040_battery.c
+++ b/drivers/power/supply/max17040_battery.c
@@ -18,6 +18,7 @@
 #include <linux/of_device.h>
 #include <linux/regmap.h>
 #include <linux/slab.h>
+#include <linux/iio/consumer.h>
 
 #define MAX17040_VCELL	0x02
 #define MAX17040_SOC	0x04
@@ -142,6 +143,7 @@ struct max17040_chip {
 	struct delayed_work		work;
 	struct power_supply		*battery;
 	struct chip_data		data;
+	struct iio_channel		*channel_temp;
 
 	/* battery capacity */
 	int soc;
@@ -404,6 +406,13 @@ static int max17040_get_property(struct power_supply *psy,
 	case POWER_SUPPLY_PROP_STATUS:
 		power_supply_get_property_from_supplier(psy, psp, val);
 		break;
+	case POWER_SUPPLY_PROP_TEMP:
+		if (!chip->channel_temp)
+			return -ENODATA;
+
+		iio_read_channel_processed_scale(chip->channel_temp,
+						 &val->intval, 10);
+		break;
 	default:
 		return -EINVAL;
 	}
@@ -424,6 +433,7 @@ static enum power_supply_property max17040_battery_props[] = {
 	POWER_SUPPLY_PROP_CAPACITY,
 	POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN,
 	POWER_SUPPLY_PROP_STATUS,
+	POWER_SUPPLY_PROP_TEMP,
 };
 
 static const struct power_supply_desc max17040_battery_desc = {
@@ -469,6 +479,17 @@ static int max17040_probe(struct i2c_client *client)
 	i2c_set_clientdata(client, chip);
 	psy_cfg.drv_data = chip;
 
+	/* Switch to devm_iio_channel_get_optional when available  */
+	chip->channel_temp = devm_iio_channel_get(&client->dev, "temp");
+	if (IS_ERR(chip->channel_temp)) {
+		ret = PTR_ERR(chip->channel_temp);
+		if (ret != -ENODEV)
+			return dev_err_probe(&client->dev, PTR_ERR(chip->channel_temp),
+					     "failed to get temp\n");
+		else
+			chip->channel_temp = NULL;
+	}
+
 	chip->battery = devm_power_supply_register(&client->dev,
 				&max17040_battery_desc, &psy_cfg);
 	if (IS_ERR(chip->battery)) {
-- 
2.39.2

Re: [PATCH v2 3/3] power: max17040: get thermal data from adc if available

[kernel test robot]

Hi Svyatoslav,

kernel test robot noticed the following build errors:

[auto build test ERROR on krzk-dt/for-next]
[also build test ERROR on linus/master v6.5-rc3 next-20230728]
[cannot apply to sre-power-supply/for-next]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Svyatoslav-Ryhel/dt-bindings-power-supply-maxim-max17040-update-properties/20230731-012920
base:   https://git.kernel.org/pub/scm/linux/kernel/git/krzk/linux-dt.git for-next
patch link:    https://lore.kernel.org/r/20230730172648.71578-4-clamor95%40gmail.com
patch subject: [PATCH v2 3/3] power: max17040: get thermal data from adc if available
config: s390-randconfig-r044-20230731 (https://download.01.org/0day-ci/archive/20230731/202307310322.iEuhtMME-lkp@intel.com/config)
compiler: clang version 17.0.0 (https://github.com/llvm/llvm-project.git 4a5ac14ee968ff0ad5d2cc1ffa0299048db4c88a)
reproduce: (https://download.01.org/0day-ci/archive/20230731/202307310322.iEuhtMME-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202307310322.iEuhtMME-lkp@intel.com/

All errors (new ones prefixed by >>):

   s390x-linux-ld: drivers/power/supply/max17040_battery.o: in function `max17040_probe':
>> drivers/power/supply/max17040_battery.c:483: undefined reference to `devm_iio_channel_get'
   s390x-linux-ld: drivers/power/supply/max17040_battery.o: in function `max17040_get_property':
>> drivers/power/supply/max17040_battery.c:413: undefined reference to `iio_read_channel_processed_scale'


vim +483 drivers/power/supply/max17040_battery.c

   385	
   386	static int max17040_get_property(struct power_supply *psy,
   387				    enum power_supply_property psp,
   388				    union power_supply_propval *val)
   389	{
   390		struct max17040_chip *chip = power_supply_get_drvdata(psy);
   391	
   392		switch (psp) {
   393		case POWER_SUPPLY_PROP_ONLINE:
   394		case POWER_SUPPLY_PROP_PRESENT:
   395			val->intval = max17040_get_online(chip);
   396			break;
   397		case POWER_SUPPLY_PROP_VOLTAGE_NOW:
   398			val->intval = max17040_get_vcell(chip);
   399			break;
   400		case POWER_SUPPLY_PROP_CAPACITY:
   401			val->intval = max17040_get_soc(chip);
   402			break;
   403		case POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN:
   404			val->intval = chip->low_soc_alert;
   405			break;
   406		case POWER_SUPPLY_PROP_STATUS:
   407			power_supply_get_property_from_supplier(psy, psp, val);
   408			break;
   409		case POWER_SUPPLY_PROP_TEMP:
   410			if (!chip->channel_temp)
   411				return -ENODATA;
   412	
 > 413			iio_read_channel_processed_scale(chip->channel_temp,
   414							 &val->intval, 10);
   415			break;
   416		default:
   417			return -EINVAL;
   418		}
   419		return 0;
   420	}
   421	
   422	static const struct regmap_config max17040_regmap = {
   423		.reg_bits	= 8,
   424		.reg_stride	= 2,
   425		.val_bits	= 16,
   426		.val_format_endian = REGMAP_ENDIAN_BIG,
   427	};
   428	
   429	static enum power_supply_property max17040_battery_props[] = {
   430		POWER_SUPPLY_PROP_ONLINE,
   431		POWER_SUPPLY_PROP_PRESENT,
   432		POWER_SUPPLY_PROP_VOLTAGE_NOW,
   433		POWER_SUPPLY_PROP_CAPACITY,
   434		POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN,
   435		POWER_SUPPLY_PROP_STATUS,
   436		POWER_SUPPLY_PROP_TEMP,
   437	};
   438	
   439	static const struct power_supply_desc max17040_battery_desc = {
   440		.name			= "battery",
   441		.type			= POWER_SUPPLY_TYPE_BATTERY,
   442		.get_property		= max17040_get_property,
   443		.set_property		= max17040_set_property,
   444		.property_is_writeable  = max17040_prop_writeable,
   445		.properties		= max17040_battery_props,
   446		.num_properties		= ARRAY_SIZE(max17040_battery_props),
   447	};
   448	
   449	static int max17040_probe(struct i2c_client *client)
   450	{
   451		const struct i2c_device_id *id = i2c_client_get_device_id(client);
   452		struct i2c_adapter *adapter = client->adapter;
   453		struct power_supply_config psy_cfg = {};
   454		struct max17040_chip *chip;
   455		enum chip_id chip_id;
   456		bool enable_irq = false;
   457		int ret;
   458	
   459		if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE))
   460			return -EIO;
   461	
   462		chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
   463		if (!chip)
   464			return -ENOMEM;
   465	
   466		chip->client = client;
   467		chip->regmap = devm_regmap_init_i2c(client, &max17040_regmap);
   468		if (IS_ERR(chip->regmap))
   469			return PTR_ERR(chip->regmap);
   470		chip_id = (enum chip_id) id->driver_data;
   471		if (client->dev.of_node) {
   472			ret = max17040_get_of_data(chip);
   473			if (ret)
   474				return ret;
   475			chip_id = (uintptr_t)of_device_get_match_data(&client->dev);
   476		}
   477		chip->data = max17040_family[chip_id];
   478	
   479		i2c_set_clientdata(client, chip);
   480		psy_cfg.drv_data = chip;
   481	
   482		/* Switch to devm_iio_channel_get_optional when available  */
 > 483		chip->channel_temp = devm_iio_channel_get(&client->dev, "temp");
   484		if (IS_ERR(chip->channel_temp)) {
   485			ret = PTR_ERR(chip->channel_temp);
   486			if (ret != -ENODEV)
   487				return dev_err_probe(&client->dev, PTR_ERR(chip->channel_temp),
   488						     "failed to get temp\n");
   489			else
   490				chip->channel_temp = NULL;
   491		}
   492	
   493		chip->battery = devm_power_supply_register(&client->dev,
   494					&max17040_battery_desc, &psy_cfg);
   495		if (IS_ERR(chip->battery)) {
   496			dev_err(&client->dev, "failed: power supply register\n");
   497			return PTR_ERR(chip->battery);
   498		}
   499	
   500		ret = max17040_get_version(chip);
   501		if (ret < 0)
   502			return ret;
   503		dev_dbg(&chip->client->dev, "MAX17040 Fuel-Gauge Ver 0x%x\n", ret);
   504	
   505		if (chip_id == ID_MAX17040 || chip_id == ID_MAX17041)
   506			max17040_reset(chip);
   507	
   508		max17040_set_rcomp(chip, chip->rcomp);
   509	
   510		/* check interrupt */
   511		if (client->irq && chip->data.has_low_soc_alert) {
   512			ret = max17040_set_low_soc_alert(chip, chip->low_soc_alert);
   513			if (ret) {
   514				dev_err(&client->dev,
   515					"Failed to set low SOC alert: err %d\n", ret);
   516				return ret;
   517			}
   518	
   519			enable_irq = true;
   520		}
   521	
   522		if (client->irq && chip->data.has_soc_alert) {
   523			ret = max17040_set_soc_alert(chip, 1);
   524			if (ret) {
   525				dev_err(&client->dev,
   526					"Failed to set SOC alert: err %d\n", ret);
   527				return ret;
   528			}
   529			enable_irq = true;
   530		} else {
   531			/* soc alerts negate the need for polling */
   532			INIT_DEFERRABLE_WORK(&chip->work, max17040_work);
   533			ret = devm_add_action(&client->dev, max17040_stop_work, chip);
   534			if (ret)
   535				return ret;
   536			max17040_queue_work(chip);
   537		}
   538	
   539		if (enable_irq) {
   540			ret = max17040_enable_alert_irq(chip);
   541			if (ret) {
   542				client->irq = 0;
   543				dev_warn(&client->dev,
   544					 "Failed to get IRQ err %d\n", ret);
   545			}
   546		}
   547	
   548		return 0;
   549	}
   550	

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

Re: [PATCH v2 3/3] power: max17040: get thermal data from adc if available

[kernel test robot]

Hi Svyatoslav,

kernel test robot noticed the following build errors:

[auto build test ERROR on krzk-dt/for-next]
[also build test ERROR on linus/master v6.5-rc3 next-20230728]
[cannot apply to sre-power-supply/for-next]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Svyatoslav-Ryhel/dt-bindings-power-supply-maxim-max17040-update-properties/20230731-012920
base:   https://git.kernel.org/pub/scm/linux/kernel/git/krzk/linux-dt.git for-next
patch link:    https://lore.kernel.org/r/20230730172648.71578-4-clamor95%40gmail.com
patch subject: [PATCH v2 3/3] power: max17040: get thermal data from adc if available
config: x86_64-buildonly-randconfig-r001-20230731 (https://download.01.org/0day-ci/archive/20230731/202307310308.FDG6br3Y-lkp@intel.com/config)
compiler: gcc-12 (Debian 12.2.0-14) 12.2.0
reproduce: (https://download.01.org/0day-ci/archive/20230731/202307310308.FDG6br3Y-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202307310308.FDG6br3Y-lkp@intel.com/

All errors (new ones prefixed by >>):

   ld: vmlinux.o: in function `max17040_get_property':
>> max17040_battery.c:(.text+0x1cb3dd0): undefined reference to `iio_read_channel_processed_scale'
   ld: vmlinux.o: in function `max17040_probe':
>> max17040_battery.c:(.text+0x1cb40f5): undefined reference to `devm_iio_channel_get'

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

Re: [PATCH v2 3/3] power: max17040: get thermal data from adc if available

[kernel test robot]

Hi Svyatoslav,

kernel test robot noticed the following build errors:

[auto build test ERROR on krzk-dt/for-next]
[also build test ERROR on linus/master v6.5-rc3 next-20230728]
[cannot apply to sre-power-supply/for-next]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Svyatoslav-Ryhel/dt-bindings-power-supply-maxim-max17040-update-properties/20230731-012920
base:   https://git.kernel.org/pub/scm/linux/kernel/git/krzk/linux-dt.git for-next
patch link:    https://lore.kernel.org/r/20230730172648.71578-4-clamor95%40gmail.com
patch subject: [PATCH v2 3/3] power: max17040: get thermal data from adc if available
config: i386-randconfig-i013-20230731 (https://download.01.org/0day-ci/archive/20230731/202307310455.Om3VuGqo-lkp@intel.com/config)
compiler: clang version 16.0.4 (https://github.com/llvm/llvm-project.git ae42196bc493ffe877a7e3dff8be32035dea4d07)
reproduce: (https://download.01.org/0day-ci/archive/20230731/202307310455.Om3VuGqo-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202307310455.Om3VuGqo-lkp@intel.com/

All errors (new ones prefixed by >>):

>> ld.lld: error: undefined symbol: devm_iio_channel_get
   >>> referenced by max17040_battery.c:483 (drivers/power/supply/max17040_battery.c:483)
   >>>               drivers/power/supply/max17040_battery.o:(max17040_probe) in archive vmlinux.a
--
>> ld.lld: error: undefined symbol: iio_read_channel_processed_scale
   >>> referenced by max17040_battery.c:413 (drivers/power/supply/max17040_battery.c:413)
   >>>               drivers/power/supply/max17040_battery.o:(max17040_get_property) in archive vmlinux.a

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki