Skip to contentSkip to conversation

rtc: pcf2127: add alarm support

PATCH Superseded Liam Beguin 3 participants 11 messages Jun 14, 2020 – Jun 16, 2020

Subsystems (2)

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

v2 cover rtc: pcf2127: add alarm support

The board used to test this series has the interrupt line of the RTC connected to a circuit controlling the power of the board. An event on the interrupt line while the board is off will power it on. Because of these hardware limitations, the irq handler added in this patch wasn't fully tested.

The alarm fuctionality was tested on a PCA2129, with:

	$ date "2010-10-10 10:10"
	Sun Oct 10 10:10:00 UTC 2010
	$ /usr/sbin/rtcwake -u -d /dev/rtc0  -s10 --mode off
	[ ... ]
	$ # power on after 10 seconds

Changes since v1:
- Document new compatible string for the pca2129
- Add calls to pcf2127_wdt_active_ping after accessing CTRL2
- Use sizeof(buf) instead of hadcoding value
- Cleanup debug trace
- Add interrupt handler and wakeup-source devicetree option

Liam Beguin (2):
rtc: pcf2127: add pca2129 device id
rtc: pcf2127: add alarm support

 .../devicetree/bindings/rtc/trivial-rtc.yaml  |   2 +
 drivers/rtc/rtc-pcf2127.c                     | 172 +++++++++++++++++-
 2 files changed, 171 insertions(+), 3 deletions(-)

Interdiff against v1:

Documentation/devicetree/bindings/rtc/trivial-rtc.yaml +2 -0
index 18cb456752f6..c7d14de214c4 100644
@@ -52,6 +52,8 @@ properties:
       - nxp,pcf2127
       # Real-time clock
       - nxp,pcf2129
+      # Real-time clock
+      - nxp,pca2129
       # Real-time Clock Module
       - pericom,pt7c4338
       # I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
drivers/rtc/rtc-pcf2127.c +69 -28

170 lines not on this page · raw message

base-commit: aaa2faab4ed8e5fe0111e04d6e168c028fe2987f

Signature · 1 line
2.27.0
#1 lore raw

PATCH v2 1/2 rtc: pcf2127: add pca2129 device id

From: Liam Beguin <[email protected]>

The PCA2129 is the automotive grade version of the PCF2129. add it to the list of compatibles.

---
Changes since v1:
- Document new compatible string for the pca2129

 Documentation/devicetree/bindings/rtc/trivial-rtc.yaml | 2 ++
 drivers/rtc/rtc-pcf2127.c                              | 3 +++
 2 files changed, 5 insertions(+)
Documentation/devicetree/bindings/rtc/trivial-rtc.yaml +2 -0
index 18cb456752f6..c7d14de214c4 100644
@@ -52,6 +52,8 @@ properties:
       - nxp,pcf2127
       # Real-time clock
       - nxp,pcf2129
+      # Real-time clock
+      - nxp,pca2129
       # Real-time Clock Module
       - pericom,pt7c4338
       # I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
drivers/rtc/rtc-pcf2127.c +3 -0
index 4e50d6768f13..396a1144a213 100644
@@ -546,6 +546,7 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
 static const struct of_device_id pcf2127_of_match[] = {
 	{ .compatible = "nxp,pcf2127" },
 	{ .compatible = "nxp,pcf2129" },
+	{ .compatible = "nxp,pca2129" },
 	{}
 };
 MODULE_DEVICE_TABLE(of, pcf2127_of_match);
