linux-iio.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Cameron <jic23@kernel.org>
To: linux-iio@vger.kernel.org
Cc: Daniel Baluta <daniel.baluta@gmail.com>,
	Hartmut Knaack <knaack.h@gmx.de>,
	Lars-Peter Clausen <lars@metafoo.de>,
	Peter Meerwald-Stadler <pmeerw@pmeerw.net>,
	Jonathan Cameron <jic23@kernel.org>
Subject: [PATCH 00/11] buffer.h cleanup and split
Date: Mon,  2 Jan 2017 19:28:23 +0000	[thread overview]
Message-ID: <20170102192834.26546-1-jic23@kernel.org> (raw)

This series came out of the mess that became apparant when looking at the
autogenerated docs.  As we pull the kernel-doc from buffer.h in when
describing the API the drivers use to access it we were pulling in a lot
of documentation that was irrelevant to that use case.

Hence, this series does two things:
1) Splits the buffer.h header into two parts:
   * buffer.h which just contains the stuff that drivers using buffers need.
   * buffer_impl.h which just contains the stuff related to the implementation
   of buffers
   This makes struct iio_buffer opaque to the drivers (with a few extra
   access functions and a bit of code reorganization)
2) Takes the documentation of struct iio_buffer inline, allowing fairly
   sensible use of the private: label within docs rather than our local
   iio specific tagging of documentation.  There is an oddity here in that
   I have deliberately 'broken' the kernel-doc for elements that are private
   in order to avoid lots of warnings about excess documentation.

Along the way various drivers gained additional includes that should probably
have been there in the first place.  This was needed to cleanup the includes
within the includes.  Most drivers did it 'right' anyway so this wasn't too
bad.

I'll probably follow this up with similar cleanups elsewhere at some point.

This was against 4.10-rc1 as that's where I'm working on docs, but should
go in reasonably cleanly on iio/togreg or iio/testing.

Jonathan Cameron (11):
  iio:buffer: Stop exporting iio_update_demux
  iio:buffer.h Reformat structure comments to be inline.
  iio:buffer: Introduced a function to assign the buffer specific attrs.
  iio:buffer: Stop exporting iio_scan_mask_query
  iio:buffers: Push some docs down into the .c file.
  iio:buffer:iio_push_to_buffers_with_timestamp fix kernel-doc.
  iio:kfifo_buf header include push down.
  iio:buffer.h include pushdown into buffer implementations
  iio:buffer: Push implementation of iio_device_attach_buffer into .c
    file
  iio:dummy: Stop enabling timestamp by default.
  iio:buffer.h - split into buffer.h and buffer_impl.h

 drivers/iio/accel/bmc150-accel-core.c       |   3 +-
 drivers/iio/accel/ssp_accel_sensor.c        |   1 +
 drivers/iio/adc/ina2xx-adc.c                |   2 +
 drivers/iio/buffer/industrialio-buffer-cb.c |   3 +-
 drivers/iio/buffer/kfifo_buf.c              |   2 +
 drivers/iio/common/ssp_sensors/ssp_iio.c    |   1 +
 drivers/iio/dummy/iio_simple_dummy_buffer.c |   4 +-
 drivers/iio/gyro/ssp_gyro_sensor.c          |   1 +
 drivers/iio/industrialio-buffer.c           | 321 +++++++++++++++-------------
 drivers/iio/industrialio-core.c             |   1 +
 drivers/staging/iio/meter/ade7758_ring.c    |   1 +
 include/linux/iio/buffer.h                  | 160 +-------------
 include/linux/iio/buffer_impl.h             | 162 ++++++++++++++
 include/linux/iio/kfifo_buf.h               |   5 +-
 14 files changed, 360 insertions(+), 307 deletions(-)
 create mode 100644 include/linux/iio/buffer_impl.h

-- 
2.11.0


             reply	other threads:[~2017-01-02 19:28 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-01-02 19:28 Jonathan Cameron [this message]
2017-01-02 19:28 ` [PATCH 01/11] iio:buffer: Stop exporting iio_update_demux Jonathan Cameron
2017-01-02 19:28 ` [PATCH 02/11] iio:buffer.h Reformat structure comments to be inline Jonathan Cameron
2017-01-02 19:28 ` [PATCH 03/11] iio:buffer: Introduced a function to assign the buffer specific attrs Jonathan Cameron
2017-01-02 19:28 ` [PATCH 04/11] iio:buffer: Stop exporting iio_scan_mask_query Jonathan Cameron
2017-01-02 19:28 ` [PATCH 05/11] iio:buffers: Push some docs down into the .c file Jonathan Cameron
2017-01-02 19:28 ` [PATCH 06/11] iio:buffer:iio_push_to_buffers_with_timestamp fix kernel-doc Jonathan Cameron
2017-01-02 19:28 ` [PATCH 07/11] iio:kfifo_buf header include push down Jonathan Cameron
2017-01-07 21:52   ` Jonathan Cameron
2017-01-02 19:28 ` [PATCH 08/11] iio:buffer.h include pushdown into buffer implementations Jonathan Cameron
2017-01-02 19:28 ` [PATCH 09/11] iio:buffer: Push implementation of iio_device_attach_buffer into .c file Jonathan Cameron
2017-01-07 22:00   ` Jonathan Cameron
2017-01-02 19:28 ` [PATCH 10/11] iio:dummy: Stop enabling timestamp by default Jonathan Cameron
2017-01-02 19:28 ` [PATCH 11/11] iio:buffer.h - split into buffer.h and buffer_impl.h Jonathan Cameron
2017-01-04 18:41 ` [PATCH 00/11] buffer.h cleanup and split Lars-Peter Clausen
2017-01-07 19:45   ` 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=20170102192834.26546-1-jic23@kernel.org \
    --to=jic23@kernel.org \
    --cc=daniel.baluta@gmail.com \
    --cc=knaack.h@gmx.de \
    --cc=lars@metafoo.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=pmeerw@pmeerw.net \
    /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;
as well as URLs for NNTP newsgroup(s).