/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2011 NetApp, Inc.
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``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 NETAPP, INC 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/types.h>

#include <time.h>
#include <assert.h>

#include <machine/vmm.h>
#include <vmmapi.h>

#include "acpi.h"
#include "config.h"
#include "pci_lpc.h"
#include "rtc.h"

#define IO_RTC          0x70

#define RTC_LMEM_LSB    0x34
#define RTC_LMEM_MSB    0x35
#define RTC_HMEM_LSB    0x5b
#define RTC_HMEM_SB     0x5c
#define RTC_HMEM_MSB    0x5d

#define m_64KB          (64*1024)
#define m_16MB          (16*1024*1024)
#define m_4GB           (4ULL*1024*1024*1024)

/*
 * Returns the current RTC time as number of seconds since 00:00:00 Jan 1, 1970
 */
#ifdef __FreeBSD__
static time_t
rtc_time(void)
{
        struct tm tm;
        time_t t;

        time(&t);
        if (get_config_bool_default("rtc.use_localtime", true)) {
                localtime_r(&t, &tm);
                t = timegm(&tm);
        }
        return (t);
}
#else /* __FreeBSD__ */
static void
rtc_time(timespec_t *ts)
{
        (void) clock_gettime(CLOCK_REALTIME, ts);

        if (get_config_bool_default("rtc.use_localtime", true)) {
                struct tm tm;

                localtime_r(&ts->tv_sec, &tm);
                ts->tv_sec = timegm(&tm);
        }
}
#endif /* __FreeBSD__ */

void
rtc_init(struct vmctx *ctx)
{
        size_t himem;
        size_t lomem;
        int err;

        /* XXX init diag/reset code/equipment/checksum ? */

        /*
         * Report guest memory size in nvram cells as required by UEFI.
         * Little-endian encoding.
         * 0x34/0x35 - 64KB chunks above 16MB, below 4GB
         * 0x5b/0x5c/0x5d - 64KB chunks above 4GB
         */
        lomem = (vm_get_lowmem_size(ctx) - m_16MB) / m_64KB;
        err = vm_rtc_write(ctx, RTC_LMEM_LSB, lomem);
        assert(err == 0);
        err = vm_rtc_write(ctx, RTC_LMEM_MSB, lomem >> 8);
        assert(err == 0);

        himem = vm_get_highmem_size(ctx) / m_64KB;
        err = vm_rtc_write(ctx, RTC_HMEM_LSB, himem);
        assert(err == 0);
        err = vm_rtc_write(ctx, RTC_HMEM_SB, himem >> 8);
        assert(err == 0);
        err = vm_rtc_write(ctx, RTC_HMEM_MSB, himem >> 16);
        assert(err == 0);

#ifdef __FreeBSD__
        err = vm_rtc_settime(ctx, rtc_time());
#else
        timespec_t ts;

        rtc_time(&ts);
        err = vm_rtc_settime(ctx, &ts);
#endif
        assert(err == 0);
}

static void
rtc_dsdt(void)
{

        dsdt_line("");
        dsdt_line("Device (RTC)");
        dsdt_line("{");
        dsdt_line("  Name (_HID, EisaId (\"PNP0B00\"))");
        dsdt_line("  Name (_CRS, ResourceTemplate ()");
        dsdt_line("  {");
        dsdt_indent(2);
        dsdt_fixed_ioport(IO_RTC, 2);
        dsdt_fixed_irq(8);
        dsdt_unindent(2);
        dsdt_line("  })");
        dsdt_line("}");
}
LPC_DSDT(rtc_dsdt);

/*
 * Reserve the extended RTC I/O ports although they are not emulated at this
 * time.
 */
SYSRES_IO(0x72, 6);