out-of-tree.rst

   1 Using ELM327 driver out-of-tree
   2 ================================
   3
   4 Requirements
   5 -------------
   6
   7 This requires Linux 4.11 (for 431af779256c), and has been tested on 4.19.
   8
   9 Also, elmcan depends on ``can-dev``:
  10
  11     sudo modprobe can-dev
  12
  13
  14
  15 Install
  16 -------
  17     cd module/
  18
  19     sudo dkms install .
  20
  21
  22
  23
  24 Porting and alternative licences
  25 =================================
  26
  27 This driver started as a derivative of linux/drivers/net/can/slcan.c
  28 and my thanks go to the original authors for their inspiration, even
  29 after almost none of their code is left.
  30
  31 This code barely bears any resemblance to slcan anymore, and whatever
  32 may be left is Linux specific boilerplate anyway, however I am leaving
  33 the GPL-2.0 identifier at the top just to be sure.
  34
  35 Please feel free to use my own code, especially the ELM327 communication
  36 logic, in accordance with SPDX-License-Identifier BSD-3-Clause to port
  37 this driver to other systems.
  38
  39 If in doubt, feel free to ask me to clarify which code is mine.
  40
  41
  42
  43
  44 Thanks
  45 =======
  46
  47 Thanks go out to Oliver Neukum for his early reviews and suggestions.
  48
  49 Several more people have encouraged me to finish this - thank you all.
  50
  51 Thanks to tomaszduda23 for the dkms.conf file.