[08/10] dmaengine: bcm2835: Document struct bcm2835_dmadev
diff mbox series

Message ID f2a812b579c0b99d7fadf61a30a6263a9cc19bc4.1564825752.git.lukas@wunner.de
State Accepted
Headers show
Series
  • Raspberry Pi SPI speedups
Related show

Commit Message

Lukas Wunner Aug. 3, 2019, 10:10 a.m. UTC
Document the BCM2835 DMA driver's device data structure so that upcoming
commits may add further members with proper kerneldoc.

Tested-by: Nuno Sá <nuno.sa@analog.com>
Signed-off-by: Lukas Wunner <lukas@wunner.de>
Cc: Martin Sperl <kernel@martin.sperl.org>
Cc: Florian Kauer <florian.kauer@koalo.de>
---
 drivers/dma/bcm2835-dma.c | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Vinod Koul Aug. 8, 2019, 12:31 p.m. UTC | #1
On 03-08-19, 12:10, Lukas Wunner wrote:
> Document the BCM2835 DMA driver's device data structure so that upcoming
> commits may add further members with proper kerneldoc.

Acked-by: Vinod Koul <vkoul@kernel.org>

> 
> Tested-by: Nuno Sá <nuno.sa@analog.com>
> Signed-off-by: Lukas Wunner <lukas@wunner.de>
> Cc: Martin Sperl <kernel@martin.sperl.org>
> Cc: Florian Kauer <florian.kauer@koalo.de>
> ---
>  drivers/dma/bcm2835-dma.c | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/drivers/dma/bcm2835-dma.c b/drivers/dma/bcm2835-dma.c
> index a65514fcb7f2..14358faf3bff 100644
> --- a/drivers/dma/bcm2835-dma.c
> +++ b/drivers/dma/bcm2835-dma.c
> @@ -37,6 +37,12 @@
>  #define BCM2835_DMA_MAX_DMA_CHAN_SUPPORTED 14
>  #define BCM2835_DMA_CHAN_NAME_SIZE 8
>  
> +/**
> + * struct bcm2835_dmadev - BCM2835 DMA controller
> + * @ddev: DMA device
> + * @base: base address of register map
> + * @dma_parms: DMA parameters (to convey 1 GByte max segment size to clients)
> + */
>  struct bcm2835_dmadev {
>  	struct dma_device ddev;
>  	void __iomem *base;
> -- 
> 2.20.1

Patch
diff mbox series

diff --git a/drivers/dma/bcm2835-dma.c b/drivers/dma/bcm2835-dma.c
index a65514fcb7f2..14358faf3bff 100644
--- a/drivers/dma/bcm2835-dma.c
+++ b/drivers/dma/bcm2835-dma.c
@@ -37,6 +37,12 @@ 
 #define BCM2835_DMA_MAX_DMA_CHAN_SUPPORTED 14
 #define BCM2835_DMA_CHAN_NAME_SIZE 8
 
+/**
+ * struct bcm2835_dmadev - BCM2835 DMA controller
+ * @ddev: DMA device
+ * @base: base address of register map
+ * @dma_parms: DMA parameters (to convey 1 GByte max segment size to clients)
+ */
 struct bcm2835_dmadev {
 	struct dma_device ddev;
 	void __iomem *base;