usr.sbin/bhyve/acpi.c

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