]> asedeno.scripts.mit.edu Git - linux.git/commitdiff
spi: spi-mem: Move the DMA-able constraint doc to the kerneldoc header
authorBoris Brezillon <boris.brezillon@bootlin.com>
Thu, 20 Sep 2018 07:31:11 +0000 (09:31 +0200)
committerMark Brown <broonie@kernel.org>
Thu, 20 Sep 2018 19:23:31 +0000 (12:23 -0700)
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>
Signed-off-by: Mark Brown <broonie@kernel.org>
include/linux/spi/spi-mem.h

index 0cfbb1ad8d967b36d42e337b95bf2491999fd628..7195fbc234aa2781ccb9406075ddaca957b20390 100644 (file)
@@ -81,8 +81,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 {
@@ -105,7 +105,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;