Skip to contentSkip to conversation

ASoC: sgtl5000: Use devm_ functions

PATCH In review Himangi Saraogi 5 participants 12 messages Jul 6, 2014 – Jul 9, 2014

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

PATCH 1/1 ASoC: sgtl5000: Use devm_ functions

This patch introduces the use of managed interfaces like devm_kzalloc, devm_kstrdup and devm_regulator_register and does avay with the calls to the functions to free the allocated memory in ldo_regulator_register and ldo_regulator_remove. The ldo_regulator_remove function is completely removed as it is no longer required. ldo_regulator_register is called from a probe function and on failure its value is returned as the result.

---
To send to: Liam Girdwood <[email protected]>,Mark Brown <[email protected]>,Jaroslav Kysela <[email protected]>,Takashi Iwai <[email protected]>,[email protected],[email protected]

 sound/soc/codecs/sgtl5000.c | 46 +++++++--------------------------------------
 1 file changed, 7 insertions(+), 39 deletions(-)
sound/soc/codecs/sgtl5000.c +7 -39
index 249fadb..0efd6d6 100644
@@ -841,14 +841,15 @@ static int ldo_regulator_register(struct snd_soc_codec *codec,
 	struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
 	struct regulator_config config = { };
 
-	ldo = kzalloc(sizeof(struct ldo_regulator), GFP_KERNEL);
+	ldo = devm_kzalloc(codec->dev, sizeof(struct ldo_regulator),
+			   GFP_KERNEL);
 
 	if (!ldo)
 		return -ENOMEM;
 
-	ldo->desc.name = kstrdup(dev_name(codec->dev), GFP_KERNEL);
+	ldo->desc.name = devm_kstrdup(codec->dev, dev_name(codec->dev),
+				      GFP_KERNEL);
 	if (!ldo->desc.name) {
-		kfree(ldo);
 		dev_err(codec->dev, "failed to allocate decs name memory\n");
 		return -ENOMEM;
 	}
@@ -865,35 +866,17 @@ static int ldo_regulator_register(struct snd_soc_codec *codec,
 	config.driver_data = ldo;
 	config.init_data = init_data;
 
-	ldo->dev = regulator_register(&ldo->desc, &config);
+	ldo->dev = devm_regulator_register(codec->dev, &ldo->desc, &config);
 	if (IS_ERR(ldo->dev)) {
 		int ret = PTR_ERR(ldo->dev);
 
 		dev_err(codec->dev, "failed to register regulator\n");
-		kfree(ldo->desc.name);
-		kfree(ldo);
-
 		return ret;
 	}
 	sgtl5000->ldo = ldo;
 
 	return 0;
 }
-
-static int ldo_regulator_remove(struct snd_soc_codec *codec)
-{
-	struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
-	struct ldo_regulator *ldo = sgtl5000->ldo;
-
-	if (!ldo)
-		return 0;
-
-	regulator_unregister(ldo->dev);
-	kfree(ldo->desc.name);
-	kfree(ldo);
-
-	return 0;
-}
 #else
 static int ldo_regulator_register(struct snd_soc_codec *codec,
 				struct regulator_init_data *init_data,
@@ -902,11 +885,6 @@ static int ldo_regulator_register(struct snd_soc_codec *codec,
 	dev_err(codec->dev, "this setup needs regulator support in the kernel\n");
 	return -EINVAL;
 }
-
-static int ldo_regulator_remove(struct snd_soc_codec *codec)
-{
-	return 0;
-}
 #endif
 
 /*
@@ -1278,23 +1256,17 @@ static int sgtl5000_enable_regulators(struct snd_soc_codec *codec)
 	ret = devm_regulator_bulk_get(codec->dev, ARRAY_SIZE(sgtl5000->supplies),
 				 sgtl5000->supplies);
 	if (ret)
-		goto err_ldo_remove;
+		return ret;
 
 	ret = regulator_bulk_enable(ARRAY_SIZE(sgtl5000->supplies),
 					sgtl5000->supplies);
 	if (ret)
-		goto err_ldo_remove;
+		return ret;
 
 	/* wait for all power rails bring up */
 	udelay(10);
 
 	return 0;
-
-err_ldo_remove:
-	if (!external_vddd)
-		ldo_regulator_remove(codec);
-	return ret;
-
 }
 
 static int sgtl5000_probe(struct snd_soc_codec *codec)
@@ -1359,8 +1331,6 @@ static int sgtl5000_probe(struct snd_soc_codec *codec)
 err:
 	regulator_bulk_disable(ARRAY_SIZE(sgtl5000->supplies),
 						sgtl5000->supplies);
-	ldo_regulator_remove(codec);
-
 	return ret;
 }
 
@@ -1372,8 +1342,6 @@ static int sgtl5000_remove(struct snd_soc_codec *codec)
 
 	regulator_bulk_disable(ARRAY_SIZE(sgtl5000->supplies),
 						sgtl5000->supplies);
-	ldo_regulator_remove(codec);
-
 	return 0;
 }
 
