Home | History | Annotate | Line # | Download | only in i2c
r2025.c revision 1.4.4.1 
      1 /* $NetBSD: r2025.c,v 1.4.4.1 2008/05/16 02:24:01 yamt 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.4.4.1 2008/05/16 02:24:01 yamt 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 	device_t		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(device_t, device_t, void *);
     61 static int	r2025rtc_match(device_t, cfdata_t, void *);
     62 
     63 CFATTACH_DECL_NEW(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(device_t parent, cfdata_t 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(device_t parent, device_t 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_dev = self;
     97 	sc->sc_open = 0;
     98 	sc->sc_todr.cookie = sc;
     99 	sc->sc_todr.todr_gettime = r2025rtc_gettime;
    100 	sc->sc_todr.todr_settime = r2025rtc_settime;
    101 	sc->sc_todr.todr_setwen = NULL;
    102 
    103 	todr_attach(&sc->sc_todr);
    104 }
    105 
    106 static int
    107 r2025rtc_gettime(struct todr_chip_handle *ch, volatile struct timeval *tv)
    108 {
    109 	struct r2025rtc_softc *sc = ch->cookie;
    110 	struct clock_ymdhms dt;
    111 	uint8_t rctrl;
    112 	uint8_t bcd[R2025_CLK_SIZE];
    113 	int hour;
    114 
    115 	memset(&dt, 0, sizeof(dt));
    116 
    117 	if (r2025rtc_reg_read(sc, R2025_REG_CTRL1, &rctrl, 1) != 0) {
    118 		aprint_error_dev(sc->sc_dev,
    119 		    "r2025rtc_gettime: failed to read registers.\n");
    120 		return -1;
    121 	}
    122 
    123 	if (r2025rtc_reg_read(sc, R2025_REG_SEC, &bcd[0], R2025_CLK_SIZE)
    124 		!= 0) {
    125 		aprint_error_dev(sc->sc_dev,
    126 		    "r2025rtc_gettime: failed to read registers.\n");
    127 		return -1;
    128 	}
    129 
    130 	dt.dt_sec = FROMBCD(bcd[R2025_REG_SEC] & R2025_REG_SEC_MASK);
    131 	dt.dt_min = FROMBCD(bcd[R2025_REG_MIN] & R2025_REG_MIN_MASK);
    132 	hour = FROMBCD(bcd[R2025_REG_HOUR] & R2025_REG_HOUR_MASK);
    133 	if (rctrl & R2025_REG_CTRL1_H1224) {
    134 		dt.dt_hour = hour;
    135 	} else {
    136 		if (hour == 12) {
    137 			dt.dt_hour = 0;
    138 		} else if (hour == 32) {
    139 			dt.dt_hour = 12;
    140 		} else if (hour > 13) {
    141 			dt.dt_hour = (hour - 8);
    142 		} else { /* (hour < 12) */
    143 			dt.dt_hour = hour;
    144 		}
    145 	}
    146 	dt.dt_wday = FROMBCD(bcd[R2025_REG_WDAY] & R2025_REG_WDAY_MASK);
    147 	dt.dt_day = FROMBCD(bcd[R2025_REG_DAY] & R2025_REG_DAY_MASK);
    148 	dt.dt_mon = FROMBCD(bcd[R2025_REG_MON] & R2025_REG_MON_MASK);
    149 	dt.dt_year = FROMBCD(bcd[R2025_REG_YEAR] & R2025_REG_YEAR_MASK)
    150 		+ ((bcd[R2025_REG_MON] & R2025_REG_MON_Y1920) ? 2000 : 1900);
    151 
    152 	tv->tv_sec = clock_ymdhms_to_secs(&dt);
    153 	tv->tv_usec = 0;
    154 
    155 	return 0;
    156 }
    157 
    158 static int
    159 r2025rtc_settime(struct todr_chip_handle *ch, volatile struct timeval *tv)
    160 {
    161 	struct r2025rtc_softc *sc = ch->cookie;
    162 	struct clock_ymdhms dt;
    163 	uint8_t rctrl;
    164 	uint8_t bcd[R2025_CLK_SIZE];
    165 
    166 	clock_secs_to_ymdhms(tv->tv_sec, &dt);
    167 
    168 	/* Y3K problem */
    169 	if (dt.dt_year >= 3000) {
    170 		aprint_error_dev(sc->sc_dev,
    171 		    "r2025rtc_settime: "
    172 		    "RTC does not support year 3000 or over.\n");
    173 		return -1;
    174 	}
    175 
    176 	if (r2025rtc_reg_read(sc, R2025_REG_CTRL1, &rctrl, 1) != 0) {
    177 		aprint_error_dev(sc->sc_dev,
    178 		    "r2025rtc_settime: failed to read register.\n");
    179 		return -1;
    180 	}
    181 	rctrl |= R2025_REG_CTRL1_H1224;
    182 
    183 	/* setup registers 0x00-0x06 (7 byte) */
    184 	bcd[R2025_REG_SEC] = TOBCD(dt.dt_sec) & R2025_REG_SEC_MASK;
    185 	bcd[R2025_REG_MIN] = TOBCD(dt.dt_min) & R2025_REG_MIN_MASK;
    186 	bcd[R2025_REG_HOUR] = TOBCD(dt.dt_hour) & R2025_REG_HOUR_MASK;
    187 	bcd[R2025_REG_WDAY] = TOBCD(dt.dt_wday) & R2025_REG_WDAY_MASK;
    188 	bcd[R2025_REG_DAY] = TOBCD(dt.dt_day) & R2025_REG_DAY_MASK;
    189 	bcd[R2025_REG_MON] = (TOBCD(dt.dt_mon) & R2025_REG_MON_MASK)
    190 		| ((dt.dt_year >= 2000) ? R2025_REG_MON_Y1920 : 0);
    191 	bcd[R2025_REG_YEAR] = TOBCD(dt.dt_year % 100) & R2025_REG_YEAR_MASK;
    192 
    193 	/* Write RTC register */
    194 	if (r2025rtc_reg_write(sc, R2025_REG_CTRL1, &rctrl, 1) != 0) {
    195 		aprint_error_dev(sc->sc_dev,
    196 		    "r2025rtc_settime: failed to write registers.\n");
    197 		return -1;
    198 	}
    199 	if (r2025rtc_reg_write(sc, R2025_REG_SEC, bcd, R2025_CLK_SIZE) != 0) {
    200 		aprint_error_dev(sc->sc_dev,
    201 		    "r2025rtc_settime: failed to write registers.\n");
    202 		return -1;
    203 	}
    204 
    205 	return 0;
    206 }
    207 
    208 static int
    209 r2025rtc_reg_write(struct r2025rtc_softc *sc, int reg, uint8_t *val, int len)
    210 {
    211 	int i;
    212 	uint8_t buf[1];
    213 	uint8_t cmdbuf[1];
    214 
    215 	if (iic_acquire_bus(sc->sc_tag, I2C_F_POLL)) {
    216 		aprint_error_dev(sc->sc_dev,
    217 		    "r2025rtc_clock_write: failed to acquire I2C bus\n");
    218 		return -1;
    219 	}
    220 
    221 	for (i = 0 ; i < len ; i++) {
    222 		cmdbuf[0] = (((reg + i) << 4) & 0xf0);
    223 		buf[0] = val[i];
    224 		if (iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_address,
    225 				cmdbuf, 1, buf, 1, I2C_F_POLL)) {
    226 			iic_release_bus(sc->sc_tag, I2C_F_POLL);
    227 			aprint_error_dev(sc->sc_dev, "r2025rtc_reg_write: "
    228 				"failed to write registers\n");
    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 		aprint_error_dev(sc->sc_dev,
    247 		    "r2025rtc_clock_read: failed to acquire I2C bus\n");
    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 			aprint_error_dev(sc->sc_dev, "r2025rtc_reg_read: "
    258 				"failed to write registers\n");
    259 			return -1;
    260 		}
    261 
    262 		*(val + i) = buf[0];
    263 	}
    264 
    265 	iic_release_bus(sc->sc_tag, I2C_F_POLL);
    266 
    267 	return 0;
    268 }
    269