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