diff mbox series

[2/3] spi: spi-mem: Move the DMA-able constraint doc to the kerneldoc header

Message ID 20180920073112.7897-3-boris.brezillon@bootlin.com (mailing list archive)
State Accepted
Commit c949a8e8b43f2c75567269bcc9a50d704ae3c420
Headers show
Series spi: spi-mem: Minor fixes/improvements | expand

Commit Message

Boris Brezillon Sept. 20, 2018, 7:31 a.m. UTC 
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 mbox series

Patch

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;