docs/development/add-new-system.md

1 # Add a New System to OpenBMC
3 **Document Purpose:** How to add a new system to the OpenBMC distribution
5 **Audience:** Programmer familiar with OpenBMC
11 **Please note:** This document is no longer officially supported by the OpenBMC
27 The OpenBMC distribution is based on [Yocto](https://www.yoctoproject.org/).
29 OpenBMC uses Yocto to create their embedded Linux distribution to run on a
33 distribution, you define a set of layers for that distribution. OpenBMC uses
35 defined within OpenBMC can be found with the meta-\* directories in OpenBMC
36 [GitHub](https://github.com/openbmc/openbmc).
50 build of an OpenBMC distribution can take hours. Once that first build is done
56 Follow the direction on the OpenBMC GitHub
57 [page](https://github.com/openbmc/openbmc/blob/master/README.md#2-download-the-source)
66 From your openbmc repository you cloned above, the Romulus layer is defined
93    meta-openembedded/meta-oe, ...). It also has OpenBMC layers like
103    with your new layer. This remains the same as it is common for all OpenBMC
170    The openbmc/skeleton repository was used for initial prototyping of OpenBMC.
172    [configs](https://github.com/openbmc/skeleton/tree/master/configs) directory.
231    OpenBMC system, you need to send these kernel updates upstream. The linked
233    [thread](https://lists.ozlabs.org/pipermail/openbmc/2018-September/013260.html)
279 This section describes how you can make changes to the kernel to port OpenBMC to
281 <https://github.com/openbmc/linux/tree/dev-4.13/arch/arm/boot/dts>. For
292      `openbmc-flash-layout.dtsi`.
294 3. Reference to [openbmc kernel doc][31] on submitting patches to mailing list.
308 In legacy OpenBMC, there is a "workbook" to describe the machine's services,
310 by other services in [skeleton][3]. In the latest OpenBMC, the skeleton services
314 [meta-quanta][4] is an example that defines its own config in OpenBMC tree, so
382 There is detailed document in openbmc [doc/architecture/sensor-architecture][6].
571 specific configs shall be written when porting OpenBMC to a new machine.
834   https://github.com/openbmc/linux/blob/dev-4.13/arch/arm/boot/dts/aspeed-bmc-opp-romulus.dts
835 [2]: https://lists.ozlabs.org/listinfo/openbmc
836 [3]: https://github.com/openbmc/skeleton
838   https://github.com/openbmc/openbmc/tree/master/meta-quanta/meta-q71l/recipes-phosphor/workbook
839 [5]: https://github.com/openbmc/skeleton/blob/master/configs/Romulus.py
841   https://github.com/openbmc/docs/blob/master/architecture/sensor-architecture.md
843   https://github.com/openbmc/openbmc/tree/master/meta-ibm/meta-romulus/recipes-phosphor/sensors
845 …https://github.com/openbmc/openbmc/blob/298c4328fd20fcd7645da1565c143b1b668ef541/meta-ibm/meta-rom…
847 …https://github.com/openbmc/linux/blob/aca92be80c008bceeb6fb62fd1d450b5be5d0a4f/arch/arm/boot/dts/a…
849 …https://github.com/openbmc/openbmc/blob/298c4328fd20fcd7645da1565c143b1b668ef541/meta-ibm/meta-rom…
851 …https://github.com/openbmc/openbmc/blob/298c4328fd20fcd7645da1565c143b1b668ef541/meta-ibm/meta-rom…
853 …https://github.com/openbmc/linux/blob/aca92be80c008bceeb6fb62fd1d450b5be5d0a4f/arch/arm/boot/dts/a…
854 [13]: https://github.com/openbmc/phosphor-mrw-tools
856 …https://github.com/openbmc/openbmc/blob/764b88f4056cc98082e233216704e94613499e64/meta-ibm/meta-wit…
858   https://github.com/openbmc/openbmc/tree/master/meta-ibm/meta-romulus/recipes-phosphor/ipmi
859 [16]: https://github.com/openbmc/phosphor-fan-presence
861   https://github.com/openbmc/phosphor-fan-presence/blob/master/control/example/events.yaml
863   https://github.com/openbmc/openbmc/tree/master/meta-ibm/meta-witherspoon/recipes-phosphor/fans
865 …https://github.com/openbmc/openbmc/blob/master/meta-ibm/meta-witherspoon/recipes-phosphor/gpio/pho…
867 …https://github.com/openbmc/openbmc/blob/master/meta-ingrasys/meta-zaius/recipes-phosphor/gpio/phos…
869 …https://github.com/openbmc/openbmc/blob/master/meta-openpower/recipes-phosphor/host/checkstop-moni…
871 …https://github.com/openbmc/openbmc/blob/master/meta-ingrasys/meta-zaius/recipes-phosphor/host/chec…
873   https://github.com/openbmc/openbmc/tree/master/meta-ibm/meta-romulus/recipes-phosphor/gpio
875   https://github.com/openbmc/linux/blob/dev-4.13/include/dt-bindings/gpio/aspeed-gpio.h
877   https://github.com/openbmc/openbmc/commit/e0e69beab7c268e4ad98972016c78b0d7d5769ac
879   https://github.com/openbmc/openbmc/commit/2a80da2262bf13aa1ddb589cf3f2b672d26b0975
881 …https://github.com/openbmc/openbmc/blob/3cce45a96f0416b4c3d8f2b698cb830662a29227/meta-ibm/meta-rom…
882 [29]: https://github.com/openbmc/phosphor-led-manager/tree/master/fault-monitor
883 [31]: https://github.com/openbmc/docs/blob/master/kernel-development.md
884 [32]: https://github.com/openbmc/docs/blob/master/development/dev-environment.md