Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Sean Anderson <sean.anderson@seco.com>
To:     Alessandro Zummo <a.zummo@towertech.it>,
        Alexandre Belloni <alexandre.belloni@bootlin.com>,
        linux-rtc@vger.kernel.org
Cc:     linux-kernel@vger.kernel.org,
        Sean Anderson <sean.anderson@seco.com>
Subject: [PATCH] rtc: abx80x: Don't warn about oscillator failure after PoR
Date:   Fri,  7 Oct 2022 12:37:12 -0400
Message-Id: <20221007163712.2193966-1-sean.anderson@seco.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?kwqRa+HJpZ2Cx/J/4yBKL1Kb+K6zQCNOAy1c2qNJS1eHna1sBEMnHXfd4wPR?=
 =?us-ascii?Q?CpAADznUeqVOjf1Zc4g3zbkfS8UvEDx6xvFtUqOKviYdUwUaYGQ8TVvLxbjz?=
 =?us-ascii?Q?SIA3HWtFBnKePaBfCWlUT4IUgnetkGvqVCupW33P72i4yj3ijpG3+TdWGgzd?=
 =?us-ascii?Q?W2CDNgqyf3oEh9ITNX8ujTJSlVCV8QlGFBzmJy7mzaxViwW0cOp0UbhujX7J?=
 =?us-ascii?Q?wxIgZG5+vrqji8dhNvdqrsY+y/5ryPcLsTmZ+XuDeTEkDK7S8nndjHOWqYiM?=
 =?us-ascii?Q?/HhbDRnJLXebV7h1775idHwxphfCMHx7ifXe//lCpFjRoK7A8i1rfZG6QomP?=
 =?us-ascii?Q?A2Es2VJ0DZ7bY5j+gFxJa9svBCnbLZifWl/gdlu8t5Uzb9aOaU+o3BkHfOQO?=
 =?us-ascii?Q?6NjPt67mWfeklFaoBUplOyr+74sFr4A8RB2czmFWNvfWfhBZvtYKWi7yjvTX?=
 =?us-ascii?Q?l9Z4ncxQb6C7uqYd8OlqGxTnq0R5OUCaXRcoM2m6OVs6yzd5Vl+TdTFPrVqR?=
 =?us-ascii?Q?YSvFTc8s8eEXFQ2swPHHeqAjlJwhlosFrIuY+4NtGKvZHrB1DxJmFf5BQpwZ?=
 =?us-ascii?Q?jiJBC2BMVLpuXszIyP3M4f0q6lACfS0MW1t5h1YK9OkUowb2PpzjSbdKNlvg?=
 =?us-ascii?Q?qfSq6TEtLJEGTT1ctlntF9xJk+Los94qyKxDUGD7QMcHQ8f0xfdz9lmf0J0+?=
 =?us-ascii?Q?a3BGw3Ftg/zEAAmqdPA25AEfKH+sEHyTcQIrIVMjJQ9cLDozHQuCmV+46f0M?=
 =?us-ascii?Q?cyDXZ7bJVk+nT1HCyUgQkyIhNmm2n3YJOaU2edKbDFzk61ytOHnCS9nDV9Vk?=
 =?us-ascii?Q?RopyXXApQyDoSRyFmQwGhH6jP9EiC4mYwTHEAM/OK9Z+Aj8yv2+UVUCyxh1w?=
 =?us-ascii?Q?z17y8wUmqMaqfl59tQpRxVzY+msJQODwS7ec87YBUIF6McvSH89CF0YbNJhq?=
 =?us-ascii?Q?TiQ/oGTHvVddXLJXKp+EdA94LMaTGi3NVTnWYtiTnhgLP3VK8KSGIrRtHPej?=
 =?us-ascii?Q?A0KVGY4/5cowtho5+Pnyr9BUSiByJlQx9sltiKs+huwAVXtYXwriwHkEta0t?=
 =?us-ascii?Q?C76ecCIHT3O2fxYGG3mAuh7lliskJGA7u3JdSmc/MUSCA0iKYs3rkDetdRc1?=
 =?us-ascii?Q?R0z0eb/q+h/I2dYkUkmEH1RCjNcGb2TpX+8txSlaSRWZHjIr4VHWx6po7t3q?=
 =?us-ascii?Q?MleSZyIq80RamOflWPC9JMItFmssX47LlDi7vFYJlknCGZzwJKGMu+lcN8Zq?=
 =?us-ascii?Q?tWwtbxe7GaOnFf/zzKhBKmt7dUgg8AUIQM5162QLLLhOHhEWs+4E27FnuY8e?=
 =?us-ascii?Q?zKnOZGInowWVXbNsMm4wXQqbqksZkLayumYmzrVUQSAoMYk4uhHFPaJ00vfC?=
 =?us-ascii?Q?ylt5fQAcY9/BwOkxvJzUrTEfYeB4EYDWAOls0GayWHB7ZtEvRfUbnS7R0ela?=
 =?us-ascii?Q?cZVVtj9P60SrYYIypQTTZ+4jjoJJE9qwJ7+OIP+/xd0aFosTwtJKqqevkv8i?=
 =?us-ascii?Q?JsXAiMfo7ep8zVOeI6/nyT4jqcK1bSa4ZUavs2lnu2k5+rZvoOKaCXdXQb25?=
 =?us-ascii?Q?0NKSgY7yPnL2333pRVVSdDb2AopB8BUSlnwrXHbAfpMCeuoJfQJn+6ssnC7N?=
 =?us-ascii?Q?nA=3D=3D?=
