summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/migration.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/migration.xml')
-rw-r--r--documentation/ref-manual/migration.xml75
1 files changed, 75 insertions, 0 deletions
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index 4cf72612bf..2330d5e895 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -3491,6 +3491,81 @@
3491 <filename>runqemu</filename> has been ported to Python and has 3491 <filename>runqemu</filename> has been ported to Python and has
3492 changed behavior in some cases. 3492 changed behavior in some cases.
3493 </para> 3493 </para>
3494
3495 <para>
3496 The new <filename>runqemu</filename> is a Python script.
3497 The script requires a configuration file in the following
3498 form in order to boot the BSP:
3499 <literallayout class='monospaced'>
3500 <replaceable>image-name</replaceable>-<replaceable>machine</replaceable>.qemuboot.conf
3501 </literallayout>
3502 Machine knowledge is no longer hardcoded into
3503 <filename>runqemu</filename>.
3504 You can use the <filename>qemuboot</filename> configuration file
3505 to define the BSP's own arguments and to make it bootable
3506 with <filename>runqemu</filename>.
3507 <note>
3508 Previous usage patterns are continued to be supported.
3509 </note>
3510 The <filename>qemuboot.conf</filename> file is generated by the
3511 <filename>qemuboot</filename>
3512 class when the root filesystem is being build (i.e.
3513 build rootfs).
3514 QEMU boot arguments can be set in BSP's configuration file and
3515 the <filename>qemuboot</filename> class will save them to
3516 <filename>qemuboot.conf</filename>.
3517 </para>
3518
3519 <para>
3520 Following is a list of variables that can be set in configuration
3521 files such as <filename>bsp.conf</filename> to enable the BSP
3522 to be booted by <filename>runqemu</filename>:
3523 <note>
3524 "QB" means "QEMU Boot".
3525 </note>
3526 <literallayout class='monospaced'>
3527 QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386")
3528 QB_OPT_APPEND: Options to append to QEMU (e.g. "-show-cursor")
3529 QB_DEFAULT_KERNEL: Default kernel to boot (e.g. "bzImage")
3530 QB_DEFAULT_FSTYPE: Default FSTYPE to boot (e.g. "ext4")
3531 QB_MEM: Memory (e.g. "-m 512")
3532 QB_MACHINE: QEMU machine (e.g. "-machine virt")
3533 QB_CPU: QEMU cpu (e.g. "-cpu qemu32")
3534 QB_CPU_KVM: Similar to QB_CPU except used for kvm support (e.g. "-cpu kvm64")
3535 QB_KERNEL_CMDLINE_APPEND: Options to append to the kernel's -append
3536 option (e.g. "console=ttyS0 console=tty")
3537 QB_DTB: QEMU dtb name
3538 QB_AUDIO_DRV: QEMU audio driver (e.g. "alsa", set it when support audio)
3539 QB_AUDIO_OPT: QEMU audio option (e.g. "-soundhw ac97,es1370"), which is used
3540 when QB_AUDIO_DRV is set.
3541 QB_KERNEL_ROOT: Kernel's root (e.g. /dev/vda)
3542 QB_TAP_OPT: Network option for 'tap' mode (e.g.
3543 "-netdev tap,id=net0,ifname=@TAP@,script=no,downscript=no -device virtio-net-device,netdev=net0").
3544 runqemu will replace "@TAP@" with the one that is used, such as tap0, tap1 ...
3545 QB_SLIRP_OPT: Network option for SLIRP mode (e.g. "-netdev user,id=net0 -device virtio-net-device,netdev=net0")
3546 QB_ROOTFS_OPT: Used as rootfs (e.g.
3547 "-drive id=disk0,file=@ROOTFS@,if=none,format=raw -device virtio-blk-device,drive=disk0").
3548 runqemu will replace "@ROOTFS@" with the one which is used, such as
3549 core-image-minimal-qemuarm64.ext4.
3550 QB_SERIAL_OPT: Serial port (e.g. "-serial mon:stdio")
3551 QB_TCPSERIAL_OPT: tcp serial port option (e.g.
3552 " -device virtio-serial-device -chardev socket,id=virtcon,port=@PORT@,host=127.0.0.1 -device virtconsole,chardev=virtcon"
3553 runqemu will replace "@PORT@" with the port number which is used.
3554 </literallayout>
3555 </para>
3556
3557 <para>
3558 To use <filename>runqemu</filename>, set
3559 <link linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link>
3560 as follows and run <filename>runqemu</filename>:
3561 <note>
3562 For command-line syntax, use
3563 <filename>runqemu help</filename>.
3564 </note>
3565 <literallayout class='monospaced'>
3566 IMAGE_CLASSES += "qemuboot"
3567 </literallayout>
3568 </para>
3494 </section> 3569 </section>
3495 3570
3496 <section id='migration-2.2-default-linker-hash-style-changed'> 3571 <section id='migration-2.2-default-linker-hash-style-changed'>