bsI2CServer.c File Reference

BotSense bsProxy server plug-in DLL I²C bus device module. More...

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

Go to the source code of this file.

Classes
struct	BsModCtlBlk_T
	Module resource control block structure type. More...

Macros
#define	BSMOD_MAX_HANDLES   32
	Maximum number of module supported simultaneous virtual connections.

Functions
static BsModCtlBlk_T *	bsModCtlBlkNew (const char *sDevUri, bool_t bTrace)
	Allocate a new resource control block. More...
static void	bsModCtlBlkDelete (BsModCtlBlk_T *pCtlBlk)
	Delete an allocated resource control block. More...
static BsModCtlBlk_T *	bsModCtlBlkFind (const char *sDevUri)
	Find an already allocated resource control block. More...
static int	bsModI2CReqRead (BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgIdReq, byte_t bufReq[], size_t uReqLen)
	Service a I2C read request. More...
static int	bsModI2CReqWrite (BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgIdReq, byte_t bufReq[], size_t uReqLen)
	Service a I2C write request. More...
static int	bsModI2CReqTrans (BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgIdReq, byte_t bufReq[], size_t uReqLen)
	Service a I2C write-read transaction request. More...
static int	bsModI2CScanCallback (i2c_t *pHndI2C, i2c_addr_t addr, void *pContext)
	I2C scan callback function. More...
static int	bsModI2CReqScan (BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgIdReq, byte_t bufReq[], size_t uReqLen)
	Service a I2C scan for devices request. More...
int	bsModInit (const char *sModUri, const BsModProxyCb_T *pCallbacks)
	Initialize I2C module. More...
void	bsModExit ()
	Exit I2C module. More...
int	bsModOpen (BsVConnHnd_T hndVConn, bool_t bTrace, const char *sDevUri, byte_t argbuf[], size_t uArgSize)
	Open an I2C device and associate with the given handle. More...
int	bsModClose (BsVConnHnd_T hndVConn)
	Close the I2C device and disassociate virtual connection handle. More...
int	bsModRequest (BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgIdReq, byte_t bufReq[], size_t uReqLen)
	Service an I2C request. More...
int	bsModTrace (BsVConnHnd_T hndVConn, bool_t bTrace)
	Enable/disable message tracing on handle. More...
const BsModInfo_T *	bsModInfo ()
	Query for the static module information. More...

Variables
static BsModInfo_T	BsModInfo
	Module static information. More...
static const char *	BsModUri
	module canonical name
static const BsModProxyCb_T *	BsModCallbacks
	module to bsProxy callbacks
static BsModRsrcTbl_T *	BsModRsrcTbl
	module resource table

Detailed Description

BotSense bsProxy server plug-in DLL I²C bus device module.

LastChangedDate

2010-09-13 10:25:05 -0600 (Mon, 13 Sep 2010)

Rev

581

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

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

Definition in file bsI2CServer.c.

Function Documentation

int bsModClose

(

BsVConnHnd_T

hndVConn

)

Close the I²C device and disassociate virtual connection handle.

The actual device and resources are only cleared if this is the last virtual connection reference to this device.

Parameters

hndVConn

Virtual connection handle.

Returns

On success, BS_OK is returned.
On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 782 of file bsI2CServer.c.

References BS_ECODE_INTERNAL, BS_ECODE_NO_VCONN, BS_OK, BSMOD_LOG_ERROR, BSMOD_RSRC_IS_INUSE, BSMOD_TRY_VCONN_HND_RANGE, bsModCtlBlkDelete(), BsModProxyCb_T::m_cbModRsrcRemove, BsModCtlBlk_T::m_hndI2C, and BsModCtlBlk_T::m_uRefCnt.

{
  BsModCtlBlk_T  *pCtlBlk;

  // check if handle is in valid range
  BSMOD_TRY_VCONN_HND_RANGE(hndVConn);

  // check is resouce is in-use (i.e. opened)
  if( !BSMOD_RSRC_IS_INUSE(BsModRsrcTbl, hndVConn) )
  {
    BSMOD_LOG_ERROR(hndVConn, BS_ECODE_NO_VCONN,
        "Resources for virtual connection not found.");
    return -BS_ECODE_NO_VCONN;
  }

  // remove from module's resource table
  pCtlBlk = (BsModCtlBlk_T *)BsModCallbacks->m_cbModRsrcRemove(BsModRsrcTbl,
                                                               hndVConn);

  if( pCtlBlk == NULL )
  {
    BSMOD_LOG_ERROR(hndVConn, BS_ECODE_INTERNAL, "No module resource found.");
    return -BS_ECODE_INTERNAL;
  }

  //
  // Closing last reference to device. So really close and free resources.
  //
  if( pCtlBlk->m_uRefCnt <= 1 )
  {
    i2c_close(&pCtlBlk->m_hndI2C);

    LOGDIAG2("VConn=%d: i2c_close(fd=%d).", hndVConn, pCtlBlk->m_hndI2C.fd);

    bsModCtlBlkDelete(pCtlBlk);
  }

  // Simply decrement reference count.
  else
  {
    pCtlBlk->m_uRefCnt--;
  }

  return BS_OK;
}

