2 * QEMU Firmware configuration device emulation
4 * Copyright (c) 2008 Gleb Natapov
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "sysemu/sysemu.h"
26 #include "hw/isa/isa.h"
27 #include "hw/nvram/fw_cfg.h"
28 #include "hw/sysbus.h"
30 #include "qemu/error-report.h"
31 #include "qemu/config-file.h"
34 #define FW_CFG_NAME "fw_cfg"
35 #define FW_CFG_PATH "/machine/" FW_CFG_NAME
37 #define TYPE_FW_CFG "fw_cfg"
38 #define TYPE_FW_CFG_IO "fw_cfg_io"
39 #define TYPE_FW_CFG_MEM "fw_cfg_mem"
41 #define FW_CFG(obj) OBJECT_CHECK(FWCfgState, (obj), TYPE_FW_CFG)
42 #define FW_CFG_IO(obj) OBJECT_CHECK(FWCfgIoState, (obj), TYPE_FW_CFG_IO)
43 #define FW_CFG_MEM(obj) OBJECT_CHECK(FWCfgMemState, (obj), TYPE_FW_CFG_MEM)
45 typedef struct FWCfgEntry
{
48 void *callback_opaque
;
49 FWCfgReadCallback read_callback
;
54 SysBusDevice parent_obj
;
57 FWCfgEntry entries
[2][FW_CFG_MAX_ENTRY
];
61 Notifier machine_ready
;
66 FWCfgState parent_obj
;
69 MemoryRegion comb_iomem
;
73 struct FWCfgMemState
{
75 FWCfgState parent_obj
;
78 MemoryRegion ctl_iomem
, data_iomem
;
80 MemoryRegionOps wide_data_ops
;
86 static char *read_splashfile(char *filename
, gsize
*file_sizep
,
93 unsigned int filehead
;
96 res
= g_file_get_contents(filename
, &content
, file_sizep
, &err
);
98 error_report("failed to read splash file '%s'", filename
);
103 /* check file size */
104 if (*file_sizep
< 30) {
109 filehead
= ((content
[0] & 0xff) + (content
[1] << 8)) & 0xffff;
110 if (filehead
== 0xd8ff) {
111 file_type
= JPG_FILE
;
112 } else if (filehead
== 0x4d42) {
113 file_type
= BMP_FILE
;
119 if (file_type
== BMP_FILE
) {
120 bmp_bpp
= (content
[28] + (content
[29] << 8)) & 0xffff;
127 *file_typep
= file_type
;
132 error_report("splash file '%s' format not recognized; must be JPEG "
133 "or 24 bit BMP", filename
);
138 static void fw_cfg_bootsplash(FWCfgState
*s
)
140 int boot_splash_time
= -1;
141 const char *boot_splash_filename
= NULL
;
143 char *filename
, *file_data
;
148 /* get user configuration */
149 QemuOptsList
*plist
= qemu_find_opts("boot-opts");
150 QemuOpts
*opts
= QTAILQ_FIRST(&plist
->head
);
152 temp
= qemu_opt_get(opts
, "splash");
154 boot_splash_filename
= temp
;
156 temp
= qemu_opt_get(opts
, "splash-time");
159 boot_splash_time
= strtol(p
, (char **)&p
, 10);
163 /* insert splash time if user configurated */
164 if (boot_splash_time
>= 0) {
165 /* validate the input */
166 if (boot_splash_time
> 0xffff) {
167 error_report("splash time is big than 65535, force it to 65535.");
168 boot_splash_time
= 0xffff;
170 /* use little endian format */
171 qemu_extra_params_fw
[0] = (uint8_t)(boot_splash_time
& 0xff);
172 qemu_extra_params_fw
[1] = (uint8_t)((boot_splash_time
>> 8) & 0xff);
173 fw_cfg_add_file(s
, "etc/boot-menu-wait", qemu_extra_params_fw
, 2);
176 /* insert splash file if user configurated */
177 if (boot_splash_filename
!= NULL
) {
178 filename
= qemu_find_file(QEMU_FILE_TYPE_BIOS
, boot_splash_filename
);
179 if (filename
== NULL
) {
180 error_report("failed to find file '%s'.", boot_splash_filename
);
184 /* loading file data */
185 file_data
= read_splashfile(filename
, &file_size
, &file_type
);
186 if (file_data
== NULL
) {
190 if (boot_splash_filedata
!= NULL
) {
191 g_free(boot_splash_filedata
);
193 boot_splash_filedata
= (uint8_t *)file_data
;
194 boot_splash_filedata_size
= file_size
;
197 if (file_type
== JPG_FILE
) {
198 fw_cfg_add_file(s
, "bootsplash.jpg",
199 boot_splash_filedata
, boot_splash_filedata_size
);
201 fw_cfg_add_file(s
, "bootsplash.bmp",
202 boot_splash_filedata
, boot_splash_filedata_size
);
208 static void fw_cfg_reboot(FWCfgState
*s
)
210 int reboot_timeout
= -1;
214 /* get user configuration */
215 QemuOptsList
*plist
= qemu_find_opts("boot-opts");
216 QemuOpts
*opts
= QTAILQ_FIRST(&plist
->head
);
218 temp
= qemu_opt_get(opts
, "reboot-timeout");
221 reboot_timeout
= strtol(p
, (char **)&p
, 10);
224 /* validate the input */
225 if (reboot_timeout
> 0xffff) {
226 error_report("reboot timeout is larger than 65535, force it to 65535.");
227 reboot_timeout
= 0xffff;
229 fw_cfg_add_file(s
, "etc/boot-fail-wait", g_memdup(&reboot_timeout
, 4), 4);
232 static void fw_cfg_write(FWCfgState
*s
, uint8_t value
)
234 /* nothing, write support removed in QEMU v2.4+ */
237 static int fw_cfg_select(FWCfgState
*s
, uint16_t key
)
242 if ((key
& FW_CFG_ENTRY_MASK
) >= FW_CFG_MAX_ENTRY
) {
243 s
->cur_entry
= FW_CFG_INVALID
;
250 trace_fw_cfg_select(s
, key
, ret
);
254 static uint8_t fw_cfg_read(FWCfgState
*s
)
256 int arch
= !!(s
->cur_entry
& FW_CFG_ARCH_LOCAL
);
257 FWCfgEntry
*e
= &s
->entries
[arch
][s
->cur_entry
& FW_CFG_ENTRY_MASK
];
260 if (s
->cur_entry
== FW_CFG_INVALID
|| !e
->data
|| s
->cur_offset
>= e
->len
)
263 if (e
->read_callback
) {
264 e
->read_callback(e
->callback_opaque
, s
->cur_offset
);
266 ret
= e
->data
[s
->cur_offset
++];
269 trace_fw_cfg_read(s
, ret
);
273 static uint64_t fw_cfg_data_mem_read(void *opaque
, hwaddr addr
,
276 FWCfgState
*s
= opaque
;
280 for (i
= 0; i
< size
; ++i
) {
281 value
= (value
<< 8) | fw_cfg_read(s
);
286 static void fw_cfg_data_mem_write(void *opaque
, hwaddr addr
,
287 uint64_t value
, unsigned size
)
289 FWCfgState
*s
= opaque
;
293 fw_cfg_write(s
, value
>> (8 * --i
));
297 static bool fw_cfg_data_mem_valid(void *opaque
, hwaddr addr
,
298 unsigned size
, bool is_write
)
303 static void fw_cfg_ctl_mem_write(void *opaque
, hwaddr addr
,
304 uint64_t value
, unsigned size
)
306 fw_cfg_select(opaque
, (uint16_t)value
);
309 static bool fw_cfg_ctl_mem_valid(void *opaque
, hwaddr addr
,
310 unsigned size
, bool is_write
)
312 return is_write
&& size
== 2;
315 static uint64_t fw_cfg_comb_read(void *opaque
, hwaddr addr
,
318 return fw_cfg_read(opaque
);
321 static void fw_cfg_comb_write(void *opaque
, hwaddr addr
,
322 uint64_t value
, unsigned size
)
326 fw_cfg_write(opaque
, (uint8_t)value
);
329 fw_cfg_select(opaque
, (uint16_t)value
);
334 static bool fw_cfg_comb_valid(void *opaque
, hwaddr addr
,
335 unsigned size
, bool is_write
)
337 return (size
== 1) || (is_write
&& size
== 2);
340 static const MemoryRegionOps fw_cfg_ctl_mem_ops
= {
341 .write
= fw_cfg_ctl_mem_write
,
342 .endianness
= DEVICE_BIG_ENDIAN
,
343 .valid
.accepts
= fw_cfg_ctl_mem_valid
,
346 static const MemoryRegionOps fw_cfg_data_mem_ops
= {
347 .read
= fw_cfg_data_mem_read
,
348 .write
= fw_cfg_data_mem_write
,
349 .endianness
= DEVICE_BIG_ENDIAN
,
351 .min_access_size
= 1,
352 .max_access_size
= 1,
353 .accepts
= fw_cfg_data_mem_valid
,
357 static const MemoryRegionOps fw_cfg_comb_mem_ops
= {
358 .read
= fw_cfg_comb_read
,
359 .write
= fw_cfg_comb_write
,
360 .endianness
= DEVICE_LITTLE_ENDIAN
,
361 .valid
.accepts
= fw_cfg_comb_valid
,
364 static void fw_cfg_reset(DeviceState
*d
)
366 FWCfgState
*s
= FW_CFG(d
);
371 /* Save restore 32 bit int as uint16_t
372 This is a Big hack, but it is how the old state did it.
373 Or we broke compatibility in the state, or we can't use struct tm
376 static int get_uint32_as_uint16(QEMUFile
*f
, void *pv
, size_t size
)
379 *v
= qemu_get_be16(f
);
383 static void put_unused(QEMUFile
*f
, void *pv
, size_t size
)
385 fprintf(stderr
, "uint32_as_uint16 is only used for backward compatibility.\n");
386 fprintf(stderr
, "This functions shouldn't be called.\n");
389 static const VMStateInfo vmstate_hack_uint32_as_uint16
= {
390 .name
= "int32_as_uint16",
391 .get
= get_uint32_as_uint16
,
395 #define VMSTATE_UINT16_HACK(_f, _s, _t) \
396 VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_hack_uint32_as_uint16, uint32_t)
399 static bool is_version_1(void *opaque
, int version_id
)
401 return version_id
== 1;
404 static const VMStateDescription vmstate_fw_cfg
= {
407 .minimum_version_id
= 1,
408 .fields
= (VMStateField
[]) {
409 VMSTATE_UINT16(cur_entry
, FWCfgState
),
410 VMSTATE_UINT16_HACK(cur_offset
, FWCfgState
, is_version_1
),
411 VMSTATE_UINT32_V(cur_offset
, FWCfgState
, 2),
412 VMSTATE_END_OF_LIST()
416 static void fw_cfg_add_bytes_read_callback(FWCfgState
*s
, uint16_t key
,
417 FWCfgReadCallback callback
,
418 void *callback_opaque
,
419 void *data
, size_t len
)
421 int arch
= !!(key
& FW_CFG_ARCH_LOCAL
);
423 key
&= FW_CFG_ENTRY_MASK
;
425 assert(key
< FW_CFG_MAX_ENTRY
&& len
< UINT32_MAX
);
426 assert(s
->entries
[arch
][key
].data
== NULL
); /* avoid key conflict */
428 s
->entries
[arch
][key
].data
= data
;
429 s
->entries
[arch
][key
].len
= (uint32_t)len
;
430 s
->entries
[arch
][key
].read_callback
= callback
;
431 s
->entries
[arch
][key
].callback_opaque
= callback_opaque
;
434 static void *fw_cfg_modify_bytes_read(FWCfgState
*s
, uint16_t key
,
435 void *data
, size_t len
)
438 int arch
= !!(key
& FW_CFG_ARCH_LOCAL
);
440 key
&= FW_CFG_ENTRY_MASK
;
442 assert(key
< FW_CFG_MAX_ENTRY
&& len
< UINT32_MAX
);
444 /* return the old data to the function caller, avoid memory leak */
445 ptr
= s
->entries
[arch
][key
].data
;
446 s
->entries
[arch
][key
].data
= data
;
447 s
->entries
[arch
][key
].len
= len
;
448 s
->entries
[arch
][key
].callback_opaque
= NULL
;
453 void fw_cfg_add_bytes(FWCfgState
*s
, uint16_t key
, void *data
, size_t len
)
455 fw_cfg_add_bytes_read_callback(s
, key
, NULL
, NULL
, data
, len
);
458 void fw_cfg_add_string(FWCfgState
*s
, uint16_t key
, const char *value
)
460 size_t sz
= strlen(value
) + 1;
462 fw_cfg_add_bytes(s
, key
, g_memdup(value
, sz
), sz
);
465 void fw_cfg_add_i16(FWCfgState
*s
, uint16_t key
, uint16_t value
)
469 copy
= g_malloc(sizeof(value
));
470 *copy
= cpu_to_le16(value
);
471 fw_cfg_add_bytes(s
, key
, copy
, sizeof(value
));
474 void fw_cfg_modify_i16(FWCfgState
*s
, uint16_t key
, uint16_t value
)
476 uint16_t *copy
, *old
;
478 copy
= g_malloc(sizeof(value
));
479 *copy
= cpu_to_le16(value
);
480 old
= fw_cfg_modify_bytes_read(s
, key
, copy
, sizeof(value
));
484 void fw_cfg_add_i32(FWCfgState
*s
, uint16_t key
, uint32_t value
)
488 copy
= g_malloc(sizeof(value
));
489 *copy
= cpu_to_le32(value
);
490 fw_cfg_add_bytes(s
, key
, copy
, sizeof(value
));
493 void fw_cfg_add_i64(FWCfgState
*s
, uint16_t key
, uint64_t value
)
497 copy
= g_malloc(sizeof(value
));
498 *copy
= cpu_to_le64(value
);
499 fw_cfg_add_bytes(s
, key
, copy
, sizeof(value
));
502 void fw_cfg_add_file_callback(FWCfgState
*s
, const char *filename
,
503 FWCfgReadCallback callback
, void *callback_opaque
,
504 void *data
, size_t len
)
510 dsize
= sizeof(uint32_t) + sizeof(FWCfgFile
) * FW_CFG_FILE_SLOTS
;
511 s
->files
= g_malloc0(dsize
);
512 fw_cfg_add_bytes(s
, FW_CFG_FILE_DIR
, s
->files
, dsize
);
515 index
= be32_to_cpu(s
->files
->count
);
516 assert(index
< FW_CFG_FILE_SLOTS
);
518 pstrcpy(s
->files
->f
[index
].name
, sizeof(s
->files
->f
[index
].name
),
520 for (i
= 0; i
< index
; i
++) {
521 if (strcmp(s
->files
->f
[index
].name
, s
->files
->f
[i
].name
) == 0) {
522 error_report("duplicate fw_cfg file name: %s",
523 s
->files
->f
[index
].name
);
528 fw_cfg_add_bytes_read_callback(s
, FW_CFG_FILE_FIRST
+ index
,
529 callback
, callback_opaque
, data
, len
);
531 s
->files
->f
[index
].size
= cpu_to_be32(len
);
532 s
->files
->f
[index
].select
= cpu_to_be16(FW_CFG_FILE_FIRST
+ index
);
533 trace_fw_cfg_add_file(s
, index
, s
->files
->f
[index
].name
, len
);
535 s
->files
->count
= cpu_to_be32(index
+1);
538 void fw_cfg_add_file(FWCfgState
*s
, const char *filename
,
539 void *data
, size_t len
)
541 fw_cfg_add_file_callback(s
, filename
, NULL
, NULL
, data
, len
);
544 void *fw_cfg_modify_file(FWCfgState
*s
, const char *filename
,
545 void *data
, size_t len
)
552 index
= be32_to_cpu(s
->files
->count
);
553 assert(index
< FW_CFG_FILE_SLOTS
);
555 for (i
= 0; i
< index
; i
++) {
556 if (strcmp(filename
, s
->files
->f
[i
].name
) == 0) {
557 ptr
= fw_cfg_modify_bytes_read(s
, FW_CFG_FILE_FIRST
+ i
,
559 s
->files
->f
[i
].size
= cpu_to_be32(len
);
564 fw_cfg_add_file_callback(s
, filename
, NULL
, NULL
, data
, len
);
568 static void fw_cfg_machine_reset(void *opaque
)
572 FWCfgState
*s
= opaque
;
573 char *bootindex
= get_boot_devices_list(&len
, false);
575 ptr
= fw_cfg_modify_file(s
, "bootorder", (uint8_t *)bootindex
, len
);
579 static void fw_cfg_machine_ready(struct Notifier
*n
, void *data
)
581 FWCfgState
*s
= container_of(n
, FWCfgState
, machine_ready
);
582 qemu_register_reset(fw_cfg_machine_reset
, s
);
587 static void fw_cfg_init1(DeviceState
*dev
)
589 FWCfgState
*s
= FW_CFG(dev
);
591 assert(!object_resolve_path(FW_CFG_PATH
, NULL
));
593 object_property_add_child(qdev_get_machine(), FW_CFG_NAME
, OBJECT(s
), NULL
);
595 qdev_init_nofail(dev
);
597 fw_cfg_add_bytes(s
, FW_CFG_SIGNATURE
, (char *)"QEMU", 4);
598 fw_cfg_add_i32(s
, FW_CFG_ID
, 1);
599 fw_cfg_add_bytes(s
, FW_CFG_UUID
, qemu_uuid
, 16);
600 fw_cfg_add_i16(s
, FW_CFG_NOGRAPHIC
, (uint16_t)(display_type
== DT_NOGRAPHIC
));
601 fw_cfg_add_i16(s
, FW_CFG_NB_CPUS
, (uint16_t)smp_cpus
);
602 fw_cfg_add_i16(s
, FW_CFG_BOOT_MENU
, (uint16_t)boot_menu
);
603 fw_cfg_bootsplash(s
);
606 s
->machine_ready
.notify
= fw_cfg_machine_ready
;
607 qemu_add_machine_init_done_notifier(&s
->machine_ready
);
610 FWCfgState
*fw_cfg_init_io(uint32_t iobase
)
614 dev
= qdev_create(NULL
, TYPE_FW_CFG_IO
);
615 qdev_prop_set_uint32(dev
, "iobase", iobase
);
621 FWCfgState
*fw_cfg_init_mem_wide(hwaddr ctl_addr
, hwaddr data_addr
,
627 dev
= qdev_create(NULL
, TYPE_FW_CFG_MEM
);
628 qdev_prop_set_uint32(dev
, "data_width", data_width
);
632 sbd
= SYS_BUS_DEVICE(dev
);
633 sysbus_mmio_map(sbd
, 0, ctl_addr
);
634 sysbus_mmio_map(sbd
, 1, data_addr
);
639 FWCfgState
*fw_cfg_init_mem(hwaddr ctl_addr
, hwaddr data_addr
)
641 return fw_cfg_init_mem_wide(ctl_addr
, data_addr
,
642 fw_cfg_data_mem_ops
.valid
.max_access_size
);
646 FWCfgState
*fw_cfg_find(void)
648 return FW_CFG(object_resolve_path(FW_CFG_PATH
, NULL
));
651 static void fw_cfg_class_init(ObjectClass
*klass
, void *data
)
653 DeviceClass
*dc
= DEVICE_CLASS(klass
);
655 dc
->reset
= fw_cfg_reset
;
656 dc
->vmsd
= &vmstate_fw_cfg
;
659 static const TypeInfo fw_cfg_info
= {
661 .parent
= TYPE_SYS_BUS_DEVICE
,
662 .instance_size
= sizeof(FWCfgState
),
663 .class_init
= fw_cfg_class_init
,
667 static Property fw_cfg_io_properties
[] = {
668 DEFINE_PROP_UINT32("iobase", FWCfgIoState
, iobase
, -1),
669 DEFINE_PROP_END_OF_LIST(),
672 static void fw_cfg_io_realize(DeviceState
*dev
, Error
**errp
)
674 FWCfgIoState
*s
= FW_CFG_IO(dev
);
675 SysBusDevice
*sbd
= SYS_BUS_DEVICE(dev
);
677 memory_region_init_io(&s
->comb_iomem
, OBJECT(s
), &fw_cfg_comb_mem_ops
,
678 FW_CFG(s
), "fwcfg", FW_CFG_SIZE
);
679 sysbus_add_io(sbd
, s
->iobase
, &s
->comb_iomem
);
682 static void fw_cfg_io_class_init(ObjectClass
*klass
, void *data
)
684 DeviceClass
*dc
= DEVICE_CLASS(klass
);
686 dc
->realize
= fw_cfg_io_realize
;
687 dc
->props
= fw_cfg_io_properties
;
690 static const TypeInfo fw_cfg_io_info
= {
691 .name
= TYPE_FW_CFG_IO
,
692 .parent
= TYPE_FW_CFG
,
693 .instance_size
= sizeof(FWCfgIoState
),
694 .class_init
= fw_cfg_io_class_init
,
698 static Property fw_cfg_mem_properties
[] = {
699 DEFINE_PROP_UINT32("data_width", FWCfgMemState
, data_width
, -1),
700 DEFINE_PROP_END_OF_LIST(),
703 static void fw_cfg_mem_realize(DeviceState
*dev
, Error
**errp
)
705 FWCfgMemState
*s
= FW_CFG_MEM(dev
);
706 SysBusDevice
*sbd
= SYS_BUS_DEVICE(dev
);
707 const MemoryRegionOps
*data_ops
= &fw_cfg_data_mem_ops
;
709 memory_region_init_io(&s
->ctl_iomem
, OBJECT(s
), &fw_cfg_ctl_mem_ops
,
710 FW_CFG(s
), "fwcfg.ctl", FW_CFG_SIZE
);
711 sysbus_init_mmio(sbd
, &s
->ctl_iomem
);
713 if (s
->data_width
> data_ops
->valid
.max_access_size
) {
714 /* memberwise copy because the "old_mmio" member is const */
715 s
->wide_data_ops
.read
= data_ops
->read
;
716 s
->wide_data_ops
.write
= data_ops
->write
;
717 s
->wide_data_ops
.endianness
= data_ops
->endianness
;
718 s
->wide_data_ops
.valid
= data_ops
->valid
;
719 s
->wide_data_ops
.impl
= data_ops
->impl
;
721 s
->wide_data_ops
.valid
.max_access_size
= s
->data_width
;
722 s
->wide_data_ops
.impl
.max_access_size
= s
->data_width
;
723 data_ops
= &s
->wide_data_ops
;
725 memory_region_init_io(&s
->data_iomem
, OBJECT(s
), data_ops
, FW_CFG(s
),
726 "fwcfg.data", data_ops
->valid
.max_access_size
);
727 sysbus_init_mmio(sbd
, &s
->data_iomem
);
730 static void fw_cfg_mem_class_init(ObjectClass
*klass
, void *data
)
732 DeviceClass
*dc
= DEVICE_CLASS(klass
);
734 dc
->realize
= fw_cfg_mem_realize
;
735 dc
->props
= fw_cfg_mem_properties
;
738 static const TypeInfo fw_cfg_mem_info
= {
739 .name
= TYPE_FW_CFG_MEM
,
740 .parent
= TYPE_FW_CFG
,
741 .instance_size
= sizeof(FWCfgMemState
),
742 .class_init
= fw_cfg_mem_class_init
,
746 static void fw_cfg_register_types(void)
748 type_register_static(&fw_cfg_info
);
749 type_register_static(&fw_cfg_io_info
);
750 type_register_static(&fw_cfg_mem_info
);
753 type_init(fw_cfg_register_types
)