BotSense bsProxy server - client raw I2C NetMsgs XML Definition. More...

#include "rnr/rnrconfig.h"
#include "rnr/netmsgs.h"
#include "rnr/i2c-dev.h"
#include "botsense/BotSense.h"

Classes
struct	BsI2CReqRead_T

struct	BsI2CReqTrans_T

struct	BsI2CRspRead_T

struct	BsI2CReqWrite_T

struct	BsI2CRspWrite_T

struct	BsI2CRspScan_T

Macros
#define	BSI2C_REQTRANS_WRITEBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

#define	BSI2C_RSPREAD_READBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

#define	BSI2C_REQWRITE_WRITEBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

#define	BSI2C_RSPSCAN_SCAN_LEN (NMFVAL_LEN_MAX_VECTOR)

Enumerations
enum	BsI2CMsgId_T { BsI2CMsgIdNone = 0, BsI2CMsgIdReqRead = 1, BsI2CMsgIdReqTrans = 2, BsI2CMsgIdRspRead = 3, BsI2CMsgIdReqWrite = 4, BsI2CMsgIdRspWrite = 5, BsI2CMsgIdReqScan = 6, BsI2CMsgIdRspScan = 7, BsI2CMsgIdNumOf = 8 }

Functions
const NMMsgDef_T *	BsI2CLookupMsgDef (BsI2CMsgId_T eMsgId)
	Look up the message definition associated with the message id. More...

size_t	BsI2CLookupMsgMaxLen (BsI2CMsgId_T eMsgId)
	Look up the message maximum length associated with the message id. More...

