summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorElliot Powell <32494740+e11i0t23@users.noreply.github.com>2019-09-03 18:09:58 +0100
committerDrashna Jaelre <drashna@live.com>2019-09-03 10:09:58 -0700
commite6a6b1f122e72d58fbb14f5752929fe489d0e828 (patch)
tree818e256f17d10713b2eeb5d79bac46e4c6a870a2 /docs
parentc522009816d2c56c8e10390e2176171c34d9faab (diff)
[Docs] Update i2c_driver.md (#6665)
Fix missing arg of i2c_start
Diffstat (limited to 'docs')
-rw-r--r--docs/i2c_driver.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/i2c_driver.md b/docs/i2c_driver.md
index 856ca0a9b2..d5c340edce 100644
--- a/docs/i2c_driver.md
+++ b/docs/i2c_driver.md
@@ -7,7 +7,7 @@ The I2C Master drivers used in QMK have a set of common functions to allow porta
|Function |Description |
|------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|`void i2c_init(void);` |Initializes the I2C driver. This function should be called once before any transaction is initiated. |
-|`uint8_t i2c_start(uint8_t address);` |Starts an I2C transaction. Address is the 7-bit slave address without the direction bit. |
+|`uint8_t i2c_start(uint8_t address, uint16_t timeout);` |Starts an I2C transaction. Address is the 7-bit slave address without the direction bit. |
|`uint8_t i2c_transmit(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);` |Transmit data over I2C. Address is the 7-bit slave address without the direction. Returns status of transaction. |
|`uint8_t i2c_receive(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);` |Receive data over I2C. Address is the 7-bit slave address without the direction. Saves number of bytes specified by `length` in `data` array. Returns status of transaction. |
|`uint8_t i2c_writeReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);` |Same as the `i2c_transmit` function but `regaddr` sets where in the slave the data will be written. |