Received-SPF: pass (google.com: domain of linux-kernel+bounces-52039-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
From: Bhavin Sharma <bhavin.sharma@siliconsignals.io>
To: sre@kernel.org,
	robh+dt@kernel.org,
	krzysztof.kozlowski+dt@linaro.org,
	conor+dt@kernel.org
Cc: Bhavin Sharma <bhavin.sharma@siliconsignals.io>,
	Hardevsinh Palaniya <hardevsinh.palaniya@siliconsignals.io>,
	linux-pm@vger.kernel.org,
	devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH v3 1/2] power: supply: Add STC3117 fuel gauge unit driver
Date: Mon,  5 Feb 2024 10:43:17 +0530
Message-Id: <20240205051321.4079933-1-bhavin.sharma@siliconsignals.io>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?XNXAeYlWuMZwJ9PTHA6mppcJFPtpzhpJAsFUqn3Nza3XyPUoxuypCTUVUkv6?=
 =?us-ascii?Q?RIfZKEkQ677fSgNIdo9gpymB7/IyYaAMrDBi2ZeYnTlxVJBzBoyGzyku4ww0?=
 =?us-ascii?Q?mYidgxvpqsQEEgSjzMNzWYd9qTZl6j9Uld8Q+MgxWNeQzBpzFVIu5sTqXVVe?=
 =?us-ascii?Q?gQnZwKBqixtjrrytK4Zq3Q7WdOchRwr8KyuT6hJQVW152gmWBoGEEJPEUyKC?=
 =?us-ascii?Q?lp0eY1jRLTprNAgpF99idOxxML6LxB7uzRcnenI6Ux6uLqMY6ExWAYgW+Cnl?=
 =?us-ascii?Q?l/LtjPKYux7ejxoIatkWlj5F9iRGlakwXZkZukS8UaHH/t+wluqSH8WLXBGO?=
 =?us-ascii?Q?YUPxtUnTC4OHWFFjHNvcaCoh3yOmTjQRoO4nagQ/+5tmZHeoJvONhLJPv4S7?=
 =?us-ascii?Q?zPOm5Wvv6RwkE0SOC/eZmkElnm5SRTDqh4Rhou5aL5OyaQ1R3gHOILBx73r5?=
 =?us-ascii?Q?0xsO4bmBeulvRWHbcsmPV98gV4KjwHDhfz+tZ/19H3ttajy38t4gk8urQYmc?=
 =?us-ascii?Q?jnJU/kXrhQwKRwfm+pjahWD8gvyoEuh52CFhxAfV8sdH/xq/aT/45RDGnH7d?=
 =?us-ascii?Q?oY03e73ejpCGwaAQAUZucLoNCG2CczeDQkzvRlVMqptYaYVK6W/19TjryOfB?=
 =?us-ascii?Q?t35P2Xfu0bJIy7Y+IU161vCuvixJCn3w7MMBXXzHU/w45z+H5VwYg+HiFHK7?=
 =?us-ascii?Q?HIjL2JoX31w0zEYK/mQaArQMaEZ+S32DTVW7D8qopHFg3B2DCuMgqgVA+U/j?=
 =?us-ascii?Q?MwcGmt0fVHfpEkyuOM1unS3ah8bXiJSeiaqr4DEzkJQrbZ5RlPMjqxWssh3K?=
 =?us-ascii?Q?EHbgwIbktxOulsCcA2udzdL0R4sFPJBSTwkvdALprXW2knKJKl11TbLBti0l?=
 =?us-ascii?Q?NXpQmAs/VC5JNE7+YWtWoUinU8oXHEt/rKhlubwodQarEyHQfx4+636VuIbX?=
 =?us-ascii?Q?Z03foA+PaAST4fdZy11COfPmyqv/KlQES3Sbe5OosqiVX1MNr0xQ7Iw9U/hv?=
 =?us-ascii?Q?xz3Th+WF3hFoKHdhHnN0H5n+lKNZ8Ea4VHEvXLV0Q7zQI8rrLQtevb72hQhh?=
 =?us-ascii?Q?OMJ8YDMoYOGD+JKMpDnyHFy0CEQmDl0Mi9HD300NFJtp/vnt+cPm+ColULcQ?=
 =?us-ascii?Q?gQi4EaWWaJIwaXMgG31mvjDPp9TMgqRkV6X5EU07wd9Ko220gaEuikDkySYx?=
 =?us-ascii?Q?4jdD2TV7E3YQJQyKvblvlthYJ8GW1YSSJANwy4UZXJvb4N0S03vl2TJDqDZv?=
 =?us-ascii?Q?aHV2H8xNzvO+6f7CPQDtsbGbxXhzIKkDrD3y9C1pzZibflW1JMHg4Gj9Ejck?=
 =?us-ascii?Q?/7nh4HexCiW0ZCa+1bb8kjQMGV+ZHE/qakOYn4KDsJqjzfkekjuiBrgA3al5?=
 =?us-ascii?Q?qsHFJc23wXIdgpsLzVAteoDIOWXl3ouW4J21b6E+rhjOOG8AmTFVW0MkuASQ?=
 =?us-ascii?Q?CCphoriDXDfy1BodcyGNjOYDUSWR0YoU/BDxg8+jKoEwnlFpotLEsmTQQdjt?=
 =?us-ascii?Q?kWz3rNuvCh+MjDwAFtyvnb9v55vLKT4w+ofd6Hh5uFYIPEc1n6ggh8Wj1Bkq?=
 =?us-ascii?Q?eXBcqaf67taQ5M/i3MG12vnExE5WwNBjLpAiwsPENIA5D0zg6eYotaJmlqUz?=
 =?us-ascii?Q?Ys/2EFqQZayoLqw9s6BZnxI=3D?=
