2 * Copyright (c) 2012 NetApp, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * bhyve ACPI table generator.
32 * Create the minimal set of ACPI tables required to boot FreeBSD (and
33 * hopefully other o/s's) by writing out ASL template files for each of
34 * the tables and the compiling them to AML with the Intel iasl compiler.
35 * The AML files are then read into guest memory.
37 * The tables are placed in the guest's ROM area just below 1MB physical,
42 * RSDP -> 0xf2400 (36 bytes fixed)
43 * RSDT -> 0xf2440 (36 bytes + 4*7 table addrs, 4 used)
44 * XSDT -> 0xf2480 (36 bytes + 8*7 table addrs, 4 used)
45 * MADT -> 0xf2500 (depends on #CPUs)
46 * FADT -> 0xf2600 (268 bytes)
47 * HPET -> 0xf2740 (56 bytes)
48 * MCFG -> 0xf2780 (60 bytes)
49 * FACS -> 0xf27C0 (64 bytes)
50 * DSDT -> 0xf2800 (variable - can go up to 0x100000)
53 #include <sys/cdefs.h>
54 __FBSDID("$FreeBSD$");
56 #include <sys/param.h>
57 #include <sys/errno.h>
67 #include <machine/vmm.h>
75 * Define the base address of the ACPI tables, and the offsets to
76 * the individual tables
78 #define BHYVE_ACPI_BASE 0xf2400
79 #define RSDT_OFFSET 0x040
80 #define XSDT_OFFSET 0x080
81 #define MADT_OFFSET 0x100
82 #define FADT_OFFSET 0x200
83 #define HPET_OFFSET 0x340
84 #define MCFG_OFFSET 0x380
85 #define FACS_OFFSET 0x3C0
86 #define DSDT_OFFSET 0x400
88 #define BHYVE_ASL_TEMPLATE "bhyve.XXXXXXX"
89 #define BHYVE_ASL_SUFFIX ".aml"
90 #define BHYVE_ASL_COMPILER "/usr/sbin/iasl"
92 static int basl_keep_temps;
93 static int basl_verbose_iasl;
95 static uint32_t basl_acpi_base = BHYVE_ACPI_BASE;
96 static uint32_t hpet_capabilities;
99 * Contains the full pathname of the template to be passed
100 * to mkstemp/mktemps(3)
102 static char basl_template[MAXPATHLEN];
103 static char basl_stemplate[MAXPATHLEN];
106 * State for dsdt_line(), dsdt_indent(), and dsdt_unindent().
108 static FILE *dsdt_fp;
109 static int dsdt_indent_level;
110 static int dsdt_error;
115 char f_name[MAXPATHLEN];
118 #define EFPRINTF(...) \
119 err = fprintf(__VA_ARGS__); if (err < 0) goto err_exit;
122 err = fflush(x); if (err != 0) goto err_exit;
125 basl_fwrite_rsdp(FILE *fp)
131 EFPRINTF(fp, "/*\n");
132 EFPRINTF(fp, " * bhyve RSDP template\n");
133 EFPRINTF(fp, " */\n");
134 EFPRINTF(fp, "[0008]\t\tSignature : \"RSD PTR \"\n");
135 EFPRINTF(fp, "[0001]\t\tChecksum : 43\n");
136 EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
137 EFPRINTF(fp, "[0001]\t\tRevision : 02\n");
138 EFPRINTF(fp, "[0004]\t\tRSDT Address : %08X\n",
139 basl_acpi_base + RSDT_OFFSET);
140 EFPRINTF(fp, "[0004]\t\tLength : 00000024\n");
141 EFPRINTF(fp, "[0008]\t\tXSDT Address : 00000000%08X\n",
142 basl_acpi_base + XSDT_OFFSET);
143 EFPRINTF(fp, "[0001]\t\tExtended Checksum : 00\n");
144 EFPRINTF(fp, "[0003]\t\tReserved : 000000\n");
155 basl_fwrite_rsdt(FILE *fp)
161 EFPRINTF(fp, "/*\n");
162 EFPRINTF(fp, " * bhyve RSDT template\n");
163 EFPRINTF(fp, " */\n");
164 EFPRINTF(fp, "[0004]\t\tSignature : \"RSDT\"\n");
165 EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
166 EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
167 EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
168 EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
169 EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVRSDT \"\n");
170 EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
171 /* iasl will fill in the compiler ID/revision fields */
172 EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
173 EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
176 /* Add in pointers to the MADT, FADT and HPET */
177 EFPRINTF(fp, "[0004]\t\tACPI Table Address 0 : %08X\n",
178 basl_acpi_base + MADT_OFFSET);
179 EFPRINTF(fp, "[0004]\t\tACPI Table Address 1 : %08X\n",
180 basl_acpi_base + FADT_OFFSET);
181 EFPRINTF(fp, "[0004]\t\tACPI Table Address 2 : %08X\n",
182 basl_acpi_base + HPET_OFFSET);
183 EFPRINTF(fp, "[0004]\t\tACPI Table Address 3 : %08X\n",
184 basl_acpi_base + MCFG_OFFSET);
195 basl_fwrite_xsdt(FILE *fp)
201 EFPRINTF(fp, "/*\n");
202 EFPRINTF(fp, " * bhyve XSDT template\n");
203 EFPRINTF(fp, " */\n");
204 EFPRINTF(fp, "[0004]\t\tSignature : \"XSDT\"\n");
205 EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
206 EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
207 EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
208 EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
209 EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVXSDT \"\n");
210 EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
211 /* iasl will fill in the compiler ID/revision fields */
212 EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
213 EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
216 /* Add in pointers to the MADT, FADT and HPET */
217 EFPRINTF(fp, "[0004]\t\tACPI Table Address 0 : 00000000%08X\n",
218 basl_acpi_base + MADT_OFFSET);
219 EFPRINTF(fp, "[0004]\t\tACPI Table Address 1 : 00000000%08X\n",
220 basl_acpi_base + FADT_OFFSET);
221 EFPRINTF(fp, "[0004]\t\tACPI Table Address 2 : 00000000%08X\n",
222 basl_acpi_base + HPET_OFFSET);
223 EFPRINTF(fp, "[0004]\t\tACPI Table Address 3 : 00000000%08X\n",
224 basl_acpi_base + MCFG_OFFSET);
235 basl_fwrite_madt(FILE *fp)
242 EFPRINTF(fp, "/*\n");
243 EFPRINTF(fp, " * bhyve MADT template\n");
244 EFPRINTF(fp, " */\n");
245 EFPRINTF(fp, "[0004]\t\tSignature : \"APIC\"\n");
246 EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
247 EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
248 EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
249 EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
250 EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVMADT \"\n");
251 EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
253 /* iasl will fill in the compiler ID/revision fields */
254 EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
255 EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
258 EFPRINTF(fp, "[0004]\t\tLocal Apic Address : FEE00000\n");
259 EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000001\n");
260 EFPRINTF(fp, "\t\t\tPC-AT Compatibility : 1\n");
263 /* Add a Processor Local APIC entry for each CPU */
264 for (i = 0; i < basl_ncpu; i++) {
265 EFPRINTF(fp, "[0001]\t\tSubtable Type : 00\n");
266 EFPRINTF(fp, "[0001]\t\tLength : 08\n");
267 /* iasl expects hex values for the proc and apic id's */
268 EFPRINTF(fp, "[0001]\t\tProcessor ID : %02x\n", i);
269 EFPRINTF(fp, "[0001]\t\tLocal Apic ID : %02x\n", i);
270 EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000001\n");
271 EFPRINTF(fp, "\t\t\tProcessor Enabled : 1\n");
275 /* Always a single IOAPIC entry, with ID 0 */
276 EFPRINTF(fp, "[0001]\t\tSubtable Type : 01\n");
277 EFPRINTF(fp, "[0001]\t\tLength : 0C\n");
278 /* iasl expects a hex value for the i/o apic id */
279 EFPRINTF(fp, "[0001]\t\tI/O Apic ID : %02x\n", 0);
280 EFPRINTF(fp, "[0001]\t\tReserved : 00\n");
281 EFPRINTF(fp, "[0004]\t\tAddress : fec00000\n");
282 EFPRINTF(fp, "[0004]\t\tInterrupt : 00000000\n");
285 /* Legacy IRQ0 is connected to pin 2 of the IOAPIC */
286 EFPRINTF(fp, "[0001]\t\tSubtable Type : 02\n");
287 EFPRINTF(fp, "[0001]\t\tLength : 0A\n");
288 EFPRINTF(fp, "[0001]\t\tBus : 00\n");
289 EFPRINTF(fp, "[0001]\t\tSource : 00\n");
290 EFPRINTF(fp, "[0004]\t\tInterrupt : 00000002\n");
291 EFPRINTF(fp, "[0002]\t\tFlags (decoded below) : 0005\n");
292 EFPRINTF(fp, "\t\t\tPolarity : 1\n");
293 EFPRINTF(fp, "\t\t\tTrigger Mode : 1\n");
296 EFPRINTF(fp, "[0001]\t\tSubtable Type : 02\n");
297 EFPRINTF(fp, "[0001]\t\tLength : 0A\n");
298 EFPRINTF(fp, "[0001]\t\tBus : 00\n");
299 EFPRINTF(fp, "[0001]\t\tSource : %02X\n", SCI_INT);
300 EFPRINTF(fp, "[0004]\t\tInterrupt : %08X\n", SCI_INT);
301 EFPRINTF(fp, "[0002]\t\tFlags (decoded below) : 0000\n");
302 EFPRINTF(fp, "\t\t\tPolarity : 3\n");
303 EFPRINTF(fp, "\t\t\tTrigger Mode : 3\n");
306 /* Local APIC NMI is connected to LINT 1 on all CPUs */
307 EFPRINTF(fp, "[0001]\t\tSubtable Type : 04\n");
308 EFPRINTF(fp, "[0001]\t\tLength : 06\n");
309 EFPRINTF(fp, "[0001]\t\tProcessorId : FF\n");
310 EFPRINTF(fp, "[0002]\t\tFlags (decoded below) : 0005\n");
311 EFPRINTF(fp, "\t\t\tPolarity : 1\n");
312 EFPRINTF(fp, "\t\t\tTrigger Mode : 1\n");
313 EFPRINTF(fp, "[0001]\t\tInterrupt : 01\n");
325 basl_fwrite_fadt(FILE *fp)
331 EFPRINTF(fp, "/*\n");
332 EFPRINTF(fp, " * bhyve FADT template\n");
333 EFPRINTF(fp, " */\n");
334 EFPRINTF(fp, "[0004]\t\tSignature : \"FACP\"\n");
335 EFPRINTF(fp, "[0004]\t\tTable Length : 0000010C\n");
336 EFPRINTF(fp, "[0001]\t\tRevision : 05\n");
337 EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
338 EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
339 EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVFACP \"\n");
340 EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
341 /* iasl will fill in the compiler ID/revision fields */
342 EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
343 EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
346 EFPRINTF(fp, "[0004]\t\tFACS Address : %08X\n",
347 basl_acpi_base + FACS_OFFSET);
348 EFPRINTF(fp, "[0004]\t\tDSDT Address : %08X\n",
349 basl_acpi_base + DSDT_OFFSET);
350 EFPRINTF(fp, "[0001]\t\tModel : 01\n");
351 EFPRINTF(fp, "[0001]\t\tPM Profile : 00 [Unspecified]\n");
352 EFPRINTF(fp, "[0002]\t\tSCI Interrupt : %04X\n",
354 EFPRINTF(fp, "[0004]\t\tSMI Command Port : %08X\n",
356 EFPRINTF(fp, "[0001]\t\tACPI Enable Value : %02X\n",
358 EFPRINTF(fp, "[0001]\t\tACPI Disable Value : %02X\n",
360 EFPRINTF(fp, "[0001]\t\tS4BIOS Command : 00\n");
361 EFPRINTF(fp, "[0001]\t\tP-State Control : 00\n");
362 EFPRINTF(fp, "[0004]\t\tPM1A Event Block Address : %08X\n",
364 EFPRINTF(fp, "[0004]\t\tPM1B Event Block Address : 00000000\n");
365 EFPRINTF(fp, "[0004]\t\tPM1A Control Block Address : %08X\n",
367 EFPRINTF(fp, "[0004]\t\tPM1B Control Block Address : 00000000\n");
368 EFPRINTF(fp, "[0004]\t\tPM2 Control Block Address : 00000000\n");
369 EFPRINTF(fp, "[0004]\t\tPM Timer Block Address : %08X\n",
371 EFPRINTF(fp, "[0004]\t\tGPE0 Block Address : 00000000\n");
372 EFPRINTF(fp, "[0004]\t\tGPE1 Block Address : 00000000\n");
373 EFPRINTF(fp, "[0001]\t\tPM1 Event Block Length : 04\n");
374 EFPRINTF(fp, "[0001]\t\tPM1 Control Block Length : 02\n");
375 EFPRINTF(fp, "[0001]\t\tPM2 Control Block Length : 00\n");
376 EFPRINTF(fp, "[0001]\t\tPM Timer Block Length : 04\n");
377 EFPRINTF(fp, "[0001]\t\tGPE0 Block Length : 00\n");
378 EFPRINTF(fp, "[0001]\t\tGPE1 Block Length : 00\n");
379 EFPRINTF(fp, "[0001]\t\tGPE1 Base Offset : 00\n");
380 EFPRINTF(fp, "[0001]\t\t_CST Support : 00\n");
381 EFPRINTF(fp, "[0002]\t\tC2 Latency : 0000\n");
382 EFPRINTF(fp, "[0002]\t\tC3 Latency : 0000\n");
383 EFPRINTF(fp, "[0002]\t\tCPU Cache Size : 0000\n");
384 EFPRINTF(fp, "[0002]\t\tCache Flush Stride : 0000\n");
385 EFPRINTF(fp, "[0001]\t\tDuty Cycle Offset : 00\n");
386 EFPRINTF(fp, "[0001]\t\tDuty Cycle Width : 00\n");
387 EFPRINTF(fp, "[0001]\t\tRTC Day Alarm Index : 00\n");
388 EFPRINTF(fp, "[0001]\t\tRTC Month Alarm Index : 00\n");
389 EFPRINTF(fp, "[0001]\t\tRTC Century Index : 32\n");
390 EFPRINTF(fp, "[0002]\t\tBoot Flags (decoded below) : 0000\n");
391 EFPRINTF(fp, "\t\t\tLegacy Devices Supported (V2) : 0\n");
392 EFPRINTF(fp, "\t\t\t8042 Present on ports 60/64 (V2) : 0\n");
393 EFPRINTF(fp, "\t\t\tVGA Not Present (V4) : 1\n");
394 EFPRINTF(fp, "\t\t\tMSI Not Supported (V4) : 0\n");
395 EFPRINTF(fp, "\t\t\tPCIe ASPM Not Supported (V4) : 1\n");
396 EFPRINTF(fp, "\t\t\tCMOS RTC Not Present (V5) : 0\n");
397 EFPRINTF(fp, "[0001]\t\tReserved : 00\n");
398 EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000000\n");
399 EFPRINTF(fp, "\t\t\tWBINVD instruction is operational (V1) : 1\n");
400 EFPRINTF(fp, "\t\t\tWBINVD flushes all caches (V1) : 0\n");
401 EFPRINTF(fp, "\t\t\tAll CPUs support C1 (V1) : 1\n");
402 EFPRINTF(fp, "\t\t\tC2 works on MP system (V1) : 0\n");
403 EFPRINTF(fp, "\t\t\tControl Method Power Button (V1) : 0\n");
404 EFPRINTF(fp, "\t\t\tControl Method Sleep Button (V1) : 1\n");
405 EFPRINTF(fp, "\t\t\tRTC wake not in fixed reg space (V1) : 0\n");
406 EFPRINTF(fp, "\t\t\tRTC can wake system from S4 (V1) : 0\n");
407 EFPRINTF(fp, "\t\t\t32-bit PM Timer (V1) : 1\n");
408 EFPRINTF(fp, "\t\t\tDocking Supported (V1) : 0\n");
409 EFPRINTF(fp, "\t\t\tReset Register Supported (V2) : 1\n");
410 EFPRINTF(fp, "\t\t\tSealed Case (V3) : 0\n");
411 EFPRINTF(fp, "\t\t\tHeadless - No Video (V3) : 1\n");
412 EFPRINTF(fp, "\t\t\tUse native instr after SLP_TYPx (V3) : 0\n");
413 EFPRINTF(fp, "\t\t\tPCIEXP_WAK Bits Supported (V4) : 0\n");
414 EFPRINTF(fp, "\t\t\tUse Platform Timer (V4) : 0\n");
415 EFPRINTF(fp, "\t\t\tRTC_STS valid on S4 wake (V4) : 0\n");
416 EFPRINTF(fp, "\t\t\tRemote Power-on capable (V4) : 0\n");
417 EFPRINTF(fp, "\t\t\tUse APIC Cluster Model (V4) : 0\n");
418 EFPRINTF(fp, "\t\t\tUse APIC Physical Destination Mode (V4) : 1\n");
419 EFPRINTF(fp, "\t\t\tHardware Reduced (V5) : 0\n");
420 EFPRINTF(fp, "\t\t\tLow Power S0 Idle (V5) : 0\n");
424 "[0012]\t\tReset Register : [Generic Address Structure]\n");
425 EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
426 EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
427 EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
428 EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
429 EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000CF9\n");
432 EFPRINTF(fp, "[0001]\t\tValue to cause reset : 06\n");
433 EFPRINTF(fp, "[0002]\t\tARM Flags (decoded below): 0000\n");
434 EFPRINTF(fp, "\t\t\tPSCI Compliant : 0\n");
435 EFPRINTF(fp, "\t\t\tMust use HVC for PSCI : 0\n");
436 EFPRINTF(fp, "[0001]\t\tFADT Minor Revision : 01\n");
437 EFPRINTF(fp, "[0008]\t\tFACS Address : 00000000%08X\n",
438 basl_acpi_base + FACS_OFFSET);
439 EFPRINTF(fp, "[0008]\t\tDSDT Address : 00000000%08X\n",
440 basl_acpi_base + DSDT_OFFSET);
442 "[0012]\t\tPM1A Event Block : [Generic Address Structure]\n");
443 EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
444 EFPRINTF(fp, "[0001]\t\tBit Width : 20\n");
445 EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
446 EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 02 [Word Access:16]\n");
447 EFPRINTF(fp, "[0008]\t\tAddress : 00000000%08X\n",
452 "[0012]\t\tPM1B Event Block : [Generic Address Structure]\n");
453 EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
454 EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
455 EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
457 "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
458 EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
462 "[0012]\t\tPM1A Control Block : [Generic Address Structure]\n");
463 EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
464 EFPRINTF(fp, "[0001]\t\tBit Width : 10\n");
465 EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
466 EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 02 [Word Access:16]\n");
467 EFPRINTF(fp, "[0008]\t\tAddress : 00000000%08X\n",
472 "[0012]\t\tPM1B Control Block : [Generic Address Structure]\n");
473 EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
474 EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
475 EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
477 "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
478 EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
482 "[0012]\t\tPM2 Control Block : [Generic Address Structure]\n");
483 EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
484 EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
485 EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
487 "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
488 EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
491 /* Valid for bhyve */
493 "[0012]\t\tPM Timer Block : [Generic Address Structure]\n");
494 EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
495 EFPRINTF(fp, "[0001]\t\tBit Width : 20\n");
496 EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
498 "[0001]\t\tEncoded Access Width : 03 [DWord Access:32]\n");
499 EFPRINTF(fp, "[0008]\t\tAddress : 00000000%08X\n",
503 EFPRINTF(fp, "[0012]\t\tGPE0 Block : [Generic Address Structure]\n");
504 EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
505 EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
506 EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
507 EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
508 EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
511 EFPRINTF(fp, "[0012]\t\tGPE1 Block : [Generic Address Structure]\n");
512 EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
513 EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
514 EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
516 "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
517 EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
521 "[0012]\t\tSleep Control Register : [Generic Address Structure]\n");
522 EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
523 EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
524 EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
525 EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
526 EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
530 "[0012]\t\tSleep Status Register : [Generic Address Structure]\n");
531 EFPRINTF(fp, "[0001]\t\tSpace ID : 01 [SystemIO]\n");
532 EFPRINTF(fp, "[0001]\t\tBit Width : 08\n");
533 EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
534 EFPRINTF(fp, "[0001]\t\tEncoded Access Width : 01 [Byte Access:8]\n");
535 EFPRINTF(fp, "[0008]\t\tAddress : 0000000000000000\n");
546 basl_fwrite_hpet(FILE *fp)
552 EFPRINTF(fp, "/*\n");
553 EFPRINTF(fp, " * bhyve HPET template\n");
554 EFPRINTF(fp, " */\n");
555 EFPRINTF(fp, "[0004]\t\tSignature : \"HPET\"\n");
556 EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
557 EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
558 EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
559 EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
560 EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVHPET \"\n");
561 EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
563 /* iasl will fill in the compiler ID/revision fields */
564 EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
565 EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
568 EFPRINTF(fp, "[0004]\t\tTimer Block ID : %08X\n", hpet_capabilities);
570 "[0012]\t\tTimer Block Register : [Generic Address Structure]\n");
571 EFPRINTF(fp, "[0001]\t\tSpace ID : 00 [SystemMemory]\n");
572 EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
573 EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
575 "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
576 EFPRINTF(fp, "[0008]\t\tAddress : 00000000FED00000\n");
579 EFPRINTF(fp, "[0001]\t\tHPET Number : 00\n");
580 EFPRINTF(fp, "[0002]\t\tMinimum Clock Ticks : 0000\n");
581 EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000001\n");
582 EFPRINTF(fp, "\t\t\t4K Page Protect : 1\n");
583 EFPRINTF(fp, "\t\t\t64K Page Protect : 0\n");
595 basl_fwrite_mcfg(FILE *fp)
599 EFPRINTF(fp, "/*\n");
600 EFPRINTF(fp, " * bhyve MCFG template\n");
601 EFPRINTF(fp, " */\n");
602 EFPRINTF(fp, "[0004]\t\tSignature : \"MCFG\"\n");
603 EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
604 EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
605 EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
606 EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
607 EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVMCFG \"\n");
608 EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
610 /* iasl will fill in the compiler ID/revision fields */
611 EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
612 EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
613 EFPRINTF(fp, "[0008]\t\tReserved : 0\n");
616 EFPRINTF(fp, "[0008]\t\tBase Address : %016lX\n", pci_ecfg_base());
617 EFPRINTF(fp, "[0002]\t\tSegment Group: 0000\n");
618 EFPRINTF(fp, "[0001]\t\tStart Bus: 00\n");
619 EFPRINTF(fp, "[0001]\t\tEnd Bus: FF\n");
620 EFPRINTF(fp, "[0004]\t\tReserved : 0\n");
628 basl_fwrite_facs(FILE *fp)
634 EFPRINTF(fp, "/*\n");
635 EFPRINTF(fp, " * bhyve FACS template\n");
636 EFPRINTF(fp, " */\n");
637 EFPRINTF(fp, "[0004]\t\tSignature : \"FACS\"\n");
638 EFPRINTF(fp, "[0004]\t\tLength : 00000040\n");
639 EFPRINTF(fp, "[0004]\t\tHardware Signature : 00000000\n");
640 EFPRINTF(fp, "[0004]\t\t32 Firmware Waking Vector : 00000000\n");
641 EFPRINTF(fp, "[0004]\t\tGlobal Lock : 00000000\n");
642 EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000000\n");
643 EFPRINTF(fp, "\t\t\tS4BIOS Support Present : 0\n");
644 EFPRINTF(fp, "\t\t\t64-bit Wake Supported (V2) : 0\n");
646 "[0008]\t\t64 Firmware Waking Vector : 0000000000000000\n");
647 EFPRINTF(fp, "[0001]\t\tVersion : 02\n");
648 EFPRINTF(fp, "[0003]\t\tReserved : 000000\n");
649 EFPRINTF(fp, "[0004]\t\tOspmFlags (decoded below) : 00000000\n");
650 EFPRINTF(fp, "\t\t\t64-bit Wake Env Required (V2) : 0\n");
661 * Helper routines for writing to the DSDT from other modules.
664 dsdt_line(const char *fmt, ...)
672 if (strcmp(fmt, "") != 0) {
673 if (dsdt_indent_level != 0)
674 EFPRINTF(dsdt_fp, "%*c", dsdt_indent_level * 2, ' ');
676 if (vfprintf(dsdt_fp, fmt, ap) < 0)
680 EFPRINTF(dsdt_fp, "\n");
688 dsdt_indent(int levels)
691 dsdt_indent_level += levels;
692 assert(dsdt_indent_level >= 0);
696 dsdt_unindent(int levels)
699 assert(dsdt_indent_level >= levels);
700 dsdt_indent_level -= levels;
704 dsdt_fixed_ioport(uint16_t iobase, uint16_t length)
707 dsdt_line("IO (Decode16,");
708 dsdt_line(" 0x%04X, // Range Minimum", iobase);
709 dsdt_line(" 0x%04X, // Range Maximum", iobase);
710 dsdt_line(" 0x01, // Alignment");
711 dsdt_line(" 0x%02X, // Length", length);
716 dsdt_fixed_irq(uint8_t irq)
719 dsdt_line("IRQNoFlags ()");
720 dsdt_line(" {%d}", irq);
724 dsdt_fixed_mem32(uint32_t base, uint32_t length)
727 dsdt_line("Memory32Fixed (ReadWrite,");
728 dsdt_line(" 0x%08X, // Address Base", base);
729 dsdt_line(" 0x%08X, // Address Length", length);
734 basl_fwrite_dsdt(FILE *fp)
741 dsdt_indent_level = 0;
744 dsdt_line(" * bhyve DSDT template");
746 dsdt_line("DefinitionBlock (\"bhyve_dsdt.aml\", \"DSDT\", 2,"
747 "\"BHYVE \", \"BVDSDT \", 0x00000001)");
749 dsdt_line(" Name (_S5, Package ()");
758 dsdt_line(" Scope (_SB.PC00)");
760 dsdt_line(" Device (HPET)");
762 dsdt_line(" Name (_HID, EISAID(\"PNP0103\"))");
763 dsdt_line(" Name (_UID, 0)");
764 dsdt_line(" Name (_CRS, ResourceTemplate ()");
767 dsdt_fixed_mem32(0xFED00000, 0x400);
786 basl_open(struct basl_fio *bf, int suffix)
793 strlcpy(bf->f_name, basl_stemplate, MAXPATHLEN);
794 bf->fd = mkstemps(bf->f_name, strlen(BHYVE_ASL_SUFFIX));
796 strlcpy(bf->f_name, basl_template, MAXPATHLEN);
797 bf->fd = mkstemp(bf->f_name);
801 bf->fp = fdopen(bf->fd, "w+");
802 if (bf->fp == NULL) {
814 basl_close(struct basl_fio *bf)
817 if (!basl_keep_temps)
823 basl_start(struct basl_fio *in, struct basl_fio *out)
827 err = basl_open(in, 0);
829 err = basl_open(out, 1);
839 basl_end(struct basl_fio *in, struct basl_fio *out)
847 basl_load(struct vmctx *ctx, int fd, uint64_t off)
852 if (fstat(fd, &sb) < 0)
855 gaddr = paddr_guest2host(ctx, basl_acpi_base + off, sb.st_size);
859 if (read(fd, gaddr, sb.st_size) < 0)
866 basl_compile(struct vmctx *ctx, int (*fwrite_section)(FILE *), uint64_t offset)
868 struct basl_fio io[2];
869 static char iaslbuf[3*MAXPATHLEN + 10];
873 err = basl_start(&io[0], &io[1]);
875 err = (*fwrite_section)(io[0].fp);
879 * iasl sends the results of the compilation to
880 * stdout. Shut this down by using the shell to
881 * redirect stdout to /dev/null, unless the user
882 * has requested verbose output for debugging
885 fmt = basl_verbose_iasl ?
887 "/bin/sh -c \"%s -p %s %s\" 1> /dev/null";
889 snprintf(iaslbuf, sizeof(iaslbuf),
892 io[1].f_name, io[0].f_name);
893 err = system(iaslbuf);
897 * Copy the aml output file into guest
898 * memory at the specified location
900 err = basl_load(ctx, io[1].fd, offset);
903 basl_end(&io[0], &io[1]);
910 basl_make_templates(void)
921 if ((tmpdir = getenv("BHYVE_TMPDIR")) == NULL || *tmpdir == '\0' ||
922 (tmpdir = getenv("TMPDIR")) == NULL || *tmpdir == '\0') {
926 len = strlen(tmpdir);
928 if ((len + sizeof(BHYVE_ASL_TEMPLATE) + 1) < MAXPATHLEN) {
929 strcpy(basl_template, tmpdir);
930 while (len > 0 && basl_template[len - 1] == '/')
932 basl_template[len] = '/';
933 strcpy(&basl_template[len + 1], BHYVE_ASL_TEMPLATE);
939 * len has been intialized (and maybe adjusted) above
941 if ((len + sizeof(BHYVE_ASL_TEMPLATE) + 1 +
942 sizeof(BHYVE_ASL_SUFFIX)) < MAXPATHLEN) {
943 strcpy(basl_stemplate, tmpdir);
944 basl_stemplate[len] = '/';
945 strcpy(&basl_stemplate[len + 1], BHYVE_ASL_TEMPLATE);
946 len = strlen(basl_stemplate);
947 strcpy(&basl_stemplate[len], BHYVE_ASL_SUFFIX);
956 int (*wsect)(FILE *fp);
960 { basl_fwrite_rsdp, 0},
961 { basl_fwrite_rsdt, RSDT_OFFSET },
962 { basl_fwrite_xsdt, XSDT_OFFSET },
963 { basl_fwrite_madt, MADT_OFFSET },
964 { basl_fwrite_fadt, FADT_OFFSET },
965 { basl_fwrite_hpet, HPET_OFFSET },
966 { basl_fwrite_mcfg, MCFG_OFFSET },
967 { basl_fwrite_facs, FACS_OFFSET },
968 { basl_fwrite_dsdt, DSDT_OFFSET },
973 acpi_build(struct vmctx *ctx, int ncpu)
980 err = vm_get_hpet_capabilities(ctx, &hpet_capabilities);
985 * For debug, allow the user to have iasl compiler output sent
986 * to stdout rather than /dev/null
988 if (getenv("BHYVE_ACPI_VERBOSE_IASL"))
989 basl_verbose_iasl = 1;
992 * Allow the user to keep the generated ASL files for debugging
993 * instead of deleting them following use
995 if (getenv("BHYVE_ACPI_KEEPTMPS"))
999 err = basl_make_templates();
1002 * Run through all the ASL files, compiling them and
1003 * copying them into guest memory
1005 while (!err && basl_ftables[i].wsect != NULL) {
1006 err = basl_compile(ctx, basl_ftables[i].wsect,
1007 basl_ftables[i].offset);