static void bsModCtlBlkDelete ( BsModCtlBlk_T *  pCtlBlk )

static

Delete an allocated resource control block.

Parameters

pCtlBlk

Pointer to allocated control block.

Definition at line 145 of file bsI2CServer.c.

References BsModCtlBlk_T::m_sDevUri.

Referenced by bsModClose(), bsModExit(), and bsModOpen().

{
  if( pCtlBlk != NULL )
  {
    delete((void *)(pCtlBlk->m_sDevUri));
    delete(pCtlBlk);
  }
}

static BsModCtlBlk_T* bsModCtlBlkFind ( const char *  sDevUri )

static

Find an already allocated resource control block.

Parameters

sDevUri

Device URI search parameter.

Returns

If found, returns pointer to matched control block. Else returns NULL.

Definition at line 162 of file bsI2CServer.c.

References BSMOD_MAX_HANDLES, BsModCtlBlk_T::m_sDevUri, and BsModRsrcTbl_T::m_vecRsrc.

Referenced by bsModOpen().

{
  int             index;
  BsModCtlBlk_T  *pCtlBlk;

  // search through modul'es resource table
  for(index=0; index<BSMOD_MAX_HANDLES; ++index)
  {
    if( (pCtlBlk = (BsModCtlBlk_T *)BsModRsrcTbl->m_vecRsrc[index]) != NULL )
    {
      if( !strcmp(pCtlBlk->m_sDevUri, sDevUri) )
      {
        return pCtlBlk;
      }
    }
  }
  return NULL;
}

static BsModCtlBlk_T* bsModCtlBlkNew ( const char *  sDevUri, bool_t  bTrace  )

static

Allocate a new resource control block.

Multiple virtual connection to the same I²C device share the same control block.

Parameters

sDevUri	Device URI.
bTrace	Do [not] trace messages.

Returns

Pointer to new allocated control block.

Definition at line 127 of file bsI2CServer.c.

References BsModCtlBlk_T::m_bTrace, BsModCtlBlk_T::m_sDevUri, and BsModCtlBlk_T::m_uRefCnt.

Referenced by bsModOpen().

{
  BsModCtlBlk_T *pCtlBlk;

  pCtlBlk = NEW(BsModCtlBlk_T);

  pCtlBlk->m_uRefCnt  = 0;
  pCtlBlk->m_sDevUri  = new_strdup(sDevUri);
  pCtlBlk->m_bTrace   = bTrace;

  return pCtlBlk;
}

void bsModExit

(

)

Exit I²C module.

Called once prior to module being unloaded.

All open I²C devices will be closed.

Definition at line 651 of file bsI2CServer.c.

References BSMOD_MAX_HANDLES, bsModCtlBlkDelete(), BsModUri, BsModProxyCb_T::m_cbModRsrcTblDelete, BsModCtlBlk_T::m_hndI2C, BsModCtlBlk_T::m_uRefCnt, and BsModRsrcTbl_T::m_vecRsrc.

{
  int             index;
  BsModCtlBlk_T  *pCtlBlk;

  // free all module virtual connnection resources.
  for(index=0; index<BSMOD_MAX_HANDLES; ++index)
  {
    if( (pCtlBlk = (BsModCtlBlk_T *)BsModRsrcTbl->m_vecRsrc[index]) != NULL )
    {
      if( pCtlBlk->m_uRefCnt <= 1 )
      {
        i2c_close(&pCtlBlk->m_hndI2C);
        bsModCtlBlkDelete(pCtlBlk);
      }
      else
      {
        pCtlBlk->m_uRefCnt--;
      }
    }
  }

  // free resource table
  BsModCallbacks->m_cbModRsrcTblDelete(BsModRsrcTbl);

  delete((char *)BsModUri);
}

static int bsModI2CReqRead ( BsVConnHnd_T  hndVConn, BsTid_T  uTid, BsMsgId_T  uMsgIdReq, byte_t  bufReq[], size_t  uReqLen  )

static

Service a I²C read request.

Note

A module-specific request service must send a response.

Parameters

hndVConn	Virtual connection handle.
uTid	Request-Response transaction id.
uMsgIdReq	Request message id.
bufReq	Packed request message buffer.
uReqLen	Size of request in buffer (number of bytes).

Returns

On success, BS_OK is returned.
On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 194 of file bsI2CServer.c.

