bsI2CClient.c File Reference

BotSense bsProxy client proxied I²C bus device library. More...

#include <stdio.h>
#include <stdlib.h>
#include <libgen.h>
#include <string.h>
#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/netmsgs.h"
#include "rnr/i2c.h"
#include "botsense/BotSense.h"
#include "botsense/libBotSense.h"
#include "botsense/bsI2C.h"
#include "botsense/bsI2CMsgs.h"

Go to the source code of this file.

Functions
const char *	bsI2CGetMsgName (BsClient_P pClient, BsVConnHnd_T hndVConn, uint_t uMsgId)
	Get the I2C message name. More...
int	bsI2CReqOpen (BsClient_P pClient, const char *sDevName, bool_t bInitTrace)
	Request proxy server to establish a virtual connection to an I2C bus device. More...
int	bsI2CReqClose (BsClient_P pClient, BsVConnHnd_T hndVConn)
	Request proxy server to close client's proxied I2C device vitual connection. More...
int	bsI2CReqRead (BsClient_P pClient, BsVConnHnd_T hndVConn, i2c_addr_t i2cAddr, size_t uReadLen, byte_t rbuf[])
	Proxied request to read from a device attached to the I2C bus. More...
int	bsI2CReqWrite (BsClient_P pClient, BsVConnHnd_T hndVConn, i2c_addr_t i2cAddr, byte_t wbuf[], size_t uWriteLen)
	Proxied request to write to a device attached to the I2C bus. More...
int	bsI2CReqTrans (BsClient_P pClient, BsVConnHnd_T hndVConn, i2c_addr_t i2cAddr, byte_t wbuf[], size_t uWriteLen, size_t uReadLen, byte_t rbuf[])
	Proxied request to execute a write-read transaction to a device attached to the I2C bus. More...
int	bsI2CReqScan (BsClient_P pClient, BsVConnHnd_T hndVConn, i2c_addr_t bufScan[], size_t sizeScanBuf)
	Proxied request to scan the I2C bus for all attached devices. More...

Variables
static BsClientAppInfo_T	bsI2CAppInfo
	BotSense client application information. More...

Detailed Description

BotSense bsProxy client proxied I²C bus device library.

LastChangedDate

2010-08-20 11:36:38 -0600 (Fri, 20 Aug 2010)

Rev

568

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2009-2017. RoadNarrows LLC.
http://www.roadnarrows.com
All Rights Reserved

Definition in file bsI2CClient.c.

Function Documentation

const char* bsI2CGetMsgName	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn,
		uint_t	uMsgId
	)

Get the I²C message name.

For each (virtual connection, message id) 2-tuple, there can be a known name string (provided the id is valid and an application provides the information).

Parameters

pClient

Definition at line 101 of file bsI2CClient.c.

References BsI2CLookupMsgDef().

{
  const NMMsgDef_T  *pMsgDef;

  pMsgDef = BsI2CLookupMsgDef((BsI2CMsgId_T)uMsgId);

  return pMsgDef!=NULL? pMsgDef->m_sMsgName: "unknown";
}

int bsI2CReqClose	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn
	)

Request proxy server to close client's proxied I²C device vitual connection.

Parameters

pClient

Definition at line 153 of file bsI2CClient.c.

{
  return bsServerReqCloseDev(pClient, hndVConn);
}

int bsI2CReqOpen	(	BsClient_P	pClient,
		const char *	sDevName,
		bool_t	bInitTrace
	)

Request proxy server to establish a virtual connection to an I²C bus device.

Parameters

pClient

Definition at line 124 of file bsI2CClient.c.

References BS_I2C_SERVER_MOD, and BSCLIENT_TRY_ECODE.

{
  int     hnd;                      // vconn handle / return code

  //
  // Execute server transaction (returns handle \h_ge 0 on success).
  //
  hnd = bsServerReqOpenDev(pClient, sDevName, BS_I2C_SERVER_MOD,
                            NULL, (size_t)0, &bsI2CAppInfo, bInitTrace);

  // check transaction return code
  BSCLIENT_TRY_ECODE(pClient, hnd, "bsServerReqOpenDev(dev='%s') failed.",
      sDevName);

  // return handle
  return hnd;
}

int bsI2CReqRead	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn,
		i2c_addr_t	i2cAddr,
		size_t	uReadLen,
		byte_t	rbuf[]
	)

Proxied request to read from a device attached to the I²C bus.

Parameters

pClient

Definition at line 171 of file bsI2CClient.c.

