Received-SPF: pass (google.com: domain of linux-kernel+bounces-152793-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
Date: Mon, 22 Apr 2024 09:38:33 +0300
From: Matti Vaittinen <mazziesaccount@gmail.com>
To: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>,
	Matti Vaittinen <mazziesaccount@gmail.com>
Cc: Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>,
	Matti Vaittinen <mazziesaccount@gmail.com>,
	linux-kernel@vger.kernel.org, Aleksander Mazur <deweloper@wp.pl>,
	Guenter Roeck <linux@roeck-us.net>
Subject: [PATCH] regulator: change stubbed devm_regulator_get_enable to
 return Ok
Message-ID: <ZiYF6d1V1vSPcsJS@drtxq0yyyyyyyyyyyyyby-3.rev.dnainternet.fi>
Precedence: bulk
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha256;
	protocol="application/pgp-signature"; boundary="Rg411aW/xVskvZh1"
Content-Disposition: inline


--Rg411aW/xVskvZh1
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

The devm_regulator_get_enable() should be a 'call and forget' API,
meaning, when it is used to enable the regulators, the API does not
provide a handle to do any further control of the regulators. It gives
no real benefit to return an error from the stub if CONFIG_REGULATOR is
not set.

On the contrary, returning and error is causing problems to drivers when
hardware is such it works out just fine with no regulator control.
Returning an error forces drivers to specifically handle the case where
CONFIG_REGULATOR is not set, making the mere existence of the stub
questionalble. Furthermore, the stub of the regulator_enable() seems to
be returning Ok.

Change the stub implementation for the devm_regulator_get_enable() to
return Ok so drivers do not separately handle the case where the
CONFIG_REGULATOR is not set.

Signed-off-by: Matti Vaittinen <mazziesaccount@gmail.com>
Reported-by: Aleksander Mazur <deweloper@wp.pl>
Suggested-by: Guenter Roeck <linux@roeck-us.net>
Fixes: da279e6965b3 ("regulator: Add devm helpers for get and enable")

---
Please find the report by Aleksander from:
https://lore.kernel.org/all/20240420183427.0d3fda27@mocarz/

This patch has not received testing. It'd be great to hear if this
solves the issue.

I see the regulator_get_exclusive() and devm_regulator_get_optional()
returning errors. I thus leave the
devm_regulator_get_enable_[optional/exclusive]() to do the same while
wondering if this is the right thing to do, and why...

---
 include/linux/regulator/consumer.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/regulator/consumer.h b/include/linux/regulator/c=
onsumer.h
index 4660582a3302..71232fb7dda3 100644
--- a/include/linux/regulator/consumer.h
+++ b/include/linux/regulator/consumer.h
@@ -320,7 +320,7 @@ devm_regulator_get_exclusive(struct device *dev, const =
char *id)
=20
 static inline int devm_regulator_get_enable(struct device *dev, const char=
 *id)
 {
-	return -ENODEV;
+	return 0;
 }
=20
 static inline int devm_regulator_get_enable_optional(struct device *dev,

base-commit: 68adb581a39ae63a0ed082c47f01fbbe515efa0e
--=20
2.43.2


--=20
Matti Vaittinen, Linux device drivers
ROHM Semiconductors, Finland SWDC
Kiviharjunlenkki 1E
90220 OULU
FINLAND

~~~ "I don't think so," said Rene Descartes. Just then he vanished ~~~
Simon says - in Latin please.
~~~ "non cogito me" dixit Rene Descarte, deinde evanescavit ~~~
Thanks to Simon Glass for the translation =3D]=20

--Rg411aW/xVskvZh1
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQEzBAEBCAAdFiEEIx+f8wZb28fLKEhTeFA3/03aocUFAmYmBd8ACgkQeFA3/03a
ocUbigf+Or1olindwWniGUvsvKbD2+e/Py0Q8NabGsgw+6C8v9v52h3ljswHSNpD
mUcbz8n3TOYj84NHuj/AF85fERwLZS11KpCZirE8uKEPP4lyegQ9WcS/0ELuku8j
lmT2RyFWQr5Y81fMRiO7/tllHSIWgluBfHDIpEYYkClTyXku4eQgAy6UV0EnMHDR
wo9fL2SX7Okf45y0+XW4CdOHFQpo1BVTXu4SKaotPEcvBQMNArjmWpZzG7lOCnmz
iA9oZxqYGPPVf3p9OFKWFMDJaJ2wZpOIZmJEz0jGGPQU+wwwceTmszI+hhZCF2N1
8kZ6IF0mnNCn7InzsWOdvhxm0P60gw==
=bXwe
-----END PGP SIGNATURE-----

--Rg411aW/xVskvZh1--