Skip to contentSkip to conversation

dma: Add dev_id parameter description in request_dma_bycap

PATCH In review Yang Li 3 participants 4 messages Apr 19, 2024 – May 2, 2024 SuperH

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 dma: Add dev_id parameter description in request_dma_bycap

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

---
 arch/sh/drivers/dma/dma-api.c | 1 +
 1 file changed, 1 insertion(+)
arch/sh/drivers/dma/dma-api.c +1 -0
index 89cd4a3b4cca..65005d348877 100644
@@ -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
Signature · 1 line
2.20.1.7.g153144c
Reviewed-by on v1 1/1
#1 lore raw
Quoted 4 lines · Yang Li

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

Fixes db9b99d461ddbbaa ("sh: dma-api channel capability extensions.")

Gr{oetje,eeting}s,

Geert

Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

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
maintainer Reviewed-by on v1 1/1
#2 lore raw
In reply to Yang Li

Hi Yang,

Quoted 13 lines · Yang Li

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

---
 arch/sh/drivers/dma/dma-api.c | 1 +
 1 file changed, 1 insertion(+)
arch/sh/drivers/dma/dma-api.c +0 -0
index 89cd4a3b4cca..65005d348877 100644

arch/sh/drivers/dma/dma-api.c static int search_cap(const char **haystack, const char *needle) · line 122

Quoted 7 lines
arch/sh/drivers/dma/dma-api.c +1 -0
@@ -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.

Adrian

Signature · 4 lines
 .''`.  John Paul Adrian Glaubitz
: :' :  Debian Developer
`. `'   Physicist
  `-    GPG: 62FF 8A75 84E0 2956 9546  0006 7426 3B37 F5B5 F913
#3 lore raw
In reply to Yang Li

Hi Yang,

Quoted 13 lines · Yang Li

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

---
 arch/sh/drivers/dma/dma-api.c | 1 +
 1 file changed, 1 insertion(+)
arch/sh/drivers/dma/dma-api.c +0 -0
index 89cd4a3b4cca..65005d348877 100644

arch/sh/drivers/dma/dma-api.c static int search_cap(const char **haystack, const char *needle) · line 122

Quoted 7 lines
arch/sh/drivers/dma/dma-api.c +1 -0
@@ -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

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