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