Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:6 as permitted sender) client-ip=2620:137:e000::3:6;
From:   Javier Carrasco <javier.carrasco@wolfvision.net>
Date:   Wed, 25 Oct 2023 18:21:54 +0200
Subject: [PATCH 1/2] rtc: pcf85363: add support for high-impedance output
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-Id: <20231024-topic-pcf85363_hiz_output-v1-1-50908aff0e52@wolfvision.net>
References: <20231024-topic-pcf85363_hiz_output-v1-0-50908aff0e52@wolfvision.net>
In-Reply-To: <20231024-topic-pcf85363_hiz_output-v1-0-50908aff0e52@wolfvision.net>
To:     Alessandro Zummo <a.zummo@towertech.it>,
        Alexandre Belloni <alexandre.belloni@bootlin.com>,
        Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Conor Dooley <conor+dt@kernel.org>
Cc:     linux-rtc@vger.kernel.org, linux-kernel@vger.kernel.org,
        devicetree@vger.kernel.org,
        Javier Carrasco <javier.carrasco@wolfvision.net>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?WnVzb0tGb0dVWUdvZFFvcSs3cFcySVlqUE5wYk85SzUzUUd4WmtTbnZxN2hO?=
 =?utf-8?B?NGdRT3p2ZHJGOVNGei8wT0FIT2hUQ2VvQ3lkdzBzZHNTMTZDLzEzOCs5Umsv?=
 =?utf-8?B?NGNKM2RNQlI2OEpnc0FuTkJXNzFoVEwzUGVJV1NySmVrQVoxU2FrbWdpem44?=
 =?utf-8?B?aUVwRUJnVUk1THBCV2l2eURJRFFYZ1kyekZHaDQ1emtMNXFnYzBsckVoY0hz?=
 =?utf-8?B?ZlgwcGNRcHVHRXBubmNpaEQ0b2wrcFluaGQxcmQ3clpkTDRVbEhPZ3B5TFI1?=
 =?utf-8?B?VDBGNXdsKzc5dlVrVzYwcDBZQllNYzFoRDlGR3ZZVE1PSkJFNTQ2alJQZlJM?=
 =?utf-8?B?b3JoK21ZaXl3eUE3NStGbVdqNTVpQlRiTThGL1VvbC9lTGtEcFJRdTVKU0c3?=
 =?utf-8?B?S3N1UkFxNGw1UzdRZXAwOVNsOFh6TjFCN3hDbVN3bzNJaXZ2WTVGSEN2U2Mx?=
 =?utf-8?B?T3M1akVBOHhKT0JTT0V4SmREdTVKMEg0SlFJaUQxRkhScUNsRTNIeFFlZkl4?=
 =?utf-8?B?a2JUNGdQNmhnQVhCMVlya0hUUTMyU2tDV0FMb3BWWXFhUG9RbFhGaUt6QW9V?=
 =?utf-8?B?bDByenJxMWJtZzNZYm5uaFl2a0hCWTlXQnJvYlJ4cURYNzg2NWFWMmNma2Fh?=
 =?utf-8?B?ekRvOFJZNlRPOFVuOU1pRVBuR0tNS2ZBbzEveFdzQStNWjFvenNnSHNiTjlo?=
 =?utf-8?B?NktyZDRVU1NsM1RqcUxCV0I0bW1RUGd6VHFBWUlmWGE0YUVtRGJlTFdZU0Ux?=
 =?utf-8?B?WU5VVWJHUmM0bFYzbndyRnVZNzA1a09NenkwazlEaWVhc2tyZzRSajRyNklU?=
 =?utf-8?B?U3drS2U4Qkl2ZENnWFZ1aW1tRmtpaGdqaEs3b1RNU1NibnNGVU4xSDNqSWt1?=
 =?utf-8?B?bnJHL0VJeVdDUjkxSlg5Y0sxQ1NzbTZibTZXM1ZBZWxtY01NRTJ2Y0FtZ0x5?=
 =?utf-8?B?ZEFRWlp2MjMwU1ZTVmxVZlBYSnM0MHRqK3FwZUFhUTlRY1d1NDNRQitKM0tx?=
 =?utf-8?B?bGkvUnNxbTFkUEI0SFUyS0tyd0ZacDg1Zllac1lYMHhpbEo2aC9vZXlZeWxR?=
 =?utf-8?B?VFlPKzdiOWw4VlRXaWJTVERHdkNRU0pNQWRYdk9SdWU5V3dLQ1h0NHZEMVY3?=
 =?utf-8?B?WlhFZGUwWmhwdmZHckYzZmRiV3RzK3dDQ0t1SnoxUUZicWVuMmlzZlpqbG93?=
 =?utf-8?B?R3JQRVd2ZDhXWGJTM3VYV1ZIOGFQZUp5SGcyTnZFTlQ4L2VUejNEc3dXNDRH?=
 =?utf-8?B?RE1jdlgwQUZsYzZWandBT1BPWFpFaHhZUUV4ZmlsTGV6SGpCNWM4Wlhjdzc5?=
 =?utf-8?B?MFdzdktFalRQNHB4Qm8yc3Urb0VzeWY0NTBwWGlEOWpqcjBtMkZWUFQ5cXly?=
 =?utf-8?B?cHVyZGxZQmdjdDNLR2hsT2RDUHc1RmdCd0ZWQlBsZmc1MFl6UkREaVl4YWIx?=
 =?utf-8?B?RkdDa1hqUFZCS2NYbHdkaUNYZnA1eS90KzFQRzMrWkpGakFuaDBUK1RZQlU5?=
 =?utf-8?B?VENEdEFXV1VpclF2WWJLTnFBeWZ6YUVYUHRubUpvUTVZeVhRMWwzeVhiK2ZR?=
 =?utf-8?B?RUVFZVYxQWU3ZVRyY1JGM1NKZkIvbkhhcjk0Tm5Sb3BmV3N6NzUrZ3Z1RXNX?=
 =?utf-8?B?R3BaYUJJR2ZnSy9saFRKcno5MWpESzRnRldiZ3BTcm1HeUFXUm9wWDh2U0NW?=
 =?utf-8?B?Yi9jdEJld1lLTm1jY3Fqb0tvUUdjTEdJaGNWYXJtWEFsVmMwMVpPQ3NrYVlm?=
 =?utf-8?B?blVoV1QzOXRHTDFwR1BCdjhzdE5ZYWxEb1FnS1FhYUpmSmhTY3VMSTBKRDRY?=
 =?utf-8?B?ck9ENTVHTWMvSmJaeTY2MFlGQU5ycUxZVHNuRUt6Nnd5TUFValpuVkJDUDFQ?=
 =?utf-8?B?LzJSZ0lSWEl4Q0FrWFIvUnpqaDk3b0pyQkl5VmFOYWdhM3RCaVRWZ0ZuOUR5?=
 =?utf-8?B?d21Sc2ZqeU9aSFhxQ0phL0x3WUhXMi9iVFJObzNsS3R1M2xaWDJQaTRpenBw?=
 =?utf-8?B?WFdmUHJyN0k2ODVkdWRrbmJydTIvSUdXMXZQMEVDL2hocXYyMEtQa0Zpc3Q4?=
 =?utf-8?B?aUpGaE0yR2ZHZEFLdldxc3RhRjREaXp1T0JQQ1RKSjlKbng5QXRwTHZWUGpu?=
 =?utf-8?B?R3V5TzVjdUpzTjlWU0lxODFGaFZvM1VNNnNKcDFGLzBLbnpjNjFya0hpUTVx?=
 =?utf-8?Q?ZDWIDpBbj2xaJSSgUoDtMgM=3D?=
