[PATCH 0/2] dmaengine: xilinx_dma: minor documentation updates

[PATCH 0/2] dmaengine: xilinx_dma: minor documentation updates

[Radhey Shyam Pandey]

This patch series add missing kernel documentation for 
xilinx_dma_device_config() and also fix return doc
for xilinx_dma_child_probe().

Radhey Shyam Pandey (2):
  dmaengine: xilinx_dma: fix xilinx_dma_child_probe() return
    documentation
  dmaengine: xilinx_dma : add xilinx_dma_device_config() return
    documentation

 drivers/dma/xilinx/xilinx_dma.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

-- 
2.25.1

[PATCH 1/2] dmaengine: xilinx_dma: fix xilinx_dma_child_probe() return documentation

[Radhey Shyam Pandey]

Modify xilinx_dma_child_probe() return documentation to be inline
with implementation i.e. can also return failure value on error.

Fixes: f17e53388e82 ("dmaengine: xilinx: Handle IRQ mapping errors")
Signed-off-by: Radhey Shyam Pandey <radhey.shyam.pandey@amd.com>
---
 drivers/dma/xilinx/xilinx_dma.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/dma/xilinx/xilinx_dma.c b/drivers/dma/xilinx/xilinx_dma.c
index 8cd4e69dc7b4..3b8cfeccf2da 100644
--- a/drivers/dma/xilinx/xilinx_dma.c
+++ b/drivers/dma/xilinx/xilinx_dma.c
@@ -2924,7 +2924,7 @@ static int xilinx_dma_chan_probe(struct xilinx_dma_device *xdev,
  * @xdev: Driver specific device structure
  * @node: Device node
  *
- * Return: 0 always.
+ * Return: '0' on success and failure value on error.
  */
 static int xilinx_dma_child_probe(struct xilinx_dma_device *xdev,
 				    struct device_node *node)
-- 
2.25.1

[PATCH 2/2] dmaengine: xilinx_dma : add xilinx_dma_device_config() return documentation

[Radhey Shyam Pandey]

document xilinx_dma_device_config() return value. Fixes below
kernel-doc warning.

xilinx_dma.c:1665: warning: No description found for return value
of 'xilinx_dma_device_config'

Fixes: 4153a7f6440f ("dmaengine: xilinx: Add empty device_config function")
Signed-off-by: Radhey Shyam Pandey <radhey.shyam.pandey@amd.com>
---
 drivers/dma/xilinx/xilinx_dma.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/drivers/dma/xilinx/xilinx_dma.c b/drivers/dma/xilinx/xilinx_dma.c
index 3b8cfeccf2da..a8d23cdf883e 100644
--- a/drivers/dma/xilinx/xilinx_dma.c
+++ b/drivers/dma/xilinx/xilinx_dma.c
@@ -1659,6 +1659,8 @@ static void xilinx_dma_issue_pending(struct dma_chan *dchan)
  * xilinx_dma_device_config - Configure the DMA channel
  * @dchan: DMA channel
  * @config: channel configuration
+ *
+ * Return: 0 always.
  */
 static int xilinx_dma_device_config(struct dma_chan *dchan,
 				    struct dma_slave_config *config)
-- 
2.25.1

Re: [PATCH 0/2] dmaengine: xilinx_dma: minor documentation updates

[Vinod Koul]

On 25-10-22, 13:12, Radhey Shyam Pandey wrote:
> This patch series add missing kernel documentation for 
> xilinx_dma_device_config() and also fix return doc
> for xilinx_dma_child_probe().

Applied, thanks

-- 
~Vinod