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