utils.h

Go to the documentation of this file.

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _NB_UTILS_H
#define _NB_UTILS_H
 
// NB Definitions
#include <predef.h>
 
// NB Libs
#include <stddef.h>
#ifndef NB_NET_TYPES_H
#include "nettypes.h"
#endif   // NB_NET_TYPES_H
 
#ifdef IPV6
#include <ipv6/ipv6_addr.h>
IPADDR AsciiToIp6(const char *p);
#endif
 
#define DB_TCPIP (1)         
#define DB_HTTP (2)          
#define DB_ETHER (4)         
#define DB_RTOS (8)          
#define DB_BUFFER (16)       
#define DB_PPP (32)          
#define DB_AU (64)           
#define DB_MAIL (128)        
#define DB_IP (256)          
#define DB_TCPDATA (512)     
#define DB_SSL (1024)        
#define DB_SNMP (2048)       
#define DB_IPV6_ND (4096)    
#define DB_IPV6_ICMP (8192)  
#define DB_IPV6_ROUTE (16384) 
#define DB_IPV6_FRAG (32768) 
#define DB_IPV6_ERR (65536)  
 
// DIAGNOSTIC FUNCTIONS
//
 
void ShowCounters();
 
void sShowCounters(char *buffer, int slen);
 
#ifdef FILE
void fShowCounters(FILE *fp);
#endif                          // FILE
 
// UTILITY I/O FUNCTIONS
//
void FdShowRingData(int fd, const uint8_t *ringBuf, uint32_t bufLen,
                uint32_t start, uint32_t end, const char *indent=NULL);
void ShowRingData(const uint8_t *ringBuf, uint32_t bufLen,
                uint32_t start, uint32_t end, const char *indent=NULL);
void FdShowData(int fd, const uint8_t *fromptr, uint16_t len);
 
void ShowData(const uint8_t *fromptr, uint16_t len);
 
void ShowMac(const MACADR *ma);
 
void fdShowMac(int fd, const MACADR *ma);
 
inline void ShowMac(const MACADR &ma)
{
    ShowMac(&ma);
};
 
void snShowMac(char *buf, size_t maxlen, const MACADR *ma);
 
inline void snShowMac(char *buf, size_t maxlen, const MACADR &ma)
{
    snShowMac(buf, maxlen, &ma);
};
 
void MacToID(MACADR *ma, char *IDBuf);
 
void outbyte(char c);
void print(const char *str);
void putnum(int i);
void putbytenum(unsigned char c);
IPADDR4 AsciiToIp4(const char *p);
MACADR AsciiToMac(const char *p);
BOOL ValidIPv4(const char *p);
 
#ifndef IPV6
#define AsciiToIp AsciiToIp4
#else
#define AsciiToIp AsciiToIp6
#endif
 
void ShowIP4(const IPADDR4 ia);
 
int snShowIP4(char *buf, size_t maxlen, const IPADDR4 ia);
 
#ifdef IPV6
inline void ShowIP6(const IPADDR &ia)
{
    ia.print();
};
 
inline int snShowIP6(char *buf, size_t maxlen, const IPADDR &ia)
{
    return ia.sprintf(buf, maxlen);
};
#define ShowIP ShowIP6
#define snShowIP snShowIP6
#else
#define ShowIP ShowIP4
#define snShowIP snShowIP4
#endif
 
// char *itoa( int value, char *buffer, int radix );
 
// HIGHER RESOLUTION COUNTER READ FUNCTION
//
 
extern uint32_t GetPreciseTime(void);
 
unsigned long long Get_msec();
 
extern "C"
{
    int kill(int pid, int sig);
 
    void _exit(int i);
 
    int _fini(void);
}
 
#ifdef _STDIO_H_
#ifndef FILE
void fShowCounters(FILE *fp);
#endif   // FILE
 
void fShowMac(FILE *fp, const MACADR *ma);
 
void fShowIP4(FILE *fp, const IPADDR4 ia);
 
