Added more details.
[mirror/scst/.git] / srpt / README.ofed
1 SCSI RDMA Protocol (SRP) Target driver for Linux
2 =================================================
3
4 Introduction
5 ------------
6
7 The SRP target driver has been designed to work on top of the Linux
8 InfiniBand kernel drivers. While all recent Linux distributions
9 include recent versions of the InfiniBand drivers, the only way to
10 obtain the latest available InfiniBand drivers is by installing the
11 OFED software stack.
12
13 The OFED stack is distributed by the OpenFabrics Alliance (OFA). The
14 mission of the OpenFabrics Alliance is to is to develop, distribute
15 and promote a unified, transport-independent, open-source software
16 stack for RDMA-capable fabrics and networks, including InfiniBand and
17 Ethernet.
18
19 Note: because during OFED installation the distro-provided InfiniBand
20 kernel drivers are replaced, doing so voids the support contract
21 offered by your Linux distributor.
22
23 Please follow the instructions below carefully. Skipping a step may
24 result in kernel modules that fail to load, a kernel oops or even a
25 system that does no longer boot.
26
27
28 Verifying the kernel version
29 ----------------------------
30
31 Before installing the OFED distribution, it is very important to check
32 the OFED release notes. Each OFED distribution has been tested
33 carefully, but only against the kernel versions specified in
34 docs/OFED_release_notes.txt (you can find this document in the OFED
35 distribution). Make sure that you are using a supported kernel / OFED
36 combination. As an example, if you want to use OFED 1.4.1 on an Ubuntu
37 system, you will have to start with replacing the Ubuntu kernel by a
38 kernel from kernel.org since OFED 1.4.1 has not been tested on any
39 Ubuntu kernel.
40
41
42 Compiling SRP against OFED
43 --------------------------
44
45 Make sure that all necessary packages needed for kernel compilation
46 have been installed (kernel headers, kernel source code, gcc,
47 binutils, ...).
48
49 Unload any loaded InfiniBand drivers:
50
51   /etc/init.d/opensmd stop
52   /etc/init.d/openibd stop
53
54 Remove any distro-provided InfiniBand drivers:
55
56   rm -rf /lib/modules/$(uname -r)/kernel/drivers/infiniband
57
58 Now locate the file Makefile.lib and patch it such that it supports
59 the variable PRE_CFLAGS:
60
61   cd /usr/src
62   find -name Makefile.lib
63   cd ...
64   patch -p0 < ${SCST_DIR}/srpt/patches/kernel-${KV}-scripts-Makefile.lib.patch
65
66 Next, download and install the OFED package. Make sure to disable
67 OFED's SRP target driver (srpt=n) and to enable at least the
68 kernel-ib, kernel-ib-devel and SRP tools packages. An example:
69
70   wget http://www.openfabrics.org/downloads/OFED/ofed-1.4/OFED-1.4.tgz
71   tar xzf OFED-1.4.tgz
72   cd OFED-1.4
73   cat <<EOF >ofed.conf
74   libibverbs=y                                          
75   libibverbs-utils=y                                    
76   libmthca=y                                            
77   libmlx4=y                                             
78   libcxgb3=y
79   libnes=y
80   libipathverbs=y
81   librdmacm=y
82   librdmacm-utils=y
83   mstflint=y
84   ofed-docs=y
85   ofed-scripts=y
86   kernel-ib=y
87   kernel-ib-devel=y
88   ibvexdmtools=y
89   qlgc_vnic_daemon=y
90   core=y
91   mthca=y
92   mlx4=y
93   mlx4_en=y
94   cxgb3=y
95   nes=y
96   ipath=y
97   ipoib=y
98   opensm=y
99   opensm-libs=y
100   srpt=n
101   srptools=y
102   EOF
103   ./install.pl -c ofed.conf  
104
105 Now continue with the installation instructions you can find in the
106 SCST-SRPT README file. The Makefile included with SCST-SRPT detects
107 whether OFED has been installed, and if so, compiles SCST-SRPT with
108 the OFED kernel headers instead of with the regular kernel headers.