firmware_tools/verification/lib/tests/utils/tcpClient.h
2020-09-04 10:36:01 +01:00

186 lines
No EOL
7 KiB
C++

/**************************************************************/
/* tcpClient.h Date: 2020/08/21 */
/* */
/* Copyright (c) 2020 GIS. All rights reserved. */
/* */
/**************************************************************/
#ifndef _TCP_CLIENT_H_
#define _TCP_CLIENT_H_
#include <stdio.h>
#include <stdint.h>
#include "tcpAccess.h"
class tcpClient : public tcpAccess
{
public:
// --------------------------------------------
// Static constants
// --------------------------------------------
// CRC32 parameters
static const uint32_t POLY = 0xEDB88320; /* 0x04C11DB7 bit reveresed */
static const uint32_t INIT = 0xFFFFFFFF;
// Nominal 10G clock frequency (Hz)
static const uint32_t CLK10G_FREQ = 156250000;
// IPv4 parameters
static const uint32_t IPV4_MULTICAST_ADDR = 0x00000000;
static const uint32_t IPV4_SUBNET_MASK = 0xffffffff;
static const uint32_t IPV4_MIN_HDR_LEN = 5; // DWORDS
static const uint32_t IPV4_SRC_ADDR_OFFSET = 3; // DWORDS
// TCP parameters
static const uint32_t IPV4_DST_ADDR_OFFSET = 4; // DWORDS
static const uint32_t TCP_MIN_HDR_LEN = 5; // DWORDS
static const uint32_t TCP_CHKSUM_OFFSET = 16; // BYTES
static const uint32_t TCP_PROTOCOL_NUM = 6;
// TCP header flag masks
static const uint32_t TCP_FLAG_NS = 0x100;
static const uint32_t TCP_FLAG_CWR = 0x080;
static const uint32_t TCP_FLAG_ECE = 0x040;
static const uint32_t TCP_FLAG_URG = 0x020;
static const uint32_t TCP_FLAG_ACK = 0x010;
static const uint32_t TCP_FLAG_PSH = 0x008;
static const uint32_t TCP_FLAG_RST = 0x004;
static const uint32_t TCP_FLAG_SYN = 0x002;
static const uint32_t TCP_FLAG_FIN = 0x001;
// Receiver error masks
static const uint32_t RX_BAD_CRC = 0x0001;
static const uint32_t RX_WRONG_MAC_ADDR = 0x0002;
static const uint32_t RX_BAD_IPV4_CHECKSUM = 0x0004;
static const uint32_t RX_WRONG_IPV4_ADDR = 0x0008;
static const uint32_t RX_BAD_TCP_CHECKSUM = 0x0010;
static const uint32_t RX_WRONG_TCP_PORT = 0x0020;
// --------------------------------------------
// Type definitions
// --------------------------------------------
// Structure definition for extracted receiver information
typedef struct {
uint64_t src_mac_addr;
uint32_t ipv4_src_addr;
uint32_t tcp_src_port;
uint32_t tcp_seq_num;
uint32_t tcp_ack_num;
uint32_t tcp_flags;
uint32_t tcp_win_size;
uint8_t rx_payload[ETH_MTU];
uint32_t rx_len;
} rxInfo_t;
// Structure definition for transmit parameters
typedef class {
public:
// TCP controls
uint32_t dst_port;
uint32_t seq_num;
uint32_t ack_num;
bool rst_conn;
bool sync_seq;
bool last_pkt;
uint32_t win_size;
// IPV4 parameters
uint32_t ip_dst_addr ;
// MAC parameters
uint64_t mac_dst_addr;
} tcpConfig_t;
// Type definition for user callback function to receive packets
typedef void (*pUsrRxCbFunc_t) (rxInfo_t rx_info, void* hdl);
// --------------------------------------------
// Constructor
// --------------------------------------------
tcpClient (uint32_t nodeIn, uint32_t ipv4AddrIn, uint64_t macAddrIn, uint32_t tcpPortIn) :
tcpAccess(nodeIn),
ipv4_addr(ipv4AddrIn),
mac_addr(macAddrIn),
tcp_port(tcpPortIn)
{
usrRxCbFunc = null;
};
// --------------------------------------------
// Public methods
// --------------------------------------------
// Function to register user callback function to receive packets
void registerUsrRxCbFunc (pUsrRxCbFunc_t pFunc, void* hdlIn) { usrRxCbFunc = pFunc; hdl = hdlIn;};
// Method to generate a TCP/IP packet
uint32_t genTcpIpPkt (tcpConfig_t &cfg, uint32_t* frm_buf, uint32_t* payload, uint32_t payload_len);
private:
// --------------------------------------------
// Private methods
// --------------------------------------------
// Method to construct an ethernet frame with (optional) payload
uint32_t ethFrame (uint32_t* eth_frame, uint32_t* payload, uint32_t payload_len, uint64_t dst_addr);
// Method to construct an IPV4 frame with (optional) payload
uint32_t ipv4Frame (uint32_t* ipv4_frame,
uint32_t* payload,
uint32_t payload_len,
uint32_t ipv4_dst_addr,
bool add_tcp_chksum = true);
// Method to construct a TCP segment with (optional) payload
uint32_t tcpSegment (uint32_t* tcp_seg,
uint32_t* payload,
uint32_t payload_len,
uint32_t dst_port,
uint32_t seq_num,
uint32_t ack_num,
bool reset_connection,
bool sync_seq,
bool last_pkt,
uint32_t window_size = 32768);
// Method for processing raw receive data
uint32_t processFrame (uint32_t* rx_buff, uint32_t rx_len);
// Ethernet CR32 calculation method
uint32_t crc32 (uint32_t* buf, uint32_t len, uint32_t poly = POLY, uint32_t init = INIT, bool debug = false);
// Method to calculate IP4v checksum. Also used (in ipv4frame) to calculate TCP checksum
uint32_t ipv4_chksum (uint32_t* buf, uint32_t len, bool debug = false);
// Method to extract receive data
void extractRx (void);
// --------------------------------------------
// Private member variables
// --------------------------------------------
// This client's TCO port number
uint32_t tcp_port;
// This client's IPV4 address
uint32_t ipv4_addr;
// This client's MAC address
uint64_t mac_addr;
// Pointer to the user's receive callback function
pUsrRxCbFunc_t usrRxCbFunc;
// Handle passed in with callback registration as pointer to calling class instance ('this' pointer).
// Used to reference specific instances' methods and member variables.
void* hdl;
};
#endif