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

/*
 * Copyright (c) 2001 Antti Kantee.  All Rights Reserved.
 *
 * 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 company nor the name of the author may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY CAUASLITY LIMITED ``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 CAUSALITY LIMITED 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.
 */

/*
 * Copyright (c) 1998 Mark Brinicombe.
 * Copyright (c) 1998 Causality Limited.
 * All rights reserved.
 *
 * Written by Mark Brinicombe, Causality Limited
 *
 * 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. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by Mark Brinicombe
 *      for the NetBSD Project.
 * 4. The name of the company nor the name of the author may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY CAUASLITY LIMITED ``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 CAUSALITY LIMITED 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.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: mcclock_mace.c,v 1.19 2025/09/07 21:45:14 thorpej Exp $");

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

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

#include <dev/clock_subr.h>
#include <dev/ic/ds1687reg.h>

#include <sgimips/mace/macevar.h>

#include <sgimips/sgimips/clockvar.h>

struct mcclock_mace_softc {
        device_t                sc_dev;

        struct todr_chip_handle sc_todrch;

        bus_space_tag_t         sc_st;
        bus_space_handle_t      sc_sh;
};

static struct mcclock_mace_softc *mace0 = NULL;

static int      mcclock_mace_match(device_t, cfdata_t, void *);
static void     mcclock_mace_attach(device_t, device_t, void *);

static int      mcclock_mace_gettime_ymdhms(todr_chip_handle_t,
    struct clock_ymdhms *);
static int      mcclock_mace_settime_ymdhms(todr_chip_handle_t,
    struct clock_ymdhms *);

unsigned int    ds1687_read(void *arg, unsigned int addr);
void            ds1687_write(void *arg, unsigned int addr, unsigned int data);

void            mcclock_poweroff(void);


CFATTACH_DECL_NEW(mcclock_mace, sizeof(struct mcclock_mace_softc),
    mcclock_mace_match, mcclock_mace_attach, NULL, NULL);

static int
mcclock_mace_match(device_t parent, cfdata_t cf, void *aux)
{

        return 1;
}

void
mcclock_mace_attach(device_t parent, device_t self, void *aux)
{
        struct mcclock_mace_softc *sc = device_private(self);
        struct mace_attach_args *maa = aux;

        sc->sc_dev = self;
        sc->sc_st = maa->maa_st;
        /* XXX should be bus_space_map() */
        if (bus_space_subregion(maa->maa_st, maa->maa_sh,
            maa->maa_offset, 0, &sc->sc_sh))
                panic("mcclock_mace_attach: couldn't map");

        /*
         * We want a fixed format: 24-hour, BCD data, so just force the
         * RTC to this mode; if there was junk there we'll be able to
         * fix things up later when we discover the time read back is
         * no good.
         */
        ds1687_write(sc, DS1687_CONTROLA, DS1687_DV1 | DS1687_BANK1);
        ds1687_write(sc, DS1687_CONTROLB, DS1687_24HRS);

        /* XXXrkb: init kickstart/wakeup stuff */

        if (!(ds1687_read(sc, DS1687_CONTROLD) & DS1687_VRT))
                printf(": lithium cell is dead, RTC unreliable");

        printf("\n");

        sc->sc_todrch.todr_dev = self;
        sc->sc_todrch.todr_gettime_ymdhms = mcclock_mace_gettime_ymdhms;
        sc->sc_todrch.todr_settime_ymdhms = mcclock_mace_settime_ymdhms;

        todr_attach(&sc->sc_todrch);
        mace0 = sc;
}

/*
 * We need to use the following two functions from
 * DS1687_PUT/GETTOD(). Hence the names.
 */
unsigned int
ds1687_read(void *arg, unsigned int addr)
{
        struct mcclock_mace_softc *sc = arg;

        return bus_space_read_1(sc->sc_st, sc->sc_sh, (addr << 8) + 7);
}

void
ds1687_write(void *arg, unsigned int addr, unsigned int data)
{
        struct mcclock_mace_softc *sc = arg;

        bus_space_write_1(sc->sc_st, sc->sc_sh, (addr << 8) + 7, data);
}

static int
mcclock_mace_gettime_ymdhms(todr_chip_handle_t todrch, struct clock_ymdhms *dt)
{
        struct mcclock_mace_softc *sc = device_private(todrch->todr_dev);
        ds1687_todregs regs;
        int s;

        s = splhigh();
        DS1687_GETTOD(sc, &regs);
        splx(s);

        dt->dt_sec = bcdtobin(regs[DS1687_SOFT_SEC]);
        dt->dt_min = bcdtobin(regs[DS1687_SOFT_MIN]);
        dt->dt_hour = bcdtobin(regs[DS1687_SOFT_HOUR]);
        dt->dt_wday = bcdtobin(regs[DS1687_SOFT_DOW]);
        dt->dt_day = bcdtobin(regs[DS1687_SOFT_DOM]);
        dt->dt_mon = bcdtobin(regs[DS1687_SOFT_MONTH]);
        dt->dt_year = bcdtobin(regs[DS1687_SOFT_YEAR]) +
            (100 * bcdtobin(regs[DS1687_SOFT_CENTURY]));

        return 0;
}

static int
mcclock_mace_settime_ymdhms(todr_chip_handle_t todrch, struct clock_ymdhms *dt)
{
        struct mcclock_mace_softc *sc = device_private(todrch->todr_dev);
        ds1687_todregs regs;
        int s;

        memset(&regs, 0, sizeof(regs));

        regs[DS1687_SOFT_SEC] = bintobcd(dt->dt_sec);
        regs[DS1687_SOFT_MIN] = bintobcd(dt->dt_min);
        regs[DS1687_SOFT_HOUR] = bintobcd(dt->dt_hour);
        regs[DS1687_SOFT_DOW] = bintobcd(dt->dt_wday);
        regs[DS1687_SOFT_DOM] = bintobcd(dt->dt_day);
        regs[DS1687_SOFT_MONTH] = bintobcd(dt->dt_mon);
        regs[DS1687_SOFT_YEAR] = bintobcd(dt->dt_year % 100);
        regs[DS1687_SOFT_CENTURY] = bintobcd(dt->dt_year / 100);
        s = splhigh();
        DS1687_PUTTOD(sc, &regs);
        splx(s);

        return 0;
}

void
mcclock_poweroff(void)
{
        uint8_t a, xctl_a, xctl_b;

        if (mace0 == NULL)
                return;

        (void)splhigh();
        a = ds1687_read(mace0, DS1687_CONTROLA);
        a &= ~DS1687_DV2;
        a |= DS1687_DV1;
        ds1687_write(mace0, DS1687_CONTROLA, a | DS1687_BANK1);
        wbflush();

        xctl_b = ds1687_read(mace0, DS1687_BANK1_XCTRL4B);
        xctl_b |= DS1687_X4B_ABE | DS1687_X4B_KIE;
        ds1687_write(mace0, DS1687_BANK1_XCTRL4B, xctl_b);

        xctl_a = ds1687_read(mace0, DS1687_BANK1_XCTRL4A);
        xctl_a &= ~(DS1687_X4A_RCF | DS1687_X4A_WAF | DS1687_X4A_KF);
        ds1687_write(mace0, DS1687_BANK1_XCTRL4A, xctl_a);
        wbflush();

        /* and down we go */
        ds1687_write(mace0, DS1687_BANK1_XCTRL4A, xctl_a | DS1687_X4A_PAB);
        ds1687_write(mace0, DS1687_CONTROLA, a);
        wbflush();
        for (;;)
                ;
}