1 /* $OpenBSD: sxirtc.c,v 1.8 2022/10/17 19:09:46 kettenis Exp $ */ 2 /* 3 * Copyright (c) 2008 Mark Kettenis 4 * Copyright (c) 2013 Artturi Alm 5 * 6 * Permission to use, copy, modify, and distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 #include <sys/param.h> 20 #include <sys/device.h> 21 #include <sys/malloc.h> 22 #include <sys/systm.h> 23 24 #include <dev/clock_subr.h> 25 26 #include <machine/bus.h> 27 #include <machine/fdt.h> 28 29 #include <dev/fdt/sunxireg.h> 30 31 #include <dev/ofw/openfirm.h> 32 #include <dev/ofw/fdt.h> 33 #include <dev/ofw/ofw_clock.h> 34 35 #define SXIRTC_LOSC_CTRL 0x00 36 #define SXIRTC_LOSC_CTRL_KEY_FIELD 0x16aa0000 37 #define SXIRTC_LOSC_CTRL_SEL_EXT32K 0x00000001 38 #define SXIRTC_YYMMDD_A10 0x04 39 #define SXIRTC_HHMMSS_A10 0x08 40 #define SXIRTC_YYMMDD_A31 0x10 41 #define SXIRTC_HHMMSS_A31 0x14 42 #define SXIRTC_LOSC_OUT_GATING 0x60 43 44 #define LEAPYEAR(y) \ 45 (((y) % 4 == 0 && \ 46 (y) % 100 != 0) || \ 47 (y) % 400 == 0) 48 49 struct sxirtc_softc { 50 struct device sc_dev; 51 bus_space_tag_t sc_iot; 52 bus_space_handle_t sc_ioh; 53 54 struct clock_device sc_cd; 55 56 bus_size_t sc_yymmdd; 57 bus_size_t sc_hhmmss; 58 uint32_t base_year; 59 uint32_t year_mask; 60 uint32_t leap_shift; 61 }; 62 63 int sxirtc_match(struct device *, void *, void *); 64 void sxirtc_attach(struct device *, struct device *, void *); 65 66 const struct cfattach sxirtc_ca = { 67 sizeof(struct sxirtc_softc), sxirtc_match, sxirtc_attach 68 }; 69 70 struct cfdriver sxirtc_cd = { 71 NULL, "sxirtc", DV_DULL 72 }; 73 74 uint32_t sxirtc_get_frequency(void *, uint32_t *); 75 void sxirtc_enable(void *, uint32_t *, int); 76 int sxirtc_gettime(todr_chip_handle_t, struct timeval *); 77 int sxirtc_settime(todr_chip_handle_t, struct timeval *); 78 79 int 80 sxirtc_match(struct device *parent, void *match, void *aux) 81 { 82 struct fdt_attach_args *faa = aux; 83 84 return (OF_is_compatible(faa->fa_node, "allwinner,sun4i-a10-rtc") || 85 OF_is_compatible(faa->fa_node, "allwinner,sun7i-a20-rtc") || 86 OF_is_compatible(faa->fa_node, "allwinner,sun6i-a31-rtc") || 87 OF_is_compatible(faa->fa_node, "allwinner,sun8i-h3-rtc") || 88 OF_is_compatible(faa->fa_node, "allwinner,sun50i-h5-rtc")); 89 } 90 91 void 92 sxirtc_attach(struct device *parent, struct device *self, void *aux) 93 { 94 struct sxirtc_softc *sc = (struct sxirtc_softc *)self; 95 struct fdt_attach_args *faa = aux; 96 todr_chip_handle_t handle; 97 98 if (faa->fa_nreg < 1) 99 return; 100 101 handle = malloc(sizeof(struct todr_chip_handle), M_DEVBUF, M_NOWAIT); 102 if (handle == NULL) 103 panic("sxirtc_attach: couldn't allocate todr_handle"); 104 105 sc->sc_iot = faa->fa_iot; 106 if (bus_space_map(sc->sc_iot, faa->fa_reg[0].addr, 107 faa->fa_reg[0].size, 0, &sc->sc_ioh)) 108 panic("sxirtc_attach: bus_space_map failed!"); 109 110 if (OF_is_compatible(faa->fa_node, "allwinner,sun6i-a31-rtc") || 111 OF_is_compatible(faa->fa_node, "allwinner,sun8i-h3-rtc") || 112 OF_is_compatible(faa->fa_node, "allwinner,sun50i-h5-rtc")) { 113 sc->sc_yymmdd = SXIRTC_YYMMDD_A31; 114 sc->sc_hhmmss = SXIRTC_HHMMSS_A31; 115 } else { 116 sc->sc_yymmdd = SXIRTC_YYMMDD_A10; 117 sc->sc_hhmmss = SXIRTC_HHMMSS_A10; 118 } 119 120 if (OF_is_compatible(faa->fa_node, "allwinner,sun7i-a20-rtc")) { 121 sc->base_year = 1970; 122 sc->year_mask = 0xff; 123 sc->leap_shift = 24; 124 } else { 125 sc->base_year = 2010; 126 sc->year_mask = 0x3f; 127 sc->leap_shift = 22; 128 } 129 130 if (OF_is_compatible(faa->fa_node, "allwinner,sun8i-h3-rtc") || 131 OF_is_compatible(faa->fa_node, "allwinner,sun50i-h5-rtc")) { 132 /* Switch to external oscillator. */ 133 SXIWRITE4(sc, SXIRTC_LOSC_CTRL, 134 SXIRTC_LOSC_CTRL_KEY_FIELD | SXIRTC_LOSC_CTRL_SEL_EXT32K); 135 136 sc->sc_cd.cd_node = faa->fa_node; 137 sc->sc_cd.cd_cookie = sc; 138 sc->sc_cd.cd_get_frequency = sxirtc_get_frequency; 139 sc->sc_cd.cd_enable = sxirtc_enable; 140 clock_register(&sc->sc_cd); 141 } 142 143 handle->cookie = self; 144 handle->todr_gettime = sxirtc_gettime; 145 handle->todr_settime = sxirtc_settime; 146 handle->bus_cookie = NULL; 147 handle->todr_setwen = NULL; 148 handle->todr_quality = 0; 149 todr_attach(handle); 150 151 printf("\n"); 152 } 153 154 uint32_t 155 sxirtc_get_frequency(void *cookie, uint32_t *cells) 156 { 157 struct sxirtc_softc *sc = cookie; 158 uint32_t idx = cells[0]; 159 160 switch (idx) { 161 case 0: /* osc32k */ 162 case 1: /* osc32k-out */ 163 return clock_get_frequency_idx(sc->sc_cd.cd_node, 0); 164 case 2: /* iosc */ 165 return 16000000; 166 } 167 168 printf("%s: 0x%08x\n", __func__, idx); 169 return 0; 170 } 171 172 void 173 sxirtc_enable(void *cookie, uint32_t *cells, int on) 174 { 175 struct sxirtc_softc *sc = cookie; 176 uint32_t idx = cells[0]; 177 178 switch (idx) { 179 case 0: /* osc32k */ 180 break; 181 case 1: /* osc32k-out */ 182 if (on) 183 SXISET4(sc, SXIRTC_LOSC_OUT_GATING, 1); 184 else 185 SXICLR4(sc, SXIRTC_LOSC_OUT_GATING, 1); 186 break; 187 case 2: /* iosc */ 188 break; 189 default: 190 printf("%s: 0x%08x\n", __func__, idx); 191 break; 192 } 193 } 194 195 int 196 sxirtc_gettime(todr_chip_handle_t handle, struct timeval *tv) 197 { 198 struct sxirtc_softc *sc = (struct sxirtc_softc *)handle->cookie; 199 struct clock_ymdhms dt; 200 uint32_t reg; 201 202 reg = SXIREAD4(sc, sc->sc_hhmmss); 203 dt.dt_sec = reg & 0x3f; 204 dt.dt_min = reg >> 8 & 0x3f; 205 dt.dt_hour = reg >> 16 & 0x1f; 206 dt.dt_wday = reg >> 29 & 0x07; 207 208 reg = SXIREAD4(sc, sc->sc_yymmdd); 209 dt.dt_day = reg & 0x1f; 210 dt.dt_mon = reg >> 8 & 0x0f; 211 dt.dt_year = (reg >> 16 & sc->year_mask) + sc->base_year; 212 213 if (dt.dt_sec > 59 || dt.dt_min > 59 || 214 dt.dt_hour > 23 || dt.dt_wday > 6 || 215 dt.dt_day > 31 || dt.dt_day == 0 || 216 dt.dt_mon > 12 || dt.dt_mon == 0) 217 return 1; 218 219 /* 220 * Reject the first year that can be represented by the clock. 221 * This avoids reporting a bogus time if the RTC isn't battery 222 * powered. 223 */ 224 if (dt.dt_year == sc->base_year) 225 return 1; 226 227 tv->tv_sec = clock_ymdhms_to_secs(&dt); 228 tv->tv_usec = 0; 229 return 0; 230 } 231 232 int 233 sxirtc_settime(todr_chip_handle_t handle, struct timeval *tv) 234 { 235 struct sxirtc_softc *sc = (struct sxirtc_softc *)handle->cookie; 236 struct clock_ymdhms dt; 237 238 clock_secs_to_ymdhms(tv->tv_sec, &dt); 239 240 if (dt.dt_sec > 59 || dt.dt_min > 59 || 241 dt.dt_hour > 23 || dt.dt_wday > 6 || 242 dt.dt_day > 31 || dt.dt_day == 0 || 243 dt.dt_mon > 12 || dt.dt_mon == 0) 244 return 1; 245 246 SXICMS4(sc, sc->sc_hhmmss, 0xe0000000 | 0x1f0000 | 0x3f00 | 0x3f, 247 dt.dt_sec | (dt.dt_min << 8) | (dt.dt_hour << 16) | 248 (dt.dt_wday << 29)); 249 250 SXICMS4(sc, sc->sc_yymmdd, 0x00400000 | (sc->year_mask << 16) | 251 0x0f00 | 0x1f, dt.dt_day | (dt.dt_mon << 8) | 252 ((dt.dt_year - sc->base_year) << 16) | 253 (LEAPYEAR(dt.dt_year) << sc->leap_shift)); 254 255 return 0; 256 } 257