xref: /illumos-gate/usr/src/cmd/bhyve/rtc.c (revision d17be682)
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 "config.h"
44 #include "pci_lpc.h"
45 #include "rtc.h"
46 
47 #define	IO_RTC		0x70
48 
49 #define	RTC_LMEM_LSB	0x34
50 #define	RTC_LMEM_MSB	0x35
51 #define	RTC_HMEM_LSB	0x5b
52 #define	RTC_HMEM_SB	0x5c
53 #define	RTC_HMEM_MSB	0x5d
54 
55 #define	m_64KB		(64*1024)
56 #define	m_16MB		(16*1024*1024)
57 #define	m_4GB		(4ULL*1024*1024*1024)
58 
59 /*
60  * Returns the current RTC time as number of seconds since 00:00:00 Jan 1, 1970
61  */
62 #ifdef __FreeBSD__
63 static time_t
64 rtc_time(void)
65 {
66 	struct tm tm;
67 	time_t t;
68 
69 	time(&t);
70 	if (get_config_bool_default("rtc.use_localtime", true)) {
71 		localtime_r(&t, &tm);
72 		t = timegm(&tm);
73 	}
74 	return (t);
75 }
76 #else /* __FreeBSD__ */
77 static void
78 rtc_time(timespec_t *ts)
79 {
80 	(void) clock_gettime(CLOCK_REALTIME, ts);
81 
82 	if (get_config_bool_default("rtc.use_localtime", true)) {
83 		struct tm tm;
84 
85 		localtime_r(&ts->tv_sec, &tm);
86 		ts->tv_sec = timegm(&tm);
87 	}
88 }
89 #endif /* __FreeBSD__ */
90 
91 void
92 rtc_init(struct vmctx *ctx)
93 {
94 	size_t himem;
95 	size_t lomem;
96 	int err;
97 
98 	/* XXX init diag/reset code/equipment/checksum ? */
99 
100 	/*
101 	 * Report guest memory size in nvram cells as required by UEFI.
102 	 * Little-endian encoding.
103 	 * 0x34/0x35 - 64KB chunks above 16MB, below 4GB
104 	 * 0x5b/0x5c/0x5d - 64KB chunks above 4GB
105 	 */
106 	lomem = (vm_get_lowmem_size(ctx) - m_16MB) / m_64KB;
107 	err = vm_rtc_write(ctx, RTC_LMEM_LSB, lomem);
108 	assert(err == 0);
109 	err = vm_rtc_write(ctx, RTC_LMEM_MSB, lomem >> 8);
110 	assert(err == 0);
111 
112 	himem = vm_get_highmem_size(ctx) / m_64KB;
113 	err = vm_rtc_write(ctx, RTC_HMEM_LSB, himem);
114 	assert(err == 0);
115 	err = vm_rtc_write(ctx, RTC_HMEM_SB, himem >> 8);
116 	assert(err == 0);
117 	err = vm_rtc_write(ctx, RTC_HMEM_MSB, himem >> 16);
118 	assert(err == 0);
119 
120 #ifdef __FreeBSD__
121 	err = vm_rtc_settime(ctx, rtc_time());
122 #else
123 	timespec_t ts;
124 
125 	rtc_time(&ts);
126 	err = vm_rtc_settime(ctx, &ts);
127 #endif
128 	assert(err == 0);
129 }
130 
131 static void
132 rtc_dsdt(void)
133 {
134 
135 	dsdt_line("");
136 	dsdt_line("Device (RTC)");
137 	dsdt_line("{");
138 	dsdt_line("  Name (_HID, EisaId (\"PNP0B00\"))");
139 	dsdt_line("  Name (_CRS, ResourceTemplate ()");
140 	dsdt_line("  {");
141 	dsdt_indent(2);
142 	dsdt_fixed_ioport(IO_RTC, 2);
143 	dsdt_fixed_irq(8);
144 	dsdt_unindent(2);
145 	dsdt_line("  })");
146 	dsdt_line("}");
147 }
148 LPC_DSDT(rtc_dsdt);
149 
150 /*
151  * Reserve the extended RTC I/O ports although they are not emulated at this
152  * time.
153  */
154 SYSRES_IO(0x72, 6);
155