arp.hpp

Go to the documentation of this file.

 
 
 
#ifndef _ARP_H_
#define _ARP_H_
 
#include "../../../NTS/nts.hpp"
#include "../../../NTS/nts_utils.hpp"
#include "../../../NTS/SimNtsUtils.hpp"
#include "../../AxisEth.hpp"
 
 
class ArpMeta  // ARP Metadata
{
  public:
    EthAddr         remoteMacAddr;
    EtherType       etherType;
    ArpHwType       arpHwType;
    ArpProtType     arpProtType;
    ArpHwLen        arpHwLen;
    ArpProtLen      arpProtLen;
    ArpSendHwAddr   arpSendHwAddr;
    ArpSendProtAddr arpSendProtAddr;
    ArpMeta() {}
};
 
 
typedef ap_uint<1> ArpLkpOp;
enum               ArpLkpOpCodes   { ARP_INSERT=0, ARP_DELETE=1 };
 
 
class RtlMacUpdateRequest {
  public:
    EthAddr         value;  // 48-bits
    Ip4Addr         key;    // 32-bits
    ArpLkpOp        opcode; //  1-bit : '0' is INSERT, '1' is DELETE
 
    RtlMacUpdateRequest() {}
    RtlMacUpdateRequest(Ip4Addr key, EthAddr value, ArpLkpOp opcode) :
            key(key), value(value), opcode(opcode) {}
};
 
 
class RtlMacUpdateReply {
  public:
    EthAddr         value;  // 48-bits
    ArpLkpOp        opcode; //  1-bit : '0' is INSERT, '1' is DELETE
 
    RtlMacUpdateReply() {}
    RtlMacUpdateReply(ArpLkpOp opcode) :
        opcode(opcode) {}
    RtlMacUpdateReply(EthAddr value, ArpLkpOp opcode) :
        value(value), opcode(opcode) {}
};
 
 
class RtlMacLookupRequest {
  public:
    Ip4Addr         key;
    RtlMacLookupRequest() {}
    RtlMacLookupRequest(Ip4Addr searchKey) :
        key(searchKey) {}
};
 
 
class RtlMacLookupReply {
  public:
    EthAddr         value;  // 48 bits
    HitBool         hit;    //  8 bits
    RtlMacLookupReply() {}
    RtlMacLookupReply(HitBool hit, EthAddr value) :
        hit(hit), value(value) {}
};
 
 
#if HLS_VERSION == 2017
 
    void arp_top(
        //------------------------------------------------------
        //-- MMIO Interfaces
        //------------------------------------------------------
        EthAddr                      piMMIO_MacAddress,
        Ip4Addr                      piMMIO_Ip4Address,
        //------------------------------------------------------
        //-- IPRX Interface
        //------------------------------------------------------
        stream<AxisEth>             &siIPRX_Data,
        //------------------------------------------------------
        //-- ETH Interface
        //------------------------------------------------------
        stream<AxisEth>             &soETH_Data,
        //------------------------------------------------------
        //-- IPTX Interfaces
        //------------------------------------------------------
        stream<Ip4Addr>             &siIPTX_MacLkpReq,
        stream<ArpLkpReply>         &soIPTX_MacLkpRep,
        //------------------------------------------------------
        //-- CAM Interfaces
        //------------------------------------------------------
        stream<RtlMacLookupRequest> &soCAM_MacLkpReq,
        stream<RtlMacLookupReply>   &siCAM_MacLkpRep,
        stream<RtlMacUpdateRequest> &soCAM_MacUpdReq,
        stream<RtlMacUpdateReply>   &siCAM_MacUpdRep
    );
 
#else
    void arp_top(
        //------------------------------------------------------
        //-- MMIO Interfaces
        //------------------------------------------------------
        EthAddr                      piMMIO_MacAddress,
        Ip4Addr                      piMMIO_Ip4Address,
        //------------------------------------------------------
        //-- IPRX Interface
        //------------------------------------------------------
        stream<AxisRaw>             &siIPRX_Data,
        //------------------------------------------------------
        //-- ETH Interface
        //------------------------------------------------------
        stream<AxisRaw>             &soETH_Data,
        //------------------------------------------------------
        //-- IPTX Interfaces
        //------------------------------------------------------
        stream<Ip4Addr>             &siIPTX_MacLkpReq,
        stream<ArpLkpReply>         &soIPTX_MacLkpRep,
        //------------------------------------------------------
        //-- CAM Interfaces
        //------------------------------------------------------
        stream<RtlMacLookupRequest> &soCAM_MacLkpReq,
        stream<RtlMacLookupReply>   &siCAM_MacLkpRep,
        stream<RtlMacUpdateRequest> &soCAM_MacUpdReq,
        stream<RtlMacUpdateReply>   &siCAM_MacUpdRep
    );
#endif    // HLS_VERSION
 
#endif