bsI2CMsgs.h

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: bsI2CMsgs.h
//
/*!
 * \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
 */
///////////////////////////////////////////////////////////////////////////////


#ifndef _BSI2CMSGS_H
#define _BSI2CMSGS_H

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

#include "rnr/i2c-dev.h"

#include "botsense/BotSense.h"


C_DECLS_BEGIN

/*!
 * BsI2C Message Id Enumeration
 */
typedef enum
{
  BsI2CMsgIdNone                        = 0,    ///< no message
  BsI2CMsgIdReqRead                     = 1,    ///< ReqRead
  BsI2CMsgIdReqTrans                    = 2,    ///< ReqTrans
  BsI2CMsgIdRspRead                     = 3,    ///< RspRead
  BsI2CMsgIdReqWrite                    = 4,    ///< ReqWrite
  BsI2CMsgIdRspWrite                    = 5,    ///< RspWrite
  BsI2CMsgIdReqScan                     = 6,    ///< ReqScan
  BsI2CMsgIdRspScan                     = 7,    ///< RspScan
  BsI2CMsgIdNumOf                       = 8     ///< number of message ids
} BsI2CMsgId_T;


//-----------------------------------------------------------------------------
// Message Types
//-----------------------------------------------------------------------------


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsI2CReqRead Declarations
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * Message ReqRead Structure
 */
typedef struct
{
  ushort_t                m_addr;             ///< addr
  byte_t                  m_readlen;          ///< readlen
} BsI2CReqRead_T;                             ///< ReqRead structure


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsI2CReqTrans Declarations
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*! ReqTrans writebuf maximum vector length */
#define BSI2C_REQTRANS_WRITEBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

/*!
 * Message ReqTrans Structure
 */
typedef struct
{
  ushort_t                m_addr;             ///< addr
  struct
  {
    size_t                m_count;            ///< vector item count
    union
    {
      void                *m_pAlign;          ///< force alignment
      byte_t              m_buf[BSI2C_REQTRANS_WRITEBUF_LEN];
                                              ///< the item vector
    } u; ///< aligned vector items
  } m_writebuf;                               ///< vector
  byte_t                  m_readlen;          ///< readlen
} BsI2CReqTrans_T;                            ///< ReqTrans structure


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsI2CRspRead Declarations
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*! RspRead readbuf maximum vector length */
#define BSI2C_RSPREAD_READBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

/*!
 * Message RspRead Structure
 */
typedef struct
{
  struct
  {
    size_t                m_count;            ///< vector item count
    union
    {
      void                *m_pAlign;          ///< force alignment
      byte_t              m_buf[BSI2C_RSPREAD_READBUF_LEN];
                                              ///< the item vector
    } u; ///< aligned vector items
  } m_readbuf;                                ///< vector
} BsI2CRspRead_T;                             ///< RspRead structure


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsI2CReqWrite Declarations
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*! ReqWrite writebuf maximum vector length */
#define BSI2C_REQWRITE_WRITEBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

/*!
 * Message ReqWrite Structure
 */
typedef struct
{
  ushort_t                m_addr;             ///< addr
  struct
  {
    size_t                m_count;            ///< vector item count
    union
    {
      void                *m_pAlign;          ///< force alignment
      byte_t              m_buf[BSI2C_REQWRITE_WRITEBUF_LEN];
                                              ///< the item vector
    } u; ///< aligned vector items
  } m_writebuf;                               ///< vector
} BsI2CReqWrite_T;                            ///< ReqWrite structure


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsI2CRspWrite Declarations
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * Message RspWrite Structure
 */
typedef struct
{
  byte_t                  m_byteswritten;     ///< byteswritten
} BsI2CRspWrite_T;                            ///< RspWrite structure


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsI2CRspScan Declarations
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*! RspScan scan maximum vector length */
#define BSI2C_RSPSCAN_SCAN_LEN (NMFVAL_LEN_MAX_VECTOR)

/*!
 * Message RspScan Structure
 */
typedef struct
{
  struct
  {
    size_t                m_count;            ///< vector item count
    union
    {
      void                *m_pAlign;          ///< force alignment
      ushort_t            m_buf[BSI2C_RSPSCAN_SCAN_LEN];
                                              ///< the item vector
    } u; ///< aligned vector items
  } m_scan;                                   ///< vector
} BsI2CRspScan_T;                             ///< RspScan structure


//-----------------------------------------------------------------------------
// External Data
//-----------------------------------------------------------------------------

//
// BsI2C Message Definition Look-Up Table.
// (indexed by BsI2CMsgId_T enum)
// 
extern const NMMsgDef_T *BsI2CMsgDefLookupTbl[];

//
// BsI2C Maximum Message Body Length (bytes) Look-Up Table.
// (indexed by BsI2CMsgId_T enum)
// 
extern size_t BsI2CMsgMaxLenLookupTbl[];


//-----------------------------------------------------------------------------
// Function Prototypes
//-----------------------------------------------------------------------------

extern const NMMsgDef_T * BsI2CLookupMsgDef( BsI2CMsgId_T eMsgId );

extern size_t BsI2CLookupMsgMaxLen( BsI2CMsgId_T eMsgId );

extern int BsI2CPackMsg( BsI2CMsgId_T eMsgId,
                         void * pStruct,
                         byte_t buf[],
                         size_t bufSize,
                         bool_t bTrace );

extern int BsI2CUnpackMsg( BsI2CMsgId_T eMsgId,
                           byte_t buf[],
                           size_t uMsgLen,
                           void * pStruct,
                           bool_t bTrace );