@@ -656,6 +657,7 @@ static int pcf2127_i2c_probe(struct i2c_client *client,
 static const struct i2c_device_id pcf2127_i2c_id[] = {
 	{ "pcf2127", 1 },
 	{ "pcf2129", 0 },
+	{ "pca2129", 0 },
 	{ }
 };
 MODULE_DEVICE_TABLE(i2c, pcf2127_i2c_id);
@@ -720,6 +722,7 @@ static int pcf2127_spi_probe(struct spi_device *spi)
 static const struct spi_device_id pcf2127_spi_id[] = {
 	{ "pcf2127", 1 },
 	{ "pcf2129", 0 },
+	{ "pca2129", 0 },
 	{ }
 };
 MODULE_DEVICE_TABLE(spi, pcf2127_spi_id);
Signature · 1 line
2.27.0
#2 lore raw

Re: [PATCH v2 1/2] rtc: pcf2127: add pca2129 device id

Den søn. 14. jun. 2020 kl. 06.04 skrev Liam Beguin <[email protected]>:

Quoted 20 lines

From: Liam Beguin <[email protected]>

The PCA2129 is the automotive grade version of the PCF2129. add it to the list of compatibles.

---
Changes since v1:
- Document new compatible string for the pca2129

 Documentation/devicetree/bindings/rtc/trivial-rtc.yaml | 2 ++
 drivers/rtc/rtc-pcf2127.c                              | 3 +++
 2 files changed, 5 insertions(+)
Documentation/devicetree/bindings/rtc/trivial-rtc.yaml +0 -0
index 18cb456752f6..c7d14de214c4 100644

Documentation/devicetree/bindings/rtc/trivial-rtc.yaml properties: · line 59

Quoted 8 lines
Documentation/devicetree/bindings/rtc/trivial-rtc.yaml +2 -0
@@ -52,6 +52,8 @@ properties:
       - nxp,pcf2127
       # Real-time clock
       - nxp,pcf2129
+      # Real-time clock
+      - nxp,pca2129
       # Real-time Clock Module
       - pericom,pt7c4338
       # I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC

Split device tree binding update into separate patch and remember to add [email protected] mailing list when you send the next patch series version.

/Bruno

Quoted 31 lines
drivers/rtc/rtc-pcf2127.c +3 -1
index 4e50d6768f13..396a1144a213 100644
@@ -546,6 +546,7 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
 static const struct of_device_id pcf2127_of_match[] = {
        { .compatible = "nxp,pcf2127" },
        { .compatible = "nxp,pcf2129" },
+       { .compatible = "nxp,pca2129" },
        {}
 };
 MODULE_DEVICE_TABLE(of, pcf2127_of_match);
@@ -656,6 +657,7 @@ static int pcf2127_i2c_probe(struct i2c_client *client,
 static const struct i2c_device_id pcf2127_i2c_id[] = {
        { "pcf2127", 1 },
        { "pcf2129", 0 },
+       { "pca2129", 0 },
        { }
 };
 MODULE_DEVICE_TABLE(i2c, pcf2127_i2c_id);
@@ -720,6 +722,7 @@ static int pcf2127_spi_probe(struct spi_device *spi)
 static const struct spi_device_id pcf2127_spi_id[] = {
        { "pcf2127", 1 },
        { "pcf2129", 0 },
+       { "pca2129", 0 },
        { }
 };
 MODULE_DEVICE_TABLE(spi, pcf2127_spi_id);
--

2.27.0

#3 lore raw

Re: [PATCH v2 1/2] rtc: pcf2127: add pca2129 device id

Quoted 25 lines · Bruno Thomsen

Den søn. 14. jun. 2020 kl. 06.04 skrev Liam Beguin <[email protected]>:

Quoted 24 lines

From: Liam Beguin <[email protected]>

The PCA2129 is the automotive grade version of the PCF2129. add it to the list of compatibles.

---
Changes since v1:
- Document new compatible string for the pca2129

 Documentation/devicetree/bindings/rtc/trivial-rtc.yaml | 2 ++
 drivers/rtc/rtc-pcf2127.c                              | 3 +++
 2 files changed, 5 insertions(+)
Documentation/devicetree/bindings/rtc/trivial-rtc.yaml +1 -0
index 18cb456752f6..c7d14de214c4 100644
@@ -52,6 +52,8 @@ properties:
       - nxp,pcf2127
       # Real-time clock
       - nxp,pcf2129
+      # Real-time clock
Quoted 9 lines

Documentation/devicetree/bindings/rtc/trivial-rtc.yaml properties: · line 59

Quoted 4 lines
Documentation/devicetree/bindings/rtc/trivial-rtc.yaml +1 -0
+      - nxp,pca2129
       # Real-time Clock Module
       - pericom,pt7c4338
       # I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC

Split device tree binding update into separate patch and remember to add [email protected] mailing list when you send the next patch series version.

For trivial rtc, it is not really necessary to separate the binding doc, especially when simply adding a compatible string.

Quoted 33 lines

/Bruno

Quoted 31 lines
drivers/rtc/rtc-pcf2127.c +3 -1
index 4e50d6768f13..396a1144a213 100644
@@ -546,6 +546,7 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
 static const struct of_device_id pcf2127_of_match[] = {
        { .compatible = "nxp,pcf2127" },
        { .compatible = "nxp,pcf2129" },
+       { .compatible = "nxp,pca2129" },
        {}
 };
 MODULE_DEVICE_TABLE(of, pcf2127_of_match);
@@ -656,6 +657,7 @@ static int pcf2127_i2c_probe(struct i2c_client *client,
 static const struct i2c_device_id pcf2127_i2c_id[] = {
        { "pcf2127", 1 },
        { "pcf2129", 0 },
+       { "pca2129", 0 },
        { }
 };
 MODULE_DEVICE_TABLE(i2c, pcf2127_i2c_id);
@@ -720,6 +722,7 @@ static int pcf2127_spi_probe(struct spi_device *spi)
 static const struct spi_device_id pcf2127_spi_id[] = {
        { "pcf2127", 1 },
        { "pcf2129", 0 },
+       { "pca2129", 0 },
        { }
 };
 MODULE_DEVICE_TABLE(spi, pcf2127_spi_id);
--

2.27.0

Signature · 3 lines
Alexandre Belloni, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#4 lore raw

PATCH v2 2/2 rtc: pcf2127: add alarm support

In reply to Liam Beguin

From: Liam Beguin <[email protected]>

Add alarm support for the pcf2127 RTC chip family. Tested on pca2129.

---
Changes since v1:
- Add calls to pcf2127_wdt_active_ping after accessing CTRL2
- Cleanup calls to regmap_{read,write,update_bits}
- Cleanup debug trace
- Add interrupt handler, untested because of hardware limitations
- Add wakeup-source devicetree option

 drivers/rtc/rtc-pcf2127.c | 169 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 166 insertions(+), 3 deletions(-)
drivers/rtc/rtc-pcf2127.c +166 -3
index 396a1144a213..87ecb29247c6 100644
@@ -20,6 +20,7 @@
 #include <linux/slab.h>
 #include <linux/module.h>
 #include <linux/of.h>
+#include <linux/of_irq.h>
 #include <linux/regmap.h>
 #include <linux/watchdog.h>
 
@@ -28,7 +29,9 @@
 #define PCF2127_BIT_CTRL1_TSF1			BIT(4)
 /* Control register 2 */
 #define PCF2127_REG_CTRL2		0x01
+#define PCF2127_BIT_CTRL2_AIE			BIT(1)
 #define PCF2127_BIT_CTRL2_TSIE			BIT(2)
+#define PCF2127_BIT_CTRL2_AF			BIT(4)
 #define PCF2127_BIT_CTRL2_TSF2			BIT(5)
 /* Control register 3 */
 #define PCF2127_REG_CTRL3		0x02
@@ -46,6 +49,12 @@
 #define PCF2127_REG_DW			0x07
 #define PCF2127_REG_MO			0x08
 #define PCF2127_REG_YR			0x09
+/* Alarm registers */
+#define PCF2127_REG_ALARM_SC		0x0A
+#define PCF2127_REG_ALARM_MN		0x0B
+#define PCF2127_REG_ALARM_HR		0x0C
+#define PCF2127_REG_ALARM_DM		0x0D
+#define PCF2127_REG_ALARM_DW		0x0E
 /* Watchdog registers */
 #define PCF2127_REG_WD_CTL		0x10
 #define PCF2127_BIT_WD_CTL_TF0			BIT(0)
@@ -79,6 +88,8 @@
 #define PCF2127_WD_VAL_MAX		255
 #define PCF2127_WD_VAL_DEFAULT		60
 
+static int pcf2127_wdt_active_ping(struct watchdog_device *wdd);
+
 struct pcf2127 {
 	struct rtc_device *rtc;
 	struct watchdog_device wdd;
@@ -185,6 +196,140 @@ static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm)
 	return 0;
 }
 
+static int pcf2127_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
+{
+	struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+	unsigned int buf[5], ctrl2;
+	int ret;
+
+	ret = regmap_read(pcf2127->regmap, PCF2127_REG_CTRL2, &ctrl2);
+	if (ret) {
+		dev_err(dev, "%s: ctrl2 read error\n", __func__);
+		return ret;
+	}
+
+	ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+	if (ret)
+		return ret;
+
+	ret = regmap_bulk_read(pcf2127->regmap, PCF2127_REG_ALARM_SC, buf,
+			       sizeof(buf));
+	if (ret) {
+		dev_err(dev, "%s: alarm read error\n", __func__);
+		return ret;
+	}
+
+	alrm->enabled = ctrl2 & PCF2127_BIT_CTRL2_AIE;
+	alrm->pending = ctrl2 & PCF2127_BIT_CTRL2_AF;
+
+	alrm->time.tm_sec = bcd2bin(buf[0] & 0x7F);
+	alrm->time.tm_min = bcd2bin(buf[1] & 0x7F);
+	alrm->time.tm_hour = bcd2bin(buf[2] & 0x3F);
+	alrm->time.tm_mday = bcd2bin(buf[3] & 0x3F);
+	alrm->time.tm_wday = buf[4] & 0x07;
+
+	dev_dbg(dev, "%s: alarm is %d:%d:%d, mday=%d, wday=%d\n", __func__,
+		alrm->time.tm_hour, alrm->time.tm_min, alrm->time.tm_sec,
+		alrm->time.tm_mday, alrm->time.tm_wday);
+
+	return 0;
+}
+
+static int pcf2127_rtc_alarm_irq_enable(struct device *dev, u32 enable)
+{
+	struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+	int ret;
+
+	ret = regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+				 PCF2127_BIT_CTRL2_AIE,
+				 enable ? PCF2127_BIT_CTRL2_AIE : 0);
+	if (ret) {
+		dev_err(dev, "%s: failed to %s alarm (%d)\n", __func__,
+			enable ? "enable" : "disable",
+			ret);
+		return ret;
+	}
+
+	ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+	if (ret)
+		return ret;
+
+	return 0;
+}
+
+static int pcf2127_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
+{
+	struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+	uint8_t buf[5];
+	int ret;
+
+	ret = regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+				 PCF2127_BIT_CTRL2_AF, 0);
+	if (ret) {
+		dev_err(dev, "%s: failed to clear alarm interrupt flag (%d)",
+			__func__, ret);
+		return ret;
+	}
+
+	ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+	if (ret)
+		return ret;
+
+	buf[0] = bin2bcd(alrm->time.tm_sec);
+	buf[1] = bin2bcd(alrm->time.tm_min);
+	buf[2] = bin2bcd(alrm->time.tm_hour);
+	buf[3] = bin2bcd(alrm->time.tm_mday);
+	buf[4] = (alrm->time.tm_wday & 0x07);
+
+	dev_dbg(dev, "%s: alarm set for: %d:%d:%d, mday=%d, wday=%d\n",
+		__func__, alrm->time.tm_hour, alrm->time.tm_min,
+		alrm->time.tm_sec, alrm->time.tm_mday, alrm->time.tm_wday);
+
+	ret = regmap_bulk_write(pcf2127->regmap, PCF2127_REG_ALARM_SC, buf,
+				sizeof(buf));
+	if (ret) {
+		dev_err(dev, "%s: failed to write alarm registers (%d)",
+			__func__, ret);
+		return ret;
+	}
+
+	pcf2127_rtc_alarm_irq_enable(dev, alrm->enabled);
+
+	return 0;
+}
+
+static irqreturn_t pcf2127_rtc_irq(int irq, void *dev)
+{
+	struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+	unsigned int ctrl2 = 0;
+	int ret = 0;
+
+	ret = regmap_read(pcf2127->regmap, PCF2127_REG_CTRL2, &ctrl2);
+	if (ret) {
+		dev_err(dev, "%s: ctrl2 read error (%d)\n", __func__, ret);
+		goto irq_err;
+	}
+
+	ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+	if (ret)
+		goto irq_err;
+
+	if (ctrl2 & PCF2127_BIT_CTRL2_AF) {
+		regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+				   PCF2127_BIT_CTRL2_AF, 0);
+
+		ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+		if (ret)
+			goto irq_err;
+
+		rtc_update_irq(pcf2127->rtc, 1, RTC_IRQF | RTC_AF);
+	}
+
+	return IRQ_HANDLED;
+irq_err:
+	return IRQ_NONE;
+}
+
 #ifdef CONFIG_RTC_INTF_DEV
 static int pcf2127_rtc_ioctl(struct device *dev,
 				unsigned int cmd, unsigned long arg)
