# openbmc

**Repository Path**: scorchfly/openbmc

## Basic Information

- **Project Name**: openbmc
- **Description**: OpenBMC is an open software framework to build a complete Linux image for a Board Management Controller (BMC).
- **Primary Language**: C
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-03-03
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenBMC

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

OpenBMC uses the [Yocto Project](https://www.yoctoproject.org) as the underlying building and distro generation framework.

| Board | Status | Description |
|-------|--------|-------------|
[**Wedge100**](https://code.facebook.com/posts/1802489260027439/wedge-100-more-open-and-versatile-than-ever/) | [![Build Status](https://jenkins.osquery.io/job/openbmcMasterBuildWedge100/badge/icon)](https://jenkins.osquery.io/job/openbmcMasterBuildWedge100/) | A 32x100G TOR switch
[**Lightning**](https://code.facebook.com/posts/989638804458007/introducing-lightning-a-flexible-nvme-jbof/) | [![Build Status](https://jenkins.osquery.io/job/openbmcMasterBuildLightning/badge/icon)](https://jenkins.osquery.io/job/openbmcMasterBuildLightning/) | A flexible NVMe JBOF
[**Yosemite**](https://code.facebook.com/posts/1616052405274961/introducing-yosemite-the-first-open-source-modular-chassis-for-high-powered-microservers-) | [![Build Status](https://jenkins.osquery.io/job/openbmcMasterBuildYosemite/badge/icon)](https://jenkins.osquery.io/job/openbmcMasterBuildYosemite/) | An open source modular chassis for high-powered microservers
[**Wedge**](https://code.facebook.com/posts/681382905244727/introducing-wedge-and-fboss-the-next-steps-toward-a-disaggregated-network/) | [![Build Status](https://jenkins.osquery.io/job/openbmcMasterBuildWedge/badge/icon)](https://jenkins.osquery.io/job/openbmcMasterBuildWedge/) | A 40G OS-agnostic TOR switch

## 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

1. Set up the build environment based on the Yocto Project's [Quick Start Guide](http://www.yoctoproject.org/docs/1.6.1/yocto-project-qs/yocto-project-qs.html).

2. Clone Yocto repository:
 ```bash
 $ git clone -b fido https://git.yoctoproject.org/git/poky
 ```

3. Clone OpenEmbedded and OpenBMC repositories, in the new created `poky` directory:
 ```bash
 $ cd poky
 $ git clone -b fido https://github.com/openembedded/meta-openembedded.git
 $ git clone -b fido https://git.yoctoproject.org/git/meta-security
 $ git clone 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:
 ```bash
 $ export TEMPLATECONF=meta-openbmc/meta-facebook/meta-wedge/conf
 $ source oe-init-build-env
 ```
 Choose between `meta-wedge`, `meta-wedge100`, and `meta-yosemite`.
 After this step, you will be dropped into a build directory, `poky/build`.

5. Start the build within the build directory:
 ```bash
 $ bitbake wedge-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/wedge`. The root password will be `0penBmc`, you may change this in the local configuration.

#### Build Artifacts

* **u-boot.bin** - This is the u-boot image for the board.
* **uImage** - This the Linux kernel for the board.
* **wedge-image-wedge.cpio.lzma.u-boot** - This is the rootfs for the board
* **flash-wedge** - 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-wedge/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-wedge \
  "
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 ??= "wedge"

# 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.