References BS_ECODE_BAD_VAL, BSCLIENT_HAS_VCONN, BSCLIENT_TRY_ECODE, BSCLIENT_TRY_EXPR, BSCLIENT_TRY_NM_ECODE, BSI2C_RSPREAD_READBUF_LEN, BsI2CMsgIdReqRead, BsI2CMsgIdRspRead, BsI2CPackReqRead(), BsI2CUnpackRspRead(), BSPROXY_BUF_BODY, BSPROXY_MSG_MAX_LEN, BsI2CReqRead_T::m_addr, BsI2CRspRead_T::m_count, BsI2CRspRead_T::m_readbuf, BsI2CReqRead_T::m_readlen, and BsI2CRspRead_T::u.

{
  static BsI2CMsgId_T msgIdReq = BsI2CMsgIdReqRead;
  static BsI2CMsgId_T msgIdRsp = BsI2CMsgIdRspRead;

  BsI2CReqRead_T    msgReq;                   // request message 
  BsI2CRspRead_T    msgRsp;                   // response message 
  byte_t            buf[BSPROXY_MSG_MAX_LEN]; // req/rsp buffer
  bool_t            bTrace;                   // do [not] trace messages
  int               n;                        // number of bytes/return code

  //
  // Parameter checks.
  //
  BSCLIENT_TRY_EXPR(pClient, BSCLIENT_HAS_VCONN(pClient, hndVConn),
      BS_ECODE_BAD_VAL, "VConn=%d", hndVConn);

  BSCLIENT_TRY_EXPR(pClient, (uReadLen <= (size_t)BSI2C_RSPREAD_READBUF_LEN),
      BS_ECODE_BAD_VAL, "read_len=%zu > max_len=%zu",
      uReadLen, (size_t)BSI2C_RSPREAD_READBUF_LEN);

  // trace state
  bTrace = bsClientAttrGetTraceState(pClient, hndVConn);

  //
  // Set request message values.
  //
  msgReq.m_addr     = (ushort_t)i2cAddr;
  msgReq.m_readlen  = (byte_t)uReadLen;

  //
  // Pack request.
  //
  n = BsI2CPackReqRead(&msgReq, BSPROXY_BUF_BODY(buf), bTrace);

  // check packing return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdReq);

  //
  // Execute request-response transaction.
  //
  n = bsClientTrans(pClient,  hndVConn,
                    msgIdReq, buf, (size_t)n,
                    msgIdRsp, buf, sizeof(buf));

  // check transaction return code
  BSCLIENT_TRY_ECODE(pClient, n, "MsgId=%u: Transaction failed.", msgIdReq);

  //
  // Unpack response.
  //
  n = BsI2CUnpackRspRead(buf, (size_t)n, &msgRsp, bTrace);

  // check unpack return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdRsp);

  //
  // Set return values from response.
  //
  if( uReadLen > msgRsp.m_readbuf.m_count )
  {
    uReadLen = msgRsp.m_readbuf.m_count;
  }
  memcpy(rbuf, msgRsp.m_readbuf.u.m_buf, uReadLen);

  return (int)uReadLen;
}

int bsI2CReqScan	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn,
		i2c_addr_t	bufScan[],
		size_t	sizeScanBuf
	)

Proxied request to scan the I²C bus for all attached devices.

Parameters

pClient

Definition at line 433 of file bsI2CClient.c.

References BS_ECODE_BAD_VAL, BSCLIENT_HAS_VCONN, BSCLIENT_TRY_ECODE, BSCLIENT_TRY_EXPR, BSCLIENT_TRY_NM_ECODE, BsI2CMsgIdReqScan, BsI2CMsgIdRspScan, BsI2CUnpackRspScan(), BSPROXY_MSG_MAX_LEN, BsI2CRspScan_T::m_count, BsI2CRspScan_T::m_scan, and BsI2CRspScan_T::u.

