[PATCH 2/3] rtc: pcf2127: Add support for the clkout clock

[Herve Codina]

All devices handled by the pcf2127 driver (i.e. PCF2127, PCF2129,
PCA2129 and PCF2131) have support for an output clock available at their
CLKOUT pins.

The clock frequency can be configured from 1 Hz to 32768 Hz and the
clock can be fully disabled putting the CLKOUT pin in HiZ.

Add support for this clkout output clock.

Signed-off-by: Herve Codina <herve.codina@xxxxxxxxxxx>
---
 drivers/rtc/rtc-pcf2127.c | 186 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 186 insertions(+)

diff --git a/drivers/rtc/rtc-pcf2127.c b/drivers/rtc/rtc-pcf2127.c
index 49542cc53411..1bb84f72cf5f 100644
--- a/drivers/rtc/rtc-pcf2127.c
+++ b/drivers/rtc/rtc-pcf2127.c
@@ -17,6 +17,7 @@
  *             https://www.nxp.com/docs/en/data-sheet/PCF2131DS.pdf
  */
 
+#include <linux/clk-provider.h>
 #include <linux/i2c.h>
 #include <linux/spi/spi.h>
 #include <linux/bcd.h>
@@ -60,6 +61,8 @@
 /* CLKOUT control register */
 #define PCF2127_REG_CLKOUT		0x0f
 #define PCF2127_BIT_CLKOUT_OTPR			BIT(5)
+#define PCF2127_CLKOUT_COF			GENMASK(2, 0)
+#define PCF2127_CLKOUT_COF_HIZ			7
 /* Watchdog registers */
 #define PCF2127_REG_WD_CTL		0x10
 #define PCF2127_BIT_WD_CTL_TF0			BIT(0)
