dmaengine: dw-axi-dmac: Coding style cleanups

This series contains a patches that fix minor coding style issues in the Synopsys DesignWare AXI DMA Controller platform driver. This adjustment possibilities were detected with the help of the analysis tool “checkpatch.pl".

These changes are purely cosmetic:
- Adjust indentation of function arguments and debug messages
- Remove an unnecessary return; statement
- Add a blank line for readability between functions

These updates improve code readability and maintain consistency with kernel coding style guidelines. No functional changes are introduced.

---
Notes:
This patch series is applied on dmaengine maintainer's tree
https://git.kernel.org/pub/scm/linux/kernel/git/vkoul/dmaengine.git/log/?h=next

Changes in v7:
- Refine summary on every patches in the series.
Changes in v6:
- Refine commit message on the patches.
Changes in v5:
- Refine the commit message of each patch to mention the use of checkpatch.pl analysis tool for the fix.
Changes in v4:
- Improve the description on every patch.
- Mentioned the commit the patches addressed.
Changes in v3:
- Split into smaller patches based on warning type
Changes in v2:
- Rebase on top of newer merge commit
v1:
https://lore.kernel.org/all/[email protected]/
---
Subject: [PATCH 0/3] *** SUBJECT HERE ***

*** BLURB HERE ***

Khairul Anuar Romli (3):
dmaengine: dw-axi-dmac: fix Alignment should match open parenthesis
dmaengine: dw-axi-dmac: Add blank line after function
dmaengine: dw-axi-dmac: Remove unnecessary return statement from void
function

 drivers/dma/dw-axi-dmac/dw-axi-dmac-platform.c | 17 ++++++++---------
 1 file changed, 8 insertions(+), 9 deletions(-)

2.43.0

checkpatch.pl --strict reports a CHECK warning in dw-axi-dmac-platform.c:

CHECK: Alignment should match open parenthesis

This warning occurs when multi-line function calls or expressions have continuation lines that don't properly align with the opening parenthesis position.

This patch fixes all instances in dw-axi-dmac-platform.c where continuation lines were indented with an inconsistent number of spaces/tabs that neither matched the parenthesis column nor followed a standard indent pattern. Proper alignment improves code readability and maintainability by making parameter lists visually consistent across the kernel codebase.

---
v6 -> v7:
- Add more details in the commit message.
- Moves the fixes from v6 to Fixes:
- Remove quote.

Reference to v6:
https://lore.kernel.org/all/[email protected]/
Reference to v1:
https://lore.kernel.org/all/[email protected]/

---
 drivers/dma/dw-axi-dmac/dw-axi-dmac-platform.c | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

index 493c2a32b0fe..8bb97fb8fd4c 100644
@@ -342,8 +342,8 @@ static void axi_desc_put(struct axi_dma_desc *desc)
 	kfree(desc);
 	atomic_sub(descs_put, &chan->descs_allocated);
 	dev_vdbg(chan2dev(chan), "%s: %d descs put, %d still allocated\n",
-		axi_chan_name(chan), descs_put,
-		atomic_read(&chan->descs_allocated));
+		 axi_chan_name(chan), descs_put,
+		 atomic_read(&chan->descs_allocated));
 }
 
 static void vchan_desc_put(struct virt_dma_desc *vdesc)

@@ -353,7 +353,7 @@ static void vchan_desc_put(struct virt_dma_desc *vdesc)
 
 static enum dma_status
 dma_chan_tx_status(struct dma_chan *dchan, dma_cookie_t cookie,
-		  struct dma_tx_state *txstate)
+		   struct dma_tx_state *txstate)
 {
 	struct axi_dma_chan *chan = dchan_to_axi_dma_chan(dchan);
 	struct virt_dma_desc *vdesc;

@@ -491,7 +491,7 @@ static void axi_chan_start_first_queued(struct axi_dma_chan *chan)
 
 	desc = vd_to_axi_desc(vd);
 	dev_vdbg(chan2dev(chan), "%s: started %u\n", axi_chan_name(chan),
-		vd->tx.cookie);
+		 vd->tx.cookie);
 	axi_chan_block_xfer_start(chan, desc);
 }
 

@@ -1162,7 +1162,7 @@ static irqreturn_t dw_axi_dma_interrupt(int irq, void *dev_id)
 		axi_chan_irq_clear(chan, status);
 
 		dev_vdbg(chip->dev, "%s %u IRQ status: 0x%08x\n",
-			axi_chan_name(chan), i, status);
+			 axi_chan_name(chan), i, status);
 
 		if (status & DWAXIDMAC_IRQ_ALL_ERR)
 			axi_chan_handle_err(chan, status);

