Structured comments updated.
[lincan.git] / lincan / README
1                 Linux CAN Driver (LinCAN) version 0.2 snapshot
2                 Pavel Pisa <pisa@cmp.felk.cvut.cz>
3                         OCERA team member
4                         <http://www.ocera.org>
5
6
7 INTRODUCTION
8 ============
9 The LinCAN is an implementation of the Linux CAN-bus device driver supporting
10 more CAN controller chips and many CAN interface boards. Its development
11 has long history already. The OCERA version of the driver has new better
12 designed internal structure, adds new features (as support for open by multiple
13 applications, select system call) and other enhancements.
14   
15 The driver consist of four main layers:
16   - chip level manipulation routines
17   - board specific support
18   - message queues
19   - user-space API and ABI character device interface
20
21
22 DRIVER HISTORY
23 ==============
24
25 The driver originates in The Linux Lab Project
26   http://www.llp.fu-berlin.de/
27 then it has been first rewritten by Arnaud Westenberg
28   http://home.wanadoo.nl/arnaud/
29 now it is developed and maintained as part of OCERA framework
30   http://www.ocera.org/
31
32 I am unable to contact previous maintainer Arnaud Westenberg
33 (arnaud@wanadoo.nl). If you know something about him, I like
34 to hear it.
35
36 Versions:
37
38 can-0.7.1       latest driver version version published
39                 by Arnaud Westenberg
40
41 can-0.7.1-tm5   the enhanced version with better support of
42                 SJA1000 PeliCAN mode and CAN Ethernet proxy
43                 contributed by Tomasz Motylewski <T.Motylewski@bfad.de>
44
45 can-0.7.1-pi1   the import and usage of previous version for
46 (Dec 2002)      OCERA group purposes
47                 
48 can-0.7.1-pi3.4 enhanced version with select support and rewritten
49 (Mar 2003)      make system for Linux kernels (2.2.x,2.4.x,2.5.x),
50                 interrupts service cleanup and partial redesign
51                 and DEVFS support
52
53 lincan-0.2-pre  heavily rewritten infrastructure of the driver based
54 (Aug 2003)      on atomic slot management of queues
55
56 The actual version of driver have been latest tested it with
57   - PC104 Advantech PCM3680 dual channel board on 2.4 RT-Linux enabled kernel
58   - PiKRON ISA card on 2.4.and 2.6 Linux kernels
59   - BfaD DIMM PC card on 2.4 RT-Linux enabled kernel
60   - KVASER pcican-q on 2.6 Linux kernel
61   - virtual board tested on all systems as well
62 It takes more time to test it with more cards and polish
63 support for 2.2 and 2.6 kernels, but these should be mainly
64 cosmetic changes (I hope ;-), infrastructure and original
65 support for more than 17 boards with more variants is in.
66
67
68 SOURCES AND URLs
69 ================
70
71 The LinCAN driver component page at OCERA web site
72 (not updated to the new version yet)
73
74   http://www.ocera.org/download/components/WP7/lincan-0.1.html
75   
76 List of related communication components
77   
78   http://www.ocera.org/download/components/WP7/index.html
79
80 The CVS repository of OCERA project at SourceForge
81
82   EXTCVS=":pserver:anonymous@cvs.ocera.sourceforge.net:/cvsroot/ocera"
83   cvs -d$EXTCVS login
84   cvs -z3 -d$EXTCVS co ocera
85   
86 Web access into CVS
87
88   http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ocera/ocera/components/comm/can/lincan/
89
90 Experimental directory at maintainer (Pavel Pisa's) pages 
91
92   http://cmp.felk.cvut.cz/~pisa/can/
93   http://cmp.felk.cvut.cz/~pisa/can/lincan-YYMMDD.tar.gz
94   
95 Please send comments, bug-fixes and enhancements directly to
96 me (Pavel Pisa <pisa@cmp.felk.cvut.cz>) or to OCERA discussion
97 forum <https://sourceforge.net/forum/forum.php?forum_id=170893> 
98 and lists <ocera-development@lists.sourceforge.net>
99
100
101 COMPILATION
102 ===========
103
104 Just type 'make' at the command line and driver module should compile
105 without errors for current running kernel.
106
107 More information can be found in driver documentation at
108   http://cmp.felk.cvut.cz/~pisa/can/
109   http://cmp.felk.cvut.cz/~pisa/can/lincan-X.Y.pdf
110
111 INSTALLATION
112 ============
113 Type 'make install'. The driver should be copied into actual kernel version
114 modules directory "/lib/modules/x.y.z/kernel/drivers/char".
115
116 LOADING
117 =======
118
119 To load the driver type:
120 # insmod can.o hw='your hardware' irq='irq number' io='io address' <options>
121 Example: # insmod can.o hw=pip5 irq=4 io=0x8000
122
123 The hw argument can be one of:
124 - pip5, for the pip5 computer by MPL
125 - pip6, for the pip6 computer by MPL
126 - pccan-q, for the PCcan-Q ISA card by KVASER
127 - pccan-f, for the PCcan-F ISA card by KVASER
128 - pccan-s, for the PCcan-S ISA card by KVASER
129 - pccan-d, for the PCcan-D ISA card by KVASER
130 - pcican-q, for the PCIcan-Q PCI card by KVASER (4x SJA1000)
131 - pcican-d, for the PCIcan-Q PCI card by KVASER (2x SJA1000)
132 - pcican-s, for the PCIcan-Q PCI card by KVASER (1x SJA1000)
133 - nsican, for the CAN104 PC/104 card by NSI
134 - cc104, for the CAN104 PC/104 card by Contemporary Controls
135 - aim104, for the AIM104CAN PC/104 card by Arcom Control Systems
136 - pc-i03, for the PC-I03 ISA card by IXXAT
137 - pcm3680, for the PCM-3680 PC/104 card by Advantech
138 - m437, for the M436 PC/104 card by SECO
139 - bfadcan for sja1000 CAN embedded card made by BFAD GmbH
140 - pikronisa for ISA memory mapped sja1000 CAN card made by PiKRON Ltd.
141 - template, for yet unsupported hardware (you need to edit src/template.c)
142 - virtual, CAN channel for testing of software and driver without CAN hardware
143
144 options can be one of:
145 - major=<nr>, major specifies the major number of the driver.
146 - minor=<nr>, you can specify which minor numbers the driver should use for your
147   hardware.
148 - extended=[1|0], configures the driver to use extended message format.
149 - pelican=[1|0], configures the driver to set the CAN chips into pelican mode.
150 - baudrate=<nr>, sets the baudrate of the device(s)
151 - clock_freq=<nr>, the frequency of the CAN quartz
152 - stdmask=<nr>, sets the standard mask of the device
153 - extmask=<nr>, sets the extended mask of the device
154 - mo15mask=<nr>, sets the mask for message object 15 (i82527 only)
155
156 There's still a lot of work to do, have a look at the TODO file for more
157 information.