@@ -211,9 +356,12 @@ static int pcf2127_rtc_ioctl(struct device *dev,
 #endif
 
 static const struct rtc_class_ops pcf2127_rtc_ops = {
-	.ioctl		= pcf2127_rtc_ioctl,
-	.read_time	= pcf2127_rtc_read_time,
-	.set_time	= pcf2127_rtc_set_time,
+	.ioctl            = pcf2127_rtc_ioctl,
+	.read_time        = pcf2127_rtc_read_time,
+	.set_time         = pcf2127_rtc_set_time,
+	.read_alarm       = pcf2127_rtc_read_alarm,
+	.set_alarm        = pcf2127_rtc_set_alarm,
+	.alarm_irq_enable = pcf2127_rtc_alarm_irq_enable,
 };
 
 static int pcf2127_nvmem_read(void *priv, unsigned int offset,
@@ -415,6 +563,7 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
 			const char *name, bool has_nvmem)
 {
 	struct pcf2127 *pcf2127;
+	int alarm_irq = 0;
 	u32 wdd_timeout;
 	int ret = 0;
 
@@ -434,6 +583,20 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
 
 	pcf2127->rtc->ops = &pcf2127_rtc_ops;
 
+	alarm_irq = of_irq_get_byname(dev->of_node, "alarm");
+	if (alarm_irq >= 0) {
+		ret = devm_request_irq(dev, alarm_irq, pcf2127_rtc_irq,
+				       IRQF_TRIGGER_LOW | IRQF_ONESHOT,
+				       dev_name(dev), dev);
+		if (ret) {
+			dev_err(dev, "failed to request alarm irq\n");
+			return ret;
+		}
+	}
+
+	if (alarm_irq >= 0 || device_property_read_bool(dev, "wakeup-source"))
+		device_init_wakeup(dev, true);
+
 	pcf2127->wdd.parent = dev;
 	pcf2127->wdd.info = &pcf2127_wdt_info;
 	pcf2127->wdd.ops = &pcf2127_watchdog_ops;
Signature · 1 line
2.27.0
#5 lore raw

Hi Liam

Good updates, but you need to rebase patches on top of the latest mainline tree.

Den søn. 14. jun. 2020 kl. 06.04 skrev Liam Beguin <[email protected]>:

Quoted 115 lines

From: Liam Beguin <[email protected]>

Add alarm support for the pcf2127 RTC chip family. Tested on pca2129.

---
Changes since v1:
- Add calls to pcf2127_wdt_active_ping after accessing CTRL2
- Cleanup calls to regmap_{read,write,update_bits}
- Cleanup debug trace
- Add interrupt handler, untested because of hardware limitations
- Add wakeup-source devicetree option

 drivers/rtc/rtc-pcf2127.c | 169 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 166 insertions(+), 3 deletions(-)
drivers/rtc/rtc-pcf2127.c +60 -0
index 396a1144a213..87ecb29247c6 100644
@@ -20,6 +20,7 @@
 #include <linux/slab.h>
 #include <linux/module.h>
 #include <linux/of.h>
+#include <linux/of_irq.h>
 #include <linux/regmap.h>
 #include <linux/watchdog.h>
 
@@ -28,7 +29,9 @@
 #define PCF2127_BIT_CTRL1_TSF1                 BIT(4)
 /* Control register 2 */
 #define PCF2127_REG_CTRL2              0x01
+#define PCF2127_BIT_CTRL2_AIE                  BIT(1)
 #define PCF2127_BIT_CTRL2_TSIE                 BIT(2)
+#define PCF2127_BIT_CTRL2_AF                   BIT(4)
 #define PCF2127_BIT_CTRL2_TSF2                 BIT(5)
 /* Control register 3 */
 #define PCF2127_REG_CTRL3              0x02
@@ -46,6 +49,12 @@
 #define PCF2127_REG_DW                 0x07
 #define PCF2127_REG_MO                 0x08
 #define PCF2127_REG_YR                 0x09
+/* Alarm registers */
+#define PCF2127_REG_ALARM_SC           0x0A
+#define PCF2127_REG_ALARM_MN           0x0B
+#define PCF2127_REG_ALARM_HR           0x0C
+#define PCF2127_REG_ALARM_DM           0x0D
+#define PCF2127_REG_ALARM_DW           0x0E
 /* Watchdog registers */
 #define PCF2127_REG_WD_CTL             0x10
 #define PCF2127_BIT_WD_CTL_TF0                 BIT(0)
@@ -79,6 +88,8 @@
 #define PCF2127_WD_VAL_MAX             255
 #define PCF2127_WD_VAL_DEFAULT         60
 
+static int pcf2127_wdt_active_ping(struct watchdog_device *wdd);
+
 struct pcf2127 {
        struct rtc_device *rtc;
        struct watchdog_device wdd;
@@ -185,6 +196,140 @@ static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm)
        return 0;
 }
 
+static int pcf2127_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
+{
+       struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+       unsigned int buf[5], ctrl2;
+       int ret;
+
+       ret = regmap_read(pcf2127->regmap, PCF2127_REG_CTRL2, &ctrl2);
+       if (ret) {
+               dev_err(dev, "%s: ctrl2 read error\n", __func__);
+               return ret;
+       }
+
+       ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+       if (ret)
+               return ret;
+
+       ret = regmap_bulk_read(pcf2127->regmap, PCF2127_REG_ALARM_SC, buf,
+                              sizeof(buf));
+       if (ret) {
+               dev_err(dev, "%s: alarm read error\n", __func__);
+               return ret;
+       }
+
+       alrm->enabled = ctrl2 & PCF2127_BIT_CTRL2_AIE;
+       alrm->pending = ctrl2 & PCF2127_BIT_CTRL2_AF;
+
+       alrm->time.tm_sec = bcd2bin(buf[0] & 0x7F);
+       alrm->time.tm_min = bcd2bin(buf[1] & 0x7F);
+       alrm->time.tm_hour = bcd2bin(buf[2] & 0x3F);
+       alrm->time.tm_mday = bcd2bin(buf[3] & 0x3F);
+       alrm->time.tm_wday = buf[4] & 0x07;
+
+       dev_dbg(dev, "%s: alarm is %d:%d:%d, mday=%d, wday=%d\n", __func__,
+               alrm->time.tm_hour, alrm->time.tm_min, alrm->time.tm_sec,
+               alrm->time.tm_mday, alrm->time.tm_wday);
+
+       return 0;
+}
+
+static int pcf2127_rtc_alarm_irq_enable(struct device *dev, u32 enable)
+{
+       struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+       int ret;
+
+       ret = regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+                                PCF2127_BIT_CTRL2_AIE,
+                                enable ? PCF2127_BIT_CTRL2_AIE : 0);
+       if (ret) {
+               dev_err(dev, "%s: failed to %s alarm (%d)\n", __func__,

drivers/rtc/rtc-pcf2127.c static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm) · line 257

Quoted 10 lines
drivers/rtc/rtc-pcf2127.c +10 -0
+                       enable ? "enable" : "disable",
+                       ret);
+               return ret;
+       }
+
+       ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+       if (ret)
+               return ret;
+
+       return 0;

Just do "return ret;" unconditional.

