Support for Microchip PolarFire SoC (MPFS250)

Author: dgarske

.github/workflows/test-build-riscv.yml

@@ -26,6 +26,7 @@ jobs:
           submodules: true
 
       - uses: actions/checkout@v4
+        if: ${{ inputs.arch == 'riscv' }}
         with:
           repository: sifive/freedom-e-sdk
           path: freedom-e-sdk
@@ -79,12 +80,21 @@ jobs:
       - name: Update repository
         run: sudo apt-get update -o Acquire::Retries=3
 
-      - name: Download and install SiFive RISC-V toolchain
+      - name: Download and install RISC-V toolchain
+        if: ${{ inputs.arch == 'riscv' }}
         run: |
-          # Download SiFive prebuilt toolchain with newlib
-          wget -q https://static.dev.sifive.com/dev-tools/freedom-tools/v2020.12/riscv64-unknown-elf-toolchain-10.2.0-2020.12.8-x86_64-linux-ubuntu14.tar.gz
-          tar xzf riscv64-unknown-elf-toolchain-10.2.0-2020.12.8-x86_64-linux-ubuntu14.tar.gz
-          echo "$GITHUB_WORKSPACE/riscv64-unknown-elf-toolchain-10.2.0-2020.12.8-x86_64-linux-ubuntu14/bin" >> $GITHUB_PATH
+          # Download latest prebuilt RISC-V toolchains
+          wget -q https://github.com/RISCV-Tools/riscv-gnu-toolchain/releases/latest/download/riscv32-elf-ubuntu-24.04-gcc.tar.xz
+          tar -xf riscv32-elf-ubuntu-24.04-gcc.tar.xz
+          echo "$GITHUB_WORKSPACE/riscv/bin" >> $GITHUB_PATH
+
+      - name: Download and install RISC-V toolchain
+        if: ${{ inputs.arch == 'riscv64' }}
+        run: |
+          # Download latest prebuilt RISC-V toolchains
+          wget -q https://github.com/RISCV-Tools/riscv-gnu-toolchain/releases/latest/download/riscv64-elf-ubuntu-24.04-gcc.tar.xz
+          tar -xf riscv64-elf-ubuntu-24.04-gcc.tar.xz
+          echo "$GITHUB_WORKSPACE/riscv/bin" >> $GITHUB_PATH
 
       - name: make clean
         run: |
@@ -98,7 +108,12 @@ jobs:
         run: |
           make -C tools/keytools && make -C tools/bin-assemble
 
-      - name: Build wolfboot
+      - name: Build wolfboot (riscv32)
+        if: ${{ inputs.arch == 'riscv' }}
         run: |
-          make FREEDOM_E_SDK=$GITHUB_WORKSPACE/freedom-e-sdk CROSS_COMPILE=riscv64-unknown-elf- ${{inputs.make-args}}
+          make CROSS_COMPILE=riscv32-unknown-elf- FREEDOM_E_SDK=$GITHUB_WORKSPACE/freedom-e-sdk ${{inputs.make-args}}
 
+      - name: Build wolfboot (riscv64))
+        if: ${{ inputs.arch == 'riscv64' }}
+        run: |
+          make CROSS_COMPILE=riscv64-unknown-elf- ${{inputs.make-args}}

.github/workflows/test-configs.yml

@@ -19,6 +19,9 @@ jobs:
     with:
       arch: riscv
       config-file: ./config/examples/hifive1.config
+      # Only building wolfBoot - not test app for now (cross compiler cannot find suitable multilib set for '-march=rv32imafdc_zicsr_zmmul_zaamo_zalrsc_zca_zcd_zcf'/'-mabi=ilp32d')
+      # Consider building cached RISCV64 toolchain for this target
+      test-args: wolfboot.bin
 
   sama5d3_test:
     uses: ./.github/workflows/test-build.yml
@@ -207,6 +210,15 @@ jobs:
       arch: arm
       config-file: ./config/examples/mcxw-tz.config
 
+  microchip_mpfs250_test:
+    uses: ./.github/workflows/test-build-riscv.yml
+    with:
+      arch: riscv64
+      config-file: ./config/examples/polarfire_mpfs250.config
+      # Only building wolfBoot - not test app for now (cross compiler cannot find suitable multilib set for '-march=rv64imafd_zicsr_zmmul_zaamo_zalrsc'/'-mabi=lp64d')
+      # Consider building cached RISCV64 toolchain for this target
+      test-args: wolfboot.bin
+
   raspi3_test:
     uses: ./.github/workflows/test-build.yml
     with:

Makefile

@@ -528,7 +528,7 @@ line-count-nrf52:
 	cloc --force-lang-def cloc_lang_def.txt src/boot_arm.c src/image.c src/libwolfboot.c src/loader.c src/update_flash.c hal/nrf52.c
 
 line-count-x86:
