[PATCH -next] dma: Add dev_id parameter description in request_dma_bycap

[PATCH -next] dma: Add dev_id parameter description in request_dma_bycap

[Yang Li]

This patch adds the missing description for the dev_id parameter in the
kernel documentation for the request_dma_bycap function.

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 arch/sh/drivers/dma/dma-api.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/arch/sh/drivers/dma/dma-api.c b/arch/sh/drivers/dma/dma-api.c
index 89cd4a3b4cca..65005d348877 100644
--- a/arch/sh/drivers/dma/dma-api.c
+++ b/arch/sh/drivers/dma/dma-api.c
@@ -116,6 +116,7 @@ static int search_cap(const char **haystack, const char *needle)
  * request_dma_bycap - Allocate a DMA channel based on its capabilities
  * @dmac: List of DMA controllers to search
  * @caps: List of capabilities
+ * @dev_id: Unique identifier for the device that is requesting a DMA channel
  *
  * Search all channels of all DMA controllers to find a channel which
  * matches the requested capabilities. The result is the channel
-- 
2.20.1.7.g153144c

Re: [PATCH -next] dma: Add dev_id parameter description in request_dma_bycap

[Geert Uytterhoeven]

On Fri, Apr 19, 2024 at 11:03 AM Yang Li <yang.lee@linux.alibaba.com> wrote:
> This patch adds the missing description for the dev_id parameter in the
> kernel documentation for the request_dma_bycap function.
>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Fixes: db9b99d461ddbbaa ("sh: dma-api channel capability extensions.")
Reviewed-by: Geert Uytterhoeven <geert+renesas@glider.be>

Gr{oetje,eeting}s,

                        Geert

-- 
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds

Re: [PATCH -next] dma: Add dev_id parameter description in request_dma_bycap

[John Paul Adrian Glaubitz]

Hi Yang,

On Fri, 2024-04-19 at 17:02 +0800, Yang Li wrote:
> This patch adds the missing description for the dev_id parameter in the
> kernel documentation for the request_dma_bycap function.
> 
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
>  arch/sh/drivers/dma/dma-api.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/arch/sh/drivers/dma/dma-api.c b/arch/sh/drivers/dma/dma-api.c
> index 89cd4a3b4cca..65005d348877 100644
> --- a/arch/sh/drivers/dma/dma-api.c
> +++ b/arch/sh/drivers/dma/dma-api.c
> @@ -116,6 +116,7 @@ static int search_cap(const char **haystack, const char *needle)
>   * request_dma_bycap - Allocate a DMA channel based on its capabilities
>   * @dmac: List of DMA controllers to search
>   * @caps: List of capabilities
> + * @dev_id: Unique identifier for the device that is requesting a DMA channel
>   *
>   * Search all channels of all DMA controllers to find a channel which
>   * matches the requested capabilities. The result is the channel

Thanks. This should include "sh:" in the subject. I will add this manually
when picking up the patch. Also, the missing Fixes tag as Geert noted.

Reviewed-by: John Paul Adrian Glaubitz <glaubitz@physik.fu-berlin.de>

Adrian

-- 
 .''`.  John Paul Adrian Glaubitz
: :' :  Debian Developer
`. `'   Physicist
  `-    GPG: 62FF 8A75 84E0 2956 9546  0006 7426 3B37 F5B5 F913

Re: [PATCH -next] dma: Add dev_id parameter description in request_dma_bycap

[John Paul Adrian Glaubitz]

Hi Yang,

On Fri, 2024-04-19 at 17:02 +0800, Yang Li wrote:
> This patch adds the missing description for the dev_id parameter in the
> kernel documentation for the request_dma_bycap function.
> 
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
>  arch/sh/drivers/dma/dma-api.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/arch/sh/drivers/dma/dma-api.c b/arch/sh/drivers/dma/dma-api.c
> index 89cd4a3b4cca..65005d348877 100644
> --- a/arch/sh/drivers/dma/dma-api.c
> +++ b/arch/sh/drivers/dma/dma-api.c
> @@ -116,6 +116,7 @@ static int search_cap(const char **haystack, const char *needle)
>   * request_dma_bycap - Allocate a DMA channel based on its capabilities
>   * @dmac: List of DMA controllers to search
>   * @caps: List of capabilities
> + * @dev_id: Unique identifier for the device that is requesting a DMA channel
>   *
>   * Search all channels of all DMA controllers to find a channel which
>   * matches the requested capabilities. The result is the channel

This patch is now obsolete since search_cap() was removed in for-next by Geert
Uytterhoven in 89256d73 ("sh: dma: Remove unused functionality").

Thanks,
Adrian

-- 
 .''`.  John Paul Adrian Glaubitz
: :' :  Debian Developer
`. `'   Physicist
  `-    GPG: 62FF 8A75 84E0 2956 9546  0006 7426 3B37 F5B5 F913