AxisTcp.hpp

Go to the documentation of this file.

 
 
#ifndef _AXIS_TCP_H_
#define _AXIS_TCP_H_
 
#include "AxisRaw.hpp"
 
 
// A TCP segment has a default header len of 20 bytes. This length may vary in
// the presence of option(s) and is indicated by the field "DataOffset" > 5.
#define TCP_HEADER_LEN      20      // In bytes
 
 
typedef ap_uint<16> LE_TcpSrcPort;  // TCP Source Port from the MAC
typedef ap_uint<16> LE_TcpDstPort;  // TCP Destination Port from the MAC
typedef ap_uint<16> LE_TcpPort;     // TCP Source or Destination Port from the MAC
typedef ap_uint<32> LE_TcpSeqNum;   // TCP Sequence Number from the MAC
typedef ap_uint<32> LE_TcpAckNum;   // TCP Acknowledgment Number from the MAC
typedef ap_uint<3>  LE_TcpResBits;  // TCP Reserved Bits from the MAC
typedef ap_uint<4>  LE_TcpDataOff;  // TCP Data Offset from the MAC
typedef ap_uint<6>  LE_TcpCtrlBits; // TCP Control Bits from the MAC
typedef ap_uint<16> LE_TcpWindow;   // TCP Window from the MAC
typedef ap_uint<16> LE_TcpChecksum; // TCP Checksum
typedef ap_uint<16> LE_TcpUrgPtr;   // TCP Urgent Pointer from the MAC
typedef ap_uint<64> LE_TcpData;     // TCP Data stream from the MAC
 
 
typedef ap_uint<16> TcpSrcPort;     // TCP Source Port
typedef ap_uint<16> TcpDstPort;     // TCP Destination Port
typedef ap_uint<16> TcpPort;        // TCP Source or Destination Port Number
typedef ap_uint<32> TcpSeqNum;      // TCP Sequence Number
typedef ap_uint<32> TcpAckNum;      // TCP Acknowledge Number
typedef ap_uint<3>  TcpResBits;     // TCP Reserved Bits
typedef ap_uint<4>  TcpDataOff;     // TCP Data Offset
typedef ap_uint<6>  TcpCtrlBits;    // TCP Control Bits
typedef ap_uint<1>  TcpCtrlBit;     // TCP Control Bit
typedef ap_uint<16> TcpWindow;      // TCP Window
typedef ap_uint<16> TcpChecksum;    // TCP Checksum
typedef ap_uint<16> TcpCsum;        // TCP Checksum (alias for TcpChecksum)
typedef ap_uint<16> TcpUrgPtr;      // TCP Urgent Pointer
 
typedef ap_uint< 8> TcpOptKind;     // TCP Option Kind
typedef ap_uint< 8> TcpOptLen ;     // TCP Option Length
typedef ap_uint<16> TcpOptMss;      // TCP Option Maximum Segment Size
 
typedef ap_uint<16> TcpSegLen;      // TCP Segment Length in octets (Header+Data)
typedef ap_uint< 8> TcpHdrLen;      // TCP Header  Length in octets
typedef ap_uint<16> TcpDatLen;      // TCP Data    Length in octets (same as TcpSegLen minus TcpHdrLen)
 
// TCP supports a variable set of options to be appended in the header.
//  Each option is identified by an 'option-kind' byte.
#define TCP_OPT_KIND_EOL    0      // End Of List
#define TCP_OPT_KIND_NOP    1      // No Operation
#define TCP_OPT_KIND_MSS    2      // Maximum Segment Size
#define TCP_OPT_KIND_WSS    3      // Window Size Shift
#define TCP_OPT_KIND_SACK   4      // Selective ACKnowledgment permitted
 
 
class AxisTcp: public AxisRaw {
 
  public:
    AxisTcp() {}
    AxisTcp(AxisRaw axisRaw) :
        AxisRaw(axisRaw.getLE_TData(), axisRaw.getLE_TKeep(), axisRaw.getLE_TLast()) {}
    AxisTcp(LE_tData tdata, LE_tKeep tkeep, LE_tLast tlast) :
        AxisRaw(tdata, tkeep, tlast) {}
    AxisTcp(const AxisTcp &axisTcp) :
        AxisRaw(axisTcp.tdata, axisTcp.tkeep, axisTcp.tlast) {}
 
 
    // Set the TCP Source Port
    void          setTcpSrcPort(TcpPort port)   {                  tdata.range(15,  0) = swapWord(port);  }
    // Get the TCP Source Port
    TcpPort       getTcpSrcPort()               { return swapWord (tdata.range(15,  0));                  }
    LE_TcpPort getLE_TcpSrcPort()               {           return tdata.range(15,  0) ;                  }
 