@@ -211,6 +214,11 @@ struct pcf2127 {
 	bool irq_enabled;
 	time64_t ts[PCF2127_MAX_TS_SUPPORTED]; /* Timestamp values. */
 	bool ts_valid[PCF2127_MAX_TS_SUPPORTED];  /* Timestamp valid indication. */
+#ifdef CONFIG_COMMON_CLK
+	struct clk_hw clkout_hw;
+	u32 clkout_cof;
+	bool clkout_enabled;
+#endif
 };
 
 /*
@@ -626,6 +634,180 @@ static int pcf2127_watchdog_init(struct device *dev, struct pcf2127 *pcf2127)
 	return devm_watchdog_register_device(dev, &pcf2127->wdd);
 }
 
+#ifdef CONFIG_COMMON_CLK
+#define clkout_hw_to_pcf2127(_hw) container_of(_hw, struct pcf2127, clkout_hw)
+
+/* Rates indexed by COF values */
+static int pcf2127_clkout_rates[] = {
+	32768,
+	16384,
+	8192,
+	4096,
+	2048,
+	1024,
+	1,
+	0, /* 0Hz (COF 0b111) will put the clockout signal to HiZ */
+};
+
+static u32 pcf2127_clkout_rate2cof(unsigned long rate)
+{
+	unsigned int i;
+
+	for (i = 0; i < ARRAY_SIZE(pcf2127_clkout_rates); i++) {
+		if (pcf2127_clkout_rates[i] <= rate)
+			return i;
+	}
+
+	return 0; /* Maximum output clock rate */
+}
+
+static int pcf2127_clkout_cof2rate(u32 cof)
+{
+	return pcf2127_clkout_rates[cof];
+}
+
+static unsigned long pcf2127_clkout_recalc_rate(struct clk_hw *hw,
+						unsigned long parent_rate)
+{
+	struct pcf2127 *pcf2127 = clkout_hw_to_pcf2127(hw);
+
+	return pcf2127_clkout_cof2rate(pcf2127->clkout_cof);
+}
+
+static int pcf2127_clkout_determine_rate(struct clk_hw *hw,
+					 struct clk_rate_request *req)
+{
+	u32 cof;
+
+	cof = pcf2127_clkout_rate2cof(req->rate);
+	req->rate = pcf2127_clkout_cof2rate(cof);
+
+	return 0;
+}
+
+static int pcf2127_clkout_set_rate(struct clk_hw *hw, unsigned long rate,
+				   unsigned long parent_rate)
+{
+	struct pcf2127 *pcf2127 = clkout_hw_to_pcf2127(hw);
+	u32 cof;
+	int ret;
+
+	cof = pcf2127_clkout_rate2cof(rate);
+
+	/*
+	 * Setting COF will enable the clock (i.e. output not in HiZ anymore)
+	 * Perform the operation only if already enabled.
+	 * Otherwise, do nothing. The expected COF will be set on prepare()
+	 */
+	if (pcf2127->clkout_enabled) {
+		ret = regmap_update_bits(pcf2127->regmap, pcf2127->cfg->reg_clkout,
+					 PCF2127_CLKOUT_COF,
+					 FIELD_PREP(PCF2127_CLKOUT_COF, cof));
+		if (ret)
+			return ret;
+	}
+
+	pcf2127->clkout_cof = cof;
+	return 0;
+}
+
+static int pcf2127_clkout_control(struct clk_hw *hw, bool enable)
+{
+	struct pcf2127 *pcf2127 = clkout_hw_to_pcf2127(hw);
+	u32 cof;
+	int ret;
+
+	cof = enable ? pcf2127->clkout_cof : PCF2127_CLKOUT_COF_HIZ;
+
+	ret = regmap_update_bits(pcf2127->regmap, pcf2127->cfg->reg_clkout,
+				 PCF2127_CLKOUT_COF,
+				 FIELD_PREP(PCF2127_CLKOUT_COF, cof));
+	if (ret)
+		return ret;
+
+	pcf2127->clkout_enabled = enable;
+	return 0;
+}
+
+static int pcf2127_clkout_prepare(struct clk_hw *hw)
+{
+	return pcf2127_clkout_control(hw, true);
+}
+
+static void pcf2127_clkout_unprepare(struct clk_hw *hw)
+{
+	pcf2127_clkout_control(hw, false);
+}
+
+static int pcf2127_clkout_is_prepared(struct clk_hw *hw)
+{
+	struct pcf2127 *pcf2127 = clkout_hw_to_pcf2127(hw);
+
+	return pcf2127->clkout_enabled;
+}
+
+static const struct clk_ops pcf2127_clkout_ops = {
+	.prepare = pcf2127_clkout_prepare,
+	.unprepare = pcf2127_clkout_unprepare,
+	.is_prepared = pcf2127_clkout_is_prepared,
+	.recalc_rate = pcf2127_clkout_recalc_rate,
+	.determine_rate = pcf2127_clkout_determine_rate,
+	.set_rate = pcf2127_clkout_set_rate,
+};
+
+static int pcf2127_clkout_init(struct device *dev, struct pcf2127 *pcf2127)
+{
+	struct clk_init_data init = {};
+	const char *name;
+	u32 clkout;
+	int ret;
+
+	/*
+	 * Backward compatibility
+	 *
+	 * The output clock is enabled by default in the hardware.
+	 *
+	 * Handling this clock in a clock driver can lead to stop this clock if
+	 * it is unused. To avoid that and be backward compatible, use the clock
+	 * driver only if we have been told to.
+	 */
+	if (!device_property_present(dev, "#clock-cells"))
+		return 0;
+
+	/* optional override of the clockname */
+	ret = device_property_read_string(dev, "clock-output-names", &name);
+
+	init.name = ret ? "pcf2127-clkout" : name;
+	init.ops = &pcf2127_clkout_ops;
+	pcf2127->clkout_hw.init = &init;
+
+	/* Get the initial value for the COF field */
+	ret = regmap_read(pcf2127->regmap, pcf2127->cfg->reg_clkout, &clkout);
+	if (ret)
+		return ret;
+
+	pcf2127->clkout_enabled = true;
+	pcf2127->clkout_cof = FIELD_GET(PCF2127_CLKOUT_COF, clkout);
+	if (pcf2127->clkout_cof == PCF2127_CLKOUT_COF_HIZ) {
+		pcf2127->clkout_enabled = false;
+		pcf2127->clkout_cof = 0; /* Maximum rate (32768Hz) */
+	}
+
+	/* register the clock */
+	ret = devm_clk_hw_register(dev, &pcf2127->clkout_hw);
+	if (ret)
+		return ret;
+
+	return devm_of_clk_add_hw_provider(dev, of_clk_hw_simple_get,
+					   &pcf2127->clkout_hw);
+}
+#else
+static int pcf2127_clkout_init(struct device *dev, struct pcf2127 *pcf2127)
+{
+	return 0;
+}
+#endif
+
 /* Alarm */
 static int pcf2127_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
 {
@@ -1319,6 +1501,10 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
 
 	pcf2127_watchdog_init(dev, pcf2127);
 
+	ret = pcf2127_clkout_init(dev, pcf2127);
+	if (ret < 0)
+		return ret;
+
 	/*
 	 * Disable battery low/switch-over timestamp and interrupts.
 	 * Clear battery interrupt flags which can block new trigger events.
-- 
2.56.0