(no commit message)

[ortcan-www.git] / lincan / index.mdwn

diff --git a/lincan/index.mdwn b/lincan/index.mdwn
index 97b5b3bed0b8168c59e53032dfaf40a5ddd81d56..c013d03d7609f9e7172e12c0662db3583c3d68ff 100644 (file)
--- a/lincan/index.mdwn
+++ b/lincan/index.mdwn
@@ -52,3 +52,36 @@ is required then cross-compiler binaries have to be specified
     CXX=powerpc-linux-gnu-g++
     AR=powerpc-linux-gnu-ar
     LD=powerpc-linux-gnu-ld
+
+## LinCAN installation and use
+
+Driver can be load into kernel directly from build directory.
+Example for pcm3680 PC/104 card
+
+    insmod _compiled/modules/lincan.ko hw=pcm3680 io=0x200 irq=7,11
+
+The board is non-plug and play and that is why all parameters has
+to be specified. Only board hardware type (i.e. hw=pcican-q) and
+zero/automatic I/O address are required (io=0) for PCI and other
+PnP cards. The boar hardware identifiers and corresponding io locations
+are separated by comma in the case of multiple boards used.
+
+The driver can be installed into system
+
+    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
+
+and then load by modprobe
+
+    modprobe lincan hw=pcm3680 io=0x200 irq=7,11
+
+or setup to autoload after boot (configuration style for Debian based system)
+
+    echo "lincan hw=pcm3680 io=0x200 irq=7,11" >/etc/modules
+
+Next line grants CAN driver access to the all regular system users
+included in users group
+
+    echo 'SUBSYSTEM=="can",GROUP="users",MODE="0660"' >/etc/udev/rules.d/10-lincan.rules