Home | History | Annotate | Line # | Download | only in i2c
pcf8563.c revision 1.4.2.2
      1 /*	$NetBSD: pcf8563.c,v 1.4.2.2 2015/06/06 14:40:07 skrll Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2011 Jonathan A. Kollasch
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  *
     16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     18  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
     20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
     23  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
     24  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
     25  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
     26  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27  */
     28 
     29 #include <sys/cdefs.h>
     30 __KERNEL_RCSID(0, "$NetBSD: pcf8563.c,v 1.4.2.2 2015/06/06 14:40:07 skrll Exp $");
     31 
     32 #include <sys/param.h>
     33 #include <sys/systm.h>
     34 #include <sys/device.h>
     35 #include <sys/kernel.h>
     36 
     37 #include <dev/clock_subr.h>
     38 
     39 #include <dev/i2c/i2cvar.h>
     40 #include <dev/i2c/pcf8563reg.h>
     41 
     42 struct pcf8563rtc_softc {
     43 	device_t sc_dev;
     44 	i2c_tag_t sc_tag;
     45 	int sc_addr;
     46 	struct todr_chip_handle sc_todr;
     47 };
     48 
     49 static int pcf8563rtc_match(device_t, cfdata_t, void *);
     50 static void pcf8563rtc_attach(device_t, device_t, void *);
     51 
     52 CFATTACH_DECL_NEW(pcf8563rtc, sizeof(struct pcf8563rtc_softc),
     53     pcf8563rtc_match, pcf8563rtc_attach, NULL, NULL);
     54 
     55 static int pcf8563rtc_clock_read(struct pcf8563rtc_softc *, struct clock_ymdhms *);
     56 static int pcf8563rtc_clock_write(struct pcf8563rtc_softc *, struct clock_ymdhms *);
     57 static int pcf8563rtc_gettime(struct todr_chip_handle *, struct clock_ymdhms *);
     58 static int pcf8563rtc_settime(struct todr_chip_handle *, struct clock_ymdhms *);
     59 
     60 static int
     61 pcf8563rtc_match(device_t parent, cfdata_t cf, void *aux)
     62 {
     63 	struct i2c_attach_args *ia = aux;
     64 
     65 	if (ia->ia_name) {
     66 		/* direct config - check name */
     67 		if (strcmp(ia->ia_name, "pcf8563rtc") == 0)
     68 			return 1;
     69 	} else {
     70 		/* indirect config - check typical address */
     71 		if (ia->ia_addr == PCF8563_ADDR)
     72 			return 1;
     73 	}
     74 	return 0;
     75 }
     76 
     77 static void
     78 pcf8563rtc_attach(device_t parent, device_t self, void *aux)
     79 {
     80 	struct pcf8563rtc_softc *sc = device_private(self);
     81 	struct i2c_attach_args *ia = aux;
     82 
     83 	aprint_naive(": Real-time Clock\n");
     84 	aprint_normal(": NXP PCF8563 Real-time Clock\n");
     85 
     86 	sc->sc_dev = self;
     87 	sc->sc_tag = ia->ia_tag;
     88 	sc->sc_addr = ia->ia_addr;
     89 	sc->sc_todr.cookie = sc;
     90 	sc->sc_todr.todr_gettime_ymdhms = pcf8563rtc_gettime;
     91 	sc->sc_todr.todr_settime_ymdhms = pcf8563rtc_settime;
     92 	sc->sc_todr.todr_setwen = NULL;
     93 
     94 	iic_acquire_bus(sc->sc_tag, I2C_F_POLL);
     95 	iic_smbus_write_byte(sc->sc_tag, sc->sc_addr, PCF8563_R_CS1, 0,
     96 	    I2C_F_POLL);
     97 	iic_smbus_write_byte(sc->sc_tag, sc->sc_addr, PCF8563_R_CS2, 0,
     98 	    I2C_F_POLL);
     99 	iic_release_bus(sc->sc_tag, I2C_F_POLL);
    100 
    101 	todr_attach(&sc->sc_todr);
    102 }
    103 
    104 static int
    105 pcf8563rtc_gettime(struct todr_chip_handle *ch, struct clock_ymdhms *dt)
    106 {
    107 	struct pcf8563rtc_softc *sc = ch->cookie;
    108 
    109 	if (pcf8563rtc_clock_read(sc, dt) == 0)
    110 		return -1;
    111 
    112 	return 0;
    113 }
    114 
    115 static int
    116 pcf8563rtc_settime(struct todr_chip_handle *ch, struct clock_ymdhms *dt)
    117 {
    118         struct pcf8563rtc_softc *sc = ch->cookie;
    119 
    120 	if (pcf8563rtc_clock_write(sc, dt) == 0)
    121 		return -1;
    122 
    123 	return 0;
    124 }
    125 
    126 static int
    127 pcf8563rtc_clock_read(struct pcf8563rtc_softc *sc, struct clock_ymdhms *dt)
    128 {
    129 	uint8_t bcd[PCF8563_NREGS];
    130 	uint8_t reg = PCF8563_R_SECOND;
    131 	const int flags = I2C_F_POLL;
    132 
    133 	if (iic_acquire_bus(sc->sc_tag, flags)) {
    134 		device_printf(sc->sc_dev, "acquire bus for read failed\n");
    135 		return 0;
    136 	}
    137 
    138 	if (iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP, sc->sc_addr, &reg, 1,
    139 		     &bcd[reg], PCF8563_R_YEAR - reg + 1, flags)) {
    140 		iic_release_bus(sc->sc_tag, flags);
    141 		device_printf(sc->sc_dev, "read failed\n");
    142 		return 0;
    143 	}
    144 
    145 	iic_release_bus(sc->sc_tag, flags);
    146 
    147 	if (bcd[PCF8563_R_SECOND] & PCF8563_M_VL)
    148 		return 0;
    149 
    150 	dt->dt_sec = bcdtobin(bcd[PCF8563_R_SECOND] & PCF8563_M_SECOND);
    151 	dt->dt_min = bcdtobin(bcd[PCF8563_R_MINUTE] & PCF8563_M_MINUTE);
    152 	dt->dt_hour = bcdtobin(bcd[PCF8563_R_HOUR] & PCF8563_M_HOUR);
    153 	dt->dt_day = bcdtobin(bcd[PCF8563_R_DAY] & PCF8563_M_DAY);
    154 	dt->dt_wday = bcdtobin(bcd[PCF8563_R_WEEKDAY] & PCF8563_M_WEEKDAY);
    155 	dt->dt_mon = bcdtobin(bcd[PCF8563_R_MONTH] & PCF8563_M_MONTH);
    156 	dt->dt_year = 1900 +
    157 	    (bcdtobin(bcd[PCF8563_R_YEAR] & PCF8563_M_YEAR) % 100);
    158 	if ((bcd[PCF8563_R_MONTH] & PCF8563_M_CENTURY) == 0)
    159 		dt->dt_year += 100;
    160 
    161 	return 1;
    162 }
    163 
    164 static int
    165 pcf8563rtc_clock_write(struct pcf8563rtc_softc *sc, struct clock_ymdhms *dt)
    166 {
    167 	uint8_t bcd[PCF8563_NREGS];
    168 	uint8_t reg = PCF8563_R_SECOND;
    169 	const int flags = I2C_F_POLL;
    170 
    171 	bcd[PCF8563_R_SECOND] = bintobcd(dt->dt_sec);
    172 	bcd[PCF8563_R_MINUTE] = bintobcd(dt->dt_min);
    173 	bcd[PCF8563_R_HOUR] = bintobcd(dt->dt_hour);
    174 	bcd[PCF8563_R_DAY] = bintobcd(dt->dt_day);
    175 	bcd[PCF8563_R_WEEKDAY] = bintobcd(dt->dt_wday);
    176 	bcd[PCF8563_R_MONTH] = bintobcd(dt->dt_mon);
    177 	bcd[PCF8563_R_YEAR] = bintobcd(dt->dt_year % 100);
    178 	if (dt->dt_year < 2000)
    179 		bcd[PCF8563_R_MONTH] |= PCF8563_M_CENTURY;
    180 
    181 	if (iic_acquire_bus(sc->sc_tag, flags)) {
    182 		device_printf(sc->sc_dev, "acquire bus for write failed\n");
    183 		return 0;
    184 	}
    185 
    186 	if (iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_addr, &reg, 1,
    187 		     &bcd[reg], PCF8563_R_YEAR - reg + 1, flags)) {
    188 		iic_release_bus(sc->sc_tag, flags);
    189 		device_printf(sc->sc_dev, "write failed\n");
    190 		return 0;
    191 	}
    192 
    193 	iic_release_bus(sc->sc_tag, flags);
    194 
    195 	return 1;
    196 }
    197