From b6b3c2be3e8b4d5dcbe680dd4c4ad37749e7f91d Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Tue, 26 Jan 2016 10:57:51 -0600 Subject: [PATCH] Add I2C_TRANSFER based wrappers for I2C_TRANSFER as well --- drivers/i2c/Make.defs | 2 +- drivers/i2c/i2c_read.c | 98 +++++++++++++++++++++++++++++++++++++ drivers/i2c/i2c_write.c | 93 +++++++++++++++++++++++++++++++++++ drivers/i2c/i2c_writeread.c | 20 +++++++- include/nuttx/i2c.h | 71 +++++++++++++++++++++++++-- 5 files changed, 276 insertions(+), 8 deletions(-) create mode 100644 drivers/i2c/i2c_read.c create mode 100644 drivers/i2c/i2c_write.c diff --git a/drivers/i2c/Make.defs b/drivers/i2c/Make.defs index 5354db1bfe..4d1d737a57 100644 --- a/drivers/i2c/Make.defs +++ b/drivers/i2c/Make.defs @@ -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 diff --git a/drivers/i2c/i2c_read.c b/drivers/i2c/i2c_read.c new file mode 100644 index 0000000000..2c93bac533 --- /dev/null +++ b/drivers/i2c/i2c_read.c @@ -0,0 +1,98 @@ +/**************************************************************************** + * drivers/i2c/i2c_read.c + * + * Copyright (C) 2016 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt + * + * 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 + +#include + +#include + +#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 */ \ No newline at end of file diff --git a/drivers/i2c/i2c_write.c b/drivers/i2c/i2c_write.c new file mode 100644 index 0000000000..3f2395e370 --- /dev/null +++ b/drivers/i2c/i2c_write.c @@ -0,0 +1,93 @@ +/**************************************************************************** + * drivers/i2c/i2c_write.c + * + * Copyright (C) 2016 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt + * + * 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 + +#include + +#include + +#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 */ \ No newline at end of file diff --git a/drivers/i2c/i2c_writeread.c b/drivers/i2c/i2c_writeread.c index 49753277b9..d5fab3f43b 100644 --- a/drivers/i2c/i2c_writeread.c +++ b/drivers/i2c/i2c_writeread.c @@ -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 * ****************************************************************************/ diff --git a/include/nuttx/i2c.h b/include/nuttx/i2c.h index 8c053d820a..03c03bced6 100644 --- a/include/nuttx/i2c.h +++ b/include/nuttx/i2c.h @@ -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) }