riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

drivers/include/i2c: Fix API documentation

Browse Source 
The write_reg/s states a repeated start write is used but that is not how the i2c is implemeneted.
Most devices also only use a continuous write so the API should be changed to match implementation and the majority of sensors.
This commit is contained in:
MrKevinWeiss 2018-12-10 09:56:31 +01:00
parent e14e6ead92
commit 0ad94e1b4b
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
drivers/include/periph/i2c.h
View File

@ -388,8 +388,8 @@ int i2c_write_bytes(i2c_t dev, uint16_t addr, const void *data,
* @brief Convenience function for writing one byte to a given * @brief Convenience function for writing one byte to a given
* register address * register address
* *
* @note This function is using a repeated start sequence for writing to the * @note This function is using a continuous sequence for writing to the
* specified register address. * specified register address. It first writes the register then data.
* *
* @pre i2c_acquire must be called before accessing the bus * @pre i2c_acquire must be called before accessing the bus
* *
@ -414,8 +414,8 @@ int i2c_write_reg(i2c_t dev, uint16_t addr, uint16_t reg,
/** /**
* @brief Convenience function for writing data to a given register address * @brief Convenience function for writing data to a given register address
* *
* @note This function is using a repeated start sequence for writing to the * @note This function is using a continuous sequence for writing to the
* specified register address. * specified register address. It first writes the register then data.
* *
* @pre i2c_acquire must be called before accessing the bus * @pre i2c_acquire must be called before accessing the bus
* *