X-OriginatorOrg: wolfvision.net
X-MS-Exchange-CrossTenant-Network-Message-Id: 0639ebf5-d03f-4861-eb3e-08dbd576835c
X-MS-Exchange-CrossTenant-AuthSource: VE1PR08MB4974.eurprd08.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Oct 2023 16:21:59.0785
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: e94ec9da-9183-471e-83b3-51baa8eb804f
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 5qdMebzrFqtiDZjmdTNRqaaZ86wT+56JpaeffBw2ebfgfIF/3t0LP7JD82dKN10IWGa6Mb7pxkTaLDHngqZs1WYnfpI4QOe1fbeKmpJUc/g=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR08MB5376
X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
	DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,
	SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no
	version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on pete.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (pete.vger.email [0.0.0.0]); Wed, 25 Oct 2023 09:22:27 -0700 (PDT)

The pcf85363 provides a high-impedance (hi-Z) mode for its output. This
mode can be used to reduce power consumption in applications where the
RTC output is only required as a clock/interrupt source when the system
runs in low-power mode (i.e. serving as a clock source for a PMU when
the system is down). If the output is not needed, it can also be
completely disabled.

This implementation adds support for a hi-Z output and also uses simple
pm operations (suspend and resume) to switch the output mode from hi-Z
in normal operation to the required operation mode in sleep mode
(currently either clock or interrupt) if the "sleep" value for the
hiz-output was set.

In order to make use of the hi-Z output modeling via device tree,
check if the new "hiz-output" property is defined and set the hi-Z
mode accordingly.

Signed-off-by: Javier Carrasco <javier.carrasco@wolfvision.net>
---
 drivers/rtc/rtc-pcf85363.c | 62 +++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 61 insertions(+), 1 deletion(-)

