xref: /freebsd/usr.sbin/bhyve/acpi.c (revision e2e956828caf2f1db308d54b264c277c0abc25df)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2012 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 /*
30  * bhyve ACPI table generator.
31  *
32  * Create the minimal set of ACPI tables required to boot FreeBSD (and
33  * hopefully other o/s's).
34  *
35  * The tables are placed in the guest's ROM area just below 1MB physical,
36  * above the MPTable.
37  */
38 
39 #include <sys/param.h>
40 #include <sys/endian.h>
41 #include <sys/errno.h>
42 #include <sys/stat.h>
43 
44 #include <err.h>
45 #include <paths.h>
46 #include <stdarg.h>
47 #include <stddef.h>
48 #include <stdio.h>
49 #include <stdlib.h>
50 #include <string.h>
51 #include <unistd.h>
52 
53 #include <machine/vmm.h>
54 #include <vmmapi.h>
55 
56 #include "bhyverun.h"
57 #include "acpi.h"
58 #include "basl.h"
59 #include "pci_emul.h"
60 #include "vmgenc.h"
61 
62 #define	BHYVE_ASL_TEMPLATE	"bhyve.XXXXXXX"
63 #define BHYVE_ASL_SUFFIX	".aml"
64 #define BHYVE_ASL_COMPILER	"/usr/sbin/iasl"
65 
66 #define BHYVE_ADDRESS_IOAPIC 	0xFEC00000
67 #define BHYVE_ADDRESS_HPET 	0xFED00000
68 #define BHYVE_ADDRESS_LAPIC 	0xFEE00000
69 
70 static int basl_keep_temps;
71 static int basl_verbose_iasl;
72 static int basl_ncpu;
73 
74 /*
75  * Contains the full pathname of the template to be passed
76  * to mkstemp/mktemps(3)
77  */
78 static char basl_template[MAXPATHLEN];
79 static char basl_stemplate[MAXPATHLEN];
80 
81 /*
82  * State for dsdt_line(), dsdt_indent(), and dsdt_unindent().
83  */
84 static FILE *dsdt_fp;
85 static int dsdt_indent_level;
86 static int dsdt_error;
87 
88 struct basl_fio {
89 	int	fd;
90 	FILE	*fp;
91 	char	f_name[MAXPATHLEN];
92 };
93 
94 #define EFPRINTF(...) \
95 	if (fprintf(__VA_ARGS__) < 0) goto err_exit
96 
97 #define EFFLUSH(x) \
98 	if (fflush(x) != 0) goto err_exit
99 
100 /*
101  * A list for additional ACPI devices like a TPM.
102  */
103 struct acpi_device_list_entry {
104 	SLIST_ENTRY(acpi_device_list_entry) chain;
105 	const struct acpi_device *dev;
106 };
107 static SLIST_HEAD(acpi_device_list,
108     acpi_device_list_entry) acpi_devices = SLIST_HEAD_INITIALIZER(acpi_devices);
109 
110 int
acpi_tables_add_device(const struct acpi_device * const dev)111 acpi_tables_add_device(const struct acpi_device *const dev)
112 {
113 	struct acpi_device_list_entry *const entry = calloc(1, sizeof(*entry));
114 	if (entry == NULL) {
115 		return (ENOMEM);
116 	}
117 
118 	entry->dev = dev;
119 	SLIST_INSERT_HEAD(&acpi_devices, entry, chain);
120 
121 	return (0);
122 }
123 
124 /*
125  * Helper routines for writing to the DSDT from other modules.
126  */
127 void
dsdt_line(const char * fmt,...)128 dsdt_line(const char *fmt, ...)
129 {
130 	va_list ap;
131 
132 	if (dsdt_error != 0)
133 		return;
134 
135 	if (strcmp(fmt, "") != 0) {
136 		if (dsdt_indent_level != 0)
137 			EFPRINTF(dsdt_fp, "%*c", dsdt_indent_level * 2, ' ');
138 		va_start(ap, fmt);
139 		if (vfprintf(dsdt_fp, fmt, ap) < 0) {
140 			va_end(ap);
141 			goto err_exit;
142 		}
143 		va_end(ap);
144 	}
145 	EFPRINTF(dsdt_fp, "\n");
146 	return;
147 
148 err_exit:
149 	dsdt_error = errno;
150 }
151 
152 void
dsdt_indent(int levels)153 dsdt_indent(int levels)
154 {
155 
156 	dsdt_indent_level += levels;
157 	assert(dsdt_indent_level >= 0);
158 }
159 
160 void
dsdt_unindent(int levels)161 dsdt_unindent(int levels)
162 {
163 
164 	assert(dsdt_indent_level >= levels);
165 	dsdt_indent_level -= levels;
166 }
167 
168 void
dsdt_fixed_ioport(uint16_t iobase,uint16_t length)169 dsdt_fixed_ioport(uint16_t iobase, uint16_t length)
170 {
171 
172 	dsdt_line("IO (Decode16,");
173 	dsdt_line("  0x%04X,             // Range Minimum", iobase);
174 	dsdt_line("  0x%04X,             // Range Maximum", iobase);
175 	dsdt_line("  0x01,               // Alignment");
176 	dsdt_line("  0x%02X,               // Length", length);
177 	dsdt_line("  )");
178 }
179 
180 void
dsdt_fixed_irq(uint8_t irq)181 dsdt_fixed_irq(uint8_t irq)
182 {
183 
184 	dsdt_line("IRQNoFlags ()");
185 	dsdt_line("  {%d}", irq);
186 }
187 
188 void
dsdt_fixed_mem32(uint32_t base,uint32_t length)189 dsdt_fixed_mem32(uint32_t base, uint32_t length)
190 {
191 
192 	dsdt_line("Memory32Fixed (ReadWrite,");
193 	dsdt_line("  0x%08X,         // Address Base", base);
194 	dsdt_line("  0x%08X,         // Address Length", length);
195 	dsdt_line("  )");
196 }
197 
198 static int
basl_fwrite_dsdt(FILE * fp)199 basl_fwrite_dsdt(FILE *fp)
200 {
201 	dsdt_fp = fp;
202 	dsdt_error = 0;
203 	dsdt_indent_level = 0;
204 
205 	dsdt_line("/*");
206 	dsdt_line(" * bhyve DSDT template");
207 	dsdt_line(" */");
208 	dsdt_line("DefinitionBlock (\"bhyve_dsdt.aml\", \"DSDT\", 2,"
209 		 "\"BHYVE \", \"BVDSDT  \", 0x00000001)");
210 	dsdt_line("{");
211 	dsdt_line("  Name (_S5, Package ()");
212 	dsdt_line("  {");
213 	dsdt_line("      0x05,");
214 	dsdt_line("      Zero,");
215 	dsdt_line("  })");
216 
217 	pci_write_dsdt();
218 
219 #ifdef __amd64__
220 	dsdt_line("");
221 	dsdt_line("  Scope (_SB.PC00)");
222 	dsdt_line("  {");
223 	dsdt_line("    Device (HPET)");
224 	dsdt_line("    {");
225 	dsdt_line("      Name (_HID, EISAID(\"PNP0103\"))");
226 	dsdt_line("      Name (_UID, 0)");
227 	dsdt_line("      Name (_CRS, ResourceTemplate ()");
228 	dsdt_line("      {");
229 	dsdt_indent(4);
230 	dsdt_fixed_mem32(0xFED00000, 0x400);
231 	dsdt_unindent(4);
232 	dsdt_line("      })");
233 	dsdt_line("    }");
234 	dsdt_line("  }");
235 #endif
236 
237 	vmgenc_write_dsdt();
238 
239 	const struct acpi_device_list_entry *entry;
240 	SLIST_FOREACH(entry, &acpi_devices, chain) {
241 		BASL_EXEC(acpi_device_write_dsdt(entry->dev));
242 	}
243 
244 	dsdt_line("}");
245 
246 	if (dsdt_error != 0)
247 		return (dsdt_error);
248 
249 	EFFLUSH(fp);
250 
251 	return (0);
252 
253 err_exit:
254 	return (errno);
255 }
256 
257 static int
basl_open(struct basl_fio * bf,int suffix)258 basl_open(struct basl_fio *bf, int suffix)
259 {
260 	int err;
261 
262 	err = 0;
263 
264 	if (suffix) {
265 		strlcpy(bf->f_name, basl_stemplate, MAXPATHLEN);
266 		bf->fd = mkstemps(bf->f_name, strlen(BHYVE_ASL_SUFFIX));
267 	} else {
268 		strlcpy(bf->f_name, basl_template, MAXPATHLEN);
269 		bf->fd = mkstemp(bf->f_name);
270 	}
271 
272 	if (bf->fd > 0) {
273 		bf->fp = fdopen(bf->fd, "w+");
274 		if (bf->fp == NULL) {
275 			unlink(bf->f_name);
276 			close(bf->fd);
277 		}
278 	} else {
279 		err = 1;
280 	}
281 
282 	return (err);
283 }
284 
285 static void
basl_close(struct basl_fio * bf)286 basl_close(struct basl_fio *bf)
287 {
288 
289 	if (!basl_keep_temps)
290 		unlink(bf->f_name);
291 	fclose(bf->fp);
292 }
293 
294 static int
basl_start(struct basl_fio * in,struct basl_fio * out)295 basl_start(struct basl_fio *in, struct basl_fio *out)
296 {
297 	int err;
298 
299 	err = basl_open(in, 0);
300 	if (!err) {
301 		err = basl_open(out, 1);
302 		if (err) {
303 			basl_close(in);
304 		}
305 	}
306 
307 	return (err);
308 }
309 
310 static void
basl_end(struct basl_fio * in,struct basl_fio * out)311 basl_end(struct basl_fio *in, struct basl_fio *out)
312 {
313 
314 	basl_close(in);
315 	basl_close(out);
316 }
317 
318 static int
basl_load(struct vmctx * ctx,int fd)319 basl_load(struct vmctx *ctx, int fd)
320 {
321 	struct stat sb;
322 	void *addr;
323 
324 	if (fstat(fd, &sb) < 0)
325 		return (errno);
326 
327 	addr = calloc(1, sb.st_size);
328 	if (addr == NULL)
329 		return (ENOMEM);
330 
331 	if (read(fd, addr, sb.st_size) < 0)
332 		return (errno);
333 
334 	struct basl_table *table;
335 
336 	uint8_t name[ACPI_NAMESEG_SIZE + 1] = { 0 };
337 	memcpy(name, addr, sizeof(name) - 1 /* last char is '\0' */);
338 	BASL_EXEC(basl_table_create(&table, ctx, name, BASL_TABLE_ALIGNMENT));
339 	BASL_EXEC(basl_table_append_bytes(table, addr, sb.st_size));
340 
341 	free(addr);
342 	return (0);
343 }
344 
345 static int
basl_compile(struct vmctx * ctx,int (* fwrite_section)(FILE *))346 basl_compile(struct vmctx *ctx, int (*fwrite_section)(FILE *))
347 {
348 	struct basl_fio io[2];
349 	static char iaslbuf[3*MAXPATHLEN + 10];
350 	const char *fmt;
351 	int err;
352 
353 	err = basl_start(&io[0], &io[1]);
354 	if (!err) {
355 		err = (*fwrite_section)(io[0].fp);
356 
357 		if (!err) {
358 			/*
359 			 * iasl sends the results of the compilation to
360 			 * stdout. Shut this down by using the shell to
361 			 * redirect stdout to /dev/null, unless the user
362 			 * has requested verbose output for debugging
363 			 * purposes
364 			 */
365 			fmt = basl_verbose_iasl ?
366 				"%s -p %s %s" :
367 				"/bin/sh -c \"%s -p %s %s\" 1> /dev/null";
368 
369 			snprintf(iaslbuf, sizeof(iaslbuf),
370 				 fmt,
371 				 BHYVE_ASL_COMPILER,
372 				 io[1].f_name, io[0].f_name);
373 			err = system(iaslbuf);
374 
375 			if (!err) {
376 				/*
377 				 * Copy the aml output file into guest
378 				 * memory at the specified location
379 				 */
380 				err = basl_load(ctx, io[1].fd);
381 			}
382 		}
383 		basl_end(&io[0], &io[1]);
384 	}
385 
386 	return (err);
387 }
388 
389 static int
basl_make_templates(void)390 basl_make_templates(void)
391 {
392 	const char *tmpdir;
393 	int err;
394 	int len;
395 
396 	err = 0;
397 
398 	/*
399 	 *
400 	 */
401 	if ((tmpdir = getenv("BHYVE_TMPDIR")) == NULL || *tmpdir == '\0' ||
402 	    (tmpdir = getenv("TMPDIR")) == NULL || *tmpdir == '\0') {
403 		tmpdir = _PATH_TMP;
404 	}
405 
406 	len = strlen(tmpdir);
407 
408 	if ((len + sizeof(BHYVE_ASL_TEMPLATE) + 1) < MAXPATHLEN) {
409 		strcpy(basl_template, tmpdir);
410 		while (len > 0 && basl_template[len - 1] == '/')
411 			len--;
412 		basl_template[len] = '/';
413 		strcpy(&basl_template[len + 1], BHYVE_ASL_TEMPLATE);
414 	} else
415 		err = E2BIG;
416 
417 	if (!err) {
418 		/*
419 		 * len has been initialized (and maybe adjusted) above
420 		 */
421 		if ((len + sizeof(BHYVE_ASL_TEMPLATE) + 1 +
422 		     sizeof(BHYVE_ASL_SUFFIX)) < MAXPATHLEN) {
423 			strcpy(basl_stemplate, tmpdir);
424 			basl_stemplate[len] = '/';
425 			strcpy(&basl_stemplate[len + 1], BHYVE_ASL_TEMPLATE);
426 			len = strlen(basl_stemplate);
427 			strcpy(&basl_stemplate[len], BHYVE_ASL_SUFFIX);
428 		} else
429 			err = E2BIG;
430 	}
431 
432 	return (err);
433 }
434 
435 static int
build_dsdt(struct vmctx * const ctx)436 build_dsdt(struct vmctx *const ctx)
437 {
438 	BASL_EXEC(basl_compile(ctx, basl_fwrite_dsdt));
439 
440 	return (0);
441 }
442 
443 static int
build_facs(struct vmctx * const ctx)444 build_facs(struct vmctx *const ctx)
445 {
446 	ACPI_TABLE_FACS facs;
447 	struct basl_table *table;
448 
449 	BASL_EXEC(basl_table_create(&table, ctx, ACPI_SIG_FACS,
450 	    BASL_TABLE_ALIGNMENT_FACS));
451 
452 	memset(&facs, 0, sizeof(facs));
453 	memcpy(facs.Signature, ACPI_SIG_FACS, ACPI_NAMESEG_SIZE);
454 	facs.Length = sizeof(facs);
455 	facs.Version = htole32(2);
456 	BASL_EXEC(basl_table_append_bytes(table, &facs, sizeof(facs)));
457 
458 	return (0);
459 }
460 
461 static int
build_fadt(struct vmctx * const ctx)462 build_fadt(struct vmctx *const ctx)
463 {
464 	ACPI_TABLE_FADT fadt;
465 	struct basl_table *table;
466 
467 	BASL_EXEC(basl_table_create(&table, ctx, ACPI_SIG_FADT,
468 	    BASL_TABLE_ALIGNMENT));
469 
470 	memset(&fadt, 0, sizeof(fadt));
471 	BASL_EXEC(basl_table_append_header(table, ACPI_SIG_FADT, 5, 1));
472 	fadt.Facs = htole32(0); /* patched by basl */
473 	fadt.Dsdt = htole32(0); /* patched by basl */
474 	fadt.SciInterrupt = htole16(SCI_INT);
475 	fadt.SmiCommand = htole32(SMI_CMD);
476 	fadt.AcpiEnable = BHYVE_ACPI_ENABLE;
477 	fadt.AcpiDisable = BHYVE_ACPI_DISABLE;
478 	fadt.Pm1aEventBlock = htole32(PM1A_EVT_ADDR);
479 	fadt.Pm1aControlBlock = htole32(PM1A_CNT_ADDR);
480 	fadt.PmTimerBlock = htole32(IO_PMTMR);
481 	fadt.Gpe0Block = htole32(IO_GPE0_BLK);
482 	fadt.Pm1EventLength = 4;
483 	fadt.Pm1ControlLength = 2;
484 	fadt.PmTimerLength = 4;
485 	fadt.Gpe0BlockLength = IO_GPE0_LEN;
486 	fadt.Century = 0x32;
487 	fadt.BootFlags = htole16(ACPI_FADT_NO_VGA | ACPI_FADT_NO_ASPM);
488 	fadt.Flags = htole32(ACPI_FADT_WBINVD | ACPI_FADT_C1_SUPPORTED |
489 	    ACPI_FADT_SLEEP_BUTTON | ACPI_FADT_32BIT_TIMER |
490 	    ACPI_FADT_RESET_REGISTER | ACPI_FADT_HEADLESS |
491 	    ACPI_FADT_APIC_PHYSICAL);
492 	basl_fill_gas(&fadt.ResetRegister, ACPI_ADR_SPACE_SYSTEM_IO, 8, 0,
493 	    ACPI_GAS_ACCESS_WIDTH_BYTE, 0xCF9);
494 	fadt.ResetValue = 6;
495 	fadt.MinorRevision = 1;
496 	fadt.XFacs = htole64(0); /* patched by basl */
497 	fadt.XDsdt = htole64(0); /* patched by basl */
498 	basl_fill_gas(&fadt.XPm1aEventBlock, ACPI_ADR_SPACE_SYSTEM_IO, 0x20, 0,
499 	    ACPI_GAS_ACCESS_WIDTH_WORD, PM1A_EVT_ADDR);
500 	basl_fill_gas(&fadt.XPm1bEventBlock, ACPI_ADR_SPACE_SYSTEM_IO, 0, 0,
501 	    ACPI_GAS_ACCESS_WIDTH_UNDEFINED, 0);
502 	basl_fill_gas(&fadt.XPm1aControlBlock, ACPI_ADR_SPACE_SYSTEM_IO, 0x10,
503 	    0, ACPI_GAS_ACCESS_WIDTH_WORD, PM1A_CNT_ADDR);
504 	basl_fill_gas(&fadt.XPm1bControlBlock, ACPI_ADR_SPACE_SYSTEM_IO, 0, 0,
505 	    ACPI_GAS_ACCESS_WIDTH_UNDEFINED, 0);
506 	basl_fill_gas(&fadt.XPm2ControlBlock, ACPI_ADR_SPACE_SYSTEM_IO, 8, 0,
507 	    ACPI_GAS_ACCESS_WIDTH_UNDEFINED, 0);
508 	basl_fill_gas(&fadt.XPmTimerBlock, ACPI_ADR_SPACE_SYSTEM_IO, 0x20, 0,
509 	    ACPI_GAS_ACCESS_WIDTH_DWORD, IO_PMTMR);
510 	basl_fill_gas(&fadt.XGpe0Block, ACPI_ADR_SPACE_SYSTEM_IO,
511 	    IO_GPE0_LEN * 8, 0, ACPI_GAS_ACCESS_WIDTH_BYTE, IO_GPE0_BLK);
512 	basl_fill_gas(&fadt.XGpe1Block, ACPI_ADR_SPACE_SYSTEM_IO, 0, 0,
513 	    ACPI_GAS_ACCESS_WIDTH_UNDEFINED, 0);
514 	basl_fill_gas(&fadt.SleepControl, ACPI_ADR_SPACE_SYSTEM_IO, 8, 0,
515 	    ACPI_GAS_ACCESS_WIDTH_BYTE, 0);
516 	basl_fill_gas(&fadt.SleepStatus, ACPI_ADR_SPACE_SYSTEM_IO, 8, 0,
517 	    ACPI_GAS_ACCESS_WIDTH_BYTE, 0);
518 	BASL_EXEC(basl_table_append_content(table, &fadt, sizeof(fadt)));
519 
520 	BASL_EXEC(basl_table_add_pointer(table, ACPI_SIG_FACS,
521 	    offsetof(ACPI_TABLE_FADT, Facs), sizeof(fadt.Facs)));
522 	BASL_EXEC(basl_table_add_pointer(table, ACPI_SIG_DSDT,
523 	    offsetof(ACPI_TABLE_FADT, Dsdt), sizeof(fadt.Dsdt)));
524 	BASL_EXEC(basl_table_add_pointer(table, ACPI_SIG_FACS,
525 	    offsetof(ACPI_TABLE_FADT, XFacs), sizeof(fadt.XFacs)));
526 	BASL_EXEC(basl_table_add_pointer(table, ACPI_SIG_DSDT,
527 	    offsetof(ACPI_TABLE_FADT, XDsdt), sizeof(fadt.XDsdt)));
528 
529 	BASL_EXEC(basl_table_register_to_rsdt(table));
530 
531 	return (0);
532 }
533 
534 #ifdef __amd64__
535 static int
build_hpet(struct vmctx * const ctx)536 build_hpet(struct vmctx *const ctx)
537 {
538 	ACPI_TABLE_HPET hpet;
539 	struct basl_table *table;
540 	uint32_t hpet_capabilities;
541 	int err;
542 
543 	err = vm_get_hpet_capabilities(ctx, &hpet_capabilities);
544 	if (err != 0)
545 		return (err);
546 
547 	BASL_EXEC(basl_table_create(&table, ctx, ACPI_SIG_HPET,
548 	    BASL_TABLE_ALIGNMENT));
549 
550 	memset(&hpet, 0, sizeof(hpet));
551 	BASL_EXEC(basl_table_append_header(table, ACPI_SIG_HPET, 1, 1));
552 	hpet.Id = htole32(hpet_capabilities);
553 	basl_fill_gas(&hpet.Address, ACPI_ADR_SPACE_SYSTEM_MEMORY, 0, 0,
554 	    ACPI_GAS_ACCESS_WIDTH_LEGACY, BHYVE_ADDRESS_HPET);
555 	hpet.Flags = ACPI_HPET_PAGE_PROTECT4;
556 	BASL_EXEC(basl_table_append_content(table, &hpet, sizeof(hpet)));
557 
558 	BASL_EXEC(basl_table_register_to_rsdt(table));
559 
560 	return (0);
561 }
562 #endif
563 
564 static int
build_madt(struct vmctx * const ctx)565 build_madt(struct vmctx *const ctx)
566 {
567 	ACPI_TABLE_MADT madt;
568 	ACPI_MADT_LOCAL_APIC madt_lapic;
569 	ACPI_MADT_IO_APIC madt_ioapic;
570 	ACPI_MADT_INTERRUPT_OVERRIDE madt_irq_override;
571 	ACPI_MADT_LOCAL_APIC_NMI madt_lapic_nmi;
572 	struct basl_table *table;
573 
574 	BASL_EXEC(basl_table_create(&table, ctx, ACPI_SIG_MADT,
575 	    BASL_TABLE_ALIGNMENT));
576 
577 	memset(&madt, 0, sizeof(madt));
578 	BASL_EXEC(basl_table_append_header(table, ACPI_SIG_MADT, 1, 1));
579 	madt.Address = htole32(BHYVE_ADDRESS_LAPIC);
580 	madt.Flags = htole32(ACPI_MADT_PCAT_COMPAT);
581 	BASL_EXEC(basl_table_append_content(table, &madt, sizeof(madt)));
582 
583 	/* Local APIC for each CPU */
584 	for (int i = 0; i < basl_ncpu; ++i) {
585 		memset(&madt_lapic, 0, sizeof(madt_lapic));
586 		madt_lapic.Header.Type = ACPI_MADT_TYPE_LOCAL_APIC;
587 		madt_lapic.Header.Length = sizeof(madt_lapic);
588 		madt_lapic.ProcessorId = i;
589 		madt_lapic.Id = i;
590 		madt_lapic.LapicFlags = htole32(ACPI_MADT_ENABLED);
591 		BASL_EXEC(basl_table_append_bytes(table, &madt_lapic,
592 		    sizeof(madt_lapic)));
593 	}
594 
595 	/* I/O APIC */
596 	memset(&madt_ioapic, 0, sizeof(madt_ioapic));
597 	madt_ioapic.Header.Type = ACPI_MADT_TYPE_IO_APIC;
598 	madt_ioapic.Header.Length = sizeof(madt_ioapic);
599 	madt_ioapic.Address = htole32(BHYVE_ADDRESS_IOAPIC);
600 	BASL_EXEC(
601 	    basl_table_append_bytes(table, &madt_ioapic, sizeof(madt_ioapic)));
602 
603 	/* Legacy IRQ0 is connected to pin 2 of the I/O APIC */
604 	memset(&madt_irq_override, 0, sizeof(madt_irq_override));
605 	madt_irq_override.Header.Type = ACPI_MADT_TYPE_INTERRUPT_OVERRIDE;
606 	madt_irq_override.Header.Length = sizeof(madt_irq_override);
607 	madt_irq_override.GlobalIrq = htole32(2);
608 	madt_irq_override.IntiFlags = htole16(
609 	    ACPI_MADT_POLARITY_ACTIVE_HIGH | ACPI_MADT_TRIGGER_EDGE);
610 	BASL_EXEC(basl_table_append_bytes(table, &madt_irq_override,
611 	    sizeof(madt_irq_override)));
612 
613 	memset(&madt_irq_override, 0, sizeof(madt_irq_override));
614 	madt_irq_override.Header.Type = ACPI_MADT_TYPE_INTERRUPT_OVERRIDE;
615 	madt_irq_override.Header.Length = sizeof(madt_irq_override);
616 	madt_irq_override.SourceIrq = SCI_INT;
617 	madt_irq_override.GlobalIrq = htole32(SCI_INT);
618 	madt_irq_override.IntiFlags = htole16(
619 	    ACPI_MADT_POLARITY_ACTIVE_LOW | ACPI_MADT_TRIGGER_LEVEL);
620 	BASL_EXEC(basl_table_append_bytes(table, &madt_irq_override,
621 	    sizeof(madt_irq_override)));
622 
623 	/* Local APIC NMI is conntected to LINT 1 on all CPUs */
624 	memset(&madt_lapic_nmi, 0, sizeof(madt_lapic_nmi));
625 	madt_lapic_nmi.Header.Type = ACPI_MADT_TYPE_LOCAL_APIC_NMI;
626 	madt_lapic_nmi.Header.Length = sizeof(madt_lapic_nmi);
627 	madt_lapic_nmi.ProcessorId = 0xFF;
628 	madt_lapic_nmi.IntiFlags = htole16(
629 	    ACPI_MADT_POLARITY_ACTIVE_HIGH | ACPI_MADT_TRIGGER_EDGE);
630 	madt_lapic_nmi.Lint = 1;
631 	BASL_EXEC(basl_table_append_bytes(table, &madt_lapic_nmi,
632 	    sizeof(madt_lapic_nmi)));
633 
634 	BASL_EXEC(basl_table_register_to_rsdt(table));
635 
636 	return (0);
637 }
638 
639 static int
build_mcfg(struct vmctx * const ctx)640 build_mcfg(struct vmctx *const ctx)
641 {
642 	ACPI_TABLE_MCFG mcfg;
643 	ACPI_MCFG_ALLOCATION mcfg_allocation;
644 	struct basl_table *table;
645 
646 	BASL_EXEC(basl_table_create(&table, ctx, ACPI_SIG_MCFG,
647 	    BASL_TABLE_ALIGNMENT));
648 
649 	memset(&mcfg, 0, sizeof(mcfg));
650 	BASL_EXEC(basl_table_append_header(table, ACPI_SIG_MCFG, 1, 1));
651 	BASL_EXEC(basl_table_append_content(table, &mcfg, sizeof(mcfg)));
652 
653 	memset(&mcfg_allocation, 0, sizeof(mcfg_allocation));
654 	mcfg_allocation.Address = htole64(pci_ecfg_base());
655 	mcfg_allocation.EndBusNumber = 0xFF;
656 	BASL_EXEC(basl_table_append_bytes(table, &mcfg_allocation,
657 	    sizeof(mcfg_allocation)));
658 
659 	BASL_EXEC(basl_table_register_to_rsdt(table));
660 
661 	return (0);
662 }
663 
664 static int
build_rsdp(struct vmctx * const ctx)665 build_rsdp(struct vmctx *const ctx)
666 {
667 	ACPI_TABLE_RSDP rsdp;
668 	struct basl_table *table;
669 
670 	BASL_EXEC(basl_table_create(&table, ctx, ACPI_RSDP_NAME,
671 	    BASL_TABLE_ALIGNMENT));
672 
673 	memset(&rsdp, 0, sizeof(rsdp));
674 	memcpy(rsdp.Signature, ACPI_SIG_RSDP, 8);
675 	rsdp.Checksum = 0; /* patched by basl */
676 	memcpy(rsdp.OemId, "BHYVE ", ACPI_OEM_ID_SIZE);
677 	rsdp.Revision = 2;
678 	rsdp.RsdtPhysicalAddress = htole32(0); /* patched by basl */
679 	rsdp.Length = htole32(0);	       /* patched by basl */
680 	rsdp.XsdtPhysicalAddress = htole64(0); /* patched by basl */
681 	rsdp.ExtendedChecksum = 0;	       /* patched by basl */
682 	BASL_EXEC(basl_table_append_bytes(table, &rsdp, sizeof(rsdp)));
683 
684 	BASL_EXEC(basl_table_add_checksum(table,
685 	    offsetof(ACPI_TABLE_RSDP, Checksum), 0, 20));
686 	BASL_EXEC(basl_table_add_pointer(table, ACPI_SIG_RSDT,
687 	    offsetof(ACPI_TABLE_RSDP, RsdtPhysicalAddress),
688 	    sizeof(rsdp.RsdtPhysicalAddress)));
689 	BASL_EXEC(basl_table_add_length(table,
690 	    offsetof(ACPI_TABLE_RSDP, Length), sizeof(rsdp.Length)));
691 	BASL_EXEC(basl_table_add_pointer(table, ACPI_SIG_XSDT,
692 	    offsetof(ACPI_TABLE_RSDP, XsdtPhysicalAddress),
693 	    sizeof(rsdp.XsdtPhysicalAddress)));
694 	BASL_EXEC(basl_table_add_checksum(table,
695 	    offsetof(ACPI_TABLE_RSDP, ExtendedChecksum), 0,
696 	    BASL_TABLE_CHECKSUM_LEN_FULL_TABLE));
697 
698 	return (0);
699 }
700 
701 static int
build_spcr(struct vmctx * const ctx)702 build_spcr(struct vmctx *const ctx)
703 {
704 	ACPI_TABLE_SPCR spcr;
705 	struct basl_table *table;
706 
707 	BASL_EXEC(basl_table_create(&table, ctx, ACPI_SIG_SPCR,
708 	    BASL_TABLE_ALIGNMENT));
709 
710 	memset(&spcr, 0, sizeof(spcr));
711 	BASL_EXEC(basl_table_append_header(table, ACPI_SIG_SPCR, 1, 1));
712 	spcr.InterfaceType = ACPI_DBG2_16550_COMPATIBLE;
713 	basl_fill_gas(&spcr.SerialPort, ACPI_ADR_SPACE_SYSTEM_IO, 8, 0,
714 	    ACPI_GAS_ACCESS_WIDTH_LEGACY, 0x3F8);
715 	spcr.InterruptType = ACPI_SPCR_INTERRUPT_TYPE_8259;
716 	spcr.PcInterrupt = 4;
717 	spcr.BaudRate = ACPI_SPCR_BAUD_RATE_115200;
718 	spcr.Parity = ACPI_SPCR_PARITY_NO_PARITY;
719 	spcr.StopBits = ACPI_SPCR_STOP_BITS_1;
720 	spcr.FlowControl = 3; /* RTS/CTS | DCD */
721 	spcr.TerminalType = ACPI_SPCR_TERMINAL_TYPE_VT_UTF8;
722 	BASL_EXEC(basl_table_append_content(table, &spcr, sizeof(spcr)));
723 
724 	BASL_EXEC(basl_table_register_to_rsdt(table));
725 
726 	return (0);
727 }
728 
729 int
acpi_build(struct vmctx * ctx,int ncpu)730 acpi_build(struct vmctx *ctx, int ncpu)
731 {
732 	basl_ncpu = ncpu;
733 
734 	/*
735 	 * For debug, allow the user to have iasl compiler output sent
736 	 * to stdout rather than /dev/null
737 	 */
738 	if (getenv("BHYVE_ACPI_VERBOSE_IASL"))
739 		basl_verbose_iasl = 1;
740 
741 	/*
742 	 * Allow the user to keep the generated ASL files for debugging
743 	 * instead of deleting them following use
744 	 */
745 	if (getenv("BHYVE_ACPI_KEEPTMPS"))
746 		basl_keep_temps = 1;
747 
748 	BASL_EXEC(basl_init(ctx));
749 
750 	BASL_EXEC(basl_make_templates());
751 
752 	/*
753 	 * Generate ACPI tables and copy them into guest memory.
754 	 *
755 	 * According to UEFI Specification v6.3 chapter 5.1 the FADT should be
756 	 * the first table pointed to by XSDT. For that reason, build it as the
757 	 * first table after XSDT.
758 	 */
759 	BASL_EXEC(build_rsdp(ctx));
760 	BASL_EXEC(build_fadt(ctx));
761 	BASL_EXEC(build_madt(ctx));
762 #ifdef __amd64__
763 	BASL_EXEC(build_hpet(ctx));
764 #endif
765 	BASL_EXEC(build_mcfg(ctx));
766 	BASL_EXEC(build_facs(ctx));
767 	BASL_EXEC(build_spcr(ctx));
768 
769 	/* Build ACPI device-specific tables such as a TPM2 table. */
770 	const struct acpi_device_list_entry *entry;
771 	SLIST_FOREACH(entry, &acpi_devices, chain) {
772 		BASL_EXEC(acpi_device_build_table(entry->dev));
773 	}
774 
775 	BASL_EXEC(build_dsdt(ctx));
776 
777 	BASL_EXEC(basl_finish());
778 
779 	return (0);
780 }
781