Page History

Overview

Refer to http://trenz.org/tem0007-info for the current online version of this manual and other available documentation.

Key Features

Revision History

Release Notes and Know Issues

Requirements

Software

Hardware

Complete List is available on <project folder>/board_files/*_board_files.csv

Design supports following modules:

Design supports following carriers:

Additional HW Requirements:

Content

For general structure and usage of the reference design, see Project Delivery - Microchip devices

Design Sources

Prebuilt

Download

Reference Design is only usable with the specified Libero version. Do never use different versions of Libero software for the same project.

Reference Design is available on:

• TEM0007 "Test Board" Reference Design

Design Flow

Trenz Electronic provides a tcl based built environment based on Libero Design Flow.

See also:

• Project Delivery - Microchip devices

The most Trenz Electronic FPGA Reference Designs are TCL-script based projects.

The "normal" Libero project will be generated in the subfolder "/Libero/" and the additional software part will be generated in the subfolder "/software/" after executing scripts.

To create project do the following steps:

1. Execute "create_project_win.cmd" or "create_project_linux.sh"
2. Select your board in "Board selection" , if there is more than one variant.
3. Choose one of the following options::
   1. Press 0 , if it will enter the full path of Libero SoC TCL shell.
   2. Press 1, if it will enter the full path of Microchip installation folder. For example "c:\Microchip\"
   3. Press 2, if it will enter folder path or drive to search for variable TCL shell and select from generated list elements.
   4. Press x to exit script.
4. Choose one of the following options:
   1. Press 0 to use Libero SoC at its path. For example Libero_SoC_v2022.2 at C:/Microchip/Libero_SoC_v2022.2
   2. Press 1 to enter path of installation folder of Microchip or Libero SoC
   3. Press 2 to enter full path of Libero SoC exe file
   4. Press 3 to exit th script
5.  Choose one of the following options:
   1. Press 0 to overwrite old Libero project folder , if it exists.
   2. Press 1 to to generate another project folder
   3. Press 2 to to enter own Libero project folder name
   4. Press 3 to exist script and do not generate the hardware design
6. Waiting to be completed the generation of new project , if a new project is desired.
7. Press y to open the generated Libero SoC project.

Launch

Programming

Get prebuilt boot binaries

1. Run create_project_win.cmd/create_project_linux.sh
2. Select Module in 'Board selection'
3. Click on 'Export prebuilt files' button
   1. Folder <project folder>/_binaries_<Article Name> with subfolder boot_linux will be generated and opened

SD-Boot mode

Prepare SD card as follows for SD-Boot.

There are two commands to write image file on the SD card after mounting SD card in the host linux same as WSL:

bmaptool copy --nobmap <Path of image file *.img>  /dev/sdX

1. After mounting the SD card in linux the name of SD card recognized via lsblk command. For example SD card name can be sda or sdb.

dd if=<Path of image file *.img> of=/dev/sdX

Programming eNVM in SoftConsole

To program HSS *.elf file on FPGA:

• Connect the TEM0703 board via its Mini-USB connector. (J4)
• Open SoftConsole software as administrator, if it is not done yet.
• Select correct directory as workspace directory.
• Build the hart-software-services-master , if it is not done yet.
• Click on Run > External Tools > Polarfire SoC program non-secure boot-mode 1

Programming Bitstream

There is two ways to program bitstream file on FPGA:

• Using Libero SoC

  • Connect the TEM0703 board via its Mini-USB connector. (J4)
  • After generating bitstream in Libero click on  Run PROGRAM Action to program bitstream file on FPGA.
    

    Expand
    title Programming FPGA using Libero SoC
    Image Added

• Using FPExpress software

  • Connect the board via USB connector
  • Export  *.job file , if does not exist yet.
    

    Expand
    title Job File Exporting using Libero SoC
    Image Added

  • Expand
    title Open FPExpress software
    Image Added

  • Click on new
  • Give path of job file by clicking on Browse
  • Click on OK
  • Click on RUN

Get prebuilt boot binaries

1. Run create_project_win.cmd/create_project_linux.sh
2. Select Module in 'Board selection'
3. Click on 'Export prebuilt files' button
   1. Folder <project folder>/_binaries_<Article Name> with subfolder boot_linux will be generated and opened

SD-Boot mode

Prepare SD card as follows for SD-Boot.

There are two commands to write image file on the SD card after mounting SD card in the host linux same as WSL:

1. 1. Insert SD card in the SD card reader

   2. Expand
      title bmaptool command
      Code Block theme Midnight linenumbers true bmaptool copy --nobmap <Path of image file *.img>  /dev/sdX

      
      
      1. After mounting the SD card in linux the name of SD card recognized via lsblk command. For example SD card name can be sda or sdb.

   3. Expand
      title dd command

Alternative SD card can be written via Win32DiskImager or balenaEtcher softwares in Windows OS.

JTAG

Not used on this example.

Usage

1. Prepare HW like described on section Programming
2. Connect UART USB (most cases same as JTAG)
3. Connect your board to the network
4. Power on PCB

UART

Open Serial Console (e.g. PuTTY)

select COM Port

Info
Win OS: see device manager Linux OS: see  dmesg | grep tty  (UART is *USB1)

1. Speed: 115200
2. Press reset button
3. Console output depends on used Software project, see Software Design - SDK#Application
Linux Console:

Login data:

InfoNote: Wait until Linux boot finished

4. 1. Code Block theme Midnight linenumbers true dd if=<Path of image file *.img> of=/dev/sdX

      1. After mounting the SD card in linux the name of SD card recognized via lsblk command. For example SD card name can be sda or sdb.

Alternative SD card can be written via Win32DiskImager or balenaEtcher softwares in Windows OS.

JTAG

Not used on this example.

Usage

1. Prepare HW like described on section Programming
2. Connect UART USB (most cases same as JTAG)
3. Connect your board to the network
4. Power on PCB

UART

1. Open Serial Console (e.g. PuTTY)

   1. select COM Port

      Info
      Win OS: see device manager Linux OS: see  dmesg | grep tty  (UART is *USB1)

      
      

   2. Speed: 115200
2. Press reset button
3. Console output depends on used Software project, see Software Design - SDK#Application
4. Linux Console:

   1. Login data:

      Info
      Note: Wait until Linux boot finished

      
      

      Code Block
      theme Midnight linenumbers true
      tem0007 login: root

      
      

   2. You can use Linux shell now.

      Code Block
      theme Midnight linenumbers true
      i2cdetect -y -r 1 (check I2C 1 Bus) dmesg | grep rtc (RTC check) udhcpc (ETH0 check) lsusb (

      tem0007 login: root
      

      You can use Linux shell now.

      Code Block
      theme Midnight linenumbers true
      i2cdetect -y -r 1 (check I2C 1 Bus) dmesg | grep rtc (RTC check) udhcpc (ETH0 check) lsusb (USB check)

      
      

5. ...

System Design - Libero

Block Design

The block designs may differ depending on the assembly variant.

Scroll Title
anchor Figure_BD title-alignment center title Block Design - Project

Scroll Title
anchor Figure_BD title-alignment center title Block Design - Platform Desginer

HPS Interfaces

Activated interfaces:

Software Design - SoftConsole

Application

Used software project depends on board assembly variant. Template location: <project folder>/source_files/software/

...

HSS (Hart Software Service)

This is Hart Software Services (HSS) code.On PolarFire SoC, this is comprised of two portions:

• A superloop monitor running on the E51 minion processor, which receives requests from the individual U54 application processors to perform certain services on their behalf;

• A Machine-Mode software interrupt trap handler, which allows the E51 to send messages to the U54s, and request them to perform certain functions for it related to rebooting a U54.

The HSS performs boot and system monitoring functions for PolarFire SoC. The HSS is compressed (DEFLATE) and stored in eNVM. On power-up, a small decompressor wrapper inflates the HSS from eNVM flash to L2-Scratchpad memory and starts the HSS.

Creating HSS workspace in SoftConsole

• Download the HSS folder here: https://github.com/polarfire-soc/hart-software-services
• Unzip the hart-software-services-master zip file in the SoftConsole workspace
• Open SoftConsole software as administrator
• Select correct directory as workspace directory. The workspace folder must consist of hart-software-services-master folder
• Right click on board folder in the left side and click on new folder
• Rename the folder for desired board. For example for TEM0007 module rename it to TEM0007. If there is TEM0007, this HSS workspace was created already and HSS is ready to be compiled.
  
• Create other subfolders as shown (For example for TEM0007):
  
  

  Expand
  title HSS Structure Example
  Image Added

  • hart-software-serevices-master
    • board
      • TEM0007
        • drivers_config
          • fpga_ip
            • miv_ihc
              • Copy miv_ihc_add_mapping.h and miv_ihc_config.h files from original folder of icicle kit board ( mpfs-icicle-kit-es ) and paste in this folder.
        • fpga_design_config
          • This folder should be left empty. After compiling the neccessary header files for ddr, clock, IOs and other properties of desired module and hardware design will be generated and saved in this folder by mpfs_configuration_generator.py python script. The python script is saved already in the tools/polarfire-soc-configuration-generator folder.
            
        • mpfs_hal_config
          • Copy  mss_sw_config.h file from original folder of icicle kit board ( mpfs-icicle-kit-es ) and paste
            
        • soc_fpga_design
          • xml
            • Copy the generated xml with PolarFireSoC MSS Configurator software here. For example TEM0007_MSS_mss_cfg.xml
              
        • Copy the following files from original folder of icicle kit board ( mpfs-icicle-kit-es ) and paste in this folder (TEM0007 folder) :
          • hss_board_init.c
          • hss_usrt_init.c
          • usrt_helper.c
          • hss_I2Scratch.lds
          • Kconfig
            • Edit Kconfig for example for TEM0007 module as shown:
              

              Expand
              title Kconfig
              Code Block title Kconfig menu "TEM0007 Design Configuration Options" config SOC_FPGA_DESIGN_XML string "Enter path to Libero XML file" default "boards/$(BOARD)/soc_fpga_design/xml/TEM0007_MSS_mss_cfg.xml" help This option specifies the design XML file to use. endmenu

• • • • • • Makefile
            • Edit Makefile for example for TEM0007 module as shown:
              

              Expand
              title Makefile of TEM0007 folder
              Scroll Title title-alignment center title Makefile of TEM0007 folder Image Added

  • Edit Makefile in hart-software-services-master Folder for example for TEM0007 as shown:
    

    Expand
    title Makefile of hart-software-services-master
    Scroll Title title-alignment center title Makefile of hart-software-services-master folder Image Added

  • Copy def_config file from original folder of icicle kit board ( mpfs-icicle-kit-es ) and paste it in hart-software-services-master folder and rename it to .config file.
    • Edit .config file according to your module. For example for TEM0007 is edited this file as shown:
      

      Expand
      title .config File
      Scroll Title title-alignment center title .config File Image Added

  • Now HSS workspace is ready to be compiled. Right click on hart-software-services-master and  click on Build Project.
  • After compiling a config.h will be generated in the hart-software-services-master folder. By opening this header file it can be seen all configurations of .config file.

Software Design - Yocto

Trenz electronic has developed his own BSP for Microchip devices same as polarfire soc in Yocto. In the following will be explained the folders in detail.

In the following table exists more information about required packets and supported version.

General Example:

hello_tei0006

Hello TEI0006 is a Hello World example as endless loop instead of one console output.

Used software project depends on board assembly variant. Template location: <project folder>/source_files/software/

...

Software Design - Yocto

Trenz BSP contains of a shell script. If this shell script in be executed , all required processes for making a linux image file will be executed. The user needs only to write the image file on the SD card. To prepare the image file :

1. Download and save meta-trenz-polarefile-bsp folder in the host linux

2. Expand
   title In meta-trenz-polarfire-bsp execute shell script via the following command:
   Code Block theme Midnight linenumbers true . ./meta-trenz-polarfire-bsp/trenz_polarfire_setup.sh

3. Expand
   title Enter the machine name. Here the machine is equal to module name , but with lower case letters. For example for TEM0007 module enter : tem0007

4. Expand
   title Enter the image type. It depends on the user application and required installed packages in linux. As default the user can enter: te-image-minimal

5. After compiling image file *.img and its converted zip file *.zip will be in trenz bsp folder saved :

• • <trenz bsp folder>/prebuilt/boot/yocto/SD_Card.img
  • <trenz bsp folder>/prebuilt/boot/yocto/SD_Card.zip

For Yocto installation and project creation, follow instructions from:

• Yocto KICKstart
• Create a custom BSP layer for Microchip SoC or FPGA

U-Boot

Start with Create a custom BSP layer for Microchip SoC or FPGA#Configure u-boot

File location: meta-<module>/recipes-bsp/u-boot/

Changes:

• No changes

Device Tree

U-boot Device Tree

// SPDX-License-Identifier: (GPL-2.0+ OR MIT)
/*
 * Copyright (C) 2021 Microchip Technology Inc.
 * Padmarao Begari <padmarao.begari@microchip.com>
 */