diff --git a/drivers/rtc/rtc-pcf85363.c b/drivers/rtc/rtc-pcf85363.c
index 540042b9eec8..82eaf8de8b33 100644
--- a/drivers/rtc/rtc-pcf85363.c
+++ b/drivers/rtc/rtc-pcf85363.c
@@ -110,9 +110,17 @@
 
 #define NVRAM_SIZE	0x40
 
+enum pcf85363_hiz_output_t {
+	PCF85363_HIZ_OFF,
+	PCF85363_HIZ_ON,
+	PCF85363_HIZ_SLEEP,
+};
+
 struct pcf85363 {
 	struct rtc_device	*rtc;
 	struct regmap		*regmap;
+
+	enum pcf85363_hiz_output_t hiz_output;
 };
 
 struct pcf85x63_config {
@@ -403,6 +411,7 @@ static int pcf85363_probe(struct i2c_client *client)
 	};
 	int ret, i, err;
 	bool wakeup_source;
+	const char *hiz_output = NULL;
 
 	if (data)
 		config = data;
@@ -433,9 +442,32 @@ static int pcf85363_probe(struct i2c_client *client)
 	pcf85363->rtc->range_min = RTC_TIMESTAMP_BEGIN_2000;
 	pcf85363->rtc->range_max = RTC_TIMESTAMP_END_2099;
 
+	if (device_property_present(&client->dev, "hiz-output")) {
+		ret = device_property_read_string(&client->dev, "hiz-output",
+						  &hiz_output);
+		if (ret)
+			return ret;
+
+		if (!strcmp(hiz_output, "enabled")) {
+			pcf85363->hiz_output = PCF85363_HIZ_ON;
+		} else if (!strcmp(hiz_output, "sleep")) {
+			pcf85363->hiz_output = PCF85363_HIZ_SLEEP;
+		} else if (!strcmp(hiz_output, "disabled")) {
+			pcf85363->hiz_output = PCF85363_HIZ_OFF;
+		} else {
+			dev_warn(&client->dev, "Unknown hiz-output: %s. Assuming disabled",
+				 hiz_output);
+			pcf85363->hiz_output = PCF85363_HIZ_OFF;
+		}
+	} else {
+		pcf85363->hiz_output = PCF85363_HIZ_OFF;
+	}
 	wakeup_source = device_property_read_bool(&client->dev,
 						  "wakeup-source");
-	if (client->irq > 0 || wakeup_source) {
+	if (pcf85363->hiz_output != PCF85363_HIZ_OFF) {
+		regmap_update_bits(pcf85363->regmap, CTRL_PIN_IO,
+				   PIN_IO_INTAPM, PIN_IO_INTA_HIZ);
+	} else if (client->irq > 0 || wakeup_source) {
 		regmap_write(pcf85363->regmap, CTRL_FLAGS, 0);
 		regmap_update_bits(pcf85363->regmap, CTRL_PIN_IO,
 				   PIN_IO_INTAPM, PIN_IO_INTA_OUT);
@@ -474,6 +506,31 @@ static int pcf85363_probe(struct i2c_client *client)
 	return ret;
 }
 
+#ifdef CONFIG_PM_SLEEP
+static int pcf85363_suspend(struct device *dev)
+{
+	struct pcf85363 *pcf85363 = dev_get_drvdata(dev);
+
+	if (pcf85363->hiz_output == PCF85363_HIZ_SLEEP)
+		regmap_update_bits(pcf85363->regmap, CTRL_PIN_IO, PIN_IO_INTAPM,
+				   device_may_wakeup(dev) ?  PIN_IO_INTA_OUT :
+				   PIN_IO_INTA_CLK);
+
+	return 0;
+}
+
+static int pcf85363_resume(struct device *dev)
+{
+	struct pcf85363 *pcf85363 = dev_get_drvdata(dev);
+
+	if (pcf85363->hiz_output == PCF85363_HIZ_SLEEP)
+		regmap_update_bits(pcf85363->regmap, CTRL_PIN_IO,
+				   PIN_IO_INTAPM, PIN_IO_INTA_HIZ);
+
+	return 0;
+}
+#endif
+
 static const __maybe_unused struct of_device_id dev_ids[] = {
 	{ .compatible = "nxp,pcf85263", .data = &pcf_85263_config },
 	{ .compatible = "nxp,pcf85363", .data = &pcf_85363_config },
@@ -481,9 +538,12 @@ static const __maybe_unused struct of_device_id dev_ids[] = {
 };
 MODULE_DEVICE_TABLE(of, dev_ids);
 
+static SIMPLE_DEV_PM_OPS(pcf85363_pm_ops, pcf85363_suspend, pcf85363_resume);
+
 static struct i2c_driver pcf85363_driver = {
 	.driver	= {
 		.name	= "pcf85363",
+		.pm	= &pcf85363_pm_ops,
 		.of_match_table = of_match_ptr(dev_ids),
 	},
 	.probe = pcf85363_probe,

-- 
2.39.2