librebmc
/
charter
32
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

feedback from Lionel on cosmetic changes

Browse Source 
Signed-off-by: Toshaan Bharvani <toshaan@vantosh.com>
master
Toshaan Bharvani 4 years ago
parent a85a69e466
commit 2342edca68
1 changed files with 93 additions and 86 deletions
Show Stats Download Patch File Download Diff File

179
content.tex
Unescape Escape View File

@ -2,43 +2,43 @@


\section{Workgroup name} \section{Workgroup name}


LibreBMC Special Integration Work Group (SIG) LibreBMC \acrfull{SIG}


\section{Definitions} \section{Definitions}


Reference the OpenPOWER Foundation IPR Policy and OpenPOWER WorkGroup Process for additional term definitions. Reference the OpenPOWER Foundation \acrshort{IPR} Policy and OpenPOWER WorkGroup Process for additional term definitions.


\begin{itemize} \begin{enumerate}
\item \item
``Maintainer" is an Eligible or Non-Eligible participant of the workgroup that has been elected by Full Majority Vote to review and ``Maintainer" is an Eligible or Non-Eligible participant of the workgroup that has been elected by Full Majority Vote to review and
approve changes to the LibreBMC code in the git repository(ies) created by this SIG. approve changes to the LibreBMC code in the git repository(ies) created by this \acrshort{SIG}.
\end{itemize} \end{enumerate}


\section{Description} \section{Description}


The LibreBMC SIG is a project workgroup whose purpose is to create a reference design of an open source Baseboard Management Controller (BMC) compatible The LibreBMC \acrshort{SIG} is a project workgroup whose purpose is to create a reference design of an open source \acrfull{BMC} compatible
with the Open Compute Project (OCP) Datacenter Secure Control Module (DC-SCM) specification, named ``LibreBMC".\par with the \acrfull{OCP} \acrfull{DC-SCM} specification, named ``LibreBMC".\par


The goal of the SIG is advance the state of the open source hardware community through the design and implementation of LibreBMC. The goal of the \acrshort{SIG} is advance the state of the open source hardware community through the design and implementation of LibreBMC.
The SIG will use many open source tools and components, including open POWER ISA processor soft core, The SIG will use many open source tools and components, including open POWER \acrshort{ISA} processor soft core, \acrfull{RTL}
Register-Transfer-Level (RTL) for all required BMC interfaces and controls, design and synthesis tools, PDKs, DC-SCM board reference designs and for all required \acrshort{BMC} interfaces and controls, design and synthesis tools, \acrfull{PDK}'s, \acrshort{DC-SCM} board reference designs and
BMC software to design and implement LibreBMC in order to contribute to their growth and usability.\par \acrshort{BMC} software to design and implement LibreBMC in order to contribute to their growth and usability.\par


The purpose of LibreBMC is to be a fully open source BMC design which will enhance the security of server management control by utilizing open hardware The purpose of LibreBMC is to be a fully open source \acrshort{BMC} design which will enhance the security of
and software, and designed with fully open source tooling.\par server management control by utilizing open hardware and software, and designed with fully open source tooling.\par


The requirement of a POWER ISA core will drive the design and open release of a new or improved POWER soft-core. The requirement of a POWER \acrshort{ISA} core will drive the design and open release of a new or improved POWER soft-core.


\section{Scope} \section{Scope}


The scope of the LibreBMC SIG is the creation of a functional BMC prototype. The scope of the LibreBMC \acrshort{SIG} is the creation of a functional \acrshort{BMC} prototype.
The prototype will include a DC-SCM card design with a FPGA controller. The prototype will include a \acrshort{DC-SCM} card design with a \acrfull{FPGA} controller.
The FPGA image will consist of a POWER ISA core(s) that can run the OpenBMC stack (including LSB) and The \acrshort{FPGA} image will consist of a POWER \acrshort{ISA} core(s) that can run the OpenBMC stack (including \acrfull{LSB}) and
manage the interface between system-management software and platform hardware. manage the interface between system-management software and platform hardware.
The FPGA image will also have all controls and interfaces required of a typical BMC.\par The \acrshort{FPGA} image will also have all controls and interfaces required of a typical \acrshort{BMC}.\par


LibreBMC will be compatible with the OCP DC-SCM specification. LibreBMC will be compatible with the \acrshort{OCP} \acrshort{DC-SCM} specification.
Any changes to the OCP DC-SCM specification is outside the scope of this workgroup and will be handled through OCP.\par Any changes to the \acrshort{OCP} \acrshort{DC-SCM} specification is outside the scope of this workgroup and will be handled through \acrshort{OCP}.\par


