bsSerialMsgs.c

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: bsSerialMsgs.c
//
/*!
 * \file
 *
 * \brief BotSense bsProxy server - client raw serial NetMsgs XML Definition
 *
 * \warning This file was auto-generated on 2018.08.10 13:54:23 from the NetMsgs
 * XML specification bsSerialMsgs.xml.
 *
 * \par Copyright:
 * (C) 2018. RoadNarrows LLC
 * (http://www.roadnarrows.com)
 * All Rights Reserved
 */
///////////////////////////////////////////////////////////////////////////////


#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/netmsgs.h"

#include "botsense/bsSerialMsgs.h"

#ifndef EOFDEF
/*! End of Field Definition entry. */
#define EOFDEF {NULL, 0, NMFTypeNone, 0, }
#endif // EOFDEF


//-----------------------------------------------------------------------------
// Private Interface
//-----------------------------------------------------------------------------


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsSerialReqOpenArgs Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsSerialReqOpenArgs Field Id Enumeration
 */
typedef enum
{
  BsSerialReqOpenArgsFIdReserved        = 0,    ///< reserved field id
  BsSerialReqOpenArgsFIdbaudrate        = 1,    ///< baudrate field id
  BsSerialReqOpenArgsFIdbytesize        = 2,    ///< bytesize field id
  BsSerialReqOpenArgsFIdparity          = 3,    ///< parity field id
  BsSerialReqOpenArgsFIdstopbits        = 4,    ///< stopbits field id
  BsSerialReqOpenArgsFIdrtscts          = 5,    ///< rtscts field id
  BsSerialReqOpenArgsFIdxonxoff         = 6,    ///< xonxoff field id
  BsSerialReqOpenArgsFIdNumOf           = 7     ///< number of fields
} BsSerialReqOpenArgsFId_T;

/*!
 * BsSerialReqOpenArgs Field Definitions
 */
static const NMFieldDef_T BsSerialReqOpenArgsFieldDefs[] =
{
  {
    .m_sFName                 = "baudrate",
    .m_eFId                   = BsSerialReqOpenArgsFIdbaudrate,
    .m_eFType                 = NMFTypeU32,
    .m_uOffset                = memberoffset(BsSerialReqOpenArgs_T, m_baudrate),
    .m_this.m_u32.m_bits      = (byte_t)(0),
    .m_this.m_u32.m_valMin    = (uint_t)(0),
    .m_this.m_u32.m_valMax    = (uint_t)(0),
    .m_this.m_u32.m_valConst  = (uint_t)(0),
  },
  {
    .m_sFName                 = "bytesize",
    .m_eFId                   = BsSerialReqOpenArgsFIdbytesize,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsSerialReqOpenArgs_T, m_bytesize),
    .m_this.m_u8.m_bits       = (byte_t)(0),
    .m_this.m_u8.m_valMin     = (byte_t)(0),
    .m_this.m_u8.m_valMax     = (byte_t)(0),
    .m_this.m_u8.m_valConst   = (byte_t)(0),
  },
  {
    .m_sFName                 = "parity",
    .m_eFId                   = BsSerialReqOpenArgsFIdparity,
    .m_eFType                 = NMFTypeChar,
    .m_uOffset                = memberoffset(BsSerialReqOpenArgs_T, m_parity),
  },
  {
    .m_sFName                 = "stopbits",
    .m_eFId                   = BsSerialReqOpenArgsFIdstopbits,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsSerialReqOpenArgs_T, m_stopbits),
    .m_this.m_u8.m_bits       = (byte_t)(0),
    .m_this.m_u8.m_valMin     = (byte_t)(0),
    .m_this.m_u8.m_valMax     = (byte_t)(0),
    .m_this.m_u8.m_valConst   = (byte_t)(0),
  },
  {
    .m_sFName                 = "rtscts",
    .m_eFId                   = BsSerialReqOpenArgsFIdrtscts,
    .m_eFType                 = NMFTypeBool,
    .m_uOffset                = memberoffset(BsSerialReqOpenArgs_T, m_rtscts),
  },
  {
    .m_sFName                 = "xonxoff",
    .m_eFId                   = BsSerialReqOpenArgsFIdxonxoff,
    .m_eFType                 = NMFTypeBool,
    .m_uOffset                = memberoffset(BsSerialReqOpenArgs_T, m_xonxoff),
  },
  EOFDEF
};

