diff mbox series

[v2,01/15] dmaengine: bcm2835: Fix several spellos

Message ID f57e15192166d696aca23804f8ac79dfe81fd399.1710226514.git.andrea.porta@suse.com (mailing list archive)
State Changes Requested
Headers show
Series dmaengine: bcm2835: add BCM2711 40-bit DMA support | expand

Commit Message

Andrea della Porta March 13, 2024, 2:08 p.m. UTC
Fixed Codespell reported warnings about spelling and coding convention
violations, among which there are also a couple potential operator
precedence issue in macroes.

Signed-off-by: Andrea della Porta <andrea.porta@suse.com>
---
 drivers/dma/bcm2835-dma.c | 96 +++++++++++++++++++--------------------
 1 file changed, 48 insertions(+), 48 deletions(-)

Comments

Florian Fainelli March 13, 2024, 3 p.m. UTC | #1
On 3/13/2024 7:08 AM, Andrea della Porta wrote:
> Fixed Codespell reported warnings about spelling and coding convention
> violations, among which there are also a couple potential operator
> precedence issue in macroes.
> 
> Signed-off-by: Andrea della Porta <andrea.porta@suse.com>

There are no spelling errors being fixed in this commit, this is purely 
stylistic and conforming to the Linux coding style guidelines.
Andrea della Porta March 13, 2024, 3:26 p.m. UTC | #2
On 08:00 Wed 13 Mar     , Florian Fainelli wrote:
> 
> 
> On 3/13/2024 7:08 AM, Andrea della Porta wrote:
> > Fixed Codespell reported warnings about spelling and coding convention
> > violations, among which there are also a couple potential operator
> > precedence issue in macroes.
> > 
> > Signed-off-by: Andrea della Porta <andrea.porta@suse.com>
> 
> There are no spelling errors being fixed in this commit, this is purely
> stylistic and conforming to the Linux coding style guidelines.

-	/* detect a size missmatch */
-	if (buf_len && (d->size != buf_len))
+	/* detect a size mismatch */
+	if (buf_len && d->size != buf_len)

Isn't 'missmatch' a spelling error? Maybe I can drop the word 'several', since it's
indeed only one...

> -- 
> Florian

Many thanks,
Andrea
Florian Fainelli March 13, 2024, 4:38 p.m. UTC | #3
On 3/13/24 08:26, Andrea della Porta wrote:
> On 08:00 Wed 13 Mar     , Florian Fainelli wrote:
>>
>>
>> On 3/13/2024 7:08 AM, Andrea della Porta wrote:
>>> Fixed Codespell reported warnings about spelling and coding convention
>>> violations, among which there are also a couple potential operator
>>> precedence issue in macroes.

and s/macroes/macros/

>>>
>>> Signed-off-by: Andrea della Porta <andrea.porta@suse.com>
>>
>> There are no spelling errors being fixed in this commit, this is purely
>> stylistic and conforming to the Linux coding style guidelines.
> 
> -	/* detect a size missmatch */
> -	if (buf_len && (d->size != buf_len))
> +	/* detect a size mismatch */
> +	if (buf_len && d->size != buf_len)
> 
> Isn't 'missmatch' a spelling error? Maybe I can drop the word 'several', since it's
> indeed only one...

Can we agree this was easy to miss when 99% of the changes are 
stylistic? The summary is that the commit subject and the message are 
not describing what this patch is about.
Andrea della Porta March 13, 2024, 4:49 p.m. UTC | #4
On 09:38 Wed 13 Mar     , Florian Fainelli wrote:
> On 3/13/24 08:26, Andrea della Porta wrote:
> > On 08:00 Wed 13 Mar     , Florian Fainelli wrote:
> > > 
> > > 
> > > On 3/13/2024 7:08 AM, Andrea della Porta wrote:
> > > > Fixed Codespell reported warnings about spelling and coding convention
> > > > violations, among which there are also a couple potential operator
> > > > precedence issue in macroes.
> 
> and s/macroes/macros/

right, sorry about that...

> 
> > > > 
> > > > Signed-off-by: Andrea della Porta <andrea.porta@suse.com>
> > > 
> > > There are no spelling errors being fixed in this commit, this is purely
> > > stylistic and conforming to the Linux coding style guidelines.
> > 
> > -	/* detect a size missmatch */
> > -	if (buf_len && (d->size != buf_len))
> > +	/* detect a size mismatch */
> > +	if (buf_len && d->size != buf_len)
> > 
> > Isn't 'missmatch' a spelling error? Maybe I can drop the word 'several', since it's
> > indeed only one...
> 
> Can we agree this was easy to miss when 99% of the changes are stylistic?
> The summary is that the commit subject and the message are not describing
> what this patch is about.
> -- 
> Florian
> 

