From patchwork Fri Nov 29 11:40:45 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bhavin Sharma X-Patchwork-Id: 846884 Received: from PNYPR01CU001.outbound.protection.outlook.com (mail-centralindiaazon11020092.outbound.protection.outlook.com [52.101.225.92]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 1CD4B17ADF7; Fri, 29 Nov 2024 11:43:05 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=fail smtp.client-ip=52.101.225.92 ARC-Seal: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732880587; cv=fail; b=t6LZ8L3KAIbHTY+0iVn63+0BYx/lf7hPUgQd0ArLNtltGauKH3DZJW0fdxJlRlLpcbNSOr43WvhGSZgQ0IcAn1Fk0FNdQqHetgAotvKyWRnQT3M+EoQ+jVLVkkM8T6em0sK4MbZtXEDoT09xB5yJKGG/eIPgvO+GDW+ZaPjqix0= ARC-Message-Signature: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732880587; c=relaxed/simple; bh=6X3Dnj6OjIAyvdJzCrwvNKPWcoZ/syWnsPRkA4Zw3Xo=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: Content-Type:MIME-Version; b=oSCpX2JkzHCTYTF7tQqDvEiFaCoBWXo3ur/k8OpMt5MMDHnd0G2YagFn0uKHhpaDBJP9rEJAS6M1gHm6cMyYb7Plus9sjD2KARtQAAtpm05MggOM9IqUKL7B9vwMHeartXHpTM9ZmjrGVMP2KeGE6Qfi6ZrXE0xrwoDqFMai2k8= ARC-Authentication-Results: i=2; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=siliconsignals.io; spf=pass smtp.mailfrom=siliconsignals.io; arc=fail smtp.client-ip=52.101.225.92 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=siliconsignals.io Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=siliconsignals.io ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=R9fbSfCulyCsK/GyBU+LMKkj5aCldhGN00QQXu9dTnpZLc44ZZ6j2VgLN7RQvcJLq3LEC31wtJ3fpazUOqZbzuN189aS2OKXnUdioO6RZA1oEte+CGKfoyTmL3OE2HYxX/ADNOI1LKobS/VPntKjl/djnTgBlgWBhaia1hIoN+I2ZPYhI/e8X9R+x2/4BWNjolHRjC5VFm++qZjQ4ZyInMaQjnRjZ2Zh6UyfdFkpWmePA4/R0Ud20jVeFuNxuZ1oNIvEy+TcRvWmoVrOTKxs1O3f4G3ZfSRIXC3zmpKj2WjdekKeF2U4IuDsVGx7J/to6CMyjAD/w/h0eO1SwDBwwA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=vUbh4EZvl+66eGcbw+s+LGpb0O+CLLHFZURb+SZDcc4=; b=Sq4+WCsML2BcIfOqroqfurgYMu4VmVJpPXj4uz8TSuQ/IDE0kMoBQxlYBnihL58KyigDPmo1Y6xeSAX6GvhpylQnGSKwWXxEYzqyWxQQs43mJjMHX83sPn6zhhcQS9N60a+lHKDVJOZDdj3Rk8kdtRly25xca4kZDMHVZT2sRLRBgl3J++ySToHlslNH6/wIrubanHve6M5dQXdKF0Sef/qqiqshnsPhSN1Q7hMpkwUXK2IBXNEbvTGKzBC3VnMlxEiwS6GgQRCG+2ZzFMkWyumIFDzwI53m/8n7Myox9USqAMTmgfr31fBnOlvKS8dHQw1VY7cyEkwyHdfk2yplhw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=siliconsignals.io; dmarc=pass action=none header.from=siliconsignals.io; dkim=pass header.d=siliconsignals.io; arc=none Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=siliconsignals.io; Received: from MA0P287MB1178.INDP287.PROD.OUTLOOK.COM (2603:1096:a01:fc::7) by PN2P287MB0599.INDP287.PROD.OUTLOOK.COM (2603:1096:c01:15e::6) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8207.15; Fri, 29 Nov 2024 11:43:02 +0000 Received: from MA0P287MB1178.INDP287.PROD.OUTLOOK.COM ([fe80::56b4:3b88:bcc8:b1c2]) by MA0P287MB1178.INDP287.PROD.OUTLOOK.COM ([fe80::56b4:3b88:bcc8:b1c2%7]) with mapi id 15.20.8207.010; Fri, 29 Nov 2024 11:43:02 +0000 From: Bhavin Sharma To: sre@kernel.org, krzk+dt@kernel.org Cc: Bhavin Sharma , Hardevsinh Palaniya , Rob Herring , Conor Dooley , linux-pm@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v5 1/2] dt-bindings: power: supply: Add STC3117 Fuel Gauge Date: Fri, 29 Nov 2024 17:10:45 +0530 Message-ID: <20241129114200.13351-2-bhavin.sharma@siliconsignals.io> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20241129114200.13351-1-bhavin.sharma@siliconsignals.io> References: <20241129114200.13351-1-bhavin.sharma@siliconsignals.io> X-ClientProxiedBy: PN2PR01CA0086.INDPRD01.PROD.OUTLOOK.COM (2603:1096:c01:23::31) To MA0P287MB1178.INDP287.PROD.OUTLOOK.COM (2603:1096:a01:fc::7) Precedence: bulk X-Mailing-List: linux-pm@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: MA0P287MB1178:EE_|PN2P287MB0599:EE_ X-MS-Office365-Filtering-Correlation-Id: 9d1bd618-8fae-42b0-75c0-08dd106afb3a X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; ARA:13230040|366016|52116014|1800799024|376014|38350700014; X-Microsoft-Antispam-Message-Info: z6DSYohEo5qGmNCFR5EIqmuhU9aB6YKk605YRpyBVGhiRnaNxm1xi7ru4ra9nAVx1vn1saOifA+/IFN/UM81UoZ901wdrj9nbLggibCDWlh0yI4q/pn4ZVtbNcW9vbVnFWKMq2OH6+lDeSOJIlMGLVXa56ZHO1HkKpixuu36EbGoqJUsCkxB0CMm4Pkzhblgo6wdgmHt2zJ9GrwikWp0VAtj7v/lszRQDhn8B36hiOk56fZ++jp7asUMGflFCZZYPOP1LccE0Nk8wlwDGxNudLPKKdIP4kJHhZ/GDPZvvziwo+U6ZM8tIS9QFudmUS2X9NUeIQwSZAsbqgNrq+1boUsbnapVOWbto2rhppm5LLBxMcO+uVpvZ8B9vbPvZeGXWr2YgHMNcGaIbua0Fh2EwFhaYYCIF7RQ+KnejYwJBRLm9kAiluJAcV9x4iqoL9rSXST/Ft+17H8ysHEQjQgAtMDWkGR1kY6jxqwvPgdT5ZjEEZwP3P5ssuuaMumfEePEfYLsG1hmvXR8SbbAhtwQukSeaE5VLERI9833QYWHI7goPO2EkGvT3+LAF8llQjUjo1EMWNjkSgrM7xtRmg5x/u+MZBiWjzdQicaz9Z4HkTjGkfB02HHSux6LFOtGBFR+ZaSjIC7/vy3j46zust5gBbPFIINnp0i+4fr4fpxjnWKGwylHuwkSlzzXpX6vt7749yBOjAshBFGVPxd+cOKmc5/H66NGS3IVJJkrmsxUzldj0wCZVdMfrcdoI2N/7RpYaDVMKyolgEfRtYIt38PIUmIZZRFXCiJmP7S+ojcHcR9Cp9RhW81j8zgMAW/e8fEUdZYLFmpGVvWA78+Ll5q4Qi4xJIv5RHuQMrDbElbKbtygPge+pRIe6nMuuTWeVUzD8aacx3otlTAYgdvy+dea5SQtObD/5jUMi1VYbj7bjMYXbp9kQ6Z7f4o+sgCmUbSPGYfS3jBZjU64R6HxRlUe3rDz8JAWAMyGzsq0JqO2n1r5qx2mDHSEYJga852GbA8a1+d1X43m0wS0vkK0/G5O0MET1q3QRgy8YTc5XQ2/BMrc9AaBSde6cHuAJrgAWiwfxZRKV9qZin6/QrsnRUcz5O6iumYx3WGZ33HaqxK+iUgGTl1dJzkKJrBFvGTp5fSMA7oAeBo/etlHUrpCbAcGjrUa+sZtXbmr9ZzHknAKBMR20RodW4T8YXXfB0sXw2iPKz+2X31tukTA4cpO0LV4Jiyl/PjZQ9RRDvtn7lUcdo9KkDZka1Ak5mIEkrNQYCEbaSWqpzvm9ynBtJkd4MybdVbOLqNo+1ICWULYy7XoXPv5lUg4no2NCJVBY1xm6HzAvALCTtLHbj7Cfsd7qcr/9NWq/lnUHU57e2UNG4CFYxg= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:MA0P287MB1178.INDP287.PROD.OUTLOOK.COM; PTR:; CAT:NONE; SFS:(13230040)(366016)(52116014)(1800799024)(376014)(38350700014); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: fq5koiwXfj7m13k/jiQ0DEikTl+s3tUX8hl5h4xkVchonWZTws8FfsmIn4Omd9Zwlg81jwmpnH96MIEaHDp5Pg9kxWbbP5LzA+D42bBVgy6F081h2M/TbAjaPcRmOvV/JvB2EDJH8xHy5GaU7/xq+iUsm72s8zIdsgItWgpWwfxG6rRYmsH3QZyHKPCYRmDC75BrCncYBbBWHBGrE2OhSFKFIfv40OAJuvYDxNBVPo6jH109IPuCdgl1kz7tCM/sOlNf/6pUQVf+1b15Cwh+SbBXLd9a1byBvDkAdABWk7wIQoOPQKR6wioyMmGTexk2igWdNljP2Idjg8o9eq03T8FufIwQPhvO45pGFiLDmL96P1FUf//iEfBQ0xwCXTl29TVHM7JwshQ6Q2TcdzvyTbwgU9uWzJQDilFek7EX6IFZfsbvUMpEBQZyfHhBCqvPNeTDNbOISuWZfIzhWSwAdicngo/mPbz3HX2z/ykSU2CVg5URFzvhgemtEtpgB2ez3dTPQA9IiXl2TYXkp4/p2UP5BZdzL6vFiSbcs5R0hQY+JR8dSpQSJjyacNSdID8ECSMsuA8dczMQdAbrFU5ER9T0G2krln9OcLi/45EsSc0tyr0spe+QaQUDRCnprv8ESak/Dq/xK6fDcAsZTVHDmoB2Hv3vsmTECEA2p/VORPSrEt5bgPL1wokufFjK/yAnxZbNkHw4M97toEsvjnxvcISMTVdYseyIpkiQPgByjZAE7Yup9dwacTQAHqkSYxur/LgY0QNqFA+4yViDEqzyYM/t8tC0SG37dVkawgDOmLgf8vpFaQa2qMPTIpl3Q2dVLWUPdC8U2zYd+iBB+nWy79wXCrxp2PMXc4FJxsYkROLWmNUXmgMI6rLOaYA3ziRIr3LdJLVB4zVmfoHyggnfNURI+s4EX/vjePKCwi7om3mVEJPSNc/k3OdEkU/AQLB3vNoeYxVznvYvOWQtGjskrCCEJ+ZkNXC8KqhzPQsszrR3p7OZdNko/GCbc0c3i1OeutR1B623TpxsW9aTsg+137zulmkGtsvvG4+ybijq+hBLbPoFuRPRbEoCmCG+srWy0hPiule/bS6xFHnoQuhydj2ZzcH+UwPPNODpiI7gtG0v+ctVbjcINtxbQVF0JaeFSsFOYvy6VlVjUVxI65G1bCCiL2QWDK0hDlS6DQJqQ167KV+KRlBEG3aX57StZEWpr6UKGKTmcvLhdNPSFF4PaZDBI/4r5c9Ugd0OJCLCADd4AqGZUBMMQ72m9K4DL5aPWjaGiqllfkgyC298OSGkFqkipxDSTLyzGc+eh3C6G3e71AG1UPy5PJqYetFB8haFHG63BMSme0RO0Evy9Hr+gb48kuwbW1fopXec4NTex3jIQoRJ7SFK5obd0M6oKiipFkKln/VDZx2zyUdb3xmhMJYZuN+QpJTYO9CTLOBWOgLX6wprEBSE7KT+8QqT4AJLQhkApEFXNHbMTBtN1bSR6dG1/0vrFN9giNMvVH0LB+fNRUHqA33PMq2tzUrHgPCNqVaRvNnftBpwMsgHK0jO10cIqCyd1C/2qG131YW9fdjNyPtDAHHAVGnNzL3PIbCiX9SjjRAh/JLOmw/DOY7nhqtL5PMIEQVh2b0GMW2OlZo= X-OriginatorOrg: siliconsignals.io X-MS-Exchange-CrossTenant-Network-Message-Id: 9d1bd618-8fae-42b0-75c0-08dd106afb3a X-MS-Exchange-CrossTenant-AuthSource: MA0P287MB1178.INDP287.PROD.OUTLOOK.COM X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 Nov 2024 11:43:02.5853 (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: 0jEUpQyKo2sJXS7hoEZFbAgGOnW0P9jIMtVQQYiftSt3GuIdfQMj1A7gFhzararWx6Rgakdza4+1rSEjQUoBWAqeYO7zRxDSKqczRJojbrg= X-MS-Exchange-Transport-CrossTenantHeadersStamped: PN2P287MB0599 The STC3117 provides a simple fuel gauge via I2C. Add a DT schema to describe how to set it up in the device tree. Signed-off-by: Hardevsinh Palaniya Signed-off-by: Bhavin Sharma --- .../bindings/power/supply/st,stc3117.yaml | 81 +++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 Documentation/devicetree/bindings/power/supply/st,stc3117.yaml diff --git a/Documentation/devicetree/bindings/power/supply/st,stc3117.yaml b/Documentation/devicetree/bindings/power/supply/st,stc3117.yaml new file mode 100644 index 000000000000..274e57be4bc6 --- /dev/null +++ b/Documentation/devicetree/bindings/power/supply/st,stc3117.yaml @@ -0,0 +1,81 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/power/supply/st,stc3117.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: STMicroelectronics STC3117 Fuel Gauge Unit Power Supply + +maintainers: + - Hardevsinh Palaniya + - Bhavin Sharma + +description: | + The STC3117 includes the STMicroelectronics OptimGauge algorithm. + It provides accurate battery state-of-charge (SOC) monitoring, tracks + battery parameter changes with operation conditions, temperature, + and aging, and allows the application to get a battery state-of-health + (SOH) indication. + + An alarm output signals low SOC or low voltage conditions and also + indicates fault conditions like a missing or swapped battery. + + Datasheet is available at + https://www.st.com/resource/en/datasheet/stc3117.pdf + +allOf: + - $ref: power-supply.yaml# + +properties: + compatible: + enum: + - st,stc3117 + + reg: + maxItems: 1 + + monitored-battery: + description: | + The fuel gauge uses the following battery properties: + - charge-full-design-microamp-hours + - voltage-min-design-microvolt + - voltage-max-design-microvolt + + sense-resistor: + $ref: /schemas/types.yaml#/definitions/phandle + description: Current sense resistor in milliohms + maxItems: 1 + + interrupts: + maxItems: 1 + +required: + - compatible + - reg + - monitored-battery + - sense-resistor + +unevaluatedProperties: false + +examples: + - | + i2c { + #address-cells = <1>; + #size-cells = <0>; + + bat: battery { + compatible = "simple-battery"; + charge-full-design-microamp-hours = <2600000>; + voltage-min-design-microvolt = <3300000>; + voltage-max-design-microvolt = <4250000>; + }; + + battery@70 { + compatible = "st,stc3117"; + reg = <0x70>; + interrupt-parent = <&gpio0>; + interrupts = <31 IRQ_TYPE_LEVEL_LOW>; + monitored-battery = <&bat>; + sense-resistor = <10>; + }; + }; From patchwork Fri Nov 29 11:40:46 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bhavin Sharma X-Patchwork-Id: 846238 Received: from MA0PR01CU012.outbound.protection.outlook.com (mail-southindiaazon11021095.outbound.protection.outlook.com [40.107.57.95]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A01FA19ABA3; Fri, 29 Nov 2024 11:43:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=fail smtp.client-ip=40.107.57.95 ARC-Seal: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732880598; cv=fail; b=gd//Y/wKVKg9Tno1N5+gmkpZge1v2zdNh938e/JwA1iGn9AKM5m5+rliCLzHgnnfLGjEfMhjx+bUlSSpyb6pTQc02yFYsZ271vQoYSfzPLKkLblS9xbZe+4W+aMe7NjnlBLlvscgzC51OBbFviirlUI6QmmXCgPKyOeDY76aorw= ARC-Message-Signature: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732880598; c=relaxed/simple; bh=04mZzVFSqGcLveK0OM0Hngjt74sCh86V9x/EcmCuQYE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: Content-Type:MIME-Version; b=CkEySIKgMy+hbku1fqHHs9qJ9jiwjGJw2PRDt8+I9Qlmw+S11KFm68QdQ1CZJEgd6vHXHVnr7HvJ6Hmx3cnN4FqFfXB3qH/vGP2DZeTolkqY2/48uypACGJHq/jj8+eyGzqspzI9hZTGjhoKv5x5EiTbnshNMsLYHV2OsGw7w6E= ARC-Authentication-Results: i=2; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=siliconsignals.io; spf=pass smtp.mailfrom=siliconsignals.io; arc=fail smtp.client-ip=40.107.57.95 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=siliconsignals.io Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=siliconsignals.io ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=BV+e+vw89AD/xbKXDMPMU9rq7ARi3BpzJ6wS1dV5mJCYO3oilmwcjAV0PzUNFnb/eg8hc1VBp/MHa8w9yvJNqxjWHvDJhydHZfaRBSo5Fk8OeK/1ALNcXJkpEgMEIh6C/qSjxrNk9gOkulZZ5KfvEPKpMD8XuLPIwV1ChigYZlv1WxuhQg7oHK7IBpQ6NsNAo2hackqvaWazlsf+EWzZqFJPZPAeduV6SjAhsqxs2ozQK4Q6H3fFHvDWL6lTAAvXq8Caf61IgWIgL+6YpO+O2IonPHe4YVQ2xoxthTvfU3uBUKkAvVPIkuhIFjT+V1xx4lxZC2qmmJ6ZRpcPovPJNw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=C3QIHRwATYd6NaxRsKTguI1GNodt8KvJlgFnK1hVfIg=; b=PDr2EuPJbf7da4dTfzMexUgdf2VlgyTumBpl5sa8hMZv27eRBJN5ahLiEWP/H0d9httBwacRaaoBz+VDIDmdmOoRSd7uoq5XozAJMjYxaUS04Q5CjsDsp04tyYq+1vBJjfOZHdDr5AiCv8KapTYFYbbYk8AanbcyYz8r2BexTMfY2f55bTkugF50/SMl9sp8CgyQNS6JVajYnefZJZ89/ddSWBzjCsSkOBVkvJwiYJBZQNG//nKU6Cz3qmfSrCeBS4A8yt1fWBn2jUtbUx43bArJ1qVIoVVL8lDNf2m4H30L9c/fmy0ob2Ug7dqbySLhwH43IFW4LGc8dpI0G6gRSA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=siliconsignals.io; dmarc=pass action=none header.from=siliconsignals.io; dkim=pass header.d=siliconsignals.io; arc=none Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=siliconsignals.io; Received: from MA0P287MB1178.INDP287.PROD.OUTLOOK.COM (2603:1096:a01:fc::7) by PN3P287MB1729.INDP287.PROD.OUTLOOK.COM (2603:1096:c01:19c::13) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8207.14; Fri, 29 Nov 2024 11:43:11 +0000 Received: from MA0P287MB1178.INDP287.PROD.OUTLOOK.COM ([fe80::56b4:3b88:bcc8:b1c2]) by MA0P287MB1178.INDP287.PROD.OUTLOOK.COM ([fe80::56b4:3b88:bcc8:b1c2%7]) with mapi id 15.20.8207.010; Fri, 29 Nov 2024 11:43:11 +0000 From: Bhavin Sharma To: sre@kernel.org, krzk+dt@kernel.org Cc: Bhavin Sharma , Hardevsinh Palaniya , Rob Herring , Conor Dooley , linux-pm@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v5 2/2] power: supply: Add STC3117 fuel gauge unit driver Date: Fri, 29 Nov 2024 17:10:46 +0530 Message-ID: <20241129114200.13351-3-bhavin.sharma@siliconsignals.io> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20241129114200.13351-1-bhavin.sharma@siliconsignals.io> References: <20241129114200.13351-1-bhavin.sharma@siliconsignals.io> X-ClientProxiedBy: PN2PR01CA0086.INDPRD01.PROD.OUTLOOK.COM (2603:1096:c01:23::31) To MA0P287MB1178.INDP287.PROD.OUTLOOK.COM (2603:1096:a01:fc::7) Precedence: bulk X-Mailing-List: linux-pm@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: MA0P287MB1178:EE_|PN3P287MB1729:EE_ X-MS-Office365-Filtering-Correlation-Id: 5ac6dd1f-fad8-4cdf-e9c2-08dd106b0040 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; ARA:13230040|1800799024|366016|52116014|376014|38350700014; X-Microsoft-Antispam-Message-Info: SA1o344pOavlYLC5UzbhUf84L85zXtpSqx2hcFXNLRw4KqUdjbLmFwnGSfPouuy2Tb9GerepYdgOModutyggOY8u+fwjH/YGYu3418m0ZJNsZPAPc8wz17T2inb/EchKJR+3a1gQbBcQaFkly0fXFWbDdhQilS1gPuIWX+LHiCLTXaRpJwFWkszAHqsWBTsXgez+BxnFnhull2/7JejhZ+YbPBmyegoXQqHHfpakC8K1Ps9LLcfJrryFdayUmvbM6J+AYlD6oThdQ94pA1tEUSEXLmsnOca6D5+Ybbyqj/Mfne+7Jghrh1oTcablvVuUoRB90sHrC7im/QasLn6vlQj6as2nAWqXPcguoTEHb99zSbDnbGZHugODAfWy/miQZT3EIIZAmdPbOH1Hli0RvIoRk1cSXaMxW3yO9BUp1HciKv44PBJepRrH4INU/I+iyDe2UUwBOaVnQ2N/S9V1rVWC4E5gqT+9Ms4XABWaHWFK9ypZvLMbsFhw8WnMC7SRhVGB1hxYTiIGnVV2tYXx6SN7mnGHycejjlUUQqWa/PkTFRsQ+tQJehhOzuvW3Y4vGA+Qfsqz6jCiY9VCXeMHCXGFHnWMCuYqIvAry8T5lajVydVBm8G/aJTaw/QbGoXpmPL+qKPEVJrjFTgEQQ4dTdjJyqFTiyJKzQKB0i0VwMrh3TF/iTPKDz8ZoIlu+HEhk7y/tVx78+kSL1TuvYWcezzWA0zcmVqKv7kj8b0cGjJP9Ah/Kik+BPduh5uaYrxzDdFyW+8J9VOO3VfRQjmdqn2gGuleVo7HQ+l+eelxcePNaAjDQ1Hrixt439tKa32KTrRvzB5pg9FIg3f71bBpLMnKghZbOTESq2BLus8uDFyeEN26GIbK0vb2tBbp6NkDGuUHgXj7a8fn8/u7ntlfIIHFlqreaNwpAWHkMvuLrd8idVrvq1jhiRnCuNIKLyGU6wbpDH2IeBK1Z/hfa95YJdj3hewmR9XBEl4aXNXwMPZw9MnSvfrwQRf0B/TRJY3939a5COBJHtVraRE0MXhVQKh6BKEkWl2Ns6cEsYzTqE45lImTRLtspBbuG9ny0FsuS0v+qgT1TIPFyXNcURk0PEXeyWAoTBJidxBMVxj0t0DFR2O7jRl2uq739Hh5rwhGet57bESF699vStPAs6zE23IbDUk6Yz39I8SniYjMC8eJqkzrsvrpyXcKUJ/ZdG1zWiwBT6Rhc0KQH4bzNl4svW1uSdEkNkhGEIwGT/xnSNxiwH3MQ+MC4vgL2J40RAnC/UHUTZ5Wxa0Z8AwPqKJ4qkt0ELz2GnoEH6gWoYJpCKUe7GO7Mz9OSMlMIT+DVu8a771mobGImf5RXuPU3geigVYJ9vOfmWdJY7TuYjLhx9ZTiuG57HAh24EfZLPnBYxvQZyw1dHYPAu6GJhX6dcTzg== X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:MA0P287MB1178.INDP287.PROD.OUTLOOK.COM; PTR:; CAT:NONE; SFS:(13230040)(1800799024)(366016)(52116014)(376014)(38350700014); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: qPOFJsf7fsBDFb8V5bMy/BYmxM3dT3o7pWtGFChoqvA7NIdbO8iTw/THOfkmktAG5mt49XQXf3mvNkLpmDtKLp6/CS/5k7Oap965azXE2k29Wisu3zwrTDCfWqGmK/+DkoiW27DhVCvPu93OnkfWG0Y1dz48OCYdbvxDjbRHyihFlZxX+DDnIciKdvOU48mCqSooyXGWEIk7p548vklcDZC74edeNV2Kh70hJdFujcmByNVJ4n7suRFk4qkoJ1W3xG6MEJARzIVVTPzyLyddQleXjBKJoCdbBf34qFoRpsWOrd4r9FlEr8kGGGUbzYmUbbYa/uo8sF4Rx7hBbVfb5xtq7bWaR7zTfJ/yT2Ib/AgbVozQPOeQR/1HTqqNaGEmtYd9xE1otrNoiMs2BwSShUlg9PdFLJHGSXXJXK/Sq4HMBQ8lsv7XWjZCjFDBNci5haM5UEuTlduEs4iDSL1PwBM2oMVQ5+9PKCv5U+qbXOZgpcYxeKCfJm4LDd4lc1ViqC+aUV4BAG4vY4Of2yHcFM5dCmtgmgbTi8QB8clgCbSNfV8yJWr6ANSKbMclYtni8rkWYUfxxmjmkbOtBo7V/KACTlCHyudzuWNE8ZdBOIXAwHhH19Jcwx0UclDbAt+c8AU+6QV8Mssk2dXgOUl8liEZTdwX+FqMguxzsPab8TZ6UUYygF22pBwhh+Ch4XqNS9mLpn5f+iz8wYuHCfDTJ+CmQCFpiwX4e1bfYpRkPR/SxVQucMx1N8L2J3EMD+PJSVlciO4psRW4yCKJO91vQ8uAdE+8jZVYi6wyRBfEleH/+FmakD5IdCAHurn9Qwvt73BBoI8KzUOEdFZ4Ax2iLyeCRrd1m+tBRwqG1noUG9cF0ipxlonayhitJJMKThyBpt9BnPKXKnp98ZQ7jfDeyDEeQgymoTEhT9h1Pl4OwsLLZxIri4zQJi1wCkstp3wOpIKcsCEFbQ2WiuP9wSM31WF80vSKPmJbZVX9GwMzoeAKoF/FuZQCX3CTV5DPRcNMpinZt2g7HBL36yFLw9z7n/P6LX4GqDT5ie2IKloMspkXe32zzvRctBg2nspCcY9cEP1M/6QJhkuYLI7QZDovXpZw7ZVTADo2nOnMS1DIhJuHPVgUGEg4CptBZgnIjMc732f4TglSn9yX5kGYQgio2XTK3K18C8D1BP/OLBOyLqGtV31KAkON4KpjSuNLHBtxDAtoGJPuLA0zGpbt83FVBS6T+CD21FZlw3YzQtHRb0IkOhJpHAGp/Qng1HHjOqrjTDzF93cTC/PP8Jjtl8zep2nbsyEFKECbEEX+tSu7AY7IUmn1coLz06CyDsmKmNGELAbFKzp6KECdIORWhe8RdPznuehfl2RxvTyzkrjXfnpF1kpR6CsFSxYyzvdCXEdoX4ia73oKVXMNqSGIpMEluHLaq9pWTHWXPTrquN5/xtxaaLc+HRgNnYNbA+vARVQyNGrLBK8+BL11bqv6B8Vj3yzelH1UD1HKBfRjxMtMCzESt8ofYeMAMlkNewb1KAQzQKzJamFAdrU5KhiLpXypv2oknmysn/i1Gk7WhIEX9+W9nzzfcWsAWX5Otp3x8hbj+oMlmRNzXO/La/FvLvtgOfu9rRGtithCiq7DWoY6UHc= X-OriginatorOrg: siliconsignals.io X-MS-Exchange-CrossTenant-Network-Message-Id: 5ac6dd1f-fad8-4cdf-e9c2-08dd106b0040 X-MS-Exchange-CrossTenant-AuthSource: MA0P287MB1178.INDP287.PROD.OUTLOOK.COM X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 Nov 2024 11:43:11.0089 (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: zxU7g2U+sH/2BSYItcMtIIJFfPLHTsYPTmZQ+Cc7E8/HSzUi5RSXG4Wero4t5YQvqnnBYSdlKDfWbpr9aFWMsYTDzEZJdXMrUg2+PjDeFRM= X-MS-Exchange-Transport-CrossTenantHeadersStamped: PN3P287MB1729 Adds initial support for the STC3117 fuel gauge. The driver provides functionality to monitor key parameters including: - Voltage - Current - State of Charge (SOC) - Temperature - Status Signed-off-by: Bhavin Sharma Signed-off-by: Hardevsinh Palaniya --- MAINTAINERS | 8 + drivers/power/supply/Kconfig | 7 + drivers/power/supply/Makefile | 1 + drivers/power/supply/stc3117_fuel_gauge.c | 665 ++++++++++++++++++++++ 4 files changed, 681 insertions(+) create mode 100644 drivers/power/supply/stc3117_fuel_gauge.c +++ b/drivers/power/supply/stc3117_fuel_gauge.c @@ -0,0 +-2,662 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * stc3117_fuel_gauge.c - STMicroelectronics STC3117 Fuel Gauge Driver + * + * Copyright (c) 2024 Silicon Signals Pvt Ltd. + * Author: Bhavin Sharma + * Hardevsinh Palaniya + */ + +#include +#include +#include +#include +#include + +#define STC3117_ADDR_MODE 0x00 +#define STC3117_ADDR_CTRL 0x01 +#define STC3117_ADDR_SOC_L 0x02 +#define STC3117_ADDR_SOC_H 0x03 +#define STC3117_ADDR_COUNTER_L 0x04 +#define STC3117_ADDR_COUNTER_H 0x05 +#define STC3117_ADDR_CURRENT_L 0x06 +#define STC3117_ADDR_CURRENT_H 0x07 +#define STC3117_ADDR_VOLTAGE_L 0x08 +#define STC3117_ADDR_VOLTAGE_H 0x09 +#define STC3117_ADDR_TEMPERATURE 0x0A +#define STC3117_ADDR_AVG_CURRENT_L 0X0B +#define STC3117_ADDR_AVG_CURRENT_H 0X0C +#define STC3117_ADDR_OCV_L 0X0D +#define STC3117_ADDR_OCV_H 0X0E +#define STC3117_ADDR_CC_CNF_L 0X0F +#define STC3117_ADDR_CC_CNF_H 0X10 +#define STC3117_ADDR_VM_CNF_L 0X11 +#define STC3117_ADDR_VM_CNF_H 0X12 +#define STC3117_ADDR_ALARM_soc 0X13 +#define STC3117_ADDR_ALARM_VOLTAGE 0X14 +#define STC3117_ADDR_ID 0X18 +#define STC3117_ADDR_CC_ADJ_L 0X1B +#define STC3117_ADDR_CC_ADJ_H 0X1C +#define STC3117_ADDR_VM_ADJ_L 0X1D +#define STC3117_ADDR_VM_ADJ_H 0X1E +#define STC3117_ADDR_RAM 0x20 +#define STC3117_ADDR_OCV_TABLE 0x30 +#define STC3117_ADDR_SOC_TABLE 0x30 + +/* Bit mask definition */ +#define STC3117_ID 0x16 +#define STC3117_MIXED_MODE 0x00 +#define STC3117_VMODE BIT(0) +#define STC3117_GG_RUN BIT(4) +#define STC3117_CC_MODE BIT(5) +#define STC3117_BATFAIL BIT(3) +#define STC3117_PORDET BIT(4) +#define STC3117_RAM_SIZE 16 +#define STC3117_OCV_TABLE_SIZE 16 +#define STC3117_RAM_TESTWORD 0x53A9 +#define STC3117_SOFT_RESET 0x11 +#define STC3117_NOMINAL_CAPACITY 2600 + +#define VOLTAGE_LSB_VALUE 9011 +#define CURRENT_LSB_VALUE 24084 +#define APP_CUTOFF_VOLTAGE 2500 +#define MAX_HRSOC 51200 +#define MAX_SOC 1000 +#define CHG_MIN_CURRENT 200 +#define CHG_END_CURRENT 20 +#define APP_MIN_CURRENT (-5) +#define BATTERY_FULL 95 +#define CRC8_POLYNOMIAL 0x07 +#define CRC8_INIT 0x00 + +DECLARE_CRC8_TABLE(stc3117_crc_table); + +enum stc3117_state { + STC3117_INIT, + STC3117_RUNNING, + STC3117_POWERDN, +}; + +enum stc3117_status { + BATT_LOWBATT = -2, + BATT_DISCHARG, + BATT_IDLE, + BATT_FULCHARG, + BATT_ENDCHARG, + BATT_CHARGING, +}; + +/* Default ocv curve Li-ion battery */ +static const int ocvValue[16] = { + 3400, 3582, 3669, 3676, 3699, 3737, 3757, 3774, + 3804, 3844, 3936, 3984, 4028, 4131, 4246, 4320 +}; + +static union stc3117_internal_ram { + u8 ram_bytes[STC3117_RAM_SIZE]; + struct { + u16 testword; /* 0-1 Bytes */ + u16 hrsoc; /* 2-3 Bytes */ + u16 cc_cnf; /* 4-5 Bytes */ + u16 vm_cnf; /* 6-7 Bytes */ + u8 soc; /* 8 Byte */ + u8 state; /* 9 Byte */ + u8 unused[5]; /* 10-14 Bytes */ + u8 crc; /* 15 Byte */ + } reg; +} ram_data; + +struct stc3117_data { + struct i2c_client *client; + struct regmap *regmap; + struct delayed_work update_work; + struct power_supply *battery; + + u8 soc_tab[16]; + int cc_cnf; + int vm_cnf; + int cc_adj; + int vm_adj; + int avg_current; + int avg_voltage; + int batt_current; + int voltage; + int temp; + int soc; + int ocv; + int hrsoc; + int presence; + int battery_state; +}; + +struct stc3117_battery_info { + int voltage_min; + int voltage_max; + int battery_capacity; + int sense_resistor; +} battery_info; + +static int STC3117_convert(int value, int factor) +{ + value = (value * factor) / 4096; + return value; +} + +static int stc3117_get_battery_data(struct stc3117_data *data) +{ + u8 reg_list[16]; + u8 data_adjust[4]; + int value, mode; + + regmap_bulk_read(data->regmap, STC3117_ADDR_MODE, + reg_list, sizeof(reg_list)); + + /* soc */ + value = (reg_list[3] << 8) + reg_list[2]; + data->hrsoc = value; + data->soc = (value * 10 + 256) / 512; + + /* cureent in mA*/ + value = (reg_list[7] << 8) + reg_list[6]; + data->batt_current = STC3117_convert(value, + CURRENT_LSB_VALUE / battery_info.sense_resistor); + + /* voltage in mV */ + value = (reg_list[9] << 8) + reg_list[8]; + data->voltage = STC3117_convert(value, VOLTAGE_LSB_VALUE); + + /* temp */ + data->temp = reg_list[10]; + + /* Avg batt_current in mA */ + value = (reg_list[12] << 8) + reg_list[11]; + regmap_read(data->regmap, STC3117_ADDR_MODE, &mode); + if (!(mode & STC3117_VMODE)) { + value = STC3117_convert(value, CURRENT_LSB_VALUE / 10); + value = value / 4; + } else { + value = STC3117_convert(value, 36 * STC3117_NOMINAL_CAPACITY); + } + data->avg_current = value; + + /* ocv */ + value = (reg_list[14] << 8) + reg_list[13]; + value = STC3117_convert(value, VOLTAGE_LSB_VALUE); + value = (value + 2) / 4; + data->ocv = value; + + /* CC & VM adjustment counters */ + regmap_bulk_read(data->regmap, STC3117_ADDR_CC_ADJ_L, + data_adjust, sizeof(data_adjust)); + value = (data_adjust[1] << 8) + data_adjust[0]; + data->cc_adj = value; + + value = (data_adjust[3] << 8) + data_adjust[2]; + data->vm_adj = value; + + return 0; +} + +static int stc3117_update_battery_status(struct stc3117_data *data) +{ + switch (data->battery_state) { + case BATT_CHARGING: + if (data->avg_current < CHG_MIN_CURRENT) + data->battery_state = BATT_ENDCHARG; + break; + + case BATT_ENDCHARG: + if (data->batt_current > CHG_MIN_CURRENT) + data->battery_state = BATT_CHARGING; + else if (data->avg_current < CHG_END_CURRENT) + data->battery_state = BATT_IDLE; + else if ((data->batt_current > CHG_END_CURRENT) && + (data->voltage > battery_info.voltage_max)) + data->battery_state = BATT_FULCHARG; + break; + + case BATT_FULCHARG: + if ((data->batt_current > CHG_MIN_CURRENT)) + data->battery_state = BATT_CHARGING; + else if (data->avg_current < CHG_END_CURRENT) { + if (data->avg_voltage > battery_info.voltage_max) + { + regmap_write(data->regmap, STC3117_ADDR_SOC_H, + (MAX_HRSOC >> 8 & 0xFF)); + regmap_write(data->regmap, STC3117_ADDR_SOC_L, + (MAX_HRSOC & 0xFF)); + data->soc = MAX_SOC; + } + data->battery_state = BATT_IDLE; + } + break; + + case BATT_IDLE: + if (data->batt_current > CHG_END_CURRENT) + data->battery_state = BATT_CHARGING; + else if (data->batt_current < APP_MIN_CURRENT) + data->battery_state = BATT_DISCHARG; + break; + + case BATT_DISCHARG: + if (data->batt_current > APP_MIN_CURRENT) + data->battery_state = BATT_IDLE; + else if (data->avg_voltage < battery_info.voltage_min) + data->battery_state = BATT_LOWBATT; + break; + + case BATT_LOWBATT: + if (data->avg_voltage > (battery_info.voltage_min + 50)) + data->battery_state = BATT_IDLE; + break; + + default: + data->battery_state = BATT_IDLE; + } + + return 0; +} + +static int ram_write(struct stc3117_data *data) +{ + int ret; + + ret = regmap_bulk_write(data->regmap, STC3117_ADDR_RAM, + ram_data.ram_bytes, STC3117_RAM_SIZE); + if (ret) + return ret; + + return 0; +}; + +static int ram_read(struct stc3117_data *data) +{ + int ret; + + ret = regmap_bulk_read(data->regmap, STC3117_ADDR_RAM, + ram_data.ram_bytes, STC3117_RAM_SIZE); + if (ret) + return ret; + + return 0; +}; + +static int stc3117_set_para(struct stc3117_data *data) +{ + int ret; + + ret = regmap_write(data->regmap, STC3117_ADDR_MODE, STC3117_VMODE); + + for (int i = 0; i < STC3117_OCV_TABLE_SIZE; i++) + regmap_write(data->regmap, STC3117_ADDR_OCV_TABLE + i, + ocvValue[i] * 100 / 55); + if (data->soc_tab[1] != 0) + regmap_bulk_write(data->regmap, STC3117_ADDR_SOC_TABLE, + data->soc_tab, STC3117_OCV_TABLE_SIZE); + + ret |= regmap_write(data->regmap, STC3117_ADDR_CC_CNF_H, + (ram_data.reg.cc_cnf >> 8) & 0xFF); + + ret |= regmap_write(data->regmap, STC3117_ADDR_CC_CNF_L, + ram_data.reg.cc_cnf & 0xFF); + + ret |= regmap_write(data->regmap, STC3117_ADDR_VM_CNF_H, + (ram_data.reg.vm_cnf >> 8) & 0xFF); + + ret |= regmap_write(data->regmap, STC3117_ADDR_VM_CNF_L, + ram_data.reg.vm_cnf & 0xFF); + + ret |= regmap_write(data->regmap, STC3117_ADDR_CTRL, 0x03); + + ret |= regmap_write(data->regmap, STC3117_ADDR_MODE, + STC3117_MIXED_MODE | STC3117_GG_RUN); + + return ret; +}; + +static int stc3117_init(struct stc3117_data *data) +{ + int ID, ret; + int ctrl; + int ocv_m, ocv_l; + + regmap_read(data->regmap, STC3117_ADDR_ID, &ID); + if (ID != STC3117_ID) + return -EINVAL; + + data->cc_cnf = (battery_info.battery_capacity * + battery_info.sense_resistor * 250 + 6194) / 12389; + data->vm_cnf = (battery_info.battery_capacity * 200 * 50 + 24444) / 48889; + + /* Battery has not been removed */ + data->presence = 1; + + /* Read RAM data */ + ret = ram_read(data); + if (ret) + return ret; + + if ((ram_data.reg.testword != STC3117_RAM_TESTWORD) || + (crc8(stc3117_crc_table, ram_data.ram_bytes, + STC3117_RAM_SIZE, CRC8_INIT)) != 0) + { + ram_data.reg.testword = STC3117_RAM_TESTWORD; + ram_data.reg.cc_cnf = data->cc_cnf; + ram_data.reg.vm_cnf = data->vm_cnf; + ram_data.reg.crc = crc8(stc3117_crc_table, ram_data.ram_bytes, + STC3117_RAM_SIZE - 1, CRC8_INIT); + + ret = regmap_read(data->regmap, STC3117_ADDR_OCV_H, &ocv_m); + + ret |= regmap_read(data->regmap, STC3117_ADDR_OCV_L, &ocv_l); + + ret |= stc3117_set_para(data); + + ret |= regmap_write(data->regmap, STC3117_ADDR_OCV_H, ocv_m); + + ret |= regmap_write(data->regmap, STC3117_ADDR_OCV_L, ocv_l); + if (ret) + return ret; + } else { + ret = regmap_read(data->regmap, STC3117_ADDR_CTRL, &ctrl); + if ((ctrl & STC3117_BATFAIL) != 0 || (ctrl & STC3117_PORDET) != 0) + { + ret = regmap_read(data->regmap, STC3117_ADDR_OCV_H, &ocv_m); + + ret |= regmap_read(data->regmap, STC3117_ADDR_OCV_L, &ocv_l); + + ret |= stc3117_set_para(data); + + ret |= regmap_write(data->regmap, STC3117_ADDR_OCV_H, ocv_m); + + ret |= regmap_write(data->regmap, STC3117_ADDR_OCV_L, ocv_l); + if (ret) + return ret; + } else { + ret = stc3117_set_para(data); + if (ret) + return ret; + regmap_write(data->regmap, STC3117_ADDR_SOC_H, + (ram_data.reg.hrsoc >> 8 & 0xFF)); + regmap_write(data->regmap, STC3117_ADDR_SOC_L, + (ram_data.reg.hrsoc & 0xFF)); + } + } + + ram_data.reg.state = STC3117_INIT; + ram_data.reg.crc = crc8(stc3117_crc_table, ram_data.ram_bytes, + STC3117_RAM_SIZE - 1, CRC8_INIT); + ret = ram_write(data); + if (ret) + return ret; + + data->battery_state = BATT_IDLE; + + return 0; +}; + +static int stc3117_task(struct stc3117_data *data) +{ + int ID, mode, ret; + int count_l, count_m; + int ocv_l, ocv_m; + + regmap_read(data->regmap, STC3117_ADDR_ID, &ID); + if (ID != STC3117_ID) { + data->presence = 0; + return -EINVAL; + } + + stc3117_get_battery_data(data); + + /* Read RAM data */ + ret = ram_read(data); + if (ret) + return ret; + + if ((ram_data.reg.testword != STC3117_RAM_TESTWORD) || + (crc8(stc3117_crc_table, ram_data.ram_bytes, + STC3117_RAM_SIZE, CRC8_INIT) != 0)) + { + ram_data.reg.testword = STC3117_RAM_TESTWORD; + ram_data.reg.cc_cnf = data->cc_cnf; + ram_data.reg.vm_cnf = data->vm_cnf; + ram_data.reg.crc = crc8(stc3117_crc_table, ram_data.ram_bytes, + STC3117_RAM_SIZE - 1, CRC8_INIT); + ram_data.reg.state = STC3117_INIT; + } + + /* check battery presence status */ + ret = regmap_read(data->regmap, STC3117_ADDR_CTRL, &mode); + if ((mode & STC3117_BATFAIL) != 0) + { + data->presence = 0; + ram_data.reg.testword = 0; + ram_data.reg.state = STC3117_INIT; + ret = ram_write(data); + if (ret) + return ret; + regmap_write(data->regmap, STC3117_ADDR_CTRL, STC3117_PORDET); + } + + data->presence = 1; + + ret = regmap_read(data->regmap, STC3117_ADDR_MODE, &mode); + if ((mode & STC3117_GG_RUN) == 0) + { + if (ram_data.reg.state > STC3117_INIT) { + ret = stc3117_set_para(data); + if (ret) + return ret; + + regmap_write(data->regmap, STC3117_ADDR_SOC_H, + (ram_data.reg.hrsoc >> 8 & 0xFF)); + regmap_write(data->regmap, STC3117_ADDR_SOC_L, + (ram_data.reg.hrsoc & 0xFF)); + } else { + ret = regmap_read(data->regmap, STC3117_ADDR_OCV_H, &ocv_m); + + ret |= regmap_read(data->regmap, STC3117_ADDR_OCV_L, &ocv_l); + + ret |= stc3117_set_para(data); + + ret |= regmap_write(data->regmap, STC3117_ADDR_OCV_H, ocv_m); + + ret |= regmap_write(data->regmap, STC3117_ADDR_OCV_L, ocv_l); + if (ret) + return ret; + } + ram_data.reg.state = STC3117_INIT; + } + + regmap_read(data->regmap, STC3117_ADDR_COUNTER_L, &count_l); + regmap_read(data->regmap, STC3117_ADDR_COUNTER_H, &count_m); + + count_m = (count_m << 8) + count_l; + + /* INIT state, wait for batt_current & temperature value available: */ + if (ram_data.reg.state == STC3117_INIT && count_m > 4) { + data->avg_voltage = data->voltage; + data->avg_current = data->batt_current; + ram_data.reg.state = STC3117_RUNNING; + } + + if (ram_data.reg.state != STC3117_RUNNING) + { + data->batt_current = 0; + data->temp = 250; + } else { + if (data->voltage < APP_CUTOFF_VOLTAGE) + data->soc = 0; + + if (mode & STC3117_VMODE) { + data->avg_current = 0; + data->batt_current = 0; + } else { + stc3117_update_battery_status(data); + } + } + + ram_data.reg.hrsoc = data->hrsoc; + ram_data.reg.soc = (data->soc + 5) / 10; + ram_data.reg.crc = crc8(stc3117_crc_table, ram_data.ram_bytes, + STC3117_RAM_SIZE - 1, CRC8_INIT); + + ret = ram_write(data); + if (ret) + return ret; + return 0; +}; + +static void fuel_gauge_update_work(struct work_struct *work) +{ + struct stc3117_data *data = container_of(to_delayed_work(work), + struct stc3117_data, update_work); + stc3117_task(data); + + /* Schedule the work to run again in 2 seconds */ + schedule_delayed_work(&data->update_work, msecs_to_jiffies(2000)); +} + +static int stc3117_get_property(struct power_supply *psy, + enum power_supply_property psp, union power_supply_propval *val) +{ + struct stc3117_data *data = power_supply_get_drvdata(psy); + + switch (psp) { + case POWER_SUPPLY_PROP_STATUS: + if (data->soc > BATTERY_FULL) + val->intval = POWER_SUPPLY_STATUS_FULL; + if (data->batt_current < 0) + val->intval = POWER_SUPPLY_STATUS_CHARGING; + else if (data->batt_current > 0) + val->intval = POWER_SUPPLY_STATUS_DISCHARGING; + else + val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING; + break; + case POWER_SUPPLY_PROP_VOLTAGE_NOW: + val->intval = data->voltage; + break; + case POWER_SUPPLY_PROP_CURRENT_NOW: + val->intval = data->batt_current; + break; + case POWER_SUPPLY_PROP_CAPACITY: + val->intval = data->soc; + break; + case POWER_SUPPLY_PROP_TEMP: + val->intval = data->temp; + break; + case POWER_SUPPLY_PROP_PRESENT: + val->intval = data->presence; + break; + default: + return -EINVAL; + } + return 0; +} + +static enum power_supply_property stc3117_battery_props[] = { + POWER_SUPPLY_PROP_STATUS, + POWER_SUPPLY_PROP_VOLTAGE_NOW, + POWER_SUPPLY_PROP_CURRENT_NOW, + POWER_SUPPLY_PROP_CAPACITY, + POWER_SUPPLY_PROP_TEMP, + POWER_SUPPLY_PROP_PRESENT, +}; + +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 const struct regmap_config stc3117_regmap_config = { + .reg_bits = 8, + .val_bits = 8, +}; + +static int stc3117_probe(struct i2c_client *client) +{ + struct stc3117_data *data; + struct power_supply_config psy_cfg = {}; + struct power_supply_battery_info *info; + int ret; + + data = devm_kzalloc(&client->dev, sizeof(*data), GFP_KERNEL); + if (!data) + return -ENOMEM; + + data->client = client; + data->regmap = devm_regmap_init_i2c(client, &stc3117_regmap_config); + if (IS_ERR(data->regmap)) + return PTR_ERR(data->regmap); + + i2c_set_clientdata(client, data); + psy_cfg.drv_data = data; + + crc8_populate_msb(stc3117_crc_table, CRC8_POLYNOMIAL); + + data->battery = devm_power_supply_register(&client->dev, + &stc3117_battery_desc, &psy_cfg); + if (IS_ERR(data->battery)) + return dev_err_probe(&client->dev, PTR_ERR(data->battery), + "failed to register battery\n"); + + ret = device_property_read_u32(&client->dev, "sense-resistor", + &battery_info.sense_resistor); + if (ret) + return dev_err_probe(&client->dev, ret, + "failed to get sense-register\n"); + + ret = power_supply_get_battery_info(data->battery, &info); + if (ret) + return dev_err_probe(&client->dev, ret, + "failed to get battery information\n"); + + battery_info.battery_capacity = info->charge_full_design_uah * 1000; + battery_info.voltage_min = info->voltage_min_design_uv * 1000; + battery_info.voltage_max = info->voltage_min_design_uv * 1000; + + ret = stc3117_init(data); + if (ret) + return dev_err_probe(&client->dev, ret, + "failed to initialization of stc3117\n"); + + INIT_DELAYED_WORK(&data->update_work, fuel_gauge_update_work); + + schedule_delayed_work(&data->update_work, 0); + + 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 "); +MODULE_AUTHOR("Hardevsinh Palaniya "); +MODULE_DESCRIPTION("STC3117 Fuel Gauge Driver"); diff --git a/MAINTAINERS b/MAINTAINERS index 82161bc70b51..1eab5179871d 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -21855,6 +21855,14 @@ T: git git://linuxtv.org/media_tree.git F: Documentation/devicetree/bindings/media/i2c/st,st-mipid02.yaml F: drivers/media/i2c/st-mipid02.c +ST STC3117 FUEL GAUGE DRIVER +M: Hardevsinh Palaniya +M: Bhavin Sharma +L: linux-pm@vger.kernel.org +S: Maintained +F: Documentation/devicetree/bindings/power/supply/st,stc3117.yaml +F: drivers/power/supply/stc3117_fuel_gauge.c + ST STM32 FIREWALL M: Gatien Chevallier S: Maintained diff --git a/drivers/power/supply/Kconfig b/drivers/power/supply/Kconfig index bcfa63fb9f1e..68d8aa848f7b 100644 --- a/drivers/power/supply/Kconfig +++ b/drivers/power/supply/Kconfig @@ -908,6 +908,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 + chip. + 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 8dcb41545317..5b4633e5818d 100644 --- a/drivers/power/supply/Makefile +++ b/drivers/power/supply/Makefile @@ -107,6 +107,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..b6b1b4f24ea2 --- /dev/null