{
  static BsI2CMsgId_T msgIdReq = BsI2CMsgIdReqScan;
  static BsI2CMsgId_T msgIdRsp = BsI2CMsgIdRspScan;

  BsI2CRspScan_T    msgRsp;                   // response message 
  byte_t            buf[BSPROXY_MSG_MAX_LEN]; // req/rsp buffer
  bool_t            bTrace;                   // do [not] trace messages
  int               i;                        // working index
  int               n;                        // number of bytes/return code

  //
  // Parameter checks.
  //
  BSCLIENT_TRY_EXPR(pClient, BSCLIENT_HAS_VCONN(pClient, hndVConn),
      BS_ECODE_BAD_VAL, "VConn=%d", hndVConn);

  // trace state
  bTrace = bsClientAttrGetTraceState(pClient, hndVConn);

  //
  // Execute request-response transaction.
  //
  n = bsClientTrans(pClient,  hndVConn,
                    msgIdReq, NULL, (size_t)0,
                    msgIdRsp, buf, sizeof(buf));

  // check transaction return code
  BSCLIENT_TRY_ECODE(pClient, n, "MsgId=%u: Transaction failed.", msgIdReq);

  //
  // Unpack response.
  //
  n = BsI2CUnpackRspScan(buf, (size_t)n, &msgRsp, bTrace);

  // check unpack return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdRsp);

  //
  // Set return values from response.
  //
  n = sizeScanBuf < (size_t)msgRsp.m_scan.m_count?
                        (int)sizeScanBuf: (int)msgRsp.m_scan.m_count;

  for(i=0; i<n; ++i)
  {
    bufScan[i] = (i2c_addr_t)msgRsp.m_scan.u.m_buf[i];
  }

  return n;
}

int bsI2CReqTrans	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn,
		i2c_addr_t	i2cAddr,
		byte_t	wbuf[],
		size_t	uWriteLen,
		size_t	uReadLen,
		byte_t	rbuf[]
	)

Proxied request to execute a write-read transaction to a device attached to the I²C bus.

Parameters

pClient

Definition at line 340 of file bsI2CClient.c.

References BS_ECODE_BAD_VAL, BSCLIENT_HAS_VCONN, BSCLIENT_TRY_ECODE, BSCLIENT_TRY_EXPR, BSCLIENT_TRY_NM_ECODE, BSI2C_REQTRANS_WRITEBUF_LEN, BSI2C_RSPREAD_READBUF_LEN, BsI2CMsgIdReqTrans, BsI2CMsgIdRspRead, BsI2CPackReqTrans(), BsI2CUnpackRspRead(), BSPROXY_BUF_BODY, BSPROXY_MSG_MAX_LEN, BsI2CReqTrans_T::m_addr, BsI2CReqTrans_T::m_count, BsI2CRspRead_T::m_count, BsI2CRspRead_T::m_readbuf, BsI2CReqTrans_T::m_readlen, BsI2CReqTrans_T::m_writebuf, BsI2CReqTrans_T::u, and BsI2CRspRead_T::u.

{
  static BsI2CMsgId_T msgIdReq = BsI2CMsgIdReqTrans;
  static BsI2CMsgId_T msgIdRsp = BsI2CMsgIdRspRead;

  BsI2CReqTrans_T   msgReq;                   // request message 
  BsI2CRspRead_T    msgRsp;                   // response message 
  byte_t            buf[BSPROXY_MSG_MAX_LEN]; // req/rsp buffer
  bool_t            bTrace;                   // do [not] trace messages
  int               n;                        // number of bytes/return code

  //
  // Parameter checks.
  //
  BSCLIENT_TRY_EXPR(pClient, BSCLIENT_HAS_VCONN(pClient, hndVConn),
      BS_ECODE_BAD_VAL, "VConn=%d", hndVConn);

  BSCLIENT_TRY_EXPR(pClient,
      (uWriteLen <= (size_t)BSI2C_REQTRANS_WRITEBUF_LEN), BS_ECODE_BAD_VAL,
      "write_len=%zu > max_len=%zu",
      uWriteLen, (size_t)BSI2C_REQTRANS_WRITEBUF_LEN);

  BSCLIENT_TRY_EXPR(pClient, (uReadLen <= (size_t)BSI2C_RSPREAD_READBUF_LEN),
      BS_ECODE_BAD_VAL, "read_len=%zu > max_len=%zu",
      uReadLen, (size_t)BSI2C_RSPREAD_READBUF_LEN);

  // trace state
  bTrace = bsClientAttrGetTraceState(pClient, hndVConn);

  //
  // Set request message values.
  //
  msgReq.m_addr = (ushort_t)i2cAddr;
  memcpy(msgReq.m_writebuf.u.m_buf, wbuf, uWriteLen);
  msgReq.m_writebuf.m_count = uWriteLen;
  msgReq.m_readlen = (byte_t)uReadLen;

  //
  // Pack request.
  //
  n = BsI2CPackReqTrans(&msgReq, BSPROXY_BUF_BODY(buf), bTrace);

  // check packing return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdReq);

  //
  // Execute request-response server transaction.
  //
  n = bsClientTrans(pClient,  hndVConn,
                    msgIdReq, buf, (size_t)n,
                    msgIdRsp, buf, sizeof(buf));

  // check transaction return code
  BSCLIENT_TRY_ECODE(pClient, n, "MsgId=%u: Transaction failed.", msgIdReq);

  //
  // Unpack response.
  //
  n = BsI2CUnpackRspRead(buf, (size_t)n, &msgRsp, bTrace);

  // check unpack return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdRsp);

  //
  // Set return values from response.
  //
  if( uReadLen > msgRsp.m_readbuf.m_count )
  {
    uReadLen = msgRsp.m_readbuf.m_count;
  }
  memcpy(rbuf, msgRsp.m_readbuf.u.m_buf, uReadLen);

  return (int)uReadLen;
}

