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