^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0-only
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Driver for Epson RTC-9701JE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (C) 2008 Magnus Damm
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Based on rtc-max6902.c
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) * Copyright (C) 2006 8D Technologies inc.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) * Copyright (C) 2004 Compulab Ltd.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <linux/module.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <linux/kernel.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <linux/platform_device.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include <linux/device.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #include <linux/init.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #include <linux/rtc.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #include <linux/spi/spi.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #include <linux/bcd.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #include <linux/delay.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #include <linux/bitops.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) #define RSECCNT 0x00 /* Second Counter */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) #define RMINCNT 0x01 /* Minute Counter */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #define RHRCNT 0x02 /* Hour Counter */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) #define RWKCNT 0x03 /* Week Counter */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) #define RDAYCNT 0x04 /* Day Counter */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) #define RMONCNT 0x05 /* Month Counter */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) #define RYRCNT 0x06 /* Year Counter */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) #define R100CNT 0x07 /* Y100 Counter */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) #define RMINAR 0x08 /* Minute Alarm */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) #define RHRAR 0x09 /* Hour Alarm */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) #define RWKAR 0x0a /* Week/Day Alarm */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) #define RTIMCNT 0x0c /* Interval Timer */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) #define REXT 0x0d /* Extension Register */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) #define RFLAG 0x0e /* RTC Flag Register */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) #define RCR 0x0f /* RTC Control Register */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) static int write_reg(struct device *dev, int address, unsigned char data)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) struct spi_device *spi = to_spi_device(dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) unsigned char buf[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) buf[0] = address & 0x7f;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) buf[1] = data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) return spi_write(spi, buf, ARRAY_SIZE(buf));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) static int read_regs(struct device *dev, unsigned char *regs, int no_regs)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) struct spi_device *spi = to_spi_device(dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) u8 txbuf[1], rxbuf[1];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) int k, ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) ret = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) for (k = 0; ret == 0 && k < no_regs; k++) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) txbuf[0] = 0x80 | regs[k];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) ret = spi_write_then_read(spi, txbuf, 1, rxbuf, 1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) regs[k] = rxbuf[0];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) static int r9701_get_datetime(struct device *dev, struct rtc_time *dt)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) int ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) unsigned char buf[] = { RSECCNT, RMINCNT, RHRCNT,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) RDAYCNT, RMONCNT, RYRCNT };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) ret = read_regs(dev, buf, ARRAY_SIZE(buf));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) if (ret)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) dt->tm_sec = bcd2bin(buf[0]); /* RSECCNT */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) dt->tm_min = bcd2bin(buf[1]); /* RMINCNT */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) dt->tm_hour = bcd2bin(buf[2]); /* RHRCNT */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) dt->tm_mday = bcd2bin(buf[3]); /* RDAYCNT */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) dt->tm_mon = bcd2bin(buf[4]) - 1; /* RMONCNT */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) dt->tm_year = bcd2bin(buf[5]) + 100; /* RYRCNT */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) static int r9701_set_datetime(struct device *dev, struct rtc_time *dt)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) int ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) ret = write_reg(dev, RHRCNT, bin2bcd(dt->tm_hour));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) ret = ret ? ret : write_reg(dev, RMINCNT, bin2bcd(dt->tm_min));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) ret = ret ? ret : write_reg(dev, RSECCNT, bin2bcd(dt->tm_sec));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) ret = ret ? ret : write_reg(dev, RDAYCNT, bin2bcd(dt->tm_mday));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) ret = ret ? ret : write_reg(dev, RMONCNT, bin2bcd(dt->tm_mon + 1));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) ret = ret ? ret : write_reg(dev, RYRCNT, bin2bcd(dt->tm_year - 100));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) static const struct rtc_class_ops r9701_rtc_ops = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) .read_time = r9701_get_datetime,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) .set_time = r9701_set_datetime,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) static int r9701_probe(struct spi_device *spi)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) struct rtc_device *rtc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) unsigned char tmp;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) int res;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) tmp = R100CNT;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) res = read_regs(&spi->dev, &tmp, 1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) if (res || tmp != 0x20) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) dev_err(&spi->dev, "cannot read RTC register\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) return -ENODEV;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) rtc = devm_rtc_allocate_device(&spi->dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) if (IS_ERR(rtc))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) return PTR_ERR(rtc);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) spi_set_drvdata(spi, rtc);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) rtc->ops = &r9701_rtc_ops;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) rtc->range_min = RTC_TIMESTAMP_BEGIN_2000;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) rtc->range_max = RTC_TIMESTAMP_END_2099;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) return rtc_register_device(rtc);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) static struct spi_driver r9701_driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) .driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) .name = "rtc-r9701",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) .probe = r9701_probe,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) module_spi_driver(r9701_driver);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) MODULE_DESCRIPTION("r9701 spi RTC driver");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) MODULE_AUTHOR("Magnus Damm <damm@opensource.se>");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) MODULE_LICENSE("GPL");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) MODULE_ALIAS("spi:rtc-r9701");