References BS_ECODE_BAD_MSG, BS_ECODE_BAD_VCONN_HND, BS_ECODE_NO_VCONN, BS_ECODE_SYS, BS_OK, BsI2CMsgIdRspRead, BsI2CPackRspRead(), BsI2CUnpackReqRead(), BSMOD_IS_VCONN_HANDLE, BSMOD_RSRC, BSMOD_SEND_ERROR_RSP, BSMOD_SEND_NMERROR_RSP, BSMOD_SEND_SYSERROR_RSP, BSPROXY_BUF_BODY, BSPROXY_MSG_MAX_LEN, BsI2CReqRead_T::m_addr, BsModCtlBlk_T::m_bTrace, BsModProxyCb_T::m_cbSendRsp, BsI2CRspRead_T::m_count, BsModCtlBlk_T::m_hndI2C, BsI2CRspRead_T::m_readbuf, BsI2CReqRead_T::m_readlen, and BsI2CRspRead_T::u.

Referenced by bsModRequest().

{
  static BsI2CMsgId_T  uMsgIdRsp = BsI2CMsgIdRspRead;

  BsModCtlBlk_T    *pCtlBlk;                      // resource control block
  BsI2CReqRead_T    msgReq;                       // request message 
  BsI2CRspRead_T    msgRsp;                       // response message 
  byte_t            bufRsp[BSPROXY_MSG_MAX_LEN];  // req/rsp buffer
  i2c_addr_t        addr;                         // \h_i2c device address
  int               n;                            // number of bytes/return code

  //
  // Parameter checks
  //
  if( !BSMOD_IS_VCONN_HANDLE(hndVConn) )
  {
    BSMOD_SEND_ERROR_RSP(BsModCallbacks, hndVConn, uTid, BS_ECODE_BAD_VCONN_HND,
          "Module vconn handle out-of-range.");
    return -BS_ECODE_BAD_VCONN_HND; \
  }

  // retrieve the resource control block
  pCtlBlk = (BsModCtlBlk_T *)BSMOD_RSRC(BsModRsrcTbl, hndVConn);

  if( pCtlBlk == NULL )
  {
    BSMOD_SEND_ERROR_RSP(BsModCallbacks, hndVConn, uTid, BS_ECODE_NO_VCONN,
        "No resources for virtual connection found.");
    return -BS_ECODE_NO_VCONN;
  }

  //
  // Unpack client request.
  //
  n = BsI2CUnpackReqRead(bufReq, uReqLen, &msgReq, pCtlBlk->m_bTrace);

  // check unpacking return code
  if( n < 0 )
  {
    BSMOD_SEND_NMERROR_RSP(BsModCallbacks, hndVConn, uTid, n,
        "MsgId=%u", uMsgIdReq);
    return -BS_ECODE_BAD_MSG;
  }

  addr = (i2c_addr_t)msgReq.m_addr;

  //
  // Execute client request.
  //
  n = i2c_read(&pCtlBlk->m_hndI2C, addr, msgRsp.m_readbuf.u.m_buf,
                        (uint_t)msgReq.m_readlen);

  // check operation return code
  if( n < 0 )
  {
    BSMOD_SEND_SYSERROR_RSP(BsModCallbacks, hndVConn, uTid,
        "i2c_read(fd=%d, addr=0x%02x, ...).", pCtlBlk->m_hndI2C.fd, addr);
    return -BS_ECODE_SYS;
  }

  LOGDIAG3("VConn=%d: %d=i2c_read(fd=%d, addr=0x%02x, buf=%p, count=%zu).",
      hndVConn, n, pCtlBlk->m_hndI2C.fd, addr, msgRsp.m_readbuf.u.m_buf,
      (size_t)msgReq.m_readlen);

  //
  // Pack server response.
  //
  msgRsp.m_readbuf.m_count = (byte_t)n;
    
  // pack
  n = BsI2CPackRspRead(&msgRsp, BSPROXY_BUF_BODY(bufRsp), pCtlBlk->m_bTrace);

  // check packing return code
  if( n < 0 )
  {
    BSMOD_SEND_NMERROR_RSP(BsModCallbacks, hndVConn, uTid, n,
        "MsgId=%u", uMsgIdRsp);
    return -BS_ECODE_BAD_MSG;
  }

  //
  // Send response.
  //
  BsModCallbacks->m_cbSendRsp(hndVConn, uTid, uMsgIdRsp, bufRsp, (size_t)n);

  return BS_OK;
}

static int bsModI2CReqScan ( BsVConnHnd_T  hndVConn, BsTid_T  uTid, BsMsgId_T  uMsgIdReq, byte_t  bufReq[], size_t  uReqLen  )

static

Service a I²C scan for devices request.

Note

A module-specific request service must send a response.

Parameters

hndVConn	Virtual connection handle.
uTid	Request-Response transaction id.
uMsgIdReq	Request message id.
bufReq	Packed request message buffer.
uReqLen	Size of request in buffer (number of bytes).

Returns

On success, BS_OK is returned.
On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 541 of file bsI2CServer.c.

