aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include/i2c.h
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/include/i2c.h')
-rw-r--r--os/hal/include/i2c.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/os/hal/include/i2c.h b/os/hal/include/i2c.h
index 2d07ae8f2..c2f717432 100644
--- a/os/hal/include/i2c.h
+++ b/os/hal/include/i2c.h
@@ -79,8 +79,15 @@ typedef enum {
/**
* @brief I2C notification callback type.
- * @details This function must be used to send start or stop events to I2C bus,
- * and change states of I2CDriver.
+ * @details This callback invoked when byte transfer finish event generated,
+ * No matter sending or reading. This function designed
+ * for sending (re)start or stop events to I2C bus.
+ * Use "restart" boolean flag
+ * in I2CSlaveConfig structure for this needs.
+ * Each slave can (must?) have its own callback function.
+ *
+ * If callback function is set to NULL - driver generate stop
+ * condition on the bus after the transfer finish.
*
* @param[in] i2cp pointer to the @p I2CDriver object triggering the
* callback