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/css.h"
23 #include "hw/s390x/ebcdic.h"
25 #include "qemu/error-report.h"
26 #include "qemu/config-file.h"
27 #include "qemu/cutils.h"
28 #include "qemu/option.h"
29 #include "exec/exec-all.h"
31 #define KERN_IMAGE_START 0x010000UL
32 #define LINUX_MAGIC_ADDR 0x010008UL
33 #define KERN_PARM_AREA 0x010480UL
34 #define INITRD_START 0x800000UL
35 #define INITRD_PARM_START 0x010408UL
36 #define PARMFILE_START 0x001000UL
37 #define ZIPL_IMAGE_START 0x009000UL
38 #define IPL_PSW_MASK (PSW_MASK_32 | PSW_MASK_64)
40 static bool iplb_extended_needed(void *opaque
)
42 S390IPLState
*ipl
= S390_IPL(object_resolve_path(TYPE_S390_IPL
, NULL
));
44 return ipl
->iplbext_migration
;
47 static const VMStateDescription vmstate_iplb_extended
= {
48 .name
= "ipl/iplb_extended",
50 .minimum_version_id
= 0,
51 .needed
= iplb_extended_needed
,
52 .fields
= (VMStateField
[]) {
53 VMSTATE_UINT8_ARRAY(reserved_ext
, IplParameterBlock
, 4096 - 200),
58 static const VMStateDescription vmstate_iplb
= {
61 .minimum_version_id
= 0,
62 .fields
= (VMStateField
[]) {
63 VMSTATE_UINT8_ARRAY(reserved1
, IplParameterBlock
, 110),
64 VMSTATE_UINT16(devno
, IplParameterBlock
),
65 VMSTATE_UINT8_ARRAY(reserved2
, IplParameterBlock
, 88),
68 .subsections
= (const VMStateDescription
*[]) {
69 &vmstate_iplb_extended
,
74 static const VMStateDescription vmstate_ipl
= {
77 .minimum_version_id
= 0,
78 .fields
= (VMStateField
[]) {
79 VMSTATE_UINT64(compat_start_addr
, S390IPLState
),
80 VMSTATE_UINT64(compat_bios_start_addr
, S390IPLState
),
81 VMSTATE_STRUCT(iplb
, S390IPLState
, 0, vmstate_iplb
, IplParameterBlock
),
82 VMSTATE_BOOL(iplb_valid
, S390IPLState
),
83 VMSTATE_UINT8(cssid
, S390IPLState
),
84 VMSTATE_UINT8(ssid
, S390IPLState
),
85 VMSTATE_UINT16(devno
, S390IPLState
),
90 static S390IPLState
*get_ipl_device(void)
92 return S390_IPL(object_resolve_path_type("", TYPE_S390_IPL
, NULL
));
95 static uint64_t bios_translate_addr(void *opaque
, uint64_t srcaddr
)
97 uint64_t dstaddr
= *(uint64_t *) opaque
;
99 * Assuming that our s390-ccw.img was linked for starting at address 0,
100 * we can simply add the destination address for the final location
102 return srcaddr
+ dstaddr
;
105 static void s390_ipl_realize(DeviceState
*dev
, Error
**errp
)
107 S390IPLState
*ipl
= S390_IPL(dev
);
118 * Always load the bios if it was enforced,
119 * even if an external kernel has been defined.
121 if (!ipl
->kernel
|| ipl
->enforce_bios
) {
122 uint64_t fwbase
= (MIN(ram_size
, 0x80000000U
) - 0x200000) & ~0xffffUL
;
124 if (bios_name
== NULL
) {
125 bios_name
= ipl
->firmware
;
128 bios_filename
= qemu_find_file(QEMU_FILE_TYPE_BIOS
, bios_name
);
129 if (bios_filename
== NULL
) {
130 error_setg(&err
, "could not find stage1 bootloader");
134 bios_size
= load_elf(bios_filename
, NULL
,
135 bios_translate_addr
, &fwbase
,
136 &ipl
->bios_start_addr
, NULL
, NULL
, 1,
139 /* Adjust ELF start address to final location */
140 ipl
->bios_start_addr
+= fwbase
;
142 /* Try to load non-ELF file */
143 bios_size
= load_image_targphys(bios_filename
, ZIPL_IMAGE_START
,
145 ipl
->bios_start_addr
= ZIPL_IMAGE_START
;
147 g_free(bios_filename
);
149 if (bios_size
== -1) {
150 error_setg(&err
, "could not load bootloader '%s'", bios_name
);
154 /* default boot target is the bios */
155 ipl
->start_addr
= ipl
->bios_start_addr
;
159 kernel_size
= load_elf(ipl
->kernel
, NULL
, NULL
, NULL
,
161 NULL
, 1, EM_S390
, 0, 0);
162 if (kernel_size
< 0) {
163 kernel_size
= load_image_targphys(ipl
->kernel
, 0, ram_size
);
164 if (kernel_size
< 0) {
165 error_setg(&err
, "could not load kernel '%s'", ipl
->kernel
);
168 /* if this is Linux use KERN_IMAGE_START */
169 magic
= rom_ptr(LINUX_MAGIC_ADDR
, 6);
170 if (magic
&& !memcmp(magic
, "S390EP", 6)) {
171 pentry
= KERN_IMAGE_START
;
173 /* if not Linux load the address of the (short) IPL PSW */
174 ipl_psw
= rom_ptr(4, 4);
176 pentry
= be32_to_cpu(*ipl_psw
) & 0x7fffffffUL
;
178 error_setg(&err
, "Could not get IPL PSW");
184 * Is it a Linux kernel (starting at 0x10000)? If yes, we fill in the
185 * kernel parameters here as well. Note: For old kernels (up to 3.2)
186 * we can not rely on the ELF entry point - it was 0x800 (the SALIPL
187 * loader) and it won't work. For this case we force it to 0x10000, too.
189 if (pentry
== KERN_IMAGE_START
|| pentry
== 0x800) {
190 char *parm_area
= rom_ptr(KERN_PARM_AREA
, strlen(ipl
->cmdline
) + 1);
191 ipl
->start_addr
= KERN_IMAGE_START
;
192 /* Overwrite parameters in the kernel image, which are "rom" */
194 strcpy(parm_area
, ipl
->cmdline
);
197 ipl
->start_addr
= pentry
;
201 ram_addr_t initrd_offset
;
205 initrd_offset
= INITRD_START
;
206 while (kernel_size
+ 0x100000 > initrd_offset
) {
207 initrd_offset
+= 0x100000;
209 initrd_size
= load_image_targphys(ipl
->initrd
, initrd_offset
,
210 ram_size
- initrd_offset
);
211 if (initrd_size
== -1) {
212 error_setg(&err
, "could not load initrd '%s'", ipl
->initrd
);
217 * we have to overwrite values in the kernel image,
220 romptr
= rom_ptr(INITRD_PARM_START
, 16);
222 stq_p(romptr
, initrd_offset
);
223 stq_p(romptr
+ 1, initrd_size
);
228 * Don't ever use the migrated values, they could come from a different
229 * BIOS and therefore don't work. But still migrate the values, so
230 * QEMUs relying on it don't break.
232 ipl
->compat_start_addr
= ipl
->start_addr
;
233 ipl
->compat_bios_start_addr
= ipl
->bios_start_addr
;
234 qemu_register_reset(qdev_reset_all_fn
, dev
);
236 error_propagate(errp
, err
);
239 static Property s390_ipl_properties
[] = {
240 DEFINE_PROP_STRING("kernel", S390IPLState
, kernel
),
241 DEFINE_PROP_STRING("initrd", S390IPLState
, initrd
),
242 DEFINE_PROP_STRING("cmdline", S390IPLState
, cmdline
),
243 DEFINE_PROP_STRING("firmware", S390IPLState
, firmware
),
244 DEFINE_PROP_STRING("netboot_fw", S390IPLState
, netboot_fw
),
245 DEFINE_PROP_BOOL("enforce_bios", S390IPLState
, enforce_bios
, false),
246 DEFINE_PROP_BOOL("iplbext_migration", S390IPLState
, iplbext_migration
,
248 DEFINE_PROP_END_OF_LIST(),
251 static void s390_ipl_set_boot_menu(S390IPLState
*ipl
)
253 QemuOptsList
*plist
= qemu_find_opts("boot-opts");
254 QemuOpts
*opts
= QTAILQ_FIRST(&plist
->head
);
255 uint8_t *flags
= &ipl
->qipl
.qipl_flags
;
256 uint32_t *timeout
= &ipl
->qipl
.boot_menu_timeout
;
258 unsigned long splash_time
= 0;
260 if (!get_boot_device(0)) {
262 error_report("boot menu requires a bootindex to be specified for "
268 switch (ipl
->iplb
.pbt
) {
269 case S390_IPL_TYPE_CCW
:
270 /* In the absence of -boot menu, use zipl parameters */
271 if (!qemu_opt_get(opts
, "menu")) {
272 *flags
|= QIPL_FLAG_BM_OPTS_ZIPL
;
276 case S390_IPL_TYPE_QEMU_SCSI
:
280 error_report("boot menu is not supported for this device type");
289 *flags
|= QIPL_FLAG_BM_OPTS_CMD
;
291 tmp
= qemu_opt_get(opts
, "splash-time");
293 if (tmp
&& qemu_strtoul(tmp
, NULL
, 10, &splash_time
)) {
294 error_report("splash-time is invalid, forcing it to 0");
299 if (splash_time
> 0xffffffff) {
300 error_report("splash-time is too large, forcing it to max value");
301 *timeout
= 0xffffffff;
305 *timeout
= cpu_to_be32(splash_time
);
308 static CcwDevice
*s390_get_ccw_device(DeviceState
*dev_st
)
310 CcwDevice
*ccw_dev
= NULL
;
313 VirtioCcwDevice
*virtio_ccw_dev
= (VirtioCcwDevice
*)
314 object_dynamic_cast(OBJECT(qdev_get_parent_bus(dev_st
)->parent
),
315 TYPE_VIRTIO_CCW_DEVICE
);
316 if (virtio_ccw_dev
) {
317 ccw_dev
= CCW_DEVICE(virtio_ccw_dev
);
319 SCSIDevice
*sd
= (SCSIDevice
*)
320 object_dynamic_cast(OBJECT(dev_st
),
323 SCSIBus
*bus
= scsi_bus_from_device(sd
);
324 VirtIOSCSI
*vdev
= container_of(bus
, VirtIOSCSI
, bus
);
325 VirtIOSCSICcw
*scsi_ccw
= container_of(vdev
, VirtIOSCSICcw
,
328 ccw_dev
= (CcwDevice
*)object_dynamic_cast(OBJECT(scsi_ccw
),
336 static bool s390_gen_initial_iplb(S390IPLState
*ipl
)
339 CcwDevice
*ccw_dev
= NULL
;
341 dev_st
= get_boot_device(0);
343 ccw_dev
= s390_get_ccw_device(dev_st
);
347 * Currently allow IPL only from CCW devices.
350 SCSIDevice
*sd
= (SCSIDevice
*) object_dynamic_cast(OBJECT(dev_st
),
354 ipl
->iplb
.len
= cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN
);
356 cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN
- S390_IPLB_HEADER_LEN
);
357 ipl
->iplb
.pbt
= S390_IPL_TYPE_QEMU_SCSI
;
358 ipl
->iplb
.scsi
.lun
= cpu_to_be32(sd
->lun
);
359 ipl
->iplb
.scsi
.target
= cpu_to_be16(sd
->id
);
360 ipl
->iplb
.scsi
.channel
= cpu_to_be16(sd
->channel
);
361 ipl
->iplb
.scsi
.devno
= cpu_to_be16(ccw_dev
->sch
->devno
);
362 ipl
->iplb
.scsi
.ssid
= ccw_dev
->sch
->ssid
& 3;
364 VirtIONet
*vn
= (VirtIONet
*) object_dynamic_cast(OBJECT(dev_st
),
367 ipl
->iplb
.len
= cpu_to_be32(S390_IPLB_MIN_CCW_LEN
);
369 cpu_to_be32(S390_IPLB_MIN_CCW_LEN
- S390_IPLB_HEADER_LEN
);
370 ipl
->iplb
.pbt
= S390_IPL_TYPE_CCW
;
371 ipl
->iplb
.ccw
.devno
= cpu_to_be16(ccw_dev
->sch
->devno
);
372 ipl
->iplb
.ccw
.ssid
= ccw_dev
->sch
->ssid
& 3;
379 if (!s390_ipl_set_loadparm(ipl
->iplb
.loadparm
)) {
380 ipl
->iplb
.flags
|= DIAG308_FLAGS_LP_VALID
;
389 int s390_ipl_set_loadparm(uint8_t *loadparm
)
391 MachineState
*machine
= MACHINE(qdev_get_machine());
392 char *lp
= object_property_get_str(OBJECT(machine
), "loadparm", NULL
);
397 /* lp is an uppercase string without leading/embedded spaces */
398 for (i
= 0; i
< 8 && lp
[i
]; i
++) {
399 loadparm
[i
] = ascii2ebcdic
[(uint8_t) lp
[i
]];
403 memset(loadparm
+ i
, 0x40, 8 - i
); /* fill with EBCDIC spaces */
413 static int load_netboot_image(Error
**errp
)
415 S390IPLState
*ipl
= get_ipl_device();
416 char *netboot_filename
;
417 MemoryRegion
*sysmem
= get_system_memory();
418 MemoryRegion
*mr
= NULL
;
419 void *ram_ptr
= NULL
;
422 mr
= memory_region_find(sysmem
, 0, 1).mr
;
424 error_setg(errp
, "Failed to find memory region at address 0");
428 ram_ptr
= memory_region_get_ram_ptr(mr
);
430 error_setg(errp
, "No RAM found");
434 netboot_filename
= qemu_find_file(QEMU_FILE_TYPE_BIOS
, ipl
->netboot_fw
);
435 if (netboot_filename
== NULL
) {
436 error_setg(errp
, "Could not find network bootloader '%s'",
441 img_size
= load_elf_ram(netboot_filename
, NULL
, NULL
, NULL
,
443 NULL
, NULL
, 1, EM_S390
, 0, 0, NULL
, false);
446 img_size
= load_image_size(netboot_filename
, ram_ptr
, ram_size
);
447 ipl
->start_addr
= KERN_IMAGE_START
;
451 error_setg(errp
, "Failed to load network bootloader");
454 g_free(netboot_filename
);
457 memory_region_unref(mr
);
461 static bool is_virtio_ccw_device_of_type(IplParameterBlock
*iplb
,
468 SubchDev
*sch
= NULL
;
470 if (iplb
->pbt
!= S390_IPL_TYPE_CCW
) {
474 devno
= be16_to_cpu(iplb
->ccw
.devno
);
475 ssid
= iplb
->ccw
.ssid
& 3;
477 for (schid
= 0; schid
< MAX_SCHID
; schid
++) {
478 for (cssid
= 0; cssid
< MAX_CSSID
; cssid
++) {
479 sch
= css_find_subch(1, cssid
, ssid
, schid
);
481 if (sch
&& sch
->devno
== devno
) {
482 return sch
->id
.cu_model
== virtio_id
;
489 static bool is_virtio_net_device(IplParameterBlock
*iplb
)
491 return is_virtio_ccw_device_of_type(iplb
, VIRTIO_ID_NET
);
494 static bool is_virtio_scsi_device(IplParameterBlock
*iplb
)
496 return is_virtio_ccw_device_of_type(iplb
, VIRTIO_ID_SCSI
);
499 void s390_ipl_update_diag308(IplParameterBlock
*iplb
)
501 S390IPLState
*ipl
= get_ipl_device();
504 ipl
->iplb_valid
= true;
505 ipl
->netboot
= is_virtio_net_device(iplb
);
508 IplParameterBlock
*s390_ipl_get_iplb(void)
510 S390IPLState
*ipl
= get_ipl_device();
512 if (!ipl
->iplb_valid
) {
518 void s390_ipl_reset_request(CPUState
*cs
, enum s390_reset reset_type
)
520 S390IPLState
*ipl
= get_ipl_device();
522 if (reset_type
== S390_RESET_EXTERNAL
|| reset_type
== S390_RESET_REIPL
) {
523 /* use CPU 0 for full resets */
524 ipl
->reset_cpu_index
= 0;
526 ipl
->reset_cpu_index
= cs
->cpu_index
;
528 ipl
->reset_type
= reset_type
;
530 if (reset_type
== S390_RESET_REIPL
&&
533 ipl
->iplb
.pbt
== S390_IPL_TYPE_CCW
&&
534 is_virtio_scsi_device(&ipl
->iplb
)) {
535 CcwDevice
*ccw_dev
= s390_get_ccw_device(get_boot_device(0));
538 cpu_to_be16(ccw_dev
->sch
->devno
) == ipl
->iplb
.ccw
.devno
&&
539 (ccw_dev
->sch
->ssid
& 3) == ipl
->iplb
.ccw
.ssid
) {
541 * this is the original boot device's SCSI
542 * so restore IPL parameter info from it
544 ipl
->iplb_valid
= s390_gen_initial_iplb(ipl
);
547 if (reset_type
== S390_RESET_MODIFIED_CLEAR
||
548 reset_type
== S390_RESET_LOAD_NORMAL
) {
549 /* ignore -no-reboot, send no event */
550 qemu_system_reset_request(SHUTDOWN_CAUSE_SUBSYSTEM_RESET
);
552 qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET
);
554 /* as this is triggered by a CPU, make sure to exit the loop */
560 void s390_ipl_get_reset_request(CPUState
**cs
, enum s390_reset
*reset_type
)
562 S390IPLState
*ipl
= get_ipl_device();
564 *cs
= qemu_get_cpu(ipl
->reset_cpu_index
);
569 *reset_type
= ipl
->reset_type
;
572 void s390_ipl_clear_reset_request(void)
574 S390IPLState
*ipl
= get_ipl_device();
576 ipl
->reset_type
= S390_RESET_EXTERNAL
;
577 /* use CPU 0 for full resets */
578 ipl
->reset_cpu_index
= 0;
581 static void s390_ipl_prepare_qipl(S390CPU
*cpu
)
583 S390IPLState
*ipl
= get_ipl_device();
587 addr
= cpu_physical_memory_map(cpu
->env
.psa
, &len
, 1);
588 if (!addr
|| len
< QIPL_ADDRESS
+ sizeof(QemuIplParameters
)) {
589 error_report("Cannot set QEMU IPL parameters");
592 memcpy(addr
+ QIPL_ADDRESS
, &ipl
->qipl
, sizeof(QemuIplParameters
));
593 cpu_physical_memory_unmap(addr
, len
, 1, len
);
596 void s390_ipl_prepare_cpu(S390CPU
*cpu
)
598 S390IPLState
*ipl
= get_ipl_device();
601 cpu
->env
.psw
.addr
= ipl
->start_addr
;
602 cpu
->env
.psw
.mask
= IPL_PSW_MASK
;
604 if (!ipl
->kernel
|| ipl
->iplb_valid
) {
605 cpu
->env
.psw
.addr
= ipl
->bios_start_addr
;
606 if (!ipl
->iplb_valid
) {
607 ipl
->iplb_valid
= s390_gen_initial_iplb(ipl
);
611 if (load_netboot_image(&err
) < 0) {
612 error_report_err(err
);
615 ipl
->qipl
.netboot_start_addr
= cpu_to_be64(ipl
->start_addr
);
617 s390_ipl_set_boot_menu(ipl
);
618 s390_ipl_prepare_qipl(cpu
);
621 static void s390_ipl_reset(DeviceState
*dev
)
623 S390IPLState
*ipl
= S390_IPL(dev
);
625 if (ipl
->reset_type
!= S390_RESET_REIPL
) {
626 ipl
->iplb_valid
= false;
627 memset(&ipl
->iplb
, 0, sizeof(IplParameterBlock
));
631 static void s390_ipl_class_init(ObjectClass
*klass
, void *data
)
633 DeviceClass
*dc
= DEVICE_CLASS(klass
);
635 dc
->realize
= s390_ipl_realize
;
636 dc
->props
= s390_ipl_properties
;
637 dc
->reset
= s390_ipl_reset
;
638 dc
->vmsd
= &vmstate_ipl
;
639 set_bit(DEVICE_CATEGORY_MISC
, dc
->categories
);
640 /* Reason: Loads the ROMs and thus can only be used one time - internally */
641 dc
->user_creatable
= false;
644 static const TypeInfo s390_ipl_info
= {
645 .class_init
= s390_ipl_class_init
,
646 .parent
= TYPE_DEVICE
,
647 .name
= TYPE_S390_IPL
,
648 .instance_size
= sizeof(S390IPLState
),
651 static void s390_ipl_register_types(void)
653 type_register_static(&s390_ipl_info
);
656 type_init(s390_ipl_register_types
)