References BS_ECODE_BAD_MSG, BS_ECODE_BAD_VCONN_HND, BS_ECODE_NO_VCONN, BS_ECODE_SYS, BS_OK, BsI2CMsgIdRspScan, BsI2CPackRspScan(), BSMOD_IS_VCONN_HANDLE, BSMOD_RSRC, BSMOD_SEND_ERROR_RSP, BSMOD_SEND_NMERROR_RSP, BSMOD_SEND_SYSERROR_RSP, bsModI2CScanCallback(), BSPROXY_BUF_BODY, BSPROXY_MSG_MAX_LEN, BsModCtlBlk_T::m_bTrace, BsModProxyCb_T::m_cbSendRsp, BsI2CRspScan_T::m_count, BsModCtlBlk_T::m_hndI2C, and BsI2CRspScan_T::m_scan.

Referenced by bsModRequest().

{
  static BsI2CMsgId_T  uMsgIdRsp = BsI2CMsgIdRspScan;

  BsModCtlBlk_T    *pCtlBlk;                      // resource control block
  BsI2CRspScan_T    msgRsp;                       // response message 
  byte_t            bufRsp[BSPROXY_MSG_MAX_LEN];  // req/rsp buffer
  int               n;                            // number of bytes/return code

  //
  // Parameter checks
  //
  if( !BSMOD_IS_VCONN_HANDLE(hndVConn) )
  {
    BSMOD_SEND_ERROR_RSP(BsModCallbacks, hndVConn, uTid, BS_ECODE_BAD_VCONN_HND,
          "Module vconn handle out-of-range.");
    return -BS_ECODE_BAD_VCONN_HND; \
  }

  // retrieve the resource control block
  pCtlBlk = (BsModCtlBlk_T *)BSMOD_RSRC(BsModRsrcTbl, hndVConn);

  if( pCtlBlk == NULL )
  {
    BSMOD_SEND_ERROR_RSP(BsModCallbacks, hndVConn, uTid, BS_ECODE_NO_VCONN,
        "No resources for virtual connection found.");
    return -BS_ECODE_NO_VCONN;
  }

  // no devices yet
  msgRsp.m_scan.m_count = (byte_t)0;
    
  //
  // Execute client request.
  //
  n = i2c_scan(&pCtlBlk->m_hndI2C, bsModI2CScanCallback, &msgRsp);

  // check operation return code
  if( n < 0 )
  {
    BSMOD_SEND_SYSERROR_RSP(BsModCallbacks, hndVConn, uTid,
        "i2c_scan(fd=%d, ...).", pCtlBlk->m_hndI2C.fd);
    return -BS_ECODE_SYS;
  }

  LOGDIAG3("VConn=%d: %d=i2c_scan(fd=%d, ...).",
      hndVConn, n, pCtlBlk->m_hndI2C.fd);

  //
  // Pack server response.
  //
  // pack
  n = BsI2CPackRspScan(&msgRsp, BSPROXY_BUF_BODY(bufRsp), pCtlBlk->m_bTrace);

  // check packing return code
  if( n < 0 )
  {
    BSMOD_SEND_NMERROR_RSP(BsModCallbacks, hndVConn, uTid, n,
        "MsgId=%u", uMsgIdRsp);
    return -BS_ECODE_BAD_MSG;
  }

  //
  // Send response.
  //
  BsModCallbacks->m_cbSendRsp(hndVConn, uTid, uMsgIdRsp, bufRsp, (size_t)n);

  return BS_OK;
}

static int bsModI2CReqTrans ( BsVConnHnd_T  hndVConn, BsTid_T  uTid, BsMsgId_T  uMsgIdReq, byte_t  bufReq[], size_t  uReqLen  )

static

Service a I²C write-read transaction request.

Note

A module-specific request service must send a response.

Parameters

hndVConn	Virtual connection handle.
uTid	Request-Response transaction id.
uMsgIdReq	Request message id.
bufReq	Packed request message buffer.
uReqLen	Size of request in buffer (number of bytes).

Returns

On success, BS_OK is returned.
On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 404 of file bsI2CServer.c.

References BS_ECODE_BAD_MSG, BS_ECODE_BAD_VCONN_HND, BS_ECODE_NO_VCONN, BS_ECODE_SYS, BS_OK, BsI2CMsgIdRspRead, BsI2CPackRspRead(), BsI2CUnpackReqTrans(), BSMOD_IS_VCONN_HANDLE, BSMOD_RSRC, BSMOD_SEND_ERROR_RSP, BSMOD_SEND_NMERROR_RSP, BSMOD_SEND_SYSERROR_RSP, BSPROXY_BUF_BODY, BSPROXY_MSG_MAX_LEN, BsI2CReqTrans_T::m_addr, BsModCtlBlk_T::m_bTrace, BsModProxyCb_T::m_cbSendRsp, BsI2CReqTrans_T::m_count, BsI2CRspRead_T::m_count, BsModCtlBlk_T::m_hndI2C, BsI2CRspRead_T::m_readbuf, BsI2CReqTrans_T::m_readlen, BsI2CReqTrans_T::m_writebuf, BsI2CReqTrans_T::u, and BsI2CRspRead_T::u.

Referenced by bsModRequest().

