| Message ID | cover.1680610554.git.mazziesaccount@gmail.com (mailing list archive) |
|---|---|
| Headers | show |
| Series | Improve kernel docs | expand |
On Tue, 4 Apr 2023 15:24:15 +0300 Matti Vaittinen <mazziesaccount@gmail.com> wrote: > 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. Something odd happened on this resend. Patch 1 didn't make it to me or patchwork. I'll reply to previous posting instead. Jonathan > > Revision history: > v2 resend: > - rebased on v6.3-rc2 > 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: eeac8ede17557680855031c6f305ece2378af326
la 8. huhtik. 2023 klo 12.34 Jonathan Cameron (jic23@kernel.org) kirjoitti: > > On Tue, 4 Apr 2023 15:24:15 +0300 > Matti Vaittinen <mazziesaccount@gmail.com> wrote: > > > 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. > > Something odd happened on this resend. Patch 1 didn't make it to me > or patchwork. I'll reply to previous posting instead. > It seems checkpatch.pl + some of the patches were only picking the huawei.com address. Maybe that is the reason? This really was a resend with no changes other than rebasing it - hence reviewing the v2 was absolutely fine. Thanks for the review! I'll check the suggestions and send v3 later this week. Yours, -- Matti
On Mon, 10 Apr 2023 13:16:22 +0300 Matti Vaittinen <mazziesaccount@gmail.com> wrote: > la 8. huhtik. 2023 klo 12.34 Jonathan Cameron (jic23@kernel.org) kirjoitti: > > > > On Tue, 4 Apr 2023 15:24:15 +0300 > > Matti Vaittinen <mazziesaccount@gmail.com> wrote: > > > > > 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. > > > > Something odd happened on this resend. Patch 1 didn't make it to me > > or patchwork. I'll reply to previous posting instead. > > > > It seems checkpatch.pl + some of the patches were only picking the > huawei.com address. Maybe that is the reason? Nope. Patchwork gets it straight from the list and b4 gets it it from lore.kernel.org which is also missing patch 1. > > This really was a resend with no changes other than rebasing it - > hence reviewing the v2 was absolutely fine. Thanks for the review! > I'll check the suggestions and send v3 later this week. Great. I'm behind with a few other discussions including the looking at your questions around that color sensor you want support. So may be a while before I circle back round to this anyway! Jonathan > > Yours, > -- Matti
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: v2 resend: - rebased on v6.3-rc2 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: eeac8ede17557680855031c6f305ece2378af326