4 * Copyright IBM, Corp. 2012
9 * This work is licensed under the terms of the GNU GPL, version 2 or (at your
10 * option) any later version. See the COPYING file in the top-level directory.
14 #include "qemu/osdep.h"
15 #include "qemu-common.h"
16 #include "qapi/error.h"
17 #include "sysemu/reset.h"
18 #include "sysemu/runstate.h"
19 #include "sysemu/sysemu.h"
20 #include "sysemu/tcg.h"
23 #include "hw/loader.h"
24 #include "hw/qdev-properties.h"
25 #include "hw/boards.h"
26 #include "hw/s390x/virtio-ccw.h"
27 #include "hw/s390x/vfio-ccw.h"
28 #include "hw/s390x/css.h"
29 #include "hw/s390x/ebcdic.h"
31 #include "qemu/error-report.h"
32 #include "qemu/config-file.h"
33 #include "qemu/cutils.h"
34 #include "qemu/option.h"
35 #include "exec/exec-all.h"
37 #define KERN_IMAGE_START 0x010000UL
38 #define LINUX_MAGIC_ADDR 0x010008UL
39 #define KERN_PARM_AREA 0x010480UL
40 #define INITRD_START 0x800000UL
41 #define INITRD_PARM_START 0x010408UL
42 #define PARMFILE_START 0x001000UL
43 #define ZIPL_IMAGE_START 0x009000UL
44 #define IPL_PSW_MASK (PSW_MASK_32 | PSW_MASK_64)
46 static bool iplb_extended_needed(void *opaque)
48 S390IPLState *ipl = S390_IPL(object_resolve_path(TYPE_S390_IPL, NULL));
50 return ipl->iplbext_migration;
53 static const VMStateDescription vmstate_iplb_extended = {
54 .name = "ipl/iplb_extended",
56 .minimum_version_id = 0,
57 .needed = iplb_extended_needed,
58 .fields = (VMStateField[]) {
59 VMSTATE_UINT8_ARRAY(reserved_ext, IplParameterBlock, 4096 - 200),
64 static const VMStateDescription vmstate_iplb = {
67 .minimum_version_id = 0,
68 .fields = (VMStateField[]) {
69 VMSTATE_UINT8_ARRAY(reserved1, IplParameterBlock, 110),
70 VMSTATE_UINT16(devno, IplParameterBlock),
71 VMSTATE_UINT8_ARRAY(reserved2, IplParameterBlock, 88),
74 .subsections = (const VMStateDescription*[]) {
75 &vmstate_iplb_extended,
80 static const VMStateDescription vmstate_ipl = {
83 .minimum_version_id = 0,
84 .fields = (VMStateField[]) {
85 VMSTATE_UINT64(compat_start_addr, S390IPLState),
86 VMSTATE_UINT64(compat_bios_start_addr, S390IPLState),
87 VMSTATE_STRUCT(iplb, S390IPLState, 0, vmstate_iplb, IplParameterBlock),
88 VMSTATE_BOOL(iplb_valid, S390IPLState),
89 VMSTATE_UINT8(cssid, S390IPLState),
90 VMSTATE_UINT8(ssid, S390IPLState),
91 VMSTATE_UINT16(devno, S390IPLState),
96 static S390IPLState *get_ipl_device(void)
98 return S390_IPL(object_resolve_path_type("", TYPE_S390_IPL, NULL));
101 static uint64_t bios_translate_addr(void *opaque, uint64_t srcaddr)
103 uint64_t dstaddr = *(uint64_t *) opaque;
105 * Assuming that our s390-ccw.img was linked for starting at address 0,
106 * we can simply add the destination address for the final location
108 return srcaddr + dstaddr;
111 static void s390_ipl_realize(DeviceState *dev, Error **errp)
113 S390IPLState *ipl = S390_IPL(dev);
124 * Always load the bios if it was enforced,
125 * even if an external kernel has been defined.
127 if (!ipl->kernel || ipl->enforce_bios) {
128 uint64_t fwbase = (MIN(ram_size, 0x80000000U) - 0x200000) & ~0xffffUL;
130 if (bios_name == NULL) {
131 bios_name = ipl->firmware;
134 bios_filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, bios_name);
135 if (bios_filename == NULL) {
136 error_setg(&err, "could not find stage1 bootloader");
140 bios_size = load_elf(bios_filename, NULL,
141 bios_translate_addr, &fwbase,
142 &ipl->bios_start_addr, NULL, NULL, 1,
145 /* Adjust ELF start address to final location */
146 ipl->bios_start_addr += fwbase;
148 /* Try to load non-ELF file */
149 bios_size = load_image_targphys(bios_filename, ZIPL_IMAGE_START,
151 ipl->bios_start_addr = ZIPL_IMAGE_START;
153 g_free(bios_filename);
155 if (bios_size == -1) {
156 error_setg(&err, "could not load bootloader '%s'", bios_name);
160 /* default boot target is the bios */
161 ipl->start_addr = ipl->bios_start_addr;
165 kernel_size = load_elf(ipl->kernel, NULL, NULL, NULL,
167 NULL, 1, EM_S390, 0, 0);
168 if (kernel_size < 0) {
169 kernel_size = load_image_targphys(ipl->kernel, 0, ram_size);
170 if (kernel_size < 0) {
171 error_setg(&err, "could not load kernel '%s'", ipl->kernel);
174 /* if this is Linux use KERN_IMAGE_START */
175 magic = rom_ptr(LINUX_MAGIC_ADDR, 6);
176 if (magic && !memcmp(magic, "S390EP", 6)) {
177 pentry = KERN_IMAGE_START;
179 /* if not Linux load the address of the (short) IPL PSW */
180 ipl_psw = rom_ptr(4, 4);
182 pentry = be32_to_cpu(*ipl_psw) & 0x7fffffffUL;
184 error_setg(&err, "Could not get IPL PSW");
190 * Is it a Linux kernel (starting at 0x10000)? If yes, we fill in the
191 * kernel parameters here as well. Note: For old kernels (up to 3.2)
192 * we can not rely on the ELF entry point - it was 0x800 (the SALIPL
193 * loader) and it won't work. For this case we force it to 0x10000, too.
195 if (pentry == KERN_IMAGE_START || pentry == 0x800) {
196 char *parm_area = rom_ptr(KERN_PARM_AREA, strlen(ipl->cmdline) + 1);
197 ipl->start_addr = KERN_IMAGE_START;
198 /* Overwrite parameters in the kernel image, which are "rom" */
200 strcpy(parm_area, ipl->cmdline);
203 ipl->start_addr = pentry;
207 ram_addr_t initrd_offset;
211 initrd_offset = INITRD_START;
212 while (kernel_size + 0x100000 > initrd_offset) {
213 initrd_offset += 0x100000;
215 initrd_size = load_image_targphys(ipl->initrd, initrd_offset,
216 ram_size - initrd_offset);
217 if (initrd_size == -1) {
218 error_setg(&err, "could not load initrd '%s'", ipl->initrd);
223 * we have to overwrite values in the kernel image,
226 romptr = rom_ptr(INITRD_PARM_START, 16);
228 stq_p(romptr, initrd_offset);
229 stq_p(romptr + 1, initrd_size);
234 * Don't ever use the migrated values, they could come from a different
235 * BIOS and therefore don't work. But still migrate the values, so
236 * QEMUs relying on it don't break.
238 ipl->compat_start_addr = ipl->start_addr;
239 ipl->compat_bios_start_addr = ipl->bios_start_addr;
240 qemu_register_reset(qdev_reset_all_fn, dev);
242 error_propagate(errp, err);
245 static Property s390_ipl_properties[] = {
246 DEFINE_PROP_STRING("kernel", S390IPLState, kernel),
247 DEFINE_PROP_STRING("initrd", S390IPLState, initrd),
248 DEFINE_PROP_STRING("cmdline", S390IPLState, cmdline),
249 DEFINE_PROP_STRING("firmware", S390IPLState, firmware),
250 DEFINE_PROP_STRING("netboot_fw", S390IPLState, netboot_fw),
251 DEFINE_PROP_BOOL("enforce_bios", S390IPLState, enforce_bios, false),
252 DEFINE_PROP_BOOL("iplbext_migration", S390IPLState, iplbext_migration,
254 DEFINE_PROP_END_OF_LIST(),
257 static void s390_ipl_set_boot_menu(S390IPLState *ipl)
259 QemuOptsList *plist = qemu_find_opts("boot-opts");
260 QemuOpts *opts = QTAILQ_FIRST(&plist->head);
262 unsigned long splash_time = 0;
264 if (!get_boot_device(0)) {
266 error_report("boot menu requires a bootindex to be specified for "
272 switch (ipl->iplb.pbt) {
273 case S390_IPL_TYPE_CCW:
274 /* In the absence of -boot menu, use zipl parameters */
275 if (!qemu_opt_get(opts, "menu")) {
276 ipl->qipl.qipl_flags |= QIPL_FLAG_BM_OPTS_ZIPL;
280 case S390_IPL_TYPE_QEMU_SCSI:
284 error_report("boot menu is not supported for this device type");
293 ipl->qipl.qipl_flags |= QIPL_FLAG_BM_OPTS_CMD;
295 tmp = qemu_opt_get(opts, "splash-time");
297 if (tmp && qemu_strtoul(tmp, NULL, 10, &splash_time)) {
298 error_report("splash-time is invalid, forcing it to 0");
299 ipl->qipl.boot_menu_timeout = 0;
303 if (splash_time > 0xffffffff) {
304 error_report("splash-time is too large, forcing it to max value");
305 ipl->qipl.boot_menu_timeout = 0xffffffff;
309 ipl->qipl.boot_menu_timeout = cpu_to_be32(splash_time);
312 #define CCW_DEVTYPE_NONE 0x00
313 #define CCW_DEVTYPE_VIRTIO 0x01
314 #define CCW_DEVTYPE_VIRTIO_NET 0x02
315 #define CCW_DEVTYPE_SCSI 0x03
316 #define CCW_DEVTYPE_VFIO 0x04
318 static CcwDevice *s390_get_ccw_device(DeviceState *dev_st, int *devtype)
320 CcwDevice *ccw_dev = NULL;
321 int tmp_dt = CCW_DEVTYPE_NONE;
324 VirtIONet *virtio_net_dev = (VirtIONet *)
325 object_dynamic_cast(OBJECT(dev_st), TYPE_VIRTIO_NET);
326 VirtioCcwDevice *virtio_ccw_dev = (VirtioCcwDevice *)
327 object_dynamic_cast(OBJECT(qdev_get_parent_bus(dev_st)->parent),
328 TYPE_VIRTIO_CCW_DEVICE);
329 VFIOCCWDevice *vfio_ccw_dev = (VFIOCCWDevice *)
330 object_dynamic_cast(OBJECT(dev_st), TYPE_VFIO_CCW);
332 if (virtio_ccw_dev) {
333 ccw_dev = CCW_DEVICE(virtio_ccw_dev);
334 if (virtio_net_dev) {
335 tmp_dt = CCW_DEVTYPE_VIRTIO_NET;
337 tmp_dt = CCW_DEVTYPE_VIRTIO;
339 } else if (vfio_ccw_dev) {
340 ccw_dev = CCW_DEVICE(vfio_ccw_dev);
341 tmp_dt = CCW_DEVTYPE_VFIO;
343 SCSIDevice *sd = (SCSIDevice *)
344 object_dynamic_cast(OBJECT(dev_st),
347 SCSIBus *bus = scsi_bus_from_device(sd);
348 VirtIOSCSI *vdev = container_of(bus, VirtIOSCSI, bus);
349 VirtIOSCSICcw *scsi_ccw = container_of(vdev, VirtIOSCSICcw,
352 ccw_dev = (CcwDevice *)object_dynamic_cast(OBJECT(scsi_ccw),
354 tmp_dt = CCW_DEVTYPE_SCSI;
364 static bool s390_gen_initial_iplb(S390IPLState *ipl)
367 CcwDevice *ccw_dev = NULL;
371 dev_st = get_boot_device(0);
373 ccw_dev = s390_get_ccw_device(dev_st, &devtype);
377 * Currently allow IPL only from CCW devices.
381 case CCW_DEVTYPE_SCSI:
382 sd = SCSI_DEVICE(dev_st);
383 ipl->iplb.len = cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN);
385 cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN - S390_IPLB_HEADER_LEN);
386 ipl->iplb.pbt = S390_IPL_TYPE_QEMU_SCSI;
387 ipl->iplb.scsi.lun = cpu_to_be32(sd->lun);
388 ipl->iplb.scsi.target = cpu_to_be16(sd->id);
389 ipl->iplb.scsi.channel = cpu_to_be16(sd->channel);
390 ipl->iplb.scsi.devno = cpu_to_be16(ccw_dev->sch->devno);
391 ipl->iplb.scsi.ssid = ccw_dev->sch->ssid & 3;
393 case CCW_DEVTYPE_VFIO:
394 ipl->iplb.len = cpu_to_be32(S390_IPLB_MIN_CCW_LEN);
395 ipl->iplb.pbt = S390_IPL_TYPE_CCW;
396 ipl->iplb.ccw.devno = cpu_to_be16(ccw_dev->sch->devno);
397 ipl->iplb.ccw.ssid = ccw_dev->sch->ssid & 3;
399 case CCW_DEVTYPE_VIRTIO_NET:
401 /* Fall through to CCW_DEVTYPE_VIRTIO case */
402 case CCW_DEVTYPE_VIRTIO:
403 ipl->iplb.len = cpu_to_be32(S390_IPLB_MIN_CCW_LEN);
405 cpu_to_be32(S390_IPLB_MIN_CCW_LEN - S390_IPLB_HEADER_LEN);
406 ipl->iplb.pbt = S390_IPL_TYPE_CCW;
407 ipl->iplb.ccw.devno = cpu_to_be16(ccw_dev->sch->devno);
408 ipl->iplb.ccw.ssid = ccw_dev->sch->ssid & 3;
412 if (!s390_ipl_set_loadparm(ipl->iplb.loadparm)) {
413 ipl->iplb.flags |= DIAG308_FLAGS_LP_VALID;
422 int s390_ipl_set_loadparm(uint8_t *loadparm)
424 MachineState *machine = MACHINE(qdev_get_machine());
425 char *lp = object_property_get_str(OBJECT(machine), "loadparm", NULL);
430 /* lp is an uppercase string without leading/embedded spaces */
431 for (i = 0; i < 8 && lp[i]; i++) {
432 loadparm[i] = ascii2ebcdic[(uint8_t) lp[i]];
436 memset(loadparm + i, 0x40, 8 - i); /* fill with EBCDIC spaces */
446 static int load_netboot_image(Error **errp)
448 S390IPLState *ipl = get_ipl_device();
449 char *netboot_filename;
450 MemoryRegion *sysmem = get_system_memory();
451 MemoryRegion *mr = NULL;
452 void *ram_ptr = NULL;
455 mr = memory_region_find(sysmem, 0, 1).mr;
457 error_setg(errp, "Failed to find memory region at address 0");
461 ram_ptr = memory_region_get_ram_ptr(mr);
463 error_setg(errp, "No RAM found");
467 netboot_filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, ipl->netboot_fw);
468 if (netboot_filename == NULL) {
469 error_setg(errp, "Could not find network bootloader '%s'",
474 img_size = load_elf_ram(netboot_filename, NULL, NULL, NULL,
476 NULL, NULL, 1, EM_S390, 0, 0, NULL, false);
479 img_size = load_image_size(netboot_filename, ram_ptr, ram_size);
480 ipl->start_addr = KERN_IMAGE_START;
484 error_setg(errp, "Failed to load network bootloader");
487 g_free(netboot_filename);
490 memory_region_unref(mr);
494 static bool is_virtio_ccw_device_of_type(IplParameterBlock *iplb,
501 SubchDev *sch = NULL;
503 if (iplb->pbt != S390_IPL_TYPE_CCW) {
507 devno = be16_to_cpu(iplb->ccw.devno);
508 ssid = iplb->ccw.ssid & 3;
510 for (schid = 0; schid < MAX_SCHID; schid++) {
511 for (cssid = 0; cssid < MAX_CSSID; cssid++) {
512 sch = css_find_subch(1, cssid, ssid, schid);
514 if (sch && sch->devno == devno) {
515 return sch->id.cu_model == virtio_id;
522 static bool is_virtio_net_device(IplParameterBlock *iplb)
524 return is_virtio_ccw_device_of_type(iplb, VIRTIO_ID_NET);
527 static bool is_virtio_scsi_device(IplParameterBlock *iplb)
529 return is_virtio_ccw_device_of_type(iplb, VIRTIO_ID_SCSI);
532 void s390_ipl_update_diag308(IplParameterBlock *iplb)
534 S390IPLState *ipl = get_ipl_device();
537 ipl->iplb_valid = true;
538 ipl->netboot = is_virtio_net_device(iplb);
541 IplParameterBlock *s390_ipl_get_iplb(void)
543 S390IPLState *ipl = get_ipl_device();
545 if (!ipl->iplb_valid) {
551 void s390_ipl_reset_request(CPUState *cs, enum s390_reset reset_type)
553 S390IPLState *ipl = get_ipl_device();
555 if (reset_type == S390_RESET_EXTERNAL || reset_type == S390_RESET_REIPL) {
556 /* use CPU 0 for full resets */
557 ipl->reset_cpu_index = 0;
559 ipl->reset_cpu_index = cs->cpu_index;
561 ipl->reset_type = reset_type;
563 if (reset_type == S390_RESET_REIPL &&
566 ipl->iplb.pbt == S390_IPL_TYPE_CCW &&
567 is_virtio_scsi_device(&ipl->iplb)) {
568 CcwDevice *ccw_dev = s390_get_ccw_device(get_boot_device(0), NULL);
571 cpu_to_be16(ccw_dev->sch->devno) == ipl->iplb.ccw.devno &&
572 (ccw_dev->sch->ssid & 3) == ipl->iplb.ccw.ssid) {
574 * this is the original boot device's SCSI
575 * so restore IPL parameter info from it
577 ipl->iplb_valid = s390_gen_initial_iplb(ipl);
580 if (reset_type == S390_RESET_MODIFIED_CLEAR ||
581 reset_type == S390_RESET_LOAD_NORMAL) {
582 /* ignore -no-reboot, send no event */
583 qemu_system_reset_request(SHUTDOWN_CAUSE_SUBSYSTEM_RESET);
585 qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET);
587 /* as this is triggered by a CPU, make sure to exit the loop */
593 void s390_ipl_get_reset_request(CPUState **cs, enum s390_reset *reset_type)
595 S390IPLState *ipl = get_ipl_device();
597 *cs = qemu_get_cpu(ipl->reset_cpu_index);
602 *reset_type = ipl->reset_type;
605 void s390_ipl_clear_reset_request(void)
607 S390IPLState *ipl = get_ipl_device();
609 ipl->reset_type = S390_RESET_EXTERNAL;
610 /* use CPU 0 for full resets */
611 ipl->reset_cpu_index = 0;
614 static void s390_ipl_prepare_qipl(S390CPU *cpu)
616 S390IPLState *ipl = get_ipl_device();
620 addr = cpu_physical_memory_map(cpu->env.psa, &len, 1);
621 if (!addr || len < QIPL_ADDRESS + sizeof(QemuIplParameters)) {
622 error_report("Cannot set QEMU IPL parameters");
625 memcpy(addr + QIPL_ADDRESS, &ipl->qipl, sizeof(QemuIplParameters));
626 cpu_physical_memory_unmap(addr, len, 1, len);
629 void s390_ipl_prepare_cpu(S390CPU *cpu)
631 S390IPLState *ipl = get_ipl_device();
634 cpu->env.psw.addr = ipl->start_addr;
635 cpu->env.psw.mask = IPL_PSW_MASK;
637 if (!ipl->kernel || ipl->iplb_valid) {
638 cpu->env.psw.addr = ipl->bios_start_addr;
639 if (!ipl->iplb_valid) {
640 ipl->iplb_valid = s390_gen_initial_iplb(ipl);
644 if (load_netboot_image(&err) < 0) {
645 error_report_err(err);
648 ipl->qipl.netboot_start_addr = cpu_to_be64(ipl->start_addr);
650 s390_ipl_set_boot_menu(ipl);
651 s390_ipl_prepare_qipl(cpu);
654 static void s390_ipl_reset(DeviceState *dev)
656 S390IPLState *ipl = S390_IPL(dev);
658 if (ipl->reset_type != S390_RESET_REIPL) {
659 ipl->iplb_valid = false;
660 memset(&ipl->iplb, 0, sizeof(IplParameterBlock));
664 static void s390_ipl_class_init(ObjectClass *klass, void *data)
666 DeviceClass *dc = DEVICE_CLASS(klass);
668 dc->realize = s390_ipl_realize;
669 dc->props = s390_ipl_properties;
670 dc->reset = s390_ipl_reset;
671 dc->vmsd = &vmstate_ipl;
672 set_bit(DEVICE_CATEGORY_MISC, dc->categories);
673 /* Reason: Loads the ROMs and thus can only be used one time - internally */
674 dc->user_creatable = false;
677 static const TypeInfo s390_ipl_info = {
678 .class_init = s390_ipl_class_init,
679 .parent = TYPE_DEVICE,
680 .name = TYPE_S390_IPL,
681 .instance_size = sizeof(S390IPLState),
684 static void s390_ipl_register_types(void)
686 type_register_static(&s390_ipl_info);
689 type_init(s390_ipl_register_types)