2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2012 NetApp, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
32 * bhyve ACPI table generator.
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.
39 * The tables are placed in the guest's ROM area just below 1MB physical,
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)
55 #include <sys/cdefs.h>
56 __FBSDID("$FreeBSD$");
58 #include <sys/param.h>
59 #include <sys/errno.h>
69 #include <machine/vmm.h>
77 * Define the base address of the ACPI tables, and the offsets to
78 * the individual tables
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
90 #define BHYVE_ASL_TEMPLATE "bhyve.XXXXXXX"
91 #define BHYVE_ASL_SUFFIX ".aml"
92 #define BHYVE_ASL_COMPILER "/usr/sbin/iasl"
94 static int basl_keep_temps;
95 static int basl_verbose_iasl;
97 static uint32_t basl_acpi_base = BHYVE_ACPI_BASE;
98 static uint32_t hpet_capabilities;
101 * Contains the full pathname of the template to be passed
102 * to mkstemp/mktemps(3)
104 static char basl_template[MAXPATHLEN];
105 static char basl_stemplate[MAXPATHLEN];
108 * State for dsdt_line(), dsdt_indent(), and dsdt_unindent().
110 static FILE *dsdt_fp;
111 static int dsdt_indent_level;
112 static int dsdt_error;
117 char f_name[MAXPATHLEN];
120 #define EFPRINTF(...) \
121 if (fprintf(__VA_ARGS__) < 0) goto err_exit;
124 if (fflush(x) != 0) goto err_exit;
127 basl_fwrite_rsdp(FILE *fp)
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");
153 basl_fwrite_rsdt(FILE *fp)
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");
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);
189 basl_fwrite_xsdt(FILE *fp)
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");
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);
225 basl_fwrite_madt(FILE *fp)
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");
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");
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");
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");
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");
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");
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");
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");
313 basl_fwrite_fadt(FILE *fp)
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");
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",
338 EFPRINTF(fp, "[0004]\t\tSMI Command Port : %08X\n",
340 EFPRINTF(fp, "[0001]\t\tACPI Enable Value : %02X\n",
342 EFPRINTF(fp, "[0001]\t\tACPI Disable Value : %02X\n",
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",
348 EFPRINTF(fp, "[0004]\t\tPM1B Event Block Address : 00000000\n");
349 EFPRINTF(fp, "[0004]\t\tPM1A Control Block Address : %08X\n",
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",
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");
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");
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);
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",
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");
441 "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
442 EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
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",
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");
461 "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
462 EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
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");
471 "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
472 EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
475 /* Valid for bhyve */
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");
482 "[0001]\t\tEncoded Access Width : 03 [DWord Access:32]\n");
483 EFPRINTF(fp, "[0008]\t\tAddress : 00000000%08X\n",
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");
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");
500 "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
501 EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
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");
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");
530 basl_fwrite_hpet(FILE *fp)
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");
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");
548 EFPRINTF(fp, "[0004]\t\tTimer Block ID : %08X\n", hpet_capabilities);
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");
555 "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
556 EFPRINTF(fp, "[0008]\t\tAddress : 00000000FED00000\n");
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");
575 basl_fwrite_mcfg(FILE *fp)
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");
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");
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");
606 basl_fwrite_facs(FILE *fp)
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");
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");
635 * Helper routines for writing to the DSDT from other modules.
638 dsdt_line(const char *fmt, ...)
645 if (strcmp(fmt, "") != 0) {
646 if (dsdt_indent_level != 0)
647 EFPRINTF(dsdt_fp, "%*c", dsdt_indent_level * 2, ' ');
649 if (vfprintf(dsdt_fp, fmt, ap) < 0) {
655 EFPRINTF(dsdt_fp, "\n");
663 dsdt_indent(int levels)
666 dsdt_indent_level += levels;
667 assert(dsdt_indent_level >= 0);
671 dsdt_unindent(int levels)
674 assert(dsdt_indent_level >= levels);
675 dsdt_indent_level -= levels;
679 dsdt_fixed_ioport(uint16_t iobase, uint16_t length)
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);
691 dsdt_fixed_irq(uint8_t irq)
694 dsdt_line("IRQNoFlags ()");
695 dsdt_line(" {%d}", irq);
699 dsdt_fixed_mem32(uint32_t base, uint32_t length)
702 dsdt_line("Memory32Fixed (ReadWrite,");
703 dsdt_line(" 0x%08X, // Address Base", base);
704 dsdt_line(" 0x%08X, // Address Length", length);
709 basl_fwrite_dsdt(FILE *fp)
713 dsdt_indent_level = 0;
716 dsdt_line(" * bhyve DSDT template");
718 dsdt_line("DefinitionBlock (\"bhyve_dsdt.aml\", \"DSDT\", 2,"
719 "\"BHYVE \", \"BVDSDT \", 0x00000001)");
721 dsdt_line(" Name (_S5, Package ()");
730 dsdt_line(" Scope (_SB.PC00)");
732 dsdt_line(" Device (HPET)");
734 dsdt_line(" Name (_HID, EISAID(\"PNP0103\"))");
735 dsdt_line(" Name (_UID, 0)");
736 dsdt_line(" Name (_CRS, ResourceTemplate ()");
739 dsdt_fixed_mem32(0xFED00000, 0x400);
758 basl_open(struct basl_fio *bf, int suffix)
765 strlcpy(bf->f_name, basl_stemplate, MAXPATHLEN);
766 bf->fd = mkstemps(bf->f_name, strlen(BHYVE_ASL_SUFFIX));
768 strlcpy(bf->f_name, basl_template, MAXPATHLEN);
769 bf->fd = mkstemp(bf->f_name);
773 bf->fp = fdopen(bf->fd, "w+");
774 if (bf->fp == NULL) {
786 basl_close(struct basl_fio *bf)
789 if (!basl_keep_temps)
795 basl_start(struct basl_fio *in, struct basl_fio *out)
799 err = basl_open(in, 0);
801 err = basl_open(out, 1);
811 basl_end(struct basl_fio *in, struct basl_fio *out)
819 basl_load(struct vmctx *ctx, int fd, uint64_t off)
824 if (fstat(fd, &sb) < 0)
827 gaddr = paddr_guest2host(ctx, basl_acpi_base + off, sb.st_size);
831 if (read(fd, gaddr, sb.st_size) < 0)
838 basl_compile(struct vmctx *ctx, int (*fwrite_section)(FILE *), uint64_t offset)
840 struct basl_fio io[2];
841 static char iaslbuf[3*MAXPATHLEN + 10];
845 err = basl_start(&io[0], &io[1]);
847 err = (*fwrite_section)(io[0].fp);
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
857 fmt = basl_verbose_iasl ?
859 "/bin/sh -c \"%s -p %s %s\" 1> /dev/null";
861 snprintf(iaslbuf, sizeof(iaslbuf),
864 io[1].f_name, io[0].f_name);
865 err = system(iaslbuf);
869 * Copy the aml output file into guest
870 * memory at the specified location
872 err = basl_load(ctx, io[1].fd, offset);
875 basl_end(&io[0], &io[1]);
882 basl_make_templates(void)
893 if ((tmpdir = getenv("BHYVE_TMPDIR")) == NULL || *tmpdir == '\0' ||
894 (tmpdir = getenv("TMPDIR")) == NULL || *tmpdir == '\0') {
898 len = strlen(tmpdir);
900 if ((len + sizeof(BHYVE_ASL_TEMPLATE) + 1) < MAXPATHLEN) {
901 strcpy(basl_template, tmpdir);
902 while (len > 0 && basl_template[len - 1] == '/')
904 basl_template[len] = '/';
905 strcpy(&basl_template[len + 1], BHYVE_ASL_TEMPLATE);
911 * len has been intialized (and maybe adjusted) above
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);
928 int (*wsect)(FILE *fp);
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 },
945 acpi_build(struct vmctx *ctx, int ncpu)
952 err = vm_get_hpet_capabilities(ctx, &hpet_capabilities);
957 * For debug, allow the user to have iasl compiler output sent
958 * to stdout rather than /dev/null
960 if (getenv("BHYVE_ACPI_VERBOSE_IASL"))
961 basl_verbose_iasl = 1;
964 * Allow the user to keep the generated ASL files for debugging
965 * instead of deleting them following use
967 if (getenv("BHYVE_ACPI_KEEPTMPS"))
971 err = basl_make_templates();
974 * Run through all the ASL files, compiling them and
975 * copying them into guest memory
977 while (!err && basl_ftables[i].wsect != NULL) {
978 err = basl_compile(ctx, basl_ftables[i].wsect,
979 basl_ftables[i].offset);