docs/development/dev-environment.md

7 **Prerequisites:** Current Linux, Mac, or Windows system
15 walk you through utilizing bitbake to build OpenBMC firmware and boot it in
18 Bitbake is the build engine used by Yocto and OpenBMC to build its custom Linux
19 distribution for a system. QEMU is a software emulator that can be used to run
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.
33 The recommended OpenBMC development environment is the latest Ubuntu LTS
41    [VMware](https://www.vmware.com/products/workstation-player/workstation-player-evaluation.html)
49    OpenBMC continuous integration utilizes docker to build its images. This is
51    [build-setup.sh](https://github.com/openbmc/openbmc-build-scripts/blob/master/build-setup.sh)
52    for a reference on the script CI uses to build an appropriate docker
56 2. Install the latest Ubuntu LTS release
58    The majority of OpenBMC development community uses Ubuntu. The qemu below is
59    built on the latest Ubuntu LTS release but whatever is most recent _should_
61    these are not tested nearly as much by the core OpenBMC team as Ubuntu.
63    **VirtualBox Tips** - You'll want copy/paste working between your VM and
66    - Devices -> Insert Guest Additions CD Image (install)
67    - Devices -> Shared Clipboard -> Bidirectional
68    - reboot (the VM)
73    [Prerequisite](https://github.com/openbmc/openbmc/blob/master/README.md#1-prerequisite)
76    **Note** - In Ubuntu, a "sudo apt-get update" will probably be needed before
82 OpenBMC image. Future tutorials will build on this by having you customize the
85 …job/latest-master/label=docker-builder,target=romulus/lastSuccessfulBuild/artifact/openbmc/build/t…
87 [Download and Start QEMU Session](#download-and-start-qemu-session) section.
95 2. Build the Romulus OpenBMC Image (note this will take 30 - 120 minutes
100    bitbake obmc-phosphor-image
104 `build/tmp/deploy/images/romulus/obmc-phosphor-image-romulus.static.mtd`
112 …wget https://jenkins.openbmc.org/job/latest-qemu-x86/lastSuccessfulBuild/artifact/qemu/build/qemu-…
114    chmod u+x qemu-system-arm
117 2. Copy the image generated by the build to your current directory
120    cp ./tmp/deploy/images/romulus/obmc-phosphor-image-romulus.static.mtd ./
125    **Note** - For REST, SSH and IPMI to work into your QEMU session, you must
131    ./qemu-system-arm -m 256 -M romulus-bmc -nographic \
132        -drive file=./obmc-phosphor-image-romulus.static.mtd,format=raw,if=mtd \
133        -net nic \
134 …-net user,hostfwd=:127.0.0.1:2222-:22,hostfwd=:127.0.0.1:2443-:443,hostfwd=udp:127.0.0.1:2623-:623…
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 user,hostfwd=:127.0.0.1:22-:22,hostfwd=:127.0.0.1:443-:443,hostfwd=tcp:127.0.0.1:80-:80,hostf…
147 4. Wait for your QEMU-based BMC to boot
151 5. Check the system state
168    Run these from the system you started QEMU on
171    ssh root@localhost -p 2222
191 - set up a bmc build environment
194 source setup romulus myBuild/build
197 - add the qemu x86 open embedded machine for testing
203 - Make the changes to the build (ie devtool modify bmcweb, devtool add gdb)
209 - build open bmc for the qemu x86 machine
212 MACHINE=qemux86 bitbake obmc-phosphor-image
215 - run qemu they way yocto provides
218 runqemu myBuild/build/tmp/deploy/images/qemux86/ nographic \
219     qemuparams="-m 2048"
222 - after that the all the a TAP network interface is added, and protocol like