Merge remote-tracking branch 'remotes/xtensa/tags/20210403-xtensa' into staging
[qemu/ar7.git] / docs / system / riscv / microchip-icicle-kit.rst
blob4fe97bce3f04deef035e01fc52eaa36edc177c26
1 Microchip PolarFire SoC Icicle Kit (``microchip-icicle-kit``)
2 =============================================================
4 Microchip PolarFire SoC Icicle Kit integrates a PolarFire SoC, with one
5 SiFive's E51 plus four U54 cores and many on-chip peripherals and an FPGA.
7 For more details about Microchip PolarFire SoC, please see:
8 https://www.microsemi.com/product-directory/soc-fpgas/5498-polarfire-soc-fpga
10 The Icicle Kit board information can be found here:
11 https://www.microsemi.com/existing-parts/parts/152514
13 Supported devices
14 -----------------
16 The ``microchip-icicle-kit`` machine supports the following devices:
18  * 1 E51 core
19  * 4 U54 cores
20  * Core Level Interruptor (CLINT)
21  * Platform-Level Interrupt Controller (PLIC)
22  * L2 Loosely Integrated Memory (L2-LIM)
23  * DDR memory controller
24  * 5 MMUARTs
25  * 1 DMA controller
26  * 2 GEM Ethernet controllers
27  * 1 SDHC storage controller
29 Boot options
30 ------------
32 The ``microchip-icicle-kit`` machine can start using the standard -bios
33 functionality for loading its BIOS image, aka Hart Software Services (HSS_).
34 HSS loads the second stage bootloader U-Boot from an SD card. It does not
35 support direct kernel loading via the -kernel option. One has to load kernel
36 from U-Boot.
38 The memory is set to 1537 MiB by default which is the minimum required high
39 memory size by HSS. A sanity check on ram size is performed in the machine
40 init routine to prompt user to increase the RAM size to > 1537 MiB when less
41 than 1537 MiB ram is detected.
43 Boot the machine
44 ----------------
46 HSS 2020.12 release is tested at the time of writing. To build an HSS image
47 that can be booted by the ``microchip-icicle-kit`` machine, type the following
48 in the HSS source tree:
50 .. code-block:: bash
52   $ export CROSS_COMPILE=riscv64-linux-
53   $ cp boards/mpfs-icicle-kit-es/def_config .config
54   $ make BOARD=mpfs-icicle-kit-es
56 Download the official SD card image released by Microchip and prepare it for
57 QEMU usage:
59 .. code-block:: bash
61   $ wget ftp://ftpsoc.microsemi.com/outgoing/core-image-minimal-dev-icicle-kit-es-sd-20201009141623.rootfs.wic.gz
62   $ gunzip core-image-minimal-dev-icicle-kit-es-sd-20201009141623.rootfs.wic.gz
63   $ qemu-img resize core-image-minimal-dev-icicle-kit-es-sd-20201009141623.rootfs.wic 4G
65 Then we can boot the machine by:
67 .. code-block:: bash
69   $ qemu-system-riscv64 -M microchip-icicle-kit -smp 5 \
70       -bios path/to/hss.bin -sd path/to/sdcard.img \
71       -nic user,model=cadence_gem \
72       -nic tap,ifname=tap,model=cadence_gem,script=no \
73       -display none -serial stdio \
74       -chardev socket,id=serial1,path=serial1.sock,server=on,wait=on \
75       -serial chardev:serial1
77 With above command line, current terminal session will be used for the first
78 serial port. Open another terminal window, and use `minicom` to connect the
79 second serial port.
81 .. code-block:: bash
83   $ minicom -D unix\#serial1.sock
85 HSS output is on the first serial port (stdio) and U-Boot outputs on the
86 second serial port. U-Boot will automatically load the Linux kernel from
87 the SD card image.
89 .. _HSS: https://github.com/polarfire-soc/hart-software-services