Merge master into can-usb1 branch to include proc update for 3.12+ kernels.

[lincan.git] / lincan / README

diff --git a/lincan/README b/lincan/README
index 6d171ab49bb9787511225e3e4ccfb76f6716a284..eee58429bba343171e9c4000e5d3dc363bfb2b35 100644 (file)
--- a/lincan/README
+++ b/lincan/README
@@ -161,14 +161,14 @@ whole OrtCAN tree.
 The latest version of stand-alone LinCAN sources can be
 obtained from GIT repository and build by next commands
 
-  git clone git://ortcan.git.sourceforge.net/gitroot/ortcan/lincan
+  git clone git://git.code.sf.net/p/ortcan/lincan
   cd lincan
   ./build-lincan.sh
 
 The other option is to build LinCAN driver as part of the whole
 OrtCAN tree
 
-  git clone git://ortcan.git.sourceforge.net/gitroot/ortcan/ortcan
+  git clone git://git.code.sf.net/p/ortcan/ortcan-top
   cd ortcan/
   git submodule update --init
   make default-config
@@ -199,24 +199,40 @@ INSTALLATION
 ============
 Type 'make install' for standard make system compilation.
 The driver should be copied into actual kernel version
-modules directory "/lib/modules/x.y.z/kernel/drivers/char".
+modules directory "/lib/modules/x.y.z/extra".
 
 OMK system requires manual copy of files from "_compiled" tree
-to its final destinations.
+to its final destinations. Just compiled driver can be
+tested directly from LinCAN build directory (i.e. example
+for PC/104 PCM3680 board)
 
-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
+  insmod _compiled/modules/lincan.ko hw=pcm3680 io=0x200 irq=7,11
+
+Driver can be copied into system final location after testing
+
+  mkdir /lib/modules/$(uname -r)/extra
+  cp _compiled/modules/lincan.ko /lib/modules/$(uname -r)/extra
+  chown root:root /lib/modules/$(uname -r)/extra/lincan.ko
+  depmod -a
+
+Right to access the driver for non-root users can be granted by
+generation of "10-lincan.rules" in the UDEV configuration directory
+"/etc/udev/rules.d"
 
   # 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 driver automatic loading of the driver can be requested by addition
+of "lincan" line into "/etc/modules" for Debian based systems. The module
+parameters can be specified in the same file after "lincan" driver name
+or in separate file in "/etc/modprobe.d" directory (i.e.)
+
+  echo >/etc/modprobe.d/lincan.conf \
+     options lincan processlocal=2 hw=pcm3680 io=0x200 irq=7,11
 
-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.
+This files location can vary between distributions.
+The LinCAN driver options are discusses in more details in
+the next paragraph.
 
 LOADING
 =======
@@ -250,6 +266,7 @@ The hw argument can be one of:
 - gensja1000io for many sja1000 I/O mapped cards (PCAN-PC/104 for example).
 - gensja1000mm for ISA memory mapped sja1000 CAN cards
   (for pikronisa card used by PiKRON Ltd. the clockfreq=24000 has to be specified)
+- pcisja1000mm for SJA1000 directly mapped into PCI mem region 0
 - pimx1 for MX1_DIS1 extension board for PiMX1 ARM based BCC
 - msmcan for MICROSPACE IO space indexed i82527
 - unican for Unicontrols PCAN card