out-of-tree.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

Using ELM327 driver out-of-tree
================================

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 .


Porting and alternative licences
=================================

This driver started as a derivative of linux/drivers/net/can/slcan.c
and my thanks go to the original authors for their inspiration, even
after almost none of their code is left.

This code barely bears any resemblance to slcan anymore, and whatever
may be left is Linux specific boilerplate anyway, however I am leaving
the GPL-2.0 identifier at the top just to be sure.

Please feel free to use my own code, especially the ELM327 communication
logic, in accordance with SPDX-License-Identifier BSD-3-Clause to port
this driver to other systems.

If in doubt, feel free to ask me to clarify which code is mine.


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.