[PATCH] i2c: tegra: Add missing kernel-doc for dma_dev member

Hans Zhang posted 1 patch 7 months ago
drivers/i2c/busses/i2c-tegra.c | 1 +
1 file changed, 1 insertion(+)
[PATCH] i2c: tegra: Add missing kernel-doc for dma_dev member
Posted by Hans Zhang 7 months ago
Fix the kernel-doc warning by describing the 'dma_dev' member in
the tegra_i2c_dev struct.  This resolves the compilation warning:

drivers/i2c/busses/i2c-tegra.c:297: warning: Function parameter or struct member 'dma_dev' not described in 'tegra_i2c_dev'

Fixes: cdbf26251d3b ("i2c: tegra: Allocate DMA memory for DMA engine")
Signed-off-by: Hans Zhang <18255117159@163.com>
---
 drivers/i2c/busses/i2c-tegra.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/i2c/busses/i2c-tegra.c b/drivers/i2c/busses/i2c-tegra.c
index 87976e99e6d0..07bb1e7e84cc 100644
--- a/drivers/i2c/busses/i2c-tegra.c
+++ b/drivers/i2c/busses/i2c-tegra.c
@@ -253,6 +253,7 @@ struct tegra_i2c_hw_feature {
  * @dma_phys: handle to DMA resources
  * @dma_buf: pointer to allocated DMA buffer
  * @dma_buf_size: DMA buffer size
+ * @dma_dev: DMA device used for transfers
  * @dma_mode: indicates active DMA transfer
  * @dma_complete: DMA completion notifier
  * @atomic_mode: indicates active atomic transfer

base-commit: fee3e843b309444f48157e2188efa6818bae85cf
-- 
2.25.1
Re: [PATCH] i2c: tegra: Add missing kernel-doc for dma_dev member
Posted by Andi Shyti 5 months, 3 weeks ago
Hi Hans,

On Fri, May 23, 2025 at 12:38:14AM +0800, Hans Zhang wrote:
> Fix the kernel-doc warning by describing the 'dma_dev' member in
> the tegra_i2c_dev struct.  This resolves the compilation warning:
> 
> drivers/i2c/busses/i2c-tegra.c:297: warning: Function parameter or struct member 'dma_dev' not described in 'tegra_i2c_dev'
> 
> Fixes: cdbf26251d3b ("i2c: tegra: Allocate DMA memory for DMA engine")
> Signed-off-by: Hans Zhang <18255117159@163.com>

Thanks for your patch. I merged it in i2c/i2c-host without the
Fixes tag as this is not a fix which deserves to be backported to
older kernels.

Thanks,
Andi
Re: [PATCH] i2c: tegra: Add missing kernel-doc for dma_dev member
Posted by Hans Zhang 6 months, 1 week ago
Hi all,

Gentle ping.

Best regards,
Hans

On 2025/5/23 00:38, Hans Zhang wrote:
> Fix the kernel-doc warning by describing the 'dma_dev' member in
> the tegra_i2c_dev struct.  This resolves the compilation warning:
> 
> drivers/i2c/busses/i2c-tegra.c:297: warning: Function parameter or struct member 'dma_dev' not described in 'tegra_i2c_dev'
> 
> Fixes: cdbf26251d3b ("i2c: tegra: Allocate DMA memory for DMA engine")
> Signed-off-by: Hans Zhang <18255117159@163.com>
> ---
>   drivers/i2c/busses/i2c-tegra.c | 1 +
>   1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/i2c/busses/i2c-tegra.c b/drivers/i2c/busses/i2c-tegra.c
> index 87976e99e6d0..07bb1e7e84cc 100644
> --- a/drivers/i2c/busses/i2c-tegra.c
> +++ b/drivers/i2c/busses/i2c-tegra.c
> @@ -253,6 +253,7 @@ struct tegra_i2c_hw_feature {
>    * @dma_phys: handle to DMA resources
>    * @dma_buf: pointer to allocated DMA buffer
>    * @dma_buf_size: DMA buffer size
> + * @dma_dev: DMA device used for transfers
>    * @dma_mode: indicates active DMA transfer
>    * @dma_complete: DMA completion notifier
>    * @atomic_mode: indicates active atomic transfer
> 
> base-commit: fee3e843b309444f48157e2188efa6818bae85cf