The first enhanced version of Linux CAN-bus driver for OCERA project

[lincan.git] / lincan / README

diff --git a/lincan/README b/lincan/README
index 34573b919976fea2573a8501e9acffedea5fa39d..f2095a8acbb5347c55540998f23cc7f4cb86825c 100644 (file)
--- a/lincan/README
+++ b/lincan/README
@@ -1,2 +1,77 @@
-Linux CAN Driver
-================
+Because we are not able to contact original author Arnaud Westenberg,
+and we have put piece of work to bugfixes and enhancements of the
+driver, we decided to offer our latest version to more tests.
+Please, if you know Arnaud's new address, contact us.
+Most of new bugs belongs to 
+
+    Pavel Pisa pisa@cmp.felk.cvut.cz 
+and Tomasz Motylewski, T.Motylewski@bfad.de
+
+Main enhancements:
+  interrupts service cleanup and partial redesign
+  deep module build redesign
+  support for select
+  preliminary support for 2.5.48 (UP only now)
+  CAN Ethernet proxy
+
+------------------------------------------------------------------------
+
+README for the linux CAN-bus driver.
+Written by Arnaud Westenberg email:arnaud@wanadoo.nl
+This software is released under the GPL-License.
+Version 0.7  6 Aug 2001
+
+Modified version can-0.7.1-pi2.2
+
+This version adds new Makefile system.
+DEVFS support
+Select/poll support for read/write events
+Preliminary cleanups for 2.5.xx kernels,
+it cannot work with SMP 2.5.xx until we get rid off
+CLI ans STI global directives
+
+Changes made by Pavel Pisa pisa@cmp.felk.cvut.cz as preliminary
+study for OCERA Real Time CAN/CANOpen project ORTCAN
+
+COMPILATION
+Just type 'make' at the command line and it should compile without errors.
+
+INSTALLATION.
+Currently there's no installation procedure, just compile and load the driver.
+
+LOADING
+To load the driver type:
+# insmod can.o hw='your hardware' irq='irq number' io='io address' <options>
+Example: # insmod can.o hw=pip5 irq=4 io=0x8000
+
+The hw argument can be one of:
+- pip5, for the pip5 computer by MPL
+- pip6, for the pip6 computer by MPL
+- pccan-q, for the PCcan-Q ISA card by KVASER
+- pccan-f, for the PCcan-F ISA card by KVASER
+- pccan-s, for the PCcan-S ISA card by KVASER
+- pccan-d, for the PCcan-D ISA card by KVASER
+- nsican, for the CAN104 PC/104 card by NSI
+- cc104, for the CAN104 PC/104 card by Contemporary Controls
+- aim104, for the AIM104CAN PC/104 card by Arcom Control Systems
+- pc-i03, for the PC-I03 ISA card by IXXAT
+- pcm3680, for the PCM-3680 PC/104 card by Advantech
+- m437, for the M436 PC/104 card by SECO
+- bfadcan for sja1000 CAN embedded card made by BFAD GmbH
+- pikronisa for ISA memory mapped sja1000 CAN card made by PiKRON Ltd.
+- template, for yet unsupported hardware (you need to edit src/template.c)
+
+options can be one of:
+- major=<nr>, major specifies the major number of the driver.
+- minor=<nr>, you can specify wich minor numbers the driver should use for your
+  hardware.
+- extended=[1|0], configures the driver to use extended message format.
+- pelican=[1|0], configures the driver to set the CAN chips into pelican mode.
+- baudrate=<nr>, sets the baudrate of the device(s)
+- clock_freq=<nr>, the frequency of the CAN quartz
+- stdmask=<nr>, sets the standard mask of the device
+- extmask=<nr>, sets the extended mask of the device
+- mo15mask=<nr>, sets the mask for message object 15 (i82527 only)
+
+There's still a lot of work to do, have a look at the TODO file for more
+information.