[PATCH v4 1/6] phy: core: Fix that API devm_phy_put() fails to release the phy

[Johan Hovold]

On Sat, Nov 02, 2024 at 11:53:43AM +0800, Zijun Hu wrote:
> From: Zijun Hu <quic_zijuhu at quicinc.com>
> 
> For devm_phy_put(), its comment says it needs to invoke phy_put() to
> release the phy, but it will not actually invoke the function since
> devres_destroy() does not call devm_phy_release(), and the missing
> phy_put() call will cause:

I still think the above should have been split in two sentences, but
this also works.

> - The phy fails to be released.
> - devm_phy_put() can not fully undo what API devm_phy_get() does.
> - Leak refcount of both the module and device for below typical usage:
> 
>   devm_phy_get(); // or its variant
>   ...
>   err = do_something();
>   if (err)
>       goto err_out;
>   ...
>   err_out:
>   devm_phy_put(); // leak refcount here
> 
>   The file(s) affected by this issue are shown below since they have such
>   typical usage.
>   drivers/pci/controller/cadence/pcie-cadence.c
>   drivers/net/ethernet/ti/am65-cpsw-nuss.c
> 
> Fixed by using devres_release() instead of devres_destroy() within the API.

Nit: in the future, try to use imperative mood in your commit messages
(e.g. "fix" instead of "fixed") as the process documentation suggests.

> Fixes: ff764963479a ("drivers: phy: add generic PHY framework")
> Cc: stable at vger.kernel.org
> Cc: Lorenzo Pieralisi <lpieralisi at kernel.org>
> Cc: "Krzysztof Wilczyński" <kw at linux.com>
> Cc: Bjorn Helgaas <bhelgaas at google.com>
> Cc: "David S. Miller" <davem at davemloft.net>
> Cc: Eric Dumazet <edumazet at google.com>
> Cc: Jakub Kicinski <kuba at kernel.org>
> Cc: Paolo Abeni <pabeni at redhat.com>
> Cc: Johan Hovold <johan at kernel.org>
> Signed-off-by: Zijun Hu <quic_zijuhu at quicinc.com>

Reviewed-by: Johan Hovold <johan+linaro at kernel.org>