4 * Copyright IBM, Corp. 2012
7 * Christian Borntraeger <borntraeger@de.ibm.com>
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
, 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
, 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
;
241 * Because this Device is not on any bus in the qbus tree (it is
242 * not a sysbus device and it's not on some other bus like a PCI
243 * bus) it will not be automatically reset by the 'reset the
244 * sysbus' hook registered by vl.c like most devices. So we must
245 * manually register a reset hook for it.
246 * TODO: there should be a better way to do this.
248 qemu_register_reset(resettable_cold_reset_fn
, dev
);
250 error_propagate(errp
, err
);
253 static Property s390_ipl_properties
[] = {
254 DEFINE_PROP_STRING("kernel", S390IPLState
, kernel
),
255 DEFINE_PROP_STRING("initrd", S390IPLState
, initrd
),
256 DEFINE_PROP_STRING("cmdline", S390IPLState
, cmdline
),
257 DEFINE_PROP_STRING("firmware", S390IPLState
, firmware
),
258 DEFINE_PROP_STRING("netboot_fw", S390IPLState
, netboot_fw
),
259 DEFINE_PROP_BOOL("enforce_bios", S390IPLState
, enforce_bios
, false),
260 DEFINE_PROP_BOOL("iplbext_migration", S390IPLState
, iplbext_migration
,
262 DEFINE_PROP_END_OF_LIST(),
265 static void s390_ipl_set_boot_menu(S390IPLState
*ipl
)
267 QemuOptsList
*plist
= qemu_find_opts("boot-opts");
268 QemuOpts
*opts
= QTAILQ_FIRST(&plist
->head
);
270 unsigned long splash_time
= 0;
272 if (!get_boot_device(0)) {
274 error_report("boot menu requires a bootindex to be specified for "
280 switch (ipl
->iplb
.pbt
) {
281 case S390_IPL_TYPE_CCW
:
282 /* In the absence of -boot menu, use zipl parameters */
283 if (!qemu_opt_get(opts
, "menu")) {
284 ipl
->qipl
.qipl_flags
|= QIPL_FLAG_BM_OPTS_ZIPL
;
288 case S390_IPL_TYPE_QEMU_SCSI
:
292 error_report("boot menu is not supported for this device type");
301 ipl
->qipl
.qipl_flags
|= QIPL_FLAG_BM_OPTS_CMD
;
303 tmp
= qemu_opt_get(opts
, "splash-time");
305 if (tmp
&& qemu_strtoul(tmp
, NULL
, 10, &splash_time
)) {
306 error_report("splash-time is invalid, forcing it to 0");
307 ipl
->qipl
.boot_menu_timeout
= 0;
311 if (splash_time
> 0xffffffff) {
312 error_report("splash-time is too large, forcing it to max value");
313 ipl
->qipl
.boot_menu_timeout
= 0xffffffff;
317 ipl
->qipl
.boot_menu_timeout
= cpu_to_be32(splash_time
);
320 #define CCW_DEVTYPE_NONE 0x00
321 #define CCW_DEVTYPE_VIRTIO 0x01
322 #define CCW_DEVTYPE_VIRTIO_NET 0x02
323 #define CCW_DEVTYPE_SCSI 0x03
324 #define CCW_DEVTYPE_VFIO 0x04
326 static CcwDevice
*s390_get_ccw_device(DeviceState
*dev_st
, int *devtype
)
328 CcwDevice
*ccw_dev
= NULL
;
329 int tmp_dt
= CCW_DEVTYPE_NONE
;
332 VirtIONet
*virtio_net_dev
= (VirtIONet
*)
333 object_dynamic_cast(OBJECT(dev_st
), TYPE_VIRTIO_NET
);
334 VirtioCcwDevice
*virtio_ccw_dev
= (VirtioCcwDevice
*)
335 object_dynamic_cast(OBJECT(qdev_get_parent_bus(dev_st
)->parent
),
336 TYPE_VIRTIO_CCW_DEVICE
);
337 VFIOCCWDevice
*vfio_ccw_dev
= (VFIOCCWDevice
*)
338 object_dynamic_cast(OBJECT(dev_st
), TYPE_VFIO_CCW
);
340 if (virtio_ccw_dev
) {
341 ccw_dev
= CCW_DEVICE(virtio_ccw_dev
);
342 if (virtio_net_dev
) {
343 tmp_dt
= CCW_DEVTYPE_VIRTIO_NET
;
345 tmp_dt
= CCW_DEVTYPE_VIRTIO
;
347 } else if (vfio_ccw_dev
) {
348 ccw_dev
= CCW_DEVICE(vfio_ccw_dev
);
349 tmp_dt
= CCW_DEVTYPE_VFIO
;
351 SCSIDevice
*sd
= (SCSIDevice
*)
352 object_dynamic_cast(OBJECT(dev_st
),
355 SCSIBus
*bus
= scsi_bus_from_device(sd
);
356 VirtIOSCSI
*vdev
= container_of(bus
, VirtIOSCSI
, bus
);
357 VirtIOSCSICcw
*scsi_ccw
= container_of(vdev
, VirtIOSCSICcw
,
360 ccw_dev
= (CcwDevice
*)object_dynamic_cast(OBJECT(scsi_ccw
),
362 tmp_dt
= CCW_DEVTYPE_SCSI
;
372 static bool s390_gen_initial_iplb(S390IPLState
*ipl
)
375 CcwDevice
*ccw_dev
= NULL
;
379 dev_st
= get_boot_device(0);
381 ccw_dev
= s390_get_ccw_device(dev_st
, &devtype
);
385 * Currently allow IPL only from CCW devices.
389 case CCW_DEVTYPE_SCSI
:
390 sd
= SCSI_DEVICE(dev_st
);
391 ipl
->iplb
.len
= cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN
);
393 cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN
- S390_IPLB_HEADER_LEN
);
394 ipl
->iplb
.pbt
= S390_IPL_TYPE_QEMU_SCSI
;
395 ipl
->iplb
.scsi
.lun
= cpu_to_be32(sd
->lun
);
396 ipl
->iplb
.scsi
.target
= cpu_to_be16(sd
->id
);
397 ipl
->iplb
.scsi
.channel
= cpu_to_be16(sd
->channel
);
398 ipl
->iplb
.scsi
.devno
= cpu_to_be16(ccw_dev
->sch
->devno
);
399 ipl
->iplb
.scsi
.ssid
= ccw_dev
->sch
->ssid
& 3;
401 case CCW_DEVTYPE_VFIO
:
402 ipl
->iplb
.len
= cpu_to_be32(S390_IPLB_MIN_CCW_LEN
);
403 ipl
->iplb
.pbt
= S390_IPL_TYPE_CCW
;
404 ipl
->iplb
.ccw
.devno
= cpu_to_be16(ccw_dev
->sch
->devno
);
405 ipl
->iplb
.ccw
.ssid
= ccw_dev
->sch
->ssid
& 3;
407 case CCW_DEVTYPE_VIRTIO_NET
:
409 /* Fall through to CCW_DEVTYPE_VIRTIO case */
410 case CCW_DEVTYPE_VIRTIO
:
411 ipl
->iplb
.len
= cpu_to_be32(S390_IPLB_MIN_CCW_LEN
);
413 cpu_to_be32(S390_IPLB_MIN_CCW_LEN
- S390_IPLB_HEADER_LEN
);
414 ipl
->iplb
.pbt
= S390_IPL_TYPE_CCW
;
415 ipl
->iplb
.ccw
.devno
= cpu_to_be16(ccw_dev
->sch
->devno
);
416 ipl
->iplb
.ccw
.ssid
= ccw_dev
->sch
->ssid
& 3;
420 if (!s390_ipl_set_loadparm(ipl
->iplb
.loadparm
)) {
421 ipl
->iplb
.flags
|= DIAG308_FLAGS_LP_VALID
;
430 int s390_ipl_set_loadparm(uint8_t *loadparm
)
432 MachineState
*machine
= MACHINE(qdev_get_machine());
433 char *lp
= object_property_get_str(OBJECT(machine
), "loadparm", NULL
);
438 /* lp is an uppercase string without leading/embedded spaces */
439 for (i
= 0; i
< 8 && lp
[i
]; i
++) {
440 loadparm
[i
] = ascii2ebcdic
[(uint8_t) lp
[i
]];
444 memset(loadparm
+ i
, 0x40, 8 - i
); /* fill with EBCDIC spaces */
454 static int load_netboot_image(Error
**errp
)
456 S390IPLState
*ipl
= get_ipl_device();
457 char *netboot_filename
;
458 MemoryRegion
*sysmem
= get_system_memory();
459 MemoryRegion
*mr
= NULL
;
460 void *ram_ptr
= NULL
;
463 mr
= memory_region_find(sysmem
, 0, 1).mr
;
465 error_setg(errp
, "Failed to find memory region at address 0");
469 ram_ptr
= memory_region_get_ram_ptr(mr
);
471 error_setg(errp
, "No RAM found");
475 netboot_filename
= qemu_find_file(QEMU_FILE_TYPE_BIOS
, ipl
->netboot_fw
);
476 if (netboot_filename
== NULL
) {
477 error_setg(errp
, "Could not find network bootloader '%s'",
482 img_size
= load_elf_ram(netboot_filename
, NULL
, NULL
, NULL
,
484 NULL
, NULL
, NULL
, 1, EM_S390
, 0, 0, NULL
,
488 img_size
= load_image_size(netboot_filename
, ram_ptr
, ram_size
);
489 ipl
->start_addr
= KERN_IMAGE_START
;
493 error_setg(errp
, "Failed to load network bootloader");
496 g_free(netboot_filename
);
499 memory_region_unref(mr
);
503 static bool is_virtio_ccw_device_of_type(IplParameterBlock
*iplb
,
510 SubchDev
*sch
= NULL
;
512 if (iplb
->pbt
!= S390_IPL_TYPE_CCW
) {
516 devno
= be16_to_cpu(iplb
->ccw
.devno
);
517 ssid
= iplb
->ccw
.ssid
& 3;
519 for (schid
= 0; schid
< MAX_SCHID
; schid
++) {
520 for (cssid
= 0; cssid
< MAX_CSSID
; cssid
++) {
521 sch
= css_find_subch(1, cssid
, ssid
, schid
);
523 if (sch
&& sch
->devno
== devno
) {
524 return sch
->id
.cu_model
== virtio_id
;
531 static bool is_virtio_net_device(IplParameterBlock
*iplb
)
533 return is_virtio_ccw_device_of_type(iplb
, VIRTIO_ID_NET
);
536 static bool is_virtio_scsi_device(IplParameterBlock
*iplb
)
538 return is_virtio_ccw_device_of_type(iplb
, VIRTIO_ID_SCSI
);
541 void s390_ipl_update_diag308(IplParameterBlock
*iplb
)
543 S390IPLState
*ipl
= get_ipl_device();
546 ipl
->iplb_valid
= true;
547 ipl
->netboot
= is_virtio_net_device(iplb
);
550 IplParameterBlock
*s390_ipl_get_iplb(void)
552 S390IPLState
*ipl
= get_ipl_device();
554 if (!ipl
->iplb_valid
) {
560 void s390_ipl_reset_request(CPUState
*cs
, enum s390_reset reset_type
)
562 S390IPLState
*ipl
= get_ipl_device();
564 if (reset_type
== S390_RESET_EXTERNAL
|| reset_type
== S390_RESET_REIPL
) {
565 /* use CPU 0 for full resets */
566 ipl
->reset_cpu_index
= 0;
568 ipl
->reset_cpu_index
= cs
->cpu_index
;
570 ipl
->reset_type
= reset_type
;
572 if (reset_type
== S390_RESET_REIPL
&&
575 ipl
->iplb
.pbt
== S390_IPL_TYPE_CCW
&&
576 is_virtio_scsi_device(&ipl
->iplb
)) {
577 CcwDevice
*ccw_dev
= s390_get_ccw_device(get_boot_device(0), NULL
);
580 cpu_to_be16(ccw_dev
->sch
->devno
) == ipl
->iplb
.ccw
.devno
&&
581 (ccw_dev
->sch
->ssid
& 3) == ipl
->iplb
.ccw
.ssid
) {
583 * this is the original boot device's SCSI
584 * so restore IPL parameter info from it
586 ipl
->iplb_valid
= s390_gen_initial_iplb(ipl
);
589 if (reset_type
== S390_RESET_MODIFIED_CLEAR
||
590 reset_type
== S390_RESET_LOAD_NORMAL
) {
591 /* ignore -no-reboot, send no event */
592 qemu_system_reset_request(SHUTDOWN_CAUSE_SUBSYSTEM_RESET
);
594 qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET
);
596 /* as this is triggered by a CPU, make sure to exit the loop */
602 void s390_ipl_get_reset_request(CPUState
**cs
, enum s390_reset
*reset_type
)
604 S390IPLState
*ipl
= get_ipl_device();
606 *cs
= qemu_get_cpu(ipl
->reset_cpu_index
);
611 *reset_type
= ipl
->reset_type
;
614 void s390_ipl_clear_reset_request(void)
616 S390IPLState
*ipl
= get_ipl_device();
618 ipl
->reset_type
= S390_RESET_EXTERNAL
;
619 /* use CPU 0 for full resets */
620 ipl
->reset_cpu_index
= 0;
623 static void s390_ipl_prepare_qipl(S390CPU
*cpu
)
625 S390IPLState
*ipl
= get_ipl_device();
629 addr
= cpu_physical_memory_map(cpu
->env
.psa
, &len
, true);
630 if (!addr
|| len
< QIPL_ADDRESS
+ sizeof(QemuIplParameters
)) {
631 error_report("Cannot set QEMU IPL parameters");
634 memcpy(addr
+ QIPL_ADDRESS
, &ipl
->qipl
, sizeof(QemuIplParameters
));
635 cpu_physical_memory_unmap(addr
, len
, 1, len
);
638 void s390_ipl_prepare_cpu(S390CPU
*cpu
)
640 S390IPLState
*ipl
= get_ipl_device();
643 cpu
->env
.psw
.addr
= ipl
->start_addr
;
644 cpu
->env
.psw
.mask
= IPL_PSW_MASK
;
646 if (!ipl
->kernel
|| ipl
->iplb_valid
) {
647 cpu
->env
.psw
.addr
= ipl
->bios_start_addr
;
648 if (!ipl
->iplb_valid
) {
649 ipl
->iplb_valid
= s390_gen_initial_iplb(ipl
);
653 if (load_netboot_image(&err
) < 0) {
654 error_report_err(err
);
657 ipl
->qipl
.netboot_start_addr
= cpu_to_be64(ipl
->start_addr
);
659 s390_ipl_set_boot_menu(ipl
);
660 s390_ipl_prepare_qipl(cpu
);
663 static void s390_ipl_reset(DeviceState
*dev
)
665 S390IPLState
*ipl
= S390_IPL(dev
);
667 if (ipl
->reset_type
!= S390_RESET_REIPL
) {
668 ipl
->iplb_valid
= false;
669 memset(&ipl
->iplb
, 0, sizeof(IplParameterBlock
));
673 static void s390_ipl_class_init(ObjectClass
*klass
, void *data
)
675 DeviceClass
*dc
= DEVICE_CLASS(klass
);
677 dc
->realize
= s390_ipl_realize
;
678 device_class_set_props(dc
, s390_ipl_properties
);
679 dc
->reset
= s390_ipl_reset
;
680 dc
->vmsd
= &vmstate_ipl
;
681 set_bit(DEVICE_CATEGORY_MISC
, dc
->categories
);
682 /* Reason: Loads the ROMs and thus can only be used one time - internally */
683 dc
->user_creatable
= false;
686 static const TypeInfo s390_ipl_info
= {
687 .class_init
= s390_ipl_class_init
,
688 .parent
= TYPE_DEVICE
,
689 .name
= TYPE_S390_IPL
,
690 .instance_size
= sizeof(S390IPLState
),
693 static void s390_ipl_register_types(void)
695 type_register_static(&s390_ipl_info
);
698 type_init(s390_ipl_register_types
)