-	cloc --force-lang-def cloc_lang_def.txt src/boot_x86_fsp.c src/boot_x86_fsp_payload.c src/boot_x86_fsp_start.S src/image.c src/keystore.c src/libwolfboot.c src/loader.c src/string.c src/update_disk.c src/x86/ahci.c src/x86/ata.c src/x86/common.c src/x86/gpt.c src/x86/hob.c src/pci.c src/x86/tgl_fsp.c hal/x86_fsp_tgl.c hal/x86_uart.c
+	cloc --force-lang-def cloc_lang_def.txt src/boot_x86_fsp.c src/boot_x86_fsp_payload.c src/boot_x86_fsp_start.S src/image.c src/keystore.c src/libwolfboot.c src/loader.c src/string.c src/update_disk.c src/gpt.c src/x86/ahci.c src/x86/ata.c src/x86/common.c src/x86/disk.c src/x86/hob.c src/pci.c src/x86/tgl_fsp.c hal/x86_fsp_tgl.c hal/x86_uart.c
 
 stack-usage: wolfboot.bin
 	$(Q)echo $(STACK_USAGE) > .stack_usage

arch.mk

@@ -545,8 +545,10 @@ endif
 ## RISCV
 ifeq ($(ARCH),RISCV)
   CROSS_COMPILE?=riscv32-unknown-elf-