/*!
 * BsSerialReqOpenArgs Message Definition
 */
static const NMMsgDef_T BsSerialReqOpenArgsMsgDef =
{
  .m_sMsgName         = "BsSerialReqOpenArgs",
  .m_eMsgId           = BsSerialMsgIdReqOpenArgs,
  .m_uCount           = (size_t)(6),
  .m_pFields          = BsSerialReqOpenArgsFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsSerialReqRead Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsSerialReqRead Field Id Enumeration
 */
typedef enum
{
  BsSerialReqReadFIdReserved            = 0,    ///< reserved field id
  BsSerialReqReadFIdreadlen             = 1,    ///< readlen field id
  BsSerialReqReadFIdNumOf               = 2     ///< number of fields
} BsSerialReqReadFId_T;

/*!
 * BsSerialReqRead Field Definitions
 */
static const NMFieldDef_T BsSerialReqReadFieldDefs[] =
{
  {
    .m_sFName                 = "readlen",
    .m_eFId                   = BsSerialReqReadFIdreadlen,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsSerialReqRead_T, m_readlen),
    .m_this.m_u8.m_bits       = (byte_t)(NMBITS_HAS_MIN|NMBITS_HAS_MAX),
    .m_this.m_u8.m_valMin     = (byte_t)(1),
    .m_this.m_u8.m_valMax     = (byte_t)(NMFVAL_LEN_MAX_VECTOR),
    .m_this.m_u8.m_valConst   = (byte_t)(0),
  },
  EOFDEF
};

/*!
 * BsSerialReqRead Message Definition
 */
static const NMMsgDef_T BsSerialReqReadMsgDef =
{
  .m_sMsgName         = "BsSerialReqRead",
  .m_eMsgId           = BsSerialMsgIdReqRead,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsSerialReqReadFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsSerialReqTrans Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsSerialReqTranswritebuf Field Definitions
 */
static const NMFieldDef_T BsSerialReqTranswritebufFieldDef[] =
{
  {
    .m_sFName                 = "writebuf",
    .m_eFId                   = 0,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = (size_t)0,
    .m_this.m_u8.m_bits       = (byte_t)(0),
    .m_this.m_u8.m_valMin     = (byte_t)(0),
    .m_this.m_u8.m_valMax     = (byte_t)(0),
    .m_this.m_u8.m_valConst   = (byte_t)(0),
  },
  EOFDEF
};

/*!
 * BsSerialReqTrans Field Id Enumeration
 */
typedef enum
{
  BsSerialReqTransFIdReserved           = 0,    ///< reserved field id
  BsSerialReqTransFIdwritebuf           = 1,    ///< writebuf field id
  BsSerialReqTransFIdreadlen            = 2,    ///< readlen field id
  BsSerialReqTransFIdNumOf              = 3     ///< number of fields
} BsSerialReqTransFId_T;

/*!
 * BsSerialReqTrans Field Definitions
 */
static const NMFieldDef_T BsSerialReqTransFieldDefs[] =
{
  {
    .m_sFName                 = "writebuf",
    .m_eFId                   = BsSerialReqTransFIdwritebuf,
    .m_eFType                 = NMFTypeVector,
    .m_uOffset                = memberoffset(BsSerialReqTrans_T, m_writebuf),
    .m_this.m_vector.m_uMaxCount
                              = (size_t)BSSERIAL_REQTRANS_WRITEBUF_LEN,
    .m_this.m_vector.m_uElemSize
                              = sizeof(byte_t),
    .m_this.m_vector.m_pThisElem
                              = BsSerialReqTranswritebufFieldDef,
  },
  {
    .m_sFName                 = "readlen",
    .m_eFId                   = BsSerialReqTransFIdreadlen,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsSerialReqTrans_T, m_readlen),
    .m_this.m_u8.m_bits       = (byte_t)(NMBITS_HAS_MIN|NMBITS_HAS_MAX),
    .m_this.m_u8.m_valMin     = (byte_t)(1),
    .m_this.m_u8.m_valMax     = (byte_t)(NMFVAL_LEN_MAX_VECTOR),
    .m_this.m_u8.m_valConst   = (byte_t)(0),
  },
  EOFDEF
};

