]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - usr.sbin/bhyve/acpi.c
Catch up with ACPICA 20190215.
[FreeBSD/FreeBSD.git] / usr.sbin / bhyve / acpi.c
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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  * $FreeBSD$
29  */
30
31 /*
32  * bhyve ACPI table generator.
33  *
34  * Create the minimal set of ACPI tables required to boot FreeBSD (and
35  * hopefully other o/s's) by writing out ASL template files for each of
36  * the tables and the compiling them to AML with the Intel iasl compiler.
37  * The AML files are then read into guest memory.
38  *
39  *  The tables are placed in the guest's ROM area just below 1MB physical,
40  * above the MPTable.
41  *
42  *  Layout
43  *  ------
44  *   RSDP  ->   0xf2400    (36 bytes fixed)
45  *     RSDT  ->   0xf2440    (36 bytes + 4*7 table addrs, 4 used)
46  *     XSDT  ->   0xf2480    (36 bytes + 8*7 table addrs, 4 used)
47  *       MADT  ->   0xf2500  (depends on #CPUs)
48  *       FADT  ->   0xf2600  (268 bytes)
49  *       HPET  ->   0xf2740  (56 bytes)
50  *       MCFG  ->   0xf2780  (60 bytes)
51  *         FACS  ->   0xf27C0 (64 bytes)
52  *         DSDT  ->   0xf2800 (variable - can go up to 0x100000)
53  */
54
55 #include <sys/cdefs.h>
56 __FBSDID("$FreeBSD$");
57
58 #include <sys/param.h>
59 #include <sys/errno.h>
60 #include <sys/stat.h>
61
62 #include <paths.h>
63 #include <stdarg.h>
64 #include <stdio.h>
65 #include <stdlib.h>
66 #include <string.h>
67 #include <unistd.h>
68
69 #include <machine/vmm.h>
70 #include <vmmapi.h>
71
72 #include "bhyverun.h"
73 #include "acpi.h"
74 #include "pci_emul.h"
75
76 /*
77  * Define the base address of the ACPI tables, and the offsets to
78  * the individual tables
79  */
80 #define BHYVE_ACPI_BASE         0xf2400
81 #define RSDT_OFFSET             0x040
82 #define XSDT_OFFSET             0x080
83 #define MADT_OFFSET             0x100
84 #define FADT_OFFSET             0x200
85 #define HPET_OFFSET             0x340
86 #define MCFG_OFFSET             0x380
87 #define FACS_OFFSET             0x3C0
88 #define DSDT_OFFSET             0x400
89
90 #define BHYVE_ASL_TEMPLATE      "bhyve.XXXXXXX"
91 #define BHYVE_ASL_SUFFIX        ".aml"
92 #define BHYVE_ASL_COMPILER      "/usr/sbin/iasl"
93
94 static int basl_keep_temps;
95 static int basl_verbose_iasl;
96 static int basl_ncpu;
97 static uint32_t basl_acpi_base = BHYVE_ACPI_BASE;
98 static uint32_t hpet_capabilities;
99
100 /*
101  * Contains the full pathname of the template to be passed
102  * to mkstemp/mktemps(3)
103  */
104 static char basl_template[MAXPATHLEN];
105 static char basl_stemplate[MAXPATHLEN];
106
107 /*
108  * State for dsdt_line(), dsdt_indent(), and dsdt_unindent().
109  */
110 static FILE *dsdt_fp;
111 static int dsdt_indent_level;
112 static int dsdt_error;
113
114 struct basl_fio {
115         int     fd;
116         FILE    *fp;
117         char    f_name[MAXPATHLEN];
118 };
119
120 #define EFPRINTF(...) \
121         if (fprintf(__VA_ARGS__) < 0) goto err_exit;
122
123 #define EFFLUSH(x) \
124         if (fflush(x) != 0) goto err_exit;
125
126 static int
127 basl_fwrite_rsdp(FILE *fp)
128 {
129         EFPRINTF(fp, "/*\n");
130         EFPRINTF(fp, " * bhyve RSDP template\n");
131         EFPRINTF(fp, " */\n");
132         EFPRINTF(fp, "[0008]\t\tSignature : \"RSD PTR \"\n");
133         EFPRINTF(fp, "[0001]\t\tChecksum : 43\n");
134         EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
135         EFPRINTF(fp, "[0001]\t\tRevision : 02\n");
136         EFPRINTF(fp, "[0004]\t\tRSDT Address : %08X\n",
137             basl_acpi_base + RSDT_OFFSET);
138         EFPRINTF(fp, "[0004]\t\tLength : 00000024\n");
139         EFPRINTF(fp, "[0008]\t\tXSDT Address : 00000000%08X\n",
140             basl_acpi_base + XSDT_OFFSET);
141         EFPRINTF(fp, "[0001]\t\tExtended Checksum : 00\n");
142         EFPRINTF(fp, "[0003]\t\tReserved : 000000\n");
143
144         EFFLUSH(fp);
145
146         return (0);
147
148 err_exit:
149         return (errno);
150 }
151
152 static int
153 basl_fwrite_rsdt(FILE *fp)
154 {
155         EFPRINTF(fp, "/*\n");
156         EFPRINTF(fp, " * bhyve RSDT template\n");
157         EFPRINTF(fp, " */\n");
158         EFPRINTF(fp, "[0004]\t\tSignature : \"RSDT\"\n");
159         EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
160         EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
161         EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
162         EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
163         EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVRSDT  \"\n");
164         EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
165         /* iasl will fill in the compiler ID/revision fields */
166         EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
167         EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
168         EFPRINTF(fp, "\n");
169
170         /* Add in pointers to the MADT, FADT and HPET */
171         EFPRINTF(fp, "[0004]\t\tACPI Table Address 0 : %08X\n",
172             basl_acpi_base + MADT_OFFSET);
173         EFPRINTF(fp, "[0004]\t\tACPI Table Address 1 : %08X\n",
174             basl_acpi_base + FADT_OFFSET);
175         EFPRINTF(fp, "[0004]\t\tACPI Table Address 2 : %08X\n",
176             basl_acpi_base + HPET_OFFSET);
177         EFPRINTF(fp, "[0004]\t\tACPI Table Address 3 : %08X\n",
178             basl_acpi_base + MCFG_OFFSET);
179
180         EFFLUSH(fp);
181
182         return (0);
183
184 err_exit:
185         return (errno);
186 }
187
188 static int
189 basl_fwrite_xsdt(FILE *fp)
190 {
191         EFPRINTF(fp, "/*\n");
192         EFPRINTF(fp, " * bhyve XSDT template\n");
193         EFPRINTF(fp, " */\n");
194         EFPRINTF(fp, "[0004]\t\tSignature : \"XSDT\"\n");
195         EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
196         EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
197         EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
198         EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
199         EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVXSDT  \"\n");
200         EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
201         /* iasl will fill in the compiler ID/revision fields */
202         EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
203         EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
204         EFPRINTF(fp, "\n");
205
206         /* Add in pointers to the MADT, FADT and HPET */
207         EFPRINTF(fp, "[0004]\t\tACPI Table Address 0 : 00000000%08X\n",
208             basl_acpi_base + MADT_OFFSET);
209         EFPRINTF(fp, "[0004]\t\tACPI Table Address 1 : 00000000%08X\n",
210             basl_acpi_base + FADT_OFFSET);
211         EFPRINTF(fp, "[0004]\t\tACPI Table Address 2 : 00000000%08X\n",
212             basl_acpi_base + HPET_OFFSET);
213         EFPRINTF(fp, "[0004]\t\tACPI Table Address 3 : 00000000%08X\n",
214             basl_acpi_base + MCFG_OFFSET);
215
216         EFFLUSH(fp);
217
218         return (0);
219
220 err_exit:
221         return (errno);
222 }
223
224 static int
225 basl_fwrite_madt(FILE *fp)
226 {
227         int i;
228
229         EFPRINTF(fp, "/*\n");
230         EFPRINTF(fp, " * bhyve MADT template\n");
231         EFPRINTF(fp, " */\n");
232         EFPRINTF(fp, "[0004]\t\tSignature : \"APIC\"\n");
233         EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
234         EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
235         EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
236         EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
237         EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVMADT  \"\n");
238         EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
239
240         /* iasl will fill in the compiler ID/revision fields */
241         EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
242         EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
243         EFPRINTF(fp, "\n");
244
245         EFPRINTF(fp, "[0004]\t\tLocal Apic Address : FEE00000\n");
246         EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000001\n");
247         EFPRINTF(fp, "\t\t\tPC-AT Compatibility : 1\n");
248         EFPRINTF(fp, "\n");
249
250         /* Add a Processor Local APIC entry for each CPU */
251         for (i = 0; i < basl_ncpu; i++) {
252                 EFPRINTF(fp, "[0001]\t\tSubtable Type : 00\n");
253                 EFPRINTF(fp, "[0001]\t\tLength : 08\n");
254                 /* iasl expects hex values for the proc and apic id's */
255                 EFPRINTF(fp, "[0001]\t\tProcessor ID : %02x\n", i);
256                 EFPRINTF(fp, "[0001]\t\tLocal Apic ID : %02x\n", i);
257                 EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000001\n");
258                 EFPRINTF(fp, "\t\t\tProcessor Enabled : 1\n");
259                 EFPRINTF(fp, "\t\t\tRuntime Online Capable : 0\n");
260                 EFPRINTF(fp, "\n");
261         }
262
263         /* Always a single IOAPIC entry, with ID 0 */
264         EFPRINTF(fp, "[0001]\t\tSubtable Type : 01\n");
265         EFPRINTF(fp, "[0001]\t\tLength : 0C\n");
266         /* iasl expects a hex value for the i/o apic id */
267         EFPRINTF(fp, "[0001]\t\tI/O Apic ID : %02x\n", 0);
268         EFPRINTF(fp, "[0001]\t\tReserved : 00\n");
269         EFPRINTF(fp, "[0004]\t\tAddress : fec00000\n");
270         EFPRINTF(fp, "[0004]\t\tInterrupt : 00000000\n");
271         EFPRINTF(fp, "\n");
272
273         /* Legacy IRQ0 is connected to pin 2 of the IOAPIC */
274         EFPRINTF(fp, "[0001]\t\tSubtable Type : 02\n");
275         EFPRINTF(fp, "[0001]\t\tLength : 0A\n");
276         EFPRINTF(fp, "[0001]\t\tBus : 00\n");
277         EFPRINTF(fp, "[0001]\t\tSource : 00\n");
278         EFPRINTF(fp, "[0004]\t\tInterrupt : 00000002\n");
279         EFPRINTF(fp, "[0002]\t\tFlags (decoded below) : 0005\n");
280         EFPRINTF(fp, "\t\t\tPolarity : 1\n");
281         EFPRINTF(fp, "\t\t\tTrigger Mode : 1\n");
282         EFPRINTF(fp, "\n");
283
284         EFPRINTF(fp, "[0001]\t\tSubtable Type : 02\n");
285         EFPRINTF(fp, "[0001]\t\tLength : 0A\n");
286         EFPRINTF(fp, "[0001]\t\tBus : 00\n");
287         EFPRINTF(fp, "[0001]\t\tSource : %02X\n", SCI_INT);
288         EFPRINTF(fp, "[0004]\t\tInterrupt : %08X\n", SCI_INT);
289         EFPRINTF(fp, "[0002]\t\tFlags (decoded below) : 0000\n");
290         EFPRINTF(fp, "\t\t\tPolarity : 3\n");
291         EFPRINTF(fp, "\t\t\tTrigger Mode : 3\n");
292         EFPRINTF(fp, "\n");
293
294         /* Local APIC NMI is connected to LINT 1 on all CPUs */
295         EFPRINTF(fp, "[0001]\t\tSubtable Type : 04\n");
296         EFPRINTF(fp, "[0001]\t\tLength : 06\n");
297         EFPRINTF(fp, "[0001]\t\tProcessorId : FF\n");
298         EFPRINTF(fp, "[0002]\t\tFlags (decoded below) : 0005\n");
299         EFPRINTF(fp, "\t\t\tPolarity : 1\n");
300         EFPRINTF(fp, "\t\t\tTrigger Mode : 1\n");
301         EFPRINTF(fp, "[0001]\t\tInterrupt : 01\n");
302         EFPRINTF(fp, "\n");
303
304         EFFLUSH(fp);
305
306         return (0);
307
308 err_exit:
309         return (errno);
310 }
311
312 static int
313 basl_fwrite_fadt(FILE *fp)
314 {
315         EFPRINTF(fp, "/*\n");
316         EFPRINTF(fp, " * bhyve FADT template\n");
317         EFPRINTF(fp, " */\n");
318         EFPRINTF(fp, "[0004]\t\tSignature : \"FACP\"\n");
319         EFPRINTF(fp, "[0004]\t\tTable Length : 0000010C\n");
320         EFPRINTF(fp, "[0001]\t\tRevision : 05\n");
321         EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
322         EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
323         EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVFACP  \"\n");
324         EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
325         /* iasl will fill in the compiler ID/revision fields */
326         EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
327         EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
328         EFPRINTF(fp, "\n");
329
330         EFPRINTF(fp, "[0004]\t\tFACS Address : %08X\n",
331             basl_acpi_base + FACS_OFFSET);
332         EFPRINTF(fp, "[0004]\t\tDSDT Address : %08X\n",
333             basl_acpi_base + DSDT_OFFSET);
334         EFPRINTF(fp, "[0001]\t\tModel : 01\n");
335         EFPRINTF(fp, "[0001]\t\tPM Profile : 00 [Unspecified]\n");
336         EFPRINTF(fp, "[0002]\t\tSCI Interrupt : %04X\n",
337             SCI_INT);
338         EFPRINTF(fp, "[0004]\t\tSMI Command Port : %08X\n",
339             SMI_CMD);
340         EFPRINTF(fp, "[0001]\t\tACPI Enable Value : %02X\n",
341             BHYVE_ACPI_ENABLE);
342         EFPRINTF(fp, "[0001]\t\tACPI Disable Value : %02X\n",
343             BHYVE_ACPI_DISABLE);
344         EFPRINTF(fp, "[0001]\t\tS4BIOS Command : 00\n");
345         EFPRINTF(fp, "[0001]\t\tP-State Control : 00\n");
346         EFPRINTF(fp, "[0004]\t\tPM1A Event Block Address : %08X\n",
347             PM1A_EVT_ADDR);
348         EFPRINTF(fp, "[0004]\t\tPM1B Event Block Address : 00000000\n");
349         EFPRINTF(fp, "[0004]\t\tPM1A Control Block Address : %08X\n",
350             PM1A_CNT_ADDR);
351         EFPRINTF(fp, "[0004]\t\tPM1B Control Block Address : 00000000\n");
352         EFPRINTF(fp, "[0004]\t\tPM2 Control Block Address : 00000000\n");
353         EFPRINTF(fp, "[0004]\t\tPM Timer Block Address : %08X\n",
354             IO_PMTMR);
355         EFPRINTF(fp, "[0004]\t\tGPE0 Block Address : 00000000\n");
356         EFPRINTF(fp, "[0004]\t\tGPE1 Block Address : 00000000\n");
357         EFPRINTF(fp, "[0001]\t\tPM1 Event Block Length : 04\n");
358         EFPRINTF(fp, "[0001]\t\tPM1 Control Block Length : 02\n");
359         EFPRINTF(fp, "[0001]\t\tPM2 Control Block Length : 00\n");
360         EFPRINTF(fp, "[0001]\t\tPM Timer Block Length : 04\n");
361         EFPRINTF(fp, "[0001]\t\tGPE0 Block Length : 00\n");
362         EFPRINTF(fp, "[0001]\t\tGPE1 Block Length : 00\n");
363         EFPRINTF(fp, "[0001]\t\tGPE1 Base Offset : 00\n");
364         EFPRINTF(fp, "[0001]\t\t_CST Support : 00\n");
365         EFPRINTF(fp, "[0002]\t\tC2 Latency : 0000\n");
366         EFPRINTF(fp, "[0002]\t\tC3 Latency : 0000\n");
367         EFPRINTF(fp, "[0002]\t\tCPU Cache Size : 0000\n");
368         EFPRINTF(fp, "[0002]\t\tCache Flush Stride : 0000\n");
369         EFPRINTF(fp, "[0001]\t\tDuty Cycle Offset : 00\n");
370         EFPRINTF(fp, "[0001]\t\tDuty Cycle Width : 00\n");
371         EFPRINTF(fp, "[0001]\t\tRTC Day Alarm Index : 00\n");
372         EFPRINTF(fp, "[0001]\t\tRTC Month Alarm Index : 00\n");
373         EFPRINTF(fp, "[0001]\t\tRTC Century Index : 32\n");
374         EFPRINTF(fp, "[0002]\t\tBoot Flags (decoded below) : 0000\n");
375         EFPRINTF(fp, "\t\t\tLegacy Devices Supported (V2) : 0\n");
376         EFPRINTF(fp, "\t\t\t8042 Present on ports 60/64 (V2) : 0\n");
377         EFPRINTF(fp, "\t\t\tVGA Not Present (V4) : 1\n");
378         EFPRINTF(fp, "\t\t\tMSI Not Supported (V4) : 0\n");
379         EFPRINTF(fp, "\t\t\tPCIe ASPM Not Supported (V4) : 1\n");
380         EFPRINTF(fp, "\t\t\tCMOS RTC Not Present (V5) : 0\n");
381         EFPRINTF(fp, "[0001]\t\tReserved : 00\n");
382         EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000000\n");
383         EFPRINTF(fp, "\t\t\tWBINVD instruction is operational (V1) : 1\n");
384         EFPRINTF(fp, "\t\t\tWBINVD flushes all caches (V1) : 0\n");
385         EFPRINTF(fp, "\t\t\tAll CPUs support C1 (V1) : 1\n");
386         EFPRINTF(fp, "\t\t\tC2 works on MP system (V1) : 0\n");
387         EFPRINTF(fp, "\t\t\tControl Method Power Button (V1) : 0\n");
388         EFPRINTF(fp, "\t\t\tControl Method Sleep Button (V1) : 1\n");
389         EFPRINTF(fp, "\t\t\tRTC wake not in fixed reg space (V1) : 0\n");
390         EFPRINTF(fp, "\t\t\tRTC can wake system from S4 (V1) : 0\n");
391         EFPRINTF(fp, "\t\t\t32-bit PM Timer (V1) : 1\n");
392         EFPRINTF(fp, "\t\t\tDocking Supported (V1) : 0\n");
393         EFPRINTF(fp, "\t\t\tReset Register Supported (V2) : 1\n");
394         EFPRINTF(fp, "\t\t\tSealed Case (V3) : 0\n");
395         EFPRINTF(fp, "\t\t\tHeadless - No Video (V3) : 1\n");
396         EFPRINTF(fp, "\t\t\tUse native instr after SLP_TYPx (V3) : 0\n");
397         EFPRINTF(fp, "\t\t\tPCIEXP_WAK Bits Supported (V4) : 0\n");
398         EFPRINTF(fp, "\t\t\tUse Platform Timer (V4) : 0\n");
399         EFPRINTF(fp, "\t\t\tRTC_STS valid on S4 wake (V4) : 0\n");
400         EFPRINTF(fp, "\t\t\tRemote Power-on capable (V4) : 0\n");
401         EFPRINTF(fp, "\t\t\tUse APIC Cluster Model (V4) : 0\n");
402         EFPRINTF(fp, "\t\t\tUse APIC Physical Destination Mode (V4) : 1\n");
403         EFPRINTF(fp, "\t\t\tHardware Reduced (V5) : 0\n");
404         EFPRINTF(fp, "\t\t\tLow Power S0 Idle (V5) : 0\n");
405         EFPRINTF(fp, "\n");
406
407         EFPRINTF(fp,
408             "[0012]\t\tReset Register : [Generic Address Structure]\n");
409         EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
410         EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
411         EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
412         EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
413         EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000CF9\n");
414         EFPRINTF(fp, "\n");
415
416         EFPRINTF(fp, "[0001]\t\tValue to cause reset : 06\n");
417         EFPRINTF(fp, "[0002]\t\tARM Flags (decoded below): 0000\n");
418         EFPRINTF(fp, "\t\t\tPSCI Compliant : 0\n");
419         EFPRINTF(fp, "\t\t\tMust use HVC for PSCI : 0\n");
420         EFPRINTF(fp, "[0001]\t\tFADT Minor Revision : 01\n");
421         EFPRINTF(fp, "[0008]\t\tFACS Address : 00000000%08X\n",
422             basl_acpi_base + FACS_OFFSET);
423         EFPRINTF(fp, "[0008]\t\tDSDT Address : 00000000%08X\n",
424             basl_acpi_base + DSDT_OFFSET);
425         EFPRINTF(fp,
426             "[0012]\t\tPM1A Event Block : [Generic Address Structure]\n");
427         EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
428         EFPRINTF(fp, "[0001]\t\tBit Width : 20\n");
429         EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
430         EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 02 [Word Access:16]\n");
431         EFPRINTF(fp, "[0008]\t\tAddress : 00000000%08X\n",
432             PM1A_EVT_ADDR);
433         EFPRINTF(fp, "\n");
434         
435         EFPRINTF(fp,
436             "[0012]\t\tPM1B Event Block : [Generic Address Structure]\n");
437         EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
438         EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
439         EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
440         EFPRINTF(fp,
441             "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
442         EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
443         EFPRINTF(fp, "\n");
444
445         EFPRINTF(fp,
446             "[0012]\t\tPM1A Control Block : [Generic Address Structure]\n");
447         EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
448         EFPRINTF(fp, "[0001]\t\tBit Width : 10\n");
449         EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
450         EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 02 [Word Access:16]\n");
451         EFPRINTF(fp, "[0008]\t\tAddress : 00000000%08X\n",
452             PM1A_CNT_ADDR);
453         EFPRINTF(fp, "\n");
454
455         EFPRINTF(fp,
456             "[0012]\t\tPM1B Control Block : [Generic Address Structure]\n");
457         EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
458         EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
459         EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
460         EFPRINTF(fp,
461             "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
462         EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
463         EFPRINTF(fp, "\n");
464
465         EFPRINTF(fp,
466             "[0012]\t\tPM2 Control Block : [Generic Address Structure]\n");
467         EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
468         EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
469         EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
470         EFPRINTF(fp,
471             "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
472         EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
473         EFPRINTF(fp, "\n");
474
475         /* Valid for bhyve */
476         EFPRINTF(fp,
477             "[0012]\t\tPM Timer Block : [Generic Address Structure]\n");
478         EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
479         EFPRINTF(fp, "[0001]\t\tBit Width : 20\n");
480         EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
481         EFPRINTF(fp,
482             "[0001]\t\tEncoded Access Width : 03 [DWord Access:32]\n");
483         EFPRINTF(fp, "[0008]\t\tAddress : 00000000%08X\n",
484             IO_PMTMR);
485         EFPRINTF(fp, "\n");
486
487         EFPRINTF(fp, "[0012]\t\tGPE0 Block : [Generic Address Structure]\n");
488         EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
489         EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
490         EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
491         EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
492         EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
493         EFPRINTF(fp, "\n");
494
495         EFPRINTF(fp, "[0012]\t\tGPE1 Block : [Generic Address Structure]\n");
496         EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
497         EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
498         EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
499         EFPRINTF(fp,
500             "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
501         EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
502         EFPRINTF(fp, "\n");
503
504         EFPRINTF(fp,
505            "[0012]\t\tSleep Control Register : [Generic Address Structure]\n");
506         EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
507         EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
508         EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
509         EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
510         EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
511         EFPRINTF(fp, "\n");
512
513         EFPRINTF(fp,
514             "[0012]\t\tSleep Status Register : [Generic Address Structure]\n");
515         EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
516         EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
517         EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
518         EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
519         EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
520
521         EFFLUSH(fp);
522
523         return (0);
524
525 err_exit:
526         return (errno);
527 }
528
529 static int
530 basl_fwrite_hpet(FILE *fp)
531 {
532         EFPRINTF(fp, "/*\n");
533         EFPRINTF(fp, " * bhyve HPET template\n");
534         EFPRINTF(fp, " */\n");
535         EFPRINTF(fp, "[0004]\t\tSignature : \"HPET\"\n");
536         EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
537         EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
538         EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
539         EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
540         EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVHPET  \"\n");
541         EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
542
543         /* iasl will fill in the compiler ID/revision fields */
544         EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
545         EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
546         EFPRINTF(fp, "\n");
547
548         EFPRINTF(fp, "[0004]\t\tTimer Block ID : %08X\n", hpet_capabilities);
549         EFPRINTF(fp,
550             "[0012]\t\tTimer Block Register : [Generic Address Structure]\n");
551         EFPRINTF(fp, "[0001]\t\tSpace ID : 00 [SystemMemory]\n");
552         EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
553         EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
554         EFPRINTF(fp,
555                  "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
556         EFPRINTF(fp, "[0008]\t\tAddress : 00000000FED00000\n");
557         EFPRINTF(fp, "\n");
558
559         EFPRINTF(fp, "[0001]\t\tHPET Number : 00\n");
560         EFPRINTF(fp, "[0002]\t\tMinimum Clock Ticks : 0000\n");
561         EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000001\n");
562         EFPRINTF(fp, "\t\t\t4K Page Protect : 1\n");
563         EFPRINTF(fp, "\t\t\t64K Page Protect : 0\n");
564         EFPRINTF(fp, "\n");
565
566         EFFLUSH(fp);
567
568         return (0);
569
570 err_exit:
571         return (errno);
572 }
573
574 static int
575 basl_fwrite_mcfg(FILE *fp)
576 {
577         EFPRINTF(fp, "/*\n");
578         EFPRINTF(fp, " * bhyve MCFG template\n");
579         EFPRINTF(fp, " */\n");
580         EFPRINTF(fp, "[0004]\t\tSignature : \"MCFG\"\n");
581         EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
582         EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
583         EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
584         EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
585         EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVMCFG  \"\n");
586         EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
587
588         /* iasl will fill in the compiler ID/revision fields */
589         EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
590         EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
591         EFPRINTF(fp, "[0008]\t\tReserved : 0\n");
592         EFPRINTF(fp, "\n");
593
594         EFPRINTF(fp, "[0008]\t\tBase Address : %016lX\n", pci_ecfg_base());
595         EFPRINTF(fp, "[0002]\t\tSegment Group: 0000\n");
596         EFPRINTF(fp, "[0001]\t\tStart Bus: 00\n");
597         EFPRINTF(fp, "[0001]\t\tEnd Bus: FF\n");
598         EFPRINTF(fp, "[0004]\t\tReserved : 0\n");
599         EFFLUSH(fp);
600         return (0);
601 err_exit:
602         return (errno);
603 }
604
605 static int
606 basl_fwrite_facs(FILE *fp)
607 {
608         EFPRINTF(fp, "/*\n");
609         EFPRINTF(fp, " * bhyve FACS template\n");
610         EFPRINTF(fp, " */\n");
611         EFPRINTF(fp, "[0004]\t\tSignature : \"FACS\"\n");
612         EFPRINTF(fp, "[0004]\t\tLength : 00000040\n");
613         EFPRINTF(fp, "[0004]\t\tHardware Signature : 00000000\n");
614         EFPRINTF(fp, "[0004]\t\t32 Firmware Waking Vector : 00000000\n");
615         EFPRINTF(fp, "[0004]\t\tGlobal Lock : 00000000\n");
616         EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000000\n");
617         EFPRINTF(fp, "\t\t\tS4BIOS Support Present : 0\n");
618         EFPRINTF(fp, "\t\t\t64-bit Wake Supported (V2) : 0\n");
619         EFPRINTF(fp,
620             "[0008]\t\t64 Firmware Waking Vector : 0000000000000000\n");
621         EFPRINTF(fp, "[0001]\t\tVersion : 02\n");
622         EFPRINTF(fp, "[0003]\t\tReserved : 000000\n");
623         EFPRINTF(fp, "[0004]\t\tOspmFlags (decoded below) : 00000000\n");
624         EFPRINTF(fp, "\t\t\t64-bit Wake Env Required (V2) : 0\n");
625
626         EFFLUSH(fp);
627
628         return (0);
629         
630 err_exit:
631         return (errno);
632 }
633
634 /*
635  * Helper routines for writing to the DSDT from other modules.
636  */
637 void
638 dsdt_line(const char *fmt, ...)
639 {
640         va_list ap;
641
642         if (dsdt_error != 0)
643                 return;
644
645         if (strcmp(fmt, "") != 0) {
646                 if (dsdt_indent_level != 0)
647                         EFPRINTF(dsdt_fp, "%*c", dsdt_indent_level * 2, ' ');
648                 va_start(ap, fmt);
649                 if (vfprintf(dsdt_fp, fmt, ap) < 0) {
650                         va_end(ap);
651                         goto err_exit;
652                 }
653                 va_end(ap);
654         }
655         EFPRINTF(dsdt_fp, "\n");
656         return;
657
658 err_exit:
659         dsdt_error = errno;
660 }
661
662 void
663 dsdt_indent(int levels)
664 {
665
666         dsdt_indent_level += levels;
667         assert(dsdt_indent_level >= 0);
668 }
669
670 void
671 dsdt_unindent(int levels)
672 {
673
674         assert(dsdt_indent_level >= levels);
675         dsdt_indent_level -= levels;
676 }
677
678 void
679 dsdt_fixed_ioport(uint16_t iobase, uint16_t length)
680 {
681
682         dsdt_line("IO (Decode16,");
683         dsdt_line("  0x%04X,             // Range Minimum", iobase);
684         dsdt_line("  0x%04X,             // Range Maximum", iobase);
685         dsdt_line("  0x01,               // Alignment");
686         dsdt_line("  0x%02X,               // Length", length);
687         dsdt_line("  )");
688 }
689
690 void
691 dsdt_fixed_irq(uint8_t irq)
692 {
693
694         dsdt_line("IRQNoFlags ()");
695         dsdt_line("  {%d}", irq);
696 }
697
698 void
699 dsdt_fixed_mem32(uint32_t base, uint32_t length)
700 {
701
702         dsdt_line("Memory32Fixed (ReadWrite,");
703         dsdt_line("  0x%08X,         // Address Base", base);
704         dsdt_line("  0x%08X,         // Address Length", length);
705         dsdt_line("  )");
706 }
707
708 static int
709 basl_fwrite_dsdt(FILE *fp)
710 {
711         dsdt_fp = fp;
712         dsdt_error = 0;
713         dsdt_indent_level = 0;
714
715         dsdt_line("/*");
716         dsdt_line(" * bhyve DSDT template");
717         dsdt_line(" */");
718         dsdt_line("DefinitionBlock (\"bhyve_dsdt.aml\", \"DSDT\", 2,"
719                  "\"BHYVE \", \"BVDSDT  \", 0x00000001)");
720         dsdt_line("{");
721         dsdt_line("  Name (_S5, Package ()");
722         dsdt_line("  {");
723         dsdt_line("      0x05,");
724         dsdt_line("      Zero,");
725         dsdt_line("  })");
726
727         pci_write_dsdt();
728
729         dsdt_line("");
730         dsdt_line("  Scope (_SB.PC00)");
731         dsdt_line("  {");
732         dsdt_line("    Device (HPET)");
733         dsdt_line("    {");
734         dsdt_line("      Name (_HID, EISAID(\"PNP0103\"))");
735         dsdt_line("      Name (_UID, 0)");
736         dsdt_line("      Name (_CRS, ResourceTemplate ()");
737         dsdt_line("      {");
738         dsdt_indent(4);
739         dsdt_fixed_mem32(0xFED00000, 0x400);
740         dsdt_unindent(4);
741         dsdt_line("      })");
742         dsdt_line("    }");
743         dsdt_line("  }");
744         dsdt_line("}");
745
746         if (dsdt_error != 0)
747                 return (dsdt_error);
748
749         EFFLUSH(fp);
750
751         return (0);
752
753 err_exit:
754         return (errno);
755 }
756
757 static int
758 basl_open(struct basl_fio *bf, int suffix)
759 {
760         int err;
761
762         err = 0;
763
764         if (suffix) {
765                 strlcpy(bf->f_name, basl_stemplate, MAXPATHLEN);
766                 bf->fd = mkstemps(bf->f_name, strlen(BHYVE_ASL_SUFFIX));
767         } else {
768                 strlcpy(bf->f_name, basl_template, MAXPATHLEN);
769                 bf->fd = mkstemp(bf->f_name);
770         }
771
772         if (bf->fd > 0) {
773                 bf->fp = fdopen(bf->fd, "w+");
774                 if (bf->fp == NULL) {
775                         unlink(bf->f_name);
776                         close(bf->fd);
777                 }
778         } else {
779                 err = 1;
780         }
781
782         return (err);
783 }
784
785 static void
786 basl_close(struct basl_fio *bf)
787 {
788
789         if (!basl_keep_temps)
790                 unlink(bf->f_name);
791         fclose(bf->fp);
792 }
793
794 static int
795 basl_start(struct basl_fio *in, struct basl_fio *out)
796 {
797         int err;
798
799         err = basl_open(in, 0);
800         if (!err) {
801                 err = basl_open(out, 1);
802                 if (err) {
803                         basl_close(in);
804                 }
805         }
806
807         return (err);
808 }
809
810 static void
811 basl_end(struct basl_fio *in, struct basl_fio *out)
812 {
813
814         basl_close(in);
815         basl_close(out);
816 }
817
818 static int
819 basl_load(struct vmctx *ctx, int fd, uint64_t off)
820 {
821         struct stat sb;
822         void *gaddr;
823
824         if (fstat(fd, &sb) < 0)
825                 return (errno);
826                 
827         gaddr = paddr_guest2host(ctx, basl_acpi_base + off, sb.st_size);
828         if (gaddr == NULL)
829                 return (EFAULT);
830
831         if (read(fd, gaddr, sb.st_size) < 0)
832                 return (errno);
833
834         return (0);
835 }
836
837 static int
838 basl_compile(struct vmctx *ctx, int (*fwrite_section)(FILE *), uint64_t offset)
839 {
840         struct basl_fio io[2];
841         static char iaslbuf[3*MAXPATHLEN + 10];
842         char *fmt;
843         int err;
844
845         err = basl_start(&io[0], &io[1]);
846         if (!err) {
847                 err = (*fwrite_section)(io[0].fp);
848
849                 if (!err) {
850                         /*
851                          * iasl sends the results of the compilation to
852                          * stdout. Shut this down by using the shell to
853                          * redirect stdout to /dev/null, unless the user
854                          * has requested verbose output for debugging
855                          * purposes
856                          */
857                         fmt = basl_verbose_iasl ?
858                                 "%s -p %s %s" :
859                                 "/bin/sh -c \"%s -p %s %s\" 1> /dev/null";
860                                 
861                         snprintf(iaslbuf, sizeof(iaslbuf),
862                                  fmt,
863                                  BHYVE_ASL_COMPILER,
864                                  io[1].f_name, io[0].f_name);
865                         err = system(iaslbuf);
866
867                         if (!err) {
868                                 /*
869                                  * Copy the aml output file into guest
870                                  * memory at the specified location
871                                  */
872                                 err = basl_load(ctx, io[1].fd, offset);
873                         }
874                 }
875                 basl_end(&io[0], &io[1]);
876         }
877
878         return (err);
879 }
880
881 static int
882 basl_make_templates(void)
883 {
884         const char *tmpdir;
885         int err;
886         int len;
887
888         err = 0;
889
890         /*
891          * 
892          */
893         if ((tmpdir = getenv("BHYVE_TMPDIR")) == NULL || *tmpdir == '\0' ||
894             (tmpdir = getenv("TMPDIR")) == NULL || *tmpdir == '\0') {
895                 tmpdir = _PATH_TMP;
896         }
897
898         len = strlen(tmpdir);
899
900         if ((len + sizeof(BHYVE_ASL_TEMPLATE) + 1) < MAXPATHLEN) {
901                 strcpy(basl_template, tmpdir);
902                 while (len > 0 && basl_template[len - 1] == '/')
903                         len--;
904                 basl_template[len] = '/';
905                 strcpy(&basl_template[len + 1], BHYVE_ASL_TEMPLATE);
906         } else
907                 err = E2BIG;
908
909         if (!err) {
910                 /*
911                  * len has been intialized (and maybe adjusted) above
912                  */
913                 if ((len + sizeof(BHYVE_ASL_TEMPLATE) + 1 +
914                      sizeof(BHYVE_ASL_SUFFIX)) < MAXPATHLEN) {
915                         strcpy(basl_stemplate, tmpdir);
916                         basl_stemplate[len] = '/';
917                         strcpy(&basl_stemplate[len + 1], BHYVE_ASL_TEMPLATE);
918                         len = strlen(basl_stemplate);
919                         strcpy(&basl_stemplate[len], BHYVE_ASL_SUFFIX);
920                 } else
921                         err = E2BIG;
922         }
923
924         return (err);
925 }
926
927 static struct {
928         int     (*wsect)(FILE *fp);
929         uint64_t  offset;
930 } basl_ftables[] =
931 {
932         { basl_fwrite_rsdp, 0},
933         { basl_fwrite_rsdt, RSDT_OFFSET },
934         { basl_fwrite_xsdt, XSDT_OFFSET },
935         { basl_fwrite_madt, MADT_OFFSET },
936         { basl_fwrite_fadt, FADT_OFFSET },
937         { basl_fwrite_hpet, HPET_OFFSET },
938         { basl_fwrite_mcfg, MCFG_OFFSET },
939         { basl_fwrite_facs, FACS_OFFSET },
940         { basl_fwrite_dsdt, DSDT_OFFSET },
941         { NULL }
942 };
943
944 int
945 acpi_build(struct vmctx *ctx, int ncpu)
946 {
947         int err;
948         int i;
949
950         basl_ncpu = ncpu;
951
952         err = vm_get_hpet_capabilities(ctx, &hpet_capabilities);
953         if (err != 0)
954                 return (err);
955
956         /*
957          * For debug, allow the user to have iasl compiler output sent
958          * to stdout rather than /dev/null
959          */
960         if (getenv("BHYVE_ACPI_VERBOSE_IASL"))
961                 basl_verbose_iasl = 1;
962
963         /*
964          * Allow the user to keep the generated ASL files for debugging
965          * instead of deleting them following use
966          */
967         if (getenv("BHYVE_ACPI_KEEPTMPS"))
968                 basl_keep_temps = 1;
969
970         i = 0;
971         err = basl_make_templates();
972
973         /*
974          * Run through all the ASL files, compiling them and
975          * copying them into guest memory
976          */
977         while (!err && basl_ftables[i].wsect != NULL) {
978                 err = basl_compile(ctx, basl_ftables[i].wsect,
979                                    basl_ftables[i].offset);
980                 i++;
981         }
982
983         return (err);
984 }