1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (C) 2008 MARVELL INTERNATIONAL LTD. 5 * All rights reserved. 6 * 7 * Developed by Semihalf. 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 * 3. Neither the name of MARVELL nor the names of contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 */ 33 34 #include <sys/cdefs.h> 35 #include <sys/param.h> 36 #include <sys/bus.h> 37 #include <sys/lock.h> 38 #include <sys/time.h> 39 #include <sys/clock.h> 40 #include <sys/resource.h> 41 #include <sys/systm.h> 42 #include <sys/rman.h> 43 #include <sys/kernel.h> 44 #include <sys/module.h> 45 46 #include <machine/bus.h> 47 #include <machine/resource.h> 48 49 #include <dev/ofw/ofw_bus.h> 50 #include <dev/ofw/ofw_bus_subr.h> 51 52 #include "clock_if.h" 53 54 #define MV_RTC_TIME_REG 0x00 55 #define MV_RTC_DATE_REG 0x04 56 #define YEAR_BASE 2000 57 58 struct mv_rtc_softc { 59 device_t dev; 60 struct resource *res[1]; 61 }; 62 63 static struct resource_spec res_spec[] = { 64 { SYS_RES_MEMORY, 0, RF_ACTIVE }, 65 { -1, 0 } 66 }; 67 68 static int mv_rtc_probe(device_t dev); 69 static int mv_rtc_attach(device_t dev); 70 71 static int mv_rtc_gettime(device_t dev, struct timespec *ts); 72 static int mv_rtc_settime(device_t dev, struct timespec *ts); 73 74 static uint32_t mv_rtc_reg_read(struct mv_rtc_softc *sc, bus_size_t off); 75 static int mv_rtc_reg_write(struct mv_rtc_softc *sc, bus_size_t off, 76 uint32_t val); 77 78 static device_method_t mv_rtc_methods[] = { 79 DEVMETHOD(device_probe, mv_rtc_probe), 80 DEVMETHOD(device_attach, mv_rtc_attach), 81 82 DEVMETHOD(clock_gettime, mv_rtc_gettime), 83 DEVMETHOD(clock_settime, mv_rtc_settime), 84 85 { 0, 0 }, 86 }; 87 88 static driver_t mv_rtc_driver = { 89 "rtc", 90 mv_rtc_methods, 91 sizeof(struct mv_rtc_softc), 92 }; 93 94 DRIVER_MODULE(mv_rtc, simplebus, mv_rtc_driver, 0, 0); 95 96 static int 97 mv_rtc_probe(device_t dev) 98 { 99 100 if (!ofw_bus_status_okay(dev)) 101 return (ENXIO); 102 103 if (!ofw_bus_is_compatible(dev, "mrvl,rtc")) 104 return (ENXIO); 105 106 device_set_desc(dev, "Marvell Integrated RTC"); 107 return (BUS_PROBE_DEFAULT); 108 } 109 110 static int 111 mv_rtc_attach(device_t dev) 112 { 113 struct mv_rtc_softc *sc; 114 115 sc = device_get_softc(dev); 116 sc->dev = dev; 117 118 clock_register(dev, 1000000); 119 120 if (bus_alloc_resources(dev, res_spec, sc->res)) { 121 device_printf(dev, "could not allocate resources\n"); 122 return (ENXIO); 123 } 124 125 return (0); 126 } 127 128 static int 129 mv_rtc_gettime(device_t dev, struct timespec *ts) 130 { 131 struct clocktime ct; 132 struct mv_rtc_softc *sc; 133 uint32_t val; 134 135 sc = device_get_softc(dev); 136 137 val = mv_rtc_reg_read(sc, MV_RTC_TIME_REG); 138 139 ct.nsec = 0; 140 ct.sec = FROMBCD(val & 0x7f); 141 ct.min = FROMBCD((val & 0x7f00) >> 8); 142 ct.hour = FROMBCD((val & 0x3f0000) >> 16); 143 ct.dow = FROMBCD((val & 0x7000000) >> 24) - 1; 144 145 val = mv_rtc_reg_read(sc, MV_RTC_DATE_REG); 146 147 ct.day = FROMBCD(val & 0x7f); 148 ct.mon = FROMBCD((val & 0x1f00) >> 8); 149 ct.year = YEAR_BASE + FROMBCD((val & 0xff0000) >> 16); 150 151 return (clock_ct_to_ts(&ct, ts)); 152 } 153 154 static int 155 mv_rtc_settime(device_t dev, struct timespec *ts) 156 { 157 struct clocktime ct; 158 struct mv_rtc_softc *sc; 159 uint32_t val; 160 161 sc = device_get_softc(dev); 162 163 /* Resolution: 1 sec */ 164 if (ts->tv_nsec >= 500000000) 165 ts->tv_sec++; 166 ts->tv_nsec = 0; 167 clock_ts_to_ct(ts, &ct); 168 169 val = TOBCD(ct.sec) | (TOBCD(ct.min) << 8) | 170 (TOBCD(ct.hour) << 16) | (TOBCD( ct.dow + 1) << 24); 171 mv_rtc_reg_write(sc, MV_RTC_TIME_REG, val); 172 173 val = TOBCD(ct.day) | (TOBCD(ct.mon) << 8) | 174 (TOBCD(ct.year - YEAR_BASE) << 16); 175 mv_rtc_reg_write(sc, MV_RTC_DATE_REG, val); 176 177 return (0); 178 } 179 180 static uint32_t 181 mv_rtc_reg_read(struct mv_rtc_softc *sc, bus_size_t off) 182 { 183 184 return (bus_read_4(sc->res[0], off)); 185 } 186 187 static int 188 mv_rtc_reg_write(struct mv_rtc_softc *sc, bus_size_t off, uint32_t val) 189 { 190 191 bus_write_4(sc->res[0], off, val); 192 return (0); 193 } 194