qcow: Switch get_cluster_offset to be byte-based
[qemu/ar7.git] / hw / s390x / ipl.c
blob0d6734900426c94e3e10306a5195d1e8d85014fa
1 /*
2 * bootloader support
4 * Copyright IBM, Corp. 2012
6 * Authors:
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"
17 #include "cpu.h"
18 #include "elf.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"
24 #include "ipl.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 INITRD_PARM_SIZE 0x010410UL
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",
50 .version_id = 0,
51 .minimum_version_id = 0,
52 .needed = iplb_extended_needed,
53 .fields = (VMStateField[]) {
54 VMSTATE_UINT8_ARRAY(reserved_ext, IplParameterBlock, 4096 - 200),
55 VMSTATE_END_OF_LIST()
59 static const VMStateDescription vmstate_iplb = {
60 .name = "ipl/iplb",
61 .version_id = 0,
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),
67 VMSTATE_END_OF_LIST()
69 .subsections = (const VMStateDescription*[]) {
70 &vmstate_iplb_extended,
71 NULL
75 static const VMStateDescription vmstate_ipl = {
76 .name = "ipl",
77 .version_id = 0,
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),
87 VMSTATE_END_OF_LIST()
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);
109 uint32_t *ipl_psw;
110 uint64_t pentry;
111 char *magic;
112 int kernel_size;
113 Error *err = NULL;
115 int bios_size;
116 char *bios_filename;
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");
132 goto error;
135 bios_size = load_elf(bios_filename, bios_translate_addr, &fwbase,
136 &ipl->bios_start_addr, NULL, NULL, 1,
137 EM_S390, 0, 0);
138 if (bios_size > 0) {
139 /* Adjust ELF start address to final location */
140 ipl->bios_start_addr += fwbase;
141 } else {
142 /* Try to load non-ELF file */
143 bios_size = load_image_targphys(bios_filename, ZIPL_IMAGE_START,
144 4096);
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);
151 goto error;
154 /* default boot target is the bios */
155 ipl->start_addr = ipl->bios_start_addr;
158 if (ipl->kernel) {
159 kernel_size = load_elf(ipl->kernel, NULL, NULL, &pentry, NULL,
160 NULL, 1, EM_S390, 0, 0);
161 if (kernel_size < 0) {
162 kernel_size = load_image_targphys(ipl->kernel, 0, ram_size);
163 if (kernel_size < 0) {
164 error_setg(&err, "could not load kernel '%s'", ipl->kernel);
165 goto error;
167 /* if this is Linux use KERN_IMAGE_START */
168 magic = rom_ptr(LINUX_MAGIC_ADDR);
169 if (magic && !memcmp(magic, "S390EP", 6)) {
170 pentry = KERN_IMAGE_START;
171 } else {
172 /* if not Linux load the address of the (short) IPL PSW */
173 ipl_psw = rom_ptr(4);
174 if (ipl_psw) {
175 pentry = be32_to_cpu(*ipl_psw) & 0x7fffffffUL;
176 } else {
177 error_setg(&err, "Could not get IPL PSW");
178 goto error;
183 * Is it a Linux kernel (starting at 0x10000)? If yes, we fill in the
184 * kernel parameters here as well. Note: For old kernels (up to 3.2)
185 * we can not rely on the ELF entry point - it was 0x800 (the SALIPL
186 * loader) and it won't work. For this case we force it to 0x10000, too.
188 if (pentry == KERN_IMAGE_START || pentry == 0x800) {
189 ipl->start_addr = KERN_IMAGE_START;
190 /* Overwrite parameters in the kernel image, which are "rom" */
191 strcpy(rom_ptr(KERN_PARM_AREA), ipl->cmdline);
192 } else {
193 ipl->start_addr = pentry;
196 if (ipl->initrd) {
197 ram_addr_t initrd_offset;
198 int initrd_size;
200 initrd_offset = INITRD_START;
201 while (kernel_size + 0x100000 > initrd_offset) {
202 initrd_offset += 0x100000;
204 initrd_size = load_image_targphys(ipl->initrd, initrd_offset,
205 ram_size - initrd_offset);
206 if (initrd_size == -1) {
207 error_setg(&err, "could not load initrd '%s'", ipl->initrd);
208 goto error;
212 * we have to overwrite values in the kernel image,
213 * which are "rom"
215 stq_p(rom_ptr(INITRD_PARM_START), initrd_offset);
216 stq_p(rom_ptr(INITRD_PARM_SIZE), initrd_size);
220 * Don't ever use the migrated values, they could come from a different
221 * BIOS and therefore don't work. But still migrate the values, so
222 * QEMUs relying on it don't break.
224 ipl->compat_start_addr = ipl->start_addr;
225 ipl->compat_bios_start_addr = ipl->bios_start_addr;
226 qemu_register_reset(qdev_reset_all_fn, dev);
227 error:
228 error_propagate(errp, err);
231 static Property s390_ipl_properties[] = {
232 DEFINE_PROP_STRING("kernel", S390IPLState, kernel),
233 DEFINE_PROP_STRING("initrd", S390IPLState, initrd),
234 DEFINE_PROP_STRING("cmdline", S390IPLState, cmdline),
235 DEFINE_PROP_STRING("firmware", S390IPLState, firmware),
236 DEFINE_PROP_STRING("netboot_fw", S390IPLState, netboot_fw),
237 DEFINE_PROP_BOOL("enforce_bios", S390IPLState, enforce_bios, false),
238 DEFINE_PROP_BOOL("iplbext_migration", S390IPLState, iplbext_migration,
239 true),
240 DEFINE_PROP_END_OF_LIST(),
243 static void s390_ipl_set_boot_menu(S390IPLState *ipl)
245 QemuOptsList *plist = qemu_find_opts("boot-opts");
246 QemuOpts *opts = QTAILQ_FIRST(&plist->head);
247 uint8_t *flags = &ipl->qipl.qipl_flags;
248 uint32_t *timeout = &ipl->qipl.boot_menu_timeout;
249 const char *tmp;
250 unsigned long splash_time = 0;
252 if (!get_boot_device(0)) {
253 if (boot_menu) {
254 error_report("boot menu requires a bootindex to be specified for "
255 "the IPL device");
257 return;
260 switch (ipl->iplb.pbt) {
261 case S390_IPL_TYPE_CCW:
262 /* In the absence of -boot menu, use zipl parameters */
263 if (!qemu_opt_get(opts, "menu")) {
264 *flags |= QIPL_FLAG_BM_OPTS_ZIPL;
265 return;
267 break;
268 case S390_IPL_TYPE_QEMU_SCSI:
269 break;
270 default:
271 if (boot_menu) {
272 error_report("boot menu is not supported for this device type");
274 return;
277 if (!boot_menu) {
278 return;
281 *flags |= QIPL_FLAG_BM_OPTS_CMD;
283 tmp = qemu_opt_get(opts, "splash-time");
285 if (tmp && qemu_strtoul(tmp, NULL, 10, &splash_time)) {
286 error_report("splash-time is invalid, forcing it to 0");
287 *timeout = 0;
288 return;
291 if (splash_time > 0xffffffff) {
292 error_report("splash-time is too large, forcing it to max value");
293 *timeout = 0xffffffff;
294 return;
297 *timeout = cpu_to_be32(splash_time);
300 static CcwDevice *s390_get_ccw_device(DeviceState *dev_st)
302 CcwDevice *ccw_dev = NULL;
304 if (dev_st) {
305 VirtioCcwDevice *virtio_ccw_dev = (VirtioCcwDevice *)
306 object_dynamic_cast(OBJECT(qdev_get_parent_bus(dev_st)->parent),
307 TYPE_VIRTIO_CCW_DEVICE);
308 if (virtio_ccw_dev) {
309 ccw_dev = CCW_DEVICE(virtio_ccw_dev);
310 } else {
311 SCSIDevice *sd = (SCSIDevice *)
312 object_dynamic_cast(OBJECT(dev_st),
313 TYPE_SCSI_DEVICE);
314 if (sd) {
315 SCSIBus *bus = scsi_bus_from_device(sd);
316 VirtIOSCSI *vdev = container_of(bus, VirtIOSCSI, bus);
317 VirtIOSCSICcw *scsi_ccw = container_of(vdev, VirtIOSCSICcw,
318 vdev);
320 ccw_dev = (CcwDevice *)object_dynamic_cast(OBJECT(scsi_ccw),
321 TYPE_CCW_DEVICE);
325 return ccw_dev;
328 static bool s390_gen_initial_iplb(S390IPLState *ipl)
330 DeviceState *dev_st;
331 CcwDevice *ccw_dev = NULL;
333 dev_st = get_boot_device(0);
334 if (dev_st) {
335 ccw_dev = s390_get_ccw_device(dev_st);
339 * Currently allow IPL only from CCW devices.
341 if (ccw_dev) {
342 SCSIDevice *sd = (SCSIDevice *) object_dynamic_cast(OBJECT(dev_st),
343 TYPE_SCSI_DEVICE);
345 if (sd) {
346 ipl->iplb.len = cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN);
347 ipl->iplb.blk0_len =
348 cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN - S390_IPLB_HEADER_LEN);
349 ipl->iplb.pbt = S390_IPL_TYPE_QEMU_SCSI;
350 ipl->iplb.scsi.lun = cpu_to_be32(sd->lun);
351 ipl->iplb.scsi.target = cpu_to_be16(sd->id);
352 ipl->iplb.scsi.channel = cpu_to_be16(sd->channel);
353 ipl->iplb.scsi.devno = cpu_to_be16(ccw_dev->sch->devno);
354 ipl->iplb.scsi.ssid = ccw_dev->sch->ssid & 3;
355 } else {
356 VirtIONet *vn = (VirtIONet *) object_dynamic_cast(OBJECT(dev_st),
357 TYPE_VIRTIO_NET);
359 ipl->iplb.len = cpu_to_be32(S390_IPLB_MIN_CCW_LEN);
360 ipl->iplb.blk0_len =
361 cpu_to_be32(S390_IPLB_MIN_CCW_LEN - S390_IPLB_HEADER_LEN);
362 ipl->iplb.pbt = S390_IPL_TYPE_CCW;
363 ipl->iplb.ccw.devno = cpu_to_be16(ccw_dev->sch->devno);
364 ipl->iplb.ccw.ssid = ccw_dev->sch->ssid & 3;
366 if (vn) {
367 ipl->netboot = true;
371 if (!s390_ipl_set_loadparm(ipl->iplb.loadparm)) {
372 ipl->iplb.flags |= DIAG308_FLAGS_LP_VALID;
375 return true;
378 return false;
381 int s390_ipl_set_loadparm(uint8_t *loadparm)
383 MachineState *machine = MACHINE(qdev_get_machine());
384 char *lp = object_property_get_str(OBJECT(machine), "loadparm", NULL);
386 if (lp) {
387 int i;
389 /* lp is an uppercase string without leading/embedded spaces */
390 for (i = 0; i < 8 && lp[i]; i++) {
391 loadparm[i] = ascii2ebcdic[(uint8_t) lp[i]];
394 if (i < 8) {
395 memset(loadparm + i, 0x40, 8 - i); /* fill with EBCDIC spaces */
398 g_free(lp);
399 return 0;
402 return -1;
405 static int load_netboot_image(Error **errp)
407 S390IPLState *ipl = get_ipl_device();
408 char *netboot_filename;
409 MemoryRegion *sysmem = get_system_memory();
410 MemoryRegion *mr = NULL;
411 void *ram_ptr = NULL;
412 int img_size = -1;
414 mr = memory_region_find(sysmem, 0, 1).mr;
415 if (!mr) {
416 error_setg(errp, "Failed to find memory region at address 0");
417 return -1;
420 ram_ptr = memory_region_get_ram_ptr(mr);
421 if (!ram_ptr) {
422 error_setg(errp, "No RAM found");
423 goto unref_mr;
426 netboot_filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, ipl->netboot_fw);
427 if (netboot_filename == NULL) {
428 error_setg(errp, "Could not find network bootloader '%s'",
429 ipl->netboot_fw);
430 goto unref_mr;
433 img_size = load_elf_ram(netboot_filename, NULL, NULL, &ipl->start_addr,
434 NULL, NULL, 1, EM_S390, 0, 0, NULL, false);
436 if (img_size < 0) {
437 img_size = load_image_size(netboot_filename, ram_ptr, ram_size);
438 ipl->start_addr = KERN_IMAGE_START;
441 if (img_size < 0) {
442 error_setg(errp, "Failed to load network bootloader");
445 g_free(netboot_filename);
447 unref_mr:
448 memory_region_unref(mr);
449 return img_size;
452 static bool is_virtio_ccw_device_of_type(IplParameterBlock *iplb,
453 int virtio_id)
455 uint8_t cssid;
456 uint8_t ssid;
457 uint16_t devno;
458 uint16_t schid;
459 SubchDev *sch = NULL;
461 if (iplb->pbt != S390_IPL_TYPE_CCW) {
462 return false;
465 devno = be16_to_cpu(iplb->ccw.devno);
466 ssid = iplb->ccw.ssid & 3;
468 for (schid = 0; schid < MAX_SCHID; schid++) {
469 for (cssid = 0; cssid < MAX_CSSID; cssid++) {
470 sch = css_find_subch(1, cssid, ssid, schid);
472 if (sch && sch->devno == devno) {
473 return sch->id.cu_model == virtio_id;
477 return false;
480 static bool is_virtio_net_device(IplParameterBlock *iplb)
482 return is_virtio_ccw_device_of_type(iplb, VIRTIO_ID_NET);
485 static bool is_virtio_scsi_device(IplParameterBlock *iplb)
487 return is_virtio_ccw_device_of_type(iplb, VIRTIO_ID_SCSI);
490 void s390_ipl_update_diag308(IplParameterBlock *iplb)
492 S390IPLState *ipl = get_ipl_device();
494 ipl->iplb = *iplb;
495 ipl->iplb_valid = true;
496 ipl->netboot = is_virtio_net_device(iplb);
499 IplParameterBlock *s390_ipl_get_iplb(void)
501 S390IPLState *ipl = get_ipl_device();
503 if (!ipl->iplb_valid) {
504 return NULL;
506 return &ipl->iplb;
509 void s390_ipl_reset_request(CPUState *cs, enum s390_reset reset_type)
511 S390IPLState *ipl = get_ipl_device();
513 if (reset_type == S390_RESET_EXTERNAL || reset_type == S390_RESET_REIPL) {
514 /* use CPU 0 for full resets */
515 ipl->reset_cpu_index = 0;
516 } else {
517 ipl->reset_cpu_index = cs->cpu_index;
519 ipl->reset_type = reset_type;
521 if (reset_type == S390_RESET_REIPL &&
522 ipl->iplb_valid &&
523 !ipl->netboot &&
524 ipl->iplb.pbt == S390_IPL_TYPE_CCW &&
525 is_virtio_scsi_device(&ipl->iplb)) {
526 CcwDevice *ccw_dev = s390_get_ccw_device(get_boot_device(0));
528 if (ccw_dev &&
529 cpu_to_be16(ccw_dev->sch->devno) == ipl->iplb.ccw.devno &&
530 (ccw_dev->sch->ssid & 3) == ipl->iplb.ccw.ssid) {
532 * this is the original boot device's SCSI
533 * so restore IPL parameter info from it
535 ipl->iplb_valid = s390_gen_initial_iplb(ipl);
538 qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET);
539 /* as this is triggered by a CPU, make sure to exit the loop */
540 if (tcg_enabled()) {
541 cpu_loop_exit(cs);
545 void s390_ipl_get_reset_request(CPUState **cs, enum s390_reset *reset_type)
547 S390IPLState *ipl = get_ipl_device();
549 *cs = qemu_get_cpu(ipl->reset_cpu_index);
550 if (!*cs) {
551 /* use any CPU */
552 *cs = first_cpu;
554 *reset_type = ipl->reset_type;
557 void s390_ipl_clear_reset_request(void)
559 S390IPLState *ipl = get_ipl_device();
561 ipl->reset_type = S390_RESET_EXTERNAL;
562 /* use CPU 0 for full resets */
563 ipl->reset_cpu_index = 0;
566 static void s390_ipl_prepare_qipl(S390CPU *cpu)
568 S390IPLState *ipl = get_ipl_device();
569 uint8_t *addr;
570 uint64_t len = 4096;
572 addr = cpu_physical_memory_map(cpu->env.psa, &len, 1);
573 if (!addr || len < QIPL_ADDRESS + sizeof(QemuIplParameters)) {
574 error_report("Cannot set QEMU IPL parameters");
575 return;
577 memcpy(addr + QIPL_ADDRESS, &ipl->qipl, sizeof(QemuIplParameters));
578 cpu_physical_memory_unmap(addr, len, 1, len);
581 void s390_ipl_prepare_cpu(S390CPU *cpu)
583 S390IPLState *ipl = get_ipl_device();
584 Error *err = NULL;
586 cpu->env.psw.addr = ipl->start_addr;
587 cpu->env.psw.mask = IPL_PSW_MASK;
589 if (!ipl->kernel || ipl->iplb_valid) {
590 cpu->env.psw.addr = ipl->bios_start_addr;
591 if (!ipl->iplb_valid) {
592 ipl->iplb_valid = s390_gen_initial_iplb(ipl);
595 if (ipl->netboot) {
596 if (load_netboot_image(&err) < 0) {
597 error_report_err(err);
598 exit(1);
600 ipl->qipl.netboot_start_addr = cpu_to_be64(ipl->start_addr);
602 s390_ipl_set_boot_menu(ipl);
603 s390_ipl_prepare_qipl(cpu);
606 static void s390_ipl_reset(DeviceState *dev)
608 S390IPLState *ipl = S390_IPL(dev);
610 if (ipl->reset_type != S390_RESET_REIPL) {
611 ipl->iplb_valid = false;
612 memset(&ipl->iplb, 0, sizeof(IplParameterBlock));
616 static void s390_ipl_class_init(ObjectClass *klass, void *data)
618 DeviceClass *dc = DEVICE_CLASS(klass);
620 dc->realize = s390_ipl_realize;
621 dc->props = s390_ipl_properties;
622 dc->reset = s390_ipl_reset;
623 dc->vmsd = &vmstate_ipl;
624 set_bit(DEVICE_CATEGORY_MISC, dc->categories);
625 /* Reason: Loads the ROMs and thus can only be used one time - internally */
626 dc->user_creatable = false;
629 static const TypeInfo s390_ipl_info = {
630 .class_init = s390_ipl_class_init,
631 .parent = TYPE_DEVICE,
632 .name = TYPE_S390_IPL,
633 .instance_size = sizeof(S390IPLState),
636 static void s390_ipl_register_types(void)
638 type_register_static(&s390_ipl_info);
641 type_init(s390_ipl_register_types)