LibreBMC should meet the requirements to manage a variety of server architectures, including but not limited to POWER, ARM, and x86 based systems. LibreBMC should meet the requirements to manage a variety of server architectures, including but not limited to POWER, ARM, and x86 based systems.
Any changes to system reference designs or specifications to use LibreBMC are outside the scope of this workgroup.\par Any changes to system reference designs or specifications to use LibreBMC are outside the scope of this workgroup.\par
@ -48,7 +48,7 @@ Any modifications of these are outside the scope of the workgroup and will be ha


\section{Similar Activities} \section{Similar Activities}


\begin{enumerate} \begin{itemize}
\item \item
Accelerator Workgroup : may work with to define the requirements for open tooling needed to complete the implementation of LibreBMC components. Accelerator Workgroup : may work with to define the requirements for open tooling needed to complete the implementation of LibreBMC components.
\item \item
@ -62,44 +62,50 @@ OpenPOWER compliant systems that will run on LibreBMC.
\item \item
Development Platform Workgroup : defines the reference architecture of future OpenPower systems that may incorporate and use LibreBMC to Development Platform Workgroup : defines the reference architecture of future OpenPower systems that may incorporate and use LibreBMC to
manage the system. manage the system.
\end{enumerate} \end{itemize}


\section{Users} \section{Users}


Any system vendor, datacenter, or cloud that plans to use a BMC, compatible with the OCP DC-SCM form factor to manage their system. \begin{itemize}
Any third-party hardware manufacturers that choose to build BMC's compatible with the DC-SCM specification. \item
Any system vendor, datacenter operator, or cloud provider that plans to use a \acrshort{BMC},
compatible with the \acrshort{OCP} \acrshort{DC-SCM} form factor to manage their system.
\item
Any third-party hardware manufacturer that choose to build \acrshort{BMC}s compatible with the \acrshort{DC-SCM} specification.
\item
Any monitoring / base software vendors. Any monitoring / base software vendors.
\end{itemize}


\section{Work Product} \section{Work Product}


\begin{enumerate} \begin{itemize}
\item \item
FPGA RTL for a POWER ISA soft-core \acrshort{FPGA} \acrshort{RTL} for a POWER \acrshort{ISA} soft-core
\item \item
FPGA RTL that includes the soft-core and all required interfaces and controls \acrshort{FPGA} \acrshort{RTL} that includes the soft-core and all required interfaces and controls
\item \item
Working LibreBMC prototype Working LibreBMC prototype
\item \item
Demonstration of LibreBMC managing a system Demonstration of LibreBMC managing a system
\end{enumerate} \end{itemize}


The FPGA RTL and reference material will be open to the general public and maintained in a public git repository(ies). The \acrshort{FPGA} \acrshort{RTL} and reference material will be open to the general public and maintained in a public git repository(ies).


\section{Projects} \section{Projects}


\begin{enumerate} \begin{itemize}
\item \item
Design an FPGA based POWER ISA soft-core capable of running OpenBMC that meets reasonable performance requirements Design an \acrshort{FPGA} based POWER \acrshort{ISA} soft-core capable of running OpenBMC that meets reasonable performance requirements
\item \item
Design and build an FPGA image for LibreBMC that contains one or more of the POWER ISA soft cores, along with the required interfaces and Design and build an \acrshort{FPGA} image for LibreBMC that contains one or more of the POWER \acrshort{ISA} soft cores,
controls, that is capable of managing a server. along with the required interfaces and controls, that is capable of managing a server.
\item \item
Create required material to properly document how to recreate and use the design. Create required material to properly document how to recreate and use the design.
\item \item
Build a prototype of LibreBMC. Build a prototype of LibreBMC.
\item \item
Demonstrate the operability of LibreBMC containing the above mentioned FPGA image in a server. Demonstrate the operability of LibreBMC containing the above mentioned \acrshort{FPGA} image in a server.
\end{enumerate} \end{itemize}


\section{Participation} \section{Participation}


@ -125,59 +131,59 @@ Subsequent meetings will be held bi-weekly alternating between 5p CST Wednesday


\section{Participants} \section{Participants}


