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/sysemu.h"
18 #include "sysemu/tcg.h"
21 #include "hw/loader.h"
22 #include "hw/boards.h"
23 #include "hw/s390x/virtio-ccw.h"
24 #include "hw/s390x/vfio-ccw.h"
25 #include "hw/s390x/css.h"
26 #include "hw/s390x/ebcdic.h"
28 #include "qemu/error-report.h"
29 #include "qemu/config-file.h"
30 #include "qemu/cutils.h"
31 #include "qemu/option.h"
32 #include "exec/exec-all.h"
34 #define KERN_IMAGE_START 0x010000UL
35 #define LINUX_MAGIC_ADDR 0x010008UL
36 #define KERN_PARM_AREA 0x010480UL
37 #define INITRD_START 0x800000UL
38 #define INITRD_PARM_START 0x010408UL
39 #define PARMFILE_START 0x001000UL
40 #define ZIPL_IMAGE_START 0x009000UL
41 #define IPL_PSW_MASK (PSW_MASK_32 | PSW_MASK_64)
43 static bool iplb_extended_needed(void *opaque
)
45 S390IPLState
*ipl
= S390_IPL(object_resolve_path(TYPE_S390_IPL
, NULL
));
47 return ipl
->iplbext_migration
;
50 static const VMStateDescription vmstate_iplb_extended
= {
51 .name
= "ipl/iplb_extended",
53 .minimum_version_id
= 0,
54 .needed
= iplb_extended_needed
,
55 .fields
= (VMStateField
[]) {
56 VMSTATE_UINT8_ARRAY(reserved_ext
, IplParameterBlock
, 4096 - 200),
61 static const VMStateDescription vmstate_iplb
= {
64 .minimum_version_id
= 0,
65 .fields
= (VMStateField
[]) {
66 VMSTATE_UINT8_ARRAY(reserved1
, IplParameterBlock
, 110),
67 VMSTATE_UINT16(devno
, IplParameterBlock
),
68 VMSTATE_UINT8_ARRAY(reserved2
, IplParameterBlock
, 88),
71 .subsections
= (const VMStateDescription
*[]) {
72 &vmstate_iplb_extended
,
77 static const VMStateDescription vmstate_ipl
= {
80 .minimum_version_id
= 0,
81 .fields
= (VMStateField
[]) {
82 VMSTATE_UINT64(compat_start_addr
, S390IPLState
),
83 VMSTATE_UINT64(compat_bios_start_addr
, S390IPLState
),
84 VMSTATE_STRUCT(iplb
, S390IPLState
, 0, vmstate_iplb
, IplParameterBlock
),
85 VMSTATE_BOOL(iplb_valid
, S390IPLState
),
86 VMSTATE_UINT8(cssid
, S390IPLState
),
87 VMSTATE_UINT8(ssid
, S390IPLState
),
88 VMSTATE_UINT16(devno
, S390IPLState
),
93 static S390IPLState
*get_ipl_device(void)
95 return S390_IPL(object_resolve_path_type("", TYPE_S390_IPL
, NULL
));
98 static uint64_t bios_translate_addr(void *opaque
, uint64_t srcaddr
)
100 uint64_t dstaddr
= *(uint64_t *) opaque
;
102 * Assuming that our s390-ccw.img was linked for starting at address 0,
103 * we can simply add the destination address for the final location
105 return srcaddr
+ dstaddr
;
108 static void s390_ipl_realize(DeviceState
*dev
, Error
**errp
)
110 S390IPLState
*ipl
= S390_IPL(dev
);
121 * Always load the bios if it was enforced,
122 * even if an external kernel has been defined.
124 if (!ipl
->kernel
|| ipl
->enforce_bios
) {
125 uint64_t fwbase
= (MIN(ram_size
, 0x80000000U
) - 0x200000) & ~0xffffUL
;
127 if (bios_name
== NULL
) {
128 bios_name
= ipl
->firmware
;
131 bios_filename
= qemu_find_file(QEMU_FILE_TYPE_BIOS
, bios_name
);
132 if (bios_filename
== NULL
) {
133 error_setg(&err
, "could not find stage1 bootloader");
137 bios_size
= load_elf(bios_filename
, NULL
,
138 bios_translate_addr
, &fwbase
,
139 &ipl
->bios_start_addr
, NULL
, NULL
, 1,
142 /* Adjust ELF start address to final location */
143 ipl
->bios_start_addr
+= fwbase
;
145 /* Try to load non-ELF file */
146 bios_size
= load_image_targphys(bios_filename
, ZIPL_IMAGE_START
,
148 ipl
->bios_start_addr
= ZIPL_IMAGE_START
;
150 g_free(bios_filename
);
152 if (bios_size
== -1) {
153 error_setg(&err
, "could not load bootloader '%s'", bios_name
);
157 /* default boot target is the bios */
158 ipl
->start_addr
= ipl
->bios_start_addr
;
162 kernel_size
= load_elf(ipl
->kernel
, NULL
, NULL
, NULL
,
164 NULL
, 1, EM_S390
, 0, 0);
165 if (kernel_size
< 0) {
166 kernel_size
= load_image_targphys(ipl
->kernel
, 0, ram_size
);
167 if (kernel_size
< 0) {
168 error_setg(&err
, "could not load kernel '%s'", ipl
->kernel
);
171 /* if this is Linux use KERN_IMAGE_START */
172 magic
= rom_ptr(LINUX_MAGIC_ADDR
, 6);
173 if (magic
&& !memcmp(magic
, "S390EP", 6)) {
174 pentry
= KERN_IMAGE_START
;
176 /* if not Linux load the address of the (short) IPL PSW */
177 ipl_psw
= rom_ptr(4, 4);
179 pentry
= be32_to_cpu(*ipl_psw
) & 0x7fffffffUL
;
181 error_setg(&err
, "Could not get IPL PSW");
187 * Is it a Linux kernel (starting at 0x10000)? If yes, we fill in the
188 * kernel parameters here as well. Note: For old kernels (up to 3.2)
189 * we can not rely on the ELF entry point - it was 0x800 (the SALIPL
190 * loader) and it won't work. For this case we force it to 0x10000, too.
192 if (pentry
== KERN_IMAGE_START
|| pentry
== 0x800) {
193 char *parm_area
= rom_ptr(KERN_PARM_AREA
, strlen(ipl
->cmdline
) + 1);
194 ipl
->start_addr
= KERN_IMAGE_START
;
195 /* Overwrite parameters in the kernel image, which are "rom" */
197 strcpy(parm_area
, ipl
->cmdline
);
200 ipl
->start_addr
= pentry
;
204 ram_addr_t initrd_offset
;
208 initrd_offset
= INITRD_START
;
209 while (kernel_size
+ 0x100000 > initrd_offset
) {
210 initrd_offset
+= 0x100000;
212 initrd_size
= load_image_targphys(ipl
->initrd
, initrd_offset
,
213 ram_size
- initrd_offset
);
214 if (initrd_size
== -1) {
215 error_setg(&err
, "could not load initrd '%s'", ipl
->initrd
);
220 * we have to overwrite values in the kernel image,
223 romptr
= rom_ptr(INITRD_PARM_START
, 16);
225 stq_p(romptr
, initrd_offset
);
226 stq_p(romptr
+ 1, initrd_size
);
231 * Don't ever use the migrated values, they could come from a different
232 * BIOS and therefore don't work. But still migrate the values, so
233 * QEMUs relying on it don't break.
235 ipl
->compat_start_addr
= ipl
->start_addr
;
236 ipl
->compat_bios_start_addr
= ipl
->bios_start_addr
;
237 qemu_register_reset(qdev_reset_all_fn
, dev
);
239 error_propagate(errp
, err
);
242 static Property s390_ipl_properties
[] = {
243 DEFINE_PROP_STRING("kernel", S390IPLState
, kernel
),
244 DEFINE_PROP_STRING("initrd", S390IPLState
, initrd
),
245 DEFINE_PROP_STRING("cmdline", S390IPLState
, cmdline
),
246 DEFINE_PROP_STRING("firmware", S390IPLState
, firmware
),
247 DEFINE_PROP_STRING("netboot_fw", S390IPLState
, netboot_fw
),
248 DEFINE_PROP_BOOL("enforce_bios", S390IPLState
, enforce_bios
, false),
249 DEFINE_PROP_BOOL("iplbext_migration", S390IPLState
, iplbext_migration
,
251 DEFINE_PROP_END_OF_LIST(),
254 static void s390_ipl_set_boot_menu(S390IPLState
*ipl
)
256 QemuOptsList
*plist
= qemu_find_opts("boot-opts");
257 QemuOpts
*opts
= QTAILQ_FIRST(&plist
->head
);
259 unsigned long splash_time
= 0;
261 if (!get_boot_device(0)) {
263 error_report("boot menu requires a bootindex to be specified for "
269 switch (ipl
->iplb
.pbt
) {
270 case S390_IPL_TYPE_CCW
:
271 /* In the absence of -boot menu, use zipl parameters */
272 if (!qemu_opt_get(opts
, "menu")) {
273 ipl
->qipl
.qipl_flags
|= QIPL_FLAG_BM_OPTS_ZIPL
;
277 case S390_IPL_TYPE_QEMU_SCSI
:
281 error_report("boot menu is not supported for this device type");
290 ipl
->qipl
.qipl_flags
|= QIPL_FLAG_BM_OPTS_CMD
;
292 tmp
= qemu_opt_get(opts
, "splash-time");
294 if (tmp
&& qemu_strtoul(tmp
, NULL
, 10, &splash_time
)) {
295 error_report("splash-time is invalid, forcing it to 0");
296 ipl
->qipl
.boot_menu_timeout
= 0;
300 if (splash_time
> 0xffffffff) {
301 error_report("splash-time is too large, forcing it to max value");
302 ipl
->qipl
.boot_menu_timeout
= 0xffffffff;
306 ipl
->qipl
.boot_menu_timeout
= cpu_to_be32(splash_time
);
309 #define CCW_DEVTYPE_NONE 0x00
310 #define CCW_DEVTYPE_VIRTIO 0x01
311 #define CCW_DEVTYPE_VIRTIO_NET 0x02
312 #define CCW_DEVTYPE_SCSI 0x03
313 #define CCW_DEVTYPE_VFIO 0x04
315 static CcwDevice
*s390_get_ccw_device(DeviceState
*dev_st
, int *devtype
)
317 CcwDevice
*ccw_dev
= NULL
;
318 int tmp_dt
= CCW_DEVTYPE_NONE
;
321 VirtIONet
*virtio_net_dev
= (VirtIONet
*)
322 object_dynamic_cast(OBJECT(dev_st
), TYPE_VIRTIO_NET
);
323 VirtioCcwDevice
*virtio_ccw_dev
= (VirtioCcwDevice
*)
324 object_dynamic_cast(OBJECT(qdev_get_parent_bus(dev_st
)->parent
),
325 TYPE_VIRTIO_CCW_DEVICE
);
326 VFIOCCWDevice
*vfio_ccw_dev
= (VFIOCCWDevice
*)
327 object_dynamic_cast(OBJECT(dev_st
), TYPE_VFIO_CCW
);
329 if (virtio_ccw_dev
) {
330 ccw_dev
= CCW_DEVICE(virtio_ccw_dev
);
331 if (virtio_net_dev
) {
332 tmp_dt
= CCW_DEVTYPE_VIRTIO_NET
;
334 tmp_dt
= CCW_DEVTYPE_VIRTIO
;
336 } else if (vfio_ccw_dev
) {
337 ccw_dev
= CCW_DEVICE(vfio_ccw_dev
);
338 tmp_dt
= CCW_DEVTYPE_VFIO
;
340 SCSIDevice
*sd
= (SCSIDevice
*)
341 object_dynamic_cast(OBJECT(dev_st
),
344 SCSIBus
*bus
= scsi_bus_from_device(sd
);
345 VirtIOSCSI
*vdev
= container_of(bus
, VirtIOSCSI
, bus
);
346 VirtIOSCSICcw
*scsi_ccw
= container_of(vdev
, VirtIOSCSICcw
,
349 ccw_dev
= (CcwDevice
*)object_dynamic_cast(OBJECT(scsi_ccw
),
351 tmp_dt
= CCW_DEVTYPE_SCSI
;
361 static bool s390_gen_initial_iplb(S390IPLState
*ipl
)
364 CcwDevice
*ccw_dev
= NULL
;
368 dev_st
= get_boot_device(0);
370 ccw_dev
= s390_get_ccw_device(dev_st
, &devtype
);
374 * Currently allow IPL only from CCW devices.
378 case CCW_DEVTYPE_SCSI
:
379 sd
= SCSI_DEVICE(dev_st
);
380 ipl
->iplb
.len
= cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN
);
382 cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN
- S390_IPLB_HEADER_LEN
);
383 ipl
->iplb
.pbt
= S390_IPL_TYPE_QEMU_SCSI
;
384 ipl
->iplb
.scsi
.lun
= cpu_to_be32(sd
->lun
);
385 ipl
->iplb
.scsi
.target
= cpu_to_be16(sd
->id
);
386 ipl
->iplb
.scsi
.channel
= cpu_to_be16(sd
->channel
);
387 ipl
->iplb
.scsi
.devno
= cpu_to_be16(ccw_dev
->sch
->devno
);
388 ipl
->iplb
.scsi
.ssid
= ccw_dev
->sch
->ssid
& 3;
390 case CCW_DEVTYPE_VFIO
:
391 ipl
->iplb
.len
= cpu_to_be32(S390_IPLB_MIN_CCW_LEN
);
392 ipl
->iplb
.pbt
= S390_IPL_TYPE_CCW
;
393 ipl
->iplb
.ccw
.devno
= cpu_to_be16(ccw_dev
->sch
->devno
);
394 ipl
->iplb
.ccw
.ssid
= ccw_dev
->sch
->ssid
& 3;
396 case CCW_DEVTYPE_VIRTIO_NET
:
398 /* Fall through to CCW_DEVTYPE_VIRTIO case */
399 case CCW_DEVTYPE_VIRTIO
:
400 ipl
->iplb
.len
= cpu_to_be32(S390_IPLB_MIN_CCW_LEN
);
402 cpu_to_be32(S390_IPLB_MIN_CCW_LEN
- S390_IPLB_HEADER_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;
409 if (!s390_ipl_set_loadparm(ipl
->iplb
.loadparm
)) {
410 ipl
->iplb
.flags
|= DIAG308_FLAGS_LP_VALID
;
419 int s390_ipl_set_loadparm(uint8_t *loadparm
)
421 MachineState
*machine
= MACHINE(qdev_get_machine());
422 char *lp
= object_property_get_str(OBJECT(machine
), "loadparm", NULL
);
427 /* lp is an uppercase string without leading/embedded spaces */
428 for (i
= 0; i
< 8 && lp
[i
]; i
++) {
429 loadparm
[i
] = ascii2ebcdic
[(uint8_t) lp
[i
]];
433 memset(loadparm
+ i
, 0x40, 8 - i
); /* fill with EBCDIC spaces */
443 static int load_netboot_image(Error
**errp
)
445 S390IPLState
*ipl
= get_ipl_device();
446 char *netboot_filename
;
447 MemoryRegion
*sysmem
= get_system_memory();
448 MemoryRegion
*mr
= NULL
;
449 void *ram_ptr
= NULL
;
452 mr
= memory_region_find(sysmem
, 0, 1).mr
;
454 error_setg(errp
, "Failed to find memory region at address 0");
458 ram_ptr
= memory_region_get_ram_ptr(mr
);
460 error_setg(errp
, "No RAM found");
464 netboot_filename
= qemu_find_file(QEMU_FILE_TYPE_BIOS
, ipl
->netboot_fw
);
465 if (netboot_filename
== NULL
) {
466 error_setg(errp
, "Could not find network bootloader '%s'",
471 img_size
= load_elf_ram(netboot_filename
, NULL
, NULL
, NULL
,
473 NULL
, NULL
, 1, EM_S390
, 0, 0, NULL
, false);
476 img_size
= load_image_size(netboot_filename
, ram_ptr
, ram_size
);
477 ipl
->start_addr
= KERN_IMAGE_START
;
481 error_setg(errp
, "Failed to load network bootloader");
484 g_free(netboot_filename
);
487 memory_region_unref(mr
);
491 static bool is_virtio_ccw_device_of_type(IplParameterBlock
*iplb
,
498 SubchDev
*sch
= NULL
;
500 if (iplb
->pbt
!= S390_IPL_TYPE_CCW
) {
504 devno
= be16_to_cpu(iplb
->ccw
.devno
);
505 ssid
= iplb
->ccw
.ssid
& 3;
507 for (schid
= 0; schid
< MAX_SCHID
; schid
++) {
508 for (cssid
= 0; cssid
< MAX_CSSID
; cssid
++) {
509 sch
= css_find_subch(1, cssid
, ssid
, schid
);
511 if (sch
&& sch
->devno
== devno
) {
512 return sch
->id
.cu_model
== virtio_id
;
519 static bool is_virtio_net_device(IplParameterBlock
*iplb
)
521 return is_virtio_ccw_device_of_type(iplb
, VIRTIO_ID_NET
);
524 static bool is_virtio_scsi_device(IplParameterBlock
*iplb
)
526 return is_virtio_ccw_device_of_type(iplb
, VIRTIO_ID_SCSI
);
529 void s390_ipl_update_diag308(IplParameterBlock
*iplb
)
531 S390IPLState
*ipl
= get_ipl_device();
534 ipl
->iplb_valid
= true;
535 ipl
->netboot
= is_virtio_net_device(iplb
);
538 IplParameterBlock
*s390_ipl_get_iplb(void)
540 S390IPLState
*ipl
= get_ipl_device();
542 if (!ipl
->iplb_valid
) {
548 void s390_ipl_reset_request(CPUState
*cs
, enum s390_reset reset_type
)
550 S390IPLState
*ipl
= get_ipl_device();
552 if (reset_type
== S390_RESET_EXTERNAL
|| reset_type
== S390_RESET_REIPL
) {
553 /* use CPU 0 for full resets */
554 ipl
->reset_cpu_index
= 0;
556 ipl
->reset_cpu_index
= cs
->cpu_index
;
558 ipl
->reset_type
= reset_type
;
560 if (reset_type
== S390_RESET_REIPL
&&
563 ipl
->iplb
.pbt
== S390_IPL_TYPE_CCW
&&
564 is_virtio_scsi_device(&ipl
->iplb
)) {
565 CcwDevice
*ccw_dev
= s390_get_ccw_device(get_boot_device(0), NULL
);
568 cpu_to_be16(ccw_dev
->sch
->devno
) == ipl
->iplb
.ccw
.devno
&&
569 (ccw_dev
->sch
->ssid
& 3) == ipl
->iplb
.ccw
.ssid
) {
571 * this is the original boot device's SCSI
572 * so restore IPL parameter info from it
574 ipl
->iplb_valid
= s390_gen_initial_iplb(ipl
);
577 if (reset_type
== S390_RESET_MODIFIED_CLEAR
||
578 reset_type
== S390_RESET_LOAD_NORMAL
) {
579 /* ignore -no-reboot, send no event */
580 qemu_system_reset_request(SHUTDOWN_CAUSE_SUBSYSTEM_RESET
);
582 qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET
);
584 /* as this is triggered by a CPU, make sure to exit the loop */
590 void s390_ipl_get_reset_request(CPUState
**cs
, enum s390_reset
*reset_type
)
592 S390IPLState
*ipl
= get_ipl_device();
594 *cs
= qemu_get_cpu(ipl
->reset_cpu_index
);
599 *reset_type
= ipl
->reset_type
;
602 void s390_ipl_clear_reset_request(void)
604 S390IPLState
*ipl
= get_ipl_device();
606 ipl
->reset_type
= S390_RESET_EXTERNAL
;
607 /* use CPU 0 for full resets */
608 ipl
->reset_cpu_index
= 0;
611 static void s390_ipl_prepare_qipl(S390CPU
*cpu
)
613 S390IPLState
*ipl
= get_ipl_device();
617 addr
= cpu_physical_memory_map(cpu
->env
.psa
, &len
, 1);
618 if (!addr
|| len
< QIPL_ADDRESS
+ sizeof(QemuIplParameters
)) {
619 error_report("Cannot set QEMU IPL parameters");
622 memcpy(addr
+ QIPL_ADDRESS
, &ipl
->qipl
, sizeof(QemuIplParameters
));
623 cpu_physical_memory_unmap(addr
, len
, 1, len
);
626 void s390_ipl_prepare_cpu(S390CPU
*cpu
)
628 S390IPLState
*ipl
= get_ipl_device();
631 cpu
->env
.psw
.addr
= ipl
->start_addr
;
632 cpu
->env
.psw
.mask
= IPL_PSW_MASK
;
634 if (!ipl
->kernel
|| ipl
->iplb_valid
) {
635 cpu
->env
.psw
.addr
= ipl
->bios_start_addr
;
636 if (!ipl
->iplb_valid
) {
637 ipl
->iplb_valid
= s390_gen_initial_iplb(ipl
);
641 if (load_netboot_image(&err
) < 0) {
642 error_report_err(err
);
645 ipl
->qipl
.netboot_start_addr
= cpu_to_be64(ipl
->start_addr
);
647 s390_ipl_set_boot_menu(ipl
);
648 s390_ipl_prepare_qipl(cpu
);
651 static void s390_ipl_reset(DeviceState
*dev
)
653 S390IPLState
*ipl
= S390_IPL(dev
);
655 if (ipl
->reset_type
!= S390_RESET_REIPL
) {
656 ipl
->iplb_valid
= false;
657 memset(&ipl
->iplb
, 0, sizeof(IplParameterBlock
));
661 static void s390_ipl_class_init(ObjectClass
*klass
, void *data
)
663 DeviceClass
*dc
= DEVICE_CLASS(klass
);
665 dc
->realize
= s390_ipl_realize
;
666 dc
->props
= s390_ipl_properties
;
667 dc
->reset
= s390_ipl_reset
;
668 dc
->vmsd
= &vmstate_ipl
;
669 set_bit(DEVICE_CATEGORY_MISC
, dc
->categories
);
670 /* Reason: Loads the ROMs and thus can only be used one time - internally */
671 dc
->user_creatable
= false;
674 static const TypeInfo s390_ipl_info
= {
675 .class_init
= s390_ipl_class_init
,
676 .parent
= TYPE_DEVICE
,
677 .name
= TYPE_S390_IPL
,
678 .instance_size
= sizeof(S390IPLState
),
681 static void s390_ipl_register_types(void)
683 type_register_static(&s390_ipl_info
);
686 type_init(s390_ipl_register_types
)