nz_debug.h

Go to the documentation of this file.

//  Debug - documentation module
#ifndef NZ_DEBUG_H
#define NZ_DEBUG_H

#include "nz_circularBuffer.h"

#if !defined(SERPORT_DEBUG_CREATE_OWN_CIRBUFS)
#include "nz_serDataPorts.h"
#endif

//Default Defines

#if !defined(DEBUG_LEVEL_OFF)
#define DEBUG_LEVEL_OFF         0
#endif

#if !defined(DEBUG_LEVEL_CRITICAL)
#define DEBUG_LEVEL_CRITICAL    1
#endif

#if !defined(DEBUG_LEVEL_ERROR)
#define DEBUG_LEVEL_ERROR       2
#endif

#if !defined(DEBUG_LEVEL_WARNING)
#define DEBUG_LEVEL_WARNING     3
#endif

#if !defined(DEBUG_LEVEL_INFO)
#define DEBUG_LEVEL_INFO        4
#endif

#if !defined(DEBUG_LEVEL_FINE)
#define DEBUG_LEVEL_FINE        5
#endif

#if !defined(DEBUG_TEMP_BUF_SIZE)
#define DEBUG_TEMP_BUF_SIZE 128
#endif

#if !defined(DEBUG_TXBUF_SIZE)
#define DEBUG_TXBUF_SIZE 256
#endif

#if !defined(DEBUG_RXBUF_SIZE)
#define DEBUG_RXBUF_SIZE 32
#endif


//Defines


//Variables

extern char debugTempBuf[DEBUG_TEMP_BUF_SIZE];

//TX and RX "Circular Buffers". Use SERPORT_DEBUG_CREATE_OWN_CIRBUFS define to use this
//module without SERPORTs. If NOT defined, this modules requires nz_serDataPorts.c
#if defined(SERPORT_DEBUG_CREATE_OWN_CIRBUFS)
    #if !defined(CIRBUF_TX_DEBUG)
    extern CIRBUF cbufTxDebug;                 //Buffer used for Debug Tx
    #define CIRBUF_TX_DEBUG (&cbufTxDebug)
    #endif

    #if !defined(CIRBUF_RX_DEBUG)
    extern CIRBUF cbufRxDebug;                 //Buffer used for Debug Rx
    #define CIRBUF_RX_DEBUG (&cbufRxDebug)
    #endif
#endif

#if !defined(DEBUG_ERROR_FLAGS_DEFINED)
typedef union __attribute__((aligned(2), packed)) {
    WORD val;
    BYTE v[2];
    struct {
        unsigned long bSerPortMemAllocFail:1;
        unsigned long bCirbufSizeError:1;
        unsigned long bCirbufPacketFormatError:1;
        unsigned long bDebugFlagsRes0_3:1;
        unsigned long bDebugFlagsRes0_4:1;
        unsigned long bDebugFlagsRes0_5:1;
        unsigned long bDebugFlagsRes0_6:1;
        unsigned long bDebugFlagsRes0_7:1;

        unsigned long bDebugFlagsRes1_0:1;
        unsigned long bDebugFlagsRes1_1:1;
        unsigned long bDebugFlagsRes1_2:1;
        unsigned long bDebugFlagsRes1_3:1;
        unsigned long bDebugFlagsRes1_4:1;
        unsigned long bDebugFlagsRes1_5:1;
        unsigned long bDebugFlagsRes1_6:1;
        unsigned long bDebugFlagsRes1_7:1;
    } bits;
} DEBUG_ERROR_FLAGS;
#endif

extern DEBUG_ERROR_FLAGS debugErrorFlags;


#if defined(HAS_NZ_DEBUGGING)

void debugInit(void);
#else
#define debugInit()
#endif


#if defined(HAS_NZ_DEBUGGING)

void debugAllInitDone(void);
#else
#define debugAllInitDone()
#endif


#if defined(HAS_NZ_DEBUGGING)

void debugService(void);
#else
#define debugService()
#endif


#if defined(HAS_NZ_DEBUGGING)

void debugPutChar(CHAR c);
#else
#define debugPutChar(c)
#endif


#if defined(HAS_NZ_DEBUGGING)

void debugPutByte(BYTE b);
#else
#define debugPutByte(b)
#endif


#if defined(HAS_NZ_DEBUGGING)

void debugPutWord(WORD w);
#else
#define debugPutWord(w)
#endif


#if defined(HAS_NZ_DEBUGGING)

void debugPutArray(const BYTE* pArr, WORD size);
#else
#define debugPutArray(pArr, size)
#endif


#if defined(HAS_NZ_DEBUGGING)

void debugPutString(const char * str);
#else
#define debugPutString(str)
#endif


#if defined(HAS_NZ_DEBUGGING)

void debugPutHexByte(BYTE b);
#else
#define debugPutHexByte(w)
#endif


#if defined(HAS_NZ_DEBUGGING)

void debugPutHexWord(WORD w);
#else
#define debugPutHexWord(w)
#endif



#if defined(HAS_NZ_DEBUGGING)

void debugPutHexLine(DWORD adr, BYTE* buf, BYTE len);
#else
#define debugPutHexLine(adr, buf, len)
#endif


#if defined(HAS_NZ_DEBUGGING)

void debugWaitForSpace(BYTE required);
#else
#define debugWaitForSpace(required)
#endif


#if defined(HAS_NZ_DEBUGGING)

void debugWaitTillAllSent(void);
#else
#define debugWaitTillAllSent()
#endif


#if defined(HAS_NZ_DEBUGGING)

BOOL debugIsTxBufEmpty(void);
#else
#define debugIsTxBufEmpty()     (1)
#endif

#if !defined(DEBUG_PUT_STR)
#define  DEBUG_PUT_STR(lvl, str) {if (MY_DEBUG_LEVEL >= lvl) {debugPutString(str);}}
#endif

#if !defined(DEBUG_PUT_CHAR)
#define  DEBUG_PUT_CHAR(lvl, c) {if (MY_DEBUG_LEVEL >= lvl) {debugPutChar(c);}}
#endif

#if !defined(DEBUG_PUT_BYTE)
#define  DEBUG_PUT_BYTE(lvl, c) {if (MY_DEBUG_LEVEL >= lvl) {debugPutByte(c);}}
#endif

#if !defined(DEBUG_PUT_WORD)
#define  DEBUG_PUT_WORD(lvl, w) {if (MY_DEBUG_LEVEL >= lvl) {debugPutWord(w);}}
#endif

#if !defined(DEBUG_PUT_HEXBYTE)
#define  DEBUG_PUT_HEXBYTE(lvl, b) {if (MY_DEBUG_LEVEL >= lvl) {debugPutHexByte(b);}}
#endif

#if !defined(DEBUG_PUT_HEXWORD)
#define  DEBUG_PUT_HEXWORD(lvl, w) {if (MY_DEBUG_LEVEL >= lvl) {debugPutHexWord(w);}}
#endif


#endif