/*
*********************************************************************************************************
*                                      uC/Probe Communication
*
*                           (c) Copyright 2007; Micrium, Inc.; Weston, FL
*
*               All rights reserved.  Protected by international copyright laws.
*               Knowledge of the source code may NOT be used to develop a similar product.
*               Please help us continue to provide the Embedded community with the finest
*               software available.  Your honesty is greatly appreciated.
*********************************************************************************************************
*/

/*
*********************************************************************************************************
*
*                                              uC/Probe
*
*                                      Communication Generic
*
* Filename      : probe_com.h
* Version       : V1.20
* Programmer(s) : Brian Nagel
*********************************************************************************************************
*/

#ifndef  __PROBE_COM_H__
#define  __PROBE_COM_H__


/*
*********************************************************************************************************
*                                               EXTERNS
*********************************************************************************************************
*/

#ifdef    PROBE_COM_GLOBALS
#define   PROBE_COM_EXT
#else
#define   PROBE_COM_EXT  extern
#endif


/*
*********************************************************************************************************
*                                             INCLUDE FILES
*********************************************************************************************************
*/

#include  <cpu.h>

#include  <lib_def.h>
#include  <lib_mem.h>

#include  <probe_com_cfg.h>

#if (PROBE_COM_SUPPORT_STR > 0)
#include  <lib_str.h>
#endif


/*
*********************************************************************************************************
*                                               DEFINES
*********************************************************************************************************
*/


/*
*********************************************************************************************************
*                                          GLOBAL VARIABLES
*********************************************************************************************************
*/

                                                                    /* ------------------- Counters ----------------------- */
#if (PROBE_COM_STAT_EN == DEF_ENABLED)
PROBE_COM_EXT  CPU_INT32U   ProbeCom_RxPktCtr;                      /*  ... Number of packets received                      */
PROBE_COM_EXT  CPU_INT32U   ProbeCom_TxPktCtr;                      /*  ... Number of packets tranmitted                    */
PROBE_COM_EXT  CPU_INT32U   ProbeCom_TxSymCtr;                      /*  ... Number of symbols transmitted                   */
PROBE_COM_EXT  CPU_INT32U   ProbeCom_TxSymByteCtr;                  /*  ... Number of symbol bytes transmitted              */
PROBE_COM_EXT  CPU_INT32U   ProbeCom_ErrPktCtr;                     /*  ... Number of error packets transmitted             */

#if (PROBE_COM_SUPPORT_STR == DEF_TRUE)
PROBE_COM_EXT  CPU_INT32U   ProbeCom_TxStrCtr;                      /*  ... Number of string characters transmitted         */
#endif
#endif

/*
*********************************************************************************************************
*                                               MACRO'S
*********************************************************************************************************
*/


/*
*********************************************************************************************************
*                                         FUNCTION PROTOTYPES
*********************************************************************************************************
*/

void         ProbeCom_Init      (void);

CPU_INT16U   ProbeCom_ParseRxPkt(void        *rx_pkt,
                                 void        *tx_pkt,
                                 CPU_INT16U   rx_pkt_sz,
                                 CPU_INT16U   tx_buf_sz);

#if (PROBE_COM_SUPPORT_STR == DEF_TRUE)
CPU_BOOLEAN  ProbeCom_TxStr     (CPU_CHAR    *s,
                                 CPU_INT16U   dly);
#endif


/*
*********************************************************************************************************
*                                         FUNCTION PROTOTYPES
*                                    DEFINED IN OS's probe_com_os.c
*********************************************************************************************************
*/

#if (PROBE_COM_SUPPORT_STR == DEF_TRUE)
void         ProbeCom_OS_Init   (void);
CPU_BOOLEAN  ProbeCom_OS_Pend   (CPU_BOOLEAN  wait);
void         ProbeCom_OS_Post   (void);
void         ProbeCom_OS_Dly    (CPU_INT16U   dly);
#endif


/*
*********************************************************************************************************
*                                        CONFIGURATION ERRORS
*********************************************************************************************************
*/

#ifndef    PROBE_COM_SUPPORT_WR
  #error  "PROBE_COM_SUPPORT_WR              not #define'd in 'probe_com_cfg.h'     "
  #error  "                       [MUST be  DEF_TRUE   Write commands     supported]"
  #error  "                       [     ||  DEF_FALSE  Write commands NOT supported]"

#elif    ((PROBE_COM_SUPPORT_WR != DEF_TRUE ) && \
          (PROBE_COM_SUPPORT_WR != DEF_FALSE))
  #error  "PROBE_COM_SUPPORT_WR        illegally #define'd in 'probe_com_cfg.h'     "
  #error  "                       [MUST be  DEF_TRUE   Write commands     supported]"
  #error  "                       [     ||  DEF_FALSE  Write commands NOT supported]"
#endif



#ifndef    PROBE_COM_SUPPORT_STR
  #error  "PROBE_COM_SUPPORT_STR                            not #define'd in 'probe_com_cfg.h'     "
  #error  "                       [MUST be  DEF_TRUE   String commands & functions     supported  ]"
  #error  "                       [     ||  DEF_FALSE  String commands & functions NOT supported  ]"

#elif    ((PROBE_COM_SUPPORT_STR != DEF_TRUE ) && \
          (PROBE_COM_SUPPORT_STR != DEF_FALSE))
  #error  "PROBE_COM_SUPPORT_STR                      illegally #define'd in 'probe_com_cfg.h'     "
  #error  "                       [MUST be  DEF_TRUE   String commands & functions     supported  ]"
  #error  "                       [     ||  DEF_FALSE  String commands & functions NOT supported  ]"
#endif



#ifndef    PROBE_COM_STAT_EN
  #error  "PROBE_COM_STAT_EN                 not #define'd in 'probe_com_cfg.h'     "
  #error  "                       [MUST be  DEF_TRUE   Counters are     maintained ]"
  #error  "                       [     ||  DEF_FALSE  Counters are NOT maintained ]"

#elif    ((PROBE_COM_STAT_EN != DEF_TRUE ) && \
          (PROBE_COM_STAT_EN != DEF_FALSE))
  #error  "PROBE_COM_STAT_EN           illegally #define'd in 'probe_com_cfg.h'     "
  #error  "                       [MUST be  DEF_TRUE   Counters are     maintained ]"
  #error  "                       [     ||  DEF_FALSE  Counters are NOT maintained ]"
#endif



#ifndef    PROBE_COM_RX_MAX_SIZE
  #error  "PROBE_COM_RX_BUF_SIZE             not #define'd in 'probe_com_cfg.h'     "
#endif



#ifndef    PROBE_COM_TX_MAX_SIZE
  #error  "PROBE_COM_TX_BUF_SIZE             not #define'd in 'probe_com_cfg.h'     "
#endif


/*
*********************************************************************************************************
*                                             MODULE END
*********************************************************************************************************
*/

#endif                                                              /* End of module include.                               */