I agree with you that I could've added '...and coding style fixes' to the subject
(while also dropping 'several').  The comment seems fine enough though. Maybe
you're suggesting to separate the patches into two, one dealing with spelling
errors and the other with coding conventions?

Many thanks,
Andrea
Florian Fainelli March 13, 2024, 5:14 p.m. UTC | #5
On 3/13/24 09:49, Andrea della Porta wrote:
> On 09:38 Wed 13 Mar     , Florian Fainelli wrote:
>> On 3/13/24 08:26, Andrea della Porta wrote:
>>> On 08:00 Wed 13 Mar     , Florian Fainelli wrote:
>>>>
>>>>
>>>> On 3/13/2024 7:08 AM, Andrea della Porta wrote:
>>>>> Fixed Codespell reported warnings about spelling and coding convention
>>>>> violations, among which there are also a couple potential operator
>>>>> precedence issue in macroes.
>>
>> and s/macroes/macros/
> 
> right, sorry about that...
> 
>>
>>>>>
>>>>> Signed-off-by: Andrea della Porta <andrea.porta@suse.com>
>>>>
>>>> There are no spelling errors being fixed in this commit, this is purely
>>>> stylistic and conforming to the Linux coding style guidelines.
>>>
>>> -	/* detect a size missmatch */
>>> -	if (buf_len && (d->size != buf_len))
>>> +	/* detect a size mismatch */
>>> +	if (buf_len && d->size != buf_len)
>>>
>>> Isn't 'missmatch' a spelling error? Maybe I can drop the word 'several', since it's
>>> indeed only one...
>>
>> Can we agree this was easy to miss when 99% of the changes are stylistic?
>> The summary is that the commit subject and the message are not describing
>> what this patch is about.
>> -- 
>> Florian
>>
> 
> I agree with you that I could've added '...and coding style fixes' to the subject
> (while also dropping 'several').  The comment seems fine enough though. Maybe
> you're suggesting to separate the patches into two, one dealing with spelling
> errors and the other with coding conventions?

What I am suggesting is to be somewhat accurate about what you do in 
your patch. If there are 99% stylistic issues, then say so, and in the 
commit subject, say: by the way, typographic errors are also fixed. Or 
any variation of that. Anyway, there are others things to be sorted 
about this patch series than this specific one, it just happened to be 
the first I looked at.
diff mbox series

Patch

