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 "qapi/error.h"
16 #include "sysemu/sysemu.h"
19 #include "hw/loader.h"
20 #include "hw/boards.h"
21 #include "hw/s390x/virtio-ccw.h"
22 #include "hw/s390x/vfio-ccw.h"
23 #include "hw/s390x/css.h"
24 #include "hw/s390x/ebcdic.h"
26 #include "qemu/error-report.h"
27 #include "qemu/config-file.h"
28 #include "qemu/cutils.h"
29 #include "qemu/option.h"
30 #include "exec/exec-all.h"
32 #define KERN_IMAGE_START 0x010000UL
33 #define LINUX_MAGIC_ADDR 0x010008UL
34 #define KERN_PARM_AREA 0x010480UL
35 #define INITRD_START 0x800000UL
36 #define INITRD_PARM_START 0x010408UL
37 #define PARMFILE_START 0x001000UL
38 #define ZIPL_IMAGE_START 0x009000UL
39 #define IPL_PSW_MASK (PSW_MASK_32 | PSW_MASK_64)
41 static bool iplb_extended_needed(void *opaque
)
43 S390IPLState
*ipl
= S390_IPL(object_resolve_path(TYPE_S390_IPL
, NULL
));
45 return ipl
->iplbext_migration
;
48 static const VMStateDescription vmstate_iplb_extended
= {
49 .name
= "ipl/iplb_extended",
51 .minimum_version_id
= 0,
52 .needed
= iplb_extended_needed
,
53 .fields
= (VMStateField
[]) {
54 VMSTATE_UINT8_ARRAY(reserved_ext
, IplParameterBlock
, 4096 - 200),
59 static const VMStateDescription vmstate_iplb
= {
62 .minimum_version_id
= 0,
63 .fields
= (VMStateField
[]) {
64 VMSTATE_UINT8_ARRAY(reserved1
, IplParameterBlock
, 110),
65 VMSTATE_UINT16(devno
, IplParameterBlock
),
66 VMSTATE_UINT8_ARRAY(reserved2
, IplParameterBlock
, 88),
69 .subsections
= (const VMStateDescription
*[]) {
70 &vmstate_iplb_extended
,
75 static const VMStateDescription vmstate_ipl
= {
78 .minimum_version_id
= 0,
79 .fields
= (VMStateField
[]) {
80 VMSTATE_UINT64(compat_start_addr
, S390IPLState
),
81 VMSTATE_UINT64(compat_bios_start_addr
, S390IPLState
),
82 VMSTATE_STRUCT(iplb
, S390IPLState
, 0, vmstate_iplb
, IplParameterBlock
),
83 VMSTATE_BOOL(iplb_valid
, S390IPLState
),
84 VMSTATE_UINT8(cssid
, S390IPLState
),
85 VMSTATE_UINT8(ssid
, S390IPLState
),
86 VMSTATE_UINT16(devno
, S390IPLState
),
91 static S390IPLState
*get_ipl_device(void)
93 return S390_IPL(object_resolve_path_type("", TYPE_S390_IPL
, NULL
));
96 static uint64_t bios_translate_addr(void *opaque
, uint64_t srcaddr
)
98 uint64_t dstaddr
= *(uint64_t *) opaque
;
100 * Assuming that our s390-ccw.img was linked for starting at address 0,
101 * we can simply add the destination address for the final location
103 return srcaddr
+ dstaddr
;
106 static void s390_ipl_realize(DeviceState
*dev
, Error
**errp
)
108 S390IPLState
*ipl
= S390_IPL(dev
);
119 * Always load the bios if it was enforced,
120 * even if an external kernel has been defined.
122 if (!ipl
->kernel
|| ipl
->enforce_bios
) {
123 uint64_t fwbase
= (MIN(ram_size
, 0x80000000U
) - 0x200000) & ~0xffffUL
;
125 if (bios_name
== NULL
) {
126 bios_name
= ipl
->firmware
;
129 bios_filename
= qemu_find_file(QEMU_FILE_TYPE_BIOS
, bios_name
);
130 if (bios_filename
== NULL
) {
131 error_setg(&err
, "could not find stage1 bootloader");
135 bios_size
= load_elf(bios_filename
, NULL
,
136 bios_translate_addr
, &fwbase
,
137 &ipl
->bios_start_addr
, NULL
, NULL
, 1,
140 /* Adjust ELF start address to final location */
141 ipl
->bios_start_addr
+= fwbase
;
143 /* Try to load non-ELF file */
144 bios_size
= load_image_targphys(bios_filename
, ZIPL_IMAGE_START
,
146 ipl
->bios_start_addr
= ZIPL_IMAGE_START
;
148 g_free(bios_filename
);
150 if (bios_size
== -1) {
151 error_setg(&err
, "could not load bootloader '%s'", bios_name
);
155 /* default boot target is the bios */
156 ipl
->start_addr
= ipl
->bios_start_addr
;
160 kernel_size
= load_elf(ipl
->kernel
, NULL
, NULL
, NULL
,
162 NULL
, 1, EM_S390
, 0, 0);
163 if (kernel_size
< 0) {
164 kernel_size
= load_image_targphys(ipl
->kernel
, 0, ram_size
);
165 if (kernel_size
< 0) {
166 error_setg(&err
, "could not load kernel '%s'", ipl
->kernel
);
169 /* if this is Linux use KERN_IMAGE_START */
170 magic
= rom_ptr(LINUX_MAGIC_ADDR
, 6);
171 if (magic
&& !memcmp(magic
, "S390EP", 6)) {
172 pentry
= KERN_IMAGE_START
;
174 /* if not Linux load the address of the (short) IPL PSW */
175 ipl_psw
= rom_ptr(4, 4);
177 pentry
= be32_to_cpu(*ipl_psw
) & 0x7fffffffUL
;
179 error_setg(&err
, "Could not get IPL PSW");
185 * Is it a Linux kernel (starting at 0x10000)? If yes, we fill in the
186 * kernel parameters here as well. Note: For old kernels (up to 3.2)
187 * we can not rely on the ELF entry point - it was 0x800 (the SALIPL
188 * loader) and it won't work. For this case we force it to 0x10000, too.
190 if (pentry
== KERN_IMAGE_START
|| pentry
== 0x800) {
191 char *parm_area
= rom_ptr(KERN_PARM_AREA
, strlen(ipl
->cmdline
) + 1);
192 ipl
->start_addr
= KERN_IMAGE_START
;
193 /* Overwrite parameters in the kernel image, which are "rom" */
195 strcpy(parm_area
, ipl
->cmdline
);
198 ipl
->start_addr
= pentry
;
202 ram_addr_t initrd_offset
;
206 initrd_offset
= INITRD_START
;
207 while (kernel_size
+ 0x100000 > initrd_offset
) {
208 initrd_offset
+= 0x100000;
210 initrd_size
= load_image_targphys(ipl
->initrd
, initrd_offset
,
211 ram_size
- initrd_offset
);
212 if (initrd_size
== -1) {
213 error_setg(&err
, "could not load initrd '%s'", ipl
->initrd
);
218 * we have to overwrite values in the kernel image,
221 romptr
= rom_ptr(INITRD_PARM_START
, 16);
223 stq_p(romptr
, initrd_offset
);
224 stq_p(romptr
+ 1, initrd_size
);
229 * Don't ever use the migrated values, they could come from a different
230 * BIOS and therefore don't work. But still migrate the values, so
231 * QEMUs relying on it don't break.
233 ipl
->compat_start_addr
= ipl
->start_addr
;
234 ipl
->compat_bios_start_addr
= ipl
->bios_start_addr
;
235 qemu_register_reset(qdev_reset_all_fn
, dev
);
237 error_propagate(errp
, err
);
240 static Property s390_ipl_properties
[] = {
241 DEFINE_PROP_STRING("kernel", S390IPLState
, kernel
),
242 DEFINE_PROP_STRING("initrd", S390IPLState
, initrd
),
243 DEFINE_PROP_STRING("cmdline", S390IPLState
, cmdline
),
244 DEFINE_PROP_STRING("firmware", S390IPLState
, firmware
),
245 DEFINE_PROP_STRING("netboot_fw", S390IPLState
, netboot_fw
),
246 DEFINE_PROP_BOOL("enforce_bios", S390IPLState
, enforce_bios
, false),
247 DEFINE_PROP_BOOL("iplbext_migration", S390IPLState
, iplbext_migration
,
249 DEFINE_PROP_END_OF_LIST(),
252 static void s390_ipl_set_boot_menu(S390IPLState
*ipl
)
254 QemuOptsList
*plist
= qemu_find_opts("boot-opts");
255 QemuOpts
*opts
= QTAILQ_FIRST(&plist
->head
);
257 unsigned long splash_time
= 0;
259 if (!get_boot_device(0)) {
261 error_report("boot menu requires a bootindex to be specified for "
267 switch (ipl
->iplb
.pbt
) {
268 case S390_IPL_TYPE_CCW
:
269 /* In the absence of -boot menu, use zipl parameters */
270 if (!qemu_opt_get(opts
, "menu")) {
271 ipl
->qipl
.qipl_flags
|= QIPL_FLAG_BM_OPTS_ZIPL
;
275 case S390_IPL_TYPE_QEMU_SCSI
:
279 error_report("boot menu is not supported for this device type");
288 ipl
->qipl
.qipl_flags
|= QIPL_FLAG_BM_OPTS_CMD
;
290 tmp
= qemu_opt_get(opts
, "splash-time");
292 if (tmp
&& qemu_strtoul(tmp
, NULL
, 10, &splash_time
)) {
293 error_report("splash-time is invalid, forcing it to 0");
294 ipl
->qipl
.boot_menu_timeout
= 0;
298 if (splash_time
> 0xffffffff) {
299 error_report("splash-time is too large, forcing it to max value");
300 ipl
->qipl
.boot_menu_timeout
= 0xffffffff;
304 ipl
->qipl
.boot_menu_timeout
= cpu_to_be32(splash_time
);
307 #define CCW_DEVTYPE_NONE 0x00
308 #define CCW_DEVTYPE_VIRTIO 0x01
309 #define CCW_DEVTYPE_VIRTIO_NET 0x02
310 #define CCW_DEVTYPE_SCSI 0x03
311 #define CCW_DEVTYPE_VFIO 0x04
313 static CcwDevice
*s390_get_ccw_device(DeviceState
*dev_st
, int *devtype
)
315 CcwDevice
*ccw_dev
= NULL
;
316 int tmp_dt
= CCW_DEVTYPE_NONE
;
319 VirtIONet
*virtio_net_dev
= (VirtIONet
*)
320 object_dynamic_cast(OBJECT(dev_st
), TYPE_VIRTIO_NET
);
321 VirtioCcwDevice
*virtio_ccw_dev
= (VirtioCcwDevice
*)
322 object_dynamic_cast(OBJECT(qdev_get_parent_bus(dev_st
)->parent
),
323 TYPE_VIRTIO_CCW_DEVICE
);
324 VFIOCCWDevice
*vfio_ccw_dev
= (VFIOCCWDevice
*)
325 object_dynamic_cast(OBJECT(dev_st
), TYPE_VFIO_CCW
);
327 if (virtio_ccw_dev
) {
328 ccw_dev
= CCW_DEVICE(virtio_ccw_dev
);
329 if (virtio_net_dev
) {
330 tmp_dt
= CCW_DEVTYPE_VIRTIO_NET
;
332 tmp_dt
= CCW_DEVTYPE_VIRTIO
;
334 } else if (vfio_ccw_dev
) {
335 ccw_dev
= CCW_DEVICE(vfio_ccw_dev
);
336 tmp_dt
= CCW_DEVTYPE_VFIO
;
338 SCSIDevice
*sd
= (SCSIDevice
*)
339 object_dynamic_cast(OBJECT(dev_st
),
342 SCSIBus
*bus
= scsi_bus_from_device(sd
);
343 VirtIOSCSI
*vdev
= container_of(bus
, VirtIOSCSI
, bus
);
344 VirtIOSCSICcw
*scsi_ccw
= container_of(vdev
, VirtIOSCSICcw
,
347 ccw_dev
= (CcwDevice
*)object_dynamic_cast(OBJECT(scsi_ccw
),
349 tmp_dt
= CCW_DEVTYPE_SCSI
;
359 static bool s390_gen_initial_iplb(S390IPLState
*ipl
)
362 CcwDevice
*ccw_dev
= NULL
;
366 dev_st
= get_boot_device(0);
368 ccw_dev
= s390_get_ccw_device(dev_st
, &devtype
);
372 * Currently allow IPL only from CCW devices.
376 case CCW_DEVTYPE_SCSI
:
377 sd
= (SCSIDevice
*) object_dynamic_cast(OBJECT(dev_st
),
379 ipl
->iplb
.len
= cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN
);
381 cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN
- S390_IPLB_HEADER_LEN
);
382 ipl
->iplb
.pbt
= S390_IPL_TYPE_QEMU_SCSI
;
383 ipl
->iplb
.scsi
.lun
= cpu_to_be32(sd
->lun
);
384 ipl
->iplb
.scsi
.target
= cpu_to_be16(sd
->id
);
385 ipl
->iplb
.scsi
.channel
= cpu_to_be16(sd
->channel
);
386 ipl
->iplb
.scsi
.devno
= cpu_to_be16(ccw_dev
->sch
->devno
);
387 ipl
->iplb
.scsi
.ssid
= ccw_dev
->sch
->ssid
& 3;
389 case CCW_DEVTYPE_VFIO
:
390 ipl
->iplb
.len
= cpu_to_be32(S390_IPLB_MIN_CCW_LEN
);
391 ipl
->iplb
.pbt
= S390_IPL_TYPE_CCW
;
392 ipl
->iplb
.ccw
.devno
= cpu_to_be16(ccw_dev
->sch
->devno
);
393 ipl
->iplb
.ccw
.ssid
= ccw_dev
->sch
->ssid
& 3;
395 case CCW_DEVTYPE_VIRTIO_NET
:
397 /* Fall through to CCW_DEVTYPE_VIRTIO case */
398 case CCW_DEVTYPE_VIRTIO
:
399 ipl
->iplb
.len
= cpu_to_be32(S390_IPLB_MIN_CCW_LEN
);
401 cpu_to_be32(S390_IPLB_MIN_CCW_LEN
- S390_IPLB_HEADER_LEN
);
402 ipl
->iplb
.pbt
= S390_IPL_TYPE_CCW
;
403 ipl
->iplb
.ccw
.devno
= cpu_to_be16(ccw_dev
->sch
->devno
);
404 ipl
->iplb
.ccw
.ssid
= ccw_dev
->sch
->ssid
& 3;
408 if (!s390_ipl_set_loadparm(ipl
->iplb
.loadparm
)) {
409 ipl
->iplb
.flags
|= DIAG308_FLAGS_LP_VALID
;
418 int s390_ipl_set_loadparm(uint8_t *loadparm
)
420 MachineState
*machine
= MACHINE(qdev_get_machine());
421 char *lp
= object_property_get_str(OBJECT(machine
), "loadparm", NULL
);
426 /* lp is an uppercase string without leading/embedded spaces */
427 for (i
= 0; i
< 8 && lp
[i
]; i
++) {
428 loadparm
[i
] = ascii2ebcdic
[(uint8_t) lp
[i
]];
432 memset(loadparm
+ i
, 0x40, 8 - i
); /* fill with EBCDIC spaces */
442 static int load_netboot_image(Error
**errp
)
444 S390IPLState
*ipl
= get_ipl_device();
445 char *netboot_filename
;
446 MemoryRegion
*sysmem
= get_system_memory();
447 MemoryRegion
*mr
= NULL
;
448 void *ram_ptr
= NULL
;
451 mr
= memory_region_find(sysmem
, 0, 1).mr
;
453 error_setg(errp
, "Failed to find memory region at address 0");
457 ram_ptr
= memory_region_get_ram_ptr(mr
);
459 error_setg(errp
, "No RAM found");
463 netboot_filename
= qemu_find_file(QEMU_FILE_TYPE_BIOS
, ipl
->netboot_fw
);
464 if (netboot_filename
== NULL
) {
465 error_setg(errp
, "Could not find network bootloader '%s'",
470 img_size
= load_elf_ram(netboot_filename
, NULL
, NULL
, NULL
,
472 NULL
, NULL
, 1, EM_S390
, 0, 0, NULL
, false);
475 img_size
= load_image_size(netboot_filename
, ram_ptr
, ram_size
);
476 ipl
->start_addr
= KERN_IMAGE_START
;
480 error_setg(errp
, "Failed to load network bootloader");
483 g_free(netboot_filename
);
486 memory_region_unref(mr
);
490 static bool is_virtio_ccw_device_of_type(IplParameterBlock
*iplb
,
497 SubchDev
*sch
= NULL
;
499 if (iplb
->pbt
!= S390_IPL_TYPE_CCW
) {
503 devno
= be16_to_cpu(iplb
->ccw
.devno
);
504 ssid
= iplb
->ccw
.ssid
& 3;
506 for (schid
= 0; schid
< MAX_SCHID
; schid
++) {
507 for (cssid
= 0; cssid
< MAX_CSSID
; cssid
++) {
508 sch
= css_find_subch(1, cssid
, ssid
, schid
);
510 if (sch
&& sch
->devno
== devno
) {
511 return sch
->id
.cu_model
== virtio_id
;
518 static bool is_virtio_net_device(IplParameterBlock
*iplb
)
520 return is_virtio_ccw_device_of_type(iplb
, VIRTIO_ID_NET
);
523 static bool is_virtio_scsi_device(IplParameterBlock
*iplb
)
525 return is_virtio_ccw_device_of_type(iplb
, VIRTIO_ID_SCSI
);
528 void s390_ipl_update_diag308(IplParameterBlock
*iplb
)
530 S390IPLState
*ipl
= get_ipl_device();
533 ipl
->iplb_valid
= true;
534 ipl
->netboot
= is_virtio_net_device(iplb
);
537 IplParameterBlock
*s390_ipl_get_iplb(void)
539 S390IPLState
*ipl
= get_ipl_device();
541 if (!ipl
->iplb_valid
) {
547 void s390_ipl_reset_request(CPUState
*cs
, enum s390_reset reset_type
)
549 S390IPLState
*ipl
= get_ipl_device();
551 if (reset_type
== S390_RESET_EXTERNAL
|| reset_type
== S390_RESET_REIPL
) {
552 /* use CPU 0 for full resets */
553 ipl
->reset_cpu_index
= 0;
555 ipl
->reset_cpu_index
= cs
->cpu_index
;
557 ipl
->reset_type
= reset_type
;
559 if (reset_type
== S390_RESET_REIPL
&&
562 ipl
->iplb
.pbt
== S390_IPL_TYPE_CCW
&&
563 is_virtio_scsi_device(&ipl
->iplb
)) {
564 CcwDevice
*ccw_dev
= s390_get_ccw_device(get_boot_device(0), NULL
);
567 cpu_to_be16(ccw_dev
->sch
->devno
) == ipl
->iplb
.ccw
.devno
&&
568 (ccw_dev
->sch
->ssid
& 3) == ipl
->iplb
.ccw
.ssid
) {
570 * this is the original boot device's SCSI
571 * so restore IPL parameter info from it
573 ipl
->iplb_valid
= s390_gen_initial_iplb(ipl
);
576 if (reset_type
== S390_RESET_MODIFIED_CLEAR
||
577 reset_type
== S390_RESET_LOAD_NORMAL
) {
578 /* ignore -no-reboot, send no event */
579 qemu_system_reset_request(SHUTDOWN_CAUSE_SUBSYSTEM_RESET
);
581 qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET
);
583 /* as this is triggered by a CPU, make sure to exit the loop */
589 void s390_ipl_get_reset_request(CPUState
**cs
, enum s390_reset
*reset_type
)
591 S390IPLState
*ipl
= get_ipl_device();
593 *cs
= qemu_get_cpu(ipl
->reset_cpu_index
);
598 *reset_type
= ipl
->reset_type
;
601 void s390_ipl_clear_reset_request(void)
603 S390IPLState
*ipl
= get_ipl_device();
605 ipl
->reset_type
= S390_RESET_EXTERNAL
;
606 /* use CPU 0 for full resets */
607 ipl
->reset_cpu_index
= 0;
610 static void s390_ipl_prepare_qipl(S390CPU
*cpu
)
612 S390IPLState
*ipl
= get_ipl_device();
616 addr
= cpu_physical_memory_map(cpu
->env
.psa
, &len
, 1);
617 if (!addr
|| len
< QIPL_ADDRESS
+ sizeof(QemuIplParameters
)) {
618 error_report("Cannot set QEMU IPL parameters");
621 memcpy(addr
+ QIPL_ADDRESS
, &ipl
->qipl
, sizeof(QemuIplParameters
));
622 cpu_physical_memory_unmap(addr
, len
, 1, len
);
625 void s390_ipl_prepare_cpu(S390CPU
*cpu
)
627 S390IPLState
*ipl
= get_ipl_device();
630 cpu
->env
.psw
.addr
= ipl
->start_addr
;
631 cpu
->env
.psw
.mask
= IPL_PSW_MASK
;
633 if (!ipl
->kernel
|| ipl
->iplb_valid
) {
634 cpu
->env
.psw
.addr
= ipl
->bios_start_addr
;
635 if (!ipl
->iplb_valid
) {
636 ipl
->iplb_valid
= s390_gen_initial_iplb(ipl
);
640 if (load_netboot_image(&err
) < 0) {
641 error_report_err(err
);
644 ipl
->qipl
.netboot_start_addr
= cpu_to_be64(ipl
->start_addr
);
646 s390_ipl_set_boot_menu(ipl
);
647 s390_ipl_prepare_qipl(cpu
);
650 static void s390_ipl_reset(DeviceState
*dev
)
652 S390IPLState
*ipl
= S390_IPL(dev
);
654 if (ipl
->reset_type
!= S390_RESET_REIPL
) {
655 ipl
->iplb_valid
= false;
656 memset(&ipl
->iplb
, 0, sizeof(IplParameterBlock
));
660 static void s390_ipl_class_init(ObjectClass
*klass
, void *data
)
662 DeviceClass
*dc
= DEVICE_CLASS(klass
);
664 dc
->realize
= s390_ipl_realize
;
665 dc
->props
= s390_ipl_properties
;
666 dc
->reset
= s390_ipl_reset
;
667 dc
->vmsd
= &vmstate_ipl
;
668 set_bit(DEVICE_CATEGORY_MISC
, dc
->categories
);
669 /* Reason: Loads the ROMs and thus can only be used one time - internally */
670 dc
->user_creatable
= false;
673 static const TypeInfo s390_ipl_info
= {
674 .class_init
= s390_ipl_class_init
,
675 .parent
= TYPE_DEVICE
,
676 .name
= TYPE_S390_IPL
,
677 .instance_size
= sizeof(S390IPLState
),
680 static void s390_ipl_register_types(void)
682 type_register_static(&s390_ipl_info
);
685 type_init(s390_ipl_register_types
)