Gitiles
Code Review Sign In
gerrit.openbmc.org / mdmillerii / openbmc / b8cf77b7cbe18df2007a098e49c3c26c6e85aee1 / .
tree: cad22ea6cd5d1a1f9cc5eab723838ef0cb082c61 [path history] [tgz]
  1. .github/
  2. meta-amd/
  3. meta-ampere/
  4. meta-aspeed/
  5. meta-asrock/
  6. meta-bytedance/
  7. meta-evb/
  8. meta-facebook/
  9. meta-fii/
  10. meta-google/
  11. meta-hpe/
  12. meta-ibm/
  13. meta-ingrasys/
  14. meta-inspur/
  15. meta-intel-openbmc/
  16. meta-inventec/
  17. meta-nuvoton/
  18. meta-openembedded/
  19. meta-openpower/
  20. meta-phosphor/
  21. meta-quanta/
  22. meta-raspberrypi/
  23. meta-security/
  24. meta-supermicro/
  25. meta-tyan/
  26. meta-wistron/
  27. meta-yadro/
  28. poky/
  29. bitbake ⇨ poky/bitbake/
  30. LICENSE ⇨ poky/LICENSE
  31. meta ⇨ poky/meta
  32. meta-poky ⇨ poky/meta-poky/
  33. meta-skeleton ⇨ poky/meta-skeleton
  34. oe-init-build-env ⇨ poky/oe-init-build-env
  35. scripts ⇨ poky/scripts/
  36. .eslintrc.json
  37. .gitignore
  38. .gitreview
  39. .templateconf
  40. MAINTAINERS
  41. openbmc-env
  42. OWNERS
  43. README.md
  44. setup
README.md

OpenBMC

Build Status

OpenBMC is a Linux distribution for management controllers used in devices such as servers, top of rack switches or RAID appliances. It uses Yocto, OpenEmbedded, systemd, and D-Bus to allow easy customization for your platform.

Setting up your OpenBMC project

1) Prerequisite

  • Ubuntu 14.04
sudo apt-get install -y git build-essential libsdl1.2-dev texinfo gawk chrpath diffstat
  • Fedora 28
sudo dnf install -y git patch diffstat texinfo chrpath SDL-devel bitbake \
    rpcgen perl-Thread-Queue perl-bignum perl-Crypt-OpenSSL-Bignum
sudo dnf groupinstall "C Development Tools and Libraries"

2) Download the source

git clone git@github.com:openbmc/openbmc.git
cd openbmc

3) Target your hardware

Any build requires an environment set up according to your hardware target. There is a special script in the root of this repository that can be used to configure the environment as needed. The script is called setup and takes the name of your hardware target as an argument.

The script needs to be sourced while in the top directory of the OpenBMC repository clone, and, if run without arguments, will display the list of supported hardware targets, see the following example:

$ . setup <machine> [build_dir]
Target machine must be specified. Use one of:

bletchley               gsj                     romulus
dl360poc                kudo                    s2600wf
e3c246d4i               mihawk                  swift
ethanolx                mtjade                  tiogapass
evb-ast2500             nicole                  transformers
evb-ast2600             olympus-nuvoton         witherspoon
evb-npcm750             on5263m5                witherspoon-tacoma
f0b                     p10bmc                  x11spi
fp5280g2                palmetto                yosemitev2
g220a                   qemuarm                 zaius
gbs                     quanta-q71l

Once you know the target (e.g. romulus), source the setup script as follows:

. setup romulus

4) Build

bitbake obmc-phosphor-image

Additional details can be found in the docs repository.

OpenBMC Development

The OpenBMC community maintains a set of tutorials new users can go through to get up to speed on OpenBMC development out here

Build Validation and Testing

Commits submitted by members of the OpenBMC GitHub community are compiled and tested via our Jenkins server. Commits are run through two levels of testing. At the repository level the makefile make check directive is run. At the system level, the commit is built into a firmware image and run with an arm-softmmu QEMU model against a barrage of CI tests.

Commits submitted by non-members do not automatically proceed through CI testing. After visual inspection of the commit, a CI run can be manually performed by the reviewer.

Automated testing against the QEMU model along with supported systems are performed. The OpenBMC project uses the Robot Framework for all automation. Our complete test repository can be found here.

Submitting Patches

Support of additional hardware and software packages is always welcome. Please follow the contributing guidelines when making a submission. It is expected that contributions contain test cases.

Bug Reporting

Issues are managed on GitHub. It is recommended you search through the issues before opening a new one.

Questions

First, please do a search on the internet. There's a good chance your question has already been asked.

For general questions, please use the openbmc tag on Stack Overflow. Please review the discussion on Stack Overflow licensing before posting any code.

For technical discussions, please see contact info below for Discord and mailing list information. Please don't file an issue to ask a question. You'll get faster results by using the mailing list or Discord.

Features of OpenBMC

Feature List

  • Host management: Power, Cooling, LEDs, Inventory, Events, Watchdog
  • Full IPMI 2.0 Compliance with DCMI
  • Code Update Support for multiple BMC/BIOS images
  • Web-based user interface
  • REST interfaces
  • D-Bus based interfaces
  • SSH based SOL
  • Remote KVM
  • Hardware Simulation
  • Automated Testing
  • User management
  • Virtual media

Features In Progress

  • OpenCompute Redfish Compliance
  • Verified Boot

Features Requested but need help

  • OpenBMC performance monitoring

Finding out more

Dive deeper into OpenBMC by opening the docs repository.

Technical Steering Committee

The Technical Steering Committee (TSC) guides the project. Members are:

  • Brad Bishop (chair), IBM
  • Nancy Yuen, Google
  • Sai Dasari, Facebook
  • James Mihm, Intel
  • Sagar Dharia, Microsoft
  • Samer El-Haj-Mahmoud, Arm

Contact