Signature · 1 line
1.9.1
maintainer
#1 lore raw

sound/soc/codecs/sgtl5000.c static int ldo_regulator_register(struct snd_soc_codec *codec, · line 845

Quoted 11 lines · Himangi Saraogi
sound/soc/codecs/sgtl5000.c +2 -1
index 249fadb..0efd6d6 100644
@@ -841,14 +841,15 @@ static int ldo_regulator_register(struct snd_soc_codec *codec,
 	struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
 	struct regulator_config config = { };
 
-	ldo = kzalloc(sizeof(struct ldo_regulator), GFP_KERNEL);
+	ldo = devm_kzalloc(codec->dev, sizeof(struct ldo_regulator),
+			   GFP_KERNEL);

You're using the managed functions within the ASoC level probe functions which doesn't work - devm_ is only usable as part of the driver model binding and unbinding. All this resource allocation needs to be moved into the device level probe (which is a better thing anyway) before it is converted to devm.

#2 lore raw
Quoted 10 lines · Mark Brown
Quoted 8 lines · Himangi Saraogi
sound/soc/codecs/sgtl5000.c +0 -0
index 249fadb..0efd6d6 100644
@@ -841,14 +841,15 @@ static int ldo_regulator_register(struct snd_soc_codec *codec,
 	struct sgtl5000_priv *sgtl5000 = snd_soc_codec_get_drvdata(codec);
 	struct regulator_config config = { };
 
Quoted 9 lines

sound/soc/codecs/sgtl5000.c static int ldo_regulator_register(struct snd_soc_codec *codec, · line 845

Quoted 3 lines
sound/soc/codecs/sgtl5000.c +2 -1
-	ldo = kzalloc(sizeof(struct ldo_regulator), GFP_KERNEL);
+	ldo = devm_kzalloc(codec->dev, sizeof(struct ldo_regulator),
+			   GFP_KERNEL);

You're using the managed functions within the ASoC level probe functions which doesn't work - devm_ is only usable as part of the driver model binding and unbinding. All this resource allocation needs to be moved into the device level probe (which is a better thing anyway) before it is converted to devm.

Nevertheless, there is already a call to devm_regulator_bulk_get in sgtl5000_enable_regulators which calls sgtl5000_replace_vddd_with_ldo which calls ldo_regulator_register. That call was introduced by

commit 63e54cd9caa3ce03635810608519e2b37d8bc706

Author: Fabio Estevam <[email protected]>
Date:   Thu Apr 24 14:13:08 2014 -0300

It seems that that patch should be reverted?

julia

maintainer
#3 lore raw
Quoted 9 lines · Julia Lawall

Nevertheless, there is already a call to devm_regulator_bulk_get in sgtl5000_enable_regulators which calls sgtl5000_replace_vddd_with_ldo which calls ldo_regulator_register. That call was introduced by

commit 63e54cd9caa3ce03635810608519e2b37d8bc706

Author: Fabio Estevam <[email protected]>
Date:   Thu Apr 24 14:13:08 2014 -0300

It seems that that patch should be reverted?

I think so. Russell also reported a kernel oops when unbinding this module, so I will prepare a patch reverting it.

Thanks

#4 lore raw
Quoted 6 lines · Fabio Estevam
Quoted 4 lines · Julia Lawall

Nevertheless, there is already a call to devm_regulator_bulk_get in sgtl5000_enable_regulators which calls sgtl5000_replace_vddd_with_ldo which calls ldo_regulator_register. That call was introduced by

Quoted 8 lines
Quoted 5 lines

commit 63e54cd9caa3ce03635810608519e2b37d8bc706

Author: Fabio Estevam <[email protected]>
Date:   Thu Apr 24 14:13:08 2014 -0300

It seems that that patch should be reverted?

I think so. Russell also reported a kernel oops when unbinding this module, so I will prepare a patch reverting it.

There is documentation about what kinds of devm functions exist, but it is too bad that there is no documentation about where they can be used. Often there are several levels of function pointers involved, so it can be hard to figure out whether they can be used just by looking at the code. I have only taken the strategy of using them in kinds of functions where someone else has alreadyy figured out that they can be used.

julia

#5 lore raw
Quoted 19 lines · Julia Lawall
Quoted 6 lines · Fabio Estevam
Quoted 4 lines · Julia Lawall

Nevertheless, there is already a call to devm_regulator_bulk_get in sgtl5000_enable_regulators which calls sgtl5000_replace_vddd_with_ldo which calls ldo_regulator_register. That call was introduced by

Quoted 8 lines
Quoted 5 lines

commit 63e54cd9caa3ce03635810608519e2b37d8bc706

Author: Fabio Estevam <[email protected]>
Date:   Thu Apr 24 14:13:08 2014 -0300

It seems that that patch should be reverted?

I think so. Russell also reported a kernel oops when unbinding this module, so I will prepare a patch reverting it.

Quoted 6 lines

There is documentation about what kinds of devm functions exist, but it is too bad that there is no documentation about where they can be used. Often there are several levels of function pointers involved, so it can be hard to figure out whether they can be used just by looking at the code. I have only taken the strategy of using them in kinds of functions where someone else has alreadyy figured out that they can be used.

Yes, it is probably a bit underdocumented. The rule of thumb is don't use it anywhere else except for device probe callbacks (and functions that are only called from a device probe function) and only for the device that is being probed. There are probably a couple of instances in the kernel where the manged resource allocators are used in places where they shouldn't be used.

- Lars

maintainer
#6 lore raw
In reply to Julia Lawall
Quoted 6 lines · Julia Lawall

There is documentation about what kinds of devm functions exist, but it is too bad that there is no documentation about where they can be used. Often there are several levels of function pointers involved, so it can be hard to figure out whether they can be used just by looking at the code. I have only taken the strategy of using them in kinds of functions where someone else has alreadyy figured out that they can be used.

It should be fairly clear given what they do I'd have thought - the devm_ functions tie the deallocation of a resource to the unbinding of a driver from a device so they can only be used to replace things that get cleaned up in a device model unbind path. There's not usually a great deal of indirection going on in those.

#7 lore raw
Quoted 9 lines · Mark Brown
Quoted 6 lines · Julia Lawall

There is documentation about what kinds of devm functions exist, but it is too bad that there is no documentation about where they can be used. Often there are several levels of function pointers involved, so it can be hard to figure out whether they can be used just by looking at the code. I have only taken the strategy of using them in kinds of functions where someone else has alreadyy figured out that they can be used.

Quoted 5 lines

It should be fairly clear given what they do I'd have thought - the devm_ functions tie the deallocation of a resource to the unbinding of a driver from a device so they can only be used to replace things that get cleaned up in a device model unbind path. There's not usually a great deal of indirection going on in those.

It is completely clear what they do. What is not clear is what device libraries are set up to call the freeing functions at what point. For example, I know that that platform drivers are set up for this, but once I tried to find the lines of code that would justify that, but I could not. Perhaps I was not patient enough or missed something.

julia

maintainer
#8 lore raw
Quoted 8 lines · Julia Lawall
Quoted 5 lines · Mark Brown

It should be fairly clear given what they do I'd have thought - the devm_ functions tie the deallocation of a resource to the unbinding of a driver from a device so they can only be used to replace things that get cleaned up in a device model unbind path. There's not usually a great deal of indirection going on in those.

Quoted 5 lines

It is completely clear what they do. What is not clear is what device libraries are set up to call the freeing functions at what point. For example, I know that that platform drivers are set up for this, but once I tried to find the lines of code that would justify that, but I could not. Perhaps I was not patient enough or missed something.

All devices do this - it's done as part of the driver model core code so there is no need for individual buses to do anything.

#9 lore raw
Quoted 9 lines · Mark Brown
Quoted 7 lines · Julia Lawall
Quoted 5 lines · Mark Brown

It should be fairly clear given what they do I'd have thought - the devm_ functions tie the deallocation of a resource to the unbinding of a driver from a device so they can only be used to replace things that get cleaned up in a device model unbind path. There's not usually a great deal of indirection going on in those.

Quoted 8 lines
Quoted 5 lines

It is completely clear what they do. What is not clear is what device libraries are set up to call the freeing functions at what point. For example, I know that that platform drivers are set up for this, but once I tried to find the lines of code that would justify that, but I could not. Perhaps I was not patient enough or missed something.

All devices do this - it's done as part of the driver model core code so there is no need for individual buses to do anything.

How should one realize that this does not apply to the original file under discussion, sound/soc/codecs/sgtl5000.c? The associated structure is snd_soc_codec_driver. What code could one look for at the call sites of the probe and remove functions to know that managed memory can be used?

thanks,
julia

maintainer
#10 lore raw
Quoted 9 lines · Julia Lawall
Quoted 2 lines · Mark Brown

All devices do this - it's done as part of the driver model core code so there is no need for individual buses to do anything.

How should one realize that this does not apply to the original file under discussion, sound/soc/codecs/sgtl5000.c? The associated structure is snd_soc_codec_driver. What code could one look for at the call sites of the probe and remove functions to know that managed memory can be used?

That's not a device model driver; the way you should realise this is that there's no device being registered on a bus which is matched by the driver core.

#11 lore raw
Quoted 6 lines · Mark Brown
Quoted 4 lines · Julia Lawall
Quoted 2 lines · Mark Brown

All devices do this - it's done as part of the driver model core code so there is no need for individual buses to do anything.

Quoted 8 lines
Quoted 4 lines

How should one realize that this does not apply to the original file under discussion, sound/soc/codecs/sgtl5000.c? The associated structure is snd_soc_codec_driver. What code could one look for at the call sites of the probe and remove functions to know that managed memory can be used?

That's not a device model driver; the way you should realise this is that there's no device being registered on a bus which is matched by the driver core.

OK, thanks for the clarification.

julia