-  CFLAGS+=-fno-builtin-printf -DUSE_M_TIME -g -march=rv32imac -mabi=ilp32 -mcmodel=medany -nostartfiles -DARCH_RISCV
-  LDFLAGS+=-march=rv32imac -mabi=ilp32 -mcmodel=medany
+  ARCH_FLAGS=-march=rv32imac -mabi=ilp32 -mcmodel=medany
+  CFLAGS+=-fno-builtin-printf -DUSE_M_TIME -g -nostartfiles -DARCH_RISCV
+  CFLAGS+=$(ARCH_FLAGS)
+  LDFLAGS+=$(ARCH_FLAGS)
   MATH_OBJS += $(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/sp_c32.o
 
   # Prune unused functions and data
@@ -557,6 +559,39 @@ ifeq ($(ARCH),RISCV)
   ARCH_FLASH_OFFSET=0x20010000
 endif
 
+## RISCV64
+ifeq ($(ARCH),RISCV64)
+  CROSS_COMPILE?=riscv64-unknown-elf-
+  CFLAGS+=-DMMU -DWOLFBOOT_DUALBOOT
+  CFLAGS+=-DWOLFBOOT_UPDATE_DISK
+  UPDATE_OBJS:=src/update_disk.o
+  OBJS += src/gpt.o
+  ARCH_FLAGS=-march=rv64imafd -mabi=lp64d -mcmodel=medany
+  CFLAGS+=-fno-builtin-printf -DUSE_M_TIME -g -nostartfiles -DARCH_RISCV64
+  CFLAGS+=$(ARCH_FLAGS)
+  LDFLAGS+=$(ARCH_FLAGS)
+
+  # Prune unused functions and data
+  CFLAGS +=-ffunction-sections -fdata-sections
+  LDFLAGS+=-Wl,--gc-sections
+
+  OBJS+=src/boot_riscv64_start.o src/boot_riscv64.o src/vector_riscv64.o
+
+  CFLAGS+=-DWOLFBOOT_FDT
+  OBJS+=src/fdt.o
+
+  ifeq ($(SPMATH),1)
+    MATH_OBJS += $(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/sp_c64.o
+  endif
+
+  ifneq ($(NO_ASM),1)
+    MATH_OBJS+=$(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/port/riscv/riscv-64-sha256.o \
+               $(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/port/riscv/riscv-64-sha512.o \
+               $(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/port/riscv/riscv-64-sha3.o \
+               $(WOLFBOOT_LIB_WOLFSSL)/wolfcrypt/src/port/riscv/riscv-64-aes.o
+  endif
+endif
+
 # powerpc
 ifeq ($(ARCH),PPC)
   CROSS_COMPILE?=powerpc-linux-gnu-
@@ -815,7 +850,7 @@ ifeq ($(TARGET),nxp_t1024)
   ARCH_FLAGS=-mhard-float -mcpu=e5500
   CFLAGS+=$(ARCH_FLAGS)
   BIG_ENDIAN=1
-  CFLAGS+=-DMMU -DWOLFBOOT_DUALBOOT
+  CFLAGS+=-DMMU -DWOLFBOOT_FDT -DWOLFBOOT_DUALBOOT
   CFLAGS+=-pipe # use pipes instead of temp files
   CFLAGS+=-feliminate-unused-debug-types
   LDFLAGS+=$(ARCH_FLAGS)
@@ -836,7 +871,7 @@ ifeq ($(TARGET),nxp_t2080)
   ARCH_FLAGS=-mhard-float -mcpu=e6500
   CFLAGS+=$(ARCH_FLAGS)
   BIG_ENDIAN=1
-  CFLAGS+=-DMMU -DWOLFBOOT_DUALBOOT
+  CFLAGS+=-DMMU -DWOLFBOOT_FDT -DWOLFBOOT_DUALBOOT
   CFLAGS+=-pipe # use pipes instead of temp files
   CFLAGS+=-feliminate-unused-debug-types
   LDFLAGS+=$(ARCH_FLAGS)
@@ -1012,6 +1047,8 @@ ifeq ("${FSP}", "1")
   LD_START_GROUP =
   LD_END_GROUP =
   LD := ld
+  # load to address in RAM after wolfBoot (aligned to 16 bytes)
+  CFLAGS+=-DWOLFBOOT_NO_LOAD_ADDRESS
   ifeq ($(filter-out $(STAGE1),1),)
     # building stage1
     ifeq ($(FSP_TGL), 1)
@@ -1079,7 +1116,8 @@ ifeq ("${FSP}", "1")
     CFLAGS+=-DWOLFBOOT_USE_PCI
     OBJS += src/x86/ahci.o
     OBJS += src/x86/ata.o
-    OBJS += src/x86/gpt.o
+    OBJS += src/gpt.o
+    OBJS += src/x86/disk.o
     OBJS += src/x86/mptable.o
     OBJS += src/stage2_params.o
     OBJS += src/x86/exceptions.o
@@ -1339,7 +1377,7 @@ BOOT_IMG?=test-app/image.bin
 
 ## Update mechanism
 ifeq ($(ARCH),AARCH64)
-  CFLAGS+=-DMMU -DWOLFBOOT_DUALBOOT
+  CFLAGS+=-DMMU -DWOLFBOOT_FDT -DWOLFBOOT_DUALBOOT
   OBJS+=src/fdt.o
   UPDATE_OBJS:=src/update_ram.o
 else

config/examples/polarfire_mpfs250.config

@@ -0,0 +1,54 @@
+ARCH?=RISCV64
+TARGET?=mpfs250
+SIGN?=ECC384
+HASH?=SHA384
+IMAGE_HEADER_SIZE=512
+WOLFBOOT_VERSION?=1
+ARMORED?=0
+DEBUG?=0
+DEBUG_SYMBOLS?=1
+DEBUG_UART?=1
+VTOR?=1
+EXT_FLASH?=1
+SPI_FLASH?=0
+NO_XIP?=1
+NVM_FLASH_WRITEONCE?=0
+UART_FLASH?=0
+V?=0
+NO_MPU?=1
+RAM_CODE?=0
+SPMATH?=1
+DUALBANK_SWAP?=0
+PKA?=0
+ENCRYPT=0
+WOLFTPM?=0
+
+# Optionally allow downgrade to older valid version in update partition
+ALLOW_DOWNGRADE?=0
+
+# Use assembly version of ECDSA and SHA
+NO_ASM?=0
+NO_ARM_ASM?=0
+
+# Optional: Use smaller SHA512
+#CFLAGS_EXTRA+=-DUSE_SLOW_SHA512
+
+# Flash sector size (4KB typical)
+WOLFBOOT_SECTOR_SIZE?=0x1000
+
+# Load Partition to RAM Address
+WOLFBOOT_LOAD_ADDRESS?=0xA0000000
+
+# Partition layout for PolarFire SoC MPFS250T
+# TODO: Update with actual flash layout based on your system design
+WOLFBOOT_PARTITION_SIZE?=0x10000
+WOLFBOOT_PARTITION_BOOT_ADDRESS?=0x08080000
+WOLFBOOT_PARTITION_UPDATE_ADDRESS?=0x08090000
+WOLFBOOT_PARTITION_SWAP_ADDRESS?=0x080FF000
+
+# DTS (Device Tree)
+WOLFBOOT_LOAD_DTS_ADDRESS?=0x80000000
+WOLFBOOT_DTS_BOOT_ADDRESS?=0x20F00000
+WOLFBOOT_DTS_UPDATE_ADDRESS?=0x20F00000
+
+#CFLAGS_EXTRA+=-DDEBUG_EXT_FLASH

config/examples/raspi3-encrypted.config

@@ -16,7 +16,6 @@ WOLFBOOT_PARTITION_SWAP_ADDRESS=0xFFFFFFFF
 WOLFBOOT_PARTITION_SIZE=0x1000000
 WOLFBOOT_SECTOR_SIZE=0x400
 EXT_FLASH=0
-MMU=1
 ENCRYPT=1
 NO_XIP=1
 ENCRYPT_WITH_AES256=1

docs/Targets.md

@@ -12,6 +12,7 @@ This README describes configuration of supported targets.
 * [Kontron VX3060-S2](#kontron-vx3060-s2)
 * [Microchip PIC32CK](#microchip-pic32ck)
 * [Microchip PIC32CZ](#microchip-pic32cz)
+* [Microchip PolarFire SoC](#microchip-polarfire-soc)
 * [Microchip SAMA5D3](#microchip-sama5d3)
 * [Microchip SAME51](#microchip-same51)
 * [Nordic nRF52840](#nordic-nrf52840)
@@ -778,6 +779,110 @@ add-symbol-file test-app/image.elf 0x20020100
 ```
 
 
+## Microchip PolarFire SoC
+
+The PolarFire SoC is a 64-bit RISC-V SoC featuring a five-core CPU cluster (1× E51 monitor core and 4× U54 application cores) and FPGA fabric. Tested with MPFS250.
+
+### Features
+* RISC-V 64-bit architecture (rv64imac)
+* Five-core CPU: 1× E51 monitor + 4× U54 application cores
+* Integrated DDR3/4, LPDDR3/4 controller and PHY
+* PCIe Gen2, USB 2.0, and Gigabit Ethernet interfaces
+* Secure boot capabilities
+* Low power consumption
+* External flash support
+
+### Building PolarFire SoC
+
+All build settings come from .config file. For this platform use `TARGET=mpfs250` and `ARCH=RISCV64`.
+
+See example configuration at `config/examples/polarfire_mpfs250.config`.
+
+```sh
+cp config/examples/polarfire_mpfs250.config .config
+make wolfboot.elf
+```
+
+To assemble this as a flashable image you need the 0x100 byte HART header added:
+
+```sh
+git clone https://github.com/polarfire-soc/hart-software-services.git
+cd hart-software-services
+cd tools/hss-payload-generator
+make
+# install tool
+sudo cp hss-payload-generator /usr/local/bin/
+```
+
+Use this command to assemble a bootable wolfboot image:
+
+```sh
+hss-payload-generator -vvv -c ./hal/mpfs.yaml wolfboot.bin
+```
+
+Any customizations to the Device Tree can be made in mpfs.dts and it can be recompiled using: `dtc -I dts -O dtb mpfs.dts -o mpfs.dtb`
+
+
+Example one-shot command:
+
+```sh
+cp ./config/examples/polarfire_mpfs250.config .config && make clean && make wolfboot.elf && size wolfboot.elf && hss-payload-generator -vvv -c ./hal/mpfs.yaml wolfboot.bin && file wolfboot.bin && ls -la wolfboot.bin
+```
+
+### Flashing PolarFire SoC
+
+
+The HSS MMC boot source looks for GPT with GUID "21686148-6449-6E6F-744E-656564454649" or sector "0" if no GPT found. That GUID is the default "BIOS" boot partition.
+
+The resulting image from `hss-payload-generator` can be directly placed into GPT BIOS partition. The HSS tinyCLI supports the `USBDMSC` command to mount the eMMC or SD card as a USB device. You can then use "dd" to copy the boot image to the BOOT partition 2. Example:
+
+```
+sudo dd if=wolfboot.bin of=/dev/sde2 bs=1024
+```
+
+Flashing to eNVM:
+
+The boot rom expects a 0x100 byte secure boot header added. It also requires the .ld is offset by 0x100 to leave room for this. The mpfsBootmodeProgrammer adds 0x100 of meta information for secure boot.
+
+```sh
+$SC_INSTALL_DIR/eclipse/jre/bin/java -jar \
+    $SC_INSTALL_DIR/extras/mpfs/mpfsBootmodeProgrammer.jar \
+    --bootmode 1 --die MPFS250T --package FCVG484 --workdir $PWD wolfboot.elf
+```
+Note: wolfBoot does not support running from eNVM in machine mode yet.
+
+### Debugging PolarFire Soc
+
+Start GDB server:
+
+```sh
+$SC_INSTALL_DIR/openocd/bin/openocd --command "set DEVICE MPFS" --file board/microsemi-riscv.cfg
+```
+
+Start GDB Client: `riscv64-unknown-elf-gdb`
+
+```
+file wolfboot.elf
+tar rem:3333
+add-symbol-file ../hart-software-services/build/hss-l2scratch.elf
+set pagination off
+foc c
+
+set $target_riscv=1
+set mem inaccessible-by-default off
+set architecture riscv:rv64
+#load wolfboot.elf
+#thread apply 2 set $pc=_reset
+#thread apply all set $pc=_start
+```
+
+### PolarFire TODO
+
+1) Add support for full HSS replacement using wolfboot.
+2) Add support for eMMC and QSPI NOR flash
+
+
+
 ## STM32F7
 
 The STM32-F76x and F77x offer dual-bank hardware-assisted swapping.