src/acpi.c

   1 // Support for generating ACPI tables (on emulators)
   2 //
   3 // Copyright (C) 2008,2009  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 LGPLv3 license.
   7
   8 #include "acpi.h" // struct rsdp_descriptor
   9 #include "util.h" // memcpy
  10 #include "pci.h" // pci_find_device
  11 #include "biosvar.h" // GET_EBDA
  12 #include "pci_ids.h" // PCI_VENDOR_ID_INTEL
  13 #include "pci_regs.h" // PCI_INTERRUPT_LINE
  14
  15
  16 /****************************************************/
  17 /* ACPI tables init */
  18
  19 /* Table structure from Linux kernel (the ACPI tables are under the
  20    BSD license) */
  21
  22 #define ACPI_TABLE_HEADER_DEF   /* ACPI common table header */ \
  23     u32 signature;          /* ACPI signature (4 ASCII characters) */ \
  24     u32 length;                 /* Length of table, in bytes, including header */ \
  25     u8  revision;               /* ACPI Specification minor version # */ \
  26     u8  checksum;               /* To make sum of entire table == 0 */ \
  27     u8  oem_id [6];             /* OEM identification */ \
  28     u8  oem_table_id [8];       /* OEM table identification */ \
  29     u32 oem_revision;           /* OEM revision number */ \
  30     u8  asl_compiler_id [4];    /* ASL compiler vendor ID */ \
  31     u32 asl_compiler_revision;  /* ASL compiler revision number */
  32
  33
  34 struct acpi_table_header         /* ACPI common table header */
  35 {
  36     ACPI_TABLE_HEADER_DEF
  37 } PACKED;
  38
  39 /*
  40  * ACPI 1.0 Root System Description Table (RSDT)
  41  */
  42 #define RSDT_SIGNATURE 0x54445352 // RSDT
  43 struct rsdt_descriptor_rev1
  44 {
  45     ACPI_TABLE_HEADER_DEF       /* ACPI common table header */
  46     u32 table_offset_entry[0];  /* Array of pointers to other */
  47     /* ACPI tables */
  48 } PACKED;
  49
  50 /*
  51  * ACPI 1.0 Firmware ACPI Control Structure (FACS)
  52  */
  53 #define FACS_SIGNATURE 0x53434146 // FACS
  54 struct facs_descriptor_rev1
  55 {
  56     u32 signature;           /* ACPI Signature */
  57     u32 length;                 /* Length of structure, in bytes */
  58     u32 hardware_signature;     /* Hardware configuration signature */
  59     u32 firmware_waking_vector; /* ACPI OS waking vector */
  60     u32 global_lock;            /* Global Lock */
  61     u32 S4bios_f        : 1;    /* Indicates if S4BIOS support is present */
  62     u32 reserved1       : 31;   /* Must be 0 */
  63     u8  resverved3 [40];        /* Reserved - must be zero */
  64 } PACKED;
  65
  66
  67 /*
  68  * ACPI 1.0 Fixed ACPI Description Table (FADT)
  69  */
  70 #define FACP_SIGNATURE 0x50434146 // FACP
  71 struct fadt_descriptor_rev1
  72 {
  73     ACPI_TABLE_HEADER_DEF     /* ACPI common table header */
  74     u32 firmware_ctrl;          /* Physical address of FACS */
  75     u32 dsdt;                   /* Physical address of DSDT */
  76     u8  model;                  /* System Interrupt Model */
  77     u8  reserved1;              /* Reserved */
  78     u16 sci_int;                /* System vector of SCI interrupt */
  79     u32 smi_cmd;                /* Port address of SMI command port */
  80     u8  acpi_enable;            /* Value to write to smi_cmd to enable ACPI */
  81     u8  acpi_disable;           /* Value to write to smi_cmd to disable ACPI */
  82     u8  S4bios_req;             /* Value to write to SMI CMD to enter S4BIOS state */
  83     u8  reserved2;              /* Reserved - must be zero */
  84     u32 pm1a_evt_blk;           /* Port address of Power Mgt 1a acpi_event Reg Blk */
  85     u32 pm1b_evt_blk;           /* Port address of Power Mgt 1b acpi_event Reg Blk */
  86     u32 pm1a_cnt_blk;           /* Port address of Power Mgt 1a Control Reg Blk */
  87     u32 pm1b_cnt_blk;           /* Port address of Power Mgt 1b Control Reg Blk */
  88     u32 pm2_cnt_blk;            /* Port address of Power Mgt 2 Control Reg Blk */
  89     u32 pm_tmr_blk;             /* Port address of Power Mgt Timer Ctrl Reg Blk */
  90     u32 gpe0_blk;               /* Port addr of General Purpose acpi_event 0 Reg Blk */
  91     u32 gpe1_blk;               /* Port addr of General Purpose acpi_event 1 Reg Blk */
  92     u8  pm1_evt_len;            /* Byte length of ports at pm1_x_evt_blk */
  93     u8  pm1_cnt_len;            /* Byte length of ports at pm1_x_cnt_blk */
  94     u8  pm2_cnt_len;            /* Byte Length of ports at pm2_cnt_blk */
  95     u8  pm_tmr_len;             /* Byte Length of ports at pm_tm_blk */
  96     u8  gpe0_blk_len;           /* Byte Length of ports at gpe0_blk */
  97     u8  gpe1_blk_len;           /* Byte Length of ports at gpe1_blk */
  98     u8  gpe1_base;              /* Offset in gpe model where gpe1 events start */
  99     u8  reserved3;              /* Reserved */
 100     u16 plvl2_lat;              /* Worst case HW latency to enter/exit C2 state */
 101     u16 plvl3_lat;              /* Worst case HW latency to enter/exit C3 state */
 102     u16 flush_size;             /* Size of area read to flush caches */
 103     u16 flush_stride;           /* Stride used in flushing caches */
 104     u8  duty_offset;            /* Bit location of duty cycle field in p_cnt reg */
 105     u8  duty_width;             /* Bit width of duty cycle field in p_cnt reg */
 106     u8  day_alrm;               /* Index to day-of-month alarm in RTC CMOS RAM */
 107     u8  mon_alrm;               /* Index to month-of-year alarm in RTC CMOS RAM */
 108     u8  century;                /* Index to century in RTC CMOS RAM */
 109     u8  reserved4;              /* Reserved */
 110     u8  reserved4a;             /* Reserved */
 111     u8  reserved4b;             /* Reserved */
 112 #if 0
 113     u32 wb_invd         : 1;    /* The wbinvd instruction works properly */
 114     u32 wb_invd_flush   : 1;    /* The wbinvd flushes but does not invalidate */
 115     u32 proc_c1         : 1;    /* All processors support C1 state */
 116     u32 plvl2_up        : 1;    /* C2 state works on MP system */
 117     u32 pwr_button      : 1;    /* Power button is handled as a generic feature */
 118     u32 sleep_button    : 1;    /* Sleep button is handled as a generic feature, or not present */
 119     u32 fixed_rTC       : 1;    /* RTC wakeup stat not in fixed register space */
 120     u32 rtcs4           : 1;    /* RTC wakeup stat not possible from S4 */
 121     u32 tmr_val_ext     : 1;    /* The tmr_val width is 32 bits (0 = 24 bits) */
 122     u32 reserved5       : 23;   /* Reserved - must be zero */
 123 #else
 124     u32 flags;
 125 #endif
 126 } PACKED;
 127
 128 /*
 129  * MADT values and structures
 130  */
 131
 132 /* Values for MADT PCATCompat */
 133
 134 #define DUAL_PIC                0
 135 #define MULTIPLE_APIC           1
 136
 137
 138 /* Master MADT */
 139
 140 #define APIC_SIGNATURE 0x43495041 // APIC
 141 struct multiple_apic_table
 142 {
 143     ACPI_TABLE_HEADER_DEF     /* ACPI common table header */
 144     u32 local_apic_address;     /* Physical address of local APIC */
 145 #if 0
 146     u32 PCATcompat      : 1;    /* A one indicates system also has dual 8259s */
 147     u32 reserved1       : 31;
 148 #else
 149     u32 flags;
 150 #endif
 151 } PACKED;
 152
 153
 154 /* Values for Type in APIC_HEADER_DEF */
 155
 156 #define APIC_PROCESSOR          0
 157 #define APIC_IO                 1
 158 #define APIC_XRUPT_OVERRIDE     2
 159 #define APIC_NMI                3
 160 #define APIC_LOCAL_NMI          4
 161 #define APIC_ADDRESS_OVERRIDE   5
 162 #define APIC_IO_SAPIC           6
 163 #define APIC_LOCAL_SAPIC        7
 164 #define APIC_XRUPT_SOURCE       8
 165 #define APIC_RESERVED           9           /* 9 and greater are reserved */
 166
 167 /*
 168  * MADT sub-structures (Follow MULTIPLE_APIC_DESCRIPTION_TABLE)
 169  */
 170 #define APIC_HEADER_DEF   /* Common APIC sub-structure header */\
 171     u8  type;                               \
 172     u8  length;
 173
 174 /* Sub-structures for MADT */
 175
 176 struct madt_processor_apic
 177 {
 178     APIC_HEADER_DEF
 179     u8  processor_id;           /* ACPI processor id */
 180     u8  local_apic_id;          /* Processor's local APIC id */
 181 #if 0
 182     u32 processor_enabled: 1;   /* Processor is usable if set */
 183     u32 reserved2       : 31;   /* Reserved, must be zero */
 184 #else
 185     u32 flags;
 186 #endif
 187 } PACKED;
 188
 189 struct madt_io_apic
 190 {
 191     APIC_HEADER_DEF
 192     u8  io_apic_id;             /* I/O APIC ID */
 193     u8  reserved;               /* Reserved - must be zero */
 194     u32 address;                /* APIC physical address */
 195     u32 interrupt;              /* Global system interrupt where INTI
 196                                  * lines start */
 197 } PACKED;
 198
 199 #if CONFIG_KVM
 200 /* IRQs 5,9,10,11 */
 201 #define PCI_ISA_IRQ_MASK    0x0e20
 202 #else
 203 #define PCI_ISA_IRQ_MASK    0x0000
 204 #endif
 205
 206 struct madt_intsrcovr {
 207     APIC_HEADER_DEF
 208     u8  bus;
 209     u8  source;
 210     u32 gsi;
 211     u16 flags;
 212 } PACKED;
 213
 214 #include "acpi-dsdt.hex"
 215
 216 static inline u16 cpu_to_le16(u16 x)
 217 {
 218     return x;
 219 }
 220
 221 static inline u32 cpu_to_le32(u32 x)
 222 {
 223     return x;
 224 }
 225
 226 static void
 227 build_header(struct acpi_table_header *h, u32 sig, int len, u8 rev)
 228 {
 229     h->signature = sig;
 230     h->length = cpu_to_le32(len);
 231     h->revision = rev;
 232     memcpy(h->oem_id, CONFIG_APPNAME6, 6);
 233     memcpy(h->oem_table_id, CONFIG_APPNAME4, 4);
 234     memcpy(h->asl_compiler_id, CONFIG_APPNAME4, 4);
 235     memcpy(h->oem_table_id + 4, (void*)&sig, 4);
 236     h->oem_revision = cpu_to_le32(1);
 237     h->asl_compiler_revision = cpu_to_le32(1);
 238     h->checksum -= checksum(h, len);
 239 }
 240
 241 static void*
 242 build_fadt(int bdf)
 243 {
 244     struct fadt_descriptor_rev1 *fadt = malloc_high(sizeof(*fadt));
 245     struct facs_descriptor_rev1 *facs = memalign_high(64, sizeof(*facs));
 246     void *dsdt = malloc_high(sizeof(AmlCode));
 247
 248     if (!fadt || !facs || !dsdt) {
 249         dprintf(1, "Not enough memory for fadt!\n");
 250         return NULL;
 251     }
 252
 253     /* FACS */
 254     memset(facs, 0, sizeof(*facs));
 255     facs->signature = FACS_SIGNATURE;
 256     facs->length = cpu_to_le32(sizeof(*facs));
 257
 258     /* DSDT */
 259     memcpy(dsdt, AmlCode, sizeof(AmlCode));
 260
 261     /* FADT */
 262     memset(fadt, 0, sizeof(*fadt));
 263     fadt->firmware_ctrl = cpu_to_le32((u32)facs);
 264     fadt->dsdt = cpu_to_le32((u32)dsdt);
 265     fadt->model = 1;
 266     fadt->reserved1 = 0;
 267     int pm_sci_int = pci_config_readb(bdf, PCI_INTERRUPT_LINE);
 268     fadt->sci_int = cpu_to_le16(pm_sci_int);
 269     fadt->smi_cmd = cpu_to_le32(PORT_SMI_CMD);
 270     fadt->acpi_enable = 0xf1;
 271     fadt->acpi_disable = 0xf0;
 272     fadt->pm1a_evt_blk = cpu_to_le32(PORT_ACPI_PM_BASE);
 273     fadt->pm1a_cnt_blk = cpu_to_le32(PORT_ACPI_PM_BASE + 0x04);
 274     fadt->pm_tmr_blk = cpu_to_le32(PORT_ACPI_PM_BASE + 0x08);
 275     fadt->pm1_evt_len = 4;
 276     fadt->pm1_cnt_len = 2;
 277     fadt->pm_tmr_len = 4;
 278     fadt->plvl2_lat = cpu_to_le16(0xfff); // C2 state not supported
 279     fadt->plvl3_lat = cpu_to_le16(0xfff); // C3 state not supported
 280     /* WBINVD + PROC_C1 + PWR_BUTTON + SLP_BUTTON + FIX_RTC */
 281     fadt->flags = cpu_to_le32((1 << 0) | (1 << 2) | (1 << 4) | (1 << 5) | (1 << 6));
 282
 283     build_header((void*)fadt, FACP_SIGNATURE, sizeof(*fadt), 1);
 284
 285     return fadt;
 286 }
 287
 288 static void*
 289 build_madt(void)
 290 {
 291     int smp_cpus = CountCPUs;
 292     int madt_size = (sizeof(struct multiple_apic_table)
 293                      + sizeof(struct madt_processor_apic) * smp_cpus
 294                      + sizeof(struct madt_io_apic)
 295                      + sizeof(struct madt_intsrcovr) * 16);
 296     struct multiple_apic_table *madt = malloc_high(madt_size);
 297     if (!madt) {
 298         dprintf(1, "Not enough memory for madt!\n");
 299         return NULL;
 300     }
 301     memset(madt, 0, madt_size);
 302     madt->local_apic_address = cpu_to_le32(BUILD_APIC_ADDR);
 303     madt->flags = cpu_to_le32(1);
 304     struct madt_processor_apic *apic = (void*)&madt[1];
 305     int i;
 306     for (i=0; i<smp_cpus; i++) {
 307         apic->type = APIC_PROCESSOR;
 308         apic->length = sizeof(*apic);
 309         apic->processor_id = i;
 310         apic->local_apic_id = i;
 311         apic->flags = cpu_to_le32(1);
 312         apic++;
 313     }
 314     struct madt_io_apic *io_apic = (void*)apic;
 315     io_apic->type = APIC_IO;
 316     io_apic->length = sizeof(*io_apic);
 317     io_apic->io_apic_id = smp_cpus;
 318     io_apic->address = cpu_to_le32(BUILD_IOAPIC_ADDR);
 319     io_apic->interrupt = cpu_to_le32(0);
 320
 321     struct madt_intsrcovr *intsrcovr = (void*)&io_apic[1];
 322     if (irq0override) {
 323         memset(intsrcovr, 0, sizeof(*intsrcovr));
 324         intsrcovr->type   = APIC_XRUPT_OVERRIDE;
 325         intsrcovr->length = sizeof(*intsrcovr);
 326         intsrcovr->source = 0;
 327         intsrcovr->gsi    = 2;
 328         intsrcovr->flags  = 0; /* conforms to bus specifications */
 329         intsrcovr++;
 330     }
 331     for (i = 1; i < 16; i++) {
 332         if (!(PCI_ISA_IRQ_MASK & (1 << i)))
 333             /* No need for a INT source override structure. */
 334             continue;
 335         memset(intsrcovr, 0, sizeof(*intsrcovr));
 336         intsrcovr->type   = APIC_XRUPT_OVERRIDE;
 337         intsrcovr->length = sizeof(*intsrcovr);
 338         intsrcovr->source = i;
 339         intsrcovr->gsi    = i;
 340         intsrcovr->flags  = 0xd; /* active high, level triggered */
 341         intsrcovr++;
 342     }
 343
 344     build_header((void*)madt, APIC_SIGNATURE, (void*)intsrcovr - (void*)madt, 1);
 345     return madt;
 346 }
 347
 348 #define SSDT_SIGNATURE 0x54445353 // SSDT
 349 static void*
 350 build_ssdt(void)
 351 {
 352     int smp_cpus = CountCPUs;
 353     int acpi_cpus = smp_cpus > 0xff ? 0xff : smp_cpus;
 354     // calculate the length of processor block and scope block
 355     // excluding PkgLength
 356     int cpu_length = 13 * acpi_cpus + 4;
 357
 358     int length = sizeof(struct acpi_table_header) + 3 + cpu_length;
 359     u8 *ssdt = malloc_high(length);
 360     if (! ssdt) {
 361         dprintf(1, "No space for ssdt!\n");
 362         return NULL;
 363     }
 364
 365     u8 *ssdt_ptr = ssdt;
 366     ssdt_ptr[9] = 0; // checksum;
 367     ssdt_ptr += sizeof(struct acpi_table_header);
 368
 369     // build processor scope header
 370     *(ssdt_ptr++) = 0x10; // ScopeOp
 371     if (cpu_length <= 0x3e) {
 372         *(ssdt_ptr++) = cpu_length + 1;
 373     } else {
 374         *(ssdt_ptr++) = 0x7F;
 375         *(ssdt_ptr++) = (cpu_length + 2) >> 6;
 376     }
 377     *(ssdt_ptr++) = '_'; // Name
 378     *(ssdt_ptr++) = 'P';
 379     *(ssdt_ptr++) = 'R';
 380     *(ssdt_ptr++) = '_';
 381
 382     // build object for each processor
 383     int i;
 384     for (i=0; i<acpi_cpus; i++) {
 385         *(ssdt_ptr++) = 0x5B; // ProcessorOp
 386         *(ssdt_ptr++) = 0x83;
 387         *(ssdt_ptr++) = 0x0B; // Length
 388         *(ssdt_ptr++) = 'C';  // Name (CPUxx)
 389         *(ssdt_ptr++) = 'P';
 390         if ((i & 0xf0) != 0)
 391             *(ssdt_ptr++) = (i >> 4) < 0xa ? (i >> 4) + '0' : (i >> 4) + 'A' - 0xa;
 392         else
 393             *(ssdt_ptr++) = 'U';
 394         *(ssdt_ptr++) = (i & 0xf) < 0xa ? (i & 0xf) + '0' : (i & 0xf) + 'A' - 0xa;
 395         *(ssdt_ptr++) = i;
 396         *(ssdt_ptr++) = 0x10; // Processor block address
 397         *(ssdt_ptr++) = 0xb0;
 398         *(ssdt_ptr++) = 0;
 399         *(ssdt_ptr++) = 0;
 400         *(ssdt_ptr++) = 6;    // Processor block length
 401     }
 402
 403     build_header((void*)ssdt, SSDT_SIGNATURE, ssdt_ptr - ssdt, 1);
 404
 405     return ssdt;
 406 }
 407
 408 struct rsdp_descriptor *RsdpAddr;
 409
 410 #define MAX_ACPI_TABLES 20
 411 void
 412 acpi_bios_init(void)
 413 {
 414     if (! CONFIG_ACPI)
 415         return;
 416
 417     dprintf(3, "init ACPI tables\n");
 418
 419     // This code is hardcoded for PIIX4 Power Management device.
 420     int bdf = pci_find_device(PCI_VENDOR_ID_INTEL
 421                               , PCI_DEVICE_ID_INTEL_82371AB_3);
 422     if (bdf < 0)
 423         // Device not found
 424         return;
 425
 426     // Create initial rsdt table
 427     struct rsdp_descriptor *rsdp = malloc_fseg(sizeof(*rsdp));
 428     if (!rsdp) {
 429         dprintf(1, "Not enough memory for acpi rsdp table!\n");
 430         return;
 431     }
 432
 433     u32 tables[MAX_ACPI_TABLES], tbl_idx = 0;
 434
 435 #define ACPI_INIT_TABLE(X)                                   \
 436     do {                                                     \
 437         tables[tbl_idx] = (u32)(X);                          \
 438         if (tables[tbl_idx])                                 \
 439             tbl_idx++;                                       \
 440     } while(0)
 441
 442     // Add tables
 443     ACPI_INIT_TABLE(build_fadt(bdf));
 444     ACPI_INIT_TABLE(build_ssdt());
 445     ACPI_INIT_TABLE(build_madt());
 446
 447     struct rsdt_descriptor_rev1 *rsdt;
 448     size_t rsdt_len = sizeof(*rsdt) + sizeof(u32) * tbl_idx;
 449     rsdt = malloc_high(rsdt_len);
 450
 451     if (!rsdt) {
 452         dprintf(1, "Not enough memory for acpi rsdt table!\n");
 453         return;
 454     }
 455     memset(rsdt, 0, rsdt_len);
 456     memcpy(rsdt->table_offset_entry, tables, sizeof(u32) * tbl_idx);
 457
 458     build_header((void*)rsdt, RSDT_SIGNATURE, rsdt_len, 1);
 459
 460     // Build rsdp pointer table
 461     memset(rsdp, 0, sizeof(*rsdp));
 462     rsdp->signature = RSDP_SIGNATURE;
 463     memcpy(rsdp->oem_id, CONFIG_APPNAME6, 6);
 464     rsdp->rsdt_physical_address = cpu_to_le32((u32)rsdt);
 465     rsdp->checksum -= checksum(rsdp, 20);
 466     RsdpAddr = rsdp;
 467     dprintf(1, "ACPI tables: RSDP=%p RSDT=%p\n", rsdp, rsdt);
 468 }
 469
 470 u32
 471 find_resume_vector()
 472 {
 473     dprintf(4, "rsdp=%p\n", RsdpAddr);
 474     if (!RsdpAddr || RsdpAddr->signature != RSDP_SIGNATURE)
 475         return 0;
 476     struct rsdt_descriptor_rev1 *rsdt = (void*)RsdpAddr->rsdt_physical_address;
 477     dprintf(4, "rsdt=%p\n", rsdt);
 478     if (!rsdt || rsdt->signature != RSDT_SIGNATURE)
 479         return 0;
 480     void *end = (void*)rsdt + rsdt->length;
 481     int i;
 482     for (i=0; (void*)&rsdt->table_offset_entry[i] < end; i++) {
 483         struct fadt_descriptor_rev1 *fadt = (void*)rsdt->table_offset_entry[i];
 484         if (!fadt || fadt->signature != FACP_SIGNATURE)
 485             continue;
 486         dprintf(4, "fadt=%p\n", fadt);
 487         struct facs_descriptor_rev1 *facs = (void*)fadt->firmware_ctrl;
 488         dprintf(4, "facs=%p\n", facs);
 489         if (! facs || facs->signature != FACS_SIGNATURE)
 490             return 0;
 491         // Found it.
 492         dprintf(4, "resume addr=%d\n", facs->firmware_waking_vector);
 493         return facs->firmware_waking_vector;
 494     }
 495     return 0;
 496 }