isabella232 / openbic

BICs (Bridge IC) are standalone devices deployed within a Data Center that enable monitoring a multi-host system using a single BMC device.

OpenBIC

OpenBIC is an open software framework to build a complete firmware image for a BridgeIC.

Platform	Status	Description
Yosemite v3.5	N/A	Yosemite Compute

Contents

This repo currently contains the following directories

• Code common to all platforms under the common directory.
• Platform specific code in the meta-facebook directory.
• The ASPEED OpenBIC SDK under the src directory.
  • app - An example application to test the various drivers
  • arch - Supporting files for the board architecture (ARM) and CMSIS.
  • board - Definitions for the various supported boards.
  • configs - configuration files used for building the supported board types
  • Drivers - Currently implemented drivers.
  • libraries - Supporting libraries such as getopt and FreeRTOS+
  • os - Supported RTOSs (currently only FreeRTOS)
  • toolchain - The included cross compilation toolchain used to build OpenBIC
  • tools - Misc tools

Currently supported RTOS

OpenBIC functionality is written using the CMSIS RTOS API as an RTOS wrapper. This allows for RTOS agnostic design and feature implementations.

The currently supported RTOSs are:

• Zephyr

Currently supported Boards

The board configuration files can be found in the configs/ directory.

The currently supported boards are:

• ASPEED AST2600 EVB
• ASPEED AST1030 EVB

Build Instructions

Dependencies

The SDK develop environment is based on Ubuntu 18.04 LTS – 64bits and bash shell. The following tools must be installed on the host machine.

• Reference url: https://docs.zephyrproject.org/2.6.0/getting_started/index.html
• Reference url: https://github.com/AspeedTech-BMC/zephyr

Dependencies minimum required:

Cmake: 3.20.0
Python: 3.6
Devicetree compiler: 1.4.6

Install dependencies:

sudo apt install --no-install-recommends git cmake ninja-build gperf \
ccache dfu-util device-tree-compiler wget \
python3-dev python3-pip python3-setuptools python3-tk python3-wheel xzutils file \
make gcc gcc-multilib g++-multilib libsdl2-dev

Download Zephyr package: Install west, and make sure ~/.local/bin is on your PATH environment variable:

pip3 install --user -U west
echo 'export PATH=~/.local/bin:"$PATH"' >> ~/.bashrc
source ~/.bashrc

Get the application and Zephyr code base from openbic GitHub.

Note: First step will only work after west.yml being merged **

west init -m https://github.com/facebook/OpenBIC zephyrproject
cd zephyrproject
west update

Install the toolchain:

cd ~
wget https://github.com/zephyrproject-rtos/sdkng/releases/download/v0.12.4/zephyr-sdk-0.12.4-x86_64-linux-setup.run

Run the installer, installing the SDK in ~/zephyr-sdk-0.12.4:

chmod +x zephyr-sdk-0.12.4-x86_64-linux-setup.run
./zephyr-sdk-0.12.4-x86_64-linux-setup.run -- -d ~/zephyr-sdk-0.12.4

Build Steps

Clean build application and Zephyr code

cd $zephyrproject/openbic.odm
touch meta-facebook/yv35-cl/CMakeLists.txt
west build -p auto -b ast1030_evb meta-facebook/yv35-cl/
```## License

OpenBIC is [Apache 2.0 licensed](https://github.com/facebookincubator/OpenBIC/blob/main/LICENSE)