#ifdef IPV6
void fShowIP6(FILE *fp, const IPADDR &ia);
#define fShowIP fShowIP6
#else
#define fShowIP fShowIP4
#endif
 
#endif   // _STDIO_H_
 
unsigned char *convertBinaryToHexAscii(unsigned char *fromBufferPtr,
                                       unsigned int fromByteCount,
                                       unsigned char *toBufferPtr,
                                       unsigned int toByteCount);
 
unsigned char *convertHexAsciiToBinary(unsigned char *fromBufferPtr,
                                       unsigned int fromByteCount,
                                       unsigned char *toBufferPtr,
                                       unsigned int toByteCount);
 
const char *bufnstr(const char *search, const char *target, size_t len);
 
// DEBUG FUNCTIONS
//
#if ((defined _DEBUG) || (defined _DEBUG_PRINT))
extern unsigned int DB_FLAGS;
void SetLogLevel();
#ifdef COLDFIRE
#define ASSERT(x)                                                   \
    if (!(x))                                                       \
    {                                                               \
        iprintf("ASSERT failed at %d of %s\n", __LINE__, __FILE__); \
        asm("Halt");                                                \
    }
#elif defined CORTEX_M7
#define ASSERT(x)                                                   \
    if (!(x))                                                       \
    {                                                               \
        iprintf("ASSERT failed at %d of %s\n", __LINE__, __FILE__); \
        while (1)                                                   \
            asm("wfi");                                             \
    }
#else
#define ASSERT(x)                                                   \
    if (!(x))                                                       \
    {                                                               \
        iprintf("ASSERT failed at %d of %s\n", __LINE__, __FILE__); \
        while (1)                                                   \
            ;                                                       \
    }
#endif
#define DBPRINT(x, y) \
    if (DB_FLAGS & x) printf(y);
#define DBNUM(x, y) \
    if (DB_FLAGS & x) putnum(y);
#define DBBYTE(x, y) \
    if (DB_FLAGS & x) putbytenum(y);
#define DBPRINTF(x, ...) \
    if (DB_FLAGS & x) printf(__VA_ARGS__);
#define DBIPRINTF(x, ...) \
    if (DB_FLAGS & x) iprintf(__VA_ARGS__);
#else
#define ASSERT(x) ((void)0)
#define DBPRINT(x, y) ((void)0)
#define DBNUM(x, y) ((void)0)
#define DBBYTE(x, y) ((void)0)
#define DBPRINTF(x, ...) ((void)0)
#define DBIPRINTF(x, ...) ((void)0)
#endif   // _DEBUG
 
#if ((defined _DEBUG) || (defined _DEBUG_PRINT))
#define PPPDBPRINT(x) DBPRINT(DB_PPP, (x))
#define PPPDBPRINTF(...) DBPRINTF(DB_PPP, __VA_ARGS__)
#define PPPDBIPRINTF(...) DBIPRINTF(DB_PPP, __VA_ARGS__)
#define PPPDBNUM(x) DBNUM(DB_PPP, (x))
#define PPPDBBYTE(x) DBBYTE(DB_PPP, (x))
#else
/*
   #define PPPDBPRINT(x) printf(x);
        #define PPPDBPRINTF(...)  printf(__VA_ARGS__)
        #define PPPDBIPRINTF(...) printf(__VA_ARGS__)
        #define PPPDBNUM(x) printf("%08X",x)
        #define PPPDBBYTE(x) printf("%02X",x)
*/
#define PPPDBPRINT(x)
#define PPPDBPRINTF(...)
#define PPPDBIPRINTF(...)
#define PPPDBNUM(x)
#define PPPDBBYTE(x)
 
#endif
 
void LocalOutByte(char c);
extern "C"
{
    void Local_OutString(const char *cp);
}
// USER_ENTER_CRITICAL ASSERTION
//
#if ((defined _DEBUG) || (defined USER_CRITICAL_SANITY))
#ifdef COLDFIRE
#define USER_CRITICAL_ASSERT()                                                     \
    if (critical_count != 0)                                                       \
    {                                                                              \
        Local_OutString("Illegal pend after USER_ENTER_CRITICAL(). Halting.\r\n"); \
        while (1)                                                                  \
            asm("Halt");                                                           \
    }
