regulator: dt-bindings: Add 'regulator-uv-less-critical-window-ms' property
authorOleksij Rempel <o.rempel@pengutronix.de>
Thu, 26 Oct 2023 14:48:23 +0000 (16:48 +0200)
committerMark Brown <broonie@kernel.org>
Mon, 13 Nov 2023 01:26:27 +0000 (01:26 +0000)
commit759e2bd96971763db1cfaf6cafc07654b12aa21e
tree3624c53e4af855b5bdc547c27de7c7a837918f89
parent633cd1c0a9de7609f97c0c86e3ac81153e8263b0
regulator: dt-bindings: Add 'regulator-uv-less-critical-window-ms' property

Introduces a new devicetree property to specifies the time window (in
milliseconds) following a critical under-voltage (UV) event during which
less critical actions can be safely carried out by the system.

Less Critical Actions:
- Logging the under-voltage event for later analysis.
- Saving less critical data that may be useful for diagnosing issues or
  for audit purposes.

More Critical Actions (post the less critical window):
- Initiating procedures to properly shutdown hardware to prevent damage.

The 'regulator-uv-less-critical-window-ms' property is crucial for
conveying board-specific hardware characteristics, not for enforcing a
certain policy. The time window represented by this property is derived
from the physical attributes of the hardware like the capacity of
on-board capacitors, the power consumption of the components, and the
time needed to safely shut down hardware to prevent damage. These
attributes can significantly vary between different boards, making it a
board-specific property rather than a policy directive.

By providing a precise representation of the time available for less
critical actions post an under-voltage event, this property enables the
kernel to make informed decisions on action prioritization, ensuring
that essential preventative measures are taken to avoid hardware damage
while also allowing for data capture and analysis.

Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
Acked-by: Rob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20231026144824.4065145-5-o.rempel@pengutronix.de
Signed-off-by: Mark Brown <broonie@kernel.org>
Documentation/devicetree/bindings/regulator/regulator.yaml