Macros
#define	DB_TCPIP (1)
	Flags to control the debug print functions.

#define	DB_HTTP (2)
	HTTP debug messages.

#define	DB_ETHER (4)
	Ethernet debug messages.

#define	DB_RTOS (8)
	RTOS debug messages.

#define	DB_BUFFER (16)
	Buffer debug messages.

#define	DB_PPP (32)
	PPP debug messages.

#define	DB_AU (64)
	Authentication debug messages.

#define	DB_MAIL (128)
	Mail debug messages.

#define	DB_IP (256)
	IP debug messages.

#define	DB_TCPDATA (512)
	TCP data debug messages.

#define	DB_SSL (1024)
	SSL debug messages.

#define	DB_SNMP (2048)
	SNMP debug messages.

#define	DB_IPV6_ND (4096)
	IPv6 Neighbor Discovery debug messages.

#define	DB_IPV6_ICMP (8192)
	IPv6 ICMP debug messages.

#define	DB_IPV6_ROUTE (16384)
	IPv6 routing debug messages.

#define	DB_IPV6_FRAG (32768)
	IPv6 fragmentation debug messages.

#define	DB_IPV6_ERR (65536)
	IPv6 error debug messages.

Functions
IPADDR	AsciiToIp6 (const char *p)
	Convert an ASCII IPv6 string to an IP address.

void	ShowCounters ()
	Dump all system counters to stdio.

void	sShowCounters (char *buffer, int slen)
	Dump all system counters to a memory buffer.

void	FdShowRingData (int fd, const uint8_t ringBuf, uint32_t bufLen, uint32_t start, uint32_t end, const char indent=NULL)
	Dump part of a ring buffer to file descriptor.

void	ShowRingData (const uint8_t ringBuf, uint32_t bufLen, uint32_t start, uint32_t end, const char indent=NULL)
	Dump part of a ring buffer to stdio.

void	FdShowData (int fd, const uint8_t *fromptr, uint16_t len)
	Dump a block of data to file descriptor and show in ASCII and hex.

void	ShowData (const uint8_t *fromptr, uint16_t len)
	Dump a block of data to stdio and show in ASCII and hex.

void	ShowMac (const MACADR *ma)
	Dump a MAC address to stdio.

void	fdShowMac (int fd, const MACADR *ma)
	Dump a MAC address to file descriptor.

void	ShowMac (const MACADR &ma)
	Dump a MAC address to stdio (reference version)

void	snShowMac (char buf, size_t maxlen, const MACADR ma)
	Dump a MAC address to character buffer.

void	snShowMac (char *buf, size_t maxlen, const MACADR &ma)
	Dump a MAC address to character buffer (reference version)

void	MacToID (MACADR ma, char IDBuf)
	Write 6 character ID string based on unique portion of MAC.

void	outbyte (char c)
	Write out a single, unbuffered byte to stdio.

void	print (const char *str)
	Write out a zero-terminated, unbuffered string.

void	putnum (int i)
	Write out a hexadecimal, unbuffered number to stdio.

void	putbytenum (unsigned char c)
	Write out a hexadecimal, unbuffered byte to stdio.

IPADDR4	AsciiToIp4 (const char *p)
	Convert an ASCII IPv4 string to an IP address.

MACADR	AsciiToMac (const char *p)
	Convert an ASCII MAC address string to a MAC address.

BOOL	ValidIPv4 (const char *p)
	Validate if a string contains a valid IPv4 address.

void	ShowIP4 (const IPADDR4 ia)
	Dump an IPv4 address in ASCII IP string format to stdio.

int	snShowIP4 (char *buf, size_t maxlen, const IPADDR4 ia)
	Dump an IPv4 address in ASCII IP string format to character buffer.

void	ShowIP6 (const IPADDR &ia)
	Dump an IPv6 address in ASCII IP string format to stdio.

int	snShowIP6 (char *buf, size_t maxlen, const IPADDR &ia)
	Dump an IPv6 address in ASCII IP string format to character buffer.

uint32_t	GetPreciseTime (void)
	Converts an integer to ASCII (adds the stdlib itoa)

unsigned long long	Get_msec ()
	Returns the number of milliseconds as a 64-bit value.

int	kill (int pid, int sig)
	Send a signal to a process.

void	_exit (int i)
	Terminate the calling process.

int	_fini (void)
	Finalization function.

unsigned char *	convertBinaryToHexAscii (unsigned char fromBufferPtr, unsigned int fromByteCount, unsigned char toBufferPtr, unsigned int toByteCount)
	Convert binary data to hexadecimal ASCII.

unsigned char *	convertHexAsciiToBinary (unsigned char fromBufferPtr, unsigned int fromByteCount, unsigned char toBufferPtr, unsigned int toByteCount)
	Convert hexadecimal ASCII to binary data.

const char *	bufnstr (const char search, const char target, size_t len)
	Search for a C string in an arbitrary memory blob that may contain NULL chars.

Detailed Description

#include< utils.h>

Macro Definition Documentation

◆ DB_TCPIP

#define DB_TCPIP (1)

#include <utils.h>

Flags to control the debug print functions.

