From: Peter Rosin <peda@axentia.se>
To: linux-kernel@vger.kernel.org
Cc: Peter Rosin <peda@axentia.se>, Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org
Subject: [PATCH v2 2/2] docs: add mux docs to the driver-api docs
Date: Tue, 12 Dec 2017 09:46:33 +0100 [thread overview]
Message-ID: <20171212084633.532-3-peda@axentia.se> (raw)
In-Reply-To: <20171212084633.532-1-peda@axentia.se>
Include both the overview and the more detailed api docs.
Signed-off-by: Peter Rosin <peda@axentia.se>
---
Documentation/driver-api/index.rst | 1 +
Documentation/driver-api/mux.rst | 25 +++++++++++++++++++++++++
MAINTAINERS | 1 +
3 files changed, 27 insertions(+)
create mode 100644 Documentation/driver-api/mux.rst
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index d17a9876b473..d10b01b2b429 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -47,6 +47,7 @@ available subsections can be seen below.
gpio
misc_devices
dmaengine/index
+ mux
.. only:: subproject and html
diff --git a/Documentation/driver-api/mux.rst b/Documentation/driver-api/mux.rst
new file mode 100644
index 000000000000..48fc5108ff0e
--- /dev/null
+++ b/Documentation/driver-api/mux.rst
@@ -0,0 +1,25 @@
+Multiplexer Subsystem
+=====================
+
+A multiplexer is a type of device that selects one of many signals and
+forwards this signal to a single output. A variant is a demultiplexer
+that instead forwards a single input to one of many outputs. There are
+also bidirectional variants. All these variants are handled the same
+by the multiplexer subsystem, and can be used to e.g. fan out an I2C
+bus to avoid client device address collisions or to allow converting
+more signals using a single analog to digital converter.
+
+Overview
+--------
+
+.. kernel-doc:: drivers/mux/core.c
+ :doc: overview
+
+Details
+-------
+
+.. kernel-doc:: include/linux/mux/driver.h
+ :internal:
+
+.. kernel-doc:: drivers/mux/core.c
+ :export:
diff --git a/MAINTAINERS b/MAINTAINERS
index d4fdcb12616c..2c0bbabedca0 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9298,6 +9298,7 @@ M: Peter Rosin <peda@axentia.se>
S: Maintained
F: Documentation/ABI/testing/mux/sysfs-class-mux*
F: Documentation/devicetree/bindings/mux/
+F: Documentation/driver-api/mux.rst
F: include/linux/dt-bindings/mux/
F: include/linux/mux/
F: drivers/mux/
--
2.11.0
next prev parent reply other threads:[~2017-12-12 8:46 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-12 8:46 [PATCH v2 0/2] mux: add overview and add to " Peter Rosin
2017-12-12 8:46 ` [PATCH v2 1/2] mux: core: add a brief overview of the subsystem Peter Rosin
2017-12-12 8:46 ` Peter Rosin [this message]
2017-12-21 21:35 ` [PATCH v2 0/2] mux: add overview and add to driver-api docs Jonathan Corbet
2017-12-21 22:11 ` Peter Rosin
2018-03-03 0:04 ` Peter Rosin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20171212084633.532-3-peda@axentia.se \
--to=peda@axentia.se \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®