michaelh/zephyr
1
0
Fork 0
Code Releases Activity

drivers: i2c: i2c_gpio: reformat comment

Browse source 
Reformat comment describing the I2C GPIO bit banging pre-requisites to
improve readability.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
This commit is contained in:
Henrik Brix Andersen 2020-05-04 15:28:43 +02:00 • committed by Kumar Gala
commit f90f5d8da8
1 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

13
drivers/i2c/i2c_gpio.c
View file

@ -12,11 +12,14 @@
* @brief Driver for software driven I2C using GPIO lines
*
* This driver implements an I2C interface by driving two GPIO lines under
* software control. The GPIO pins used must be configured (through devicetree and pinmux) with suitable
* flags, i.e. the SDA pin as open-colector/open-drain with a pull-up resistor
* (possibly as an external component attached to the pin). When the SDA pin
* is read it must return the state of the physical hardware line, not just the
* last state written to it for output.
* software control.
*
* The GPIO pins used must be configured (through devicetree and pinmux) with
* suitable flags, i.e. the SDA pin as open-collector/open-drain with a pull-up
* resistor (possibly as an external component attached to the pin).
*
* When the SDA pin is read it must return the state of the physical hardware
* line, not just the last state written to it for output.
*
* The SCL pin should be configured in the same manner as SDA, or, if it is known
* that the hardware attached to pin doesn't attempt clock stretching, then the