Removed trailing whitespace because checkpatch complained about it.
[mirror/scst/.git] / fcst / README
1 fcst README                                             v0.1 02/17/2010
2
3 $Id$
4
5 FCST is a module that depends on libfc and SCST to provide FC target support.
6
7 To build for linux-2.6.33-rc8, do:
8
9 1. Get the kernel:
10
11         KERNEL=linux-2.6.33-rc8
12
13         cd /usr/src/kernels
14         URL_DIR=http://www.kernel.org/pub/linux/kernel/v2.6/testing/
15         TARFILE=$VER.tar.bz2
16         wget -o $TARFILE $URL_DIR/$TARFILE
17         tar xfj $TARFILE
18         cd $KERNEL
19
20 2. Apply patches needed for libfc target hooks and point-to-point fixes:
21
22         KDIR=/usr/src/kernels/$KERNEL
23         PDIR=/usr/src/scst/trunk/fcst/linux-patches     # use your dir here
24
25         cd $PDIR
26         for patch in `grep -v '^#' series-$KERNEL`
27         do
28                 (cd $KDIR; patch -p1) < $patch
29         done
30
31 3.  Apply SCST patches to the kernel
32         See trunk/scst/README
33         The readahead patches are not needed in 2.6.33.
34         The io_context patch needs to be adjusted for 2.6.33.  Skip it for now.
35
36 4.  Configure and make your kernel
37
38 5.  Install SCST
39         See trunk/scst/README. Make sure you are building sysfs SCST build, because
40         FCST supports only it.
41
42 6.  Make FCST
43         In this directory, just do
44                 make
45                 make install
46
47 7.  Install the FCoE admin tools, including dcbd and fcoeadm.
48         Some distros may have these.
49         You should be able to use the source at
50         http://www.open-fcoe.org/openfc/downloads/2.6.32/open-fcoe-2.6.32.tar.gz
51
52 8.  Bring up SCST and configure the devices.
53
54 9.  Bring up an FCoE initiator (we'll enable target mode on it later):
55         fcoeadm -c eth3
56
57     The other end can be an initiator as well, in point-to-point mode
58     over a full-duplex loss-less link (enable pause on both sides),
59     or a link to an FCoE switch.
60
61 10. Use fcc (part of the open-fcoe debug tools in step 7) to see the
62     initiator setup.  To get the FCoE port name for eth3
63
64         # fcc
65         FC HBAs:
66         HBA       Port Name                Port ID   State     Device
67         host4     20:00:00:1b:21:06:58:21  01:01:02  Online    eth3
68
69         host4 Remote Ports:
70         Path      Port Name                Port ID   State     Roles
71         4:0-0     10:00:50:41:4c:4f:3b:00  01:01:01  Online    FCP Initiator
72
73     In the above example, there's one local host on eth3, and it's in
74     a point-to-point connection with the remote initiator with Port_id 010101.
75
76 11.  Load fcst and create an ini-group for the remote initiator.  Do:
77
78         LPORT=20:00:00:1b:21:06:58:21           # the local Port_Name
79         INIT_PORT=10:00:50:41:4c:4f:3b:00       # remote Port Name
80         GROUP=test                              # your choice ini_group name
81         GDIR=$LPORT/ini_group/$GROUP
82
83         modprobe fcst
84         cd /sys/kernel/scst_tgt/targets/fcst
85         echo create $GROUP > $LPORT/ini_group/mgmt
86         echo add $INIT_PORT > $GDIR/initiators/mgmt
87
88 12.  Add any disks you want to the LUNs in that init group.
89
90         echo add disk-name 0 > $GDIR/luns/mgmt
91
92 13.  Enable the initiator:
93
94         echo 1 > $LPORT/enabled
95
96 14.  As a temporary workaround, you may need to reset the interface
97      on the initiator side so it sees the SCST device as a target and
98      discovers LUNs.  You can avoid this by bringing up the initiator last.