[v2,3/6] phy: core: Fix that API devm_phy_destroy() fails to destroy the phy

Commit Message

Zijun Hu Oct. 24, 2024, 2:39 p.m. UTC

From: Zijun Hu <[e-mail]>

For devm_phy_destroy(), its comment says it needs to invoke phy_destroy()
to destroy the phy, but it does not invoke the function actually since
devres_destroy() will not call devm_phy_consume() at all which will call
the function, and the missing phy_destroy() call will case that the phy
fails to be destroyed.

Fixed by using devres_release() instead of devres_destroy() within the API.

Fixes: ff764963479a ("drivers: phy: add generic PHY framework")
Cc: [e-mail]
Signed-off-by: Zijun Hu <[e-mail]>
---
 drivers/phy/phy-core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Johan Hovold Oct. 29, 2024, 1:45 p.m. UTC | #1

On Thu, Oct 24, 2024 at 10:39:28PM +0800, Zijun Hu wrote:
> From: Zijun Hu <[e-mail]>
> 
> For devm_phy_destroy(), its comment says it needs to invoke phy_destroy()
> to destroy the phy, but it does not invoke the function actually since
> devres_destroy() will not call devm_phy_consume() at all which will call
> the function, and the missing phy_destroy() call will case that the phy
> fails to be destroyed.

Here too, split in at least two sentences.
 
> Fixed by using devres_release() instead of devres_destroy() within the API.

And add a comment about there not being any in-tree users of the
interface.

And consider dropping it.

> Fixes: ff764963479a ("drivers: phy: add generic PHY framework")
> Cc: [e-mail]
> Signed-off-by: Zijun Hu <[e-mail]>

Johan

Zijun Hu Oct. 29, 2024, 3:38 p.m. UTC | #2

On 2024/10/29 21:45, Johan Hovold wrote:
> On Thu, Oct 24, 2024 at 10:39:28PM +0800, Zijun Hu wrote:
>> From: Zijun Hu <[e-mail]>
>>
>> For devm_phy_destroy(), its comment says it needs to invoke phy_destroy()
>> to destroy the phy, but it does not invoke the function actually since
>> devres_destroy() will not call devm_phy_consume() at all which will call
>> the function, and the missing phy_destroy() call will case that the phy
>> fails to be destroyed.
> 
> Here too, split in at least two sentences.
> 

okay.
>> Fixed by using devres_release() instead of devres_destroy() within the API.
> 
> And add a comment about there not being any in-tree users of the
> interface.
>

okay, will do it within v2.
> And consider dropping it.

okay, will follow the same action as [PATCH 2/6]

> 
>> Fixes: ff764963479a ("drivers: phy: add generic PHY framework")
>> Cc: [e-mail]
>> Signed-off-by: Zijun Hu <[e-mail]>
> 
> Johan

Patch

diff --git a/drivers/phy/phy-core.c b/drivers/phy/phy-core.c
index de07e1616b34..52ca590a58b9 100644
--- a/drivers/phy/phy-core.c
+++ b/drivers/phy/phy-core.c
@@ -1121,7 +1121,7 @@  void devm_phy_destroy(struct device *dev, struct phy *phy)
 {
 	int r;
 
-	r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
+	r = devres_release(dev, devm_phy_consume, devm_phy_match, phy);
 	dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
 }
 EXPORT_SYMBOL_GPL(devm_phy_destroy);