diff --git a/drivers/dma/bcm2835-dma.c b/drivers/dma/bcm2835-dma.c
index 9d74fe97452e..428253b468ac 100644
--- a/drivers/dma/bcm2835-dma.c
+++ b/drivers/dma/bcm2835-dma.c
@@ -51,13 +51,13 @@  struct bcm2835_dmadev {
 };
 
 struct bcm2835_dma_cb {
-	uint32_t info;
-	uint32_t src;
-	uint32_t dst;
-	uint32_t length;
-	uint32_t stride;
-	uint32_t next;
-	uint32_t pad[2];
+	u32 info;
+	u32 src;
+	u32 dst;
+	u32 length;
+	u32 stride;
+	u32 next;
+	u32 pad[2];
 };
 
 struct bcm2835_cb_entry {
@@ -116,8 +116,8 @@  struct bcm2835_desc {
 					       * AXI-write to ack
 					       */
 #define BCM2835_DMA_ERR		BIT(8)
-#define BCM2835_DMA_PRIORITY(x) ((x & 15) << 16) /* AXI priority */
-#define BCM2835_DMA_PANIC_PRIORITY(x) ((x & 15) << 20) /* panic priority */
+#define BCM2835_DMA_PRIORITY(x) (((x) & 15) << 16) /* AXI priority */
+#define BCM2835_DMA_PANIC_PRIORITY(x) (((x) & 15) << 20) /* panic priority */
 /* current value of TI.BCM2835_DMA_WAIT_RESP */
 #define BCM2835_DMA_WAIT_FOR_WRITES BIT(28)
 #define BCM2835_DMA_DIS_DEBUG	BIT(29) /* disable debug pause signal */
@@ -136,9 +136,9 @@  struct bcm2835_desc {
 #define BCM2835_DMA_S_WIDTH	BIT(9) /* 128bit writes if set */
 #define BCM2835_DMA_S_DREQ	BIT(10) /* enable SREQ for source */
 #define BCM2835_DMA_S_IGNORE	BIT(11) /* ignore source reads - read 0 */
-#define BCM2835_DMA_BURST_LENGTH(x) ((x & 15) << 12)
-#define BCM2835_DMA_PER_MAP(x)	((x & 31) << 16) /* REQ source */
-#define BCM2835_DMA_WAIT(x)	((x & 31) << 21) /* add DMA-wait cycles */
+#define BCM2835_DMA_BURST_LENGTH(x) (((x) & 15) << 12)
+#define BCM2835_DMA_PER_MAP(x)	(((x) & 31) << 16) /* REQ source */
+#define BCM2835_DMA_WAIT(x)	(((x) & 31) << 21) /* add DMA-wait cycles */
 #define BCM2835_DMA_NO_WIDE_BURSTS BIT(26) /* no 2 beat write bursts */
 
 /* debug register bits */
@@ -214,17 +214,15 @@  static void bcm2835_dma_free_cb_chain(struct bcm2835_desc *desc)
 
 static void bcm2835_dma_desc_free(struct virt_dma_desc *vd)
 {
-	bcm2835_dma_free_cb_chain(
-		container_of(vd, struct bcm2835_desc, vd));
+	bcm2835_dma_free_cb_chain(container_of(vd, struct bcm2835_desc, vd));
 }
 
-static void bcm2835_dma_create_cb_set_length(
-	struct bcm2835_chan *chan,
-	struct bcm2835_dma_cb *control_block,
-	size_t len,
-	size_t period_len,
-	size_t *total_len,
-	u32 finalextrainfo)
+static void bcm2835_dma_create_cb_set_length(struct bcm2835_chan *chan,
+					     struct bcm2835_dma_cb *control_block,
+					     size_t len,
+					     size_t period_len,
+					     size_t *total_len,
+					     u32 finalextrainfo)
 {
 	size_t max_len = bcm2835_dma_max_frame_length(chan);
 
@@ -260,10 +258,9 @@  static void bcm2835_dma_create_cb_set_length(
 	control_block->info |= finalextrainfo;
 }
 
-static inline size_t bcm2835_dma_count_frames_for_sg(
-	struct bcm2835_chan *c,
-	struct scatterlist *sgl,
-	unsigned int sg_len)
+static inline size_t bcm2835_dma_count_frames_for_sg(struct bcm2835_chan *c,
+						     struct scatterlist *sgl,
+						     unsigned int sg_len)
 {
 	size_t frames = 0;
 	struct scatterlist *sgent;
@@ -271,8 +268,8 @@  static inline size_t bcm2835_dma_count_frames_for_sg(
 	size_t plength = bcm2835_dma_max_frame_length(c);
 
 	for_each_sg(sgl, sgent, sg_len, i)
-		frames += bcm2835_dma_frames_for_length(
-			sg_dma_len(sgent), plength);
+		frames += bcm2835_dma_frames_for_length(sg_dma_len(sgent),
+							plength);
 
 	return frames;
 }
@@ -298,10 +295,13 @@  static inline size_t bcm2835_dma_count_frames_for_sg(
  * @gfp:            the GFP flag to use for allocation
  */
 static struct bcm2835_desc *bcm2835_dma_create_cb_chain(
-	struct dma_chan *chan, enum dma_transfer_direction direction,
-	bool cyclic, u32 info, u32 finalextrainfo, size_t frames,
-	dma_addr_t src, dma_addr_t dst, size_t buf_len,
-	size_t period_len, gfp_t gfp)
+					struct dma_chan *chan,
+					enum dma_transfer_direction direction,
+					bool cyclic, u32 info,
+					u32 finalextrainfo,
+					size_t frames, dma_addr_t src,
+					dma_addr_t dst, size_t buf_len,
+					size_t period_len, gfp_t gfp)
 {
 	struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 	size_t len = buf_len, total_len;
@@ -343,10 +343,10 @@  static struct bcm2835_desc *bcm2835_dma_create_cb_chain(
 		/* set up length in control_block if requested */
 		if (buf_len) {
 			/* calculate length honoring period_length */
-			bcm2835_dma_create_cb_set_length(
-				c, control_block,
-				len, period_len, &total_len,
-				cyclic ? finalextrainfo : 0);
+			bcm2835_dma_create_cb_set_length(c, control_block,
+							 len, period_len,
+							 &total_len,
+							 cyclic ? finalextrainfo : 0);
 
 			/* calculate new remaining length */
 			len -= control_block->length;
@@ -369,8 +369,8 @@  static struct bcm2835_desc *bcm2835_dma_create_cb_chain(
 	/* the last frame requires extra flags */
 	d->cb_list[d->frames - 1].cb->info |= finalextrainfo;
 
-	/* detect a size missmatch */
-	if (buf_len && (d->size != buf_len))
+	/* detect a size mismatch */
+	if (buf_len && d->size != buf_len)
 		goto error_cb;
 
 	return d;
@@ -410,7 +410,7 @@  static void bcm2835_dma_fill_cb_chain_with_sg(
 static void bcm2835_dma_abort(struct bcm2835_chan *c)
 {
 	void __iomem *chan_base = c->chan_base;
-	long int timeout = 10000;
+	long timeout = 10000;
 
 	/*
 	 * A zero control block address means the channel is idle.
@@ -438,7 +438,6 @@  static void bcm2835_dma_abort(struct bcm2835_chan *c)
 static void bcm2835_dma_start_desc(struct bcm2835_chan *c)
 {
 	struct virt_dma_desc *vd = vchan_next_desc(&c->vc);
-	struct bcm2835_desc *d;
 
 	if (!vd) {
 		c->desc = NULL;
@@ -447,9 +446,9 @@  static void bcm2835_dma_start_desc(struct bcm2835_chan *c)
 
 	list_del(&vd->node);
 
-	c->desc = d = to_bcm2835_dma_desc(&vd->tx);
+	c->desc = to_bcm2835_dma_desc(&vd->tx);
 
-	writel(d->cb_list[0].paddr, c->chan_base + BCM2835_DMA_ADDR);
+	writel(c->desc->cb_list[0].paddr, c->chan_base + BCM2835_DMA_ADDR);
 	writel(BCM2835_DMA_ACTIVE, c->chan_base + BCM2835_DMA_CS);
 }
 
@@ -560,7 +559,8 @@  static size_t bcm2835_dma_desc_size_pos(struct bcm2835_desc *d, dma_addr_t addr)
 }
 
 static enum dma_status bcm2835_dma_tx_status(struct dma_chan *chan,
-	dma_cookie_t cookie, struct dma_tx_state *txstate)
+					     dma_cookie_t cookie,
+					     struct dma_tx_state *txstate)
 {
 	struct bcm2835_chan *c = to_bcm2835_dma_chan(chan);
 	struct virt_dma_desc *vd;
@@ -860,7 +860,7 @@  static const struct of_device_id bcm2835_dma_of_match[] = {
 MODULE_DEVICE_TABLE(of, bcm2835_dma_of_match);
 
 static struct dma_chan *bcm2835_dma_xlate(struct of_phandle_args *spec,
-					   struct of_dma *ofdma)
+					  struct of_dma *ofdma)
 {
 	struct bcm2835_dmadev *d = ofdma->of_dma_data;
 	struct dma_chan *chan;
@@ -883,7 +883,7 @@  static int bcm2835_dma_probe(struct platform_device *pdev)
 	int i, j;
 	int irq[BCM2835_DMA_MAX_DMA_CHAN_SUPPORTED + 1];
 	int irq_flags;
-	uint32_t chans_available;
+	u32 chans_available;
 	char chan_name[BCM2835_DMA_CHAN_NAME_SIZE];
 
 	if (!pdev->dev.dma_mask)
@@ -942,8 +942,8 @@  static int bcm2835_dma_probe(struct platform_device *pdev)
 
 	/* Request DMA channel mask from device tree */
 	if (of_property_read_u32(pdev->dev.of_node,
-			"brcm,dma-channel-mask",
-			&chans_available)) {
+				 "brcm,dma-channel-mask",
+				 &chans_available)) {
 		dev_err(&pdev->dev, "Failed to get channel mask\n");
 		rc = -EINVAL;
 		goto err_no_dma;
@@ -982,7 +982,7 @@  static int bcm2835_dma_probe(struct platform_device *pdev)
 		/* check if there are other channels that also use this irq */
 		irq_flags = 0;
 		for (j = 0; j <= BCM2835_DMA_MAX_DMA_CHAN_SUPPORTED; j++)
-			if ((i != j) && (irq[j] == irq[i])) {
+			if (i != j && irq[j] == irq[i]) {
 				irq_flags = IRQF_SHARED;
 				break;
 			}
@@ -997,7 +997,7 @@  static int bcm2835_dma_probe(struct platform_device *pdev)
 
 	/* Device-tree DMA controller registration */
 	rc = of_dma_controller_register(pdev->dev.of_node,
-			bcm2835_dma_xlate, od);
+					bcm2835_dma_xlate, od);
 	if (rc) {
 		dev_err(&pdev->dev, "Failed to register DMA controller\n");
 		goto err_no_dma;