Change N_ELMCAN to N_DEVELOPMENT

[elmcan.git] / readme.rst

diff --git a/readme.rst b/readme.rst
index bfaf89b96307fe82aa7af322fb0fb9de2660656e..4103d18ce0db158c9842f435b9ae1944fbe83b8a 100644 (file)
--- a/readme.rst
+++ b/readme.rst
@@ -1,6 +1,16 @@
-Linux SocketCAN driver for ELM327
+.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
+
+ELM327 driver for Linux SocketCAN
 ==================================
 
+Out-of-tree version
+--------------------
+
+This is the non-upstreamed version of the elmcan driver.
+Please see out-of-tree.rst for compilation/usage hints.
+
+
+
 Authors
 --------
 
@@ -24,13 +34,13 @@ Introduction
 -------------
 
 This driver is an effort to turn abundant ELM327 based OBD interfaces
-into full-fledged (as far as possible) CAN interfaces.
+into full fledged (as far as possible) CAN interfaces.
 
-Since the ELM327 was never meant to be a stand-alone CAN controller,
+Since the ELM327 was never meant to be a stand alone CAN controller,
 the driver has to switch between its modes as quickly as possible in
 order to fake full-duplex operation.
 
-As such, elmcan is a best-effort driver. However, this is more than
+As such, elmcan is a best effort driver. However, this is more than
 enough to implement simple request-response protocols (such as OBD II),
 and to monitor broadcast messages on a bus (such as in a vehicle).
 
@@ -44,17 +54,6 @@ known limitations in older controllers and clones.
 
 
 
-Requirements
--------------
-
-This requires Linux 4.11 (for 431af779256c), and has been tested on 4.19.
-
-Also, elmcan depends on ``can-dev``:
-
-    sudo modprobe can-dev
-
-
-
 Data sheet
 -----------
 
@@ -108,23 +107,6 @@ 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.
-       Without this option, the driver will bail on the first unrecognized
-       character it receives from the TTY.
-
-       LOAD TIME::
-
-               module/kernel parameter: accept_flaky_uart=[0|1]
-
-
-
 Known limitations of the controller
 ------------------------------------
 
@@ -180,8 +162,8 @@ Known limitations of the controller
 - Versions prior to 1.3
 
   These chips cannot be used at all with elmcan. They do not support
-  the "``AT D1``", which is necessary to avoid parsing conflicts on
-  incoming data, as well as distinction of RTR frame lengths.
+  the "``AT D1``" command, which is necessary to avoid parsing conflicts
+  on incoming data, as well as distinction of RTR frame lengths.
 
   Specifically, this allows for easy distinction of SFF and EFF
   frames, and to check whether frames are complete. While it is possible
@@ -335,10 +317,3 @@ not helpful when trying to tap into the middle of an existing CAN bus.
 
 If communications don't work with the adapter connected, check for the
 termination resistors on its PCB and try removing them.
-
-
-
-To Do list for future development
-----------------------------------
-
-- None currently