{
  static BsI2CMsgId_T  uMsgIdRsp = BsI2CMsgIdRspRead;

  BsModCtlBlk_T    *pCtlBlk;                      // resource control block
  BsI2CReqTrans_T   msgReq;                       // request message 
  BsI2CRspRead_T    msgRsp;                       // response message 
  byte_t            bufRsp[BSPROXY_MSG_MAX_LEN];  // req/rsp buffer
  i2c_addr_t        addr;                         // \h_i2c device address
  int               n;                            // number of bytes/return code
  int               rc;                           // return code

  //
  // Parameter checks
  //
  if( !BSMOD_IS_VCONN_HANDLE(hndVConn) )
  {
    BSMOD_SEND_ERROR_RSP(BsModCallbacks, hndVConn, uTid, BS_ECODE_BAD_VCONN_HND,
          "Module vconn handle out-of-range.");
    return -BS_ECODE_BAD_VCONN_HND; \
  }

  // retrieve the resource control block
  pCtlBlk = (BsModCtlBlk_T *)BSMOD_RSRC(BsModRsrcTbl, hndVConn);

  if( pCtlBlk == NULL )
  {
    BSMOD_SEND_ERROR_RSP(BsModCallbacks, hndVConn, uTid, BS_ECODE_NO_VCONN,
        "No resources for virtual connection found.");
    return -BS_ECODE_NO_VCONN;
  }

  //
  // Unpack client request.
  //
  n = BsI2CUnpackReqTrans(bufReq, uReqLen, &msgReq, pCtlBlk->m_bTrace);

  // check unpacking return code
  if( n < 0 )
  {
    BSMOD_SEND_NMERROR_RSP(BsModCallbacks, hndVConn, uTid, n,
        "MsgId=%u", uMsgIdReq);
    return -BS_ECODE_BAD_MSG;
  }

  addr = (i2c_addr_t)msgReq.m_addr;

  //
  // Execute client request.
  //
  rc = i2c_transfer(&pCtlBlk->m_hndI2C, addr,
                  msgReq.m_writebuf.u.m_buf, (uint_t)msgReq.m_writebuf.m_count,
                  msgRsp.m_readbuf.u.m_buf, (uint_t)msgReq.m_readlen);

  // check operation return code
  if( rc < 0 )
  {
    BSMOD_SEND_SYSERROR_RSP(BsModCallbacks, hndVConn, uTid, 
        "i2c_transfer(fd=%d, addr=0x%02x, ...).", pCtlBlk->m_hndI2C.fd, addr);
    return -BS_ECODE_SYS;
  }

  LOGDIAG3("VConn=%d: i2c_transfer(fd=%d, addr=0x%02x, wbuf=%p, wcount=%zu, "
            "rbuf=%p, rcount=%zu).",
      hndVConn, pCtlBlk->m_hndI2C.fd,
      msgReq.m_writebuf.u.m_buf, (size_t)msgReq.m_writebuf.m_count,
      msgRsp.m_readbuf.u.m_buf, (size_t)msgReq.m_readlen);

  //
  // Pack server response. Note: transfer fails if full number of bytes are
  // not read.
  //
  msgRsp.m_readbuf.m_count = (byte_t)msgReq.m_readlen;
    
  // pack
  n = BsI2CPackRspRead(&msgRsp, BSPROXY_BUF_BODY(bufRsp), pCtlBlk->m_bTrace);

  // check packing return code
  if( n < 0 )
  {
    BSMOD_SEND_NMERROR_RSP(BsModCallbacks, hndVConn, uTid, n,
        "MsgId=%u", uMsgIdRsp);
    return -BS_ECODE_BAD_MSG;
  }

  //
  // Send response.
  //
  BsModCallbacks->m_cbSendRsp(hndVConn, uTid, uMsgIdRsp, bufRsp, (size_t)n);

  return BS_OK;
}

static int bsModI2CReqWrite ( BsVConnHnd_T  hndVConn, BsTid_T  uTid, BsMsgId_T  uMsgIdReq, byte_t  bufReq[], size_t  uReqLen  )

static

Service a I²C write request.

Note

A module-specific request service must send a response.

Parameters

hndVConn	Virtual connection handle.
uTid	Request-Response transaction id.
uMsgIdReq	Request message id.
bufReq	Packed request message buffer.
uReqLen	Size of request in buffer (number of bytes).

Returns

On success, BS_OK is returned.
On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 299 of file bsI2CServer.c.

References BS_ECODE_BAD_MSG, BS_ECODE_BAD_VCONN_HND, BS_ECODE_NO_VCONN, BS_ECODE_SYS, BS_OK, BsI2CMsgIdRspWrite, BsI2CPackRspWrite(), BsI2CUnpackReqWrite(), BSMOD_IS_VCONN_HANDLE, BSMOD_RSRC, BSMOD_SEND_ERROR_RSP, BSMOD_SEND_NMERROR_RSP, BSMOD_SEND_SYSERROR_RSP, BSPROXY_BUF_BODY, BSPROXY_MSG_MAX_LEN, BsI2CReqWrite_T::m_addr, BsModCtlBlk_T::m_bTrace, BsI2CRspWrite_T::m_byteswritten, BsModProxyCb_T::m_cbSendRsp, BsI2CReqWrite_T::m_count, BsModCtlBlk_T::m_hndI2C, BsI2CReqWrite_T::m_writebuf, and BsI2CReqWrite_T::u.

