bsI2CMsgs.c

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: bsI2CMsgs.c
//
/*!
 * \file
 *
 * \brief BotSense bsProxy server - client raw I2C NetMsgs XML Definition
 *
 * \warning This file was auto-generated on 2018.08.10 13:54:23 from the NetMsgs
 * XML specification bsI2CMsgs.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/bsI2CMsgs.h"

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


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


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsI2CReqRead Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsI2CReqRead Field Id Enumeration
 */
typedef enum
{
  BsI2CReqReadFIdReserved               = 0,    ///< reserved field id
  BsI2CReqReadFIdaddr                   = 1,    ///< addr field id
  BsI2CReqReadFIdreadlen                = 2,    ///< readlen field id
  BsI2CReqReadFIdNumOf                  = 3     ///< number of fields
} BsI2CReqReadFId_T;

/*!
 * BsI2CReqRead Field Definitions
 */
static const NMFieldDef_T BsI2CReqReadFieldDefs[] =
{
  {
    .m_sFName                 = "addr",
    .m_eFId                   = BsI2CReqReadFIdaddr,
    .m_eFType                 = NMFTypeU16,
    .m_uOffset                = memberoffset(BsI2CReqRead_T, m_addr),
    .m_this.m_u16.m_bits      = (byte_t)(0),
    .m_this.m_u16.m_valMin    = (ushort_t)(0),
    .m_this.m_u16.m_valMax    = (ushort_t)(0),
    .m_this.m_u16.m_valConst  = (ushort_t)(0),
  },
  {
    .m_sFName                 = "readlen",
    .m_eFId                   = BsI2CReqReadFIdreadlen,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsI2CReqRead_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
};

/*!
 * BsI2CReqRead Message Definition
 */
static const NMMsgDef_T BsI2CReqReadMsgDef =
{
  .m_sMsgName         = "BsI2CReqRead",
  .m_eMsgId           = BsI2CMsgIdReqRead,
  .m_uCount           = (size_t)(2),
  .m_pFields          = BsI2CReqReadFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsI2CReqTrans Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsI2CReqTranswritebuf Field Definitions
 */
static const NMFieldDef_T BsI2CReqTranswritebufFieldDef[] =
{
  {
    .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
};

/*!
 * BsI2CReqTrans Field Id Enumeration
 */
typedef enum
{
  BsI2CReqTransFIdReserved              = 0,    ///< reserved field id
  BsI2CReqTransFIdaddr                  = 1,    ///< addr field id
  BsI2CReqTransFIdwritebuf              = 2,    ///< writebuf field id
  BsI2CReqTransFIdreadlen               = 3,    ///< readlen field id
  BsI2CReqTransFIdNumOf                 = 4     ///< number of fields
} BsI2CReqTransFId_T;

/*!
 * BsI2CReqTrans Field Definitions
 */
static const NMFieldDef_T BsI2CReqTransFieldDefs[] =
{
  {
    .m_sFName                 = "addr",
    .m_eFId                   = BsI2CReqTransFIdaddr,
    .m_eFType                 = NMFTypeU16,
    .m_uOffset                = memberoffset(BsI2CReqTrans_T, m_addr),
    .m_this.m_u16.m_bits      = (byte_t)(0),
    .m_this.m_u16.m_valMin    = (ushort_t)(0),
    .m_this.m_u16.m_valMax    = (ushort_t)(0),
    .m_this.m_u16.m_valConst  = (ushort_t)(0),
  },
  {
    .m_sFName                 = "writebuf",
    .m_eFId                   = BsI2CReqTransFIdwritebuf,
    .m_eFType                 = NMFTypeVector,
    .m_uOffset                = memberoffset(BsI2CReqTrans_T, m_writebuf),
    .m_this.m_vector.m_uMaxCount
                              = (size_t)BSI2C_REQTRANS_WRITEBUF_LEN,
    .m_this.m_vector.m_uElemSize
                              = sizeof(byte_t),
    .m_this.m_vector.m_pThisElem
                              = BsI2CReqTranswritebufFieldDef,
  },
  {
    .m_sFName                 = "readlen",
    .m_eFId                   = BsI2CReqTransFIdreadlen,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsI2CReqTrans_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
};

/*!
 * BsI2CReqTrans Message Definition
 */
static const NMMsgDef_T BsI2CReqTransMsgDef =
{
  .m_sMsgName         = "BsI2CReqTrans",
  .m_eMsgId           = BsI2CMsgIdReqTrans,
  .m_uCount           = (size_t)(3),
  .m_pFields          = BsI2CReqTransFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsI2CRspRead Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsI2CRspReadreadbuf Field Definitions
 */
static const NMFieldDef_T BsI2CRspReadreadbufFieldDef[] =
{
  {
    .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
};

/*!
 * BsI2CRspRead Field Id Enumeration
 */
typedef enum
{
  BsI2CRspReadFIdReserved               = 0,    ///< reserved field id
  BsI2CRspReadFIdreadbuf                = 1,    ///< readbuf field id
  BsI2CRspReadFIdNumOf                  = 2     ///< number of fields
} BsI2CRspReadFId_T;

/*!
 * BsI2CRspRead Field Definitions
 */
static const NMFieldDef_T BsI2CRspReadFieldDefs[] =
{
  {
    .m_sFName                 = "readbuf",
    .m_eFId                   = BsI2CRspReadFIdreadbuf,
    .m_eFType                 = NMFTypeVector,
    .m_uOffset                = memberoffset(BsI2CRspRead_T, m_readbuf),
    .m_this.m_vector.m_uMaxCount
                              = (size_t)BSI2C_RSPREAD_READBUF_LEN,
    .m_this.m_vector.m_uElemSize
                              = sizeof(byte_t),
    .m_this.m_vector.m_pThisElem
                              = BsI2CRspReadreadbufFieldDef,
  },
  EOFDEF
};

/*!
 * BsI2CRspRead Message Definition
 */
static const NMMsgDef_T BsI2CRspReadMsgDef =
{
  .m_sMsgName         = "BsI2CRspRead",
  .m_eMsgId           = BsI2CMsgIdRspRead,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsI2CRspReadFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsI2CReqWrite Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsI2CReqWritewritebuf Field Definitions
 */
static const NMFieldDef_T BsI2CReqWritewritebufFieldDef[] =
{
  {
    .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
};

/*!
 * BsI2CReqWrite Field Id Enumeration
 */
typedef enum
{
  BsI2CReqWriteFIdReserved              = 0,    ///< reserved field id
  BsI2CReqWriteFIdaddr                  = 1,    ///< addr field id
  BsI2CReqWriteFIdwritebuf              = 2,    ///< writebuf field id
  BsI2CReqWriteFIdNumOf                 = 3     ///< number of fields
} BsI2CReqWriteFId_T;

/*!
 * BsI2CReqWrite Field Definitions
 */
static const NMFieldDef_T BsI2CReqWriteFieldDefs[] =
{
  {
    .m_sFName                 = "addr",
    .m_eFId                   = BsI2CReqWriteFIdaddr,
    .m_eFType                 = NMFTypeU16,
    .m_uOffset                = memberoffset(BsI2CReqWrite_T, m_addr),
    .m_this.m_u16.m_bits      = (byte_t)(0),
    .m_this.m_u16.m_valMin    = (ushort_t)(0),
    .m_this.m_u16.m_valMax    = (ushort_t)(0),
    .m_this.m_u16.m_valConst  = (ushort_t)(0),
  },
  {
    .m_sFName                 = "writebuf",
    .m_eFId                   = BsI2CReqWriteFIdwritebuf,
    .m_eFType                 = NMFTypeVector,
    .m_uOffset                = memberoffset(BsI2CReqWrite_T, m_writebuf),
    .m_this.m_vector.m_uMaxCount
                              = (size_t)BSI2C_REQWRITE_WRITEBUF_LEN,
    .m_this.m_vector.m_uElemSize
                              = sizeof(byte_t),
    .m_this.m_vector.m_pThisElem
                              = BsI2CReqWritewritebufFieldDef,
  },
  EOFDEF
};

/*!
 * BsI2CReqWrite Message Definition
 */
static const NMMsgDef_T BsI2CReqWriteMsgDef =
{
  .m_sMsgName         = "BsI2CReqWrite",
  .m_eMsgId           = BsI2CMsgIdReqWrite,
  .m_uCount           = (size_t)(2),
  .m_pFields          = BsI2CReqWriteFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsI2CRspWrite Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsI2CRspWrite Field Id Enumeration
 */
typedef enum
{
  BsI2CRspWriteFIdReserved              = 0,    ///< reserved field id
  BsI2CRspWriteFIdbyteswritten          = 1,    ///< byteswritten field id
  BsI2CRspWriteFIdNumOf                 = 2     ///< number of fields
} BsI2CRspWriteFId_T;

/*!
 * BsI2CRspWrite Field Definitions
 */
static const NMFieldDef_T BsI2CRspWriteFieldDefs[] =
{
  {
    .m_sFName                 = "byteswritten",
    .m_eFId                   = BsI2CRspWriteFIdbyteswritten,
    .m_eFType                 = NMFTypeU8,
    .m_uOffset                = memberoffset(BsI2CRspWrite_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
};

/*!
 * BsI2CRspWrite Message Definition
 */
static const NMMsgDef_T BsI2CRspWriteMsgDef =
{
  .m_sMsgName         = "BsI2CRspWrite",
  .m_eMsgId           = BsI2CMsgIdRspWrite,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsI2CRspWriteFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsI2CReqScan Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsI2CReqScan Field Id Enumeration
 */
typedef enum
{
  BsI2CReqScanFIdReserved               = 0,    ///< reserved field id
  BsI2CReqScanFIdNumOf                  = 1     ///< number of fields
} BsI2CReqScanFId_T;

/*!
 * BsI2CReqScan Field Definitions
 */
static const NMFieldDef_T BsI2CReqScanFieldDefs[] =
{
  EOFDEF
};

/*!
 * BsI2CReqScan Message Definition
 */
static const NMMsgDef_T BsI2CReqScanMsgDef =
{
  .m_sMsgName         = "BsI2CReqScan",
  .m_eMsgId           = BsI2CMsgIdReqScan,
  .m_uCount           = (size_t)(0),
  .m_pFields          = BsI2CReqScanFieldDefs
};


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsI2CRspScan Definition
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * BsI2CRspScanscan Field Definitions
 */
static const NMFieldDef_T BsI2CRspScanscanFieldDef[] =
{
  {
    .m_sFName                 = "scan",
    .m_eFId                   = 0,
    .m_eFType                 = NMFTypeU16,
    .m_uOffset                = (size_t)0,
    .m_this.m_u16.m_bits      = (byte_t)(0),
    .m_this.m_u16.m_valMin    = (ushort_t)(0),
    .m_this.m_u16.m_valMax    = (ushort_t)(0),
    .m_this.m_u16.m_valConst  = (ushort_t)(0),
  },
  EOFDEF
};

/*!
 * BsI2CRspScan Field Id Enumeration
 */
typedef enum
{
  BsI2CRspScanFIdReserved               = 0,    ///< reserved field id
  BsI2CRspScanFIdscan                   = 1,    ///< scan field id
  BsI2CRspScanFIdNumOf                  = 2     ///< number of fields
} BsI2CRspScanFId_T;

/*!
 * BsI2CRspScan Field Definitions
 */
static const NMFieldDef_T BsI2CRspScanFieldDefs[] =
{
  {
    .m_sFName                 = "scan",
    .m_eFId                   = BsI2CRspScanFIdscan,
    .m_eFType                 = NMFTypeVector,
    .m_uOffset                = memberoffset(BsI2CRspScan_T, m_scan),
    .m_this.m_vector.m_uMaxCount
                              = (size_t)BSI2C_RSPSCAN_SCAN_LEN,
    .m_this.m_vector.m_uElemSize
                              = sizeof(ushort_t),
    .m_this.m_vector.m_pThisElem
                              = BsI2CRspScanscanFieldDef,
  },
  EOFDEF
};

/*!
 * BsI2CRspScan Message Definition
 */
static const NMMsgDef_T BsI2CRspScanMsgDef =
{
  .m_sMsgName         = "BsI2CRspScan",
  .m_eMsgId           = BsI2CMsgIdRspScan,
  .m_uCount           = (size_t)(1),
  .m_pFields          = BsI2CRspScanFieldDefs
};


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

/*!
 * BsI2C Message Definition Look-Up Table. Indexed by BsI2CMsgId_T enum.
 */
const NMMsgDef_T *BsI2CMsgDefLookupTbl[] =
{
  NULL,                                 ///< [BsI2CMsgIdNone]
  &BsI2CReqReadMsgDef,                  ///< [BsI2CMsgIdReqRead]
  &BsI2CReqTransMsgDef,                 ///< [BsI2CMsgIdReqTrans]
  &BsI2CRspReadMsgDef,                  ///< [BsI2CMsgIdRspRead]
  &BsI2CReqWriteMsgDef,                 ///< [BsI2CMsgIdReqWrite]
  &BsI2CRspWriteMsgDef,                 ///< [BsI2CMsgIdRspWrite]
  &BsI2CReqScanMsgDef,                  ///< [BsI2CMsgIdReqScan]
  &BsI2CRspScanMsgDef,                  ///< [BsI2CMsgIdRspScan]
  NULL                                  ///< [BsI2CMsgIdNumOf]
};

/*!
 * BsI2C Message Maximum Size Look-Up Table. Indexed by BsI2CMsgId_T enum.
 */
size_t BsI2CMsgMaxLenLookupTbl[] =
{
  (size_t)(0),                          ///< [BsI2CMsgIdNone]
  (size_t)(10),                         ///< [BsI2CMsgIdReqRead]
  (size_t)(269),                        ///< [BsI2CMsgIdReqTrans]
  (size_t)(262),                        ///< [BsI2CMsgIdRspRead]
  (size_t)(266),                        ///< [BsI2CMsgIdReqWrite]
  (size_t)(6),                          ///< [BsI2CMsgIdRspWrite]
  (size_t)(3),                          ///< [BsI2CMsgIdReqScan]
  (size_t)(517),                        ///< [BsI2CMsgIdRspScan]
  (size_t)(0)                           ///< [BsI2CMsgIdNumOf]
};


//-----------------------------------------------------------------------------
// 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 * BsI2CLookupMsgDef( BsI2CMsgId_T eMsgId )
{
  if( (uint_t)eMsgId >= (uint_t)BsI2CMsgIdNumOf )
  {
    return NULL;
  }
  else
  {
    return BsI2CMsgDefLookupTbl[(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 BsI2CLookupMsgMaxLen( BsI2CMsgId_T eMsgId )
{
  if( (uint_t)eMsgId >= (uint_t)BsI2CMsgIdNumOf )
  {
    return (size_t)0;
  }
  else
  {
    return BsI2CMsgMaxLenLookupTbl[(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 BsI2CPackMsg( BsI2CMsgId_T eMsgId,
                  void * pStruct,
                  byte_t buf[],
                  size_t bufSize,
                  bool_t bTrace )
{
  const  NMMsgDef_T  *pMsgDef;
  
  if( (pMsgDef = BsI2CLookupMsgDef(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 BsI2CUnpackMsg( BsI2CMsgId_T eMsgId,
                    byte_t buf[],
                    size_t uMsgLen,
                    void * pStruct,
                    bool_t bTrace )
{
  const  NMMsgDef_T  *pMsgDef;
  
  if( (pMsgDef = BsI2CLookupMsgDef(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);
  }
}