root/dev/i2c/rs5c372.c

DEFINITIONS

1. ricohrtc_match
2. ricohrtc_attach
3. ricohrtc_gettime
4. ricohrtc_settime
5. ricohrtc_setcal
6. ricohrtc_getcal
7. ricohrtc_reg_write
8. ricohrtc_clock_read
9. ricohrtc_clock_write

    1 /*      $NetBSD: rs5c372.c,v 1.5 2006/03/29 06:41:24 thorpej Exp $      */
    3 /*
    4  * Copyright (c) 2005 Kimihiro Nonaka
    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 WASABI SYSTEMS, INC. ``AS IS'' AND
   17  * 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 WASABI SYSTEMS, INC
   20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   26  * POSSIBILITY OF SUCH DAMAGE.
   27  */
   29 #include <sys/param.h>
   30 #include <sys/systm.h>
   31 #include <sys/device.h>
   32 #include <sys/kernel.h>
   33 #include <sys/fcntl.h>
   34 #include <sys/uio.h>
   35 #include <sys/conf.h>
   36 #include <sys/event.h>
   38 #include <dev/clock_subr.h>
   40 #include <dev/i2c/i2cvar.h>
   42 /*
   43  * RS5C372[AB] Real-Time Clock
   44  */
   46 #define RICOHRTC_ADDR           0x32    /* Fixed I2C Slave Address */
   48 #define RICOHRTC_SECONDS        0
   49 #define RICOHRTC_MINUTES        1
   50 #define RICOHRTC_HOURS          2
   51 #define RICOHRTC_DAY            3
   52 #define RICOHRTC_DATE           4
   53 #define RICOHRTC_MONTH          5
   54 #define RICOHRTC_YEAR           6
   55 #define RICOHRTC_CLOCK_CORRECT  7
   56 #define RICOHRTC_ALARMA_MIN     8
   57 #define RICOHRTC_ALARMA_HOUR    9
   58 #define RICOHRTC_ALARMA_DATE    10
   59 #define RICOHRTC_ALARMB_MIN     11
   60 #define RICOHRTC_ALARMB_HOUR    12
   61 #define RICOHRTC_ALARMB_DATE    13
   62 #define RICOHRTC_CONTROL1       14
   63 #define RICOHRTC_CONTROL2       15
   64 #define RICOHRTC_NREGS          16
   65 #define RICOHRTC_NRTC_REGS      7
   67 /*
   68  * Bit definitions.
   69  */
   70 #define RICOHRTC_SECONDS_MASK   0x7f
   71 #define RICOHRTC_MINUTES_MASK   0x7f
   72 #define RICOHRTC_HOURS_12HRS_PM (1u << 5)       /* If 12 hr mode, set = PM */
   73 #define RICOHRTC_HOURS_12MASK   0x1f
   74 #define RICOHRTC_HOURS_24MASK   0x3f
   75 #define RICOHRTC_DAY_MASK       0x07
   76 #define RICOHRTC_DATE_MASK      0x3f
   77 #define RICOHRTC_MONTH_MASK     0x1f
   78 #define RICOHRTC_CONTROL2_24HRS (1u << 5)
   79 #define RICOHRTC_CONTROL2_XSTP  (1u << 4)       /* read */
   80 #define RICOHRTC_CONTROL2_ADJ   (1u << 4)       /* write */
   81 #define RICOHRTC_CONTROL2_NCLEN (1u << 3)
   82 #define RICOHRTC_CONTROL2_CTFG  (1u << 2)
   83 #define RICOHRTC_CONTROL2_AAFG  (1u << 1)
   84 #define RICOHRTC_CONTROL2_BAFG  (1u << 0)
   86 struct ricohrtc_softc {
   87         struct device sc_dev;
i2c_tag_t sc_tag;
   89         int sc_address;
   90         struct todr_chip_handle sc_todr;
   91 };
   93 int ricohrtc_match(struct device *, void *, void *);
   94 void ricohrtc_attach(struct device *, struct device *, void *);
   96 struct cfattach ricohrtc_ca = {
   97         sizeof(struct ricohrtc_softc), ricohrtc_match, ricohrtc_attach
   98 };
  100 struct cfdriver ricohrtc_cd = {
NULL, "ricohrtc", DV_DULL
  102 };
  104 void ricohrtc_reg_write(struct ricohrtc_softc *, int, uint8_t);
  105 int ricohrtc_clock_read(struct ricohrtc_softc *, struct clock_ymdhms *);
  106 int ricohrtc_clock_write(struct ricohrtc_softc *, struct clock_ymdhms *);
  107 int ricohrtc_gettime(struct todr_chip_handle *, struct timeval *);
  108 int ricohrtc_settime(struct todr_chip_handle *, struct timeval *);
  109 int ricohrtc_getcal(struct todr_chip_handle *, int *);
  110 int ricohrtc_setcal(struct todr_chip_handle *, int);
  112 int