Referenced by bsModRequest().

{
  static BsI2CMsgId_T  uMsgIdRsp = BsI2CMsgIdRspWrite;

  BsModCtlBlk_T    *pCtlBlk;                      // resource control block
  BsI2CReqWrite_T   msgReq;                       // request message 
  BsI2CRspWrite_T   msgRsp;                       // response message 
  byte_t            bufRsp[BSPROXY_MSG_MAX_LEN];  // req/rsp buffer
  i2c_addr_t        addr;                         // \h_i2c device address
  int               n;                            // number of bytes/return code

  //
  // Parameter checks
  //
  if( !BSMOD_IS_VCONN_HANDLE(hndVConn) )
  {
    BSMOD_SEND_ERROR_RSP(BsModCallbacks, hndVConn, uTid, BS_ECODE_BAD_VCONN_HND,
          "Module vconn handle out-of-range.");
    return -BS_ECODE_BAD_VCONN_HND; \
  }

  // retrieve the resource control block
  pCtlBlk = (BsModCtlBlk_T *)BSMOD_RSRC(BsModRsrcTbl, hndVConn);

  if( pCtlBlk == NULL )
  {
    BSMOD_SEND_ERROR_RSP(BsModCallbacks, hndVConn, uTid, BS_ECODE_NO_VCONN,
        "No resources for virtual connection found.");
    return -BS_ECODE_NO_VCONN;
  }

  //
  // Unpack client request.
  //
  n = BsI2CUnpackReqWrite(bufReq, uReqLen, &msgReq, pCtlBlk->m_bTrace);

  // check unpacking return code
  if( n < 0 )
  {
    BSMOD_SEND_NMERROR_RSP(BsModCallbacks, hndVConn, uTid, n,
        "MsgId=%u", uMsgIdReq);
    return -BS_ECODE_BAD_MSG;
  }

  addr = (i2c_addr_t)msgReq.m_addr;

  //
  // Execute client request.
  //
  n = i2c_write(&pCtlBlk->m_hndI2C, addr, msgReq.m_writebuf.u.m_buf,
                      (uint_t)msgReq.m_writebuf.m_count);

  // check operation return code
  if( n < 0 )
  {
    BSMOD_SEND_SYSERROR_RSP(BsModCallbacks, hndVConn, uTid,
        "i2c_write(fd=%d, addr=0x%02x, ...).", pCtlBlk->m_hndI2C.fd, addr);
    return -BS_ECODE_SYS;
  }

  LOGDIAG3("VConn=%d: %d=i2c_write(fd=%d, addr=0x%02x, buf=%p, count=%zu).",
      hndVConn, n, pCtlBlk->m_hndI2C.fd, addr, msgReq.m_writebuf.u.m_buf,
      (size_t)msgReq.m_writebuf.m_count);

  //
  // Pack server response.
  //
  msgRsp.m_byteswritten = (byte_t)n;
    
  // pack
  n = BsI2CPackRspWrite(&msgRsp, BSPROXY_BUF_BODY(bufRsp), pCtlBlk->m_bTrace);

  // check packing return code
  if( n < 0 )
  {
    BSMOD_SEND_NMERROR_RSP(BsModCallbacks, hndVConn, uTid, n,
        "MsgId=%u", uMsgIdRsp);
    return -BS_ECODE_BAD_MSG;
  }

  //
  // Send response.
  //
  BsModCallbacks->m_cbSendRsp(hndVConn, uTid, uMsgIdRsp, bufRsp, (size_t)n);

  return BS_OK;
}

static int bsModI2CScanCallback ( i2c_t *  pHndI2C, i2c_addr_t  addr, void *  pContext  )

static

I²C scan callback function.

Parameters

pHndI2C	Pointer to I2C Bus handle.
addr	Discovered I2C device address during scan.
pContext	Callback context.

Returns

On success, returns current number of scanned device found. On error, errno is set and - BS_ECODE_SYS is returned.

Definition at line 512 of file bsI2CServer.c.

References BS_ECODE_SYS, BSI2C_RSPSCAN_SCAN_LEN, BsI2CRspScan_T::m_count, BsI2CRspScan_T::m_scan, and BsI2CRspScan_T::u.

Referenced by bsModI2CReqScan().

{
  BsI2CRspScan_T  *pMsgRsp = (BsI2CRspScan_T *)pContext;  // response message 

  if( pMsgRsp->m_scan.m_count < BSI2C_RSPSCAN_SCAN_LEN )
  {
    pMsgRsp->m_scan.u.m_buf[pMsgRsp->m_scan.m_count++] = addr;
    return pMsgRsp->m_scan.m_count;
  }
  else
  {
    errno = E2BIG;
    return -BS_ECODE_SYS;
  }
}

