usr.sbin/bhyve/rtc.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2011 NetApp, Inc.
   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  *
  16  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34 #include <sys/types.h>
  35
  36 #include <time.h>
  37 #include <assert.h>
  38
  39 #include <machine/vmm.h>
  40 #include <vmmapi.h>
  41
  42 #include "acpi.h"
  43 #include "pci_lpc.h"
  44 #include "rtc.h"
  45
  46 #define IO_RTC          0x70
  47
  48 #define RTC_LMEM_LSB    0x34
  49 #define RTC_LMEM_MSB    0x35
  50 #define RTC_HMEM_LSB    0x5b
  51 #define RTC_HMEM_SB     0x5c
  52 #define RTC_HMEM_MSB    0x5d
  53
  54 #define m_64KB          (64*1024)
  55 #define m_16MB          (16*1024*1024)
  56 #define m_4GB           (4ULL*1024*1024*1024)
  57
  58 /*
  59  * Returns the current RTC time as number of seconds since 00:00:00 Jan 1, 1970
  60  */
  61 static time_t
  62 rtc_time(struct vmctx *ctx, int use_localtime)
  63 {
  64         struct tm tm;
  65         time_t t;
  66
  67         time(&t);
  68         if (use_localtime) {
  69                 localtime_r(&t, &tm);
  70                 t = timegm(&tm);
  71         }
  72         return (t);
  73 }
  74
  75 void
  76 rtc_init(struct vmctx *ctx, int use_localtime)
  77 {
  78         size_t himem;
  79         size_t lomem;
  80         int err;
  81
  82         /* XXX init diag/reset code/equipment/checksum ? */
  83
  84         /*
  85          * Report guest memory size in nvram cells as required by UEFI.
  86          * Little-endian encoding.
  87          * 0x34/0x35 - 64KB chunks above 16MB, below 4GB
  88          * 0x5b/0x5c/0x5d - 64KB chunks above 4GB
  89          */
  90         lomem = (vm_get_lowmem_size(ctx) - m_16MB) / m_64KB;
  91         err = vm_rtc_write(ctx, RTC_LMEM_LSB, lomem);
  92         assert(err == 0);
  93         err = vm_rtc_write(ctx, RTC_LMEM_MSB, lomem >> 8);
  94         assert(err == 0);
  95
  96         himem = vm_get_highmem_size(ctx) / m_64KB;
  97         err = vm_rtc_write(ctx, RTC_HMEM_LSB, himem);
  98         assert(err == 0);
  99         err = vm_rtc_write(ctx, RTC_HMEM_SB, himem >> 8);
 100         assert(err == 0);
 101         err = vm_rtc_write(ctx, RTC_HMEM_MSB, himem >> 16);
 102         assert(err == 0);
 103
 104         err = vm_rtc_settime(ctx, rtc_time(ctx, use_localtime));
 105         assert(err == 0);
 106 }
 107
 108 static void
 109 rtc_dsdt(void)
 110 {
 111
 112         dsdt_line("");
 113         dsdt_line("Device (RTC)");
 114         dsdt_line("{");
 115         dsdt_line("  Name (_HID, EisaId (\"PNP0B00\"))");
 116         dsdt_line("  Name (_CRS, ResourceTemplate ()");
 117         dsdt_line("  {");
 118         dsdt_indent(2);
 119         dsdt_fixed_ioport(IO_RTC, 2);
 120         dsdt_fixed_irq(8);
 121         dsdt_unindent(2);
 122         dsdt_line("  })");
 123         dsdt_line("}");
 124 }
 125 LPC_DSDT(rtc_dsdt);
 126
 127 /*
 128  * Reserve the extended RTC I/O ports although they are not emulated at this
 129  * time.
 130  */
 131 SYSRES_IO(0x72, 6);