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 "hw/nvram/fw_cfg.h"
26 #include "qemu/config-file.h"
27 #include "qapi/opts-visitor.h"
28 #include "qapi/dealloc-visitor.h"
29 #include "qapi-visit.h"
30 #include "qapi-event.h"
32 struct acpi_table_header
{
33 uint16_t _length
; /* our length, not actual part of the hdr */
34 /* allows easier parsing for fw_cfg clients */
35 char sig
[4]; /* ACPI signature (4 ASCII characters) */
36 uint32_t length
; /* Length of table, in bytes, including header */
37 uint8_t revision
; /* ACPI Specification minor version # */
38 uint8_t checksum
; /* To make sum of entire table == 0 */
39 char oem_id
[6]; /* OEM identification */
40 char oem_table_id
[8]; /* OEM table identification */
41 uint32_t oem_revision
; /* OEM revision number */
42 char asl_compiler_id
[4]; /* ASL compiler vendor ID */
43 uint32_t asl_compiler_revision
; /* ASL compiler revision number */
46 #define ACPI_TABLE_HDR_SIZE sizeof(struct acpi_table_header)
47 #define ACPI_TABLE_PFX_SIZE sizeof(uint16_t) /* size of the extra prefix */
49 static const char unsigned dfl_hdr
[ACPI_TABLE_HDR_SIZE
- ACPI_TABLE_PFX_SIZE
] =
50 "QEMU\0\0\0\0\1\0" /* sig (4), len(4), revno (1), csum (1) */
51 "QEMUQEQEMUQEMU\1\0\0\0" /* OEM id (6), table (8), revno (4) */
52 "QEMU\1\0\0\0" /* ASL compiler ID (4), version (4) */
55 char unsigned *acpi_tables
;
56 size_t acpi_tables_len
;
58 static QemuOptsList qemu_acpi_opts
= {
60 .implied_opt_name
= "data",
61 .head
= QTAILQ_HEAD_INITIALIZER(qemu_acpi_opts
.head
),
62 .desc
= { { 0 } } /* validated with OptsVisitor */
65 static void acpi_register_config(void)
67 qemu_add_opts(&qemu_acpi_opts
);
70 machine_init(acpi_register_config
);
72 static int acpi_checksum(const uint8_t *data
, int len
)
76 for (i
= 0; i
< len
; i
++) {
83 /* Install a copy of the ACPI table specified in @blob.
85 * If @has_header is set, @blob starts with the System Description Table Header
86 * structure. Otherwise, "dfl_hdr" is prepended. In any case, each header field
87 * is optionally overwritten from @hdrs.
89 * It is valid to call this function with
90 * (@blob == NULL && bloblen == 0 && !has_header).
92 * @hdrs->file and @hdrs->data are ignored.
94 * SIZE_MAX is considered "infinity" in this function.
96 * The number of tables that can be installed is not limited, but the 16-bit
97 * counter at the beginning of "acpi_tables" wraps around after UINT16_MAX.
99 static void acpi_table_install(const char unsigned *blob
, size_t bloblen
,
101 const struct AcpiTableOptions
*hdrs
,
105 const char unsigned *hdr_src
;
106 size_t body_size
, acpi_payload_size
;
107 struct acpi_table_header
*ext_hdr
;
108 unsigned changed_fields
;
110 /* Calculate where the ACPI table body starts within the blob, plus where
111 * to copy the ACPI table header from.
114 /* _length | ACPI header in blob | blob body
115 * ^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^
116 * ACPI_TABLE_PFX_SIZE sizeof dfl_hdr body_size
119 * ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
120 * acpi_payload_size == bloblen
122 body_start
= sizeof dfl_hdr
;
124 if (bloblen
< body_start
) {
125 error_setg(errp
, "ACPI table claiming to have header is too "
126 "short, available: %zu, expected: %zu", bloblen
,
132 /* _length | ACPI header in template | blob body
133 * ^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^
134 * ACPI_TABLE_PFX_SIZE sizeof dfl_hdr body_size
137 * ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
143 body_size
= bloblen
- body_start
;
144 acpi_payload_size
= sizeof dfl_hdr
+ body_size
;
146 if (acpi_payload_size
> UINT16_MAX
) {
147 error_setg(errp
, "ACPI table too big, requested: %zu, max: %u",
148 acpi_payload_size
, (unsigned)UINT16_MAX
);
152 /* We won't fail from here on. Initialize / extend the globals. */
153 if (acpi_tables
== NULL
) {
154 acpi_tables_len
= sizeof(uint16_t);
155 acpi_tables
= g_malloc0(acpi_tables_len
);
158 acpi_tables
= g_realloc(acpi_tables
, acpi_tables_len
+
159 ACPI_TABLE_PFX_SIZE
+
160 sizeof dfl_hdr
+ body_size
);
162 ext_hdr
= (struct acpi_table_header
*)(acpi_tables
+ acpi_tables_len
);
163 acpi_tables_len
+= ACPI_TABLE_PFX_SIZE
;
165 memcpy(acpi_tables
+ acpi_tables_len
, hdr_src
, sizeof dfl_hdr
);
166 acpi_tables_len
+= sizeof dfl_hdr
;
169 memcpy(acpi_tables
+ acpi_tables_len
, blob
+ body_start
, body_size
);
170 acpi_tables_len
+= body_size
;
173 /* increase number of tables */
174 stw_le_p(acpi_tables
, lduw_le_p(acpi_tables
) + 1u);
176 /* Update the header fields. The strings need not be NUL-terminated. */
178 ext_hdr
->_length
= cpu_to_le16(acpi_payload_size
);
181 strncpy(ext_hdr
->sig
, hdrs
->sig
, sizeof ext_hdr
->sig
);
185 if (has_header
&& le32_to_cpu(ext_hdr
->length
) != acpi_payload_size
) {
187 "warning: ACPI table has wrong length, header says "
188 "%" PRIu32
", actual size %zu bytes\n",
189 le32_to_cpu(ext_hdr
->length
), acpi_payload_size
);
191 ext_hdr
->length
= cpu_to_le32(acpi_payload_size
);
194 ext_hdr
->revision
= hdrs
->rev
;
198 ext_hdr
->checksum
= 0;
200 if (hdrs
->has_oem_id
) {
201 strncpy(ext_hdr
->oem_id
, hdrs
->oem_id
, sizeof ext_hdr
->oem_id
);
204 if (hdrs
->has_oem_table_id
) {
205 strncpy(ext_hdr
->oem_table_id
, hdrs
->oem_table_id
,
206 sizeof ext_hdr
->oem_table_id
);
209 if (hdrs
->has_oem_rev
) {
210 ext_hdr
->oem_revision
= cpu_to_le32(hdrs
->oem_rev
);
213 if (hdrs
->has_asl_compiler_id
) {
214 strncpy(ext_hdr
->asl_compiler_id
, hdrs
->asl_compiler_id
,
215 sizeof ext_hdr
->asl_compiler_id
);
218 if (hdrs
->has_asl_compiler_rev
) {
219 ext_hdr
->asl_compiler_revision
= cpu_to_le32(hdrs
->asl_compiler_rev
);
223 if (!has_header
&& changed_fields
== 0) {
224 fprintf(stderr
, "warning: ACPI table: no headers are specified\n");
227 /* recalculate checksum */
228 ext_hdr
->checksum
= acpi_checksum((const char unsigned *)ext_hdr
+
229 ACPI_TABLE_PFX_SIZE
, acpi_payload_size
);
232 void acpi_table_add(const QemuOpts
*opts
, Error
**errp
)
234 AcpiTableOptions
*hdrs
= NULL
;
236 char **pathnames
= NULL
;
239 char unsigned *blob
= NULL
;
244 ov
= opts_visitor_new(opts
);
245 visit_type_AcpiTableOptions(opts_get_visitor(ov
), &hdrs
, NULL
, &err
);
246 opts_visitor_cleanup(ov
);
252 if (hdrs
->has_file
== hdrs
->has_data
) {
253 error_setg(&err
, "'-acpitable' requires one of 'data' or 'file'");
257 pathnames
= g_strsplit(hdrs
->has_file
? hdrs
->file
: hdrs
->data
, ":", 0);
258 if (pathnames
== NULL
|| pathnames
[0] == NULL
) {
259 error_setg(&err
, "'-acpitable' requires at least one pathname");
263 /* now read in the data files, reallocating buffer as needed */
264 for (cur
= pathnames
; *cur
; ++cur
) {
265 int fd
= open(*cur
, O_RDONLY
| O_BINARY
);
268 error_setg(&err
, "can't open file %s: %s", *cur
, strerror(errno
));
273 char unsigned data
[8192];
276 r
= read(fd
, data
, sizeof data
);
280 blob
= g_realloc(blob
, bloblen
+ r
);
281 memcpy(blob
+ bloblen
, data
, r
);
283 } else if (errno
!= EINTR
) {
284 error_setg(&err
, "can't read file %s: %s",
285 *cur
, strerror(errno
));
294 acpi_table_install(blob
, bloblen
, hdrs
->has_file
, hdrs
, &err
);
298 g_strfreev(pathnames
);
301 QapiDeallocVisitor
*dv
;
303 dv
= qapi_dealloc_visitor_new();
304 visit_type_AcpiTableOptions(qapi_dealloc_get_visitor(dv
), &hdrs
, NULL
,
306 qapi_dealloc_visitor_cleanup(dv
);
309 error_propagate(errp
, err
);
312 static bool acpi_table_builtin
= false;
314 void acpi_table_add_builtin(const QemuOpts
*opts
, Error
**errp
)
316 acpi_table_builtin
= true;
317 acpi_table_add(opts
, errp
);
320 unsigned acpi_table_len(void *current
)
322 struct acpi_table_header
*hdr
= current
- sizeof(hdr
->_length
);
327 void *acpi_table_hdr(void *h
)
329 struct acpi_table_header
*hdr
= h
;
333 uint8_t *acpi_table_first(void)
335 if (acpi_table_builtin
|| !acpi_tables
) {
338 return acpi_table_hdr(acpi_tables
+ ACPI_TABLE_PFX_SIZE
);
341 uint8_t *acpi_table_next(uint8_t *current
)
343 uint8_t *next
= current
+ acpi_table_len(current
);
345 if (next
- acpi_tables
>= acpi_tables_len
) {
348 return acpi_table_hdr(next
);
352 static void acpi_notify_wakeup(Notifier
*notifier
, void *data
)
354 ACPIREGS
*ar
= container_of(notifier
, ACPIREGS
, wakeup
);
355 WakeupReason
*reason
= data
;
358 case QEMU_WAKEUP_REASON_RTC
:
360 (ACPI_BITMASK_WAKE_STATUS
| ACPI_BITMASK_RT_CLOCK_STATUS
);
362 case QEMU_WAKEUP_REASON_PMTIMER
:
364 (ACPI_BITMASK_WAKE_STATUS
| ACPI_BITMASK_TIMER_STATUS
);
366 case QEMU_WAKEUP_REASON_OTHER
:
367 /* ACPI_BITMASK_WAKE_STATUS should be set on resume.
368 Pretend that resume was caused by power button */
370 (ACPI_BITMASK_WAKE_STATUS
| ACPI_BITMASK_POWER_BUTTON_STATUS
);
378 uint16_t acpi_pm1_evt_get_sts(ACPIREGS
*ar
)
380 /* Compare ns-clock, not PM timer ticks, because
381 acpi_pm_tmr_update function uses ns for setting the timer. */
382 int64_t d
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
383 if (d
>= muldiv64(ar
->tmr
.overflow_time
,
384 get_ticks_per_sec(), PM_TIMER_FREQUENCY
)) {
385 ar
->pm1
.evt
.sts
|= ACPI_BITMASK_TIMER_STATUS
;
387 return ar
->pm1
.evt
.sts
;
390 static void acpi_pm1_evt_write_sts(ACPIREGS
*ar
, uint16_t val
)
392 uint16_t pm1_sts
= acpi_pm1_evt_get_sts(ar
);
393 if (pm1_sts
& val
& ACPI_BITMASK_TIMER_STATUS
) {
394 /* if TMRSTS is reset, then compute the new overflow time */
395 acpi_pm_tmr_calc_overflow_time(ar
);
397 ar
->pm1
.evt
.sts
&= ~val
;
400 static void acpi_pm1_evt_write_en(ACPIREGS
*ar
, uint16_t val
)
402 ar
->pm1
.evt
.en
= val
;
403 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_RTC
,
404 val
& ACPI_BITMASK_RT_CLOCK_ENABLE
);
405 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_PMTIMER
,
406 val
& ACPI_BITMASK_TIMER_ENABLE
);
409 void acpi_pm1_evt_power_down(ACPIREGS
*ar
)
411 if (ar
->pm1
.evt
.en
& ACPI_BITMASK_POWER_BUTTON_ENABLE
) {
412 ar
->pm1
.evt
.sts
|= ACPI_BITMASK_POWER_BUTTON_STATUS
;
413 ar
->tmr
.update_sci(ar
);
417 void acpi_pm1_evt_reset(ACPIREGS
*ar
)
421 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_RTC
, 0);
422 qemu_system_wakeup_enable(QEMU_WAKEUP_REASON_PMTIMER
, 0);
425 static uint64_t acpi_pm_evt_read(void *opaque
, hwaddr addr
, unsigned width
)
427 ACPIREGS
*ar
= opaque
;
430 return acpi_pm1_evt_get_sts(ar
);
432 return ar
->pm1
.evt
.en
;
438 static void acpi_pm_evt_write(void *opaque
, hwaddr addr
, uint64_t val
,
441 ACPIREGS
*ar
= opaque
;
444 acpi_pm1_evt_write_sts(ar
, val
);
445 ar
->pm1
.evt
.update_sci(ar
);
448 acpi_pm1_evt_write_en(ar
, val
);
449 ar
->pm1
.evt
.update_sci(ar
);
454 static const MemoryRegionOps acpi_pm_evt_ops
= {
455 .read
= acpi_pm_evt_read
,
456 .write
= acpi_pm_evt_write
,
457 .valid
.min_access_size
= 2,
458 .valid
.max_access_size
= 2,
459 .endianness
= DEVICE_LITTLE_ENDIAN
,
462 void acpi_pm1_evt_init(ACPIREGS
*ar
, acpi_update_sci_fn update_sci
,
463 MemoryRegion
*parent
)
465 ar
->pm1
.evt
.update_sci
= update_sci
;
466 memory_region_init_io(&ar
->pm1
.evt
.io
, memory_region_owner(parent
),
467 &acpi_pm_evt_ops
, ar
, "acpi-evt", 4);
468 memory_region_add_subregion(parent
, 0, &ar
->pm1
.evt
.io
);
472 void acpi_pm_tmr_update(ACPIREGS
*ar
, bool enable
)
476 /* schedule a timer interruption if needed */
478 expire_time
= muldiv64(ar
->tmr
.overflow_time
, get_ticks_per_sec(),
480 timer_mod(ar
->tmr
.timer
, expire_time
);
482 timer_del(ar
->tmr
.timer
);
486 void acpi_pm_tmr_calc_overflow_time(ACPIREGS
*ar
)
488 int64_t d
= acpi_pm_tmr_get_clock();
489 ar
->tmr
.overflow_time
= (d
+ 0x800000LL
) & ~0x7fffffLL
;
492 static uint32_t acpi_pm_tmr_get(ACPIREGS
*ar
)
494 uint32_t d
= acpi_pm_tmr_get_clock();
498 static void acpi_pm_tmr_timer(void *opaque
)
500 ACPIREGS
*ar
= opaque
;
501 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_PMTIMER
);
502 ar
->tmr
.update_sci(ar
);
505 static uint64_t acpi_pm_tmr_read(void *opaque
, hwaddr addr
, unsigned width
)
507 return acpi_pm_tmr_get(opaque
);
510 static void acpi_pm_tmr_write(void *opaque
, hwaddr addr
, uint64_t val
,
516 static const MemoryRegionOps acpi_pm_tmr_ops
= {
517 .read
= acpi_pm_tmr_read
,
518 .write
= acpi_pm_tmr_write
,
519 .valid
.min_access_size
= 4,
520 .valid
.max_access_size
= 4,
521 .endianness
= DEVICE_LITTLE_ENDIAN
,
524 void acpi_pm_tmr_init(ACPIREGS
*ar
, acpi_update_sci_fn update_sci
,
525 MemoryRegion
*parent
)
527 ar
->tmr
.update_sci
= update_sci
;
528 ar
->tmr
.timer
= timer_new_ns(QEMU_CLOCK_VIRTUAL
, acpi_pm_tmr_timer
, ar
);
529 memory_region_init_io(&ar
->tmr
.io
, memory_region_owner(parent
),
530 &acpi_pm_tmr_ops
, ar
, "acpi-tmr", 4);
531 memory_region_clear_global_locking(&ar
->tmr
.io
);
532 memory_region_add_subregion(parent
, 8, &ar
->tmr
.io
);
535 void acpi_pm_tmr_reset(ACPIREGS
*ar
)
537 ar
->tmr
.overflow_time
= 0;
538 timer_del(ar
->tmr
.timer
);
542 static void acpi_pm1_cnt_write(ACPIREGS
*ar
, uint16_t val
)
544 ar
->pm1
.cnt
.cnt
= val
& ~(ACPI_BITMASK_SLEEP_ENABLE
);
546 if (val
& ACPI_BITMASK_SLEEP_ENABLE
) {
547 /* change suspend type */
548 uint16_t sus_typ
= (val
>> 10) & 7;
550 case 0: /* soft power off */
551 qemu_system_shutdown_request();
554 qemu_system_suspend_request();
557 if (sus_typ
== ar
->pm1
.cnt
.s4_val
) { /* S4 request */
558 qapi_event_send_suspend_disk(&error_abort
);
559 qemu_system_shutdown_request();
566 void acpi_pm1_cnt_update(ACPIREGS
*ar
,
567 bool sci_enable
, bool sci_disable
)
569 /* ACPI specs 3.0, 4.7.2.5 */
571 ar
->pm1
.cnt
.cnt
|= ACPI_BITMASK_SCI_ENABLE
;
572 } else if (sci_disable
) {
573 ar
->pm1
.cnt
.cnt
&= ~ACPI_BITMASK_SCI_ENABLE
;
577 static uint64_t acpi_pm_cnt_read(void *opaque
, hwaddr addr
, unsigned width
)
579 ACPIREGS
*ar
= opaque
;
580 return ar
->pm1
.cnt
.cnt
;
583 static void acpi_pm_cnt_write(void *opaque
, hwaddr addr
, uint64_t val
,
586 acpi_pm1_cnt_write(opaque
, val
);
589 static const MemoryRegionOps acpi_pm_cnt_ops
= {
590 .read
= acpi_pm_cnt_read
,
591 .write
= acpi_pm_cnt_write
,
592 .valid
.min_access_size
= 2,
593 .valid
.max_access_size
= 2,
594 .endianness
= DEVICE_LITTLE_ENDIAN
,
597 void acpi_pm1_cnt_init(ACPIREGS
*ar
, MemoryRegion
*parent
,
598 bool disable_s3
, bool disable_s4
, uint8_t s4_val
)
602 ar
->pm1
.cnt
.s4_val
= s4_val
;
603 ar
->wakeup
.notify
= acpi_notify_wakeup
;
604 qemu_register_wakeup_notifier(&ar
->wakeup
);
605 memory_region_init_io(&ar
->pm1
.cnt
.io
, memory_region_owner(parent
),
606 &acpi_pm_cnt_ops
, ar
, "acpi-cnt", 2);
607 memory_region_add_subregion(parent
, 4, &ar
->pm1
.cnt
.io
);
609 fw_cfg
= fw_cfg_find();
611 uint8_t suspend
[6] = {128, 0, 0, 129, 128, 128};
612 suspend
[3] = 1 | ((!disable_s3
) << 7);
613 suspend
[4] = s4_val
| ((!disable_s4
) << 7);
615 fw_cfg_add_file(fw_cfg
, "etc/system-states", g_memdup(suspend
, 6), 6);
619 void acpi_pm1_cnt_reset(ACPIREGS
*ar
)
625 void acpi_gpe_init(ACPIREGS
*ar
, uint8_t len
)
628 ar
->gpe
.sts
= g_malloc0(len
/ 2);
629 ar
->gpe
.en
= g_malloc0(len
/ 2);
632 void acpi_gpe_reset(ACPIREGS
*ar
)
634 memset(ar
->gpe
.sts
, 0, ar
->gpe
.len
/ 2);
635 memset(ar
->gpe
.en
, 0, ar
->gpe
.len
/ 2);
638 static uint8_t *acpi_gpe_ioport_get_ptr(ACPIREGS
*ar
, uint32_t addr
)
642 if (addr
< ar
->gpe
.len
/ 2) {
643 cur
= ar
->gpe
.sts
+ addr
;
644 } else if (addr
< ar
->gpe
.len
) {
645 cur
= ar
->gpe
.en
+ addr
- ar
->gpe
.len
/ 2;
653 void acpi_gpe_ioport_writeb(ACPIREGS
*ar
, uint32_t addr
, uint32_t val
)
657 cur
= acpi_gpe_ioport_get_ptr(ar
, addr
);
658 if (addr
< ar
->gpe
.len
/ 2) {
660 *cur
= (*cur
) & ~val
;
661 } else if (addr
< ar
->gpe
.len
) {
669 uint32_t acpi_gpe_ioport_readb(ACPIREGS
*ar
, uint32_t addr
)
674 cur
= acpi_gpe_ioport_get_ptr(ar
, addr
);
683 void acpi_send_gpe_event(ACPIREGS
*ar
, qemu_irq irq
,
684 AcpiGPEStatusBits status
)
686 ar
->gpe
.sts
[0] |= status
;
687 acpi_update_sci(ar
, irq
);
690 void acpi_update_sci(ACPIREGS
*regs
, qemu_irq irq
)
692 int sci_level
, pm1a_sts
;
694 pm1a_sts
= acpi_pm1_evt_get_sts(regs
);
696 sci_level
= ((pm1a_sts
&
697 regs
->pm1
.evt
.en
& ACPI_BITMASK_PM1_COMMON_ENABLED
) != 0) ||
698 ((regs
->gpe
.sts
[0] & regs
->gpe
.en
[0]) != 0);
700 qemu_set_irq(irq
, sci_level
);
702 /* schedule a timer interruption if needed */
703 acpi_pm_tmr_update(regs
,
704 (regs
->pm1
.evt
.en
& ACPI_BITMASK_TIMER_ENABLE
) &&
705 !(pm1a_sts
& ACPI_BITMASK_TIMER_STATUS
));