======================================================================================================
|
======================================================================================================
|
UDP/IP Core for FPGAs (in VHDL)
|
UDP/IP Core for FPGAs (in VHDL)
|
======================================================================================================
|
======================================================================================================
|
|
|
Update date: February 9th, 2010
|
Update date: February 9th, 2010
|
Build date: December 15th, 2009
|
Build date: December 15th, 2009
|
|
|
|
|
Description
|
Description
|
-----------
|
-----------
|
|
|
|
|
This is a VHDL implementation of a UDP/IP core that can be connected to the input and output ports of the
|
This is a VHDL implementation of a UDP/IP core that can be connected to the input and output ports of the
|
Virtex-5 Ethernet MAC Local Link Wrapper and enable communication betweena a PC and a FPGA.
|
Virtex-5 Ethernet MAC Local Link Wrapper and enable communication betweena a PC and a FPGA.
|
|
|
It has been area-optimized, it is suitable for direct PC-FPGA communication and can operate at Gigabit speed.
|
It has been area-optimized, it is suitable for direct PC-FPGA communication and can operate at Gigabit speed.
|
|
|
|
|
Example placement on a Virtex 5:
|
Example placement on a Virtex 5:
|
|
|
|
|
-- -----------------------------------------------------------------------
|
-- -----------------------------------------------------------------------
|
-- | EXAMPLE DESIGN WRAPPER |
|
-- | EXAMPLE DESIGN WRAPPER |
|
-- | --------------------------------------------------------|
|
-- | --------------------------------------------------------|
|
-- | |LOCAL LINK WRAPPER |
|
-- | |LOCAL LINK WRAPPER |
|
-- | | -----------------------------------------|
|
-- | | -----------------------------------------|
|
-- | UDP/IP core | |BLOCK LEVEL WRAPPER |
|
-- | UDP/IP core | |BLOCK LEVEL WRAPPER |
|
-- | ----------- | | --------------------- |
|
-- | ----------- | | --------------------- |
|
-- | |-------- | | ---------- | | ETHERNET MAC | |
|
-- | |-------- | | ---------- | | ETHERNET MAC | |
|
-- | || IPv4 | | | | | | | WRAPPER | --------- |
|
-- | || IPv4 | | | | | | | WRAPPER | --------- |
|
-- |->| pack |-> |->| |--|--->| Tx Tx |--| |--->|
|
-- |->| pack |-> |->| |--|--->| Tx Tx |--| |--->|
|
-- | || trans| | | | | | | client PHY | | | |
|
-- | || trans| | | | | | | client PHY | | | |
|
-- | |-------- | | | LOCAL | | | I/F I/F | | | |
|
-- | |-------- | | | LOCAL | | | I/F I/F | | | |
|
-- | | | | | LINK | | | | | PHY | |
|
-- | | | | | LINK | | | | | PHY | |
|
-- | | | | | FIFO | | | | | I/F | |
|
-- | | | | | FIFO | | | | | I/F | |
|
-- | | | | | | | | | | | |
|
-- | | | | | | | | | | | |
|
-- | |-------- | | | | | | Rx Rx | | | |
|
-- | |-------- | | | | | | Rx Rx | | | |
|
-- | || IPv4 | | | | | | | client PHY | | | |
|
-- | || IPv4 | | | | | | | client PHY | | | |
|
-- | || pack |<- |<-| |<-|----| I/F I/F |<-| |<---|
|
-- | || pack |<- |<-| |<-|----| I/F I/F |<-| |<---|
|
-- | ||receiv| | | | | | | | --------- |
|
-- | ||receiv| | | | | | | | --------- |
|
-- | |-------- | | ---------- | --------------------- |
|
-- | |-------- | | ---------- | --------------------- |
|
-- | ----------- | -----------------------------------------|
|
-- | ----------- | -----------------------------------------|
|
-- | --------------------------------------------------------|
|
-- | --------------------------------------------------------|
|
-- -----------------------------------------------------------------------
|
-- -----------------------------------------------------------------------
|
|
|
|
|
|
|
Package Structure
|
Package Structure
|
-----------------
|
-----------------
|
|
|
This package contains the following files and folder:
|
This package contains the following files and folder:
|
|
|
-README : This file
|
-README : This file
|
|
|
-UDP_IP_CORE : This folder contains VHDL, XCO and NGC files both for Virtex 5 as well as Spartan 3 FPGAs.
|
-UDP_IP_CORE : This folder contains VHDL, XCO and NGC files both for Virtex 5 as well as Spartan 3 FPGAs.
|
|
|
-LUT COE file : This folder contains a COE file for the LUT that contains the IP packet header field.
|
-LUT COE file : This folder contains a COE file for the LUT that contains the IP packet header field.
|
|
|
-JAVA app : This folder contains the JAVA application used on the PC side for transmitting and receiving packets.
|
-JAVA app : This folder contains the JAVA application used on the PC side for transmitting and receiving packets.
|
|
|
-PAPER : This folder contains a paper that describes in detail the design and implementation of the core.
|
-PAPER : This folder contains a paper that describes in detail the design and implementation of the core.
|
|
|
|
|
|
|
Usage of the UDP/IP core
|
Usage of the UDP/IP core
|
------------------------
|
------------------------
|
|
|
|
|
Before integrating the core into your design you have to reinitialize the LUT of the transmitter.
|
Before integrating the core into your design you have to reinitialize the LUT of the transmitter.
|
This LUT contains the header section of the IP packet.One must change the X fields that appear in the following table.
|
This LUT contains the header section of the IP packet.One must change the X fields that appear in the following table.
|
|
|
The field that should be changed are:
|
The field that should be changed are:
|
Destination MAC Address : (LUT)
|
Destination MAC Address : (LUT)
|
Source MAC Address : (LUT)
|
Source MAC Address : (LUT)
|
Source IP Address : (LUT)
|
Source IP Address : (LUT)
|
Destination IP Address : (LUT)
|
Destination IP Address : (LUT)
|
Source Port : (LUT)
|
Source Port : (LUT)
|
Destination Port : (LUT)
|
Destination Port : (LUT)
|
Header Checksum : VHDL file
|
Header Checksum : VHDL file
|
|
|
The Addresses are read from the LUT, thats why a reinitialization is required.
|
The Addresses are read from the LUT, thats why a reinitialization is required.
|
The Header Checksum base value is not read from the LUT. It can be found in the VHDL file.
|
The Header Checksum base value is not read from the LUT. It can be found in the VHDL file.
|
The Header Checksum base value depends on the IP Addresses and it is the Header Checksum value of a packet with no user data.
|
The Header Checksum base value depends on the IP Addresses and it is the Header Checksum value of a packet with no user data.
|
|
|
If you choose to use the JAVA application provided in this packet only the Destination MAC Address needs to change.
|
If you choose to use the JAVA application provided in this packet only the Destination MAC Address needs to change.
|
|
|
|
|
------------------------------------------------------------------------------------------------------------------------------------------
|
------------------------------------------------------------------------------------------------------------------------------------------
|
------------------------------------------------------------------------------------------------------------------------------------------
|
------------------------------------------------------------------------------------------------------------------------------------------
|
-- IPv4 PACKET STRUCTURE : -- --
|
-- IPv4 PACKET STRUCTURE : -- --
|
-- size | Description | Transmission Order | Position --
|
-- size | Description | Transmission Order | Position --
|
------------------------------------------------------------------------------------------------------------------------------------------
|
------------------------------------------------------------------------------------------------------------------------------------------
|
-- 6 bytes | Destin MAC Address (PC) | 0 1 2 3 4 5 | LUT --
|
-- 6 bytes | Destin MAC Address (PC) | 0 1 2 3 4 5 | LUT --
|
-- | X-X-X-X-X-X | | --
|
-- | X-X-X-X-X-X | | --
|
-- | | | --
|
-- | | | --
|
-- 6 bytes | Source MAC Address (FPGA) | 6 7 8 9 10 11 | LUT --
|
-- 6 bytes | Source MAC Address (FPGA) | 6 7 8 9 10 11 | LUT --
|
-- | 11111111-11111111-11111111-11111111-... | | --
|
-- | 11111111-11111111-11111111-11111111-... | | --
|
-- 2 bytes | Ethernet Type | 12 13 | LUT --
|
-- 2 bytes | Ethernet Type | 12 13 | LUT --
|
-- | (fixed to 00001000-00000000 :=> | | --
|
-- | (fixed to 00001000-00000000 :=> | | --
|
-- | Internet Protocol, Version 4 (IPv4)) | | --
|
-- | Internet Protocol, Version 4 (IPv4)) | | --
|
-- -- Start of IPv4 Packet - - - - - - - - - - - - - -- --
|
-- -- Start of IPv4 Packet - - - - - - - - - - - - - -- --
|
-- 1 byte | 4 MSBs = Version , 4 LSBs = Header Length| 14 | LUT --
|
-- 1 byte | 4 MSBs = Version , 4 LSBs = Header Length| 14 | LUT --
|
-- | 0100 0101 | | --
|
-- | 0100 0101 | | --
|
-- 1 byte | Differentiated Services | 15 | LUT --
|
-- 1 byte | Differentiated Services | 15 | LUT --
|
-- | 00000000 | | --
|
-- | 00000000 | | --
|
-- 2 bytes | Total Length | 16 17 | REG --
|
-- 2 bytes | Total Length | 16 17 | REG --
|
-- | 00000000-00100100 (base: 20 + 8 + datalength)| | --
|
-- | 00000000-00100100 (base: 20 + 8 + datalength)| | --
|
-- 2 bytes | Identification | 18 19 | LUT --
|
-- 2 bytes | Identification | 18 19 | LUT --
|
-- | 00000000-00000000 | | --
|
-- | 00000000-00000000 | | --
|
-- 2 bytes | 3 MSBs = Flags , 13 LSBs = Fragment Offset| 20 21 | LUT --
|
-- 2 bytes | 3 MSBs = Flags , 13 LSBs = Fragment Offset| 20 21 | LUT --
|
-- | 010 - 0000000000000 | | --
|
-- | 010 - 0000000000000 | | --
|
-- 1 byte | Time to Live | 22 | LUT --
|
-- 1 byte | Time to Live | 22 | LUT --
|
-- | 01000000 | | --
|
-- | 01000000 | | --
|
-- 1 byte | Protocol | 23 | LUT --
|
-- 1 byte | Protocol | 23 | LUT --
|
-- | 00010001 | | --
|
-- | 00010001 | | --
|
-- 2 bytes | Header Checksum | 24 25 | REG --
|
-- 2 bytes | Header Checksum | 24 25 | REG --
|
-- | X X (base value) | | --
|
-- | X X (base value) | | --
|
-- 4 bytes | Source IP Address | 26 27 28 29 | LUT --
|
-- 4 bytes | Source IP Address | 26 27 28 29 | LUT --
|
-- | X-X-X-X - FPGA | | --
|
-- | X-X-X-X - FPGA | | --
|
-- 4 bytes | Destin IP Address | 30 31 32 33 | LUT --
|
-- 4 bytes | Destin IP Address | 30 31 32 33 | LUT --
|
-- | X-X-X-X - PC | | --
|
-- | X-X-X-X - PC | | --
|
-- -- Start of UDP Packet - - - - - - - - - - - - - - -- --
|
-- -- Start of UDP Packet - - - - - - - - - - - - - - -- --
|
-- 2 bytes | Source Port | 34 35 | LUT --
|
-- 2 bytes | Source Port | 34 35 | LUT --
|
-- | X-X | | --
|
-- | X-X | | --
|
-- 2 bytes | Destination Port | 36 37 | LUT --
|
-- 2 bytes | Destination Port | 36 37 | LUT --
|
-- | X-X | | --
|
-- | X-X | | --
|
-- 2 bytes | Length | 38 39 | REG --
|
-- 2 bytes | Length | 38 39 | REG --
|
-- | 00000000 - 00010000 (8 + # data bytes)| | --
|
-- | 00000000 - 00010000 (8 + # data bytes)| | --
|
-- 2 bytes | Checksum | 40 41 | LUT --
|
-- 2 bytes | Checksum | 40 41 | LUT --
|
-- | 00000000 - 00000000 | | --
|
-- | 00000000 - 00000000 | | --
|
-- X bytes | Data | 42 .. X | from input --
|
-- X bytes | Data | 42 .. X | from input --
|
-- | | | -- --
|
-- | | | -- --
|
------------------------------------------------------------------------------------------------------------------------------------------
|
------------------------------------------------------------------------------------------------------------------------------------------
|
------------------------------------------------------------------------------------------------------------------------------------------
|
------------------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
|
Interface of the UDP/IP core
|
Interface of the UDP/IP core
|
----------------------------
|
----------------------------
|
|
|
|
|
The interface of the unit is defined as follows:
|
The interface of the unit is defined as follows:
|
|
|
entity UDP_IP_Core is
|
entity UDP_IP_Core is
|
Port ( rst : in STD_LOGIC; -- active-high
|
Port ( rst : in STD_LOGIC; -- active-high
|
clk_125MHz : in STD_LOGIC;
|
clk_125MHz : in STD_LOGIC;
|
|
|
-- Transmit signals
|
-- Transmit signals
|
transmit_start_enable : in STD_LOGIC;
|
transmit_start_enable : in STD_LOGIC;
|
transmit_data_length : in STD_LOGIC_VECTOR (15 downto 0);
|
transmit_data_length : in STD_LOGIC_VECTOR (15 downto 0);
|
usr_data_trans_phase_on : out STD_LOGIC;
|
usr_data_trans_phase_on : out STD_LOGIC;
|
transmit_data_input_bus : in STD_LOGIC_VECTOR (7 downto 0);
|
transmit_data_input_bus : in STD_LOGIC_VECTOR (7 downto 0);
|
start_of_frame_O : out STD_LOGIC;
|
start_of_frame_O : out STD_LOGIC;
|
end_of_frame_O : out STD_LOGIC;
|
end_of_frame_O : out STD_LOGIC;
|
source_ready : out STD_LOGIC;
|
source_ready : out STD_LOGIC;
|
transmit_data_output_bus : out STD_LOGIC_VECTOR (7 downto 0);
|
transmit_data_output_bus : out STD_LOGIC_VECTOR (7 downto 0);
|
|
|
--Receive Signals
|
--Receive Signals
|
rx_sof : in STD_LOGIC;
|
rx_sof : in STD_LOGIC;
|
rx_eof : in STD_LOGIC;
|
rx_eof : in STD_LOGIC;
|
input_bus : in STD_LOGIC_VECTOR(7 downto 0);
|
input_bus : in STD_LOGIC_VECTOR(7 downto 0);
|
valid_out_usr_data : out STD_LOGIC;
|
valid_out_usr_data : out STD_LOGIC;
|
usr_data_output_bus : out STD_LOGIC_VECTOR (7 downto 0)
|
usr_data_output_bus : out STD_LOGIC_VECTOR (7 downto 0)
|
);
|
);
|
end UDP_IP_Core;
|
end UDP_IP_Core;
|
|
|
|
|
The UDP/IP core and the LOCAL LINK WRAPPER must have the same rst and clk signals.
|
The UDP/IP core and the LOCAL LINK WRAPPER must have the same rst and clk signals.
|
|
|
Signal transmit_start_enable : active high , It must be high for one clock cycle only.
|
Signal transmit_start_enable : active high , It must be high for one clock cycle only.
|
|
|
Signal transmit_data_length : number of user data to be transmitted (number of bytes)
|
Signal transmit_data_length : number of user data to be transmitted (number of bytes)
|
|
|
Signal usr_data_trans_phase_on: is high one clock cycle before the transmittion of user data and remains high while transmitting user data.
|
Signal usr_data_trans_phase_on: is high one clock cycle before the transmittion of user data and remains high while transmitting user data.
|
|
|
Signal transmit_data_input_bus : input data to be transmitted. Starts transmitting one clock cycle after the usr_data_trans_phase_on is set.
|
Signal transmit_data_input_bus : input data to be transmitted. Starts transmitting one clock cycle after the usr_data_trans_phase_on is set.
|
|
|
Signals start_of_frame_O,end_of_frame_O,source_ready,transmit_data_output_bus should be connected to the local link wrapper's input ports.
|
Signals start_of_frame_O,end_of_frame_O,source_ready,transmit_data_output_bus should be connected to the local link wrapper's input ports.
|
|
|
Signals rx_sof, rx_eof : active low, inputs from the local link wrapper
|
Signals rx_sof, rx_eof : active low, inputs from the local link wrapper
|
|
|
Signal input_bus : input from the local link wrapper
|
Signal input_bus : input from the local link wrapper
|
|
|
Signal valid_out_usr_data : output to user, when set it indicates that the usr_data_output_bus contains the user data section of the incoming packet
|
Signal valid_out_usr_data : output to user, when set it indicates that the usr_data_output_bus contains the user data section of the incoming packet
|
|
|
Signal usr_data_output_bus : user data output bus output to the user
|
Signal usr_data_output_bus : user data output bus output to the user
|
|
|
|
|
|
|
Implementation Details
|
Implementation Details
|
----------------------
|
----------------------
|
|
|
The VHDL unit have been designed using the Xilinx 10.1 Design Suite.
|
The VHDL unit have been designed using the Xilinx 10.1 Design Suite.
|
|
|
ISE 10.1 was used to create the unit.
|
ISE 10.1 was used to create the unit.
|
|
|
|
|
|
|
Verification Details
|
Verification Details
|
--------------------
|
--------------------
|
|
|
Modelsim 6.3f was used for extensive post place and route simulations.
|
Modelsim 6.3f was used for extensive post place and route simulations.
|
|
|
The development board HTG-V5-PCIE by HiTech Global populated with a V5SX95T-1 FPGA was used to verify the correct behavior of the core.
|
The development board HTG-V5-PCIE by HiTech Global populated with a V5SX95T-1 FPGA was used to verify the correct behavior of the core.
|
|
|
The Spartan3 configuration has not been hardware-verified!
|
The Spartan3 configuration has not been hardware-verified!
|
|
|
|
It has been verified on Virtex 6 FPGA by users!
|
|
|
|
|
Citation
|
Citation
|
--------
|
--------
|
|
|
By using this component in any architecture design and associated publication, you agree to cite it as:
|
By using this component in any architecture design and associated publication, you agree to cite it as:
|
"Efficient PC-FPGA Communication over Gigabit Ethernet", by Nikolaos Alachiotis, Simon A. Berger and Alexandros Stamatakis,
|
"Efficient PC-FPGA Communication over Gigabit Ethernet", by Nikolaos Alachiotis, Simon A. Berger and Alexandros Stamatakis,
|
The Exelixis Lab, Exelixis-RRDR-2010-4, TU Munich, February 2010.
|
IEEE ICESS 2010, June/July 2010.
|
|
|
|
|
Authors and Contact Details
|
Authors and Contact Details
|
---------------------------
|
---------------------------
|
|
|
Nikos Alachiotis alachiot@in.tum.de , n.alachiotis@gmail.com
|
Nikos Alachiotis n.alachiotis@gmail.com
|
Simon A. Berger bergers@in.tum.de
|
Simon A. Berger bergers@in.tum.de
|
Alexandros Stamatakis stamatak@in.tum.de
|
Alexandros Stamatakis stamatak@in.tum.de
|
|
|
Technichal University of Munich
|
Technichal University of Munich
|
Department of Computer Science / I 12
|
Department of Computer Science / I 12
|
The Exelixis Lab
|
The Exelixis Lab
|
Boltzmannstr. 3
|
Boltzmannstr. 3
|
D-85748 Garching b. Muenchen
|
D-85748 Garching b. Muenchen
|
|
|
|
|
Copyright
|
Copyright
|
---------
|
---------
|
|
|
This component is free. In case you use it for any purpose, particularly
|
This component is free. In case you use it for any purpose, particularly
|
when publishing work relying on this component you must cite it as:
|
when publishing work relying on this component you must cite it as:
|
|
|
IPv4 PACKET TRANSMITTER by Nikolas Alachiotis and Alexandros Stamatakis, The Exelixis Lab, TU Munich, distributed by the authors via
|
N. Alachiotis, S.A. Berger, A. Stamatakis: "Efficient PC-FPGA Communication over Gigabit Ethernet". IEEE ICESS 2010, June/July 2010.
|
http://wwwkramer.in.tum.de/exelixis/
|
|
|
|
|
|
You can redistribute it and/or modify
|
You can redistribute it and/or modify
|
it under the terms of the GNU General Public License as published by
|
it under the terms of the GNU Lesser General Public License as published by
|
the Free Software Foundation; either version 2 of the License, or
|
the Free Software Foundation; either version 2 of the License, or
|
(at your option) any later version.
|
(at your option) any later version.
|
|
|
This component is distributed in the hope that it will be useful,
|
This component is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU General Public License for more details.
|
GNU General Public License for more details.
|
|
|
|
|
|
|
Release Notes
|
Release Notes
|
------------
|
------------
|
|
|
Update date: February 9th, 2010
|
Update date: February 9th, 2010
|
|
|
Build date : December 15th, 2009
|
Build date : December 15th, 2009
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
