pranoygoru / openbmc

OpenBMC is an open software framework to build a complete Linux image for a Board Management Controller (BMC).

OpenBMC

OpenBMC is an open software framework to build a complete Linux image for a Board Management Controller (BMC).

OpenBMC uses the Yocto Project as the underlying building and distro generation framework.

Board	Status	Description
Wedge100		A 32x100G TOR switch
Lightning		A flexible NVMe JBOF
Yosemite		An open source modular chassis for high-powered microservers
Wedge		A 40G OS-agnostic TOR switch
Bryce Canyon		Disk Storage platform

Contents

This repository includes 3 set of layers:

• OpenBMC Common Layer - Common packages and recipes can be used in different types of BMC.
• BMC System-on-Chip (SoC) Layer - SoC specific drivers and tools. This layer includes the bootloader (u-boot) and the Linux kernel. Both the bootloader and Linux kernel shall include the hardware drivers specific for the SoC.
• Board Specific Layer - Board specific drivers, configurations, and tools. This layer defines how to configure the image. It also defines what packages to be installed for an OpenBMC image for this board. Any board specific initialization and tools are also included in this layer.

File structure

The Yocto naming pattern is used in this repository. A "meta-layer" is used to name a layer or a category of layers. And recipe-abc is used to name a recipe. The project will exist as a meta layer itself! Within the Yocto Project's distribution call this project meta-openbmc.

The recipes for OpenBMC common layer are found in common.

The BMC SoC layer and board specific layer are grouped together based on the vendor/manufacturer name. For example, all Facebook boards specific code should be in meta-facebook. Likewise, meta-aspeed includes source code for Aspeed SoCs.

How to build

Note: In the instruction set below, references to for some of the steps is an example only and need to be replaced with the respective platform when setting up for a different platform.

1. Set up the build environment based on the Yocto Project's Quick Start Guide.

2. Clone Yocto repository:

$ git clone -b krogoth https://git.yoctoproject.org/git/poky

3. Clone OpenEmbedded and OpenBMC repositories, in the new created poky directory:

$ cd poky
$ git clone -b krogoth https://github.com/openembedded/meta-openembedded.git
$ git clone -b krogoth https://git.yoctoproject.org/git/meta-security
$ git clone -b helium https://github.com/facebook/openbmc.git meta-openbmc

Note that this project does not use Yocto release branch names.

4. Initialize a build directory. In the poky directory:

$ export TEMPLATECONF=meta-openbmc/meta-facebook/meta-<platform>/conf
$ source oe-init-build-env

Choose between meta-wedge, meta-wedge100, meta-yosemite, or any of the other platforms listed in the meta-openbmc/meta-facebook directory. After this step, you will be dropped into a build directory, poky/build.

5. Start the build within the build directory: In general to build for the platform:

$ bitbake <platform>-image

The build process automatically fetches all necessary packages and builds the complete image. The final build results are in poky/build/tmp/deploy/images/<platform>. The root password will be 0penBmc, you may change this in the local configuration.

Kernel Development

By default, OpenBMC build process fetches and build Linux kernel directly from GitHub repository. To make local kernel changes and build with the modified kernel:

1. Clone kernel source

$ cd poky
$ git clone -b openbmc/helium/4.1 https://github.com/theopolis/linux.git meta-openbmc/meta-aspeed/recipes-kernel/linux/files/linux-aspeed-4.1

2. Update build recipes to point to local kernel source directory in meta-aspeed/conf/machine/include/ast2520.inc, add these 2 lines below the PREFERRED_PROVIDER_virtual/kernel ?= "linux-aspeed line

(check meta-facebook/meta-<platfom>/conf/machine/<platfom>.conf for the correct astxxxx.inc file to modify)

INHERIT += "externalsrc"
EXTERNALSRC_pn-linux-aspeed = "<dir>/meta-openbmc/meta-aspeed/recipes-kernel/linux/files/linux-aspeed-4.1"

Build Artifacts

• u-boot.bin - This is the u-boot image for the board.
• uImage - This the Linux kernel for the board.
• -image-.cpio.lzma.u-boot - This is the rootfs for the board
• flash- - This is the complete flash image including u-boot, kernel, and the rootfs.

Yocto Configuration

It is recommended to setup a new Yocto distribution (a checkout of poky). The initialization script oe-init-build-env can read the included TEMPLATECONF and set up a local build/conf/local.conf along with the associated layer/build configuration.

If you have previously set up and built poky, you may change your local configuration:

When using the example TEMPLATECONF for Wedge, the ./build/conf/templateconf.cfg:

meta-openbmc/meta-facebook/meta-<platform>/conf

The layers config ./build/conf/bblayers.conf, will contain:

BBPATH = "${TOPDIR}"
BBFILES ?= ""

BBLAYERS ?= " \
  /PREFIX/poky/meta \
  /PREFIX/poky/meta-yocto \
  /PREFIX/poky/meta-yocto-bsp \
  /PREFIX/poky/meta-openembedded/meta-oe \
  /PREFIX/poky/meta-openembedded/meta-networking \
  /PREFIX/poky/meta-openembedded/meta-python \
  /PREFIX/poky/meta-openbmc \
  /PREFIX/poky/meta-openbmc/meta-aspeed \
  /PREFIX/poky/meta-openbmc/meta-facebook/meta-<platform> \
  "
BBLAYERS_NON_REMOVABLE ?= " \
  /PREFIX/poky/meta \
  /PREFIX/poky/meta-yocto \
  "

And finally the ./build/config/local.conf will include important configuration options:

# Machine Selection
MACHINE ??= "<platform>"

# OpenBMC distro settings
DISTRO ?= "openbmc-fb"

How can I contribute

If you have an application that can be used by different BMCs, you can contribute your application to the OpenBMC common layer.

If you are a BMC SoC vendor, you can contribute your SoC specific drivers to the BMC SoC layer.

If you are a board vendor, you can contribute your board specific configurations and tools to the Board specific layer. If the board uses a new BMC SoC that is not part of the BMC SoC layer, the SoC specific driver contribution to the BMC SoC layer is also required.