docs/development/dev-environment.md

7 **Prerequisites:** Current Linux, Mac, or Windows system
16 [QEMU](https://www.qemu.org/).
19 distribution for a system. QEMU is a software emulator that can be used to run
23 development environment, building OpenBMC, and running that image in QEMU.
25 For testing purposes, this guide uses the Romulus system as the default because
26 this is the system tested for each CI job, which means it's the most stable.
41    [VMware](https://www.vmware.com/products/workstation-player/workstation-player-evaluation.html)
51    [build-setup.sh](https://github.com/openbmc/openbmc-build-scripts/blob/master/build-setup.sh)
58    The majority of OpenBMC development community uses Ubuntu. The qemu below is
63    **VirtualBox Tips** - You'll want copy/paste working between your VM and
65    - Devices -> Insert Guest Additions CD Image (install)
66    - Devices -> Shared Clipboard -> Bidirectional
67    - reboot (the VM)
72    [Prerequisite](https://github.com/openbmc/openbmc/blob/master/README.md#1-prerequisite)
75    **Note** - In Ubuntu, a "sudo apt-get update" will probably be needed before
82 image. If you would like to skip the building and just try out OpenBMC and QEMU
84 …job/latest-master/label=docker-builder,target=romulus/lastSuccessfulBuild/artifact/openbmc/build/t…
86 [Download and Start QEMU Session](#download-and-start-qemu-session) section.
94 2. Build the Romulus OpenBMC Image (note this will take 30 - 120 minutes
99    bitbake obmc-phosphor-image
103 `build/tmp/deploy/images/romulus/obmc-phosphor-image-romulus.static.mtd`
106 ## Download and Start QEMU Session
108 1. Download latest openbmc/qemu fork of QEMU application
111 …wget https://jenkins.openbmc.org/job/latest-qemu-x86/lastSuccessfulBuild/artifact/qemu/build/qemu-…
113    chmod u+x qemu-system-arm
119    cp ./tmp/deploy/images/romulus/obmc-phosphor-image-romulus.static.mtd ./
122 3. Start QEMU with the Romulus image
124    **Note** - For REST, SSH and IPMI to work into your QEMU session, you must
125    connect up some host ports to the REST, SSH and IPMI ports in your QEMU
130    ./qemu-system-arm -m 256 -M romulus-bmc -nographic \
131       -drive file=./obmc-phosphor-image-romulus.static.mtd,format=raw,if=mtd \
132       -net nic \
133 …-net user,hostfwd=:127.0.0.1:2222-:22,hostfwd=:127.0.0.1:2443-:443,hostfwd=udp:127.0.0.1:2623-:623…
137    ports, then you would start QEMU with the following.
141    ./qemu-system-arm -m 256 -machine romulus-bmc -nographic \
142     -drive file=./obmc-phosphor-image-romulus.static.mtd,format=raw,if=mtd \
143     -net nic \
144     -net
145 …-:22,hostfwd=:127.0.0.1:443-:443,hostfwd=tcp:127.0.0.1:80-:80,hostfwd=tcp:127.0.0.1:2200-:2200,hos…
149 4. Wait for your QEMU-based BMC to boot
153 5. Check the system state
166    **Note** To exit (and kill) your QEMU session run: `ctrl+a x`
170    Run these from the system you started QEMU on
173    ssh root@localhost -p 2222
176    Login is the same as what was used above for the default QEMU login.
178 You've now built an OpenBMC distribution and booted it in QEMU!
180 ## Alternative yocto QEMU
182 yocto has tools for building and running qemu. These tools avoid some of the
184 binaries. Using yocto qemu also uses the
193 - set up a bmc build environment
199 - add the qemu x86 open embedded machine for testing
205 - Make the changes to the build (ie devtool modify bmcweb, devtool add gdb)
211 - build open bmc for the qemu x86 machine
214 MACHINE=qemux86 bitbake obmc-phosphor-image
217 - run qemu they way yocto provides
221     qemuparams="-m 2048"
224 - after that the all the a TAP network interface is added, and protocol like
231 re-downloading and re-building, saving time and disk.
236    mkdir -p "${XDG_CACHE_HOME}/bitbake/downloads" "${XDG_CACHE_HOME}/bitbake/sstate"