-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
+ Linux CAN Driver (LinCAN) version 0.2 snapshot
+ Pavel Pisa <pisa@cmp.felk.cvut.cz>
+ OCERA team member
+ <http://www.ocera.org>
- 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
+INTRODUCTION
+============
+The LinCAN is an implementation of the Linux CAN-bus device driver supporting
+more CAN controller chips and many CAN interface boards. Its development
+has long history already. The OCERA version of the driver has new better
+designed internal structure, adds new features (as support for open by multiple
+applications, select system call) and other enhancements.
+
+The driver consist of four main layers:
+ - chip level manipulation routines
+ - board specific support
+ - message queues
+ - user-space API and ABI character device interface
-------------------------------------------------------------------------
-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
+DRIVER HISTORY
+==============
-Modified version can-0.7.1-pi2.2
+The driver originates in The Linux Lab Project
+ http://www.llp.fu-berlin.de/
+then it has been first rewritten by Arnaud Westenberg
+ http://home.wanadoo.nl/arnaud/
+now it is developed and maintained as part of OCERA framework
+ http://www.ocera.org/
-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
+I am unable to contact previous maintainer Arnaud Westenberg
+(arnaud@wanadoo.nl). If you know something about him, I like
+to hear it.
+
+Versions:
+
+can-0.7.1 latest driver version version published
+ by Arnaud Westenberg
+
+can-0.7.1-tm5 the enhanced version with better support of
+ SJA1000 PeliCAN mode and CAN Ethernet proxy
+ contributed by Tomasz Motylewski <T.Motylewski@bfad.de>
+
+can-0.7.1-pi1 the import and usage of previous version for
+(Dec 2002) OCERA group purposes
+
+can-0.7.1-pi3.4 enhanced version with select support and rewritten
+(Mar 2003) make system for Linux kernels (2.2.x,2.4.x,2.5.x),
+ interrupts service cleanup and partial redesign
+ and DEVFS support
+
+lincan-0.2-pre heavily rewritten infrastructure of the driver based
+(Aug 2003) on atomic slot management of queues
+
+The actual version of driver have been latest tested it with
+PC104 Advantech PCM3680 dual channel board on 2.4 kernel.
+It takes more time to test it with more cards and polish
+support for 2.2 and 2.6 kernels, but these should be mainly
+cosmetic changes (I hope ;-), infrastructure and original
+support for more than 14 boards with more variants is in.
+
+
+SOURCES AND URLs
+================
+
+The LinCAN driver component page at OCERA web site
+(not updated to the new version yet)
+
+ http://www.ocera.org/download/components/WP7/lincan-0.1.html
+
+List of related communication components
+
+ http://www.ocera.org/download/components/WP7/index.html
+
+The CVS repository of OCERA project at SourceForge
+
+ EXTCVS=":pserver:anonymous@cvs.ocera.sourceforge.net:/cvsroot/ocera"
+ cvs -d$EXTCVS login
+ cvs -z3 -d$EXTCVS co ocera
+
+Web access into CVS
+
+ http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ocera/ocera/components/comm/can/lincan/
+
+Experimental directory at maintainer (Pavel Pisa's) pages
+
+ http://cmp.felk.cvut.cz/~pisa/can/
+ http://cmp.felk.cvut.cz/~pisa/can/lincan-YYMMDD.tar.gz
+
+Please send comments, bug-fixes and enhancements directly to
+me (Pavel Pisa <pisa@cmp.felk.cvut.cz>) or to OCERA discussion
+forum <https://sourceforge.net/forum/forum.php?forum_id=170893>
+and lists <ocera-development@lists.sourceforge.net>
-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.
+===========
+
+Just type 'make' at the command line and driver module should compile
+without errors for current running kernel.
-INSTALLATION.
-Currently there's no installation procedure, just compile and load the driver.
+More information can be found in driver documentation at
+ http://cmp.felk.cvut.cz/~pisa/can/
+ http://cmp.felk.cvut.cz/~pisa/can/lincan-X.Y.pdf
+
+INSTALLATION
+============
+Type 'make install'. The driver should be copied into actual kernel version
+modules directory "/lib/modules/x.y.z/kernel/drivers/char".
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
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
+- minor=<nr>, you can specify which 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.
projects / lincan.git / blobdiff