sys/dev/ic/mk48txx.c

   1 /*      $NetBSD: mk48txx.c,v 1.24 2008/01/10 15:31:27 tsutsui Exp $ */
   2 /*-
   3  * Copyright (c) 2000 The NetBSD Foundation, Inc.
   4  * All rights reserved.
   5  *
   6  * This code is derived from software contributed to The NetBSD Foundation
   7  * by Paul Kranenburg.
   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 copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 /*
  32  * Mostek MK48T02, MK48T08, MK48T59 time-of-day chip subroutines.
  33  */
  34
  35 #include <sys/cdefs.h>
  36 __KERNEL_RCSID(0, "$NetBSD: mk48txx.c,v 1.24 2008/01/10 15:31:27 tsutsui Exp $");
  37
  38 #include <sys/param.h>
  39 #include <sys/systm.h>
  40 #include <sys/device.h>
  41 #include <sys/errno.h>
  42
  43 #include <sys/bus.h>
  44 #include <dev/clock_subr.h>
  45 #include <dev/ic/mk48txxreg.h>
  46 #include <dev/ic/mk48txxvar.h>
  47
  48 int mk48txx_gettime_ymdhms(todr_chip_handle_t, struct clock_ymdhms *);
  49 int mk48txx_settime_ymdhms(todr_chip_handle_t, struct clock_ymdhms *);
  50 uint8_t mk48txx_def_nvrd(struct mk48txx_softc *, int);
  51 void mk48txx_def_nvwr(struct mk48txx_softc *, int, uint8_t);
  52
  53 struct {
  54         const char *name;
  55         bus_size_t nvramsz;
  56         bus_size_t clkoff;
  57         int flags;
  58 #define MK48TXX_EXT_REGISTERS   1       /* Has extended register set */
  59 } mk48txx_models[] = {
  60         { "mk48t02", MK48T02_CLKSZ, MK48T02_CLKOFF, 0 },
  61         { "mk48t08", MK48T08_CLKSZ, MK48T08_CLKOFF, 0 },
  62         { "mk48t18", MK48T18_CLKSZ, MK48T18_CLKOFF, 0 },
  63         { "mk48t59", MK48T59_CLKSZ, MK48T59_CLKOFF, MK48TXX_EXT_REGISTERS },
  64 };
  65
  66 void
  67 mk48txx_attach(struct mk48txx_softc *sc)
  68 {
  69         todr_chip_handle_t handle;
  70         int i;
  71
  72         aprint_normal(": %s", sc->sc_model);
  73
  74         i = __arraycount(mk48txx_models);
  75         while (--i >= 0) {
  76                 if (strcmp(sc->sc_model, mk48txx_models[i].name) == 0)
  77                         break;
  78         }
  79         if (i < 0)
  80                 panic("%s: unsupported model", __func__);
  81
  82         sc->sc_nvramsz = mk48txx_models[i].nvramsz;
  83         sc->sc_clkoffset = mk48txx_models[i].clkoff;
  84
  85         handle = &sc->sc_handle;
  86         handle->cookie = sc;
  87         handle->todr_gettime = NULL;
  88         handle->todr_settime = NULL;
  89         handle->todr_gettime_ymdhms = mk48txx_gettime_ymdhms;
  90         handle->todr_settime_ymdhms = mk48txx_settime_ymdhms;
  91
  92         if (sc->sc_nvrd == NULL)
  93                 sc->sc_nvrd = mk48txx_def_nvrd;
  94         if (sc->sc_nvwr == NULL)
  95                 sc->sc_nvwr = mk48txx_def_nvwr;
  96
  97         todr_attach(handle);
  98 }
  99
 100 /*
 101  * Get time-of-day and convert to a `struct timeval'
 102  * Return 0 on success; an error number otherwise.
 103  */
 104 int
 105 mk48txx_gettime_ymdhms(todr_chip_handle_t handle, struct clock_ymdhms *dt)
 106 {
 107         struct mk48txx_softc *sc;
 108         bus_size_t clkoff;
 109         int year;
 110         uint8_t csr;
 111
 112         sc = handle->cookie;
 113         clkoff = sc->sc_clkoffset;
 114
 115         todr_wenable(handle, 1);
 116
 117         /* enable read (stop time) */
 118         csr = (*sc->sc_nvrd)(sc, clkoff + MK48TXX_ICSR);
 119         csr |= MK48TXX_CSR_READ;
 120         (*sc->sc_nvwr)(sc, clkoff + MK48TXX_ICSR, csr);
 121
 122         dt->dt_sec = FROMBCD((*sc->sc_nvrd)(sc, clkoff + MK48TXX_ISEC));
 123         dt->dt_min = FROMBCD((*sc->sc_nvrd)(sc, clkoff + MK48TXX_IMIN));
 124         dt->dt_hour = FROMBCD((*sc->sc_nvrd)(sc, clkoff + MK48TXX_IHOUR));
 125         dt->dt_day = FROMBCD((*sc->sc_nvrd)(sc, clkoff + MK48TXX_IDAY));
 126         dt->dt_wday = FROMBCD((*sc->sc_nvrd)(sc, clkoff + MK48TXX_IWDAY));
 127         dt->dt_mon = FROMBCD((*sc->sc_nvrd)(sc, clkoff + MK48TXX_IMON));
 128         year = FROMBCD((*sc->sc_nvrd)(sc, clkoff + MK48TXX_IYEAR));
 129
 130         year += sc->sc_year0;
 131         if (year < POSIX_BASE_YEAR &&
 132             (sc->sc_flag & MK48TXX_NO_CENT_ADJUST) == 0)
 133                 year += 100;
 134
 135         dt->dt_year = year;
 136
 137         /* time wears on */
 138         csr = (*sc->sc_nvrd)(sc, clkoff + MK48TXX_ICSR);
 139         csr &= ~MK48TXX_CSR_READ;
 140         (*sc->sc_nvwr)(sc, clkoff + MK48TXX_ICSR, csr);
 141         todr_wenable(handle, 0);
 142
 143         return 0;
 144 }
 145
 146 /*
 147  * Set the time-of-day clock based on the value of the `struct timeval' arg.
 148  * Return 0 on success; an error number otherwise.
 149  */
 150 int
 151 mk48txx_settime_ymdhms(todr_chip_handle_t handle, struct clock_ymdhms *dt)
 152 {
 153         struct mk48txx_softc *sc;
 154         bus_size_t clkoff;
 155         uint8_t csr;
 156         int year;
 157
 158         sc = handle->cookie;
 159         clkoff = sc->sc_clkoffset;
 160
 161         year = dt->dt_year - sc->sc_year0;
 162         if (year > 99 &&
 163             (sc->sc_flag & MK48TXX_NO_CENT_ADJUST) == 0)
 164                 year -= 100;
 165
 166         todr_wenable(handle, 1);
 167         /* enable write */
 168         csr = (*sc->sc_nvrd)(sc, clkoff + MK48TXX_ICSR);
 169         csr |= MK48TXX_CSR_WRITE;
 170         (*sc->sc_nvwr)(sc, clkoff + MK48TXX_ICSR, csr);
 171
 172         (*sc->sc_nvwr)(sc, clkoff + MK48TXX_ISEC, TOBCD(dt->dt_sec));
 173         (*sc->sc_nvwr)(sc, clkoff + MK48TXX_IMIN, TOBCD(dt->dt_min));
 174         (*sc->sc_nvwr)(sc, clkoff + MK48TXX_IHOUR, TOBCD(dt->dt_hour));
 175         (*sc->sc_nvwr)(sc, clkoff + MK48TXX_IWDAY, TOBCD(dt->dt_wday));
 176         (*sc->sc_nvwr)(sc, clkoff + MK48TXX_IDAY, TOBCD(dt->dt_day));
 177         (*sc->sc_nvwr)(sc, clkoff + MK48TXX_IMON, TOBCD(dt->dt_mon));
 178         (*sc->sc_nvwr)(sc, clkoff + MK48TXX_IYEAR, TOBCD(year));
 179
 180         /* load them up */
 181         csr = (*sc->sc_nvrd)(sc, clkoff + MK48TXX_ICSR);
 182         csr &= ~MK48TXX_CSR_WRITE;
 183         (*sc->sc_nvwr)(sc, clkoff + MK48TXX_ICSR, csr);
 184         todr_wenable(handle, 0);
 185         return 0;
 186 }
 187
 188 int
 189 mk48txx_get_nvram_size(todr_chip_handle_t handle, bus_size_t *vp)
 190 {
 191         struct mk48txx_softc *sc;
 192
 193         sc = handle->cookie;
 194         *vp = sc->sc_nvramsz;
 195         return 0;
 196 }
 197
 198 uint8_t
 199 mk48txx_def_nvrd(struct mk48txx_softc *sc, int off)
 200 {
 201
 202         return bus_space_read_1(sc->sc_bst, sc->sc_bsh, off);
 203 }
 204
 205 void
 206 mk48txx_def_nvwr(struct mk48txx_softc *sc, int off, uint8_t v)
 207 {
 208
 209         bus_space_write_1(sc->sc_bst, sc->sc_bsh, off, v);
 210 }