aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/Documentation/i2c
diff options
context:
space:
mode:
authorLuca Ceresoli <luca.ceresoli@bootlin.com>2022-08-24 10:31:03 +0200
committerWolfram Sang <wsa@kernel.org>2022-08-29 12:28:13 +0200
commit12c035a1a840e07a351c277d7a468269fa603000 (patch)
tree108139f6e26bcba3fc67bb813585e5b2fe73834f /Documentation/i2c
parentdocs: i2c: i2c-topology: fix typo (diff)
downloadwireguard-linux-12c035a1a840e07a351c277d7a468269fa603000.tar.xz
wireguard-linux-12c035a1a840e07a351c277d7a468269fa603000.zip
docs: i2c: i2c-topology: fix incorrect heading
"Etc" here was never meant to be a heading, it became one while converting to ReST. It would be easy to just convert it to plain text, but rather remove it and add an introductory text before the list that conveys the same meaning but with a better reading flow. Fixes: ccf988b66d69 ("docs: i2c: convert to ReST and add to driver-api bookset") Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Acked-by: Peter Rosin <peda@axentia.se> Signed-off-by: Wolfram Sang <wsa@kernel.org>
Diffstat (limited to 'Documentation/i2c')
-rw-r--r--Documentation/i2c/i2c-topology.rst5
1 files changed, 2 insertions, 3 deletions
diff --git a/Documentation/i2c/i2c-topology.rst b/Documentation/i2c/i2c-topology.rst
index c9ed3b4d6085..326a1198551e 100644
--- a/Documentation/i2c/i2c-topology.rst
+++ b/Documentation/i2c/i2c-topology.rst
@@ -5,6 +5,8 @@ I2C muxes and complex topologies
There are a couple of reasons for building more complex I2C topologies
than a straight-forward I2C bus with one adapter and one or more devices.
+Some example use cases are:
+
1. A mux may be needed on the bus to prevent address collisions.
2. The bus may be accessible from some external bus master, and arbitration
@@ -14,9 +16,6 @@ than a straight-forward I2C bus with one adapter and one or more devices.
from the I2C bus, at least most of the time, and sits behind a gate
that has to be operated before the device can be accessed.
-Etc
-===
-
These constructs are represented as I2C adapter trees by Linux, where
each adapter has a parent adapter (except the root adapter) and zero or
more child adapters. The root adapter is the actual adapter that issues