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 "qemu/config-file.h"
26 #include "qapi/opts-visitor.h"
27 #include "qapi/dealloc-visitor.h"
28 #include "qapi-visit.h"
29 #include "qapi-event.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 /* Compare ns-clock, not PM timer ticks, because
380 acpi_pm_tmr_update function uses ns for setting the timer. */
381 int64_t d
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
382 if (d
>= muldiv64(ar
->tmr
.overflow_time
,
383 get_ticks_per_sec(), PM_TIMER_FREQUENCY
)) {
384 ar
->pm1
.evt
.sts
|= ACPI_BITMASK_TIMER_STATUS
;
386 return ar
->pm1
.evt
.sts
;
389 static void acpi_pm1_evt_write_sts(ACPIREGS
*ar
, uint16_t val
)
391 uint16_t pm1_sts
= acpi_pm1_evt_get_sts(ar
);
392 if (pm1_sts
& val
& ACPI_BITMASK_TIMER_STATUS
) {
393 /* if TMRSTS is reset, then compute the new overflow time */
394 acpi_pm_tmr_calc_overflow_time(ar
);
396 ar
->pm1
.evt
.sts
&= ~val
;
399 static void acpi_pm1_evt_write_en(ACPIREGS
*ar
, uint16_t val
)
401 ar
->pm1
.evt
.en
= val
;
402 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_RTC
,
403 val
& ACPI_BITMASK_RT_CLOCK_ENABLE
);
404 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_PMTIMER
,
405 val
& ACPI_BITMASK_TIMER_ENABLE
);
408 void acpi_pm1_evt_power_down(ACPIREGS
*ar
)
410 if (ar
->pm1
.evt
.en
& ACPI_BITMASK_POWER_BUTTON_ENABLE
) {
411 ar
->pm1
.evt
.sts
|= ACPI_BITMASK_POWER_BUTTON_STATUS
;
412 ar
->tmr
.update_sci(ar
);
416 void acpi_pm1_evt_reset(ACPIREGS
*ar
)
420 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_RTC
, 0);
421 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_PMTIMER
, 0);
424 static uint64_t acpi_pm_evt_read(void *opaque
, hwaddr addr
, unsigned width
)
426 ACPIREGS
*ar
= opaque
;
429 return acpi_pm1_evt_get_sts(ar
);
431 return ar
->pm1
.evt
.en
;
437 static void acpi_pm_evt_write(void *opaque
, hwaddr addr
, uint64_t val
,
440 ACPIREGS
*ar
= opaque
;
443 acpi_pm1_evt_write_sts(ar
, val
);
444 ar
->pm1
.evt
.update_sci(ar
);
447 acpi_pm1_evt_write_en(ar
, val
);
448 ar
->pm1
.evt
.update_sci(ar
);
453 static const MemoryRegionOps acpi_pm_evt_ops
= {
454 .read
= acpi_pm_evt_read
,
455 .write
= acpi_pm_evt_write
,
456 .valid
.min_access_size
= 2,
457 .valid
.max_access_size
= 2,
458 .endianness
= DEVICE_LITTLE_ENDIAN
,
461 void acpi_pm1_evt_init(ACPIREGS
*ar
, acpi_update_sci_fn update_sci
,
462 MemoryRegion
*parent
)
464 ar
->pm1
.evt
.update_sci
= update_sci
;
465 memory_region_init_io(&ar
->pm1
.evt
.io
, memory_region_owner(parent
),
466 &acpi_pm_evt_ops
, ar
, "acpi-evt", 4);
467 memory_region_add_subregion(parent
, 0, &ar
->pm1
.evt
.io
);
471 void acpi_pm_tmr_update(ACPIREGS
*ar
, bool enable
)
475 /* schedule a timer interruption if needed */
477 expire_time
= muldiv64(ar
->tmr
.overflow_time
, get_ticks_per_sec(),
479 timer_mod(ar
->tmr
.timer
, expire_time
);
481 timer_del(ar
->tmr
.timer
);
485 void acpi_pm_tmr_calc_overflow_time(ACPIREGS
*ar
)
487 int64_t d
= acpi_pm_tmr_get_clock();
488 ar
->tmr
.overflow_time
= (d
+ 0x800000LL
) & ~0x7fffffLL
;
491 static uint32_t acpi_pm_tmr_get(ACPIREGS
*ar
)
493 uint32_t d
= acpi_pm_tmr_get_clock();
497 static void acpi_pm_tmr_timer(void *opaque
)
499 ACPIREGS
*ar
= opaque
;
500 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_PMTIMER
);
501 ar
->tmr
.update_sci(ar
);
504 static uint64_t acpi_pm_tmr_read(void *opaque
, hwaddr addr
, unsigned width
)
506 return acpi_pm_tmr_get(opaque
);
509 static void acpi_pm_tmr_write(void *opaque
, hwaddr addr
, uint64_t val
,
515 static const MemoryRegionOps acpi_pm_tmr_ops
= {
516 .read
= acpi_pm_tmr_read
,
517 .write
= acpi_pm_tmr_write
,
518 .valid
.min_access_size
= 4,
519 .valid
.max_access_size
= 4,
520 .endianness
= DEVICE_LITTLE_ENDIAN
,
523 void acpi_pm_tmr_init(ACPIREGS
*ar
, acpi_update_sci_fn update_sci
,
524 MemoryRegion
*parent
)
526 ar
->tmr
.update_sci
= update_sci
;
527 ar
->tmr
.timer
= timer_new_ns(QEMU_CLOCK_VIRTUAL
, acpi_pm_tmr_timer
, ar
);
528 memory_region_init_io(&ar
->tmr
.io
, memory_region_owner(parent
),
529 &acpi_pm_tmr_ops
, ar
, "acpi-tmr", 4);
530 memory_region_add_subregion(parent
, 8, &ar
->tmr
.io
);
533 void acpi_pm_tmr_reset(ACPIREGS
*ar
)
535 ar
->tmr
.overflow_time
= 0;
536 timer_del(ar
->tmr
.timer
);
540 static void acpi_pm1_cnt_write(ACPIREGS
*ar
, uint16_t val
)
542 ar
->pm1
.cnt
.cnt
= val
& ~(ACPI_BITMASK_SLEEP_ENABLE
);
544 if (val
& ACPI_BITMASK_SLEEP_ENABLE
) {
545 /* change suspend type */
546 uint16_t sus_typ
= (val
>> 10) & 7;
548 case 0: /* soft power off */
549 qemu_system_shutdown_request();
552 qemu_system_suspend_request();
555 if (sus_typ
== ar
->pm1
.cnt
.s4_val
) { /* S4 request */
556 qapi_event_send_suspend_disk(&error_abort
);
557 qemu_system_shutdown_request();
564 void acpi_pm1_cnt_update(ACPIREGS
*ar
,
565 bool sci_enable
, bool sci_disable
)
567 /* ACPI specs 3.0, 4.7.2.5 */
569 ar
->pm1
.cnt
.cnt
|= ACPI_BITMASK_SCI_ENABLE
;
570 } else if (sci_disable
) {
571 ar
->pm1
.cnt
.cnt
&= ~ACPI_BITMASK_SCI_ENABLE
;
575 static uint64_t acpi_pm_cnt_read(void *opaque
, hwaddr addr
, unsigned width
)
577 ACPIREGS
*ar
= opaque
;
578 return ar
->pm1
.cnt
.cnt
;
581 static void acpi_pm_cnt_write(void *opaque
, hwaddr addr
, uint64_t val
,
584 acpi_pm1_cnt_write(opaque
, val
);
587 static const MemoryRegionOps acpi_pm_cnt_ops
= {
588 .read
= acpi_pm_cnt_read
,
589 .write
= acpi_pm_cnt_write
,
590 .valid
.min_access_size
= 2,
591 .valid
.max_access_size
= 2,
592 .endianness
= DEVICE_LITTLE_ENDIAN
,
595 void acpi_pm1_cnt_init(ACPIREGS
*ar
, MemoryRegion
*parent
, uint8_t s4_val
)
597 ar
->pm1
.cnt
.s4_val
= s4_val
;
598 ar
->wakeup
.notify
= acpi_notify_wakeup
;
599 qemu_register_wakeup_notifier(&ar
->wakeup
);
600 memory_region_init_io(&ar
->pm1
.cnt
.io
, memory_region_owner(parent
),
601 &acpi_pm_cnt_ops
, ar
, "acpi-cnt", 2);
602 memory_region_add_subregion(parent
, 4, &ar
->pm1
.cnt
.io
);
605 void acpi_pm1_cnt_reset(ACPIREGS
*ar
)
611 void acpi_gpe_init(ACPIREGS
*ar
, uint8_t len
)
614 ar
->gpe
.sts
= g_malloc0(len
/ 2);
615 ar
->gpe
.en
= g_malloc0(len
/ 2);
618 void acpi_gpe_reset(ACPIREGS
*ar
)
620 memset(ar
->gpe
.sts
, 0, ar
->gpe
.len
/ 2);
621 memset(ar
->gpe
.en
, 0, ar
->gpe
.len
/ 2);
624 static uint8_t *acpi_gpe_ioport_get_ptr(ACPIREGS
*ar
, uint32_t addr
)
628 if (addr
< ar
->gpe
.len
/ 2) {
629 cur
= ar
->gpe
.sts
+ addr
;
630 } else if (addr
< ar
->gpe
.len
) {
631 cur
= ar
->gpe
.en
+ addr
- ar
->gpe
.len
/ 2;
639 void acpi_gpe_ioport_writeb(ACPIREGS
*ar
, uint32_t addr
, uint32_t val
)
643 cur
= acpi_gpe_ioport_get_ptr(ar
, addr
);
644 if (addr
< ar
->gpe
.len
/ 2) {
646 *cur
= (*cur
) & ~val
;
647 } else if (addr
< ar
->gpe
.len
) {
655 uint32_t acpi_gpe_ioport_readb(ACPIREGS
*ar
, uint32_t addr
)
660 cur
= acpi_gpe_ioport_get_ptr(ar
, addr
);
669 void acpi_update_sci(ACPIREGS
*regs
, qemu_irq irq
)
671 int sci_level
, pm1a_sts
;
673 pm1a_sts
= acpi_pm1_evt_get_sts(regs
);
675 sci_level
= ((pm1a_sts
&
676 regs
->pm1
.evt
.en
& ACPI_BITMASK_PM1_COMMON_ENABLED
) != 0) ||
677 ((regs
->gpe
.sts
[0] & regs
->gpe
.en
[0]) != 0);
679 qemu_set_irq(irq
, sci_level
);
681 /* schedule a timer interruption if needed */
682 acpi_pm_tmr_update(regs
,
683 (regs
->pm1
.evt
.en
& ACPI_BITMASK_TIMER_ENABLE
) &&
684 !(pm1a_sts
& ACPI_BITMASK_TIMER_STATUS
));