i2c: tegra: Fix failure during probe deferral cleanup
PATCH v2 1/1 i2c: tegra: Fix failure during probe deferral cleanup
From: Thierry Reding <[email protected]>
If the driver fails to obtain a DMA channel, it will initiate cleanup and try to release the DMA channel that couldn't be retrieved. This will cause a crash because the cleanup will try to dereference an ERR_PTR()- encoded error code.
However, there's nothing to clean up at this point yet, so we can avoid this by simply resetting the DMA channel to NULL instead of storing the error code.
---
Changes in v2:
- simplify patch by setting dma_chan = NULL on channel request failure
drivers/i2c/busses/i2c-tegra.c | 1 + 1 file changed, 1 insertion(+)
drivers/i2c/busses/i2c-tegra.c +1 -0
@@ -460,6 +460,7 @@ static int tegra_i2c_init_dma(struct tegra_i2c_dev *i2c_dev) i2c_dev->dma_chan =dma_request_chan (i2c_dev->dev,"tx" );if (IS_ERR (i2c_dev->dma_chan)) { err =PTR_ERR (i2c_dev->dma_chan); + i2c_dev->dma_chan =NULL ; goto err_out; }
Signature · 1 line
2.41.0
Quoted 5 lines
If the driver fails to obtain a DMA channel, it will initiate cleanup and try to release the DMA channel that couldn't be retrieved. This will cause a crash because the cleanup will try to dereference an ERR_PTR()- encoded error code.
Quoted 7 lines
However, there's nothing to clean up at this point yet, so we can avoid this by simply resetting the DMA channel to NULL instead of storing the error code.
Fixes fcc8a89a1c83 ("i2c: tegra: Share same DMA channel for RX andTX")
Signed-off-by Thierry Reding mailto:[email protected]
This fixed the crash issue seen when there is no dmas property in the device tree.
Resending this with the correct headers to get it recorded by patchwork.
Quoted 11 lines · Thierry Reding
From: Thierry Reding <[email protected]>
If the driver fails to obtain a DMA channel, it will initiate cleanup and try to release the DMA channel that couldn't be retrieved. This will cause a crash because the cleanup will try to dereference an ERR_PTR()- encoded error code.
However, there's nothing to clean up at this point yet, so we can avoid this by simply resetting the DMA channel to NULL instead of storing the error code.
Quoted 8 lines
Fixes fcc8a89a1c83 ("i2c: tegra: Share same DMA channel for RX and TX")Signed-off-by Thierry Reding <[email protected]>---
Changes in v2:
- simplify patch by settingdma_chan= NULL on channel request failuredrivers/i2c/busses/i2c-tegra.c | 1 + 1 file changed, 1 insertion(+)
Hi Andy, Wolfram,
do you have any reservations about this? This fixes a bug that was introduced in v6.5-rc1, so it'd be great if this could make v6.5.
Thanks,
Thierry
Quoted 16 lines
drivers/i2c/busses/i2c-tegra.c +1
-0@@ -460,6 +460,7 @@ static int tegra_i2c_init_dma(struct tegra_i2c_dev *i2c_dev) i2c_dev->dma_chan =dma_request_chan (i2c_dev->dev,"tx" );if (IS_ERR (i2c_dev->dma_chan)) { err =PTR_ERR (i2c_dev->dma_chan); + i2c_dev->dma_chan =NULL ; goto err_out; }Signature · 1 line
2.41.0
Andi Shyti
maintainerHi Thierry,
Quoted 6 lines · Thierry Reding
From: Thierry Reding <[email protected]>
If the driver fails to obtain a DMA channel, it will initiate cleanup and try to release the DMA channel that couldn't be retrieved. This will cause a crash because the cleanup will try to dereference an ERR_PTR()- encoded error code.
while this is a valid solution I think the best thing here is to clear the exit path by adding another goto label.
By setting dma_chan = NULL you would go through some extra checks that are not needed.
I guess that by doing this we could even remove the
if (i2c_dev->dma_buf) if (i2c_dev->dma_chan)
in tegra_i2c_release_dma(). However you see it cleaner. I'm not going to be picky, though. Let me know if you are up for some more clean up, otherwise I can give you an r-b... after a little clarification...
Quoted 5 lines
However, there's nothing to clean up at this point yet, so we can avoid this by simply resetting the DMA channel to NULL instead of storing the error code.
Fixes fcc8a89a1c83 ("i2c: tegra: Share same DMA channel for RX and TX")
... is this the correct commit that is getting fixed? I think it's this one:
Thanks,
Andi
Quoted 23 lines
Signed-off-by Thierry Reding <[email protected]>---
Changes in v2:
- simplify patch by settingdma_chan= NULL on channel request failuredrivers/i2c/busses/i2c-tegra.c | 1 + 1 file changed, 1 insertion(+)drivers/i2c/busses/i2c-tegra.c +1
-0@@ -460,6 +460,7 @@ static int tegra_i2c_init_dma(struct tegra_i2c_dev *i2c_dev) i2c_dev->dma_chan =dma_request_chan (i2c_dev->dev,"tx" );if (IS_ERR (i2c_dev->dma_chan)) { err =PTR_ERR (i2c_dev->dma_chan); + i2c_dev->dma_chan =NULL ; goto err_out; }Signature · 1 line
2.41.0
Quoted 18 lines · Andi Shyti
Hi Thierry,
Quoted 6 lines · Thierry Reding
From: Thierry Reding <[email protected]>
If the driver fails to obtain a DMA channel, it will initiate cleanup and try to release the DMA channel that couldn't be retrieved. This will cause a crash because the cleanup will try to dereference an ERR_PTR()- encoded error code.
while this is a valid solution I think the best thing here is to clear the exit path by adding another goto label.
By setting
dma_chan= NULL you would go through some extra checks that are not needed.I guess that by doing this we could even remove the
Quoted 7 lines
if (i2c_dev->dma_buf) if (i2c_dev->dma_chan)in
tegra_i2c_release_dma(). However you see it cleaner. I'm not going to be picky, though. Let me know if you are up for some more clean up, otherwise I can give you an r-b... after a little clarification...
The problem is that DMA support is optional, so we will typically succeed probe even when the DMA channel cannot be retrieved. The tegra_i2c_release_dma() is going to get called in any case and if we were to remove those checks, it would try and release a NULL buffer and a NULL channel for the non-DMA case.
That's also the reason why we set dma_chan = NULL rather than use an error label. We could technically skip tegra_i2c_release_dma() when we fail to get the channel, but we do want to run it when we fail to allocate the DMA buffer. So that would mean we end up with two different cleanup paths rather than just one. So overall the cleanup is simpler if we treat both code paths the same.
Quoted 11 lines
Quoted 5 lines
However, there's nothing to clean up at this point yet, so we can avoid this by simply resetting the DMA channel to NULL instead of storing the error code.
Fixes fcc8a89a1c83 ("i2c: tegra: Share same DMA channel for RX and TX")... is this the correct commit that is getting fixed? I think it's this one:
Fixes 86c92b9965ff ("i2c: tegra: Add DMA support")Cc <[email protected]> # v5.1+
The original DMA support patch didn't have this issue because it was storing the DMA channel (or error code) in a local variable first and only assigned it to the i2c_dev->{rx,tx}_dma_channel fields after checking for errors. Hence, those fields would never end up with an error code and therefore this wasn't causing any issues previously.
I hope that answers all your questions.
Thanks,
Thierry
Hi Thierry,
Quoted 27 lines
Quoted 13 lines
Quoted 4 lines
If the driver fails to obtain a DMA channel, it will initiate cleanup and try to release the DMA channel that couldn't be retrieved. This will cause a crash because the cleanup will try to dereference an ERR_PTR()- encoded error code.
while this is a valid solution I think the best thing here is to clear the exit path by adding another goto label.
By setting
dma_chan= NULL you would go through some extra checks that are not needed.I guess that by doing this we could even remove the
Quoted 7 lines
if (i2c_dev->dma_buf) if (i2c_dev->dma_chan)in
tegra_i2c_release_dma(). However you see it cleaner. I'm not going to be picky, though. Let me know if you are up for some more clean up, otherwise I can give you an r-b... after a little clarification...The problem is that DMA support is optional, so we will typically succeed probe even when the DMA channel cannot be retrieved. The
tegra_i2c_release_dma()is going to get called in any case and if we were to remove those checks, it would try and release a NULL buffer and a NULL channel for the non-DMA case.
Quoted 6 lines
That's also the reason why we set
dma_chan= NULL rather than use an error label. We could technically skiptegra_i2c_release_dma()when we fail to get the channel, but we do want to run it when we fail to allocate the DMA buffer. So that would mean we end up with two different cleanup paths rather than just one. So overall the cleanup is simpler if we treat both code paths the same.
that's indeed an easy one-liner fix... that's why I proposed my r-b in the earlier mail.
Quoted 9 lines
Quoted 9 lines
Quoted 5 lines
However, there's nothing to clean up at this point yet, so we can avoid this by simply resetting the DMA channel to NULL instead of storing the error code.
Fixes fcc8a89a1c83 ("i2c: tegra: Share same DMA channel for RX and TX")... is this the correct commit that is getting fixed? I think it's this one:
Quoted 8 lines
Quoted 2 lines
Fixes 86c92b9965ff ("i2c: tegra: Add DMA support")Cc <[email protected]> # v5.1+The original DMA support patch didn't have this issue because it was storing the DMA channel (or error code) in a local variable first and only assigned it to the i2c_dev->{rx,tx}_dma_channel fields after checking for errors. Hence, those fields would never end up with an error code and therefore this wasn't causing any issues previously.
Yes, you are right! the patch commit you mentioned is actually releasing the channel by checking i2c_dev->dma_chan which might store the error number and therefore is not NULL.
Thanks for the clarification!
Andi
Quoted 4 lines
I hope that answers all your questions.
Thanks,
Thierry
Wolfram Sang
AppliedQuoted 7 lines · Thierry Reding
From: Thierry Reding <[email protected]>
If the driver fails to obtain a DMA channel, it will initiate cleanup and try to release the DMA channel that couldn't be retrieved. This will cause a crash because the cleanup will try to dereference an ERR_PTR()- encoded error code.
Quoted 6 lines
However, there's nothing to clean up at this point yet, so we can avoid this by simply resetting the DMA channel to NULL instead of storing the error code.
Fixes fcc8a89a1c83 ("i2c: tegra: Share same DMA channel for RX and TX")Signed-off-by Thierry Reding <[email protected]>
Applied to for-current, thanks!