Merge branch 'at91' into devel
[linux-2.6] / drivers / ide / ide-iops.c
1 /*
2  *  Copyright (C) 2000-2002     Andre Hedrick <andre@linux-ide.org>
3  *  Copyright (C) 2003          Red Hat
4  *
5  */
6
7 #include <linux/module.h>
8 #include <linux/types.h>
9 #include <linux/string.h>
10 #include <linux/kernel.h>
11 #include <linux/timer.h>
12 #include <linux/mm.h>
13 #include <linux/interrupt.h>
14 #include <linux/major.h>
15 #include <linux/errno.h>
16 #include <linux/genhd.h>
17 #include <linux/blkpg.h>
18 #include <linux/slab.h>
19 #include <linux/pci.h>
20 #include <linux/delay.h>
21 #include <linux/ide.h>
22 #include <linux/bitops.h>
23 #include <linux/nmi.h>
24
25 #include <asm/byteorder.h>
26 #include <asm/irq.h>
27 #include <asm/uaccess.h>
28 #include <asm/io.h>
29
30 void SELECT_MASK(ide_drive_t *drive, int mask)
31 {
32         const struct ide_port_ops *port_ops = drive->hwif->port_ops;
33
34         if (port_ops && port_ops->maskproc)
35                 port_ops->maskproc(drive, mask);
36 }
37
38 u8 ide_read_error(ide_drive_t *drive)
39 {
40         struct ide_taskfile tf;
41
42         drive->hwif->tp_ops->tf_read(drive, &tf, IDE_VALID_ERROR);
43
44         return tf.error;
45 }
46 EXPORT_SYMBOL_GPL(ide_read_error);
47
48 void ide_fix_driveid(u16 *id)
49 {
50 #ifndef __LITTLE_ENDIAN
51 # ifdef __BIG_ENDIAN
52         int i;
53
54         for (i = 0; i < 256; i++)
55                 id[i] = __le16_to_cpu(id[i]);
56 # else
57 #  error "Please fix <asm/byteorder.h>"
58 # endif
59 #endif
60 }
61
62 /*
63  * ide_fixstring() cleans up and (optionally) byte-swaps a text string,
64  * removing leading/trailing blanks and compressing internal blanks.
65  * It is primarily used to tidy up the model name/number fields as
66  * returned by the ATA_CMD_ID_ATA[PI] commands.
67  */
68
69 void ide_fixstring(u8 *s, const int bytecount, const int byteswap)
70 {
71         u8 *p, *end = &s[bytecount & ~1]; /* bytecount must be even */
72
73         if (byteswap) {
74                 /* convert from big-endian to host byte order */
75                 for (p = s ; p != end ; p += 2)
76                         be16_to_cpus((u16 *) p);
77         }
78
79         /* strip leading blanks */
80         p = s;
81         while (s != end && *s == ' ')
82                 ++s;
83         /* compress internal blanks and strip trailing blanks */
84         while (s != end && *s) {
85                 if (*s++ != ' ' || (s != end && *s && *s != ' '))
86                         *p++ = *(s-1);
87         }
88         /* wipe out trailing garbage */
89         while (p != end)
90                 *p++ = '\0';
91 }
92 EXPORT_SYMBOL(ide_fixstring);
93
94 /*
95  * This routine busy-waits for the drive status to be not "busy".
96  * It then checks the status for all of the "good" bits and none
97  * of the "bad" bits, and if all is okay it returns 0.  All other
98  * cases return error -- caller may then invoke ide_error().
99  *
100  * This routine should get fixed to not hog the cpu during extra long waits..
101  * That could be done by busy-waiting for the first jiffy or two, and then
102  * setting a timer to wake up at half second intervals thereafter,
103  * until timeout is achieved, before timing out.
104  */
105 static int __ide_wait_stat(ide_drive_t *drive, u8 good, u8 bad,
106                            unsigned long timeout, u8 *rstat)
107 {
108         ide_hwif_t *hwif = drive->hwif;
109         const struct ide_tp_ops *tp_ops = hwif->tp_ops;
110         unsigned long flags;
111         int i;
112         u8 stat;
113
114         udelay(1);      /* spec allows drive 400ns to assert "BUSY" */
115         stat = tp_ops->read_status(hwif);
116
117         if (stat & ATA_BUSY) {
118                 local_save_flags(flags);
119                 local_irq_enable_in_hardirq();
120                 timeout += jiffies;
121                 while ((stat = tp_ops->read_status(hwif)) & ATA_BUSY) {
122                         if (time_after(jiffies, timeout)) {
123                                 /*
124                                  * One last read after the timeout in case
125                                  * heavy interrupt load made us not make any
126                                  * progress during the timeout..
127                                  */
128                                 stat = tp_ops->read_status(hwif);
129                                 if ((stat & ATA_BUSY) == 0)
130                                         break;
131
132                                 local_irq_restore(flags);
133                                 *rstat = stat;
134                                 return -EBUSY;
135                         }
136                 }
137                 local_irq_restore(flags);
138         }
139         /*
140          * Allow status to settle, then read it again.
141          * A few rare drives vastly violate the 400ns spec here,
142          * so we'll wait up to 10usec for a "good" status
143          * rather than expensively fail things immediately.
144          * This fix courtesy of Matthew Faupel & Niccolo Rigacci.
145          */
146         for (i = 0; i < 10; i++) {
147                 udelay(1);
148                 stat = tp_ops->read_status(hwif);
149
150                 if (OK_STAT(stat, good, bad)) {
151                         *rstat = stat;
152                         return 0;
153                 }
154         }
155         *rstat = stat;
156         return -EFAULT;
157 }
158
159 /*
160  * In case of error returns error value after doing "*startstop = ide_error()".
161  * The caller should return the updated value of "startstop" in this case,
162  * "startstop" is unchanged when the function returns 0.
163  */
164 int ide_wait_stat(ide_startstop_t *startstop, ide_drive_t *drive, u8 good,
165                   u8 bad, unsigned long timeout)
166 {
167         int err;
168         u8 stat;
169
170         /* bail early if we've exceeded max_failures */
171         if (drive->max_failures && (drive->failures > drive->max_failures)) {
172                 *startstop = ide_stopped;
173                 return 1;
174         }
175
176         err = __ide_wait_stat(drive, good, bad, timeout, &stat);
177
178         if (err) {
179                 char *s = (err == -EBUSY) ? "status timeout" : "status error";
180                 *startstop = ide_error(drive, s, stat);
181         }
182
183         return err;
184 }
185 EXPORT_SYMBOL(ide_wait_stat);
186
187 /**
188  *      ide_in_drive_list       -       look for drive in black/white list
189  *      @id: drive identifier
190  *      @table: list to inspect
191  *
192  *      Look for a drive in the blacklist and the whitelist tables
193  *      Returns 1 if the drive is found in the table.
194  */
195
196 int ide_in_drive_list(u16 *id, const struct drive_list_entry *table)
197 {
198         for ( ; table->id_model; table++)
199                 if ((!strcmp(table->id_model, (char *)&id[ATA_ID_PROD])) &&
200                     (!table->id_firmware ||
201                      strstr((char *)&id[ATA_ID_FW_REV], table->id_firmware)))
202                         return 1;
203         return 0;
204 }
205 EXPORT_SYMBOL_GPL(ide_in_drive_list);
206
207 /*
208  * Early UDMA66 devices don't set bit14 to 1, only bit13 is valid.
209  * Some optical devices with the buggy firmwares have the same problem.
210  */
211 static const struct drive_list_entry ivb_list[] = {
212         { "QUANTUM FIREBALLlct10 05"    , "A03.0900"    },
213         { "TSSTcorp CDDVDW SH-S202J"    , "SB00"        },
214         { "TSSTcorp CDDVDW SH-S202J"    , "SB01"        },
215         { "TSSTcorp CDDVDW SH-S202N"    , "SB00"        },
216         { "TSSTcorp CDDVDW SH-S202N"    , "SB01"        },
217         { "TSSTcorp CDDVDW SH-S202H"    , "SB00"        },
218         { "TSSTcorp CDDVDW SH-S202H"    , "SB01"        },
219         { "SAMSUNG SP0822N"             , "WA100-10"    },
220         { NULL                          , NULL          }
221 };
222
223 /*
224  *  All hosts that use the 80c ribbon must use!
225  *  The name is derived from upper byte of word 93 and the 80c ribbon.
226  */
227 u8 eighty_ninty_three(ide_drive_t *drive)
228 {
229         ide_hwif_t *hwif = drive->hwif;
230         u16 *id = drive->id;
231         int ivb = ide_in_drive_list(id, ivb_list);
232
233         if (hwif->cbl == ATA_CBL_PATA40_SHORT)
234                 return 1;
235
236         if (ivb)
237                 printk(KERN_DEBUG "%s: skipping word 93 validity check\n",
238                                   drive->name);
239
240         if (ata_id_is_sata(id) && !ivb)
241                 return 1;
242
243         if (hwif->cbl != ATA_CBL_PATA80 && !ivb)
244                 goto no_80w;
245
246         /*
247          * FIXME:
248          * - change master/slave IDENTIFY order
249          * - force bit13 (80c cable present) check also for !ivb devices
250          *   (unless the slave device is pre-ATA3)
251          */
252         if (id[ATA_ID_HW_CONFIG] & 0x4000)
253                 return 1;
254
255         if (ivb) {
256                 const char *model = (char *)&id[ATA_ID_PROD];
257
258                 if (strstr(model, "TSSTcorp CDDVDW SH-S202")) {
259                         /*
260                          * These ATAPI devices always report 80c cable
261                          * so we have to depend on the host in this case.
262                          */
263                         if (hwif->cbl == ATA_CBL_PATA80)
264                                 return 1;
265                 } else {
266                         /* Depend on the device side cable detection. */
267                         if (id[ATA_ID_HW_CONFIG] & 0x2000)
268                                 return 1;
269                 }
270         }
271 no_80w:
272         if (drive->dev_flags & IDE_DFLAG_UDMA33_WARNED)
273                 return 0;
274
275         printk(KERN_WARNING "%s: %s side 80-wire cable detection failed, "
276                             "limiting max speed to UDMA33\n",
277                             drive->name,
278                             hwif->cbl == ATA_CBL_PATA80 ? "drive" : "host");
279
280         drive->dev_flags |= IDE_DFLAG_UDMA33_WARNED;
281
282         return 0;
283 }
284
285 int ide_driveid_update(ide_drive_t *drive)
286 {
287         u16 *id;
288         int rc;
289
290         id = kmalloc(SECTOR_SIZE, GFP_ATOMIC);
291         if (id == NULL)
292                 return 0;
293
294         SELECT_MASK(drive, 1);
295         rc = ide_dev_read_id(drive, ATA_CMD_ID_ATA, id);
296         SELECT_MASK(drive, 0);
297
298         if (rc)
299                 goto out_err;
300
301         drive->id[ATA_ID_UDMA_MODES]  = id[ATA_ID_UDMA_MODES];
302         drive->id[ATA_ID_MWDMA_MODES] = id[ATA_ID_MWDMA_MODES];
303         drive->id[ATA_ID_SWDMA_MODES] = id[ATA_ID_SWDMA_MODES];
304         drive->id[ATA_ID_CFA_MODES]   = id[ATA_ID_CFA_MODES];
305         /* anything more ? */
306
307         kfree(id);
308
309         if ((drive->dev_flags & IDE_DFLAG_USING_DMA) && ide_id_dma_bug(drive))
310                 ide_dma_off(drive);
311
312         return 1;
313 out_err:
314         SELECT_MASK(drive, 0);
315         if (rc == 2)
316                 printk(KERN_ERR "%s: %s: bad status\n", drive->name, __func__);
317         kfree(id);
318         return 0;
319 }
320
321 int ide_config_drive_speed(ide_drive_t *drive, u8 speed)
322 {
323         ide_hwif_t *hwif = drive->hwif;
324         const struct ide_tp_ops *tp_ops = hwif->tp_ops;
325         struct ide_taskfile tf;
326         u16 *id = drive->id, i;
327         int error = 0;
328         u8 stat;
329
330 #ifdef CONFIG_BLK_DEV_IDEDMA
331         if (hwif->dma_ops)      /* check if host supports DMA */
332                 hwif->dma_ops->dma_host_set(drive, 0);
333 #endif
334
335         /* Skip setting PIO flow-control modes on pre-EIDE drives */
336         if ((speed & 0xf8) == XFER_PIO_0 && ata_id_has_iordy(drive->id) == 0)
337                 goto skip;
338
339         /*
340          * Don't use ide_wait_cmd here - it will
341          * attempt to set_geometry and recalibrate,
342          * but for some reason these don't work at
343          * this point (lost interrupt).
344          */
345
346         /*
347          *      FIXME: we race against the running IRQ here if
348          *      this is called from non IRQ context. If we use
349          *      disable_irq() we hang on the error path. Work
350          *      is needed.
351          */
352         disable_irq_nosync(hwif->irq);
353
354         udelay(1);
355         tp_ops->dev_select(drive);
356         SELECT_MASK(drive, 1);
357         udelay(1);
358         tp_ops->write_devctl(hwif, ATA_NIEN | ATA_DEVCTL_OBS);
359
360         memset(&tf, 0, sizeof(tf));
361         tf.feature = SETFEATURES_XFER;
362         tf.nsect   = speed;
363
364         tp_ops->tf_load(drive, &tf, IDE_VALID_FEATURE | IDE_VALID_NSECT);
365
366         tp_ops->exec_command(hwif, ATA_CMD_SET_FEATURES);
367
368         if (drive->quirk_list == 2)
369                 tp_ops->write_devctl(hwif, ATA_DEVCTL_OBS);
370
371         error = __ide_wait_stat(drive, drive->ready_stat,
372                                 ATA_BUSY | ATA_DRQ | ATA_ERR,
373                                 WAIT_CMD, &stat);
374
375         SELECT_MASK(drive, 0);
376
377         enable_irq(hwif->irq);
378
379         if (error) {
380                 (void) ide_dump_status(drive, "set_drive_speed_status", stat);
381                 return error;
382         }
383
384         if (speed >= XFER_SW_DMA_0) {
385                 id[ATA_ID_UDMA_MODES]  &= ~0xFF00;
386                 id[ATA_ID_MWDMA_MODES] &= ~0x0700;
387                 id[ATA_ID_SWDMA_MODES] &= ~0x0700;
388                 if (ata_id_is_cfa(id))
389                         id[ATA_ID_CFA_MODES] &= ~0x0E00;
390         } else  if (ata_id_is_cfa(id))
391                 id[ATA_ID_CFA_MODES] &= ~0x01C0;
392
393  skip:
394 #ifdef CONFIG_BLK_DEV_IDEDMA
395         if (speed >= XFER_SW_DMA_0 && (drive->dev_flags & IDE_DFLAG_USING_DMA))
396                 hwif->dma_ops->dma_host_set(drive, 1);
397         else if (hwif->dma_ops) /* check if host supports DMA */
398                 ide_dma_off_quietly(drive);
399 #endif
400
401         if (speed >= XFER_UDMA_0) {
402                 i = 1 << (speed - XFER_UDMA_0);
403                 id[ATA_ID_UDMA_MODES] |= (i << 8 | i);
404         } else if (ata_id_is_cfa(id) && speed >= XFER_MW_DMA_3) {
405                 i = speed - XFER_MW_DMA_2;
406                 id[ATA_ID_CFA_MODES] |= i << 9;
407         } else if (speed >= XFER_MW_DMA_0) {
408                 i = 1 << (speed - XFER_MW_DMA_0);
409                 id[ATA_ID_MWDMA_MODES] |= (i << 8 | i);
410         } else if (speed >= XFER_SW_DMA_0) {
411                 i = 1 << (speed - XFER_SW_DMA_0);
412                 id[ATA_ID_SWDMA_MODES] |= (i << 8 | i);
413         } else if (ata_id_is_cfa(id) && speed >= XFER_PIO_5) {
414                 i = speed - XFER_PIO_4;
415                 id[ATA_ID_CFA_MODES] |= i << 6;
416         }
417
418         if (!drive->init_speed)
419                 drive->init_speed = speed;
420         drive->current_speed = speed;
421         return error;
422 }
423
424 /*
425  * This should get invoked any time we exit the driver to
426  * wait for an interrupt response from a drive.  handler() points
427  * at the appropriate code to handle the next interrupt, and a
428  * timer is started to prevent us from waiting forever in case
429  * something goes wrong (see the ide_timer_expiry() handler later on).
430  *
431  * See also ide_execute_command
432  */
433 void __ide_set_handler(ide_drive_t *drive, ide_handler_t *handler,
434                        unsigned int timeout)
435 {
436         ide_hwif_t *hwif = drive->hwif;
437
438         BUG_ON(hwif->handler);
439         hwif->handler           = handler;
440         hwif->timer.expires     = jiffies + timeout;
441         hwif->req_gen_timer     = hwif->req_gen;
442         add_timer(&hwif->timer);
443 }
444
445 void ide_set_handler(ide_drive_t *drive, ide_handler_t *handler,
446                      unsigned int timeout)
447 {
448         ide_hwif_t *hwif = drive->hwif;
449         unsigned long flags;
450
451         spin_lock_irqsave(&hwif->lock, flags);
452         __ide_set_handler(drive, handler, timeout);
453         spin_unlock_irqrestore(&hwif->lock, flags);
454 }
455 EXPORT_SYMBOL(ide_set_handler);
456
457 /**
458  *      ide_execute_command     -       execute an IDE command
459  *      @drive: IDE drive to issue the command against
460  *      @cmd: command
461  *      @handler: handler for next phase
462  *      @timeout: timeout for command
463  *
464  *      Helper function to issue an IDE command. This handles the
465  *      atomicity requirements, command timing and ensures that the
466  *      handler and IRQ setup do not race. All IDE command kick off
467  *      should go via this function or do equivalent locking.
468  */
469
470 void ide_execute_command(ide_drive_t *drive, struct ide_cmd *cmd,
471                          ide_handler_t *handler, unsigned timeout)
472 {
473         ide_hwif_t *hwif = drive->hwif;
474         unsigned long flags;
475
476         spin_lock_irqsave(&hwif->lock, flags);
477         if ((cmd->protocol != ATAPI_PROT_DMA &&
478              cmd->protocol != ATAPI_PROT_PIO) ||
479             (drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT))
480                 __ide_set_handler(drive, handler, timeout);
481         hwif->tp_ops->exec_command(hwif, cmd->tf.command);
482         /*
483          * Drive takes 400nS to respond, we must avoid the IRQ being
484          * serviced before that.
485          *
486          * FIXME: we could skip this delay with care on non shared devices
487          */
488         ndelay(400);
489         spin_unlock_irqrestore(&hwif->lock, flags);
490 }
491
492 /*
493  * ide_wait_not_busy() waits for the currently selected device on the hwif
494  * to report a non-busy status, see comments in ide_probe_port().
495  */
496 int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout)
497 {
498         u8 stat = 0;
499
500         while (timeout--) {
501                 /*
502                  * Turn this into a schedule() sleep once I'm sure
503                  * about locking issues (2.5 work ?).
504                  */
505                 mdelay(1);
506                 stat = hwif->tp_ops->read_status(hwif);
507                 if ((stat & ATA_BUSY) == 0)
508                         return 0;
509                 /*
510                  * Assume a value of 0xff means nothing is connected to
511                  * the interface and it doesn't implement the pull-down
512                  * resistor on D7.
513                  */
514                 if (stat == 0xff)
515                         return -ENODEV;
516                 touch_softlockup_watchdog();
517                 touch_nmi_watchdog();
518         }
519         return -EBUSY;
520 }