diff mbox series

[v4,3/6] regulator: core: Add helper for allow HW access to enable/disable regulator

Message ID 20240616105402.45211-4-biju.das.jz@bp.renesas.com (mailing list archive)
State Handled Elsewhere, archived
Headers show
Series None | expand

Commit Message

Biju Das June 16, 2024, 10:53 a.m. UTC
Add a helper function that allow regulator consumers to allow low-level
HW access, in order to enable/disable regulator in atomic context.

The use-case for RZ/G2L SoC is to enable VBUS selection register based
on vbus detection that happens in interrupt context.

Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
---
v3->v4:
 * Updated commit header and description
 * Replaced regulator_set_hardware_enable_register()->regulator_hardware_enable()
 * Updated documentation to "must use of regulator_get_exclusive() for consumers"
 * Enforced exclusive access in regulator_hardware_enable().
 * Added generic support regulator_hardware_enable().
v3:
 * New patch.
---
 Documentation/power/regulator/consumer.rst |  6 +++++
 drivers/regulator/core.c                   | 28 ++++++++++++++++++++++
 include/linux/regulator/consumer.h         |  7 ++++++
 3 files changed, 41 insertions(+)

Comments

Mark Brown July 2, 2024, 1:30 p.m. UTC | #1
On Sun, Jun 16, 2024 at 11:53:55AM +0100, Biju Das wrote:
> Add a helper function that allow regulator consumers to allow low-level
> HW access, in order to enable/disable regulator in atomic context.

The following changes since commit f2661062f16b2de5d7b6a5c42a9a5c96326b8454:

  Linux 6.10-rc5 (2024-06-23 17:08:54 -0400)

are available in the Git repository at:

  https://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator.git tags/regulator-hw-enable-helper

for you to fetch changes up to 1cb7d29157603561af4c38535e936850ceb99f0f:

  regulator: core: Add helper for allow HW access to enable/disable regulator (2024-06-26 18:17:05 +0100)

----------------------------------------------------------------
regulator: Add helper to allow enable/disable in interrupt context

Add a helper function that enables exclusive consumers to bypass locking
and do an enable/disable from within interrupt context.

----------------------------------------------------------------
Biju Das (1):
      regulator: core: Add helper for allow HW access to enable/disable regulator

 Documentation/power/regulator/consumer.rst |  6 ++++++
 drivers/regulator/core.c                   | 28 ++++++++++++++++++++++++++++
 include/linux/regulator/consumer.h         |  7 +++++++
 3 files changed, 41 insertions(+)
Philipp Zabel July 3, 2024, 9:07 a.m. UTC | #2
On Di, 2024-07-02 at 14:30 +0100, Mark Brown wrote:
> On Sun, Jun 16, 2024 at 11:53:55AM +0100, Biju Das wrote:
> > Add a helper function that allow regulator consumers to allow low-level
> > HW access, in order to enable/disable regulator in atomic context.
> 
> The following changes since commit f2661062f16b2de5d7b6a5c42a9a5c96326b8454:
> 
>   Linux 6.10-rc5 (2024-06-23 17:08:54 -0400)
> 
> [...]

Thank you, merged into reset/next.

regards
Philipp
diff mbox series

Patch

diff --git a/Documentation/power/regulator/consumer.rst b/Documentation/power/regulator/consumer.rst
index 85c2bf5ac07e..9d2416f63f6e 100644
--- a/Documentation/power/regulator/consumer.rst
+++ b/Documentation/power/regulator/consumer.rst
@@ -227,3 +227,9 @@  directly written to the voltage selector register, use::
 
 	int regulator_list_hardware_vsel(struct regulator *regulator,
 					 unsigned selector);
+
+To access the hardware for enabling/disabling the regulator, consumers must
+use regulator_get_exclusive(), as it can't work if there's more than one
+consumer. To enable/disable regulator use::
+
+	int regulator_hardware_enable(struct regulator *regulator, bool enable);
diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index 844e9587a880..7674b7f2df14 100644
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -3408,6 +3408,34 @@  int regulator_list_hardware_vsel(struct regulator *regulator,
 }
 EXPORT_SYMBOL_GPL(regulator_list_hardware_vsel);
 
+/**
+ * regulator_hardware_enable - access the HW for enable/disable regulator
+ * @regulator: regulator source
+ * @enable: true for enable, false for disable
+ *
+ * Request that the regulator be enabled/disabled with the regulator output at
+ * the predefined voltage or current value.
+ *
+ * On success 0 is returned, otherwise a negative errno is returned.
+ */
+int regulator_hardware_enable(struct regulator *regulator, bool enable)
+{
+	struct regulator_dev *rdev = regulator->rdev;
+	const struct regulator_ops *ops = rdev->desc->ops;
+	int ret = -EOPNOTSUPP;
+
+	if (!rdev->exclusive || !ops || !ops->enable || !ops->disable)
+		return ret;
+
+	if (enable)
+		ret = ops->enable(rdev);
+	else
+		ret = ops->disable(rdev);
+
+	return ret;
+}
+EXPORT_SYMBOL_GPL(regulator_hardware_enable);
+
 /**
  * regulator_get_linear_step - return the voltage step size between VSEL values
  * @regulator: regulator source
diff --git a/include/linux/regulator/consumer.h b/include/linux/regulator/consumer.h
index e6f81fc1fb17..d986ec13092e 100644
--- a/include/linux/regulator/consumer.h
+++ b/include/linux/regulator/consumer.h
@@ -250,6 +250,7 @@  int regulator_get_hardware_vsel_register(struct regulator *regulator,
 					 unsigned *vsel_mask);
 int regulator_list_hardware_vsel(struct regulator *regulator,
 				 unsigned selector);
+int regulator_hardware_enable(struct regulator *regulator, bool enable);
 
 /* regulator notifier block */
 int regulator_register_notifier(struct regulator *regulator,
@@ -571,6 +572,12 @@  static inline int regulator_list_hardware_vsel(struct regulator *regulator,
 	return -EOPNOTSUPP;
 }
 
+static inline int regulator_hardware_enable(struct regulator *regulator,
+					    bool enable)
+{
+	return -EOPNOTSUPP;
+}
+
 static inline int regulator_register_notifier(struct regulator *regulator,
 			      struct notifier_block *nb)
 {