/dts-v1/;

#include "microchip-mpfs.dtsi"
#include "dt-bindings/gpio/gpio.h"

/* Clock frequency (in Hz) of the rtcclk */
#define RTCCLK_FREQ		1000000

/ {
	model = "Microchip PolarFire-SoC Icicle Kit";
	compatible = "microchip,mpfs-icicle-kit", "microchip,mpfs";

	aliases {
		serial1 = &uart1;
		ethernet0 = &mac0;
		spi0 = &qspi;
	};

	chosen {
		stdout-path = "serial1";
	};

	cpus {
		timebase-frequency = <RTCCLK_FREQ>;
	};

	ddrc_cache: memory@80000000 {
		device_type = "memory";
		reg = <0x0 0x80000000 0x0 0x40000000>;
		clocks = <&clkcfg CLK_DDRC>;
		status = "okay";
	};
        
};

&uart1 {
	status = "okay";
};

&mmc {
	status = "okay";
	bus-width = <4>;
	disable-wp;
	cap-mmc-highspeed;
	cap-sd-highspeed;
    cd-debounce-delay-ms;
	card-detect-delay = <200>;
	mmc-ddr-1_8v;
	mmc-hs200-1_8v;
	sd-uhs-sdr12;
	sd-uhs-sdr25;
	sd-uhs-sdr50;
	sd-uhs-sdr104;
};

