abcrtc(4), a driver for the Abracon AB1805 RTC and similar variants.

ok kettenis@

2 files changed, 266 insertions, 1 deletions

diff --git a/sys/dev/i2c/abx80x.c b/sys/dev/i2c/abx80x.c
new file mode 100644
index 00000000000..c5a87606e6f
--- /dev/null
+++ b/sys/dev/i2c/abx80x.c
@@ -0,0 +1,260 @@
+/*	$OpenBSD: abx80x.c,v 1.1 2019/01/02 21:15:47 patrick Exp $	*/
+/*
+ * Copyright (c) 2018 Mark Kettenis <kettenis@openbsd.org>
+ * Copyright (c) 2018 Patrick Wildt <patrick@blueri.se>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/device.h>
+
+#include <dev/i2c/i2cvar.h>
+
+#include <dev/clock_subr.h>
+
+extern todr_chip_handle_t todr_handle;
+
+#define ABX8XX_HTH		0x00
+#define ABX8XX_SC		0x01
+#define ABX8XX_MN		0x02
+#define ABX8XX_HR		0x03
+#define ABX8XX_DA		0x04
+#define ABX8XX_MO		0x05
+#define ABX8XX_YR		0x06
+#define ABX8XX_WD		0x07
+#define ABX8XX_CTRL		0x10
+#define  ABX8XX_CTRL_WRITE		(1 << 0)
+#define  ABX8XX_CTRL_ARST		(1 << 2)
+#define  ABX8XX_CTRL_12_24		(1 << 6)
+#define ABX8XX_CD_TIMER_CTL	0x18
+#define  ABX8XX_CD_TIMER_CTL_EN		(1 << 2)
+#define ABX8XX_OSS		0x1d
+#define ABX8XX_OSS_OF			(1 << 1)
+#define ABX8XX_OSS_OMODE		(1 << 4)
+
+#define ABX8XX_NRTC_REGS	8
+
+struct abcrtc_softc {
+	struct device sc_dev;
+	i2c_tag_t sc_tag;
+	i2c_addr_t sc_addr;
+
+	struct todr_chip_handle sc_todr;
+};
+
+int	abcrtc_match(struct device *, void *, void *);
+void	abcrtc_attach(struct device *, struct device *, void *);
+
+struct cfattach abcrtc_ca = {
+	sizeof(struct abcrtc_softc), abcrtc_match, abcrtc_attach
+};
+
+struct cfdriver abcrtc_cd = {
+	NULL, "abcrtc", DV_DULL
+};
+
+uint8_t	abcrtc_reg_read(struct abcrtc_softc *, int);
+void	abcrtc_reg_write(struct abcrtc_softc *, int, uint8_t);
+int	abcrtc_clock_read(struct abcrtc_softc *, struct clock_ymdhms *);
+int	abcrtc_clock_write(struct abcrtc_softc *, struct clock_ymdhms *);
+int	abcrtc_gettime(struct todr_chip_handle *, struct timeval *);
+int	abcrtc_settime(struct todr_chip_handle *, struct timeval *);
+
+int
+abcrtc_match(struct device *parent, void *match, void *aux)
+{
+	struct i2c_attach_args *ia = aux;
+
+	if (strcmp(ia->ia_name, "abracon,ab1805") == 0)
+		return 1;
+
+	return 0;
+}
+
+void
+abcrtc_attach(struct device *parent, struct device *self, void *aux)
+{
+	struct abcrtc_softc *sc = (struct abcrtc_softc *)self;
+	struct i2c_attach_args *ia = aux;
+	uint8_t reg;
+
+	sc->sc_tag = ia->ia_tag;
+	sc->sc_addr = ia->ia_addr;
+
+	reg = abcrtc_reg_read(sc, ABX8XX_CTRL);
+	reg &= ~(ABX8XX_CTRL_ARST | ABX8XX_CTRL_12_24);
+	reg |= ABX8XX_CTRL_WRITE;
+	abcrtc_reg_write(sc, ABX8XX_CTRL, reg);
+
+	abcrtc_reg_write(sc, ABX8XX_CD_TIMER_CTL, ABX8XX_CD_TIMER_CTL_EN);
+
+	sc->sc_todr.cookie = sc;
+	sc->sc_todr.todr_gettime = abcrtc_gettime;
+	sc->sc_todr.todr_settime = abcrtc_settime;
+	todr_handle = &sc->sc_todr;
+
+	printf("\n");
+}
+
+int
+abcrtc_gettime(struct todr_chip_handle *handle, struct timeval *tv)
+{
+	struct abcrtc_softc *sc = handle->cookie;
+	struct clock_ymdhms dt;
+	int error;
+
+	error = abcrtc_clock_read(sc, &dt);
+	if (error)
+		return error;
+
+	if (dt.dt_sec > 59 || dt.dt_min > 59 || dt.dt_hour > 23 ||
+	    dt.dt_day > 31 || dt.dt_day == 0 ||
+	    dt.dt_mon > 12 || dt.dt_mon == 0 ||
+	    dt.dt_year < POSIX_BASE_YEAR)
+		return EINVAL;
+
+	tv->tv_sec = clock_ymdhms_to_secs(&dt);
+	tv->tv_usec = 0;
+	return 0;
+}
+
+int
+abcrtc_settime(struct todr_chip_handle *handle, struct timeval *tv)
+{
+	struct abcrtc_softc *sc = handle->cookie;
+	struct clock_ymdhms dt;
+
+	clock_secs_to_ymdhms(tv->tv_sec, &dt);
+
+	return abcrtc_clock_write(sc, &dt);
+}
+
+uint8_t
+abcrtc_reg_read(struct abcrtc_softc *sc, int reg)
+{
+	uint8_t cmd = reg;
+	uint8_t val[2];
+	int error;
+
+	iic_acquire_bus(sc->sc_tag, I2C_F_POLL);
+	error = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP, sc->sc_addr,
+	    &cmd, sizeof cmd, &val, sizeof val, I2C_F_POLL);
+	iic_release_bus(sc->sc_tag, I2C_F_POLL);
+
+	if (error) {
+		printf("%s: can't read register 0x%02x\n",
+		    sc->sc_dev.dv_xname, reg);
+		return 0xff;
+	}
+
+	return val[1];
+}
+
+void
+abcrtc_reg_write(struct abcrtc_softc *sc, int reg, uint8_t data)
+{
+	uint8_t cmd = reg;
+	uint8_t val[2];
+	int error;
+
+	val[0] = 1;
+	val[1] = reg;
+
+	iic_acquire_bus(sc->sc_tag, I2C_F_POLL);
+	error = iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_addr,
+	    &cmd, sizeof cmd, &val, sizeof val, I2C_F_POLL);
+	iic_release_bus(sc->sc_tag, I2C_F_POLL);
+
+	if (error) {
+		printf("%s: can't write register 0x%02x\n",
+		    sc->sc_dev.dv_xname, reg);
+	}
+}
+
+int
+abcrtc_clock_read(struct abcrtc_softc *sc, struct clock_ymdhms *dt)
+{
+	uint8_t regs[ABX8XX_NRTC_REGS+1];
+	uint8_t cmd = ABX8XX_HTH;
+	int error;
+
+	/* Don't trust the RTC if the oscillator failure is set. */
+	if ((abcrtc_reg_read(sc, ABX8XX_OSS) & ABX8XX_OSS_OMODE) == 0 &&
+	    (abcrtc_reg_read(sc, ABX8XX_OSS) & ABX8XX_OSS_OF) != 0)
+		return EIO;
+
+	iic_acquire_bus(sc->sc_tag, I2C_F_POLL);
+	error = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP, sc->sc_addr,
+	    &cmd, sizeof(cmd), regs, sizeof(regs), I2C_F_POLL);
+	iic_release_bus(sc->sc_tag, I2C_F_POLL);
+
+	if (error) {
+		printf("%s: can't read RTC\n", sc->sc_dev.dv_xname);
+		return error;
+	}
+
+	/*
+	 * Convert the ABX8XX's register values into something useable.
+	 */
+	dt->dt_sec = FROMBCD(regs[2] & 0x7f);
+	dt->dt_min = FROMBCD(regs[3] & 0x7f);
+	dt->dt_hour = FROMBCD(regs[4] & 0x3f);
+	dt->dt_day = FROMBCD(regs[5] & 0x3f);
+	dt->dt_mon = FROMBCD(regs[6] & 0x1f);
+	dt->dt_year = FROMBCD(regs[7]) + 2000;
+	dt->dt_wday = regs[8] & 0x7;
+
+	return 0;
+}
+
+int
+abcrtc_clock_write(struct abcrtc_softc *sc, struct clock_ymdhms *dt)
+{
+	uint8_t regs[ABX8XX_NRTC_REGS+1];
+	uint8_t cmd = ABX8XX_HTH;
+	uint8_t reg;
+	int error;
+
+	/*
+	 * Convert our time representation into something the ABX8XX
+	 * can understand.
+	 */
+	regs[0] = ABX8XX_NRTC_REGS;
+	regs[1] = 0;
+	regs[2] = TOBCD(dt->dt_sec);
+	regs[3] = TOBCD(dt->dt_min);
+	regs[4] = TOBCD(dt->dt_hour);
+	regs[5] = TOBCD(dt->dt_day);
+	regs[6] = TOBCD(dt->dt_mon);
+	regs[7] = TOBCD(dt->dt_year - 2000);
+	regs[8] = dt->dt_wday;
+
+	iic_acquire_bus(sc->sc_tag, I2C_F_POLL);
+	error = iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_addr,
+	    &cmd, sizeof(cmd), regs, sizeof(regs), I2C_F_POLL);
+	iic_release_bus(sc->sc_tag, I2C_F_POLL);
+
+	if (error) {
+		printf("%s: can't write RTC\n", sc->sc_dev.dv_xname);
+		return error;
+	}
+
+	/* Clear oscillator failure. */
+	reg = abcrtc_reg_read(sc, ABX8XX_OSS);
+	reg &= ~ABX8XX_OSS_OF;
+	abcrtc_reg_write(sc, ABX8XX_OSS, reg);
+
+	return 0;
+}
diff --git a/sys/dev/i2c/files.i2c b/sys/dev/i2c/files.i2c
index ca43e7ee943..fc4c134ecbe 100644
--- a/sys/dev/i2c/files.i2c
+++ b/sys/dev/i2c/files.i2c
@@ -1,4 +1,4 @@
-# $OpenBSD: files.i2c,v 1.61 2018/07/09 18:48:52 patrick Exp $
+# $OpenBSD: files.i2c,v 1.62 2019/01/02 21:15:47 patrick Exp $
 #	$NetBSD: files.i2c,v 1.3 2003/10/20 16:24:10 briggs Exp $
 
 define	i2c {[addr = -1], [size = -1]}
@@ -224,3 +224,8 @@ file dev/i2c/bmc150.c				bgw
 device	islrtc
 attach	islrtc at i2c
 file dev/i2c/isl1208.c				islrtc
+
+# Abracon ABx8xx Real Time Clock
+device	abcrtc
+attach	abcrtc at i2c
+file dev/i2c/abx80x.c				abcrtc