Home | History | Annotate | Line # | Download | only in i2c
r2025.c revision 1.3 
      1 /* $NetBSD: r2025.c,v 1.3 2006/09/04 23:45:30 gdamore Exp $ */
      2 
      3 /*-
      4  * Copyright (c) 2006 Shigeyuki Fukushima.
      5  * All rights reserved.
      6  *
      7  * Written by Shigeyuki Fukushima.
      8  *
      9  * Redistribution and use in source and binary forms, with or without
     10  * modification, are permitted provided that the following conditions
     11  * are met:
     12  * 1. Redistributions of source code must retain the above copyright
     13  *    notice, this list of conditions and the following disclaimer.
     14  * 2. Redistributions in binary form must reproduce the above
     15  *    copyright notice, this list of conditions and the following
     16  *    disclaimer in the documentation and/or other materials provided
     17  *    with the distribution.
     18  * 3. The name of the author may not be used to endorse or promote
     19  *    products derived from this software without specific prior
     20  *    written permission.
     21  *
     22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
     23  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     24  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     25  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
     26  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
     28  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
     30  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
     31  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     33  */
     34 
     35 #include <sys/cdefs.h>
     36 __KERNEL_RCSID(0, "$NetBSD: r2025.c,v 1.3 2006/09/04 23:45:30 gdamore Exp $");
     37 
     38 #include <sys/param.h>
     39 #include <sys/systm.h>
     40 #include <sys/device.h>
     41 #include <sys/kernel.h>
     42 #include <sys/fcntl.h>
     43 #include <sys/uio.h>
     44 #include <sys/conf.h>
     45 #include <sys/event.h>
     46 
     47 #include <dev/clock_subr.h>
     48 
     49 #include <dev/i2c/i2cvar.h>
     50 #include <dev/i2c/r2025reg.h>
     51 
     52 struct r2025rtc_softc {
     53 	struct device		sc_dev;
     54 	i2c_tag_t		sc_tag;
     55 	int			sc_address;
     56 	int			sc_open;
     57 	struct todr_chip_handle	sc_todr;
     58 };
     59 
     60 static void	r2025rtc_attach(struct device *, struct device *, void *);
     61 static int	r2025rtc_match(struct device *, struct cfdata *, void *);
     62 
     63 CFATTACH_DECL(r2025rtc, sizeof(struct r2025rtc_softc),
     64 	r2025rtc_match, r2025rtc_attach, NULL, NULL);
     65 
     66 static int	r2025rtc_gettime(struct todr_chip_handle *,
     67 				volatile struct timeval *);
     68 static int	r2025rtc_settime(struct todr_chip_handle *,
     69 				volatile struct timeval *);
     70 static int	r2025rtc_reg_write(struct r2025rtc_softc *, int, uint8_t*, int);
     71 static int	r2025rtc_reg_read(struct r2025rtc_softc *, int, uint8_t*, int);
     72 
     73 
     74 static int
     75 r2025rtc_match(struct device *parent, struct cfdata *cf, void *arg)
     76 {
     77 	struct i2c_attach_args *ia = arg;
     78 
     79 	/* match only R2025 RTC devices */
     80 	if (ia->ia_addr == R2025_ADDR)
     81 		return 1;
     82 
     83 	return 0;
     84 }
     85 
     86 static void
     87 r2025rtc_attach(struct device *parent, struct device *self, void *arg)
     88 {
     89 	struct r2025rtc_softc *sc = device_private(self);
     90 	struct i2c_attach_args *ia = arg;
     91 
     92 	aprint_normal(": RICOH R2025S/D Real-time Clock\n");
     93 
     94 	sc->sc_tag = ia->ia_tag;
     95 	sc->sc_address = ia->ia_addr;
     96 	sc->sc_open = 0;
     97 	sc->sc_todr.cookie = sc;
     98 	sc->sc_todr.todr_gettime = r2025rtc_gettime;
     99 	sc->sc_todr.todr_settime = r2025rtc_settime;
    100 	sc->sc_todr.todr_setwen = NULL;
    101 
    102 	todr_attach(&sc->sc_todr);
    103 }
    104 
    105 static int
    106 r2025rtc_gettime(struct todr_chip_handle *ch, volatile struct timeval *tv)
    107 {
    108 	struct r2025rtc_softc *sc = ch->cookie;
    109 	struct clock_ymdhms dt;
    110 	uint8_t rctrl;
    111 	uint8_t bcd[R2025_CLK_SIZE];
    112 	int hour;
    113 
    114 	memset(&dt, 0, sizeof(dt));
    115 
    116 	if (r2025rtc_reg_read(sc, R2025_REG_CTRL1, &rctrl, 1) != 0) {
    117 		printf("%s: r2025rtc_gettime: failed to read registers.\n",
    118 			sc->sc_dev.dv_xname);
    119 		return -1;
    120 	}
    121 
    122 	if (r2025rtc_reg_read(sc, R2025_REG_SEC, &bcd[0], R2025_CLK_SIZE)
    123 		!= 0) {
    124 		printf("%s: r2025rtc_gettime: failed to read registers.\n",
    125 			sc->sc_dev.dv_xname);
    126 		return -1;
    127 	}
    128 
    129 	dt.dt_sec = FROMBCD(bcd[R2025_REG_SEC] & R2025_REG_SEC_MASK);
    130 	dt.dt_min = FROMBCD(bcd[R2025_REG_MIN] & R2025_REG_MIN_MASK);
    131 	hour = FROMBCD(bcd[R2025_REG_HOUR] & R2025_REG_HOUR_MASK);
    132 	if (rctrl & R2025_REG_CTRL1_H1224) {
    133 		dt.dt_hour = hour;
    134 	} else {
    135 		if (hour == 12) {
    136 			dt.dt_hour = 0;
    137 		} else if (hour == 32) {
    138 			dt.dt_hour = 12;
    139 		} else if (hour > 13) {
    140 			dt.dt_hour = (hour - 8);
    141 		} else { /* (hour < 12) */
    142 			dt.dt_hour = hour;
    143 		}
    144 	}
    145 	dt.dt_wday = FROMBCD(bcd[R2025_REG_WDAY] & R2025_REG_WDAY_MASK);
    146 	dt.dt_day = FROMBCD(bcd[R2025_REG_DAY] & R2025_REG_DAY_MASK);
    147 	dt.dt_mon = FROMBCD(bcd[R2025_REG_MON] & R2025_REG_MON_MASK);
    148 	dt.dt_year = FROMBCD(bcd[R2025_REG_YEAR] & R2025_REG_YEAR_MASK)
    149 		+ ((bcd[R2025_REG_MON] & R2025_REG_MON_Y1920) ? 2000 : 1900);
    150 
    151 	tv->tv_sec = clock_ymdhms_to_secs(&dt);
    152 	tv->tv_usec = 0;
    153 
    154 	return 0;
    155 }
    156 
    157 static int
    158 r2025rtc_settime(struct todr_chip_handle *ch, volatile struct timeval *tv)
    159 {
    160 	struct r2025rtc_softc *sc = ch->cookie;
    161 	struct clock_ymdhms dt;
    162 	uint8_t rctrl;
    163 	uint8_t bcd[R2025_CLK_SIZE];
    164 
    165 	clock_secs_to_ymdhms(tv->tv_sec, &dt);
    166 
    167 	/* Y3K problem */
    168 	if (dt.dt_year >= 3000) {
    169 		printf("%s: r2025rtc_settime: "
    170 			"RTC does not support year 3000 or over.\n",
    171 			sc->sc_dev.dv_xname);
    172 		return -1;
    173 	}
    174 
    175 	if (r2025rtc_reg_read(sc, R2025_REG_CTRL1, &rctrl, 1) != 0) {
    176 		printf("%s: r2025rtc_settime: failed to read register.\n",
    177 			sc->sc_dev.dv_xname);
    178 		return -1;
    179 	}
    180 	rctrl |= R2025_REG_CTRL1_H1224;
    181 
    182 	/* setup registers 0x00-0x06 (7 byte) */
    183 	bcd[R2025_REG_SEC] = TOBCD(dt.dt_sec) & R2025_REG_SEC_MASK;
    184 	bcd[R2025_REG_MIN] = TOBCD(dt.dt_min) & R2025_REG_MIN_MASK;
    185 	bcd[R2025_REG_HOUR] = TOBCD(dt.dt_hour) & R2025_REG_HOUR_MASK;
    186 	bcd[R2025_REG_WDAY] = TOBCD(dt.dt_wday) & R2025_REG_WDAY_MASK;
    187 	bcd[R2025_REG_DAY] = TOBCD(dt.dt_day) & R2025_REG_DAY_MASK;
    188 	bcd[R2025_REG_MON] = (TOBCD(dt.dt_mon) & R2025_REG_MON_MASK)
    189 		| ((dt.dt_year >= 2000) ? R2025_REG_MON_Y1920 : 0);
    190 	bcd[R2025_REG_YEAR] = TOBCD(dt.dt_year % 100) & R2025_REG_YEAR_MASK;
    191 
    192 	/* Write RTC register */
    193 	if (r2025rtc_reg_write(sc, R2025_REG_CTRL1, &rctrl, 1) != 0) {
    194 		printf("%s: r2025rtc_settime: failed to write registers.\n",
    195 			sc->sc_dev.dv_xname);
    196 		return -1;
    197 	}
    198 	if (r2025rtc_reg_write(sc, R2025_REG_SEC, bcd, R2025_CLK_SIZE) != 0) {
    199 		printf("%s: r2025rtc_settime: failed to write registers.\n",
    200 			sc->sc_dev.dv_xname);
    201 		return -1;
    202 	}
    203 
    204 	return 0;
    205 }
    206 
    207 static int
    208 r2025rtc_reg_write(struct r2025rtc_softc *sc, int reg, uint8_t *val, int len)
    209 {
    210 	int i;
    211 	uint8_t buf[1];
    212 	uint8_t cmdbuf[1];
    213 
    214 	if (iic_acquire_bus(sc->sc_tag, I2C_F_POLL)) {
    215 		printf("%s: r2025rtc_clock_write: failed to acquire I2C bus\n",
    216 			sc->sc_dev.dv_xname);
    217 		return -1;
    218 	}
    219 
    220 	for (i = 0 ; i < len ; i++) {
    221 		cmdbuf[0] = (((reg + i) << 4) & 0xf0);
    222 		buf[0] = val[i];
    223 		if (iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_address,
    224 				cmdbuf, 1, buf, 1, I2C_F_POLL)) {
    225 			iic_release_bus(sc->sc_tag, I2C_F_POLL);
    226 			printf("%s: r2025rtc_reg_write: "
    227 				"failed to write registers\n",
    228 				sc->sc_dev.dv_xname);
    229 			return -1;
    230 		}
    231 	}
    232 
    233 	iic_release_bus(sc->sc_tag, I2C_F_POLL);
    234 
    235 	return 0;
    236 }
    237 
    238 static int
    239 r2025rtc_reg_read(struct r2025rtc_softc *sc, int reg, uint8_t *val, int len)
    240 {
    241 	int i;
    242 	uint8_t buf[1];
    243 	uint8_t cmdbuf[1];
    244 
    245 	if (iic_acquire_bus(sc->sc_tag, I2C_F_POLL)) {
    246 		printf("%s: r2025rtc_clock_read: failed to acquire I2C bus\n",
    247 			sc->sc_dev.dv_xname);
    248 		return -1;
    249 	}
    250 
    251 	for (i = 0 ; i < len ; i++) {
    252 		cmdbuf[0] = (((reg + i) << 4) & 0xf0);
    253 		buf[0] = 0;
    254 		if (iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP, sc->sc_address,
    255 				cmdbuf, 1, buf, 1, I2C_F_POLL)) {
    256 			iic_release_bus(sc->sc_tag, I2C_F_POLL);
    257 			printf("%s: r2025rtc_reg_read: "
    258 				"failed to write registers\n",
    259 				sc->sc_dev.dv_xname);
    260 			return -1;
    261 		}
    262 
    263 		*(val + i) = buf[0];
    264 	}
    265 
    266 	iic_release_bus(sc->sc_tag, I2C_F_POLL);
    267 
    268 	return 0;
    269 }
    270