Add I2C_TRANSFER based wrappers for I2C_TRANSFER as well

This commit is contained in:
Gregory Nutt 2016-01-26 10:57:51 -06:00
parent d4a53ee131
commit b6b3c2be3e
5 changed files with 276 additions and 8 deletions

View file

@ -38,7 +38,7 @@
ifeq ($(CONFIG_I2C),y)
ifeq ($(CONFIG_I2C_TRANSFER),y)
CSRCS += i2c_writeread.c
CSRCS += i2c_read.c i2c_write.c i2c_writeread.c
endif
# Include I2C device driver build support

98
drivers/i2c/i2c_read.c Normal file
View file

@ -0,0 +1,98 @@
/****************************************************************************
* drivers/i2c/i2c_read.c
*
* Copyright (C) 2016 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <assert.h>
#include <nuttx/i2c.h>
#if defined(CONFIG_I2C_TRANSFER)
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: i2c_read
*
* Description:
* Receive a block of data from I2C using the previously selected I2C
* frequency and slave address. Each read operational will be an 'atomic'
* operation in the sense that any other I2C actions will be serialized
* and pend until this read completes. Required.
*
* Input Parameters:
* dev - Device-specific state data
* buffer - A pointer to a buffer of data to receive the data from the device
* buflen - The requested number of bytes to be read
*
* Returned Value:
* 0: success, <0: A negated errno
*
****************************************************************************/
int i2c_read(FAR struct i2c_dev_s *dev, FAR const struct i2c_config_s *config,
FAR uint8_t *buffer, int buflen)
{
struct i2c_msg_s msg;
unsigned int flags;
/* 7- or 10-bit? */
flags = (config->addrlen == 10) ? I2C_M_TEN : 0;
/* Setup for the transfer */
msg.addr = config->address,
msg.flags = (flags | I2C_M_READ);
msg.buffer = buffer;
msg.length = buflen;
/* Then perform the transfer
*
* REVISIT: The following two operations must become atomic in order to
* assure thread safety.
*/
I2C_SETFREQUENCY(dev, config->frequency);
return I2C_TRANSFER(dev, &msg, 1);
}
#endif /* CONFIG_I2C_TRANSFER */

93
drivers/i2c/i2c_write.c Normal file
View file

@ -0,0 +1,93 @@
/****************************************************************************
* drivers/i2c/i2c_write.c
*
* Copyright (C) 2016 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <assert.h>
#include <nuttx/i2c.h>
#if defined(CONFIG_I2C_TRANSFER)
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: i2c_write
*
* Description:
* Send a block of data on I2C. Each write operational will be an 'atomic'
* operation in the sense that any other I2C actions will be serialized
* and pend until this write completes.
*
* Input Parameters:
* dev - Device-specific state data
* config - Described the I2C configuration
* buffer - A pointer to the read-only buffer of data to be written to device
* buflen - The number of bytes to send from the buffer
*
* Returned Value:
* 0: success, <0: A negated errno
*
****************************************************************************/
int i2c_write(FAR struct i2c_dev_s *dev, FAR const struct i2c_config_s *config,
FAR const uint8_t *buffer, int buflen)
{
struct i2c_msg_s msg;
/* Setup for the transfer */
msg.addr = config->address;
msg.flags = (config->addrlen == 10) ? I2C_M_TEN : 0;
msg.buffer = (FAR uint8_t *)buffer; /* Override const */
msg.length = buflen;
/* Then perform the transfer
*
* REVISIT: The following two operations must become atomic in order to
* assure thread safety.
*/
I2C_SETFREQUENCY(dev, config->frequency);
return I2C_TRANSFER(dev, &msg, 1);
}
#endif /* CONFIG_I2C_TRANSFER */

View file

