11# OpenBMC
22
3- [ ![ Build Status] ( https://openpower.xyz/buildStatus/icon?job=openbmc-build )] ( https://openpower.xyz/job/openbmc-build/ )
4-
53The OpenBMC project can be described as a Linux distribution for embedded
64devices that have a BMC; typically, but not limited to, things like servers,
75top 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```
2119sudo 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 [email protected] :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
4537of 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
40+ $ . setup
41+ Target machine must be specified.
6142```
62-
63- Once you know the target (e.g. romulus), source the ` setup ` script as follows:
64-
65- ```
66- . setup romulus build
67- ```
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,32 +62,38 @@ 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+
75+ meta-sp6 supports boards:
76+ 1 . Sunstone
77+ 2 . Shale
78+ 3 . Cinnabar
79+
80+ meta-turin supports boards:
81+ 1 . Chalupa
82+ 2 . Galena
83+ 3 . Huambo
84+ 4 . Purico
85+ 5 . Recluse
86+ 6 . Volcano
87+
88+ The builds are ** beta** quality at this point in time.
89+ Please check back for updates.
10990
11091## Submitting Patches
111- Support of additional hardware and software packages is always welcome.
112- Please follow the [ contributing guidelines] ( https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md )
113- when making a submission. It is expected that contributions contain test
114- cases.
92+ AMD welcomes contributions. Please create pull requests to contribute: (https://github.com/AMDESE/OpenBMC/pulls )
11593
11694## Bug Reporting
117- [ Issues] ( https://github.com/openbmc/openbmc /issues ) are managed on
118- GitHub. It is recommended you search through the issues before opening
95+ [ Issues] ( https://github.com/AMDESE/OpenBMC /issues ) are managed on
96+ GitHub. It is recommended you search through the issues before opening
11997a new one.
12098
12199## Questions
@@ -128,51 +106,65 @@ For general questions, please use the openbmc tag on
128106Please review the [ discussion] ( https://meta.stackexchange.com/questions/272956/a-new-code-license-the-mit-this-time-with-attribution-required?cb=1 )
129107on Stack Overflow licensing before posting any code.
130108
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
150-
151- ** Features In Progress**
152- * OpenCompute Redfish Compliance
153- * Verified Boot
154-
155- ** Features Requested but need help**
156- * OpenBMC performance monitoring
157-
109+ For technical discussions, please see [ contact info] ( #contact ) below for IRC and
110+ mailing list information. Please don't file an issue to ask a question. You'll
111+ get faster results by using the mailing list or IRC.
112+
113+ ## Supported Features:
114+ - WebUI
115+ - System at a glance
116+ - Network info
117+ - Unique host name
118+ - Control Interface
119+ - IPMI (OOB)
120+ - Redfish (OOB)
121+ - SSH Console (BMC)
122+ - Firmware Updates
123+ - BMC (OOB)
124+ - BIOS (OOB)
125+ - CLEAR CMOS via script
126+ - HAWAII FPGA (OOB) - Command line only, NO UI
127+ - Onyx/Quartz FPGA (OOB) - Command line only, NO UI
128+ - SOL Console
129+ - webui
130+ - ssh
131+ - Power Control
132+ - ON
133+ - OFF
134+ - State detection
135+ - New WebUI
136+ - webvue-ui
137+ - Fan Control
138+ - Adaptive fan Control
139+ - KVM
140+ - Keyboard, Video, Mouse
141+ - VNC Client support
142+ - APML
143+ - CPU temperature sensors
144+ - I3C tools supported
145+ - Locator/Chassis ID LEDs
146+ - Post Code Capture using eSPI
147+ - Inband IPMI over KCS (eSPI)
148+ - LCD Display
149+ - Display Port Enablement
150+ - BMC RAS
151+ - BMC Crashdump
152+ - Power Capping
153+ - PMIC Error Injection
154+ - MCTP Support
155+ - CPER format data for RAS
156+ - VR update
157+ - Single CPER file for RAS Error
158+ - FPGA dump script
159+
160+ ## Features in Progress:
161+ - New platform support
158162
159163## Finding out more
160164
161165Dive deeper into OpenBMC by opening the
162166[ docs] ( https://github.com/openbmc/docs ) repository.
163167
164- ## Technical Steering Committee
165-
166- The Technical Steering Committee (TSC) guides the project. Members are:
167-
168- * Brad Bishop (chair), IBM
169- * Nancy Yuen, Google
170- * Sai Dasari, Facebook
171- * James Mihm, Intel
172- * Sagar Dharia, Microsoft
173- * Supreeth Venkatesh, Arm
174-
175168## Contact
176- - Mail:
[email protected] [ https://lists.ozlabs.org/listinfo/openbmc ] ( https://lists.ozlabs.org/listinfo/openbmc ) 177- - Discord: https://discord.gg/69Km47zH98
178-
169+ - Mail:
[email protected] [ https://lists.ozlabs.org/listinfo/openbmc ] ( https://lists.ozlabs.org/listinfo/openbmc ) with the subject "meta-amd"
170+ - Alternatively, you can copy the maintainer: Supreeth Venkatesh <
[email protected] >
0 commit comments