Merge: Corrected conditional for "virtual" board inclusion in the board list.

[lincan.git] / lincan / README

diff --git a/lincan/README b/lincan/README
index 7ff2b918541c55da32fd24d0d87708f816de5059..774de93b3b29cc8a6b32818b5e973dfc0f65899c 100644 (file)
--- a/lincan/README
+++ b/lincan/README
@@ -1,4 +1,5 @@
-               Linux CAN Driver (LinCAN) version 0.3
+
+               Linux CAN Driver (LinCAN) version 0.3.1

                Pavel Pisa <pisa@cmp.felk.cvut.cz>
                        OCERA team member
                        <http://www.ocera.org>
                Pavel Pisa <pisa@cmp.felk.cvut.cz>
                        OCERA team member
                        <http://www.ocera.org>


@@ -56,12 +57,18 @@ lincan-0.2-pre      heavily rewritten infrastructure of the driver based
 lincan-0.2     version tested on many bords and 2.2, 2.4, 2.6 Linux
 (Mar 2004)     and RT-Linux enabled 2.4 Linux kernel
 
 lincan-0.2     version tested on many bords and 2.2, 2.4, 2.6 Linux
 (Mar 2004)     and RT-Linux enabled 2.4 Linux kernel
 

-lincan-0.3     possible SMP and HT deadlock fixed, driver can take
+lincan-0.2.8   possible SMP and HT deadlock fixed, driver can take

 (Jul 2004)     advantage of CMPXCHG instruction if present on CPU,
                added support for CPC-PCI and PCAN-PCI cards,
                messages timestamping implemented
                partially implemented support for Bosch C_CAN module,
                requires more work and real hardware
 (Jul 2004)     advantage of CMPXCHG instruction if present on CPU,
                added support for CPC-PCI and PCAN-PCI cards,
                messages timestamping implemented
                partially implemented support for Bosch C_CAN module,
                requires more work and real hardware

+
+lincan-0.3     Changed SJA1000 chip IRQ handling. Enhanced VME
+(Nov 2004)     and EMS CPC-PCI support and many other changes.
+
+lincan-0.3.1   Small improvements, RTR read moved into separate IOCTL,
+(Jul 2005)     initial support for some boards contributed by users

                
 The actual version of driver have been latest tested it with
   - PC104 Advantech PCM3680 dual channel board on 2.4 RT-Linux enabled kernel
                
 The actual version of driver have been latest tested it with
   - PC104 Advantech PCM3680 dual channel board on 2.4 RT-Linux enabled kernel


@@ -136,6 +143,9 @@ Makefiles can be switched to old ones by script
   make
 
 If you have problem to obtain recent GNU make program,
   make
 
 If you have problem to obtain recent GNU make program,

+
+ http://paulandlesley.org/make/make-3.81beta1.tar.bz2
+

 you can use our local copy
 
   http://cmp.felk.cvut.cz/~pisa/can/make-3.81beta1.tar.gz
 you can use our local copy
 
   http://cmp.felk.cvut.cz/~pisa/can/make-3.81beta1.tar.gz


@@ -170,7 +180,7 @@ compiled with use of old style Makefiles as well.
 Old style Makefiles compilation of the LinCAN driver only
 ---------------------------------------------------------------------------
   cd ocera/components/comm/can/lincan
 Old style Makefiles compilation of the LinCAN driver only
 ---------------------------------------------------------------------------
   cd ocera/components/comm/can/lincan

-  ./switch2std
+  ./switch-omk2std

   make
 
 
   make
 
 


@@ -192,8 +202,10 @@ Examples: # insmod can.o hw=pip5 irq=4 io=0x8000
           # insmod can.o hw=virtual io=0
 
 The hw argument can be one of:
           # insmod can.o hw=virtual io=0
 
 The hw argument can be one of:

-- pip5, for the pip5 computer by MPL
-- pip6, for the pip6 computer by MPL
+- pip5, for the PIP5 computer by MPL
+- pip6, for the PIP6 computer by MPL
+- pip7, for the PIP7 computer by MPL
+- pip8, for the PIP8 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-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


@@ -201,6 +213,7 @@ The hw argument can be one of:
 - pcican-q, for the PCIcan-Q PCI card by KVASER (4x SJA1000)
 - pcican-d, for the PCIcan-Q PCI card by KVASER (2x SJA1000)
 - pcican-s, for the PCIcan-Q PCI card by KVASER (1x SJA1000)
 - pcican-q, for the PCIcan-Q PCI card by KVASER (4x SJA1000)
 - pcican-d, for the PCIcan-Q PCI card by KVASER (2x SJA1000)
 - pcican-s, for the PCIcan-Q PCI card by KVASER (1x SJA1000)

+- smartcan for i82527 based card with indexed access

 - 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
 - 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


@@ -213,7 +226,12 @@ The hw argument can be one of:
 - unican for Unicontrols PCAN card
 - unican-pci for Unicontrols PCAN-PCI card
 - unican-vme for Unicontrols VCAN card
 - unican for Unicontrols PCAN card
 - unican-pci for Unicontrols PCAN-PCI card
 - unican-vme for Unicontrols VCAN card

+- ipci165 for IXXAT iPC-I 165 (PCI), requires CONFIG_OC_LINCAN_CARD_ipci165=y

 - ems_cpcpci for EMS CPC-PCI card
 - ems_cpcpci for EMS CPC-PCI card

+- pcan_dongle for PEAK's printer port dongle addapter
+- 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

 - template, for yet unsupported hardware (you need to edit src/template.c)
 - virtual, CAN channel for testing of software and driver without CAN hardware
 
 - template, for yet unsupported hardware (you need to edit src/template.c)
 - virtual, CAN channel for testing of software and driver without CAN hardware
 


@@ -236,3 +254,6 @@ options can be one of:
 There's still a lot of work to do, have a look at the TODO file for more
 information.
 
 There's still a lot of work to do, have a look at the TODO file for more
 information.
 

+Some boards support is compiled in only, when it is enabled through
+config.omk file. It has to be stored in same directory as Makefile.rules
+and config.omk-default is located.