Board: Altera Cyclone V SoC Board
Tools Version: 14.0.2
State: running

Introduction

This design demonstrates how you can route the HPS EMAC into the FPGA in order to use FPGA I/O for the interface. Since the HPS EMAC only supports RGMII when HPS I/O are used, you can route the EMAC to the FPGA in order to support SGMII PHYs. When the EMAC is routed into the FPGA it is exposed as a MII/GMII interface so this design also adapts the exposed interface to SGMII before it is connected to FPGA I/O.

Altera Cyclone V SoC has 2 Ethernet Media Access Controller (EMAC) peripherals embedded along with the A9 core in the Hard Processor System (HPS). Each EMAC can be used to transmit and receive data at 10/100/1000 Mbps over Ethernet connections in compliance with the IEEE 802.3 specification.

In a huge system design which utilizes a lot of the HPS peripheral components, users will very likely run into a situation where only 1 of the EMAC output can be channeled to the HPS dedicated IOs. This limitation can be a great hindrance to complex design which needs multiple Ethernet interfaces to meet the design requirement.

Serial Gigabit Media Independent Interface (SGMII) presents itself as one of the solution to convey network data up to 1000Mbps with significantly less pin counts compared to GMII alone.

To transmit Ethernet data via the SGMII protocol, data leaving the MAC will have to be serialize while incoming packet from the PHY will be deserialize hence a transceiver module is needed to perform such operations. The example design utilizes a soft IP which translates GMII signals coming from the HPS into SGMII signal which will be channel out to the PHY via the FPGA transceiver modules.

Release Contents

The Altera Cyclone V SoC SGMII Design Example sources and prebuilt binaries can be downloaded from this link.

Folder File Description
bin linux-socfpga-sgmii-cv-bin.tar.gz

Cyclone V binaries archive


All the prebuilt images needed for demo and building the SD Image sd_image.bin is a 2GB SD card image file contains all the require components for demo, including Preloader, U-boot, rootfs, kernel image and device tree blob

hw cv_soc_sgmii_ed.tar.gz Hardware design example zip file, consist of necessary system file to generate sof image
board_test_system board_test_system.tar.gz Clock control application file to program the clock source

Prerequisites

The following hardware and software components are required to implement this design:

Hardware

Software

This design example is build based on Cyclone V SoC GSRD (Golden System design example) and tested with Quartus II version 14.0.2. It is recommended for user to go through below material before get started with this design example.

  • Quartus II version 14.0.2
  • Clock Control which can be downloaded from here.
  • SoC Embedded Design Suite (SoCEDS) version 14.0.2
  • Please refer this link for Cyclone V SoC Development Kit documentation and installation files.
  • Please refer to GSRD User Manual and perform the following action:

Quick Start Guide

Setup Board

Board setup is based on Altera GHRD Getting Started Guides.

Obtain Image

Download and unzip the binary file from release contents.
$ cd ~
<Download linux-socfpga-sgmii-cv-bin.tar.gz> $ tar xzf linux-socfpga-sgmii-cv-bin.tar.gz

Program SD card

Load sd_image.bin into sd card by following the below command.
$ cd ~/linux-socfpga-sgmii-cv-bin 
$ sudo dd if=bin/linux/sd_image.img of=/dev/sdx
* Please replace ‘dev/sdx’ with the name of the SD card device on your host computer.
$ sync

Program TSE reference clock

Configure dip switch SW2 to 1:OFF 2:ON 3:OFF 4:OFF

Configure dip switch SW4 to 1:OFF 2:OFF 3:ON 4:OFF

Plug the HSMC daughter card into slot.

Power up the board and make sure you have connected your board with either USB Blaster or USB Blaster II.

Open Clock Control GUI application under board_test_system folder and set frequency to 125Mhz for TSE PCS reference clock.

*Note:
  • Clock Control GUI requires Quartus II 14.0 to be installed
  • Clock configuration is required for every board power cycle
clock control.png

Boot

Slot in the SD card, insert Ethernet cable to port eth0 (HSMC port 1) and eth1 as shown in picture before warm reset HPS.

U-boot will load FPGA RBF image file from SD card to FPGA.

Wait until booting process is done, login as root at kernel terminal.

User needs to run "udhcpc -i eth0" command to obtain IP address for eth0 which is used for SGMII.

sgmii.png

Hardware Implementation

Architecture

sgmii hw new.png

The Ethernet SGMII example design consists of a HPS subsystem surrounded by the various IP residing in the FPGA fabric. The HPS is configured to enable UART, SDMMC Controller, 2 GMAC controllers and the H2F AXI Light Weight Bridge for communication with the FPGA domain.

On the FPGA side, there is an AXI to Avalon Bridge which will convert AXI protocol signals coming over from HPS to Avalon-MM compliant signals. The System ID block can be used to ensure that clocks are properly assigned to the various master components in the system.

Altera GMII to SGMII Adapter IP consits of 3 components: Altera HPS Emac Interface Splitter, GMII to SGMII adapter and TSE PCS only.
  • Altera HPS Emac Interface Splitter core is used as a bridge between HPS core and Altera GMII to SGMII Adapter core. The intermediate component is responsible to split the emac conduit interface output from HPS core into several interfaces according to their function (hps_gmii, ptp, mdio interfaces). It is also responsible to manage the differences between Emac interfaces of Arria V/Cyclone V HPS and Arria 10 HPS. This approach enables Altera GMII to SGMII Adapter core to only manage GMII interface and minimize the possibility of changing/updating the core due to future HPS Emac interface changes.
  • Altera GMII to SGMII Adapter core is a soft IP core in FPGA fabric which provides logic to hook up the connection between HPS’s EMAC GMII/MII to Altera TSE 1000BASE-X/SGMII PCS core for SGMII interface realization.
  • Altera TSE 1000BASE-X/SGMII PCS core is utilized to convert GMII/MII interface to serial interface through GigE transceiver.
The MPU is running the Linux OS which will be responsible for proper register setting on the peripheral components that make up the SGMII system design. A JTAG Master which resides on the FPGA will aid hardware debug activities as it can be used to send and receive configuration bits via the system console interface.

Quartus Design Files

Below is some of the important file in this design example:
cv_soc_sgmii_5csxfc6.qsys Top lovel Qsys system block
top.v Top level RTL
soc_system_timing.sdc Timing constraint file
cv_soc_sgmii_5csxfc6.qsf Quartus setting file
cv_soc_sgmii_5csxfc6.qpf Quartus project file

Important Note

There is timing model issue in Quartus 14.0.2. Basically timing arc for the first node of tx_clk driven register was missing from HPS timing model, and this node is important to ensure the first path between HPS and first FPGA register driven by tx_clk is analyzed. In order use the correct timing model from Quartus, below are the workarounds.

Workaround 1:
  1. An INI file is required to enable the internal timing path from HPS clock mux. The quartus.ini file can be obtained in cv_soc_sgmii_ed.tar.gz.
Workaround 2:

  1. Open and generate cv_soc_sgmii_5csxfc6.qsys file.
  2. Remove all the content inside the file cv_soc_sgmii_5csxfc6/synthesis/submodules/cv_soc_sgmii_5csxfc6_hps_0_fpga_interfaces.sdc
  3. Compile quartus

Altera HPS Emac Interface Splitter Core IP and Altera GMII to SGMII Adapter Core IP are hidden in Quartus 14.0.2. To enable these 2 hidden components, please perform the following steps:
  1. In Quartus, go to Tools-→Options-→Internet Connectivity-→Talkback Options-→Check "Enable sending TalkBack data to Altera"
  2. Launch Qsys, right click on empty area on left panel of IP Catalog. Click "Show Hidden Components"

Software Development Flow

Angstrom Flow

This design will built based on Angstrom instead of Yocto enviroment . Angstrom is a Linux distribution, targetting Embedded Systems. More information can be found on the Angstrom documentation.

How to get the build scripts

First, the repository with the angstrom build scripts must be cloned:
$ git clone http://git.rocketboards.org/angstrom-socfpga.git

Then, checkout the branch matching the tag version (ACDS14.0.2_REL_SGMII_PR):
$ cd angstrom-socfpga
$ git checkout -b sgmii-ed-socfpga ACDS14.0.2_REL_SGMII_PR

Setting Up Environment

# Configure the build environment for Cyclone5
$ MACHINE=socfpga_cyclone5 ./oebb.sh config socfpga_cyclone5
$ source enviroment-angstrom-v2013.12

Build U-Boot/Kernel/Rootfs

$ MACHINE=socfpga_cyclone5 bitbake virtual/bootloader
$ MACHINE=socfpga_cyclone5 bitbake linux-altera-ltsi
$ MACHINE=socfpga_cyclone5 bitbake gsrd-console-image

Output files

u-boot-socfpga_cyclone5.img U-Boot image
zImage Compressed kernel image
gsrd-console-image-socfpga_cyclone5.ext3 Root Filesystem as ext3 image
gsrd-console-image-socfpga_cyclone5.tar.gz Root Filesystem in tar gzip archive format

Generate Device Tree Blob

EMAC Interface Splitter, SGMII adapter and TSE PCS must be included as phandle in device tree (cv_soc_sgmii_5csxfc6_board_info.xml in the hardware design will add this for you).

hps_0_gmac0: ethernet@0xff700000 {

compatible = "synopsys,dwmac-14.0", "altr,socfpga-stmmac", "snps,dwmac-3.70a", "snps,dwmac";

reg = < 0xFF700000 0x00002000 >;

interrupt-parent = < &hps_0_arm_gic_0 >;

interrupts = < 0 115 4 >;

clocks = < &emac0_clk >;

clock-names = "stmmaceth";

interrupt-names = "macirq";

mac-address = "[00 00 00 00 00 00]";

status = "okay";

address-bits = < 48 >;

max-frame-size = < 3800 >;

local-mac-address = [ 00 00 00 00 00 00 ];

phy-mode = "sgmii";

snps,phy-addr = < 0x00000001 >;

phy-addr = < 0x00000001 >;

altr,gmii_to_sgmii_converter = <&gmii_to_sgmii_converter_0>;

};

gmii_to_sgmii_converter_0: phy@0x100000000 {

compatible = "altr,gmii-to-sgmii-14.0";

reg = <0x00000001 0x00000000 0x00000008>,

<0x00000001 0x00000010 0x00000008>,

<0x00000001 0x00000040 0x00000040>;

reg-names = "hps_emac_interface_splitter_avalon_slave", "gmii_to_sgmii_adapter_avalon_slave", "eth_tse_control_port";

clocks = <&clk_0>;

};

Use below command to generate device tree blob:
$ sopc2dts --input cv_soc_sgmii_5csxfc6.sopcinfo --output socfpga.dtb –type dtb --board cv_soc_sgmii_5csxfc6_board_info.xml --board hps_common_board_info.xml --bridge-removal all --clocks

Note:
  • *.sopcinfo and *.xml files is store at SGMII example design hardware directory.
Output file: socfpga.dtb

For more details about device tree generation, please refer to GSRD User Manual - Generating the Device Tree.

Generate Preloader

For more details about preloader generation, please refer to GSRD - Generating and Compiling the Preloader.

Output file: preloader-mkpimage_cyclone5.bin

Convert FPGA SOF to RBF

For more details about converting FPGA image from .sof to .rbf, please refer to GSRD - Compile Hardware Design.

Output file: <sgmii_design>.rbf

Build SD Card Image

Replace all required component into SD Card, or build and replace the whole image.

For more details about SD card image generation, please refer to GSRD - Creating and Updating SD Card.

Demo

Refer to this link for Ethernet Design Example Demo Testing.

Give us your feedback

© 1999-2017 RocketBoards.org by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Privacy.