[v2] iio: buffer: document calling context when pushing to buffers

[PATCH v2 0/7] iio: buffer: document calling context when pushing to buffers

David Lechner posted 7 patches 2 weeks, 1 day ago

Diff against v1
Download series mbox

drivers/iio/buffer/industrialio-buffer-cb.c |  1 +
drivers/iio/industrialio-buffer.c           |  8 ++++++++
include/linux/iio/buffer.h                  | 22 +++++++++++++++++-----
include/linux/iio/buffer_impl.h             |  3 ++-
include/linux/iio/consumer.h                |  3 ++-
5 files changed, 30 insertions(+), 7 deletions(-)

Expand all Fold all

[PATCH v2 0/7] iio: buffer: document calling context when pushing to buffers

Posted by David Lechner 2 weeks, 1 day ago

It came up in a recent discussion [1] that we need to be careful about
the calling context for various iio_push_to_buffer*() functions. Here is
a series that adds some documentation in a number of places to make this
a bit more visible.

[1]: https://lore.kernel.org/linux-iio/CAHp75Vc8u2N2AHWtnPRmRXWKN3u8Qi=yvx5afbFh4NLNb8-y9A@mail.gmail.com/

---
Changes in v2:
- Picked up a review tag (PATCH 1)
- Clarified comment about scan buffer size (PATCH 3)
- Use DEPRECATED to signal function deprecation (PATCH 4)
- Link to v1: https://lore.kernel.org/r/20250912-iio-doc-push-to-buffers-context-v1-0-c4aad013d96e@baylibre.com

---
David Lechner (7):
      iio: buffer: document iio_push_to_buffers_with_ts_unaligned() may sleep
      iio: buffer: iio_push_to_buffers_with_ts_unaligned() might_sleep()
      iio: buffer: document iio_push_to_buffers_with_ts()
      iio: buffer: deprecated iio_push_to_buffers_with_timestamp()
      iio: buffer: document iio_push_to_buffers() calling context
      iio: buffer: document store_to() callback may be called in any context
      iio: buffer: document that buffer callback must be context safe

 drivers/iio/buffer/industrialio-buffer-cb.c |  1 +
 drivers/iio/industrialio-buffer.c           |  8 ++++++++
 include/linux/iio/buffer.h                  | 22 +++++++++++++++++-----
 include/linux/iio/buffer_impl.h             |  3 ++-
 include/linux/iio/consumer.h                |  3 ++-
 5 files changed, 30 insertions(+), 7 deletions(-)
---
base-commit: 671b9b6d7f4fe17a174c410397e72253877ca64e
change-id: 20250912-iio-doc-push-to-buffers-context-df3ca98fe0df

Best regards,
-- 
David Lechner <dlechner@baylibre.com>