mk48txx.c revision 201005
193836Stmm/*- 293836Stmm * Copyright (c) 2000 The NetBSD Foundation, Inc. 393836Stmm * All rights reserved. 493836Stmm * 593836Stmm * This code is derived from software contributed to The NetBSD Foundation 693836Stmm * by Paul Kranenburg. 793836Stmm * 893836Stmm * Redistribution and use in source and binary forms, with or without 993836Stmm * modification, are permitted provided that the following conditions 1093836Stmm * are met: 1193836Stmm * 1. Redistributions of source code must retain the above copyright 1293836Stmm * notice, this list of conditions and the following disclaimer. 1393836Stmm * 2. Redistributions in binary form must reproduce the above copyright 1493836Stmm * notice, this list of conditions and the following disclaimer in the 1593836Stmm * documentation and/or other materials provided with the distribution. 1693836Stmm * 1793836Stmm * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 1893836Stmm * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 1993836Stmm * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2093836Stmm * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 2193836Stmm * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 2293836Stmm * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 2393836Stmm * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 2493836Stmm * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 2593836Stmm * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 2693836Stmm * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 2793836Stmm * POSSIBILITY OF SUCH DAMAGE. 2893836Stmm * 29201004Smarius * $NetBSD: mk48txx.c,v 1.25 2008/04/28 20:23:50 martin Exp $ 3093836Stmm */ 3193836Stmm 32119418Sobrien#include <sys/cdefs.h> 33119418Sobrien__FBSDID("$FreeBSD: head/sys/dev/mk48txx/mk48txx.c 201005 2009-12-25 21:53:20Z marius $"); 34119418Sobrien 3593836Stmm/* 36201003Smarius * Mostek MK48T02, MK48T08, MK48T18, MK48T59 time-of-day chip subroutines 3793836Stmm */ 3893836Stmm 3993836Stmm#include <sys/param.h> 4093836Stmm#include <sys/systm.h> 4193836Stmm#include <sys/bus.h> 4293836Stmm#include <sys/clock.h> 43146416Smarius#include <sys/eventhandler.h> 44146416Smarius#include <sys/lock.h> 45146416Smarius#include <sys/mutex.h> 46201005Smarius#include <sys/rman.h> 47146416Smarius#include <sys/watchdog.h> 4893836Stmm 4993836Stmm#include <machine/bus.h> 5093836Stmm 51119352Smarcel#include <dev/mk48txx/mk48txxreg.h> 52137813Smarius#include <dev/mk48txx/mk48txxvar.h> 5393836Stmm 5493836Stmm#include "clock_if.h" 5593836Stmm 56201003Smariusstatic uint8_t mk48txx_def_nvrd(device_t dev, int off); 57201003Smariusstatic void mk48txx_def_nvwr(device_t dev, int off, uint8_t v); 58201003Smariusstatic void mk48txx_watchdog(void *arg, u_int cmd, int *error); 5993836Stmm 60201003Smariusstatic const struct { 6193836Stmm const char *name; 6293836Stmm bus_size_t nvramsz; 6393836Stmm bus_size_t clkoff; 64201003Smarius u_int flags; 65201003Smarius#define MK48TXX_EXT_REGISTERS 1 /* Has extended register set. */ 66201003Smarius} const mk48txx_models[] = { 6793836Stmm { "mk48t02", MK48T02_CLKSZ, MK48T02_CLKOFF, 0 }, 6893836Stmm { "mk48t08", MK48T08_CLKSZ, MK48T08_CLKOFF, 0 }, 69137813Smarius { "mk48t18", MK48T18_CLKSZ, MK48T18_CLKOFF, 0 }, 7093836Stmm { "mk48t59", MK48T59_CLKSZ, MK48T59_CLKOFF, MK48TXX_EXT_REGISTERS }, 7193836Stmm}; 7293836Stmm 7393836Stmmint 74137813Smariusmk48txx_attach(device_t dev) 7593836Stmm{ 7693836Stmm struct mk48txx_softc *sc; 7793836Stmm int i; 78146416Smarius uint8_t wday; 7993836Stmm 80137813Smarius sc = device_get_softc(dev); 81137813Smarius 82146416Smarius if (mtx_initialized(&sc->sc_mtx) == 0) { 83146416Smarius device_printf(dev, "%s: mutex not initialized\n", __func__); 84146416Smarius return (ENXIO); 85146416Smarius } 86146416Smarius 87137813Smarius device_printf(dev, "model %s", sc->sc_model); 8893836Stmm i = sizeof(mk48txx_models) / sizeof(mk48txx_models[0]); 8993836Stmm while (--i >= 0) { 90137813Smarius if (strcmp(sc->sc_model, mk48txx_models[i].name) == 0) { 9193836Stmm break; 9293836Stmm } 9393836Stmm } 9493836Stmm if (i < 0) { 9593836Stmm device_printf(dev, " (unsupported)\n"); 9693836Stmm return (ENXIO); 9793836Stmm } 9893836Stmm printf("\n"); 99137813Smarius sc->sc_nvramsz = mk48txx_models[i].nvramsz; 100137813Smarius sc->sc_clkoffset = mk48txx_models[i].clkoff; 10193836Stmm 102137813Smarius if (sc->sc_nvrd == NULL) 103137813Smarius sc->sc_nvrd = mk48txx_def_nvrd; 104137813Smarius if (sc->sc_nvwr == NULL) 105137813Smarius sc->sc_nvwr = mk48txx_def_nvwr; 106137813Smarius 107146416Smarius if (mk48txx_models[i].flags & MK48TXX_EXT_REGISTERS) { 108146416Smarius mtx_lock(&sc->sc_mtx); 109201003Smarius if ((*sc->sc_nvrd)(dev, sc->sc_clkoffset + MK48TXX_FLAGS) & 110146416Smarius MK48TXX_FLAGS_BL) { 111146416Smarius mtx_unlock(&sc->sc_mtx); 112146416Smarius device_printf(dev, "%s: battery low\n", __func__); 113146416Smarius return (ENXIO); 114146416Smarius } 115146416Smarius mtx_unlock(&sc->sc_mtx); 116135481Smarius } 117135481Smarius 118146416Smarius if (sc->sc_flag & MK48TXX_NO_CENT_ADJUST) { 119146416Smarius /* 120146416Smarius * Use MK48TXX_WDAY_CB instead of manually adjusting the 121146416Smarius * century. 122146416Smarius */ 123146416Smarius if (!(mk48txx_models[i].flags & MK48TXX_EXT_REGISTERS)) { 124146416Smarius device_printf(dev, "%s: no century bit\n", __func__); 125146416Smarius return (ENXIO); 126146416Smarius } else { 127146416Smarius mtx_lock(&sc->sc_mtx); 128146416Smarius wday = (*sc->sc_nvrd) 129146416Smarius (dev, sc->sc_clkoffset + MK48TXX_IWDAY); 130146416Smarius wday |= MK48TXX_WDAY_CEB; 131146416Smarius (*sc->sc_nvwr) 132146416Smarius (dev, sc->sc_clkoffset + MK48TXX_IWDAY, wday); 133146416Smarius mtx_unlock(&sc->sc_mtx); 134146416Smarius } 135146416Smarius } 136146416Smarius 137201003Smarius clock_register(dev, 1000000); /* 1 second resolution */ 13893836Stmm 139146416Smarius if ((sc->sc_flag & MK48TXX_WDOG_REGISTER) && 140146416Smarius (mk48txx_models[i].flags & MK48TXX_EXT_REGISTERS)) { 141146416Smarius sc->sc_wet = EVENTHANDLER_REGISTER(watchdog_list, 142146416Smarius mk48txx_watchdog, dev, 0); 143146416Smarius device_printf(dev, 144161837Smarius "watchdog registered, timeout interval max. 128 sec\n"); 145146416Smarius } 146146416Smarius 14793836Stmm return (0); 14893836Stmm} 14993836Stmm 15093836Stmm/* 15193836Stmm * Get time-of-day and convert to a `struct timespec' 15293836Stmm * Return 0 on success; an error number otherwise. 15393836Stmm */ 15493836Stmmint 15593836Stmmmk48txx_gettime(device_t dev, struct timespec *ts) 15693836Stmm{ 157137813Smarius struct mk48txx_softc *sc; 158137813Smarius bus_size_t clkoff; 15993836Stmm struct clocktime ct; 16093836Stmm int year; 161146416Smarius uint8_t csr; 16293836Stmm 163137813Smarius sc = device_get_softc(dev); 164137813Smarius clkoff = sc->sc_clkoffset; 165137813Smarius 166146416Smarius mtx_lock(&sc->sc_mtx); 16793836Stmm /* enable read (stop time) */ 168137813Smarius csr = (*sc->sc_nvrd)(dev, clkoff + MK48TXX_ICSR); 16993836Stmm csr |= MK48TXX_CSR_READ; 170137813Smarius (*sc->sc_nvwr)(dev, clkoff + MK48TXX_ICSR, csr); 17193836Stmm 172137813Smarius#define FROMREG(reg, mask) ((*sc->sc_nvrd)(dev, clkoff + (reg)) & (mask)) 173135481Smarius 17493836Stmm ct.nsec = 0; 175135481Smarius ct.sec = FROMBCD(FROMREG(MK48TXX_ISEC, MK48TXX_SEC_MASK)); 176135481Smarius ct.min = FROMBCD(FROMREG(MK48TXX_IMIN, MK48TXX_MIN_MASK)); 177135481Smarius ct.hour = FROMBCD(FROMREG(MK48TXX_IHOUR, MK48TXX_HOUR_MASK)); 178135481Smarius ct.day = FROMBCD(FROMREG(MK48TXX_IDAY, MK48TXX_DAY_MASK)); 179201005Smarius#if 0 180135481Smarius /* Map dow from 1 - 7 to 0 - 6; FROMBCD() isn't necessary here. */ 181135481Smarius ct.dow = FROMREG(MK48TXX_IWDAY, MK48TXX_WDAY_MASK) - 1; 182201005Smarius#else 183201005Smarius /* 184201005Smarius * Set dow = -1 because some drivers (for example the NetBSD and 185201005Smarius * OpenBSD mk48txx(4)) don't set it correctly. 186201005Smarius */ 187201005Smarius ct.dow = - 1; 188201005Smarius#endif 189135481Smarius ct.mon = FROMBCD(FROMREG(MK48TXX_IMON, MK48TXX_MON_MASK)); 190135481Smarius year = FROMBCD(FROMREG(MK48TXX_IYEAR, MK48TXX_YEAR_MASK)); 191146416Smarius year += sc->sc_year0; 192146416Smarius if (sc->sc_flag & MK48TXX_NO_CENT_ADJUST) 193146416Smarius year += (FROMREG(MK48TXX_IWDAY, MK48TXX_WDAY_CB) >> 194146416Smarius MK48TXX_WDAY_CB_SHIFT) * 100; 195146416Smarius else if (year < POSIX_BASE_YEAR) 196146416Smarius year += 100; 19793836Stmm 198135481Smarius#undef FROMREG 199135481Smarius 20093836Stmm ct.year = year; 20193836Stmm 20293836Stmm /* time wears on */ 203137813Smarius csr = (*sc->sc_nvrd)(dev, clkoff + MK48TXX_ICSR); 20493836Stmm csr &= ~MK48TXX_CSR_READ; 205137813Smarius (*sc->sc_nvwr)(dev, clkoff + MK48TXX_ICSR, csr); 206146416Smarius mtx_unlock(&sc->sc_mtx); 20793836Stmm 20893836Stmm return (clock_ct_to_ts(&ct, ts)); 20993836Stmm} 21093836Stmm 21193836Stmm/* 21293836Stmm * Set the time-of-day clock based on the value of the `struct timespec' arg. 21393836Stmm * Return 0 on success; an error number otherwise. 21493836Stmm */ 21593836Stmmint 21693836Stmmmk48txx_settime(device_t dev, struct timespec *ts) 21793836Stmm{ 218137813Smarius struct mk48txx_softc *sc; 219137813Smarius bus_size_t clkoff; 22093836Stmm struct clocktime ct; 221146416Smarius uint8_t csr; 222146416Smarius int cent, year; 22393836Stmm 224137813Smarius sc = device_get_softc(dev); 225137813Smarius clkoff = sc->sc_clkoffset; 226137813Smarius 22793836Stmm /* Accuracy is only one second. */ 22893836Stmm if (ts->tv_nsec >= 500000000) 22993836Stmm ts->tv_sec++; 23093836Stmm ts->tv_nsec = 0; 23193836Stmm clock_ts_to_ct(ts, &ct); 23293836Stmm 233146416Smarius mtx_lock(&sc->sc_mtx); 23493836Stmm /* enable write */ 235137813Smarius csr = (*sc->sc_nvrd)(dev, clkoff + MK48TXX_ICSR); 23693836Stmm csr |= MK48TXX_CSR_WRITE; 237137813Smarius (*sc->sc_nvwr)(dev, clkoff + MK48TXX_ICSR, csr); 23893836Stmm 239135481Smarius#define TOREG(reg, mask, val) \ 240137813Smarius ((*sc->sc_nvwr)(dev, clkoff + (reg), \ 241137813Smarius ((*sc->sc_nvrd)(dev, clkoff + (reg)) & ~(mask)) | \ 242135481Smarius ((val) & (mask)))) 24393836Stmm 244135481Smarius TOREG(MK48TXX_ISEC, MK48TXX_SEC_MASK, TOBCD(ct.sec)); 245135481Smarius TOREG(MK48TXX_IMIN, MK48TXX_MIN_MASK, TOBCD(ct.min)); 246135481Smarius TOREG(MK48TXX_IHOUR, MK48TXX_HOUR_MASK, TOBCD(ct.hour)); 247135481Smarius /* Map dow from 0 - 6 to 1 - 7; TOBCD() isn't necessary here. */ 248135481Smarius TOREG(MK48TXX_IWDAY, MK48TXX_WDAY_MASK, ct.dow + 1); 249135481Smarius TOREG(MK48TXX_IDAY, MK48TXX_DAY_MASK, TOBCD(ct.day)); 250135481Smarius TOREG(MK48TXX_IMON, MK48TXX_MON_MASK, TOBCD(ct.mon)); 251146416Smarius 252146416Smarius year = ct.year - sc->sc_year0; 253146416Smarius if (sc->sc_flag & MK48TXX_NO_CENT_ADJUST) { 254146416Smarius cent = year / 100; 255146416Smarius TOREG(MK48TXX_IWDAY, MK48TXX_WDAY_CB, 256146416Smarius cent << MK48TXX_WDAY_CB_SHIFT); 257146416Smarius year -= cent * 100; 258146416Smarius } else if (year > 99) 259146416Smarius year -= 100; 260135481Smarius TOREG(MK48TXX_IYEAR, MK48TXX_YEAR_MASK, TOBCD(year)); 261135481Smarius 262135481Smarius#undef TOREG 263135481Smarius 26493836Stmm /* load them up */ 265137813Smarius csr = (*sc->sc_nvrd)(dev, clkoff + MK48TXX_ICSR); 26693836Stmm csr &= ~MK48TXX_CSR_WRITE; 267137813Smarius (*sc->sc_nvwr)(dev, clkoff + MK48TXX_ICSR, csr); 268146416Smarius mtx_unlock(&sc->sc_mtx); 26993836Stmm return (0); 27093836Stmm} 27193836Stmm 272146416Smariusstatic uint8_t 273137813Smariusmk48txx_def_nvrd(device_t dev, int off) 27493836Stmm{ 275137813Smarius struct mk48txx_softc *sc; 27693836Stmm 277137813Smarius sc = device_get_softc(dev); 278201005Smarius return (bus_read_1(sc->sc_res, off)); 27993836Stmm} 280137813Smarius 281137813Smariusstatic void 282146416Smariusmk48txx_def_nvwr(device_t dev, int off, uint8_t v) 283137813Smarius{ 284137813Smarius struct mk48txx_softc *sc; 285137813Smarius 286137813Smarius sc = device_get_softc(dev); 287201005Smarius bus_write_1(sc->sc_res, off, v); 288137813Smarius} 289146416Smarius 290146416Smariusstatic void 291146416Smariusmk48txx_watchdog(void *arg, u_int cmd, int *error) 292146416Smarius{ 293146416Smarius device_t dev; 294146416Smarius struct mk48txx_softc *sc; 295146416Smarius uint8_t t, wdog; 296146416Smarius 297146416Smarius dev = arg; 298146416Smarius sc = device_get_softc(dev); 299146416Smarius 300146416Smarius t = cmd & WD_INTERVAL; 301167950Sn_hibma if (t >= 26 && t <= 37) { 302167950Sn_hibma wdog = 0; 303146416Smarius if (t <= WD_TO_2SEC) { 304146416Smarius wdog |= MK48TXX_WDOG_RB_1_16; 305146416Smarius t -= 26; 306146416Smarius } else if (t <= WD_TO_8SEC) { 307146416Smarius wdog |= MK48TXX_WDOG_RB_1_4; 308146416Smarius t -= WD_TO_250MS; 309146416Smarius } else if (t <= WD_TO_32SEC) { 310146416Smarius wdog |= MK48TXX_WDOG_RB_1; 311146416Smarius t -= WD_TO_1SEC; 312146416Smarius } else { 313146416Smarius wdog |= MK48TXX_WDOG_RB_4; 314146416Smarius t -= WD_TO_4SEC; 315146416Smarius } 316146416Smarius wdog |= (min(1 << t, 317146416Smarius MK48TXX_WDOG_BMB_MASK >> MK48TXX_WDOG_BMB_SHIFT)) << 318146416Smarius MK48TXX_WDOG_BMB_SHIFT; 319146416Smarius if (sc->sc_flag & MK48TXX_WDOG_ENABLE_WDS) 320146416Smarius wdog |= MK48TXX_WDOG_WDS; 321146416Smarius *error = 0; 322167950Sn_hibma } else { 323167950Sn_hibma wdog = 0; 324146416Smarius } 325146416Smarius mtx_lock(&sc->sc_mtx); 326146416Smarius (*sc->sc_nvwr)(dev, sc->sc_clkoffset + MK48TXX_WDOG, wdog); 327146416Smarius mtx_unlock(&sc->sc_mtx); 328146416Smarius} 329