Use devm_of_iomap() instead of of_iomap() to automatically
handle the unused ioremap region. If any error occurs, regions allocated by
kzalloc() will leak, but using devm_kzalloc() instead will automatically
free the memory using devm_kfree().
Also, fix error handling of hws by adding unregister_hws label, which
unregisters remaining hws when iomap failed.
Fixes: 7154b046d8f3 ("clk: imx: Add initial support for i.MXRT1050 clock driver")
Signed-off-by: Kai Ma <[email protected]>
---
The issue is found by static analysis and remains untested.
---
drivers/clk/imx/clk-imxrt1050.c | 22 +++++++++++++++-------
1 file changed, 15 insertions(+), 7 deletions(-)
diff --git a/drivers/clk/imx/clk-imxrt1050.c b/drivers/clk/imx/clk-imxrt1050.c
index fd5c51fc92c0..08d155feb035 100644
--- a/drivers/clk/imx/clk-imxrt1050.c
+++ b/drivers/clk/imx/clk-imxrt1050.c
@@ -42,7 +42,7 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
struct device_node *anp;
int ret;
- clk_hw_data = kzalloc(struct_size(clk_hw_data, hws,
+ clk_hw_data = devm_kzalloc(dev, struct_size(clk_hw_data, hws,
IMXRT1050_CLK_END), GFP_KERNEL);
if (WARN_ON(!clk_hw_data))
return -ENOMEM;
@@ -53,10 +53,12 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
hws[IMXRT1050_CLK_OSC] = imx_get_clk_hw_by_name(np, "osc");
anp = of_find_compatible_node(NULL, NULL, "fsl,imxrt-anatop");
- pll_base = of_iomap(anp, 0);
+ pll_base = devm_of_iomap(dev, anp, 0, NULL);
of_node_put(anp);
- if (WARN_ON(!pll_base))
- return -ENOMEM;
+ if (WARN_ON(IS_ERR(pll_base))) {
+ ret = PTR_ERR(pll_base);
+ goto unregister_hws;
+ }
/* Anatop clocks */
hws[IMXRT1050_CLK_DUMMY] = imx_clk_hw_fixed("dummy", 0UL);
@@ -104,8 +106,10 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
/* CCM clocks */
ccm_base = devm_platform_ioremap_resource(pdev, 0);
- if (WARN_ON(IS_ERR(ccm_base)))
- return PTR_ERR(ccm_base);
+ if (WARN_ON(IS_ERR(ccm_base))) {
+ ret = PTR_ERR(ccm_base);
+ goto unregister_hws;
+ }
hws[IMXRT1050_CLK_ARM_PODF] = imx_clk_hw_divider("arm_podf", "pll1_arm", ccm_base + 0x10, 0, 3);
hws[IMXRT1050_CLK_PRE_PERIPH_SEL] = imx_clk_hw_mux("pre_periph_sel", ccm_base + 0x18, 18, 2,
@@ -149,8 +153,12 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
ret = of_clk_add_hw_provider(np, of_clk_hw_onecell_get, clk_hw_data);
if (ret < 0) {
dev_err(dev, "Failed to register clks for i.MXRT1050.\n");
- imx_unregister_hw_clocks(hws, IMXRT1050_CLK_END);
+ goto unregister_hws;
}
+ return 0;
+
+unregister_hws:
+ imx_unregister_hw_clocks(hws, IMXRT1050_CLK_END);
return ret;
}
static const struct of_device_id imxrt1050_clk_of_match[] = {
--
2.34.1
On 4/18/23 07:34, Kai Ma wrote:
> Use devm_of_iomap() instead of of_iomap() to automatically
> handle the unused ioremap region. If any error occurs, regions allocated by
> kzalloc() will leak, but using devm_kzalloc() instead will automatically
> free the memory using devm_kfree().
>
> Also, fix error handling of hws by adding unregister_hws label, which
> unregisters remaining hws when iomap failed.
>
> Fixes: 7154b046d8f3 ("clk: imx: Add initial support for i.MXRT1050 clock driver")
> Signed-off-by: Kai Ma <[email protected]>
> ---
> The issue is found by static analysis and remains untested.
> ---
> drivers/clk/imx/clk-imxrt1050.c | 22 +++++++++++++++-------
> 1 file changed, 15 insertions(+), 7 deletions(-)
>
> diff --git a/drivers/clk/imx/clk-imxrt1050.c b/drivers/clk/imx/clk-imxrt1050.c
> index fd5c51fc92c0..08d155feb035 100644
> --- a/drivers/clk/imx/clk-imxrt1050.c
> +++ b/drivers/clk/imx/clk-imxrt1050.c
> @@ -42,7 +42,7 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
> struct device_node *anp;
> int ret;
>
> - clk_hw_data = kzalloc(struct_size(clk_hw_data, hws,
> + clk_hw_data = devm_kzalloc(dev, struct_size(clk_hw_data, hws,
> IMXRT1050_CLK_END), GFP_KERNEL);
> if (WARN_ON(!clk_hw_data))
> return -ENOMEM;
> @@ -53,10 +53,12 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
> hws[IMXRT1050_CLK_OSC] = imx_get_clk_hw_by_name(np, "osc");
>
> anp = of_find_compatible_node(NULL, NULL, "fsl,imxrt-anatop");
> - pll_base = of_iomap(anp, 0);
> + pll_base = devm_of_iomap(dev, anp, 0, NULL);
> of_node_put(anp);
> - if (WARN_ON(!pll_base))
> - return -ENOMEM;
> + if (WARN_ON(IS_ERR(pll_base))) {
> + ret = PTR_ERR(pll_base);
> + goto unregister_hws;
> + }
>
> /* Anatop clocks */
> hws[IMXRT1050_CLK_DUMMY] = imx_clk_hw_fixed("dummy", 0UL);
> @@ -104,8 +106,10 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
>
> /* CCM clocks */
> ccm_base = devm_platform_ioremap_resource(pdev, 0);
> - if (WARN_ON(IS_ERR(ccm_base)))
> - return PTR_ERR(ccm_base);
> + if (WARN_ON(IS_ERR(ccm_base))) {
> + ret = PTR_ERR(ccm_base);
> + goto unregister_hws;
> + }
>
> hws[IMXRT1050_CLK_ARM_PODF] = imx_clk_hw_divider("arm_podf", "pll1_arm", ccm_base + 0x10, 0, 3);
> hws[IMXRT1050_CLK_PRE_PERIPH_SEL] = imx_clk_hw_mux("pre_periph_sel", ccm_base + 0x18, 18, 2,
> @@ -149,8 +153,12 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
> ret = of_clk_add_hw_provider(np, of_clk_hw_onecell_get, clk_hw_data);
> if (ret < 0) {
> dev_err(dev, "Failed to register clks for i.MXRT1050.\n");
> - imx_unregister_hw_clocks(hws, IMXRT1050_CLK_END);
> + goto unregister_hws;
> }
> + return 0;
> +
> +unregister_hws:
> + imx_unregister_hw_clocks(hws, IMXRT1050_CLK_END);
> return ret;
> }
> static const struct of_device_id imxrt1050_clk_of_match[] = {
Looks good! The fix seems to be similar to how clk-imx8mn.c does this.
Acked-by: Jesse Taube <[email protected]>
A similar issue seems to also be in drivers/clk/imx/clk-imx8mm.c,clk-imx93.c,clk-imx8mp.c.
Sorry for recreating the issue :(.
Thanks,
Jesse Taube
On 4/18/2023 7:34 PM, Kai Ma wrote:
> Use devm_of_iomap() instead of of_iomap() to automatically
> handle the unused ioremap region. If any error occurs, regions allocated by
> kzalloc() will leak, but using devm_kzalloc() instead will automatically
> free the memory using devm_kfree().
>
> Also, fix error handling of hws by adding unregister_hws label, which
> unregisters remaining hws when iomap failed.
>
> Fixes: 7154b046d8f3 ("clk: imx: Add initial support for i.MXRT1050 clock driver")
> Signed-off-by: Kai Ma <[email protected]>
Reviewed-by: Peng Fan <[email protected]>
> ---
> The issue is found by static analysis and remains untested.
> ---
> drivers/clk/imx/clk-imxrt1050.c | 22 +++++++++++++++-------
> 1 file changed, 15 insertions(+), 7 deletions(-)
>
> diff --git a/drivers/clk/imx/clk-imxrt1050.c b/drivers/clk/imx/clk-imxrt1050.c
> index fd5c51fc92c0..08d155feb035 100644
> --- a/drivers/clk/imx/clk-imxrt1050.c
> +++ b/drivers/clk/imx/clk-imxrt1050.c
> @@ -42,7 +42,7 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
> struct device_node *anp;
> int ret;
>
> - clk_hw_data = kzalloc(struct_size(clk_hw_data, hws,
> + clk_hw_data = devm_kzalloc(dev, struct_size(clk_hw_data, hws,
> IMXRT1050_CLK_END), GFP_KERNEL);
> if (WARN_ON(!clk_hw_data))
> return -ENOMEM;
> @@ -53,10 +53,12 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
> hws[IMXRT1050_CLK_OSC] = imx_get_clk_hw_by_name(np, "osc");
>
> anp = of_find_compatible_node(NULL, NULL, "fsl,imxrt-anatop");
> - pll_base = of_iomap(anp, 0);
> + pll_base = devm_of_iomap(dev, anp, 0, NULL);
> of_node_put(anp);
> - if (WARN_ON(!pll_base))
> - return -ENOMEM;
> + if (WARN_ON(IS_ERR(pll_base))) {
> + ret = PTR_ERR(pll_base);
> + goto unregister_hws;
> + }
>
> /* Anatop clocks */
> hws[IMXRT1050_CLK_DUMMY] = imx_clk_hw_fixed("dummy", 0UL);
> @@ -104,8 +106,10 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
>
> /* CCM clocks */
> ccm_base = devm_platform_ioremap_resource(pdev, 0);
> - if (WARN_ON(IS_ERR(ccm_base)))
> - return PTR_ERR(ccm_base);
> + if (WARN_ON(IS_ERR(ccm_base))) {
> + ret = PTR_ERR(ccm_base);
> + goto unregister_hws;
> + }
>
> hws[IMXRT1050_CLK_ARM_PODF] = imx_clk_hw_divider("arm_podf", "pll1_arm", ccm_base + 0x10, 0, 3);
> hws[IMXRT1050_CLK_PRE_PERIPH_SEL] = imx_clk_hw_mux("pre_periph_sel", ccm_base + 0x18, 18, 2,
> @@ -149,8 +153,12 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
> ret = of_clk_add_hw_provider(np, of_clk_hw_onecell_get, clk_hw_data);
> if (ret < 0) {
> dev_err(dev, "Failed to register clks for i.MXRT1050.\n");
> - imx_unregister_hw_clocks(hws, IMXRT1050_CLK_END);
> + goto unregister_hws;
> }
> + return 0;
> +
> +unregister_hws:
> + imx_unregister_hw_clocks(hws, IMXRT1050_CLK_END);
> return ret;
> }
> static const struct of_device_id imxrt1050_clk_of_match[] = {
On 23-04-18 11:34:51, Kai Ma wrote:
> Use devm_of_iomap() instead of of_iomap() to automatically
> handle the unused ioremap region. If any error occurs, regions allocated by
> kzalloc() will leak, but using devm_kzalloc() instead will automatically
> free the memory using devm_kfree().
>
> Also, fix error handling of hws by adding unregister_hws label, which
> unregisters remaining hws when iomap failed.
>
> Fixes: 7154b046d8f3 ("clk: imx: Add initial support for i.MXRT1050 clock driver")
> Signed-off-by: Kai Ma <[email protected]>
Reviewed-by: Abel Vesa <[email protected]>
Stephen, can you apply this through clk-fixes?
> ---
> The issue is found by static analysis and remains untested.
> ---
> drivers/clk/imx/clk-imxrt1050.c | 22 +++++++++++++++-------
> 1 file changed, 15 insertions(+), 7 deletions(-)
>
> diff --git a/drivers/clk/imx/clk-imxrt1050.c b/drivers/clk/imx/clk-imxrt1050.c
> index fd5c51fc92c0..08d155feb035 100644
> --- a/drivers/clk/imx/clk-imxrt1050.c
> +++ b/drivers/clk/imx/clk-imxrt1050.c
> @@ -42,7 +42,7 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
> struct device_node *anp;
> int ret;
>
> - clk_hw_data = kzalloc(struct_size(clk_hw_data, hws,
> + clk_hw_data = devm_kzalloc(dev, struct_size(clk_hw_data, hws,
> IMXRT1050_CLK_END), GFP_KERNEL);
> if (WARN_ON(!clk_hw_data))
> return -ENOMEM;
> @@ -53,10 +53,12 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
> hws[IMXRT1050_CLK_OSC] = imx_get_clk_hw_by_name(np, "osc");
>
> anp = of_find_compatible_node(NULL, NULL, "fsl,imxrt-anatop");
> - pll_base = of_iomap(anp, 0);
> + pll_base = devm_of_iomap(dev, anp, 0, NULL);
> of_node_put(anp);
> - if (WARN_ON(!pll_base))
> - return -ENOMEM;
> + if (WARN_ON(IS_ERR(pll_base))) {
> + ret = PTR_ERR(pll_base);
> + goto unregister_hws;
> + }
>
> /* Anatop clocks */
> hws[IMXRT1050_CLK_DUMMY] = imx_clk_hw_fixed("dummy", 0UL);
> @@ -104,8 +106,10 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
>
> /* CCM clocks */
> ccm_base = devm_platform_ioremap_resource(pdev, 0);
> - if (WARN_ON(IS_ERR(ccm_base)))
> - return PTR_ERR(ccm_base);
> + if (WARN_ON(IS_ERR(ccm_base))) {
> + ret = PTR_ERR(ccm_base);
> + goto unregister_hws;
> + }
>
> hws[IMXRT1050_CLK_ARM_PODF] = imx_clk_hw_divider("arm_podf", "pll1_arm", ccm_base + 0x10, 0, 3);
> hws[IMXRT1050_CLK_PRE_PERIPH_SEL] = imx_clk_hw_mux("pre_periph_sel", ccm_base + 0x18, 18, 2,
> @@ -149,8 +153,12 @@ static int imxrt1050_clocks_probe(struct platform_device *pdev)
> ret = of_clk_add_hw_provider(np, of_clk_hw_onecell_get, clk_hw_data);
> if (ret < 0) {
> dev_err(dev, "Failed to register clks for i.MXRT1050.\n");
> - imx_unregister_hw_clocks(hws, IMXRT1050_CLK_END);
> + goto unregister_hws;
> }
> + return 0;
> +
> +unregister_hws:
> + imx_unregister_hw_clocks(hws, IMXRT1050_CLK_END);
> return ret;
> }
> static const struct of_device_id imxrt1050_clk_of_match[] = {
> --
> 2.34.1
>
On Thursday, May 18, 2023 6:34:38 PM CST Abel Vesa wrote:
> On 23-04-18 11:34:51, Kai Ma wrote:
> > Use devm_of_iomap() instead of of_iomap() to automatically
> > handle the unused ioremap region. If any error occurs, regions allocated by
> > kzalloc() will leak, but using devm_kzalloc() instead will automatically
> > free the memory using devm_kfree().
> >
> > Also, fix error handling of hws by adding unregister_hws label, which
> > unregisters remaining hws when iomap failed.
> >
> > Fixes: 7154b046d8f3 ("clk: imx: Add initial support for i.MXRT1050 clock driver")
> > Signed-off-by: Kai Ma <[email protected]>
>
> Reviewed-by: Abel Vesa <[email protected]>
>
> Stephen, can you apply this through clk-fixes?
>
Thanks for your review, I am glad to let you know that I am a student at a
university and we collaborate to contribute to the Linux kernel. Here we
have some similar patches for clk. Could you please take care of them?
[1] https://lore.kernel.org/linux-arm-kernel/DU0PR04MB9417B63DE97D4A2A77B4176C88969@DU0PR04MB9417.eurprd04.prod.outlook.com/T/
[2] https://lore.kernel.org/linux-arm-kernel/[email protected]/T/
[3] https://lore.kernel.org/linux-arm-kernel/[email protected]/
[4] https://lore.kernel.org/linux-arm-kernel/[email protected]/
Thank you very much!
Regards,
Kai Ma
On Mon, May 29, 2023 at 12:55 AM Kai Ma <[email protected]> wrote:
>
> On Thursday, May 18, 2023 6:34:38 PM CST Abel Vesa wrote:
> > On 23-04-18 11:34:51, Kai Ma wrote:
> > > Use devm_of_iomap() instead of of_iomap() to automatically
> > > handle the unused ioremap region. If any error occurs, regions allocated by
> > > kzalloc() will leak, but using devm_kzalloc() instead will automatically
> > > free the memory using devm_kfree().
> > >
> > > Also, fix error handling of hws by adding unregister_hws label, which
> > > unregisters remaining hws when iomap failed.
> > >
> > > Fixes: 7154b046d8f3 ("clk: imx: Add initial support for i.MXRT1050 clock driver")
> > > Signed-off-by: Kai Ma <[email protected]>
> >
> > Reviewed-by: Abel Vesa <[email protected]>
> >
> > Stephen, can you apply this through clk-fixes?
> >
>
> Thanks for your review, I am glad to let you know that I am a student at a
> university and we collaborate to contribute to the Linux kernel.
That's cool, I am too!
Is there going to be a V2 of
https://lore.kernel.org/linux-arm-kernel/[email protected]/T/
Thanks,
Jesse Taube
> Here we
> have some similar patches for clk. Could you please take care of them?
>
> [1] https://lore.kernel.org/linux-arm-kernel/DU0PR04MB9417B63DE97D4A2A77B4176C88969@DU0PR04MB9417.eurprd04.prod.outlook.com/T/
> [2] https://lore.kernel.org/linux-arm-kernel/[email protected]/T/
> [3] https://lore.kernel.org/linux-arm-kernel/[email protected]/
> [4] https://lore.kernel.org/linux-arm-kernel/[email protected]/
>
> Thank you very much!
>
> Regards,
> Kai Ma
On Tue, 18 Apr 2023 11:34:51 +0000, Kai Ma wrote:
> Use devm_of_iomap() instead of of_iomap() to automatically
> handle the unused ioremap region. If any error occurs, regions allocated by
> kzalloc() will leak, but using devm_kzalloc() instead will automatically
> free the memory using devm_kfree().
>
> Also, fix error handling of hws by adding unregister_hws label, which
> unregisters remaining hws when iomap failed.
>
> [...]
Applied, thanks!
[1/1] clk: imx: clk-imxrt1050: fix memory leak in imxrt1050_clocks_probe
commit: 1b280598ab3bd8a2dc8b96a12530d5b1ee7a8f4a
Best regards,
--
Abel Vesa <[email protected]>