src/acpi.c

   1 // Support for generating ACPI tables (on emulators)
   2 //
   3 // Copyright (C) 2008  Kevin O'Connor <kevin@koconnor.net>
   4 // Copyright (C) 2006 Fabrice Bellard
   5 //
   6 // This file may be distributed under the terms of the GNU GPLv3 license.
   7
   8 #include "acpi.h" // struct rsdp_descriptor
   9 #include "util.h" // memcpy
  10 #include "memmap.h" // bios_table_cur_addr
  11 #include "pci.h" // pci_find_device
  12 #include "biosvar.h" // GET_EBDA
  13
  14
  15 /****************************************************/
  16 /* ACPI tables init */
  17
  18 /* Table structure from Linux kernel (the ACPI tables are under the
  19    BSD license) */
  20
  21 #define ACPI_TABLE_HEADER_DEF   /* ACPI common table header */ \
  22         u8                            signature [4];          /* ACPI signature (4 ASCII characters) */\
  23         u32                             length;                 /* Length of table, in bytes, including header */\
  24         u8                              revision;               /* ACPI Specification minor version # */\
  25         u8                              checksum;               /* To make sum of entire table == 0 */\
  26         u8                            oem_id [6];             /* OEM identification */\
  27         u8                            oem_table_id [8];       /* OEM table identification */\
  28         u32                             oem_revision;           /* OEM revision number */\
  29         u8                            asl_compiler_id [4];    /* ASL compiler vendor ID */\
  30         u32                             asl_compiler_revision;  /* ASL compiler revision number */
  31
  32
  33 struct acpi_table_header         /* ACPI common table header */
  34 {
  35         ACPI_TABLE_HEADER_DEF
  36 };
  37
  38 /*
  39  * ACPI 1.0 Root System Description Table (RSDT)
  40  */
  41 struct rsdt_descriptor_rev1
  42 {
  43         ACPI_TABLE_HEADER_DEF                           /* ACPI common table header */
  44         u32                             table_offset_entry [3]; /* Array of pointers to other */
  45                          /* ACPI tables */
  46 };
  47
  48 /*
  49  * ACPI 1.0 Firmware ACPI Control Structure (FACS)
  50  */
  51 struct facs_descriptor_rev1
  52 {
  53         u8                            signature[4];           /* ACPI Signature */
  54         u32                             length;                 /* Length of structure, in bytes */
  55         u32                             hardware_signature;     /* Hardware configuration signature */
  56         u32                             firmware_waking_vector; /* ACPI OS waking vector */
  57         u32                             global_lock;            /* Global Lock */
  58         u32                             S4bios_f        : 1;    /* Indicates if S4BIOS support is present */
  59         u32                             reserved1       : 31;   /* Must be 0 */
  60         u8                              resverved3 [40];        /* Reserved - must be zero */
  61 };
  62
  63
  64 /*
  65  * ACPI 1.0 Fixed ACPI Description Table (FADT)
  66  */
  67 struct fadt_descriptor_rev1
  68 {
  69         ACPI_TABLE_HEADER_DEF                           /* ACPI common table header */
  70         u32                             firmware_ctrl;          /* Physical address of FACS */
  71         u32                             dsdt;                   /* Physical address of DSDT */
  72         u8                              model;                  /* System Interrupt Model */
  73         u8                              reserved1;              /* Reserved */
  74         u16                             sci_int;                /* System vector of SCI interrupt */
  75         u32                             smi_cmd;                /* Port address of SMI command port */
  76         u8                              acpi_enable;            /* Value to write to smi_cmd to enable ACPI */
  77         u8                              acpi_disable;           /* Value to write to smi_cmd to disable ACPI */
  78         u8                              S4bios_req;             /* Value to write to SMI CMD to enter S4BIOS state */
  79         u8                              reserved2;              /* Reserved - must be zero */
  80         u32                             pm1a_evt_blk;           /* Port address of Power Mgt 1a acpi_event Reg Blk */
  81         u32                             pm1b_evt_blk;           /* Port address of Power Mgt 1b acpi_event Reg Blk */
  82         u32                             pm1a_cnt_blk;           /* Port address of Power Mgt 1a Control Reg Blk */
  83         u32                             pm1b_cnt_blk;           /* Port address of Power Mgt 1b Control Reg Blk */
  84         u32                             pm2_cnt_blk;            /* Port address of Power Mgt 2 Control Reg Blk */
  85         u32                             pm_tmr_blk;             /* Port address of Power Mgt Timer Ctrl Reg Blk */
  86         u32                             gpe0_blk;               /* Port addr of General Purpose acpi_event 0 Reg Blk */
  87         u32                             gpe1_blk;               /* Port addr of General Purpose acpi_event 1 Reg Blk */
  88         u8                              pm1_evt_len;            /* Byte length of ports at pm1_x_evt_blk */
  89         u8                              pm1_cnt_len;            /* Byte length of ports at pm1_x_cnt_blk */
  90         u8                              pm2_cnt_len;            /* Byte Length of ports at pm2_cnt_blk */
  91         u8                              pm_tmr_len;              /* Byte Length of ports at pm_tm_blk */
  92         u8                              gpe0_blk_len;           /* Byte Length of ports at gpe0_blk */
  93         u8                              gpe1_blk_len;           /* Byte Length of ports at gpe1_blk */
  94         u8                              gpe1_base;              /* Offset in gpe model where gpe1 events start */
  95         u8                              reserved3;              /* Reserved */
  96         u16                             plvl2_lat;              /* Worst case HW latency to enter/exit C2 state */
  97         u16                             plvl3_lat;              /* Worst case HW latency to enter/exit C3 state */
  98         u16                             flush_size;             /* Size of area read to flush caches */
  99         u16                             flush_stride;           /* Stride used in flushing caches */
 100         u8                              duty_offset;            /* Bit location of duty cycle field in p_cnt reg */
 101         u8                              duty_width;             /* Bit width of duty cycle field in p_cnt reg */
 102         u8                              day_alrm;               /* Index to day-of-month alarm in RTC CMOS RAM */
 103         u8                              mon_alrm;               /* Index to month-of-year alarm in RTC CMOS RAM */
 104         u8                              century;                /* Index to century in RTC CMOS RAM */
 105         u8                              reserved4;              /* Reserved */
 106         u8                              reserved4a;             /* Reserved */
 107         u8                              reserved4b;             /* Reserved */
 108 #if 0
 109         u32                             wb_invd         : 1;    /* The wbinvd instruction works properly */
 110         u32                             wb_invd_flush   : 1;    /* The wbinvd flushes but does not invalidate */
 111         u32                             proc_c1         : 1;    /* All processors support C1 state */
 112         u32                             plvl2_up        : 1;    /* C2 state works on MP system */
 113         u32                             pwr_button      : 1;    /* Power button is handled as a generic feature */
 114         u32                             sleep_button    : 1;    /* Sleep button is handled as a generic feature, or not present */
 115         u32                             fixed_rTC       : 1;    /* RTC wakeup stat not in fixed register space */
 116         u32                             rtcs4           : 1;    /* RTC wakeup stat not possible from S4 */
 117         u32                             tmr_val_ext     : 1;    /* The tmr_val width is 32 bits (0 = 24 bits) */
 118         u32                             reserved5       : 23;   /* Reserved - must be zero */
 119 #else
 120         u32 flags;
 121 #endif
 122 };
 123
 124 /*
 125  * MADT values and structures
 126  */
 127
 128 /* Values for MADT PCATCompat */
 129
 130 #define DUAL_PIC                0
 131 #define MULTIPLE_APIC           1
 132
 133
 134 /* Master MADT */
 135
 136 struct multiple_apic_table
 137 {
 138         ACPI_TABLE_HEADER_DEF                           /* ACPI common table header */
 139         u32                             local_apic_address;     /* Physical address of local APIC */
 140 #if 0
 141         u32                             PCATcompat      : 1;    /* A one indicates system also has dual 8259s */
 142         u32                             reserved1       : 31;
 143 #else
 144         u32                             flags;
 145 #endif
 146 };
 147
 148
 149 /* Values for Type in APIC_HEADER_DEF */
 150
 151 #define APIC_PROCESSOR          0
 152 #define APIC_IO                 1
 153 #define APIC_XRUPT_OVERRIDE     2
 154 #define APIC_NMI                3
 155 #define APIC_LOCAL_NMI          4
 156 #define APIC_ADDRESS_OVERRIDE   5
 157 #define APIC_IO_SAPIC           6
 158 #define APIC_LOCAL_SAPIC        7
 159 #define APIC_XRUPT_SOURCE       8
 160 #define APIC_RESERVED           9           /* 9 and greater are reserved */
 161
 162 /*
 163  * MADT sub-structures (Follow MULTIPLE_APIC_DESCRIPTION_TABLE)
 164  */
 165 #define APIC_HEADER_DEF                     /* Common APIC sub-structure header */\
 166         u8                              type; \
 167         u8                              length;
 168
 169 /* Sub-structures for MADT */
 170
 171 struct madt_processor_apic
 172 {
 173         APIC_HEADER_DEF
 174         u8                              processor_id;           /* ACPI processor id */
 175         u8                              local_apic_id;          /* Processor's local APIC id */
 176 #if 0
 177         u32                             processor_enabled: 1;   /* Processor is usable if set */
 178         u32                             reserved2       : 31;   /* Reserved, must be zero */
 179 #else
 180         u32 flags;
 181 #endif
 182 };
 183
 184 struct madt_io_apic
 185 {
 186         APIC_HEADER_DEF
 187         u8                              io_apic_id;             /* I/O APIC ID */
 188         u8                              reserved;               /* Reserved - must be zero */
 189         u32                             address;                /* APIC physical address */
 190         u32                             interrupt;              /* Global system interrupt where INTI
 191                           * lines start */
 192 };
 193
 194 #include "acpi-dsdt.hex"
 195
 196 static inline u16 cpu_to_le16(u16 x)
 197 {
 198     return x;
 199 }
 200
 201 static inline u32 cpu_to_le32(u32 x)
 202 {
 203     return x;
 204 }
 205
 206 static void acpi_build_table_header(struct acpi_table_header *h,
 207                                     char *sig, int len, u8 rev)
 208 {
 209     memcpy(h->signature, sig, 4);
 210     h->length = cpu_to_le32(len);
 211     h->revision = rev;
 212     if (CONFIG_QEMU) {
 213         memcpy(h->oem_id, "QEMU  ", 6);
 214         memcpy(h->oem_table_id, "QEMU", 4);
 215         memcpy(h->asl_compiler_id, "QEMU", 4);
 216     } else {
 217         memcpy(h->oem_id, "BOCHS ", 6);
 218         memcpy(h->oem_table_id, "BXPC", 4);
 219         memcpy(h->asl_compiler_id, "BXPC", 4);
 220     }
 221     memcpy(h->oem_table_id + 4, sig, 4);
 222     h->oem_revision = cpu_to_le32(1);
 223     h->asl_compiler_revision = cpu_to_le32(1);
 224     h->checksum = -checksum((void *)h, len);
 225 }
 226
 227 static int
 228 acpi_build_processor_ssdt(u8 *ssdt)
 229 {
 230     u8 *ssdt_ptr = ssdt;
 231     int i, length;
 232     int smp_cpus = smp_probe();
 233     int acpi_cpus = smp_cpus > 0xff ? 0xff : smp_cpus;
 234
 235     ssdt_ptr[9] = 0; // checksum;
 236     ssdt_ptr += sizeof(struct acpi_table_header);
 237
 238     // caluculate the length of processor block and scope block excluding PkgLength
 239     length = 0x0d * acpi_cpus + 4;
 240
 241     // build processor scope header
 242     *(ssdt_ptr++) = 0x10; // ScopeOp
 243     if (length <= 0x3e) {
 244         *(ssdt_ptr++) = length + 1;
 245     } else {
 246         *(ssdt_ptr++) = 0x7F;
 247         *(ssdt_ptr++) = (length + 2) >> 6;
 248     }
 249     *(ssdt_ptr++) = '_'; // Name
 250     *(ssdt_ptr++) = 'P';
 251     *(ssdt_ptr++) = 'R';
 252     *(ssdt_ptr++) = '_';
 253
 254     // build object for each processor
 255     for(i=0;i<acpi_cpus;i++) {
 256         *(ssdt_ptr++) = 0x5B; // ProcessorOp
 257         *(ssdt_ptr++) = 0x83;
 258         *(ssdt_ptr++) = 0x0B; // Length
 259         *(ssdt_ptr++) = 'C';  // Name (CPUxx)
 260         *(ssdt_ptr++) = 'P';
 261         if ((i & 0xf0) != 0)
 262             *(ssdt_ptr++) = (i >> 4) < 0xa ? (i >> 4) + '0' : (i >> 4) + 'A' - 0xa;
 263         else
 264             *(ssdt_ptr++) = 'U';
 265         *(ssdt_ptr++) = (i & 0xf) < 0xa ? (i & 0xf) + '0' : (i & 0xf) + 'A' - 0xa;
 266         *(ssdt_ptr++) = i;
 267         *(ssdt_ptr++) = 0x10; // Processor block address
 268         *(ssdt_ptr++) = 0xb0;
 269         *(ssdt_ptr++) = 0;
 270         *(ssdt_ptr++) = 0;
 271         *(ssdt_ptr++) = 6;    // Processor block length
 272     }
 273
 274     acpi_build_table_header((struct acpi_table_header *)ssdt,
 275                             "SSDT", ssdt_ptr - ssdt, 1);
 276
 277     return ssdt_ptr - ssdt;
 278 }
 279
 280 /* base_addr must be a multiple of 4KB */
 281 void acpi_bios_init(void)
 282 {
 283     if (! CONFIG_ACPI)
 284         return;
 285
 286     // This code is hardcoded for PIIX4 Power Management device.
 287     PCIDevice d;
 288     int ret = pci_find_device(0x8086, 0x7113, 0, &d);
 289     if (ret)
 290         // Device not found
 291         return;
 292
 293     struct rsdp_descriptor *rsdp;
 294     struct rsdt_descriptor_rev1 *rsdt;
 295     struct fadt_descriptor_rev1 *fadt;
 296     struct facs_descriptor_rev1 *facs;
 297     struct multiple_apic_table *madt;
 298     u8 *dsdt, *ssdt;
 299     u32 base_addr, rsdt_addr, fadt_addr, addr, facs_addr, dsdt_addr, ssdt_addr;
 300     u32 acpi_tables_size, madt_addr, madt_size;
 301     int i;
 302
 303     /* reserve memory space for tables */
 304     bios_table_cur_addr = ALIGN(bios_table_cur_addr, 16);
 305     rsdp = (void *)(bios_table_cur_addr);
 306     bios_table_cur_addr += sizeof(*rsdp);
 307
 308     addr = base_addr = GET_EBDA(ram_size) - CONFIG_ACPI_DATA_SIZE;
 309     add_e820(addr, CONFIG_ACPI_DATA_SIZE, E820_ACPI);
 310     rsdt_addr = addr;
 311     rsdt = (void *)(addr);
 312     addr += sizeof(*rsdt);
 313
 314     fadt_addr = addr;
 315     fadt = (void *)(addr);
 316     addr += sizeof(*fadt);
 317
 318     /* XXX: FACS should be in RAM */
 319     addr = (addr + 63) & ~63; /* 64 byte alignment for FACS */
 320     facs_addr = addr;
 321     facs = (void *)(addr);
 322     addr += sizeof(*facs);
 323
 324     dsdt_addr = addr;
 325     dsdt = (void *)(addr);
 326     addr += sizeof(AmlCode);
 327
 328     ssdt_addr = addr;
 329     ssdt = (void *)(addr);
 330     addr += acpi_build_processor_ssdt(ssdt);
 331
 332     int smp_cpus = smp_probe();
 333     addr = (addr + 7) & ~7;
 334     madt_addr = addr;
 335     madt_size = sizeof(*madt) +
 336         sizeof(struct madt_processor_apic) * smp_cpus +
 337         sizeof(struct madt_io_apic);
 338     madt = (void *)(addr);
 339     addr += madt_size;
 340
 341     acpi_tables_size = addr - base_addr;
 342
 343     dprintf(1, "ACPI tables: RSDP addr=0x%08lx"
 344             " ACPI DATA addr=0x%08lx size=0x%x\n",
 345             (unsigned long)rsdp,
 346             (unsigned long)rsdt, acpi_tables_size);
 347
 348     /* RSDP */
 349     memset(rsdp, 0, sizeof(*rsdp));
 350     memcpy(rsdp->signature, "RSD PTR ", 8);
 351     if (CONFIG_QEMU)
 352         memcpy(rsdp->oem_id, "QEMU  ", 6);
 353     else
 354         memcpy(rsdp->oem_id, "BOCHS ", 6);
 355     rsdp->rsdt_physical_address = cpu_to_le32(rsdt_addr);
 356     rsdp->checksum = -checksum((void *)rsdp, 20);
 357
 358     /* RSDT */
 359     memset(rsdt, 0, sizeof(*rsdt));
 360     rsdt->table_offset_entry[0] = cpu_to_le32(fadt_addr);
 361     rsdt->table_offset_entry[1] = cpu_to_le32(madt_addr);
 362     rsdt->table_offset_entry[2] = cpu_to_le32(ssdt_addr);
 363     acpi_build_table_header((struct acpi_table_header *)rsdt,
 364                             "RSDT", sizeof(*rsdt), 1);
 365
 366     /* FADT */
 367     memset(fadt, 0, sizeof(*fadt));
 368     fadt->firmware_ctrl = cpu_to_le32(facs_addr);
 369     fadt->dsdt = cpu_to_le32(dsdt_addr);
 370     fadt->model = 1;
 371     fadt->reserved1 = 0;
 372     int pm_sci_int = pci_config_readb(d, PCI_INTERRUPT_LINE);
 373     fadt->sci_int = cpu_to_le16(pm_sci_int);
 374     fadt->smi_cmd = cpu_to_le32(BUILD_SMI_CMD_IO_ADDR);
 375     fadt->acpi_enable = 0xf1;
 376     fadt->acpi_disable = 0xf0;
 377     fadt->pm1a_evt_blk = cpu_to_le32(BUILD_PM_IO_BASE);
 378     fadt->pm1a_cnt_blk = cpu_to_le32(BUILD_PM_IO_BASE + 0x04);
 379     fadt->pm_tmr_blk = cpu_to_le32(BUILD_PM_IO_BASE + 0x08);
 380     fadt->pm1_evt_len = 4;
 381     fadt->pm1_cnt_len = 2;
 382     fadt->pm_tmr_len = 4;
 383     fadt->plvl2_lat = cpu_to_le16(0xfff); // C2 state not supported
 384     fadt->plvl3_lat = cpu_to_le16(0xfff); // C3 state not supported
 385     /* WBINVD + PROC_C1 + PWR_BUTTON + SLP_BUTTON + FIX_RTC */
 386     fadt->flags = cpu_to_le32((1 << 0) | (1 << 2) | (1 << 4) | (1 << 5) | (1 << 6));
 387     acpi_build_table_header((struct acpi_table_header *)fadt, "FACP",
 388                             sizeof(*fadt), 1);
 389
 390     /* FACS */
 391     memset(facs, 0, sizeof(*facs));
 392     memcpy(facs->signature, "FACS", 4);
 393     facs->length = cpu_to_le32(sizeof(*facs));
 394
 395     /* DSDT */
 396     memcpy(dsdt, AmlCode, sizeof(AmlCode));
 397
 398     /* MADT */
 399     {
 400         struct madt_processor_apic *apic;
 401         struct madt_io_apic *io_apic;
 402
 403         memset(madt, 0, madt_size);
 404         madt->local_apic_address = cpu_to_le32(0xfee00000);
 405         madt->flags = cpu_to_le32(1);
 406         apic = (void *)(madt + 1);
 407         for(i=0;i<smp_cpus;i++) {
 408             apic->type = APIC_PROCESSOR;
 409             apic->length = sizeof(*apic);
 410             apic->processor_id = i;
 411             apic->local_apic_id = i;
 412             apic->flags = cpu_to_le32(1);
 413             apic++;
 414         }
 415         io_apic = (void *)apic;
 416         io_apic->type = APIC_IO;
 417         io_apic->length = sizeof(*io_apic);
 418         io_apic->io_apic_id = smp_cpus;
 419         io_apic->address = cpu_to_le32(0xfec00000);
 420         io_apic->interrupt = cpu_to_le32(0);
 421
 422         acpi_build_table_header((struct acpi_table_header *)madt,
 423                                 "APIC", madt_size, 1);
 424     }
 425 }