ide: ide.c 'clear' fix, update "ide=nodma" documentation
[linux-3.10.git] / drivers / ide / ide.c
1 /*
2  *  Copyright (C) 1994-1998         Linus Torvalds & authors (see below)
3  *  Copyright (C) 2003-2005, 2007   Bartlomiej Zolnierkiewicz
4  */
5
6 /*
7  *  Mostly written by Mark Lord  <mlord@pobox.com>
8  *                and Gadi Oxman <gadio@netvision.net.il>
9  *                and Andre Hedrick <andre@linux-ide.org>
10  *
11  *  See linux/MAINTAINERS for address of current maintainer.
12  *
13  * This is the multiple IDE interface driver, as evolved from hd.c.
14  * It supports up to MAX_HWIFS IDE interfaces, on one or more IRQs
15  *   (usually 14 & 15).
16  * There can be up to two drives per interface, as per the ATA-2 spec.
17  *
18  * ...
19  *
20  *  From hd.c:
21  *  |
22  *  | It traverses the request-list, using interrupts to jump between functions.
23  *  | As nearly all functions can be called within interrupts, we may not sleep.
24  *  | Special care is recommended.  Have Fun!
25  *  |
26  *  | modified by Drew Eckhardt to check nr of hd's from the CMOS.
27  *  |
28  *  | Thanks to Branko Lankester, lankeste@fwi.uva.nl, who found a bug
29  *  | in the early extended-partition checks and added DM partitions.
30  *  |
31  *  | Early work on error handling by Mika Liljeberg (liljeber@cs.Helsinki.FI).
32  *  |
33  *  | IRQ-unmask, drive-id, multiple-mode, support for ">16 heads",
34  *  | and general streamlining by Mark Lord (mlord@pobox.com).
35  *
36  *  October, 1994 -- Complete line-by-line overhaul for linux 1.1.x, by:
37  *
38  *      Mark Lord       (mlord@pobox.com)               (IDE Perf.Pkg)
39  *      Delman Lee      (delman@ieee.org)               ("Mr. atdisk2")
40  *      Scott Snyder    (snyder@fnald0.fnal.gov)        (ATAPI IDE cd-rom)
41  *
42  *  This was a rewrite of just about everything from hd.c, though some original
43  *  code is still sprinkled about.  Think of it as a major evolution, with
44  *  inspiration from lots of linux users, esp.  hamish@zot.apana.org.au
45  */
46
47 #include <linux/module.h>
48 #include <linux/types.h>
49 #include <linux/string.h>
50 #include <linux/kernel.h>
51 #include <linux/interrupt.h>
52 #include <linux/major.h>
53 #include <linux/errno.h>
54 #include <linux/genhd.h>
55 #include <linux/slab.h>
56 #include <linux/init.h>
57 #include <linux/pci.h>
58 #include <linux/ide.h>
59 #include <linux/hdreg.h>
60 #include <linux/completion.h>
61 #include <linux/device.h>
62
63 struct class *ide_port_class;
64
65 /*
66  *      Locks for IDE setting functionality
67  */
68
69 DEFINE_MUTEX(ide_setting_mtx);
70
71 ide_devset_get(io_32bit, io_32bit);
72
73 static int set_io_32bit(ide_drive_t *drive, int arg)
74 {
75         if (drive->dev_flags & IDE_DFLAG_NO_IO_32BIT)
76                 return -EPERM;
77
78         if (arg < 0 || arg > 1 + (SUPPORT_VLB_SYNC << 1))
79                 return -EINVAL;
80
81         drive->io_32bit = arg;
82
83         return 0;
84 }
85
86 ide_devset_get_flag(ksettings, IDE_DFLAG_KEEP_SETTINGS);
87
88 static int set_ksettings(ide_drive_t *drive, int arg)
89 {
90         if (arg < 0 || arg > 1)
91                 return -EINVAL;
92
93         if (arg)
94                 drive->dev_flags |= IDE_DFLAG_KEEP_SETTINGS;
95         else
96                 drive->dev_flags &= ~IDE_DFLAG_KEEP_SETTINGS;
97
98         return 0;
99 }
100
101 ide_devset_get_flag(using_dma, IDE_DFLAG_USING_DMA);
102
103 static int set_using_dma(ide_drive_t *drive, int arg)
104 {
105 #ifdef CONFIG_BLK_DEV_IDEDMA
106         int err = -EPERM;
107
108         if (arg < 0 || arg > 1)
109                 return -EINVAL;
110
111         if (ata_id_has_dma(drive->id) == 0)
112                 goto out;
113
114         if (drive->hwif->dma_ops == NULL)
115                 goto out;
116
117         err = 0;
118
119         if (arg) {
120                 if (ide_set_dma(drive))
121                         err = -EIO;
122         } else
123                 ide_dma_off(drive);
124
125 out:
126         return err;
127 #else
128         if (arg < 0 || arg > 1)
129                 return -EINVAL;
130
131         return -EPERM;
132 #endif
133 }
134
135 /*
136  * handle HDIO_SET_PIO_MODE ioctl abusers here, eventually it will go away
137  */
138 static int set_pio_mode_abuse(ide_hwif_t *hwif, u8 req_pio)
139 {
140         switch (req_pio) {
141         case 202:
142         case 201:
143         case 200:
144         case 102:
145         case 101:
146         case 100:
147                 return (hwif->host_flags & IDE_HFLAG_ABUSE_DMA_MODES) ? 1 : 0;
148         case 9:
149         case 8:
150                 return (hwif->host_flags & IDE_HFLAG_ABUSE_PREFETCH) ? 1 : 0;
151         case 7:
152         case 6:
153                 return (hwif->host_flags & IDE_HFLAG_ABUSE_FAST_DEVSEL) ? 1 : 0;
154         default:
155                 return 0;
156         }
157 }
158
159 static int set_pio_mode(ide_drive_t *drive, int arg)
160 {
161         ide_hwif_t *hwif = drive->hwif;
162         const struct ide_port_ops *port_ops = hwif->port_ops;
163
164         if (arg < 0 || arg > 255)
165                 return -EINVAL;
166
167         if (port_ops == NULL || port_ops->set_pio_mode == NULL ||
168             (hwif->host_flags & IDE_HFLAG_NO_SET_MODE))
169                 return -ENOSYS;
170
171         if (set_pio_mode_abuse(drive->hwif, arg)) {
172                 if (arg == 8 || arg == 9) {
173                         unsigned long flags;
174
175                         /* take lock for IDE_DFLAG_[NO_]UNMASK/[NO_]IO_32BIT */
176                         spin_lock_irqsave(&hwif->lock, flags);
177                         port_ops->set_pio_mode(drive, arg);
178                         spin_unlock_irqrestore(&hwif->lock, flags);
179                 } else
180                         port_ops->set_pio_mode(drive, arg);
181         } else {
182                 int keep_dma = !!(drive->dev_flags & IDE_DFLAG_USING_DMA);
183
184                 ide_set_pio(drive, arg);
185
186                 if (hwif->host_flags & IDE_HFLAG_SET_PIO_MODE_KEEP_DMA) {
187                         if (keep_dma)
188                                 ide_dma_on(drive);
189                 }
190         }
191
192         return 0;
193 }
194
195 ide_devset_get_flag(unmaskirq, IDE_DFLAG_UNMASK);
196
197 static int set_unmaskirq(ide_drive_t *drive, int arg)
198 {
199         if (drive->dev_flags & IDE_DFLAG_NO_UNMASK)
200                 return -EPERM;
201
202         if (arg < 0 || arg > 1)
203                 return -EINVAL;
204
205         if (arg)
206                 drive->dev_flags |= IDE_DFLAG_UNMASK;
207         else
208                 drive->dev_flags &= ~IDE_DFLAG_UNMASK;
209
210         return 0;
211 }
212
213 ide_ext_devset_rw_sync(io_32bit, io_32bit);
214 ide_ext_devset_rw_sync(keepsettings, ksettings);
215 ide_ext_devset_rw_sync(unmaskirq, unmaskirq);
216 ide_ext_devset_rw_sync(using_dma, using_dma);
217 __IDE_DEVSET(pio_mode, DS_SYNC, NULL, set_pio_mode);
218
219 /**
220  * ide_device_get       -       get an additional reference to a ide_drive_t
221  * @drive:      device to get a reference to
222  *
223  * Gets a reference to the ide_drive_t and increments the use count of the
224  * underlying LLDD module.
225  */
226 int ide_device_get(ide_drive_t *drive)
227 {
228         struct device *host_dev;
229         struct module *module;
230
231         if (!get_device(&drive->gendev))
232                 return -ENXIO;
233
234         host_dev = drive->hwif->host->dev[0];
235         module = host_dev ? host_dev->driver->owner : NULL;
236
237         if (module && !try_module_get(module)) {
238                 put_device(&drive->gendev);
239                 return -ENXIO;
240         }
241
242         return 0;
243 }
244 EXPORT_SYMBOL_GPL(ide_device_get);
245
246 /**
247  * ide_device_put       -       release a reference to a ide_drive_t
248  * @drive:      device to release a reference on
249  *
250  * Release a reference to the ide_drive_t and decrements the use count of
251  * the underlying LLDD module.
252  */
253 void ide_device_put(ide_drive_t *drive)
254 {
255 #ifdef CONFIG_MODULE_UNLOAD
256         struct device *host_dev = drive->hwif->host->dev[0];
257         struct module *module = host_dev ? host_dev->driver->owner : NULL;
258
259         if (module)
260                 module_put(module);
261 #endif
262         put_device(&drive->gendev);
263 }
264 EXPORT_SYMBOL_GPL(ide_device_put);
265
266 static int ide_bus_match(struct device *dev, struct device_driver *drv)
267 {
268         return 1;
269 }
270
271 static int ide_uevent(struct device *dev, struct kobj_uevent_env *env)
272 {
273         ide_drive_t *drive = to_ide_device(dev);
274
275         add_uevent_var(env, "MEDIA=%s", ide_media_string(drive));
276         add_uevent_var(env, "DRIVENAME=%s", drive->name);
277         add_uevent_var(env, "MODALIAS=ide:m-%s", ide_media_string(drive));
278         return 0;
279 }
280
281 static int generic_ide_probe(struct device *dev)
282 {
283         ide_drive_t *drive = to_ide_device(dev);
284         struct ide_driver *drv = to_ide_driver(dev->driver);
285
286         return drv->probe ? drv->probe(drive) : -ENODEV;
287 }
288
289 static int generic_ide_remove(struct device *dev)
290 {
291         ide_drive_t *drive = to_ide_device(dev);
292         struct ide_driver *drv = to_ide_driver(dev->driver);
293
294         if (drv->remove)
295                 drv->remove(drive);
296
297         return 0;
298 }
299
300 static void generic_ide_shutdown(struct device *dev)
301 {
302         ide_drive_t *drive = to_ide_device(dev);
303         struct ide_driver *drv = to_ide_driver(dev->driver);
304
305         if (dev->driver && drv->shutdown)
306                 drv->shutdown(drive);
307 }
308
309 struct bus_type ide_bus_type = {
310         .name           = "ide",
311         .match          = ide_bus_match,
312         .uevent         = ide_uevent,
313         .probe          = generic_ide_probe,
314         .remove         = generic_ide_remove,
315         .shutdown       = generic_ide_shutdown,
316         .dev_attrs      = ide_dev_attrs,
317         .suspend        = generic_ide_suspend,
318         .resume         = generic_ide_resume,
319 };
320
321 EXPORT_SYMBOL_GPL(ide_bus_type);
322
323 int ide_vlb_clk;
324 EXPORT_SYMBOL_GPL(ide_vlb_clk);
325
326 module_param_named(vlb_clock, ide_vlb_clk, int, 0);
327 MODULE_PARM_DESC(vlb_clock, "VLB clock frequency (in MHz)");
328
329 int ide_pci_clk;
330 EXPORT_SYMBOL_GPL(ide_pci_clk);
331
332 module_param_named(pci_clock, ide_pci_clk, int, 0);
333 MODULE_PARM_DESC(pci_clock, "PCI bus clock frequency (in MHz)");
334
335 static int ide_set_dev_param_mask(const char *s, struct kernel_param *kp)
336 {
337         int a, b, i, j = 1;
338         unsigned int *dev_param_mask = (unsigned int *)kp->arg;
339
340         /* controller . device (0 or 1) [ : 1 (set) | 0 (clear) ] */
341         if (sscanf(s, "%d.%d:%d", &a, &b, &j) != 3 &&
342             sscanf(s, "%d.%d", &a, &b) != 2)
343                 return -EINVAL;
344
345         i = a * MAX_DRIVES + b;
346
347         if (i >= MAX_HWIFS * MAX_DRIVES || j < 0 || j > 1)
348                 return -EINVAL;
349
350         if (j)
351                 *dev_param_mask |= (1 << i);
352         else
353                 *dev_param_mask &= ~(1 << i);
354
355         return 0;
356 }
357
358 static unsigned int ide_nodma;
359
360 module_param_call(nodma, ide_set_dev_param_mask, NULL, &ide_nodma, 0);
361 MODULE_PARM_DESC(nodma, "disallow DMA for a device");
362
363 static unsigned int ide_noflush;
364
365 module_param_call(noflush, ide_set_dev_param_mask, NULL, &ide_noflush, 0);
366 MODULE_PARM_DESC(noflush, "disable flush requests for a device");
367
368 static unsigned int ide_noprobe;
369
370 module_param_call(noprobe, ide_set_dev_param_mask, NULL, &ide_noprobe, 0);
371 MODULE_PARM_DESC(noprobe, "skip probing for a device");
372
373 static unsigned int ide_nowerr;
374
375 module_param_call(nowerr, ide_set_dev_param_mask, NULL, &ide_nowerr, 0);
376 MODULE_PARM_DESC(nowerr, "ignore the ATA_DF bit for a device");
377
378 static unsigned int ide_cdroms;
379
380 module_param_call(cdrom, ide_set_dev_param_mask, NULL, &ide_cdroms, 0);
381 MODULE_PARM_DESC(cdrom, "force device as a CD-ROM");
382
383 struct chs_geom {
384         unsigned int    cyl;
385         u8              head;
386         u8              sect;
387 };
388
389 static unsigned int ide_disks;
390 static struct chs_geom ide_disks_chs[MAX_HWIFS * MAX_DRIVES];
391
392 static int ide_set_disk_chs(const char *str, struct kernel_param *kp)
393 {
394         int a, b, c = 0, h = 0, s = 0, i, j = 1;
395
396         /* controller . device (0 or 1) : Cylinders , Heads , Sectors */
397         /* controller . device (0 or 1) : 1 (use CHS) | 0 (ignore CHS) */
398         if (sscanf(str, "%d.%d:%d,%d,%d", &a, &b, &c, &h, &s) != 5 &&
399             sscanf(str, "%d.%d:%d", &a, &b, &j) != 3)
400                 return -EINVAL;
401
402         i = a * MAX_DRIVES + b;
403
404         if (i >= MAX_HWIFS * MAX_DRIVES || j < 0 || j > 1)
405                 return -EINVAL;
406
407         if (c > INT_MAX || h > 255 || s > 255)
408                 return -EINVAL;
409
410         if (j)
411                 ide_disks |= (1 << i);
412         else
413                 ide_disks &= ~(1 << i);
414
415         ide_disks_chs[i].cyl  = c;
416         ide_disks_chs[i].head = h;
417         ide_disks_chs[i].sect = s;
418
419         return 0;
420 }
421
422 module_param_call(chs, ide_set_disk_chs, NULL, NULL, 0);
423 MODULE_PARM_DESC(chs, "force device as a disk (using CHS)");
424
425 static void ide_dev_apply_params(ide_drive_t *drive, u8 unit)
426 {
427         int i = drive->hwif->index * MAX_DRIVES + unit;
428
429         if (ide_nodma & (1 << i)) {
430                 printk(KERN_INFO "ide: disallowing DMA for %s\n", drive->name);
431                 drive->dev_flags |= IDE_DFLAG_NODMA;
432         }
433         if (ide_noflush & (1 << i)) {
434                 printk(KERN_INFO "ide: disabling flush requests for %s\n",
435                                  drive->name);
436                 drive->dev_flags |= IDE_DFLAG_NOFLUSH;
437         }
438         if (ide_noprobe & (1 << i)) {
439                 printk(KERN_INFO "ide: skipping probe for %s\n", drive->name);
440                 drive->dev_flags |= IDE_DFLAG_NOPROBE;
441         }
442         if (ide_nowerr & (1 << i)) {
443                 printk(KERN_INFO "ide: ignoring the ATA_DF bit for %s\n",
444                                  drive->name);
445                 drive->bad_wstat = BAD_R_STAT;
446         }
447         if (ide_cdroms & (1 << i)) {
448                 printk(KERN_INFO "ide: forcing %s as a CD-ROM\n", drive->name);
449                 drive->dev_flags |= IDE_DFLAG_PRESENT;
450                 drive->media = ide_cdrom;
451                 /* an ATAPI device ignores DRDY */
452                 drive->ready_stat = 0;
453         }
454         if (ide_disks & (1 << i)) {
455                 drive->cyl  = drive->bios_cyl  = ide_disks_chs[i].cyl;
456                 drive->head = drive->bios_head = ide_disks_chs[i].head;
457                 drive->sect = drive->bios_sect = ide_disks_chs[i].sect;
458
459                 printk(KERN_INFO "ide: forcing %s as a disk (%d/%d/%d)\n",
460                                  drive->name,
461                                  drive->cyl, drive->head, drive->sect);
462
463                 drive->dev_flags |= IDE_DFLAG_FORCED_GEOM | IDE_DFLAG_PRESENT;
464                 drive->media = ide_disk;
465                 drive->ready_stat = ATA_DRDY;
466         }
467 }
468
469 static unsigned int ide_ignore_cable;
470
471 static int ide_set_ignore_cable(const char *s, struct kernel_param *kp)
472 {
473         int i, j = 1;
474
475         /* controller (ignore) */
476         /* controller : 1 (ignore) | 0 (use) */
477         if (sscanf(s, "%d:%d", &i, &j) != 2 && sscanf(s, "%d", &i) != 1)
478                 return -EINVAL;
479
480         if (i >= MAX_HWIFS || j < 0 || j > 1)
481                 return -EINVAL;
482
483         if (j)
484                 ide_ignore_cable |= (1 << i);
485         else
486                 ide_ignore_cable &= ~(1 << i);
487
488         return 0;
489 }
490
491 module_param_call(ignore_cable, ide_set_ignore_cable, NULL, NULL, 0);
492 MODULE_PARM_DESC(ignore_cable, "ignore cable detection");
493
494 void ide_port_apply_params(ide_hwif_t *hwif)
495 {
496         ide_drive_t *drive;
497         int i;
498
499         if (ide_ignore_cable & (1 << hwif->index)) {
500                 printk(KERN_INFO "ide: ignoring cable detection for %s\n",
501                                  hwif->name);
502                 hwif->cbl = ATA_CBL_PATA40_SHORT;
503         }
504
505         ide_port_for_each_dev(i, drive, hwif)
506                 ide_dev_apply_params(drive, i);
507 }
508
509 /*
510  * This is gets invoked once during initialization, to set *everything* up
511  */
512 static int __init ide_init(void)
513 {
514         int ret;
515
516         printk(KERN_INFO "Uniform Multi-Platform E-IDE driver\n");
517
518         ret = bus_register(&ide_bus_type);
519         if (ret < 0) {
520                 printk(KERN_WARNING "IDE: bus_register error: %d\n", ret);
521                 return ret;
522         }
523
524         ide_port_class = class_create(THIS_MODULE, "ide_port");
525         if (IS_ERR(ide_port_class)) {
526                 ret = PTR_ERR(ide_port_class);
527                 goto out_port_class;
528         }
529
530         proc_ide_create();
531
532         return 0;
533
534 out_port_class:
535         bus_unregister(&ide_bus_type);
536
537         return ret;
538 }
539
540 static void __exit ide_exit(void)
541 {
542         proc_ide_destroy();
543
544         class_destroy(ide_port_class);
545
546         bus_unregister(&ide_bus_type);
547 }
548
549 module_init(ide_init);
550 module_exit(ide_exit);
551
552 MODULE_LICENSE("GPL");