diff options
| author | Wolfram Sang <wsa+renesas@sang-engineering.com> | 2019-01-21 17:16:57 +0300 |
|---|---|---|
| committer | Wolfram Sang <wsa@the-dreams.de> | 2019-02-05 16:19:55 +0300 |
| commit | 05bd07280d5f70920c3619998b3a79742e4cde30 (patch) | |
| tree | 6638edcf4f506ea9b35e5a7ad60bf30679d92ef7 /Documentation/i2c | |
| parent | c6324fadeac80da60ab99d22cfe19873a31dd30d (diff) | |
| download | linux-05bd07280d5f70920c3619998b3a79742e4cde30.tar.xz | |
i2c: gpio: fault-injector: better SPHINX style in docs
We don't use SPHINX currently in I2C documentation; but preparing the
I2C fault injector docs already is a good idea since it makes it easier
to read. Especially as new stuff is going to be added soon.
Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
Diffstat (limited to 'Documentation/i2c')
| -rw-r--r-- | Documentation/i2c/gpio-fault-injection | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/Documentation/i2c/gpio-fault-injection b/Documentation/i2c/gpio-fault-injection index a4ce62090fd5..1a44e3edc0c4 100644 --- a/Documentation/i2c/gpio-fault-injection +++ b/Documentation/i2c/gpio-fault-injection @@ -1,3 +1,4 @@ +========================= Linux I2C fault injection ========================= @@ -13,6 +14,9 @@ mounted at /sys/kernel/debug. There will be a separate subdirectory per GPIO driven I2C bus. Each subdirectory will contain files to trigger the fault injection. They will be described now along with their intended use-cases. +Wire states +=========== + "scl" ----- @@ -34,10 +38,10 @@ I2C specification version 4, section 3.1.16) using the helpers of the Linux I2C core (see 'struct bus_recovery_info'). However, the bus recovery will not succeed because SDA is still pinned low until you manually release it again with "echo 1 > sda". A test with an automatic release can be done with the -following class of fault injectors. +"incomplete transfers" class of fault injectors. -Introduction to incomplete transfers ------------------------------------- +Incomplete transfers +==================== The following fault injectors create situations where SDA will be held low by a device. Bus recovery should be able to fix these situations. But please note: |