Quoted 59 lines
drivers/rtc/rtc-pcf2127.c +59 -0
+}
+
+static int pcf2127_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
+{
+       struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+       uint8_t buf[5];
+       int ret;
+
+       ret = regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+                                PCF2127_BIT_CTRL2_AF, 0);
+       if (ret) {
+               dev_err(dev, "%s: failed to clear alarm interrupt flag (%d)",
+                       __func__, ret);
+               return ret;
+       }
+
+       ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+       if (ret)
+               return ret;
+
+       buf[0] = bin2bcd(alrm->time.tm_sec);
+       buf[1] = bin2bcd(alrm->time.tm_min);
+       buf[2] = bin2bcd(alrm->time.tm_hour);
+       buf[3] = bin2bcd(alrm->time.tm_mday);
+       buf[4] = (alrm->time.tm_wday & 0x07);
+
+       dev_dbg(dev, "%s: alarm set for: %d:%d:%d, mday=%d, wday=%d\n",
+               __func__, alrm->time.tm_hour, alrm->time.tm_min,
+               alrm->time.tm_sec, alrm->time.tm_mday, alrm->time.tm_wday);
+
+       ret = regmap_bulk_write(pcf2127->regmap, PCF2127_REG_ALARM_SC, buf,
+                               sizeof(buf));
+       if (ret) {
+               dev_err(dev, "%s: failed to write alarm registers (%d)",
+                       __func__, ret);
+               return ret;
+       }
+
+       pcf2127_rtc_alarm_irq_enable(dev, alrm->enabled);
+
+       return 0;
+}
+
+static irqreturn_t pcf2127_rtc_irq(int irq, void *dev)
+{
+       struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+       unsigned int ctrl2 = 0;
+       int ret = 0;
+
+       ret = regmap_read(pcf2127->regmap, PCF2127_REG_CTRL2, &ctrl2);
+       if (ret) {
+               dev_err(dev, "%s: ctrl2 read error (%d)\n", __func__, ret);
+               goto irq_err;
+       }
+
+       ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+       if (ret)
+               goto irq_err;
+

drivers/rtc/rtc-pcf2127.c static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm) · line 326

Quoted 10 lines
drivers/rtc/rtc-pcf2127.c +10 -0
+       if (ctrl2 & PCF2127_BIT_CTRL2_AF) {
+               regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+                                  PCF2127_BIT_CTRL2_AF, 0);
+
+               ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+               if (ret)
+                       goto irq_err;
+
+               rtc_update_irq(pcf2127->rtc, 1, RTC_IRQF | RTC_AF);
+       }

Do pcf2127_wdt_active_ping() here to avoid having the same code twice in the function.

/Bruno

Quoted 57 lines
drivers/rtc/rtc-pcf2127.c +27 -4
+
+       return IRQ_HANDLED;
+irq_err:
+       return IRQ_NONE;
+}
+
 #ifdef CONFIG_RTC_INTF_DEV
 static int pcf2127_rtc_ioctl(struct device *dev,
                                unsigned int cmd, unsigned long arg)
@@ -211,9 +356,12 @@ static int pcf2127_rtc_ioctl(struct device *dev,
 #endif
 
 static const struct rtc_class_ops pcf2127_rtc_ops = {
-       .ioctl          = pcf2127_rtc_ioctl,
-       .read_time      = pcf2127_rtc_read_time,
-       .set_time       = pcf2127_rtc_set_time,
+       .ioctl            = pcf2127_rtc_ioctl,
+       .read_time        = pcf2127_rtc_read_time,
+       .set_time         = pcf2127_rtc_set_time,
+       .read_alarm       = pcf2127_rtc_read_alarm,
+       .set_alarm        = pcf2127_rtc_set_alarm,
+       .alarm_irq_enable = pcf2127_rtc_alarm_irq_enable,
 };
 
 static int pcf2127_nvmem_read(void *priv, unsigned int offset,
@@ -415,6 +563,7 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
                        const char *name, bool has_nvmem)
 {
        struct pcf2127 *pcf2127;
+       int alarm_irq = 0;
        u32 wdd_timeout;
        int ret = 0;
 
@@ -434,6 +583,20 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
 
        pcf2127->rtc->ops = &pcf2127_rtc_ops;
 
+       alarm_irq = of_irq_get_byname(dev->of_node, "alarm");
+       if (alarm_irq >= 0) {
+               ret = devm_request_irq(dev, alarm_irq, pcf2127_rtc_irq,
+                                      IRQF_TRIGGER_LOW | IRQF_ONESHOT,
+                                      dev_name(dev), dev);
+               if (ret) {
+                       dev_err(dev, "failed to request alarm irq\n");
+                       return ret;
+               }
+       }
+
+       if (alarm_irq >= 0 || device_property_read_bool(dev, "wakeup-source"))
+               device_init_wakeup(dev, true);
+
        pcf2127->wdd.parent = dev;
        pcf2127->wdd.info = &pcf2127_wdt_info;
        pcf2127->wdd.ops = &pcf2127_watchdog_ops;
--

2.27.0

#6 lore raw
Quoted 53 lines · Bruno Thomsen
Quoted 53 lines
drivers/rtc/rtc-pcf2127.c +53 -0
+static int pcf2127_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
+{
+       struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+       unsigned int buf[5], ctrl2;
+       int ret;
+
+       ret = regmap_read(pcf2127->regmap, PCF2127_REG_CTRL2, &ctrl2);
+       if (ret) {
+               dev_err(dev, "%s: ctrl2 read error\n", __func__);
+               return ret;
+       }
+
+       ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+       if (ret)
+               return ret;
+
+       ret = regmap_bulk_read(pcf2127->regmap, PCF2127_REG_ALARM_SC, buf,
+                              sizeof(buf));
+       if (ret) {
+               dev_err(dev, "%s: alarm read error\n", __func__);
+               return ret;
+       }
+
+       alrm->enabled = ctrl2 & PCF2127_BIT_CTRL2_AIE;
+       alrm->pending = ctrl2 & PCF2127_BIT_CTRL2_AF;
+
+       alrm->time.tm_sec = bcd2bin(buf[0] & 0x7F);
+       alrm->time.tm_min = bcd2bin(buf[1] & 0x7F);
+       alrm->time.tm_hour = bcd2bin(buf[2] & 0x3F);
+       alrm->time.tm_mday = bcd2bin(buf[3] & 0x3F);
+       alrm->time.tm_wday = buf[4] & 0x07;
+
+       dev_dbg(dev, "%s: alarm is %d:%d:%d, mday=%d, wday=%d\n", __func__,
+               alrm->time.tm_hour, alrm->time.tm_min, alrm->time.tm_sec,
+               alrm->time.tm_mday, alrm->time.tm_wday);
+
+       return 0;
+}
+
+static int pcf2127_rtc_alarm_irq_enable(struct device *dev, u32 enable)
+{
+       struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+       int ret;
+
+       ret = regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+                                PCF2127_BIT_CTRL2_AIE,
+                                enable ? PCF2127_BIT_CTRL2_AIE : 0);
+       if (ret) {
+               dev_err(dev, "%s: failed to %s alarm (%d)\n", __func__,
+                       enable ? "enable" : "disable",
+                       ret);
+               return ret;
+       }
Quoted 9 lines

drivers/rtc/rtc-pcf2127.c static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm) · line 235

Quoted 6 lines
drivers/rtc/rtc-pcf2127.c +6 -0
+
+       ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+       if (ret)
+               return ret;
+
+       return 0;

Just do "return ret;" unconditional.

Just return pcf2127_wdt_active_ping(&pcf2127->wdd);

Signature · 3 lines
Alexandre Belloni, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#7 lore raw
In reply to Bruno Thomsen

Hi Bruno,

Quoted 3 lines · Bruno Thomsen

Hi Liam

Good updates, but you need to rebase patches on top of the latest mainline tree.

Thanks, I'll rebase before sending v3.

Quoted 194 lines

Den søn. 14. jun. 2020 kl. 06.04 skrev Liam Beguin <[email protected]>:

Quoted 115 lines

From: Liam Beguin <[email protected]>

Add alarm support for the pcf2127 RTC chip family. Tested on pca2129.

---
Changes since v1:
- Add calls to pcf2127_wdt_active_ping after accessing CTRL2
- Cleanup calls to regmap_{read,write,update_bits}
- Cleanup debug trace
- Add interrupt handler, untested because of hardware limitations
- Add wakeup-source devicetree option

 drivers/rtc/rtc-pcf2127.c | 169 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 166 insertions(+), 3 deletions(-)
drivers/rtc/rtc-pcf2127.c +60 -0
index 396a1144a213..87ecb29247c6 100644
@@ -20,6 +20,7 @@
 #include <linux/slab.h>
 #include <linux/module.h>
 #include <linux/of.h>
+#include <linux/of_irq.h>
 #include <linux/regmap.h>
 #include <linux/watchdog.h>
 
@@ -28,7 +29,9 @@
 #define PCF2127_BIT_CTRL1_TSF1                 BIT(4)
 /* Control register 2 */
 #define PCF2127_REG_CTRL2              0x01
+#define PCF2127_BIT_CTRL2_AIE                  BIT(1)
 #define PCF2127_BIT_CTRL2_TSIE                 BIT(2)
+#define PCF2127_BIT_CTRL2_AF                   BIT(4)
 #define PCF2127_BIT_CTRL2_TSF2                 BIT(5)
 /* Control register 3 */
 #define PCF2127_REG_CTRL3              0x02
@@ -46,6 +49,12 @@
 #define PCF2127_REG_DW                 0x07
 #define PCF2127_REG_MO                 0x08
 #define PCF2127_REG_YR                 0x09
+/* Alarm registers */
+#define PCF2127_REG_ALARM_SC           0x0A
+#define PCF2127_REG_ALARM_MN           0x0B
+#define PCF2127_REG_ALARM_HR           0x0C
+#define PCF2127_REG_ALARM_DM           0x0D
+#define PCF2127_REG_ALARM_DW           0x0E
 /* Watchdog registers */
 #define PCF2127_REG_WD_CTL             0x10
 #define PCF2127_BIT_WD_CTL_TF0                 BIT(0)
@@ -79,6 +88,8 @@
 #define PCF2127_WD_VAL_MAX             255
 #define PCF2127_WD_VAL_DEFAULT         60
 
+static int pcf2127_wdt_active_ping(struct watchdog_device *wdd);
+
 struct pcf2127 {
        struct rtc_device *rtc;
        struct watchdog_device wdd;
@@ -185,6 +196,140 @@ static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm)
        return 0;
 }
 
