i2ccore.h File Reference

I2C python C interface header. More...

#include "rnr/rnrconfig.h"

Go to the source code of this file.

Functions
int	i2ccore_open (const char *device)
	Open a I2C bus device. More...
int	i2ccore_close (int fd)
	Close an open I2C bus device. More...
int	i2ccore_read (int fd, unsigned short cur_addr, unsigned short addr, byte_t buf[], unsigned int len)
	Read data from an attached device connected to the open I2C bus. More...
int	i2ccore_write (int fd, unsigned short cur_addr, unsigned short addr, byte_t buf[], unsigned int len)
	Write data to an attached device connected to the open I2C bus. More...
int	i2ccore_transfer (int fd, unsigned short cur_addr, unsigned short addr, byte_t wbuf[], unsigned int wcount, byte_t rbuf[], unsigned int rcount)
	Transfer data to an attached device connected to the open I2C bus reead back. More...
int	i2ccore_check (int fd, unsigned short cur_addr, unsigned short addr)
	Test for the existence of a device with the given address. More...

Detailed Description

I2C python C interface header.

LastChangedDate

2016-01-28 14:19:12 -0700 (Thu, 28 Jan 2016)

Rev

4278

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

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

Definition in file i2ccore.h.

Function Documentation

int i2ccore_check	(	int	fd,
		unsigned short	cur_addr,
		unsigned short	addr
	)

Test for the existence of a device with the given address.

Parameters

fd	File descriptor.
cur_addr	I2C address of last I/O operation.
addr	I2C device address to read.

Returns

If device is found, returns 1, else returns 0.

Definition at line 3414 of file i2ccore_wrap.c.

References i2c_struct::addr, i2c_struct::fd, i2c_exists(), i2ccore_close(), i2ccore_open(), i2ccore_read(), i2ccore_transfer(), and i2ccore_write().

{
  i2c_t i2c;

  i2c.fd    = fd;
  i2c.addr  = cur_addr;

  return i2c_exists(&i2c, addr);
}

int i2ccore_close

(

int

fd

)

Close an open I2C bus device.

Returns

On success, returns 0. On failure, returns -errno.

Definition at line 3309 of file i2ccore_wrap.c.

References i2c_struct::fd, and i2c_close().

Referenced by i2ccore_check().

{
  i2c_t i2c;
  
  i2c.fd = fd;

  i2c_close(&i2c);

  return OK;
}

int i2ccore_open

(

const char *

device

)

Open a I2C bus device.

Parameters

device

Device name.

Returns

On success, returns open file descriptor. On failure, returns -errno.

Definition at line 3292 of file i2ccore_wrap.c.

References i2c_struct::fd, and i2c_open().

Referenced by i2ccore_check().

{
  i2c_t i2c;
  int   rc;

  rc = i2c_open(&i2c, device);

  return rc < 0? -errno: i2c.fd;
}

int i2ccore_read	(	int	fd,
		unsigned short	cur_addr,
		unsigned short	addr,
		byte_t	buf[],
		unsigned int	count
	)

Read data from an attached device connected to the open I2C bus.

Parameters

	fd	File descriptor.
	cur_addr	I2C address of last I/O operation.
	addr	I2C device address to read.
[out]	buf	Output buffer.
	count	Number of byte to read.

Returns

On success, returns number of bytes read. On failure, returns -errno.

Definition at line 3333 of file i2ccore_wrap.c.

References i2c_struct::addr, i2c_struct::fd, and i2c_read().

Referenced by i2ccore_check().

{
  i2c_t i2c;
  int   n;

  i2c.fd    = fd;
  i2c.addr  = cur_addr;

  n = i2c_read(&i2c, addr, buf, count);

  return n < 0? -errno: n;
}

int i2ccore_transfer	(	int	fd,
		unsigned short	cur_addr,
		unsigned short	addr,
		byte_t	wbuf[],
		unsigned int	wcount,
		byte_t	rbuf[],
		unsigned int	rcount
	)

Transfer data to an attached device connected to the open I2C bus reead back.

Parameters

	fd	File descriptor.
	cur_addr	I2C address of last I/O operation.
	addr	I2C device address to read.
[in]	wbuf	Input buffer.
	wcount	Number of byte to write.
[out]	rbuf	Output buffer.
	rcount	Number of byte to read.

Returns

On success, returns 0. On failure, returns -errno.

Definition at line 3390 of file i2ccore_wrap.c.

References i2c_struct::addr, i2c_struct::fd, and i2c_transfer().

Referenced by i2ccore_check().

{
  i2c_t i2c;
  int   rc;

  i2c.fd    = fd;
  i2c.addr  = cur_addr;

  rc = i2c_transfer(&i2c, addr, wbuf, wcount, rbuf, rcount);

  return rc < 0? -errno: rc;
}

int i2ccore_write	(	int	fd,
		unsigned short	cur_addr,
		unsigned short	addr,
		byte_t	buf[],
		unsigned int	count
	)

Write data to an attached device connected to the open I2C bus.

Parameters

	fd	File descriptor.
	cur_addr	I2C address of last I/O operation.
	addr	I2C device address to read.
[in]	buf	Input buffer.
	count	Number of byte to write.

Returns

On success, returns number of bytes written. On failure, returns -errno.

Definition at line 3360 of file i2ccore_wrap.c.

References i2c_struct::addr, i2c_struct::fd, and i2c_write().

Referenced by i2ccore_check().

{
  i2c_t i2c;
  int   n;

  i2c.fd    = fd;
  i2c.addr  = cur_addr;

  n = i2c_write(&i2c, addr, buf, count);

  return n < 0? -errno: n;
}