ricohrtc_match(struct device *parent, void *v, void *arg)
  114 {
  115         struct i2c_attach_args *ia = arg;
  116 #ifdef PARANOID_CHECKS
u_int8_t data, cmd;
  118 #endif
  120         if (ia->ia_addr != RICOHRTC_ADDR)
  121                 return (0);
  123 #ifdef PARANOID_CHECKS
  124         /* Verify that the 'reserved bits in a few registers read 0 */
  125         if (iic_acquire_bus(ia->ia_tag, I2C_F_POLL)) {
printf("ricohrtc acquire fail\n");
  127                 return (0);
  128         }
cmd = RICOHRTC_SECONDS;
  131         if (iic_exec(ia->ia_tag, I2C_OP_READ_WITH_STOP, ia->ia_addr,
  132             &cmd, 1, &data, 1, I2C_F_POLL)) {
iic_release_bus(ia->ia_tag, I2C_F_POLL);
printf("ricohrtc read %d fail\n", cmd);
  135                 return (0);
  136         }
  137         if ((data & ~RICOHRTC_SECONDS_MASK) != 0) {
printf("ricohrtc second %d\n",data);
  139                 return (0);
  140         }
cmd = RICOHRTC_MINUTES;
  143         if (iic_exec(ia->ia_tag, I2C_OP_READ_WITH_STOP, ia->ia_addr,
  144             &cmd, 1, &data, 1, I2C_F_POLL)) {
iic_release_bus(ia->ia_tag, I2C_F_POLL);
printf("ricohrtc read %d fail\n", cmd);
  147                 return (0);
  148         }
  150         if ((data & ~RICOHRTC_MINUTES_MASK) != 0) {
printf("ricohrtc minute %d\n",data);
  152                 return (0);
  153         }
cmd = RICOHRTC_HOURS;
  156         if (iic_exec(ia->ia_tag, I2C_OP_READ_WITH_STOP, ia->ia_addr,
  157             &cmd, 1, &data, 1, I2C_F_POLL)) {
iic_release_bus(ia->ia_tag, I2C_F_POLL);
printf("ricohrtc read %d fail\n", cmd);
  160                 return (0);
  161         }
  162         if ((data & ~RICOHRTC_HOURS_24MASK) != 0) {
printf("ricohrtc hour %d\n",data);
  164                 return (0);
  165         }
  166 #endif
iic_release_bus(ia->ia_tag, I2C_F_POLL);
  169         return (1);
  170 }
  172 void
ricohrtc_attach(struct device *parent, struct device *self, void *arg)
  174 {
  175         struct ricohrtc_softc *sc = (struct ricohrtc_softc *)self;
  176         struct i2c_attach_args *ia = arg;
printf(": RICOH RS5C372[AB] Real-time Clock\n");
sc->sc_tag = ia->ia_tag;
sc->sc_address = ia->ia_addr;
sc->sc_todr.cookie = sc;
sc->sc_todr.todr_gettime = ricohrtc_gettime;
sc->sc_todr.todr_settime = ricohrtc_settime;
sc->sc_todr.todr_getcal = ricohrtc_getcal;
sc->sc_todr.todr_setcal = ricohrtc_setcal;
sc->sc_todr.todr_setwen = NULL;
  189 #if 0
todr_attach(&sc->sc_todr);
  191 #else
  192         /* XXX */
  193         {
  194         extern todr_chip_handle_t todr_handle;
todr_handle = &sc->sc_todr;
  196         }
  197 #endif
  199         /* Initialize RTC */
ricohrtc_reg_write(sc, RICOHRTC_CONTROL2, RICOHRTC_CONTROL2_24HRS);
ricohrtc_reg_write(sc, RICOHRTC_CONTROL1, 0);
  202 }
  204 int
ricohrtc_gettime(struct todr_chip_handle *ch, struct timeval *tv)
  206 {
  207         struct ricohrtc_softc *sc = ch->cookie;
  208         struct clock_ymdhms dt;
memset(&dt, 0, sizeof(dt));
  211         if (ricohrtc_clock_read(sc, &dt) == 0)
  212                 return (-1);
tv->tv_sec = clock_ymdhms_to_secs(&dt);
tv->tv_usec = 0;
  216         return (0);
  217 }
  219 int