const BsModInfo_T* bsModInfo

(

)

Query for the static module information.

Returns

Pointer to module static information.

Definition at line 927 of file bsI2CServer.c.

References BsModInfo.

{
  return &BsModInfo;
}

int bsModInit	(	const char *	sModUri,
		const BsModProxyCb_T *	pCallbacks
	)

Initialize I²C module.

Called once after module is loaded.

Parameters

sModUri	Expanded, canonical module path name.
pCallbacks	Pointer to a set of module -> bsProxy core callback functions.

Returns

On success, BS_OK is returned.
On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 631 of file bsI2CServer.c.

References BS_OK, BSMOD_MAX_HANDLES, BsModUri, and BsModProxyCb_T::m_cbModRsrcTblNew.

{
  BsModUri = new_strdup(sModUri);

  // save bsProxy server callbacks
  BsModCallbacks = pCallbacks;

  // create module resource table
  BsModRsrcTbl = BsModCallbacks->m_cbModRsrcTblNew(BSMOD_MAX_HANDLES);

  return BS_OK;
}

int bsModOpen	(	BsVConnHnd_T	hndVConn,
		bool_t	bTrace,
		const char *	sDevUri,
		byte_t	argbuf[],
		size_t	uArgSize
	)

Open an I²C device and associate with the given handle.

Subsequent calls to the module use the given handle to associate the specific module-device instance.

The argument buffer contains packed message arguements specific to the device and module. For this I²C module, there are now additional arguments.

Note

Each call to this exported function will only open the I²C device if it is the first call. All virtual connections to the same device share the same opened file resource descriptor.

It is the responsibile of the client to ensure consistency if more than one virtual connection is established.

Parameters

hndVConn	Virtual connection handle.
bTrace	Do [not] enable message tracing on this handle.
sDevUri	Device URI.
argbuf	Packed specific open configuration arguments submessage.
uArgSize	Size of packed argumets in buffer (number of bytes).

Returns

On success, returns a unique resource descriptor ≥ 0 which is typically an opened file descriptor or socket descriptor, but can be module defined.
On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 708 of file bsI2CServer.c.

References BS_ECODE_BUSY, BS_ECODE_NO_RSRC, BS_ECODE_SYS, BSMOD_LOG_ERROR, BSMOD_LOG_SYSERROR, BSMOD_MAX_HANDLES, BSMOD_RSRC_INUSE_COUNT, BSMOD_RSRC_IS_INUSE, BSMOD_TRY_VCONN_HND_RANGE, bsModCtlBlkDelete(), bsModCtlBlkFind(), bsModCtlBlkNew(), BsModProxyCb_T::m_cbModRsrcAdd, BsModCtlBlk_T::m_hndI2C, and BsModCtlBlk_T::m_uRefCnt.

{
  BsModCtlBlk_T        *pCtlBlk;
  int                   rc;

  // Check if handle is in valid range.
  BSMOD_TRY_VCONN_HND_RANGE(hndVConn);

  // Check if resources are available.
  if( BSMOD_RSRC_INUSE_COUNT(BsModRsrcTbl) >= BSMOD_MAX_HANDLES )
  {
    BSMOD_LOG_ERROR(hndVConn, BS_ECODE_NO_RSRC,
        "InUseCount=%u: No more resources available.",
        BSMOD_RSRC_INUSE_COUNT(BsModRsrcTbl));
    return -BS_ECODE_NO_RSRC;
  }
  
  // Check if the handle in this module's resource table is not already in-use.
  else if( BSMOD_RSRC_IS_INUSE(BsModRsrcTbl, hndVConn) )
  {
    BSMOD_LOG_ERROR(hndVConn, BS_ECODE_BUSY, 
        "Module virtual connection handle already in use");
    return -BS_ECODE_BUSY;
  }

  //
  // Search for an existing opened device control block. If this is a first 
  // reference to the device, then create a shared control block and open
  // the actual device.
  //
  if( (pCtlBlk = bsModCtlBlkFind(sDevUri)) == NULL )
  {
    // allocate a new control block and initialize
    pCtlBlk = bsModCtlBlkNew(sDevUri, bTrace);

    // open the device
    rc = i2c_open(&pCtlBlk->m_hndI2C, sDevUri);

    if( rc < 0 )
    {
      BSMOD_LOG_SYSERROR(hndVConn, "i2c_open(%p, %s).",
                                  &pCtlBlk->m_hndI2C, sDevUri);
      bsModCtlBlkDelete(pCtlBlk);
      return -BS_ECODE_SYS;
    }
  }

  // bump device reference count
  pCtlBlk->m_uRefCnt++;

  // add (a copy) to this module's resource table
  BsModCallbacks->m_cbModRsrcAdd(BsModRsrcTbl, hndVConn, pCtlBlk);

  LOGDIAG2("VConn=%d: %d=i2c_open(%p, dev=%s).",
      hndVConn, pCtlBlk->m_hndI2C.fd, &pCtlBlk->m_hndI2C, sDevUri);

  return pCtlBlk->m_hndI2C.fd;
}

