| Message ID | 20241018141332.942844-4-peter.maydell@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | docs/system/arm: Provide at least skeleton docs for all boards | expand |
On 10/18/24 16:13, Peter Maydell wrote: > The fby35 machine is not implemented in hw/arm/aspeed.c, > but its documentation is currently stuck at the end of aspeed.rst, > formatted in a way that it gets its own heading in the top-level > list of boards in target-arm.html. > > We don't have any other boards that we document like this; split it > out into its own rst file. This improves consistency with other > board docs and means we can have the entry in the target-arm > list be in the correct alphabetical order. > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Cédric Le Goater <clg@redhat.com> Thanks, C. > --- > MAINTAINERS | 1 + > docs/system/arm/aspeed.rst | 48 -------------------------------------- > docs/system/arm/fby35.rst | 47 +++++++++++++++++++++++++++++++++++++ > docs/system/target-arm.rst | 1 + > 4 files changed, 49 insertions(+), 48 deletions(-) > create mode 100644 docs/system/arm/fby35.rst > > diff --git a/MAINTAINERS b/MAINTAINERS > index c21d6a2f9e1..dff8073c5bc 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -1121,6 +1121,7 @@ F: include/hw/*/*aspeed* > F: hw/net/ftgmac100.c > F: include/hw/net/ftgmac100.h > F: docs/system/arm/aspeed.rst > +F: docs/system/arm/fby35.rst > F: tests/*/*aspeed* > F: hw/arm/fby35.c > > diff --git a/docs/system/arm/aspeed.rst b/docs/system/arm/aspeed.rst > index 968ba88b997..63910d382fe 100644 > --- a/docs/system/arm/aspeed.rst > +++ b/docs/system/arm/aspeed.rst > @@ -257,51 +257,3 @@ To boot a kernel directly from a Zephyr build tree: > > $ qemu-system-arm -M ast1030-evb -nographic \ > -kernel zephyr.elf > - > -Facebook Yosemite v3.5 Platform and CraterLake Server (``fby35``) > -================================================================== > - > -Facebook has a series of multi-node compute server designs named > -Yosemite. The most recent version released was > -`Yosemite v3 <https://www.opencompute.org/documents/ocp-yosemite-v3-platform-design-specification-1v16-pdf>`__. > - > -Yosemite v3.5 is an iteration on this design, and is very similar: there's a > -baseboard with a BMC, and 4 server slots. The new server board design termed > -"CraterLake" includes a Bridge IC (BIC), with room for expansion boards to > -include various compute accelerators (video, inferencing, etc). At the moment, > -only the first server slot's BIC is included. > - > -Yosemite v3.5 is itself a sled which fits into a 40U chassis, and 3 sleds > -can be fit into a chassis. See `here <https://www.opencompute.org/products/423/wiwynn-yosemite-v3-server>`__ > -for an example. > - > -In this generation, the BMC is an AST2600 and each BIC is an AST1030. The BMC > -runs `OpenBMC <https://github.com/facebook/openbmc>`__, and the BIC runs > -`OpenBIC <https://github.com/facebook/openbic>`__. > - > -Firmware images can be retrieved from the Github releases or built from the > -source code, see the README's for instructions on that. This image uses the > -"fby35" machine recipe from OpenBMC, and the "yv35-cl" target from OpenBIC. > -Some reference images can also be found here: > - > -.. code-block:: bash > - > - $ wget https://github.com/facebook/openbmc/releases/download/openbmc-e2294ff5d31d/fby35.mtd > - $ wget https://github.com/peterdelevoryas/OpenBIC/releases/download/oby35-cl-2022.13.01/Y35BCL.elf > - > -Since this machine has multiple SoC's, each with their own serial console, the > -recommended way to run it is to allocate a pseudoterminal for each serial > -console and let the monitor use stdio. Also, starting in a paused state is > -useful because it allows you to attach to the pseudoterminals before the boot > -process starts. > - > -.. code-block:: bash > - > - $ qemu-system-arm -machine fby35 \ > - -drive file=fby35.mtd,format=raw,if=mtd \ > - -device loader,file=Y35BCL.elf,addr=0,cpu-num=2 \ > - -serial pty -serial pty -serial mon:stdio \ > - -display none -S > - $ screen /dev/tty0 # In a separate TMUX pane, terminal window, etc. > - $ screen /dev/tty1 > - $ (qemu) c # Start the boot process once screen is setup. > diff --git a/docs/system/arm/fby35.rst b/docs/system/arm/fby35.rst > new file mode 100644 > index 00000000000..742b887d44c > --- /dev/null > +++ b/docs/system/arm/fby35.rst > @@ -0,0 +1,47 @@ > +Facebook Yosemite v3.5 Platform and CraterLake Server (``fby35``) > +================================================================== > + > +Facebook has a series of multi-node compute server designs named > +Yosemite. The most recent version released was > +`Yosemite v3 <https://www.opencompute.org/documents/ocp-yosemite-v3-platform-design-specification-1v16-pdf>`__. > + > +Yosemite v3.5 is an iteration on this design, and is very similar: there's a > +baseboard with a BMC, and 4 server slots. The new server board design termed > +"CraterLake" includes a Bridge IC (BIC), with room for expansion boards to > +include various compute accelerators (video, inferencing, etc). At the moment, > +only the first server slot's BIC is included. > + > +Yosemite v3.5 is itself a sled which fits into a 40U chassis, and 3 sleds > +can be fit into a chassis. See `here <https://www.opencompute.org/products/423/wiwynn-yosemite-v3-server>`__ > +for an example. > + > +In this generation, the BMC is an AST2600 and each BIC is an AST1030. The BMC > +runs `OpenBMC <https://github.com/facebook/openbmc>`__, and the BIC runs > +`OpenBIC <https://github.com/facebook/openbic>`__. > + > +Firmware images can be retrieved from the Github releases or built from the > +source code, see the README's for instructions on that. This image uses the > +"fby35" machine recipe from OpenBMC, and the "yv35-cl" target from OpenBIC. > +Some reference images can also be found here: > + > +.. code-block:: bash > + > + $ wget https://github.com/facebook/openbmc/releases/download/openbmc-e2294ff5d31d/fby35.mtd > + $ wget https://github.com/peterdelevoryas/OpenBIC/releases/download/oby35-cl-2022.13.01/Y35BCL.elf > + > +Since this machine has multiple SoC's, each with their own serial console, the > +recommended way to run it is to allocate a pseudoterminal for each serial > +console and let the monitor use stdio. Also, starting in a paused state is > +useful because it allows you to attach to the pseudoterminals before the boot > +process starts. > + > +.. code-block:: bash > + > + $ qemu-system-arm -machine fby35 \ > + -drive file=fby35.mtd,format=raw,if=mtd \ > + -device loader,file=Y35BCL.elf,addr=0,cpu-num=2 \ > + -serial pty -serial pty -serial mon:stdio \ > + -display none -S > + $ screen /dev/tty0 # In a separate TMUX pane, terminal window, etc. > + $ screen /dev/tty1 > + $ (qemu) c # Start the boot process once screen is setup. > diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst > index 3c0a5848453..9c01e66ffa9 100644 > --- a/docs/system/target-arm.rst > +++ b/docs/system/target-arm.rst > @@ -90,6 +90,7 @@ undocumented; you can get a complete list by running > arm/digic > arm/cubieboard > arm/emcraft-sf2 > + arm/fby35 > arm/musicpal > arm/kzm > arm/nrf
diff --git a/MAINTAINERS b/MAINTAINERS index c21d6a2f9e1..dff8073c5bc 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1121,6 +1121,7 @@ F: include/hw/*/*aspeed* F: hw/net/ftgmac100.c F: include/hw/net/ftgmac100.h F: docs/system/arm/aspeed.rst +F: docs/system/arm/fby35.rst F: tests/*/*aspeed* F: hw/arm/fby35.c diff --git a/docs/system/arm/aspeed.rst b/docs/system/arm/aspeed.rst index 968ba88b997..63910d382fe 100644 --- a/docs/system/arm/aspeed.rst +++ b/docs/system/arm/aspeed.rst @@ -257,51 +257,3 @@ To boot a kernel directly from a Zephyr build tree: $ qemu-system-arm -M ast1030-evb -nographic \ -kernel zephyr.elf - -Facebook Yosemite v3.5 Platform and CraterLake Server (``fby35``) -================================================================== - -Facebook has a series of multi-node compute server designs named -Yosemite. The most recent version released was -`Yosemite v3 <https://www.opencompute.org/documents/ocp-yosemite-v3-platform-design-specification-1v16-pdf>`__. - -Yosemite v3.5 is an iteration on this design, and is very similar: there's a -baseboard with a BMC, and 4 server slots. The new server board design termed -"CraterLake" includes a Bridge IC (BIC), with room for expansion boards to -include various compute accelerators (video, inferencing, etc). At the moment, -only the first server slot's BIC is included. - -Yosemite v3.5 is itself a sled which fits into a 40U chassis, and 3 sleds -can be fit into a chassis. See `here <https://www.opencompute.org/products/423/wiwynn-yosemite-v3-server>`__ -for an example. - -In this generation, the BMC is an AST2600 and each BIC is an AST1030. The BMC -runs `OpenBMC <https://github.com/facebook/openbmc>`__, and the BIC runs -`OpenBIC <https://github.com/facebook/openbic>`__. - -Firmware images can be retrieved from the Github releases or built from the -source code, see the README's for instructions on that. This image uses the -"fby35" machine recipe from OpenBMC, and the "yv35-cl" target from OpenBIC. -Some reference images can also be found here: - -.. code-block:: bash - - $ wget https://github.com/facebook/openbmc/releases/download/openbmc-e2294ff5d31d/fby35.mtd - $ wget https://github.com/peterdelevoryas/OpenBIC/releases/download/oby35-cl-2022.13.01/Y35BCL.elf - -Since this machine has multiple SoC's, each with their own serial console, the -recommended way to run it is to allocate a pseudoterminal for each serial -console and let the monitor use stdio. Also, starting in a paused state is -useful because it allows you to attach to the pseudoterminals before the boot -process starts. - -.. code-block:: bash - - $ qemu-system-arm -machine fby35 \ - -drive file=fby35.mtd,format=raw,if=mtd \ - -device loader,file=Y35BCL.elf,addr=0,cpu-num=2 \ - -serial pty -serial pty -serial mon:stdio \ - -display none -S - $ screen /dev/tty0 # In a separate TMUX pane, terminal window, etc. - $ screen /dev/tty1 - $ (qemu) c # Start the boot process once screen is setup. diff --git a/docs/system/arm/fby35.rst b/docs/system/arm/fby35.rst new file mode 100644 index 00000000000..742b887d44c --- /dev/null +++ b/docs/system/arm/fby35.rst @@ -0,0 +1,47 @@ +Facebook Yosemite v3.5 Platform and CraterLake Server (``fby35``) +================================================================== + +Facebook has a series of multi-node compute server designs named +Yosemite. The most recent version released was +`Yosemite v3 <https://www.opencompute.org/documents/ocp-yosemite-v3-platform-design-specification-1v16-pdf>`__. + +Yosemite v3.5 is an iteration on this design, and is very similar: there's a +baseboard with a BMC, and 4 server slots. The new server board design termed +"CraterLake" includes a Bridge IC (BIC), with room for expansion boards to +include various compute accelerators (video, inferencing, etc). At the moment, +only the first server slot's BIC is included. + +Yosemite v3.5 is itself a sled which fits into a 40U chassis, and 3 sleds +can be fit into a chassis. See `here <https://www.opencompute.org/products/423/wiwynn-yosemite-v3-server>`__ +for an example. + +In this generation, the BMC is an AST2600 and each BIC is an AST1030. The BMC +runs `OpenBMC <https://github.com/facebook/openbmc>`__, and the BIC runs +`OpenBIC <https://github.com/facebook/openbic>`__. + +Firmware images can be retrieved from the Github releases or built from the +source code, see the README's for instructions on that. This image uses the +"fby35" machine recipe from OpenBMC, and the "yv35-cl" target from OpenBIC. +Some reference images can also be found here: + +.. code-block:: bash + + $ wget https://github.com/facebook/openbmc/releases/download/openbmc-e2294ff5d31d/fby35.mtd + $ wget https://github.com/peterdelevoryas/OpenBIC/releases/download/oby35-cl-2022.13.01/Y35BCL.elf + +Since this machine has multiple SoC's, each with their own serial console, the +recommended way to run it is to allocate a pseudoterminal for each serial +console and let the monitor use stdio. Also, starting in a paused state is +useful because it allows you to attach to the pseudoterminals before the boot +process starts. + +.. code-block:: bash + + $ qemu-system-arm -machine fby35 \ + -drive file=fby35.mtd,format=raw,if=mtd \ + -device loader,file=Y35BCL.elf,addr=0,cpu-num=2 \ + -serial pty -serial pty -serial mon:stdio \ + -display none -S + $ screen /dev/tty0 # In a separate TMUX pane, terminal window, etc. + $ screen /dev/tty1 + $ (qemu) c # Start the boot process once screen is setup. diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst index 3c0a5848453..9c01e66ffa9 100644 --- a/docs/system/target-arm.rst +++ b/docs/system/target-arm.rst @@ -90,6 +90,7 @@ undocumented; you can get a complete list by running arm/digic arm/cubieboard arm/emcraft-sf2 + arm/fby35 arm/musicpal arm/kzm arm/nrf
The fby35 machine is not implemented in hw/arm/aspeed.c, but its documentation is currently stuck at the end of aspeed.rst, formatted in a way that it gets its own heading in the top-level list of boards in target-arm.html. We don't have any other boards that we document like this; split it out into its own rst file. This improves consistency with other board docs and means we can have the entry in the target-arm list be in the correct alphabetical order. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> --- MAINTAINERS | 1 + docs/system/arm/aspeed.rst | 48 -------------------------------------- docs/system/arm/fby35.rst | 47 +++++++++++++++++++++++++++++++++++++ docs/system/target-arm.rst | 1 + 4 files changed, 49 insertions(+), 48 deletions(-) create mode 100644 docs/system/arm/fby35.rst