@@ -1451,7 +1451,7 @@ static int axi_req_irqs(struct platform_device *pdev, struct axi_dma_chip *chip)
 		if (chip->irq[i] < 0)
 			return chip->irq[i];
 		ret = devm_request_irq(chip->dev, chip->irq[i], dw_axi_dma_interrupt,
-				IRQF_SHARED, KBUILD_MODNAME, chip);
+				       IRQF_SHARED, KBUILD_MODNAME, chip);
 		if (ret < 0)
 			return ret;
 	}

@@ -1645,7 +1645,7 @@ static void dw_remove(struct platform_device *pdev)
 	of_dma_controller_free(chip->dev->of_node);
 
 	list_for_each_entry_safe(chan, _chan, &dw->dma.channels,
-			vc.chan.device_node) {
+				 vc.chan.device_node) {
 		list_del(&chan->vc.chan.device_node);
 		tasklet_kill(&chan->vc.task);
 	}

2.43.0

…> This patch fixes …

See also once more:
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst?h=v6.19-rc8#n94

Did anything hinder you to use imperative mood for improved change descriptions?

Regards,
Markus

Sorry, I will use imperative mood as suggested by the submitting patches documentation in the next revision on all the patches in the series.

Thanks for pointing this out.

Regards,
Khairul

checkpatch.pl reports a CHECK warning in dw-axi-dmac-platform.c:

CHECK: Please use a blank line after function/struct/union/enum declarations drivers/dma/dw-axi-dmac/dw-axi-dmac-platform.c:

The Linux kernel coding style [Documentation/process/coding-style.rst] requires a blank line after function definitions to provide visual separation between distinct code elements.

This patch inserts the required blank line after the closing brace of the function definition after dw_axi_dma_set_byte_halfword(), placing it before the contextual comment that describes the locking requirements.

---
v6 -> v7:
- Refine the details that was not included in v6.
- Add Fixes that was not mentioned earlier.

Reference to v6:
https://lore.kernel.org/all/[email protected]/

---
 drivers/dma/dw-axi-dmac/dw-axi-dmac-platform.c | 1 +
 1 file changed, 1 insertion(+)

index 8bb97fb8fd4c..e59725376f8e 100644
@@ -419,6 +419,7 @@ static void dw_axi_dma_set_byte_halfword(struct axi_dma_chan *chan, bool set)
 
 	iowrite32(val, chan->chip->apb_regs + offset);
 }
+
 /* Called in chan locked context */
 static void axi_chan_block_xfer_start(struct axi_dma_chan *chan,
 				      struct axi_dma_desc *first)

2.43.0

checkpatch.pl --strict reports a WARNING in dw-axi-dmac-platform.c:

WARNING: void function return statements are not generally useful
FILE: drivers/dma/dw-axi-dmac/dw-axi-dmac-platform.c

According to Linux kernel coding style [Documentation/process/ coding-style.rst], explicit "return;" statements at the end of void functions are redundant and should be omitted. The function will automatically return upon reaching the closing brace, so the extra statement adds unnecessary clutter without functional benefit.

This patch removes the superfluous "return;" statement in dw_axi_dma_set_hw_channel() to comply with kernel coding standards and eliminate the checkpatch warning.

---
v6 -> v7:
- Make slightly adjustment to the commit title to reflect exactly to what the patch is address.
- Refine the details in the patch summary.
- Move the commit that the patch try to fix to Fixes.

Reference to v6:
https://lore.kernel.org/all/[email protected]/

---
 drivers/dma/dw-axi-dmac/dw-axi-dmac-platform.c | 2 --
 1 file changed, 2 deletions(-)

index e59725376f8e..c124ac6c8df6 100644
@@ -593,8 +593,6 @@ static void dw_axi_dma_set_hw_channel(struct axi_dma_chan *chan, bool set)
 			(chan->id * DMA_APB_HS_SEL_BIT_SIZE));
 	reg_value |= (val << (chan->id * DMA_APB_HS_SEL_BIT_SIZE));
 	lo_hi_writeq(reg_value, chip->apb_regs + DMAC_APB_HW_HS_SEL_0);
-
-	return;
 }
 
 /*

2.43.0

Did you move any related information into better patches?

…

Why were such questionable data sent “accidentally”?

Regards,
Markus

Applied, thanks!

[1/3] dmaengine: dw-axi-dmac: fix Alignment should match open parenthesis

      commit: 6c5883a9ba296d2797437066592d15b2d202de7a
[2/3] dmaengine: dw-axi-dmac: Add blank line after function
      commit: a1adb6de361be08352badb45cce3214b8cd6abed
[3/3] dmaengine: dw-axi-dmac: Remove unnecessary return statement from void function
      commit: 704eb9b17a6178b01b20e16ff8d36337bd90e429

Best regards,

~Vinod

Hi Vinod,

Thanks for applying to patch to the next branch. Really appreciate it. Sorry for not able to improve it with refine description as I was not had a chance to look at the code for last few weeks.

Thank You so much.

Best Regards,
Khairul