xref: /src/sys/arch/sgimips/dev/dpclock.c

/*	$NetBSD: dpclock.c,v 1.9 2025/09/07 21:45:14 thorpej Exp $	*/

/*
 * Copyright (c) 2001 Erik Reid
 * Copyright (c) 2001 Rafal K. Boni
 * Copyright (c) 2001 Christopher Sekiya
 * Copyright (c) 1998, 1999, 2000 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * Portions of this code are derived from software contributed to The
 * NetBSD Foundation by Jason R. Thorpe of the Numerical Aerospace
 * Simulation Facility, NASA Ames Research Center.
 *
 * 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.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 */

#include <sys/param.h>
#include <sys/kernel.h>
#include <sys/systm.h>
#include <sys/device.h>

#include <sys/bus.h>
#include <machine/autoconf.h>
#include <machine/sysconf.h>
#include <machine/machtype.h>

#include <dev/clock_subr.h>
#include <sgimips/dev/dp8573areg.h>

#include <sgimips/sgimips/clockvar.h>

struct dpclock_softc {
	device_t		sc_dev;
	struct todr_chip_handle sc_todrch;

	/* RTC registers */
	bus_space_tag_t		sc_rtct;
	bus_space_handle_t	sc_rtch;
	int			sc_offset;
};

static int	dpclock_match(device_t, cfdata_t, void *);
static void	dpclock_attach(device_t, device_t, void *);
static int	dpclock_gettime_ymdhms(struct todr_chip_handle *,
				       struct clock_ymdhms *);
static int	dpclock_settime_ymdhms(struct todr_chip_handle *,
				       struct clock_ymdhms *);

CFATTACH_DECL_NEW(dpclock, sizeof(struct dpclock_softc),
    dpclock_match, dpclock_attach, NULL, NULL);

static int
dpclock_match(device_t parent, cfdata_t cf, void *aux)
{
	struct mainbus_attach_args *ma = aux;

	switch (mach_type) {
	case MACH_SGI_IP6 | MACH_SGI_IP10:
		if (ma->ma_addr == 0x1fbc0000)
			return (1);
		break;

	case MACH_SGI_IP12:
	case MACH_SGI_IP20:
		if (ma->ma_addr == 0x1fb80e00)
			return (1);
		break;
	}

	return (0);
}

static void
writereg(struct dpclock_softc *sc, uint32_t reg, uint8_t val)
{
	bus_space_write_1(sc->sc_rtct, sc->sc_rtch,
	    (reg << 2) + sc->sc_offset, val);
}

static uint8_t
readreg(struct dpclock_softc *sc, uint32_t reg)
{
	return bus_space_read_1(sc->sc_rtct, sc->sc_rtch,
	    (reg << 2) + sc->sc_offset);
}

static void
dpclock_attach(device_t parent, device_t self, void *aux)
{
	struct dpclock_softc *sc = device_private(self);
	struct mainbus_attach_args *ma = aux;
	int err;

	printf("\n");

	sc->sc_dev = self;
	sc->sc_rtct = normal_memt;
	/*
	 * All machines have one byte register per word. IP6/IP10 use
	 * the MSB, others the LSB.
	 */
	if (mach_type == MACH_SGI_IP12 || mach_type == MACH_SGI_IP20)
		sc->sc_offset = 3;
	else
		sc->sc_offset = 0;

	if ((err = bus_space_map(sc->sc_rtct, ma->ma_addr, 0x1ffff,
	    BUS_SPACE_MAP_LINEAR, &sc->sc_rtch)) != 0) {
		printf(": unable to map RTC registers, error = %d\n", err);
		return;
	}

	sc->sc_todrch.todr_dev = self;
	sc->sc_todrch.todr_gettime_ymdhms = dpclock_gettime_ymdhms;
	sc->sc_todrch.todr_settime_ymdhms = dpclock_settime_ymdhms;

	todr_attach(&sc->sc_todrch);
}

/*
 * Get the time of day, based on the clock's value and/or the base value.
 */
