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