X-OriginatorOrg: seco.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 7ae47ece-2aec-47c8-d5f7-08daa8823d93
X-MS-Exchange-CrossTenant-AuthSource: DB7PR03MB4972.eurprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Oct 2022 16:37:36.0534
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: bebe97c3-6438-442e-ade3-ff17aa50e733
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: Ng8BWueMVz7Bpsy6li2NTePgmPjNpduAqHyhZxXFoHoFgD+XMJUeKorNrdd2N5fs3d/9OK8DFvSS449oiz6l4A==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB9PR03MB7771
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_PASS autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

According to the datasheet, the "oscillator failure" bit is set

> ...on a power on reset, when both the system and battery voltages have
> dropped below acceptable levels. It is also set if an Oscillator Failure
> occurs....

From testing, this bit is also set if a software reset is initiated.

This bit has a confusing name; it really tells us whether the time data
is valid. We clear it when writing the time. If it is still set, that
means there is a persistent issue (such as an oscillator failure),
instead of a transient one (such as power loss).

Because there are several other reasons which might cause this bit
to be set (including booting for the first time or a battery failure),
do not warn about oscillator failures willy-nilly. This may cause system
integrators to waste time looking into the wrong line of investigation.

Signed-off-by: Sean Anderson <sean.anderson@seco.com>
---

 drivers/rtc/rtc-abx80x.c | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/drivers/rtc/rtc-abx80x.c b/drivers/rtc/rtc-abx80x.c
index 9b0138d07232..1eb752e4e39d 100644
--- a/drivers/rtc/rtc-abx80x.c
+++ b/drivers/rtc/rtc-abx80x.c
@@ -115,6 +115,7 @@ struct abx80x_priv {
 	struct rtc_device *rtc;
 	struct i2c_client *client;
 	struct watchdog_device wdog;
+	bool wrote_time;
 };
 
 static int abx80x_write_config_key(struct i2c_client *client, u8 key)
@@ -167,6 +168,7 @@ static int abx80x_enable_trickle_charger(struct i2c_client *client,
 static int abx80x_rtc_read_time(struct device *dev, struct rtc_time *tm)
 {
 	struct i2c_client *client = to_i2c_client(dev);
+	struct abx80x_priv *priv = i2c_get_clientdata(client);
 	unsigned char buf[8];
 	int err, flags, rc_mode = 0;
 
@@ -181,7 +183,18 @@ static int abx80x_rtc_read_time(struct device *dev, struct rtc_time *tm)
 			return flags;
 
 		if (flags & ABX8XX_OSS_OF) {
-			dev_err(dev, "Oscillator failure, data is invalid.\n");
+			/*
+			 * The OF bit can be set either because of a reset
+			 * (PoR/Software reset) or because of an oscillator
+			 * failure. Effectively, it indicates that the stored
+			 * time is invalid. When we write the time, we clear
+			 * this bit. If it stays set, then this indicates an
+			 * oscillator failure.
+			 */
+			if (priv->wrote_time)
+				dev_err(dev, "Oscillator failure\n");
+			else
+				dev_info(dev, "Time data invalid\n");
 			return -EINVAL;
 		}
 	}
@@ -207,6 +220,7 @@ static int abx80x_rtc_read_time(struct device *dev, struct rtc_time *tm)
 static int abx80x_rtc_set_time(struct device *dev, struct rtc_time *tm)
 {
 	struct i2c_client *client = to_i2c_client(dev);
+	struct abx80x_priv *priv = i2c_get_clientdata(client);
 	unsigned char buf[8];
 	int err, flags;
 
@@ -240,6 +254,7 @@ static int abx80x_rtc_set_time(struct device *dev, struct rtc_time *tm)
 		dev_err(&client->dev, "Unable to write oscillator status register\n");
 		return err;
 	}
+	priv->wrote_time = true;
 
 	return 0;
 }
-- 
2.35.1.1320.gc452695387.dirty