+static int pcf2127_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
+{
+       struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+       unsigned int buf[5], ctrl2;
+       int ret;
+
+       ret = regmap_read(pcf2127->regmap, PCF2127_REG_CTRL2, &ctrl2);
+       if (ret) {
+               dev_err(dev, "%s: ctrl2 read error\n", __func__);
+               return ret;
+       }
+
+       ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+       if (ret)
+               return ret;
+
+       ret = regmap_bulk_read(pcf2127->regmap, PCF2127_REG_ALARM_SC, buf,
+                              sizeof(buf));
+       if (ret) {
+               dev_err(dev, "%s: alarm read error\n", __func__);
+               return ret;
+       }
+
+       alrm->enabled = ctrl2 & PCF2127_BIT_CTRL2_AIE;
+       alrm->pending = ctrl2 & PCF2127_BIT_CTRL2_AF;
+
+       alrm->time.tm_sec = bcd2bin(buf[0] & 0x7F);
+       alrm->time.tm_min = bcd2bin(buf[1] & 0x7F);
+       alrm->time.tm_hour = bcd2bin(buf[2] & 0x3F);
+       alrm->time.tm_mday = bcd2bin(buf[3] & 0x3F);
+       alrm->time.tm_wday = buf[4] & 0x07;
+
+       dev_dbg(dev, "%s: alarm is %d:%d:%d, mday=%d, wday=%d\n", __func__,
+               alrm->time.tm_hour, alrm->time.tm_min, alrm->time.tm_sec,
+               alrm->time.tm_mday, alrm->time.tm_wday);
+
+       return 0;
+}
+
+static int pcf2127_rtc_alarm_irq_enable(struct device *dev, u32 enable)
+{
+       struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+       int ret;
+
+       ret = regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+                                PCF2127_BIT_CTRL2_AIE,
+                                enable ? PCF2127_BIT_CTRL2_AIE : 0);
+       if (ret) {
+               dev_err(dev, "%s: failed to %s alarm (%d)\n", __func__,

drivers/rtc/rtc-pcf2127.c static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm) · line 257

Quoted 10 lines
drivers/rtc/rtc-pcf2127.c +10 -0
+                       enable ? "enable" : "disable",
+                       ret);
+               return ret;
+       }
+
+       ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+       if (ret)
+               return ret;
+
+       return 0;

Just do "return ret;" unconditional.

Quoted 64 lines
drivers/rtc/rtc-pcf2127.c +64 -0
+}
+
+static int pcf2127_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
+{
+       struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+       uint8_t buf[5];
+       int ret;
+
+       ret = regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+                                PCF2127_BIT_CTRL2_AF, 0);
+       if (ret) {
+               dev_err(dev, "%s: failed to clear alarm interrupt flag (%d)",
+                       __func__, ret);
+               return ret;
+       }
+
+       ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+       if (ret)
+               return ret;
+
+       buf[0] = bin2bcd(alrm->time.tm_sec);
+       buf[1] = bin2bcd(alrm->time.tm_min);
+       buf[2] = bin2bcd(alrm->time.tm_hour);
+       buf[3] = bin2bcd(alrm->time.tm_mday);
+       buf[4] = (alrm->time.tm_wday & 0x07);
+
+       dev_dbg(dev, "%s: alarm set for: %d:%d:%d, mday=%d, wday=%d\n",
+               __func__, alrm->time.tm_hour, alrm->time.tm_min,
+               alrm->time.tm_sec, alrm->time.tm_mday, alrm->time.tm_wday);
+
+       ret = regmap_bulk_write(pcf2127->regmap, PCF2127_REG_ALARM_SC, buf,
+                               sizeof(buf));
+       if (ret) {
+               dev_err(dev, "%s: failed to write alarm registers (%d)",
+                       __func__, ret);
+               return ret;
+       }
+
+       pcf2127_rtc_alarm_irq_enable(dev, alrm->enabled);
+
+       return 0;
+}
+
+static irqreturn_t pcf2127_rtc_irq(int irq, void *dev)
+{
+       struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+       unsigned int ctrl2 = 0;
+       int ret = 0;
+
+       ret = regmap_read(pcf2127->regmap, PCF2127_REG_CTRL2, &ctrl2);
+       if (ret) {
+               dev_err(dev, "%s: ctrl2 read error (%d)\n", __func__, ret);
+               goto irq_err;
+       }
+
+       ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+       if (ret)
+               goto irq_err;
+
+       if (ctrl2 & PCF2127_BIT_CTRL2_AF) {
+               regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+                                  PCF2127_BIT_CTRL2_AF, 0);
+
+               ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
Quoted 8 lines

drivers/rtc/rtc-pcf2127.c static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm) · line 326

Quoted 5 lines
drivers/rtc/rtc-pcf2127.c +5 -0
+               if (ret)
+                       goto irq_err;
+
+               rtc_update_irq(pcf2127->rtc, 1, RTC_IRQF | RTC_AF);
+       }

Do pcf2127_wdt_active_ping() here to avoid having the same code twice in the function.

That looks better, I'll update.

Thanks,
Liam

Quoted 60 lines

/Bruno

Quoted 57 lines
drivers/rtc/rtc-pcf2127.c +27 -4
+
+       return IRQ_HANDLED;
+irq_err:
+       return IRQ_NONE;
+}
+
 #ifdef CONFIG_RTC_INTF_DEV
 static int pcf2127_rtc_ioctl(struct device *dev,
                                unsigned int cmd, unsigned long arg)
