hollalinux
/
linux-sg2042
mirror of https://github.com/sophgo/linux-riscv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Wolfram Sang 2019-01-21 15:16:57 +01:00 committed by Wolfram Sang
parent c6324fadea
commit 05bd07280d
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/i2c/gpio-fault-injection
View File

@ -1,3 +1,4 @@
=========================
Linux I2C fault injection 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 driven I2C bus. Each subdirectory will contain files to trigger the fault
injection. They will be described now along with their intended use-cases. injection. They will be described now along with their intended use-cases.
Wire states
===========
"scl" "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 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 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 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 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: device. Bus recovery should be able to fix these situations. But please note: