Added qla2x00t HOWTO written by Amit Mehta. Web pages updated correspondingly.
[mirror/scst/.git] / qla2x00t / qla2x00-target / qla2x00t-howto.html
1 <html>
2 <head>
3 <title>
4 How to configure QLogic target driver for 22xx/23xx cards
5 </title>
6 <body>
7
8 <div style="text-align: center;"> <strong>How to configure QLogic target driver for 22xx/23xx cards. Step by step guide.</strong></br></br></div>\r
9 \r
10                     <div style="text-align: center;"> <strong>ON TARGET</strong></div><br><br>\r
11 \r
12 1: Get the Linux kernel sources for version >= 2.6.16 from kernel.org</br>\r
13     <br>I've downloaded kernel version 2.6.24</br>\r
14     <br><a href="ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.24.tar.bz2">ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.24.tar.bz2</a></br></br></br>\r
15 \r
16 2: Get the appropiate firmware for your QLogic card from<a href="ftp://ftp.qlogic.com/outgoing/linux/firmware">\r
17    ftp://ftp.qlogic.com/outgoing/linux/firmware/</a> and put it under /lib/firmware.\r
18     Otherwise during boot or when you manually insert the QLogic module, you'll\r
19     get the following error mesage in the logs(/var/log/messages)\r
20     &lt snip &gt</br></br>\r
21 \r
22     qla2xxx 0000:13:00.0: Firmware image unavailable.</br>\r
23     qla2xxx 0000:13:00.0: Failed to initialize adapter</br>\r
24     &lt snip &gt</br>\r
25 \r
26     In this case I had to download ql2400_fw.bin</br></br></br>\r
27 \r
28 3: Unzip it under /usr/src/</br>\r
29     [root@proj src ] bunzip2 /usr/src/linux-2.6.24.tar.bz2</br>\r
30     [root@server src ] tar -xvf /usr/src/linux-2.6.24.tar</br></br></br>\r
31    \r
32 4: Create symlinks</br>\r
33     [root@proj src ] pwd</br>\r
34     /usr/src</br>\r
35     [root@proj src ] ln -s /usr/src/linux-2.6.24 linux</br>\r
36     [root@proj src ] ln -s /usr/src/linux-2.6.24 kernel</br></br></br>\r
37 \r
38 5: Get the SCST code from their SVN code base</br>\r
39     [root@proj ] svn co https://scst.svn.sourceforge.net/svnroot/scst</br>\r
40     If the command returns successfully then you'll have 'scst'</br>\r
41     directory under your current directory ( here it is /root )</br></br>\r
42    \r
43     Please check if svn (open source version control system) is installed on\r
44     your Linux box.</br></br></br>\r
45 \r
46 6:  Change directory to ~scst/trunk/</br>\r
47     [root@proj trunk]# pwd</br>\r
48     /root/scst/trunk</br></br>\r
49 \r
50     [root@proj trunk]# ls</br>\r
51     AskingQuestions        iscsi-release.patch  mpt                       qla2x00t-release.patch  scripts    scst-full_perf.patch  usr                  www\r
52     doc                    iscsi-scst           qla2x00t                  qla_isp                 scst       scst-release.patch    usr-full_perf.patch\r
53     iscsi-full_perf.patch  Makefile             qla2x00t-full_perf.patch  README                  scstadmin  srpt                  usr-release.patch</br></br></br>\r
54 \r
55 7:  Patch the kernel (the kernel version you've downloaded in step 1)</br>\r
56     [root@proj ] cp /root/scst/trunk/scst/kernel/scst_exec_req_fifo-2.6.24.patch /usr/src</br></br>\r
57    \r
58     [root@proj ] cd /usr/src</br>\r
59     [root@proj src] patch -p0 &lt scst_exec_req_fifo-2.6.24.patch</br></br></br>\r
60 \r
61 8: Replace the QLogic FC driver code in the kernel source tree with the modified version \r
62     of QLogic FC driver code from scst code base.</br></br>\r
63     [root@proj trunk] pwd</br>\r
64     /root/scst/trunk</br>\r
65     [root@proj trunk] mv /usr/src/linux/drivers/scsi/qla2xxx /usr/src/linux/drivers/scsi/qla2xxx_orig</br>\r
66     [root@proj trunk] ln -s /root/scst/trunk/qla2x00t /usr/src/linux/drivers/scsi/qla2xxx</br></br></br>\r
67    \r
68 9: Now build the kernel.</br></br>\r
69    \r
70     Make sure you disable kernel hacking feature, and enable\r
71     "Device Drivers->SCSI device support->SCSI low level drivers->Qlogic 2xxx target mode support"</br>\r
72     (i.e. CONFIG_SCSI_QLA2XXX_TARGET=y)</br>\r
73     Also turn OFF HIGHMEM4G|HIGHMEM64G,</br>\r
74     i.e.</br>\r
75     [root@proj ] grep -i highmem /usr/src/linux/.config</br>\r
76     CONFIG_NOHIGHMEM=y</br>\r
77     # CONFIG_HIGHMEM4G is not set</br>\r
78     # CONFIG_HIGHMEM64G is not set</br></br>\r
79    \r
80     [root@proj linux ] pwd</br>\r
81     /usr/src/linux</br>\r
82     [root@proj linux ] make</br>\r
83     [root@proj linux ] make menuconfig</br>\r
84     [root@proj linux ] make modules</br>\r
85     [root@proj linux ] make modules_install</br>\r
86     [root@proj linux ] make install</br></br></br>\r
87    \r
88 10: Reboot the machine and during boot select the modified kernel to boot from.</br></br></br>\r
89 \r
90 11:Depending on your requirement (performance/debugging) apply the appropiate\r
91     patches that comes with choose the appropriate SCST build mode. By default SCST has debug build mode.
92     Here is how to switch to the release mode:</br></br>\r
93     [root@proj trunk ] pwd</br>\r
94     /root/scst/trunk</br>\r
95     [root@proj trunk ] make debug2release</br></br></br>\r
96 \r
97 12:OPTIONAL step: do the cleanup before building scst module</br>\r
98     (Follow step 11 only if you get error "scst: disagrees about version of\r
99     symbol struct_module")</br></br>\r
100    \r
101     This error indicates that the kernel module the script was trying to\r
102     load was compiled against kernel headers that do not match the running\r
103     kernel. Doing a clean rebuild of the kernel and SCST should make the\r
104     above error go away. To make sure nothing of the old kernel is left,\r
105     Do clean rebuild of kernel and SCST :</br>\r
106     Follow the step below:</br></br>\r
107    \r
108     [root@proj linux ] pwd</br>\r
109     /usr/src/linux</br>\r
110     [root@proj linux ] make oldconfig</br>\r
111     [root@proj linux ] make clean</br>\r
112     [root@proj linux ] rm -rf /lib/modules/`uname -r`</br>\r
113     [root@proj linux ] make modules</br>\r
114     [root@proj linux ] make modules_install</br>\r
115     [root@proj linux ] make install</br>\r
116     [root@proj linux ] reboot</br></br></br>\r
117 \r
118 13:Now build the modules.</br>\r
119     But first make sure that the link "/lib/modules/`uname -r`/build"</br>\r
120     points to the current running kernel sources.</br></br>\r
121    \r
122     a) Build scst.</br>\r
123         [root@proj ] cd /root/scst/trunk/scst/src</br>\r
124         [root@proj ] make all (here I am building everything)</br>\r
125         [root@proj ] make install</br>\r
126        \r
127 \r
128     b) Build QLogic driver.</br>\r
129         [root@proj ] cd /root/scst/trunk/qla2x00t</br>\r
130         [root@proj ] make</br>\r
131         [root@proj ] make install</br></br>\r
132    \r
133     c) Build QLogic target driver</br>\r
134         [root@proj ] cd /root/scst/trunk/qla2x00t/qla2x00-target/</br>\r
135         root@proj ] make</br>\r
136         [root@proj ] make install</br></br></br>\r
137                 \r
138        \r
139 14:Insert the modules.</br>\r
140     The driver modules will be installed in '/lib/modules/`you_kernel_version`/extra'.</br>\r
141     In addition, scst.h, scst_debug.h as well as Module.symvers or\r
142     Modules.symvers will be copied to '/usr/local/include/scst'.</br> The first\r
143     file contains all SCST's public data definition, which are used by\r
144     target drivers. The other ones support debug messages logging and build process.</br></br>\r
145    \r
146     [root@proj scst]# ls -l /lib/modules/`uname -r`/extra</br>\r
147     total 232</br>\r
148     drwxr-xr-x  2 root root   4096 Jun 20 18:43 dev_handlers</br>\r
149     -rw-r--r--  1 root root  36756 Jun 20 18:46 qla2x00tgt.ko</br>\r
150     -rw-r--r--  1 root root 160192 Jun 20 18:46    qla2xxx.ko </br>  \r
151     -rw-r--r--  1 root root 190848 Jun 20 18:43 scst.ko</br></br>\r
152    \r
153     [root@proj scst]# ls -l /lib/modules/`uname -r`/extra/dev_handlers</br>\r
154     total 192</br>\r
155     -rw-r--r--  1 root root 11757 Jun 20 18:43 scst_cdrom.ko</br>\r
156     -rw-r--r--  1 root root 10111 Jun 20 18:43 scst_changer.ko</br>\r
157     -rw-r--r--  1 root root 12420 Jun 20 18:43 scst_disk.ko</br>\r
158     -rw-r--r--  1 root root 12449 Jun 20 18:43 scst_modisk.ko</br>\r
159     -rw-r--r--  1 root root 10131 Jun 20 18:43 scst_processor.ko</br>\r
160     -rw-r--r--  1 root root 10081 Jun 20 18:43 scst_raid.ko</br>\r
161     -rw-r--r--  1 root root 12563 Jun 20 18:43 scst_tape.ko</br>\r
162     -rw-r--r--  1 root root 37937 Jun 20 18:43 scst_user.ko</br>\r
163     -rw-r--r--  1 root root 50194 Jun 20 18:43 scst_vdisk.ko</br></br>\r
164    \r
165     where:</br>\r
166     - scst - SCST itself</br>\r
167      - scst_disk - device handler for disks (type 0)</br>\r
168      - scst_tape - device handler for tapes (type 1)</br>\r
169      - scst_processor - device handler for processors (type 3)</br>\r
170      - scst_cdrom - device handler for CDROMs (type 5)</br>\r
171      - scst_modisk - device handler for MO disks (type 7)</br>\r
172      - scst_changer - device handler for medium changers (type 8)</br>\r
173      - scst_raid - device handler for storage array controller (e.g. raid) (type C)</br>\r
174      - scst_vdisk - device handler for virtual disks (file, device or ISO CD image).</br>\r
175      - scst_user - user space device handler</br></br>\r
176 \r
177     You can insert any of these modules by 'modprobe' program, I've inserted all\r
178     the modules !!!</br>\r
179     [root@proj ] for _mod in scst qla2xxx qla2x00tgt scst_vdisk scst_user \r
180         scst_disk....; do modprobe $_mod; done</br></br>\r
181 \r
182     &lt snip from dmesg &gt</br></br>\r
183 \r
184     scst: SCST version 1.0.0-rc1 loaded successfully (max mem for commands 16251MB, per device 6500MB)</br>\r
185     scst: Enabled features: TRACING</br>\r
186     scst: Target template qla2x00tgt registered successfully</br>\r
187     scst: Virtual device handler vdisk for type 0 registered successfully</br>\r
188     scst: Virtual device handler "scst_user" registered successfully</br>\r
189     --------</br>\r
190     --------</br>\r
191     &lt snip from dmesg &gt</br></br></br>\r
192 \r
193 15:To see the devices remotely, we have to add them to atleast "Default" security group.</br>\r
194     Where each security group will have LUN 0(LUs numeration must not start from, e.g., 1)</br></br>\r
195 \r
196    \r
197     [root@proj ] dd if=/dev/zero of=/mnt/disk1 bs=1024k count=512</br>\r
198     512+0 records in</br>\r
199     512+0 records out</br></br>\r
200    \r
201     [root@proj ] ls -l /mnt/disk1</br>\r
202     -rw-r--r--  1 root root 536870912 Jun 23 13:27 /mnt/disk1</br></br>\r
203    \r
204     [root@proj ] file /mnt/disk1</br>\r
205     /mnt/disk1: data</br></br>\r
206 \r
207    \r
208     [root@proj ] echo "open vm_disk /mnt/disk1" > /proc/scsi_tgt/vdisk/vdisk</br>\r
209    \r
210     [root@proj ] echo "add vm_disk 0" >/proc/scsi_tgt/groups/Default/devices</br></br>\r
211 \r
212     &lt snip from dmesg &gt</br>\r
213     dev_vdisk: Attached SCSI target virtual disk vm_disk (file="/mnt/disk1", fs=512MB, bs=512, nblocks=1048576, cyln=512)</br>\r
214     scst: Attached SCSI target mid-level to virtual device vm_disk (id 1)</br>\r
215     scst: Added device vm_disk to group Default (LUN 0, rd_only 0)</br>\r
216     &lt snip from dmesg &gt</br></br>\r
217    \r
218     [root@proj ] cat /proc/scsi_tgt/groups/Default/devices</br>\r
219     Device (host:ch:id:lun or name)                             Virtual lun  Options</br>\r
220     vm_disk                                                        0           </br></br>\r
221 \r
222     [root@proj ] cat /proc/scsi_tgt/vdisk/vdisk</br>\r
223     Name              Size(MB)    Block size  Options         File name</br>\r
224     vm_disk           512         512                         /mnt/disk1</br></br></br>\r
225    \r
226    \r
227 16:After the drivers are loaded, the target mode should be enabled via a</br>\r
228 \r
229     sysfs interface on a per card basis. Under the appropriate scsi_host\r
230     there is an entry target_mode_enabled, where you should write "1", like:</br>\r
231 \r
232     [root@proj ] echo "1" >/sys/class/scsi_host/host11/target_mode_enabled</br></br>\r
233 \r
234 \r
235   <div style="text-align: center;"><strong>ON INITIATOR</strong></div></br>\r
236 \r
237 17:&lt snip from README &gt</br>\r
238     Without loading appropriate device handler, corresponding device\r
239     will be invisible for remote initiators, hence we have to\r
240     add them manully.</br> \r
241    &lt snip from README &gt</br></br>\r
242 \r
243     But as I've already loaded the device handler(scst_vdisk) on the target, \r
244     hence I don't need to perform step 17. </br></br>\r
245    \r
246     [root@initiator ] echo "scsi add-single-device 11 0 0 0" >/proc/scsi/scsi</br>\r
247     where A: host number</br>\r
248           B: Lun</br></br></br>\r
249 \r
250 18:After enabling the target mode on the target (see step 16),\r
251    to see new targets and devices you need either to rescan \r
252    initiator(s) manually, for example, by rmmod/modprobe the\r
253    corresponding FC device module on the initiator, or reboot the initiator itself.
254    Automatic discovery isn't supported by all known initiators,\r
255    so you need a way to make SCSI subsystem on the initiator to do the new devices discovery and hence be able to see\r
256    the new devices attached.</br></br>\r
257
258    Alternatively, if your initiator already connected to the target and you simply added new devices to it, you can try to run
259    a manual rescan by:</br>
260
261    [root@initiator ] echo "scsi add-single-device 11 0 0 B" >/proc/scsi/scsi</br>\r
262     where A: host number</br>\r
263           B: Lun</br></br></br>\r
264  \r
265 </body>\r
266 </html>                 \r
267