summaryrefslogtreecommitdiff
path: root/readme.rst
diff options
context:
space:
mode:
authornorly <ny-git@enpas.org>2019-02-19 00:24:21 +0100
committernorly <ny-git@enpas.org>2019-02-19 00:33:42 +0100
commit8376bf6ff844f12088f568d2284a4ef4a69ca9c4 (patch)
treed9089cc8728aa2d71d266c2ca35015f9e3db9da6 /readme.rst
parent36e4fcf1d8f65e51e2baf5c4de091b0862bb02fb (diff)
Sanity check TTY input and bail on problems
Also, introduce module parameter 'accept_flaky_uart'. If your adapter or its connection is unreliable, set this option to true to try and make the best of a bad situation, but undefined behavior is prone to occur.
Diffstat (limited to 'readme.rst')
-rw-r--r--readme.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/readme.rst b/readme.rst
index d2aced2..23920d8 100644
--- a/readme.rst
+++ b/readme.rst
@@ -92,6 +92,21 @@ sheet. This needs to be done before attaching the line discipline.
+Module parameters
+------------------
+
+- ``accept_flaky_uart`` - Try to live with a bad controller or UART line
+
+ Some adapters and/or their connection are unreliable. Enable this
+ option to try and work around the situation. This is a best-effort
+ workaround, so undefined behavior will likely occur sooner or later.
+
+ LOAD TIME::
+
+ module/kernel parameter: accept_flaky_uart=[0|1]
+
+
+
Known limitations of the controller
------------------------------------