@@ -211,9 +356,12 @@ static int pcf2127_rtc_ioctl(struct device *dev,
 #endif
 
 static const struct rtc_class_ops pcf2127_rtc_ops = {
-       .ioctl          = pcf2127_rtc_ioctl,
-       .read_time      = pcf2127_rtc_read_time,
-       .set_time       = pcf2127_rtc_set_time,
+       .ioctl            = pcf2127_rtc_ioctl,
+       .read_time        = pcf2127_rtc_read_time,
+       .set_time         = pcf2127_rtc_set_time,
+       .read_alarm       = pcf2127_rtc_read_alarm,
+       .set_alarm        = pcf2127_rtc_set_alarm,
+       .alarm_irq_enable = pcf2127_rtc_alarm_irq_enable,
 };
 
 static int pcf2127_nvmem_read(void *priv, unsigned int offset,
@@ -415,6 +563,7 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
                        const char *name, bool has_nvmem)
 {
        struct pcf2127 *pcf2127;
+       int alarm_irq = 0;
        u32 wdd_timeout;
        int ret = 0;
 
@@ -434,6 +583,20 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
 
        pcf2127->rtc->ops = &pcf2127_rtc_ops;
 
+       alarm_irq = of_irq_get_byname(dev->of_node, "alarm");
+       if (alarm_irq >= 0) {
+               ret = devm_request_irq(dev, alarm_irq, pcf2127_rtc_irq,
+                                      IRQF_TRIGGER_LOW | IRQF_ONESHOT,
+                                      dev_name(dev), dev);
+               if (ret) {
+                       dev_err(dev, "failed to request alarm irq\n");
+                       return ret;
+               }
+       }
+
+       if (alarm_irq >= 0 || device_property_read_bool(dev, "wakeup-source"))
+               device_init_wakeup(dev, true);
+
        pcf2127->wdd.parent = dev;
        pcf2127->wdd.info = &pcf2127_wdt_info;
        pcf2127->wdd.ops = &pcf2127_watchdog_ops;
--

2.27.0

#8 lore raw
In reply to Liam Beguin

Hi,

Quoted 53 lines · Liam Beguin

From: Liam Beguin <[email protected]>

Add alarm support for the pcf2127 RTC chip family. Tested on pca2129.

---
Changes since v1:
- Add calls to pcf2127_wdt_active_ping after accessing CTRL2
- Cleanup calls to regmap_{read,write,update_bits}
- Cleanup debug trace
- Add interrupt handler, untested because of hardware limitations
- Add wakeup-source devicetree option

 drivers/rtc/rtc-pcf2127.c | 169 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 166 insertions(+), 3 deletions(-)
drivers/rtc/rtc-pcf2127.c +9 -0
index 396a1144a213..87ecb29247c6 100644
@@ -20,6 +20,7 @@
 #include <linux/slab.h>
 #include <linux/module.h>
 #include <linux/of.h>
+#include <linux/of_irq.h>
 #include <linux/regmap.h>
 #include <linux/watchdog.h>
 
@@ -28,7 +29,9 @@
 #define PCF2127_BIT_CTRL1_TSF1			BIT(4)
 /* Control register 2 */
 #define PCF2127_REG_CTRL2		0x01
+#define PCF2127_BIT_CTRL2_AIE			BIT(1)
 #define PCF2127_BIT_CTRL2_TSIE			BIT(2)
+#define PCF2127_BIT_CTRL2_AF			BIT(4)
 #define PCF2127_BIT_CTRL2_TSF2			BIT(5)
 /* Control register 3 */
 #define PCF2127_REG_CTRL3		0x02
@@ -46,6 +49,12 @@
 #define PCF2127_REG_DW			0x07
 #define PCF2127_REG_MO			0x08
 #define PCF2127_REG_YR			0x09
+/* Alarm registers */
+#define PCF2127_REG_ALARM_SC		0x0A
+#define PCF2127_REG_ALARM_MN		0x0B
+#define PCF2127_REG_ALARM_HR		0x0C
+#define PCF2127_REG_ALARM_DM		0x0D
+#define PCF2127_REG_ALARM_DW		0x0E
 /* Watchdog registers */
 #define PCF2127_REG_WD_CTL		0x10
 #define PCF2127_BIT_WD_CTL_TF0			BIT(0)

drivers/rtc/rtc-pcf2127.c line 92

Quoted 5 lines
drivers/rtc/rtc-pcf2127.c +2 -0
@@ -79,6 +88,8 @@
 #define PCF2127_WD_VAL_MAX		255
 #define PCF2127_WD_VAL_DEFAULT		60
 
+static int pcf2127_wdt_active_ping(struct watchdog_device *wdd);
+

This forward declaration should be avoided.

Quoted 6 lines
drivers/rtc/rtc-pcf2127.c +0 -0
 struct pcf2127 {
 	struct rtc_device *rtc;
 	struct watchdog_device wdd;
@@ -185,6 +196,140 @@ static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm)
 	return 0;
 }

drivers/rtc/rtc-pcf2127.c static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm) · line 207

Quoted 10 lines
drivers/rtc/rtc-pcf2127.c +9 -0
 
+static int pcf2127_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
+{
+	struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+	unsigned int buf[5], ctrl2;
+	int ret;
+
+	ret = regmap_read(pcf2127->regmap, PCF2127_REG_CTRL2, &ctrl2);
+	if (ret) {
+		dev_err(dev, "%s: ctrl2 read error\n", __func__);

Honestly, I would prefer avoiding adding so many strings in the driver. The reality is that nobody will look into dmesg to know what was the issue and even if somebody does, the solution would simply be to start the operation again. Something that can already be deducted when returning a simple error code. (This is valid for the subsequent dev_err).

Quoted 17 lines
drivers/rtc/rtc-pcf2127.c +17 -0
+		return ret;
+	}
+
+	ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+	if (ret)
+		return ret;
+
+	ret = regmap_bulk_read(pcf2127->regmap, PCF2127_REG_ALARM_SC, buf,
+			       sizeof(buf));
+	if (ret) {
+		dev_err(dev, "%s: alarm read error\n", __func__);
+		return ret;
+	}
+
+	alrm->enabled = ctrl2 & PCF2127_BIT_CTRL2_AIE;
+	alrm->pending = ctrl2 & PCF2127_BIT_CTRL2_AF;
+

drivers/rtc/rtc-pcf2127.c static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm) · line 234

Quoted 10 lines
drivers/rtc/rtc-pcf2127.c +10 -0
+	alrm->time.tm_sec = bcd2bin(buf[0] & 0x7F);
+	alrm->time.tm_min = bcd2bin(buf[1] & 0x7F);
+	alrm->time.tm_hour = bcd2bin(buf[2] & 0x3F);
+	alrm->time.tm_mday = bcd2bin(buf[3] & 0x3F);
+	alrm->time.tm_wday = buf[4] & 0x07;
+
+	dev_dbg(dev, "%s: alarm is %d:%d:%d, mday=%d, wday=%d\n", __func__,
+		alrm->time.tm_hour, alrm->time.tm_min, alrm->time.tm_sec,
+		alrm->time.tm_mday, alrm->time.tm_wday);
+

It is generally not useful to have those debug strings anymore because the core already provides tracepoints at the correct locations.

If you really want to keep it, then please use %ptR.

This is also valid for the other dev_dbg.

Quoted 75 lines
drivers/rtc/rtc-pcf2127.c +75 -0
+	return 0;
+}
+
+static int pcf2127_rtc_alarm_irq_enable(struct device *dev, u32 enable)
+{
+	struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+	int ret;
+
+	ret = regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+				 PCF2127_BIT_CTRL2_AIE,
+				 enable ? PCF2127_BIT_CTRL2_AIE : 0);
+	if (ret) {
+		dev_err(dev, "%s: failed to %s alarm (%d)\n", __func__,
+			enable ? "enable" : "disable",
+			ret);
+		return ret;
+	}
+
+	ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+	if (ret)
+		return ret;
+
+	return 0;
+}
+
+static int pcf2127_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
+{
+	struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+	uint8_t buf[5];
+	int ret;
+
+	ret = regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+				 PCF2127_BIT_CTRL2_AF, 0);
+	if (ret) {
+		dev_err(dev, "%s: failed to clear alarm interrupt flag (%d)",
+			__func__, ret);
+		return ret;
+	}
+
+	ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+	if (ret)
+		return ret;
+
+	buf[0] = bin2bcd(alrm->time.tm_sec);
+	buf[1] = bin2bcd(alrm->time.tm_min);
+	buf[2] = bin2bcd(alrm->time.tm_hour);
+	buf[3] = bin2bcd(alrm->time.tm_mday);
+	buf[4] = (alrm->time.tm_wday & 0x07);
+
+	dev_dbg(dev, "%s: alarm set for: %d:%d:%d, mday=%d, wday=%d\n",
+		__func__, alrm->time.tm_hour, alrm->time.tm_min,
+		alrm->time.tm_sec, alrm->time.tm_mday, alrm->time.tm_wday);
+
+	ret = regmap_bulk_write(pcf2127->regmap, PCF2127_REG_ALARM_SC, buf,
+				sizeof(buf));
+	if (ret) {
+		dev_err(dev, "%s: failed to write alarm registers (%d)",
+			__func__, ret);
+		return ret;
+	}
+
+	pcf2127_rtc_alarm_irq_enable(dev, alrm->enabled);
+
+	return 0;
+}
+
+static irqreturn_t pcf2127_rtc_irq(int irq, void *dev)
+{
+	struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+	unsigned int ctrl2 = 0;
+	int ret = 0;
+
+	ret = regmap_read(pcf2127->regmap, PCF2127_REG_CTRL2, &ctrl2);
+	if (ret) {
+		dev_err(dev, "%s: ctrl2 read error (%d)\n", __func__, ret);

drivers/rtc/rtc-pcf2127.c static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm) · line 319

Quoted 10 lines
drivers/rtc/rtc-pcf2127.c +10 -0
+		goto irq_err;
+	}
+
+	ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+	if (ret)
+		goto irq_err;
+
+	if (ctrl2 & PCF2127_BIT_CTRL2_AF) {
+		regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+				   PCF2127_BIT_CTRL2_AF, 0);

