4 * Copyright (c) 2006 Fabrice Bellard
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, see <http://www.gnu.org/licenses/>
18 * Contributions after 2012-01-13 are licensed under the terms of the
19 * GNU GPL, version 2 or (at your option) any later version.
21 #include "sysemu/sysemu.h"
23 #include "hw/i386/pc.h"
24 #include "hw/acpi/acpi.h"
25 #include "monitor/monitor.h"
26 #include "qemu/config-file.h"
27 #include "qapi/opts-visitor.h"
28 #include "qapi/dealloc-visitor.h"
29 #include "qapi-visit.h"
31 struct acpi_table_header {
32 uint16_t _length; /* our length, not actual part of the hdr */
33 /* allows easier parsing for fw_cfg clients */
34 char sig[4]; /* ACPI signature (4 ASCII characters) */
35 uint32_t length; /* Length of table, in bytes, including header */
36 uint8_t revision; /* ACPI Specification minor version # */
37 uint8_t checksum; /* To make sum of entire table == 0 */
38 char oem_id[6]; /* OEM identification */
39 char oem_table_id[8]; /* OEM table identification */
40 uint32_t oem_revision; /* OEM revision number */
41 char asl_compiler_id[4]; /* ASL compiler vendor ID */
42 uint32_t asl_compiler_revision; /* ASL compiler revision number */
45 #define ACPI_TABLE_HDR_SIZE sizeof(struct acpi_table_header)
46 #define ACPI_TABLE_PFX_SIZE sizeof(uint16_t) /* size of the extra prefix */
48 static const char unsigned dfl_hdr[ACPI_TABLE_HDR_SIZE - ACPI_TABLE_PFX_SIZE] =
49 "QEMU\0\0\0\0\1\0" /* sig (4), len(4), revno (1), csum (1) */
50 "QEMUQEQEMUQEMU\1\0\0\0" /* OEM id (6), table (8), revno (4) */
51 "QEMU\1\0\0\0" /* ASL compiler ID (4), version (4) */
54 char unsigned *acpi_tables;
55 size_t acpi_tables_len;
57 static QemuOptsList qemu_acpi_opts = {
59 .implied_opt_name = "data",
60 .head = QTAILQ_HEAD_INITIALIZER(qemu_acpi_opts.head),
61 .desc = { { 0 } } /* validated with OptsVisitor */
64 static void acpi_register_config(void)
66 qemu_add_opts(&qemu_acpi_opts);
69 machine_init(acpi_register_config);
71 static int acpi_checksum(const uint8_t *data, int len)
75 for (i = 0; i < len; i++) {
82 /* Install a copy of the ACPI table specified in @blob.
84 * If @has_header is set, @blob starts with the System Description Table Header
85 * structure. Otherwise, "dfl_hdr" is prepended. In any case, each header field
86 * is optionally overwritten from @hdrs.
88 * It is valid to call this function with
89 * (@blob == NULL && bloblen == 0 && !has_header).
91 * @hdrs->file and @hdrs->data are ignored.
93 * SIZE_MAX is considered "infinity" in this function.
95 * The number of tables that can be installed is not limited, but the 16-bit
96 * counter at the beginning of "acpi_tables" wraps around after UINT16_MAX.
98 static void acpi_table_install(const char unsigned *blob, size_t bloblen,
100 const struct AcpiTableOptions *hdrs,
104 const char unsigned *hdr_src;
105 size_t body_size, acpi_payload_size;
106 struct acpi_table_header *ext_hdr;
107 unsigned changed_fields;
109 /* Calculate where the ACPI table body starts within the blob, plus where
110 * to copy the ACPI table header from.
113 /* _length | ACPI header in blob | blob body
114 * ^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^
115 * ACPI_TABLE_PFX_SIZE sizeof dfl_hdr body_size
118 * ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
119 * acpi_payload_size == bloblen
121 body_start = sizeof dfl_hdr;
123 if (bloblen < body_start) {
124 error_setg(errp, "ACPI table claiming to have header is too "
125 "short, available: %zu, expected: %zu", bloblen,
131 /* _length | ACPI header in template | blob body
132 * ^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^
133 * ACPI_TABLE_PFX_SIZE sizeof dfl_hdr body_size
136 * ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
142 body_size = bloblen - body_start;
143 acpi_payload_size = sizeof dfl_hdr + body_size;
145 if (acpi_payload_size > UINT16_MAX) {
146 error_setg(errp, "ACPI table too big, requested: %zu, max: %u",
147 acpi_payload_size, (unsigned)UINT16_MAX);
151 /* We won't fail from here on. Initialize / extend the globals. */
152 if (acpi_tables == NULL) {
153 acpi_tables_len = sizeof(uint16_t);
154 acpi_tables = g_malloc0(acpi_tables_len);
157 acpi_tables = g_realloc(acpi_tables, acpi_tables_len +
158 ACPI_TABLE_PFX_SIZE +
159 sizeof dfl_hdr + body_size);
161 ext_hdr = (struct acpi_table_header *)(acpi_tables + acpi_tables_len);
162 acpi_tables_len += ACPI_TABLE_PFX_SIZE;
164 memcpy(acpi_tables + acpi_tables_len, hdr_src, sizeof dfl_hdr);
165 acpi_tables_len += sizeof dfl_hdr;
168 memcpy(acpi_tables + acpi_tables_len, blob + body_start, body_size);
169 acpi_tables_len += body_size;
172 /* increase number of tables */
173 stw_le_p(acpi_tables, lduw_le_p(acpi_tables) + 1u);
175 /* Update the header fields. The strings need not be NUL-terminated. */
177 ext_hdr->_length = cpu_to_le16(acpi_payload_size);
180 strncpy(ext_hdr->sig, hdrs->sig, sizeof ext_hdr->sig);
184 if (has_header && le32_to_cpu(ext_hdr->length) != acpi_payload_size) {
186 "warning: ACPI table has wrong length, header says "
187 "%" PRIu32 ", actual size %zu bytes\n",
188 le32_to_cpu(ext_hdr->length), acpi_payload_size);
190 ext_hdr->length = cpu_to_le32(acpi_payload_size);
193 ext_hdr->revision = hdrs->rev;
197 ext_hdr->checksum = 0;
199 if (hdrs->has_oem_id) {
200 strncpy(ext_hdr->oem_id, hdrs->oem_id, sizeof ext_hdr->oem_id);
203 if (hdrs->has_oem_table_id) {
204 strncpy(ext_hdr->oem_table_id, hdrs->oem_table_id,
205 sizeof ext_hdr->oem_table_id);
208 if (hdrs->has_oem_rev) {
209 ext_hdr->oem_revision = cpu_to_le32(hdrs->oem_rev);
212 if (hdrs->has_asl_compiler_id) {
213 strncpy(ext_hdr->asl_compiler_id, hdrs->asl_compiler_id,
214 sizeof ext_hdr->asl_compiler_id);
217 if (hdrs->has_asl_compiler_rev) {
218 ext_hdr->asl_compiler_revision = cpu_to_le32(hdrs->asl_compiler_rev);
222 if (!has_header && changed_fields == 0) {
223 fprintf(stderr, "warning: ACPI table: no headers are specified\n");
226 /* recalculate checksum */
227 ext_hdr->checksum = acpi_checksum((const char unsigned *)ext_hdr +
228 ACPI_TABLE_PFX_SIZE, acpi_payload_size);
231 void acpi_table_add(const QemuOpts *opts, Error **errp)
233 AcpiTableOptions *hdrs = NULL;
235 char **pathnames = NULL;
238 char unsigned *blob = NULL;
243 ov = opts_visitor_new(opts);
244 visit_type_AcpiTableOptions(opts_get_visitor(ov), &hdrs, NULL, &err);
245 opts_visitor_cleanup(ov);
251 if (hdrs->has_file == hdrs->has_data) {
252 error_setg(&err, "'-acpitable' requires one of 'data' or 'file'");
256 pathnames = g_strsplit(hdrs->has_file ? hdrs->file : hdrs->data, ":", 0);
257 if (pathnames == NULL || pathnames[0] == NULL) {
258 error_setg(&err, "'-acpitable' requires at least one pathname");
262 /* now read in the data files, reallocating buffer as needed */
263 for (cur = pathnames; *cur; ++cur) {
264 int fd = open(*cur, O_RDONLY | O_BINARY);
267 error_setg(&err, "can't open file %s: %s", *cur, strerror(errno));
272 char unsigned data[8192];
275 r = read(fd, data, sizeof data);
279 blob = g_realloc(blob, bloblen + r);
280 memcpy(blob + bloblen, data, r);
282 } else if (errno != EINTR) {
283 error_setg(&err, "can't read file %s: %s",
284 *cur, strerror(errno));
293 acpi_table_install(blob, bloblen, hdrs->has_file, hdrs, &err);
297 g_strfreev(pathnames);
300 QapiDeallocVisitor *dv;
302 dv = qapi_dealloc_visitor_new();
303 visit_type_AcpiTableOptions(qapi_dealloc_get_visitor(dv), &hdrs, NULL,
305 qapi_dealloc_visitor_cleanup(dv);
308 error_propagate(errp, err);
311 static bool acpi_table_builtin = false;
313 void acpi_table_add_builtin(const QemuOpts *opts, Error **errp)
315 acpi_table_builtin = true;
316 acpi_table_add(opts, errp);
319 unsigned acpi_table_len(void *current)
321 struct acpi_table_header *hdr = current - sizeof(hdr->_length);
326 void *acpi_table_hdr(void *h)
328 struct acpi_table_header *hdr = h;
332 uint8_t *acpi_table_first(void)
334 if (acpi_table_builtin || !acpi_tables) {
337 return acpi_table_hdr(acpi_tables + ACPI_TABLE_PFX_SIZE);
340 uint8_t *acpi_table_next(uint8_t *current)
342 uint8_t *next = current + acpi_table_len(current);
344 if (next - acpi_tables >= acpi_tables_len) {
347 return acpi_table_hdr(next);
351 static void acpi_notify_wakeup(Notifier *notifier, void *data)
353 ACPIREGS *ar = container_of(notifier, ACPIREGS, wakeup);
354 WakeupReason *reason = data;
357 case QEMU_WAKEUP_REASON_RTC:
359 (ACPI_BITMASK_WAKE_STATUS | ACPI_BITMASK_RT_CLOCK_STATUS);
361 case QEMU_WAKEUP_REASON_PMTIMER:
363 (ACPI_BITMASK_WAKE_STATUS | ACPI_BITMASK_TIMER_STATUS);
365 case QEMU_WAKEUP_REASON_OTHER:
366 /* ACPI_BITMASK_WAKE_STATUS should be set on resume.
367 Pretend that resume was caused by power button */
369 (ACPI_BITMASK_WAKE_STATUS | ACPI_BITMASK_POWER_BUTTON_STATUS);
377 uint16_t acpi_pm1_evt_get_sts(ACPIREGS *ar)
379 int64_t d = acpi_pm_tmr_get_clock();
380 if (d >= ar->tmr.overflow_time) {
381 ar->pm1.evt.sts |= ACPI_BITMASK_TIMER_STATUS;
383 return ar->pm1.evt.sts;
386 static void acpi_pm1_evt_write_sts(ACPIREGS *ar, uint16_t val)
388 uint16_t pm1_sts = acpi_pm1_evt_get_sts(ar);
389 if (pm1_sts & val & ACPI_BITMASK_TIMER_STATUS) {
390 /* if TMRSTS is reset, then compute the new overflow time */
391 acpi_pm_tmr_calc_overflow_time(ar);
393 ar->pm1.evt.sts &= ~val;
396 static void acpi_pm1_evt_write_en(ACPIREGS *ar, uint16_t val)
398 ar->pm1.evt.en = val;
399 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_RTC,
400 val & ACPI_BITMASK_RT_CLOCK_ENABLE);
401 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_PMTIMER,
402 val & ACPI_BITMASK_TIMER_ENABLE);
405 void acpi_pm1_evt_power_down(ACPIREGS *ar)
407 if (ar->pm1.evt.en & ACPI_BITMASK_POWER_BUTTON_ENABLE) {
408 ar->pm1.evt.sts |= ACPI_BITMASK_POWER_BUTTON_STATUS;
409 ar->tmr.update_sci(ar);
413 void acpi_pm1_evt_reset(ACPIREGS *ar)
417 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_RTC, 0);
418 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_PMTIMER, 0);
421 static uint64_t acpi_pm_evt_read(void *opaque, hwaddr addr, unsigned width)
423 ACPIREGS *ar = opaque;
426 return acpi_pm1_evt_get_sts(ar);
428 return ar->pm1.evt.en;
434 static void acpi_pm_evt_write(void *opaque, hwaddr addr, uint64_t val,
437 ACPIREGS *ar = opaque;
440 acpi_pm1_evt_write_sts(ar, val);
441 ar->pm1.evt.update_sci(ar);
444 acpi_pm1_evt_write_en(ar, val);
445 ar->pm1.evt.update_sci(ar);
450 static const MemoryRegionOps acpi_pm_evt_ops = {
451 .read = acpi_pm_evt_read,
452 .write = acpi_pm_evt_write,
453 .valid.min_access_size = 2,
454 .valid.max_access_size = 2,
455 .endianness = DEVICE_LITTLE_ENDIAN,
458 void acpi_pm1_evt_init(ACPIREGS *ar, acpi_update_sci_fn update_sci,
459 MemoryRegion *parent)
461 ar->pm1.evt.update_sci = update_sci;
462 memory_region_init_io(&ar->pm1.evt.io, memory_region_owner(parent),
463 &acpi_pm_evt_ops, ar, "acpi-evt", 4);
464 memory_region_add_subregion(parent, 0, &ar->pm1.evt.io);
468 void acpi_pm_tmr_update(ACPIREGS *ar, bool enable)
472 /* schedule a timer interruption if needed */
474 expire_time = muldiv64(ar->tmr.overflow_time, get_ticks_per_sec(),
476 timer_mod(ar->tmr.timer, expire_time);
478 timer_del(ar->tmr.timer);
482 void acpi_pm_tmr_calc_overflow_time(ACPIREGS *ar)
484 int64_t d = acpi_pm_tmr_get_clock();
485 ar->tmr.overflow_time = (d + 0x800000LL) & ~0x7fffffLL;
488 static uint32_t acpi_pm_tmr_get(ACPIREGS *ar)
490 uint32_t d = acpi_pm_tmr_get_clock();
494 static void acpi_pm_tmr_timer(void *opaque)
496 ACPIREGS *ar = opaque;
497 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_PMTIMER);
498 ar->tmr.update_sci(ar);
501 static uint64_t acpi_pm_tmr_read(void *opaque, hwaddr addr, unsigned width)
503 return acpi_pm_tmr_get(opaque);
506 static void acpi_pm_tmr_write(void *opaque, hwaddr addr, uint64_t val,
512 static const MemoryRegionOps acpi_pm_tmr_ops = {
513 .read = acpi_pm_tmr_read,
514 .write = acpi_pm_tmr_write,
515 .valid.min_access_size = 4,
516 .valid.max_access_size = 4,
517 .endianness = DEVICE_LITTLE_ENDIAN,
520 void acpi_pm_tmr_init(ACPIREGS *ar, acpi_update_sci_fn update_sci,
521 MemoryRegion *parent)
523 ar->tmr.update_sci = update_sci;
524 ar->tmr.timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, acpi_pm_tmr_timer, ar);
525 memory_region_init_io(&ar->tmr.io, memory_region_owner(parent),
526 &acpi_pm_tmr_ops, ar, "acpi-tmr", 4);
527 memory_region_add_subregion(parent, 8, &ar->tmr.io);
530 void acpi_pm_tmr_reset(ACPIREGS *ar)
532 ar->tmr.overflow_time = 0;
533 timer_del(ar->tmr.timer);
537 static void acpi_pm1_cnt_write(ACPIREGS *ar, uint16_t val)
539 ar->pm1.cnt.cnt = val & ~(ACPI_BITMASK_SLEEP_ENABLE);
541 if (val & ACPI_BITMASK_SLEEP_ENABLE) {
542 /* change suspend type */
543 uint16_t sus_typ = (val >> 10) & 7;
545 case 0: /* soft power off */
546 qemu_system_shutdown_request();
549 qemu_system_suspend_request();
552 if (sus_typ == ar->pm1.cnt.s4_val) { /* S4 request */
553 monitor_protocol_event(QEVENT_SUSPEND_DISK, NULL);
554 qemu_system_shutdown_request();
561 void acpi_pm1_cnt_update(ACPIREGS *ar,
562 bool sci_enable, bool sci_disable)
564 /* ACPI specs 3.0, 4.7.2.5 */
566 ar->pm1.cnt.cnt |= ACPI_BITMASK_SCI_ENABLE;
567 } else if (sci_disable) {
568 ar->pm1.cnt.cnt &= ~ACPI_BITMASK_SCI_ENABLE;
572 static uint64_t acpi_pm_cnt_read(void *opaque, hwaddr addr, unsigned width)
574 ACPIREGS *ar = opaque;
575 return ar->pm1.cnt.cnt;
578 static void acpi_pm_cnt_write(void *opaque, hwaddr addr, uint64_t val,
581 acpi_pm1_cnt_write(opaque, val);
584 static const MemoryRegionOps acpi_pm_cnt_ops = {
585 .read = acpi_pm_cnt_read,
586 .write = acpi_pm_cnt_write,
587 .valid.min_access_size = 2,
588 .valid.max_access_size = 2,
589 .endianness = DEVICE_LITTLE_ENDIAN,
592 void acpi_pm1_cnt_init(ACPIREGS *ar, MemoryRegion *parent, uint8_t s4_val)
594 ar->pm1.cnt.s4_val = s4_val;
595 ar->wakeup.notify = acpi_notify_wakeup;
596 qemu_register_wakeup_notifier(&ar->wakeup);
597 memory_region_init_io(&ar->pm1.cnt.io, memory_region_owner(parent),
598 &acpi_pm_cnt_ops, ar, "acpi-cnt", 2);
599 memory_region_add_subregion(parent, 4, &ar->pm1.cnt.io);
602 void acpi_pm1_cnt_reset(ACPIREGS *ar)
608 void acpi_gpe_init(ACPIREGS *ar, uint8_t len)
611 ar->gpe.sts = g_malloc0(len / 2);
612 ar->gpe.en = g_malloc0(len / 2);
615 void acpi_gpe_reset(ACPIREGS *ar)
617 memset(ar->gpe.sts, 0, ar->gpe.len / 2);
618 memset(ar->gpe.en, 0, ar->gpe.len / 2);
621 static uint8_t *acpi_gpe_ioport_get_ptr(ACPIREGS *ar, uint32_t addr)
625 if (addr < ar->gpe.len / 2) {
626 cur = ar->gpe.sts + addr;
627 } else if (addr < ar->gpe.len) {
628 cur = ar->gpe.en + addr - ar->gpe.len / 2;
636 void acpi_gpe_ioport_writeb(ACPIREGS *ar, uint32_t addr, uint32_t val)
640 cur = acpi_gpe_ioport_get_ptr(ar, addr);
641 if (addr < ar->gpe.len / 2) {
643 *cur = (*cur) & ~val;
644 } else if (addr < ar->gpe.len) {
652 uint32_t acpi_gpe_ioport_readb(ACPIREGS *ar, uint32_t addr)
657 cur = acpi_gpe_ioport_get_ptr(ar, addr);
666 void acpi_update_sci(ACPIREGS *regs, qemu_irq irq)
668 int sci_level, pm1a_sts;
670 pm1a_sts = acpi_pm1_evt_get_sts(regs);
672 sci_level = ((pm1a_sts &
673 regs->pm1.evt.en & ACPI_BITMASK_PM1_COMMON_ENABLED) != 0) ||
674 ((regs->gpe.sts[0] & regs->gpe.en[0]) != 0);
676 qemu_set_irq(irq, sci_level);
678 /* schedule a timer interruption if needed */
679 acpi_pm_tmr_update(regs,
680 (regs->pm1.evt.en & ACPI_BITMASK_TIMER_ENABLE) &&
681 !(pm1a_sts & ACPI_BITMASK_TIMER_STATUS));