Clear TTY_DO_WRITE_WAKEUP bit on uart_side_failure

[elmcan.git] / readme.rst

diff --git a/readme.rst b/readme.rst
index 5fb0e5e6e83e245980f2714860506719143e8388..e3792211b6c172ae506f7f073b0517e715250bec 100644 (file)
--- a/readme.rst
+++ b/readme.rst
@@ -1,6 +1,16 @@
+.. 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
 --------
 
@@ -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 .
-
 Data sheet
 -----------
 
@@ -110,6 +105,20 @@ The line discipline can be attached on a command prompt as follows::
 To change the ELM327's serial settings, please refer to its data
 sheet. This needs to be done before attaching the line discipline.
 
+Once the ldisc is attached, the CAN interface starts out unconfigured.
+Set the speed before starting it:
+
+    # The interface needs to be down to change parameters
+    sudo ip link set can0 down
+    sudo ip link set can0 type can bitrate 500000
+    sudo ip link set can0 up
+
+500000 bit/s is a common rate for OBD-II diagnostics.
+If you're connecting straight to a car's OBD port, this is the speed
+that most cars (but not all!) expect.
+
+After this, you can set out as usual with candump, cansniffer, etc.
+
 
 
 Known limitations of the controller
@@ -167,8 +176,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
@@ -322,12 +331,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.