\begin{enumerate} \begin{itemize}
\item \item
IBM IBM
\begin{enumerate} \begin{itemize}
\item \item
Paul Lecocq (lecocq@us.ibm.com) Paul Lecocq (lecocq@us.ibm.com)
\item \item
Paul Mackerras (pmac@au1.ibm.com) Paul Mackerras (pmac@au1.ibm.com)
\item \item
Steve Roberts (robers@us.ibm.com) Steve Roberts (robers@us.ibm.com)
\end{enumerate} \end{itemize}
\item \item
Google Google
\begin{enumerate} \begin{itemize}
\item \item
Tim Ansel (tansell@google.com) Tim Ansel (tansell@google.com)
\end{enumerate} \end{itemize}
\item \item
Antmicro Antmicro
\begin{enumerate} \begin{itemize}
\item \item
Michael Gielda (mgielda@antmicro.com) Michael Gielda (mgielda@antmicro.com)
\end{enumerate} \end{itemize}
\item \item
Raptor Computing Systems Raptor Computing Systems
\begin{enumerate} \begin{itemize}
\item \item
Timothy Pearson (tpearson@raptorengineering.com) Timothy Pearson (tpearson@raptorengineering.com)
\end{enumerate} \end{itemize}
VanTosh VanTosh
\begin{enumerate} \begin{itemize}
\item \item
Toshaan Bharvani (toshaan@vantosh.com) Toshaan Bharvani (toshaan@vantosh.com)
\end{enumerate} \end{itemize}
Yadro Yadro
\begin{enumerate} \begin{itemize}
\item \item
Alexey Stepanov (a.stepanov@yadro.com) Alexey Stepanov (a.stepanov@yadro.com)
\end{enumerate} \end{itemize}
\end{enumerate} \end{itemize}


\section{Balloting Approval Requirements} \section{Balloting Approval Requirements}


While the WG aims to operate as a consensus based community from time to time a WG decision may require a vote to move a Project forward.\par While the WG aims to operate as a consensus based community from time to time a WG decision may require a vote to move a Project forward.\par


Standard WG Process applies with the following specific requirements with respect to Maintainers : Standard WG Process applies with the following specific requirements with respect to Maintainers :
\begin{enumerate} \begin{itemize}
\item \item
Election of repository Maintainer(s) will be by Full Majority Vote. Election of repository Maintainer(s) will be by Full Majority Vote.
A Maintainer can be removed from their position as Maintainer by Full Majority Vote as well. A Maintainer can be removed from their position as Maintainer by Full Majority Vote as well.
\item \item
The initial Maintainer(s) will be voted in prior to setting up the git repository for the project. The initial Maintainer(s) will be voted in prior to setting up the git repository for the project.
\end{enumerate} \end{itemize}


\section{Member Organization Support} \section{Member Organization Support}


@ -185,14 +191,14 @@ Member organization support will be confirmed as part of the approval process.


\section{Anticipated Contributions} \section{Anticipated Contributions}


\begin{enumerate} \begin{itemize}
\item \item
Power ISA Core RTL POWER \acrshort{ISA} Core \acrshort{RTL}
\item \item
RTL created as part of the workgroup deliverable \acrshort{RTL} created as part of the workgroup deliverable
\item \item
OCP DC-SCM compatible board schematics \acrshort{OCP} \acrshort{DC-SCM} compatible board schematics
\end{enumerate} \end{itemize}


\section{IPR, Confidentiality \& Licensing} \section{IPR, Confidentiality \& Licensing}


@ -231,31 +237,32 @@ The executed Contribution / Feedback License or Guest Participation Agreement mu


As a default position, all Code that is, or is made part of, an OpenPOWER Deliverable shall be licensed out by OpenPOWER under one of the following As a default position, all Code that is, or is made part of, an OpenPOWER Deliverable shall be licensed out by OpenPOWER under one of the following
licenses and shall at least be provided in source code form. licenses and shall at least be provided in source code form.
The selected license will include or be accompanied by a clarification that any necessary license rights for the Power ISA comes from The selected license will include or be accompanied by a clarification that any necessary license rights for the Power \acrshort{ISA} comes from
the Power ISA license and is not granted under the selected license for the OpenPOWER Deliverable. the POWER \acrshort{ISA} license and is not granted under the selected license for the OpenPOWER Deliverable.
\begin{enumerate} \begin{itemize}
\item \item
Apache License, V2.0 with the condition that the patent license granted in Section 3 of the License, as applied to the ``Work", Apache License, V2.0 with the condition that the patent license granted in Section 3 of the License, as applied to the ``Work",
hereby includes implementations of the Work in physical form. hereby includes implementations of the Work in physical form.
\item \item
a future open hardware license with WG, TSC, and Board approval. a future open hardware license with WG, TSC, and Board approval.
\end{itemize}


