Update USB documentation.
[qemu/mini2440.git] / hw / acpi.c
blob8fb054428dc038c51eacbe65958d0739a427ce46
1 /*
2 * ACPI implementation
3 *
4 * Copyright (c) 2006 Fabrice Bellard
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License version 2 as published by the Free Software Foundation.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 #include "vl.h"
21 //#define DEBUG
23 /* i82731AB (PIIX4) compatible power management function */
24 #define PM_FREQ 3579545
26 /* XXX: make them variable */
27 #define PM_IO_BASE 0xb000
28 #define SMI_CMD_IO_ADDR 0xb040
29 #define ACPI_DBG_IO_ADDR 0xb044
31 typedef struct PIIX4PMState {
32 PCIDevice dev;
33 uint16_t pmsts;
34 uint16_t pmen;
35 uint16_t pmcntrl;
36 QEMUTimer *tmr_timer;
37 int64_t tmr_overflow_time;
38 } PIIX4PMState;
40 #define RTC_EN (1 << 10)
41 #define PWRBTN_EN (1 << 8)
42 #define GBL_EN (1 << 5)
43 #define TMROF_EN (1 << 0)
45 #define SCI_EN (1 << 0)
47 #define SUS_EN (1 << 13)
49 /* Note: only used for ACPI bios init. Could be deleted when ACPI init
50 is integrated in Bochs BIOS */
51 static PIIX4PMState *piix4_pm_state;
53 static uint32_t get_pmtmr(PIIX4PMState *s)
55 uint32_t d;
56 d = muldiv64(qemu_get_clock(vm_clock), PM_FREQ, ticks_per_sec);
57 return d & 0xffffff;
60 static int get_pmsts(PIIX4PMState *s)
62 int64_t d;
63 int pmsts;
64 pmsts = s->pmsts;
65 d = muldiv64(qemu_get_clock(vm_clock), PM_FREQ, ticks_per_sec);
66 if (d >= s->tmr_overflow_time)
67 s->pmsts |= TMROF_EN;
68 return pmsts;
71 static void pm_update_sci(PIIX4PMState *s)
73 int sci_level, pmsts;
74 int64_t expire_time;
76 pmsts = get_pmsts(s);
77 sci_level = (((pmsts & s->pmen) &
78 (RTC_EN | PWRBTN_EN | GBL_EN | TMROF_EN)) != 0);
79 pci_set_irq(&s->dev, 0, sci_level);
80 /* schedule a timer interruption if needed */
81 if ((s->pmen & TMROF_EN) && !(pmsts & TMROF_EN)) {
82 expire_time = muldiv64(s->tmr_overflow_time, ticks_per_sec, PM_FREQ);
83 qemu_mod_timer(s->tmr_timer, expire_time);
84 } else {
85 qemu_del_timer(s->tmr_timer);
89 static void pm_tmr_timer(void *opaque)
91 PIIX4PMState *s = opaque;
92 pm_update_sci(s);
95 static void pm_ioport_writew(void *opaque, uint32_t addr, uint32_t val)
97 PIIX4PMState *s = opaque;
98 addr &= 0x3f;
99 switch(addr) {
100 case 0x00:
102 int64_t d;
103 int pmsts;
104 pmsts = get_pmsts(s);
105 if (pmsts & val & TMROF_EN) {
106 /* if TMRSTS is reset, then compute the new overflow time */
107 d = muldiv64(qemu_get_clock(vm_clock), PM_FREQ, ticks_per_sec);
108 s->tmr_overflow_time = (d + 0x800000LL) & ~0x7fffffLL;
110 s->pmsts &= ~val;
111 pm_update_sci(s);
113 break;
114 case 0x02:
115 s->pmen = val;
116 pm_update_sci(s);
117 break;
118 case 0x04:
120 int sus_typ;
121 s->pmcntrl = val & ~(SUS_EN);
122 if (val & SUS_EN) {
123 /* change suspend type */
124 sus_typ = (val >> 10) & 3;
125 switch(sus_typ) {
126 case 0: /* soft power off */
127 qemu_system_shutdown_request();
128 break;
129 default:
130 break;
134 break;
135 default:
136 break;
138 #ifdef DEBUG
139 printf("PM writew port=0x%04x val=0x%04x\n", addr, val);
140 #endif
143 static uint32_t pm_ioport_readw(void *opaque, uint32_t addr)
145 PIIX4PMState *s = opaque;
146 uint32_t val;
148 addr &= 0x3f;
149 switch(addr) {
150 case 0x00:
151 val = get_pmsts(s);
152 break;
153 case 0x02:
154 val = s->pmen;
155 break;
156 case 0x04:
157 val = s->pmcntrl;
158 break;
159 default:
160 val = 0;
161 break;
163 #ifdef DEBUG
164 printf("PM readw port=0x%04x val=0x%04x\n", addr, val);
165 #endif
166 return val;
169 static void pm_ioport_writel(void *opaque, uint32_t addr, uint32_t val)
171 // PIIX4PMState *s = opaque;
172 addr &= 0x3f;
173 #ifdef DEBUG
174 printf("PM writel port=0x%04x val=0x%08x\n", addr, val);
175 #endif
178 static uint32_t pm_ioport_readl(void *opaque, uint32_t addr)
180 PIIX4PMState *s = opaque;
181 uint32_t val;
183 addr &= 0x3f;
184 switch(addr) {
185 case 0x08:
186 val = get_pmtmr(s);
187 break;
188 default:
189 val = 0;
190 break;
192 #ifdef DEBUG
193 printf("PM readl port=0x%04x val=0x%08x\n", addr, val);
194 #endif
195 return val;
198 static void smi_cmd_writeb(void *opaque, uint32_t addr, uint32_t val)
200 PIIX4PMState *s = opaque;
201 #ifdef DEBUG
202 printf("SMI cmd val=0x%02x\n", val);
203 #endif
204 switch(val) {
205 case 0xf0: /* ACPI disable */
206 s->pmcntrl &= ~SCI_EN;
207 break;
208 case 0xf1: /* ACPI enable */
209 s->pmcntrl |= SCI_EN;
210 break;
214 static void acpi_dbg_writel(void *opaque, uint32_t addr, uint32_t val)
216 #if defined(DEBUG)
217 printf("ACPI: DBG: 0x%08x\n", val);
218 #endif
221 /* XXX: we still add it to the PIIX3 and we count on the fact that
222 OSes are smart enough to accept this strange configuration */
223 void piix4_pm_init(PCIBus *bus, int devfn)
225 PIIX4PMState *s;
226 uint8_t *pci_conf;
227 uint32_t pm_io_base;
229 s = (PIIX4PMState *)pci_register_device(bus,
230 "PM", sizeof(PIIX4PMState),
231 devfn, NULL, NULL);
232 pci_conf = s->dev.config;
233 pci_conf[0x00] = 0x86;
234 pci_conf[0x01] = 0x80;
235 pci_conf[0x02] = 0x13;
236 pci_conf[0x03] = 0x71;
237 pci_conf[0x08] = 0x00; // revision number
238 pci_conf[0x09] = 0x00;
239 pci_conf[0x0a] = 0x80; // other bridge device
240 pci_conf[0x0b] = 0x06; // bridge device
241 pci_conf[0x0e] = 0x00; // header_type
242 pci_conf[0x3d] = 0x01; // interrupt pin 1
243 pci_conf[0x60] = 0x10; // release number
245 pm_io_base = PM_IO_BASE;
246 pci_conf[0x40] = pm_io_base | 1;
247 pci_conf[0x41] = pm_io_base >> 8;
248 register_ioport_write(pm_io_base, 64, 2, pm_ioport_writew, s);
249 register_ioport_read(pm_io_base, 64, 2, pm_ioport_readw, s);
250 register_ioport_write(pm_io_base, 64, 4, pm_ioport_writel, s);
251 register_ioport_read(pm_io_base, 64, 4, pm_ioport_readl, s);
253 register_ioport_write(SMI_CMD_IO_ADDR, 1, 1, smi_cmd_writeb, s);
254 register_ioport_write(ACPI_DBG_IO_ADDR, 4, 4, acpi_dbg_writel, s);
256 s->tmr_timer = qemu_new_timer(vm_clock, pm_tmr_timer, s);
257 piix4_pm_state = s;
260 /* ACPI tables */
261 /* XXX: move them in the Bochs BIOS ? */
263 /*************************************************/
265 /* Table structure from Linux kernel (the ACPI tables are under the
266 BSD license) */
268 #define ACPI_TABLE_HEADER_DEF /* ACPI common table header */ \
269 uint8_t signature [4]; /* ACPI signature (4 ASCII characters) */\
270 uint32_t length; /* Length of table, in bytes, including header */\
271 uint8_t revision; /* ACPI Specification minor version # */\
272 uint8_t checksum; /* To make sum of entire table == 0 */\
273 uint8_t oem_id [6]; /* OEM identification */\
274 uint8_t oem_table_id [8]; /* OEM table identification */\
275 uint32_t oem_revision; /* OEM revision number */\
276 uint8_t asl_compiler_id [4]; /* ASL compiler vendor ID */\
277 uint32_t asl_compiler_revision; /* ASL compiler revision number */
280 struct acpi_table_header /* ACPI common table header */
282 ACPI_TABLE_HEADER_DEF
285 struct rsdp_descriptor /* Root System Descriptor Pointer */
287 uint8_t signature [8]; /* ACPI signature, contains "RSD PTR " */
288 uint8_t checksum; /* To make sum of struct == 0 */
289 uint8_t oem_id [6]; /* OEM identification */
290 uint8_t revision; /* Must be 0 for 1.0, 2 for 2.0 */
291 uint32_t rsdt_physical_address; /* 32-bit physical address of RSDT */
292 uint32_t length; /* XSDT Length in bytes including hdr */
293 uint64_t xsdt_physical_address; /* 64-bit physical address of XSDT */
294 uint8_t extended_checksum; /* Checksum of entire table */
295 uint8_t reserved [3]; /* Reserved field must be 0 */
299 * ACPI 1.0 Root System Description Table (RSDT)
301 struct rsdt_descriptor_rev1
303 ACPI_TABLE_HEADER_DEF /* ACPI common table header */
304 uint32_t table_offset_entry [2]; /* Array of pointers to other */
305 /* ACPI tables */
309 * ACPI 1.0 Firmware ACPI Control Structure (FACS)
311 struct facs_descriptor_rev1
313 uint8_t signature[4]; /* ACPI Signature */
314 uint32_t length; /* Length of structure, in bytes */
315 uint32_t hardware_signature; /* Hardware configuration signature */
316 uint32_t firmware_waking_vector; /* ACPI OS waking vector */
317 uint32_t global_lock; /* Global Lock */
318 uint32_t S4bios_f : 1; /* Indicates if S4BIOS support is present */
319 uint32_t reserved1 : 31; /* Must be 0 */
320 uint8_t resverved3 [40]; /* Reserved - must be zero */
325 * ACPI 1.0 Fixed ACPI Description Table (FADT)
327 struct fadt_descriptor_rev1
329 ACPI_TABLE_HEADER_DEF /* ACPI common table header */
330 uint32_t firmware_ctrl; /* Physical address of FACS */
331 uint32_t dsdt; /* Physical address of DSDT */
332 uint8_t model; /* System Interrupt Model */
333 uint8_t reserved1; /* Reserved */
334 uint16_t sci_int; /* System vector of SCI interrupt */
335 uint32_t smi_cmd; /* Port address of SMI command port */
336 uint8_t acpi_enable; /* Value to write to smi_cmd to enable ACPI */
337 uint8_t acpi_disable; /* Value to write to smi_cmd to disable ACPI */
338 uint8_t S4bios_req; /* Value to write to SMI CMD to enter S4BIOS state */
339 uint8_t reserved2; /* Reserved - must be zero */
340 uint32_t pm1a_evt_blk; /* Port address of Power Mgt 1a acpi_event Reg Blk */
341 uint32_t pm1b_evt_blk; /* Port address of Power Mgt 1b acpi_event Reg Blk */
342 uint32_t pm1a_cnt_blk; /* Port address of Power Mgt 1a Control Reg Blk */
343 uint32_t pm1b_cnt_blk; /* Port address of Power Mgt 1b Control Reg Blk */
344 uint32_t pm2_cnt_blk; /* Port address of Power Mgt 2 Control Reg Blk */
345 uint32_t pm_tmr_blk; /* Port address of Power Mgt Timer Ctrl Reg Blk */
346 uint32_t gpe0_blk; /* Port addr of General Purpose acpi_event 0 Reg Blk */
347 uint32_t gpe1_blk; /* Port addr of General Purpose acpi_event 1 Reg Blk */
348 uint8_t pm1_evt_len; /* Byte length of ports at pm1_x_evt_blk */
349 uint8_t pm1_cnt_len; /* Byte length of ports at pm1_x_cnt_blk */
350 uint8_t pm2_cnt_len; /* Byte Length of ports at pm2_cnt_blk */
351 uint8_t pm_tmr_len; /* Byte Length of ports at pm_tm_blk */
352 uint8_t gpe0_blk_len; /* Byte Length of ports at gpe0_blk */
353 uint8_t gpe1_blk_len; /* Byte Length of ports at gpe1_blk */
354 uint8_t gpe1_base; /* Offset in gpe model where gpe1 events start */
355 uint8_t reserved3; /* Reserved */
356 uint16_t plvl2_lat; /* Worst case HW latency to enter/exit C2 state */
357 uint16_t plvl3_lat; /* Worst case HW latency to enter/exit C3 state */
358 uint16_t flush_size; /* Size of area read to flush caches */
359 uint16_t flush_stride; /* Stride used in flushing caches */
360 uint8_t duty_offset; /* Bit location of duty cycle field in p_cnt reg */
361 uint8_t duty_width; /* Bit width of duty cycle field in p_cnt reg */
362 uint8_t day_alrm; /* Index to day-of-month alarm in RTC CMOS RAM */
363 uint8_t mon_alrm; /* Index to month-of-year alarm in RTC CMOS RAM */
364 uint8_t century; /* Index to century in RTC CMOS RAM */
365 uint8_t reserved4; /* Reserved */
366 uint8_t reserved4a; /* Reserved */
367 uint8_t reserved4b; /* Reserved */
368 #if 0
369 uint32_t wb_invd : 1; /* The wbinvd instruction works properly */
370 uint32_t wb_invd_flush : 1; /* The wbinvd flushes but does not invalidate */
371 uint32_t proc_c1 : 1; /* All processors support C1 state */
372 uint32_t plvl2_up : 1; /* C2 state works on MP system */
373 uint32_t pwr_button : 1; /* Power button is handled as a generic feature */
374 uint32_t sleep_button : 1; /* Sleep button is handled as a generic feature, or not present */
375 uint32_t fixed_rTC : 1; /* RTC wakeup stat not in fixed register space */
376 uint32_t rtcs4 : 1; /* RTC wakeup stat not possible from S4 */
377 uint32_t tmr_val_ext : 1; /* The tmr_val width is 32 bits (0 = 24 bits) */
378 uint32_t reserved5 : 23; /* Reserved - must be zero */
379 #else
380 uint32_t flags;
381 #endif
385 * MADT values and structures
388 /* Values for MADT PCATCompat */
390 #define DUAL_PIC 0
391 #define MULTIPLE_APIC 1
394 /* Master MADT */
396 struct multiple_apic_table
398 ACPI_TABLE_HEADER_DEF /* ACPI common table header */
399 uint32_t local_apic_address; /* Physical address of local APIC */
400 #if 0
401 uint32_t PCATcompat : 1; /* A one indicates system also has dual 8259s */
402 uint32_t reserved1 : 31;
403 #else
404 uint32_t flags;
405 #endif
409 /* Values for Type in APIC_HEADER_DEF */
411 #define APIC_PROCESSOR 0
412 #define APIC_IO 1
413 #define APIC_XRUPT_OVERRIDE 2
414 #define APIC_NMI 3
415 #define APIC_LOCAL_NMI 4
416 #define APIC_ADDRESS_OVERRIDE 5
417 #define APIC_IO_SAPIC 6
418 #define APIC_LOCAL_SAPIC 7
419 #define APIC_XRUPT_SOURCE 8
420 #define APIC_RESERVED 9 /* 9 and greater are reserved */
423 * MADT sub-structures (Follow MULTIPLE_APIC_DESCRIPTION_TABLE)
425 #define APIC_HEADER_DEF /* Common APIC sub-structure header */\
426 uint8_t type; \
427 uint8_t length;
429 /* Sub-structures for MADT */
431 struct madt_processor_apic
433 APIC_HEADER_DEF
434 uint8_t processor_id; /* ACPI processor id */
435 uint8_t local_apic_id; /* Processor's local APIC id */
436 #if 0
437 uint32_t processor_enabled: 1; /* Processor is usable if set */
438 uint32_t reserved2 : 31; /* Reserved, must be zero */
439 #else
440 uint32_t flags;
441 #endif
444 struct madt_io_apic
446 APIC_HEADER_DEF
447 uint8_t io_apic_id; /* I/O APIC ID */
448 uint8_t reserved; /* Reserved - must be zero */
449 uint32_t address; /* APIC physical address */
450 uint32_t interrupt; /* Global system interrupt where INTI
451 * lines start */
454 #include "acpi-dsdt.hex"
456 static int acpi_checksum(const uint8_t *data, int len)
458 int sum, i;
459 sum = 0;
460 for(i = 0; i < len; i++)
461 sum += data[i];
462 return (-sum) & 0xff;
465 static void acpi_build_table_header(struct acpi_table_header *h,
466 char *sig, int len)
468 memcpy(h->signature, sig, 4);
469 h->length = cpu_to_le32(len);
470 h->revision = 0;
471 memcpy(h->oem_id, "QEMU ", 6);
472 memcpy(h->oem_table_id, "QEMU", 4);
473 memcpy(h->oem_table_id + 4, sig, 4);
474 h->oem_revision = cpu_to_le32(1);
475 memcpy(h->asl_compiler_id, "QEMU", 4);
476 h->asl_compiler_revision = cpu_to_le32(1);
477 h->checksum = acpi_checksum((void *)h, len);
480 #define ACPI_TABLES_BASE 0x000e8000
482 /* base_addr must be a multiple of 4KB */
483 void acpi_bios_init(void)
485 struct rsdp_descriptor *rsdp;
486 struct rsdt_descriptor_rev1 *rsdt;
487 struct fadt_descriptor_rev1 *fadt;
488 struct facs_descriptor_rev1 *facs;
489 struct multiple_apic_table *madt;
490 uint8_t *dsdt;
491 uint32_t base_addr, rsdt_addr, fadt_addr, addr, facs_addr, dsdt_addr;
492 uint32_t pm_io_base, acpi_tables_size, madt_addr, madt_size;
493 int i;
495 /* compute PCI I/O addresses */
496 pm_io_base = (piix4_pm_state->dev.config[0x40] |
497 (piix4_pm_state->dev.config[0x41] << 8)) & ~0x3f;
499 base_addr = ACPI_TABLES_BASE;
501 /* reserve memory space for tables */
502 addr = base_addr;
503 rsdp = (void *)(phys_ram_base + addr);
504 addr += sizeof(*rsdp);
506 rsdt_addr = addr;
507 rsdt = (void *)(phys_ram_base + addr);
508 addr += sizeof(*rsdt);
510 fadt_addr = addr;
511 fadt = (void *)(phys_ram_base + addr);
512 addr += sizeof(*fadt);
514 /* XXX: FACS should be in RAM */
515 addr = (addr + 63) & ~63; /* 64 byte alignment for FACS */
516 facs_addr = addr;
517 facs = (void *)(phys_ram_base + addr);
518 addr += sizeof(*facs);
520 dsdt_addr = addr;
521 dsdt = (void *)(phys_ram_base + addr);
522 addr += sizeof(AmlCode);
524 addr = (addr + 7) & ~7;
525 madt_addr = addr;
526 madt_size = sizeof(*madt) +
527 sizeof(struct madt_processor_apic) * smp_cpus +
528 sizeof(struct madt_io_apic);
529 madt = (void *)(phys_ram_base + addr);
530 addr += madt_size;
532 acpi_tables_size = addr - base_addr;
534 cpu_register_physical_memory(base_addr, acpi_tables_size,
535 base_addr | IO_MEM_ROM);
537 /* RSDP */
538 memset(rsdp, 0, sizeof(*rsdp));
539 memcpy(rsdp->signature, "RSD PTR ", 8);
540 memcpy(rsdp->oem_id, "QEMU ", 6);
541 rsdp->rsdt_physical_address = cpu_to_le32(rsdt_addr);
542 rsdp->checksum = acpi_checksum((void *)rsdp, 20);
544 /* RSDT */
545 rsdt->table_offset_entry[0] = cpu_to_le32(fadt_addr);
546 rsdt->table_offset_entry[1] = cpu_to_le32(madt_addr);
547 acpi_build_table_header((struct acpi_table_header *)rsdt,
548 "RSDT", sizeof(*rsdt));
550 /* FADT */
551 memset(fadt, 0, sizeof(*fadt));
552 fadt->firmware_ctrl = cpu_to_le32(facs_addr);
553 fadt->dsdt = cpu_to_le32(dsdt_addr);
554 fadt->model = 1;
555 fadt->reserved1 = 0;
556 fadt->sci_int = cpu_to_le16(piix4_pm_state->dev.config[0x3c]);
557 fadt->smi_cmd = cpu_to_le32(SMI_CMD_IO_ADDR);
558 fadt->acpi_enable = 0xf1;
559 fadt->acpi_disable = 0xf0;
560 fadt->pm1a_evt_blk = cpu_to_le32(pm_io_base);
561 fadt->pm1a_cnt_blk = cpu_to_le32(pm_io_base + 0x04);
562 fadt->pm_tmr_blk = cpu_to_le32(pm_io_base + 0x08);
563 fadt->pm1_evt_len = 4;
564 fadt->pm1_cnt_len = 2;
565 fadt->pm_tmr_len = 4;
566 fadt->plvl2_lat = cpu_to_le16(50);
567 fadt->plvl3_lat = cpu_to_le16(50);
568 fadt->plvl3_lat = cpu_to_le16(50);
569 /* WBINVD + PROC_C1 + PWR_BUTTON + SLP_BUTTON + FIX_RTC */
570 fadt->flags = cpu_to_le32((1 << 0) | (1 << 2) | (1 << 4) | (1 << 5) | (1 << 6));
571 acpi_build_table_header((struct acpi_table_header *)fadt, "FACP",
572 sizeof(*fadt));
574 /* FACS */
575 memset(facs, 0, sizeof(*facs));
576 memcpy(facs->signature, "FACS", 4);
577 facs->length = cpu_to_le32(sizeof(*facs));
579 /* DSDT */
580 memcpy(dsdt, AmlCode, sizeof(AmlCode));
582 /* MADT */
584 struct madt_processor_apic *apic;
585 struct madt_io_apic *io_apic;
587 memset(madt, 0, madt_size);
588 madt->local_apic_address = cpu_to_le32(0xfee00000);
589 madt->flags = cpu_to_le32(1);
590 apic = (void *)(madt + 1);
591 for(i=0;i<smp_cpus;i++) {
592 apic->type = APIC_PROCESSOR;
593 apic->length = sizeof(*apic);
594 apic->processor_id = i;
595 apic->local_apic_id = i;
596 apic->flags = cpu_to_le32(1);
597 apic++;
599 io_apic = (void *)apic;
600 io_apic->type = APIC_IO;
601 io_apic->length = sizeof(*io_apic);
602 io_apic->io_apic_id = smp_cpus;
603 io_apic->address = cpu_to_le32(0xfec00000);
604 io_apic->interrupt = cpu_to_le32(0);
606 acpi_build_table_header((struct acpi_table_header *)madt,
607 "APIC", madt_size);