X-OriginatorOrg: siliconsignals.io
X-MS-Exchange-CrossTenant-Network-Message-Id: 2cbc2cfc-6bd0-45aa-5918-08dc26093a4c
X-MS-Exchange-CrossTenant-AuthSource: MAZPR01MB6957.INDPRD01.PROD.OUTLOOK.COM
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Feb 2024 05:13:45.5511
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 7ec5089e-a433-4bd1-a638-82ee62e21d37
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: b9aINSWVua3UTKxaMfQzCAjnxFwVJIipyYl8RxMTJUTFN6xUbIDDnMYeu3NwIFF3pne8iIbtYPfZZs/xeyY1VIUXSjZxZiqr/CYaUmFEy4A=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PN0PR01MB5496

Adding minimal support for stc3117 fuel gauge driver
to read battery voltage level

Signed-off-by: Bhavin Sharma <bhavin.sharma@siliconsignals.io>
---
Changelogs :

v2 -> v3
- Resolved kernel test robot build warnings
- Aligned included header files in alphabetical order
- Removed unused header files
- Removed unnecessary blank lines
- Aligned all the macros in alphabetical order
- Changed macro LSB_VALUE to VOLTAGE_LSB_VALUE
- Dropped function prototypes and arranged the code accordingly
- Used macros instead of static numbers for array declaration
- Removed redundant code
- Replaced 'power_supply_register' with 'devm_power_supply_register' and 'pr_err' with 'dev_err'
- Removed global variables

v1 -> v2
- No change
---
 drivers/power/supply/Kconfig              |   7 ++
 drivers/power/supply/Makefile             |   1 +
 drivers/power/supply/stc3117_fuel_gauge.c | 107 ++++++++++++++++++++++
 3 files changed, 115 insertions(+)
 create mode 100644 drivers/power/supply/stc3117_fuel_gauge.c

diff --git a/drivers/power/supply/Kconfig b/drivers/power/supply/Kconfig
index f21cb05815ec..e2e3af4bcd5f 100644
--- a/drivers/power/supply/Kconfig
+++ b/drivers/power/supply/Kconfig
@@ -875,6 +875,13 @@ config FUEL_GAUGE_SC27XX
 	  Say Y here to enable support for fuel gauge with SC27XX
 	  PMIC chips.
 
+config FUEL_GAUGE_STC3117
+        tristate "STMicroelectronics STC3117 fuel gauge driver"
+        depends on I2C
+        help
+          Say Y here to enable support for fuel gauge with STC3117
+          PMIC chips.
+
 config CHARGER_UCS1002
 	tristate "Microchip UCS1002 USB Port Power Controller"
 	depends on I2C
diff --git a/drivers/power/supply/Makefile b/drivers/power/supply/Makefile
index 58b567278034..be8961661bd1 100644
--- a/drivers/power/supply/Makefile
+++ b/drivers/power/supply/Makefile
@@ -104,6 +104,7 @@ obj-$(CONFIG_CHARGER_CROS_USBPD)	+= cros_usbpd-charger.o
 obj-$(CONFIG_CHARGER_CROS_PCHG)	+= cros_peripheral_charger.o
 obj-$(CONFIG_CHARGER_SC2731)	+= sc2731_charger.o
 obj-$(CONFIG_FUEL_GAUGE_SC27XX)	+= sc27xx_fuel_gauge.o
