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