In that case, I think it makes more sense to use regmap_write as this would avoid another read of ctrl2.

Quoted 47 lines
drivers/rtc/rtc-pcf2127.c +23 -3
+
+		ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+		if (ret)
+			goto irq_err;
+
+		rtc_update_irq(pcf2127->rtc, 1, RTC_IRQF | RTC_AF);
+	}
+
+	return IRQ_HANDLED;
+irq_err:
+	return IRQ_NONE;
+}
+
 #ifdef CONFIG_RTC_INTF_DEV
 static int pcf2127_rtc_ioctl(struct device *dev,
 				unsigned int cmd, unsigned long arg)
@@ -211,9 +356,12 @@ static int pcf2127_rtc_ioctl(struct device *dev,
 #endif
 
 static const struct rtc_class_ops pcf2127_rtc_ops = {
-	.ioctl		= pcf2127_rtc_ioctl,
-	.read_time	= pcf2127_rtc_read_time,
-	.set_time	= pcf2127_rtc_set_time,
+	.ioctl            = pcf2127_rtc_ioctl,
+	.read_time        = pcf2127_rtc_read_time,
+	.set_time         = pcf2127_rtc_set_time,
+	.read_alarm       = pcf2127_rtc_read_alarm,
+	.set_alarm        = pcf2127_rtc_set_alarm,
+	.alarm_irq_enable = pcf2127_rtc_alarm_irq_enable,
 };
 
 static int pcf2127_nvmem_read(void *priv, unsigned int offset,
@@ -415,6 +563,7 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
 			const char *name, bool has_nvmem)
 {
 	struct pcf2127 *pcf2127;
+	int alarm_irq = 0;
 	u32 wdd_timeout;
 	int ret = 0;
 
@@ -434,6 +583,20 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
 
 	pcf2127->rtc->ops = &pcf2127_rtc_ops;
 
+	alarm_irq = of_irq_get_byname(dev->of_node, "alarm");
+	if (alarm_irq >= 0) {
+		ret = devm_request_irq(dev, alarm_irq, pcf2127_rtc_irq,

drivers/rtc/rtc-pcf2127.c static int pcf2127_probe(struct device *dev, struct regmap *regmap, · line 598

Quoted 10 lines
drivers/rtc/rtc-pcf2127.c +10 -0
+				       IRQF_TRIGGER_LOW | IRQF_ONESHOT,
+				       dev_name(dev), dev);
+		if (ret) {
+			dev_err(dev, "failed to request alarm irq\n");
+			return ret;
+		}
+	}
+
+	if (alarm_irq >= 0 || device_property_read_bool(dev, "wakeup-source"))
+		device_init_wakeup(dev, true);

The last thing here is that you should have two different rtc_class_ops struct, one with alarm and the other one without. at this point, you know which one you should use. I know this is not convenient but I'm working on a series to make things better. Until this is ready, this is what we will have to live with.

Signature · 3 lines
Alexandre Belloni, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#9 lore raw

Hi Alexandre,

Quoted 59 lines · Alexandre Belloni

Hi,

Quoted 56 lines · Liam Beguin

From: Liam Beguin <[email protected]>

Add alarm support for the pcf2127 RTC chip family. Tested on pca2129.

---
Changes since v1:
- Add calls to pcf2127_wdt_active_ping after accessing CTRL2
- Cleanup calls to regmap_{read,write,update_bits}
- Cleanup debug trace
- Add interrupt handler, untested because of hardware limitations
- Add wakeup-source devicetree option

 drivers/rtc/rtc-pcf2127.c | 169 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 166 insertions(+), 3 deletions(-)
drivers/rtc/rtc-pcf2127.c +9 -0
index 396a1144a213..87ecb29247c6 100644
@@ -20,6 +20,7 @@
 #include <linux/slab.h>
 #include <linux/module.h>
 #include <linux/of.h>
+#include <linux/of_irq.h>
 #include <linux/regmap.h>
 #include <linux/watchdog.h>
 
@@ -28,7 +29,9 @@
 #define PCF2127_BIT_CTRL1_TSF1			BIT(4)
 /* Control register 2 */
 #define PCF2127_REG_CTRL2		0x01
+#define PCF2127_BIT_CTRL2_AIE			BIT(1)
 #define PCF2127_BIT_CTRL2_TSIE			BIT(2)
+#define PCF2127_BIT_CTRL2_AF			BIT(4)
 #define PCF2127_BIT_CTRL2_TSF2			BIT(5)
 /* Control register 3 */
 #define PCF2127_REG_CTRL3		0x02
@@ -46,6 +49,12 @@
 #define PCF2127_REG_DW			0x07
 #define PCF2127_REG_MO			0x08
 #define PCF2127_REG_YR			0x09
+/* Alarm registers */
+#define PCF2127_REG_ALARM_SC		0x0A
+#define PCF2127_REG_ALARM_MN		0x0B
+#define PCF2127_REG_ALARM_HR		0x0C
+#define PCF2127_REG_ALARM_DM		0x0D
+#define PCF2127_REG_ALARM_DW		0x0E
 /* Watchdog registers */
 #define PCF2127_REG_WD_CTL		0x10
 #define PCF2127_BIT_WD_CTL_TF0			BIT(0)
@@ -79,6 +88,8 @@
 #define PCF2127_WD_VAL_MAX		255
 #define PCF2127_WD_VAL_DEFAULT		60
 
Quoted 5 lines

drivers/rtc/rtc-pcf2127.c line 92

Quoted 2 lines
drivers/rtc/rtc-pcf2127.c +2 -0
+static int pcf2127_wdt_active_ping(struct watchdog_device *wdd);
+

This forward declaration should be avoided.

I'll try to move things around to avoid this.

Quoted 7 lines
Quoted 7 lines
drivers/rtc/rtc-pcf2127.c +0 -0
 struct pcf2127 {
 	struct rtc_device *rtc;
 	struct watchdog_device wdd;
@@ -185,6 +196,140 @@ static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm)
 	return 0;
 }
 
Quoted 17 lines

drivers/rtc/rtc-pcf2127.c static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm) · line 207

Quoted 9 lines
drivers/rtc/rtc-pcf2127.c +9 -0
+static int pcf2127_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
+{
+	struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+	unsigned int buf[5], ctrl2;
+	int ret;
+
+	ret = regmap_read(pcf2127->regmap, PCF2127_REG_CTRL2, &ctrl2);
+	if (ret) {
+		dev_err(dev, "%s: ctrl2 read error\n", __func__);

Honestly, I would prefer avoiding adding so many strings in the driver. The reality is that nobody will look into dmesg to know what was the issue and even if somebody does, the solution would simply be to start the operation again. Something that can already be deducted when returning a simple error code. (This is valid for the subsequent dev_err).

Understood, I'll get rid of these unnecessary strings.

Quoted 31 lines
Quoted 17 lines
drivers/rtc/rtc-pcf2127.c +17 -0
+		return ret;
+	}
+
+	ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+	if (ret)
+		return ret;
+
+	ret = regmap_bulk_read(pcf2127->regmap, PCF2127_REG_ALARM_SC, buf,
+			       sizeof(buf));
+	if (ret) {
+		dev_err(dev, "%s: alarm read error\n", __func__);
+		return ret;
+	}
+
+	alrm->enabled = ctrl2 & PCF2127_BIT_CTRL2_AIE;
+	alrm->pending = ctrl2 & PCF2127_BIT_CTRL2_AF;
+

drivers/rtc/rtc-pcf2127.c static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm) · line 234

Quoted 10 lines
drivers/rtc/rtc-pcf2127.c +10 -0
+	alrm->time.tm_sec = bcd2bin(buf[0] & 0x7F);
+	alrm->time.tm_min = bcd2bin(buf[1] & 0x7F);
+	alrm->time.tm_hour = bcd2bin(buf[2] & 0x3F);
+	alrm->time.tm_mday = bcd2bin(buf[3] & 0x3F);
+	alrm->time.tm_wday = buf[4] & 0x07;
+
+	dev_dbg(dev, "%s: alarm is %d:%d:%d, mday=%d, wday=%d\n", __func__,
+		alrm->time.tm_hour, alrm->time.tm_min, alrm->time.tm_sec,
+		alrm->time.tm_mday, alrm->time.tm_wday);
+

It is generally not useful to have those debug strings anymore because the core already provides tracepoints at the correct locations.

Quoted 4 lines

If you really want to keep it, then please use %ptR.

This is also valid for the other dev_dbg.

I'm not particularly attached to keeping these in. I just left them in since it seemed to be common in other rtc drivers.

I'll update to use %ptR.

Quoted 80 lines
Quoted 80 lines
drivers/rtc/rtc-pcf2127.c +80 -0
+	return 0;
+}
+
+static int pcf2127_rtc_alarm_irq_enable(struct device *dev, u32 enable)
+{
+	struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+	int ret;
+
+	ret = regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+				 PCF2127_BIT_CTRL2_AIE,
+				 enable ? PCF2127_BIT_CTRL2_AIE : 0);
+	if (ret) {
+		dev_err(dev, "%s: failed to %s alarm (%d)\n", __func__,
+			enable ? "enable" : "disable",
+			ret);
+		return ret;
+	}
+
+	ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+	if (ret)
+		return ret;
+
+	return 0;
+}
+
+static int pcf2127_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
+{
+	struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+	uint8_t buf[5];
+	int ret;
+
+	ret = regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+				 PCF2127_BIT_CTRL2_AF, 0);
+	if (ret) {
+		dev_err(dev, "%s: failed to clear alarm interrupt flag (%d)",
+			__func__, ret);
+		return ret;
+	}
+
+	ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+	if (ret)
+		return ret;
+
+	buf[0] = bin2bcd(alrm->time.tm_sec);
+	buf[1] = bin2bcd(alrm->time.tm_min);
+	buf[2] = bin2bcd(alrm->time.tm_hour);
+	buf[3] = bin2bcd(alrm->time.tm_mday);
+	buf[4] = (alrm->time.tm_wday & 0x07);
+
+	dev_dbg(dev, "%s: alarm set for: %d:%d:%d, mday=%d, wday=%d\n",
+		__func__, alrm->time.tm_hour, alrm->time.tm_min,
+		alrm->time.tm_sec, alrm->time.tm_mday, alrm->time.tm_wday);
+
+	ret = regmap_bulk_write(pcf2127->regmap, PCF2127_REG_ALARM_SC, buf,
+				sizeof(buf));
+	if (ret) {
+		dev_err(dev, "%s: failed to write alarm registers (%d)",
+			__func__, ret);
+		return ret;
+	}
+
+	pcf2127_rtc_alarm_irq_enable(dev, alrm->enabled);
+
+	return 0;
+}
+
+static irqreturn_t pcf2127_rtc_irq(int irq, void *dev)
+{
+	struct pcf2127 *pcf2127 = dev_get_drvdata(dev);
+	unsigned int ctrl2 = 0;
+	int ret = 0;
+
+	ret = regmap_read(pcf2127->regmap, PCF2127_REG_CTRL2, &ctrl2);
+	if (ret) {
+		dev_err(dev, "%s: ctrl2 read error (%d)\n", __func__, ret);
+		goto irq_err;
+	}
+
+	ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+	if (ret)
Quoted 9 lines

drivers/rtc/rtc-pcf2127.c static int pcf2127_rtc_set_time(struct device *dev, struct rtc_time *tm) · line 319

Quoted 5 lines
drivers/rtc/rtc-pcf2127.c +5 -0
+		goto irq_err;
+
+	if (ctrl2 & PCF2127_BIT_CTRL2_AF) {
+		regmap_update_bits(pcf2127->regmap, PCF2127_REG_CTRL2,
+				   PCF2127_BIT_CTRL2_AF, 0);

In that case, I think it makes more sense to use regmap_write as this would avoid another read of ctrl2.

Thanks, will update that.

Quoted 55 lines
Quoted 55 lines
drivers/rtc/rtc-pcf2127.c +31 -3
+
+		ret = pcf2127_wdt_active_ping(&pcf2127->wdd);
+		if (ret)
+			goto irq_err;
+
+		rtc_update_irq(pcf2127->rtc, 1, RTC_IRQF | RTC_AF);
+	}
+
+	return IRQ_HANDLED;
+irq_err:
+	return IRQ_NONE;
+}
+
 #ifdef CONFIG_RTC_INTF_DEV
 static int pcf2127_rtc_ioctl(struct device *dev,
 				unsigned int cmd, unsigned long arg)
