ide: remove obsoleted "idex=" kernel parameters
[linux-2.6/libata-dev.git] / Documentation / ide / ide.txt
blobaf95fb33d1a10440df46b015b7ed6d43f353c504
2         Information regarding the Enhanced IDE drive in Linux 2.6
4 ==============================================================================
7    The hdparm utility can be used to control various IDE features on a
8    running system. It is packaged separately.  Please Look for it on popular
9    linux FTP sites.
13 ***  IMPORTANT NOTICES:  BUGGY IDE CHIPSETS CAN CORRUPT DATA!!
14 ***  =================
15 ***  PCI versions of the CMD640 and RZ1000 interfaces are now detected
16 ***  automatically at startup when PCI BIOS support is configured.
17 ***
18 ***  Linux disables the "prefetch" ("readahead") mode of the RZ1000
19 ***  to prevent data corruption possible due to hardware design flaws.
20 ***
21 ***  For the CMD640, linux disables "IRQ unmasking" (hdparm -u1) on any
22 ***  drive for which the "prefetch" mode of the CMD640 is turned on.
23 ***  If "prefetch" is disabled (hdparm -p8), then "IRQ unmasking" can be
24 ***  used again.
25 ***
26 ***  For the CMD640, linux disables "32bit I/O" (hdparm -c1) on any drive
27 ***  for which the "prefetch" mode of the CMD640 is turned off.
28 ***  If "prefetch" is enabled (hdparm -p9), then "32bit I/O" can be
29 ***  used again.
30 ***
31 ***  The CMD640 is also used on some Vesa Local Bus (VLB) cards, and is *NOT*
32 ***  automatically detected by Linux.  For safe, reliable operation with such
33 ***  interfaces, one *MUST* use the "cmd640.probe_vlb" kernel option.
34 ***
35 ***  Use of the "serialize" option is no longer necessary.
37 ================================================================================
38 Common pitfalls:
40 - 40-conductor IDE cables are capable of transferring data in DMA modes up to
41   udma2, but no faster.
43 - If possible devices should be attached to separate channels if they are
44   available. Typically the disk on the first and CD-ROM on the second.
46 - If you mix devices on the same cable, please consider using similar devices
47   in respect of the data transfer mode they support.
49 - Even better try to stick to the same vendor and device type on the same
50   cable.
52 ================================================================================
54 This is the multiple IDE interface driver, as evolved from hd.c.
56 It supports up to 9 IDE interfaces per default, on one or more IRQs (usually
57 14 & 15).  There can be up to two drives per interface, as per the ATA-6 spec.
59 Primary:    ide0, port 0x1f0; major=3;  hda is minor=0; hdb is minor=64
60 Secondary:  ide1, port 0x170; major=22; hdc is minor=0; hdd is minor=64
61 Tertiary:   ide2, port 0x1e8; major=33; hde is minor=0; hdf is minor=64
62 Quaternary: ide3, port 0x168; major=34; hdg is minor=0; hdh is minor=64
63 fifth..     ide4, usually PCI, probed
64 sixth..     ide5, usually PCI, probed
66 To access devices on interfaces > ide0, device entries please make sure that
67 device files for them are present in /dev.  If not, please create such
68 entries, by using /dev/MAKEDEV.
70 This driver automatically probes for most IDE interfaces (including all PCI
71 ones), for the drives/geometries attached to those interfaces, and for the IRQ
72 lines being used by the interfaces (normally 14, 15 for ide0/ide1).
74 Any number of interfaces may share a single IRQ if necessary, at a slight
75 performance penalty, whether on separate cards or a single VLB card.
76 The IDE driver automatically detects and handles this.  However, this may
77 or may not be harmful to your hardware.. two or more cards driving the same IRQ
78 can potentially burn each other's bus driver, though in practice this
79 seldom occurs.  Be careful, and if in doubt, don't do it!
81 Drives are normally found by auto-probing and/or examining the CMOS/BIOS data.
82 For really weird situations, the apparent (fdisk) geometry can also be specified
83 on the kernel "command line" using LILO.  The format of such lines is:
85         hdx=cyls,heads,sects
86 or      hdx=cdrom
88 where hdx can be any of hda through hdh, Three values are required
89 (cyls,heads,sects).  For example:
91         hdc=1050,32,64  hdd=cdrom
93 either {hda,hdb} or {hdc,hdd}.  The results of successful auto-probing may
94 override the physical geometry/irq specified, though the "original" geometry
95 may be retained as the "logical" geometry for partitioning purposes (fdisk).
97 If the auto-probing during boot time confuses a drive (ie. the drive works
98 with hd.c but not with ide.c), then an command line option may be specified
99 for each drive for which you'd like the drive to skip the hardware
100 probe/identification sequence.  For example:
102         hdb=noprobe
104         hdc=768,16,32
105         hdc=noprobe
107 Note that when only one IDE device is attached to an interface, it should be
108 jumpered as "single" or "master", *not* "slave".  Many folks have had
109 "trouble" with cdroms because of this requirement, so the driver now probes
110 for both units, though success is more likely when the drive is jumpered
111 correctly.
113 Courtesy of Scott Snyder and others, the driver supports ATAPI cdrom drives
114 such as the NEC-260 and the new MITSUMI triple/quad speed drives.
115 Such drives will be identified at boot time, just like a hard disk.
117 If for some reason your cdrom drive is *not* found at boot time, you can force
118 the probe to look harder by supplying a kernel command line parameter
119 via LILO, such as:
121         hdc=cdrom       /* hdc = "master" on second interface */
123         hdd=cdrom       /* hdd = "slave" on second interface */
125 For example, a GW2000 system might have a hard drive on the primary
126 interface (/dev/hda) and an IDE cdrom drive on the secondary interface
127 (/dev/hdc).  To mount a CD in the cdrom drive, one would use something like:
129         ln -sf /dev/hdc /dev/cdrom
130         mkdir /mnt/cdrom
131         mount /dev/cdrom /mnt/cdrom -t iso9660 -o ro
133 If, after doing all of the above, mount doesn't work and you see
134 errors from the driver (with dmesg) complaining about `status=0xff',
135 this means that the hardware is not responding to the driver's attempts
136 to read it.  One of the following is probably the problem:
138   - Your hardware is broken.
140   - You are using the wrong address for the device, or you have the
141     drive jumpered wrong.  Review the configuration instructions above.
143   - Your IDE controller requires some nonstandard initialization sequence
144     before it will work properly.  If this is the case, there will often
145     be a separate MS-DOS driver just for the controller.  IDE interfaces
146     on sound cards usually fall into this category.  Such configurations
147     can often be made to work by first booting MS-DOS, loading the
148     appropriate drivers, and then warm-booting linux (without powering
149     off).  This can be automated using loadlin in the MS-DOS autoexec.
151 If you always get timeout errors, interrupts from the drive are probably
152 not making it to the host.  Check how you have the hardware jumpered
153 and make sure it matches what the driver expects (see the configuration
154 instructions above).  If you have a PCI system, also check the BIOS
155 setup; I've had one report of a system which was shipped with IRQ 15
156 disabled by the BIOS.
158 The kernel is able to execute binaries directly off of the cdrom,
159 provided it is mounted with the default block size of 1024 (as above).
161 Please pass on any feedback on any of this stuff to the maintainer,
162 whose address can be found in linux/MAINTAINERS.
164 The IDE driver is modularized.  The high level disk/CD-ROM/tape/floppy
165 drivers can always be compiled as loadable modules, the chipset drivers
166 can only be compiled into the kernel, and the core code (ide.c) can be
167 compiled as a loadable module provided no chipset support is needed.
169 When using ide.c as a module in combination with kmod, add:
171         alias block-major-3 ide-probe
173 to /etc/modprobe.conf.
175 When ide.c is used as a module, you can pass command line parameters to the
176 driver using the "options=" keyword to insmod, while replacing any ',' with
177 ';'.  For example:
179         insmod ide.o options="hda=nodma hdb=nodma"
182 ================================================================================
184 Summary of ide driver parameters for kernel command line
185 --------------------------------------------------------
187  "hdx="  is recognized for all "x" from "a" to "u", such as "hdc".
189  "hdx=noprobe"          : drive may be present, but do not probe for it
191  "hdx=none"             : drive is NOT present, ignore cmos and do not probe
193  "hdx=nowerr"           : ignore the WRERR_STAT bit on this drive
195  "hdx=cdrom"            : drive is present, and is a cdrom drive
197  "hdx=cyl,head,sect"    : disk drive is present, with specified geometry
199  "hdx=autotune"         : driver will attempt to tune interface speed
200                           to the fastest PIO mode supported,
201                           if possible for this drive only.
202                           Not fully supported by all chipset types,
203                           and quite likely to cause trouble with
204                           older/odd IDE drives.
206  "hdx=nodma"            : disallow DMA
208  "idebus=xx"            : inform IDE driver of VESA/PCI bus speed in MHz,
209                           where "xx" is between 20 and 66 inclusive,
210                           used when tuning chipset PIO modes.
211                           For PCI bus, 25 is correct for a P75 system,
212                           30 is correct for P90,P120,P180 systems,
213                           and 33 is used for P100,P133,P166 systems.
214                           If in doubt, use idebus=33 for PCI.
215                           As for VLB, it is safest to not specify it.
216                           Bigger values are safer than smaller ones.
218  "ide=doubler"          : probe/support IDE doublers on Amiga
220 There may be more options than shown -- use the source, Luke!
222 Everything else is rejected with a "BAD OPTION" message.
224 For legacy IDE VLB host drivers (ali14xx/dtc2278/ht6560b/qd65xx/umc8672)
225 you need to explicitly enable probing by using "probe" kernel parameter,
226 i.e. to enable probing for ALI M14xx chipsets (ali14xx host driver) use:
228 * "ali14xx.probe" boot option when ali14xx driver is built-in the kernel
230 * "probe" module parameter when ali14xx driver is compiled as module
231   ("modprobe ali14xx probe")
233 Also for legacy CMD640 host driver (cmd640) you need to use "probe_vlb"
234 kernel paremeter to enable probing for VLB version of the chipset (PCI ones
235 are detected automatically).
237 You also need to use "probe" kernel parameter for ide-4drives driver
238 (support for IDE generic chipset with four drives on one port).
240 To force ignoring cable detection (this should be needed only if you're using
241 short 40-wires cable which cannot be automatically detected - if this is not
242 a case please report it as a bug instead) use "ignore_cable" kernel parameter:
244 * "ide_core.ignore_cable=[interface_number]" boot option if IDE is built-in
245   (i.e. "ide_core.ignore_cable=1" to force ignoring cable for "ide1")
247 * "ignore_cable=[interface_number]" module parameter (for ide_core module)
248   if IDE is compiled as module
250 ================================================================================
252 Some Terminology
253 ----------------
254 IDE = Integrated Drive Electronics, meaning that each drive has a built-in
255 controller, which is why an "IDE interface card" is not a "controller card".
257 ATA = AT (the old IBM 286 computer) Attachment Interface, a draft American
258 National Standard for connecting hard drives to PCs.  This is the official
259 name for "IDE".
261 The latest standards define some enhancements, known as the ATA-6 spec,
262 which grew out of vendor-specific "Enhanced IDE" (EIDE) implementations.
264 ATAPI = ATA Packet Interface, a new protocol for controlling the drives,
265 similar to SCSI protocols, created at the same time as the ATA2 standard.
266 ATAPI is currently used for controlling CDROM, TAPE and FLOPPY (ZIP or
267 LS120/240) devices, removable R/W cartridges, and for high capacity hard disk
268 drives.
270 mlord@pobox.com
273 Wed Apr 17 22:52:44 CEST 2002 edited by Marcin Dalecki, the current
274 maintainer.
276 Wed Aug 20 22:31:29 CEST 2003 updated ide boot options to current ide.c
277 comments at 2.6.0-test4 time. Maciej Soltysiak <solt@dns.toxicfilms.tv>