+obj-$(CONFIG_FUEL_GAUGE_STC3117)        += stc3117_fuel_gauge.o
 obj-$(CONFIG_CHARGER_UCS1002)	+= ucs1002_power.o
 obj-$(CONFIG_CHARGER_BD99954)	+= bd99954-charger.o
 obj-$(CONFIG_CHARGER_WILCO)	+= wilco-charger.o
diff --git a/drivers/power/supply/stc3117_fuel_gauge.c b/drivers/power/supply/stc3117_fuel_gauge.c
new file mode 100644
index 000000000000..29eb00b44e21
--- /dev/null
+++ b/drivers/power/supply/stc3117_fuel_gauge.c
@@ -0,0 +1,107 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * stc3117_fuel_gauge.c - STMicroelectronics STC3117 Fuel Gauge Driver
+ *
+ * Copyright (c) 2024 Silicon Signals Pvt Ltd.
+ * Author:      Bhavin Sharma <bhavin.sharma@siliconsignals.io>
+ *              Hardevsinh Palaniya <hardevsinh.palaniya@siliconsignals.com>
+ */
+
+#include <linux/i2c.h>
+#include <linux/power_supply.h>
+
+#define VOLTAGE_DATA_SIZE	2		// in bytes
+#define VOLTAGE_LSB_VALUE	2200		// in micro-volts
+#define VOLTAGE_REG_ADDR	0x08
+#define VOLTAGE_REG_ADDR_SIZE	1		// in bytes
+
+static int stc3117_get_batt_volt(const struct i2c_client *stc_client)
+{
+	int ret, volt = 0;
+	char i2c_tx = VOLTAGE_REG_ADDR, i2c_rx[VOLTAGE_DATA_SIZE] = {0};
+
+	ret = i2c_master_send(stc_client, &i2c_tx, VOLTAGE_REG_ADDR_SIZE);
+	if (ret < 0)
+		return ret;
+
+	ret = i2c_master_recv(stc_client, i2c_rx, VOLTAGE_DATA_SIZE);
+	if (ret < 0)
+		return ret;
+
+	volt = (i2c_rx[1] << 8) + i2c_rx[0];
+	volt *= VOLTAGE_LSB_VALUE;
+
+	return volt;
+}
+
+static int stc3117_get_property(struct power_supply *psy,
+	enum power_supply_property psp, union power_supply_propval *val)
+{
+	struct i2c_client *client = to_i2c_client(psy->dev.parent);
+
+	switch (psp) {
+	case POWER_SUPPLY_PROP_VOLTAGE_NOW:
+		val->intval = stc3117_get_batt_volt(client);
+		break;
+	default:
+		return -EINVAL;
+	}
+	return 0;
+}
+
+static enum power_supply_property stc3117_battery_props[] = {
+	POWER_SUPPLY_PROP_VOLTAGE_NOW,
+};
+
+static const struct power_supply_desc stc3117_battery_desc = {
+	.name = "stc3117-battery",
+	.type = POWER_SUPPLY_TYPE_BATTERY,
+	.get_property = stc3117_get_property,
+	.properties = stc3117_battery_props,
+	.num_properties = ARRAY_SIZE(stc3117_battery_props),
+};
+
+static int stc3117_probe(struct i2c_client *client)
+{
+	struct power_supply_config psy_cfg = {};
+	struct device *dev;
+	struct power_supply *stc_sply;
+
+	dev = &client->dev;
+
+	psy_cfg.of_node = dev->of_node;
+
+	stc_sply = devm_power_supply_register(dev, &stc3117_battery_desc, &psy_cfg);
+	if (IS_ERR(stc_sply))
+		dev_err(dev, "failed to register battery\n");
+
+	return 0;
+}
+
+static const struct i2c_device_id stc3117_id[] = {
+	{"stc3117", 0},
+	{},
+};
+MODULE_DEVICE_TABLE(i2c, stc3117_id);
+
+static const struct of_device_id stc3117_of_match[] = {
+	{ .compatible = "st,stc3117" },
+	{},
+};
+MODULE_DEVICE_TABLE(of, stc3117_of_match);
+
+static struct i2c_driver stc3117_i2c_driver = {
+	.driver = {
+		.name = "stc3117_i2c_driver",
+		.of_match_table = stc3117_of_match,
+	},
+	.probe = stc3117_probe,
+	.id_table = stc3117_id,
+};
+
+module_i2c_driver(stc3117_i2c_driver);
+
+MODULE_LICENSE("GPL");
+MODULE_AUTHOR("Bhavin Sharma <bhavin.sharma@siliconsignals.io>");
+MODULE_AUTHOR("Hardevsinh Palaniya <hardevsinh.palaniya@siliconsignals.io>");
+MODULE_DESCRIPTION("STC3117 Fuel Gauge Driver");
-- 
2.25.1