int bsModRequest	(	BsVConnHnd_T	hndVConn,
		BsTid_T	uTid,
		BsMsgId_T	uMsgIdReq,
		byte_t	bufReq[],
		size_t	uReqLen
	)

Service an I²C request.

Note

A module-specific request service must send a response.

Parameters

hndVConn	Virtual connection handle.
uTid	Request-Response transaction id.
uMsgIdReq	Request message id.
bufReq	Packed request message buffer.
uReqLen	Size of request in buffer (number of bytes).

Returns

On success, BS_OK is returned.
On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 841 of file bsI2CServer.c.

References BS_ECODE_BAD_VCONN_HND, BS_ECODE_NO_VCONN, BS_ECODE_UNKNOWN_REQ, BsI2CMsgIdReqRead, BsI2CMsgIdReqScan, BsI2CMsgIdReqTrans, BsI2CMsgIdReqWrite, BSMOD_IS_VCONN_HANDLE, BSMOD_RSRC, BSMOD_SEND_ERROR_RSP, bsModI2CReqRead(), bsModI2CReqScan(), bsModI2CReqTrans(), and bsModI2CReqWrite().

{
  BsModCtlBlk_T  *pCtlBlk;

  // check if handle is in valid range
  if( !BSMOD_IS_VCONN_HANDLE(hndVConn) )
  {
    BSMOD_SEND_ERROR_RSP(BsModCallbacks, hndVConn, uTid, BS_ECODE_BAD_VCONN_HND,
          "Module vconn handle out-of-range.");
    return -BS_ECODE_BAD_VCONN_HND; \
  }

  // retrieve resource control block
  pCtlBlk = (BsModCtlBlk_T *)BSMOD_RSRC(BsModRsrcTbl, hndVConn);

  // check resource
  if( pCtlBlk == NULL )
  {
    BSMOD_SEND_ERROR_RSP(BsModCallbacks, hndVConn, uTid, BS_ECODE_NO_VCONN,
        "No resources for virtual connection found.");
    return -BS_ECODE_NO_VCONN;
  }

  switch( uMsgIdReq )
  {
    case BsI2CMsgIdReqRead:
      return bsModI2CReqRead(hndVConn, uTid, uMsgIdReq, bufReq, uReqLen);
    case BsI2CMsgIdReqTrans:
      return bsModI2CReqTrans(hndVConn, uTid, uMsgIdReq, bufReq, uReqLen);
    case BsI2CMsgIdReqWrite:
      return bsModI2CReqWrite(hndVConn, uTid, uMsgIdReq, bufReq, uReqLen);
    case BsI2CMsgIdReqScan:
      return bsModI2CReqScan(hndVConn, uTid, uMsgIdReq, bufReq, uReqLen);
    default:
      BSMOD_SEND_ERROR_RSP(BsModCallbacks, hndVConn, uTid, BS_ECODE_UNKNOWN_REQ,
          "MsgId=%u.", uMsgIdReq);
      return -BS_ECODE_UNKNOWN_REQ;
  }
}

int bsModTrace	(	BsVConnHnd_T	hndVConn,
		bool_t	bTrace
	)

Enable/disable message tracing on handle.

Parameters

hndVConn	Virtual connection handle.
bTrace	Do [not] enable message tracing on this handle.

Returns

On success, BS_OK is returned.
On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 893 of file bsI2CServer.c.

References BS_ECODE_BAD_VCONN_HND, BS_ECODE_NO_VCONN, BS_OK, BSMOD_IS_VCONN_HANDLE, BSMOD_LOG_ERROR, BSMOD_RSRC, and BsModCtlBlk_T::m_bTrace.

{
  BsModCtlBlk_T  *pCtlBlk;

  // check if handle is in valid range
  if( !BSMOD_IS_VCONN_HANDLE(hndVConn) )
  {
    BSMOD_LOG_ERROR(hndVConn, BS_ECODE_BAD_VCONN_HND,
          "Module vconn handle out-of-range.");
    return -BS_ECODE_BAD_VCONN_HND;
  }

  // retrieve resource control block
  pCtlBlk = (BsModCtlBlk_T *)BSMOD_RSRC(BsModRsrcTbl, hndVConn);

  // check resource
  if( pCtlBlk == NULL )
  {
    BSMOD_LOG_ERROR(hndVConn, BS_ECODE_NO_VCONN,
        "No resources for virtual connection found.");
    return -BS_ECODE_NO_VCONN;
  }

  pCtlBlk->m_bTrace = bTrace;

  return BS_OK;
}

Variable Documentation

BsModInfo_T BsModInfo

static

Initial value:

= 
{
  .mod_name   = BS_I2C_SERVER_MOD,
  .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."
}

Module static information.

Definition at line 72 of file bsI2CServer.c.

Referenced by bsModInfo().