TCP/IP debug messages

Function Documentation

◆ _exit()

void _exit ( int i )

#include <utils.h>

Terminate the calling process.

Parameters

i	Exit status

◆ _fini()

int _fini ( void )

#include <utils.h>

Finalization function.

Returns: Status code

◆ AsciiToIp4()

IPADDR4 AsciiToIp4 ( const char * p )

#include <utils.h>

Convert an ASCII IPv4 string to an IP address.

Parameters

p	Pointer to null-terminated ASCII IPv4 string

Returns: IPADDR4 object containing the converted IPv4 address

◆ AsciiToIp6()

IPADDR AsciiToIp6 ( const char * p )

#include <utils.h>

Convert an ASCII IPv6 string to an IP address.

Parameters

p	Pointer to null-terminated ASCII IPv6 string

Returns: IPADDR object containing the converted IPv6 address

◆ AsciiToMac()

MACADR AsciiToMac ( const char * p )

#include <utils.h>

Convert an ASCII MAC address string to a MAC address.

Parameters

p	Pointer to null-terminated ASCII MAC address string

Returns: MACADR object containing the converted MAC address

◆ bufnstr()

const char * bufnstr	(	const char *	search,
		const char *	target,
		size_t	len )

#include <utils.h>

Search for a C string in an arbitrary memory blob that may contain NULL chars.

Parameters

search	Pointer to the buffer to search
target	The C string being searched for
len	Length of the search buffer

Returns: Pointer to the start of the target string in the search buffer, or NULL if target not found

◆ convertBinaryToHexAscii()

unsigned char * convertBinaryToHexAscii	(	unsigned char *	fromBufferPtr,
		unsigned int	fromByteCount,
		unsigned char *	toBufferPtr,
		unsigned int	toByteCount )

#include <utils.h>

Convert binary data to hexadecimal ASCII.

Parameters

fromBufferPtr	Source binary data
fromByteCount	Source byte count
toBufferPtr	Buffer for converted hexadecimal ASCII data
toByteCount	Size of destination buffer

Returns: Pointer to next free byte in converted buffer

Note: Hexadecimal ASCII buffer must be at least twice the size of the binary buffer size

◆ convertHexAsciiToBinary()

unsigned char * convertHexAsciiToBinary	(	unsigned char *	fromBufferPtr,
		unsigned int	fromByteCount,
		unsigned char *	toBufferPtr,
		unsigned int	toByteCount )

#include <utils.h>

Convert hexadecimal ASCII to binary data.

Parameters

fromBufferPtr	Source hexadecimal ASCII data
fromByteCount	Source byte count
toBufferPtr	Buffer for converted binary data
toByteCount	Size of destination buffer

Returns: Pointer to next free byte in converted buffer

◆ FdShowData()

void FdShowData	(	int	fd,
		const uint8_t *	fromptr,
		uint16_t	len )

#include <utils.h>

Dump a block of data to file descriptor and show in ASCII and hex.

Parameters

fd	File descriptor to write to
fromptr	Pointer to data to display
len	Number of bytes to display

◆ fdShowMac()

void fdShowMac	(	int	fd,
		const MACADR *	ma )

#include <utils.h>

Dump a MAC address to file descriptor.

Parameters

fd	File descriptor to write to
ma	Pointer to MACADR structure to display

◆ FdShowRingData()

void FdShowRingData	(	int	fd,
		const uint8_t *	ringBuf,
		uint32_t	bufLen,
		uint32_t	start,
		uint32_t	end,
		const char *	indent = NULL )

#include <utils.h>

Dump part of a ring buffer to file descriptor.

Parameters

fd	File descriptor to write to
ringBuf	Pointer to ring buffer data
bufLen	Total length of ring buffer
start	Start offset in ring buffer
end	End offset in ring buffer
indent	Optional indentation string for formatting (can be NULL)

◆ Get_msec()

unsigned long long Get_msec ( )

#include <utils.h>

Returns the number of milliseconds as a 64-bit value.

Return values

Number of milliseconds

◆ GetPreciseTime()

uint32_t GetPreciseTime ( void )

extern

#include <utils.h>

Converts an integer to ASCII (adds the stdlib itoa)

Parameters

value	Integer value to convert
buffer	Buffer to store the ASCII representation
radix	Base for conversion (e.g., 10 for decimal, 16 for hexadecimal)

Returns: Pointer to the converted string

Gets the time tick since system start at a higher resolution

Resolution depends on the platform: 0.868-us for MOD5234/70, and 1.929-us for MOD5282

Returns: High resolution time tick value

◆ kill()

int kill	(	int	pid,
		int	sig )

#include <utils.h>

Send a signal to a process.

Parameters

pid	Process ID
sig	Signal number

Returns: 0 on success, -1 on error

◆ MacToID()

void MacToID	(	MACADR *	ma,
		char *	IDBuf )

#include <utils.h>

Write 6 character ID string based on unique portion of MAC.

Parameters

ma	Pointer to MACADR structure
IDBuf	Buffer to write 6-character ID string to (must be at least 7 bytes for null terminator)

◆ outbyte()

void outbyte ( char c )