    // Set the TCP Destination Port
    void          setTcpDstPort(TcpPort port)   {                  tdata.range(31, 16) = swapWord(port);  }
    // Get the TCP Destination Port
    TcpPort       getTcpDstPort()               { return swapWord (tdata.range(31, 16));                  }
    LE_TcpPort getLE_TcpDstPort()               {           return tdata.range(31, 16);                   }
 
    // Set the TCP Sequence Number
    void       setTcpSeqNum(TcpSeqNum num)      {                  tdata.range(63, 32) = swapDWord(num);  }
    // Get the TCP Sequence Number
    TcpSeqNum  getTcpSeqNum()                   { return swapDWord(tdata.range(63, 32));                  }
 
    // Set the TCP Acknowledgment Number
    void       setTcpAckNum(TcpAckNum num)      {                  tdata.range(31,  0) = swapDWord(num);  }
    // Get the TCP Acknowledgment Number
    TcpAckNum  getTcpAckNum()                   { return swapDWord(tdata.range(31,  0));                  }
 
    // Set the TCP Data Offset
    void       setTcpDataOff(TcpDataOff offset) {                  tdata.range(39, 36) = offset;          }
    // Get the TCP Data Offset
    TcpDataOff getTcpDataOff()                  { return           tdata.range(39, 36);                   }
 
    // Set-Get the TCP Control Bits
    void setTcpCtrlFin(TcpCtrlBit bit)          {                  tdata.bit(40) = bit;                   }
    TcpCtrlBit getTcpCtrlFin()                  {           return tdata.bit(40);                         }
    void setTcpCtrlSyn(TcpCtrlBit bit)          {                  tdata.bit(41) = bit;                   }
    TcpCtrlBit getTcpCtrlSyn()                  {           return tdata.bit(41);                         }
    void setTcpCtrlRst(TcpCtrlBit bit)          {                  tdata.bit(42) = bit;                   }
    TcpCtrlBit getTcpCtrlRst()                  {           return tdata.bit(42);                         }
    void setTcpCtrlPsh(TcpCtrlBit bit)          {                  tdata.bit(43) = bit;                   }
    TcpCtrlBit getTcpCtrlPsh()                  {           return tdata.bit(43);                         }
    void setTcpCtrlAck(TcpCtrlBit bit)          {                  tdata.bit(44) = bit;                   }
    TcpCtrlBit getTcpCtrlAck()                  {           return tdata.bit(44);                         }
    void setTcpCtrlUrg(TcpCtrlBit bit)          {                  tdata.bit(45) = bit;                   }
    TcpCtrlBit getTcpCtrlUrg()                  {           return tdata.bit(45);                         }
 
    // Set the TCP Window
    void        setTcpWindow(TcpWindow win)     {                  tdata.range(63, 48) = swapWord(win);   }
    // Get the TCP Window
    TcpWindow   getTcpWindow()                  { return swapWord (tdata.range(63, 48));                  }
 
    // Set the TCP Checksum
    void        setTcpChecksum(TcpChecksum csum){                  tdata.range(15,  0) = swapWord(csum);                   }
    // Get the TCP Checksum
    TcpChecksum getTcpChecksum()                { return swapWord (tdata.range(15,  0));                  }
 
    // Set the TCP Urgent Pointer
    void        setTcpUrgPtr(TcpUrgPtr ptr)     {                  tdata.range(31, 16) = swapWord(ptr);   }
    // Get the TCP Urgent Pointer
    TcpUrgPtr   getTcpUrgPtr()                  { return swapWord (tdata.range(31, 16));                  }
 
    // Set the TCP Option Kind
    void        setTcpOptKind(TcpOptKind val)   {                  tdata.range(39, 32);                   }
    // Get the TCP Option Kind
    TcpOptKind  getTcpOptKind()                 { return           tdata.range(39, 32);                   }
    // Set the TCP Maximum Segment Size Option
    void        setTcpOptMss(TcpOptMss val)     {                  tdata.range(63, 48);                   }
    // Get the TCP Maximum Segment Size Option
    TcpOptMss   getTcpOptMss()                  { return swapWord (tdata.range(63, 48));                  }
 
  private:
    // Swap the two bytes of a word (.i.e, 16 bits)
    ap_uint<16> swapWord(ap_uint<16> inpWord) {
      return (inpWord.range(7,0), inpWord.range(15, 8));
    }
    // Swap the four bytes of a double-word (.i.e, 32 bits)
    ap_uint<32> swapDWord(ap_uint<32> inpDWord) {
      return (inpDWord.range( 7, 0), inpDWord.range(15,  8),
              inpDWord.range(23,16), inpDWord.range(31, 24));
    }
 
}; // End of: AxisTcp
 
#endif