mk48txx.c revision 221957
1230557Sjimharris/*- 2230557Sjimharris * Copyright (c) 2000 The NetBSD Foundation, Inc. 3230557Sjimharris * All rights reserved. 4230557Sjimharris * 5230557Sjimharris * This code is derived from software contributed to The NetBSD Foundation 6230557Sjimharris * by Paul Kranenburg. 7230557Sjimharris * 8230557Sjimharris * Redistribution and use in source and binary forms, with or without 9230557Sjimharris * modification, are permitted provided that the following conditions 10230557Sjimharris * are met: 11230557Sjimharris * 1. Redistributions of source code must retain the above copyright 12230557Sjimharris * notice, this list of conditions and the following disclaimer. 13230557Sjimharris * 2. Redistributions in binary form must reproduce the above copyright 14230557Sjimharris * notice, this list of conditions and the following disclaimer in the 15230557Sjimharris * documentation and/or other materials provided with the distribution. 16230557Sjimharris * 17230557Sjimharris * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 18230557Sjimharris * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 19230557Sjimharris * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 20230557Sjimharris * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 21230557Sjimharris * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 22230557Sjimharris * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 23230557Sjimharris * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24230557Sjimharris * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 25230557Sjimharris * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 26230557Sjimharris * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 27230557Sjimharris * POSSIBILITY OF SUCH DAMAGE. 28230557Sjimharris * 29230557Sjimharris * $NetBSD: mk48txx.c,v 1.25 2008/04/28 20:23:50 martin Exp $ 30230557Sjimharris */ 31230557Sjimharris 32230557Sjimharris#include <sys/cdefs.h> 33230557Sjimharris__FBSDID("$FreeBSD: head/sys/dev/mk48txx/mk48txx.c 221957 2011-05-15 13:17:08Z marius $"); 34230557Sjimharris 35230557Sjimharris/* 36230557Sjimharris * Mostek MK48T02, MK48T08, MK48T18, MK48T37 and MK48T59 time-of-day chip 37230557Sjimharris * subroutines 38230557Sjimharris */ 39230557Sjimharris 40230557Sjimharris#include <sys/param.h> 41230557Sjimharris#include <sys/systm.h> 42230557Sjimharris#include <sys/bus.h> 43230557Sjimharris#include <sys/clock.h> 44230557Sjimharris#include <sys/eventhandler.h> 45230557Sjimharris#include <sys/lock.h> 46230557Sjimharris#include <sys/mutex.h> 47230557Sjimharris#include <sys/rman.h> 48230557Sjimharris#include <sys/watchdog.h> 49230557Sjimharris 50230557Sjimharris#include <machine/bus.h> 51230557Sjimharris 52230557Sjimharris#include <dev/mk48txx/mk48txxreg.h> 53230557Sjimharris#include <dev/mk48txx/mk48txxvar.h> 54230557Sjimharris 55230557Sjimharris#include "clock_if.h" 56230557Sjimharris 57230557Sjimharrisstatic uint8_t mk48txx_def_nvrd(device_t dev, int off); 58230557Sjimharrisstatic void mk48txx_def_nvwr(device_t dev, int off, uint8_t v); 59230557Sjimharrisstatic void mk48txx_watchdog(void *arg, u_int cmd, int *error); 60230557Sjimharris 61230557Sjimharrisstatic const struct { 62230557Sjimharris const char *name; 63230557Sjimharris bus_size_t nvramsz; 64230557Sjimharris bus_size_t clkoff; 65230557Sjimharris u_int flags; 66230557Sjimharris#define MK48TXX_EXT_REGISTERS 1 /* Has extended register set. */ 67230557Sjimharris} const mk48txx_models[] = { 68230557Sjimharris { "mk48t02", MK48T02_CLKSZ, MK48T02_CLKOFF, 0 }, 69230557Sjimharris { "mk48t08", MK48T08_CLKSZ, MK48T08_CLKOFF, 0 }, 70230557Sjimharris { "mk48t18", MK48T18_CLKSZ, MK48T18_CLKOFF, 0 }, 71230557Sjimharris { "mk48t37", MK48T37_CLKSZ, MK48T37_CLKOFF, MK48TXX_EXT_REGISTERS }, 72230557Sjimharris { "mk48t59", MK48T59_CLKSZ, MK48T59_CLKOFF, MK48TXX_EXT_REGISTERS }, 73230557Sjimharris}; 74230557Sjimharris 75230557Sjimharrisint 76230557Sjimharrismk48txx_attach(device_t dev) 77230557Sjimharris{ 78230557Sjimharris struct mk48txx_softc *sc; 79230557Sjimharris int i; 80230557Sjimharris uint8_t wday; 81230557Sjimharris 82230557Sjimharris sc = device_get_softc(dev); 83230557Sjimharris 84230557Sjimharris if (mtx_initialized(&sc->sc_mtx) == 0) { 85230557Sjimharris device_printf(dev, "%s: mutex not initialized\n", __func__); 86230557Sjimharris return (ENXIO); 87230557Sjimharris } 88230557Sjimharris 89230557Sjimharris device_printf(dev, "model %s", sc->sc_model); 90230557Sjimharris i = sizeof(mk48txx_models) / sizeof(mk48txx_models[0]); 91230557Sjimharris while (--i >= 0) { 92230557Sjimharris if (strcmp(sc->sc_model, mk48txx_models[i].name) == 0) { 93230557Sjimharris break; 94230557Sjimharris } 95230557Sjimharris } 96230557Sjimharris if (i < 0) { 97230557Sjimharris device_printf(dev, " (unsupported)\n"); 98230557Sjimharris return (ENXIO); 99230557Sjimharris } 100230557Sjimharris printf("\n"); 101230557Sjimharris sc->sc_nvramsz = mk48txx_models[i].nvramsz; 102230557Sjimharris sc->sc_clkoffset = mk48txx_models[i].clkoff; 103230557Sjimharris 104230557Sjimharris if (sc->sc_nvrd == NULL) 105230557Sjimharris sc->sc_nvrd = mk48txx_def_nvrd; 106230557Sjimharris if (sc->sc_nvwr == NULL) 107230557Sjimharris sc->sc_nvwr = mk48txx_def_nvwr; 108230557Sjimharris 109230557Sjimharris if (mk48txx_models[i].flags & MK48TXX_EXT_REGISTERS) { 110230557Sjimharris mtx_lock(&sc->sc_mtx); 111230557Sjimharris if ((*sc->sc_nvrd)(dev, sc->sc_clkoffset + MK48TXX_FLAGS) & 112230557Sjimharris MK48TXX_FLAGS_BL) { 113230557Sjimharris mtx_unlock(&sc->sc_mtx); 114230557Sjimharris device_printf(dev, "%s: battery low\n", __func__); 115230557Sjimharris return (ENXIO); 116230557Sjimharris } 117230557Sjimharris mtx_unlock(&sc->sc_mtx); 118230557Sjimharris } 119230557Sjimharris 120230557Sjimharris if (sc->sc_flag & MK48TXX_NO_CENT_ADJUST) { 121230557Sjimharris /* 122230557Sjimharris * Use MK48TXX_WDAY_CB instead of manually adjusting the 123230557Sjimharris * century. 124230557Sjimharris */ 125230557Sjimharris if (!(mk48txx_models[i].flags & MK48TXX_EXT_REGISTERS)) { 126230557Sjimharris device_printf(dev, "%s: no century bit\n", __func__); 127230557Sjimharris return (ENXIO); 128230557Sjimharris } else { 129230557Sjimharris mtx_lock(&sc->sc_mtx); 130230557Sjimharris wday = (*sc->sc_nvrd) 131230557Sjimharris (dev, sc->sc_clkoffset + MK48TXX_IWDAY); 132230557Sjimharris wday |= MK48TXX_WDAY_CEB; 133230557Sjimharris (*sc->sc_nvwr) 134230557Sjimharris (dev, sc->sc_clkoffset + MK48TXX_IWDAY, wday); 135230557Sjimharris mtx_unlock(&sc->sc_mtx); 136230557Sjimharris } 137230557Sjimharris } 138230557Sjimharris 139230557Sjimharris clock_register(dev, 1000000); /* 1 second resolution */ 140230557Sjimharris 141230557Sjimharris if ((sc->sc_flag & MK48TXX_WDOG_REGISTER) && 142230557Sjimharris (mk48txx_models[i].flags & MK48TXX_EXT_REGISTERS)) { 143230557Sjimharris sc->sc_wet = EVENTHANDLER_REGISTER(watchdog_list, 144230557Sjimharris mk48txx_watchdog, dev, 0); 145230557Sjimharris device_printf(dev, 146230557Sjimharris "watchdog registered, timeout interval max. 128 sec\n"); 147230557Sjimharris } 148230557Sjimharris 149230557Sjimharris return (0); 150230557Sjimharris} 151230557Sjimharris 152230557Sjimharris/* 153230557Sjimharris * Get time-of-day and convert to a `struct timespec' 154230557Sjimharris * Return 0 on success; an error number otherwise. 155230557Sjimharris */ 156230557Sjimharrisint 157230557Sjimharrismk48txx_gettime(device_t dev, struct timespec *ts) 158230557Sjimharris{ 159230557Sjimharris struct mk48txx_softc *sc; 160230557Sjimharris bus_size_t clkoff; 161230557Sjimharris struct clocktime ct; 162230557Sjimharris int year; 163230557Sjimharris uint8_t csr; 164230557Sjimharris 165230557Sjimharris sc = device_get_softc(dev); 166230557Sjimharris clkoff = sc->sc_clkoffset; 167230557Sjimharris 168230557Sjimharris mtx_lock(&sc->sc_mtx); 169230557Sjimharris /* enable read (stop time) */ 170230557Sjimharris csr = (*sc->sc_nvrd)(dev, clkoff + MK48TXX_ICSR); 171230557Sjimharris csr |= MK48TXX_CSR_READ; 172230557Sjimharris (*sc->sc_nvwr)(dev, clkoff + MK48TXX_ICSR, csr); 173230557Sjimharris 174230557Sjimharris#define FROMREG(reg, mask) ((*sc->sc_nvrd)(dev, clkoff + (reg)) & (mask)) 175230557Sjimharris 176230557Sjimharris ct.nsec = 0; 177230557Sjimharris ct.sec = FROMBCD(FROMREG(MK48TXX_ISEC, MK48TXX_SEC_MASK)); 178230557Sjimharris ct.min = FROMBCD(FROMREG(MK48TXX_IMIN, MK48TXX_MIN_MASK)); 179230557Sjimharris ct.hour = FROMBCD(FROMREG(MK48TXX_IHOUR, MK48TXX_HOUR_MASK)); 180230557Sjimharris ct.day = FROMBCD(FROMREG(MK48TXX_IDAY, MK48TXX_DAY_MASK)); 181230557Sjimharris#if 0 182230557Sjimharris /* Map dow from 1 - 7 to 0 - 6; FROMBCD() isn't necessary here. */ 183230557Sjimharris ct.dow = FROMREG(MK48TXX_IWDAY, MK48TXX_WDAY_MASK) - 1; 184230557Sjimharris#else 185230557Sjimharris /* 186230557Sjimharris * Set dow = -1 because some drivers (for example the NetBSD and 187230557Sjimharris * OpenBSD mk48txx(4)) don't set it correctly. 188230557Sjimharris */ 189230557Sjimharris ct.dow = -1; 190230557Sjimharris#endif 191230557Sjimharris ct.mon = FROMBCD(FROMREG(MK48TXX_IMON, MK48TXX_MON_MASK)); 192230557Sjimharris year = FROMBCD(FROMREG(MK48TXX_IYEAR, MK48TXX_YEAR_MASK)); 193230557Sjimharris year += sc->sc_year0; 194230557Sjimharris if (sc->sc_flag & MK48TXX_NO_CENT_ADJUST) 195230557Sjimharris year += (FROMREG(MK48TXX_IWDAY, MK48TXX_WDAY_CB) >> 196230557Sjimharris MK48TXX_WDAY_CB_SHIFT) * 100; 197230557Sjimharris else if (year < POSIX_BASE_YEAR) 198230557Sjimharris year += 100; 199230557Sjimharris 200230557Sjimharris#undef FROMREG 201230557Sjimharris 202230557Sjimharris ct.year = year; 203230557Sjimharris 204230557Sjimharris /* time wears on */ 205230557Sjimharris csr = (*sc->sc_nvrd)(dev, clkoff + MK48TXX_ICSR); 206230557Sjimharris csr &= ~MK48TXX_CSR_READ; 207230557Sjimharris (*sc->sc_nvwr)(dev, clkoff + MK48TXX_ICSR, csr); 208230557Sjimharris mtx_unlock(&sc->sc_mtx); 209230557Sjimharris 210230557Sjimharris return (clock_ct_to_ts(&ct, ts)); 211230557Sjimharris} 212230557Sjimharris 213230557Sjimharris/* 214230557Sjimharris * Set the time-of-day clock based on the value of the `struct timespec' arg. 215230557Sjimharris * Return 0 on success; an error number otherwise. 216230557Sjimharris */ 217230557Sjimharrisint 218230557Sjimharrismk48txx_settime(device_t dev, struct timespec *ts) 219230557Sjimharris{ 220230557Sjimharris struct mk48txx_softc *sc; 221230557Sjimharris bus_size_t clkoff; 222230557Sjimharris struct clocktime ct; 223230557Sjimharris uint8_t csr; 224230557Sjimharris int cent, year; 225230557Sjimharris 226230557Sjimharris sc = device_get_softc(dev); 227230557Sjimharris clkoff = sc->sc_clkoffset; 228230557Sjimharris 229230557Sjimharris /* Accuracy is only one second. */ 230230557Sjimharris if (ts->tv_nsec >= 500000000) 231230557Sjimharris ts->tv_sec++; 232230557Sjimharris ts->tv_nsec = 0; 233230557Sjimharris clock_ts_to_ct(ts, &ct); 234230557Sjimharris 235230557Sjimharris mtx_lock(&sc->sc_mtx); 236230557Sjimharris /* enable write */ 237230557Sjimharris csr = (*sc->sc_nvrd)(dev, clkoff + MK48TXX_ICSR); 238230557Sjimharris csr |= MK48TXX_CSR_WRITE; 239230557Sjimharris (*sc->sc_nvwr)(dev, clkoff + MK48TXX_ICSR, csr); 240230557Sjimharris 241230557Sjimharris#define TOREG(reg, mask, val) \ 242230557Sjimharris ((*sc->sc_nvwr)(dev, clkoff + (reg), \ 243230557Sjimharris ((*sc->sc_nvrd)(dev, clkoff + (reg)) & ~(mask)) | \ 244230557Sjimharris ((val) & (mask)))) 245230557Sjimharris 246230557Sjimharris TOREG(MK48TXX_ISEC, MK48TXX_SEC_MASK, TOBCD(ct.sec)); 247230557Sjimharris TOREG(MK48TXX_IMIN, MK48TXX_MIN_MASK, TOBCD(ct.min)); 248230557Sjimharris TOREG(MK48TXX_IHOUR, MK48TXX_HOUR_MASK, TOBCD(ct.hour)); 249230557Sjimharris /* Map dow from 0 - 6 to 1 - 7; TOBCD() isn't necessary here. */ 250230557Sjimharris TOREG(MK48TXX_IWDAY, MK48TXX_WDAY_MASK, ct.dow + 1); 251230557Sjimharris TOREG(MK48TXX_IDAY, MK48TXX_DAY_MASK, TOBCD(ct.day)); 252230557Sjimharris TOREG(MK48TXX_IMON, MK48TXX_MON_MASK, TOBCD(ct.mon)); 253230557Sjimharris 254230557Sjimharris year = ct.year - sc->sc_year0; 255230557Sjimharris if (sc->sc_flag & MK48TXX_NO_CENT_ADJUST) { 256230557Sjimharris cent = year / 100; 257230557Sjimharris TOREG(MK48TXX_IWDAY, MK48TXX_WDAY_CB, 258230557Sjimharris cent << MK48TXX_WDAY_CB_SHIFT); 259230557Sjimharris year -= cent * 100; 260230557Sjimharris } else if (year > 99) 261230557Sjimharris year -= 100; 262230557Sjimharris TOREG(MK48TXX_IYEAR, MK48TXX_YEAR_MASK, TOBCD(year)); 263230557Sjimharris 264230557Sjimharris#undef TOREG 265230557Sjimharris 266230557Sjimharris /* load them up */ 267230557Sjimharris csr = (*sc->sc_nvrd)(dev, clkoff + MK48TXX_ICSR); 268230557Sjimharris csr &= ~MK48TXX_CSR_WRITE; 269230557Sjimharris (*sc->sc_nvwr)(dev, clkoff + MK48TXX_ICSR, csr); 270230557Sjimharris mtx_unlock(&sc->sc_mtx); 271230557Sjimharris return (0); 272230557Sjimharris} 273230557Sjimharris 274230557Sjimharrisstatic uint8_t 275230557Sjimharrismk48txx_def_nvrd(device_t dev, int off) 276230557Sjimharris{ 277230557Sjimharris struct mk48txx_softc *sc; 278230557Sjimharris 279230557Sjimharris sc = device_get_softc(dev); 280230557Sjimharris return (bus_read_1(sc->sc_res, off)); 281230557Sjimharris} 282230557Sjimharris 283230557Sjimharrisstatic void 284230557Sjimharrismk48txx_def_nvwr(device_t dev, int off, uint8_t v) 285230557Sjimharris{ 286230557Sjimharris struct mk48txx_softc *sc; 287230557Sjimharris 288230557Sjimharris sc = device_get_softc(dev); 289230557Sjimharris bus_write_1(sc->sc_res, off, v); 290230557Sjimharris} 291230557Sjimharris 292230557Sjimharrisstatic void 293230557Sjimharrismk48txx_watchdog(void *arg, u_int cmd, int *error) 294230557Sjimharris{ 295230557Sjimharris device_t dev; 296230557Sjimharris struct mk48txx_softc *sc; 297230557Sjimharris uint8_t t, wdog; 298230557Sjimharris 299230557Sjimharris dev = arg; 300230557Sjimharris sc = device_get_softc(dev); 301230557Sjimharris 302230557Sjimharris t = cmd & WD_INTERVAL; 303230557Sjimharris if (t >= 26 && t <= 37) { 304230557Sjimharris wdog = 0; 305230557Sjimharris if (t <= WD_TO_2SEC) { 306230557Sjimharris wdog |= MK48TXX_WDOG_RB_1_16; 307230557Sjimharris t -= 26; 308230557Sjimharris } else if (t <= WD_TO_8SEC) { 309230557Sjimharris wdog |= MK48TXX_WDOG_RB_1_4; 310230557Sjimharris t -= WD_TO_250MS; 311230557Sjimharris } else if (t <= WD_TO_32SEC) { 312230557Sjimharris wdog |= MK48TXX_WDOG_RB_1; 313230557Sjimharris t -= WD_TO_1SEC; 314230557Sjimharris } else { 315230557Sjimharris wdog |= MK48TXX_WDOG_RB_4; 316230557Sjimharris t -= WD_TO_4SEC; 317230557Sjimharris } 318230557Sjimharris wdog |= (min(1 << t, 319230557Sjimharris MK48TXX_WDOG_BMB_MASK >> MK48TXX_WDOG_BMB_SHIFT)) << 320230557Sjimharris MK48TXX_WDOG_BMB_SHIFT; 321230557Sjimharris if (sc->sc_flag & MK48TXX_WDOG_ENABLE_WDS) 322230557Sjimharris wdog |= MK48TXX_WDOG_WDS; 323230557Sjimharris *error = 0; 324230557Sjimharris } else { 325230557Sjimharris wdog = 0; 326230557Sjimharris } 327230557Sjimharris mtx_lock(&sc->sc_mtx); 328230557Sjimharris (*sc->sc_nvwr)(dev, sc->sc_clkoffset + MK48TXX_WDOG, wdog); 329230557Sjimharris mtx_unlock(&sc->sc_mtx); 330230557Sjimharris} 331230557Sjimharris