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,
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.)
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)
57 #include <sys/cdefs.h>
58 __FBSDID("$FreeBSD$");
60 #include <sys/param.h>
61 #include <sys/errno.h>
71 #include <machine/vmm.h>
80 * Define the base address of the ACPI tables, the sizes of some tables,
81 * and the offsets to the individual tables,
83 #define BHYVE_ACPI_BASE 0xf2400
84 #define RSDT_OFFSET 0x040
85 #define XSDT_OFFSET 0x080
86 #define MADT_OFFSET 0x100
88 * The MADT consists of:
90 * 8 * maxcpu Processor Local APIC entries
92 * 2 * 10 Interrupt Source Override entires
93 * 6 Local APIC NMI entry
95 #define MADT_SIZE (44 + VM_MAXCPU*8 + 12 + 2*10 + 6)
96 #define FADT_OFFSET (MADT_OFFSET + MADT_SIZE)
97 #define FADT_SIZE 0x140
98 #define HPET_OFFSET (FADT_OFFSET + FADT_SIZE)
99 #define HPET_SIZE 0x40
100 #define MCFG_OFFSET (HPET_OFFSET + HPET_SIZE)
101 #define MCFG_SIZE 0x40
102 #define FACS_OFFSET (MCFG_OFFSET + MCFG_SIZE)
103 #define FACS_SIZE 0x40
104 #define DSDT_OFFSET (FACS_OFFSET + FACS_SIZE)
106 #define BHYVE_ASL_TEMPLATE "bhyve.XXXXXXX"
107 #define BHYVE_ASL_SUFFIX ".aml"
108 #define BHYVE_ASL_COMPILER "/usr/sbin/iasl"
110 static int basl_keep_temps;
111 static int basl_verbose_iasl;
112 static int basl_ncpu;
113 static uint32_t basl_acpi_base = BHYVE_ACPI_BASE;
114 static uint32_t hpet_capabilities;
117 * Contains the full pathname of the template to be passed
118 * to mkstemp/mktemps(3)
120 static char basl_template[MAXPATHLEN];
121 static char basl_stemplate[MAXPATHLEN];
124 * State for dsdt_line(), dsdt_indent(), and dsdt_unindent().
126 static FILE *dsdt_fp;
127 static int dsdt_indent_level;
128 static int dsdt_error;
133 char f_name[MAXPATHLEN];
136 #define EFPRINTF(...) \
137 if (fprintf(__VA_ARGS__) < 0) goto err_exit;
140 if (fflush(x) != 0) goto err_exit;
143 basl_fwrite_rsdp(FILE *fp)
145 EFPRINTF(fp, "/*\n");
146 EFPRINTF(fp, " * bhyve RSDP template\n");
147 EFPRINTF(fp, " */\n");
148 EFPRINTF(fp, "[0008]\t\tSignature : \"RSD PTR \"\n");
149 EFPRINTF(fp, "[0001]\t\tChecksum : 43\n");
150 EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
151 EFPRINTF(fp, "[0001]\t\tRevision : 02\n");
152 EFPRINTF(fp, "[0004]\t\tRSDT Address : %08X\n",
153 basl_acpi_base + RSDT_OFFSET);
154 EFPRINTF(fp, "[0004]\t\tLength : 00000024\n");
155 EFPRINTF(fp, "[0008]\t\tXSDT Address : 00000000%08X\n",
156 basl_acpi_base + XSDT_OFFSET);
157 EFPRINTF(fp, "[0001]\t\tExtended Checksum : 00\n");
158 EFPRINTF(fp, "[0003]\t\tReserved : 000000\n");
169 basl_fwrite_rsdt(FILE *fp)
171 EFPRINTF(fp, "/*\n");
172 EFPRINTF(fp, " * bhyve RSDT template\n");
173 EFPRINTF(fp, " */\n");
174 EFPRINTF(fp, "[0004]\t\tSignature : \"RSDT\"\n");
175 EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
176 EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
177 EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
178 EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
179 EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVRSDT \"\n");
180 EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
181 /* iasl will fill in the compiler ID/revision fields */
182 EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
183 EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
186 /* Add in pointers to the MADT, FADT and HPET */
187 EFPRINTF(fp, "[0004]\t\tACPI Table Address 0 : %08X\n",
188 basl_acpi_base + MADT_OFFSET);
189 EFPRINTF(fp, "[0004]\t\tACPI Table Address 1 : %08X\n",
190 basl_acpi_base + FADT_OFFSET);
191 EFPRINTF(fp, "[0004]\t\tACPI Table Address 2 : %08X\n",
192 basl_acpi_base + HPET_OFFSET);
193 EFPRINTF(fp, "[0004]\t\tACPI Table Address 3 : %08X\n",
194 basl_acpi_base + MCFG_OFFSET);
205 basl_fwrite_xsdt(FILE *fp)
207 EFPRINTF(fp, "/*\n");
208 EFPRINTF(fp, " * bhyve XSDT template\n");
209 EFPRINTF(fp, " */\n");
210 EFPRINTF(fp, "[0004]\t\tSignature : \"XSDT\"\n");
211 EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
212 EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
213 EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
214 EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
215 EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVXSDT \"\n");
216 EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
217 /* iasl will fill in the compiler ID/revision fields */
218 EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
219 EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
222 /* Add in pointers to the MADT, FADT and HPET */
223 EFPRINTF(fp, "[0004]\t\tACPI Table Address 0 : 00000000%08X\n",
224 basl_acpi_base + MADT_OFFSET);
225 EFPRINTF(fp, "[0004]\t\tACPI Table Address 1 : 00000000%08X\n",
226 basl_acpi_base + FADT_OFFSET);
227 EFPRINTF(fp, "[0004]\t\tACPI Table Address 2 : 00000000%08X\n",
228 basl_acpi_base + HPET_OFFSET);
229 EFPRINTF(fp, "[0004]\t\tACPI Table Address 3 : 00000000%08X\n",
230 basl_acpi_base + MCFG_OFFSET);
241 basl_fwrite_madt(FILE *fp)
245 EFPRINTF(fp, "/*\n");
246 EFPRINTF(fp, " * bhyve MADT template\n");
247 EFPRINTF(fp, " */\n");
248 EFPRINTF(fp, "[0004]\t\tSignature : \"APIC\"\n");
249 EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
250 EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
251 EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
252 EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
253 EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVMADT \"\n");
254 EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
256 /* iasl will fill in the compiler ID/revision fields */
257 EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
258 EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
261 EFPRINTF(fp, "[0004]\t\tLocal Apic Address : FEE00000\n");
262 EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000001\n");
263 EFPRINTF(fp, "\t\t\tPC-AT Compatibility : 1\n");
266 /* Add a Processor Local APIC entry for each CPU */
267 for (i = 0; i < basl_ncpu; i++) {
268 EFPRINTF(fp, "[0001]\t\tSubtable Type : 00\n");
269 EFPRINTF(fp, "[0001]\t\tLength : 08\n");
270 /* iasl expects hex values for the proc and apic id's */
271 EFPRINTF(fp, "[0001]\t\tProcessor ID : %02x\n", i);
272 EFPRINTF(fp, "[0001]\t\tLocal Apic ID : %02x\n", i);
273 EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000001\n");
274 EFPRINTF(fp, "\t\t\tProcessor Enabled : 1\n");
275 EFPRINTF(fp, "\t\t\tRuntime Online Capable : 0\n");
279 /* Always a single IOAPIC entry, with ID 0 */
280 EFPRINTF(fp, "[0001]\t\tSubtable Type : 01\n");
281 EFPRINTF(fp, "[0001]\t\tLength : 0C\n");
282 /* iasl expects a hex value for the i/o apic id */
283 EFPRINTF(fp, "[0001]\t\tI/O Apic ID : %02x\n", 0);
284 EFPRINTF(fp, "[0001]\t\tReserved : 00\n");
285 EFPRINTF(fp, "[0004]\t\tAddress : fec00000\n");
286 EFPRINTF(fp, "[0004]\t\tInterrupt : 00000000\n");
289 /* Legacy IRQ0 is connected to pin 2 of the IOAPIC */
290 EFPRINTF(fp, "[0001]\t\tSubtable Type : 02\n");
291 EFPRINTF(fp, "[0001]\t\tLength : 0A\n");
292 EFPRINTF(fp, "[0001]\t\tBus : 00\n");
293 EFPRINTF(fp, "[0001]\t\tSource : 00\n");
294 EFPRINTF(fp, "[0004]\t\tInterrupt : 00000002\n");
295 EFPRINTF(fp, "[0002]\t\tFlags (decoded below) : 0005\n");
296 EFPRINTF(fp, "\t\t\tPolarity : 1\n");
297 EFPRINTF(fp, "\t\t\tTrigger Mode : 1\n");
300 EFPRINTF(fp, "[0001]\t\tSubtable Type : 02\n");
301 EFPRINTF(fp, "[0001]\t\tLength : 0A\n");
302 EFPRINTF(fp, "[0001]\t\tBus : 00\n");
303 EFPRINTF(fp, "[0001]\t\tSource : %02X\n", SCI_INT);
304 EFPRINTF(fp, "[0004]\t\tInterrupt : %08X\n", SCI_INT);
305 EFPRINTF(fp, "[0002]\t\tFlags (decoded below) : 0000\n");
306 EFPRINTF(fp, "\t\t\tPolarity : 3\n");
307 EFPRINTF(fp, "\t\t\tTrigger Mode : 3\n");
310 /* Local APIC NMI is connected to LINT 1 on all CPUs */
311 EFPRINTF(fp, "[0001]\t\tSubtable Type : 04\n");
312 EFPRINTF(fp, "[0001]\t\tLength : 06\n");
313 EFPRINTF(fp, "[0001]\t\tProcessor ID : FF\n");
314 EFPRINTF(fp, "[0002]\t\tFlags (decoded below) : 0005\n");
315 EFPRINTF(fp, "\t\t\tPolarity : 1\n");
316 EFPRINTF(fp, "\t\t\tTrigger Mode : 1\n");
317 EFPRINTF(fp, "[0001]\t\tInterrupt Input LINT : 01\n");
329 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 : %08X\n", IO_GPE0_BLK);
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 : %02x\n", IO_GPE0_LEN);
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 : %02x\n", IO_GPE0_LEN * 8);
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 : %016X\n", IO_GPE0_BLK);
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)
548 EFPRINTF(fp, "/*\n");
549 EFPRINTF(fp, " * bhyve HPET template\n");
550 EFPRINTF(fp, " */\n");
551 EFPRINTF(fp, "[0004]\t\tSignature : \"HPET\"\n");
552 EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
553 EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
554 EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
555 EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
556 EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVHPET \"\n");
557 EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
559 /* iasl will fill in the compiler ID/revision fields */
560 EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
561 EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
564 EFPRINTF(fp, "[0004]\t\tHardware Block ID : %08X\n", hpet_capabilities);
566 "[0012]\t\tTimer Block Register : [Generic Address Structure]\n");
567 EFPRINTF(fp, "[0001]\t\tSpace ID : 00 [SystemMemory]\n");
568 EFPRINTF(fp, "[0001]\t\tBit Width : 00\n");
569 EFPRINTF(fp, "[0001]\t\tBit Offset : 00\n");
571 "[0001]\t\tEncoded Access Width : 00 [Undefined/Legacy]\n");
572 EFPRINTF(fp, "[0008]\t\tAddress : 00000000FED00000\n");
575 EFPRINTF(fp, "[0001]\t\tSequence Number : 00\n");
576 EFPRINTF(fp, "[0002]\t\tMinimum Clock Ticks : 0000\n");
577 EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000001\n");
578 EFPRINTF(fp, "\t\t\t4K Page Protect : 1\n");
579 EFPRINTF(fp, "\t\t\t64K Page Protect : 0\n");
591 basl_fwrite_mcfg(FILE *fp)
593 EFPRINTF(fp, "/*\n");
594 EFPRINTF(fp, " * bhyve MCFG template\n");
595 EFPRINTF(fp, " */\n");
596 EFPRINTF(fp, "[0004]\t\tSignature : \"MCFG\"\n");
597 EFPRINTF(fp, "[0004]\t\tTable Length : 00000000\n");
598 EFPRINTF(fp, "[0001]\t\tRevision : 01\n");
599 EFPRINTF(fp, "[0001]\t\tChecksum : 00\n");
600 EFPRINTF(fp, "[0006]\t\tOem ID : \"BHYVE \"\n");
601 EFPRINTF(fp, "[0008]\t\tOem Table ID : \"BVMCFG \"\n");
602 EFPRINTF(fp, "[0004]\t\tOem Revision : 00000001\n");
604 /* iasl will fill in the compiler ID/revision fields */
605 EFPRINTF(fp, "[0004]\t\tAsl Compiler ID : \"xxxx\"\n");
606 EFPRINTF(fp, "[0004]\t\tAsl Compiler Revision : 00000000\n");
607 EFPRINTF(fp, "[0008]\t\tReserved : 0\n");
610 EFPRINTF(fp, "[0008]\t\tBase Address : %016lX\n", pci_ecfg_base());
611 EFPRINTF(fp, "[0002]\t\tSegment Group Number : 0000\n");
612 EFPRINTF(fp, "[0001]\t\tStart Bus Number : 00\n");
613 EFPRINTF(fp, "[0001]\t\tEnd Bus Number : FF\n");
614 EFPRINTF(fp, "[0004]\t\tReserved : 0\n");
622 basl_fwrite_facs(FILE *fp)
624 EFPRINTF(fp, "/*\n");
625 EFPRINTF(fp, " * bhyve FACS template\n");
626 EFPRINTF(fp, " */\n");
627 EFPRINTF(fp, "[0004]\t\tSignature : \"FACS\"\n");
628 EFPRINTF(fp, "[0004]\t\tLength : 00000040\n");
629 EFPRINTF(fp, "[0004]\t\tHardware Signature : 00000000\n");
630 EFPRINTF(fp, "[0004]\t\t32 Firmware Waking Vector : 00000000\n");
631 EFPRINTF(fp, "[0004]\t\tGlobal Lock : 00000000\n");
632 EFPRINTF(fp, "[0004]\t\tFlags (decoded below) : 00000000\n");
633 EFPRINTF(fp, "\t\t\tS4BIOS Support Present : 0\n");
634 EFPRINTF(fp, "\t\t\t64-bit Wake Supported (V2) : 0\n");
636 "[0008]\t\t64 Firmware Waking Vector : 0000000000000000\n");
637 EFPRINTF(fp, "[0001]\t\tVersion : 02\n");
638 EFPRINTF(fp, "[0003]\t\tReserved : 000000\n");
639 EFPRINTF(fp, "[0004]\t\tOspmFlags (decoded below) : 00000000\n");
640 EFPRINTF(fp, "\t\t\t64-bit Wake Env Required (V2) : 0\n");
651 * Helper routines for writing to the DSDT from other modules.
654 dsdt_line(const char *fmt, ...)
661 if (strcmp(fmt, "") != 0) {
662 if (dsdt_indent_level != 0)
663 EFPRINTF(dsdt_fp, "%*c", dsdt_indent_level * 2, ' ');
665 if (vfprintf(dsdt_fp, fmt, ap) < 0) {
671 EFPRINTF(dsdt_fp, "\n");
679 dsdt_indent(int levels)
682 dsdt_indent_level += levels;
683 assert(dsdt_indent_level >= 0);
687 dsdt_unindent(int levels)
690 assert(dsdt_indent_level >= levels);
691 dsdt_indent_level -= levels;
695 dsdt_fixed_ioport(uint16_t iobase, uint16_t length)
698 dsdt_line("IO (Decode16,");
699 dsdt_line(" 0x%04X, // Range Minimum", iobase);
700 dsdt_line(" 0x%04X, // Range Maximum", iobase);
701 dsdt_line(" 0x01, // Alignment");
702 dsdt_line(" 0x%02X, // Length", length);
707 dsdt_fixed_irq(uint8_t irq)
710 dsdt_line("IRQNoFlags ()");
711 dsdt_line(" {%d}", irq);
715 dsdt_fixed_mem32(uint32_t base, uint32_t length)
718 dsdt_line("Memory32Fixed (ReadWrite,");
719 dsdt_line(" 0x%08X, // Address Base", base);
720 dsdt_line(" 0x%08X, // Address Length", length);
725 basl_fwrite_dsdt(FILE *fp)
729 dsdt_indent_level = 0;
732 dsdt_line(" * bhyve DSDT template");
734 dsdt_line("DefinitionBlock (\"bhyve_dsdt.aml\", \"DSDT\", 2,"
735 "\"BHYVE \", \"BVDSDT \", 0x00000001)");
737 dsdt_line(" Name (_S5, Package ()");
746 dsdt_line(" Scope (_SB.PC00)");
748 dsdt_line(" Device (HPET)");
750 dsdt_line(" Name (_HID, EISAID(\"PNP0103\"))");
751 dsdt_line(" Name (_UID, 0)");
752 dsdt_line(" Name (_CRS, ResourceTemplate ()");
755 dsdt_fixed_mem32(0xFED00000, 0x400);
777 basl_open(struct basl_fio *bf, int suffix)
784 strlcpy(bf->f_name, basl_stemplate, MAXPATHLEN);
785 bf->fd = mkstemps(bf->f_name, strlen(BHYVE_ASL_SUFFIX));
787 strlcpy(bf->f_name, basl_template, MAXPATHLEN);
788 bf->fd = mkstemp(bf->f_name);
792 bf->fp = fdopen(bf->fd, "w+");
793 if (bf->fp == NULL) {
805 basl_close(struct basl_fio *bf)
808 if (!basl_keep_temps)
814 basl_start(struct basl_fio *in, struct basl_fio *out)
818 err = basl_open(in, 0);
820 err = basl_open(out, 1);
830 basl_end(struct basl_fio *in, struct basl_fio *out)
838 basl_load(struct vmctx *ctx, int fd, uint64_t off)
843 if (fstat(fd, &sb) < 0)
846 gaddr = paddr_guest2host(ctx, basl_acpi_base + off, sb.st_size);
850 if (read(fd, gaddr, sb.st_size) < 0)
857 basl_compile(struct vmctx *ctx, int (*fwrite_section)(FILE *), uint64_t offset)
859 struct basl_fio io[2];
860 static char iaslbuf[3*MAXPATHLEN + 10];
864 err = basl_start(&io[0], &io[1]);
866 err = (*fwrite_section)(io[0].fp);
870 * iasl sends the results of the compilation to
871 * stdout. Shut this down by using the shell to
872 * redirect stdout to /dev/null, unless the user
873 * has requested verbose output for debugging
876 fmt = basl_verbose_iasl ?
878 "/bin/sh -c \"%s -p %s %s\" 1> /dev/null";
880 snprintf(iaslbuf, sizeof(iaslbuf),
883 io[1].f_name, io[0].f_name);
884 err = system(iaslbuf);
888 * Copy the aml output file into guest
889 * memory at the specified location
891 err = basl_load(ctx, io[1].fd, offset);
894 basl_end(&io[0], &io[1]);
901 basl_make_templates(void)
912 if ((tmpdir = getenv("BHYVE_TMPDIR")) == NULL || *tmpdir == '\0' ||
913 (tmpdir = getenv("TMPDIR")) == NULL || *tmpdir == '\0') {
917 len = strlen(tmpdir);
919 if ((len + sizeof(BHYVE_ASL_TEMPLATE) + 1) < MAXPATHLEN) {
920 strcpy(basl_template, tmpdir);
921 while (len > 0 && basl_template[len - 1] == '/')
923 basl_template[len] = '/';
924 strcpy(&basl_template[len + 1], BHYVE_ASL_TEMPLATE);
930 * len has been intialized (and maybe adjusted) above
932 if ((len + sizeof(BHYVE_ASL_TEMPLATE) + 1 +
933 sizeof(BHYVE_ASL_SUFFIX)) < MAXPATHLEN) {
934 strcpy(basl_stemplate, tmpdir);
935 basl_stemplate[len] = '/';
936 strcpy(&basl_stemplate[len + 1], BHYVE_ASL_TEMPLATE);
937 len = strlen(basl_stemplate);
938 strcpy(&basl_stemplate[len], BHYVE_ASL_SUFFIX);
947 int (*wsect)(FILE *fp);
951 { basl_fwrite_rsdp, 0},
952 { basl_fwrite_rsdt, RSDT_OFFSET },
953 { basl_fwrite_xsdt, XSDT_OFFSET },
954 { basl_fwrite_madt, MADT_OFFSET },
955 { basl_fwrite_fadt, FADT_OFFSET },
956 { basl_fwrite_hpet, HPET_OFFSET },
957 { basl_fwrite_mcfg, MCFG_OFFSET },
958 { basl_fwrite_facs, FACS_OFFSET },
959 { basl_fwrite_dsdt, DSDT_OFFSET },
964 acpi_build(struct vmctx *ctx, int ncpu)
971 err = vm_get_hpet_capabilities(ctx, &hpet_capabilities);
976 * For debug, allow the user to have iasl compiler output sent
977 * to stdout rather than /dev/null
979 if (getenv("BHYVE_ACPI_VERBOSE_IASL"))
980 basl_verbose_iasl = 1;
983 * Allow the user to keep the generated ASL files for debugging
984 * instead of deleting them following use
986 if (getenv("BHYVE_ACPI_KEEPTMPS"))
990 err = basl_make_templates();
993 * Run through all the ASL files, compiling them and
994 * copying them into guest memory
996 while (!err && basl_ftables[i].wsect != NULL) {
997 err = basl_compile(ctx, basl_ftables[i].wsect,
998 basl_ftables[i].offset);