Documentation update to prepare for LinCAN-0.3.2 release. CLT_COMM_CAN-lincan-0_3_2
authorppisa <ppisa>
Fri, 10 Feb 2006 16:30:54 +0000 (16:30 +0000)
committerppisa <ppisa>
Fri, 10 Feb 2006 16:30:54 +0000 (16:30 +0000)
lincan/README
lincan/include/constants.h

index 774de93..d0b07e8 100644 (file)
@@ -1,8 +1,9 @@
 
-               Linux CAN Driver (LinCAN) version 0.3.1
+               Linux CAN Driver (LinCAN) version 0.3.2
                Pavel Pisa <pisa@cmp.felk.cvut.cz>
-                       OCERA team member
-                       <http://www.ocera.org>
+                       OCERA team member <http://www.ocera.org>
+                       Real-time Systems Laboratory <http://rtlab.felk.cvut.cz/>
+                       Department of Control Engineering, FEE CTU
 
 
 INTRODUCTION
@@ -69,10 +70,18 @@ lincan-0.3  Changed SJA1000 chip IRQ handling. Enhanced VME
 
 lincan-0.3.1   Small improvements, RTR read moved into separate IOCTL,
 (Jul 2005)     initial support for some boards contributed by users
+
+lincan-0.3.2   Improvements in SJA1000 error handling and reporting,
+(Feb 2006)     i82527 support fixes, simple UDEV support,
+               updates for kernels up to 2.6.15 and fully preemptive
+               kernel compatibility. Support for MX1_DIS1 extension
+               board for PiMX1 ARM based BCC.
+
                
 The actual version of driver have been latest tested it with
   - PC104 Advantech PCM3680 dual channel board on 2.4 RT-Linux enabled kernel
   - PiKRON ISA card on 2.4.and 2.6 Linux kernels
+  - PiKRON CAN extension board for PiMCX1 ARM BCC on 2.6 Linux kernels
   - BfaD DIMM PC card on 2.4 RT-Linux enabled kernel
   - KVASER pcican-q on 2.6 Linux kernel
   - MICROSPACE msmcan on 2.4 Linux and RT-Linux enabled kernel
@@ -90,17 +99,18 @@ 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.2.html
+  http://www.ocera.org/download/components/WP7/lincan-0.3.1.html
   
 List of related communication components
   
   http://www.ocera.org/download/components/WP7/index.html
 
-The CVS repository of OCERA project at SourceForge
+The obtaining LinCAN and other CAN related components
+from OCERA CVS repository at SourceForge
 
   EXTCVS=":pserver:anonymous@cvs.ocera.sourceforge.net:/cvsroot/ocera"
   cvs -d$EXTCVS login
-  cvs -z3 -d$EXTCVS co ocera
+  cvs -z3 -d$EXTCVS co ocera/components/comm/can
   
 Web access into CVS
 
@@ -118,7 +128,7 @@ and lists <ocera-development@lists.sourceforge.net>
 
 Driver documentation can be found at
 
-  http://cmp.felk.cvut.cz/~pisa/can/doc/lincandoc-0.2.pdf
+  http://cmp.felk.cvut.cz/~pisa/can/doc/lincandoc-0.3.pdf
 
 The anouncements of new version are published at FreshMeat page
 
@@ -144,7 +154,7 @@ Makefiles can be switched to old ones by script
 
 If you have problem to obtain recent GNU make program,
 
http://paulandlesley.org/make/make-3.81beta1.tar.bz2
ftp://alpha.gnu.org/gnu/make/make-3.81beta4.tar.bz2
 
 you can use our local copy
 
@@ -193,6 +203,20 @@ modules directory "/lib/modules/x.y.z/kernel/drivers/char".
 OMK system requires manual copy of files from "_compiled" tree
 to its final destinations.
 
+Create file "lincan.rules" with contents listed below in or linked
+into "/etc/udev/rules.d" directory to enable automatic device nodes
+creation for UDEV based system
+
+  # LinCAN driver
+  SUBSYSTEM=="can",GROUP="users",MODE="0660"
+
+The driver automatic loding can be requested by addition of "lincan"
+line into "/etc/modules" od Debian based systems.
+
+The target hardware/board specific options should be added into
+"/etc/modprobe.conf" file or file with similar functionality for your
+distribution. The options are discusses in the next paragraph.
+
 LOADING
 =======
 
@@ -222,6 +246,7 @@ The hw argument can be one of:
 - 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.
+- pimx1 for MX1_DIS1 extension board for PiMX1 ARM based BCC
 - msmcan for MICROSPACE IO space indexed i82527
 - unican for Unicontrols PCAN card
 - unican-pci for Unicontrols PCAN-PCI card
@@ -232,6 +257,9 @@ The hw argument can be one of:
 - oscar for SJA1000 based card connected to ARM LH7A400 SoC
 - eb8245 for Kontron EB8245 onboard CAN with SJA1000 controller
 - adlink7841 for ADLINK PCI-7841 dual SJA1000 based card
+- tscan1 for Technologic Systems' TS-CAN1 single SJA1000 based board
+- ts7kv for Technologic Systems' TS-7KV Multi-function board with SJA1000
+   both these cards require CONFIG_OC_LINCAN_CARD_tscan1=y
 - template, for yet unsupported hardware (you need to edit src/template.c)
 - virtual, CAN channel for testing of software and driver without CAN hardware
 
index b777cad..80c280b 100644 (file)
@@ -19,7 +19,7 @@
 /* Version of the driver */
 #define CAN_DRV_VER_MAJOR 0
 #define CAN_DRV_VER_MINOR 3
-#define CAN_DRV_VER_PATCH 1
+#define CAN_DRV_VER_PATCH 2
 #define CAN_DRV_VER ((CAN_DRV_VER_MAJOR<<16) | (CAN_DRV_VER_MINOR<<8) | CAN_DRV_VER_PATCH)
 
 /* Default driver major number, see /usr/src/linux/Documentation/devices.txt */