1 /* 2 * bootloader support 3 * 4 * Copyright IBM, Corp. 2012 5 * 6 * Authors: 7 * Christian Borntraeger <borntraeger@de.ibm.com> 8 * 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. 11 * 12 */ 13 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" 30 31 #define KERN_IMAGE_START 0x010000UL 32 #define KERN_PARM_AREA 0x010480UL 33 #define INITRD_START 0x800000UL 34 #define INITRD_PARM_START 0x010408UL 35 #define INITRD_PARM_SIZE 0x010410UL 36 #define PARMFILE_START 0x001000UL 37 #define ZIPL_IMAGE_START 0x009000UL 38 #define IPL_PSW_MASK (PSW_MASK_32 | PSW_MASK_64) 39 40 static bool iplb_extended_needed(void *opaque) 41 { 42 S390IPLState *ipl = S390_IPL(object_resolve_path(TYPE_S390_IPL, NULL)); 43 44 return ipl->iplbext_migration; 45 } 46 47 static const VMStateDescription vmstate_iplb_extended = { 48 .name = "ipl/iplb_extended", 49 .version_id = 0, 50 .minimum_version_id = 0, 51 .needed = iplb_extended_needed, 52 .fields = (VMStateField[]) { 53 VMSTATE_UINT8_ARRAY(reserved_ext, IplParameterBlock, 4096 - 200), 54 VMSTATE_END_OF_LIST() 55 } 56 }; 57 58 static const VMStateDescription vmstate_iplb = { 59 .name = "ipl/iplb", 60 .version_id = 0, 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), 66 VMSTATE_END_OF_LIST() 67 }, 68 .subsections = (const VMStateDescription*[]) { 69 &vmstate_iplb_extended, 70 NULL 71 } 72 }; 73 74 static const VMStateDescription vmstate_ipl = { 75 .name = "ipl", 76 .version_id = 0, 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), 86 VMSTATE_END_OF_LIST() 87 } 88 }; 89 90 static S390IPLState *get_ipl_device(void) 91 { 92 return S390_IPL(object_resolve_path_type("", TYPE_S390_IPL, NULL)); 93 } 94 95 static uint64_t bios_translate_addr(void *opaque, uint64_t srcaddr) 96 { 97 uint64_t dstaddr = *(uint64_t *) opaque; 98 /* 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 101 */ 102 return srcaddr + dstaddr; 103 } 104 105 static void s390_ipl_realize(DeviceState *dev, Error **errp) 106 { 107 S390IPLState *ipl = S390_IPL(dev); 108 uint64_t pentry = KERN_IMAGE_START; 109 int kernel_size; 110 Error *err = NULL; 111 112 int bios_size; 113 char *bios_filename; 114 115 /* 116 * Always load the bios if it was enforced, 117 * even if an external kernel has been defined. 118 */ 119 if (!ipl->kernel || ipl->enforce_bios) { 120 uint64_t fwbase = (MIN(ram_size, 0x80000000U) - 0x200000) & ~0xffffUL; 121 122 if (bios_name == NULL) { 123 bios_name = ipl->firmware; 124 } 125 126 bios_filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, bios_name); 127 if (bios_filename == NULL) { 128 error_setg(&err, "could not find stage1 bootloader"); 129 goto error; 130 } 131 132 bios_size = load_elf(bios_filename, bios_translate_addr, &fwbase, 133 &ipl->bios_start_addr, NULL, NULL, 1, 134 EM_S390, 0, 0); 135 if (bios_size > 0) { 136 /* Adjust ELF start address to final location */ 137 ipl->bios_start_addr += fwbase; 138 } else { 139 /* Try to load non-ELF file */ 140 bios_size = load_image_targphys(bios_filename, ZIPL_IMAGE_START, 141 4096); 142 ipl->bios_start_addr = ZIPL_IMAGE_START; 143 } 144 g_free(bios_filename); 145 146 if (bios_size == -1) { 147 error_setg(&err, "could not load bootloader '%s'", bios_name); 148 goto error; 149 } 150 151 /* default boot target is the bios */ 152 ipl->start_addr = ipl->bios_start_addr; 153 } 154 155 if (ipl->kernel) { 156 kernel_size = load_elf(ipl->kernel, NULL, NULL, &pentry, NULL, 157 NULL, 1, EM_S390, 0, 0); 158 if (kernel_size < 0) { 159 kernel_size = load_image_targphys(ipl->kernel, 0, ram_size); 160 } 161 if (kernel_size < 0) { 162 error_setg(&err, "could not load kernel '%s'", ipl->kernel); 163 goto error; 164 } 165 /* 166 * Is it a Linux kernel (starting at 0x10000)? If yes, we fill in the 167 * kernel parameters here as well. Note: For old kernels (up to 3.2) 168 * we can not rely on the ELF entry point - it was 0x800 (the SALIPL 169 * loader) and it won't work. For this case we force it to 0x10000, too. 170 */ 171 if (pentry == KERN_IMAGE_START || pentry == 0x800) { 172 ipl->start_addr = KERN_IMAGE_START; 173 /* Overwrite parameters in the kernel image, which are "rom" */ 174 strcpy(rom_ptr(KERN_PARM_AREA), ipl->cmdline); 175 } else { 176 ipl->start_addr = pentry; 177 } 178 179 if (ipl->initrd) { 180 ram_addr_t initrd_offset; 181 int initrd_size; 182 183 initrd_offset = INITRD_START; 184 while (kernel_size + 0x100000 > initrd_offset) { 185 initrd_offset += 0x100000; 186 } 187 initrd_size = load_image_targphys(ipl->initrd, initrd_offset, 188 ram_size - initrd_offset); 189 if (initrd_size == -1) { 190 error_setg(&err, "could not load initrd '%s'", ipl->initrd); 191 goto error; 192 } 193 194 /* 195 * we have to overwrite values in the kernel image, 196 * which are "rom" 197 */ 198 stq_p(rom_ptr(INITRD_PARM_START), initrd_offset); 199 stq_p(rom_ptr(INITRD_PARM_SIZE), initrd_size); 200 } 201 } 202 /* 203 * Don't ever use the migrated values, they could come from a different 204 * BIOS and therefore don't work. But still migrate the values, so 205 * QEMUs relying on it don't break. 206 */ 207 ipl->compat_start_addr = ipl->start_addr; 208 ipl->compat_bios_start_addr = ipl->bios_start_addr; 209 qemu_register_reset(qdev_reset_all_fn, dev); 210 error: 211 error_propagate(errp, err); 212 } 213 214 static Property s390_ipl_properties[] = { 215 DEFINE_PROP_STRING("kernel", S390IPLState, kernel), 216 DEFINE_PROP_STRING("initrd", S390IPLState, initrd), 217 DEFINE_PROP_STRING("cmdline", S390IPLState, cmdline), 218 DEFINE_PROP_STRING("firmware", S390IPLState, firmware), 219 DEFINE_PROP_STRING("netboot_fw", S390IPLState, netboot_fw), 220 DEFINE_PROP_BOOL("enforce_bios", S390IPLState, enforce_bios, false), 221 DEFINE_PROP_BOOL("iplbext_migration", S390IPLState, iplbext_migration, 222 true), 223 DEFINE_PROP_END_OF_LIST(), 224 }; 225 226 static void s390_ipl_set_boot_menu(S390IPLState *ipl) 227 { 228 QemuOptsList *plist = qemu_find_opts("boot-opts"); 229 QemuOpts *opts = QTAILQ_FIRST(&plist->head); 230 uint8_t *flags = &ipl->qipl.qipl_flags; 231 uint32_t *timeout = &ipl->qipl.boot_menu_timeout; 232 const char *tmp; 233 unsigned long splash_time = 0; 234 235 if (!get_boot_device(0)) { 236 if (boot_menu) { 237 error_report("boot menu requires a bootindex to be specified for " 238 "the IPL device"); 239 } 240 return; 241 } 242 243 switch (ipl->iplb.pbt) { 244 case S390_IPL_TYPE_CCW: 245 /* In the absence of -boot menu, use zipl parameters */ 246 if (!qemu_opt_get(opts, "menu")) { 247 *flags |= QIPL_FLAG_BM_OPTS_ZIPL; 248 return; 249 } 250 break; 251 case S390_IPL_TYPE_QEMU_SCSI: 252 break; 253 default: 254 if (boot_menu) { 255 error_report("boot menu is not supported for this device type"); 256 } 257 return; 258 } 259 260 if (!boot_menu) { 261 return; 262 } 263 264 *flags |= QIPL_FLAG_BM_OPTS_CMD; 265 266 tmp = qemu_opt_get(opts, "splash-time"); 267 268 if (tmp && qemu_strtoul(tmp, NULL, 10, &splash_time)) { 269 error_report("splash-time is invalid, forcing it to 0"); 270 *timeout = 0; 271 return; 272 } 273 274 if (splash_time > 0xffffffff) { 275 error_report("splash-time is too large, forcing it to max value"); 276 *timeout = 0xffffffff; 277 return; 278 } 279 280 *timeout = cpu_to_be32(splash_time); 281 } 282 283 static CcwDevice *s390_get_ccw_device(DeviceState *dev_st) 284 { 285 CcwDevice *ccw_dev = NULL; 286 287 if (dev_st) { 288 VirtioCcwDevice *virtio_ccw_dev = (VirtioCcwDevice *) 289 object_dynamic_cast(OBJECT(qdev_get_parent_bus(dev_st)->parent), 290 TYPE_VIRTIO_CCW_DEVICE); 291 if (virtio_ccw_dev) { 292 ccw_dev = CCW_DEVICE(virtio_ccw_dev); 293 } else { 294 SCSIDevice *sd = (SCSIDevice *) 295 object_dynamic_cast(OBJECT(dev_st), 296 TYPE_SCSI_DEVICE); 297 if (sd) { 298 SCSIBus *bus = scsi_bus_from_device(sd); 299 VirtIOSCSI *vdev = container_of(bus, VirtIOSCSI, bus); 300 VirtIOSCSICcw *scsi_ccw = container_of(vdev, VirtIOSCSICcw, 301 vdev); 302 303 ccw_dev = (CcwDevice *)object_dynamic_cast(OBJECT(scsi_ccw), 304 TYPE_CCW_DEVICE); 305 } 306 } 307 } 308 return ccw_dev; 309 } 310 311 static bool s390_gen_initial_iplb(S390IPLState *ipl) 312 { 313 DeviceState *dev_st; 314 CcwDevice *ccw_dev = NULL; 315 316 dev_st = get_boot_device(0); 317 if (dev_st) { 318 ccw_dev = s390_get_ccw_device(dev_st); 319 } 320 321 /* 322 * Currently allow IPL only from CCW devices. 323 */ 324 if (ccw_dev) { 325 SCSIDevice *sd = (SCSIDevice *) object_dynamic_cast(OBJECT(dev_st), 326 TYPE_SCSI_DEVICE); 327 328 if (sd) { 329 ipl->iplb.len = cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN); 330 ipl->iplb.blk0_len = 331 cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN - S390_IPLB_HEADER_LEN); 332 ipl->iplb.pbt = S390_IPL_TYPE_QEMU_SCSI; 333 ipl->iplb.scsi.lun = cpu_to_be32(sd->lun); 334 ipl->iplb.scsi.target = cpu_to_be16(sd->id); 335 ipl->iplb.scsi.channel = cpu_to_be16(sd->channel); 336 ipl->iplb.scsi.devno = cpu_to_be16(ccw_dev->sch->devno); 337 ipl->iplb.scsi.ssid = ccw_dev->sch->ssid & 3; 338 } else { 339 VirtIONet *vn = (VirtIONet *) object_dynamic_cast(OBJECT(dev_st), 340 TYPE_VIRTIO_NET); 341 342 ipl->iplb.len = cpu_to_be32(S390_IPLB_MIN_CCW_LEN); 343 ipl->iplb.blk0_len = 344 cpu_to_be32(S390_IPLB_MIN_CCW_LEN - S390_IPLB_HEADER_LEN); 345 ipl->iplb.pbt = S390_IPL_TYPE_CCW; 346 ipl->iplb.ccw.devno = cpu_to_be16(ccw_dev->sch->devno); 347 ipl->iplb.ccw.ssid = ccw_dev->sch->ssid & 3; 348 349 if (vn) { 350 ipl->netboot = true; 351 } 352 } 353 354 if (!s390_ipl_set_loadparm(ipl->iplb.loadparm)) { 355 ipl->iplb.flags |= DIAG308_FLAGS_LP_VALID; 356 } 357 358 return true; 359 } 360 361 return false; 362 } 363 364 int s390_ipl_set_loadparm(uint8_t *loadparm) 365 { 366 MachineState *machine = MACHINE(qdev_get_machine()); 367 char *lp = object_property_get_str(OBJECT(machine), "loadparm", NULL); 368 369 if (lp) { 370 int i; 371 372 /* lp is an uppercase string without leading/embedded spaces */ 373 for (i = 0; i < 8 && lp[i]; i++) { 374 loadparm[i] = ascii2ebcdic[(uint8_t) lp[i]]; 375 } 376 377 if (i < 8) { 378 memset(loadparm + i, 0x40, 8 - i); /* fill with EBCDIC spaces */ 379 } 380 381 g_free(lp); 382 return 0; 383 } 384 385 return -1; 386 } 387 388 static int load_netboot_image(Error **errp) 389 { 390 S390IPLState *ipl = get_ipl_device(); 391 char *netboot_filename; 392 MemoryRegion *sysmem = get_system_memory(); 393 MemoryRegion *mr = NULL; 394 void *ram_ptr = NULL; 395 int img_size = -1; 396 397 mr = memory_region_find(sysmem, 0, 1).mr; 398 if (!mr) { 399 error_setg(errp, "Failed to find memory region at address 0"); 400 return -1; 401 } 402 403 ram_ptr = memory_region_get_ram_ptr(mr); 404 if (!ram_ptr) { 405 error_setg(errp, "No RAM found"); 406 goto unref_mr; 407 } 408 409 netboot_filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, ipl->netboot_fw); 410 if (netboot_filename == NULL) { 411 error_setg(errp, "Could not find network bootloader '%s'", 412 ipl->netboot_fw); 413 goto unref_mr; 414 } 415 416 img_size = load_elf_ram(netboot_filename, NULL, NULL, &ipl->start_addr, 417 NULL, NULL, 1, EM_S390, 0, 0, NULL, false); 418 419 if (img_size < 0) { 420 img_size = load_image_size(netboot_filename, ram_ptr, ram_size); 421 ipl->start_addr = KERN_IMAGE_START; 422 } 423 424 if (img_size < 0) { 425 error_setg(errp, "Failed to load network bootloader"); 426 } 427 428 g_free(netboot_filename); 429 430 unref_mr: 431 memory_region_unref(mr); 432 return img_size; 433 } 434 435 static bool is_virtio_ccw_device_of_type(IplParameterBlock *iplb, 436 int virtio_id) 437 { 438 uint8_t cssid; 439 uint8_t ssid; 440 uint16_t devno; 441 uint16_t schid; 442 SubchDev *sch = NULL; 443 444 if (iplb->pbt != S390_IPL_TYPE_CCW) { 445 return false; 446 } 447 448 devno = be16_to_cpu(iplb->ccw.devno); 449 ssid = iplb->ccw.ssid & 3; 450 451 for (schid = 0; schid < MAX_SCHID; schid++) { 452 for (cssid = 0; cssid < MAX_CSSID; cssid++) { 453 sch = css_find_subch(1, cssid, ssid, schid); 454 455 if (sch && sch->devno == devno) { 456 return sch->id.cu_model == virtio_id; 457 } 458 } 459 } 460 return false; 461 } 462 463 static bool is_virtio_net_device(IplParameterBlock *iplb) 464 { 465 return is_virtio_ccw_device_of_type(iplb, VIRTIO_ID_NET); 466 } 467 468 static bool is_virtio_scsi_device(IplParameterBlock *iplb) 469 { 470 return is_virtio_ccw_device_of_type(iplb, VIRTIO_ID_SCSI); 471 } 472 473 void s390_ipl_update_diag308(IplParameterBlock *iplb) 474 { 475 S390IPLState *ipl = get_ipl_device(); 476 477 ipl->iplb = *iplb; 478 ipl->iplb_valid = true; 479 ipl->netboot = is_virtio_net_device(iplb); 480 } 481 482 IplParameterBlock *s390_ipl_get_iplb(void) 483 { 484 S390IPLState *ipl = get_ipl_device(); 485 486 if (!ipl->iplb_valid) { 487 return NULL; 488 } 489 return &ipl->iplb; 490 } 491 492 void s390_ipl_reset_request(CPUState *cs, enum s390_reset reset_type) 493 { 494 S390IPLState *ipl = get_ipl_device(); 495 496 if (reset_type == S390_RESET_EXTERNAL || reset_type == S390_RESET_REIPL) { 497 /* use CPU 0 for full resets */ 498 ipl->reset_cpu_index = 0; 499 } else { 500 ipl->reset_cpu_index = cs->cpu_index; 501 } 502 ipl->reset_type = reset_type; 503 504 if (reset_type == S390_RESET_REIPL && 505 ipl->iplb_valid && 506 !ipl->netboot && 507 ipl->iplb.pbt == S390_IPL_TYPE_CCW && 508 is_virtio_scsi_device(&ipl->iplb)) { 509 CcwDevice *ccw_dev = s390_get_ccw_device(get_boot_device(0)); 510 511 if (ccw_dev && 512 cpu_to_be16(ccw_dev->sch->devno) == ipl->iplb.ccw.devno && 513 (ccw_dev->sch->ssid & 3) == ipl->iplb.ccw.ssid) { 514 /* 515 * this is the original boot device's SCSI 516 * so restore IPL parameter info from it 517 */ 518 ipl->iplb_valid = s390_gen_initial_iplb(ipl); 519 } 520 } 521 qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET); 522 /* as this is triggered by a CPU, make sure to exit the loop */ 523 if (tcg_enabled()) { 524 cpu_loop_exit(cs); 525 } 526 } 527 528 void s390_ipl_get_reset_request(CPUState **cs, enum s390_reset *reset_type) 529 { 530 S390IPLState *ipl = get_ipl_device(); 531 532 *cs = qemu_get_cpu(ipl->reset_cpu_index); 533 if (!*cs) { 534 /* use any CPU */ 535 *cs = first_cpu; 536 } 537 *reset_type = ipl->reset_type; 538 } 539 540 void s390_ipl_clear_reset_request(void) 541 { 542 S390IPLState *ipl = get_ipl_device(); 543 544 ipl->reset_type = S390_RESET_EXTERNAL; 545 /* use CPU 0 for full resets */ 546 ipl->reset_cpu_index = 0; 547 } 548 549 static void s390_ipl_prepare_qipl(S390CPU *cpu) 550 { 551 S390IPLState *ipl = get_ipl_device(); 552 uint8_t *addr; 553 uint64_t len = 4096; 554 555 addr = cpu_physical_memory_map(cpu->env.psa, &len, 1); 556 if (!addr || len < QIPL_ADDRESS + sizeof(QemuIplParameters)) { 557 error_report("Cannot set QEMU IPL parameters"); 558 return; 559 } 560 memcpy(addr + QIPL_ADDRESS, &ipl->qipl, sizeof(QemuIplParameters)); 561 cpu_physical_memory_unmap(addr, len, 1, len); 562 } 563 564 void s390_ipl_prepare_cpu(S390CPU *cpu) 565 { 566 S390IPLState *ipl = get_ipl_device(); 567 Error *err = NULL; 568 569 cpu->env.psw.addr = ipl->start_addr; 570 cpu->env.psw.mask = IPL_PSW_MASK; 571 572 if (!ipl->kernel || ipl->iplb_valid) { 573 cpu->env.psw.addr = ipl->bios_start_addr; 574 if (!ipl->iplb_valid) { 575 ipl->iplb_valid = s390_gen_initial_iplb(ipl); 576 } 577 } 578 if (ipl->netboot) { 579 if (load_netboot_image(&err) < 0) { 580 error_report_err(err); 581 exit(1); 582 } 583 ipl->qipl.netboot_start_addr = cpu_to_be64(ipl->start_addr); 584 } 585 s390_ipl_set_boot_menu(ipl); 586 s390_ipl_prepare_qipl(cpu); 587 } 588 589 static void s390_ipl_reset(DeviceState *dev) 590 { 591 S390IPLState *ipl = S390_IPL(dev); 592 593 if (ipl->reset_type != S390_RESET_REIPL) { 594 ipl->iplb_valid = false; 595 memset(&ipl->iplb, 0, sizeof(IplParameterBlock)); 596 } 597 } 598 599 static void s390_ipl_class_init(ObjectClass *klass, void *data) 600 { 601 DeviceClass *dc = DEVICE_CLASS(klass); 602 603 dc->realize = s390_ipl_realize; 604 dc->props = s390_ipl_properties; 605 dc->reset = s390_ipl_reset; 606 dc->vmsd = &vmstate_ipl; 607 set_bit(DEVICE_CATEGORY_MISC, dc->categories); 608 /* Reason: Loads the ROMs and thus can only be used one time - internally */ 609 dc->user_creatable = false; 610 } 611 612 static const TypeInfo s390_ipl_info = { 613 .class_init = s390_ipl_class_init, 614 .parent = TYPE_DEVICE, 615 .name = TYPE_S390_IPL, 616 .instance_size = sizeof(S390IPLState), 617 }; 618 619 static void s390_ipl_register_types(void) 620 { 621 type_register_static(&s390_ipl_info); 622 } 623 624 type_init(s390_ipl_register_types) 625