xref: /openbmc/qemu/docs/system/arm/aspeed.rst (revision 93e0932b)
1Aspeed family boards (``*-bmc``, ``ast2500-evb``, ``ast2600-evb``)
2==================================================================
3
4The QEMU Aspeed machines model BMCs of various OpenPOWER systems and
5Aspeed evaluation boards. They are based on different releases of the
6Aspeed SoC : the AST2400 integrating an ARM926EJ-S CPU (400MHz), the
7AST2500 with an ARM1176JZS CPU (800MHz) and more recently the AST2600
8with dual cores ARM Cortex-A7 CPUs (1.2GHz).
9
10The SoC comes with RAM, Gigabit ethernet, USB, SD/MMC, USB, SPI, I2C,
11etc.
12
13AST2400 SoC based machines :
14
15- ``palmetto-bmc``         OpenPOWER Palmetto POWER8 BMC
16- ``quanta-q71l-bmc``      OpenBMC Quanta BMC
17- ``supermicrox11-bmc``    Supermicro X11 BMC
18
19AST2500 SoC based machines :
20
21- ``ast2500-evb``          Aspeed AST2500 Evaluation board
22- ``romulus-bmc``          OpenPOWER Romulus POWER9 BMC
23- ``witherspoon-bmc``      OpenPOWER Witherspoon POWER9 BMC
24- ``sonorapass-bmc``       OCP SonoraPass BMC
25- ``fp5280g2-bmc``         Inspur FP5280G2 BMC
26- ``g220a-bmc``            Bytedance G220A BMC
27
28AST2600 SoC based machines :
29
30- ``ast2600-evb``          Aspeed AST2600 Evaluation board (Cortex-A7)
31- ``tacoma-bmc``           OpenPOWER Witherspoon POWER9 AST2600 BMC
32- ``rainier-bmc``          IBM Rainier POWER10 BMC
33- ``fuji-bmc``             Facebook Fuji BMC
34- ``bletchley-bmc``        Facebook Bletchley BMC
35- ``fby35-bmc``            Facebook fby35 BMC
36- ``qcom-dc-scm-v1-bmc``   Qualcomm DC-SCM V1 BMC
37- ``qcom-firework-bmc``    Qualcomm Firework BMC
38
39Supported devices
40-----------------
41
42 * SMP (for the AST2600 Cortex-A7)
43 * Interrupt Controller (VIC)
44 * Timer Controller
45 * RTC Controller
46 * I2C Controller, including the new register interface of the AST2600
47 * System Control Unit (SCU)
48 * SRAM mapping
49 * X-DMA Controller (basic interface)
50 * Static Memory Controller (SMC or FMC) - Only SPI Flash support
51 * SPI Memory Controller
52 * USB 2.0 Controller
53 * SD/MMC storage controllers
54 * SDRAM controller (dummy interface for basic settings and training)
55 * Watchdog Controller
56 * GPIO Controller (Master only)
57 * UART
58 * Ethernet controllers
59 * Front LEDs (PCA9552 on I2C bus)
60 * LPC Peripheral Controller (a subset of subdevices are supported)
61 * Hash/Crypto Engine (HACE) - Hash support only. TODO: HMAC and RSA
62 * ADC
63 * Secure Boot Controller (AST2600)
64 * eMMC Boot Controller (dummy)
65 * PECI Controller (minimal)
66 * I3C Controller
67
68
69Missing devices
70---------------
71
72 * Coprocessor support
73 * PWM and Fan Controller
74 * Slave GPIO Controller
75 * Super I/O Controller
76 * PCI-Express 1 Controller
77 * Graphic Display Controller
78 * MCTP Controller
79 * Mailbox Controller
80 * Virtual UART
81 * eSPI Controller
82
83Boot options
84------------
85
86The Aspeed machines can be started using the ``-kernel`` and ``-dtb`` options
87to load a Linux kernel or from a firmware. Images can be downloaded from the
88OpenBMC jenkins :
89
90   https://jenkins.openbmc.org/job/ci-openbmc/lastSuccessfulBuild/
91
92or directly from the OpenBMC GitHub release repository :
93
94   https://github.com/openbmc/openbmc/releases
95
96To boot a kernel directly from a Linux build tree:
97
98.. code-block:: bash
99
100  $ qemu-system-arm -M ast2600-evb -nographic \
101        -kernel arch/arm/boot/zImage \
102        -dtb arch/arm/boot/dts/aspeed-ast2600-evb.dtb \
103        -initrd rootfs.cpio
104
105The image should be attached as an MTD drive. Run :
106
107.. code-block:: bash
108
109  $ qemu-system-arm -M romulus-bmc -nic user \
110	-drive file=obmc-phosphor-image-romulus.static.mtd,format=raw,if=mtd -nographic
111
112Options specific to Aspeed machines are :
113
114 * ``execute-in-place`` which emulates the boot from the CE0 flash
115   device by using the FMC controller to load the instructions, and
116   not simply from RAM. This takes a little longer.
117
118 * ``fmc-model`` to change the FMC Flash model. FW needs support for
119   the chip model to boot.
120
121 * ``spi-model`` to change the SPI Flash model.
122
123For instance, to start the ``ast2500-evb`` machine with a different
124FMC chip and a bigger (64M) SPI chip, use :
125
126.. code-block:: bash
127
128  -M ast2500-evb,fmc-model=mx25l25635e,spi-model=mx66u51235f
129
130
131Aspeed minibmc family boards (``ast1030-evb``)
132==================================================================
133
134The QEMU Aspeed machines model mini BMCs of various Aspeed evaluation
135boards. They are based on different releases of the
136Aspeed SoC : the AST1030 integrating an ARM Cortex M4F CPU (200MHz).
137
138The SoC comes with SRAM, SPI, I2C, etc.
139
140AST1030 SoC based machines :
141
142- ``ast1030-evb``          Aspeed AST1030 Evaluation board (Cortex-M4F)
143
144Supported devices
145-----------------
146
147 * SMP (for the AST1030 Cortex-M4F)
148 * Interrupt Controller (VIC)
149 * Timer Controller
150 * I2C Controller
151 * System Control Unit (SCU)
152 * SRAM mapping
153 * Static Memory Controller (SMC or FMC) - Only SPI Flash support
154 * SPI Memory Controller
155 * USB 2.0 Controller
156 * Watchdog Controller
157 * GPIO Controller (Master only)
158 * UART
159 * LPC Peripheral Controller (a subset of subdevices are supported)
160 * Hash/Crypto Engine (HACE) - Hash support only. TODO: HMAC and RSA
161 * ADC
162 * Secure Boot Controller
163 * PECI Controller (minimal)
164
165
166Missing devices
167---------------
168
169 * PWM and Fan Controller
170 * Slave GPIO Controller
171 * Mailbox Controller
172 * Virtual UART
173 * eSPI Controller
174 * I3C Controller
175
176Boot options
177------------
178
179The Aspeed machines can be started using the ``-kernel`` to load a
180Zephyr OS or from a firmware. Images can be downloaded from the
181ASPEED GitHub release repository :
182
183   https://github.com/AspeedTech-BMC/zephyr/releases
184
185To boot a kernel directly from a Zephyr build tree:
186
187.. code-block:: bash
188
189  $ qemu-system-arm -M ast1030-evb -nographic \
190        -kernel zephyr.elf
191
192Facebook Yosemite v3.5 Platform and CraterLake Server (``fby35``)
193==================================================================
194
195Facebook has a series of multi-node compute server designs named
196Yosemite. The most recent version released was
197`Yosemite v3 <https://www.opencompute.org/documents/ocp-yosemite-v3-platform-design-specification-1v16-pdf>`__.
198
199Yosemite v3.5 is an iteration on this design, and is very similar: there's a
200baseboard with a BMC, and 4 server slots. The new server board design termed
201"CraterLake" includes a Bridge IC (BIC), with room for expansion boards to
202include various compute accelerators (video, inferencing, etc). At the moment,
203only the first server slot's BIC is included.
204
205Yosemite v3.5 is itself a sled which fits into a 40U chassis, and 3 sleds
206can be fit into a chassis. See `here <https://www.opencompute.org/products/423/wiwynn-yosemite-v3-server>`__
207for an example.
208
209In this generation, the BMC is an AST2600 and each BIC is an AST1030. The BMC
210runs `OpenBMC <https://github.com/facebook/openbmc>`__, and the BIC runs
211`OpenBIC <https://github.com/facebook/openbic>`__.
212
213Firmware images can be retrieved from the Github releases or built from the
214source code, see the README's for instructions on that. This image uses the
215"fby35" machine recipe from OpenBMC, and the "yv35-cl" target from OpenBIC.
216Some reference images can also be found here:
217
218.. code-block:: bash
219
220    $ wget https://github.com/facebook/openbmc/releases/download/openbmc-e2294ff5d31d/fby35.mtd
221    $ wget https://github.com/peterdelevoryas/OpenBIC/releases/download/oby35-cl-2022.13.01/Y35BCL.elf
222
223Since this machine has multiple SoC's, each with their own serial console, the
224recommended way to run it is to allocate a pseudoterminal for each serial
225console and let the monitor use stdio. Also, starting in a paused state is
226useful because it allows you to attach to the pseudoterminals before the boot
227process starts.
228
229.. code-block:: bash
230
231    $ qemu-system-arm -machine fby35 \
232        -drive file=fby35.mtd,format=raw,if=mtd \
233        -device loader,file=Y35BCL.elf,addr=0,cpu-num=2 \
234        -serial pty -serial pty -serial mon:stdio \
235        -display none -S
236    $ screen /dev/tty0 # In a separate TMUX pane, terminal window, etc.
237    $ screen /dev/tty1
238    $ (qemu) c		   # Start the boot process once screen is setup.
239