seabios: acpi: clean up of finding pm device.
[seabios.git] / 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 #include "paravirt.h"
15 #include "dev-i440fx.h" // piix4_fadt_init
16
17 /****************************************************/
18 /* ACPI tables init */
19
20 /* Table structure from Linux kernel (the ACPI tables are under the
21    BSD license) */
22
23 struct acpi_table_header         /* ACPI common table header */
24 {
25     ACPI_TABLE_HEADER_DEF
26 } PACKED;
27
28 /*
29  * ACPI 1.0 Root System Description Table (RSDT)
30  */
31 #define RSDT_SIGNATURE 0x54445352 // RSDT
32 struct rsdt_descriptor_rev1
33 {
34     ACPI_TABLE_HEADER_DEF       /* ACPI common table header */
35     u32 table_offset_entry[0];  /* Array of pointers to other */
36     /* ACPI tables */
37 } PACKED;
38
39 /*
40  * ACPI 1.0 Firmware ACPI Control Structure (FACS)
41  */
42 #define FACS_SIGNATURE 0x53434146 // FACS
43 struct facs_descriptor_rev1
44 {
45     u32 signature;           /* ACPI Signature */
46     u32 length;                 /* Length of structure, in bytes */
47     u32 hardware_signature;     /* Hardware configuration signature */
48     u32 firmware_waking_vector; /* ACPI OS waking vector */
49     u32 global_lock;            /* Global Lock */
50     u32 S4bios_f        : 1;    /* Indicates if S4BIOS support is present */
51     u32 reserved1       : 31;   /* Must be 0 */
52     u8  resverved3 [40];        /* Reserved - must be zero */
53 } PACKED;
54
55
56 /*
57  * MADT values and structures
58  */
59
60 /* Values for MADT PCATCompat */
61
62 #define DUAL_PIC                0
63 #define MULTIPLE_APIC           1
64
65
66 /* Master MADT */
67
68 #define APIC_SIGNATURE 0x43495041 // APIC
69 struct multiple_apic_table
70 {
71     ACPI_TABLE_HEADER_DEF     /* ACPI common table header */
72     u32 local_apic_address;     /* Physical address of local APIC */
73 #if 0
74     u32 PCATcompat      : 1;    /* A one indicates system also has dual 8259s */
75     u32 reserved1       : 31;
76 #else
77     u32 flags;
78 #endif
79 } PACKED;
80
81
82 /* Values for Type in APIC sub-headers */
83
84 #define APIC_PROCESSOR          0
85 #define APIC_IO                 1
86 #define APIC_XRUPT_OVERRIDE     2
87 #define APIC_NMI                3
88 #define APIC_LOCAL_NMI          4
89 #define APIC_ADDRESS_OVERRIDE   5
90 #define APIC_IO_SAPIC           6
91 #define APIC_LOCAL_SAPIC        7
92 #define APIC_XRUPT_SOURCE       8
93 #define APIC_RESERVED           9           /* 9 and greater are reserved */
94
95 /*
96  * MADT sub-structures (Follow MULTIPLE_APIC_DESCRIPTION_TABLE)
97  */
98 #define ACPI_SUB_HEADER_DEF   /* Common ACPI sub-structure header */\
99     u8  type;                               \
100     u8  length;
101
102 /* Sub-structures for MADT */
103
104 struct madt_processor_apic
105 {
106     ACPI_SUB_HEADER_DEF
107     u8  processor_id;           /* ACPI processor id */
108     u8  local_apic_id;          /* Processor's local APIC id */
109 #if 0
110     u32 processor_enabled: 1;   /* Processor is usable if set */
111     u32 reserved2       : 31;   /* Reserved, must be zero */
112 #else
113     u32 flags;
114 #endif
115 } PACKED;
116
117 struct madt_io_apic
118 {
119     ACPI_SUB_HEADER_DEF
120     u8  io_apic_id;             /* I/O APIC ID */
121     u8  reserved;               /* Reserved - must be zero */
122     u32 address;                /* APIC physical address */
123     u32 interrupt;              /* Global system interrupt where INTI
124                                  * lines start */
125 } PACKED;
126
127 /* IRQs 5,9,10,11 */
128 #define PCI_ISA_IRQ_MASK    0x0e20
129
130 struct madt_intsrcovr {
131     ACPI_SUB_HEADER_DEF
132     u8  bus;
133     u8  source;
134     u32 gsi;
135     u16 flags;
136 } PACKED;
137
138 /*
139  * ACPI 2.0 Generic Address Space definition.
140  */
141 struct acpi_20_generic_address {
142     u8  address_space_id;
143     u8  register_bit_width;
144     u8  register_bit_offset;
145     u8  reserved;
146     u64 address;
147 } PACKED;
148
149 /*
150  * HPET Description Table
151  */
152 struct acpi_20_hpet {
153     ACPI_TABLE_HEADER_DEF                    /* ACPI common table header */
154     u32           timer_block_id;
155     struct acpi_20_generic_address addr;
156     u8            hpet_number;
157     u16           min_tick;
158     u8            page_protect;
159 } PACKED;
160 #define ACPI_HPET_ADDRESS 0xFED00000UL
161
162 /*
163  * SRAT (NUMA topology description) table
164  */
165
166 #define SRAT_PROCESSOR          0
167 #define SRAT_MEMORY             1
168
169 struct system_resource_affinity_table
170 {
171     ACPI_TABLE_HEADER_DEF
172     u32    reserved1;
173     u32    reserved2[2];
174 } PACKED;
175
176 struct srat_processor_affinity
177 {
178     ACPI_SUB_HEADER_DEF
179     u8     proximity_lo;
180     u8     local_apic_id;
181     u32    flags;
182     u8     local_sapic_eid;
183     u8     proximity_hi[3];
184     u32    reserved;
185 } PACKED;
186
187 struct srat_memory_affinity
188 {
189     ACPI_SUB_HEADER_DEF
190     u8     proximity[4];
191     u16    reserved1;
192     u32    base_addr_low,base_addr_high;
193     u32    length_low,length_high;
194     u32    reserved2;
195     u32    flags;
196     u32    reserved3[2];
197 } PACKED;
198
199 #include "acpi-dsdt.hex"
200
201 static void
202 build_header(struct acpi_table_header *h, u32 sig, int len, u8 rev)
203 {
204     h->signature = sig;
205     h->length = cpu_to_le32(len);
206     h->revision = rev;
207     memcpy(h->oem_id, CONFIG_APPNAME6, 6);
208     memcpy(h->oem_table_id, CONFIG_APPNAME4, 4);
209     memcpy(h->asl_compiler_id, CONFIG_APPNAME4, 4);
210     memcpy(h->oem_table_id + 4, (void*)&sig, 4);
211     h->oem_revision = cpu_to_le32(1);
212     h->asl_compiler_revision = cpu_to_le32(1);
213     h->checksum -= checksum(h, len);
214 }
215
216 static const struct pci_device_id fadt_init_tbl[] = {
217     /* PIIX4 Power Management device (for ACPI) */
218     PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82371AB_3,
219                piix4_fadt_init),
220
221     PCI_DEVICE_END
222 };
223
224 static void*
225 build_fadt(int bdf)
226 {
227     struct fadt_descriptor_rev1 *fadt = malloc_high(sizeof(*fadt));
228     struct facs_descriptor_rev1 *facs = memalign_high(64, sizeof(*facs));
229     void *dsdt = malloc_high(sizeof(AmlCode));
230
231     if (!fadt || !facs || !dsdt) {
232         warn_noalloc();
233         return NULL;
234     }
235
236     /* FACS */
237     memset(facs, 0, sizeof(*facs));
238     facs->signature = FACS_SIGNATURE;
239     facs->length = cpu_to_le32(sizeof(*facs));
240
241     /* DSDT */
242     memcpy(dsdt, AmlCode, sizeof(AmlCode));
243
244     /* FADT */
245     memset(fadt, 0, sizeof(*fadt));
246     fadt->firmware_ctrl = cpu_to_le32((u32)facs);
247     fadt->dsdt = cpu_to_le32((u32)dsdt);
248     fadt->model = 1;
249     fadt->reserved1 = 0;
250     int pm_sci_int = pci_config_readb(bdf, PCI_INTERRUPT_LINE);
251     fadt->sci_int = cpu_to_le16(pm_sci_int);
252     fadt->smi_cmd = cpu_to_le32(PORT_SMI_CMD);
253     fadt->pm1a_evt_blk = cpu_to_le32(PORT_ACPI_PM_BASE);
254     fadt->pm1a_cnt_blk = cpu_to_le32(PORT_ACPI_PM_BASE + 0x04);
255     fadt->pm_tmr_blk = cpu_to_le32(PORT_ACPI_PM_BASE + 0x08);
256     fadt->pm1_evt_len = 4;
257     fadt->pm1_cnt_len = 2;
258     fadt->pm_tmr_len = 4;
259     fadt->plvl2_lat = cpu_to_le16(0xfff); // C2 state not supported
260     fadt->plvl3_lat = cpu_to_le16(0xfff); // C3 state not supported
261     pci_init_device(fadt_init_tbl, bdf, fadt);
262     /* WBINVD + PROC_C1 + SLP_BUTTON + FIX_RTC */
263     fadt->flags = cpu_to_le32((1 << 0) | (1 << 2) | (1 << 5) | (1 << 6));
264
265     build_header((void*)fadt, FACP_SIGNATURE, sizeof(*fadt), 1);
266
267     return fadt;
268 }
269
270 static void*
271 build_madt(void)
272 {
273     int madt_size = (sizeof(struct multiple_apic_table)
274                      + sizeof(struct madt_processor_apic) * MaxCountCPUs
275                      + sizeof(struct madt_io_apic)
276                      + sizeof(struct madt_intsrcovr) * 16);
277     struct multiple_apic_table *madt = malloc_high(madt_size);
278     if (!madt) {
279         warn_noalloc();
280         return NULL;
281     }
282     memset(madt, 0, madt_size);
283     madt->local_apic_address = cpu_to_le32(BUILD_APIC_ADDR);
284     madt->flags = cpu_to_le32(1);
285     struct madt_processor_apic *apic = (void*)&madt[1];
286     int i;
287     for (i=0; i<MaxCountCPUs; i++) {
288         apic->type = APIC_PROCESSOR;
289         apic->length = sizeof(*apic);
290         apic->processor_id = i;
291         apic->local_apic_id = i;
292         if (i < CountCPUs)
293             apic->flags = cpu_to_le32(1);
294         else
295             apic->flags = cpu_to_le32(0);
296         apic++;
297     }
298     struct madt_io_apic *io_apic = (void*)apic;
299     io_apic->type = APIC_IO;
300     io_apic->length = sizeof(*io_apic);
301     io_apic->io_apic_id = CountCPUs;
302     io_apic->address = cpu_to_le32(BUILD_IOAPIC_ADDR);
303     io_apic->interrupt = cpu_to_le32(0);
304
305     struct madt_intsrcovr *intsrcovr = (void*)&io_apic[1];
306     if (qemu_cfg_irq0_override()) {
307         memset(intsrcovr, 0, sizeof(*intsrcovr));
308         intsrcovr->type   = APIC_XRUPT_OVERRIDE;
309         intsrcovr->length = sizeof(*intsrcovr);
310         intsrcovr->source = 0;
311         intsrcovr->gsi    = 2;
312         intsrcovr->flags  = 0; /* conforms to bus specifications */
313         intsrcovr++;
314     }
315     for (i = 1; i < 16; i++) {
316         if (!(PCI_ISA_IRQ_MASK & (1 << i)))
317             /* No need for a INT source override structure. */
318             continue;
319         memset(intsrcovr, 0, sizeof(*intsrcovr));
320         intsrcovr->type   = APIC_XRUPT_OVERRIDE;
321         intsrcovr->length = sizeof(*intsrcovr);
322         intsrcovr->source = i;
323         intsrcovr->gsi    = i;
324         intsrcovr->flags  = 0xd; /* active high, level triggered */
325         intsrcovr++;
326     }
327
328     build_header((void*)madt, APIC_SIGNATURE, (void*)intsrcovr - (void*)madt, 1);
329     return madt;
330 }
331
332 #define SSDT_SIGNATURE 0x54445353 // SSDT
333 static void*
334 build_ssdt(void)
335 {
336     int acpi_cpus = MaxCountCPUs > 0xff ? 0xff : MaxCountCPUs;
337     // calculate the length of processor block and scope block
338     // excluding PkgLength
339     int cpu_length = 13 * acpi_cpus + 4;
340
341     int length = sizeof(struct acpi_table_header) + 3 + cpu_length;
342     u8 *ssdt = malloc_high(length);
343     if (! ssdt) {
344         warn_noalloc();
345         return NULL;
346     }
347
348     u8 *ssdt_ptr = ssdt;
349     ssdt_ptr[9] = 0; // checksum;
350     ssdt_ptr += sizeof(struct acpi_table_header);
351
352     // build processor scope header
353     *(ssdt_ptr++) = 0x10; // ScopeOp
354     if (cpu_length <= 0x3e) {
355         /* Handle 1-4 CPUs with one byte encoding */
356         *(ssdt_ptr++) = cpu_length + 1;
357     } else {
358         /* Handle 5-314 CPUs with two byte encoding */
359         *(ssdt_ptr++) = 0x40 | ((cpu_length + 2) & 0xf);
360         *(ssdt_ptr++) = (cpu_length + 2) >> 4;
361     }
362     *(ssdt_ptr++) = '_'; // Name
363     *(ssdt_ptr++) = 'P';
364     *(ssdt_ptr++) = 'R';
365     *(ssdt_ptr++) = '_';
366
367     // build object for each processor
368     int i;
369     for (i=0; i<acpi_cpus; i++) {
370         *(ssdt_ptr++) = 0x5B; // ProcessorOp
371         *(ssdt_ptr++) = 0x83;
372         *(ssdt_ptr++) = 0x0B; // Length
373         *(ssdt_ptr++) = 'C';  // Name (CPUxx)
374         *(ssdt_ptr++) = 'P';
375         if ((i & 0xf0) != 0)
376             *(ssdt_ptr++) = (i >> 4) < 0xa ? (i >> 4) + '0' : (i >> 4) + 'A' - 0xa;
377         else
378             *(ssdt_ptr++) = 'U';
379         *(ssdt_ptr++) = (i & 0xf) < 0xa ? (i & 0xf) + '0' : (i & 0xf) + 'A' - 0xa;
380         *(ssdt_ptr++) = i;
381         *(ssdt_ptr++) = 0x10; // Processor block address
382         *(ssdt_ptr++) = 0xb0;
383         *(ssdt_ptr++) = 0;
384         *(ssdt_ptr++) = 0;
385         *(ssdt_ptr++) = 6;    // Processor block length
386     }
387
388     build_header((void*)ssdt, SSDT_SIGNATURE, ssdt_ptr - ssdt, 1);
389
390     return ssdt;
391 }
392
393 #define HPET_SIGNATURE 0x54455048 //HPET
394 static void*
395 build_hpet(void)
396 {
397     struct acpi_20_hpet *hpet = malloc_high(sizeof(*hpet));
398     if (!hpet) {
399         warn_noalloc();
400         return NULL;
401     }
402
403     memset(hpet, 0, sizeof(*hpet));
404     /* Note timer_block_id value must be kept in sync with value advertised by
405      * emulated hpet
406      */
407     hpet->timer_block_id = cpu_to_le32(0x8086a201);
408     hpet->addr.address = cpu_to_le32(ACPI_HPET_ADDRESS);
409     build_header((void*)hpet, HPET_SIGNATURE, sizeof(*hpet), 1);
410
411     return hpet;
412 }
413
414 static void
415 acpi_build_srat_memory(struct srat_memory_affinity *numamem,
416                        u64 base, u64 len, int node, int enabled)
417 {
418     numamem->type = SRAT_MEMORY;
419     numamem->length = sizeof(*numamem);
420     memset (numamem->proximity, 0 ,4);
421     numamem->proximity[0] = node;
422     numamem->flags = cpu_to_le32(!!enabled);
423     numamem->base_addr_low = base & 0xFFFFFFFF;
424     numamem->base_addr_high = base >> 32;
425     numamem->length_low = len & 0xFFFFFFFF;
426     numamem->length_high = len >> 32;
427 }
428
429 #define SRAT_SIGNATURE 0x54415253 //HPET
430 static void *
431 build_srat(void)
432 {
433     int nb_numa_nodes = qemu_cfg_get_numa_nodes();
434
435     if (nb_numa_nodes == 0)
436         return NULL;
437
438     u64 *numadata = malloc_tmphigh(sizeof(u64) * (MaxCountCPUs + nb_numa_nodes));
439     if (!numadata) {
440         warn_noalloc();
441         return NULL;
442     }
443
444     qemu_cfg_get_numa_data(numadata, MaxCountCPUs + nb_numa_nodes);
445
446     struct system_resource_affinity_table *srat;
447     int srat_size = sizeof(*srat) +
448         sizeof(struct srat_processor_affinity) * MaxCountCPUs +
449         sizeof(struct srat_memory_affinity) * (nb_numa_nodes + 2);
450
451     srat = malloc_high(srat_size);
452     if (!srat) {
453         warn_noalloc();
454         free(numadata);
455         return NULL;
456     }
457
458     memset(srat, 0, srat_size);
459     srat->reserved1=1;
460     struct srat_processor_affinity *core = (void*)(srat + 1);
461     int i;
462     u64 curnode;
463
464     for (i = 0; i < MaxCountCPUs; ++i) {
465         core->type = SRAT_PROCESSOR;
466         core->length = sizeof(*core);
467         core->local_apic_id = i;
468         curnode = *numadata++;
469         core->proximity_lo = curnode;
470         memset(core->proximity_hi, 0, 3);
471         core->local_sapic_eid = 0;
472         if (i < CountCPUs)
473             core->flags = cpu_to_le32(1);
474         else
475             core->flags = 0;
476         core++;
477     }
478
479
480     /* the memory map is a bit tricky, it contains at least one hole
481      * from 640k-1M and possibly another one from 3.5G-4G.
482      */
483     struct srat_memory_affinity *numamem = (void*)core;
484     int slots = 0;
485     u64 mem_len, mem_base, next_base = 0;
486
487     acpi_build_srat_memory(numamem, 0, 640*1024, 0, 1);
488     next_base = 1024 * 1024;
489     numamem++;
490     slots++;
491     for (i = 1; i < nb_numa_nodes + 1; ++i) {
492         mem_base = next_base;
493         mem_len = *numadata++;
494         if (i == 1)
495             mem_len -= 1024 * 1024;
496         next_base = mem_base + mem_len;
497
498         /* Cut out the PCI hole */
499         if (mem_base <= RamSize && next_base > RamSize) {
500             mem_len -= next_base - RamSize;
501             if (mem_len > 0) {
502                 acpi_build_srat_memory(numamem, mem_base, mem_len, i-1, 1);
503                 numamem++;
504                 slots++;
505             }
506             mem_base = 1ULL << 32;
507             mem_len = next_base - RamSize;
508             next_base += (1ULL << 32) - RamSize;
509         }
510         acpi_build_srat_memory(numamem, mem_base, mem_len, i-1, 1);
511         numamem++;
512         slots++;
513     }
514     for (; slots < nb_numa_nodes + 2; slots++) {
515         acpi_build_srat_memory(numamem, 0, 0, 0, 0);
516         numamem++;
517     }
518
519     build_header((void*)srat, SRAT_SIGNATURE, srat_size, 1);
520
521     free(numadata);
522     return srat;
523 }
524
525 static const struct pci_device_id acpi_find_tbl[] = {
526     /* PIIX4 Power Management device. */
527     PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82371AB_3, NULL),
528
529     PCI_DEVICE_END,
530 };
531
532 struct rsdp_descriptor *RsdpAddr;
533
534 #define MAX_ACPI_TABLES 20
535 void
536 acpi_bios_init(void)
537 {
538     if (! CONFIG_ACPI)
539         return;
540
541     dprintf(3, "init ACPI tables\n");
542
543     // This code is hardcoded for PIIX4 Power Management device.
544     int bdf = pci_find_init_device(acpi_find_tbl, NULL);
545     if (bdf < 0)
546         // Device not found
547         return;
548
549     // Create initial rsdt table
550     struct rsdp_descriptor *rsdp = malloc_fseg(sizeof(*rsdp));
551     if (!rsdp) {
552         warn_noalloc();
553         return;
554     }
555
556     u32 tables[MAX_ACPI_TABLES], tbl_idx = 0;
557
558 #define ACPI_INIT_TABLE(X)                                   \
559     do {                                                     \
560         tables[tbl_idx] = (u32)(X);                          \
561         if (tables[tbl_idx])                                 \
562             tbl_idx++;                                       \
563     } while(0)
564
565     // Add tables
566     ACPI_INIT_TABLE(build_fadt(bdf));
567     ACPI_INIT_TABLE(build_ssdt());
568     ACPI_INIT_TABLE(build_madt());
569     ACPI_INIT_TABLE(build_hpet());
570     ACPI_INIT_TABLE(build_srat());
571
572     u16 i, external_tables = qemu_cfg_acpi_additional_tables();
573
574     for(i = 0; i < external_tables; i++) {
575         u16 len = qemu_cfg_next_acpi_table_len();
576         void *addr = malloc_high(len);
577         if (!addr) {
578             warn_noalloc();
579             continue;
580         }
581         ACPI_INIT_TABLE(qemu_cfg_next_acpi_table_load(addr, len));
582         if (tbl_idx == MAX_ACPI_TABLES) {
583             warn_noalloc();
584             break;
585         }
586     }
587
588     struct rsdt_descriptor_rev1 *rsdt;
589     size_t rsdt_len = sizeof(*rsdt) + sizeof(u32) * tbl_idx;
590     rsdt = malloc_high(rsdt_len);
591
592     if (!rsdt) {
593         warn_noalloc();
594         return;
595     }
596     memset(rsdt, 0, rsdt_len);
597     memcpy(rsdt->table_offset_entry, tables, sizeof(u32) * tbl_idx);
598
599     build_header((void*)rsdt, RSDT_SIGNATURE, rsdt_len, 1);
600
601     // Build rsdp pointer table
602     memset(rsdp, 0, sizeof(*rsdp));
603     rsdp->signature = RSDP_SIGNATURE;
604     memcpy(rsdp->oem_id, CONFIG_APPNAME6, 6);
605     rsdp->rsdt_physical_address = cpu_to_le32((u32)rsdt);
606     rsdp->checksum -= checksum(rsdp, 20);
607     RsdpAddr = rsdp;
608     dprintf(1, "ACPI tables: RSDP=%p RSDT=%p\n", rsdp, rsdt);
609 }
610
611 u32
612 find_resume_vector(void)
613 {
614     dprintf(4, "rsdp=%p\n", RsdpAddr);
615     if (!RsdpAddr || RsdpAddr->signature != RSDP_SIGNATURE)
616         return 0;
617     struct rsdt_descriptor_rev1 *rsdt = (void*)RsdpAddr->rsdt_physical_address;
618     dprintf(4, "rsdt=%p\n", rsdt);
619     if (!rsdt || rsdt->signature != RSDT_SIGNATURE)
620         return 0;
621     void *end = (void*)rsdt + rsdt->length;
622     int i;
623     for (i=0; (void*)&rsdt->table_offset_entry[i] < end; i++) {
624         struct fadt_descriptor_rev1 *fadt = (void*)rsdt->table_offset_entry[i];
625         if (!fadt || fadt->signature != FACP_SIGNATURE)
626             continue;
627         dprintf(4, "fadt=%p\n", fadt);
628         struct facs_descriptor_rev1 *facs = (void*)fadt->firmware_ctrl;
629         dprintf(4, "facs=%p\n", facs);
630         if (! facs || facs->signature != FACS_SIGNATURE)
631             return 0;
632         // Found it.
633         dprintf(4, "resume addr=%d\n", facs->firmware_waking_vector);
634         return facs->firmware_waking_vector;
635     }
636     return 0;
637 }