#include <utils.h>

Write out a single, unbuffered byte to stdio.

Parameters

c	Character to output

◆ print()

void print ( const char * str )

#include <utils.h>

Write out a zero-terminated, unbuffered string.

Parameters

str	Pointer to null-terminated string to output

◆ putbytenum()

void putbytenum ( unsigned char c )

#include <utils.h>

Write out a hexadecimal, unbuffered byte to stdio.

Parameters

c	Byte value to output in hexadecimal format

◆ putnum()

void putnum ( int i )

#include <utils.h>

Write out a hexadecimal, unbuffered number to stdio.

Parameters

i	Integer value to output in hexadecimal format

◆ ShowData()

void ShowData	(	const uint8_t *	fromptr,
		uint16_t	len )

#include <utils.h>

Dump a block of data to stdio and show in ASCII and hex.

Parameters

fromptr	Pointer to data to display
len	Number of bytes to display

◆ ShowIP4()

void ShowIP4 ( const IPADDR4 ia )

#include <utils.h>

Dump an IPv4 address in ASCII IP string format to stdio.

Parameters

ia	IPv4 address to display

◆ ShowIP6()

void ShowIP6 ( const IPADDR & ia )

inline

#include <utils.h>

Dump an IPv6 address in ASCII IP string format to stdio.

Parameters

ia	IPv6 address to display

◆ ShowMac() [1/2]

void ShowMac ( const MACADR & ma )

inline

#include <utils.h>

Dump a MAC address to stdio (reference version)

Parameters

ma	Reference to MACADR structure to display

◆ ShowMac() [2/2]

void ShowMac ( const MACADR * ma )

#include <utils.h>

Dump a MAC address to stdio.

Parameters

ma	Pointer to MACADR structure to display

◆ ShowRingData()

void ShowRingData	(	const uint8_t *	ringBuf,
		uint32_t	bufLen,
		uint32_t	start,
		uint32_t	end,
		const char *	indent = NULL )

#include <utils.h>

Dump part of a ring buffer to stdio.

Parameters

ringBuf	Pointer to ring buffer data
bufLen	Total length of ring buffer
start	Start offset in ring buffer
end	End offset in ring buffer
indent	Optional indentation string for formatting (can be NULL)

◆ snShowIP4()

int snShowIP4	(	char *	buf,
		size_t	maxlen,
		const IPADDR4	ia )

#include <utils.h>

Dump an IPv4 address in ASCII IP string format to character buffer.

Parameters

buf	Buffer to write IP address string to
maxlen	Maximum length of buffer
ia	IPv4 address to convert

Returns: Number of characters written to buffer

◆ snShowIP6()

int snShowIP6	(	char *	buf,
		size_t	maxlen,
		const IPADDR &	ia )

inline

#include <utils.h>

Dump an IPv6 address in ASCII IP string format to character buffer.

Parameters

buf	Buffer to write IP address string to
maxlen	Maximum length of buffer
ia	IPv6 address to convert

Returns: Number of characters written to buffer

◆ snShowMac() [1/2]

void snShowMac	(	char *	buf,
		size_t	maxlen,
		const MACADR &	ma )

inline

#include <utils.h>

Dump a MAC address to character buffer (reference version)

Parameters

buf	Buffer to write MAC address string to
maxlen	Maximum length of buffer
ma	Reference to MACADR structure to convert

◆ snShowMac() [2/2]

void snShowMac	(	char *	buf,
		size_t	maxlen,
		const MACADR *	ma )

#include <utils.h>

Dump a MAC address to character buffer.

Parameters

buf	Buffer to write MAC address string to
maxlen	Maximum length of buffer
ma	Pointer to MACADR structure to convert

◆ sShowCounters()

void sShowCounters	(	char *	buffer,
		int	slen )

#include <utils.h>

Dump all system counters to a memory buffer.

Parameters

buffer	Pointer to buffer to store counter information
slen	Size of the buffer in bytes

◆ ValidIPv4()

BOOL ValidIPv4 ( const char * p )

#include <utils.h>

Validate if a string contains a valid IPv4 address.

Parameters

p	Pointer to null-terminated string to validate

Returns: TRUE if string contains valid IPv4 address, FALSE otherwise

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ DB_TCPIP

Function Documentation

◆ _exit()

◆ _fini()

◆ AsciiToIp4()

◆ AsciiToIp6()

◆ AsciiToMac()

◆ bufnstr()

◆ convertBinaryToHexAscii()

◆ convertHexAsciiToBinary()

◆ FdShowData()

◆ fdShowMac()

◆ FdShowRingData()

◆ Get_msec()

◆ GetPreciseTime()

◆ kill()

◆ MacToID()

◆ outbyte()

◆ print()

◆ putbytenum()

◆ putnum()

◆ ShowData()

◆ ShowIP4()

◆ ShowIP6()

◆ ShowMac() [1/2]

◆ ShowMac() [2/2]

◆ ShowRingData()

◆ snShowIP4()

◆ snShowIP6()

◆ snShowMac() [1/2]

◆ snShowMac() [2/2]

◆ sShowCounters()

◆ ValidIPv4()