/*!
 * BsSerialReqTrans Message Definition
 */
static const NMMsgDef_T BsSerialReqTransMsgDef =
{
  .m_sMsgName         = "BsSerialReqTrans",
  .m_eMsgId           = BsSerialMsgIdReqTrans,
  .m_uCount           = (size_t)(2),
  .m_pFields          = BsSerialReqTransFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsSerialRspRead Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsSerialRspReadreadbuf Field Definitions
 */
static const NMFieldDef_T BsSerialRspReadreadbufFieldDef[] =
{
  {
    .m_sFName                 = "readbuf",
    .m_eFId                   = 0,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = (size_t)0,
    .m_this.m_u8.m_bits       = (byte_t)(0),
    .m_this.m_u8.m_valMin     = (byte_t)(0),
    .m_this.m_u8.m_valMax     = (byte_t)(0),
    .m_this.m_u8.m_valConst   = (byte_t)(0),
  },
  EOFDEF
};

/*!
 * BsSerialRspRead Field Id Enumeration
 */
typedef enum
{
  BsSerialRspReadFIdReserved            = 0,    ///< reserved field id
  BsSerialRspReadFIdreadbuf             = 1,    ///< readbuf field id
  BsSerialRspReadFIdNumOf               = 2     ///< number of fields
} BsSerialRspReadFId_T;

/*!
 * BsSerialRspRead Field Definitions
 */
static const NMFieldDef_T BsSerialRspReadFieldDefs[] =
{
  {
    .m_sFName                 = "readbuf",
    .m_eFId                   = BsSerialRspReadFIdreadbuf,
    .m_eFType                 = NMFTypeVector,
    .m_uOffset                = memberoffset(BsSerialRspRead_T, m_readbuf),
    .m_this.m_vector.m_uMaxCount
                              = (size_t)BSSERIAL_RSPREAD_READBUF_LEN,
    .m_this.m_vector.m_uElemSize
                              = sizeof(byte_t),
    .m_this.m_vector.m_pThisElem
                              = BsSerialRspReadreadbufFieldDef,
  },
  EOFDEF
};

/*!
 * BsSerialRspRead Message Definition
 */
static const NMMsgDef_T BsSerialRspReadMsgDef =
{
  .m_sMsgName         = "BsSerialRspRead",
  .m_eMsgId           = BsSerialMsgIdRspRead,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsSerialRspReadFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsSerialReqWrite Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsSerialReqWritewritebuf Field Definitions
 */
static const NMFieldDef_T BsSerialReqWritewritebufFieldDef[] =
{
  {
    .m_sFName                 = "writebuf",
    .m_eFId                   = 0,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = (size_t)0,
    .m_this.m_u8.m_bits       = (byte_t)(0),
    .m_this.m_u8.m_valMin     = (byte_t)(0),
    .m_this.m_u8.m_valMax     = (byte_t)(0),
    .m_this.m_u8.m_valConst   = (byte_t)(0),
  },
  EOFDEF
};

/*!
 * BsSerialReqWrite Field Id Enumeration
 */
typedef enum
{
  BsSerialReqWriteFIdReserved           = 0,    ///< reserved field id
  BsSerialReqWriteFIdwritebuf           = 1,    ///< writebuf field id
  BsSerialReqWriteFIdNumOf              = 2     ///< number of fields
} BsSerialReqWriteFId_T;

/*!
 * BsSerialReqWrite Field Definitions
 */
static const NMFieldDef_T BsSerialReqWriteFieldDefs[] =
{
  {
    .m_sFName                 = "writebuf",
    .m_eFId                   = BsSerialReqWriteFIdwritebuf,
    .m_eFType                 = NMFTypeVector,
    .m_uOffset                = memberoffset(BsSerialReqWrite_T, m_writebuf),
    .m_this.m_vector.m_uMaxCount
                              = (size_t)BSSERIAL_REQWRITE_WRITEBUF_LEN,
    .m_this.m_vector.m_uElemSize
                              = sizeof(byte_t),
    .m_this.m_vector.m_pThisElem
                              = BsSerialReqWritewritebufFieldDef,
  },
  EOFDEF
};

/*!
 * BsSerialReqWrite Message Definition
 */
static const NMMsgDef_T BsSerialReqWriteMsgDef =
{
  .m_sMsgName         = "BsSerialReqWrite",
  .m_eMsgId           = BsSerialMsgIdReqWrite,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsSerialReqWriteFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsSerialRspWrite Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsSerialRspWrite Field Id Enumeration
 */
typedef enum
{
  BsSerialRspWriteFIdReserved           = 0,    ///< reserved field id
  BsSerialRspWriteFIdbyteswritten       = 1,    ///< byteswritten field id
  BsSerialRspWriteFIdNumOf              = 2     ///< number of fields
} BsSerialRspWriteFId_T;

/*!
 * BsSerialRspWrite Field Definitions
 */
static const NMFieldDef_T BsSerialRspWriteFieldDefs[] =
{
  {
    .m_sFName                 = "byteswritten",
    .m_eFId                   = BsSerialRspWriteFIdbyteswritten,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsSerialRspWrite_T, m_byteswritten),
    .m_this.m_u8.m_bits       = (byte_t)(0),
    .m_this.m_u8.m_valMin     = (byte_t)(0),
    .m_this.m_u8.m_valMax     = (byte_t)(0),
    .m_this.m_u8.m_valConst   = (byte_t)(0),
  },
  EOFDEF
};

/*!
 * BsSerialRspWrite Message Definition
 */
static const NMMsgDef_T BsSerialRspWriteMsgDef =
{
  .m_sMsgName         = "BsSerialRspWrite",
  .m_eMsgId           = BsSerialMsgIdRspWrite,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsSerialRspWriteFieldDefs
};


//-----------------------------------------------------------------------------
// Public Interface
//-----------------------------------------------------------------------------

/*!
 * BsSerial Message Definition Look-Up Table. Indexed by BsSerialMsgId_T enum.
 */
const NMMsgDef_T *BsSerialMsgDefLookupTbl[] =
{
  NULL,                                 ///< [BsSerialMsgIdNone]
  &BsSerialReqOpenArgsMsgDef,           ///< [BsSerialMsgIdReqOpenArgs]
  &BsSerialReqReadMsgDef,               ///< [BsSerialMsgIdReqRead]
  &BsSerialReqTransMsgDef,              ///< [BsSerialMsgIdReqTrans]
  &BsSerialRspReadMsgDef,               ///< [BsSerialMsgIdRspRead]
  &BsSerialReqWriteMsgDef,              ///< [BsSerialMsgIdReqWrite]
  &BsSerialRspWriteMsgDef,              ///< [BsSerialMsgIdRspWrite]
  NULL                                  ///< [BsSerialMsgIdNumOf]
};

/*!
 * BsSerial Message Maximum Size Look-Up Table. Indexed by BsSerialMsgId_T enum.
 */
size_t BsSerialMsgMaxLenLookupTbl[] =
{
  (size_t)(0),                          ///< [BsSerialMsgIdNone]
  (size_t)(24),                         ///< [BsSerialMsgIdReqOpenArgs]
  (size_t)(6),                          ///< [BsSerialMsgIdReqRead]
  (size_t)(265),                        ///< [BsSerialMsgIdReqTrans]
  (size_t)(262),                        ///< [BsSerialMsgIdRspRead]
  (size_t)(262),                        ///< [BsSerialMsgIdReqWrite]
  (size_t)(6),                          ///< [BsSerialMsgIdRspWrite]
  (size_t)(0)                           ///< [BsSerialMsgIdNumOf]
};


//-----------------------------------------------------------------------------
// Functions
//-----------------------------------------------------------------------------

/*!
 * \brief Look up the message definition associated with the message id.
 * 
 * \param eMsgId          Message Id.
 * 
 * \return
 * On success, returns the pointer to the NMMsgDef_T.
 * On error, NULL is returned.
 */
const NMMsgDef_T * BsSerialLookupMsgDef( BsSerialMsgId_T eMsgId )
{
  if( (uint_t)eMsgId >= (uint_t)BsSerialMsgIdNumOf )
  {
    return NULL;
  }
  else
  {
    return BsSerialMsgDefLookupTbl[(uint_t)eMsgId];
  }
}

/*!
 * \brief Look up the message maximum length associated with the message id.
 * 
 * The maximum length is the total number of packed bytes possible for the
 * given message. The message may be much shorter.
 * 
 * \param eMsgId          Message Id.
 * 
 * \return
 * On success, returns the number of bytes.
 * On error, 0 is returned.
 */
size_t BsSerialLookupMsgMaxLen( BsSerialMsgId_T eMsgId )
{
  if( (uint_t)eMsgId >= (uint_t)BsSerialMsgIdNumOf )
  {
    return (size_t)0;
  }
  else
  {
    return BsSerialMsgMaxLenLookupTbl[(uint_t)eMsgId];
  }
}

/*!
 * \brief Pack a ITV message in big-endian byte order.
 * 
 * \param eMsgId          Message Id.
 * \param [in] pStruct    Pointer to the associated, populated message
 *                        structure.
 * \param [out] buf       Output message buffer.
 * \param bufSize         Size of output buffer.
 * \param bTrace          Do [not] trace packing.
 * 
 * \return
 * On success, returns the number of bytes packed.
 * On error, returns the appropriate < 0 negated NM_ECODE.
 */
int BsSerialPackMsg( BsSerialMsgId_T eMsgId,
                     void * pStruct,
                     byte_t buf[],
                     size_t bufSize,
                     bool_t bTrace )
{
  const  NMMsgDef_T  *pMsgDef;
  
  if( (pMsgDef = BsSerialLookupMsgDef(eMsgId)) == NULL )
  {
    LOGERROR("%s(ecode=%d): msgid=%u.", 
              nmStrError(NM_ECODE_MSGID), NM_ECODE_MSGID, eMsgId);
    return -NM_ECODE_MSGID;
  }
  
  if( bTrace )
  {
    return nmPackITVMsgDebug(pMsgDef, pStruct, buf, bufSize, NMEndianBig);
  }
  else
  {
    return nmPackITVMsg(pMsgDef, pStruct, buf, bufSize, NMEndianBig);
  }
}

/*!
 * \brief Unpack a ITV message in big-endian byte order.
 * 
 * \param eMsgId          Message Id.
 * \param [in] buf        Input message buffer.
 * \param uMsgLen         Length of message (bytes) in input buffer.
 * \param [out] pStruct   Pointer to the associated message structure.
 * \param bTrace          Do [not] trace packing.
 * 
 * \return
 * On success, returns the number of bytes unpacked.
 * On error, returns the appropriate < 0 negated NM_ECODE.
 */
int BsSerialUnpackMsg( BsSerialMsgId_T eMsgId,
                       byte_t buf[],
                       size_t uMsgLen,
                       void * pStruct,
                       bool_t bTrace )
{
  const  NMMsgDef_T  *pMsgDef;
  
  if( (pMsgDef = BsSerialLookupMsgDef(eMsgId)) == NULL )
  {
    LOGERROR("%s(ecode=%d): msgid=%u.", 
              nmStrError(NM_ECODE_MSGID), NM_ECODE_MSGID, eMsgId);
    return -NM_ECODE_MSGID;
  }
  
  if( bTrace )
  {
    return nmUnpackITVMsgDebug(pMsgDef, buf, uMsgLen, pStruct, NMEndianBig);
  }
  else
  {
    return nmUnpackITVMsg(pMsgDef, buf, uMsgLen, pStruct, NMEndianBig);
  }
}