\subsection{Open Source Communities} \subsection{Open Source Communities}


This WG may accept Code from the following OS Communities under their respective licenses. This WG may accept Code from the following OS Communities under their respective licenses.


\begin{enumerate} \begin{itemize}
\item \item
LiteX LiteX
\begin{enumerate} \begin{itemize}
\item \item
https://github.com/enjoy-digital/litex https://github.com/enjoy-digital/litex
\item \item
2-Clause BSD 2-Clause BSD
\end{enumerate} \end{itemize}
\item \item
Microwatt POWER ISA Core Microwatt POWER ISA Core
\begin{enumerate} \begin{itemize}
\item \item
https://github.com/antonblanchard/microwatt https://github.com/antonblanchard/microwatt
\item \item
@ -263,73 +270,73 @@ Microwatt POWER ISA Core
\end{itemize} \end{itemize}
\item \item
Antmicro DC-SCM board Antmicro DC-SCM board
\begin{enumerate} \begin{itemize}
\item \item
https://github.com/antmicro/artix-dc-scm (ecp5-dc-scm) https://github.com/antmicro/artix-dc-scm (ecp5-dc-scm)
\item \item
Apache license, Version 2.0 Apache license, Version 2.0
\end{enumerate} \end{itemize}
\end{enumerate} \end{itemize}


This WG may accept other OS Code under a Permissive License such as Apache License, v2.0, 2 or 3 clause BSD, MIT, ISC, This WG may accept other OS Code under a Permissive License such as Apache License, v2.0, 2 or 3 clause BSD, MIT, ISC,
or other OS license approved by this WG, TSC and Board.\par or other \acrshort{OS} license approved by this WG, TSC and Board.\par


This WG may contribute Code to the following OS Communities under either the respective OS Communities required license or an approved WG deliverable This WG may contribute Code to the following \acrshort{OS} Communities under either the respective \acrshort{OS} Communities
license as defined in the above OS Licensing Mode.\par required license or an approved WG deliverable license as defined in the above \acrshort{OS} Licensing Mode.\par


\begin{enumerate} \begin{itemize}
\item \item
OpenBMC OpenBMC
\begin{enumerate} \begin{itemize}
\item \item
https://github.com/openbmc https://github.com/openbmc
\ite, \item
Apache license, Version 2.0 Apache license, Version 2.0
\end{enumerate} \end{itemize}
\item \item
LiteX LiteX
\begin{enumerate} \begin{itemize}
\item \item
https://github.com/enjoy-digital/litex https://github.com/enjoy-digital/litex
\item \item
2-Clause BSD 2-Clause BSD
\end{enumerate} \end{itemize}
Microwatt POWER ISA Core Microwatt POWER ISA Core
\begin{enumerate} \begin{itemize}
\item \item
https://github.com/antonblanchard/microwatt https://github.com/antonblanchard/microwatt
\item \item
Apache License, Version 2.0 Apache License, Version 2.0
\end{enumerate} \end{itemize}
Antmicro DC-SCM board Antmicro DC-SCM board
\begin{enumerate} \begin{itemize}
\item \item
o https://github.com/antmicro/artix-dc-scm or ecp5-dc-scm o https://github.com/antmicro/artix-dc-scm or ecp5-dc-scm
\item \item
Apache license, Version 2.0 Apache license, Version 2.0
\end{enumerate} \end{itemize}
SymbiFlow SymbiFlow
\begin{enumerate} \begin{itemize}
\item \item
https://symbiflow.github.io/ https://symbiflow.github.io/
\item \item
ISC License ISC License
\end{enumerate} \end{itemize}
Yosys Yosys
\begin{enumerate} \begin{itemize}
\item \item
http://www.clifford.at/yosys/ http://www.clifford.at/yosys/
\item \item
ISC License ISC License
\end{enumerate} \end{itemize}
Project X-Ray Project X-Ray
\begin{enumerate} \begin{itemize}
\item \item
https://github.com/SymbiFlow/prjxray https://github.com/SymbiFlow/prjxray
\item \item
ISC License ISC License
\end{enumerate} \end{itemize}
\end{enumerate} \end{itemize}


This WG may accept or contribute Code from/to additional OS Communities with approval by the WG, TSC, and Board. This WG may accept or contribute Code from/to additional OS Communities with approval by the WG, TSC, and Board.
Any code accepted from or contributed to approved OS Communities must be under a Permissive License such as Any code accepted from or contributed to approved OS Communities must be under a Permissive License such as

Write Preview
Loading…
Cancel
Save