From: Matti Vaittinen <mazziesaccount@gmail.com>
To: Matti Vaittinen <mazziesaccount@gmail.com>,
Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
Cc: Jonathan Cameron <jic23@kernel.org>,
Lars-Peter Clausen <lars@metafoo.de>,
Andrea Merello <andrea.merello@iit.it>,
Andy Shevchenko <andy.shevchenko@gmail.com>,
Matti Vaittinen <mazziesaccount@gmail.com>,
Jagath Jog J <jagathjog1996@gmail.com>,
linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v2 0/3] iio: Improce kernel docs
Date: Sat, 25 Feb 2023 15:53:22 +0200 [thread overview]
Message-ID: <cover.1677331779.git.mazziesaccount@gmail.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 2013 bytes --]
IIO has very nice facilities for efficiently providing data from a
device to user (and probably also vice-versa - but I've not used that
direction). Getting started with IIO may not be so simple though - some
of the concepts like triggers and buffers are quite unique.
This series tries to make it easier for a newcomer to write his/her first
IIO driver by adding some documentation to used enums. Series does not
provide extensive documentation but just documents those few entries I
have become familiar with - but it still aims to be a starting point for
others to add missing bits and pieces.
This series is marked as v2 because the patch 1 was previously sent as a
stan-alone RFC to collect the missing channel units. RFC can be seen
here:
https://lore.kernel.org/all/10a855f9adc1d710150b7f647500c3c6a769f9ca.1677243698.git.mazziesaccount@gmail.com/
Patches 2 and 3 were added as a result of discussion followed by the
RFC.
Revision history:
RFCv1 => v2:
- added patches 2 and 3
- added missing channel type docs provided by Jonathan
- added @in front of member names and fix typos pointed by Andy
- dropped TODOs as Jonathan clarified the units
---
Matti Vaittinen (3):
iio: Add some kerneldoc for channel types
iio: add documentation for iio_chan_info_enum
doc: Make sysfs-bus-iio doc more exact
Documentation/ABI/testing/sysfs-bus-iio | 11 +-
include/linux/iio/types.h | 46 +++++++-
include/uapi/linux/iio/types.h | 134 ++++++++++++++++++++++++
3 files changed, 185 insertions(+), 6 deletions(-)
base-commit: c9c3395d5e3dcc6daee66c6908354d47bf98cb0c
--
2.39.2
--
Matti Vaittinen, Linux device drivers
ROHM Semiconductors, Finland SWDC
Kiviharjunlenkki 1E
90220 OULU
FINLAND
~~~ "I don't think so," said Rene Descartes. Just then he vanished ~~~
Simon says - in Latin please.
~~~ "non cogito me" dixit Rene Descarte, deinde evanescavit ~~~
Thanks to Simon Glass for the translation =]
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
next reply other threads:[~2023-02-25 13:53 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-25 13:53 Matti Vaittinen [this message]
2023-02-25 13:54 ` [PATCH v2 1/3] iio: Add some kerneldoc for channel types Matti Vaittinen
2023-04-08 10:18 ` Jonathan Cameron
2023-02-25 13:55 ` [PATCH v2 2/3] iio: add documentation for iio_chan_info_enum Matti Vaittinen
2023-04-08 10:30 ` Jonathan Cameron
2023-04-11 8:27 ` Vaittinen, Matti
2023-04-16 13:18 ` Jonathan Cameron
2023-04-12 8:52 ` Matti Vaittinen
2023-04-16 13:19 ` Jonathan Cameron
2023-02-25 13:56 ` [PATCH v2 3/3] doc: Make sysfs-bus-iio doc more exact Matti Vaittinen
2023-04-08 10:32 ` Jonathan Cameron
2023-04-09 9:47 ` Andy Shevchenko
2023-04-10 11:23 ` Jonathan Cameron
2023-02-26 17:22 ` [PATCH v2 0/3] iio: Improce kernel docs Jonathan Cameron
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=cover.1677331779.git.mazziesaccount@gmail.com \
--to=mazziesaccount@gmail.com \
--cc=andrea.merello@iit.it \
--cc=andy.shevchenko@gmail.com \
--cc=jagathjog1996@gmail.com \
--cc=jic23@kernel.org \
--cc=lars@metafoo.de \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=matti.vaittinen@fi.rohmeurope.com \
/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