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