Home | History | Annotate | Line # | Download | only in dev
rtc.c revision 1.9
      1 /*	$NetBSD: rtc.c,v 1.9 2002/12/03 17:54:54 uwe Exp $ */
      2 
      3 /*
      4  * Copyright (c) 2001 Valeriy E. Ushakov
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. The name of the author may not be used to endorse or promote products
     16  *    derived from this software without specific prior written permission
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     28  */
     29 
     30 /*
     31  * `rtc' is a DS1287A (== MC146818A) time-of-day clock at EBus.
     32  * In Krups it's not used to store idprom so this driver doesn't
     33  * support it.  Don't know about other ms-IIep systems.
     34  */
     35 
     36 #include <sys/param.h>
     37 #include <sys/kernel.h>
     38 #include <sys/device.h>
     39 #include <sys/malloc.h>
     40 #include <sys/systm.h>
     41 #ifdef GPROF
     42 #include <sys/gmon.h>
     43 #endif
     44 
     45 #include <machine/bus.h>
     46 #include <machine/autoconf.h>
     47 
     48 #include <dev/clock_subr.h>
     49 #include <dev/ic/mc146818reg.h>
     50 
     51 #include <dev/ebus/ebusreg.h>
     52 #include <dev/ebus/ebusvar.h>
     53 
     54 struct rtc_ebus_softc {
     55 	struct device		sc_dev;
     56 
     57 	bus_space_tag_t		sc_bt;	/* parent bus tag */
     58 	bus_space_handle_t	sc_bh;	/* handle for registers */
     59 };
     60 
     61 static int	rtcmatch_ebus(struct device *, struct cfdata *, void *);
     62 static void	rtcattach_ebus(struct device *, struct device *, void *);
     63 
     64 CFATTACH_DECL(rtc_ebus, sizeof(struct rtc_ebus_softc),
     65     rtcmatch_ebus, rtcattach_ebus, NULL, NULL);
     66 
     67 /* XXX: global TOD clock handle (sparc/clock.c) */
     68 extern todr_chip_handle_t todr_handle;
     69 
     70 /* todr(9) methods */
     71 int rtc_gettime(todr_chip_handle_t, struct timeval *);
     72 int rtc_settime(todr_chip_handle_t, struct timeval *);
     73 int rtc_getcal(todr_chip_handle_t, int *);
     74 int rtc_setcal(todr_chip_handle_t, int);
     75 
     76 int rtc_auto_century_adjust = 1; /* XXX: do we ever want not to? */
     77 
     78 
     79 /*
     80  * MD read/write functions declared in mc146818reg.h
     81  */
     82 #define	RTC_ADDR	0
     83 #define	RTC_DATA	1
     84 
     85 u_int
     86 mc146818_read(cookie, reg)
     87 	void *cookie;
     88 	u_int reg;
     89 {
     90 	struct rtc_ebus_softc *sc = cookie;
     91 
     92 	bus_space_write_1(sc->sc_bt, sc->sc_bh, RTC_ADDR, reg);
     93 	return (bus_space_read_1(sc->sc_bt, sc->sc_bh, RTC_DATA));
     94 }
     95 
     96 void
     97 mc146818_write(cookie, reg, datum)
     98 	void *cookie;
     99 	u_int reg;
    100 	u_int datum;
    101 {
    102 	struct rtc_ebus_softc *sc = cookie;
    103 
    104 	bus_space_write_1(sc->sc_bt, sc->sc_bh, RTC_ADDR, reg);
    105 	bus_space_write_1(sc->sc_bt, sc->sc_bh, RTC_DATA, datum);
    106 }
    107 
    108 
    109 static int
    110 rtcmatch_ebus(parent, cf, aux)
    111 	struct device *parent;
    112 	struct cfdata *cf;
    113 	void *aux;
    114 {
    115 	struct ebus_attach_args *ea = aux;
    116 
    117 	return (strcmp(cf->cf_name, ea->ea_name) == 0);
    118 }
    119 
    120 static void
    121 rtcattach_ebus(parent, self, aux)
    122 	struct device *parent;
    123 	struct device *self;
    124 	void *aux;
    125 {
    126 	struct rtc_ebus_softc *sc = (void *)self;
    127 	struct ebus_attach_args *ea = aux;
    128 
    129 	todr_chip_handle_t handle;
    130 
    131 	sc->sc_bt = ea->ea_bustag;
    132 	if (bus_space_map(sc->sc_bt, EBUS_ADDR_FROM_REG(&ea->ea_reg[0]),
    133 			  ea->ea_reg[0].size, 0, &sc->sc_bh) != 0)
    134 	{
    135 		printf(": unable to map registers\n");
    136 		return;
    137 	}
    138 
    139 	/* XXX: no "model" property in Krups */
    140 	printf(": time-of-day clock\n");
    141 
    142 	/*
    143 	 * Turn interrupts off (clear MC_REGB_?IE bits), just in case
    144 	 * (although they shouldn't be wired to an interrupt
    145 	 * controller on sparcs).
    146 	 */
    147 	mc146818_write(sc, MC_REGB, MC_REGB_BINARY | MC_REGB_24HR);
    148 
    149 	/* setup our todr_handle */
    150 	handle = malloc(ALIGN(sizeof(struct todr_chip_handle)),
    151 			M_DEVBUF, M_NOWAIT);
    152 
    153 	handle->cookie = sc;
    154 	handle->bus_cookie = NULL; /* unused */
    155 	handle->todr_gettime = rtc_gettime;
    156 	handle->todr_settime = rtc_settime;
    157 	handle->todr_getcal = rtc_getcal;
    158 	handle->todr_setcal = rtc_setcal;
    159 	handle->todr_setwen = NULL; /* not necessary, no idprom to protect */
    160 
    161 	todr_handle = handle;
    162 }
    163 
    164 
    165 /*
    166  * Get time-of-day and convert to a `struct timeval'
    167  * Return 0 on success; an error number otherwise.
    168  */
    169 int
    170 rtc_gettime(handle, tv)
    171 	todr_chip_handle_t handle;
    172 	struct timeval *tv;
    173 {
    174 	struct rtc_ebus_softc *sc = handle->cookie;
    175 	struct clock_ymdhms dt;
    176 	u_int year;
    177 
    178 	/* update in progress; spin loop */
    179 	while (mc146818_read(sc, MC_REGA) & MC_REGA_UIP)
    180 		continue;
    181 
    182 	/* stop updates (XXX: do we need that???) */
    183 	mc146818_write(sc, MC_REGB,
    184 		       (mc146818_read(sc, MC_REGB) | MC_REGB_SET));
    185 
    186 	/* read time */
    187 	dt.dt_sec  = mc146818_read(sc, MC_SEC);
    188 	dt.dt_min  = mc146818_read(sc, MC_MIN);
    189 	dt.dt_hour = mc146818_read(sc, MC_HOUR);
    190 	dt.dt_day  = mc146818_read(sc, MC_DOM);
    191 	dt.dt_mon  = mc146818_read(sc, MC_MONTH);
    192 	year       = mc146818_read(sc, MC_YEAR);
    193 
    194 	/* reenable updates */
    195 	mc146818_write(sc, MC_REGB,
    196 		       (mc146818_read(sc, MC_REGB) & ~MC_REGB_SET));
    197 
    198 	/* year in the century 0..99: adjust to AD */
    199 	year += 1900;
    200 	if (year < POSIX_BASE_YEAR && rtc_auto_century_adjust != 0)
    201 		year += 100;
    202 	dt.dt_year = year;
    203 
    204 	/* simple sanity checks */
    205 	if (dt.dt_mon > 12 || dt.dt_day > 31
    206 	    || dt.dt_hour >= 24 || dt.dt_min >= 60 || dt.dt_sec >= 60)
    207 		return (ERANGE);
    208 
    209 	tv->tv_sec = clock_ymdhms_to_secs(&dt);
    210 	tv->tv_usec = 0;
    211 	return (0);
    212 }
    213 
    214 /*
    215  * Set the time-of-day clock based on the value of the `struct timeval' arg.
    216  * Return 0 on success; an error number otherwise.
    217  */
    218 int
    219 rtc_settime(handle, tv)
    220 	todr_chip_handle_t handle;
    221 	struct timeval *tv;
    222 {
    223 	struct rtc_ebus_softc *sc = handle->cookie;
    224 	struct clock_ymdhms dt;
    225 	u_int year;
    226 
    227 	clock_secs_to_ymdhms(tv->tv_sec, &dt);
    228 
    229 	year = dt.dt_year - 1900;
    230 	if (year >= 100 && rtc_auto_century_adjust != 0)
    231 		year -= 100;
    232 
    233 	/* stop updates */
    234 	mc146818_write(sc, MC_REGB,
    235 		       (mc146818_read(sc, MC_REGB) | MC_REGB_SET));
    236 
    237 	mc146818_write(sc, MC_SEC,   dt.dt_sec);
    238 	mc146818_write(sc, MC_MIN,   dt.dt_min);
    239 	mc146818_write(sc, MC_HOUR,  dt.dt_hour);
    240 	mc146818_write(sc, MC_DOW,   dt.dt_wday + 1);
    241 	mc146818_write(sc, MC_DOM,   dt.dt_day);
    242 	mc146818_write(sc, MC_MONTH, dt.dt_mon);
    243 	mc146818_write(sc, MC_YEAR,  year);
    244 
    245 	/* reenable updates */
    246 	mc146818_write(sc, MC_REGB,
    247 		       (mc146818_read(sc, MC_REGB) & ~MC_REGB_SET));
    248 	return (0);
    249 }
    250 
    251 
    252 /*
    253  * RTC does not support TOD clock calibration
    254  */
    255 
    256 /* ARGSUSED */
    257 int
    258 rtc_getcal(handle, vp)
    259 	todr_chip_handle_t handle;
    260 	int *vp;
    261 {
    262 	return (EOPNOTSUPP);
    263 }
    264 
    265 /* ARGSUSED */
    266 int
    267 rtc_setcal(handle, v)
    268 	todr_chip_handle_t handle;
    269 	int v;
    270 {
    271 	return (EOPNOTSUPP);
    272 }
    273