/*!
 * \brief Pack a BsI2CReqRead ITV message in big-endian byte order
 *        into the output buffer.
 * 
 * \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 \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsI2CPackReqRead( BsI2CReqRead_T * pStruct,
                                  byte_t buf[],
                                  size_t bufSize,
                                  bool_t bTrace )
{
  return BsI2CPackMsg(BsI2CMsgIdReqRead, pStruct, buf, bufSize, bTrace);
}

/*!
 * \brief Unpack a BsI2CReqRead ITV message in big-endian byte order
 *        from the input buffer.
 * 
 * \param [in] buf        Output 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 \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsI2CUnpackReqRead( byte_t buf[],
                                    size_t uMsgLen,
                                    BsI2CReqRead_T * pStruct,
                                    bool_t bTrace )
{
  return BsI2CUnpackMsg(BsI2CMsgIdReqRead, buf, uMsgLen, pStruct, bTrace);
}

/*!
 * \brief Pack a BsI2CReqTrans ITV message in big-endian byte order
 *        into the output buffer.
 * 
 * \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 \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsI2CPackReqTrans( BsI2CReqTrans_T * pStruct,
                                   byte_t buf[],
                                   size_t bufSize,
                                   bool_t bTrace )
{
  return BsI2CPackMsg(BsI2CMsgIdReqTrans, pStruct, buf, bufSize, bTrace);
}

/*!
 * \brief Unpack a BsI2CReqTrans ITV message in big-endian byte order
 *        from the input buffer.
 * 
 * \param [in] buf        Output 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 \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsI2CUnpackReqTrans( byte_t buf[],
                                     size_t uMsgLen,
                                     BsI2CReqTrans_T * pStruct,
                                     bool_t bTrace )
{
  return BsI2CUnpackMsg(BsI2CMsgIdReqTrans, buf, uMsgLen, pStruct, bTrace);
}

/*!
 * \brief Pack a BsI2CRspRead ITV message in big-endian byte order
 *        into the output buffer.
 * 
 * \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 \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsI2CPackRspRead( BsI2CRspRead_T * pStruct,
                                  byte_t buf[],
                                  size_t bufSize,
                                  bool_t bTrace )
{
  return BsI2CPackMsg(BsI2CMsgIdRspRead, pStruct, buf, bufSize, bTrace);
}

/*!
 * \brief Unpack a BsI2CRspRead ITV message in big-endian byte order
 *        from the input buffer.
 * 
 * \param [in] buf        Output 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 \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsI2CUnpackRspRead( byte_t buf[],
                                    size_t uMsgLen,
                                    BsI2CRspRead_T * pStruct,
                                    bool_t bTrace )
{
  return BsI2CUnpackMsg(BsI2CMsgIdRspRead, buf, uMsgLen, pStruct, bTrace);
}

/*!
 * \brief Pack a BsI2CReqWrite ITV message in big-endian byte order
 *        into the output buffer.
 * 
 * \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 \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsI2CPackReqWrite( BsI2CReqWrite_T * pStruct,
                                   byte_t buf[],
                                   size_t bufSize,
                                   bool_t bTrace )
{
  return BsI2CPackMsg(BsI2CMsgIdReqWrite, pStruct, buf, bufSize, bTrace);
}

/*!
 * \brief Unpack a BsI2CReqWrite ITV message in big-endian byte order
 *        from the input buffer.
 * 
 * \param [in] buf        Output 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 \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsI2CUnpackReqWrite( byte_t buf[],
                                     size_t uMsgLen,
                                     BsI2CReqWrite_T * pStruct,
                                     bool_t bTrace )
{
  return BsI2CUnpackMsg(BsI2CMsgIdReqWrite, buf, uMsgLen, pStruct, bTrace);
}

/*!
 * \brief Pack a BsI2CRspWrite ITV message in big-endian byte order
 *        into the output buffer.
 * 
 * \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 \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsI2CPackRspWrite( BsI2CRspWrite_T * pStruct,
                                   byte_t buf[],
                                   size_t bufSize,
                                   bool_t bTrace )
{
  return BsI2CPackMsg(BsI2CMsgIdRspWrite, pStruct, buf, bufSize, bTrace);
}

/*!
 * \brief Unpack a BsI2CRspWrite ITV message in big-endian byte order
 *        from the input buffer.
 * 
 * \param [in] buf        Output 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 \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsI2CUnpackRspWrite( byte_t buf[],
                                     size_t uMsgLen,
                                     BsI2CRspWrite_T * pStruct,
                                     bool_t bTrace )
{
  return BsI2CUnpackMsg(BsI2CMsgIdRspWrite, buf, uMsgLen, pStruct, bTrace);
}

/*!
 * \brief Pack a BsI2CRspScan ITV message in big-endian byte order
 *        into the output buffer.
 * 
 * \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 \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsI2CPackRspScan( BsI2CRspScan_T * pStruct,
                                  byte_t buf[],
                                  size_t bufSize,
                                  bool_t bTrace )
{
  return BsI2CPackMsg(BsI2CMsgIdRspScan, pStruct, buf, bufSize, bTrace);
}

/*!
 * \brief Unpack a BsI2CRspScan ITV message in big-endian byte order
 *        from the input buffer.
 * 
 * \param [in] buf        Output 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 \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsI2CUnpackRspScan( byte_t buf[],
                                    size_t uMsgLen,
                                    BsI2CRspScan_T * pStruct,
                                    bool_t bTrace )
{
  return BsI2CUnpackMsg(BsI2CMsgIdRspScan, buf, uMsgLen, pStruct, bTrace);
}


C_DECLS_END


#endif // _BSI2CMSGS_H