vserver 1.9.5.x5
[linux-2.6.git] / Documentation / cciss.txt
1 This driver is for Compaq's SMART Array Controllers.
2
3 Supported Cards:
4 ----------------
5
6 This driver is known to work with the following cards:
7
8         * SA 5300
9         * SA 5i 
10         * SA 532
11         * SA 5312
12         * SA 641
13         * SA 642
14         * SA 6400
15         * SA 6400 U320 Expansion Module
16         * SA 6i
17         * SA P600
18
19 If nodes are not already created in the /dev/cciss directory, run as root:
20
21 # cd /dev
22 # ./MAKEDEV cciss
23
24 Device Naming:
25 --------------
26
27 You need some entries in /dev for the cciss device.  The MAKEDEV script
28 can make device nodes for you automatically.  Currently the device setup
29 is as follows:
30
31 Major numbers:
32         104     cciss0  
33         105     cciss1  
34         106     cciss2
35         105     cciss3
36         108     cciss4
37         109     cciss5
38         110     cciss6
39         111     cciss7
40
41 Minor numbers:
42         b7 b6 b5 b4 b3 b2 b1 b0
43         |----+----| |----+----|
44              |           |
45              |           +-------- Partition ID (0=wholedev, 1-15 partition)
46              |
47              +-------------------- Logical Volume number
48
49 The device naming scheme is:
50 /dev/cciss/c0d0                 Controller 0, disk 0, whole device
51 /dev/cciss/c0d0p1               Controller 0, disk 0, partition 1
52 /dev/cciss/c0d0p2               Controller 0, disk 0, partition 2
53 /dev/cciss/c0d0p3               Controller 0, disk 0, partition 3
54
55 /dev/cciss/c1d1                 Controller 1, disk 1, whole device
56 /dev/cciss/c1d1p1               Controller 1, disk 1, partition 1
57 /dev/cciss/c1d1p2               Controller 1, disk 1, partition 2
58 /dev/cciss/c1d1p3               Controller 1, disk 1, partition 3
59
60 SCSI tape drive and medium changer support
61 ------------------------------------------
62
63 SCSI sequential access devices and medium changer devices are supported and 
64 appropriate device nodes are automatically created.  (e.g.  
65 /dev/st0, /dev/st1, etc.  See the "st" man page for more details.) 
66 You must enable "SCSI tape drive support for Smart Array 5xxx" and 
67 "SCSI support" in your kernel configuration to be able to use SCSI
68 tape drives with your Smart Array 5xxx controller.
69
70 Additionally, note that the driver will not engage the SCSI core at init 
71 time.  The driver must be directed to dynamically engage the SCSI core via 
72 the /proc filesystem entry which the "block" side of the driver creates as 
73 /proc/driver/cciss/cciss* at runtime.  This is because at driver init time, 
74 the SCSI core may not yet be initialized (because the driver is a block 
75 driver) and attempting to register it with the SCSI core in such a case 
76 would cause a hang.  This is best done via an initialization script 
77 (typically in /etc/init.d, but could vary depending on distibution). 
78 For example:
79
80         for x in /proc/driver/cciss/cciss[0-9]*
81         do
82                 echo "engage scsi" > $x
83         done
84
85 Once the SCSI core is engaged by the driver, it cannot be disengaged 
86 (except by unloading the driver, if it happens to be linked as a module.)
87
88 Note also that if no sequential access devices or medium changers are
89 detected, the SCSI core will not be engaged by the action of the above
90 script.
91
92 Hot plug support for SCSI tape drives
93 -------------------------------------
94
95 Hot plugging of SCSI tape drives is supported, with some caveats.
96 The cciss driver must be informed that changes to the SCSI bus
97 have been made, in addition to and prior to informing the SCSI 
98 mid layer.  This may be done via the /proc filesystem.  For example:
99
100         echo "rescan" > /proc/scsi/cciss0/1
101
102 This causes the adapter to query the adapter about changes to the 
103 physical SCSI buses and/or fibre channel arbitrated loop and the 
104 driver to make note of any new or removed sequential access devices
105 or medium changers.  The driver will output messages indicating what 
106 devices have been added or removed and the controller, bus, target and 
107 lun used to address the device.  Once this is done, the SCSI mid layer 
108 can be informed of changes to the virtual SCSI bus which the driver 
109 presents to it in the usual way. For example: 
110
111         echo scsi add-single-device 3 2 1 0 > /proc/scsi/scsi
112  
113 to add a device on controller 3, bus 2, target 1, lun 0.   Note that
114 the driver makes an effort to preserve the devices positions
115 in the virtual SCSI bus, so if you are only moving tape drives 
116 around on the same adapter and not adding or removing tape drives 
117 from the adapter, informing the SCSI mid layer may not be necessary.
118
119 Note that the naming convention of the /proc filesystem entries 
120 contains a number in addition to the driver name.  (E.g. "cciss0" 
121 instead of just "cciss" which you might expect.)
122
123 Note: ONLY sequential access devices and medium changers are presented 
124 as SCSI devices to the SCSI mid layer by the cciss driver.  Specifically, 
125 physical SCSI disk drives are NOT presented to the SCSI mid layer.  The 
126 physical SCSI disk drives are controlled directly by the array controller 
127 hardware and it is important to prevent the kernel from attempting to directly
128 access these devices too, as if the array controller were merely a SCSI 
129 controller in the same way that we are allowing it to access SCSI tape drives.
130