#elif (defined CORTEX_M7)
#define USER_CRITICAL_ASSERT()                                                     \
    if (critical_count != 0)                                                       \
    {                                                                              \
        Local_OutString("Illegal pend after USER_ENTER_CRITICAL(). Halting.\r\n"); \
        while (1)                                                                  \
            asm("wfi");                                                            \
    }
#else
#define USER_CRITICAL_ASSERT()                                                     \
    if (critical_count != 0)                                                       \
    {                                                                              \
        Local_OutString("Illegal pend after USER_ENTER_CRITICAL(). Halting.\r\n"); \
        while (1)                                                                  \
            ;                                                                      \
    }
#endif
#else   // !((defined _DEBUG) || (defined USER_CRITICAL_SANITY))
#define USER_CRITICAL_ASSERT() ((void)0)
#endif
 
// DEVELOPMENT BOARD I/O FUNCTIONS
//
BOOL OnModDev70(void);            // Return TRUE if on MOD-DEV-70, otherwise FALSE
void putleds(unsigned char c);    // Set the LEDs on the MOD-DEV-70/100
unsigned char getleds();          // Get the LEDs state from CPLD, MOD-DEV-100 only
void putdisp(unsigned short w);   // Set the 7-segment LEDs on the MOD-DEV-100, BCD input, CPLD controls segmnet switching
unsigned short getdisp();         // Get the 7-segment LEDs on the MOD-DEV-100, BCD
unsigned char getdipsw();         // Read the DIP switch values on the MOD-DEV-70/100
 
//--- The following functions are only valid on v1.12+ revisions of the dev board
//--- CPLD programming files are available to upgrade older board revs
// Set the 7-segment LEDs on the MOD-DEV-100
void putSegments(unsigned char DisplayMask,
                 unsigned char DisplayData);   // Display Mask - 4bit value indicates which display shows value,  DisplayData - Segment bit
                                               // 7 is decimal point, bits 0-6 = Segments A-G
void putDecimal(unsigned char DisplayMask);    // Set the 7-segment decimal point on the MOD-DEV-100, Display Mask - 4bit value indicates
                                               // which display has decimal point
unsigned char getCPLDver();                    // returns the version # of the CPLD
unsigned char getCPLDrev();                    // returns the revision # of the CPLD
 
//  Predefined segments for the putSegments display function
#define SevenSeg_0 (0x3F)
#define SevenSeg_1 (0x06)
#define SevenSeg_2 (0x5B)
#define SevenSeg_3 (0x4F)
#define SevenSeg_4 (0x66)
#define SevenSeg_5 (0x6D)
#define SevenSeg_6 (0x7C)
#define SevenSeg_7 (0x07)
#define SevenSeg_8 (0x7F)
#define SevenSeg_9 (0x67)
#define SevenSeg_A (0x77)
#define SevenSeg_B (0x7F)
#define SevenSeg_C (0x39)
#define SevenSeg_D (0x3F)
#define SevenSeg_E (0x79)
#define SevenSeg_F (0x71)
#define SevenSeg_H (0x76)
#define SevenSeg_I (0x06)
#define SevenSeg_J (0x1E)
#define SevenSeg_L (0x38)
#define SevenSeg_O (0x3F)
#define SevenSeg_P (0x73)
#define SevenSeg_S (0x6D)
#define SevenSeg_U (0x3E)
#define SevenSeg_b (0x7C)
#define SevenSeg_c (0x58)
#define SevenSeg_d (0x5E)
#define SevenSeg_h (0x74)
#define SevenSeg_l (0x06)
#define SevenSeg_n (0x54)
#define SevenSeg_o (0x53)
#define SevenSeg_r (0x50)
#define SevenSeg_u (0x1C)
#define SevenSeg_Dash (0x40)
#define SevenSeg_Decimal (0x80)
#define SevenSeg_OFF (0x00)
 
#endif /* #ifndef _NB_UTILS_H */