Skip to content

Commit a93c7dc

Browse files
committed
Update README md file
Updates README md file. Signed-off-by: Supreeth Venkatesh <supreeth.venkatesh@amd.com> Change-Id: I748e2a87ea47a0e72bfa2722793d0312a6509e1f
1 parent 15dfb39 commit a93c7dc

File tree

58 files changed

+86
-4553
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+86
-4553
lines changed

README.md

Lines changed: 86 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# OpenBMC
22

3-
[![Build Status](https://openpower.xyz/buildStatus/icon?job=openbmc-build)](https://openpower.xyz/job/openbmc-build/)
4-
53
The OpenBMC project can be described as a Linux distribution for embedded
64
devices that have a BMC; typically, but not limited to, things like servers,
75
top of rack switches or RAID appliances. The OpenBMC stack uses technologies
@@ -15,23 +13,17 @@ customization for your server platform.
1513
## Setting up your OpenBMC project
1614

1715
### 1) Prerequisite
18-
- Ubuntu 14.04
16+
- Ubuntu 18.04
1917

2018
```
2119
sudo apt-get install -y git build-essential libsdl1.2-dev texinfo gawk chrpath diffstat
2220
```
2321

24-
- Fedora 28
25-
26-
```
27-
sudo dnf install -y git patch diffstat texinfo chrpath SDL-devel bitbake \
28-
rpcgen perl-Thread-Queue perl-bignum perl-Crypt-OpenSSL-Bignum
29-
sudo dnf groupinstall "C Development Tools and Libraries"
30-
```
3122
### 2) Download the source
3223
```
33-
git clone git@github.com:openbmc/openbmc.git
34-
cd openbmc
24+
mkdir OpenBMC
25+
cd OpenBMC
26+
git clone https://github.com/AMDESE/OpenBMC.git .
3527
```
3628

3729
### 3) Target your hardware
@@ -45,33 +37,13 @@ repository clone, and, if run without arguments, will display the list
4537
of supported hardware targets, see the following example:
4638

4739
```
48-
$ . setup <machine> [build_dir]
49-
Target machine must be specified. Use one of:
50-
51-
centriq2400-rep f0b fp5280g2
52-
gsj hr630 hr855xg2
53-
lanyang mihawk msn
54-
neptune nicole olympus
55-
olympus-nuvoton on5263m5 p10bmc
56-
palmetto qemuarm quanta-q71l
57-
romulus s2600wf stardragon4800-rep2
58-
swift tiogapass vesnin
59-
witherspoon witherspoon-tacoma yosemitev2
60-
zaius
61-
```
62-
63-
Once you know the target (e.g. romulus), source the `setup` script as follows:
64-
65-
```
66-
. setup romulus build
40+
$ . setup
41+
Target machine must be specified.
6742
```
68-
69-
For evb-ast2500, please use the below command to specify the machine config,
70-
because the machine in `meta-aspeed` layer is in a BSP layer and does not
71-
build the openbmc image.
43+
Once you know the target (e.g. onyx), source the `setup` script as follows:
7244

7345
```
74-
TEMPLATECONF=meta-evb/meta-evb-aspeed/meta-evb-ast2500/conf . openbmc-env
46+
. setup sp5
7547
```
7648

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

9264
## Build Validation and Testing
93-
Commits submitted by members of the OpenBMC GitHub community are compiled and
94-
tested via our [Jenkins](https://jenkins.openbmc.org/) server. Commits are run
95-
through two levels of testing. At the repository level the makefile `make
96-
check` directive is run. At the system level, the commit is built into a
97-
firmware image and run with an arm-softmmu QEMU model against a barrage of
98-
[CI tests](https://openpower.xyz/job/openbmc-test-qemu-ci/).
99-
100-
Commits submitted by non-members do not automatically proceed through CI
101-
testing. After visual inspection of the commit, a CI run can be manually
102-
performed by the reviewer.
103-
104-
Automated testing against the QEMU model along with supported systems are
105-
performed. The OpenBMC project uses the
106-
[Robot Framework](http://robotframework.org/) for all automation. Our
107-
complete test repository can be found
108-
[here](https://github.com/openbmc/openbmc-test-automation).
65+
This contains bring up code to port OpenBMC on AMD's customer reference boards.
66+
meta-sp5 supports boards:
67+
1. Onyx
68+
2. Quartz
69+
3. Ruby
70+
4. Titanite
71+
72+
meta-sh5 supports boards:
73+
1. sh5 d807
74+
2. Onyx
75+
76+
meta-sp6 supports boards:
77+
1. Sunstone
78+
2. Shale
79+
3. Cinnabar
80+
81+
meta-turin supports boards:
82+
1. Chalupa
83+
2. Galena
84+
3. Huambo
85+
4. Purico
86+
5. Recluse
87+
6. Volcano
88+
89+
The builds are **beta** quality at this point in time.
90+
Please check back for updates.
10991

11092
## Submitting Patches
11193
Support of additional hardware and software packages is always welcome.
@@ -128,25 +110,56 @@ For general questions, please use the openbmc tag on
128110
Please review the [discussion](https://meta.stackexchange.com/questions/272956/a-new-code-license-the-mit-this-time-with-attribution-required?cb=1)
129111
on Stack Overflow licensing before posting any code.
130112

131-
For technical discussions, please see [contact info](#contact) below for
132-
Discord and mailing list information. Please don't file an issue to ask a
133-
question. You'll get faster results by using the mailing list or Discord.
134-
135-
## Features of OpenBMC
136-
137-
**Feature List**
138-
* Host management: Power, Cooling, LEDs, Inventory, Events, Watchdog
139-
* Full IPMI 2.0 Compliance with DCMI
140-
* Code Update Support for multiple BMC/BIOS images
141-
* Web-based user interface
142-
* REST interfaces
143-
* D-Bus based interfaces
144-
* SSH based SOL
145-
* Remote KVM
146-
* Hardware Simulation
147-
* Automated Testing
148-
* User management
149-
* Virtual media
113+
For technical discussions, please see [contact info](#contact) below for IRC and
114+
mailing list information. Please don't file an issue to ask a question. You'll
115+
get faster results by using the mailing list or IRC.
116+
117+
## Supported Features:
118+
- WebUI
119+
- System at a glance
120+
- Network info
121+
- Unique host name
122+
- Control Interface
123+
- IPMI (OOB)
124+
- Redfish (OOB)
125+
- SSH Console (BMC)
126+
- Firmware Updates
127+
- BMC (OOB)
128+
- BIOS (OOB)
129+
- CLEAR CMOS via script
130+
- HAWAII FPGA (OOB) - Command line only, NO UI
131+
- Onyx/Quartz FPGA (OOB) - Command line only, NO UI
132+
- SOL Console
133+
- webui
134+
- ssh
135+
- Power Control
136+
- ON
137+
- OFF
138+
- State detection
139+
- New WebUI
140+
- webvue-ui
141+
- Fan Control
142+
- Adaptive fan Control
143+
- KVM
144+
- Keyboard, Video, Mouse
145+
- VNC Client support
146+
- APML
147+
- CPU temperature sensors
148+
- I3C tools supported
149+
- Locator/Chassis ID LEDs
150+
- Post Code Capture using eSPI
151+
- Inband IPMI over KCS (eSPI)
152+
- LCD Display
153+
- Display Port Enablement
154+
- BMC RAS
155+
- BMC Crashdump
156+
- Power Capping
157+
- PMIC Error Injection
158+
- MCTP Support
159+
- CPER format data for RAS
160+
- VR update
161+
- Single CPER file for RAS Error
162+
- FPGA dump script
150163

151164
**Features In Progress**
152165
* OpenCompute Redfish Compliance
@@ -173,6 +186,5 @@ The Technical Steering Committee (TSC) guides the project. Members are:
173186
* Supreeth Venkatesh, Arm
174187

175188
## Contact
176-
- Mail: openbmc@lists.ozlabs.org [https://lists.ozlabs.org/listinfo/openbmc](https://lists.ozlabs.org/listinfo/openbmc)
177-
- Discord: https://discord.gg/69Km47zH98
178-
189+
- Mail: openbmc@lists.ozlabs.org [https://lists.ozlabs.org/listinfo/openbmc](https://lists.ozlabs.org/listinfo/openbmc) with the subject "meta-amd"
190+
- Alternatively, you can copy the maintainer: Supreeth Venkatesh <supreeth.venkatesh@amd.com>

meta-amd/meta-common/recipes-amd/amd-bmc-ubm/amd-bmc-ubm.bb

Lines changed: 0 additions & 27 deletions
This file was deleted.

meta-amd/meta-common/recipes-amd/amd-ppr/amd-ppr.bb

Lines changed: 0 additions & 35 deletions
This file was deleted.

meta-amd/meta-common/recipes-amd/amd-spdm/amd-spdm.bb

Lines changed: 0 additions & 55 deletions
This file was deleted.

meta-amd/meta-common/recipes-amd/amd-spdm/files/set-spdm-config.service

Lines changed: 0 additions & 10 deletions
This file was deleted.

meta-amd/meta-common/recipes-amd/amd-yaap/amd-yaap.bb

Lines changed: 0 additions & 38 deletions
This file was deleted.

meta-amd/meta-common/recipes-amd/auto-notify/auto-notify.bb

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)