diff options
| author | James Churchill <pelrun@gmail.com> | 2019-03-13 03:23:28 +1000 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2019-03-12 10:23:28 -0700 |
| commit | 37932c293c15011f883a91e91ee02631ead44a2e (patch) | |
| tree | f1b4b3b44f816240b06580658b42b3646f121025 /docs/i2c_driver.md | |
| parent | 25bb059e4e42ed2637202230ff3d8b765e1295cd (diff) | |
| download | qmk_firmware-37932c293c15011f883a91e91ee02631ead44a2e.tar.gz qmk_firmware-37932c293c15011f883a91e91ee02631ead44a2e.zip | |
Next set of split_common changes (#4974)
* Update split_common to use standard i2c drivers
* Eliminate RGB_DIRTY/BACKLIT_DIRTY
* Fix avr i2c_master error handling
* Fix i2c_slave addressing
* Remove unneeded timeout on i2c_stop()
* Fix RGB I2C transfers
* Remove incorrect comment
Diffstat (limited to 'docs/i2c_driver.md')
| -rw-r--r-- | docs/i2c_driver.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/i2c_driver.md b/docs/i2c_driver.md index 18546fc62..bb1a2d74f 100644 --- a/docs/i2c_driver.md +++ b/docs/i2c_driver.md | |||
| @@ -12,7 +12,7 @@ The I2C Master drivers used in QMK have a set of common functions to allow porta | |||
| 12 | |`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. | | 12 | |`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. | |
| 13 | |`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. | | 13 | |`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. | |
| 14 | |`uint8_t i2c_readReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);` |Same as the `i2c_receive` function but `regaddr` sets from where in the slave the data will be read. | | 14 | |`uint8_t i2c_readReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);` |Same as the `i2c_receive` function but `regaddr` sets from where in the slave the data will be read. | |
| 15 | |`uint8_t i2c_stop(uint16_t timeout);` |Stops the I2C driver. | | 15 | |`uint8_t i2c_stop(void);` |Ends an I2C transaction. | |
| 16 | 16 | ||
| 17 | ### Function Return | 17 | ### Function Return |
| 18 | 18 | ||