All of lore.kernel.org
 help / color / mirror / Atom feed
From: Boris Brezillon <boris.brezillon@bootlin.com>
To: Mark Brown <broonie@kernel.org>, linux-spi@vger.kernel.org
Cc: David Woodhouse <dwmw2@infradead.org>,
	Brian Norris <computersforpeace@gmail.com>,
	Boris Brezillon <boris.brezillon@bootlin.com>,
	Marek Vasut <marek.vasut@gmail.com>,
	Richard Weinberger <richard@nod.at>,
	linux-mtd@lists.infradead.org
Subject: [PATCH 2/3] spi: spi-mem: Move the DMA-able constraint doc to the kerneldoc header
Date: Thu, 20 Sep 2018 09:31:11 +0200	[thread overview]
Message-ID: <20180920073112.7897-3-boris.brezillon@bootlin.com> (raw)
In-Reply-To: <20180920073112.7897-1-boris.brezillon@bootlin.com>

We'd better have that documented in the kerneldoc header, so that it's
exposed to the doc generated by Sphinx.

Signed-off-by: Boris Brezillon <boris.brezillon@bootlin.com>
---
 include/linux/spi/spi-mem.h | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/include/linux/spi/spi-mem.h b/include/linux/spi/spi-mem.h
index aeb87c02cf1d..69ee30456864 100644
--- a/include/linux/spi/spi-mem.h
+++ b/include/linux/spi/spi-mem.h
@@ -83,8 +83,8 @@ enum spi_mem_data_dir {
  * @data.dir: direction of the transfer
  * @data.nbytes: number of data bytes to send/receive. Can be zero if the
  *		 operation does not involve transferring data
- * @data.buf.in: input buffer
- * @data.buf.out: output buffer
+ * @data.buf.in: input buffer (must be DMA-able)
+ * @data.buf.out: output buffer (must be DMA-able)
  */
 struct spi_mem_op {
 	struct {
@@ -107,7 +107,6 @@ struct spi_mem_op {
 		u8 buswidth;
 		enum spi_mem_data_dir dir;
 		unsigned int nbytes;
-		/* buf.{in,out} must be DMA-able. */
 		union {
 			void *in;
 			const void *out;
-- 
2.14.1

WARNING: multiple messages have this Message-ID (diff)
From: Boris Brezillon <boris.brezillon@bootlin.com>
To: Mark Brown <broonie@kernel.org>, linux-spi@vger.kernel.org
Cc: Marek Vasut <marek.vasut@gmail.com>,
	Richard Weinberger <richard@nod.at>,
	Boris Brezillon <boris.brezillon@bootlin.com>,
	linux-mtd@lists.infradead.org,
	Brian Norris <computersforpeace@gmail.com>,
	David Woodhouse <dwmw2@infradead.org>
Subject: [PATCH 2/3] spi: spi-mem: Move the DMA-able constraint doc to the kerneldoc header
Date: Thu, 20 Sep 2018 09:31:11 +0200	[thread overview]
Message-ID: <20180920073112.7897-3-boris.brezillon@bootlin.com> (raw)
In-Reply-To: <20180920073112.7897-1-boris.brezillon@bootlin.com>

We'd better have that documented in the kerneldoc header, so that it's
exposed to the doc generated by Sphinx.

Signed-off-by: Boris Brezillon <boris.brezillon@bootlin.com>
---
 include/linux/spi/spi-mem.h | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/include/linux/spi/spi-mem.h b/include/linux/spi/spi-mem.h
index aeb87c02cf1d..69ee30456864 100644
--- a/include/linux/spi/spi-mem.h
+++ b/include/linux/spi/spi-mem.h
@@ -83,8 +83,8 @@ enum spi_mem_data_dir {
  * @data.dir: direction of the transfer
  * @data.nbytes: number of data bytes to send/receive. Can be zero if the
  *		 operation does not involve transferring data
- * @data.buf.in: input buffer
- * @data.buf.out: output buffer
+ * @data.buf.in: input buffer (must be DMA-able)
+ * @data.buf.out: output buffer (must be DMA-able)
  */
 struct spi_mem_op {
 	struct {
@@ -107,7 +107,6 @@ struct spi_mem_op {
 		u8 buswidth;
 		enum spi_mem_data_dir dir;
 		unsigned int nbytes;
-		/* buf.{in,out} must be DMA-able. */
 		union {
 			void *in;
 			const void *out;
-- 
2.14.1


______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/

  parent reply	other threads:[~2018-09-20  7:31 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-20  7:31 [PATCH 0/3] spi: spi-mem: Minor fixes/improvements Boris Brezillon
2018-09-20  7:31 ` Boris Brezillon
2018-09-20  7:31 ` [PATCH 1/3] spi: spi-mem: Add missing description for data.nbytes field Boris Brezillon
2018-09-20  7:31   ` Boris Brezillon
2018-09-20 19:26   ` Applied "spi: spi-mem: Add missing description for data.nbytes field" to the spi tree Mark Brown
2018-09-20 19:26     ` Mark Brown
2018-09-20  7:31 ` Boris Brezillon [this message]
2018-09-20  7:31   ` [PATCH 2/3] spi: spi-mem: Move the DMA-able constraint doc to the kerneldoc header Boris Brezillon
2018-09-20 19:26   ` Applied "spi: spi-mem: Move the DMA-able constraint doc to the kerneldoc header" to the spi tree Mark Brown
2018-09-20 19:26     ` Mark Brown
2018-09-20  7:31 ` [PATCH 3/3] spi: spi-mem: Add extra sanity checks on the op param Boris Brezillon
2018-09-20  7:31   ` Boris Brezillon
2018-09-20 10:31   ` Yogesh Narayan Gaur
2018-09-20 10:31     ` Yogesh Narayan Gaur
2018-09-20 11:14     ` Boris Brezillon
2018-09-20 11:14       ` Boris Brezillon
2018-09-20 19:26   ` Applied "spi: spi-mem: Add extra sanity checks on the op param" to the spi tree Mark Brown
2018-09-20 19:26     ` Mark Brown
2018-09-25  9:40   ` [PATCH 3/3] spi: spi-mem: Add extra sanity checks on the op param Geert Uytterhoeven
2018-09-25  9:40     ` Geert Uytterhoeven

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=20180920073112.7897-3-boris.brezillon@bootlin.com \
    --to=boris.brezillon@bootlin.com \
    --cc=broonie@kernel.org \
    --cc=computersforpeace@gmail.com \
    --cc=dwmw2@infradead.org \
    --cc=linux-mtd@lists.infradead.org \
    --cc=linux-spi@vger.kernel.org \
    --cc=marek.vasut@gmail.com \
    --cc=richard@nod.at \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.