tests/qapi-schema: Improve coverage of bogus member docs
[qemu/ar7.git] / hw / s390x / ipl.c
blob7978c7d52a89f1e4df6bf9ea20cdc28fb9ebf83f
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/s390x/virtio-ccw.h"
21 #include "hw/s390x/css.h"
22 #include "ipl.h"
23 #include "qemu/error-report.h"
25 #define KERN_IMAGE_START 0x010000UL
26 #define KERN_PARM_AREA 0x010480UL
27 #define INITRD_START 0x800000UL
28 #define INITRD_PARM_START 0x010408UL
29 #define INITRD_PARM_SIZE 0x010410UL
30 #define PARMFILE_START 0x001000UL
31 #define ZIPL_IMAGE_START 0x009000UL
32 #define IPL_PSW_MASK (PSW_MASK_32 | PSW_MASK_64)
34 static bool iplb_extended_needed(void *opaque)
36 S390IPLState *ipl = S390_IPL(object_resolve_path(TYPE_S390_IPL, NULL));
38 return ipl->iplbext_migration;
41 static const VMStateDescription vmstate_iplb_extended = {
42 .name = "ipl/iplb_extended",
43 .version_id = 0,
44 .minimum_version_id = 0,
45 .needed = iplb_extended_needed,
46 .fields = (VMStateField[]) {
47 VMSTATE_UINT8_ARRAY(reserved_ext, IplParameterBlock, 4096 - 200),
48 VMSTATE_END_OF_LIST()
52 static const VMStateDescription vmstate_iplb = {
53 .name = "ipl/iplb",
54 .version_id = 0,
55 .minimum_version_id = 0,
56 .fields = (VMStateField[]) {
57 VMSTATE_UINT8_ARRAY(reserved1, IplParameterBlock, 110),
58 VMSTATE_UINT16(devno, IplParameterBlock),
59 VMSTATE_UINT8_ARRAY(reserved2, IplParameterBlock, 88),
60 VMSTATE_END_OF_LIST()
62 .subsections = (const VMStateDescription*[]) {
63 &vmstate_iplb_extended,
64 NULL
68 static const VMStateDescription vmstate_ipl = {
69 .name = "ipl",
70 .version_id = 0,
71 .minimum_version_id = 0,
72 .fields = (VMStateField[]) {
73 VMSTATE_UINT64(compat_start_addr, S390IPLState),
74 VMSTATE_UINT64(compat_bios_start_addr, S390IPLState),
75 VMSTATE_STRUCT(iplb, S390IPLState, 0, vmstate_iplb, IplParameterBlock),
76 VMSTATE_BOOL(iplb_valid, S390IPLState),
77 VMSTATE_UINT8(cssid, S390IPLState),
78 VMSTATE_UINT8(ssid, S390IPLState),
79 VMSTATE_UINT16(devno, S390IPLState),
80 VMSTATE_END_OF_LIST()
84 static S390IPLState *get_ipl_device(void)
86 return S390_IPL(object_resolve_path_type("", TYPE_S390_IPL, NULL));
89 static uint64_t bios_translate_addr(void *opaque, uint64_t srcaddr)
91 uint64_t dstaddr = *(uint64_t *) opaque;
93 * Assuming that our s390-ccw.img was linked for starting at address 0,
94 * we can simply add the destination address for the final location
96 return srcaddr + dstaddr;
99 static void s390_ipl_realize(DeviceState *dev, Error **errp)
101 S390IPLState *ipl = S390_IPL(dev);
102 uint64_t pentry = KERN_IMAGE_START;
103 int kernel_size;
104 Error *err = NULL;
106 int bios_size;
107 char *bios_filename;
110 * Always load the bios if it was enforced,
111 * even if an external kernel has been defined.
113 if (!ipl->kernel || ipl->enforce_bios) {
114 uint64_t fwbase = (MIN(ram_size, 0x80000000U) - 0x200000) & ~0xffffUL;
116 if (bios_name == NULL) {
117 bios_name = ipl->firmware;
120 bios_filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, bios_name);
121 if (bios_filename == NULL) {
122 error_setg(&err, "could not find stage1 bootloader");
123 goto error;
126 bios_size = load_elf(bios_filename, bios_translate_addr, &fwbase,
127 &ipl->bios_start_addr, NULL, NULL, 1,
128 EM_S390, 0, 0);
129 if (bios_size > 0) {
130 /* Adjust ELF start address to final location */
131 ipl->bios_start_addr += fwbase;
132 } else {
133 /* Try to load non-ELF file */
134 bios_size = load_image_targphys(bios_filename, ZIPL_IMAGE_START,
135 4096);
136 ipl->bios_start_addr = ZIPL_IMAGE_START;
138 g_free(bios_filename);
140 if (bios_size == -1) {
141 error_setg(&err, "could not load bootloader '%s'", bios_name);
142 goto error;
145 /* default boot target is the bios */
146 ipl->start_addr = ipl->bios_start_addr;
149 if (ipl->kernel) {
150 kernel_size = load_elf(ipl->kernel, NULL, NULL, &pentry, NULL,
151 NULL, 1, EM_S390, 0, 0);
152 if (kernel_size < 0) {
153 kernel_size = load_image_targphys(ipl->kernel, 0, ram_size);
155 if (kernel_size < 0) {
156 error_setg(&err, "could not load kernel '%s'", ipl->kernel);
157 goto error;
160 * Is it a Linux kernel (starting at 0x10000)? If yes, we fill in the
161 * kernel parameters here as well. Note: For old kernels (up to 3.2)
162 * we can not rely on the ELF entry point - it was 0x800 (the SALIPL
163 * loader) and it won't work. For this case we force it to 0x10000, too.
165 if (pentry == KERN_IMAGE_START || pentry == 0x800) {
166 ipl->start_addr = KERN_IMAGE_START;
167 /* Overwrite parameters in the kernel image, which are "rom" */
168 strcpy(rom_ptr(KERN_PARM_AREA), ipl->cmdline);
169 } else {
170 ipl->start_addr = pentry;
173 if (ipl->initrd) {
174 ram_addr_t initrd_offset;
175 int initrd_size;
177 initrd_offset = INITRD_START;
178 while (kernel_size + 0x100000 > initrd_offset) {
179 initrd_offset += 0x100000;
181 initrd_size = load_image_targphys(ipl->initrd, initrd_offset,
182 ram_size - initrd_offset);
183 if (initrd_size == -1) {
184 error_setg(&err, "could not load initrd '%s'", ipl->initrd);
185 goto error;
189 * we have to overwrite values in the kernel image,
190 * which are "rom"
192 stq_p(rom_ptr(INITRD_PARM_START), initrd_offset);
193 stq_p(rom_ptr(INITRD_PARM_SIZE), initrd_size);
197 * Don't ever use the migrated values, they could come from a different
198 * BIOS and therefore don't work. But still migrate the values, so
199 * QEMUs relying on it don't break.
201 ipl->compat_start_addr = ipl->start_addr;
202 ipl->compat_bios_start_addr = ipl->bios_start_addr;
203 qemu_register_reset(qdev_reset_all_fn, dev);
204 error:
205 error_propagate(errp, err);
208 static Property s390_ipl_properties[] = {
209 DEFINE_PROP_STRING("kernel", S390IPLState, kernel),
210 DEFINE_PROP_STRING("initrd", S390IPLState, initrd),
211 DEFINE_PROP_STRING("cmdline", S390IPLState, cmdline),
212 DEFINE_PROP_STRING("firmware", S390IPLState, firmware),
213 DEFINE_PROP_STRING("netboot_fw", S390IPLState, netboot_fw),
214 DEFINE_PROP_BOOL("enforce_bios", S390IPLState, enforce_bios, false),
215 DEFINE_PROP_BOOL("iplbext_migration", S390IPLState, iplbext_migration,
216 true),
217 DEFINE_PROP_END_OF_LIST(),
220 static bool s390_gen_initial_iplb(S390IPLState *ipl)
222 DeviceState *dev_st;
224 dev_st = get_boot_device(0);
225 if (dev_st) {
226 VirtioCcwDevice *virtio_ccw_dev = (VirtioCcwDevice *)
227 object_dynamic_cast(OBJECT(qdev_get_parent_bus(dev_st)->parent),
228 TYPE_VIRTIO_CCW_DEVICE);
229 SCSIDevice *sd = (SCSIDevice *) object_dynamic_cast(OBJECT(dev_st),
230 TYPE_SCSI_DEVICE);
231 VirtIONet *vn = (VirtIONet *) object_dynamic_cast(OBJECT(dev_st),
232 TYPE_VIRTIO_NET);
234 if (vn) {
235 ipl->netboot = true;
237 if (virtio_ccw_dev) {
238 CcwDevice *ccw_dev = CCW_DEVICE(virtio_ccw_dev);
240 ipl->iplb.len = cpu_to_be32(S390_IPLB_MIN_CCW_LEN);
241 ipl->iplb.blk0_len =
242 cpu_to_be32(S390_IPLB_MIN_CCW_LEN - S390_IPLB_HEADER_LEN);
243 ipl->iplb.pbt = S390_IPL_TYPE_CCW;
244 ipl->iplb.ccw.devno = cpu_to_be16(ccw_dev->sch->devno);
245 ipl->iplb.ccw.ssid = ccw_dev->sch->ssid & 3;
246 return true;
247 } else if (sd) {
248 SCSIBus *bus = scsi_bus_from_device(sd);
249 VirtIOSCSI *vdev = container_of(bus, VirtIOSCSI, bus);
250 VirtIOSCSICcw *scsi_ccw = container_of(vdev, VirtIOSCSICcw, vdev);
251 CcwDevice *ccw_dev = CCW_DEVICE(scsi_ccw);
253 ipl->iplb.len = cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN);
254 ipl->iplb.blk0_len =
255 cpu_to_be32(S390_IPLB_MIN_QEMU_SCSI_LEN - S390_IPLB_HEADER_LEN);
256 ipl->iplb.pbt = S390_IPL_TYPE_QEMU_SCSI;
257 ipl->iplb.scsi.lun = cpu_to_be32(sd->lun);
258 ipl->iplb.scsi.target = cpu_to_be16(sd->id);
259 ipl->iplb.scsi.channel = cpu_to_be16(sd->channel);
260 ipl->iplb.scsi.devno = cpu_to_be16(ccw_dev->sch->devno);
261 ipl->iplb.scsi.ssid = ccw_dev->sch->ssid & 3;
262 return true;
266 return false;
269 static int load_netboot_image(Error **errp)
271 S390IPLState *ipl = get_ipl_device();
272 char *netboot_filename;
273 MemoryRegion *sysmem = get_system_memory();
274 MemoryRegion *mr = NULL;
275 void *ram_ptr = NULL;
276 int img_size = -1;
278 mr = memory_region_find(sysmem, 0, 1).mr;
279 if (!mr) {
280 error_setg(errp, "Failed to find memory region at address 0");
281 return -1;
284 ram_ptr = memory_region_get_ram_ptr(mr);
285 if (!ram_ptr) {
286 error_setg(errp, "No RAM found");
287 goto unref_mr;
290 netboot_filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, ipl->netboot_fw);
291 if (netboot_filename == NULL) {
292 error_setg(errp, "Could not find network bootloader");
293 goto unref_mr;
296 img_size = load_elf_ram(netboot_filename, NULL, NULL, &ipl->start_addr,
297 NULL, NULL, 1, EM_S390, 0, 0, NULL, false);
299 if (img_size < 0) {
300 img_size = load_image_size(netboot_filename, ram_ptr, ram_size);
301 ipl->start_addr = KERN_IMAGE_START;
304 if (img_size < 0) {
305 error_setg(errp, "Failed to load network bootloader");
308 g_free(netboot_filename);
310 unref_mr:
311 memory_region_unref(mr);
312 return img_size;
315 static bool is_virtio_net_device(IplParameterBlock *iplb)
317 uint8_t cssid;
318 uint8_t ssid;
319 uint16_t devno;
320 uint16_t schid;
321 SubchDev *sch = NULL;
323 if (iplb->pbt != S390_IPL_TYPE_CCW) {
324 return false;
327 devno = be16_to_cpu(iplb->ccw.devno);
328 ssid = iplb->ccw.ssid & 3;
330 for (schid = 0; schid < MAX_SCHID; schid++) {
331 for (cssid = 0; cssid < MAX_CSSID; cssid++) {
332 sch = css_find_subch(1, cssid, ssid, schid);
334 if (sch && sch->devno == devno) {
335 return sch->id.cu_model == VIRTIO_ID_NET;
339 return false;
342 void s390_ipl_update_diag308(IplParameterBlock *iplb)
344 S390IPLState *ipl = get_ipl_device();
346 ipl->iplb = *iplb;
347 ipl->iplb_valid = true;
348 ipl->netboot = is_virtio_net_device(iplb);
351 IplParameterBlock *s390_ipl_get_iplb(void)
353 S390IPLState *ipl = get_ipl_device();
355 if (!ipl->iplb_valid) {
356 return NULL;
358 return &ipl->iplb;
361 void s390_reipl_request(void)
363 S390IPLState *ipl = get_ipl_device();
365 ipl->reipl_requested = true;
366 qemu_system_reset_request();
369 void s390_ipl_prepare_cpu(S390CPU *cpu)
371 S390IPLState *ipl = get_ipl_device();
372 Error *err = NULL;
374 cpu->env.psw.addr = ipl->start_addr;
375 cpu->env.psw.mask = IPL_PSW_MASK;
377 if (!ipl->kernel || ipl->iplb_valid) {
378 cpu->env.psw.addr = ipl->bios_start_addr;
379 if (!ipl->iplb_valid) {
380 ipl->iplb_valid = s390_gen_initial_iplb(ipl);
383 if (ipl->netboot) {
384 if (load_netboot_image(&err) < 0) {
385 error_report_err(err);
386 vm_stop(RUN_STATE_INTERNAL_ERROR);
388 ipl->iplb.ccw.netboot_start_addr = ipl->start_addr;
392 static void s390_ipl_reset(DeviceState *dev)
394 S390IPLState *ipl = S390_IPL(dev);
396 if (!ipl->reipl_requested) {
397 ipl->iplb_valid = false;
398 memset(&ipl->iplb, 0, sizeof(IplParameterBlock));
400 ipl->reipl_requested = false;
403 static void s390_ipl_class_init(ObjectClass *klass, void *data)
405 DeviceClass *dc = DEVICE_CLASS(klass);
407 dc->realize = s390_ipl_realize;
408 dc->props = s390_ipl_properties;
409 dc->reset = s390_ipl_reset;
410 dc->vmsd = &vmstate_ipl;
411 set_bit(DEVICE_CATEGORY_MISC, dc->categories);
414 static const TypeInfo s390_ipl_info = {
415 .class_init = s390_ipl_class_init,
416 .parent = TYPE_DEVICE,
417 .name = TYPE_S390_IPL,
418 .instance_size = sizeof(S390IPLState),
421 static void s390_ipl_register_types(void)
423 type_register_static(&s390_ipl_info);
426 type_init(s390_ipl_register_types)