Skip to content

Commit

Permalink
drivers: i2c: add an option to skip auto-sending stop on last message
Browse files Browse the repository at this point in the history
The I2C transfer API has been recently changed to always automatically
set a STOP on the last message, which was well documented but
implemented only by few drivers.

Unfortunately, while documented, this is a change in the current
behavior and it turns out that some applications depended on it for some
complex operations.

Add a flag to temporarily restore the old behavior, buying time to fix
the application code depending on this.

Signed-off-by: Fabio Baltieri <[email protected]>
  • Loading branch information
fabiobaltieri committed Aug 2, 2024
1 parent ebd31d3 commit 493b041
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
8 changes: 8 additions & 0 deletions drivers/i2c/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,14 @@ config I2C_CALLBACK
help
API and implementations of i2c_transfer_cb.

config I2C_LAST_MESSAGE_IMPLICIT_STOP
bool "Always send a STOP on the last message of an I2C transfer"
default y
help
The last message of an I2C transaction implies a STOP whether or not
it is explicitly set. This is the default behavior and the option
will be removed in Zephyr 4.1.

config HAS_I2C_RTIO
bool
help
Expand Down
8 changes: 6 additions & 2 deletions include/zephyr/drivers/i2c.h
Original file line number Diff line number Diff line change
Expand Up @@ -789,7 +789,9 @@ static inline int z_impl_i2c_transfer(const struct device *dev,
return 0;
}

msgs[num_msgs - 1].flags |= I2C_MSG_STOP;
if (IS_ENABLED(CONFIG_I2C_LAST_MESSAGE_IMPLICIT_STOP)) {
msgs[num_msgs - 1].flags |= I2C_MSG_STOP;
}

int res = api->transfer(dev, msgs, num_msgs, addr);

Expand Down Expand Up @@ -845,7 +847,9 @@ static inline int i2c_transfer_cb(const struct device *dev,
return 0;
}

msgs[num_msgs - 1].flags |= I2C_MSG_STOP;
if (IS_ENABLED(CONFIG_I2C_LAST_MESSAGE_IMPLICIT_STOP)) {
msgs[num_msgs - 1].flags |= I2C_MSG_STOP;
}

return api->transfer_cb(dev, msgs, num_msgs, addr, cb, userdata);
}
Expand Down

0 comments on commit 493b041

Please sign in to comment.