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.
22 #include "qemu/osdep.h"
24 #include "hw/acpi/acpi.h"
25 #include "hw/nvram/fw_cfg.h"
26 #include "qemu/config-file.h"
27 #include "qapi/error.h"
28 #include "qapi/opts-visitor.h"
29 #include "qapi/qapi-events-run-state.h"
30 #include "qapi/qapi-visit-misc.h"
31 #include "qemu/error-report.h"
32 #include "qemu/module.h"
33 #include "qemu/option.h"
34 #include "sysemu/runstate.h"
36 struct acpi_table_header
{
37 uint16_t _length
; /* our length, not actual part of the hdr */
38 /* allows easier parsing for fw_cfg clients */
40 QEMU_NONSTRING
; /* ACPI signature (4 ASCII characters) */
41 uint32_t length
; /* Length of table, in bytes, including header */
42 uint8_t revision
; /* ACPI Specification minor version # */
43 uint8_t checksum
; /* To make sum of entire table == 0 */
45 QEMU_NONSTRING
; /* OEM identification */
47 QEMU_NONSTRING
; /* OEM table identification */
48 uint32_t oem_revision
; /* OEM revision number */
49 char asl_compiler_id
[4]
50 QEMU_NONSTRING
; /* ASL compiler vendor ID */
51 uint32_t asl_compiler_revision
; /* ASL compiler revision number */
54 #define ACPI_TABLE_HDR_SIZE sizeof(struct acpi_table_header)
55 #define ACPI_TABLE_PFX_SIZE sizeof(uint16_t) /* size of the extra prefix */
57 static const char unsigned dfl_hdr
[ACPI_TABLE_HDR_SIZE
- ACPI_TABLE_PFX_SIZE
] =
58 "QEMU\0\0\0\0\1\0" /* sig (4), len(4), revno (1), csum (1) */
59 "QEMUQEQEMUQEMU\1\0\0\0" /* OEM id (6), table (8), revno (4) */
60 "QEMU\1\0\0\0" /* ASL compiler ID (4), version (4) */
63 char unsigned *acpi_tables
;
64 size_t acpi_tables_len
;
66 static QemuOptsList qemu_acpi_opts
= {
68 .implied_opt_name
= "data",
69 .head
= QTAILQ_HEAD_INITIALIZER(qemu_acpi_opts
.head
),
70 .desc
= { { 0 } } /* validated with OptsVisitor */
73 static void acpi_register_config(void)
75 qemu_add_opts(&qemu_acpi_opts
);
78 opts_init(acpi_register_config
);
80 static int acpi_checksum(const uint8_t *data
, int len
)
84 for (i
= 0; i
< len
; i
++) {
91 /* Install a copy of the ACPI table specified in @blob.
93 * If @has_header is set, @blob starts with the System Description Table Header
94 * structure. Otherwise, "dfl_hdr" is prepended. In any case, each header field
95 * is optionally overwritten from @hdrs.
97 * It is valid to call this function with
98 * (@blob == NULL && bloblen == 0 && !has_header).
100 * @hdrs->file and @hdrs->data are ignored.
102 * SIZE_MAX is considered "infinity" in this function.
104 * The number of tables that can be installed is not limited, but the 16-bit
105 * counter at the beginning of "acpi_tables" wraps around after UINT16_MAX.
107 static void acpi_table_install(const char unsigned *blob
, size_t bloblen
,
109 const struct AcpiTableOptions
*hdrs
,
113 const char unsigned *hdr_src
;
114 size_t body_size
, acpi_payload_size
;
115 struct acpi_table_header
*ext_hdr
;
116 unsigned changed_fields
;
118 /* Calculate where the ACPI table body starts within the blob, plus where
119 * to copy the ACPI table header from.
122 /* _length | ACPI header in blob | blob body
123 * ^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^
124 * ACPI_TABLE_PFX_SIZE sizeof dfl_hdr body_size
127 * ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
128 * acpi_payload_size == bloblen
130 body_start
= sizeof dfl_hdr
;
132 if (bloblen
< body_start
) {
133 error_setg(errp
, "ACPI table claiming to have header is too "
134 "short, available: %zu, expected: %zu", bloblen
,
140 /* _length | ACPI header in template | blob body
141 * ^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^
142 * ACPI_TABLE_PFX_SIZE sizeof dfl_hdr body_size
145 * ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
151 body_size
= bloblen
- body_start
;
152 acpi_payload_size
= sizeof dfl_hdr
+ body_size
;
154 if (acpi_payload_size
> UINT16_MAX
) {
155 error_setg(errp
, "ACPI table too big, requested: %zu, max: %u",
156 acpi_payload_size
, (unsigned)UINT16_MAX
);
160 /* We won't fail from here on. Initialize / extend the globals. */
161 if (acpi_tables
== NULL
) {
162 acpi_tables_len
= sizeof(uint16_t);
163 acpi_tables
= g_malloc0(acpi_tables_len
);
166 acpi_tables
= g_realloc(acpi_tables
, acpi_tables_len
+
167 ACPI_TABLE_PFX_SIZE
+
168 sizeof dfl_hdr
+ body_size
);
170 ext_hdr
= (struct acpi_table_header
*)(acpi_tables
+ acpi_tables_len
);
171 acpi_tables_len
+= ACPI_TABLE_PFX_SIZE
;
173 memcpy(acpi_tables
+ acpi_tables_len
, hdr_src
, sizeof dfl_hdr
);
174 acpi_tables_len
+= sizeof dfl_hdr
;
177 memcpy(acpi_tables
+ acpi_tables_len
, blob
+ body_start
, body_size
);
178 acpi_tables_len
+= body_size
;
181 /* increase number of tables */
182 stw_le_p(acpi_tables
, lduw_le_p(acpi_tables
) + 1u);
184 /* Update the header fields. The strings need not be NUL-terminated. */
186 ext_hdr
->_length
= cpu_to_le16(acpi_payload_size
);
189 strncpy(ext_hdr
->sig
, hdrs
->sig
, sizeof ext_hdr
->sig
);
193 if (has_header
&& le32_to_cpu(ext_hdr
->length
) != acpi_payload_size
) {
194 warn_report("ACPI table has wrong length, header says "
195 "%" PRIu32
", actual size %zu bytes",
196 le32_to_cpu(ext_hdr
->length
), acpi_payload_size
);
198 ext_hdr
->length
= cpu_to_le32(acpi_payload_size
);
201 ext_hdr
->revision
= hdrs
->rev
;
205 ext_hdr
->checksum
= 0;
207 if (hdrs
->has_oem_id
) {
208 strncpy(ext_hdr
->oem_id
, hdrs
->oem_id
, sizeof ext_hdr
->oem_id
);
211 if (hdrs
->has_oem_table_id
) {
212 strncpy(ext_hdr
->oem_table_id
, hdrs
->oem_table_id
,
213 sizeof ext_hdr
->oem_table_id
);
216 if (hdrs
->has_oem_rev
) {
217 ext_hdr
->oem_revision
= cpu_to_le32(hdrs
->oem_rev
);
220 if (hdrs
->has_asl_compiler_id
) {
221 strncpy(ext_hdr
->asl_compiler_id
, hdrs
->asl_compiler_id
,
222 sizeof ext_hdr
->asl_compiler_id
);
225 if (hdrs
->has_asl_compiler_rev
) {
226 ext_hdr
->asl_compiler_revision
= cpu_to_le32(hdrs
->asl_compiler_rev
);
230 if (!has_header
&& changed_fields
== 0) {
231 warn_report("ACPI table: no headers are specified");
234 /* recalculate checksum */
235 ext_hdr
->checksum
= acpi_checksum((const char unsigned *)ext_hdr
+
236 ACPI_TABLE_PFX_SIZE
, acpi_payload_size
);
239 void acpi_table_add(const QemuOpts
*opts
, Error
**errp
)
241 AcpiTableOptions
*hdrs
= NULL
;
243 char **pathnames
= NULL
;
246 char unsigned *blob
= NULL
;
251 v
= opts_visitor_new(opts
);
252 visit_type_AcpiTableOptions(v
, NULL
, &hdrs
, &err
);
259 if (hdrs
->has_file
== hdrs
->has_data
) {
260 error_setg(&err
, "'-acpitable' requires one of 'data' or 'file'");
264 pathnames
= g_strsplit(hdrs
->has_file
? hdrs
->file
: hdrs
->data
, ":", 0);
265 if (pathnames
== NULL
|| pathnames
[0] == NULL
) {
266 error_setg(&err
, "'-acpitable' requires at least one pathname");
270 /* now read in the data files, reallocating buffer as needed */
271 for (cur
= pathnames
; *cur
; ++cur
) {
272 int fd
= open(*cur
, O_RDONLY
| O_BINARY
);
275 error_setg(&err
, "can't open file %s: %s", *cur
, strerror(errno
));
280 char unsigned data
[8192];
283 r
= read(fd
, data
, sizeof data
);
287 blob
= g_realloc(blob
, bloblen
+ r
);
288 memcpy(blob
+ bloblen
, data
, r
);
290 } else if (errno
!= EINTR
) {
291 error_setg(&err
, "can't read file %s: %s",
292 *cur
, strerror(errno
));
301 acpi_table_install(blob
, bloblen
, hdrs
->has_file
, hdrs
, &err
);
305 g_strfreev(pathnames
);
306 qapi_free_AcpiTableOptions(hdrs
);
308 error_propagate(errp
, err
);
311 unsigned acpi_table_len(void *current
)
313 struct acpi_table_header
*hdr
= current
- sizeof(hdr
->_length
);
318 void *acpi_table_hdr(void *h
)
320 struct acpi_table_header
*hdr
= h
;
324 uint8_t *acpi_table_first(void)
329 return acpi_table_hdr(acpi_tables
+ ACPI_TABLE_PFX_SIZE
);
332 uint8_t *acpi_table_next(uint8_t *current
)
334 uint8_t *next
= current
+ acpi_table_len(current
);
336 if (next
- acpi_tables
>= acpi_tables_len
) {
339 return acpi_table_hdr(next
);
343 int acpi_get_slic_oem(AcpiSlicOem
*oem
)
347 for (u
= acpi_table_first(); u
; u
= acpi_table_next(u
)) {
348 struct acpi_table_header
*hdr
= (void *)(u
- sizeof(hdr
->_length
));
350 if (memcmp(hdr
->sig
, "SLIC", 4) == 0) {
351 oem
->id
= hdr
->oem_id
;
352 oem
->table_id
= hdr
->oem_table_id
;
359 static void acpi_notify_wakeup(Notifier
*notifier
, void *data
)
361 ACPIREGS
*ar
= container_of(notifier
, ACPIREGS
, wakeup
);
362 WakeupReason
*reason
= data
;
365 case QEMU_WAKEUP_REASON_RTC
:
367 (ACPI_BITMASK_WAKE_STATUS
| ACPI_BITMASK_RT_CLOCK_STATUS
);
369 case QEMU_WAKEUP_REASON_PMTIMER
:
371 (ACPI_BITMASK_WAKE_STATUS
| ACPI_BITMASK_TIMER_STATUS
);
373 case QEMU_WAKEUP_REASON_OTHER
:
374 /* ACPI_BITMASK_WAKE_STATUS should be set on resume.
375 Pretend that resume was caused by power button */
377 (ACPI_BITMASK_WAKE_STATUS
| ACPI_BITMASK_POWER_BUTTON_STATUS
);
385 uint16_t acpi_pm1_evt_get_sts(ACPIREGS
*ar
)
387 /* Compare ns-clock, not PM timer ticks, because
388 acpi_pm_tmr_update function uses ns for setting the timer. */
389 int64_t d
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
390 if (d
>= muldiv64(ar
->tmr
.overflow_time
,
391 NANOSECONDS_PER_SECOND
, PM_TIMER_FREQUENCY
)) {
392 ar
->pm1
.evt
.sts
|= ACPI_BITMASK_TIMER_STATUS
;
394 return ar
->pm1
.evt
.sts
;
397 static void acpi_pm1_evt_write_sts(ACPIREGS
*ar
, uint16_t val
)
399 uint16_t pm1_sts
= acpi_pm1_evt_get_sts(ar
);
400 if (pm1_sts
& val
& ACPI_BITMASK_TIMER_STATUS
) {
401 /* if TMRSTS is reset, then compute the new overflow time */
402 acpi_pm_tmr_calc_overflow_time(ar
);
404 ar
->pm1
.evt
.sts
&= ~val
;
407 static void acpi_pm1_evt_write_en(ACPIREGS
*ar
, uint16_t val
)
409 ar
->pm1
.evt
.en
= val
;
410 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_RTC
,
411 val
& ACPI_BITMASK_RT_CLOCK_ENABLE
);
412 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_PMTIMER
,
413 val
& ACPI_BITMASK_TIMER_ENABLE
);
416 void acpi_pm1_evt_power_down(ACPIREGS
*ar
)
418 if (ar
->pm1
.evt
.en
& ACPI_BITMASK_POWER_BUTTON_ENABLE
) {
419 ar
->pm1
.evt
.sts
|= ACPI_BITMASK_POWER_BUTTON_STATUS
;
420 ar
->tmr
.update_sci(ar
);
424 void acpi_pm1_evt_reset(ACPIREGS
*ar
)
428 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_RTC
, 0);
429 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_PMTIMER
, 0);
432 static uint64_t acpi_pm_evt_read(void *opaque
, hwaddr addr
, unsigned width
)
434 ACPIREGS
*ar
= opaque
;
437 return acpi_pm1_evt_get_sts(ar
);
439 return ar
->pm1
.evt
.en
;
445 static void acpi_pm_evt_write(void *opaque
, hwaddr addr
, uint64_t val
,
448 ACPIREGS
*ar
= opaque
;
451 acpi_pm1_evt_write_sts(ar
, val
);
452 ar
->pm1
.evt
.update_sci(ar
);
455 acpi_pm1_evt_write_en(ar
, val
);
456 ar
->pm1
.evt
.update_sci(ar
);
461 static const MemoryRegionOps acpi_pm_evt_ops
= {
462 .read
= acpi_pm_evt_read
,
463 .write
= acpi_pm_evt_write
,
464 .valid
.min_access_size
= 2,
465 .valid
.max_access_size
= 2,
466 .endianness
= DEVICE_LITTLE_ENDIAN
,
469 void acpi_pm1_evt_init(ACPIREGS
*ar
, acpi_update_sci_fn update_sci
,
470 MemoryRegion
*parent
)
472 ar
->pm1
.evt
.update_sci
= update_sci
;
473 memory_region_init_io(&ar
->pm1
.evt
.io
, memory_region_owner(parent
),
474 &acpi_pm_evt_ops
, ar
, "acpi-evt", 4);
475 memory_region_add_subregion(parent
, 0, &ar
->pm1
.evt
.io
);
479 void acpi_pm_tmr_update(ACPIREGS
*ar
, bool enable
)
483 /* schedule a timer interruption if needed */
485 expire_time
= muldiv64(ar
->tmr
.overflow_time
, NANOSECONDS_PER_SECOND
,
487 timer_mod(ar
->tmr
.timer
, expire_time
);
489 timer_del(ar
->tmr
.timer
);
493 static inline int64_t acpi_pm_tmr_get_clock(void)
495 return muldiv64(qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
), PM_TIMER_FREQUENCY
,
496 NANOSECONDS_PER_SECOND
);
499 void acpi_pm_tmr_calc_overflow_time(ACPIREGS
*ar
)
501 int64_t d
= acpi_pm_tmr_get_clock();
502 ar
->tmr
.overflow_time
= (d
+ 0x800000LL
) & ~0x7fffffLL
;
505 static uint32_t acpi_pm_tmr_get(ACPIREGS
*ar
)
507 uint32_t d
= acpi_pm_tmr_get_clock();
511 static void acpi_pm_tmr_timer(void *opaque
)
513 ACPIREGS
*ar
= opaque
;
515 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_PMTIMER
, NULL
);
516 ar
->tmr
.update_sci(ar
);
519 static uint64_t acpi_pm_tmr_read(void *opaque
, hwaddr addr
, unsigned width
)
521 return acpi_pm_tmr_get(opaque
);
524 static void acpi_pm_tmr_write(void *opaque
, hwaddr addr
, uint64_t val
,
530 static const MemoryRegionOps acpi_pm_tmr_ops
= {
531 .read
= acpi_pm_tmr_read
,
532 .write
= acpi_pm_tmr_write
,
533 .valid
.min_access_size
= 4,
534 .valid
.max_access_size
= 4,
535 .endianness
= DEVICE_LITTLE_ENDIAN
,
538 void acpi_pm_tmr_init(ACPIREGS
*ar
, acpi_update_sci_fn update_sci
,
539 MemoryRegion
*parent
)
541 ar
->tmr
.update_sci
= update_sci
;
542 ar
->tmr
.timer
= timer_new_ns(QEMU_CLOCK_VIRTUAL
, acpi_pm_tmr_timer
, ar
);
543 memory_region_init_io(&ar
->tmr
.io
, memory_region_owner(parent
),
544 &acpi_pm_tmr_ops
, ar
, "acpi-tmr", 4);
545 memory_region_add_subregion(parent
, 8, &ar
->tmr
.io
);
548 void acpi_pm_tmr_reset(ACPIREGS
*ar
)
550 ar
->tmr
.overflow_time
= 0;
551 timer_del(ar
->tmr
.timer
);
555 static void acpi_pm1_cnt_write(ACPIREGS
*ar
, uint16_t val
)
557 ar
->pm1
.cnt
.cnt
= val
& ~(ACPI_BITMASK_SLEEP_ENABLE
);
559 if (val
& ACPI_BITMASK_SLEEP_ENABLE
) {
560 /* change suspend type */
561 uint16_t sus_typ
= (val
>> 10) & 7;
563 case 0: /* soft power off */
564 qemu_system_shutdown_request(SHUTDOWN_CAUSE_GUEST_SHUTDOWN
);
567 qemu_system_suspend_request();
570 if (sus_typ
== ar
->pm1
.cnt
.s4_val
) { /* S4 request */
571 qapi_event_send_suspend_disk();
572 qemu_system_shutdown_request(SHUTDOWN_CAUSE_GUEST_SHUTDOWN
);
579 void acpi_pm1_cnt_update(ACPIREGS
*ar
,
580 bool sci_enable
, bool sci_disable
)
582 /* ACPI specs 3.0, 4.7.2.5 */
584 ar
->pm1
.cnt
.cnt
|= ACPI_BITMASK_SCI_ENABLE
;
585 } else if (sci_disable
) {
586 ar
->pm1
.cnt
.cnt
&= ~ACPI_BITMASK_SCI_ENABLE
;
590 static uint64_t acpi_pm_cnt_read(void *opaque
, hwaddr addr
, unsigned width
)
592 ACPIREGS
*ar
= opaque
;
593 return ar
->pm1
.cnt
.cnt
;
596 static void acpi_pm_cnt_write(void *opaque
, hwaddr addr
, uint64_t val
,
599 acpi_pm1_cnt_write(opaque
, val
);
602 static const MemoryRegionOps acpi_pm_cnt_ops
= {
603 .read
= acpi_pm_cnt_read
,
604 .write
= acpi_pm_cnt_write
,
605 .valid
.min_access_size
= 2,
606 .valid
.max_access_size
= 2,
607 .endianness
= DEVICE_LITTLE_ENDIAN
,
610 void acpi_pm1_cnt_init(ACPIREGS
*ar
, MemoryRegion
*parent
,
611 bool disable_s3
, bool disable_s4
, uint8_t s4_val
)
615 ar
->pm1
.cnt
.s4_val
= s4_val
;
616 ar
->wakeup
.notify
= acpi_notify_wakeup
;
617 qemu_register_wakeup_notifier(&ar
->wakeup
);
620 * Register wake-up support in QMP query-current-machine API
622 qemu_register_wakeup_support();
624 memory_region_init_io(&ar
->pm1
.cnt
.io
, memory_region_owner(parent
),
625 &acpi_pm_cnt_ops
, ar
, "acpi-cnt", 2);
626 memory_region_add_subregion(parent
, 4, &ar
->pm1
.cnt
.io
);
628 fw_cfg
= fw_cfg_find();
630 uint8_t suspend
[6] = {128, 0, 0, 129, 128, 128};
631 suspend
[3] = 1 | ((!disable_s3
) << 7);
632 suspend
[4] = s4_val
| ((!disable_s4
) << 7);
634 fw_cfg_add_file(fw_cfg
, "etc/system-states", g_memdup(suspend
, 6), 6);
638 void acpi_pm1_cnt_reset(ACPIREGS
*ar
)
644 void acpi_gpe_init(ACPIREGS
*ar
, uint8_t len
)
647 /* Only first len / 2 bytes are ever used,
648 * but the caller in ich9.c migrates full len bytes.
649 * TODO: fix ich9.c and drop the extra allocation.
651 ar
->gpe
.sts
= g_malloc0(len
);
652 ar
->gpe
.en
= g_malloc0(len
);
655 void acpi_gpe_reset(ACPIREGS
*ar
)
657 memset(ar
->gpe
.sts
, 0, ar
->gpe
.len
/ 2);
658 memset(ar
->gpe
.en
, 0, ar
->gpe
.len
/ 2);
661 static uint8_t *acpi_gpe_ioport_get_ptr(ACPIREGS
*ar
, uint32_t addr
)
665 if (addr
< ar
->gpe
.len
/ 2) {
666 cur
= ar
->gpe
.sts
+ addr
;
667 } else if (addr
< ar
->gpe
.len
) {
668 cur
= ar
->gpe
.en
+ addr
- ar
->gpe
.len
/ 2;
676 void acpi_gpe_ioport_writeb(ACPIREGS
*ar
, uint32_t addr
, uint32_t val
)
680 cur
= acpi_gpe_ioport_get_ptr(ar
, addr
);
681 if (addr
< ar
->gpe
.len
/ 2) {
683 *cur
= (*cur
) & ~val
;
684 } else if (addr
< ar
->gpe
.len
) {
692 uint32_t acpi_gpe_ioport_readb(ACPIREGS
*ar
, uint32_t addr
)
697 cur
= acpi_gpe_ioport_get_ptr(ar
, addr
);
706 void acpi_send_gpe_event(ACPIREGS
*ar
, qemu_irq irq
,
707 AcpiEventStatusBits status
)
709 ar
->gpe
.sts
[0] |= status
;
710 acpi_update_sci(ar
, irq
);
713 void acpi_update_sci(ACPIREGS
*regs
, qemu_irq irq
)
715 int sci_level
, pm1a_sts
;
717 pm1a_sts
= acpi_pm1_evt_get_sts(regs
);
719 sci_level
= ((pm1a_sts
&
720 regs
->pm1
.evt
.en
& ACPI_BITMASK_PM1_COMMON_ENABLED
) != 0) ||
721 ((regs
->gpe
.sts
[0] & regs
->gpe
.en
[0]) != 0);
723 qemu_set_irq(irq
, sci_level
);
725 /* schedule a timer interruption if needed */
726 acpi_pm_tmr_update(regs
,
727 (regs
->pm1
.evt
.en
& ACPI_BITMASK_TIMER_ENABLE
) &&
728 !(pm1a_sts
& ACPI_BITMASK_TIMER_STATUS
));