openbmc/docs/cheatsheet.md

11  meta-phosphor/common/recipes-kernel/linux/linux-obmc_X.Y.bb
31 bitbake obmc-phosphor-image
41 bitbake obmc-phosphor-image
49 meta-<layer>/meta-<system>/conf/machine/machineA.conf
50 meta-<layer>/meta-<system>/conf/machine/machineB.conf
59 bitbake obmc-phosphor-image
69 bitbake -c populate_sdk obmc-phosphor-image
70 ./tmp/deploy/sdk/openbmc-phosphor-glibc-x86_64-obmc-phosphor-image-armv5e-toolchain-2.1.sh
77 . /opt/openbmc-phosphor/2.1/environment-setup-armv5e-openbmc-linux-gnueabi
82 You can reconfigure your build by removing the build/conf dir:
85 rm -rf build/conf
90 ## Useful D-Bus CLI tools
96 Great tool to issue D-Bus commands via cli. That way you don't have to wait for
97 the code to hit the path on the system. Great for running commands with QEMU
106 - \<parameters\> example : sssay "t1" "t2" "t3" 2 2 3
108 ## Using QEMU
110 QEMU has a palmetto-bmc machine (as of v2.6.0) which implements the core devices
112 [maintains a tree](https://github.com/openbmc/qemu) with patches on their way
113 upstream or temporary work-arounds that add to QEMU's capabilities where
117 qemu-system-arm -m 256 -M palmetto-bmc -nographic \
118     -drive file=<path>/flash-palmetto,format=raw,if=mtd \
119     -net nic \
120     -net user,hostfwd=:127.0.0.1:2222-:22,hostfwd=:127.0.0.1:2443-:443,hostname=qemu
123 If you get an error you likely need to build QEMU (see the section in this
124 document). If no error and QEMU starts up just change the port when interacting
128 curl -c cjar -b cjar -k -H "Content-Type: application/json" \
129     -X POST https://localhost:2443/login -d "{\"data\": [ \"root\", \"0penBmc\" ] }"
135 ssh -p 2222 root@localhost
138 To quit, type `Ctrl-a c` to switch to the QEMU monitor, and then `quit` to exit.
140 ## Building QEMU
143 git clone https://github.com/openbmc/qemu.git
144 cd qemu
145 git submodule update --init dtc
148 ../configure --target-list=arm-softmmu
152 Built file will be located at: `arm-softmmu/qemu-system-arm`
157 your qemu session runs in the bridges subnet so no port forwarding is needed.
161 apt-get install libvirt libvirt-bin bridge-utils uml-utilities qemu-system-common
163 qemu-system-arm -m 256 -M palmetto-bmc -nographic \
164     -drive file=<path>/flash-palmetto,format=raw,if=mtd \
165     -net nic,macaddr=C0:FF:EE:00:00:02,model=ftgmac100  \
166     -net bridge,id=net0,helper=/usr/lib/qemu-bridge-helper,br=virbr0
170 window. This results in having an easily accessible qemu command session.
171 `-monitor stdio -serial pty -nodefaults`
178 curl -c cjar -k -X POST -H "Content-Type: application/json" -d '{"data": [ "root", "0penBmc" ] }' h…
184 ssh -p 2200 root@bmc
190 curl -c cjar -b cjar -k -H "Content-Type: application/json" -X PUT \
191     -d '{"data": "xyz.openbmc_project.State.Host.Transition.On"}' \
197 [SDK build](#building-the-openbmc-sdk) provides GDB and debug symbols:
199 - `$GDB` is available to use once SDK environment is setup
200 - Debug symbols are located in `.debug/` directory of each executable
218 ulimit -c unlimited
221 ## Cleaning up read-write file system changes
240 - If a repo is a single archive, it usually looks like this:
241   - `zlib-1.2.11.tar.xz` - The repo itself
242   - `zlib-1.2.11.tar.xz.done` - A flag indicating the repo is downloaded
243 - If a repo is managed by git, it usually looks like this:
244   - `git2/github.com.openbmc.linux` - The git bare clone
245   - `git2/github.com.openbmc.linux.done` - A flag indicating the repo is
251 - Set `DL_DIR` Bitbake environment variable to the location of your shared
252   downloads directory by editing the `build/conf/local.conf` file:
258 - Or create a symbol link:
261 ln -sf <path>/<to>/<existing>/downloads build/downloads
271 Google `git-proxy-wrapper` will find various ways to setup the proxy for the git
278 ## Use connect-proxy as git proxy wrapper which supports SOCKS5
279 ## Install with `apt-get install connect-proxy`
280 ## Use with `export GIT_PROXY_COMMAND=~/bin/git-proxy-wrapper`
281 /usr/bin/connect -S localhost:9054 "$@"
284 Then you can run `export GIT_PROXY_COMMAND=~/bin/git-proxy-wrapper` and you are
296 bitbake obmc-phosphor-image  # Build with local changes
302 To use this tool, you need the build environment, e.g. `. oe-init-build-env`.
311 the code in [phosphor-host-ipmid][1]. Checking the recipes, you know this repo
312 is in [phosphor-ipmi-host.bb][2]. Below are the steps to use devtool to modify
318    devtool modify phosphor-ipmi-host
321    devtool clones the repo into `build/workspace/sources/phosphor-ipmi-host`,
330    bitbake obmc-phosphor-image  # Build the whole image
331    bitbake phosphor-ipmi-host  # Build the recipe
341 …workspace/sources/phosphor-ipmi-host/oe-workdir/package/usr/lib/ipmid-providers/libapphandler.so.0…
342    systemctl restart phosphor-ipmi-host.service  # Restart the inband ipmi daemon
343    # Or restart phosphor-ipmi-net.service if you want to test net ipmi.
356 `linux-aspeed` for Aspeed based OpenBMC builds. In the following examples,
357 replace `linux-obmc` with `linux-aspeed` if you are on a revision later than
362    `linux-obmc_4.13.bb` specifies `dev-4.13` branch.
364 3. devtool copies the defconfig and machine-specific config into `oe-workdir`.
370 bitbake linux-obmc -c build
378 bitbake linux-obmc -c menuconfig
382 bitbake linux-obmc -c savedefconfig
383 # It will save the new defconfig at oe-workdir/linux-obmc-<version>/defconfig
398    `build/tmp/deploy/images/romulus/fitImage-obmc-phosphor-initramfs-romulus.bin`
413 [1]: https://github.com/openbmc/phosphor-host-ipmid
415 …mc/blob/c53f375a0f92f847d2aa50e19de54840e8472c8e/meta-phosphor/recipes-phosphor/ipmi/phosphor-ipmi…