Documentation: kernel-parameters.txt cleanups
[linux-2.6.git] / Documentation / scsi / dc395x.txt
1 README file for the dc395x SCSI driver
2 ==========================================
3
4 Status
5 ------
6 The driver has been tested with CD-R and CD-R/W drives. These should
7 be safe to use. Testing with hard disks has not been done to any
8 great degree and caution should be exercised if you want to attempt
9 to use this driver with hard disks.
10
11 This is a 2.5 only driver. For a 2.4 driver please see the original
12 driver (which this driver started from) at
13 http://www.garloff.de/kurt/linux/dc395/
14
15 Problems, questions and patches should be submitted to the mailing
16 list. Details on the list, including archives, are available at
17 http://lists.twibble.org/mailman/listinfo/dc395x/
18
19 Parameters
20 ----------
21 The driver uses the settings from the EEPROM set in the SCSI BIOS 
22 setup. If there is no EEPROM, the driver uses default values.
23 Both can be overridden by command line parameters (module or kernel
24 parameters).
25
26 The following parameters are available:
27
28  - safe
29    Default: 0, Acceptable values: 0 or 1
30
31    If safe is set to 1 then the adapter will use conservative
32    ("safe") default settings. This sets:
33
34                 shortcut for dc395x=7,4,9,15,2,10
35
36  - adapter_id
37    Default: 7, Acceptable values: 0 to 15
38
39    Sets the host adapter SCSI ID.
40
41  - max_speed
42    Default: 1, Acceptable value: 0 to 7
43    0 = 20   Mhz
44    1 = 12.2 Mhz
45    2 = 10   Mhz
46    3 = 8    Mhz
47    4 = 6.7  Mhz
48    5 = 5.8  Hhz
49    6 = 5    Mhz
50    7 = 4    Mhz
51
52  - dev_mode
53    Bitmap for device configuration
54
55    DevMode bit definition:
56       Bit Val(hex) Val(dec)  Meaning
57       *0    0x01       1     Parity check
58       *1    0x02       2     Synchronous Negotiation
59       *2    0x04       4     Disconnection
60       *3    0x08       8     Send Start command on startup. (Not used)
61       *4    0x10      16     Tagged Command Queueing
62       *5    0x20      32     Wide Negotiation
63
64  - adapter_mode
65    Bitmap for adapter configuration
66
67    AdaptMode bit definition
68       Bit Val(hex) Val(dec)  Meaning
69       *0    0x01       1     Support more than two drives. (Not used)
70       *1    0x02       2     Use DOS compatible mapping for HDs greater than 1GB.
71       *2    0x04       4     Reset SCSI Bus on startup.
72       *3    0x08       8     Active Negation: Improves SCSI Bus noise immunity.
73        4    0x10      16     Immediate return on BIOS seek command. (Not used)
74     (*)5    0x20      32     Check for LUNs >= 1.
75
76  - tags
77    Default: 3, Acceptable values: 0-5
78    
79    The number of tags is 1<<x, if x has been specified
80
81  - reset_delay
82    Default: 1, Acceptable values: 0-180
83
84    The seconds to not accept commands after a SCSI Reset
85
86
87 For the built  in driver the parameters should be prefixed with
88 dc395x. (eg "dc395x.safe=1")
89
90
91 Copyright
92 ---------
93 The driver is free software. It is protected by the GNU General Public
94 License (GPL). Please read it, before using this driver. It should be
95 included in your kernel sources and with your distribution. It carries the
96 filename COPYING. If you don't have it, please ask me to send you one by
97 email.
98 Note: The GNU GPL says also something about warranty and liability. 
99 Please be aware the following: While we do my best to provide a working and
100 reliable driver, there is a chance, that it will kill your valuable data. 
101 We refuse to take any responsibility for that. The driver is provided as-is
102 and YOU USE IT AT YOUR OWN RESPONSIBILITY.