/* $NetBSD: mk48txx.c,v 1.30 2026/09/03 05:52:43 jdc Exp $ */ /*- * Copyright (c) 2000 The NetBSD Foundation, Inc. * All rights reserved. * * This code is derived from software contributed to The NetBSD Foundation * by Paul Kranenburg. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ /* * Mostek MK48T02, MK48T08, MK48T59 time-of-day chip subroutines. */ #include __KERNEL_RCSID(0, "$NetBSD: mk48txx.c,v 1.30 2026/09/03 05:52:43 jdc Exp $"); #include #include #include #include #include #include #include #include #include int mk48txx_gettime_ymdhms(todr_chip_handle_t, struct clock_ymdhms *); int mk48txx_settime_ymdhms(todr_chip_handle_t, struct clock_ymdhms *); uint8_t mk48txx_def_nvrd(struct mk48txx_softc *, int); void mk48txx_def_nvwr(struct mk48txx_softc *, int, uint8_t); void mk48txx_refresh(struct sysmon_envsys *, envsys_data_t *); static int sysctl_mk48txx_osc(SYSCTLFN_ARGS); const struct { const char *name; bus_size_t nvramsz; bus_size_t clkoff; int flags; } mk48txx_models[] = { { "mk48t02", MK48T02_CLKSZ, MK48T02_CLKOFF, 0 }, { "mk48t08", MK48T08_CLKSZ, MK48T08_CLKOFF, 0 }, { "mk48t18", MK48T18_CLKSZ, MK48T18_CLKOFF, 0 }, { "mk48t59", MK48T59_CLKSZ, MK48T59_CLKOFF, MK48TXX_EXT_REGISTERS }, { "ds1553", DS1553_CLKSZ, DS1553_CLKOFF, MK48TXX_EXT_REGISTERS }, }; void mk48txx_attach(struct mk48txx_softc *sc) { todr_chip_handle_t handle; const struct sysctlnode *me = NULL, *node = NULL; int i; uint8_t csr; aprint_normal(": %s", sc->sc_model); i = __arraycount(mk48txx_models); while (--i >= 0) { if (strcmp(sc->sc_model, mk48txx_models[i].name) == 0) break; } if (i < 0) panic("%s: unsupported model", __func__); sc->sc_nvramsz = mk48txx_models[i].nvramsz; sc->sc_clkoffset = mk48txx_models[i].clkoff; sc->sc_flag |= mk48txx_models[i].flags; handle = &sc->sc_handle; KASSERT(sc->sc_dev != NULL); handle->todr_dev = sc->sc_dev; handle->todr_gettime_ymdhms = mk48txx_gettime_ymdhms; handle->todr_settime_ymdhms = mk48txx_settime_ymdhms; if (sc->sc_nvrd == NULL) sc->sc_nvrd = mk48txx_def_nvrd; if (sc->sc_nvwr == NULL) sc->sc_nvwr = mk48txx_def_nvwr; csr = (*sc->sc_nvrd)(sc, sc->sc_clkoffset + MK48TXX_ISEC); if (csr & MK48TXX_SEC_STOP) { aprint_normal("\n"); aprint_error_dev(sc->sc_dev, "WARNING: oscillator is stopped (0x%02x)", csr); sc->sc_osc_stp = 1; } else sc->sc_osc_stp = 0; /* Setup envsys if the chip has the battery low flag */ if (sc->sc_flag & MK48TXX_EXT_REGISTERS) { sc->sc_sme = sysmon_envsys_create(); sc->sc_sensor.units = ENVSYS_INDICATOR; sc->sc_sensor.state = ENVSYS_SINVALID; sc->sc_sensor.value_cur = 0; sc->sc_sensor.flags |= ENVSYS_FMONCRITICAL; (void)strlcpy(sc->sc_sensor.desc, "battery low", sizeof(sc->sc_sensor.desc)); if (sysmon_envsys_sensor_attach(sc->sc_sme, &sc->sc_sensor)) { sysmon_envsys_destroy(sc->sc_sme); sc->sc_sme = NULL; aprint_error_dev(sc->sc_dev, "unable to attach sensor to sysmon\n"); } else { sc->sc_sme->sme_name = device_xname(sc->sc_dev); sc->sc_sme->sme_cookie = sc; sc->sc_sme->sme_refresh = mk48txx_refresh; if (sysmon_envsys_register(sc->sc_sme)) { sysmon_envsys_destroy(sc->sc_sme); sc->sc_sme = NULL; aprint_error_dev(sc->sc_dev, "unable to register with sysmon\n"); sysmon_envsys_destroy(sc->sc_sme); } } } /* Setup sysctl for the oscillator control */ sysctl_createv(NULL, 0, NULL, &me, CTLFLAG_READWRITE, CTLTYPE_NODE, device_xname(sc->sc_dev), NULL, NULL, 0, NULL, 0, CTL_HW, CTL_CREATE, CTL_EOL); if (me == NULL) aprint_error_dev(sc->sc_dev, "unable to add sysctl root\n"); else { sysctl_createv(NULL, 0, NULL, &node, CTLFLAG_READWRITE | CTLFLAG_OWNDESC, CTLTYPE_INT, "stop_oscillator", "Stop the chip oscillator", sysctl_mk48txx_osc, 1, (void *)sc, 0, CTL_HW, me->sysctl_num, CTL_CREATE, CTL_EOL); if (node == NULL) aprint_error_dev(sc->sc_dev, "unable to add sysctl node\n"); } todr_attach(handle); } /* * Get time-of-day and convert to a `struct timeval' * Return 0 on success; an error number otherwise. */ int mk48txx_gettime_ymdhms(todr_chip_handle_t handle, struct clock_ymdhms *dt) { struct mk48txx_softc *sc = device_private(handle->todr_dev); bus_size_t clkoff; int year; uint8_t csr; clkoff = sc->sc_clkoffset; /* enable read (stop time) */ csr = (*sc->sc_nvrd)(sc, clkoff + MK48TXX_ICSR); csr |= MK48TXX_CSR_READ; (*sc->sc_nvwr)(sc, clkoff + MK48TXX_ICSR, csr); dt->dt_sec = bcdtobin((*sc->sc_nvrd)(sc, clkoff + MK48TXX_ISEC)); dt->dt_min = bcdtobin((*sc->sc_nvrd)(sc, clkoff + MK48TXX_IMIN)); dt->dt_hour = bcdtobin((*sc->sc_nvrd)(sc, clkoff + MK48TXX_IHOUR)); dt->dt_day = bcdtobin((*sc->sc_nvrd)(sc, clkoff + MK48TXX_IDAY)); dt->dt_wday = bcdtobin((*sc->sc_nvrd)(sc, clkoff + MK48TXX_IWDAY)); dt->dt_mon = bcdtobin((*sc->sc_nvrd)(sc, clkoff + MK48TXX_IMON)); year = bcdtobin((*sc->sc_nvrd)(sc, clkoff + MK48TXX_IYEAR)); if (sc->sc_flag & MK48TXX_HAVE_CENT_REG) { year += 100*bcdtobin(csr & MK48TXX_CSR_CENT_MASK); } else { year += sc->sc_year0; if (year < POSIX_BASE_YEAR && (sc->sc_flag & MK48TXX_NO_CENT_ADJUST) == 0) year += 100; } dt->dt_year = year; /* time wears on */ csr = (*sc->sc_nvrd)(sc, clkoff + MK48TXX_ICSR); csr &= ~MK48TXX_CSR_READ; (*sc->sc_nvwr)(sc, clkoff + MK48TXX_ICSR, csr); return 0; } /* * Set the time-of-day clock based on the value of the `struct timeval' arg. * Return 0 on success; an error number otherwise. */ int mk48txx_settime_ymdhms(todr_chip_handle_t handle, struct clock_ymdhms *dt) { struct mk48txx_softc *sc = device_private(handle->todr_dev); bus_size_t clkoff; uint8_t csr; int year; int cent; clkoff = sc->sc_clkoffset; if ((sc->sc_flag & MK48TXX_HAVE_CENT_REG) == 0) { cent = 0; year = dt->dt_year - sc->sc_year0; if (year > 99 && (sc->sc_flag & MK48TXX_NO_CENT_ADJUST) == 0) year -= 100; } else { cent = dt->dt_year / 100; year = dt->dt_year % 100; } /* enable write */ csr = (*sc->sc_nvrd)(sc, clkoff + MK48TXX_ICSR); csr |= MK48TXX_CSR_WRITE; (*sc->sc_nvwr)(sc, clkoff + MK48TXX_ICSR, csr); (*sc->sc_nvwr)(sc, clkoff + MK48TXX_ISEC, bintobcd(dt->dt_sec)); (*sc->sc_nvwr)(sc, clkoff + MK48TXX_IMIN, bintobcd(dt->dt_min)); (*sc->sc_nvwr)(sc, clkoff + MK48TXX_IHOUR, bintobcd(dt->dt_hour)); (*sc->sc_nvwr)(sc, clkoff + MK48TXX_IWDAY, bintobcd(dt->dt_wday)); (*sc->sc_nvwr)(sc, clkoff + MK48TXX_IDAY, bintobcd(dt->dt_day)); (*sc->sc_nvwr)(sc, clkoff + MK48TXX_IMON, bintobcd(dt->dt_mon)); (*sc->sc_nvwr)(sc, clkoff + MK48TXX_IYEAR, bintobcd(year)); /* * If we have a century register and the century has changed * update it. */ if ((sc->sc_flag & MK48TXX_HAVE_CENT_REG) && (csr & MK48TXX_CSR_CENT_MASK) != bintobcd(cent)) { csr &= ~MK48TXX_CSR_CENT_MASK; csr |= MK48TXX_CSR_CENT_MASK & bintobcd(cent); (*sc->sc_nvwr)(sc, clkoff + MK48TXX_ICSR, csr); } /* load them up */ csr = (*sc->sc_nvrd)(sc, clkoff + MK48TXX_ICSR); csr &= ~MK48TXX_CSR_WRITE; (*sc->sc_nvwr)(sc, clkoff + MK48TXX_ICSR, csr); return 0; } int mk48txx_get_nvram_size(todr_chip_handle_t handle, bus_size_t *vp) { struct mk48txx_softc *sc = device_private(handle->todr_dev); *vp = sc->sc_nvramsz; return 0; } uint8_t mk48txx_def_nvrd(struct mk48txx_softc *sc, int off) { return bus_space_read_1(sc->sc_bst, sc->sc_bsh, off); } void mk48txx_def_nvwr(struct mk48txx_softc *sc, int off, uint8_t v) { bus_space_write_1(sc->sc_bst, sc->sc_bsh, off, v); } void mk48txx_refresh(struct sysmon_envsys *sme, envsys_data_t *edata) { struct mk48txx_softc *sc = sme->sme_cookie; uint8_t flgs; /* * The chip checks the battery every 24h, so we change the * monitoring timeout after the first refresh @ 30s. */ sme->sme_events_timeout = 86400; flgs = (*sc->sc_nvrd)(sc, sc->sc_clkoffset + MK48TXX_IFLAGS); if (flgs &= MK48TXX_FLAGS_BATTLOW) { edata->value_cur = 1; edata->state = ENVSYS_SCRITICAL; } else { edata->value_cur = 0; edata->state = ENVSYS_SVALID; } } static int sysctl_mk48txx_osc(SYSCTLFN_ARGS) { struct sysctlnode node = *rnode; struct mk48txx_softc *sc = node.sysctl_data; todr_chip_handle_t handle = &sc->sc_handle; bus_size_t clkoff; int stp; uint8_t sec; if (newp) { /* write */ clkoff = sc->sc_clkoffset; stp = sc->sc_osc_stp; node.sysctl_data = &stp; if (sysctl_lookup(SYSCTLFN_CALL(&node)) == 0) { if (stp != 0 && stp != 1) return EINVAL; if (stp != sc->sc_osc_stp) { sc->sc_osc_stp = stp; /* * We ignore any existing seconds values, * because we're either stopping or starting * the oscillator and the seconds * soon will be or are already incorrect. */ if (stp) sec = MK48TXX_SEC_STOP; else sec = 0; if (handle->todr_setwen != NULL) handle->todr_setwen(handle, 1); (*sc->sc_nvwr)(sc, clkoff + MK48TXX_ISEC, sec); if (handle->todr_setwen != NULL) handle->todr_setwen(handle, 0); } return 0; } return EINVAL; } else { node.sysctl_data = &sc->sc_osc_stp; node.sysctl_size = 4; return (sysctl_lookup(SYSCTLFN_CALL(&node))); } return 0; }