xref: /freebsd/usr.sbin/bhyve/acpi.c (revision 06e8e46410776c1d2a28c89004cda266402a8e69)
1 /*-
2  * Copyright (c) 2012 NetApp, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
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) by writing out ASL template files for each of
34  * the tables and the compiling them to AML with the Intel iasl compiler.
35  * The AML files are then read into guest memory.
36  *
37  *  The tables are placed in the guest's ROM area just below 1MB physical,
38  * above the MPTable.
39  *
40  *  Layout
41  *  ------
42  *   RSDP  ->   0xf0400    (36 bytes fixed)
43  *     RSDT  ->   0xf0440    (36 bytes + 4*N table addrs, 2 used)
44  *     XSDT  ->   0xf0480    (36 bytes + 8*N table addrs, 2 used)
45  *       MADT  ->   0xf0500  (depends on #CPUs)
46  *       FADT  ->   0xf0600  (268 bytes)
47  *         FACS  ->   0xf0780 (64 bytes)
48  *         DSDT  ->   0xf0800 (variable - can go up to 0x100000)
49  */
50 
51 #include <sys/cdefs.h>
52 __FBSDID("$FreeBSD$");
53 
54 #include <sys/param.h>
55 #include <sys/errno.h>
56 #include <sys/stat.h>
57 
58 #include <paths.h>
59 #include <stdio.h>
60 #include <stdlib.h>
61 #include <string.h>
62 #include <unistd.h>
63 
64 #include "bhyverun.h"
65 #include "acpi.h"
66 
67 /*
68  * Define the base address of the ACPI tables, and the offsets to
69  * the individual tables
70  */
71 #define BHYVE_ACPI_BASE		0xf0400
72 #define RSDT_OFFSET		0x040
73 #define XSDT_OFFSET		0x080
74 #define MADT_OFFSET		0x100
75 #define FADT_OFFSET		0x200
76 #define FACS_OFFSET		0x380
77 #define DSDT_OFFSET		0x400
78 
79 #define	BHYVE_ASL_TEMPLATE	"bhyve.XXXXXXX"
80 #define BHYVE_ASL_SUFFIX	".aml"
81 #define BHYVE_ASL_COMPILER	"/usr/sbin/iasl"
82 
83 #define BHYVE_PM_TIMER_ADDR	0x408
84 
85 static int basl_keep_temps;
86 static int basl_verbose_iasl;
87 static int basl_ncpu;
88 static uint32_t basl_acpi_base = BHYVE_ACPI_BASE;
89 
90 /*
91  * Contains the full pathname of the template to be passed
92  * to mkstemp/mktemps(3)
93  */
94 static char basl_template[MAXPATHLEN];
95 static char basl_stemplate[MAXPATHLEN];
96 
97 struct basl_fio {
98 	int	fd;
99 	FILE	*fp;
100 	char	f_name[MAXPATHLEN];
101 };
102 
103 #define EFPRINTF(...) \
104 	err = fprintf(__VA_ARGS__); if (err < 0) goto err_exit;
105 
106 #define EFFLUSH(x) \
107 	err = fflush(x); if (err != 0) goto err_exit;
108 
109 static int
110 basl_fwrite_rsdp(FILE *fp)
111 {
112 	int err;
113 
114 	err = 0;
115 
116 	EFPRINTF(fp, "/*\n");
117 	EFPRINTF(fp, " * bhyve RSDP template\n");
118 	EFPRINTF(fp, " */\n");
119 	EFPRINTF(fp, "[0008]\t\tSignature : \"RSD PTR \"\n");
120 	EFPRINTF(fp, "[0001]\t\tChecksum : 43\n");
121 	EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
122 	EFPRINTF(fp, "[0001]\t\tRevision : 02\n");
123 	EFPRINTF(fp, "[0004]\t\tRSDT Address : %08X\n",
124 	    basl_acpi_base + RSDT_OFFSET);
125 	EFPRINTF(fp, "[0004]\t\tLength : 00000024\n");
126 	EFPRINTF(fp, "[0008]\t\tXSDT Address : 00000000%08X\n",
127 	    basl_acpi_base + XSDT_OFFSET);
128 	EFPRINTF(fp, "[0001]\t\tExtended Checksum : 00\n");
129 	EFPRINTF(fp, "[0003]\t\tReserved : 000000\n");
130 
131 	EFFLUSH(fp);
132 
133 	return (0);
134 
135 err_exit:
136 	return (errno);
137 }
138 
139 static int
140 basl_fwrite_rsdt(FILE *fp)
141 {
142 	int err;
143 
144 	err = 0;
145 
146 	EFPRINTF(fp, "/*\n");
147 	EFPRINTF(fp, " * bhyve RSDT template\n");
148 	EFPRINTF(fp, " */\n");
149 	EFPRINTF(fp, "[0004]\t\tSignature : \"RSDT\"\n");
150 	EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
151 	EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
152 	EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
153 	EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
154 	EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVRSDT  \"\n");
155 	EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
156 	/* iasl will fill in the compiler ID/revision fields */
157 	EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
158 	EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
159 	EFPRINTF(fp, "\n");
160 
161 	/* Add in pointers to the MADT and FADT */
162 	EFPRINTF(fp, "[0004]\t\tACPI Table Address 0 : %08X\n",
163 	    basl_acpi_base + MADT_OFFSET);
164 	EFPRINTF(fp, "[0004]\t\tACPI Table Address 1 : %08X\n",
165 	    basl_acpi_base + FADT_OFFSET);
166 
167 	EFFLUSH(fp);
168 
169 	return (0);
170 
171 err_exit:
172 	return (errno);
173 }
174 
175 static int
176 basl_fwrite_xsdt(FILE *fp)
177 {
178 	int err;
179 
180 	err = 0;
181 
182 	EFPRINTF(fp, "/*\n");
183 	EFPRINTF(fp, " * bhyve XSDT template\n");
184 	EFPRINTF(fp, " */\n");
185 	EFPRINTF(fp, "[0004]\t\tSignature : \"XSDT\"\n");
186 	EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
187 	EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
188 	EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
189 	EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
190 	EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVXSDT  \"\n");
191 	EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
192 	/* iasl will fill in the compiler ID/revision fields */
193 	EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
194 	EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
195 	EFPRINTF(fp, "\n");
196 
197 	/* Add in pointers to the MADT and FADT */
198 	EFPRINTF(fp, "[0004]\t\tACPI Table Address 0 : 00000000%08X\n",
199 	    basl_acpi_base + MADT_OFFSET);
200 	EFPRINTF(fp, "[0004]\t\tACPI Table Address 1 : 00000000%08X\n",
201 	    basl_acpi_base + FADT_OFFSET);
202 
203 	EFFLUSH(fp);
204 
205 	return (0);
206 
207 err_exit:
208 	return (errno);
209 }
210 
211 static int
212 basl_fwrite_madt(FILE *fp)
213 {
214 	int err;
215 	int i;
216 
217 	err = 0;
218 
219 	EFPRINTF(fp, "/*\n");
220 	EFPRINTF(fp, " * bhyve MADT template\n");
221 	EFPRINTF(fp, " */\n");
222 	EFPRINTF(fp, "[0004]\t\tSignature : \"APIC\"\n");
223 	EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
224 	EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
225 	EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
226 	EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
227 	EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVMADT  \"\n");
228 	EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
229 
230 	/* iasl will fill in the compiler ID/revision fields */
231 	EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
232 	EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
233 	EFPRINTF(fp, "\n");
234 
235 	EFPRINTF(fp, "[0004]\t\tLocal Apic Address : FEE00000\n");
236 	EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000001\n");
237 	EFPRINTF(fp, "\t\t\tPC-AT Compatibility : 1\n");
238 	EFPRINTF(fp, "\n");
239 
240 	/* Add a Processor Local APIC entry for each CPU */
241 	for (i = 0; i < basl_ncpu; i++) {
242 		EFPRINTF(fp, "[0001]\t\tSubtable Type : 00\n");
243 		EFPRINTF(fp, "[0001]\t\tLength : 08\n");
244 		EFPRINTF(fp, "[0001]\t\tProcessor ID : %02d\n", i);
245 		EFPRINTF(fp, "[0001]\t\tLocal Apic ID : %02d\n", i);
246 		EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000001\n");
247 		EFPRINTF(fp, "\t\t\tProcessor Enabled : 1\n");
248 		EFPRINTF(fp, "\n");
249 	}
250 
251 	/* Always a single IOAPIC entry, with ID ncpu+1 */
252 	EFPRINTF(fp, "[0001]\t\tSubtable Type : 01\n");
253 	EFPRINTF(fp, "[0001]\t\tLength : 0C\n");
254 	EFPRINTF(fp, "[0001]\t\tI/O Apic ID : %02d\n", basl_ncpu);
255 	EFPRINTF(fp, "[0001]\t\tReserved : 00\n");
256 	EFPRINTF(fp, "[0004]\t\tAddress : fec00000\n");
257 	EFPRINTF(fp, "[0004]\t\tInterrupt : 00000000\n");
258 	EFPRINTF(fp, "\n");
259 
260 	/* Override the 8259 chained vector. XXX maybe not needed */
261 	EFPRINTF(fp, "[0001]\t\tSubtable Type : 02\n");
262 	EFPRINTF(fp, "[0001]\t\tLength : 0A\n");
263 	EFPRINTF(fp, "[0001]\t\tBus : 00\n");
264 	EFPRINTF(fp, "[0001]\t\tSource : 09\n");
265 	EFPRINTF(fp, "[0004]\t\tInterrupt : 00000009\n");
266 	EFPRINTF(fp, "[0002]\t\tFlags (decoded below) : 0000\n");
267 	EFPRINTF(fp, "\t\t\tPolarity : 0\n");
268 	EFPRINTF(fp, "\t\t\tTrigger Mode : 0\n");
269 	EFPRINTF(fp, "\n");
270 
271 	EFFLUSH(fp);
272 
273 	return (0);
274 
275 err_exit:
276 	return (errno);
277 }
278 
279 static int
280 basl_fwrite_fadt(FILE *fp)
281 {
282 	int err;
283 
284 	err = 0;
285 
286 	EFPRINTF(fp, "/*\n");
287 	EFPRINTF(fp, " * bhyve FADT template\n");
288 	EFPRINTF(fp, " */\n");
289 	EFPRINTF(fp, "[0004]\t\tSignature : \"FACP\"\n");
290 	EFPRINTF(fp, "[0004]\t\tTable Length : 0000010C\n");
291 	EFPRINTF(fp, "[0001]\t\tRevision : 05\n");
292 	EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
293 	EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
294 	EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVFACP  \"\n");
295 	EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
296 	/* iasl will fill in the compiler ID/revision fields */
297 	EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
298 	EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
299 	EFPRINTF(fp, "\n");
300 
301 	EFPRINTF(fp, "[0004]\t\tFACS Address : %08X\n",
302 	    basl_acpi_base + FACS_OFFSET);
303 	EFPRINTF(fp, "[0004]\t\tDSDT Address : %08X\n",
304 	    basl_acpi_base + DSDT_OFFSET);
305 	EFPRINTF(fp, "[0001]\t\tModel : 00\n");
306 	EFPRINTF(fp, "[0001]\t\tPM Profile : 00 [Unspecified]\n");
307 	EFPRINTF(fp, "[0002]\t\tSCI Interrupt : 0009\n");
308 	EFPRINTF(fp, "[0004]\t\tSMI Command Port : 00000000\n");
309 	EFPRINTF(fp, "[0001]\t\tACPI Enable Value : 00\n");
310 	EFPRINTF(fp, "[0001]\t\tACPI Disable Value : 00\n");
311 	EFPRINTF(fp, "[0001]\t\tS4BIOS Command : 00\n");
312 	EFPRINTF(fp, "[0001]\t\tP-State Control : 00\n");
313 	EFPRINTF(fp, "[0004]\t\tPM1A Event Block Address : 00000000\n");
314 	EFPRINTF(fp, "[0004]\t\tPM1B Event Block Address : 00000000\n");
315 	EFPRINTF(fp, "[0004]\t\tPM1A Control Block Address : 00000000\n");
316 	EFPRINTF(fp, "[0004]\t\tPM1B Control Block Address : 00000000\n");
317 	EFPRINTF(fp, "[0004]\t\tPM2 Control Block Address : 00000000\n");
318 	EFPRINTF(fp, "[0004]\t\tPM Timer Block Address : %08X\n",
319 		 BHYVE_PM_TIMER_ADDR);
320 	EFPRINTF(fp, "[0004]\t\tGPE0 Block Address : 00000000\n");
321 	EFPRINTF(fp, "[0004]\t\tGPE1 Block Address : 00000000\n");
322 	EFPRINTF(fp, "[0001]\t\tPM1 Event Block Length : 04\n");
323 	EFPRINTF(fp, "[0001]\t\tPM1 Control Block Length : 02\n");
324 	EFPRINTF(fp, "[0001]\t\tPM2 Control Block Length : 00\n");
325 	EFPRINTF(fp, "[0001]\t\tPM Timer Block Length : 04\n");
326 	EFPRINTF(fp, "[0001]\t\tGPE0 Block Length : 00\n");
327 	EFPRINTF(fp, "[0001]\t\tGPE1 Block Length : 00\n");
328 	EFPRINTF(fp, "[0001]\t\tGPE1 Base Offset : 00\n");
329 	EFPRINTF(fp, "[0001]\t\t_CST Support : 00\n");
330 	EFPRINTF(fp, "[0002]\t\tC2 Latency : 0000\n");
331 	EFPRINTF(fp, "[0002]\t\tC3 Latency : 0000\n");
332 	EFPRINTF(fp, "[0002]\t\tCPU Cache Size : 0000\n");
333 	EFPRINTF(fp, "[0002]\t\tCache Flush Stride : 0000\n");
334 	EFPRINTF(fp, "[0001]\t\tDuty Cycle Offset : 00\n");
335 	EFPRINTF(fp, "[0001]\t\tDuty Cycle Width : 00\n");
336 	EFPRINTF(fp, "[0001]\t\tRTC Day Alarm Index : 00\n");
337 	EFPRINTF(fp, "[0001]\t\tRTC Month Alarm Index : 00\n");
338 	EFPRINTF(fp, "[0001]\t\tRTC Century Index : 00\n");
339 	EFPRINTF(fp, "[0002]\t\tBoot Flags (decoded below) : 0000\n");
340 	EFPRINTF(fp, "\t\t\tLegacy Devices Supported (V2) : 0\n");
341 	EFPRINTF(fp, "\t\t\t8042 Present on ports 60/64 (V2) : 0\n");
342 	EFPRINTF(fp, "\t\t\tVGA Not Present (V4) : 1\n");
343 	EFPRINTF(fp, "\t\t\tMSI Not Supported (V4) : 0\n");
344 	EFPRINTF(fp, "\t\t\tPCIe ASPM Not Supported (V4) : 1\n");
345 	EFPRINTF(fp, "\t\t\tCMOS RTC Not Present (V5) : 0\n");
346 	EFPRINTF(fp, "[0001]\t\tReserved : 00\n");
347 	EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000000\n");
348 	EFPRINTF(fp, "\t\t\tWBINVD instruction is operational (V1) : 1\n");
349 	EFPRINTF(fp, "\t\t\tWBINVD flushes all caches (V1) : 0\n");
350 	EFPRINTF(fp, "\t\t\tAll CPUs support C1 (V1) : 0\n");
351 	EFPRINTF(fp, "\t\t\tC2 works on MP system (V1) : 0\n");
352 	EFPRINTF(fp, "\t\t\tControl Method Power Button (V1) : 1\n");
353 	EFPRINTF(fp, "\t\t\tControl Method Sleep Button (V1) : 1\n");
354 	EFPRINTF(fp, "\t\t\tRTC wake not in fixed reg space (V1) : 0\n");
355 	EFPRINTF(fp, "\t\t\tRTC can wake system from S4 (V1) : 0\n");
356 	EFPRINTF(fp, "\t\t\t32-bit PM Timer (V1) : 1\n");
357 	EFPRINTF(fp, "\t\t\tDocking Supported (V1) : 0\n");
358 	EFPRINTF(fp, "\t\t\tReset Register Supported (V2) : 0\n");
359 	EFPRINTF(fp, "\t\t\tSealed Case (V3) : 0\n");
360 	EFPRINTF(fp, "\t\t\tHeadless - No Video (V3) : 1\n");
361 	EFPRINTF(fp, "\t\t\tUse native instr after SLP_TYPx (V3) : 0\n");
362 	EFPRINTF(fp, "\t\t\tPCIEXP_WAK Bits Supported (V4) : 0\n");
363 	EFPRINTF(fp, "\t\t\tUse Platform Timer (V4) : 0\n");
364 	EFPRINTF(fp, "\t\t\tRTC_STS valid on S4 wake (V4) : 0\n");
365 	EFPRINTF(fp, "\t\t\tRemote Power-on capable (V4) : 0\n");
366 	EFPRINTF(fp, "\t\t\tUse APIC Cluster Model (V4) : 0\n");
367 	EFPRINTF(fp, "\t\t\tUse APIC Physical Destination Mode (V4) : 1\n");
368 	EFPRINTF(fp, "\t\t\tHardware Reduced (V5) : 0\n");
369 	EFPRINTF(fp, "\t\t\tLow Power S0 Idle (V5) : 0\n");
370 	EFPRINTF(fp, "\n");
371 
372 	EFPRINTF(fp,
373 	    "[0012]\t\tReset Register : [Generic Address Structure]\n");
374 	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
375 	EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
376 	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
377 	EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
378 	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000001\n");
379 	EFPRINTF(fp, "\n");
380 
381 	EFPRINTF(fp, "[0001]\t\tValue to cause reset : 00\n");
382 	EFPRINTF(fp, "[0003]\t\tReserved : 000000\n");
383 	EFPRINTF(fp, "[0008]\t\tFACS Address : 00000000%08X\n",
384 	    basl_acpi_base + FACS_OFFSET);
385 	EFPRINTF(fp, "[0008]\t\tDSDT Address : 00000000%08X\n",
386 	    basl_acpi_base + DSDT_OFFSET);
387 	EFPRINTF(fp,
388 	    "[0012]\t\tPM1A Event Block : [Generic Address Structure]\n");
389 	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
390 	EFPRINTF(fp, "[0001]\t\tBit Width : 20\n");
391 	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
392 	EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 02 [Word Access:16]\n");
393 	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000001\n");
394 	EFPRINTF(fp, "\n");
395 
396 	EFPRINTF(fp,
397 	    "[0012]\t\tPM1B Event Block : [Generic Address Structure]\n");
398 	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
399 	EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
400 	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
401 	EFPRINTF(fp,
402 	    "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
403 	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
404 	EFPRINTF(fp, "\n");
405 
406 	EFPRINTF(fp,
407 	    "[0012]\t\tPM1A Control Block : [Generic Address Structure]\n");
408 	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
409 	EFPRINTF(fp, "[0001]\t\tBit Width : 10\n");
410 	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
411 	EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 02 [Word Access:16]\n");
412 	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000001\n");
413 	EFPRINTF(fp, "\n");
414 
415 	EFPRINTF(fp,
416 	    "[0012]\t\tPM1B Control Block : [Generic Address Structure]\n");
417 	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
418 	EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
419 	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
420 	EFPRINTF(fp,
421 	    "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
422 	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
423 	EFPRINTF(fp, "\n");
424 
425 	EFPRINTF(fp,
426 	    "[0012]\t\tPM2 Control Block : [Generic Address Structure]\n");
427 	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
428 	EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
429 	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
430 	EFPRINTF(fp,
431 	    "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
432 	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
433 	EFPRINTF(fp, "\n");
434 
435 	/* Valid for bhyve */
436 	EFPRINTF(fp,
437 	    "[0012]\t\tPM Timer Block : [Generic Address Structure]\n");
438 	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
439 	EFPRINTF(fp, "[0001]\t\tBit Width : 32\n");
440 	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
441 	EFPRINTF(fp,
442 	    "[0001]\t\tEncoded Access Width : 03 [DWord Access:32]\n");
443 	EFPRINTF(fp, "[0008]\t\tAddress : 00000000%08X\n",
444 	    BHYVE_PM_TIMER_ADDR);
445 	EFPRINTF(fp, "\n");
446 
447 	EFPRINTF(fp, "[0012]\t\tGPE0 Block : [Generic Address Structure]\n");
448 	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
449 	EFPRINTF(fp, "[0001]\t\tBit Width : 80\n");
450 	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
451 	EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
452 	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
453 	EFPRINTF(fp, "\n");
454 
455 	EFPRINTF(fp, "[0012]\t\tGPE1 Block : [Generic Address Structure]\n");
456 	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
457 	EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
458 	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
459 	EFPRINTF(fp,
460 	    "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
461 	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
462 	EFPRINTF(fp, "\n");
463 
464 	EFPRINTF(fp,
465 	   "[0012]\t\tSleep Control Register : [Generic Address Structure]\n");
466 	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
467 	EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
468 	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
469 	EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
470 	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
471 	EFPRINTF(fp, "\n");
472 
473 	EFPRINTF(fp,
474 	    "[0012]\t\tSleep Status Register : [Generic Address Structure]\n");
475 	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
476 	EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
477 	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
478 	EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
479 	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
480 
481 	EFFLUSH(fp);
482 
483 	return (0);
484 
485 err_exit:
486 	return (errno);
487 }
488 
489 static int
490 basl_fwrite_facs(FILE *fp)
491 {
492 	int err;
493 
494 	err = 0;
495 
496 	EFPRINTF(fp, "/*\n");
497 	EFPRINTF(fp, " * bhyve FACS template\n");
498 	EFPRINTF(fp, " */\n");
499 	EFPRINTF(fp, "[0004]\t\tSignature : \"FACS\"\n");
500 	EFPRINTF(fp, "[0004]\t\tLength : 00000040\n");
501 	EFPRINTF(fp, "[0004]\t\tHardware Signature : 00000000\n");
502 	EFPRINTF(fp, "[0004]\t\t32 Firmware Waking Vector : 00000000\n");
503 	EFPRINTF(fp, "[0004]\t\tGlobal Lock : 00000000\n");
504 	EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000000\n");
505 	EFPRINTF(fp, "\t\t\tS4BIOS Support Present : 0\n");
506 	EFPRINTF(fp, "\t\t\t64-bit Wake Supported (V2) : 0\n");
507 	EFPRINTF(fp,
508 	    "[0008]\t\t64 Firmware Waking Vector : 0000000000000000\n");
509 	EFPRINTF(fp, "[0001]\t\tVersion : 02\n");
510 	EFPRINTF(fp, "[0003]\t\tReserved : 000000\n");
511 	EFPRINTF(fp, "[0004]\t\tOspmFlags (decoded below) : 00000000\n");
512 	EFPRINTF(fp, "\t\t\t64-bit Wake Env Required (V2) : 0\n");
513 
514 	EFFLUSH(fp);
515 
516 	return (0);
517 
518 err_exit:
519 	return (errno);
520 }
521 
522 static int
523 basl_fwrite_dsdt(FILE *fp)
524 {
525 	int err;
526 
527 	err = 0;
528 
529 	EFPRINTF(fp, "/*\n");
530 	EFPRINTF(fp, " * bhyve DSDT template\n");
531 	EFPRINTF(fp, " */\n");
532 	EFPRINTF(fp, "DefinitionBlock (\"bhyve_dsdt.aml\", \"DSDT\", 2,"
533 		 "\"BHYVE \", \"BVDSDT  \", 0x00000001)\n");
534 	EFPRINTF(fp, "{\n");
535 	EFPRINTF(fp, "  Scope (_SB)\n");
536 	EFPRINTF(fp, "  {\n");
537 	EFPRINTF(fp, "    Device (PCI0)\n");
538 	EFPRINTF(fp, "    {\n");
539 	EFPRINTF(fp, "      Name (_HID, EisaId (\"PNP0A03\"))\n");
540 	EFPRINTF(fp, "      Name (_ADR, Zero)\n");
541 	EFPRINTF(fp, "      Name (_UID, One)\n");
542 	EFPRINTF(fp, "      Name (_CRS, ResourceTemplate ()\n");
543 	EFPRINTF(fp, "      {\n");
544 	EFPRINTF(fp, "        WordBusNumber (ResourceProducer, MinFixed,"
545 		 "MaxFixed, PosDecode,\n");
546 	EFPRINTF(fp, "            0x0000,             // Granularity\n");
547 	EFPRINTF(fp, "            0x0000,             // Range Minimum\n");
548 	EFPRINTF(fp, "            0x00FF,             // Range Maximum\n");
549 	EFPRINTF(fp, "            0x0000,             // Transl Offset\n");
550 	EFPRINTF(fp, "            0x0100,             // Length\n");
551 	EFPRINTF(fp, "            ,, )\n");
552 	EFPRINTF(fp, "         IO (Decode16,\n");
553 	EFPRINTF(fp, "            0x0CF8,             // Range Minimum\n");
554 	EFPRINTF(fp, "            0x0CF8,             // Range Maximum\n");
555 	EFPRINTF(fp, "            0x01,               // Alignment\n");
556 	EFPRINTF(fp, "            0x08,               // Length\n");
557 	EFPRINTF(fp, "            )\n");
558 	EFPRINTF(fp, "         WordIO (ResourceProducer, MinFixed, MaxFixed,"
559 		 "PosDecode, EntireRange,\n");
560 	EFPRINTF(fp, "            0x0000,             // Granularity\n");
561 	EFPRINTF(fp, "            0x0000,             // Range Minimum\n");
562 	EFPRINTF(fp, "            0x0CF7,             // Range Maximum\n");
563 	EFPRINTF(fp, "            0x0000,             // Transl Offset\n");
564 	EFPRINTF(fp, "            0x0CF8,             // Length\n");
565 	EFPRINTF(fp, "            ,, , TypeStatic)\n");
566 	EFPRINTF(fp, "         WordIO (ResourceProducer, MinFixed, MaxFixed,"
567 		 "PosDecode, EntireRange,\n");
568 	EFPRINTF(fp, "            0x0000,             // Granularity\n");
569 	EFPRINTF(fp, "            0x0D00,             // Range Minimum\n");
570 	EFPRINTF(fp, "            0xFFFF,             // Range Maximum\n");
571 	EFPRINTF(fp, "            0x0000,             // Transl Offset\n");
572 	EFPRINTF(fp, "            0xF300,             // Length\n");
573 	EFPRINTF(fp, "             ,, , TypeStatic)\n");
574 	EFPRINTF(fp, "          })\n");
575 	EFPRINTF(fp, "     }\n");
576 	EFPRINTF(fp, "  }\n");
577 	EFPRINTF(fp, "\n");
578 	EFPRINTF(fp, "  Scope (_SB.PCI0)\n");
579 	EFPRINTF(fp, "  {\n");
580 	EFPRINTF(fp, "    Device (ISA)\n");
581 	EFPRINTF(fp, "    {\n");
582 	EFPRINTF(fp, "      Name (_ADR, 0x00010000)\n");
583 	EFPRINTF(fp, "      OperationRegion (P40C, PCI_Config, 0x60, 0x04)\n");
584 	EFPRINTF(fp, "    }\n");
585 	EFPRINTF(fp, "  }\n");
586 	EFPRINTF(fp, "\n");
587 	EFPRINTF(fp, "  Scope (_SB.PCI0.ISA)\n");
588         EFPRINTF(fp, "  {\n");
589 	EFPRINTF(fp, "    Device (RTC)\n");
590         EFPRINTF(fp, "    {\n");
591 	EFPRINTF(fp, "      Name (_HID, EisaId (\"PNP0B00\"))\n");
592 	EFPRINTF(fp, "      Name (_CRS, ResourceTemplate ()\n");
593 	EFPRINTF(fp, "      {\n");
594 	EFPRINTF(fp, "        IO (Decode16,\n");
595 	EFPRINTF(fp, "            0x0070,             // Range Minimum\n");
596 	EFPRINTF(fp, "            0x0070,             // Range Maximum\n");
597 	EFPRINTF(fp, "            0x10,               // Alignment\n");
598 	EFPRINTF(fp, "            0x02,               // Length\n");
599 	EFPRINTF(fp, "            )\n");
600 	EFPRINTF(fp, "        IRQNoFlags ()\n");
601 	EFPRINTF(fp, "            {8}\n");
602 	EFPRINTF(fp, "        IO (Decode16,\n");
603 	EFPRINTF(fp, "            0x0072,             // Range Minimum\n");
604 	EFPRINTF(fp, "            0x0072,             // Range Maximum\n");
605 	EFPRINTF(fp, "            0x02,               // Alignment\n");
606 	EFPRINTF(fp, "            0x06,               // Length\n");
607 	EFPRINTF(fp, "            )\n");
608 	EFPRINTF(fp, "      })\n");
609         EFPRINTF(fp, "    }\n");
610 	EFPRINTF(fp, "  }\n");
611 	EFPRINTF(fp, "}\n");
612 
613 	EFFLUSH(fp);
614 
615 	return (0);
616 
617 err_exit:
618 	return (errno);
619 }
620 
621 static int
622 basl_open(struct basl_fio *bf, int suffix)
623 {
624 	int err;
625 
626 	err = 0;
627 
628 	if (suffix) {
629 		strncpy(bf->f_name, basl_stemplate, MAXPATHLEN);
630 		bf->fd = mkstemps(bf->f_name, strlen(BHYVE_ASL_SUFFIX));
631 	} else {
632 		strncpy(bf->f_name, basl_template, MAXPATHLEN);
633 		bf->fd = mkstemp(bf->f_name);
634 	}
635 
636 	if (bf->fd > 0) {
637 		bf->fp = fdopen(bf->fd, "w+");
638 		if (bf->fp == NULL) {
639 			unlink(bf->f_name);
640 			close(bf->fd);
641 		}
642 	} else {
643 		err = 1;
644 	}
645 
646 	return (err);
647 }
648 
649 static void
650 basl_close(struct basl_fio *bf)
651 {
652 
653 	if (!basl_keep_temps)
654 		unlink(bf->f_name);
655 	fclose(bf->fp);
656 }
657 
658 static int
659 basl_start(struct basl_fio *in, struct basl_fio *out)
660 {
661 	int err;
662 
663 	err = basl_open(in, 0);
664 	if (!err) {
665 		err = basl_open(out, 1);
666 		if (err) {
667 			basl_close(in);
668 		}
669 	}
670 
671 	return (err);
672 }
673 
674 static void
675 basl_end(struct basl_fio *in, struct basl_fio *out)
676 {
677 
678 	basl_close(in);
679 	basl_close(out);
680 }
681 
682 static int
683 basl_load(struct vmctx *ctx, int fd, uint64_t off)
684 {
685 	struct stat sb;
686 	void *gaddr;
687 
688 	if (fstat(fd, &sb) < 0)
689 		return (errno);
690 
691 	gaddr = paddr_guest2host(ctx, basl_acpi_base + off, sb.st_size);
692 	if (gaddr == NULL)
693 		return (EFAULT);
694 
695 	if (read(fd, gaddr, sb.st_size) < 0)
696 		return (errno);
697 
698 	return (0);
699 }
700 
701 static int
702 basl_compile(struct vmctx *ctx, int (*fwrite_section)(FILE *), uint64_t offset)
703 {
704 	struct basl_fio io[2];
705 	static char iaslbuf[3*MAXPATHLEN + 10];
706 	char *fmt;
707 	int err;
708 
709 	err = basl_start(&io[0], &io[1]);
710 	if (!err) {
711 		err = (*fwrite_section)(io[0].fp);
712 
713 		if (!err) {
714 			/*
715 			 * iasl sends the results of the compilation to
716 			 * stdout. Shut this down by using the shell to
717 			 * redirect stdout to /dev/null, unless the user
718 			 * has requested verbose output for debugging
719 			 * purposes
720 			 */
721 			fmt = basl_verbose_iasl ?
722 				"%s -p %s %s" :
723 				"/bin/sh -c \"%s -p %s %s\" 1> /dev/null";
724 
725 			snprintf(iaslbuf, sizeof(iaslbuf),
726 				 fmt,
727 				 BHYVE_ASL_COMPILER,
728 				 io[1].f_name, io[0].f_name);
729 			err = system(iaslbuf);
730 
731 			if (!err) {
732 				/*
733 				 * Copy the aml output file into guest
734 				 * memory at the specified location
735 				 */
736 				err = basl_load(ctx, io[1].fd, offset);
737 			}
738 		}
739 		basl_end(&io[0], &io[1]);
740 	}
741 
742 	return (err);
743 }
744 
745 static int
746 basl_make_templates(void)
747 {
748 	const char *tmpdir;
749 	int err;
750 	int len;
751 
752 	err = 0;
753 
754 	/*
755 	 *
756 	 */
757 	if ((tmpdir = getenv("BHYVE_TMPDIR")) == NULL || *tmpdir == '\0' ||
758 	    (tmpdir = getenv("TMPDIR")) == NULL || *tmpdir == '\0') {
759 		tmpdir = _PATH_TMP;
760 	}
761 
762 	len = strlen(tmpdir);
763 
764 	if ((len + sizeof(BHYVE_ASL_TEMPLATE) + 1) < MAXPATHLEN) {
765 		strcpy(basl_template, tmpdir);
766 		while (len > 0 && basl_template[len - 1] == '/')
767 			len--;
768 		basl_template[len] = '/';
769 		strcpy(&basl_template[len + 1], BHYVE_ASL_TEMPLATE);
770 	} else
771 		err = E2BIG;
772 
773 	if (!err) {
774 		/*
775 		 * len has been intialized (and maybe adjusted) above
776 		 */
777 		if ((len + sizeof(BHYVE_ASL_TEMPLATE) + 1 +
778 		     sizeof(BHYVE_ASL_SUFFIX)) < MAXPATHLEN) {
779 			strcpy(basl_stemplate, tmpdir);
780 			basl_stemplate[len] = '/';
781 			strcpy(&basl_stemplate[len + 1], BHYVE_ASL_TEMPLATE);
782 			len = strlen(basl_stemplate);
783 			strcpy(&basl_stemplate[len], BHYVE_ASL_SUFFIX);
784 		} else
785 			err = E2BIG;
786 	}
787 
788 	return (err);
789 }
790 
791 static struct {
792 	int	(*wsect)(FILE *fp);
793 	uint64_t  offset;
794 } basl_ftables[] =
795 {
796 	{ basl_fwrite_rsdp, 0},
797 	{ basl_fwrite_rsdt, RSDT_OFFSET },
798 	{ basl_fwrite_xsdt, XSDT_OFFSET },
799 	{ basl_fwrite_madt, MADT_OFFSET },
800 	{ basl_fwrite_fadt, FADT_OFFSET },
801 	{ basl_fwrite_facs, FACS_OFFSET },
802 	{ basl_fwrite_dsdt, DSDT_OFFSET },
803 	{ NULL }
804 };
805 
806 int
807 acpi_build(struct vmctx *ctx, int ncpu, int ioapic)
808 {
809 	int err;
810 	int i;
811 
812 	err = 0;
813 	basl_ncpu = ncpu;
814 
815 	if (!ioapic) {
816 		fprintf(stderr, "ACPI tables require an ioapic\n");
817 		return (EINVAL);
818 	}
819 
820 	/*
821 	 * For debug, allow the user to have iasl compiler output sent
822 	 * to stdout rather than /dev/null
823 	 */
824 	if (getenv("BHYVE_ACPI_VERBOSE_IASL"))
825 		basl_verbose_iasl = 1;
826 
827 	/*
828 	 * Allow the user to keep the generated ASL files for debugging
829 	 * instead of deleting them following use
830 	 */
831 	if (getenv("BHYVE_ACPI_KEEPTMPS"))
832 		basl_keep_temps = 1;
833 
834 	i = 0;
835 	err = basl_make_templates();
836 
837 	/*
838 	 * Run through all the ASL files, compiling them and
839 	 * copying them into guest memory
840 	 */
841 	while (!err && basl_ftables[i].wsect != NULL) {
842 		err = basl_compile(ctx, basl_ftables[i].wsect,
843 				   basl_ftables[i].offset);
844 		i++;
845 	}
846 
847 	return (err);
848 }
849