@@ -211,9 +356,12 @@ static int pcf2127_rtc_ioctl(struct device *dev,
 #endif
 
 static const struct rtc_class_ops pcf2127_rtc_ops = {
-	.ioctl		= pcf2127_rtc_ioctl,
-	.read_time	= pcf2127_rtc_read_time,
-	.set_time	= pcf2127_rtc_set_time,
+	.ioctl            = pcf2127_rtc_ioctl,
+	.read_time        = pcf2127_rtc_read_time,
+	.set_time         = pcf2127_rtc_set_time,
+	.read_alarm       = pcf2127_rtc_read_alarm,
+	.set_alarm        = pcf2127_rtc_set_alarm,
+	.alarm_irq_enable = pcf2127_rtc_alarm_irq_enable,
 };
 
 static int pcf2127_nvmem_read(void *priv, unsigned int offset,
@@ -415,6 +563,7 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
 			const char *name, bool has_nvmem)
 {
 	struct pcf2127 *pcf2127;
+	int alarm_irq = 0;
 	u32 wdd_timeout;
 	int ret = 0;
 
@@ -434,6 +583,20 @@ static int pcf2127_probe(struct device *dev, struct regmap *regmap,
 
 	pcf2127->rtc->ops = &pcf2127_rtc_ops;
 
+	alarm_irq = of_irq_get_byname(dev->of_node, "alarm");
+	if (alarm_irq >= 0) {
+		ret = devm_request_irq(dev, alarm_irq, pcf2127_rtc_irq,
+				       IRQF_TRIGGER_LOW | IRQF_ONESHOT,
+				       dev_name(dev), dev);
+		if (ret) {
+			dev_err(dev, "failed to request alarm irq\n");
+			return ret;
+		}
+	}
+
Quoted 9 lines

drivers/rtc/rtc-pcf2127.c static int pcf2127_probe(struct device *dev, struct regmap *regmap, · line 598

Quoted 2 lines
drivers/rtc/rtc-pcf2127.c +2 -0
+	if (alarm_irq >= 0 || device_property_read_bool(dev, "wakeup-source"))
+		device_init_wakeup(dev, true);

The last thing here is that you should have two different rtc_class_ops struct, one with alarm and the other one without. at this point, you know which one you should use. I know this is not convenient but I'm working on a series to make things better. Until this is ready, this is what we will have to live with.

Okay, will update that too.

Thanks for your time,
Liam

Quoted 4 lines
Signature · 3 lines
Alexandre Belloni, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#10 lore raw
Quoted 11 lines · Liam Beguin
Quoted 7 lines

It is generally not useful to have those debug strings anymore because the core already provides tracepoints at the correct locations.

If you really want to keep it, then please use %ptR.

This is also valid for the other dev_dbg.

I'm not particularly attached to keeping these in. I just left them in since it seemed to be common in other rtc drivers.

Yes, those predates the tracepoints (which are fairly recent).

Signature · 3 lines
Alexandre Belloni, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com