uoe.hpp

Go to the documentation of this file.

 
 
 
#ifndef _UOE_H_
#define _UOE_H_
 
#include "../../../NTS/nts.hpp"
#include "../../../NTS/nts_utils.hpp"
#include "../../../NTS/SimNtsUtils.hpp"
#include "../../AxisIp4.hpp"
#include "../../AxisPsd4.hpp"
 
 
 
//-- The Maximum Datagram Size (MDS) that can be received or sent by UOE
//--  FYI: MDS is rounded modulo 8 bytes to match the chunk size.
static const Ly4Len UDP_MDS = (MTU_ZYC2-IP4_HEADER_LEN-UDP_HEADER_LEN) & ~0x7;  // 1416
 
//-------------------------------------------------------------------
//-- DEFINES FOR THE UOE INTERNAL STREAMS (can be changed)
//-------------------------------------------------------------------
#define UOE_ELASTIC_DATA_BUFFER  16*1024  // In Bytes
#define UOE_ELASTIC_HEADER_BUFF       64  // In Headers
 
//-------------------------------------------------------------------
//-- DERIVED CONSTANTS FOR THE UOE INTERNAl STREAMS (don't touch)
//-------------------------------------------------------------------
const int cUdpRxDataFifoSize = (UOE_ELASTIC_DATA_BUFFER)/(ARW/8); // Size of UDP Rx data buffer (in chunks)
const int cUdpRxHdrsFifoSize = (UOE_ELASTIC_HEADER_BUFF); // Size of the UDP Rx header buffer (in UDP headers)
const int cIp4RxHdrsFifoSize = (cUdpRxHdrsFifoSize * 4);  // Size of the IP4 Rx header buffer (1-header=4-entries in the FiFo)
const int cMtuSize           = (2*MTU)/(ARW/8);           // Minimum size to store one MTU
 
 
//---------------------------------------------------------
//-- UOE - IPv4 ADDRESS PAIR
//---------------------------------------------------------
class IpAddrPair {
  public:
    Ip4Addr     ipSa;
    Ip4Addr     ipDa;
    IpAddrPair() {}
    IpAddrPair(Ip4Addr ipSa, Ip4Addr ipDa) :
        ipSa(ipSa), ipDa(ipDa) {}
};
 
 
 
#if HLS_VERSION == 2017
 
    void uoe_top(
 
        //------------------------------------------------------
        //-- MMIO Interface
        //------------------------------------------------------
        CmdBit                   piMMIO_En,
        stream<ap_uint<16> >    &soMMIO_DropCnt,
        stream<StsBool>         &soMMIO_Ready,
 
        //------------------------------------------------------
        //-- IPRX / IP Rx / Data Interface
        //------------------------------------------------------
        stream<AxisIp4>         &siIPRX_Data,
 
        //------------------------------------------------------
        //-- IPTX / IP Tx / Data Interface
        //------------------------------------------------------
        stream<AxisIp4>         &soIPTX_Data,
 
        //------------------------------------------------------
        //-- UAIF / Control Port Interfaces
        //------------------------------------------------------
        stream<UdpAppLsnReq>    &siUAIF_LsnReq,
        stream<UdpAppLsnRep>    &soUAIF_LsnRep,
        stream<UdpAppClsReq>    &siUAIF_ClsReq,
        stream<UdpAppClsRep>    &soUAIF_ClsRep,
 
        //------------------------------------------------------
        //-- UAIF / Rx Data Interfaces
        //------------------------------------------------------
        stream<UdpAppData>      &soUAIF_Data,
        stream<UdpAppMeta>      &soUAIF_Meta,
        stream<UdpAppDLen>      &soUAIF_DLen,
 
        //------------------------------------------------------
        //-- UAIF / Tx Data Interfaces
        //------------------------------------------------------
        stream<UdpAppData>      &siUAIF_Data,
        stream<UdpAppMeta>      &siUAIF_Meta,
        stream<UdpAppDLen>      &siUAIF_DLen,
 
        //------------------------------------------------------
        //-- ICMP / Message Data Interface (Port Unreachable)
        //------------------------------------------------------
        stream<AxisIcmp>        &soICMP_Data
    );
#else
 
    void uoe_top(
        //------------------------------------------------------
        //-- MMIO Interface
        //------------------------------------------------------
        CmdBit                   piMMIO_En,
        stream<ap_uint<16> >    &soMMIO_DropCnt,
        stream<StsBool>         &soMMIO_Ready,
 
        //------------------------------------------------------
        //-- IPRX / IP Rx / Data Interface
        //------------------------------------------------------
        stream<AxisRaw>         &siIPRX_Data,
 
        //------------------------------------------------------
        //-- IPTX / IP Tx / Data Interface
        //------------------------------------------------------
        stream<AxisRaw>         &soIPTX_Data,
 
        //------------------------------------------------------
        //-- UAIF / Control Port Interfaces
        //------------------------------------------------------
        stream<UdpAppLsnReq>    &siUAIF_LsnReq,
        stream<UdpAppLsnRep>    &soUAIF_LsnRep,
        stream<UdpAppClsReq>    &siUAIF_ClsReq,
        stream<UdpAppClsRep>    &soUAIF_ClsRep,
 
        //------------------------------------------------------
        //-- UAIF / Rx Data Interfaces
        //------------------------------------------------------
        stream<UdpAppData>      &soUAIF_Data,
        stream<UdpAppMeta>      &soUAIF_Meta,
        stream<UdpAppDLen>      &soUAIF_DLen,
 
        //------------------------------------------------------
        //-- UAIF / Tx Data Interfaces
        //------------------------------------------------------
        stream<UdpAppData>      &siUAIF_Data,
        stream<UdpAppMeta>      &siUAIF_Meta,
        stream<UdpAppDLen>      &siUAIF_DLen,
 
        //------------------------------------------------------
        //-- ICMP / Message Data Interface (Port Unreachable)
        //------------------------------------------------------
        stream<AxisRaw>         &soICMP_Data
    );
 
#endif  // HLS_VERSION
 
#endif