Skip to content

Commit

Permalink
Update README md file
Browse files Browse the repository at this point in the history
Updates README md file.

Signed-off-by: Supreeth Venkatesh <[email protected]>
  • Loading branch information
supven01 committed Jan 11, 2024
1 parent 4a1b447 commit 6228c6b
Show file tree
Hide file tree
Showing 65 changed files with 91 additions and 4,647 deletions.
190 changes: 91 additions & 99 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# OpenBMC

[![Build Status](https://openpower.xyz/buildStatus/icon?job=openbmc-build)](https://openpower.xyz/job/openbmc-build/)

The OpenBMC project can be described as a Linux distribution for embedded
devices that have a BMC; typically, but not limited to, things like servers,
top of rack switches or RAID appliances. The OpenBMC stack uses technologies
Expand All @@ -15,23 +13,17 @@ customization for your server platform.
## Setting up your OpenBMC project

### 1) Prerequisite
- Ubuntu 14.04
- Ubuntu 18.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 [email protected]:openbmc/openbmc.git
cd openbmc
mkdir OpenBMC
cd OpenBMC
git clone https://github.com/AMDESE/OpenBMC.git .
```

### 3) Target your hardware
Expand All @@ -45,33 +37,13 @@ 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:
centriq2400-rep f0b fp5280g2
gsj hr630 hr855xg2
lanyang mihawk msn
neptune nicole olympus
olympus-nuvoton on5263m5 p10bmc
palmetto qemuarm quanta-q71l
romulus s2600wf stardragon4800-rep2
swift tiogapass vesnin
witherspoon witherspoon-tacoma yosemitev2
zaius
$ . setup
Target machine must be specified.
```

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

```
. setup romulus build
```

For evb-ast2500, please use the below command to specify the machine config,
because the machine in `meta-aspeed` layer is in a BSP layer and does not
build the openbmc image.
Once you know the target (e.g. onyx), source the `setup` script as follows:

```
TEMPLATECONF=meta-evb/meta-evb-aspeed/meta-evb-ast2500/conf . openbmc-env
. setup sp5
```

### 4) Build
Expand All @@ -90,32 +62,38 @@ to get up to speed on OpenBMC development out
[here](https://github.com/openbmc/docs/blob/master/development/README.md)

## Build Validation and Testing
Commits submitted by members of the OpenBMC GitHub community are compiled and
tested via our [Jenkins](https://jenkins.openbmc.org/) 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](https://openpower.xyz/job/openbmc-test-qemu-ci/).

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](http://robotframework.org/) for all automation. Our
complete test repository can be found
[here](https://github.com/openbmc/openbmc-test-automation).
This contains bring up code to port OpenBMC on AMD's customer reference boards.
meta-sp5 supports boards:
1. Onyx
2. Quartz
3. Ruby
4. Titanite

meta-sh5 supports boards:
1. sh5 d807

meta-sp6 supports boards:
1. Sunstone
2. Shale
3. Cinnabar

meta-turin supports boards:
1. Chalupa
2. Galena
3. Huambo
4. Purico
5. Recluse
6. Volcano

The builds are **beta** quality at this point in time.
Please check back for updates.

## Submitting Patches
Support of additional hardware and software packages is always welcome.
Please follow the [contributing guidelines](https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md)
when making a submission. It is expected that contributions contain test
cases.
AMD welcomes contributions. Please create pull requests to contribute: (https://github.com/AMDESE/OpenBMC/pulls)

## Bug Reporting
[Issues](https://github.com/openbmc/openbmc/issues) are managed on
GitHub. It is recommended you search through the issues before opening
[Issues](https://github.com/AMDESE/OpenBMC/issues) are managed on
GitHub. It is recommended you search through the issues before opening
a new one.

## Questions
Expand All @@ -128,51 +106,65 @@ For general questions, please use the openbmc tag on
Please review the [discussion](https://meta.stackexchange.com/questions/272956/a-new-code-license-the-mit-this-time-with-attribution-required?cb=1)
on Stack Overflow licensing before posting any code.

For technical discussions, please see [contact info](#contact) 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

For technical discussions, please see [contact info](#contact) below for IRC 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 IRC.

## Supported Features:
- WebUI
- System at a glance
- Network info
- Unique host name
- Control Interface
- IPMI (OOB)
- Redfish (OOB)
- SSH Console (BMC)
- Firmware Updates
- BMC (OOB)
- BIOS (OOB)
- CLEAR CMOS via script
- HAWAII FPGA (OOB) - Command line only, NO UI
- Onyx/Quartz FPGA (OOB) - Command line only, NO UI
- SOL Console
- webui
- ssh
- Power Control
- ON
- OFF
- State detection
- New WebUI
- webvue-ui
- Fan Control
- Adaptive fan Control
- KVM
- Keyboard, Video, Mouse
- VNC Client support
- APML
- CPU temperature sensors
- I3C tools supported
- Locator/Chassis ID LEDs
- Post Code Capture using eSPI
- Inband IPMI over KCS (eSPI)
- LCD Display
- Display Port Enablement
- BMC RAS
- BMC Crashdump
- Power Capping
- PMIC Error Injection
- MCTP Support
- CPER format data for RAS
- VR update
- Single CPER file for RAS Error
- FPGA dump script

## Features in Progress:
- New platform support

## Finding out more

Dive deeper into OpenBMC by opening the
[docs](https://github.com/openbmc/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
* Supreeth Venkatesh, Arm

## Contact
- Mail: [email protected] [https://lists.ozlabs.org/listinfo/openbmc](https://lists.ozlabs.org/listinfo/openbmc)
- Discord: https://discord.gg/69Km47zH98

- Mail: [email protected] [https://lists.ozlabs.org/listinfo/openbmc](https://lists.ozlabs.org/listinfo/openbmc) with the subject "meta-amd"
- Alternatively, you can copy the maintainer: Supreeth Venkatesh <[email protected]>
27 changes: 0 additions & 27 deletions meta-amd/meta-common/recipes-amd/amd-bmc-ubm/amd-bmc-ubm.bb

This file was deleted.

35 changes: 0 additions & 35 deletions meta-amd/meta-common/recipes-amd/amd-ppr/amd-ppr.bb

This file was deleted.

55 changes: 0 additions & 55 deletions meta-amd/meta-common/recipes-amd/amd-spdm/amd-spdm.bb

This file was deleted.

This file was deleted.

Loading

0 comments on commit 6228c6b

Please sign in to comment.