&i2c1 {
	status = "okay";
	clock-frequency = <100000>;

};



&mac1 {
	status = "disabled";
};

&mac0 {
	status = "okay";
	phy-mode = "sgmii";
	phy-handle = <&phy0>;
	phy0: ethernet-phy@1 {
		device-type = "ethernet-phy";
		reg = <1>;       
        reset-names = "ETH_RST";
        reset-gpios = <&gpio1 16 GPIO_ACTIVE_LOW>;
	};
};



&qspi {
	status = "okay";
	num-cs = <1>;
	flash0: spi-nor@0 {
		compatible = "spi-nor";
		reg = <0x0>;
		spi-tx-bus-width = <4>;
		spi-rx-bus-width = <4>;
		spi-max-frequency = <20000000>;
		spi-cpol;
		spi-cpha;
	};
};
 

Kernel Device Tree

// SPDX-License-Identifier: (GPL-2.0 OR MIT)
/* Copyright (c) 2020-2021 Microchip Technology Inc */

/dts-v1/;

#include "mpfs.dtsi"
#include "mpfs-icicle-kit-fabric.dtsi"

#include <dt-bindings/gpio/gpio.h>
#include <dt-bindings/phy/phy.h>

/* Clock frequency (in Hz) of the rtcclk */
#define MTIMER_FREQ		1000000

