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$"); 34119418Sobrien 3593836Stmm/* 36221957Smarius * Mostek MK48T02, MK48T08, MK48T18, MK48T37 and MK48T59 time-of-day chip 37221957Smarius * subroutines 3893836Stmm */ 3993836Stmm 4093836Stmm#include <sys/param.h> 4193836Stmm#include <sys/systm.h> 4293836Stmm#include <sys/bus.h> 4393836Stmm#include <sys/clock.h> 44146416Smarius#include <sys/eventhandler.h> 45146416Smarius#include <sys/lock.h> 46146416Smarius#include <sys/mutex.h> 47201005Smarius#include <sys/rman.h> 48146416Smarius#include <sys/watchdog.h> 4993836Stmm 5093836Stmm#include <machine/bus.h> 5193836Stmm 52119352Smarcel#include <dev/mk48txx/mk48txxreg.h> 53137813Smarius#include <dev/mk48txx/mk48txxvar.h> 5493836Stmm 5593836Stmm#include "clock_if.h" 5693836Stmm 57201003Smariusstatic uint8_t mk48txx_def_nvrd(device_t dev, int off); 58201003Smariusstatic void mk48txx_def_nvwr(device_t dev, int off, uint8_t v); 59201003Smariusstatic void mk48txx_watchdog(void *arg, u_int cmd, int *error); 6093836Stmm 61201003Smariusstatic const struct { 6293836Stmm const char *name; 6393836Stmm bus_size_t nvramsz; 6493836Stmm bus_size_t clkoff; 65201003Smarius u_int flags; 66201003Smarius#define MK48TXX_EXT_REGISTERS 1 /* Has extended register set. */ 67201003Smarius} const mk48txx_models[] = { 6893836Stmm { "mk48t02", MK48T02_CLKSZ, MK48T02_CLKOFF, 0 }, 6993836Stmm { "mk48t08", MK48T08_CLKSZ, MK48T08_CLKOFF, 0 }, 70137813Smarius { "mk48t18", MK48T18_CLKSZ, MK48T18_CLKOFF, 0 }, 71221957Smarius { "mk48t37", MK48T37_CLKSZ, MK48T37_CLKOFF, MK48TXX_EXT_REGISTERS }, 7293836Stmm { "mk48t59", MK48T59_CLKSZ, MK48T59_CLKOFF, MK48TXX_EXT_REGISTERS }, 7393836Stmm}; 7493836Stmm 7593836Stmmint 76137813Smariusmk48txx_attach(device_t dev) 7793836Stmm{ 7893836Stmm struct mk48txx_softc *sc; 7993836Stmm int i; 80146416Smarius uint8_t wday; 8193836Stmm 82137813Smarius sc = device_get_softc(dev); 83137813Smarius 84146416Smarius if (mtx_initialized(&sc->sc_mtx) == 0) { 85146416Smarius device_printf(dev, "%s: mutex not initialized\n", __func__); 86146416Smarius return (ENXIO); 87146416Smarius } 88146416Smarius 89137813Smarius device_printf(dev, "model %s", sc->sc_model); 9093836Stmm i = sizeof(mk48txx_models) / sizeof(mk48txx_models[0]); 9193836Stmm while (--i >= 0) { 92137813Smarius if (strcmp(sc->sc_model, mk48txx_models[i].name) == 0) { 9393836Stmm break; 9493836Stmm } 9593836Stmm } 9693836Stmm if (i < 0) { 9793836Stmm device_printf(dev, " (unsupported)\n"); 9893836Stmm return (ENXIO); 9993836Stmm } 10093836Stmm printf("\n"); 101137813Smarius sc->sc_nvramsz = mk48txx_models[i].nvramsz; 102137813Smarius sc->sc_clkoffset = mk48txx_models[i].clkoff; 10393836Stmm 104137813Smarius if (sc->sc_nvrd == NULL) 105137813Smarius sc->sc_nvrd = mk48txx_def_nvrd; 106137813Smarius if (sc->sc_nvwr == NULL) 107137813Smarius sc->sc_nvwr = mk48txx_def_nvwr; 108137813Smarius 109146416Smarius if (mk48txx_models[i].flags & MK48TXX_EXT_REGISTERS) { 110146416Smarius mtx_lock(&sc->sc_mtx); 111201003Smarius if ((*sc->sc_nvrd)(dev, sc->sc_clkoffset + MK48TXX_FLAGS) & 112146416Smarius MK48TXX_FLAGS_BL) { 113146416Smarius mtx_unlock(&sc->sc_mtx); 114146416Smarius device_printf(dev, "%s: battery low\n", __func__); 115146416Smarius return (ENXIO); 116146416Smarius } 117146416Smarius mtx_unlock(&sc->sc_mtx); 118135481Smarius } 119135481Smarius 120146416Smarius if (sc->sc_flag & MK48TXX_NO_CENT_ADJUST) { 121146416Smarius /* 122146416Smarius * Use MK48TXX_WDAY_CB instead of manually adjusting the 123146416Smarius * century. 124146416Smarius */ 125146416Smarius if (!(mk48txx_models[i].flags & MK48TXX_EXT_REGISTERS)) { 126146416Smarius device_printf(dev, "%s: no century bit\n", __func__); 127146416Smarius return (ENXIO); 128146416Smarius } else { 129146416Smarius mtx_lock(&sc->sc_mtx); 130146416Smarius wday = (*sc->sc_nvrd) 131146416Smarius (dev, sc->sc_clkoffset + MK48TXX_IWDAY); 132146416Smarius wday |= MK48TXX_WDAY_CEB; 133146416Smarius (*sc->sc_nvwr) 134146416Smarius (dev, sc->sc_clkoffset + MK48TXX_IWDAY, wday); 135146416Smarius mtx_unlock(&sc->sc_mtx); 136146416Smarius } 137146416Smarius } 138146416Smarius 139201003Smarius clock_register(dev, 1000000); /* 1 second resolution */ 14093836Stmm 141146416Smarius if ((sc->sc_flag & MK48TXX_WDOG_REGISTER) && 142146416Smarius (mk48txx_models[i].flags & MK48TXX_EXT_REGISTERS)) { 143146416Smarius sc->sc_wet = EVENTHANDLER_REGISTER(watchdog_list, 144146416Smarius mk48txx_watchdog, dev, 0); 145146416Smarius device_printf(dev, 146161837Smarius "watchdog registered, timeout interval max. 128 sec\n"); 147146416Smarius } 148146416Smarius 14993836Stmm return (0); 15093836Stmm} 15193836Stmm 15293836Stmm/* 15393836Stmm * Get time-of-day and convert to a `struct timespec' 15493836Stmm * Return 0 on success; an error number otherwise. 15593836Stmm */ 15693836Stmmint 15793836Stmmmk48txx_gettime(device_t dev, struct timespec *ts) 15893836Stmm{ 159137813Smarius struct mk48txx_softc *sc; 160137813Smarius bus_size_t clkoff; 16193836Stmm struct clocktime ct; 16293836Stmm int year; 163146416Smarius uint8_t csr; 16493836Stmm 165137813Smarius sc = device_get_softc(dev); 166137813Smarius clkoff = sc->sc_clkoffset; 167137813Smarius 168146416Smarius mtx_lock(&sc->sc_mtx); 16993836Stmm /* enable read (stop time) */ 170137813Smarius csr = (*sc->sc_nvrd)(dev, clkoff + MK48TXX_ICSR); 17193836Stmm csr |= MK48TXX_CSR_READ; 172137813Smarius (*sc->sc_nvwr)(dev, clkoff + MK48TXX_ICSR, csr); 17393836Stmm 174137813Smarius#define FROMREG(reg, mask) ((*sc->sc_nvrd)(dev, clkoff + (reg)) & (mask)) 175135481Smarius 17693836Stmm ct.nsec = 0; 177135481Smarius ct.sec = FROMBCD(FROMREG(MK48TXX_ISEC, MK48TXX_SEC_MASK)); 178135481Smarius ct.min = FROMBCD(FROMREG(MK48TXX_IMIN, MK48TXX_MIN_MASK)); 179135481Smarius ct.hour = FROMBCD(FROMREG(MK48TXX_IHOUR, MK48TXX_HOUR_MASK)); 180135481Smarius ct.day = FROMBCD(FROMREG(MK48TXX_IDAY, MK48TXX_DAY_MASK)); 181201005Smarius#if 0 182135481Smarius /* Map dow from 1 - 7 to 0 - 6; FROMBCD() isn't necessary here. */ 183135481Smarius ct.dow = FROMREG(MK48TXX_IWDAY, MK48TXX_WDAY_MASK) - 1; 184201005Smarius#else 185201005Smarius /* 186201005Smarius * Set dow = -1 because some drivers (for example the NetBSD and 187201005Smarius * OpenBSD mk48txx(4)) don't set it correctly. 188201005Smarius */ 189201371Smarius ct.dow = -1; 190201005Smarius#endif 191135481Smarius ct.mon = FROMBCD(FROMREG(MK48TXX_IMON, MK48TXX_MON_MASK)); 192135481Smarius year = FROMBCD(FROMREG(MK48TXX_IYEAR, MK48TXX_YEAR_MASK)); 193146416Smarius year += sc->sc_year0; 194146416Smarius if (sc->sc_flag & MK48TXX_NO_CENT_ADJUST) 195146416Smarius year += (FROMREG(MK48TXX_IWDAY, MK48TXX_WDAY_CB) >> 196146416Smarius MK48TXX_WDAY_CB_SHIFT) * 100; 197146416Smarius else if (year < POSIX_BASE_YEAR) 198146416Smarius year += 100; 19993836Stmm 200135481Smarius#undef FROMREG 201135481Smarius 20293836Stmm ct.year = year; 20393836Stmm 20493836Stmm /* time wears on */ 205137813Smarius csr = (*sc->sc_nvrd)(dev, clkoff + MK48TXX_ICSR); 20693836Stmm csr &= ~MK48TXX_CSR_READ; 207137813Smarius (*sc->sc_nvwr)(dev, clkoff + MK48TXX_ICSR, csr); 208146416Smarius mtx_unlock(&sc->sc_mtx); 20993836Stmm 21093836Stmm return (clock_ct_to_ts(&ct, ts)); 21193836Stmm} 21293836Stmm 21393836Stmm/* 21493836Stmm * Set the time-of-day clock based on the value of the `struct timespec' arg. 21593836Stmm * Return 0 on success; an error number otherwise. 21693836Stmm */ 21793836Stmmint 21893836Stmmmk48txx_settime(device_t dev, struct timespec *ts) 21993836Stmm{ 220137813Smarius struct mk48txx_softc *sc; 221137813Smarius bus_size_t clkoff; 22293836Stmm struct clocktime ct; 223146416Smarius uint8_t csr; 224146416Smarius int cent, year; 22593836Stmm 226137813Smarius sc = device_get_softc(dev); 227137813Smarius clkoff = sc->sc_clkoffset; 228137813Smarius 22993836Stmm /* Accuracy is only one second. */ 23093836Stmm if (ts->tv_nsec >= 500000000) 23193836Stmm ts->tv_sec++; 23293836Stmm ts->tv_nsec = 0; 23393836Stmm clock_ts_to_ct(ts, &ct); 23493836Stmm 235146416Smarius mtx_lock(&sc->sc_mtx); 23693836Stmm /* enable write */ 237137813Smarius csr = (*sc->sc_nvrd)(dev, clkoff + MK48TXX_ICSR); 23893836Stmm csr |= MK48TXX_CSR_WRITE; 239137813Smarius (*sc->sc_nvwr)(dev, clkoff + MK48TXX_ICSR, csr); 24093836Stmm 241135481Smarius#define TOREG(reg, mask, val) \ 242137813Smarius ((*sc->sc_nvwr)(dev, clkoff + (reg), \ 243137813Smarius ((*sc->sc_nvrd)(dev, clkoff + (reg)) & ~(mask)) | \ 244135481Smarius ((val) & (mask)))) 24593836Stmm 246135481Smarius TOREG(MK48TXX_ISEC, MK48TXX_SEC_MASK, TOBCD(ct.sec)); 247135481Smarius TOREG(MK48TXX_IMIN, MK48TXX_MIN_MASK, TOBCD(ct.min)); 248135481Smarius TOREG(MK48TXX_IHOUR, MK48TXX_HOUR_MASK, TOBCD(ct.hour)); 249135481Smarius /* Map dow from 0 - 6 to 1 - 7; TOBCD() isn't necessary here. */ 250135481Smarius TOREG(MK48TXX_IWDAY, MK48TXX_WDAY_MASK, ct.dow + 1); 251135481Smarius TOREG(MK48TXX_IDAY, MK48TXX_DAY_MASK, TOBCD(ct.day)); 252135481Smarius TOREG(MK48TXX_IMON, MK48TXX_MON_MASK, TOBCD(ct.mon)); 253146416Smarius 254146416Smarius year = ct.year - sc->sc_year0; 255146416Smarius if (sc->sc_flag & MK48TXX_NO_CENT_ADJUST) { 256146416Smarius cent = year / 100; 257146416Smarius TOREG(MK48TXX_IWDAY, MK48TXX_WDAY_CB, 258146416Smarius cent << MK48TXX_WDAY_CB_SHIFT); 259146416Smarius year -= cent * 100; 260146416Smarius } else if (year > 99) 261146416Smarius year -= 100; 262135481Smarius TOREG(MK48TXX_IYEAR, MK48TXX_YEAR_MASK, TOBCD(year)); 263135481Smarius 264135481Smarius#undef TOREG 265135481Smarius 26693836Stmm /* load them up */ 267137813Smarius csr = (*sc->sc_nvrd)(dev, clkoff + MK48TXX_ICSR); 26893836Stmm csr &= ~MK48TXX_CSR_WRITE; 269137813Smarius (*sc->sc_nvwr)(dev, clkoff + MK48TXX_ICSR, csr); 270146416Smarius mtx_unlock(&sc->sc_mtx); 27193836Stmm return (0); 27293836Stmm} 27393836Stmm 274146416Smariusstatic uint8_t 275137813Smariusmk48txx_def_nvrd(device_t dev, int off) 27693836Stmm{ 277137813Smarius struct mk48txx_softc *sc; 27893836Stmm 279137813Smarius sc = device_get_softc(dev); 280201005Smarius return (bus_read_1(sc->sc_res, off)); 28193836Stmm} 282137813Smarius 283137813Smariusstatic void 284146416Smariusmk48txx_def_nvwr(device_t dev, int off, uint8_t v) 285137813Smarius{ 286137813Smarius struct mk48txx_softc *sc; 287137813Smarius 288137813Smarius sc = device_get_softc(dev); 289201005Smarius bus_write_1(sc->sc_res, off, v); 290137813Smarius} 291146416Smarius 292146416Smariusstatic void 293146416Smariusmk48txx_watchdog(void *arg, u_int cmd, int *error) 294146416Smarius{ 295146416Smarius device_t dev; 296146416Smarius struct mk48txx_softc *sc; 297146416Smarius uint8_t t, wdog; 298146416Smarius 299146416Smarius dev = arg; 300146416Smarius sc = device_get_softc(dev); 301146416Smarius 302146416Smarius t = cmd & WD_INTERVAL; 303167950Sn_hibma if (t >= 26 && t <= 37) { 304167950Sn_hibma wdog = 0; 305146416Smarius if (t <= WD_TO_2SEC) { 306146416Smarius wdog |= MK48TXX_WDOG_RB_1_16; 307146416Smarius t -= 26; 308146416Smarius } else if (t <= WD_TO_8SEC) { 309146416Smarius wdog |= MK48TXX_WDOG_RB_1_4; 310146416Smarius t -= WD_TO_250MS; 311146416Smarius } else if (t <= WD_TO_32SEC) { 312146416Smarius wdog |= MK48TXX_WDOG_RB_1; 313146416Smarius t -= WD_TO_1SEC; 314146416Smarius } else { 315146416Smarius wdog |= MK48TXX_WDOG_RB_4; 316146416Smarius t -= WD_TO_4SEC; 317146416Smarius } 318146416Smarius wdog |= (min(1 << t, 319146416Smarius MK48TXX_WDOG_BMB_MASK >> MK48TXX_WDOG_BMB_SHIFT)) << 320146416Smarius MK48TXX_WDOG_BMB_SHIFT; 321146416Smarius if (sc->sc_flag & MK48TXX_WDOG_ENABLE_WDS) 322146416Smarius wdog |= MK48TXX_WDOG_WDS; 323146416Smarius *error = 0; 324167950Sn_hibma } else { 325167950Sn_hibma wdog = 0; 326146416Smarius } 327146416Smarius mtx_lock(&sc->sc_mtx); 328146416Smarius (*sc->sc_nvwr)(dev, sc->sc_clkoffset + MK48TXX_WDOG, wdog); 329146416Smarius mtx_unlock(&sc->sc_mtx); 330146416Smarius} 331