acpi.c revision 259301
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: stable/10/usr.sbin/bhyve/acpi.c 259301 2013-12-13 06:59:18Z grehan $
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: stable/10/usr.sbin/bhyve/acpi.c 259301 2013-12-13 06:59:18Z grehan $");
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
85static int basl_keep_temps;
86static int basl_verbose_iasl;
87static int basl_ncpu;
88static 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 */
94static char basl_template[MAXPATHLEN];
95static char basl_stemplate[MAXPATHLEN];
96
97struct 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
109static int
110basl_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
135err_exit:
136	return (errno);
137}
138
139static int
140basl_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
171err_exit:
172	return (errno);
173}
174
175static int
176basl_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
207err_exit:
208	return (errno);
209}
210
211static int
212basl_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		/* iasl expects hex values for the proc and apic id's */
245		EFPRINTF(fp, "[0001]\t\tProcessor ID : %02x\n", i);
246		EFPRINTF(fp, "[0001]\t\tLocal Apic ID : %02x\n", i);
247		EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000001\n");
248		EFPRINTF(fp, "\t\t\tProcessor Enabled : 1\n");
249		EFPRINTF(fp, "\n");
250	}
251
252	/* Always a single IOAPIC entry, with ID ncpu+1 */
253	EFPRINTF(fp, "[0001]\t\tSubtable Type : 01\n");
254	EFPRINTF(fp, "[0001]\t\tLength : 0C\n");
255	/* iasl expects a hex value for the i/o apic id */
256	EFPRINTF(fp, "[0001]\t\tI/O Apic ID : %02x\n", 0);
257	EFPRINTF(fp, "[0001]\t\tReserved : 00\n");
258	EFPRINTF(fp, "[0004]\t\tAddress : fec00000\n");
259	EFPRINTF(fp, "[0004]\t\tInterrupt : 00000000\n");
260	EFPRINTF(fp, "\n");
261
262	/* Legacy IRQ0 is connected to pin 2 of the IOAPIC */
263	EFPRINTF(fp, "[0001]\t\tSubtable Type : 02\n");
264	EFPRINTF(fp, "[0001]\t\tLength : 0A\n");
265	EFPRINTF(fp, "[0001]\t\tBus : 00\n");
266	EFPRINTF(fp, "[0001]\t\tSource : 00\n");
267	EFPRINTF(fp, "[0004]\t\tInterrupt : 00000002\n");
268	EFPRINTF(fp, "[0002]\t\tFlags (decoded below) : 0005\n");
269	EFPRINTF(fp, "\t\t\tPolarity : 1\n");
270	EFPRINTF(fp, "\t\t\tTrigger Mode : 1\n");
271	EFPRINTF(fp, "\n");
272
273	EFPRINTF(fp, "[0001]\t\tSubtable Type : 02\n");
274	EFPRINTF(fp, "[0001]\t\tLength : 0A\n");
275	EFPRINTF(fp, "[0001]\t\tBus : 00\n");
276	EFPRINTF(fp, "[0001]\t\tSource : 09\n");
277	EFPRINTF(fp, "[0004]\t\tInterrupt : 00000009\n");
278	EFPRINTF(fp, "[0002]\t\tFlags (decoded below) : 0000\n");
279	EFPRINTF(fp, "\t\t\tPolarity : 0\n");
280	EFPRINTF(fp, "\t\t\tTrigger Mode : 0\n");
281	EFPRINTF(fp, "\n");
282
283	EFFLUSH(fp);
284
285	return (0);
286
287err_exit:
288	return (errno);
289}
290
291static int
292basl_fwrite_fadt(FILE *fp)
293{
294	int err;
295
296	err = 0;
297
298	EFPRINTF(fp, "/*\n");
299	EFPRINTF(fp, " * bhyve FADT template\n");
300	EFPRINTF(fp, " */\n");
301	EFPRINTF(fp, "[0004]\t\tSignature : \"FACP\"\n");
302	EFPRINTF(fp, "[0004]\t\tTable Length : 0000010C\n");
303	EFPRINTF(fp, "[0001]\t\tRevision : 05\n");
304	EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
305	EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
306	EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVFACP  \"\n");
307	EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
308	/* iasl will fill in the compiler ID/revision fields */
309	EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
310	EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
311	EFPRINTF(fp, "\n");
312
313	EFPRINTF(fp, "[0004]\t\tFACS Address : %08X\n",
314	    basl_acpi_base + FACS_OFFSET);
315	EFPRINTF(fp, "[0004]\t\tDSDT Address : %08X\n",
316	    basl_acpi_base + DSDT_OFFSET);
317	EFPRINTF(fp, "[0001]\t\tModel : 00\n");
318	EFPRINTF(fp, "[0001]\t\tPM Profile : 00 [Unspecified]\n");
319	EFPRINTF(fp, "[0002]\t\tSCI Interrupt : 0009\n");
320	EFPRINTF(fp, "[0004]\t\tSMI Command Port : 00000000\n");
321	EFPRINTF(fp, "[0001]\t\tACPI Enable Value : 00\n");
322	EFPRINTF(fp, "[0001]\t\tACPI Disable Value : 00\n");
323	EFPRINTF(fp, "[0001]\t\tS4BIOS Command : 00\n");
324	EFPRINTF(fp, "[0001]\t\tP-State Control : 00\n");
325	EFPRINTF(fp, "[0004]\t\tPM1A Event Block Address : 00000000\n");
326	EFPRINTF(fp, "[0004]\t\tPM1B Event Block Address : 00000000\n");
327	EFPRINTF(fp, "[0004]\t\tPM1A Control Block Address : 00000000\n");
328	EFPRINTF(fp, "[0004]\t\tPM1B Control Block Address : 00000000\n");
329	EFPRINTF(fp, "[0004]\t\tPM2 Control Block Address : 00000000\n");
330	EFPRINTF(fp, "[0004]\t\tPM Timer Block Address : %08X\n",
331		 BHYVE_PM_TIMER_ADDR);
332	EFPRINTF(fp, "[0004]\t\tGPE0 Block Address : 00000000\n");
333	EFPRINTF(fp, "[0004]\t\tGPE1 Block Address : 00000000\n");
334	EFPRINTF(fp, "[0001]\t\tPM1 Event Block Length : 04\n");
335	EFPRINTF(fp, "[0001]\t\tPM1 Control Block Length : 02\n");
336	EFPRINTF(fp, "[0001]\t\tPM2 Control Block Length : 00\n");
337	EFPRINTF(fp, "[0001]\t\tPM Timer Block Length : 04\n");
338	EFPRINTF(fp, "[0001]\t\tGPE0 Block Length : 00\n");
339	EFPRINTF(fp, "[0001]\t\tGPE1 Block Length : 00\n");
340	EFPRINTF(fp, "[0001]\t\tGPE1 Base Offset : 00\n");
341	EFPRINTF(fp, "[0001]\t\t_CST Support : 00\n");
342	EFPRINTF(fp, "[0002]\t\tC2 Latency : 0000\n");
343	EFPRINTF(fp, "[0002]\t\tC3 Latency : 0000\n");
344	EFPRINTF(fp, "[0002]\t\tCPU Cache Size : 0000\n");
345	EFPRINTF(fp, "[0002]\t\tCache Flush Stride : 0000\n");
346	EFPRINTF(fp, "[0001]\t\tDuty Cycle Offset : 00\n");
347	EFPRINTF(fp, "[0001]\t\tDuty Cycle Width : 00\n");
348	EFPRINTF(fp, "[0001]\t\tRTC Day Alarm Index : 00\n");
349	EFPRINTF(fp, "[0001]\t\tRTC Month Alarm Index : 00\n");
350	EFPRINTF(fp, "[0001]\t\tRTC Century Index : 00\n");
351	EFPRINTF(fp, "[0002]\t\tBoot Flags (decoded below) : 0000\n");
352	EFPRINTF(fp, "\t\t\tLegacy Devices Supported (V2) : 0\n");
353	EFPRINTF(fp, "\t\t\t8042 Present on ports 60/64 (V2) : 0\n");
354	EFPRINTF(fp, "\t\t\tVGA Not Present (V4) : 1\n");
355	EFPRINTF(fp, "\t\t\tMSI Not Supported (V4) : 0\n");
356	EFPRINTF(fp, "\t\t\tPCIe ASPM Not Supported (V4) : 1\n");
357	EFPRINTF(fp, "\t\t\tCMOS RTC Not Present (V5) : 0\n");
358	EFPRINTF(fp, "[0001]\t\tReserved : 00\n");
359	EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000000\n");
360	EFPRINTF(fp, "\t\t\tWBINVD instruction is operational (V1) : 1\n");
361	EFPRINTF(fp, "\t\t\tWBINVD flushes all caches (V1) : 0\n");
362	EFPRINTF(fp, "\t\t\tAll CPUs support C1 (V1) : 0\n");
363	EFPRINTF(fp, "\t\t\tC2 works on MP system (V1) : 0\n");
364	EFPRINTF(fp, "\t\t\tControl Method Power Button (V1) : 1\n");
365	EFPRINTF(fp, "\t\t\tControl Method Sleep Button (V1) : 1\n");
366	EFPRINTF(fp, "\t\t\tRTC wake not in fixed reg space (V1) : 0\n");
367	EFPRINTF(fp, "\t\t\tRTC can wake system from S4 (V1) : 0\n");
368	EFPRINTF(fp, "\t\t\t32-bit PM Timer (V1) : 1\n");
369	EFPRINTF(fp, "\t\t\tDocking Supported (V1) : 0\n");
370	EFPRINTF(fp, "\t\t\tReset Register Supported (V2) : 0\n");
371	EFPRINTF(fp, "\t\t\tSealed Case (V3) : 0\n");
372	EFPRINTF(fp, "\t\t\tHeadless - No Video (V3) : 1\n");
373	EFPRINTF(fp, "\t\t\tUse native instr after SLP_TYPx (V3) : 0\n");
374	EFPRINTF(fp, "\t\t\tPCIEXP_WAK Bits Supported (V4) : 0\n");
375	EFPRINTF(fp, "\t\t\tUse Platform Timer (V4) : 0\n");
376	EFPRINTF(fp, "\t\t\tRTC_STS valid on S4 wake (V4) : 0\n");
377	EFPRINTF(fp, "\t\t\tRemote Power-on capable (V4) : 0\n");
378	EFPRINTF(fp, "\t\t\tUse APIC Cluster Model (V4) : 0\n");
379	EFPRINTF(fp, "\t\t\tUse APIC Physical Destination Mode (V4) : 1\n");
380	EFPRINTF(fp, "\t\t\tHardware Reduced (V5) : 0\n");
381	EFPRINTF(fp, "\t\t\tLow Power S0 Idle (V5) : 0\n");
382	EFPRINTF(fp, "\n");
383
384	EFPRINTF(fp,
385	    "[0012]\t\tReset Register : [Generic Address Structure]\n");
386	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
387	EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
388	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
389	EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
390	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000001\n");
391	EFPRINTF(fp, "\n");
392
393	EFPRINTF(fp, "[0001]\t\tValue to cause reset : 00\n");
394	EFPRINTF(fp, "[0003]\t\tReserved : 000000\n");
395	EFPRINTF(fp, "[0008]\t\tFACS Address : 00000000%08X\n",
396	    basl_acpi_base + FACS_OFFSET);
397	EFPRINTF(fp, "[0008]\t\tDSDT Address : 00000000%08X\n",
398	    basl_acpi_base + DSDT_OFFSET);
399	EFPRINTF(fp,
400	    "[0012]\t\tPM1A Event Block : [Generic Address Structure]\n");
401	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
402	EFPRINTF(fp, "[0001]\t\tBit Width : 20\n");
403	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
404	EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 02 [Word Access:16]\n");
405	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000001\n");
406	EFPRINTF(fp, "\n");
407
408	EFPRINTF(fp,
409	    "[0012]\t\tPM1B Event Block : [Generic Address Structure]\n");
410	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
411	EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
412	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
413	EFPRINTF(fp,
414	    "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
415	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
416	EFPRINTF(fp, "\n");
417
418	EFPRINTF(fp,
419	    "[0012]\t\tPM1A Control Block : [Generic Address Structure]\n");
420	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
421	EFPRINTF(fp, "[0001]\t\tBit Width : 10\n");
422	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
423	EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 02 [Word Access:16]\n");
424	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000001\n");
425	EFPRINTF(fp, "\n");
426
427	EFPRINTF(fp,
428	    "[0012]\t\tPM1B Control Block : [Generic Address Structure]\n");
429	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
430	EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
431	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
432	EFPRINTF(fp,
433	    "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
434	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
435	EFPRINTF(fp, "\n");
436
437	EFPRINTF(fp,
438	    "[0012]\t\tPM2 Control Block : [Generic Address Structure]\n");
439	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
440	EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
441	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
442	EFPRINTF(fp,
443	    "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
444	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
445	EFPRINTF(fp, "\n");
446
447	/* Valid for bhyve */
448	EFPRINTF(fp,
449	    "[0012]\t\tPM Timer Block : [Generic Address Structure]\n");
450	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
451	EFPRINTF(fp, "[0001]\t\tBit Width : 32\n");
452	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
453	EFPRINTF(fp,
454	    "[0001]\t\tEncoded Access Width : 03 [DWord Access:32]\n");
455	EFPRINTF(fp, "[0008]\t\tAddress : 00000000%08X\n",
456	    BHYVE_PM_TIMER_ADDR);
457	EFPRINTF(fp, "\n");
458
459	EFPRINTF(fp, "[0012]\t\tGPE0 Block : [Generic Address Structure]\n");
460	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
461	EFPRINTF(fp, "[0001]\t\tBit Width : 80\n");
462	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
463	EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
464	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
465	EFPRINTF(fp, "\n");
466
467	EFPRINTF(fp, "[0012]\t\tGPE1 Block : [Generic Address Structure]\n");
468	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
469	EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
470	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
471	EFPRINTF(fp,
472	    "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
473	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
474	EFPRINTF(fp, "\n");
475
476	EFPRINTF(fp,
477	   "[0012]\t\tSleep Control Register : [Generic Address Structure]\n");
478	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
479	EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
480	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
481	EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
482	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
483	EFPRINTF(fp, "\n");
484
485	EFPRINTF(fp,
486	    "[0012]\t\tSleep Status Register : [Generic Address Structure]\n");
487	EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
488	EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
489	EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
490	EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
491	EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
492
493	EFFLUSH(fp);
494
495	return (0);
496
497err_exit:
498	return (errno);
499}
500
501static int
502basl_fwrite_facs(FILE *fp)
503{
504	int err;
505
506	err = 0;
507
508	EFPRINTF(fp, "/*\n");
509	EFPRINTF(fp, " * bhyve FACS template\n");
510	EFPRINTF(fp, " */\n");
511	EFPRINTF(fp, "[0004]\t\tSignature : \"FACS\"\n");
512	EFPRINTF(fp, "[0004]\t\tLength : 00000040\n");
513	EFPRINTF(fp, "[0004]\t\tHardware Signature : 00000000\n");
514	EFPRINTF(fp, "[0004]\t\t32 Firmware Waking Vector : 00000000\n");
515	EFPRINTF(fp, "[0004]\t\tGlobal Lock : 00000000\n");
516	EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000000\n");
517	EFPRINTF(fp, "\t\t\tS4BIOS Support Present : 0\n");
518	EFPRINTF(fp, "\t\t\t64-bit Wake Supported (V2) : 0\n");
519	EFPRINTF(fp,
520	    "[0008]\t\t64 Firmware Waking Vector : 0000000000000000\n");
521	EFPRINTF(fp, "[0001]\t\tVersion : 02\n");
522	EFPRINTF(fp, "[0003]\t\tReserved : 000000\n");
523	EFPRINTF(fp, "[0004]\t\tOspmFlags (decoded below) : 00000000\n");
524	EFPRINTF(fp, "\t\t\t64-bit Wake Env Required (V2) : 0\n");
525
526	EFFLUSH(fp);
527
528	return (0);
529
530err_exit:
531	return (errno);
532}
533
534static int
535basl_fwrite_dsdt(FILE *fp)
536{
537	int err;
538
539	err = 0;
540
541	EFPRINTF(fp, "/*\n");
542	EFPRINTF(fp, " * bhyve DSDT template\n");
543	EFPRINTF(fp, " */\n");
544	EFPRINTF(fp, "DefinitionBlock (\"bhyve_dsdt.aml\", \"DSDT\", 2,"
545		 "\"BHYVE \", \"BVDSDT  \", 0x00000001)\n");
546	EFPRINTF(fp, "{\n");
547	EFPRINTF(fp, "  Scope (_SB)\n");
548	EFPRINTF(fp, "  {\n");
549	EFPRINTF(fp, "    Device (PCI0)\n");
550	EFPRINTF(fp, "    {\n");
551	EFPRINTF(fp, "      Name (_HID, EisaId (\"PNP0A03\"))\n");
552	EFPRINTF(fp, "      Name (_ADR, Zero)\n");
553	EFPRINTF(fp, "      Name (_UID, One)\n");
554	EFPRINTF(fp, "      Name (_CRS, ResourceTemplate ()\n");
555	EFPRINTF(fp, "      {\n");
556	EFPRINTF(fp, "        WordBusNumber (ResourceProducer, MinFixed,"
557		 "MaxFixed, PosDecode,\n");
558	EFPRINTF(fp, "            0x0000,             // Granularity\n");
559	EFPRINTF(fp, "            0x0000,             // Range Minimum\n");
560	EFPRINTF(fp, "            0x00FF,             // Range Maximum\n");
561	EFPRINTF(fp, "            0x0000,             // Transl Offset\n");
562	EFPRINTF(fp, "            0x0100,             // Length\n");
563	EFPRINTF(fp, "            ,, )\n");
564	EFPRINTF(fp, "         IO (Decode16,\n");
565	EFPRINTF(fp, "            0x0CF8,             // Range Minimum\n");
566	EFPRINTF(fp, "            0x0CF8,             // Range Maximum\n");
567	EFPRINTF(fp, "            0x01,               // Alignment\n");
568	EFPRINTF(fp, "            0x08,               // Length\n");
569	EFPRINTF(fp, "            )\n");
570	EFPRINTF(fp, "         WordIO (ResourceProducer, MinFixed, MaxFixed,"
571		 "PosDecode, EntireRange,\n");
572	EFPRINTF(fp, "            0x0000,             // Granularity\n");
573	EFPRINTF(fp, "            0x0000,             // Range Minimum\n");
574	EFPRINTF(fp, "            0x0CF7,             // Range Maximum\n");
575	EFPRINTF(fp, "            0x0000,             // Transl Offset\n");
576	EFPRINTF(fp, "            0x0CF8,             // Length\n");
577	EFPRINTF(fp, "            ,, , TypeStatic)\n");
578	EFPRINTF(fp, "         WordIO (ResourceProducer, MinFixed, MaxFixed,"
579		 "PosDecode, EntireRange,\n");
580	EFPRINTF(fp, "            0x0000,             // Granularity\n");
581	EFPRINTF(fp, "            0x0D00,             // Range Minimum\n");
582	EFPRINTF(fp, "            0xFFFF,             // Range Maximum\n");
583	EFPRINTF(fp, "            0x0000,             // Transl Offset\n");
584	EFPRINTF(fp, "            0xF300,             // Length\n");
585	EFPRINTF(fp, "             ,, , TypeStatic)\n");
586	EFPRINTF(fp, "          })\n");
587	EFPRINTF(fp, "     }\n");
588	EFPRINTF(fp, "  }\n");
589	EFPRINTF(fp, "\n");
590	EFPRINTF(fp, "  Scope (_SB.PCI0)\n");
591	EFPRINTF(fp, "  {\n");
592	EFPRINTF(fp, "    Device (ISA)\n");
593	EFPRINTF(fp, "    {\n");
594	EFPRINTF(fp, "      Name (_ADR, 0x00010000)\n");
595	EFPRINTF(fp, "      OperationRegion (P40C, PCI_Config, 0x60, 0x04)\n");
596	EFPRINTF(fp, "    }\n");
597	EFPRINTF(fp, "  }\n");
598	EFPRINTF(fp, "\n");
599	EFPRINTF(fp, "  Scope (_SB.PCI0.ISA)\n");
600        EFPRINTF(fp, "  {\n");
601	EFPRINTF(fp, "    Device (RTC)\n");
602        EFPRINTF(fp, "    {\n");
603	EFPRINTF(fp, "      Name (_HID, EisaId (\"PNP0B00\"))\n");
604	EFPRINTF(fp, "      Name (_CRS, ResourceTemplate ()\n");
605	EFPRINTF(fp, "      {\n");
606	EFPRINTF(fp, "        IO (Decode16,\n");
607	EFPRINTF(fp, "            0x0070,             // Range Minimum\n");
608	EFPRINTF(fp, "            0x0070,             // Range Maximum\n");
609	EFPRINTF(fp, "            0x10,               // Alignment\n");
610	EFPRINTF(fp, "            0x02,               // Length\n");
611	EFPRINTF(fp, "            )\n");
612	EFPRINTF(fp, "        IRQNoFlags ()\n");
613	EFPRINTF(fp, "            {8}\n");
614	EFPRINTF(fp, "        IO (Decode16,\n");
615	EFPRINTF(fp, "            0x0072,             // Range Minimum\n");
616	EFPRINTF(fp, "            0x0072,             // Range Maximum\n");
617	EFPRINTF(fp, "            0x02,               // Alignment\n");
618	EFPRINTF(fp, "            0x06,               // Length\n");
619	EFPRINTF(fp, "            )\n");
620	EFPRINTF(fp, "      })\n");
621        EFPRINTF(fp, "    }\n");
622	EFPRINTF(fp, "  }\n");
623	EFPRINTF(fp, "}\n");
624
625	EFFLUSH(fp);
626
627	return (0);
628
629err_exit:
630	return (errno);
631}
632
633static int
634basl_open(struct basl_fio *bf, int suffix)
635{
636	int err;
637
638	err = 0;
639
640	if (suffix) {
641		strncpy(bf->f_name, basl_stemplate, MAXPATHLEN);
642		bf->fd = mkstemps(bf->f_name, strlen(BHYVE_ASL_SUFFIX));
643	} else {
644		strncpy(bf->f_name, basl_template, MAXPATHLEN);
645		bf->fd = mkstemp(bf->f_name);
646	}
647
648	if (bf->fd > 0) {
649		bf->fp = fdopen(bf->fd, "w+");
650		if (bf->fp == NULL) {
651			unlink(bf->f_name);
652			close(bf->fd);
653		}
654	} else {
655		err = 1;
656	}
657
658	return (err);
659}
660
661static void
662basl_close(struct basl_fio *bf)
663{
664
665	if (!basl_keep_temps)
666		unlink(bf->f_name);
667	fclose(bf->fp);
668}
669
670static int
671basl_start(struct basl_fio *in, struct basl_fio *out)
672{
673	int err;
674
675	err = basl_open(in, 0);
676	if (!err) {
677		err = basl_open(out, 1);
678		if (err) {
679			basl_close(in);
680		}
681	}
682
683	return (err);
684}
685
686static void
687basl_end(struct basl_fio *in, struct basl_fio *out)
688{
689
690	basl_close(in);
691	basl_close(out);
692}
693
694static int
695basl_load(struct vmctx *ctx, int fd, uint64_t off)
696{
697	struct stat sb;
698	void *gaddr;
699
700	if (fstat(fd, &sb) < 0)
701		return (errno);
702
703	gaddr = paddr_guest2host(ctx, basl_acpi_base + off, sb.st_size);
704	if (gaddr == NULL)
705		return (EFAULT);
706
707	if (read(fd, gaddr, sb.st_size) < 0)
708		return (errno);
709
710	return (0);
711}
712
713static int
714basl_compile(struct vmctx *ctx, int (*fwrite_section)(FILE *), uint64_t offset)
715{
716	struct basl_fio io[2];
717	static char iaslbuf[3*MAXPATHLEN + 10];
718	char *fmt;
719	int err;
720
721	err = basl_start(&io[0], &io[1]);
722	if (!err) {
723		err = (*fwrite_section)(io[0].fp);
724
725		if (!err) {
726			/*
727			 * iasl sends the results of the compilation to
728			 * stdout. Shut this down by using the shell to
729			 * redirect stdout to /dev/null, unless the user
730			 * has requested verbose output for debugging
731			 * purposes
732			 */
733			fmt = basl_verbose_iasl ?
734				"%s -p %s %s" :
735				"/bin/sh -c \"%s -p %s %s\" 1> /dev/null";
736
737			snprintf(iaslbuf, sizeof(iaslbuf),
738				 fmt,
739				 BHYVE_ASL_COMPILER,
740				 io[1].f_name, io[0].f_name);
741			err = system(iaslbuf);
742
743			if (!err) {
744				/*
745				 * Copy the aml output file into guest
746				 * memory at the specified location
747				 */
748				err = basl_load(ctx, io[1].fd, offset);
749			}
750		}
751		basl_end(&io[0], &io[1]);
752	}
753
754	return (err);
755}
756
757static int
758basl_make_templates(void)
759{
760	const char *tmpdir;
761	int err;
762	int len;
763
764	err = 0;
765
766	/*
767	 *
768	 */
769	if ((tmpdir = getenv("BHYVE_TMPDIR")) == NULL || *tmpdir == '\0' ||
770	    (tmpdir = getenv("TMPDIR")) == NULL || *tmpdir == '\0') {
771		tmpdir = _PATH_TMP;
772	}
773
774	len = strlen(tmpdir);
775
776	if ((len + sizeof(BHYVE_ASL_TEMPLATE) + 1) < MAXPATHLEN) {
777		strcpy(basl_template, tmpdir);
778		while (len > 0 && basl_template[len - 1] == '/')
779			len--;
780		basl_template[len] = '/';
781		strcpy(&basl_template[len + 1], BHYVE_ASL_TEMPLATE);
782	} else
783		err = E2BIG;
784
785	if (!err) {
786		/*
787		 * len has been intialized (and maybe adjusted) above
788		 */
789		if ((len + sizeof(BHYVE_ASL_TEMPLATE) + 1 +
790		     sizeof(BHYVE_ASL_SUFFIX)) < MAXPATHLEN) {
791			strcpy(basl_stemplate, tmpdir);
792			basl_stemplate[len] = '/';
793			strcpy(&basl_stemplate[len + 1], BHYVE_ASL_TEMPLATE);
794			len = strlen(basl_stemplate);
795			strcpy(&basl_stemplate[len], BHYVE_ASL_SUFFIX);
796		} else
797			err = E2BIG;
798	}
799
800	return (err);
801}
802
803static struct {
804	int	(*wsect)(FILE *fp);
805	uint64_t  offset;
806} basl_ftables[] =
807{
808	{ basl_fwrite_rsdp, 0},
809	{ basl_fwrite_rsdt, RSDT_OFFSET },
810	{ basl_fwrite_xsdt, XSDT_OFFSET },
811	{ basl_fwrite_madt, MADT_OFFSET },
812	{ basl_fwrite_fadt, FADT_OFFSET },
813	{ basl_fwrite_facs, FACS_OFFSET },
814	{ basl_fwrite_dsdt, DSDT_OFFSET },
815	{ NULL }
816};
817
818int
819acpi_build(struct vmctx *ctx, int ncpu)
820{
821	int err;
822	int i;
823
824	err = 0;
825	basl_ncpu = ncpu;
826
827	/*
828	 * For debug, allow the user to have iasl compiler output sent
829	 * to stdout rather than /dev/null
830	 */
831	if (getenv("BHYVE_ACPI_VERBOSE_IASL"))
832		basl_verbose_iasl = 1;
833
834	/*
835	 * Allow the user to keep the generated ASL files for debugging
836	 * instead of deleting them following use
837	 */
838	if (getenv("BHYVE_ACPI_KEEPTMPS"))
839		basl_keep_temps = 1;
840
841	i = 0;
842	err = basl_make_templates();
843
844	/*
845	 * Run through all the ASL files, compiling them and
846	 * copying them into guest memory
847	 */
848	while (!err && basl_ftables[i].wsect != NULL) {
849		err = basl_compile(ctx, basl_ftables[i].wsect,
850				   basl_ftables[i].offset);
851		i++;
852	}
853
854	return (err);
855}
856