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