cloudFPGA (cF) API  1.0
The documentation of the source code of cloudFPGA (cF)
nts_utils.hpp File Reference

: Utilities and helpers for the Network-Transport-Stack (NTS) components. More...

#include "../MEM/mem.hpp"
#include "../NTS/nts.hpp"
Include dependency graph for nts_utils.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  log2Ceil< n >
 

Macros

#define __SYNTH_LOG2CEIL__
 
#define concat2(firstCharConst, secondCharConst)   firstCharConst secondCharConst
 
#define concat3(firstCharConst, secondCharConst, thirdCharConst)   firstCharConst secondCharConst thirdCharConst
 
#define printInfo(callerName, format, ...)    do { gTraceEvent = true; printf("(@%5.5d) [%-20s] INFO - " format, gSimCycCnt, callerName, ##__VA_ARGS__); } while (0)
 A macro to print an information message. More...
 
#define printWarn(callerName, format, ...)    do { gTraceEvent = true; printf("(@%5.5d) [%-20s] WARNING - " format, gSimCycCnt, callerName, ##__VA_ARGS__); } while (0)
 A macro to print a warning message. More...
 
#define printError(callerName, format, ...)    do { gTraceEvent = true; printf("(@%5.5d) [%-20s] ERROR - " format, gSimCycCnt, callerName, ##__VA_ARGS__); } while (0)
 A macro to print an error message. More...
 
#define printFatal(callerName, format, ...)    do { gTraceEvent = true; gFatalError = true; printf("\n(@%5.5d) [%-20s] FATAL - " format, gSimCycCnt, callerName, ##__VA_ARGS__); printf("\n\n"); exit(99); } while (0)
 A macro to print a fatal error message and exit. More...
 
#define assessSize(callerName, stream, streamName, depth)    do { if (stream.size() >= depth) printFatal(callerName, "Stream \'%s\' is full: Cannot write.", streamName); } while (0)
 A macro that checks if a stream is full. More...
 

Functions

tKeep lenTotKeep (ap_uint< 4 > noValidBytes)
 A function to set a number of '1' in an 8-bit field. It is used here to set the number of valid bytes within the 'tkeep' field of an AxisRaw. More...
 
LE_tKeep lenToLE_tKeep (ap_uint< 4 > noValidBytes)
 A function to set a number of '1' in an 8-bit field. It is used here to set the number of valid bytes within the 'tkeep' field of an AxisRaw. More...
 
ap_uint< 16 > byteSwap16 (ap_uint< 16 > inputValue)
 Swap the two bytes of a word (.i.e, 16 bits). More...
 
ap_uint< 32 > byteSwap32 (ap_uint< 32 > inputValue)
 Swap the four bytes of a double-word (.i.e, 32 bits). More...
 
ap_uint< 48 > byteSwap48 (ap_uint< 48 > inputValue)
 Swap the six bytes of a triple-word (.i.e, 48 bits). More...
 
ap_uint< 64 > byteSwap64 (ap_uint< 64 > inputValue)
 Swap the eight bytes of a quad-word (.i.e, 64 bits). More...
 
const char * getTcpStateName (TcpState tcpState)
 Returns the name of an enum-based TCP-State as a user friendly string. More...
 
void printAxisRaw (const char *callerName, AxisRaw chunk)
 Prints an Axis raw data chunk (used for debugging). More...
 
void printAxisRaw (const char *callerName, const char *message, AxisRaw chunk)
 Print an Axis raw data chunk prepended with a message. More...
 
void printDmCmd (const char *callerName, DmCmd dmCmd)
 Prints the details of a Data Mover Command (used for debugging). More...
 
void printArpBindPair (const char *callerName, ArpBindPair arpBind)
 Print an ARP binding pair association. More...
 
void printSockAddr (const char *callerName, SockAddr sockAddr)
 Print a socket address. More...
 
void printSockAddr (const char *callerName, LE_SockAddr leSockAddr)
 Print a socket address. More...
 
void printSockAddr (SockAddr sockAddr)
 
void printSockPair (const char *callerName, SocketPair sockPair)
 Print a socket pair association. More...
 
void printSockPair (const char *callerName, LE_SocketPair leSockPair)
 Print a socket pair association. More...
 
void printLE_SockAddr (const char *callerName, LE_SockAddr leSockAddr)
 Print a socket address encoded in LITTLE_ENDIAN order. More...
 
void printLE_SockPair (const char *callerName, LE_SocketPair sockPair)
 Print a socket pair association in LITTLE-ENDIAN order. More...
 
void printIp4Addr (const char *callerName, const char *message, Ip4Addr ip4Addr)
 Print an IPv4 address prepended with a message (used for debugging). More...
 
void printIp4Addr (const char *callerName, Ip4Addr ip4Addr)
 Print an IPv4 address encoded in NETWORK-BYTE order. More...
 
void printEthAddr (const char *callerName, const char *message, EthAddr ethAddr)
 Print an ETHERNET MAC address prepended with a message (for debug). More...
 
void printEthAddr (const char *callerName, EthAddr ethAddr)
 Print an ETHERNET MAC address in NETWORK-BYTE order. More...
 
void printEthAddr (EthAddr ethAddr)
 
void printTcpPort (const char *callerName, TcpPort tcpPort)
 Print a TCP port. More...
 
void printTcpPort (TcpPort tcpPort)
 

Variables

bool gTraceEvent
 
bool gFatalError
 
unsigned int gSimCycCnt
 

Detailed Description

: Utilities and helpers for the Network-Transport-Stack (NTS) components.

System: : cloudFPGA Component : Shell, Network Transport Stack (NTS) Language : Vivado HLS

Definition in file nts_utils.hpp.