[2/2] rtc: ds1307: Add support for Epson RX8111
Commit Message
From: Mike Looijmans <mike.looijmans@topic.nl>
The rx_8111 is quite similar to the rx_8030. This adds support for this
chip to the ds1307 driver. Date/time and alarm registers are in the
usual places. The nvmem is located at 0x40. Time stamping is not
supported.
Signed-off-by: Mike Looijmans <mike.looijmans@topic.nl>
---
drivers/rtc/rtc-ds1307.c | 129 ++++++++++++++++++++++++++++++++-------
1 file changed, 107 insertions(+), 22 deletions(-)
Comments
Hello,
On 28/10/2022 16:40:41+0200, glasveze@delta.nl wrote:
> +static u8 do_trickle_setup_rx8111(struct ds1307 *ds1307, u32 ohms, bool diode)
> +{
> + /* make sure that the backup battery is enabled */
> + u8 setup = RX8111_PSC_SMP_INIEN;
You can't do that, else it will never be possible to remove that without
breaking existing users. Instead, you should use
RTC_PARAM_BACKUP_SWITCH_MODE. Honestly, I would really like stopping
adding support for more RTCs in this driver and instead split them all
out.
> +
> + if (diode)
> + setup |= RX8111_PSC_SMP_CHGEN;
> +
> + return setup;
> +}
> +
> static u8 do_trickle_setup_rx8130(struct ds1307 *ds1307, u32 ohms, bool diode)
> {
> /* make sure that the backup battery is enabled */
> @@ -1012,6 +1078,16 @@ static const struct chip_desc chips[last_ds_type] = {
> .century_bit = DS1337_BIT_CENTURY,
> .bbsqi_bit = DS3231_BIT_BBSQW,
> },
> + [rx_8111] = {
> + .alarm = 1,
> + .nvram_offset = 0x40,
> + .nvram_size = 0x40, /* 0x40 .. 0x7F is user RAM */
> + .offset = 0x10,
> + .irq_handler = rx8130_irq,
> + .rtc_ops = &rx8130_rtc_ops,
> + .trickle_charger_reg = RX8111_PWR_SWITCH_CTRL,
> + .do_trickle_setup = &do_trickle_setup_rx8111,
> + },
> [rx_8130] = {
> .alarm = 1,
> /* this is battery backed SRAM */
> @@ -1063,6 +1139,7 @@ static const struct i2c_device_id ds1307_id[] = {
> { "pt7c4338", ds_1307 },
> { "rx8025", rx_8025 },
> { "isl12057", ds_1337 },
> + { "rx8111", rx_8111 },
> { "rx8130", rx_8130 },
> { }
> };
> @@ -1137,6 +1214,10 @@ static const struct of_device_id ds1307_of_match[] = {
> .compatible = "isil,isl12057",
> .data = (void *)ds_1337
> },
> + {
> + .compatible = "epson,rx8111",
> + .data = (void *)rx_8111
> + },
> {
> .compatible = "epson,rx8130",
> .data = (void *)rx_8130
> @@ -1880,6 +1961,10 @@ static int ds1307_probe(struct i2c_client *client,
> DS1307_REG_HOUR << 4 | 0x08, hour);
> }
> break;
> + case rx_8111:
> + /* Use memory as user RAM */
> + regmap_write(ds1307->regmap, RX8111_TIME_STAMP_BUF_CTRL, 0);
> + break;
> case ds_1388:
> err = regmap_read(ds1307->regmap, DS1388_REG_CONTROL, &tmp);
> if (err) {
> --
> 2.17.1
>
@@ -46,6 +46,7 @@ enum ds_type {
m41t11,
mcp794xx,
rx_8025,
+ rx_8111,
rx_8130,
last_ds_type /* always last */
/* rs5c372 too? different address... */
@@ -113,6 +114,14 @@ enum ds_type {
# define RX8025_BIT_VDET 0x40
# define RX8025_BIT_XST 0x20
+#define RX8111_FLAG 0x1e
+# define RX8111_FLAG_VLF BIT(1)
+# define RX8111_FLAG_AF BIT(3)
+#define RX8111_PWR_SWITCH_CTRL 0x32
+# define RX8111_PSC_SMP_INIEN BIT(6)
+# define RX8111_PSC_SMP_CHGEN BIT(7)
+#define RX8111_TIME_STAMP_BUF_CTRL 0x34
+
#define RX8130_REG_ALARM_MIN 0x17
#define RX8130_REG_ALARM_HOUR 0x18
#define RX8130_REG_ALARM_WEEK_OR_DAY 0x19
@@ -205,6 +214,68 @@ struct chip_desc {
static const struct chip_desc chips[last_ds_type];
+static int ds1307_check_voltage_lost(struct ds1307 *ds1307)
+{
+ int ret;
+ unsigned int reg;
+ unsigned int mask;
+ unsigned int regflag;
+
+ switch (ds1307->type) {
+ case rx_8111:
+ reg = RX8111_FLAG;
+ mask = RX8111_FLAG_VLF;
+ break;
+ case rx_8130:
+ reg = RX8130_REG_FLAG;
+ mask = RX8130_REG_FLAG_VLF;
+ break;
+ default:
+ return 0;
+ }
+
+ ret = regmap_read(ds1307->regmap, reg, ®flag);
+ if (ret) {
+ dev_err(ds1307->dev, "%s error %d\n", "read", ret);
+ return ret;
+ }
+
+ if (regflag & mask) {
+ dev_warn_once(ds1307->dev, "oscillator failed, set time!\n");
+ return -EINVAL;
+ }
+
+ return 0;
+}
+
+static int ds1307_clear_voltage_lost(struct ds1307 *ds1307)
+{
+ int ret;
+ unsigned int reg;
+ unsigned int mask;
+
+ switch (ds1307->type) {
+ case rx_8111:
+ reg = RX8111_FLAG;
+ mask = (unsigned int)~RX8111_FLAG_VLF;
+ break;
+ case rx_8130:
+ reg = RX8130_REG_FLAG;
+ mask = (unsigned int)~RX8130_REG_FLAG_VLF;
+ break;
+ default:
+ return 0;
+ }
+
+ ret = regmap_write(ds1307->regmap, reg, mask);
+ if (ret) {
+ dev_err(ds1307->dev, "%s error %d\n", "write", ret);
+ return ret;
+ }
+
+ return 0;
+}
+
static int ds1307_get_time(struct device *dev, struct rtc_time *t)
{
struct ds1307 *ds1307 = dev_get_drvdata(dev);
@@ -212,19 +283,9 @@ static int ds1307_get_time(struct device *dev, struct rtc_time *t)
const struct chip_desc *chip = &chips[ds1307->type];
u8 regs[7];
- if (ds1307->type == rx_8130) {
- unsigned int regflag;
- ret = regmap_read(ds1307->regmap, RX8130_REG_FLAG, ®flag);
- if (ret) {
- dev_err(dev, "%s error %d\n", "read", ret);
- return ret;
- }
-
- if (regflag & RX8130_REG_FLAG_VLF) {
- dev_warn_once(dev, "oscillator failed, set time!\n");
- return -EINVAL;
- }
- }
+ ret = ds1307_check_voltage_lost(ds1307);
+ if (ret)
+ return ret;
/* read the RTC date and time registers all at once */
ret = regmap_bulk_read(ds1307->regmap, chip->offset, regs,
@@ -397,15 +458,9 @@ static int ds1307_set_time(struct device *dev, struct rtc_time *t)
return result;
}
- if (ds1307->type == rx_8130) {
- /* clear Voltage Loss Flag as data is available now */
- result = regmap_write(ds1307->regmap, RX8130_REG_FLAG,
- ~(u8)RX8130_REG_FLAG_VLF);
- if (result) {
- dev_err(dev, "%s error %d\n", "write", result);
- return result;
- }
- }
+ result = ds1307_clear_voltage_lost(ds1307);
+ if (result)
+ return result;
return 0;
}
@@ -541,6 +596,17 @@ static u8 do_trickle_setup_ds1339(struct ds1307 *ds1307, u32 ohms, bool diode)
return setup;
}
+static u8 do_trickle_setup_rx8111(struct ds1307 *ds1307, u32 ohms, bool diode)
+{
+ /* make sure that the backup battery is enabled */
+ u8 setup = RX8111_PSC_SMP_INIEN;
+
+ if (diode)
+ setup |= RX8111_PSC_SMP_CHGEN;
+
+ return setup;
+}
+
static u8 do_trickle_setup_rx8130(struct ds1307 *ds1307, u32 ohms, bool diode)
{
/* make sure that the backup battery is enabled */
@@ -1012,6 +1078,16 @@ static const struct chip_desc chips[last_ds_type] = {
.century_bit = DS1337_BIT_CENTURY,
.bbsqi_bit = DS3231_BIT_BBSQW,
},
+ [rx_8111] = {
+ .alarm = 1,
+ .nvram_offset = 0x40,
+ .nvram_size = 0x40, /* 0x40 .. 0x7F is user RAM */
+ .offset = 0x10,
+ .irq_handler = rx8130_irq,
+ .rtc_ops = &rx8130_rtc_ops,
+ .trickle_charger_reg = RX8111_PWR_SWITCH_CTRL,
+ .do_trickle_setup = &do_trickle_setup_rx8111,
+ },
[rx_8130] = {
.alarm = 1,
/* this is battery backed SRAM */
@@ -1063,6 +1139,7 @@ static const struct i2c_device_id ds1307_id[] = {
{ "pt7c4338", ds_1307 },
{ "rx8025", rx_8025 },
{ "isl12057", ds_1337 },
+ { "rx8111", rx_8111 },
{ "rx8130", rx_8130 },
{ }
};
@@ -1137,6 +1214,10 @@ static const struct of_device_id ds1307_of_match[] = {
.compatible = "isil,isl12057",
.data = (void *)ds_1337
},
+ {
+ .compatible = "epson,rx8111",
+ .data = (void *)rx_8111
+ },
{
.compatible = "epson,rx8130",
.data = (void *)rx_8130
@@ -1880,6 +1961,10 @@ static int ds1307_probe(struct i2c_client *client,
DS1307_REG_HOUR << 4 | 0x08, hour);
}
break;
+ case rx_8111:
+ /* Use memory as user RAM */
+ regmap_write(ds1307->regmap, RX8111_TIME_STAMP_BUF_CTRL, 0);
+ break;
case ds_1388:
err = regmap_read(ds1307->regmap, DS1388_REG_CONTROL, &tmp);
if (err) {