[PATCH v3 2/4] Documentation: reset-reason: document new BROWNOUT reason

[Ahmad Fatoum <a.fatoum@pengutronix.de>]

Now that enum reset_src_type has been extended by BROWNOUT as a reason,
add it to the user documentation.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 Documentation/user/reset-reason.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/user/reset-reason.rst b/Documentation/user/reset-reason.rst
index 26d37f86dd3e..e46f2ca684ab 100644
--- a/Documentation/user/reset-reason.rst
+++ b/Documentation/user/reset-reason.rst
@@ -41,6 +41,10 @@ The following values can help to detect the reason why the bootloader runs:
 * ``EXT`` (EXTernal): some SoCs have special device pins for external reset
   signals other than the ``RST`` one. Application specific how to handle this
   state.
+* ``BROWNOUT``: some SoCs detect undervoltage conditions and stay in reset
+  till the supply voltage crosses a predefined threshold voltage. This avoids
+  erratic behavior that may occur when running out-of-spec. Application specific
+  how to handle this state.
 
 It depends on your board/SoC and its features if the hardware is able to detect
 these reset reasons. Most of the time only ``POR`` and ``RST`` are supported
-- 
2.20.1


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox