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