diff options
author | Elwin Hammer <elwinhammer@gmail.com> | 2024-06-22 22:32:30 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-06-22 22:32:30 +0200 |
commit | a9eb2013e6b7297cfce4116179f4ab2d58d1c8d6 (patch) | |
tree | 0f16b75795d9926c5ea4a8ef52a695365837a8e4 /client/i2c.h | |
parent | f121de7c7e3ca8f0dc526973a5ee2586485aad22 (diff) | |
parent | d6440954806d381dae5b3df65b43192f897018c6 (diff) |
Merge pull request #21 from lonkaars/master
Updating branch
Diffstat (limited to 'client/i2c.h')
-rw-r--r-- | client/i2c.h | 29 |
1 files changed, 28 insertions, 1 deletions
diff --git a/client/i2c.h b/client/i2c.h index f9f58f9..87f33c9 100644 --- a/client/i2c.h +++ b/client/i2c.h @@ -3,6 +3,33 @@ #include <stdint.h> #include <stddef.h> +/** + * \ingroup pbc + * \defgroup pbc_i2c i2c + * \brief I2C abstraction functions + * \{ + */ + +/** + * \brief Fake I2C send function + * + * This function sends an I2C message to the main controller over TCP using + * \ref i2ctcp. + * + * \param addr I2C address + * \param data Data to send + * \param data_size size of \p data + */ void i2c_send(uint16_t addr, const char * data, size_t data_size); -void i2c_recv(uint16_t addr, const char * data, size_t data_size); +/** + * \brief Fake I2C receive handler + * + * This function is called for I2C messages received by the main controller and + * forwarded to \ref pbc. + * + * \param data Received data + * \param data_size size of \p data + */ +void i2c_recv(const char * data, size_t data_size); +/// \} |