* [PATCH v6 0/8] Extend regulator notification support
@ 2021-04-07 10:02 Matti Vaittinen
2021-04-07 10:02 ` [PATCH v6 1/8] dt_bindings: Add protection limit properties Matti Vaittinen
` (7 more replies)
0 siblings, 8 replies; 15+ messages in thread
From: Matti Vaittinen @ 2021-04-07 10:02 UTC (permalink / raw)
To: Matti Vaittinen, Matti Vaittinen
Cc: Liam Girdwood, Mark Brown, Rob Herring, Matti Vaittinen,
Andy Gross, Bjorn Andersson, linux-kernel, devicetree,
linux-power, linux-arm-msm, linux-renesas-soc
Extend regulator notification support
This series extends the regulator notification and error flag support. Initial
discussion on the topic can be found here:
https://lore.kernel.org/lkml/6046836e22b8252983f08d5621c35ececb97820d.camel@fi.rohmeurope.com/
This series is built on top of the BD9576MUF support patch series v9
which is currently in MFD tree at immutable branch ib-mfd-watchdog-5.13
https://lore.kernel.org/lkml/cover.1615219345.git.matti.vaittinen@fi.rohmeurope.com/
(The series should apply without those patches but there is compile time
dependency to definitions brought in at the last patch of the BD9576
series. This should be Ok though as there is a Kconfig dependency in
BD9576 regulator driver)
In a nutshell - the series adds:
1. WARNING level events/error flags. (Patch 2)
Current regulator 'ERROR' event notifications for over/under
voltage, over current and over temperature are used to indicate
condition where monitored entity is so badly "off" that it actually
indicates a hardware error which can not be recovered. The most
typical hanling for that is believed to be a (graceful)
system-shutdown. Here we add set of 'WARNING' level flags to allow
sending notifications to consumers before things are 'that badly off'
so that consumer drivers can implement recovery-actions.
2. Device-tree properties for specifying limit values. (Patches 1, 4)
Add limits for above mentioned 'ERROR' and 'WARNING' levels (which
send notifications to consumers) and also for a 'PROTECTION' level
(which will be used to immediately shut-down the regulator(s) W/O
informing consumer drivers. Typically implemented by hardware).
Property parsing is implemented in regulator core which then calls
callback operations for limit setting from the IC drivers. A
warning is emitted if protection is requested by device tree but the
underlying IC does not support configuring requested protection.
3. Helpers which can be registered by IC. (Patch 3)
Target is to avoid implementing IRQ handling and IRQ storm protection
in each IC driver. (Many of the ICs implementin these IRQs do not allow
masking or acking the IRQ but keep the IRQ asserted for the whole
duration of problem keeping the processor in IRQ handling loop).
The helper was attempted to be done so it could be used to implement
roughly same logic as is used in qcom-labibb regulator. This means
amongst other things a safety shut-down if IC registers are not readable.
Using these shut-down retry counters are optional. The idea is that the
helper could be also used by simpler ICs which do not provide status
register(s) which can be used to check if error is still active.
ICs which do not have such status register can simply omit the 'renable'
callback (and retry-counts etc) - and helper assumes the situation is Ok
and re-enables IRQ after given time period. If problem persists the
handler is ran again and another notification is sent - but at least the
delay allows processor to avoid IRQ loop.
Patch 6 takes this notification support in use at BD9576MUF.
Patch 7 is related to MFD change which is not really related to the RFC
here. It was added to this series in order to avoid potential conflicts.
Patch 8 adds a maintainers entry.
Changelog v6:
Add MAINTAINERS entry
Changes to IRQ notifiers
- move devm functions to drivers/regulator/devres.c
- drop irq validity check
- use devm_add_action_or_reset()
- fix styling issues
- fix kerneldocs
Changelog v5:
- Fix the badly formatted pr_emerg() call.
Changelog v4:
- rebased on v5.12-rc6
- dropped RFC
- fix external FET DT-binding.
- improve prints for cases when expecting HW failure.
- styling and typos
Changelog v3:
Regulator core:
- Fix dangling pointer access at regulator_irq_helper()
stpmic1_regulator:
- fix function prototype (compile error)
bd9576-regulator:
- Update over current limits to what was given in new data-sheet
(REV00K)
- Allow over-current monitoring without external FET. Set limits to
values given in data-sheet (REV00K).
Changelog v2:
Generic:
- rebase on v5.12-rc2 + BD9576 series
- Split devm variant of delayed wq to own series
Regulator framework:
- Provide non devm variant of IRQ notification helpers
- shorten dt-property names as suggested by Rob
- unconditionally call map_event in IRQ handling and require it to be
populated
BD9576 regulators:
- change the FET resistance property to micro-ohms
- fix voltage computation in OC limit setting
--
Matti Vaittinen (8):
dt_bindings: Add protection limit properties
regulator: add warning flags
regulator: IRQ based event/error notification helpers
regulator: add property parsing and callbacks to set protection limits
dt-bindings: regulator: bd9576 add FET ON-resistance for OCW
regulator: bd9576: Support error reporting
regulator: bd9576: Fix the driver name in id table
MAINTAINERS: Add reviewer for regulator irq_helpers
.../bindings/regulator/regulator.yaml | 82 ++
.../regulator/rohm,bd9576-regulator.yaml | 6 +
MAINTAINERS | 4 +
drivers/regulator/Makefile | 2 +-
drivers/regulator/bd9576-regulator.c | 1060 +++++++++++++++--
drivers/regulator/core.c | 146 ++-
drivers/regulator/devres.c | 49 +
drivers/regulator/irq_helpers.c | 396 ++++++
drivers/regulator/of_regulator.c | 58 +
drivers/regulator/qcom-labibb-regulator.c | 10 +-
drivers/regulator/qcom_spmi-regulator.c | 6 +-
drivers/regulator/stpmic1_regulator.c | 20 +-
include/linux/regulator/consumer.h | 14 +
include/linux/regulator/driver.h | 176 ++-
include/linux/regulator/machine.h | 26 +
15 files changed, 1913 insertions(+), 142 deletions(-)
create mode 100644 drivers/regulator/irq_helpers.c
base-commit: e49d033bddf5b565044e2abe4241353959bc9120
--
2.25.4
--
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 =]
^ permalink raw reply [flat|nested] 15+ messages in thread
* [PATCH v6 1/8] dt_bindings: Add protection limit properties
2021-04-07 10:02 [PATCH v6 0/8] Extend regulator notification support Matti Vaittinen
@ 2021-04-07 10:02 ` Matti Vaittinen
2021-04-07 10:03 ` [PATCH v6 2/8] regulator: add warning flags Matti Vaittinen
` (6 subsequent siblings)
7 siblings, 0 replies; 15+ messages in thread
From: Matti Vaittinen @ 2021-04-07 10:02 UTC (permalink / raw)
To: Matti Vaittinen, Matti Vaittinen
Cc: Liam Girdwood, Mark Brown, Rob Herring, Matti Vaittinen,
Andy Gross, Bjorn Andersson, linux-kernel, devicetree,
linux-power, linux-arm-msm, linux-renesas-soc
Support specifying protection/error/warning limits for regulator
over current, over temperature and over/under voltage.
Most of the PMICs support only "protection" feature but few
setups do also support error/warning level indications.
On many ICs most of the protection limits can't actually be set.
But for example the ampere limit for over-current protection on ROHM
BD9576 can be configured - or feature can be completely disabled.
Provide limit setting for all protections/errors for the sake of
the completeness and do that using own properties for all so that
not all users would need to set all levels when only one or few are
supported.
Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
Reviewed-by: Rob Herring <robh@kernel.org>
---
No changes since RFC-v2
---
.../bindings/regulator/regulator.yaml | 82 +++++++++++++++++++
1 file changed, 82 insertions(+)
diff --git a/Documentation/devicetree/bindings/regulator/regulator.yaml b/Documentation/devicetree/bindings/regulator/regulator.yaml
index 6d0bc9cd4040..a6ae9ecae5cc 100644
--- a/Documentation/devicetree/bindings/regulator/regulator.yaml
+++ b/Documentation/devicetree/bindings/regulator/regulator.yaml
@@ -117,6 +117,88 @@ properties:
description: Enable over current protection.
type: boolean
+ regulator-oc-protection-microamp:
+ description: Set over current protection limit. This is a limit where
+ hardware performs emergency shutdown. Zero can be passed to disable
+ protection and value '1' indicates that protection should be enabled but
+ limit setting can be omitted.
+
+ regulator-oc-error-microamp:
+ description: Set over current error limit. This is a limit where part of
+ the hardware propably is malfunctional and damage prevention is requested.
+ Zero can be passed to disable error detection and value '1' indicates
+ that detection should be enabled but limit setting can be omitted.
+
+ regulator-oc-warn-microamp:
+ description: Set over current warning limit. This is a limit where hardware
+ is assumed still to be functional but approaching limit where it gets
+ damaged. Recovery actions should be initiated. Zero can be passed to
+ disable detection and value '1' indicates that detection should
+ be enabled but limit setting can be omitted.
+
+ regulator-ov-protection-microvolt:
+ description: Set over voltage protection limit. This is a limit where
+ hardware performs emergency shutdown. Zero can be passed to disable
+ protection and value '1' indicates that protection should be enabled but
+ limit setting can be omitted. Limit is given as microvolt offset from
+ voltage set to regulator.
+
+ regulator-ov-error-microvolt:
+ description: Set over voltage error limit. This is a limit where part of
+ the hardware propably is malfunctional and damage prevention is requested
+ Zero can be passed to disable error detection and value '1' indicates
+ that detection should be enabled but limit setting can be omitted. Limit
+ is given as microvolt offset from voltage set to regulator.
+
+ regulator-ov-warn-microvolt:
+ description: Set over voltage warning limit. This is a limit where hardware
+ is assumed still to be functional but approaching limit where it gets
+ damaged. Recovery actions should be initiated. Zero can be passed to
+ disable detection and value '1' indicates that detection should
+ be enabled but limit setting can be omitted. Limit is given as microvolt
+ offset from voltage set to regulator.
+
+ regulator-uv-protection-microvolt:
+ description: Set over under voltage protection limit. This is a limit where
+ hardware performs emergency shutdown. Zero can be passed to disable
+ protection and value '1' indicates that protection should be enabled but
+ limit setting can be omitted. Limit is given as microvolt offset from
+ voltage set to regulator.
+
+ regulator-uv-error-microvolt:
+ description: Set under voltage error limit. This is a limit where part of
+ the hardware propably is malfunctional and damage prevention is requested
+ Zero can be passed to disable error detection and value '1' indicates
+ that detection should be enabled but limit setting can be omitted. Limit
+ is given as microvolt offset from voltage set to regulator.
+
+ regulator-uv-warn-microvolt:
+ description: Set over under voltage warning limit. This is a limit where
+ hardware is assumed still to be functional but approaching limit where
+ it gets damaged. Recovery actions should be initiated. Zero can be passed
+ to disable detection and value '1' indicates that detection should
+ be enabled but limit setting can be omitted. Limit is given as microvolt
+ offset from voltage set to regulator.
+
+ regulator-temp-protection-kelvin:
+ description: Set over temperature protection limit. This is a limit where
+ hardware performs emergency shutdown. Zero can be passed to disable
+ protection and value '1' indicates that protection should be enabled but
+ limit setting can be omitted.
+
+ regulator-temp-error-kelvin:
+ description: Set over temperature error limit. This is a limit where part of
+ the hardware propably is malfunctional and damage prevention is requested
+ Zero can be passed to disable error detection and value '1' indicates
+ that detection should be enabled but limit setting can be omitted.
+
+ regulator-temp-warn-kelvin:
+ description: Set over temperature warning limit. This is a limit where
+ hardware is assumed still to be functional but approaching limit where it
+ gets damaged. Recovery actions should be initiated. Zero can be passed to
+ disable detection and value '1' indicates that detection should
+ be enabled but limit setting can be omitted.
+
regulator-active-discharge:
description: |
tristate, enable/disable active discharge of regulators. The values are:
--
2.25.4
--
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 =]
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v6 2/8] regulator: add warning flags
2021-04-07 10:02 [PATCH v6 0/8] Extend regulator notification support Matti Vaittinen
2021-04-07 10:02 ` [PATCH v6 1/8] dt_bindings: Add protection limit properties Matti Vaittinen
@ 2021-04-07 10:03 ` Matti Vaittinen
2021-04-07 10:04 ` [PATCH v6 3/8] regulator: IRQ based event/error notification helpers Matti Vaittinen
` (5 subsequent siblings)
7 siblings, 0 replies; 15+ messages in thread
From: Matti Vaittinen @ 2021-04-07 10:03 UTC (permalink / raw)
To: Matti Vaittinen, Matti Vaittinen
Cc: Liam Girdwood, Mark Brown, Rob Herring, Matti Vaittinen,
Andy Gross, Bjorn Andersson, linux-kernel, devicetree,
linux-power, linux-arm-msm, linux-renesas-soc
Add 'warning' level events and error flags to regulator core.
Current regulator core notifications are used to inform consumers
about errors where HW is misbehaving in such way it is assumed to
be broken/unrecoverable.
There are PMICs which are designed for system(s) that may have use
for regulator indications sent before HW is damaged so that some
board/consumer specific recovery-event can be performed while
continuing most of the normal operations.
Add new WARNING level events and notifications to be used for
that purpose.
Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
---
No changes since RFC-v2
---
include/linux/regulator/consumer.h | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/include/linux/regulator/consumer.h b/include/linux/regulator/consumer.h
index 20e84a84fb77..f72ca73631be 100644
--- a/include/linux/regulator/consumer.h
+++ b/include/linux/regulator/consumer.h
@@ -119,6 +119,16 @@ struct regulator_dev;
#define REGULATOR_EVENT_PRE_DISABLE 0x400
#define REGULATOR_EVENT_ABORT_DISABLE 0x800
#define REGULATOR_EVENT_ENABLE 0x1000
+/*
+ * Following notifications should be emitted only if detected condition
+ * is such that the HW is likely to still be working but consumers should
+ * take a recovery action to prevent problems esacalating into errors.
+ */
+#define REGULATOR_EVENT_UNDER_VOLTAGE_WARN 0x2000
+#define REGULATOR_EVENT_OVER_CURRENT_WARN 0x4000
+#define REGULATOR_EVENT_OVER_VOLTAGE_WARN 0x8000
+#define REGULATOR_EVENT_OVER_TEMP_WARN 0x10000
+#define REGULATOR_EVENT_WARN_MASK 0x1E000
/*
* Regulator errors that can be queried using regulator_get_error_flags
@@ -138,6 +148,10 @@ struct regulator_dev;
#define REGULATOR_ERROR_FAIL BIT(4)
#define REGULATOR_ERROR_OVER_TEMP BIT(5)
+#define REGULATOR_ERROR_UNDER_VOLTAGE_WARN BIT(6)
+#define REGULATOR_ERROR_OVER_CURRENT_WARN BIT(7)
+#define REGULATOR_ERROR_OVER_VOLTAGE_WARN BIT(8)
+#define REGULATOR_ERROR_OVER_TEMP_WARN BIT(9)
/**
* struct pre_voltage_change_data - Data sent with PRE_VOLTAGE_CHANGE event
--
2.25.4
--
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 =]
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v6 3/8] regulator: IRQ based event/error notification helpers
2021-04-07 10:02 [PATCH v6 0/8] Extend regulator notification support Matti Vaittinen
2021-04-07 10:02 ` [PATCH v6 1/8] dt_bindings: Add protection limit properties Matti Vaittinen
2021-04-07 10:03 ` [PATCH v6 2/8] regulator: add warning flags Matti Vaittinen
@ 2021-04-07 10:04 ` Matti Vaittinen
2021-04-07 13:21 ` Andy Shevchenko
2021-04-07 10:04 ` [PATCH v6 4/8] regulator: add property parsing and callbacks to set protection limits Matti Vaittinen
` (4 subsequent siblings)
7 siblings, 1 reply; 15+ messages in thread
From: Matti Vaittinen @ 2021-04-07 10:04 UTC (permalink / raw)
To: Matti Vaittinen, Matti Vaittinen
Cc: Liam Girdwood, Mark Brown, Rob Herring, Matti Vaittinen,
Andy Gross, Bjorn Andersson, linux-kernel, devicetree,
linux-power, linux-arm-msm, linux-renesas-soc, Andy Shevchenko
Provide helper function for IC's implementing regulator notifications
when an IRQ fires. The helper also works for IRQs which can not be acked.
Helper can be set to disable the IRQ at handler and then re-enabling it
on delayed work later. The helper also adds regulator_get_error_flags()
errors in cache for the duration of IRQ disabling.
Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
---
v6 (fix issues noted by Andy):
- remove unnecessary variable
- use BIT(foo) instead of 1 << foo
- use devm_add_action_or_reset()
- do not check the irq parameter validity, leave that to
request_threaded_irq()
- put resource-managed function in devres.c
- fix the kerneldocs for the new IRQ helpers
v5:
- fix the pr_emerg print
v4:
- Comment block styling
- Added prints to point the potential HW failure before BUG()
- Corrected typo from kerneldoc
- added missing newlines
---
drivers/regulator/Makefile | 2 +-
drivers/regulator/core.c | 24 +-
drivers/regulator/devres.c | 49 ++++
drivers/regulator/irq_helpers.c | 396 +++++++++++++++++++++++++++++++
include/linux/regulator/driver.h | 135 +++++++++++
5 files changed, 602 insertions(+), 4 deletions(-)
create mode 100644 drivers/regulator/irq_helpers.c
diff --git a/drivers/regulator/Makefile b/drivers/regulator/Makefile
index 44d2f8bf4b74..e25f1c2d6c9b 100644
--- a/drivers/regulator/Makefile
+++ b/drivers/regulator/Makefile
@@ -4,7 +4,7 @@
#
-obj-$(CONFIG_REGULATOR) += core.o dummy.o fixed-helper.o helpers.o devres.o
+obj-$(CONFIG_REGULATOR) += core.o dummy.o fixed-helper.o helpers.o devres.o irq_helpers.o
obj-$(CONFIG_OF) += of_regulator.o
obj-$(CONFIG_REGULATOR_FIXED_VOLTAGE) += fixed.o
obj-$(CONFIG_REGULATOR_VIRTUAL_CONSUMER) += virtual.o
diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index 16114aea099a..fabc83288e1b 100644
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -4388,20 +4388,37 @@ unsigned int regulator_get_mode(struct regulator *regulator)
}
EXPORT_SYMBOL_GPL(regulator_get_mode);
+static int rdev_get_cached_err_flags(struct regulator_dev *rdev)
+{
+ int ret = 0;
+
+ if (rdev->use_cached_err) {
+ spin_lock(&rdev->err_lock);
+ ret = rdev->cached_err;
+ spin_unlock(&rdev->err_lock);
+ }
+ return ret;
+}
+
static int _regulator_get_error_flags(struct regulator_dev *rdev,
unsigned int *flags)
{
- int ret;
+ int ret, tmpret;
regulator_lock(rdev);
+ ret = rdev_get_cached_err_flags(rdev);
+
/* sanity check */
- if (!rdev->desc->ops->get_error_flags) {
+ if (rdev->desc->ops->get_error_flags) {
+ tmpret = rdev->desc->ops->get_error_flags(rdev, flags);
+ if (tmpret > 0)
+ ret |= tmpret;
+ } else if (!rdev->use_cached_err) {
ret = -EINVAL;
goto out;
}
- ret = rdev->desc->ops->get_error_flags(rdev, flags);
out:
regulator_unlock(rdev);
return ret;
@@ -5236,6 +5253,7 @@ regulator_register(const struct regulator_desc *regulator_desc,
goto rinse;
}
device_initialize(&rdev->dev);
+ spin_lock_init(&rdev->err_lock);
/*
* Duplicate the config so the driver could override it after
diff --git a/drivers/regulator/devres.c b/drivers/regulator/devres.c
index 3091210889e3..127262dcd3f7 100644
--- a/drivers/regulator/devres.c
+++ b/drivers/regulator/devres.c
@@ -481,3 +481,52 @@ void devm_regulator_unregister_notifier(struct regulator *regulator,
WARN_ON(rc);
}
EXPORT_SYMBOL_GPL(devm_regulator_unregister_notifier);
+
+static void regulator_irq_helper_drop(void *res)
+{
+ regulator_irq_helper_cancel(&res);
+}
+
+/**
+ * devm_regulator_irq_helper - resource managed registration of IRQ based
+ * regulator event/error notifier
+ *
+ * @dev: device to which lifetime the helper's lifetime is
+ * bound.
+ * @d: IRQ helper descriptor.
+ * @irq: IRQ used to inform events/errors to be notified.
+ * @irq_flags: Extra IRQ flags to be OR's with the default IRQF_ONESHOT
+ * when requesting the (threaded) irq.
+ * @common_errs: Errors which can be flagged by this IRQ for all rdevs.
+ * When IRQ is re-enabled these errors will be cleared
+ * from all associated regulators
+ * @per_rdev_errs: Optional error flag array describing errors specific
+ * for only some of the regulators. These errors will be
+ * or'ed with common errors. If this is given the array
+ * should contain rdev_amount flags. Can be set to NULL
+ * if there is no regulator specific error flags for this
+ * IRQ.
+ * @rdev: Array of regulators associated with this IRQ.
+ * @rdev_amount: Amount of regulators associated wit this IRQ.
+ */
+void *devm_regulator_irq_helper(struct device *dev,
+ const struct regulator_irq_desc *d, int irq,
+ int irq_flags, int common_errs,
+ int *per_rdev_errs,
+ struct regulator_dev **rdev, int rdev_amount)
+{
+ void *ptr;
+ int ret;
+
+ ptr = regulator_irq_helper(dev, d, irq, irq_flags, common_errs,
+ per_rdev_errs, rdev, rdev_amount);
+ if (IS_ERR(ptr))
+ return ptr;
+
+ ret = devm_add_action_or_reset(dev, regulator_irq_helper_drop, ptr);
+ if (ret)
+ return ERR_PTR(ret);
+
+ return ptr;
+}
+EXPORT_SYMBOL_GPL(devm_regulator_irq_helper);
diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helpers.c
new file mode 100644
index 000000000000..374ff0f3c6d3
--- /dev/null
+++ b/drivers/regulator/irq_helpers.c
@@ -0,0 +1,396 @@
+// SPDX-License-Identifier: GPL-2.0
+//
+// Copyright (C) 2021 ROHM Semiconductors
+// regulator IRQ based event notification helpers
+//
+// Logic has been partially adapted from qcom-labibb driver.
+//
+// Author: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
+
+#include <linux/device.h>
+#include <linux/err.h>
+#include <linux/kernel.h>
+#include <linux/of_irq.h>
+#include <linux/regmap.h>
+#include <linux/slab.h>
+#include <linux/spinlock.h>
+#include <linux/regulator/driver.h>
+
+struct regulator_irq {
+ struct regulator_irq_data rdata;
+ struct regulator_irq_desc desc;
+ int irq;
+ int retry_cnt;
+ struct delayed_work isr_work;
+};
+
+/*
+ * Should only be called from threaded handler to prevent potential deadlock
+ */
+static void rdev_flag_err(struct regulator_dev *rdev, int err)
+{
+ spin_lock(&rdev->err_lock);
+ rdev->cached_err |= err;
+ spin_unlock(&rdev->err_lock);
+}
+
+static void rdev_clear_err(struct regulator_dev *rdev, int err)
+{
+ spin_lock(&rdev->err_lock);
+ rdev->cached_err &= ~err;
+ spin_unlock(&rdev->err_lock);
+}
+
+static void die_loudly(const char *msg)
+{
+ pr_emerg("%s\n", msg);
+ BUG();
+}
+
+static void regulator_notifier_isr_work(struct work_struct *work)
+{
+ struct regulator_irq *h;
+ struct regulator_irq_desc *d;
+ struct regulator_irq_data *rid;
+ int ret = 0;
+ int tmo, i;
+ int num_rdevs;
+
+ h = container_of(work, struct regulator_irq,
+ isr_work.work);
+ d = &h->desc;
+ rid = &h->rdata;
+ num_rdevs = rid->num_states;
+
+reread:
+ if (d->fatal_cnt && h->retry_cnt > d->fatal_cnt) {
+ if (d->die)
+ ret = d->die(rid);
+ else
+ die_loudly("Regulator HW failure? - no IC recovery");
+
+ /*
+ * If the 'last resort' IC recovery failed we will have
+ * nothing else left to do...
+ */
+ if (ret)
+ die_loudly("Regulator HW failure? - IC recovery failed");
+
+ /*
+ * If h->die() was implemented we assume recovery has been
+ * attempted (probably regulator was shut down)
+ * and we just enable IRQ and bail-out.
+ */
+ goto enable_out;
+ }
+ if (d->renable) {
+ ret = d->renable(rid);
+
+ if (ret == REGULATOR_FAILED_RETRY) {
+ /* Driver could not get current status */
+ h->retry_cnt++;
+ if (!d->reread_ms)
+ goto reread;
+
+ tmo = d->reread_ms;
+ goto reschedule;
+ }
+
+ if (ret) {
+ /*
+ * IC status reading succeeded. update error info
+ * just in case the renable changed it.
+ */
+ for (i = 0; i < num_rdevs; i++) {
+ struct regulator_err_state *stat;
+ struct regulator_dev *rdev;
+
+ stat = &rid->states[i];
+ rdev = stat->rdev;
+ rdev_clear_err(rdev, (~stat->errors) &
+ stat->possible_errs);
+ }
+ h->retry_cnt++;
+ /*
+ * The IC indicated problem is still ON - no point in
+ * re-enabling the IRQ. Retry later.
+ */
+ tmo = d->irq_off_ms;
+ goto reschedule;
+ }
+ }
+
+ /*
+ * Either IC reported problem cleared or no status checker was provided.
+ * If problems are gone - good. If not - then the IRQ will fire again
+ * and we'll have new nice loop. In any case we should clear error flags
+ * here and re-enable IRQs.
+ */
+ for (i = 0; i < num_rdevs; i++) {
+ struct regulator_err_state *stat;
+ struct regulator_dev *rdev;
+
+ stat = &rid->states[i];
+ rdev = stat->rdev;
+ rdev_clear_err(rdev, stat->possible_errs);
+ }
+
+ /*
+ * Things have been seemingly successful => zero retry-counter.
+ */
+ h->retry_cnt = 0;
+
+enable_out:
+ enable_irq(h->irq);
+
+ return;
+
+reschedule:
+ if (!d->high_prio)
+ mod_delayed_work(system_wq, &h->isr_work,
+ msecs_to_jiffies(tmo));
+ else
+ mod_delayed_work(system_highpri_wq, &h->isr_work,
+ msecs_to_jiffies(tmo));
+}
+
+static irqreturn_t regulator_notifier_isr(int irq, void *data)
+{
+ struct regulator_irq *h = data;
+ struct regulator_irq_desc *d;
+ struct regulator_irq_data *rid;
+ unsigned long rdev_map = 0;
+ int num_rdevs;
+ int ret, i, j;
+
+ d = &h->desc;
+ rid = &h->rdata;
+ num_rdevs = rid->num_states;
+
+ if (d->fatal_cnt)
+ h->retry_cnt++;
+
+ /*
+ * we spare few cycles by not clearing statuses prior this call.
+ * The IC driver must initialize the status buffers for rdevs
+ * which it indicates having active events via rdev_map.
+ *
+ * Maybe we should just to be on a safer side(?)
+ */
+ ret = d->map_event(irq, rid, &rdev_map);
+
+ /*
+ * If status reading fails (which is unlikely) we don't ack/disable
+ * IRQ but just increase fail count and retry when IRQ fires again.
+ * If retry_count exceeds given safety limit we call IC specific die
+ * handler which can try disabling regulator(s).
+ *
+ * If no die handler is given we will just bug() as a last resort.
+ *
+ * We could try disabling all associated rdevs - but we might shoot
+ * ourself in the head and leave problematic regulator enabled. So
+ * if IC has no die-handler populated we just assume the regulator
+ * can't be disabled.
+ */
+ if (unlikely(ret == REGULATOR_FAILED_RETRY))
+ goto fail_out;
+
+ h->retry_cnt = 0;
+ /*
+ * Let's not disable IRQ if there was no status bits for us. We'd
+ * better leave spurious IRQ handling to genirq
+ */
+ if (ret || !rdev_map)
+ return IRQ_NONE;
+
+ /*
+ * Some events are bogus if regulator is disabled. Skip such events
+ * if all relevant regulators are disabled
+ */
+ if (d->skip_off) {
+ for_each_set_bit(i, &rdev_map, num_rdevs) {
+ struct regulator_dev *rdev;
+ const struct regulator_ops *ops;
+
+ rdev = rid->states[i].rdev;
+ ops = rdev->desc->ops;
+
+ /*
+ * If any of the flagged regulators is enabled we do
+ * handle this
+ */
+ if (ops->is_enabled(rdev))
+ break;
+ }
+ if (i == num_rdevs)
+ return IRQ_NONE;
+ }
+
+ /* Disable IRQ if HW keeps line asserted */
+ if (d->irq_off_ms)
+ disable_irq_nosync(irq);
+
+ /*
+ * IRQ seems to be for us. Let's fire correct notifiers / store error
+ * flags
+ */
+ for_each_set_bit(i, &rdev_map, num_rdevs) {
+ struct regulator_err_state *stat;
+ int len;
+ struct regulator_dev *rdev;
+
+ stat = &rid->states[i];
+ len = sizeof(stat->notifs);
+
+ rdev = stat->rdev;
+ for_each_set_bit(j, &stat->notifs, 8 * len)
+ regulator_notifier_call_chain(rdev, BIT(j - 1), NULL);
+
+ rdev_flag_err(rdev, stat->errors);
+ }
+
+ if (d->irq_off_ms) {
+ if (!d->high_prio)
+ schedule_delayed_work(&h->isr_work,
+ msecs_to_jiffies(d->irq_off_ms));
+ else
+ mod_delayed_work(system_highpri_wq,
+ &h->isr_work,
+ msecs_to_jiffies(d->irq_off_ms));
+ }
+
+ return IRQ_HANDLED;
+
+fail_out:
+ if (d->fatal_cnt && h->retry_cnt > d->fatal_cnt) {
+ if (d->die)
+ ret = d->die(rid);
+
+ /*
+ * If die() failed or was not implemented just BUG() as last
+ * attemt to save HW.
+ */
+ if (ret)
+ die_loudly("Regulator HW failure? - retry count exceeded");
+ }
+
+ return IRQ_NONE;
+}
+
+static int init_rdev_state(struct device *dev, struct regulator_irq *h,
+ struct regulator_dev **rdev, int common_err,
+ int *rdev_err, int rdev_amount)
+{
+ int i;
+
+ h->rdata.states = devm_kzalloc(dev, sizeof(*h->rdata.states) *
+ rdev_amount, GFP_KERNEL);
+ if (!h->rdata.states)
+ return -ENOMEM;
+
+ h->rdata.num_states = rdev_amount;
+ h->rdata.data = h->desc.data;
+
+ for (i = 0; i < rdev_amount; i++) {
+ h->rdata.states[i].possible_errs = common_err;
+ if (rdev_err)
+ h->rdata.states[i].possible_errs |= *rdev_err++;
+ h->rdata.states[i].rdev = *rdev++;
+ }
+
+ return 0;
+}
+
+static void init_rdev_errors(struct regulator_irq *h)
+{
+ int i;
+
+ for (i = 0; i < h->rdata.num_states; i++) {
+ if (h->rdata.states[i].possible_errs)
+ /* Can we trust writing this boolean is atomic? */
+ h->rdata.states[i].rdev->use_cached_err = true;
+ }
+}
+
+/**
+ * regulator_irq_helper - register IRQ based regulator event/error notifier
+ *
+ * @dev: device providing the IRQs
+ * @d: IRQ helper descriptor.
+ * @irq: IRQ used to inform events/errors to be notified.
+ * @irq_flags: Extra IRQ flags to be OR's with the default IRQF_ONESHOT
+ * when requesting the (threaded) irq.
+ * @common_errs: Errors which can be flagged by this IRQ for all rdevs.
+ * When IRQ is re-enabled these errors will be cleared
+ * from all associated regulators
+ * @per_rdev_errs: Optional error flag array describing errors specific
+ * for only some of the regulators. These errors will be
+ * or'ed with common errors. If this is given the array
+ * should contain rdev_amount flags. Can be set to NULL
+ * if there is no regulator specific error flags for this
+ * IRQ.
+ * @rdev: Array of regulators associated with this IRQ.
+ * @rdev_amount: Amount of regulators associated wit this IRQ.
+ */
+void *regulator_irq_helper(struct device *dev,
+ const struct regulator_irq_desc *d, int irq,
+ int irq_flags, int common_errs, int *per_rdev_errs,
+ struct regulator_dev **rdev, int rdev_amount)
+{
+ struct regulator_irq *h;
+ int ret;
+
+ if (!rdev_amount || !d || !d->map_event || !d->name)
+ return ERR_PTR(-EINVAL);
+
+ h = devm_kzalloc(dev, sizeof(*h), GFP_KERNEL);
+ if (!h)
+ return ERR_PTR(-ENOMEM);
+
+ h->irq = irq;
+ h->desc = *d;
+
+ ret = init_rdev_state(dev, h, rdev, common_errs, per_rdev_errs,
+ rdev_amount);
+ if (ret)
+ return ERR_PTR(ret);
+
+ init_rdev_errors(h);
+
+ if (h->desc.irq_off_ms)
+ INIT_DELAYED_WORK(&h->isr_work, regulator_notifier_isr_work);
+
+ ret = request_threaded_irq(h->irq, NULL, regulator_notifier_isr,
+ IRQF_ONESHOT | irq_flags, h->desc.name, h);
+ if (ret) {
+ dev_err(dev, "Failed to request IRQ %d\n", irq);
+
+ return ERR_PTR(ret);
+ }
+
+ return h;
+}
+EXPORT_SYMBOL_GPL(regulator_irq_helper);
+
+/**
+ * regulator_irq_helper_cancel - drop IRQ based regulator event/error notifier
+ *
+ * @handle: Pointer to handle returned by a successful call to
+ * regulator_irq_helper(). Will be NULLed upon return.
+ *
+ * The associated IRQ is released and work is cancelled when the function
+ * returns.
+ */
+void regulator_irq_helper_cancel(void **handle)
+{
+ if (handle && *handle) {
+ struct regulator_irq *h = *handle;
+
+ free_irq(h->irq, h);
+ if (h->desc.irq_off_ms)
+ cancel_delayed_work_sync(&h->isr_work);
+
+ h = NULL;
+ }
+}
+EXPORT_SYMBOL_GPL(regulator_irq_helper_cancel);
diff --git a/include/linux/regulator/driver.h b/include/linux/regulator/driver.h
index d7c77ee370f3..03a8eee9fca9 100644
--- a/include/linux/regulator/driver.h
+++ b/include/linux/regulator/driver.h
@@ -409,6 +409,128 @@ struct regulator_config {
struct gpio_desc *ena_gpiod;
};
+/**
+ * struct regulator_err_state - regulator error/notification status
+ *
+ * @rdev: Regulator which status the struct indicates.
+ * @notifs: Events which have occurred on regulator.
+ * @errors: Errors which are active on regulator.
+ * @possible_errs: Errors which can be signaled (by given IRQ).
+ */
+struct regulator_err_state {
+ struct regulator_dev *rdev;
+ unsigned long notifs;
+ unsigned long errors;
+ int possible_errs;
+};
+
+/**
+ * struct regulator_irq_data - regulator error/notification status date
+ *
+ * @states: Status structs for each of the associated regulators.
+ * @num_states: Amount of associated regulators.
+ * @data: Driver data pointer given at regulator_irq_desc.
+ * @opaque: Value storage for IC driver. Core does not update this. ICs
+ * may want to store status register value here at map_event and
+ * compare contents at renable to see if new problems have been
+ * added to status. If that is the case it may be desirable to
+ * return REGULATOR_ERROR_CLEARED and not REGULATOR_ERROR_ON to
+ * allow IRQ fire again and to generate notifications also for
+ * the new issues.
+ *
+ * This structure is passed to map_event and renable for reporting regulator
+ * status to core.
+ */
+struct regulator_irq_data {
+ struct regulator_err_state *states;
+ int num_states;
+ void *data;
+ long opaque;
+};
+
+/**
+ * struct regulator_irq_desc - notification sender for IRQ based events.
+ *
+ * @name: The visible name for the IRQ
+ * @fatal_cnt: If this IRQ is used to signal HW damaging condition it may be
+ * best to shut-down regulator(s) or reboot the SOC if error
+ * handling is repeteadly failing. If fatal_cnt is given the IRQ
+ * handling is aborted if it fails for fatal_cnt times and die()
+ * callback (if populated) or BUG() is called to try to prevent
+ * further damage.
+ * @reread_ms: The time which is waited before attempting to re-read status
+ * at the worker if IC reading fails. Immediate re-read is done
+ * if time is not specified.
+ * @irq_off_ms: The time which IRQ is kept disabled before re-evaluating the
+ * status for devices which keep IRQ disabled for duration of the
+ * error. If this is not given the IRQ is left enabled and renable
+ * is not called.
+ * @skip_off: If set to true the IRQ handler will attempt to check if any of
+ * the associated regulators are enabled prior to taking other
+ * actions. If no regulators are enabled and this is set to true
+ * a spurious IRQ is assumed and IRQ_NONE is returned.
+ * @high_prio: Boolean to indicate that high priority WQ should be used.
+ * @data: Driver private data pointer which will be passed as such to
+ * the renable, map_event and die callbacks in regulator_irq_data.
+ * @die: Protection callback. If IC status reading or recovery actions
+ * fail fatal_cnt times this callback or BUG() is called. This
+ * callback should implement final protection attempt like
+ * disabling the regulator. If protection succeeded this may
+ * return 0. If anything else is returned the core assumes final
+ * protection failed and calls BUG() as a last resort.
+ * @map_event: Driver callback to map IRQ status into regulator devices with
+ * events / errors. NOTE: callback MUST initialize both the
+ * errors and notifs for all rdevs which it signals having
+ * active events as core does not clean the map data.
+ * REGULATOR_FAILED_RETRY can be returned to indicate that the
+ * status reading from IC failed. If this is repeated for
+ * fatal_cnt times the core will call die() callback or BUG()
+ * as a last resort to protect the HW.
+ * @renable: Optional callback to check status (if HW supports that) before
+ * re-enabling IRQ. If implemented this should clear the error
+ * flags so that errors fetched by regulator_get_error_flags()
+ * are updated. If callback is not impelemted then errors are
+ * assumed to be cleared and IRQ is re-enabled.
+ * REGULATOR_FAILED_RETRY can be returned to
+ * indicate that the status reading from IC failed. If this is
+ * repeated for 'fatal_cnt' times the core will call die()
+ * callback or BUG() as a last resort to protect the HW.
+ * Returning zero indicates that the problem in HW has been solved
+ * and IRQ will be re-enabled. Returning REGULATOR_ERROR_ON
+ * indicates the error condition is still active and keeps IRQ
+ * disabled. Please note that returning REGULATOR_ERROR_ON does
+ * not retrigger evaluating what events are active or resending
+ * notifications. If this is needed you probably want to return
+ * zero and allow IRQ to retrigger causing events to be
+ * re-evaluated and re-sent.
+ *
+ * This structure is used for registering regulator IRQ notification helper.
+ */
+struct regulator_irq_desc {
+ const char *name;
+ int irq_flags;
+ int fatal_cnt;
+ int reread_ms;
+ int irq_off_ms;
+ bool skip_off;
+ bool high_prio;
+ void *data;
+
+ int (*die)(struct regulator_irq_data *rid);
+ int (*map_event)(int irq, struct regulator_irq_data *rid,
+ unsigned long *dev_mask);
+ int (*renable)(struct regulator_irq_data *rid);
+};
+
+/*
+ * Return values for regulator IRQ helpers.
+ */
+enum {
+ REGULATOR_ERROR_CLEARED,
+ REGULATOR_FAILED_RETRY,
+ REGULATOR_ERROR_ON,
+};
+
/*
* struct coupling_desc
*
@@ -473,6 +595,9 @@ struct regulator_dev {
/* time when this regulator was disabled last time */
unsigned long last_off_jiffy;
+ int cached_err;
+ bool use_cached_err;
+ spinlock_t err_lock;
};
struct regulator_dev *
@@ -487,6 +612,16 @@ void devm_regulator_unregister(struct device *dev, struct regulator_dev *rdev);
int regulator_notifier_call_chain(struct regulator_dev *rdev,
unsigned long event, void *data);
+void *devm_regulator_irq_helper(struct device *dev,
+ const struct regulator_irq_desc *d, int irq,
+ int irq_flags, int common_errs,
+ int *per_rdev_errs, struct regulator_dev **rdev,
+ int rdev_amount);
+void *regulator_irq_helper(struct device *dev,
+ const struct regulator_irq_desc *d, int irq,
+ int irq_flags, int common_errs, int *per_rdev_errs,
+ struct regulator_dev **rdev, int rdev_amount);
+void regulator_irq_helper_cancel(void **handle);
void *rdev_get_drvdata(struct regulator_dev *rdev);
struct device *rdev_get_dev(struct regulator_dev *rdev);
--
2.25.4
--
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 =]
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v6 4/8] regulator: add property parsing and callbacks to set protection limits
2021-04-07 10:02 [PATCH v6 0/8] Extend regulator notification support Matti Vaittinen
` (2 preceding siblings ...)
2021-04-07 10:04 ` [PATCH v6 3/8] regulator: IRQ based event/error notification helpers Matti Vaittinen
@ 2021-04-07 10:04 ` Matti Vaittinen
2021-04-07 10:04 ` [PATCH v6 5/8] dt-bindings: regulator: bd9576 add FET ON-resistance for OCW Matti Vaittinen
` (3 subsequent siblings)
7 siblings, 0 replies; 15+ messages in thread
From: Matti Vaittinen @ 2021-04-07 10:04 UTC (permalink / raw)
To: Matti Vaittinen, Matti Vaittinen
Cc: Liam Girdwood, Mark Brown, Rob Herring, Matti Vaittinen,
Andy Gross, Bjorn Andersson, linux-kernel, devicetree,
linux-power, linux-arm-msm, linux-renesas-soc
Add DT property parsing code and setting callback for regulator over/under
voltage, over-current and temperature error limits.
Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
---
No changes since RFC-v3
---
drivers/regulator/core.c | 122 +++++++++++++++++++++-
drivers/regulator/of_regulator.c | 58 ++++++++++
drivers/regulator/qcom-labibb-regulator.c | 10 +-
drivers/regulator/qcom_spmi-regulator.c | 6 +-
drivers/regulator/stpmic1_regulator.c | 20 +++-
include/linux/regulator/driver.h | 41 +++++++-
include/linux/regulator/machine.h | 26 +++++
7 files changed, 274 insertions(+), 9 deletions(-)
diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index fabc83288e1b..5a3b932dc8a5 100644
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -1312,6 +1312,52 @@ static int machine_constraints_current(struct regulator_dev *rdev,
static int _regulator_do_enable(struct regulator_dev *rdev);
+static int notif_set_limit(struct regulator_dev *rdev,
+ int (*set)(struct regulator_dev *, int, int, bool),
+ int limit, int severity)
+{
+ bool enable;
+
+ if (limit == REGULATOR_NOTIF_LIMIT_DISABLE) {
+ enable = false;
+ limit = 0;
+ } else {
+ enable = true;
+ }
+
+ if (limit == REGULATOR_NOTIF_LIMIT_ENABLE)
+ limit = 0;
+
+ return set(rdev, limit, severity, enable);
+}
+
+static int handle_notify_limits(struct regulator_dev *rdev,
+ int (*set)(struct regulator_dev *, int, int, bool),
+ struct notification_limit *limits)
+{
+ int ret = 0;
+
+ if (!set)
+ return -EOPNOTSUPP;
+
+ if (limits->prot)
+ ret = notif_set_limit(rdev, set, limits->prot,
+ REGULATOR_SEVERITY_PROT);
+ if (ret)
+ return ret;
+
+ if (limits->err)
+ ret = notif_set_limit(rdev, set, limits->err,
+ REGULATOR_SEVERITY_ERR);
+ if (ret)
+ return ret;
+
+ if (limits->warn)
+ ret = notif_set_limit(rdev, set, limits->warn,
+ REGULATOR_SEVERITY_WARN);
+
+ return ret;
+}
/**
* set_machine_constraints - sets regulator constraints
* @rdev: regulator source
@@ -1397,9 +1443,27 @@ static int set_machine_constraints(struct regulator_dev *rdev)
}
}
+ /*
+ * Existing logic does not warn if over_current_protection is given as
+ * a constraint but driver does not support that. I think we should
+ * warn about this type of issues as it is possible someone changes
+ * PMIC on board to another type - and the another PMIC's driver does
+ * not support setting protection. Board composer may happily believe
+ * the DT limits are respected - especially if the new PMIC HW also
+ * supports protection but the driver does not. I won't change the logic
+ * without hearing more experienced opinion on this though.
+ *
+ * If warning is seen as a good idea then we can merge handling the
+ * over-curret protection and detection and get rid of this special
+ * handling.
+ */
if (rdev->constraints->over_current_protection
&& ops->set_over_current_protection) {
- ret = ops->set_over_current_protection(rdev);
+ int lim = rdev->constraints->over_curr_limits.prot;
+
+ ret = ops->set_over_current_protection(rdev, lim,
+ REGULATOR_SEVERITY_PROT,
+ true);
if (ret < 0) {
rdev_err(rdev, "failed to set over current protection: %pe\n",
ERR_PTR(ret));
@@ -1407,6 +1471,62 @@ static int set_machine_constraints(struct regulator_dev *rdev)
}
}
+ if (rdev->constraints->over_current_detection)
+ ret = handle_notify_limits(rdev,
+ ops->set_over_current_protection,
+ &rdev->constraints->over_curr_limits);
+ if (ret) {
+ if (ret != -EOPNOTSUPP) {
+ rdev_err(rdev, "failed to set over current limits: %pe\n",
+ ERR_PTR(ret));
+ return ret;
+ }
+ rdev_warn(rdev,
+ "IC does not support requested over-current limits\n");
+ }
+
+ if (rdev->constraints->over_voltage_detection)
+ ret = handle_notify_limits(rdev,
+ ops->set_over_voltage_protection,
+ &rdev->constraints->over_voltage_limits);
+ if (ret) {
+ if (ret != -EOPNOTSUPP) {
+ rdev_err(rdev, "failed to set over voltage limits %pe\n",
+ ERR_PTR(ret));
+ return ret;
+ }
+ rdev_warn(rdev,
+ "IC does not support requested over voltage limits\n");
+ }
+
+ if (rdev->constraints->under_voltage_detection)
+ ret = handle_notify_limits(rdev,
+ ops->set_under_voltage_protection,
+ &rdev->constraints->under_voltage_limits);
+ if (ret) {
+ if (ret != -EOPNOTSUPP) {
+ rdev_err(rdev, "failed to set under voltage limits %pe\n",
+ ERR_PTR(ret));
+ return ret;
+ }
+ rdev_warn(rdev,
+ "IC does not support requested under voltage limits\n");
+ }
+
+ if (rdev->constraints->over_temp_detection)
+ ret = handle_notify_limits(rdev,
+ ops->set_thermal_protection,
+ &rdev->constraints->temp_limits);
+ if (ret) {
+ if (ret != -EOPNOTSUPP) {
+ rdev_err(rdev, "failed to set temperature limits %pe\n",
+ ERR_PTR(ret));
+ return ret;
+ }
+ rdev_warn(rdev,
+ "IC does not support requested temperature limits\n");
+ }
+
if (rdev->constraints->active_discharge && ops->set_active_discharge) {
bool ad_state = (rdev->constraints->active_discharge ==
REGULATOR_ACTIVE_DISCHARGE_ENABLE) ? true : false;
diff --git a/drivers/regulator/of_regulator.c b/drivers/regulator/of_regulator.c
index 564f928eb1db..b70fdc5c7000 100644
--- a/drivers/regulator/of_regulator.c
+++ b/drivers/regulator/of_regulator.c
@@ -21,6 +21,62 @@ static const char *const regulator_states[PM_SUSPEND_MAX + 1] = {
[PM_SUSPEND_MAX] = "regulator-state-disk",
};
+static void fill_limit(int *limit, int val)
+{
+ if (val)
+ if (val == 1)
+ *limit = REGULATOR_NOTIF_LIMIT_ENABLE;
+ else
+ *limit = val;
+ else
+ *limit = REGULATOR_NOTIF_LIMIT_DISABLE;
+}
+
+static void of_get_regulator_prot_limits(struct device_node *np,
+ struct regulation_constraints *constraints)
+{
+ u32 pval;
+ int i;
+ static const char *const props[] = {
+ "regulator-oc-%s-microamp",
+ "regulator-ov-%s-microvolt",
+ "regulator-temp-%s-kelvin",
+ "regulator-uv-%s-microvolt",
+ };
+ struct notification_limit *limits[] = {
+ &constraints->over_curr_limits,
+ &constraints->over_voltage_limits,
+ &constraints->temp_limits,
+ &constraints->under_voltage_limits,
+ };
+ bool set[4] = {0};
+
+ /* Protection limits: */
+ for (i = 0; i < ARRAY_SIZE(props); i++) {
+ char prop[255];
+ bool found;
+ int j;
+ static const char *const lvl[] = {
+ "protection", "error", "warn"
+ };
+ int *l[] = {
+ &limits[i]->prot, &limits[i]->err, &limits[i]->warn,
+ };
+
+ for (j = 0; j < ARRAY_SIZE(lvl); j++) {
+ snprintf(prop, 255, props[i], lvl[j]);
+ found = !of_property_read_u32(np, prop, &pval);
+ if (found)
+ fill_limit(l[j], pval);
+ set[i] |= found;
+ }
+ }
+ constraints->over_current_detection = set[0];
+ constraints->over_voltage_detection = set[1];
+ constraints->over_temp_detection = set[2];
+ constraints->under_voltage_detection = set[3];
+}
+
static int of_get_regulation_constraints(struct device *dev,
struct device_node *np,
struct regulator_init_data **init_data,
@@ -188,6 +244,8 @@ static int of_get_regulation_constraints(struct device *dev,
constraints->over_current_protection = of_property_read_bool(np,
"regulator-over-current-protection");
+ of_get_regulator_prot_limits(np, constraints);
+
for (i = 0; i < ARRAY_SIZE(regulator_states); i++) {
switch (i) {
case PM_SUSPEND_MEM:
diff --git a/drivers/regulator/qcom-labibb-regulator.c b/drivers/regulator/qcom-labibb-regulator.c
index de25e3279b4b..b3da0dc58782 100644
--- a/drivers/regulator/qcom-labibb-regulator.c
+++ b/drivers/regulator/qcom-labibb-regulator.c
@@ -307,13 +307,21 @@ static irqreturn_t qcom_labibb_ocp_isr(int irq, void *chip)
return IRQ_HANDLED;
}
-static int qcom_labibb_set_ocp(struct regulator_dev *rdev)
+static int qcom_labibb_set_ocp(struct regulator_dev *rdev, int lim,
+ int severity, bool enable)
{
struct labibb_regulator *vreg = rdev_get_drvdata(rdev);
char *ocp_irq_name;
u32 irq_flags = IRQF_ONESHOT;
int irq_trig_low, ret;
+ /*
+ * labibb supports only protection - and does not support setting
+ * limit. Furthermore, we don't support disabling protection.
+ */
+ if (lim || severity != REGULATOR_SEVERITY_PROT || !enable)
+ return -EINVAL;
+
/* If there is no OCP interrupt, there's nothing to set */
if (vreg->ocp_irq <= 0)
return -EINVAL;
diff --git a/drivers/regulator/qcom_spmi-regulator.c b/drivers/regulator/qcom_spmi-regulator.c
index e62e1d72d943..45b29c8856bd 100644
--- a/drivers/regulator/qcom_spmi-regulator.c
+++ b/drivers/regulator/qcom_spmi-regulator.c
@@ -594,11 +594,15 @@ static int spmi_regulator_vs_enable(struct regulator_dev *rdev)
return regulator_enable_regmap(rdev);
}
-static int spmi_regulator_vs_ocp(struct regulator_dev *rdev)
+static int spmi_regulator_vs_ocp(struct regulator_dev *rdev, int lim_uA,
+ int severity, bool enable)
{
struct spmi_regulator *vreg = rdev_get_drvdata(rdev);
u8 reg = SPMI_VS_OCP_OVERRIDE;
+ if (lim_uA || !enable || severity != REGULATOR_SEVERITY_PROT)
+ return -EINVAL;
+
return spmi_vreg_write(vreg, SPMI_VS_REG_OCP, ®, 1);
}
diff --git a/drivers/regulator/stpmic1_regulator.c b/drivers/regulator/stpmic1_regulator.c
index cf10fdb72e32..2d7597c76e4a 100644
--- a/drivers/regulator/stpmic1_regulator.c
+++ b/drivers/regulator/stpmic1_regulator.c
@@ -32,7 +32,8 @@ struct stpmic1_regulator_cfg {
static int stpmic1_set_mode(struct regulator_dev *rdev, unsigned int mode);
static unsigned int stpmic1_get_mode(struct regulator_dev *rdev);
-static int stpmic1_set_icc(struct regulator_dev *rdev);
+static int stpmic1_set_icc(struct regulator_dev *rdev, int lim, int severity,
+ bool enable);
static unsigned int stpmic1_map_mode(unsigned int mode);
enum {
@@ -491,11 +492,26 @@ static int stpmic1_set_mode(struct regulator_dev *rdev, unsigned int mode)
STPMIC1_BUCK_MODE_LP, value);
}
-static int stpmic1_set_icc(struct regulator_dev *rdev)
+static int stpmic1_set_icc(struct regulator_dev *rdev, int lim, int severity,
+ bool enable)
{
struct stpmic1_regulator_cfg *cfg = rdev_get_drvdata(rdev);
struct regmap *regmap = rdev_get_regmap(rdev);
+ /*
+ * The code seems like one bit in a register controls whether OCP is
+ * enabled. So we might be able to turn it off here is if that
+ * was requested. I won't support this because I don't have the HW.
+ * Feel free to try and implement if you have the HW and need kernel
+ * to disable this.
+ *
+ * Also, I don't know if limit can be configured or if we support
+ * error/warning instead of protect. So I just keep existing logic
+ * and assume no.
+ */
+ if (lim || severity != REGULATOR_SEVERITY_PROT || !enable)
+ return -EINVAL;
+
/* enable switch off in case of over current */
return regmap_update_bits(regmap, cfg->icc_reg, cfg->icc_mask,
cfg->icc_mask);
diff --git a/include/linux/regulator/driver.h b/include/linux/regulator/driver.h
index 03a8eee9fca9..ded1933ae17a 100644
--- a/include/linux/regulator/driver.h
+++ b/include/linux/regulator/driver.h
@@ -40,6 +40,15 @@ enum regulator_status {
REGULATOR_STATUS_UNDEFINED,
};
+enum regulator_detection_severity {
+ /* Hardware shut down voltage outputs if condition is detected */
+ REGULATOR_SEVERITY_PROT,
+ /* Hardware is probably damaged/inoperable */
+ REGULATOR_SEVERITY_ERR,
+ /* Hardware is still recoverable but recovery action must be taken */
+ REGULATOR_SEVERITY_WARN,
+};
+
/* Initialize struct linear_range for regulators */
#define REGULATOR_LINEAR_RANGE(_min_uV, _min_sel, _max_sel, _step_uV) \
{ \
@@ -78,8 +87,25 @@ enum regulator_status {
* @get_current_limit: Get the configured limit for a current-limited regulator.
* @set_input_current_limit: Configure an input limit.
*
- * @set_over_current_protection: Support capability of automatically shutting
- * down when detecting an over current event.
+ * @set_over_current_protection: Support enabling of and setting limits for over
+ * current situation detection. Detection can be configured for three
+ * levels of severity.
+ * REGULATOR_SEVERITY_PROT should automatically shut down the regulator(s).
+ * REGULATOR_SEVERITY_ERR should indicate that over-current situation is
+ * caused by an unrecoverable error but HW does not perform
+ * automatic shut down.
+ * REGULATOR_SEVERITY_WARN should indicate situation where hardware is
+ * still believed to not be damaged but that a board sepcific
+ * recovery action is needed. If lim_uA is 0 the limit should not
+ * be changed but the detection should just be enabled/disabled as
+ * is requested.
+ * @set_over_voltage_protection: Support enabling of and setting limits for over
+ * voltage situation detection. Detection can be configured for same
+ * severities as over current protection.
+ * @set_under_voltage_protection: Support enabling of and setting limits for
+ * under situation detection.
+ * @set_thermal_protection: Support enabling of and setting limits for over
+ * temperature situation detection.
*
* @set_active_discharge: Set active discharge enable/disable of regulators.
*
@@ -143,8 +169,15 @@ struct regulator_ops {
int (*get_current_limit) (struct regulator_dev *);
int (*set_input_current_limit) (struct regulator_dev *, int lim_uA);
- int (*set_over_current_protection) (struct regulator_dev *);
- int (*set_active_discharge) (struct regulator_dev *, bool enable);
+ int (*set_over_current_protection)(struct regulator_dev *, int lim_uA,
+ int severity, bool enable);
+ int (*set_over_voltage_protection)(struct regulator_dev *, int lim_uV,
+ int severity, bool enable);
+ int (*set_under_voltage_protection)(struct regulator_dev *, int lim_uV,
+ int severity, bool enable);
+ int (*set_thermal_protection)(struct regulator_dev *, int lim,
+ int severity, bool enable);
+ int (*set_active_discharge)(struct regulator_dev *, bool enable);
/* enable/disable regulator */
int (*enable) (struct regulator_dev *);
diff --git a/include/linux/regulator/machine.h b/include/linux/regulator/machine.h
index 8a56f033b6cd..68b4a514a410 100644
--- a/include/linux/regulator/machine.h
+++ b/include/linux/regulator/machine.h
@@ -83,6 +83,14 @@ struct regulator_state {
bool changeable;
};
+#define REGULATOR_NOTIF_LIMIT_DISABLE -1
+#define REGULATOR_NOTIF_LIMIT_ENABLE -2
+struct notification_limit {
+ int prot;
+ int err;
+ int warn;
+};
+
/**
* struct regulation_constraints - regulator operating constraints.
*
@@ -100,6 +108,11 @@ struct regulator_state {
* @ilim_uA: Maximum input current.
* @system_load: Load that isn't captured by any consumer requests.
*
+ * @over_curr_limits: Limits for acting on over current.
+ * @over_voltage_limits: Limits for acting on over voltage.
+ * @under_voltage_limits: Limits for acting on under voltage.
+ * @temp_limits: Limits for acting on over temperature.
+
* @max_spread: Max possible spread between coupled regulators
* @max_uV_step: Max possible step change in voltage
* @valid_modes_mask: Mask of modes which may be configured by consumers.
@@ -116,6 +129,11 @@ struct regulator_state {
* @pull_down: Enable pull down when regulator is disabled.
* @over_current_protection: Auto disable on over current event.
*
+ * @over_current_detection: Configure over current limits.
+ * @over_voltage_detection: Configure over voltage limits.
+ * @under_voltage_detection: Configure under voltage limits.
+ * @over_temp_detection: Configure over temperature limits.
+ *
* @input_uV: Input voltage for regulator when supplied by another regulator.
*
* @state_disk: State for regulator when system is suspended in disk mode.
@@ -172,6 +190,10 @@ struct regulation_constraints {
struct regulator_state state_disk;
struct regulator_state state_mem;
struct regulator_state state_standby;
+ struct notification_limit over_curr_limits;
+ struct notification_limit over_voltage_limits;
+ struct notification_limit under_voltage_limits;
+ struct notification_limit temp_limits;
suspend_state_t initial_state; /* suspend state to set at init */
/* mode to set on startup */
@@ -193,6 +215,10 @@ struct regulation_constraints {
unsigned soft_start:1; /* ramp voltage slowly */
unsigned pull_down:1; /* pull down resistor when regulator off */
unsigned over_current_protection:1; /* auto disable on over current */
+ unsigned over_current_detection:1; /* notify on over current */
+ unsigned over_voltage_detection:1; /* notify on over voltage */
+ unsigned under_voltage_detection:1; /* notify on under voltage */
+ unsigned over_temp_detection:1; /* notify on over temperature */
};
/**
--
2.25.4
--
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 =]
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v6 5/8] dt-bindings: regulator: bd9576 add FET ON-resistance for OCW
2021-04-07 10:02 [PATCH v6 0/8] Extend regulator notification support Matti Vaittinen
` (3 preceding siblings ...)
2021-04-07 10:04 ` [PATCH v6 4/8] regulator: add property parsing and callbacks to set protection limits Matti Vaittinen
@ 2021-04-07 10:04 ` Matti Vaittinen
2021-04-08 15:22 ` Rob Herring
2021-04-07 10:05 ` [PATCH v6 6/8] regulator: bd9576: Support error reporting Matti Vaittinen
` (2 subsequent siblings)
7 siblings, 1 reply; 15+ messages in thread
From: Matti Vaittinen @ 2021-04-07 10:04 UTC (permalink / raw)
To: Matti Vaittinen, Matti Vaittinen
Cc: Liam Girdwood, Mark Brown, Rob Herring, Matti Vaittinen,
Andy Gross, Bjorn Andersson, linux-kernel, devicetree,
linux-power, linux-arm-msm, linux-renesas-soc
BD9576MUF provides over-current protection and detection. Current is
measured as voltage loss over external FET. Allow specifying FET's on
resistance so current monitoring limits can be converted to voltages.
Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
---
v5 onwards:
- No changes
v4:
- Fixed the description indentiation
---
.../bindings/regulator/rohm,bd9576-regulator.yaml | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml b/Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml
index b6515a0cee62..7cb74cc8c5d9 100644
--- a/Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml
+++ b/Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml
@@ -27,6 +27,12 @@ patternProperties:
Properties for single regulator.
$ref: "regulator.yaml#"
+ properties:
+ rohm,ocw-fet-ron-micro-ohms:
+ description: |
+ External FET's ON-resistance. Required if VoutS1 OCP/OCW is
+ to be set.
+
required:
- regulator-name
--
2.25.4
--
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 =]
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v6 6/8] regulator: bd9576: Support error reporting
2021-04-07 10:02 [PATCH v6 0/8] Extend regulator notification support Matti Vaittinen
` (4 preceding siblings ...)
2021-04-07 10:04 ` [PATCH v6 5/8] dt-bindings: regulator: bd9576 add FET ON-resistance for OCW Matti Vaittinen
@ 2021-04-07 10:05 ` Matti Vaittinen
2021-04-07 10:06 ` [PATCH v6 7/8] regulator: bd9576: Fix the driver name in id table Matti Vaittinen
2021-04-07 10:06 ` [PATCH v6 8/8] MAINTAINERS: Add reviewer for regulator irq_helpers Matti Vaittinen
7 siblings, 0 replies; 15+ messages in thread
From: Matti Vaittinen @ 2021-04-07 10:05 UTC (permalink / raw)
To: Matti Vaittinen, Matti Vaittinen
Cc: Liam Girdwood, Mark Brown, Rob Herring, Matti Vaittinen,
Andy Gross, Bjorn Andersson, linux-kernel, devicetree,
linux-power, linux-arm-msm, linux-renesas-soc
BD9573 and BD9576 support set of "protection" interrupts for "fatal"
issues. Those lead to SOC reset as PMIC shuts the power outputs. Thus
there is no relevant IRQ handling for them.
Few "detection" interrupts were added to the BD9576 with the idea that
SOC could take some recovery-action before error gets unrecoverable.
Add support for over and under voltage detection for Vout1 ... Vout4
and VoutL1. Add over-current detection for VoutS1 and finally a
thermal warning (common for all regulators) which alerts 30 C
before temperature reaches the thermal shutdown point. This way
consumer drivers can build error-recovery mechanisms.
Unfortunately the BD9576 interrupt logic was not re-evaluated. IRQs
are not designed to be properly acknowleged - and IRQ line is kept
active for whole duration of error condition (in comparison to
informing only about state change).
Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
---
No changes since RFC-v3
---
drivers/regulator/bd9576-regulator.c | 1056 ++++++++++++++++++++++----
1 file changed, 929 insertions(+), 127 deletions(-)
diff --git a/drivers/regulator/bd9576-regulator.c b/drivers/regulator/bd9576-regulator.c
index a8b5832a5a1b..0d55d383d2aa 100644
--- a/drivers/regulator/bd9576-regulator.c
+++ b/drivers/regulator/bd9576-regulator.c
@@ -2,10 +2,10 @@
// Copyright (C) 2020 ROHM Semiconductors
// ROHM BD9576MUF/BD9573MUF regulator driver
-#include <linux/delay.h>
#include <linux/err.h>
#include <linux/gpio/consumer.h>
#include <linux/interrupt.h>
+#include <linux/jiffies.h>
#include <linux/kernel.h>
#include <linux/mfd/rohm-bd957x.h>
#include <linux/mfd/rohm-generic.h>
@@ -16,11 +16,18 @@
#include <linux/regulator/machine.h>
#include <linux/regulator/of_regulator.h>
#include <linux/slab.h>
+#include <linux/spinlock.h>
+#include <linux/workqueue.h>
#define BD957X_VOUTS1_VOLT 3300000
#define BD957X_VOUTS4_BASE_VOLT 1030000
#define BD957X_VOUTS34_NUM_VOLT 32
+#define BD9576_THERM_IRQ_MASK_TW BIT(5)
+#define BD9576_xVD_IRQ_MASK_VOUTL1 BIT(5)
+#define BD9576_UVD_IRQ_MASK_VOUTS1_OCW BIT(6)
+#define BD9576_xVD_IRQ_MASK_VOUT1TO4 0x0F
+
static int vout1_volt_table[] = {5000000, 4900000, 4800000, 4700000, 4600000,
4500000, 4500000, 4500000, 5000000, 5100000,
5200000, 5300000, 5400000, 5500000, 5500000,
@@ -36,9 +43,85 @@ static int voutl1_volt_table[] = {2500000, 2540000, 2580000, 2620000, 2660000,
2420000, 2380000, 2340000, 2300000, 2260000,
2220000};
+static const struct linear_range vout1_xvd_ranges[] = {
+ REGULATOR_LINEAR_RANGE(225000, 0x01, 0x2b, 0),
+ REGULATOR_LINEAR_RANGE(225000, 0x2c, 0x54, 5000),
+ REGULATOR_LINEAR_RANGE(425000, 0x55, 0x7f, 0),
+};
+
+static const struct linear_range vout234_xvd_ranges[] = {
+ REGULATOR_LINEAR_RANGE(17000, 0x01, 0x0f, 0),
+ REGULATOR_LINEAR_RANGE(17000, 0x10, 0x6d, 1000),
+ REGULATOR_LINEAR_RANGE(110000, 0x6e, 0x7f, 0),
+};
+
+static const struct linear_range voutL1_xvd_ranges[] = {
+ REGULATOR_LINEAR_RANGE(34000, 0x01, 0x0f, 0),
+ REGULATOR_LINEAR_RANGE(34000, 0x10, 0x6d, 2000),
+ REGULATOR_LINEAR_RANGE(220000, 0x6e, 0x7f, 0),
+};
+
+static struct linear_range voutS1_ocw_ranges_internal[] = {
+ REGULATOR_LINEAR_RANGE(200000, 0x01, 0x04, 0),
+ REGULATOR_LINEAR_RANGE(250000, 0x05, 0x18, 50000),
+ REGULATOR_LINEAR_RANGE(1200000, 0x19, 0x3f, 0),
+};
+
+static struct linear_range voutS1_ocw_ranges[] = {
+ REGULATOR_LINEAR_RANGE(50000, 0x01, 0x04, 0),
+ REGULATOR_LINEAR_RANGE(60000, 0x05, 0x18, 10000),
+ REGULATOR_LINEAR_RANGE(250000, 0x19, 0x3f, 0),
+};
+
+static struct linear_range voutS1_ocp_ranges_internal[] = {
+ REGULATOR_LINEAR_RANGE(300000, 0x01, 0x06, 0),
+ REGULATOR_LINEAR_RANGE(350000, 0x7, 0x1b, 50000),
+ REGULATOR_LINEAR_RANGE(1350000, 0x1c, 0x3f, 0),
+};
+
+static struct linear_range voutS1_ocp_ranges[] = {
+ REGULATOR_LINEAR_RANGE(70000, 0x01, 0x06, 0),
+ REGULATOR_LINEAR_RANGE(80000, 0x7, 0x1b, 10000),
+ REGULATOR_LINEAR_RANGE(280000, 0x1c, 0x3f, 0),
+};
+
struct bd957x_regulator_data {
struct regulator_desc desc;
int base_voltage;
+ struct regulator_dev *rdev;
+ int ovd_notif;
+ int uvd_notif;
+ int temp_notif;
+ int ovd_err;
+ int uvd_err;
+ int temp_err;
+ const struct linear_range *xvd_ranges;
+ int num_xvd_ranges;
+ bool oc_supported;
+ unsigned int ovd_reg;
+ unsigned int uvd_reg;
+ unsigned int xvd_mask;
+ unsigned int ocp_reg;
+ unsigned int ocp_mask;
+ unsigned int ocw_reg;
+ unsigned int ocw_mask;
+ unsigned int ocw_rfet;
+};
+
+#define BD9576_NUM_REGULATORS 6
+#define BD9576_NUM_OVD_REGULATORS 5
+
+struct bd957x_data {
+ struct bd957x_regulator_data regulator_data[BD9576_NUM_REGULATORS];
+ struct regmap *regmap;
+ struct delayed_work therm_irq_suppress;
+ struct delayed_work ovd_irq_suppress;
+ struct delayed_work uvd_irq_suppress;
+ unsigned int therm_irq;
+ unsigned int ovd_irq;
+ unsigned int uvd_irq;
+ spinlock_t err_lock;
+ int regulator_global_err;
};
static int bd957x_vout34_list_voltage(struct regulator_dev *rdev,
@@ -72,151 +155,784 @@ static int bd957x_list_voltage(struct regulator_dev *rdev,
return desc->volt_table[index];
}
-static const struct regulator_ops bd957x_vout34_ops = {
+static void bd9576_fill_ovd_flags(struct bd957x_regulator_data *data,
+ bool warn)
+{
+ if (warn) {
+ data->ovd_notif = REGULATOR_EVENT_OVER_VOLTAGE_WARN;
+ data->ovd_err = REGULATOR_ERROR_OVER_VOLTAGE_WARN;
+ } else {
+ data->ovd_notif = REGULATOR_EVENT_REGULATION_OUT;
+ data->ovd_err = REGULATOR_ERROR_REGULATION_OUT;
+ }
+}
+
+static void bd9576_fill_ocp_flags(struct bd957x_regulator_data *data,
+ bool warn)
+{
+ if (warn) {
+ data->uvd_notif = REGULATOR_EVENT_OVER_CURRENT_WARN;
+ data->uvd_err = REGULATOR_ERROR_OVER_CURRENT_WARN;
+ } else {
+ data->uvd_notif = REGULATOR_EVENT_OVER_CURRENT;
+ data->uvd_err = REGULATOR_ERROR_OVER_CURRENT;
+ }
+}
+
+static void bd9576_fill_uvd_flags(struct bd957x_regulator_data *data,
+ bool warn)
+{
+ if (warn) {
+ data->uvd_notif = REGULATOR_EVENT_UNDER_VOLTAGE_WARN;
+ data->uvd_err = REGULATOR_ERROR_UNDER_VOLTAGE_WARN;
+ } else {
+ data->uvd_notif = REGULATOR_EVENT_UNDER_VOLTAGE;
+ data->uvd_err = REGULATOR_ERROR_UNDER_VOLTAGE;
+ }
+}
+
+static void bd9576_fill_temp_flags(struct bd957x_regulator_data *data,
+ bool enable, bool warn)
+{
+ if (!enable) {
+ data->temp_notif = 0;
+ data->temp_err = 0;
+ } else if (warn) {
+ data->temp_notif = REGULATOR_EVENT_OVER_TEMP_WARN;
+ data->temp_err = REGULATOR_ERROR_OVER_TEMP_WARN;
+ } else {
+ data->temp_notif = REGULATOR_EVENT_OVER_TEMP;
+ data->temp_err = REGULATOR_ERROR_OVER_TEMP;
+ }
+}
+
+static int bd9576_set_limit(const struct linear_range *r, int num_ranges,
+ struct regmap *regmap, int reg, int mask, int lim)
+{
+ int ret;
+ bool found;
+ int sel = 0;
+
+ if (lim) {
+
+ ret = linear_range_get_selector_low_array(r, num_ranges,
+ lim, &sel, &found);
+ if (ret)
+ return ret;
+
+ if (!found)
+ dev_warn(regmap_get_device(regmap),
+ "limit %d out of range. Setting lower\n",
+ lim);
+ }
+
+ return regmap_update_bits(regmap, reg, mask, sel);
+}
+
+static bool check_ocp_flag_mismatch(struct regulator_dev *rdev, int severity,
+ struct bd957x_regulator_data *r)
+{
+ if ((severity == REGULATOR_SEVERITY_ERR &&
+ r->uvd_notif != REGULATOR_EVENT_OVER_CURRENT) ||
+ (severity == REGULATOR_SEVERITY_WARN &&
+ r->uvd_notif != REGULATOR_EVENT_OVER_CURRENT_WARN)) {
+ dev_warn(rdev_get_dev(rdev),
+ "Can't support both OCP WARN and ERR\n");
+ /* Do not overwrite ERR config with WARN */
+ if (severity == REGULATOR_SEVERITY_WARN)
+ return true;
+
+ bd9576_fill_ocp_flags(r, 0);
+ }
+
+ return false;
+}
+
+static bool check_uvd_flag_mismatch(struct regulator_dev *rdev, int severity,
+ struct bd957x_regulator_data *r)
+{
+ if ((severity == REGULATOR_SEVERITY_ERR &&
+ r->uvd_notif != REGULATOR_EVENT_UNDER_VOLTAGE) ||
+ (severity == REGULATOR_SEVERITY_WARN &&
+ r->uvd_notif != REGULATOR_EVENT_UNDER_VOLTAGE_WARN)) {
+ dev_warn(rdev_get_dev(rdev),
+ "Can't support both UVD WARN and ERR\n");
+ if (severity == REGULATOR_SEVERITY_WARN)
+ return true;
+
+ bd9576_fill_uvd_flags(r, 0);
+ }
+
+ return false;
+}
+
+static bool check_ovd_flag_mismatch(struct regulator_dev *rdev, int severity,
+ struct bd957x_regulator_data *r)
+{
+ if ((severity == REGULATOR_SEVERITY_ERR &&
+ r->ovd_notif != REGULATOR_EVENT_REGULATION_OUT) ||
+ (severity == REGULATOR_SEVERITY_WARN &&
+ r->ovd_notif != REGULATOR_EVENT_OVER_VOLTAGE_WARN)) {
+ dev_warn(rdev_get_dev(rdev),
+ "Can't support both OVD WARN and ERR\n");
+ if (severity == REGULATOR_SEVERITY_WARN)
+ return true;
+
+ bd9576_fill_ovd_flags(r, 0);
+ }
+
+ return false;
+}
+
+static bool check_temp_flag_mismatch(struct regulator_dev *rdev, int severity,
+ struct bd957x_regulator_data *r)
+{
+ if ((severity == REGULATOR_SEVERITY_ERR &&
+ r->ovd_notif != REGULATOR_EVENT_OVER_TEMP) ||
+ (severity == REGULATOR_SEVERITY_WARN &&
+ r->ovd_notif != REGULATOR_EVENT_OVER_TEMP_WARN)) {
+ dev_warn(rdev_get_dev(rdev),
+ "Can't support both thermal WARN and ERR\n");
+ if (severity == REGULATOR_SEVERITY_WARN)
+ return true;
+ }
+
+ return false;
+}
+
+static int bd9576_set_ocp(struct regulator_dev *rdev, int lim_uA, int severity,
+ bool enable)
+{
+ struct bd957x_data *d;
+ struct bd957x_regulator_data *r;
+ int reg, mask;
+ int Vfet, rfet;
+ const struct linear_range *range;
+ int num_ranges;
+
+ if ((lim_uA && !enable) || (!lim_uA && enable))
+ return -EINVAL;
+
+ r = container_of(rdev->desc, struct bd957x_regulator_data, desc);
+ if (!r->oc_supported)
+ return -EINVAL;
+
+ d = rdev_get_drvdata(rdev);
+
+ if (severity == REGULATOR_SEVERITY_PROT) {
+ reg = r->ocp_reg;
+ mask = r->ocp_mask;
+ if (r->ocw_rfet) {
+ range = voutS1_ocp_ranges;
+ num_ranges = ARRAY_SIZE(voutS1_ocp_ranges);
+ rfet = r->ocw_rfet / 1000;
+ } else {
+ range = voutS1_ocp_ranges_internal;
+ num_ranges = ARRAY_SIZE(voutS1_ocp_ranges_internal);
+ /* Internal values are already micro-amperes */
+ rfet = 1000;
+ }
+ } else {
+ reg = r->ocw_reg;
+ mask = r->ocw_mask;
+
+ if (r->ocw_rfet) {
+ range = voutS1_ocw_ranges;
+ num_ranges = ARRAY_SIZE(voutS1_ocw_ranges);
+ rfet = r->ocw_rfet / 1000;
+ } else {
+ range = voutS1_ocw_ranges_internal;
+ num_ranges = ARRAY_SIZE(voutS1_ocw_ranges_internal);
+ /* Internal values are already micro-amperes */
+ rfet = 1000;
+ }
+
+ /* We abuse uvd fields for OCW on VoutS1 */
+ if (r->uvd_notif) {
+ /*
+ * If both warning and error are requested, prioritize
+ * ERROR configuration
+ */
+ if (check_ocp_flag_mismatch(rdev, severity, r))
+ return 0;
+ } else {
+ bool warn = severity == REGULATOR_SEVERITY_WARN;
+
+ bd9576_fill_ocp_flags(r, warn);
+ }
+ }
+
+ /*
+ * limits are given in uA, rfet is mOhm
+ * Divide lim_uA by 1000 to get Vfet in uV.
+ * (We expect both Rfet and limit uA to be magnitude of hundreds of
+ * milli Amperes & milli Ohms => we should still have decent accuracy)
+ */
+ Vfet = lim_uA/1000 * rfet;
+
+ return bd9576_set_limit(range, num_ranges, d->regmap,
+ reg, mask, Vfet);
+}
+
+static int bd9576_set_uvp(struct regulator_dev *rdev, int lim_uV, int severity,
+ bool enable)
+{
+ struct bd957x_data *d;
+ struct bd957x_regulator_data *r;
+ int mask, reg;
+
+ if (severity == REGULATOR_SEVERITY_PROT) {
+ if (!enable || lim_uV)
+ return -EINVAL;
+ return 0;
+ }
+
+ /*
+ * BD9576 has enable control as a special value in limit reg. Can't
+ * set limit but keep feature disabled or enable W/O given limit.
+ */
+ if ((lim_uV && !enable) || (!lim_uV && enable))
+ return -EINVAL;
+
+ r = container_of(rdev->desc, struct bd957x_regulator_data, desc);
+ d = rdev_get_drvdata(rdev);
+
+ mask = r->xvd_mask;
+ reg = r->uvd_reg;
+ /*
+ * Check that there is no mismatch for what the detection IRQs are to
+ * be used.
+ */
+ if (r->uvd_notif) {
+ if (check_uvd_flag_mismatch(rdev, severity, r))
+ return 0;
+ } else {
+ bd9576_fill_uvd_flags(r, severity == REGULATOR_SEVERITY_WARN);
+ }
+
+ return bd9576_set_limit(r->xvd_ranges, r->num_xvd_ranges, d->regmap,
+ reg, mask, lim_uV);
+}
+
+static int bd9576_set_ovp(struct regulator_dev *rdev, int lim_uV, int severity,
+ bool enable)
+{
+ struct bd957x_data *d;
+ struct bd957x_regulator_data *r;
+ int mask, reg;
+
+ if (severity == REGULATOR_SEVERITY_PROT) {
+ if (!enable || lim_uV)
+ return -EINVAL;
+ return 0;
+ }
+
+ /*
+ * BD9576 has enable control as a special value in limit reg. Can't
+ * set limit but keep feature disabled or enable W/O given limit.
+ */
+ if ((lim_uV && !enable) || (!lim_uV && enable))
+ return -EINVAL;
+
+ r = container_of(rdev->desc, struct bd957x_regulator_data, desc);
+ d = rdev_get_drvdata(rdev);
+
+ mask = r->xvd_mask;
+ reg = r->ovd_reg;
+ /*
+ * Check that there is no mismatch for what the detection IRQs are to
+ * be used.
+ */
+ if (r->ovd_notif) {
+ if (check_ovd_flag_mismatch(rdev, severity, r))
+ return 0;
+ } else {
+ bd9576_fill_ovd_flags(r, severity == REGULATOR_SEVERITY_WARN);
+ }
+
+ return bd9576_set_limit(r->xvd_ranges, r->num_xvd_ranges, d->regmap,
+ reg, mask, lim_uV);
+}
+
+
+static int bd9576_set_tw(struct regulator_dev *rdev, int lim, int severity,
+ bool enable)
+{
+ struct bd957x_data *d;
+ struct bd957x_regulator_data *r;
+ int i;
+
+ /*
+ * BD9576MUF has fixed temperature limits
+ * The detection can only be enabled/disabled
+ */
+ if (lim)
+ return -EINVAL;
+
+ /* Protection can't be disabled */
+ if (severity == REGULATOR_SEVERITY_PROT) {
+ if (!enable)
+ return -EINVAL;
+ else
+ return 0;
+ }
+
+ r = container_of(rdev->desc, struct bd957x_regulator_data, desc);
+ d = rdev_get_drvdata(rdev);
+
+ /*
+ * Check that there is no mismatch for what the detection IRQs are to
+ * be used.
+ */
+ if (r->temp_notif)
+ if (check_temp_flag_mismatch(rdev, severity, r))
+ return 0;
+
+ bd9576_fill_temp_flags(r, enable, severity == REGULATOR_SEVERITY_WARN);
+
+ if (enable)
+ return regmap_update_bits(d->regmap, BD957X_REG_INT_THERM_MASK,
+ BD9576_THERM_IRQ_MASK_TW, 0);
+
+ /*
+ * If any of the regulators is interested in thermal warning we keep IRQ
+ * enabled.
+ */
+ for (i = 0; i < BD9576_NUM_REGULATORS; i++)
+ if (d->regulator_data[i].temp_notif)
+ return 0;
+
+ return regmap_update_bits(d->regmap, BD957X_REG_INT_THERM_MASK,
+ BD9576_THERM_IRQ_MASK_TW,
+ BD9576_THERM_IRQ_MASK_TW);
+}
+
+static const struct regulator_ops bd9573_vout34_ops = {
+ .is_enabled = regulator_is_enabled_regmap,
+ .list_voltage = bd957x_vout34_list_voltage,
+ .get_voltage_sel = regulator_get_voltage_sel_regmap,
+};
+
+static const struct regulator_ops bd9576_vout34_ops = {
.is_enabled = regulator_is_enabled_regmap,
.list_voltage = bd957x_vout34_list_voltage,
.get_voltage_sel = regulator_get_voltage_sel_regmap,
+ .set_over_voltage_protection = bd9576_set_ovp,
+ .set_under_voltage_protection = bd9576_set_uvp,
+ .set_thermal_protection = bd9576_set_tw,
};
-static const struct regulator_ops bd957X_vouts1_regulator_ops = {
+static const struct regulator_ops bd9573_vouts1_regulator_ops = {
.is_enabled = regulator_is_enabled_regmap,
};
-static const struct regulator_ops bd957x_ops = {
+static const struct regulator_ops bd9576_vouts1_regulator_ops = {
+ .is_enabled = regulator_is_enabled_regmap,
+ .set_over_current_protection = bd9576_set_ocp,
+};
+
+static const struct regulator_ops bd9573_ops = {
+ .is_enabled = regulator_is_enabled_regmap,
+ .list_voltage = bd957x_list_voltage,
+ .get_voltage_sel = regulator_get_voltage_sel_regmap,
+};
+
+static const struct regulator_ops bd9576_ops = {
.is_enabled = regulator_is_enabled_regmap,
.list_voltage = bd957x_list_voltage,
.get_voltage_sel = regulator_get_voltage_sel_regmap,
+ .set_over_voltage_protection = bd9576_set_ovp,
+ .set_under_voltage_protection = bd9576_set_uvp,
+ .set_thermal_protection = bd9576_set_tw,
+};
+
+static const struct regulator_ops *bd9573_ops_arr[] = {
+ [BD957X_VD50] = &bd9573_ops,
+ [BD957X_VD18] = &bd9573_ops,
+ [BD957X_VDDDR] = &bd9573_vout34_ops,
+ [BD957X_VD10] = &bd9573_vout34_ops,
+ [BD957X_VOUTL1] = &bd9573_ops,
+ [BD957X_VOUTS1] = &bd9573_vouts1_regulator_ops,
};
-static struct bd957x_regulator_data bd9576_regulators[] = {
- {
- .desc = {
- .name = "VD50",
- .of_match = of_match_ptr("regulator-vd50"),
- .regulators_node = of_match_ptr("regulators"),
- .id = BD957X_VD50,
- .type = REGULATOR_VOLTAGE,
- .ops = &bd957x_ops,
- .volt_table = &vout1_volt_table[0],
- .n_voltages = ARRAY_SIZE(vout1_volt_table),
- .vsel_reg = BD957X_REG_VOUT1_TUNE,
- .vsel_mask = BD957X_MASK_VOUT1_TUNE,
- .enable_reg = BD957X_REG_POW_TRIGGER1,
- .enable_mask = BD957X_REGULATOR_EN_MASK,
- .enable_val = BD957X_REGULATOR_DIS_VAL,
- .enable_is_inverted = true,
- .owner = THIS_MODULE,
+static const struct regulator_ops *bd9576_ops_arr[] = {
+ [BD957X_VD50] = &bd9576_ops,
+ [BD957X_VD18] = &bd9576_ops,
+ [BD957X_VDDDR] = &bd9576_vout34_ops,
+ [BD957X_VD10] = &bd9576_vout34_ops,
+ [BD957X_VOUTL1] = &bd9576_ops,
+ [BD957X_VOUTS1] = &bd9576_vouts1_regulator_ops,
+};
+
+static int vouts1_get_fet_res(struct device_node *np,
+ const struct regulator_desc *desc,
+ struct regulator_config *cfg)
+{
+ struct bd957x_regulator_data *data;
+ int ret;
+ u32 uohms;
+
+ data = container_of(desc, struct bd957x_regulator_data, desc);
+
+ ret = of_property_read_u32(np, "rohm,ocw-fet-ron-micro-ohms", &uohms);
+ if (ret) {
+ if (ret != -EINVAL)
+ return ret;
+
+ return 0;
+ }
+ data->ocw_rfet = uohms;
+ return 0;
+}
+
+static struct bd957x_data bd957x_regulators = {
+ .regulator_data = {
+ {
+ .desc = {
+ .name = "VD50",
+ .of_match = of_match_ptr("regulator-vd50"),
+ .regulators_node = of_match_ptr("regulators"),
+ .id = BD957X_VD50,
+ .type = REGULATOR_VOLTAGE,
+ .volt_table = &vout1_volt_table[0],
+ .n_voltages = ARRAY_SIZE(vout1_volt_table),
+ .vsel_reg = BD957X_REG_VOUT1_TUNE,
+ .vsel_mask = BD957X_MASK_VOUT1_TUNE,
+ .enable_reg = BD957X_REG_POW_TRIGGER1,
+ .enable_mask = BD957X_REGULATOR_EN_MASK,
+ .enable_val = BD957X_REGULATOR_DIS_VAL,
+ .enable_is_inverted = true,
+ .owner = THIS_MODULE,
+ },
+ .xvd_ranges = vout1_xvd_ranges,
+ .num_xvd_ranges = ARRAY_SIZE(vout1_xvd_ranges),
+ .ovd_reg = BD9576_REG_VOUT1_OVD,
+ .uvd_reg = BD9576_REG_VOUT1_UVD,
+ .xvd_mask = BD9576_MASK_XVD,
},
- },
- {
- .desc = {
- .name = "VD18",
- .of_match = of_match_ptr("regulator-vd18"),
- .regulators_node = of_match_ptr("regulators"),
- .id = BD957X_VD18,
- .type = REGULATOR_VOLTAGE,
- .ops = &bd957x_ops,
- .volt_table = &vout2_volt_table[0],
- .n_voltages = ARRAY_SIZE(vout2_volt_table),
- .vsel_reg = BD957X_REG_VOUT2_TUNE,
- .vsel_mask = BD957X_MASK_VOUT2_TUNE,
- .enable_reg = BD957X_REG_POW_TRIGGER2,
- .enable_mask = BD957X_REGULATOR_EN_MASK,
- .enable_val = BD957X_REGULATOR_DIS_VAL,
- .enable_is_inverted = true,
- .owner = THIS_MODULE,
+ {
+ .desc = {
+ .name = "VD18",
+ .of_match = of_match_ptr("regulator-vd18"),
+ .regulators_node = of_match_ptr("regulators"),
+ .id = BD957X_VD18,
+ .type = REGULATOR_VOLTAGE,
+ .volt_table = &vout2_volt_table[0],
+ .n_voltages = ARRAY_SIZE(vout2_volt_table),
+ .vsel_reg = BD957X_REG_VOUT2_TUNE,
+ .vsel_mask = BD957X_MASK_VOUT2_TUNE,
+ .enable_reg = BD957X_REG_POW_TRIGGER2,
+ .enable_mask = BD957X_REGULATOR_EN_MASK,
+ .enable_val = BD957X_REGULATOR_DIS_VAL,
+ .enable_is_inverted = true,
+ .owner = THIS_MODULE,
+ },
+ .xvd_ranges = vout234_xvd_ranges,
+ .num_xvd_ranges = ARRAY_SIZE(vout234_xvd_ranges),
+ .ovd_reg = BD9576_REG_VOUT2_OVD,
+ .uvd_reg = BD9576_REG_VOUT2_UVD,
+ .xvd_mask = BD9576_MASK_XVD,
},
- },
- {
- .desc = {
- .name = "VDDDR",
- .of_match = of_match_ptr("regulator-vdddr"),
- .regulators_node = of_match_ptr("regulators"),
- .id = BD957X_VDDDR,
- .ops = &bd957x_vout34_ops,
- .type = REGULATOR_VOLTAGE,
- .n_voltages = BD957X_VOUTS34_NUM_VOLT,
- .vsel_reg = BD957X_REG_VOUT3_TUNE,
- .vsel_mask = BD957X_MASK_VOUT3_TUNE,
- .enable_reg = BD957X_REG_POW_TRIGGER3,
- .enable_mask = BD957X_REGULATOR_EN_MASK,
- .enable_val = BD957X_REGULATOR_DIS_VAL,
- .enable_is_inverted = true,
- .owner = THIS_MODULE,
+ {
+ .desc = {
+ .name = "VDDDR",
+ .of_match = of_match_ptr("regulator-vdddr"),
+ .regulators_node = of_match_ptr("regulators"),
+ .id = BD957X_VDDDR,
+ .type = REGULATOR_VOLTAGE,
+ .n_voltages = BD957X_VOUTS34_NUM_VOLT,
+ .vsel_reg = BD957X_REG_VOUT3_TUNE,
+ .vsel_mask = BD957X_MASK_VOUT3_TUNE,
+ .enable_reg = BD957X_REG_POW_TRIGGER3,
+ .enable_mask = BD957X_REGULATOR_EN_MASK,
+ .enable_val = BD957X_REGULATOR_DIS_VAL,
+ .enable_is_inverted = true,
+ .owner = THIS_MODULE,
+ },
+ .ovd_reg = BD9576_REG_VOUT3_OVD,
+ .uvd_reg = BD9576_REG_VOUT3_UVD,
+ .xvd_mask = BD9576_MASK_XVD,
+ .xvd_ranges = vout234_xvd_ranges,
+ .num_xvd_ranges = ARRAY_SIZE(vout234_xvd_ranges),
},
- },
- {
- .desc = {
- .name = "VD10",
- .of_match = of_match_ptr("regulator-vd10"),
- .regulators_node = of_match_ptr("regulators"),
- .id = BD957X_VD10,
- .ops = &bd957x_vout34_ops,
- .type = REGULATOR_VOLTAGE,
- .fixed_uV = BD957X_VOUTS4_BASE_VOLT,
- .n_voltages = BD957X_VOUTS34_NUM_VOLT,
- .vsel_reg = BD957X_REG_VOUT4_TUNE,
- .vsel_mask = BD957X_MASK_VOUT4_TUNE,
- .enable_reg = BD957X_REG_POW_TRIGGER4,
- .enable_mask = BD957X_REGULATOR_EN_MASK,
- .enable_val = BD957X_REGULATOR_DIS_VAL,
- .enable_is_inverted = true,
- .owner = THIS_MODULE,
+ {
+ .desc = {
+ .name = "VD10",
+ .of_match = of_match_ptr("regulator-vd10"),
+ .regulators_node = of_match_ptr("regulators"),
+ .id = BD957X_VD10,
+ .type = REGULATOR_VOLTAGE,
+ .fixed_uV = BD957X_VOUTS4_BASE_VOLT,
+ .n_voltages = BD957X_VOUTS34_NUM_VOLT,
+ .vsel_reg = BD957X_REG_VOUT4_TUNE,
+ .vsel_mask = BD957X_MASK_VOUT4_TUNE,
+ .enable_reg = BD957X_REG_POW_TRIGGER4,
+ .enable_mask = BD957X_REGULATOR_EN_MASK,
+ .enable_val = BD957X_REGULATOR_DIS_VAL,
+ .enable_is_inverted = true,
+ .owner = THIS_MODULE,
+ },
+ .xvd_ranges = vout234_xvd_ranges,
+ .num_xvd_ranges = ARRAY_SIZE(vout234_xvd_ranges),
+ .ovd_reg = BD9576_REG_VOUT4_OVD,
+ .uvd_reg = BD9576_REG_VOUT4_UVD,
+ .xvd_mask = BD9576_MASK_XVD,
},
- },
- {
- .desc = {
- .name = "VOUTL1",
- .of_match = of_match_ptr("regulator-voutl1"),
- .regulators_node = of_match_ptr("regulators"),
- .id = BD957X_VOUTL1,
- .ops = &bd957x_ops,
- .type = REGULATOR_VOLTAGE,
- .volt_table = &voutl1_volt_table[0],
- .n_voltages = ARRAY_SIZE(voutl1_volt_table),
- .vsel_reg = BD957X_REG_VOUTL1_TUNE,
- .vsel_mask = BD957X_MASK_VOUTL1_TUNE,
- .enable_reg = BD957X_REG_POW_TRIGGERL1,
- .enable_mask = BD957X_REGULATOR_EN_MASK,
- .enable_val = BD957X_REGULATOR_DIS_VAL,
- .enable_is_inverted = true,
- .owner = THIS_MODULE,
+ {
+ .desc = {
+ .name = "VOUTL1",
+ .of_match = of_match_ptr("regulator-voutl1"),
+ .regulators_node = of_match_ptr("regulators"),
+ .id = BD957X_VOUTL1,
+ .type = REGULATOR_VOLTAGE,
+ .volt_table = &voutl1_volt_table[0],
+ .n_voltages = ARRAY_SIZE(voutl1_volt_table),
+ .vsel_reg = BD957X_REG_VOUTL1_TUNE,
+ .vsel_mask = BD957X_MASK_VOUTL1_TUNE,
+ .enable_reg = BD957X_REG_POW_TRIGGERL1,
+ .enable_mask = BD957X_REGULATOR_EN_MASK,
+ .enable_val = BD957X_REGULATOR_DIS_VAL,
+ .enable_is_inverted = true,
+ .owner = THIS_MODULE,
+ },
+ .xvd_ranges = voutL1_xvd_ranges,
+ .num_xvd_ranges = ARRAY_SIZE(voutL1_xvd_ranges),
+ .ovd_reg = BD9576_REG_VOUTL1_OVD,
+ .uvd_reg = BD9576_REG_VOUTL1_UVD,
+ .xvd_mask = BD9576_MASK_XVD,
},
- },
- {
- .desc = {
- .name = "VOUTS1",
- .of_match = of_match_ptr("regulator-vouts1"),
- .regulators_node = of_match_ptr("regulators"),
- .id = BD957X_VOUTS1,
- .ops = &bd957X_vouts1_regulator_ops,
- .type = REGULATOR_VOLTAGE,
- .n_voltages = 1,
- .fixed_uV = BD957X_VOUTS1_VOLT,
- .enable_reg = BD957X_REG_POW_TRIGGERS1,
- .enable_mask = BD957X_REGULATOR_EN_MASK,
- .enable_val = BD957X_REGULATOR_DIS_VAL,
- .enable_is_inverted = true,
- .owner = THIS_MODULE,
+ {
+ .desc = {
+ .name = "VOUTS1",
+ .of_match = of_match_ptr("regulator-vouts1"),
+ .regulators_node = of_match_ptr("regulators"),
+ .id = BD957X_VOUTS1,
+ .type = REGULATOR_VOLTAGE,
+ .n_voltages = 1,
+ .fixed_uV = BD957X_VOUTS1_VOLT,
+ .enable_reg = BD957X_REG_POW_TRIGGERS1,
+ .enable_mask = BD957X_REGULATOR_EN_MASK,
+ .enable_val = BD957X_REGULATOR_DIS_VAL,
+ .enable_is_inverted = true,
+ .owner = THIS_MODULE,
+ .of_parse_cb = vouts1_get_fet_res,
+ },
+ .oc_supported = true,
+ .ocw_reg = BD9576_REG_VOUT1S_OCW,
+ .ocw_mask = BD9576_MASK_VOUT1S_OCW,
+ .ocp_reg = BD9576_REG_VOUT1S_OCP,
+ .ocp_mask = BD9576_MASK_VOUT1S_OCP,
},
},
};
+static int bd9576_renable(struct regulator_irq_data *rid, int reg, int mask)
+{
+ int val, ret;
+ struct bd957x_data *d = (struct bd957x_data *)rid->data;
+
+ ret = regmap_read(d->regmap, reg, &val);
+ if (ret)
+ return REGULATOR_FAILED_RETRY;
+
+ if (rid->opaque && rid->opaque == (val & mask)) {
+ /*
+ * It seems we stil have same status. Ack and return
+ * information that we are still out of limits and core
+ * should not enable IRQ
+ */
+ regmap_write(d->regmap, reg, mask & val);
+ return REGULATOR_ERROR_ON;
+ }
+ rid->opaque = 0;
+ /*
+ * Status was changed. Either prolem was solved or we have new issues.
+ * Let's re-enable IRQs and be prepared to report problems again
+ */
+ return REGULATOR_ERROR_CLEARED;
+}
+
+static int bd9576_uvd_renable(struct regulator_irq_data *rid)
+{
+ return bd9576_renable(rid, BD957X_REG_INT_UVD_STAT, UVD_IRQ_VALID_MASK);
+}
+
+static int bd9576_ovd_renable(struct regulator_irq_data *rid)
+{
+ return bd9576_renable(rid, BD957X_REG_INT_OVD_STAT, OVD_IRQ_VALID_MASK);
+}
+
+static int bd9576_temp_renable(struct regulator_irq_data *rid)
+{
+ return bd9576_renable(rid, BD957X_REG_INT_THERM_STAT,
+ BD9576_THERM_IRQ_MASK_TW);
+}
+
+static int bd9576_uvd_handler(int irq, struct regulator_irq_data *rid,
+ unsigned long *dev_mask)
+{
+ int val, ret, i;
+ struct bd957x_data *d = (struct bd957x_data *)rid->data;
+
+ ret = regmap_read(d->regmap, BD957X_REG_INT_UVD_STAT, &val);
+ if (ret)
+ return REGULATOR_FAILED_RETRY;
+
+ *dev_mask = 0;
+
+ rid->opaque = val & UVD_IRQ_VALID_MASK;
+
+ /*
+ * Go through the set status bits and report either error or warning
+ * to the notifier depending on what was flagged in DT
+ */
+ *dev_mask = val & BD9576_xVD_IRQ_MASK_VOUT1TO4;
+ /* There is 1 bit gap in register after Vout1 .. Vout4 statuses */
+ *dev_mask |= ((val & BD9576_xVD_IRQ_MASK_VOUTL1) >> 1);
+ /*
+ * We (ab)use the uvd for OCW notification. DT parsing should
+ * have added correct OCW flag to uvd_notif and uvd_err for S1
+ */
+ *dev_mask |= ((val & BD9576_UVD_IRQ_MASK_VOUTS1_OCW) >> 1);
+
+ for_each_set_bit(i, dev_mask, 6) {
+ struct bd957x_regulator_data *rdata;
+ struct regulator_err_state *stat;
+
+ rdata = &d->regulator_data[i];
+ stat = &rid->states[i];
+
+ stat->notifs = rdata->uvd_notif;
+ stat->errors = rdata->uvd_err;
+ }
+
+ ret = regmap_write(d->regmap, BD957X_REG_INT_UVD_STAT,
+ UVD_IRQ_VALID_MASK & val);
+
+ return 0;
+}
+
+static int bd9576_ovd_handler(int irq, struct regulator_irq_data *rid,
+ unsigned long *dev_mask)
+{
+ int val, ret, i;
+ struct bd957x_data *d = (struct bd957x_data *)rid->data;
+
+ ret = regmap_read(d->regmap, BD957X_REG_INT_OVD_STAT, &val);
+ if (ret)
+ return REGULATOR_FAILED_RETRY;
+
+ rid->opaque = val & OVD_IRQ_VALID_MASK;
+ *dev_mask = 0;
+
+ if (!(val & OVD_IRQ_VALID_MASK))
+ return 0;
+
+ *dev_mask = val & BD9576_xVD_IRQ_MASK_VOUT1TO4;
+ /* There is 1 bit gap in register after Vout1 .. Vout4 statuses */
+ *dev_mask |= ((val & BD9576_xVD_IRQ_MASK_VOUTL1) >> 1);
+
+ for_each_set_bit(i, dev_mask, 5) {
+ struct bd957x_regulator_data *rdata;
+ struct regulator_err_state *stat;
+
+ rdata = &d->regulator_data[i];
+ stat = &rid->states[i];
+
+ stat->notifs = rdata->ovd_notif;
+ stat->errors = rdata->ovd_err;
+ }
+
+ /* Clear the sub-IRQ status */
+ regmap_write(d->regmap, BD957X_REG_INT_OVD_STAT,
+ OVD_IRQ_VALID_MASK & val);
+
+ return 0;
+}
+
+#define BD9576_DEV_MASK_ALL_REGULATORS 0x3F
+
+static int bd9576_thermal_handler(int irq, struct regulator_irq_data *rid,
+ unsigned long *dev_mask)
+{
+ int val, ret, i;
+ struct bd957x_data *d = (struct bd957x_data *)rid->data;
+
+ ret = regmap_read(d->regmap, BD957X_REG_INT_THERM_STAT, &val);
+ if (ret)
+ return REGULATOR_FAILED_RETRY;
+
+ if (!(val & BD9576_THERM_IRQ_MASK_TW)) {
+ *dev_mask = 0;
+ return 0;
+ }
+
+ *dev_mask = BD9576_DEV_MASK_ALL_REGULATORS;
+
+ for (i = 0; i < BD9576_NUM_REGULATORS; i++) {
+ struct bd957x_regulator_data *rdata;
+ struct regulator_err_state *stat;
+
+ rdata = &d->regulator_data[i];
+ stat = &rid->states[i];
+
+ stat->notifs = rdata->temp_notif;
+ stat->errors = rdata->temp_err;
+ }
+
+ /* Clear the sub-IRQ status */
+ regmap_write(d->regmap, BD957X_REG_INT_THERM_STAT,
+ BD9576_THERM_IRQ_MASK_TW);
+
+ return 0;
+}
+
static int bd957x_probe(struct platform_device *pdev)
{
struct regmap *regmap;
struct regulator_config config = { 0 };
- int i, err;
- bool vout_mode, ddr_sel;
- const struct bd957x_regulator_data *reg_data = &bd9576_regulators[0];
- unsigned int num_reg_data = ARRAY_SIZE(bd9576_regulators);
+ int i, err = 0;
+ bool vout_mode, ddr_sel, may_have_irqs;
+ struct bd957x_data *ic_data;
+ unsigned int num_reg_data;
+ /* All regulators are related to UVD and thermal IRQs... */
+ struct regulator_dev *rdevs[BD9576_NUM_REGULATORS];
+ /* ...But VoutS1 is not flagged by OVD IRQ */
+ struct regulator_dev *ovd_devs[BD9576_NUM_OVD_REGULATORS];
+ static const struct regulator_irq_desc bd9576_notif_uvd = {
+ .name = "bd9576-uvd",
+ .irq_off_ms = 1000,
+ .map_event = bd9576_uvd_handler,
+ .renable = bd9576_uvd_renable,
+ .data = &bd957x_regulators,
+ };
+ static const struct regulator_irq_desc bd9576_notif_ovd = {
+ .name = "bd9576-ovd",
+ .irq_off_ms = 1000,
+ .map_event = bd9576_ovd_handler,
+ .renable = bd9576_ovd_renable,
+ .data = &bd957x_regulators,
+ };
+ static const struct regulator_irq_desc bd9576_notif_temp = {
+ .name = "bd9576-temp",
+ .irq_off_ms = 1000,
+ .map_event = bd9576_thermal_handler,
+ .renable = bd9576_temp_renable,
+ .data = &bd957x_regulators,
+ };
enum rohm_chip_type chip = platform_get_device_id(pdev)->driver_data;
+ num_reg_data = ARRAY_SIZE(bd957x_regulators.regulator_data);
+
+ ic_data = &bd957x_regulators;
+
regmap = dev_get_regmap(pdev->dev.parent, NULL);
if (!regmap) {
dev_err(&pdev->dev, "No regmap\n");
return -EINVAL;
}
+
+ ic_data->regmap = regmap;
vout_mode = of_property_read_bool(pdev->dev.parent->of_node,
"rohm,vout1-en-low");
if (vout_mode) {
@@ -263,15 +979,17 @@ static int bd957x_probe(struct platform_device *pdev)
* bytes and use bd9576_regulators directly for non-constant configs
* like DDR voltage selection.
*/
+ platform_set_drvdata(pdev, ic_data);
ddr_sel = of_property_read_bool(pdev->dev.parent->of_node,
"rohm,ddr-sel-low");
if (ddr_sel)
- bd9576_regulators[2].desc.fixed_uV = 1350000;
+ ic_data->regulator_data[2].desc.fixed_uV = 1350000;
else
- bd9576_regulators[2].desc.fixed_uV = 1500000;
+ ic_data->regulator_data[2].desc.fixed_uV = 1500000;
switch (chip) {
case ROHM_CHIP_TYPE_BD9576:
+ may_have_irqs = true;
dev_dbg(&pdev->dev, "Found BD9576MUF\n");
break;
case ROHM_CHIP_TYPE_BD9573:
@@ -280,37 +998,121 @@ static int bd957x_probe(struct platform_device *pdev)
default:
dev_err(&pdev->dev, "Unsupported chip type\n");
err = -EINVAL;
- goto err;
+ goto err_out;
+ }
+
+ for (i = 0; i < num_reg_data; i++) {
+ struct regulator_desc *d;
+
+ d = &ic_data->regulator_data[i].desc;
+
+
+ if (may_have_irqs) {
+ if (d->id >= ARRAY_SIZE(bd9576_ops_arr))
+ return -EINVAL;
+
+ d->ops = bd9576_ops_arr[d->id];
+ } else {
+ if (d->id >= ARRAY_SIZE(bd9573_ops_arr))
+ return -EINVAL;
+
+ d->ops = bd9573_ops_arr[d->id];
+ }
}
config.dev = pdev->dev.parent;
config.regmap = regmap;
+ config.driver_data = ic_data;
for (i = 0; i < num_reg_data; i++) {
- const struct regulator_desc *desc;
- struct regulator_dev *rdev;
- const struct bd957x_regulator_data *r;
+ struct bd957x_regulator_data *r = &ic_data->regulator_data[i];
+ const struct regulator_desc *desc = &r->desc;
- r = ®_data[i];
- desc = &r->desc;
-
- rdev = devm_regulator_register(&pdev->dev, desc, &config);
- if (IS_ERR(rdev)) {
+ r->rdev = devm_regulator_register(&pdev->dev, desc,
+ &config);
+ if (IS_ERR(r->rdev)) {
dev_err(&pdev->dev,
"failed to register %s regulator\n",
desc->name);
- err = PTR_ERR(rdev);
- goto err;
+ err = PTR_ERR(r->rdev);
+ goto err_out;
}
/*
* Clear the VOUT1 GPIO setting - rest of the regulators do not
* support GPIO control
*/
config.ena_gpiod = NULL;
+
+ if (!may_have_irqs)
+ continue;
+
+ rdevs[i] = r->rdev;
+ if (i < BD957X_VOUTS1)
+ ovd_devs[i] = r->rdev;
}
+ if (may_have_irqs) {
+ void *ret;
+ /*
+ * We can add both the possible error and warning flags here
+ * because the core uses these only for status clearing and
+ * if we use warnings - errors are always clear and the other
+ * way around. We can also add CURRENT flag for all regulators
+ * because it is never set if it is not supported. Same applies
+ * to setting UVD for VoutS1 - it is not accidentally cleared
+ * as it is never set.
+ */
+ int uvd_errs = REGULATOR_ERROR_UNDER_VOLTAGE |
+ REGULATOR_ERROR_UNDER_VOLTAGE_WARN |
+ REGULATOR_ERROR_OVER_CURRENT |
+ REGULATOR_ERROR_OVER_CURRENT_WARN;
+ int ovd_errs = REGULATOR_ERROR_OVER_VOLTAGE_WARN |
+ REGULATOR_ERROR_REGULATION_OUT;
+ int temp_errs = REGULATOR_ERROR_OVER_TEMP |
+ REGULATOR_ERROR_OVER_TEMP_WARN;
+ int irq;
+
+ irq = platform_get_irq_byname(pdev, "bd9576-uvd");
+
+ /* Register notifiers - can fail if IRQ is not given */
+ ret = devm_regulator_irq_helper(&pdev->dev, &bd9576_notif_uvd,
+ irq, 0, uvd_errs, NULL,
+ &rdevs[0],
+ BD9576_NUM_REGULATORS);
+ if (IS_ERR(ret)) {
+ if (PTR_ERR(ret) == -EPROBE_DEFER)
+ return -EPROBE_DEFER;
+
+ dev_warn(&pdev->dev, "UVD disabled %pe\n", ret);
+ }
+
+ irq = platform_get_irq_byname(pdev, "bd9576-ovd");
+
+ ret = devm_regulator_irq_helper(&pdev->dev, &bd9576_notif_ovd,
+ irq, 0, ovd_errs, NULL,
+ &ovd_devs[0],
+ BD9576_NUM_OVD_REGULATORS);
+ if (IS_ERR(ret)) {
+ if (PTR_ERR(ret) == -EPROBE_DEFER)
+ return -EPROBE_DEFER;
+
+ dev_warn(&pdev->dev, "OVD disabled %pe\n", ret);
+ }
+ irq = platform_get_irq_byname(pdev, "bd9576-temp");
+
+ ret = devm_regulator_irq_helper(&pdev->dev, &bd9576_notif_temp,
+ irq, 0, temp_errs, NULL,
+ &rdevs[0],
+ BD9576_NUM_REGULATORS);
+ if (IS_ERR(ret)) {
+ if (PTR_ERR(ret) == -EPROBE_DEFER)
+ return -EPROBE_DEFER;
-err:
+ dev_warn(&pdev->dev, "Thermal warning disabled %pe\n",
+ ret);
+ }
+ }
+err_out:
return err;
}
--
2.25.4
--
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 =]
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v6 7/8] regulator: bd9576: Fix the driver name in id table
2021-04-07 10:02 [PATCH v6 0/8] Extend regulator notification support Matti Vaittinen
` (5 preceding siblings ...)
2021-04-07 10:05 ` [PATCH v6 6/8] regulator: bd9576: Support error reporting Matti Vaittinen
@ 2021-04-07 10:06 ` Matti Vaittinen
2021-04-07 10:06 ` [PATCH v6 8/8] MAINTAINERS: Add reviewer for regulator irq_helpers Matti Vaittinen
7 siblings, 0 replies; 15+ messages in thread
From: Matti Vaittinen @ 2021-04-07 10:06 UTC (permalink / raw)
To: Matti Vaittinen, Matti Vaittinen
Cc: Liam Girdwood, Mark Brown, Rob Herring, Matti Vaittinen,
Andy Gross, Bjorn Andersson, linux-kernel, devicetree,
linux-power, linux-arm-msm, linux-renesas-soc
Driver name was changed in MFD cell:
https://lore.kernel.org/lkml/560b9748094392493ebf7af11b6cc558776c4fd5.1613031055.git.matti.vaittinen@fi.rohmeurope.com/
Fix the ID table to match this.
Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
---
Please note - this patch is not really related to the series. This
change is related to separate MFD driver change and was only added
as part of this series to avoid the conflicts.
No changes since RFC-v2
---
drivers/regulator/bd9576-regulator.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/drivers/regulator/bd9576-regulator.c b/drivers/regulator/bd9576-regulator.c
index 0d55d383d2aa..aeb816cf9ad3 100644
--- a/drivers/regulator/bd9576-regulator.c
+++ b/drivers/regulator/bd9576-regulator.c
@@ -1117,8 +1117,8 @@ static int bd957x_probe(struct platform_device *pdev)
}
static const struct platform_device_id bd957x_pmic_id[] = {
- { "bd9573-pmic", ROHM_CHIP_TYPE_BD9573 },
- { "bd9576-pmic", ROHM_CHIP_TYPE_BD9576 },
+ { "bd9573-regulator", ROHM_CHIP_TYPE_BD9573 },
+ { "bd9576-regulator", ROHM_CHIP_TYPE_BD9576 },
{ },
};
MODULE_DEVICE_TABLE(platform, bd957x_pmic_id);
--
2.25.4
--
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 =]
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v6 8/8] MAINTAINERS: Add reviewer for regulator irq_helpers
2021-04-07 10:02 [PATCH v6 0/8] Extend regulator notification support Matti Vaittinen
` (6 preceding siblings ...)
2021-04-07 10:06 ` [PATCH v6 7/8] regulator: bd9576: Fix the driver name in id table Matti Vaittinen
@ 2021-04-07 10:06 ` Matti Vaittinen
7 siblings, 0 replies; 15+ messages in thread
From: Matti Vaittinen @ 2021-04-07 10:06 UTC (permalink / raw)
To: Matti Vaittinen, Matti Vaittinen
Cc: Liam Girdwood, Mark Brown, Rob Herring, Matti Vaittinen,
Andy Gross, Bjorn Andersson, linux-kernel, devicetree,
linux-power, linux-arm-msm, linux-renesas-soc
Add a reviewer entry for the regulator irq_helpers.
Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
---
Changelog:
v6:
- New patch
---
MAINTAINERS | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/MAINTAINERS b/MAINTAINERS
index c80ad735b384..8ed6af3e66f7 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -19211,6 +19211,10 @@ F: include/dt-bindings/regulator/
F: include/linux/regulator/
K: regulator_get_optional
+VOLTAGE AND CURRENT REGULATOR IRQ HELPERS
+R: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
+F: drivers/regulator/irq_helpers.c
+
VRF
M: David Ahern <dsahern@kernel.org>
L: netdev@vger.kernel.org
--
2.25.4
--
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 =]
^ permalink raw reply related [flat|nested] 15+ messages in thread
* Re: [PATCH v6 3/8] regulator: IRQ based event/error notification helpers
2021-04-07 10:04 ` [PATCH v6 3/8] regulator: IRQ based event/error notification helpers Matti Vaittinen
@ 2021-04-07 13:21 ` Andy Shevchenko
2021-04-08 5:22 ` Matti Vaittinen
2021-04-08 8:21 ` Matti Vaittinen
0 siblings, 2 replies; 15+ messages in thread
From: Andy Shevchenko @ 2021-04-07 13:21 UTC (permalink / raw)
To: Matti Vaittinen
Cc: Matti Vaittinen, Liam Girdwood, Mark Brown, Rob Herring,
Andy Gross, Bjorn Andersson, Linux Kernel Mailing List,
devicetree, linux-power, linux-arm-msm, Linux-Renesas
On Wed, Apr 7, 2021 at 1:04 PM Matti Vaittinen
<matti.vaittinen@fi.rohmeurope.com> wrote:
>
> Provide helper function for IC's implementing regulator notifications
> when an IRQ fires. The helper also works for IRQs which can not be acked.
> Helper can be set to disable the IRQ at handler and then re-enabling it
> on delayed work later. The helper also adds regulator_get_error_flags()
> errors in cache for the duration of IRQ disabling.
Thanks for an update, my comments below. After addressing them, feel free to add
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
> Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
>
> ---
> v6 (fix issues noted by Andy):
> - remove unnecessary variable
> - use BIT(foo) instead of 1 << foo
> - use devm_add_action_or_reset()
> - do not check the irq parameter validity, leave that to
> request_threaded_irq()
> - put resource-managed function in devres.c
> - fix the kerneldocs for the new IRQ helpers
> v5:
> - fix the pr_emerg print
> v4:
> - Comment block styling
> - Added prints to point the potential HW failure before BUG()
> - Corrected typo from kerneldoc
> - added missing newlines
> ---
> drivers/regulator/Makefile | 2 +-
> drivers/regulator/core.c | 24 +-
> drivers/regulator/devres.c | 49 ++++
> drivers/regulator/irq_helpers.c | 396 +++++++++++++++++++++++++++++++
> include/linux/regulator/driver.h | 135 +++++++++++
> 5 files changed, 602 insertions(+), 4 deletions(-)
> create mode 100644 drivers/regulator/irq_helpers.c
>
> diff --git a/drivers/regulator/Makefile b/drivers/regulator/Makefile
> index 44d2f8bf4b74..e25f1c2d6c9b 100644
> --- a/drivers/regulator/Makefile
> +++ b/drivers/regulator/Makefile
> @@ -4,7 +4,7 @@
> #
>
>
> -obj-$(CONFIG_REGULATOR) += core.o dummy.o fixed-helper.o helpers.o devres.o
> +obj-$(CONFIG_REGULATOR) += core.o dummy.o fixed-helper.o helpers.o devres.o irq_helpers.o
> obj-$(CONFIG_OF) += of_regulator.o
> obj-$(CONFIG_REGULATOR_FIXED_VOLTAGE) += fixed.o
> obj-$(CONFIG_REGULATOR_VIRTUAL_CONSUMER) += virtual.o
> diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
> index 16114aea099a..fabc83288e1b 100644
> --- a/drivers/regulator/core.c
> +++ b/drivers/regulator/core.c
> @@ -4388,20 +4388,37 @@ unsigned int regulator_get_mode(struct regulator *regulator)
> }
> EXPORT_SYMBOL_GPL(regulator_get_mode);
>
> +static int rdev_get_cached_err_flags(struct regulator_dev *rdev)
> +{
> + int ret = 0;
> +
> + if (rdev->use_cached_err) {
> + spin_lock(&rdev->err_lock);
> + ret = rdev->cached_err;
> + spin_unlock(&rdev->err_lock);
> + }
> + return ret;
Not critical, but I would rather have it this way
if (! bla bla bla) // space after ! on visibility purpose
return 0;
spin lock
ret =
spin unlock
return ret;
And drop ret = 0, the main reason why I pointed to this. We have a lot
of issues of hiding (potential) errors due to global assignments like
this. I saw some problematic patches that people unthoughtfully put
such an assignment to shut the compiler up about uninitialized
variables.
however it's not critical per se, can be refactored later.
> +}
> +
> static int _regulator_get_error_flags(struct regulator_dev *rdev,
> unsigned int *flags)
> {
> - int ret;
> + int ret, tmpret;
>
> regulator_lock(rdev);
>
> + ret = rdev_get_cached_err_flags(rdev);
> +
> /* sanity check */
> - if (!rdev->desc->ops->get_error_flags) {
> + if (rdev->desc->ops->get_error_flags) {
> + tmpret = rdev->desc->ops->get_error_flags(rdev, flags);
> + if (tmpret > 0)
> + ret |= tmpret;
Oh, I don't like this. Easy fix is to rename ret (okay, it's been used
elsewhere, so adding then) to something meaningful, like error_flags,
then you can easily understand that value should be positive and error
codes are negative.
> + } else if (!rdev->use_cached_err) {
> ret = -EINVAL;
> goto out;
> }
>
> - ret = rdev->desc->ops->get_error_flags(rdev, flags);
> out:
> regulator_unlock(rdev);
> return ret;
> @@ -5236,6 +5253,7 @@ regulator_register(const struct regulator_desc *regulator_desc,
> goto rinse;
> }
> device_initialize(&rdev->dev);
> + spin_lock_init(&rdev->err_lock);
>
> /*
> * Duplicate the config so the driver could override it after
> diff --git a/drivers/regulator/devres.c b/drivers/regulator/devres.c
> index 3091210889e3..127262dcd3f7 100644
> --- a/drivers/regulator/devres.c
> +++ b/drivers/regulator/devres.c
> @@ -481,3 +481,52 @@ void devm_regulator_unregister_notifier(struct regulator *regulator,
> WARN_ON(rc);
> }
> EXPORT_SYMBOL_GPL(devm_regulator_unregister_notifier);
> +
> +static void regulator_irq_helper_drop(void *res)
> +{
> + regulator_irq_helper_cancel(&res);
> +}
> +
> +/**
> + * devm_regulator_irq_helper - resource managed registration of IRQ based
> + * regulator event/error notifier
> + *
> + * @dev: device to which lifetime the helper's lifetime is
> + * bound.
> + * @d: IRQ helper descriptor.
> + * @irq: IRQ used to inform events/errors to be notified.
> + * @irq_flags: Extra IRQ flags to be OR's with the default IRQF_ONESHOT
OR'ed
> + * when requesting the (threaded) irq.
> + * @common_errs: Errors which can be flagged by this IRQ for all rdevs.
> + * When IRQ is re-enabled these errors will be cleared
> + * from all associated regulators
> + * @per_rdev_errs: Optional error flag array describing errors specific
> + * for only some of the regulators. These errors will be
> + * or'ed with common errors. If this is given the array
> + * should contain rdev_amount flags. Can be set to NULL
> + * if there is no regulator specific error flags for this
> + * IRQ.
> + * @rdev: Array of regulators associated with this IRQ.
> + * @rdev_amount: Amount of regulators associated wit this IRQ.
wit -> with
Can you describe, please, the return value meaning. It will be good
also to move detailed descriptions (expectations?) of the fields to
the Description section, here.
> + */
> +void *devm_regulator_irq_helper(struct device *dev,
> + const struct regulator_irq_desc *d, int irq,
> + int irq_flags, int common_errs,
> + int *per_rdev_errs,
> + struct regulator_dev **rdev, int rdev_amount)
I didn't get why you need the ** pointer instead of plain pointer.
> +{
> + void *ptr;
> + int ret;
> +
> + ptr = regulator_irq_helper(dev, d, irq, irq_flags, common_errs,
> + per_rdev_errs, rdev, rdev_amount);
> + if (IS_ERR(ptr))
> + return ptr;
> + ret = devm_add_action_or_reset(dev, regulator_irq_helper_drop, ptr);
> + if (ret)
> + return ERR_PTR(ret);
> +
> + return ptr;
> +}
> +EXPORT_SYMBOL_GPL(devm_regulator_irq_helper);
> diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helpers.c
> new file mode 100644
> index 000000000000..374ff0f3c6d3
> --- /dev/null
> +++ b/drivers/regulator/irq_helpers.c
> @@ -0,0 +1,396 @@
> +// SPDX-License-Identifier: GPL-2.0
> +//
> +// Copyright (C) 2021 ROHM Semiconductors
> +// regulator IRQ based event notification helpers
> +//
> +// Logic has been partially adapted from qcom-labibb driver.
> +//
> +// Author: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
> +
> +#include <linux/device.h>
> +#include <linux/err.h>
> +#include <linux/kernel.h>
> +#include <linux/of_irq.h>
Not sure how this header is used. I haven't found any direct users of
it. Perhaps you wanted interrupt.h?
> +#include <linux/regmap.h>
> +#include <linux/slab.h>
> +#include <linux/spinlock.h>
+ Blank line? I would separate group of generic headers with
particular to the subsystem
> +#include <linux/regulator/driver.h>
> +
> +struct regulator_irq {
> + struct regulator_irq_data rdata;
> + struct regulator_irq_desc desc;
> + int irq;
> + int retry_cnt;
> + struct delayed_work isr_work;
> +};
> +
> +/*
> + * Should only be called from threaded handler to prevent potential deadlock
> + */
> +static void rdev_flag_err(struct regulator_dev *rdev, int err)
> +{
> + spin_lock(&rdev->err_lock);
> + rdev->cached_err |= err;
> + spin_unlock(&rdev->err_lock);
> +}
> +
> +static void rdev_clear_err(struct regulator_dev *rdev, int err)
> +{
> + spin_lock(&rdev->err_lock);
> + rdev->cached_err &= ~err;
> + spin_unlock(&rdev->err_lock);
> +}
> +
> +static void die_loudly(const char *msg)
I feel that this is a too generic name, perhaps rdev_die_loudly().
> +{
> + pr_emerg("%s\n", msg);
> + BUG();
> +}
> +
> +static void regulator_notifier_isr_work(struct work_struct *work)
> +{
> + struct regulator_irq *h;
> + struct regulator_irq_desc *d;
> + struct regulator_irq_data *rid;
> + int ret = 0;
> + int tmo, i;
> + int num_rdevs;
> +
> + h = container_of(work, struct regulator_irq,
> + isr_work.work);
> + d = &h->desc;
> + rid = &h->rdata;
> + num_rdevs = rid->num_states;
> +
> +reread:
> + if (d->fatal_cnt && h->retry_cnt > d->fatal_cnt) {
> + if (d->die)
> + ret = d->die(rid);
> + else
> + die_loudly("Regulator HW failure? - no IC recovery");
> +
> + /*
> + * If the 'last resort' IC recovery failed we will have
> + * nothing else left to do...
> + */
> + if (ret)
> + die_loudly("Regulator HW failure? - IC recovery failed");
Looking at the above code this will be executed if and only if
d->die() is defined, correct?
In that case, why not
if (d->die) {
ret = ...
if (ret)
rdev_die_loudly(...);
} else
rdev_die_loudly(...);
?
> + /*
> + * If h->die() was implemented we assume recovery has been
> + * attempted (probably regulator was shut down)
> + * and we just enable IRQ and bail-out.
> + */
> + goto enable_out;
> + }
> + if (d->renable) {
> + ret = d->renable(rid);
> +
> + if (ret == REGULATOR_FAILED_RETRY) {
> + /* Driver could not get current status */
> + h->retry_cnt++;
> + if (!d->reread_ms)
> + goto reread;
> +
> + tmo = d->reread_ms;
> + goto reschedule;
> + }
> +
> + if (ret) {
> + /*
> + * IC status reading succeeded. update error info
> + * just in case the renable changed it.
> + */
> + for (i = 0; i < num_rdevs; i++) {
> + struct regulator_err_state *stat;
> + struct regulator_dev *rdev;
> +
> + stat = &rid->states[i];
> + rdev = stat->rdev;
> + rdev_clear_err(rdev, (~stat->errors) &
> + stat->possible_errs);
> + }
> + h->retry_cnt++;
> + /*
> + * The IC indicated problem is still ON - no point in
> + * re-enabling the IRQ. Retry later.
> + */
> + tmo = d->irq_off_ms;
> + goto reschedule;
> + }
> + }
> +
> + /*
> + * Either IC reported problem cleared or no status checker was provided.
> + * If problems are gone - good. If not - then the IRQ will fire again
> + * and we'll have new nice loop. In any case we should clear error flags
have a new
> + * here and re-enable IRQs.
> + */
> + for (i = 0; i < num_rdevs; i++) {
> + struct regulator_err_state *stat;
> + struct regulator_dev *rdev;
> +
> + stat = &rid->states[i];
> + rdev = stat->rdev;
> + rdev_clear_err(rdev, stat->possible_errs);
> + }
> +
> + /*
> + * Things have been seemingly successful => zero retry-counter.
> + */
> + h->retry_cnt = 0;
> +
> +enable_out:
> + enable_irq(h->irq);
> +
> + return;
> +
> +reschedule:
> + if (!d->high_prio)
> + mod_delayed_work(system_wq, &h->isr_work,
> + msecs_to_jiffies(tmo));
> + else
> + mod_delayed_work(system_highpri_wq, &h->isr_work,
> + msecs_to_jiffies(tmo));
> +}
> +
> +static irqreturn_t regulator_notifier_isr(int irq, void *data)
> +{
> + struct regulator_irq *h = data;
> + struct regulator_irq_desc *d;
> + struct regulator_irq_data *rid;
> + unsigned long rdev_map = 0;
> + int num_rdevs;
> + int ret, i, j;
> +
> + d = &h->desc;
> + rid = &h->rdata;
> + num_rdevs = rid->num_states;
> +
> + if (d->fatal_cnt)
> + h->retry_cnt++;
> +
> + /*
> + * we spare few cycles by not clearing statuses prior this call.
We spare a few
prior to this
> + * The IC driver must initialize the status buffers for rdevs
> + * which it indicates having active events via rdev_map.
> + *
> + * Maybe we should just to be on a safer side(?)
> + */
> + ret = d->map_event(irq, rid, &rdev_map);
> +
> + /*
> + * If status reading fails (which is unlikely) we don't ack/disable
> + * IRQ but just increase fail count and retry when IRQ fires again.
> + * If retry_count exceeds given safety limit we call IC specific die
exceeds the given
> + * handler which can try disabling regulator(s).
> + *
> + * If no die handler is given we will just bug() as a last resort.
> + *
> + * We could try disabling all associated rdevs - but we might shoot
> + * ourself in the head and leave problematic regulator enabled. So
ourselves
the problematic regulator
> + * if IC has no die-handler populated we just assume the regulator
> + * can't be disabled.
> + */
> + if (unlikely(ret == REGULATOR_FAILED_RETRY))
> + goto fail_out;
> +
> + h->retry_cnt = 0;
> + /*
> + * Let's not disable IRQ if there was no status bits for us. We'd
were
> + * better leave spurious IRQ handling to genirq
> + */
> + if (ret || !rdev_map)
> + return IRQ_NONE;
> +
> + /*
> + * Some events are bogus if regulator is disabled. Skip such events
if the regulator
> + * if all relevant regulators are disabled
> + */
> + if (d->skip_off) {
> + for_each_set_bit(i, &rdev_map, num_rdevs) {
> + struct regulator_dev *rdev;
> + const struct regulator_ops *ops;
> +
> + rdev = rid->states[i].rdev;
> + ops = rdev->desc->ops;
> +
> + /*
> + * If any of the flagged regulators is enabled we do
> + * handle this
> + */
> + if (ops->is_enabled(rdev))
> + break;
> + }
> + if (i == num_rdevs)
> + return IRQ_NONE;
> + }
> +
> + /* Disable IRQ if HW keeps line asserted */
> + if (d->irq_off_ms)
> + disable_irq_nosync(irq);
> +
> + /*
> + * IRQ seems to be for us. Let's fire correct notifiers / store error
> + * flags
> + */
> + for_each_set_bit(i, &rdev_map, num_rdevs) {
> + struct regulator_err_state *stat;
> + int len;
Redundant, see below.
> + struct regulator_dev *rdev;
> +
> + stat = &rid->states[i];
> + len = sizeof(stat->notifs);
> +
> + rdev = stat->rdev;
> + for_each_set_bit(j, &stat->notifs, 8 * len)
BITS_PER_TYPE(stat->notifs)
> + regulator_notifier_call_chain(rdev, BIT(j - 1), NULL);
> +
> + rdev_flag_err(rdev, stat->errors);
> + }
> +
> + if (d->irq_off_ms) {
> + if (!d->high_prio)
> + schedule_delayed_work(&h->isr_work,
> + msecs_to_jiffies(d->irq_off_ms));
> + else
> + mod_delayed_work(system_highpri_wq,
> + &h->isr_work,
> + msecs_to_jiffies(d->irq_off_ms));
> + }
> +
> + return IRQ_HANDLED;
> +
> +fail_out:
> + if (d->fatal_cnt && h->retry_cnt > d->fatal_cnt) {
> + if (d->die)
> + ret = d->die(rid);
> +
> + /*
> + * If die() failed or was not implemented just BUG() as last
> + * attemt to save HW.
> + */
> + if (ret)
> + die_loudly("Regulator HW failure? - retry count exceeded");
> + }
> +
> + return IRQ_NONE;
> +}
> +
> +static int init_rdev_state(struct device *dev, struct regulator_irq *h,
> + struct regulator_dev **rdev, int common_err,
> + int *rdev_err, int rdev_amount)
> +{
> + int i;
> +
> + h->rdata.states = devm_kzalloc(dev, sizeof(*h->rdata.states) *
> + rdev_amount, GFP_KERNEL);
> + if (!h->rdata.states)
> + return -ENOMEM;
> +
> + h->rdata.num_states = rdev_amount;
> + h->rdata.data = h->desc.data;
> +
> + for (i = 0; i < rdev_amount; i++) {
> + h->rdata.states[i].possible_errs = common_err;
> + if (rdev_err)
> + h->rdata.states[i].possible_errs |= *rdev_err++;
> + h->rdata.states[i].rdev = *rdev++;
> + }
> +
> + return 0;
> +}
> +
> +static void init_rdev_errors(struct regulator_irq *h)
> +{
> + int i;
> +
> + for (i = 0; i < h->rdata.num_states; i++) {
> + if (h->rdata.states[i].possible_errs)
> + /* Can we trust writing this boolean is atomic? */
No. boolean is a compiler / platform specific and it may potentially
be written in a non-atomic way.
> + h->rdata.states[i].rdev->use_cached_err = true;
> + }
> +}
> +
> +/**
> + * regulator_irq_helper - register IRQ based regulator event/error notifier
> + *
> + * @dev: device providing the IRQs
> + * @d: IRQ helper descriptor.
> + * @irq: IRQ used to inform events/errors to be notified.
> + * @irq_flags: Extra IRQ flags to be OR's with the default IRQF_ONESHOT
OR'ed
> + * when requesting the (threaded) irq.
> + * @common_errs: Errors which can be flagged by this IRQ for all rdevs.
> + * When IRQ is re-enabled these errors will be cleared
> + * from all associated regulators
> + * @per_rdev_errs: Optional error flag array describing errors specific
> + * for only some of the regulators. These errors will be
> + * or'ed with common errors. If this is given the array
> + * should contain rdev_amount flags. Can be set to NULL
> + * if there is no regulator specific error flags for this
> + * IRQ.
> + * @rdev: Array of regulators associated with this IRQ.
> + * @rdev_amount: Amount of regulators associated wit this IRQ.
> + */
> +void *regulator_irq_helper(struct device *dev,
> + const struct regulator_irq_desc *d, int irq,
> + int irq_flags, int common_errs, int *per_rdev_errs,
> + struct regulator_dev **rdev, int rdev_amount)
> +{
> + struct regulator_irq *h;
> + int ret;
> +
> + if (!rdev_amount || !d || !d->map_event || !d->name)
> + return ERR_PTR(-EINVAL);
> +
> + h = devm_kzalloc(dev, sizeof(*h), GFP_KERNEL);
> + if (!h)
> + return ERR_PTR(-ENOMEM);
> +
> + h->irq = irq;
> + h->desc = *d;
> +
> + ret = init_rdev_state(dev, h, rdev, common_errs, per_rdev_errs,
> + rdev_amount);
> + if (ret)
> + return ERR_PTR(ret);
> +
> + init_rdev_errors(h);
> +
> + if (h->desc.irq_off_ms)
> + INIT_DELAYED_WORK(&h->isr_work, regulator_notifier_isr_work);
> +
> + ret = request_threaded_irq(h->irq, NULL, regulator_notifier_isr,
> + IRQF_ONESHOT | irq_flags, h->desc.name, h);
> + if (ret) {
> + dev_err(dev, "Failed to request IRQ %d\n", irq);
> +
> + return ERR_PTR(ret);
> + }
> +
> + return h;
> +}
> +EXPORT_SYMBOL_GPL(regulator_irq_helper);
> +
> +/**
> + * regulator_irq_helper_cancel - drop IRQ based regulator event/error notifier
> + *
> + * @handle: Pointer to handle returned by a successful call to
> + * regulator_irq_helper(). Will be NULLed upon return.
> + *
> + * The associated IRQ is released and work is cancelled when the function
> + * returns.
> + */
> +void regulator_irq_helper_cancel(void **handle)
> +{
> + if (handle && *handle) {
> + struct regulator_irq *h = *handle;
> +
> + free_irq(h->irq, h);
> + if (h->desc.irq_off_ms)
> + cancel_delayed_work_sync(&h->isr_work);
> +
> + h = NULL;
> + }
> +}
> +EXPORT_SYMBOL_GPL(regulator_irq_helper_cancel);
> diff --git a/include/linux/regulator/driver.h b/include/linux/regulator/driver.h
> index d7c77ee370f3..03a8eee9fca9 100644
> --- a/include/linux/regulator/driver.h
> +++ b/include/linux/regulator/driver.h
> @@ -409,6 +409,128 @@ struct regulator_config {
> struct gpio_desc *ena_gpiod;
> };
>
> +/**
> + * struct regulator_err_state - regulator error/notification status
> + *
> + * @rdev: Regulator which status the struct indicates.
> + * @notifs: Events which have occurred on regulator.
on the regulator
> + * @errors: Errors which are active on regulator.
> + * @possible_errs: Errors which can be signaled (by given IRQ).
> + */
> +struct regulator_err_state {
> + struct regulator_dev *rdev;
> + unsigned long notifs;
> + unsigned long errors;
> + int possible_errs;
> +};
> +
> +/**
> + * struct regulator_irq_data - regulator error/notification status date
> + *
> + * @states: Status structs for each of the associated regulators.
> + * @num_states: Amount of associated regulators.
> + * @data: Driver data pointer given at regulator_irq_desc.
> + * @opaque: Value storage for IC driver. Core does not update this. ICs
> + * may want to store status register value here at map_event and
> + * compare contents at renable to see if new problems have been
re-enable / reenable
> + * added to status. If that is the case it may be desirable to
> + * return REGULATOR_ERROR_CLEARED and not REGULATOR_ERROR_ON to
> + * allow IRQ fire again and to generate notifications also for
> + * the new issues.
> + *
> + * This structure is passed to map_event and renable for reporting regulator
Ditto.
> + * status to core.
> + */
> +struct regulator_irq_data {
> + struct regulator_err_state *states;
> + int num_states;
> + void *data;
> + long opaque;
> +};
> +
> +/**
> + * struct regulator_irq_desc - notification sender for IRQ based events.
> + *
> + * @name: The visible name for the IRQ
> + * @fatal_cnt: If this IRQ is used to signal HW damaging condition it may be
> + * best to shut-down regulator(s) or reboot the SOC if error
> + * handling is repeteadly failing. If fatal_cnt is given the IRQ
repeatedly
> + * handling is aborted if it fails for fatal_cnt times and die()
> + * callback (if populated) or BUG() is called to try to prevent
> + * further damage.
> + * @reread_ms: The time which is waited before attempting to re-read status
> + * at the worker if IC reading fails. Immediate re-read is done
> + * if time is not specified.
> + * @irq_off_ms: The time which IRQ is kept disabled before re-evaluating the
> + * status for devices which keep IRQ disabled for duration of the
> + * error. If this is not given the IRQ is left enabled and renable
> + * is not called.
> + * @skip_off: If set to true the IRQ handler will attempt to check if any of
> + * the associated regulators are enabled prior to taking other
> + * actions. If no regulators are enabled and this is set to true
> + * a spurious IRQ is assumed and IRQ_NONE is returned.
> + * @high_prio: Boolean to indicate that high priority WQ should be used.
> + * @data: Driver private data pointer which will be passed as such to
> + * the renable, map_event and die callbacks in regulator_irq_data.
> + * @die: Protection callback. If IC status reading or recovery actions
> + * fail fatal_cnt times this callback or BUG() is called. This
> + * callback should implement final protection attempt like
implement a final
> + * disabling the regulator. If protection succeeded this may
> + * return 0. If anything else is returned the core assumes final
> + * protection failed and calls BUG() as a last resort.
> + * @map_event: Driver callback to map IRQ status into regulator devices with
> + * events / errors. NOTE: callback MUST initialize both the
> + * errors and notifs for all rdevs which it signals having
> + * active events as core does not clean the map data.
> + * REGULATOR_FAILED_RETRY can be returned to indicate that the
> + * status reading from IC failed. If this is repeated for
> + * fatal_cnt times the core will call die() callback or BUG()
> + * as a last resort to protect the HW.
> + * @renable: Optional callback to check status (if HW supports that) before
> + * re-enabling IRQ. If implemented this should clear the error
> + * flags so that errors fetched by regulator_get_error_flags()
> + * are updated. If callback is not impelemted then errors are
implemented
> + * assumed to be cleared and IRQ is re-enabled.
> + * REGULATOR_FAILED_RETRY can be returned to
> + * indicate that the status reading from IC failed. If this is
> + * repeated for 'fatal_cnt' times the core will call die()
> + * callback or BUG() as a last resort to protect the HW.
> + * Returning zero indicates that the problem in HW has been solved
> + * and IRQ will be re-enabled. Returning REGULATOR_ERROR_ON
> + * indicates the error condition is still active and keeps IRQ
> + * disabled. Please note that returning REGULATOR_ERROR_ON does
> + * not retrigger evaluating what events are active or resending
> + * notifications. If this is needed you probably want to return
> + * zero and allow IRQ to retrigger causing events to be
> + * re-evaluated and re-sent.
> + *
> + * This structure is used for registering regulator IRQ notification helper.
> + */
> +struct regulator_irq_desc {
> + const char *name;
> + int irq_flags;
> + int fatal_cnt;
> + int reread_ms;
> + int irq_off_ms;
> + bool skip_off;
> + bool high_prio;
> + void *data;
> +
> + int (*die)(struct regulator_irq_data *rid);
> + int (*map_event)(int irq, struct regulator_irq_data *rid,
> + unsigned long *dev_mask);
> + int (*renable)(struct regulator_irq_data *rid);
> +};
> +
> +/*
> + * Return values for regulator IRQ helpers.
> + */
> +enum {
> + REGULATOR_ERROR_CLEARED,
> + REGULATOR_FAILED_RETRY,
> + REGULATOR_ERROR_ON,
> +};
> +
> /*
> * struct coupling_desc
> *
> @@ -473,6 +595,9 @@ struct regulator_dev {
>
> /* time when this regulator was disabled last time */
> unsigned long last_off_jiffy;
> + int cached_err;
> + bool use_cached_err;
> + spinlock_t err_lock;
> };
>
> struct regulator_dev *
> @@ -487,6 +612,16 @@ void devm_regulator_unregister(struct device *dev, struct regulator_dev *rdev);
>
> int regulator_notifier_call_chain(struct regulator_dev *rdev,
> unsigned long event, void *data);
> +void *devm_regulator_irq_helper(struct device *dev,
> + const struct regulator_irq_desc *d, int irq,
> + int irq_flags, int common_errs,
> + int *per_rdev_errs, struct regulator_dev **rdev,
> + int rdev_amount);
> +void *regulator_irq_helper(struct device *dev,
> + const struct regulator_irq_desc *d, int irq,
> + int irq_flags, int common_errs, int *per_rdev_errs,
> + struct regulator_dev **rdev, int rdev_amount);
> +void regulator_irq_helper_cancel(void **handle);
>
> void *rdev_get_drvdata(struct regulator_dev *rdev);
> struct device *rdev_get_dev(struct regulator_dev *rdev);
> --
> 2.25.4
>
>
> --
> 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 =]
--
With Best Regards,
Andy Shevchenko
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v6 3/8] regulator: IRQ based event/error notification helpers
2021-04-07 13:21 ` Andy Shevchenko
@ 2021-04-08 5:22 ` Matti Vaittinen
2021-04-08 8:21 ` Matti Vaittinen
1 sibling, 0 replies; 15+ messages in thread
From: Matti Vaittinen @ 2021-04-08 5:22 UTC (permalink / raw)
To: Andy Shevchenko
Cc: Liam Girdwood, Mark Brown, Rob Herring, Andy Gross,
Bjorn Andersson, Linux Kernel Mailing List, devicetree,
linux-power, linux-arm-msm, Linux-Renesas
Hello Andy, All.
On Wed, 2021-04-07 at 16:21 +0300, Andy Shevchenko wrote:
> On Wed, Apr 7, 2021 at 1:04 PM Matti Vaittinen
> <matti.vaittinen@fi.rohmeurope.com> wrote:
> > Provide helper function for IC's implementing regulator
> > notifications
> > when an IRQ fires. The helper also works for IRQs which can not be
> > acked.
> > Helper can be set to disable the IRQ at handler and then re-
> > enabling it
> > on delayed work later. The helper also adds
> > regulator_get_error_flags()
> > errors in cache for the duration of IRQ disabling.
>
> Thanks for an update, my comments below. After addressing them, feel
> free to add
> Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
>
> > Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
> >
> > static int _regulator_get_error_flags(struct regulator_dev *rdev,
> > unsigned int *flags)
> > {
> > - int ret;
> > + int ret, tmpret;
> >
> > regulator_lock(rdev);
> >
> > + ret = rdev_get_cached_err_flags(rdev);
> > +
> > /* sanity check */
> > - if (!rdev->desc->ops->get_error_flags) {
> > + if (rdev->desc->ops->get_error_flags) {
> > + tmpret = rdev->desc->ops->get_error_flags(rdev,
> > flags);
> > + if (tmpret > 0)
> > + ret |= tmpret;
>
> Oh, I don't like this. Easy fix is to rename ret (okay, it's been
> used
> elsewhere, so adding then) to something meaningful, like error_flags,
> then you can easily understand that value should be positive and
> error
> codes are negative.
No wonder if this looks hairy. I think I have got this plain wrong. The
rdev_get_cached_err_flags() is not updating the flags. Looks like just
plain mistake from my side. I think I've mixed the returning flags via
parameter and return value. This must be fixed. Well spotted.
> + */
> > +void *devm_regulator_irq_helper(struct device *dev,
> > + const struct regulator_irq_desc *d,
> > int irq,
> > + int irq_flags, int common_errs,
> > + int *per_rdev_errs,
> > + struct regulator_dev **rdev, int
> > rdev_amount)
>
> I didn't get why you need the ** pointer instead of plain pointer.
We have an array of pointers. And we give a pointer to the first
pointer. Maybe it's the lack of coffee but I don't see why a single
pointer would be correct? rdev structures are not in contagious memory,
pointers to rdevs are. So we need address of first pointer, right?
+#include <linux/device.h>
> > +#include <linux/err.h>
> > +#include <linux/kernel.h>
> > +#include <linux/of_irq.h>
>
> Not sure how this header is used. I haven't found any direct users of
> it. Perhaps you wanted interrupt.h?
Thanks. I think this specific header may be a leftover from first draft
where I thought I'll use named IRQs. The header was for
of_irq_get_byname(). That ended up as a mess for everything else but
platform devices :) I'll check the headers, thanks.
> > +#include <linux/regmap.h>
> > +#include <linux/slab.h>
> > +#include <linux/spinlock.h>
>
> + Blank line? I would separate group of generic headers with
> particular to the subsystem
I don't see this being used in regulator subsystem - and to tell the
truth, I don't really see the value.
> > +#include <linux/regulator/driver.h>
...
> > +
> > +reread:
> > + if (d->fatal_cnt && h->retry_cnt > d->fatal_cnt) {
> > + if (d->die)
> > + ret = d->die(rid);
> > + else
> > + die_loudly("Regulator HW failure? - no IC
> > recovery");
> > +
> > + /*
> > + * If the 'last resort' IC recovery failed we will
> > have
> > + * nothing else left to do...
> > + */
> > + if (ret)
> > + die_loudly("Regulator HW failure? - IC
> > recovery failed");
>
> Looking at the above code this will be executed if and only if
> d->die() is defined, correct?
> In that case, why not
>
> if (d->die) {
> ret = ...
> if (ret)
> rdev_die_loudly(...);
> } else
> rdev_die_loudly(...);
>
> ?
I think this should simply be:
if (!d->die)
die_loudly("Regulator HW failure? - no IC recovery");
ret = d->die(rdev);
if (ret)
die_loudly(...);
...
> > +static void init_rdev_errors(struct regulator_irq *h)
> > +{
> > + int i;
> > +
> > + for (i = 0; i < h->rdata.num_states; i++) {
> > + if (h->rdata.states[i].possible_errs)
> > + /* Can we trust writing this boolean is
> > atomic? */
>
> No. boolean is a compiler / platform specific and it may potentially
> be written in a non-atomic way.
Hmm.. I don't think this really is a problem here. We only use the
use_cached_err for true/false evaluation - and if error getting api is
called after the boolean is changed - then cached error is used, if
before, then it is not used. Even if the value of the boolean was read
in the middle of writing it, it will still evaluate either true or
false - there is no 'maybe' state :)
My point, I guess we can do the change without locking here. Please
correct me if I am wrong. I'll just drop this comment.
>
> re-enable / reenable
>
> > + * added to status. If that is the case it may be
> > desirable to
> > + * return REGULATOR_ERROR_CLEARED and not
> > REGULATOR_ERROR_ON to
> > + * allow IRQ fire again and to generate notifications
> > also for
> > + * the new issues.
> > + *
> > + * This structure is passed to map_event and renable for reporting
> > regulator
>
> Ditto.
the "renable" is referring to the callback function pointer which is
named "renable".
Best Regards
-- Matti Vaittinen
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v6 3/8] regulator: IRQ based event/error notification helpers
2021-04-07 13:21 ` Andy Shevchenko
2021-04-08 5:22 ` Matti Vaittinen
@ 2021-04-08 8:21 ` Matti Vaittinen
2021-04-08 9:58 ` Andy Shevchenko
1 sibling, 1 reply; 15+ messages in thread
From: Matti Vaittinen @ 2021-04-08 8:21 UTC (permalink / raw)
To: Andy Shevchenko
Cc: Liam Girdwood, Mark Brown, Rob Herring, Andy Gross,
Bjorn Andersson, Linux Kernel Mailing List, devicetree,
linux-power, linux-arm-msm, Linux-Renesas
Hello Andy,
On Wed, 2021-04-07 at 16:21 +0300, Andy Shevchenko wrote:
> On Wed, Apr 7, 2021 at 1:04 PM Matti Vaittinen
> <matti.vaittinen@fi.rohmeurope.com> wrote:
> > Provide helper function for IC's implementing regulator
> > notifications
> > when an IRQ fires. The helper also works for IRQs which can not be
> > acked.
> > Helper can be set to disable the IRQ at handler and then re-
> > enabling it
> > on delayed work later. The helper also adds
> > regulator_get_error_flags()
> > errors in cache for the duration of IRQ disabling.
>
> Thanks for an update, my comments below. After addressing them, feel
> free to add
> Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
I (eventually) disagreed with couple of points here and haven't changed
those. Please see list below.
I still do think you did a really good job reviewing this - and you
should get the recognition from that work. Thus I'd nevertheless would
like to add your Reviewed-by to the next version. Please let me know if
you think it's ok. (I have the v7 ready but I'll wait until the next
Monday before sending it to see if this brings more discussion).
> > +/**
> > + * devm_regulator_irq_helper - resource managed registration of
> > IRQ based
> > + * regulator event/error notifier
> > + *
> > + * @dev: device to which lifetime the helper's
> > lifetime is
> > + * bound.
> > + * @d: IRQ helper descriptor.
> > + * @irq: IRQ used to inform events/errors to be
> > notified.
> > + * @irq_flags: Extra IRQ flags to be OR's with the default
> > IRQF_ONESHOT
> > + * when requesting the (threaded) irq.
> > + * @common_errs: Errors which can be flagged by this IRQ for
> > all rdevs.
> > + * When IRQ is re-enabled these errors will be
> > cleared
> > + * from all associated regulators
> > + * @per_rdev_errs: Optional error flag array describing errors
> > specific
> > + * for only some of the regulators. These
> > errors will be
> > + * or'ed with common errors. If this is given
> > the array
> > + * should contain rdev_amount flags. Can be
> > set to NULL
> > + * if there is no regulator specific error
> > flags for this
> > + * IRQ.
> > + * @rdev: Array of regulators associated with this
> > IRQ.
> > + * @rdev_amount: Amount of regulators associated wit this
> > IRQ.
>
> Can you describe, please, the return value meaning. It will be good
> also to move detailed descriptions (expectations?) of the fields to
> the Description section, here.
I added the return-value documentation as you suggested. For parameter
descriptions I still think the best and clearest place is in parameter
description.
>
> > + */
> > +void *devm_regulator_irq_helper(struct device *dev,
> > + const struct regulator_irq_desc *d,
> > int irq,
> > + int irq_flags, int common_errs,
> > + int *per_rdev_errs,
> > + struct regulator_dev **rdev, int
> > rdev_amount)
>
> I didn't get why you need the ** pointer instead of plain pointer.
>
This I replied to earlier - I did change the parameter documentation a
bit to explain this:
"@rdev: Array of pointers to regulators associated with this IRQ"
> > +#include <linux/regmap.h>
> > +#include <linux/slab.h>
> > +#include <linux/spinlock.h>
>
> + Blank line? I would separate group of generic headers with
> particular to the subsystem
I haven't seen this practice in other parts of regulator subsystem (and
I personally fail to see the value).
> > +/**
> > + * struct regulator_irq_data - regulator error/notification status
> > date
> > + *
> > + * @states: Status structs for each of the associated
> > regulators.
> > + * @num_states: Amount of associated regulators.
> > + * @data: Driver data pointer given at regulator_irq_desc.
> > + * @opaque: Value storage for IC driver. Core does not update
> > this. ICs
> > + * may want to store status register value here at
> > map_event and
> > + * compare contents at renable to see if new problems
> > have been
>
> re-enable / reenable
>
> > + * added to status. If that is the case it may be
> > desirable to
> > + * return REGULATOR_ERROR_CLEARED and not
> > REGULATOR_ERROR_ON to
> > + * allow IRQ fire again and to generate notifications
> > also for
> > + * the new issues.
> > + *
> > + * This structure is passed to map_event and renable for reporting
> > regulator
>
> Ditto.
'renable' refers to the callback name. I tried to clarify that in
comments though.
"compare contents at 'renable' callback to see..." and "This structure
is passed to 'map_event' and 'renable' callbacks for..."
Best Regards
Matti Vaittinen
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v6 3/8] regulator: IRQ based event/error notification helpers
2021-04-08 8:21 ` Matti Vaittinen
@ 2021-04-08 9:58 ` Andy Shevchenko
2021-04-08 10:06 ` Vaittinen, Matti
0 siblings, 1 reply; 15+ messages in thread
From: Andy Shevchenko @ 2021-04-08 9:58 UTC (permalink / raw)
To: Matti Vaittinen
Cc: Liam Girdwood, Mark Brown, Rob Herring, Andy Gross,
Bjorn Andersson, Linux Kernel Mailing List, devicetree,
linux-power, linux-arm-msm, Linux-Renesas
On Thu, Apr 8, 2021 at 11:21 AM Matti Vaittinen
<matti.vaittinen@fi.rohmeurope.com> wrote:
>
> Hello Andy,
>
> On Wed, 2021-04-07 at 16:21 +0300, Andy Shevchenko wrote:
> > On Wed, Apr 7, 2021 at 1:04 PM Matti Vaittinen
> > <matti.vaittinen@fi.rohmeurope.com> wrote:
> > > Provide helper function for IC's implementing regulator
> > > notifications
> > > when an IRQ fires. The helper also works for IRQs which can not be
> > > acked.
> > > Helper can be set to disable the IRQ at handler and then re-
> > > enabling it
> > > on delayed work later. The helper also adds
> > > regulator_get_error_flags()
> > > errors in cache for the duration of IRQ disabling.
> >
> > Thanks for an update, my comments below. After addressing them, feel
> > free to add
> > Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
>
> I (eventually) disagreed with couple of points here and haven't changed
> those. Please see list below.
>
> I still do think you did a really good job reviewing this - and you
> should get the recognition from that work. Thus I'd nevertheless would
> like to add your Reviewed-by to the next version. Please let me know if
> you think it's ok. (I have the v7 ready but I'll wait until the next
> Monday before sending it to see if this brings more discussion).
Looks OK to me.
Just rename die_loudly() to rdev_die_loudly() and in any way of
conditionals with that, please mark it with __noreturn attribute, so
if (bla bla bla)
rdev_die_loudly();
will be an understandable trap.
--
With Best Regards,
Andy Shevchenko
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v6 3/8] regulator: IRQ based event/error notification helpers
2021-04-08 9:58 ` Andy Shevchenko
@ 2021-04-08 10:06 ` Vaittinen, Matti
0 siblings, 0 replies; 15+ messages in thread
From: Vaittinen, Matti @ 2021-04-08 10:06 UTC (permalink / raw)
To: andy.shevchenko
Cc: agross, broonie, devicetree, linux-power, linux-kernel,
linux-renesas-soc, linux-arm-msm, bjorn.andersson, lgirdwood,
robh+dt
On Thu, 2021-04-08 at 12:58 +0300, Andy Shevchenko wrote:
> On Thu, Apr 8, 2021 at 11:21 AM Matti Vaittinen
> <matti.vaittinen@fi.rohmeurope.com> wrote:
> > Hello Andy,
> >
> > On Wed, 2021-04-07 at 16:21 +0300, Andy Shevchenko wrote:
> > > On Wed, Apr 7, 2021 at 1:04 PM Matti Vaittinen
> > > <matti.vaittinen@fi.rohmeurope.com> wrote:
> > > > Provide helper function for IC's implementing regulator
> > > > notifications
> > > > when an IRQ fires. The helper also works for IRQs which can not
> > > > be
> > > > acked.
> > > > Helper can be set to disable the IRQ at handler and then re-
> > > > enabling it
> > > > on delayed work later. The helper also adds
> > > > regulator_get_error_flags()
> > > > errors in cache for the duration of IRQ disabling.
> > >
> > > Thanks for an update, my comments below. After addressing them,
> > > feel
> > > free to add
> > > Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
> >
> > I (eventually) disagreed with couple of points here and haven't
> > changed
> > those. Please see list below.
> >
> > I still do think you did a really good job reviewing this - and you
> > should get the recognition from that work. Thus I'd nevertheless
> > would
> > like to add your Reviewed-by to the next version. Please let me
> > know if
> > you think it's ok. (I have the v7 ready but I'll wait until the
> > next
> > Monday before sending it to see if this brings more discussion).
>
> Looks OK to me.
> Just rename die_loudly() to rdev_die_loudly()
I did that. Thanks.
> and in any way of
> conditionals with that, please mark it with __noreturn attribute, so
> if (bla bla bla)
> rdev_die_loudly();
>
> will be an understandable trap.
Valid point. Will do, thanks again.
Best Regards
Matti Vaittinen
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v6 5/8] dt-bindings: regulator: bd9576 add FET ON-resistance for OCW
2021-04-07 10:04 ` [PATCH v6 5/8] dt-bindings: regulator: bd9576 add FET ON-resistance for OCW Matti Vaittinen
@ 2021-04-08 15:22 ` Rob Herring
0 siblings, 0 replies; 15+ messages in thread
From: Rob Herring @ 2021-04-08 15:22 UTC (permalink / raw)
To: Matti Vaittinen
Cc: devicetree, Rob Herring, Liam Girdwood, Bjorn Andersson,
Matti Vaittinen, linux-power, linux-kernel, linux-arm-msm,
linux-renesas-soc, Andy Gross, Mark Brown
On Wed, 07 Apr 2021 13:04:51 +0300, Matti Vaittinen wrote:
> BD9576MUF provides over-current protection and detection. Current is
> measured as voltage loss over external FET. Allow specifying FET's on
> resistance so current monitoring limits can be converted to voltages.
>
> Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
> ---
> v5 onwards:
> - No changes
> v4:
> - Fixed the description indentiation
> ---
> .../bindings/regulator/rohm,bd9576-regulator.yaml | 6 ++++++
> 1 file changed, 6 insertions(+)
>
Reviewed-by: Rob Herring <robh@kernel.org>
^ permalink raw reply [flat|nested] 15+ messages in thread
end of thread, other threads:[~2021-04-08 15:23 UTC | newest]
Thread overview: 15+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-07 10:02 [PATCH v6 0/8] Extend regulator notification support Matti Vaittinen
2021-04-07 10:02 ` [PATCH v6 1/8] dt_bindings: Add protection limit properties Matti Vaittinen
2021-04-07 10:03 ` [PATCH v6 2/8] regulator: add warning flags Matti Vaittinen
2021-04-07 10:04 ` [PATCH v6 3/8] regulator: IRQ based event/error notification helpers Matti Vaittinen
2021-04-07 13:21 ` Andy Shevchenko
2021-04-08 5:22 ` Matti Vaittinen
2021-04-08 8:21 ` Matti Vaittinen
2021-04-08 9:58 ` Andy Shevchenko
2021-04-08 10:06 ` Vaittinen, Matti
2021-04-07 10:04 ` [PATCH v6 4/8] regulator: add property parsing and callbacks to set protection limits Matti Vaittinen
2021-04-07 10:04 ` [PATCH v6 5/8] dt-bindings: regulator: bd9576 add FET ON-resistance for OCW Matti Vaittinen
2021-04-08 15:22 ` Rob Herring
2021-04-07 10:05 ` [PATCH v6 6/8] regulator: bd9576: Support error reporting Matti Vaittinen
2021-04-07 10:06 ` [PATCH v6 7/8] regulator: bd9576: Fix the driver name in id table Matti Vaittinen
2021-04-07 10:06 ` [PATCH v6 8/8] MAINTAINERS: Add reviewer for regulator irq_helpers Matti Vaittinen
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).