@ -46,10 +46,26 @@
#if defined(CONFIG_I2C_TRANSFER)
/****************************************************************************
* Name: pca9555_writeread
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: i2c_writeread
*
* Description:
* Write to then read from the I2C device.
* Send a block of data on I2C using the previously, followed by restarted
* read access. This provides a convenient wrapper to the transfer function.
*
* Input Parameters:
* dev - Device-specific state data
* config - Described the I2C configuration
* wbuffer - A pointer to the read-only buffer of data to be written to device
* wbuflen - The number of bytes to send from the buffer
* rbuffer - A pointer to a buffer of data to receive the data from the device
* rbuflen - The requested number of bytes to be read
*
* Returned Value:
* 0: success, <0: A negated errno
*
****************************************************************************/

View file

@ -228,9 +228,10 @@ struct i2c_ops_s
{
uint32_t (*setfrequency)(FAR struct i2c_dev_s *dev, uint32_t frequency);
int (*setaddress)(FAR struct i2c_dev_s *dev, int addr, int nbits);
int (*write)(FAR struct i2c_dev_s *dev, const uint8_t *buffer,
int (*write)(FAR struct i2c_dev_s *dev, FAR const uint8_t *buffer,
int buflen);
int (*read)(FAR struct i2c_dev_s *dev, FAR uint8_t *buffer,
int buflen);
int (*read)(FAR struct i2c_dev_s *dev, uint8_t *buffer, int buflen);
#ifdef CONFIG_I2C_TRANSFER
int (*transfer)(FAR struct i2c_dev_s *dev, FAR struct i2c_msg_s *msgs,
int count);
@ -338,13 +339,25 @@ int up_i2cuninitialize(FAR struct i2c_dev_s *dev);
int up_i2creset(FAR struct i2c_dev_s *dev);
#endif
/************************************************************************************
/****************************************************************************
* Name: i2c_writeread
*
* Description:
* Write to then read from the I2C device.
* Send a block of data on I2C using the previously, followed by restarted
* read access. This provides a convenient wrapper to the transfer function.
*
************************************************************************************/
* Input Parameters:
* dev - Device-specific state data
* config - Described the I2C configuration
* wbuffer - A pointer to the read-only buffer of data to be written to device
* wbuflen - The number of bytes to send from the buffer
* rbuffer - A pointer to a buffer of data to receive the data from the device
* rbuflen - The requested number of bytes to be read
*
* Returned Value:
* 0: success, <0: A negated errno
*
****************************************************************************/
#ifdef CONFIG_I2C_TRANSFER
int i2c_writeread(FAR struct i2c_dev_s *dev, FAR const struct i2c_config_s *config,
@ -352,6 +365,54 @@ int i2c_writeread(FAR struct i2c_dev_s *dev, FAR const struct i2c_config_s *conf
FAR uint8_t *rbuffer, int rbuflen);
#endif
/****************************************************************************
* Name: i2c_write
*
* Description:
* Send a block of data on I2C. Each write operational will be an 'atomic'
* operation in the sense that any other I2C actions will be serialized
* and pend until this write completes.
*
* Input Parameters:
* dev - Device-specific state data
* config - Described the I2C configuration
* buffer - A pointer to the read-only buffer of data to be written to device
* buflen - The number of bytes to send from the buffer
*
* Returned Value:
* 0: success, <0: A negated errno
*
****************************************************************************/
#ifdef CONFIG_I2C_TRANSFER
int i2c_write(FAR struct i2c_dev_s *dev, FAR const struct i2c_config_s *config,
FAR const uint8_t *buffer, int buflen);
#endif
/****************************************************************************
* Name: i2c_read
*
* Description:
* Receive a block of data from I2C using the previously selected I2C
* frequency and slave address. Each read operational will be an 'atomic'
* operation in the sense that any other I2C actions will be serialized
* and pend until this read completes. Required.
*
* Input Parameters:
* dev - Device-specific state data
* buffer - A pointer to a buffer of data to receive the data from the device
* buflen - The requested number of bytes to be read
*
* Returned Value:
* 0: success, <0: A negated errno
*
****************************************************************************/
#ifdef CONFIG_I2C_TRANSFER
int i2c_read(FAR struct i2c_dev_s *dev, FAR const struct i2c_config_s *config,
FAR uint8_t *buffer, int buflen);
#endif
#undef EXTERN
#if defined(__cplusplus)
}