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