int	BsI2CPackMsg (BsI2CMsgId_T eMsgId, void *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a ITV message in big-endian byte order. More...

int	BsI2CUnpackMsg (BsI2CMsgId_T eMsgId, byte_t buf[], size_t uMsgLen, void *pStruct, bool_t bTrace)
	Unpack a ITV message in big-endian byte order. More...

INLINE_IN_H int	BsI2CPackReqRead (BsI2CReqRead_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsI2CReqRead ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsI2CUnpackReqRead (byte_t buf[], size_t uMsgLen, BsI2CReqRead_T *pStruct, bool_t bTrace)
	Unpack a BsI2CReqRead ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsI2CPackReqTrans (BsI2CReqTrans_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsI2CReqTrans ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsI2CUnpackReqTrans (byte_t buf[], size_t uMsgLen, BsI2CReqTrans_T *pStruct, bool_t bTrace)
	Unpack a BsI2CReqTrans ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsI2CPackRspRead (BsI2CRspRead_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsI2CRspRead ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsI2CUnpackRspRead (byte_t buf[], size_t uMsgLen, BsI2CRspRead_T *pStruct, bool_t bTrace)
	Unpack a BsI2CRspRead ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsI2CPackReqWrite (BsI2CReqWrite_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsI2CReqWrite ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsI2CUnpackReqWrite (byte_t buf[], size_t uMsgLen, BsI2CReqWrite_T *pStruct, bool_t bTrace)
	Unpack a BsI2CReqWrite ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsI2CPackRspWrite (BsI2CRspWrite_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsI2CRspWrite ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsI2CUnpackRspWrite (byte_t buf[], size_t uMsgLen, BsI2CRspWrite_T *pStruct, bool_t bTrace)
	Unpack a BsI2CRspWrite ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsI2CPackRspScan (BsI2CRspScan_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsI2CRspScan ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsI2CUnpackRspScan (byte_t buf[], size_t uMsgLen, BsI2CRspScan_T *pStruct, bool_t bTrace)
	Unpack a BsI2CRspScan ITV message in big-endian byte order from the input buffer. More...

Variables
const NMMsgDef_T *	BsI2CMsgDefLookupTbl []

size_t	BsI2CMsgMaxLenLookupTbl []

Detailed Description

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.

Copyright:: (C) 2018. RoadNarrows LLC (http://www.roadnarrows.com) All Rights Reserved

Definition in file bsI2CMsgs.h.

Macro Definition Documentation

#define BSI2C_REQTRANS_WRITEBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

ReqTrans writebuf maximum vector length

Definition at line 75 of file bsI2CMsgs.h.

Referenced by bsI2CReqTrans().

#define BSI2C_REQWRITE_WRITEBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

ReqWrite writebuf maximum vector length

Definition at line 127 of file bsI2CMsgs.h.

Referenced by bsI2CReqWrite().

#define BSI2C_RSPREAD_READBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

RspRead readbuf maximum vector length

Definition at line 102 of file bsI2CMsgs.h.

Referenced by bsI2CReqRead(), and bsI2CReqTrans().

#define BSI2C_RSPSCAN_SCAN_LEN (NMFVAL_LEN_MAX_VECTOR)

RspScan scan maximum vector length

Definition at line 166 of file bsI2CMsgs.h.

Referenced by bsModI2CScanCallback().

Enumeration Type Documentation

enum BsI2CMsgId_T

BsI2C Message Id Enumeration

Enumerator
BsI2CMsgIdNone	no message
BsI2CMsgIdReqRead	ReqRead.
BsI2CMsgIdReqTrans	ReqTrans.
BsI2CMsgIdRspRead	RspRead.
BsI2CMsgIdReqWrite	ReqWrite.
BsI2CMsgIdRspWrite	RspWrite.
BsI2CMsgIdReqScan	ReqScan.
BsI2CMsgIdRspScan	RspScan.
BsI2CMsgIdNumOf	number of message ids

Definition at line 37 of file bsI2CMsgs.h.

 {
   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;

Function Documentation

const NMMsgDef_T* BsI2CLookupMsgDef ( BsI2CMsgId_T eMsgId )

Look up the message definition associated with the message id.

Parameters

eMsgId Message Id.

Returns: On success, returns the pointer to the NMMsgDef_T. On error, NULL is returned.

Definition at line 509 of file bsI2CMsgs.c.

References BsI2CMsgDefLookupTbl, and BsI2CMsgIdNumOf.

Referenced by bsI2CGetMsgName(), BsI2CPackMsg(), and BsI2CUnpackMsg().

 {
   if( (uint_t)eMsgId >= (uint_t)BsI2CMsgIdNumOf )
   {
     return NULL;
   }
   else
   {
     return BsI2CMsgDefLookupTbl[(uint_t)eMsgId];
   }
 }

size_t BsI2CLookupMsgMaxLen ( BsI2CMsgId_T eMsgId )

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.

Parameters

eMsgId Message Id.

Returns: On success, returns the number of bytes. On error, 0 is returned.

Definition at line 533 of file bsI2CMsgs.c.

References BsI2CMsgIdNumOf, and BsI2CMsgMaxLenLookupTbl.

 {
   if( (uint_t)eMsgId >= (uint_t)BsI2CMsgIdNumOf )
   {
     return (size_t)0;
   }
   else
   {
     return BsI2CMsgMaxLenLookupTbl[(uint_t)eMsgId];
   }
 }

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

Pack a ITV message in big-endian byte order.

Parameters

	eMsgId	Message Id.
[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 559 of file bsI2CMsgs.c.

References BsI2CLookupMsgDef().

Referenced by BsI2CPackReqRead(), BsI2CPackReqTrans(), BsI2CPackReqWrite(), BsI2CPackRspRead(), BsI2CPackRspScan(), and BsI2CPackRspWrite().

 {
   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);
   }
 }

INLINE_IN_H int BsI2CPackReqRead	(	BsI2CReqRead_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsI2CReqRead ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 237 of file bsI2CMsgs.h.

References BsI2CMsgIdReqRead, and BsI2CPackMsg().

Referenced by bsI2CReqRead().

 {
   return BsI2CPackMsg(BsI2CMsgIdReqRead, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsI2CPackReqTrans	(	BsI2CReqTrans_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsI2CReqTrans ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 280 of file bsI2CMsgs.h.

References BsI2CMsgIdReqTrans, and BsI2CPackMsg().

Referenced by bsI2CReqTrans().

 {
   return BsI2CPackMsg(BsI2CMsgIdReqTrans, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsI2CPackReqWrite	(	BsI2CReqWrite_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsI2CReqWrite ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 366 of file bsI2CMsgs.h.

References BsI2CMsgIdReqWrite, and BsI2CPackMsg().

Referenced by bsI2CReqWrite().

 {
   return BsI2CPackMsg(BsI2CMsgIdReqWrite, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsI2CPackRspRead	(	BsI2CRspRead_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsI2CRspRead ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 323 of file bsI2CMsgs.h.

References BsI2CMsgIdRspRead, and BsI2CPackMsg().

Referenced by bsModI2CReqRead(), and bsModI2CReqTrans().

 {
   return BsI2CPackMsg(BsI2CMsgIdRspRead, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsI2CPackRspScan	(	BsI2CRspScan_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsI2CRspScan ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 452 of file bsI2CMsgs.h.

References BsI2CMsgIdRspScan, and BsI2CPackMsg().

Referenced by bsModI2CReqScan().

 {
   return BsI2CPackMsg(BsI2CMsgIdRspScan, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsI2CPackRspWrite	(	BsI2CRspWrite_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsI2CRspWrite ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 409 of file bsI2CMsgs.h.

References BsI2CMsgIdRspWrite, and BsI2CPackMsg().

Referenced by bsModI2CReqWrite().

 {
   return BsI2CPackMsg(BsI2CMsgIdRspWrite, pStruct, buf, bufSize, bTrace);
 }

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

Unpack a ITV message in big-endian byte order.

Parameters

	eMsgId	Message Id.
[in]	buf	Input message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 597 of file bsI2CMsgs.c.

References BsI2CLookupMsgDef().

Referenced by BsI2CUnpackReqRead(), BsI2CUnpackReqTrans(), BsI2CUnpackReqWrite(), BsI2CUnpackRspRead(), BsI2CUnpackRspScan(), and BsI2CUnpackRspWrite().

 {
   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);
   }
 }

INLINE_IN_H int BsI2CUnpackReqRead	(	byte_t	buf[],
		size_t	uMsgLen,
		BsI2CReqRead_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsI2CReqRead ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 258 of file bsI2CMsgs.h.

References BsI2CMsgIdReqRead, and BsI2CUnpackMsg().

Referenced by bsModI2CReqRead().

 {
   return BsI2CUnpackMsg(BsI2CMsgIdReqRead, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsI2CUnpackReqTrans	(	byte_t	buf[],
		size_t	uMsgLen,
		BsI2CReqTrans_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsI2CReqTrans ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 301 of file bsI2CMsgs.h.

References BsI2CMsgIdReqTrans, and BsI2CUnpackMsg().

Referenced by bsModI2CReqTrans().

 {
   return BsI2CUnpackMsg(BsI2CMsgIdReqTrans, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsI2CUnpackReqWrite	(	byte_t	buf[],
		size_t	uMsgLen,
		BsI2CReqWrite_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsI2CReqWrite ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 387 of file bsI2CMsgs.h.

References BsI2CMsgIdReqWrite, and BsI2CUnpackMsg().

Referenced by bsModI2CReqWrite().

 {
   return BsI2CUnpackMsg(BsI2CMsgIdReqWrite, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsI2CUnpackRspRead	(	byte_t	buf[],
		size_t	uMsgLen,
		BsI2CRspRead_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsI2CRspRead ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 344 of file bsI2CMsgs.h.

References BsI2CMsgIdRspRead, and BsI2CUnpackMsg().

Referenced by bsI2CReqRead(), and bsI2CReqTrans().

 {
   return BsI2CUnpackMsg(BsI2CMsgIdRspRead, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsI2CUnpackRspScan	(	byte_t	buf[],
		size_t	uMsgLen,
		BsI2CRspScan_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsI2CRspScan ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 473 of file bsI2CMsgs.h.

References BsI2CMsgIdRspScan, and BsI2CUnpackMsg().

Referenced by bsI2CReqScan().

 {
   return BsI2CUnpackMsg(BsI2CMsgIdRspScan, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsI2CUnpackRspWrite	(	byte_t	buf[],
		size_t	uMsgLen,
		BsI2CRspWrite_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsI2CRspWrite ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 430 of file bsI2CMsgs.h.

References BsI2CMsgIdRspWrite, and BsI2CUnpackMsg().

Referenced by bsI2CReqWrite().

 {
   return BsI2CUnpackMsg(BsI2CMsgIdRspWrite, buf, uMsgLen, pStruct, bTrace);
 }

Variable Documentation

const NMMsgDef_T* BsI2CMsgDefLookupTbl[]

BsI2C Message Definition Look-Up Table. Indexed by BsI2CMsgId_T enum.

Definition at line 466 of file bsI2CMsgs.c.

Referenced by BsI2CLookupMsgDef().

size_t BsI2CMsgMaxLenLookupTbl[]

BsI2C Message Maximum Size Look-Up Table. Indexed by BsI2CMsgId_T enum.

Definition at line 482 of file bsI2CMsgs.c.

Referenced by BsI2CLookupMsgMaxLen().

Classes

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation