Skip to contentSkip to conversation

net: lantiq_etop: check the result of request_irq()

PATCH In review Masahiro Yamada 4 participants 7 messages Dec 21, 2020

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 net: lantiq_etop: check the result of request_irq()

The declaration of request_irq() in <linux/interrupt.h> is marked as __must_check.

Without the return value check, I see the following warnings:

drivers/net/ethernet/lantiq_etop.c: In function 'ltq_etop_hw_init':
drivers/net/ethernet/lantiq_etop.c:273:4: warning: ignoring return value of 'request_irq', declared with attribute warn_unused_result [-Wunused-result] 273 |    request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
      |    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
drivers/net/ethernet/lantiq_etop.c:281:4: warning: ignoring return value of 'request_irq', declared with attribute warn_unused_result [-Wunused-result] 281 |    request_irq(irq, ltq_etop_dma_irq, 0, "etop_rx", priv);
      |    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

---

 drivers/net/ethernet/lantiq_etop.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
drivers/net/ethernet/lantiq_etop.c +11 -2
index 2d0c52f7106b..960494f9752b 100644
@@ -264,13 +264,18 @@ ltq_etop_hw_init(struct net_device *dev)
 	for (i = 0; i < MAX_DMA_CHAN; i++) {
 		int irq = LTQ_DMA_CH0_INT + i;
 		struct ltq_etop_chan *ch = &priv->ch[i];
+		int ret;
 
 		ch->idx = ch->dma.nr = i;
 		ch->dma.dev = &priv->pdev->dev;
 
 		if (IS_TX(i)) {
 			ltq_dma_alloc_tx(&ch->dma);
-			request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
+			ret = request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
+			if (ret) {
+				netdev_err(dev, "failed to request irq\n");
+				return ret;
+			}
 		} else if (IS_RX(i)) {
 			ltq_dma_alloc_rx(&ch->dma);
 			for (ch->dma.desc = 0; ch->dma.desc < LTQ_DESC_NUM;
@@ -278,7 +283,11 @@ ltq_etop_hw_init(struct net_device *dev)
 				if (ltq_etop_alloc_skb(ch))
 					return -ENOMEM;
 			ch->dma.desc = 0;
-			request_irq(irq, ltq_etop_dma_irq, 0, "etop_rx", priv);
+			ret = request_irq(irq, ltq_etop_dma_irq, 0, "etop_rx", priv);
+			if (ret) {
+				netdev_err(dev, "failed to request irq\n");
+				return ret;
+			}
 		}
 		ch->dma.irq = irq;
 	}
Signature · 1 line
2.27.0
#1 lore raw
Quoted 30 lines · Masahiro Yamada

The declaration of request_irq() in <linux/interrupt.h> is marked as __must_check.

Without the return value check, I see the following warnings:

drivers/net/ethernet/lantiq_etop.c: In function 'ltq_etop_hw_init':
drivers/net/ethernet/lantiq_etop.c:273:4: warning: ignoring return value of 'request_irq', declared with attribute warn_unused_result [-Wunused-result] 273 |    request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
      |    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
drivers/net/ethernet/lantiq_etop.c:281:4: warning: ignoring return value of 'request_irq', declared with attribute warn_unused_result [-Wunused-result] 281 |    request_irq(irq, ltq_etop_dma_irq, 0, "etop_rx", priv);
      |    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

---

 drivers/net/ethernet/lantiq_etop.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
drivers/net/ethernet/lantiq_etop.c +1 -0
index 2d0c52f7106b..960494f9752b 100644
@@ -264,13 +264,18 @@ ltq_etop_hw_init(struct net_device *dev)
 	for (i = 0; i < MAX_DMA_CHAN; i++) {
 		int irq = LTQ_DMA_CH0_INT + i;
 		struct ltq_etop_chan *ch = &priv->ch[i];
+		int ret;
 

drivers/net/ethernet/lantiq_etop.c ltq_etop_hw_init(struct net_device *dev) · line 277

Quoted 10 lines
drivers/net/ethernet/lantiq_etop.c +4 -1
 		ch->idx = ch->dma.nr = i;
 		ch->dma.dev = &priv->pdev->dev;
 
 		if (IS_TX(i)) {
 			ltq_dma_alloc_tx(&ch->dma);
-			request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
+			ret = request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
+			if (ret) {
+				netdev_err(dev, "failed to request irq\n");
+				return ret;

You need to cleanup what ltq_dma_alloc_tx() did.

drivers/net/ethernet/lantiq_etop.c ltq_etop_hw_init(struct net_device *dev) · line 289

Quoted 13 lines
drivers/net/ethernet/lantiq_etop.c +5 -1
+			}
 		} else if (IS_RX(i)) {
 			ltq_dma_alloc_rx(&ch->dma);
 			for (ch->dma.desc = 0; ch->dma.desc < LTQ_DESC_NUM;
@@ -278,7 +283,11 @@ ltq_etop_hw_init(struct net_device *dev)
 				if (ltq_etop_alloc_skb(ch))
 					return -ENOMEM;
 			ch->dma.desc = 0;
-			request_irq(irq, ltq_etop_dma_irq, 0, "etop_rx", priv);
+			ret = request_irq(irq, ltq_etop_dma_irq, 0, "etop_rx", priv);
+			if (ret) {
+				netdev_err(dev, "failed to request irq\n");
+				return ret;

And here you need to cleanup ltq_dma_alloc_rx().

Andrew

#2 lore raw
Quoted 35 lines · Andrew Lunn
Quoted 33 lines · Masahiro Yamada

The declaration of request_irq() in <linux/interrupt.h> is marked as __must_check.

Without the return value check, I see the following warnings:

drivers/net/ethernet/lantiq_etop.c: In function 'ltq_etop_hw_init':
drivers/net/ethernet/lantiq_etop.c:273:4: warning: ignoring return value of 'request_irq', declared with attribute warn_unused_result [-Wunused-result]

  273 |    request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
      |    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
drivers/net/ethernet/lantiq_etop.c:281:4: warning: ignoring return value of 'request_irq', declared with attribute warn_unused_result [-Wunused-result]
  281 |    request_irq(irq, ltq_etop_dma_irq, 0, "etop_rx", priv);
      |    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

---

 drivers/net/ethernet/lantiq_etop.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
drivers/net/ethernet/lantiq_etop.c +1 -0
index 2d0c52f7106b..960494f9752b 100644
@@ -264,13 +264,18 @@ ltq_etop_hw_init(struct net_device *dev)
      for (i = 0; i < MAX_DMA_CHAN; i++) {
              int irq = LTQ_DMA_CH0_INT + i;
              struct ltq_etop_chan *ch = &priv->ch[i];
+             int ret;
 
              ch->idx = ch->dma.nr = i;
              ch->dma.dev = &priv->pdev->dev;
 
Quoted 9 lines

drivers/net/ethernet/lantiq_etop.c ltq_etop_hw_init(struct net_device *dev) · line 277

Quoted 7 lines
drivers/net/ethernet/lantiq_etop.c +4 -1
              if (IS_TX(i)) {
                      ltq_dma_alloc_tx(&ch->dma);
-                     request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
+                     ret = request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
+                     if (ret) {
+                             netdev_err(dev, "failed to request irq\n");
+                             return ret;

You need to cleanup what ltq_dma_alloc_tx() did.

Any failure from this function will roll back
in the following paths:

ltq_etop_hw_exit()

     -> ltq_etop_free_channel()
          -> ltq_dma_free()

So, dma is freed anyway.

One problem I see is,
ltq_etop_hw_exit() frees all DMA channels,
some of which may not have been allocated yet.

If it is a bug, it is an existing bug.

Quoted 8 lines

drivers/net/ethernet/lantiq_etop.c ltq_etop_hw_init(struct net_device *dev) · line 284

Quoted 8 lines
drivers/net/ethernet/lantiq_etop.c +1 -0
+                     }
              } else if (IS_RX(i)) {
                      ltq_dma_alloc_rx(&ch->dma);
                      for (ch->dma.desc = 0; ch->dma.desc < LTQ_DESC_NUM;
@@ -278,7 +283,11 @@ ltq_etop_hw_init(struct net_device *dev)
                              if (ltq_etop_alloc_skb(ch))
                                      return -ENOMEM;

This -ENOMEM does not roll back anything here.

As stated above, dma_free_coherent() is called. The problem is, ltq_etop_hw_exit() rolls back too much.

If your requirement is "this driver is completely wrong. Please rewrite it", sorry, I cannot (unless I am paid to do so).

I am just following this driver's roll-back model.

Please do not expect more to a person who
volunteers to eliminate build warnings.

Of course, if somebody volunteers to rewrite this driver correctly, that is appreciated.

Quoted 10 lines

drivers/net/ethernet/lantiq_etop.c ltq_etop_hw_init(struct net_device *dev) · line 289

Quoted 6 lines
drivers/net/ethernet/lantiq_etop.c +4 -1
                      ch->dma.desc = 0;
-                     request_irq(irq, ltq_etop_dma_irq, 0, "etop_rx", priv);
+                     ret = request_irq(irq, ltq_etop_dma_irq, 0, "etop_rx", priv);
+                     if (ret) {
+                             netdev_err(dev, "failed to request irq\n");
+                             return ret;

And here you need to cleanup ltq_dma_alloc_rx().

Andrew

Signature · 2 lines
Best Regards
Masahiro Yamada
#3 lore raw
Quoted 50 lines · Masahiro Yamada
Quoted 35 lines · Andrew Lunn
Quoted 33 lines · Masahiro Yamada

The declaration of request_irq() in <linux/interrupt.h> is marked as __must_check.

Without the return value check, I see the following warnings:

drivers/net/ethernet/lantiq_etop.c: In function 'ltq_etop_hw_init':
drivers/net/ethernet/lantiq_etop.c:273:4: warning: ignoring return value of 'request_irq', declared with attribute warn_unused_result [-Wunused-result]

  273 |    request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
      |    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
drivers/net/ethernet/lantiq_etop.c:281:4: warning: ignoring return value of 'request_irq', declared with attribute warn_unused_result [-Wunused-result]
  281 |    request_irq(irq, ltq_etop_dma_irq, 0, "etop_rx", priv);
      |    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

---

 drivers/net/ethernet/lantiq_etop.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
drivers/net/ethernet/lantiq_etop.c +1 -0
index 2d0c52f7106b..960494f9752b 100644
@@ -264,13 +264,18 @@ ltq_etop_hw_init(struct net_device *dev)
      for (i = 0; i < MAX_DMA_CHAN; i++) {
              int irq = LTQ_DMA_CH0_INT + i;
              struct ltq_etop_chan *ch = &priv->ch[i];
+             int ret;
 
              ch->idx = ch->dma.nr = i;
              ch->dma.dev = &priv->pdev->dev;
 
Quoted 9 lines

drivers/net/ethernet/lantiq_etop.c ltq_etop_hw_init(struct net_device *dev) · line 277

Quoted 7 lines
drivers/net/ethernet/lantiq_etop.c +4 -1
              if (IS_TX(i)) {
                      ltq_dma_alloc_tx(&ch->dma);
-                     request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
+                     ret = request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
+                     if (ret) {
+                             netdev_err(dev, "failed to request irq\n");
+                             return ret;

You need to cleanup what ltq_dma_alloc_tx() did.

Any failure from this function will roll back
in the following paths:

Quoted 6 lines

ltq_etop_hw_exit()

     -> ltq_etop_free_channel()
          -> ltq_dma_free()

So, dma is freed anyway.

O.K, thanks for the information.

Quoted 22 lines

One problem I see is,
ltq_etop_hw_exit() frees all DMA channels,
some of which may not have been allocated yet.

If it is a bug, it is an existing bug.

Quoted 8 lines

drivers/net/ethernet/lantiq_etop.c ltq_etop_hw_init(struct net_device *dev) · line 284

Quoted 8 lines
drivers/net/ethernet/lantiq_etop.c +1 -0
+                     }
              } else if (IS_RX(i)) {
                      ltq_dma_alloc_rx(&ch->dma);
                      for (ch->dma.desc = 0; ch->dma.desc < LTQ_DESC_NUM;
@@ -278,7 +283,11 @@ ltq_etop_hw_init(struct net_device *dev)
                              if (ltq_etop_alloc_skb(ch))
                                      return -ENOMEM;

This -ENOMEM does not roll back anything here.

As stated above, dma_free_coherent() is called. The problem is, ltq_etop_hw_exit() rolls back too much.

Quoted 7 lines

If your requirement is "this driver is completely wrong. Please rewrite it", sorry, I cannot (unless I am paid to do so).

I am just following this driver's roll-back model.

Please do not expect more to a person who
volunteers to eliminate build warnings.

There is a balance here. We should not remove a warning unless we properly fix the warning. Otherwise having the warning is pointless.

So please leave the warning in place, and maybe somebody else will fully fix it.

Andrew

#4 lore raw
Quoted 3 lines · Andrew Lunn

So please leave the warning in place, and maybe somebody else will fully fix it.

For context: the plan is to enable the warning unconditionally starting with 5.11. After that, the idea is making it an error as soon as reasonable (e.g. 5.12 if no warnings remain by then).

However, if there is nobody planning to fix a given warning, then I'd say documenting the problem with a FIXME comment (plus a change like this or simply ignoring the return value) would be the best approach.

Cheers,
Miguel

#5 lore raw
In reply to Masahiro Yamada
Quoted 82 lines · Masahiro Yamada
Quoted 35 lines · Andrew Lunn
Quoted 33 lines · Masahiro Yamada

The declaration of request_irq() in <linux/interrupt.h> is marked as __must_check.

Without the return value check, I see the following warnings:

drivers/net/ethernet/lantiq_etop.c: In function 'ltq_etop_hw_init':
drivers/net/ethernet/lantiq_etop.c:273:4: warning: ignoring return value of 'request_irq', declared with attribute warn_unused_result [-Wunused-result]

  273 |    request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
      |    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
drivers/net/ethernet/lantiq_etop.c:281:4: warning: ignoring return value of 'request_irq', declared with attribute warn_unused_result [-Wunused-result]
  281 |    request_irq(irq, ltq_etop_dma_irq, 0, "etop_rx", priv);
      |    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

---

 drivers/net/ethernet/lantiq_etop.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
drivers/net/ethernet/lantiq_etop.c +1 -0
index 2d0c52f7106b..960494f9752b 100644
@@ -264,13 +264,18 @@ ltq_etop_hw_init(struct net_device *dev)
      for (i = 0; i < MAX_DMA_CHAN; i++) {
              int irq = LTQ_DMA_CH0_INT + i;
              struct ltq_etop_chan *ch = &priv->ch[i];
+             int ret;
 
              ch->idx = ch->dma.nr = i;
              ch->dma.dev = &priv->pdev->dev;
 
Quoted 9 lines

drivers/net/ethernet/lantiq_etop.c ltq_etop_hw_init(struct net_device *dev) · line 277

Quoted 7 lines
drivers/net/ethernet/lantiq_etop.c +4 -1
              if (IS_TX(i)) {
                      ltq_dma_alloc_tx(&ch->dma);
-                     request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
+                     ret = request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
+                     if (ret) {
+                             netdev_err(dev, "failed to request irq\n");
+                             return ret;

You need to cleanup what ltq_dma_alloc_tx() did.

Any failure from this function will roll back
in the following paths:

ltq_etop_hw_exit()

     -> ltq_etop_free_channel()
          -> ltq_dma_free()

So, dma is freed anyway.

One problem I see is,
ltq_etop_hw_exit() frees all DMA channels,
some of which may not have been allocated yet.

If it is a bug, it is an existing bug.

Quoted 8 lines

drivers/net/ethernet/lantiq_etop.c ltq_etop_hw_init(struct net_device *dev) · line 284

Quoted 8 lines
drivers/net/ethernet/lantiq_etop.c +1 -0
+                     }
              } else if (IS_RX(i)) {
                      ltq_dma_alloc_rx(&ch->dma);
                      for (ch->dma.desc = 0; ch->dma.desc < LTQ_DESC_NUM;
@@ -278,7 +283,11 @@ ltq_etop_hw_init(struct net_device *dev)
                              if (ltq_etop_alloc_skb(ch))
                                      return -ENOMEM;

This -ENOMEM does not roll back anything here.

As stated above, dma_free_coherent() is called. The problem is, ltq_etop_hw_exit() rolls back too much.

If your requirement is "this driver is completely wrong. Please rewrite it", sorry, I cannot (unless I am paid to do so).

Quoted 7 lines

I am just following this driver's roll-back model.

Please do not expect more to a person who
volunteers to eliminate build warnings.

Of course, if somebody volunteers to rewrite this driver correctly, that is appreciated.

Hi Hauke

Do you still have this hardware? Do you have time to take a look at the cleanup code?

Thanks
Andrew

#6 lore raw
Quoted 91 lines · Andrew Lunn
Quoted 82 lines · Masahiro Yamada
Quoted 35 lines · Andrew Lunn
Quoted 33 lines · Masahiro Yamada

The declaration of request_irq() in <linux/interrupt.h> is marked as __must_check.

Without the return value check, I see the following warnings:

drivers/net/ethernet/lantiq_etop.c: In function 'ltq_etop_hw_init':
drivers/net/ethernet/lantiq_etop.c:273:4: warning: ignoring return value of 'request_irq', declared with attribute warn_unused_result [-Wunused-result]

   273 |    request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
       |    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
drivers/net/ethernet/lantiq_etop.c:281:4: warning: ignoring return value of 'request_irq', declared with attribute warn_unused_result [-Wunused-result]
   281 |    request_irq(irq, ltq_etop_dma_irq, 0, "etop_rx", priv);
       |    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

---

  drivers/net/ethernet/lantiq_etop.c | 13 +++++++++++--
  1 file changed, 11 insertions(+), 2 deletions(-)
drivers/net/ethernet/lantiq_etop.c +1 -0
index 2d0c52f7106b..960494f9752b 100644
@@ -264,13 +264,18 @@ ltq_etop_hw_init(struct net_device *dev)
       for (i = 0; i < MAX_DMA_CHAN; i++) {
               int irq = LTQ_DMA_CH0_INT + i;
               struct ltq_etop_chan *ch = &priv->ch[i];
+             int ret;
 
               ch->idx = ch->dma.nr = i;
               ch->dma.dev = &priv->pdev->dev;
 
Quoted 9 lines

drivers/net/ethernet/lantiq_etop.c ltq_etop_hw_init(struct net_device *dev) · line 277

Quoted 7 lines
drivers/net/ethernet/lantiq_etop.c +4 -1
               if (IS_TX(i)) {
                       ltq_dma_alloc_tx(&ch->dma);
-                     request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
+                     ret = request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
+                     if (ret) {
+                             netdev_err(dev, "failed to request irq\n");
+                             return ret;

You need to cleanup what ltq_dma_alloc_tx() did.

Any failure from this function will roll back
in the following paths:

   ltq_etop_hw_exit()
      -> ltq_etop_free_channel()
           -> ltq_dma_free()

So, dma is freed anyway.

One problem I see is,
ltq_etop_hw_exit() frees all DMA channels,
some of which may not have been allocated yet.

If it is a bug, it is an existing bug.

Quoted 8 lines

drivers/net/ethernet/lantiq_etop.c ltq_etop_hw_init(struct net_device *dev) · line 284

Quoted 8 lines
drivers/net/ethernet/lantiq_etop.c +1 -0
+                     }
               } else if (IS_RX(i)) {
                       ltq_dma_alloc_rx(&ch->dma);
                       for (ch->dma.desc = 0; ch->dma.desc < LTQ_DESC_NUM;
@@ -278,7 +283,11 @@ ltq_etop_hw_init(struct net_device *dev)
                               if (ltq_etop_alloc_skb(ch))
                                       return -ENOMEM;

This -ENOMEM does not roll back anything here.

As stated above, dma_free_coherent() is called. The problem is, ltq_etop_hw_exit() rolls back too much.

If your requirement is "this driver is completely wrong. Please rewrite it", sorry, I cannot (unless I am paid to do so).

Quoted 7 lines

I am just following this driver's roll-back model.

Please do not expect more to a person who
volunteers to eliminate build warnings.

Of course, if somebody volunteers to rewrite this driver correctly, that is appreciated.

Quoted 8 lines

Hi Hauke

Do you still have this hardware? Do you have time to take a look at the cleanup code?

Thanks
Andrew

Hi Andrew,

I have this hardware somewhere at home, but I never made it work. If I find some time I can have a loom at this problem in the next few weeks.

Hauke