+.. 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
--------
-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
-----------
-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
------------------------------------
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.