static int
dpclock_gettime_ymdhms(struct todr_chip_handle *todrch, struct clock_ymdhms *dt)
{
	struct dpclock_softc *sc = device_private(todrch->todr_dev);
	int s;
	u_int8_t i, j;
	u_int8_t regs[32];

	s = splhigh();
	i = readreg(sc, DP8573A_TIMESAVE_CTL);
	j = i | DP8573A_TIMESAVE_CTL_EN;
	writereg(sc, DP8573A_TIMESAVE_CTL, j);
	writereg(sc, DP8573A_TIMESAVE_CTL, i);
	splx(s);

	for (i = 0; i < 32; i++)
		regs[i] = readreg(sc, i);

	dt->dt_sec = bcdtobin(regs[DP8573A_SAVE_SEC]);
	dt->dt_min = bcdtobin(regs[DP8573A_SAVE_MIN]);

	if (regs[DP8573A_RT_MODE] & DP8573A_RT_MODE_1224) {
		dt->dt_hour = bcdtobin(regs[DP8573A_SAVE_HOUR] &
						DP8573A_HOUR_12HR_MASK) +
		    ((regs[DP8573A_SAVE_HOUR] & DP8573A_RT_MODE_1224) ? 0 : 12);

		/*
		 * In AM/PM mode, hour range is 01-12, so adding in 12 hours
		 * for PM gives us 01-24, whereas we want 00-23, so map hour
		 * 24 to hour 0.
		 */

		if (dt->dt_hour == 24)
			dt->dt_hour = 0;
	} else {
		dt->dt_hour = bcdtobin(regs[DP8573A_SAVE_HOUR] &
							DP8573A_HOUR_24HR_MASK);
	}

	dt->dt_wday = bcdtobin(regs[DP8573A_DOW]);    /* Not from time saved */
	dt->dt_day = bcdtobin(regs[DP8573A_SAVE_DOM]);
	dt->dt_mon = bcdtobin(regs[DP8573A_SAVE_MONTH]);
	dt->dt_year = FROM_IRIX_YEAR(bcdtobin(regs[DP8573A_YEAR]));

	return (0);
}

/*
 * Reset the TODR based on the time value.
 */
static int
dpclock_settime_ymdhms(struct todr_chip_handle *todrch, struct clock_ymdhms *dt)
{
	struct dpclock_softc *sc = device_private(todrch->todr_dev);
	int s;
	u_int8_t i, j;
	u_int8_t regs[32];

	s = splhigh();
	i = readreg(sc, DP8573A_TIMESAVE_CTL);
	j = i | DP8573A_TIMESAVE_CTL_EN;
	writereg(sc, DP8573A_TIMESAVE_CTL, j);
	writereg(sc, DP8573A_TIMESAVE_CTL, i);
	splx(s);

	for (i = 0; i < 32; i++)
		regs[i] = readreg(sc, i);

	regs[DP8573A_SUBSECOND] = 0;
	regs[DP8573A_SECOND] = bintobcd(dt->dt_sec);
	regs[DP8573A_MINUTE] = bintobcd(dt->dt_min);
	regs[DP8573A_HOUR] = bintobcd(dt->dt_hour) & DP8573A_HOUR_24HR_MASK;
	regs[DP8573A_DOW] = bintobcd(dt->dt_wday);
	regs[DP8573A_DOM] = bintobcd(dt->dt_day);
	regs[DP8573A_MONTH] = bintobcd(dt->dt_mon);
	regs[DP8573A_YEAR] = bintobcd(TO_IRIX_YEAR(dt->dt_year));

	s = splhigh();
	i = readreg(sc, DP8573A_RT_MODE);
	j = i & ~DP8573A_RT_MODE_CLKSS;
	writereg(sc, DP8573A_RT_MODE, j);

	for (i = 0; i < 10; i++)
		writereg(sc, DP8573A_COUNTERS +i, regs[DP8573A_COUNTERS + i]);

	writereg(sc, DP8573A_RT_MODE, i);
	splx(s);

	return (0);
}