ricohrtc_settime(struct todr_chip_handle *ch, struct timeval *tv)
  221 {
  222         struct ricohrtc_softc *sc = ch->cookie;
  223         struct clock_ymdhms dt;
clock_secs_to_ymdhms(tv->tv_sec, &dt);
  227         if (ricohrtc_clock_write(sc, &dt) == 0)
  228                 return (-1);
  229         return (0);
  230 }
  232 int
ricohrtc_setcal(struct todr_chip_handle *ch, int cal)
  234 {
  236         return (EOPNOTSUPP);
  237 }
  239 int
ricohrtc_getcal(struct todr_chip_handle *ch, int *cal)
  241 {
  243         return (EOPNOTSUPP);
  244 }
  246 void
ricohrtc_reg_write(struct ricohrtc_softc *sc, int reg, uint8_t val)
  248 {
uint8_t cmd;
iic_acquire_bus(sc->sc_tag, I2C_F_POLL);
reg &= 0xf;
cmd = (reg << 4);
  254         if (iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_address,
  255             &cmd, 1, &val, 1, I2C_F_POLL)) {
iic_release_bus(sc->sc_tag, I2C_F_POLL);
printf("%s: ricohrtc_reg_write: failed to write reg%d\n",
sc->sc_dev.dv_xname, reg);
  259                 return;
  260         }
iic_release_bus(sc->sc_tag, I2C_F_POLL);
  262 }
  264 int
ricohrtc_clock_read(struct ricohrtc_softc *sc, struct clock_ymdhms *dt)
  266 {
uint8_t bcd[RICOHRTC_NRTC_REGS];
uint8_t cmd;
iic_acquire_bus(sc->sc_tag, I2C_F_POLL);
cmd = (RICOHRTC_SECONDS << 4);
  272         if (iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP, sc->sc_address,
  273             &cmd, 1, bcd, RICOHRTC_NRTC_REGS, I2C_F_POLL)) {
iic_release_bus(sc->sc_tag, I2C_F_POLL);
printf("%s: ricohrtc_clock_read: failed to read rtc\n",
sc->sc_dev.dv_xname);
  277                 return (0);
  278         }
iic_release_bus(sc->sc_tag, I2C_F_POLL);
  281         /*
  282          * Convert the RICOHRTC's register values into something useable
  283          */
dt->dt_sec = FROMBCD(bcd[RICOHRTC_SECONDS] & RICOHRTC_SECONDS_MASK);
dt->dt_min = FROMBCD(bcd[RICOHRTC_MINUTES] & RICOHRTC_MINUTES_MASK);
dt->dt_hour = FROMBCD(bcd[RICOHRTC_HOURS] & RICOHRTC_HOURS_24MASK);
dt->dt_day = FROMBCD(bcd[RICOHRTC_DATE] & RICOHRTC_DATE_MASK);
dt->dt_mon = FROMBCD(bcd[RICOHRTC_MONTH] & RICOHRTC_MONTH_MASK);
dt->dt_year = FROMBCD(bcd[RICOHRTC_YEAR]) + POSIX_BASE_YEAR;
  290         return (1);
  291 }
  293 int
ricohrtc_clock_write(struct ricohrtc_softc *sc, struct clock_ymdhms *dt)
  295 {
uint8_t bcd[RICOHRTC_NRTC_REGS];
uint8_t cmd;
  299         /*
  300          * Convert our time representation into something the RICOHRTC
  301          * can understand.
  302          */
bcd[RICOHRTC_SECONDS] = TOBCD(dt->dt_sec);
bcd[RICOHRTC_MINUTES] = TOBCD(dt->dt_min);
bcd[RICOHRTC_HOURS] = TOBCD(dt->dt_hour);
bcd[RICOHRTC_DATE] = TOBCD(dt->dt_day);
bcd[RICOHRTC_DAY] = TOBCD(dt->dt_wday);
bcd[RICOHRTC_MONTH] = TOBCD(dt->dt_mon);
bcd[RICOHRTC_YEAR] = TOBCD(dt->dt_year - POSIX_BASE_YEAR);
iic_acquire_bus(sc->sc_tag, I2C_F_POLL);
cmd = (RICOHRTC_SECONDS << 4);
  313         if (iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_address,
  314             &cmd, 1, bcd, RICOHRTC_NRTC_REGS, I2C_F_POLL)) {
iic_release_bus(sc->sc_tag, I2C_F_POLL);
printf("%s: ricohrtc_clock_write: failed to write rtc\n",
sc->sc_dev.dv_xname);
  318                 return (0);
  319         }
iic_release_bus(sc->sc_tag, I2C_F_POLL);
  321         return (1);
  322 }