out-of-tree.rst: Add porting info

[elmcan.git] / readme.rst

diff --git a/readme.rst b/readme.rst
index c8f12c0d549c5a99ae2ce44371d67746b89c795f..408c6911663aeb4c8e9afd8f6c248a3a779bddd9 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,21 +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
-
-Install
--------------
-    cd module/
-    
-    sudo dkms install `pwd`
-
 Data sheet
 -----------
 
@@ -112,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
 ------------------------------------
 
@@ -339,19 +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.
-
-
-
-Thanks
--------
-
-Thanks go out to Oliver Neukum for his early reviews and suggestions.
-
-Several more people have encouraged me to finish this - thank you all.
-
-
-
-To Do list for future development
-----------------------------------
-
-- None currently