/ {
	#address-cells = <2>;
	#size-cells = <2>;
	model = "Microchip PolarFire-SoC Icicle Kit";
	compatible = "microchip,mpfs-icicle-reference-rtlv2209", "microchip,mpfs-icicle-kit",
		     "microchip,mpfs";

	aliases {
		ethernet0 = &mac0;
		serial0 = &mmuart0;
		serial1 = &mmuart1;
		serial2 = &mmuart2;
		serial3 = &mmuart3;
		serial4 = &mmuart4;
	};

	chosen {
		stdout-path = "serial1:115200n8";
	};

	cpus {
		timebase-frequency = <MTIMER_FREQ>;
	};
    


    //******************************************************//
    
    ddrc_cache: memory@80000000 {
		device_type = "memory";
		reg = <0x0 0x80000000 0x0 0x40000000>;
		status = "okay";
	};
    
    reserved-memory {	
        #address-cells = <2>;
		#size-cells = <2>;
        
		ranges;
        
		fabricbuf0ddrc: buffer@A0000000 {
			compatible = "shared-dma-pool";
			reg = <0x0 0xA0000000 0x0 0x2000000>;
			no-map;
		};
	};
    
	udmabuf0 {
		compatible = "ikwzm,u-dma-buf";
		device-name = "udmabuf-ddr-c0";
		minor-number = <0>;
		size = <0x0 0x2000000>;
		memory-region = <&fabricbuf0ddrc>;
		sync-mode = <3>;
	};
    
    
    //******************************************************//
    
    usb_phy: usb_phy {
    	#phy-cells = <0>;
        //compatible = "ulpi-phy";
		compatible = "usb-nop-xceiv";
		reset-gpios = <&gpio1 17 GPIO_ACTIVE_LOW>;
        reset-names = "OTG_RST";
    };
    
    
	soc {
	};
};

&can0 {
	status = "disabled";
};

&core_pwm0 {
	status = "okay";
};


&fpgadma {
	status = "okay";
};

&fpgalsram {
	status = "okay";
};

&gpio1 {
    status = "okay";
};

&gpio2 {
	interrupts = <53>, <53>, <53>, <53>,
		     <53>, <53>, <53>, <53>,
		     <53>, <53>, <53>, <53>,
		     <53>, <53>, <53>, <53>,
		     <53>, <53>, <53>, <53>,
		     <53>, <53>, <53>, <53>,
		     <53>, <53>, <53>, <53>,
		     <53>, <53>, <53>, <53>;
	status = "okay";
};

&i2c0 {
	status = "okay";
};

&i2c1 {
	status = "okay";    
	#address-cells = <1>;
    #size-cells = <0>;

	eeprom: eeprom@50 {
    	compatible = "atmel,24c02";
        reg = <0x50>;
        #address-cells = <1>;
        #size-cells = <1>;        
        eth0_addr: eth-mac-addr@FA {
            reg = <0xFA 0x06>;
        };
    };
};

&i2c2 {
	status = "okay";       
};

&mac0 {
	status = "okay";
	phy-mode = "sgmii";    
	nvmem-cells = <&eth0_addr>;
	nvmem-cell-names = "mac-address";    
	/delete-property/ local-mac-address;    
	phy-handle = <&phy0>;
	phy0: ethernet-phy@1 {
		device-type = "ethernet-phy";
		reg = <1>;       
		reset-names = "ETH_RST";
		reset-gpios = <&gpio1 16 GPIO_ACTIVE_LOW>;
	};
};

&mac1 {
	status = "disabled";
};


&mbox {
	status = "okay";
};

&mmc {
	status = "okay";
	bus-width = <4>;
	disable-wp;
	cap-sd-highspeed;
	cap-mmc-highspeed;
	mmc-ddr-1_8v;
	mmc-hs200-1_8v;
	sd-uhs-sdr12;
	sd-uhs-sdr25;
	sd-uhs-sdr50;
	sd-uhs-sdr104;
};

&mmuart1 {
	status = "okay";
};

&mmuart2 {
	status = "okay";
};

&mmuart3 {
	status = "okay";
};

&mmuart4 {
	status = "okay";
};


&qspi {
	status = "okay";
    num-cs = <1>;
};

&refclk {
	clock-frequency = <125000000>;
};


&spi0 {
	status = "okay";
};

&spi1 {
	status = "disabled";
};


&usb {
	status = "okay";
	dr_mode = "otg";  
    phys = <&usb_phy PHY_TYPE_USB2>;
};

 

Kernel

Start withCreate a custom BSP layer for Intel SoC or FPGA#Configure linux kernel

File location: meta-<module>/recipes-kernel/linux/

Changes:

• No changes.

Images

Image recipe for minimal console image

File location: meta-<module>/recipes-images/yocto/

Image recipes:

• te-image-minimal.bb: create minimal linux image
• te-initramfs.bb: required for building an image with initial RAM Filesystem

Added packages/recipes:

• No packages/recipes

Rootfs

Used filesystem: Initial RAM Filesystem (initramfs)

Appx. A: Change History and Legal Notices

Document Change History

To get content of older revision  got to "Change History"  of this page and select older document revision number.

Legal Notices