int bsI2CReqWrite	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn,
		i2c_addr_t	i2cAddr,
		byte_t	wbuf[],
		size_t	uWriteLen
	)

Proxied request to write to a device attached to the I²C bus.

Parameters

pClient

Definition at line 256 of file bsI2CClient.c.

References BS_ECODE_BAD_VAL, BSCLIENT_HAS_VCONN, BSCLIENT_TRY_ECODE, BSCLIENT_TRY_EXPR, BSCLIENT_TRY_NM_ECODE, BSI2C_REQWRITE_WRITEBUF_LEN, BsI2CMsgIdReqWrite, BsI2CMsgIdRspWrite, BsI2CPackReqWrite(), BsI2CUnpackRspWrite(), BSPROXY_BUF_BODY, BSPROXY_MSG_MAX_LEN, BsI2CReqWrite_T::m_addr, BsI2CRspWrite_T::m_byteswritten, BsI2CReqWrite_T::m_count, BsI2CReqWrite_T::m_writebuf, and BsI2CReqWrite_T::u.

{
  static BsI2CMsgId_T msgIdReq = BsI2CMsgIdReqWrite;
  static BsI2CMsgId_T msgIdRsp = BsI2CMsgIdRspWrite;

  BsI2CReqWrite_T   msgReq;                   // request message 
  BsI2CRspWrite_T   msgRsp;                   // response message 
  byte_t            buf[BSPROXY_MSG_MAX_LEN]; // req/rsp buffer
  bool_t            bTrace;                   // do [not] trace messages
  int               n;                        // number of bytes/return code

  //
  // Parameter checks.
  //
  BSCLIENT_TRY_EXPR(pClient, BSCLIENT_HAS_VCONN(pClient, hndVConn),
      BS_ECODE_BAD_VAL, "VConn=%d", hndVConn);

  BSCLIENT_TRY_EXPR(pClient,
      (uWriteLen <= (size_t)BSI2C_REQWRITE_WRITEBUF_LEN), BS_ECODE_BAD_VAL,
      "write_len=%zu > max_len=%zu",
      uWriteLen, (size_t)BSI2C_REQWRITE_WRITEBUF_LEN);

  // trace state
  bTrace = bsClientAttrGetTraceState(pClient, hndVConn);

  //
  // Set request message values.
  //
  msgReq.m_addr = (ushort_t)i2cAddr;
  memcpy(msgReq.m_writebuf.u.m_buf, wbuf, uWriteLen);
  msgReq.m_writebuf.m_count = uWriteLen;

  //
  // Pack request.
  //
  n = BsI2CPackReqWrite(&msgReq, BSPROXY_BUF_BODY(buf), bTrace);

  // check packing return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdReq);

  //
  // Execute request-response transaction.
  //
  n = bsClientTrans(pClient,  hndVConn,
                    msgIdReq, buf, (size_t)n,
                    msgIdRsp, buf, sizeof(buf));

  // check transaction return code
  BSCLIENT_TRY_ECODE(pClient, n, "MsgId=%u: Transaction failed.", msgIdReq);

  //
  // Unpack response.
  //
  n = BsI2CUnpackRspWrite(buf, (size_t)n, &msgRsp, bTrace);

  // check unpack return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdRsp);

  //
  // Set return values from response.
  //
  return (int)msgRsp.m_byteswritten;
}

Variable Documentation

BsClientAppInfo_T bsI2CAppInfo

static

Initial value:

= 
{
  .app_name     = "libbsclient_i2c",
  .brief        = "Raw I2C Bus proxied device.",
  .version      = "2.0.0",
  .date         = "2010.07.20",
  .maintainer   = "RaodNarrows LLC",
  .license      = "(C) 2010 RoadNarrows LLC. All rights reserved.",

  .fnGetMsgName = bsI2CGetMsgName
}

BotSense client application information.

Definition at line 71 of file bsI2CClient.c.