ide-floppy: merge idefloppy_transfer_pc() and idefloppy_transfer_pc1()
[linux-2.6] / drivers / ide / ide-floppy.c
1 /*
2  * IDE ATAPI floppy driver.
3  *
4  * Copyright (C) 1996-1999  Gadi Oxman <gadio@netvision.net.il>
5  * Copyright (C) 2000-2002  Paul Bristow <paul@paulbristow.net>
6  * Copyright (C) 2005       Bartlomiej Zolnierkiewicz
7  *
8  * This driver supports the following IDE floppy drives:
9  *
10  * LS-120/240 SuperDisk
11  * Iomega Zip 100/250
12  * Iomega PC Card Clik!/PocketZip
13  *
14  * For a historical changelog see
15  * Documentation/ide/ChangeLog.ide-floppy.1996-2002
16  */
17
18 #define IDEFLOPPY_VERSION "1.00"
19
20 #include <linux/module.h>
21 #include <linux/types.h>
22 #include <linux/string.h>
23 #include <linux/kernel.h>
24 #include <linux/delay.h>
25 #include <linux/timer.h>
26 #include <linux/mm.h>
27 #include <linux/interrupt.h>
28 #include <linux/major.h>
29 #include <linux/errno.h>
30 #include <linux/genhd.h>
31 #include <linux/slab.h>
32 #include <linux/cdrom.h>
33 #include <linux/ide.h>
34 #include <linux/bitops.h>
35 #include <linux/mutex.h>
36
37 #include <scsi/scsi_ioctl.h>
38
39 #include <asm/byteorder.h>
40 #include <linux/irq.h>
41 #include <linux/uaccess.h>
42 #include <linux/io.h>
43 #include <asm/unaligned.h>
44
45 /* define to see debug info */
46 #define IDEFLOPPY_DEBUG_LOG             0
47
48 /* #define IDEFLOPPY_DEBUG(fmt, args...) printk(KERN_INFO fmt, ## args) */
49 #define IDEFLOPPY_DEBUG(fmt, args...)
50
51 #if IDEFLOPPY_DEBUG_LOG
52 #define debug_log(fmt, args...) \
53         printk(KERN_INFO "ide-floppy: " fmt, ## args)
54 #else
55 #define debug_log(fmt, args...) do {} while (0)
56 #endif
57
58
59 /* Some drives require a longer irq timeout. */
60 #define IDEFLOPPY_WAIT_CMD              (5 * WAIT_CMD)
61
62 /*
63  * After each failed packet command we issue a request sense command and retry
64  * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
65  */
66 #define IDEFLOPPY_MAX_PC_RETRIES        3
67
68 /*
69  * With each packet command, we allocate a buffer of IDEFLOPPY_PC_BUFFER_SIZE
70  * bytes.
71  */
72 #define IDEFLOPPY_PC_BUFFER_SIZE        256
73
74 /*
75  * In various places in the driver, we need to allocate storage for packet
76  * commands and requests, which will remain valid while we leave the driver to
77  * wait for an interrupt or a timeout event.
78  */
79 #define IDEFLOPPY_PC_STACK              (10 + IDEFLOPPY_MAX_PC_RETRIES)
80
81 /* format capacities descriptor codes */
82 #define CAPACITY_INVALID        0x00
83 #define CAPACITY_UNFORMATTED    0x01
84 #define CAPACITY_CURRENT        0x02
85 #define CAPACITY_NO_CARTRIDGE   0x03
86
87 /*
88  * Most of our global data which we need to save even as we leave the driver
89  * due to an interrupt or a timer event is stored in a variable of type
90  * idefloppy_floppy_t, defined below.
91  */
92 typedef struct ide_floppy_obj {
93         ide_drive_t     *drive;
94         ide_driver_t    *driver;
95         struct gendisk  *disk;
96         struct kref     kref;
97         unsigned int    openers;        /* protected by BKL for now */
98
99         /* Current packet command */
100         struct ide_atapi_pc *pc;
101         /* Last failed packet command */
102         struct ide_atapi_pc *failed_pc;
103         /* Packet command stack */
104         struct ide_atapi_pc pc_stack[IDEFLOPPY_PC_STACK];
105         /* Next free packet command storage space */
106         int pc_stack_index;
107         struct request rq_stack[IDEFLOPPY_PC_STACK];
108         /* We implement a circular array */
109         int rq_stack_index;
110
111         /* Last error information */
112         u8 sense_key, asc, ascq;
113         /* delay this long before sending packet command */
114         u8 ticks;
115         int progress_indication;
116
117         /* Device information */
118         /* Current format */
119         int blocks, block_size, bs_factor;
120         /* Last format capacity descriptor */
121         u8 cap_desc[8];
122         /* Copy of the flexible disk page */
123         u8 flexible_disk_page[32];
124         /* Write protect */
125         int wp;
126         /* Supports format progress report */
127         int srfp;
128         /* Status/Action flags */
129         unsigned long flags;
130 } idefloppy_floppy_t;
131
132 #define IDEFLOPPY_TICKS_DELAY   HZ/20   /* default delay for ZIP 100 (50ms) */
133
134 /* Floppy flag bits values. */
135 enum {
136         /* DRQ interrupt device */
137         IDEFLOPPY_FLAG_DRQ_INTERRUPT            = (1 << 0),
138         /* Media may have changed */
139         IDEFLOPPY_FLAG_MEDIA_CHANGED            = (1 << 1),
140         /* Format in progress */
141         IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS       = (1 << 2),
142         /* Avoid commands not supported in Clik drive */
143         IDEFLOPPY_FLAG_CLIK_DRIVE               = (1 << 3),
144         /* Requires BH algorithm for packets */
145         IDEFLOPPY_FLAG_ZIP_DRIVE                = (1 << 4),
146 };
147
148 /* Defines for the MODE SENSE command */
149 #define MODE_SENSE_CURRENT              0x00
150 #define MODE_SENSE_CHANGEABLE           0x01
151 #define MODE_SENSE_DEFAULT              0x02
152 #define MODE_SENSE_SAVED                0x03
153
154 /* IOCTLs used in low-level formatting. */
155 #define IDEFLOPPY_IOCTL_FORMAT_SUPPORTED        0x4600
156 #define IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY     0x4601
157 #define IDEFLOPPY_IOCTL_FORMAT_START            0x4602
158 #define IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS     0x4603
159
160 /* Error code returned in rq->errors to the higher part of the driver. */
161 #define IDEFLOPPY_ERROR_GENERAL         101
162
163 /*
164  * Pages of the SELECT SENSE / MODE SENSE packet commands.
165  * See SFF-8070i spec.
166  */
167 #define IDEFLOPPY_CAPABILITIES_PAGE     0x1b
168 #define IDEFLOPPY_FLEXIBLE_DISK_PAGE    0x05
169
170 static DEFINE_MUTEX(idefloppy_ref_mutex);
171
172 #define to_ide_floppy(obj) container_of(obj, struct ide_floppy_obj, kref)
173
174 #define ide_floppy_g(disk) \
175         container_of((disk)->private_data, struct ide_floppy_obj, driver)
176
177 static struct ide_floppy_obj *ide_floppy_get(struct gendisk *disk)
178 {
179         struct ide_floppy_obj *floppy = NULL;
180
181         mutex_lock(&idefloppy_ref_mutex);
182         floppy = ide_floppy_g(disk);
183         if (floppy)
184                 kref_get(&floppy->kref);
185         mutex_unlock(&idefloppy_ref_mutex);
186         return floppy;
187 }
188
189 static void idefloppy_cleanup_obj(struct kref *);
190
191 static void ide_floppy_put(struct ide_floppy_obj *floppy)
192 {
193         mutex_lock(&idefloppy_ref_mutex);
194         kref_put(&floppy->kref, idefloppy_cleanup_obj);
195         mutex_unlock(&idefloppy_ref_mutex);
196 }
197
198 /*
199  * Used to finish servicing a request. For read/write requests, we will call
200  * ide_end_request to pass to the next buffer.
201  */
202 static int idefloppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
203 {
204         idefloppy_floppy_t *floppy = drive->driver_data;
205         struct request *rq = HWGROUP(drive)->rq;
206         int error;
207
208         debug_log("Reached %s\n", __func__);
209
210         switch (uptodate) {
211         case 0: error = IDEFLOPPY_ERROR_GENERAL; break;
212         case 1: error = 0; break;
213         default: error = uptodate;
214         }
215         if (error)
216                 floppy->failed_pc = NULL;
217         /* Why does this happen? */
218         if (!rq)
219                 return 0;
220         if (!blk_special_request(rq)) {
221                 /* our real local end request function */
222                 ide_end_request(drive, uptodate, nsecs);
223                 return 0;
224         }
225         rq->errors = error;
226         /* fixme: need to move this local also */
227         ide_end_drive_cmd(drive, 0, 0);
228         return 0;
229 }
230
231 static void ide_floppy_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
232                                   unsigned int bcount, int direction)
233 {
234         ide_hwif_t *hwif = drive->hwif;
235         struct request *rq = pc->rq;
236         struct req_iterator iter;
237         struct bio_vec *bvec;
238         unsigned long flags;
239         int count, done = 0;
240         char *data;
241
242         rq_for_each_segment(bvec, rq, iter) {
243                 if (!bcount)
244                         break;
245
246                 count = min(bvec->bv_len, bcount);
247
248                 data = bvec_kmap_irq(bvec, &flags);
249                 if (direction)
250                         hwif->output_data(drive, NULL, data, count);
251                 else
252                         hwif->input_data(drive, NULL, data, count);
253                 bvec_kunmap_irq(data, &flags);
254
255                 bcount -= count;
256                 pc->b_count += count;
257                 done += count;
258         }
259
260         idefloppy_end_request(drive, 1, done >> 9);
261
262         if (bcount) {
263                 printk(KERN_ERR "%s: leftover data in %s, bcount == %d\n",
264                                 drive->name, __func__, bcount);
265                 ide_pad_transfer(drive, direction, bcount);
266         }
267 }
268
269 static void idefloppy_update_buffers(ide_drive_t *drive,
270                                 struct ide_atapi_pc *pc)
271 {
272         struct request *rq = pc->rq;
273         struct bio *bio = rq->bio;
274
275         while ((bio = rq->bio) != NULL)
276                 idefloppy_end_request(drive, 1, 0);
277 }
278
279 /*
280  * Generate a new packet command request in front of the request queue, before
281  * the current request so that it will be processed immediately, on the next
282  * pass through the driver.
283  */
284 static void idefloppy_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
285                 struct request *rq)
286 {
287         struct ide_floppy_obj *floppy = drive->driver_data;
288
289         blk_rq_init(NULL, rq);
290         rq->buffer = (char *) pc;
291         rq->cmd_type = REQ_TYPE_SPECIAL;
292         rq->cmd_flags |= REQ_PREEMPT;
293         rq->rq_disk = floppy->disk;
294         ide_do_drive_cmd(drive, rq);
295 }
296
297 static struct ide_atapi_pc *idefloppy_next_pc_storage(ide_drive_t *drive)
298 {
299         idefloppy_floppy_t *floppy = drive->driver_data;
300
301         if (floppy->pc_stack_index == IDEFLOPPY_PC_STACK)
302                 floppy->pc_stack_index = 0;
303         return (&floppy->pc_stack[floppy->pc_stack_index++]);
304 }
305
306 static struct request *idefloppy_next_rq_storage(ide_drive_t *drive)
307 {
308         idefloppy_floppy_t *floppy = drive->driver_data;
309
310         if (floppy->rq_stack_index == IDEFLOPPY_PC_STACK)
311                 floppy->rq_stack_index = 0;
312         return (&floppy->rq_stack[floppy->rq_stack_index++]);
313 }
314
315 static void idefloppy_request_sense_callback(ide_drive_t *drive)
316 {
317         idefloppy_floppy_t *floppy = drive->driver_data;
318         u8 *buf = floppy->pc->buf;
319
320         debug_log("Reached %s\n", __func__);
321
322         if (!floppy->pc->error) {
323                 floppy->sense_key = buf[2] & 0x0F;
324                 floppy->asc = buf[12];
325                 floppy->ascq = buf[13];
326                 floppy->progress_indication = buf[15] & 0x80 ?
327                         (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
328
329                 if (floppy->failed_pc)
330                         debug_log("pc = %x, sense key = %x, asc = %x,"
331                                         " ascq = %x\n",
332                                         floppy->failed_pc->c[0],
333                                         floppy->sense_key,
334                                         floppy->asc,
335                                         floppy->ascq);
336                 else
337                         debug_log("sense key = %x, asc = %x, ascq = %x\n",
338                                         floppy->sense_key,
339                                         floppy->asc,
340                                         floppy->ascq);
341
342
343                 idefloppy_end_request(drive, 1, 0);
344         } else {
345                 printk(KERN_ERR "Error in REQUEST SENSE itself - Aborting"
346                                 " request!\n");
347                 idefloppy_end_request(drive, 0, 0);
348         }
349 }
350
351 /* General packet command callback function. */
352 static void idefloppy_pc_callback(ide_drive_t *drive)
353 {
354         idefloppy_floppy_t *floppy = drive->driver_data;
355
356         debug_log("Reached %s\n", __func__);
357
358         idefloppy_end_request(drive, floppy->pc->error ? 0 : 1, 0);
359 }
360
361 static void idefloppy_init_pc(struct ide_atapi_pc *pc)
362 {
363         memset(pc->c, 0, 12);
364         pc->retries = 0;
365         pc->flags = 0;
366         pc->req_xfer = 0;
367         pc->buf = pc->pc_buf;
368         pc->buf_size = IDEFLOPPY_PC_BUFFER_SIZE;
369         pc->idefloppy_callback = &idefloppy_pc_callback;
370 }
371
372 static void idefloppy_create_request_sense_cmd(struct ide_atapi_pc *pc)
373 {
374         idefloppy_init_pc(pc);
375         pc->c[0] = GPCMD_REQUEST_SENSE;
376         pc->c[4] = 255;
377         pc->req_xfer = 18;
378         pc->idefloppy_callback = &idefloppy_request_sense_callback;
379 }
380
381 /*
382  * Called when an error was detected during the last packet command. We queue a
383  * request sense packet command in the head of the request list.
384  */
385 static void idefloppy_retry_pc(ide_drive_t *drive)
386 {
387         struct ide_atapi_pc *pc;
388         struct request *rq;
389
390         (void)ide_read_error(drive);
391         pc = idefloppy_next_pc_storage(drive);
392         rq = idefloppy_next_rq_storage(drive);
393         idefloppy_create_request_sense_cmd(pc);
394         idefloppy_queue_pc_head(drive, pc, rq);
395 }
396
397 /* The usual interrupt handler called during a packet command. */
398 static ide_startstop_t idefloppy_pc_intr(ide_drive_t *drive)
399 {
400         idefloppy_floppy_t *floppy = drive->driver_data;
401         ide_hwif_t *hwif = drive->hwif;
402         struct ide_atapi_pc *pc = floppy->pc;
403         struct request *rq = pc->rq;
404         xfer_func_t *xferfunc;
405         unsigned int temp;
406         int dma_error = 0;
407         u16 bcount;
408         u8 stat, ireason;
409
410         debug_log("Reached %s interrupt handler\n", __func__);
411
412         if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
413                 dma_error = hwif->dma_ops->dma_end(drive);
414                 if (dma_error) {
415                         printk(KERN_ERR "%s: DMA %s error\n", drive->name,
416                                         rq_data_dir(rq) ? "write" : "read");
417                         pc->flags |= PC_FLAG_DMA_ERROR;
418                 } else {
419                         pc->xferred = pc->req_xfer;
420                         idefloppy_update_buffers(drive, pc);
421                 }
422                 debug_log("DMA finished\n");
423         }
424
425         /* Clear the interrupt */
426         stat = ide_read_status(drive);
427
428         /* No more interrupts */
429         if ((stat & DRQ_STAT) == 0) {
430                 debug_log("Packet command completed, %d bytes transferred\n",
431                                 pc->xferred);
432                 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
433
434                 local_irq_enable_in_hardirq();
435
436                 if ((stat & ERR_STAT) || (pc->flags & PC_FLAG_DMA_ERROR)) {
437                         /* Error detected */
438                         debug_log("%s: I/O error\n", drive->name);
439                         rq->errors++;
440                         if (pc->c[0] == GPCMD_REQUEST_SENSE) {
441                                 printk(KERN_ERR "ide-floppy: I/O error in "
442                                         "request sense command\n");
443                                 return ide_do_reset(drive);
444                         }
445                         /* Retry operation */
446                         idefloppy_retry_pc(drive);
447                         /* queued, but not started */
448                         return ide_stopped;
449                 }
450                 pc->error = 0;
451                 if (floppy->failed_pc == pc)
452                         floppy->failed_pc = NULL;
453                 /* Command finished - Call the callback function */
454                 pc->idefloppy_callback(drive);
455                 return ide_stopped;
456         }
457
458         if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
459                 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
460                 printk(KERN_ERR "ide-floppy: The floppy wants to issue "
461                         "more interrupts in DMA mode\n");
462                 ide_dma_off(drive);
463                 return ide_do_reset(drive);
464         }
465
466         /* Get the number of bytes to transfer */
467         bcount = (hwif->INB(hwif->io_ports.lbah_addr) << 8) |
468                   hwif->INB(hwif->io_ports.lbam_addr);
469         /* on this interrupt */
470         ireason = hwif->INB(hwif->io_ports.nsect_addr);
471
472         if (ireason & CD) {
473                 printk(KERN_ERR "ide-floppy: CoD != 0 in %s\n", __func__);
474                 return ide_do_reset(drive);
475         }
476         if (((ireason & IO) == IO) == !!(pc->flags & PC_FLAG_WRITING)) {
477                 /* Hopefully, we will never get here */
478                 printk(KERN_ERR "ide-floppy: We wanted to %s, ",
479                                 (ireason & IO) ? "Write" : "Read");
480                 printk(KERN_ERR "but the floppy wants us to %s !\n",
481                                 (ireason & IO) ? "Read" : "Write");
482                 return ide_do_reset(drive);
483         }
484         if (!(pc->flags & PC_FLAG_WRITING)) {
485                 /* Reading - Check that we have enough space */
486                 temp = pc->xferred + bcount;
487                 if (temp > pc->req_xfer) {
488                         if (temp > pc->buf_size) {
489                                 printk(KERN_ERR "ide-floppy: The floppy wants "
490                                         "to send us more data than expected "
491                                         "- discarding data\n");
492                                 ide_pad_transfer(drive, 0, bcount);
493
494                                 ide_set_handler(drive,
495                                                 &idefloppy_pc_intr,
496                                                 IDEFLOPPY_WAIT_CMD,
497                                                 NULL);
498                                 return ide_started;
499                         }
500                         debug_log("The floppy wants to send us more data than"
501                                         " expected - allowing transfer\n");
502                 }
503         }
504         if (pc->flags & PC_FLAG_WRITING)
505                 xferfunc = hwif->output_data;
506         else
507                 xferfunc = hwif->input_data;
508
509         if (pc->buf)
510                 xferfunc(drive, NULL, pc->cur_pos, bcount);
511         else
512                 ide_floppy_io_buffers(drive, pc, bcount,
513                                       !!(pc->flags & PC_FLAG_WRITING));
514
515         /* Update the current position */
516         pc->xferred += bcount;
517         pc->cur_pos += bcount;
518
519         /* And set the interrupt handler again */
520         ide_set_handler(drive, &idefloppy_pc_intr, IDEFLOPPY_WAIT_CMD, NULL);
521         return ide_started;
522 }
523
524 /*
525  * What we have here is a classic case of a top half / bottom half interrupt
526  * service routine. In interrupt mode, the device sends an interrupt to signal
527  * that it is ready to receive a packet. However, we need to delay about 2-3
528  * ticks before issuing the packet or we gets in trouble.
529  *
530  * So, follow carefully. transfer_pc1 is called as an interrupt (or directly).
531  * In either case, when the device says it's ready for a packet, we schedule
532  * the packet transfer to occur about 2-3 ticks later in transfer_pc2.
533  */
534 static int idefloppy_transfer_pc2(ide_drive_t *drive)
535 {
536         idefloppy_floppy_t *floppy = drive->driver_data;
537
538         /* Send the actual packet */
539         drive->hwif->output_data(drive, NULL, floppy->pc->c, 12);
540
541         /* Timeout for the packet command */
542         return IDEFLOPPY_WAIT_CMD;
543 }
544
545 static ide_startstop_t idefloppy_transfer_pc1(ide_drive_t *drive)
546 {
547         ide_hwif_t *hwif = drive->hwif;
548         idefloppy_floppy_t *floppy = drive->driver_data;
549         ide_expiry_t *expiry;
550         unsigned int timeout;
551         ide_startstop_t startstop;
552         u8 ireason;
553
554         if (ide_wait_stat(&startstop, drive, DRQ_STAT, BUSY_STAT, WAIT_READY)) {
555                 printk(KERN_ERR "ide-floppy: Strange, packet command "
556                                 "initiated yet DRQ isn't asserted\n");
557                 return startstop;
558         }
559         ireason = hwif->INB(hwif->io_ports.nsect_addr);
560         if ((ireason & CD) == 0 || (ireason & IO)) {
561                 printk(KERN_ERR "ide-floppy: (IO,CoD) != (0,1) "
562                                 "while issuing a packet command\n");
563                 return ide_do_reset(drive);
564         }
565         /*
566          * The following delay solves a problem with ATAPI Zip 100 drives
567          * where the Busy flag was apparently being deasserted before the
568          * unit was ready to receive data. This was happening on a
569          * 1200 MHz Athlon system. 10/26/01 25msec is too short,
570          * 40 and 50msec work well. idefloppy_pc_intr will not be actually
571          * used until after the packet is moved in about 50 msec.
572          */
573         if (floppy->flags & IDEFLOPPY_FLAG_ZIP_DRIVE) {
574                 timeout = floppy->ticks;
575                 expiry = &idefloppy_transfer_pc2;
576         } else {
577                 timeout = IDEFLOPPY_WAIT_CMD;
578                 expiry = NULL;
579         }
580
581         ide_set_handler(drive, &idefloppy_pc_intr, timeout, expiry);
582
583         if ((floppy->flags & IDEFLOPPY_FLAG_ZIP_DRIVE) == 0)
584                 /* Send the actual packet */
585                 hwif->output_data(drive, NULL, floppy->pc->c, 12);
586
587         return ide_started;
588 }
589
590 static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
591                                     struct ide_atapi_pc *pc)
592 {
593         /* supress error messages resulting from Medium not present */
594         if (floppy->sense_key == 0x02 &&
595             floppy->asc       == 0x3a &&
596             floppy->ascq      == 0x00)
597                 return;
598
599         printk(KERN_ERR "ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
600                         "asc = %2x, ascq = %2x\n",
601                         floppy->drive->name, pc->c[0], floppy->sense_key,
602                         floppy->asc, floppy->ascq);
603
604 }
605
606 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
607                 struct ide_atapi_pc *pc)
608 {
609         idefloppy_floppy_t *floppy = drive->driver_data;
610         ide_hwif_t *hwif = drive->hwif;
611         u16 bcount;
612         u8 dma;
613
614         if (floppy->failed_pc == NULL &&
615             pc->c[0] != GPCMD_REQUEST_SENSE)
616                 floppy->failed_pc = pc;
617         /* Set the current packet command */
618         floppy->pc = pc;
619
620         if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
621                 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
622                         ide_floppy_report_error(floppy, pc);
623                 /* Giving up */
624                 pc->error = IDEFLOPPY_ERROR_GENERAL;
625
626                 floppy->failed_pc = NULL;
627                 pc->idefloppy_callback(drive);
628                 return ide_stopped;
629         }
630
631         debug_log("Retry number - %d\n", pc->retries);
632
633         pc->retries++;
634         /* We haven't transferred any data yet */
635         pc->xferred = 0;
636         pc->cur_pos = pc->buf;
637         bcount = min(pc->req_xfer, 63 * 1024);
638
639         if (pc->flags & PC_FLAG_DMA_ERROR) {
640                 pc->flags &= ~PC_FLAG_DMA_ERROR;
641                 ide_dma_off(drive);
642         }
643         dma = 0;
644
645         if ((pc->flags & PC_FLAG_DMA_RECOMMENDED) && drive->using_dma)
646                 dma = !hwif->dma_ops->dma_setup(drive);
647
648         ide_pktcmd_tf_load(drive, IDE_TFLAG_OUT_DEVICE, bcount, dma);
649
650         if (dma) {
651                 /* Begin DMA, if necessary */
652                 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
653                 hwif->dma_ops->dma_start(drive);
654         }
655
656         if (floppy->flags & IDEFLOPPY_FLAG_DRQ_INTERRUPT) {
657                 /* Issue the packet command */
658                 ide_execute_command(drive, WIN_PACKETCMD,
659                                 &idefloppy_transfer_pc1,
660                                 IDEFLOPPY_WAIT_CMD,
661                                 NULL);
662                 return ide_started;
663         } else {
664                 /* Issue the packet command */
665                 ide_execute_pkt_cmd(drive);
666                 return idefloppy_transfer_pc1(drive);
667         }
668 }
669
670 static void idefloppy_rw_callback(ide_drive_t *drive)
671 {
672         debug_log("Reached %s\n", __func__);
673
674         idefloppy_end_request(drive, 1, 0);
675         return;
676 }
677
678 static void idefloppy_create_prevent_cmd(struct ide_atapi_pc *pc, int prevent)
679 {
680         debug_log("creating prevent removal command, prevent = %d\n", prevent);
681
682         idefloppy_init_pc(pc);
683         pc->c[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL;
684         pc->c[4] = prevent;
685 }
686
687 static void idefloppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
688 {
689         idefloppy_init_pc(pc);
690         pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
691         pc->c[7] = 255;
692         pc->c[8] = 255;
693         pc->req_xfer = 255;
694 }
695
696 static void idefloppy_create_format_unit_cmd(struct ide_atapi_pc *pc, int b,
697                 int l, int flags)
698 {
699         idefloppy_init_pc(pc);
700         pc->c[0] = GPCMD_FORMAT_UNIT;
701         pc->c[1] = 0x17;
702
703         memset(pc->buf, 0, 12);
704         pc->buf[1] = 0xA2;
705         /* Default format list header, u8 1: FOV/DCRT/IMM bits set */
706
707         if (flags & 1)                          /* Verify bit on... */
708                 pc->buf[1] ^= 0x20;             /* ... turn off DCRT bit */
709         pc->buf[3] = 8;
710
711         put_unaligned(cpu_to_be32(b), (unsigned int *)(&pc->buf[4]));
712         put_unaligned(cpu_to_be32(l), (unsigned int *)(&pc->buf[8]));
713         pc->buf_size = 12;
714         pc->flags |= PC_FLAG_WRITING;
715 }
716
717 /* A mode sense command is used to "sense" floppy parameters. */
718 static void idefloppy_create_mode_sense_cmd(struct ide_atapi_pc *pc,
719                 u8 page_code, u8 type)
720 {
721         u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
722
723         idefloppy_init_pc(pc);
724         pc->c[0] = GPCMD_MODE_SENSE_10;
725         pc->c[1] = 0;
726         pc->c[2] = page_code + (type << 6);
727
728         switch (page_code) {
729         case IDEFLOPPY_CAPABILITIES_PAGE:
730                 length += 12;
731                 break;
732         case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
733                 length += 32;
734                 break;
735         default:
736                 printk(KERN_ERR "ide-floppy: unsupported page code "
737                                 "in create_mode_sense_cmd\n");
738         }
739         put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
740         pc->req_xfer = length;
741 }
742
743 static void idefloppy_create_start_stop_cmd(struct ide_atapi_pc *pc, int start)
744 {
745         idefloppy_init_pc(pc);
746         pc->c[0] = GPCMD_START_STOP_UNIT;
747         pc->c[4] = start;
748 }
749
750 static void idefloppy_create_test_unit_ready_cmd(struct ide_atapi_pc *pc)
751 {
752         idefloppy_init_pc(pc);
753         pc->c[0] = GPCMD_TEST_UNIT_READY;
754 }
755
756 static void idefloppy_create_rw_cmd(idefloppy_floppy_t *floppy,
757                                     struct ide_atapi_pc *pc, struct request *rq,
758                                     unsigned long sector)
759 {
760         int block = sector / floppy->bs_factor;
761         int blocks = rq->nr_sectors / floppy->bs_factor;
762         int cmd = rq_data_dir(rq);
763
764         debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
765                 block, blocks);
766
767         idefloppy_init_pc(pc);
768         pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
769         put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
770         put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
771
772         pc->idefloppy_callback = &idefloppy_rw_callback;
773         pc->rq = rq;
774         pc->b_count = cmd == READ ? 0 : rq->bio->bi_size;
775         if (rq->cmd_flags & REQ_RW)
776                 pc->flags |= PC_FLAG_WRITING;
777         pc->buf = NULL;
778         pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
779         pc->flags |= PC_FLAG_DMA_RECOMMENDED;
780 }
781
782 static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
783                 struct ide_atapi_pc *pc, struct request *rq)
784 {
785         idefloppy_init_pc(pc);
786         pc->idefloppy_callback = &idefloppy_rw_callback;
787         memcpy(pc->c, rq->cmd, sizeof(pc->c));
788         pc->rq = rq;
789         pc->b_count = rq->data_len;
790         if (rq->data_len && rq_data_dir(rq) == WRITE)
791                 pc->flags |= PC_FLAG_WRITING;
792         pc->buf = rq->data;
793         if (rq->bio)
794                 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
795         /*
796          * possibly problematic, doesn't look like ide-floppy correctly
797          * handled scattered requests if dma fails...
798          */
799         pc->req_xfer = pc->buf_size = rq->data_len;
800 }
801
802 static ide_startstop_t idefloppy_do_request(ide_drive_t *drive,
803                 struct request *rq, sector_t block_s)
804 {
805         idefloppy_floppy_t *floppy = drive->driver_data;
806         struct ide_atapi_pc *pc;
807         unsigned long block = (unsigned long)block_s;
808
809         debug_log("dev: %s, cmd_type: %x, errors: %d\n",
810                         rq->rq_disk ? rq->rq_disk->disk_name : "?",
811                         rq->cmd_type, rq->errors);
812         debug_log("sector: %ld, nr_sectors: %ld, "
813                         "current_nr_sectors: %d\n", (long)rq->sector,
814                         rq->nr_sectors, rq->current_nr_sectors);
815
816         if (rq->errors >= ERROR_MAX) {
817                 if (floppy->failed_pc)
818                         ide_floppy_report_error(floppy, floppy->failed_pc);
819                 else
820                         printk(KERN_ERR "ide-floppy: %s: I/O error\n",
821                                 drive->name);
822                 idefloppy_end_request(drive, 0, 0);
823                 return ide_stopped;
824         }
825         if (blk_fs_request(rq)) {
826                 if (((long)rq->sector % floppy->bs_factor) ||
827                     (rq->nr_sectors % floppy->bs_factor)) {
828                         printk(KERN_ERR "%s: unsupported r/w request size\n",
829                                         drive->name);
830                         idefloppy_end_request(drive, 0, 0);
831                         return ide_stopped;
832                 }
833                 pc = idefloppy_next_pc_storage(drive);
834                 idefloppy_create_rw_cmd(floppy, pc, rq, block);
835         } else if (blk_special_request(rq)) {
836                 pc = (struct ide_atapi_pc *) rq->buffer;
837         } else if (blk_pc_request(rq)) {
838                 pc = idefloppy_next_pc_storage(drive);
839                 idefloppy_blockpc_cmd(floppy, pc, rq);
840         } else {
841                 blk_dump_rq_flags(rq,
842                         "ide-floppy: unsupported command in queue");
843                 idefloppy_end_request(drive, 0, 0);
844                 return ide_stopped;
845         }
846
847         pc->rq = rq;
848         return idefloppy_issue_pc(drive, pc);
849 }
850
851 /*
852  * Add a special packet command request to the tail of the request queue,
853  * and wait for it to be serviced.
854  */
855 static int idefloppy_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
856 {
857         struct ide_floppy_obj *floppy = drive->driver_data;
858         struct request *rq;
859         int error;
860
861         rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
862         rq->buffer = (char *) pc;
863         rq->cmd_type = REQ_TYPE_SPECIAL;
864         error = blk_execute_rq(drive->queue, floppy->disk, rq, 0);
865         blk_put_request(rq);
866
867         return error;
868 }
869
870 /*
871  * Look at the flexible disk page parameters. We ignore the CHS capacity
872  * parameters and use the LBA parameters instead.
873  */
874 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive)
875 {
876         idefloppy_floppy_t *floppy = drive->driver_data;
877         struct ide_atapi_pc pc;
878         u8 *page;
879         int capacity, lba_capacity;
880         u16 transfer_rate, sector_size, cyls, rpm;
881         u8 heads, sectors;
882
883         idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE,
884                                         MODE_SENSE_CURRENT);
885
886         if (idefloppy_queue_pc_tail(drive, &pc)) {
887                 printk(KERN_ERR "ide-floppy: Can't get flexible disk page"
888                                 " parameters\n");
889                 return 1;
890         }
891         floppy->wp = !!(pc.buf[3] & 0x80);
892         set_disk_ro(floppy->disk, floppy->wp);
893         page = &pc.buf[8];
894
895         transfer_rate = be16_to_cpu(*(u16 *)&pc.buf[8 + 2]);
896         sector_size   = be16_to_cpu(*(u16 *)&pc.buf[8 + 6]);
897         cyls          = be16_to_cpu(*(u16 *)&pc.buf[8 + 8]);
898         rpm           = be16_to_cpu(*(u16 *)&pc.buf[8 + 28]);
899         heads         = pc.buf[8 + 4];
900         sectors       = pc.buf[8 + 5];
901
902         capacity = cyls * heads * sectors * sector_size;
903
904         if (memcmp(page, &floppy->flexible_disk_page, 32))
905                 printk(KERN_INFO "%s: %dkB, %d/%d/%d CHS, %d kBps, "
906                                 "%d sector size, %d rpm\n",
907                                 drive->name, capacity / 1024, cyls, heads,
908                                 sectors, transfer_rate / 8, sector_size, rpm);
909
910         memcpy(&floppy->flexible_disk_page, page, 32);
911         drive->bios_cyl = cyls;
912         drive->bios_head = heads;
913         drive->bios_sect = sectors;
914         lba_capacity = floppy->blocks * floppy->block_size;
915
916         if (capacity < lba_capacity) {
917                 printk(KERN_NOTICE "%s: The disk reports a capacity of %d "
918                         "bytes, but the drive only handles %d\n",
919                         drive->name, lba_capacity, capacity);
920                 floppy->blocks = floppy->block_size ?
921                         capacity / floppy->block_size : 0;
922         }
923         return 0;
924 }
925
926 static int idefloppy_get_sfrp_bit(ide_drive_t *drive)
927 {
928         idefloppy_floppy_t *floppy = drive->driver_data;
929         struct ide_atapi_pc pc;
930
931         floppy->srfp = 0;
932         idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_CAPABILITIES_PAGE,
933                                                  MODE_SENSE_CURRENT);
934
935         pc.flags |= PC_FLAG_SUPPRESS_ERROR;
936         if (idefloppy_queue_pc_tail(drive, &pc))
937                 return 1;
938
939         floppy->srfp = pc.buf[8 + 2] & 0x40;
940         return (0);
941 }
942
943 /*
944  * Determine if a media is present in the floppy drive, and if so, its LBA
945  * capacity.
946  */
947 static int ide_floppy_get_capacity(ide_drive_t *drive)
948 {
949         idefloppy_floppy_t *floppy = drive->driver_data;
950         struct ide_atapi_pc pc;
951         u8 *cap_desc;
952         u8 header_len, desc_cnt;
953         int i, rc = 1, blocks, length;
954
955         drive->bios_cyl = 0;
956         drive->bios_head = drive->bios_sect = 0;
957         floppy->blocks = 0;
958         floppy->bs_factor = 1;
959         set_capacity(floppy->disk, 0);
960
961         idefloppy_create_read_capacity_cmd(&pc);
962         if (idefloppy_queue_pc_tail(drive, &pc)) {
963                 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
964                 return 1;
965         }
966         header_len = pc.buf[3];
967         cap_desc = &pc.buf[4];
968         desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
969
970         for (i = 0; i < desc_cnt; i++) {
971                 unsigned int desc_start = 4 + i*8;
972
973                 blocks = be32_to_cpu(*(u32 *)&pc.buf[desc_start]);
974                 length = be16_to_cpu(*(u16 *)&pc.buf[desc_start + 6]);
975
976                 debug_log("Descriptor %d: %dkB, %d blocks, %d sector size\n",
977                                 i, blocks * length / 1024, blocks, length);
978
979                 if (i)
980                         continue;
981                 /*
982                  * the code below is valid only for the 1st descriptor, ie i=0
983                  */
984
985                 switch (pc.buf[desc_start + 4] & 0x03) {
986                 /* Clik! drive returns this instead of CAPACITY_CURRENT */
987                 case CAPACITY_UNFORMATTED:
988                         if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE))
989                                 /*
990                                  * If it is not a clik drive, break out
991                                  * (maintains previous driver behaviour)
992                                  */
993                                 break;
994                 case CAPACITY_CURRENT:
995                         /* Normal Zip/LS-120 disks */
996                         if (memcmp(cap_desc, &floppy->cap_desc, 8))
997                                 printk(KERN_INFO "%s: %dkB, %d blocks, %d "
998                                         "sector size\n", drive->name,
999                                         blocks * length / 1024, blocks, length);
1000                         memcpy(&floppy->cap_desc, cap_desc, 8);
1001
1002                         if (!length || length % 512) {
1003                                 printk(KERN_NOTICE "%s: %d bytes block size "
1004                                         "not supported\n", drive->name, length);
1005                         } else {
1006                                 floppy->blocks = blocks;
1007                                 floppy->block_size = length;
1008                                 floppy->bs_factor = length / 512;
1009                                 if (floppy->bs_factor != 1)
1010                                         printk(KERN_NOTICE "%s: warning: non "
1011                                                 "512 bytes block size not "
1012                                                 "fully supported\n",
1013                                                 drive->name);
1014                                 rc = 0;
1015                         }
1016                         break;
1017                 case CAPACITY_NO_CARTRIDGE:
1018                         /*
1019                          * This is a KERN_ERR so it appears on screen
1020                          * for the user to see
1021                          */
1022                         printk(KERN_ERR "%s: No disk in drive\n", drive->name);
1023                         break;
1024                 case CAPACITY_INVALID:
1025                         printk(KERN_ERR "%s: Invalid capacity for disk "
1026                                 "in drive\n", drive->name);
1027                         break;
1028                 }
1029                 debug_log("Descriptor 0 Code: %d\n",
1030                           pc.buf[desc_start + 4] & 0x03);
1031         }
1032
1033         /* Clik! disk does not support get_flexible_disk_page */
1034         if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE))
1035                 (void) ide_floppy_get_flexible_disk_page(drive);
1036
1037         set_capacity(floppy->disk, floppy->blocks * floppy->bs_factor);
1038         return rc;
1039 }
1040
1041 /*
1042  * Obtain the list of formattable capacities.
1043  * Very similar to ide_floppy_get_capacity, except that we push the capacity
1044  * descriptors to userland, instead of our own structures.
1045  *
1046  * Userland gives us the following structure:
1047  *
1048  * struct idefloppy_format_capacities {
1049  *      int nformats;
1050  *      struct {
1051  *              int nblocks;
1052  *              int blocksize;
1053  *      } formats[];
1054  * };
1055  *
1056  * userland initializes nformats to the number of allocated formats[] records.
1057  * On exit we set nformats to the number of records we've actually initialized.
1058  */
1059
1060 static int ide_floppy_get_format_capacities(ide_drive_t *drive, int __user *arg)
1061 {
1062         struct ide_atapi_pc pc;
1063         u8 header_len, desc_cnt;
1064         int i, blocks, length, u_array_size, u_index;
1065         int __user *argp;
1066
1067         if (get_user(u_array_size, arg))
1068                 return (-EFAULT);
1069
1070         if (u_array_size <= 0)
1071                 return (-EINVAL);
1072
1073         idefloppy_create_read_capacity_cmd(&pc);
1074         if (idefloppy_queue_pc_tail(drive, &pc)) {
1075                 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
1076                 return (-EIO);
1077         }
1078         header_len = pc.buf[3];
1079         desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
1080
1081         u_index = 0;
1082         argp = arg + 1;
1083
1084         /*
1085          * We always skip the first capacity descriptor.  That's the current
1086          * capacity.  We are interested in the remaining descriptors, the
1087          * formattable capacities.
1088          */
1089         for (i = 1; i < desc_cnt; i++) {
1090                 unsigned int desc_start = 4 + i*8;
1091
1092                 if (u_index >= u_array_size)
1093                         break;  /* User-supplied buffer too small */
1094
1095                 blocks = be32_to_cpu(*(u32 *)&pc.buf[desc_start]);
1096                 length = be16_to_cpu(*(u16 *)&pc.buf[desc_start + 6]);
1097
1098                 if (put_user(blocks, argp))
1099                         return(-EFAULT);
1100                 ++argp;
1101
1102                 if (put_user(length, argp))
1103                         return (-EFAULT);
1104                 ++argp;
1105
1106                 ++u_index;
1107         }
1108
1109         if (put_user(u_index, arg))
1110                 return (-EFAULT);
1111         return (0);
1112 }
1113
1114 /*
1115  * Get ATAPI_FORMAT_UNIT progress indication.
1116  *
1117  * Userland gives a pointer to an int.  The int is set to a progress
1118  * indicator 0-65536, with 65536=100%.
1119  *
1120  * If the drive does not support format progress indication, we just check
1121  * the dsc bit, and return either 0 or 65536.
1122  */
1123
1124 static int idefloppy_get_format_progress(ide_drive_t *drive, int __user *arg)
1125 {
1126         idefloppy_floppy_t *floppy = drive->driver_data;
1127         struct ide_atapi_pc pc;
1128         int progress_indication = 0x10000;
1129
1130         if (floppy->srfp) {
1131                 idefloppy_create_request_sense_cmd(&pc);
1132                 if (idefloppy_queue_pc_tail(drive, &pc))
1133                         return (-EIO);
1134
1135                 if (floppy->sense_key == 2 &&
1136                     floppy->asc == 4 &&
1137                     floppy->ascq == 4)
1138                         progress_indication = floppy->progress_indication;
1139
1140                 /* Else assume format_unit has finished, and we're at 0x10000 */
1141         } else {
1142                 unsigned long flags;
1143                 u8 stat;
1144
1145                 local_irq_save(flags);
1146                 stat = ide_read_status(drive);
1147                 local_irq_restore(flags);
1148
1149                 progress_indication = ((stat & SEEK_STAT) == 0) ? 0 : 0x10000;
1150         }
1151         if (put_user(progress_indication, arg))
1152                 return (-EFAULT);
1153
1154         return (0);
1155 }
1156
1157 static sector_t idefloppy_capacity(ide_drive_t *drive)
1158 {
1159         idefloppy_floppy_t *floppy = drive->driver_data;
1160         unsigned long capacity = floppy->blocks * floppy->bs_factor;
1161
1162         return capacity;
1163 }
1164
1165 /*
1166  * Check whether we can support a drive, based on the ATAPI IDENTIFY command
1167  * results.
1168  */
1169 static int idefloppy_identify_device(ide_drive_t *drive, struct hd_driveid *id)
1170 {
1171         u8 gcw[2];
1172         u8 device_type, protocol, removable, drq_type, packet_size;
1173
1174         *((u16 *) &gcw) = id->config;
1175
1176         device_type =  gcw[1] & 0x1F;
1177         removable   = (gcw[0] & 0x80) >> 7;
1178         protocol    = (gcw[1] & 0xC0) >> 6;
1179         drq_type    = (gcw[0] & 0x60) >> 5;
1180         packet_size =  gcw[0] & 0x03;
1181
1182 #ifdef CONFIG_PPC
1183         /* kludge for Apple PowerBook internal zip */
1184         if (device_type == 5 &&
1185             !strstr(id->model, "CD-ROM") && strstr(id->model, "ZIP"))
1186                 device_type = 0;
1187 #endif
1188
1189         if (protocol != 2)
1190                 printk(KERN_ERR "ide-floppy: Protocol (0x%02x) is not ATAPI\n",
1191                         protocol);
1192         else if (device_type != 0)
1193                 printk(KERN_ERR "ide-floppy: Device type (0x%02x) is not set "
1194                                 "to floppy\n", device_type);
1195         else if (!removable)
1196                 printk(KERN_ERR "ide-floppy: The removable flag is not set\n");
1197         else if (drq_type == 3)
1198                 printk(KERN_ERR "ide-floppy: Sorry, DRQ type (0x%02x) not "
1199                                 "supported\n", drq_type);
1200         else if (packet_size != 0)
1201                 printk(KERN_ERR "ide-floppy: Packet size (0x%02x) is not 12 "
1202                                 "bytes\n", packet_size);
1203         else
1204                 return 1;
1205         return 0;
1206 }
1207
1208 #ifdef CONFIG_IDE_PROC_FS
1209 static void idefloppy_add_settings(ide_drive_t *drive)
1210 {
1211         idefloppy_floppy_t *floppy = drive->driver_data;
1212
1213         ide_add_setting(drive, "bios_cyl", SETTING_RW, TYPE_INT, 0, 1023, 1, 1,
1214                         &drive->bios_cyl, NULL);
1215         ide_add_setting(drive, "bios_head", SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1216                         &drive->bios_head, NULL);
1217         ide_add_setting(drive, "bios_sect", SETTING_RW, TYPE_BYTE, 0,  63, 1, 1,
1218                         &drive->bios_sect, NULL);
1219         ide_add_setting(drive, "ticks",    SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1220                         &floppy->ticks,  NULL);
1221 }
1222 #else
1223 static inline void idefloppy_add_settings(ide_drive_t *drive) { ; }
1224 #endif
1225
1226 static void idefloppy_setup(ide_drive_t *drive, idefloppy_floppy_t *floppy)
1227 {
1228         u8 gcw[2];
1229
1230         *((u16 *) &gcw) = drive->id->config;
1231         floppy->pc = floppy->pc_stack;
1232
1233         if (((gcw[0] & 0x60) >> 5) == 1)
1234                 floppy->flags |= IDEFLOPPY_FLAG_DRQ_INTERRUPT;
1235         /*
1236          * We used to check revisions here. At this point however I'm giving up.
1237          * Just assume they are all broken, its easier.
1238          *
1239          * The actual reason for the workarounds was likely a driver bug after
1240          * all rather than a firmware bug, and the workaround below used to hide
1241          * it. It should be fixed as of version 1.9, but to be on the safe side
1242          * we'll leave the limitation below for the 2.2.x tree.
1243          */
1244         if (!strncmp(drive->id->model, "IOMEGA ZIP 100 ATAPI", 20)) {
1245                 floppy->flags |= IDEFLOPPY_FLAG_ZIP_DRIVE;
1246                 /* This value will be visible in the /proc/ide/hdx/settings */
1247                 floppy->ticks = IDEFLOPPY_TICKS_DELAY;
1248                 blk_queue_max_sectors(drive->queue, 64);
1249         }
1250
1251         /*
1252          * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
1253          * nasty clicking noises without it, so please don't remove this.
1254          */
1255         if (strncmp(drive->id->model, "IOMEGA Clik!", 11) == 0) {
1256                 blk_queue_max_sectors(drive->queue, 64);
1257                 floppy->flags |= IDEFLOPPY_FLAG_CLIK_DRIVE;
1258         }
1259
1260         (void) ide_floppy_get_capacity(drive);
1261         idefloppy_add_settings(drive);
1262 }
1263
1264 static void ide_floppy_remove(ide_drive_t *drive)
1265 {
1266         idefloppy_floppy_t *floppy = drive->driver_data;
1267         struct gendisk *g = floppy->disk;
1268
1269         ide_proc_unregister_driver(drive, floppy->driver);
1270
1271         del_gendisk(g);
1272
1273         ide_floppy_put(floppy);
1274 }
1275
1276 static void idefloppy_cleanup_obj(struct kref *kref)
1277 {
1278         struct ide_floppy_obj *floppy = to_ide_floppy(kref);
1279         ide_drive_t *drive = floppy->drive;
1280         struct gendisk *g = floppy->disk;
1281
1282         drive->driver_data = NULL;
1283         g->private_data = NULL;
1284         put_disk(g);
1285         kfree(floppy);
1286 }
1287
1288 #ifdef CONFIG_IDE_PROC_FS
1289 static int proc_idefloppy_read_capacity(char *page, char **start, off_t off,
1290                 int count, int *eof, void *data)
1291 {
1292         ide_drive_t*drive = (ide_drive_t *)data;
1293         int len;
1294
1295         len = sprintf(page, "%llu\n", (long long)idefloppy_capacity(drive));
1296         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1297 }
1298
1299 static ide_proc_entry_t idefloppy_proc[] = {
1300         { "capacity",   S_IFREG|S_IRUGO, proc_idefloppy_read_capacity,  NULL },
1301         { "geometry",   S_IFREG|S_IRUGO, proc_ide_read_geometry,        NULL },
1302         { NULL, 0, NULL, NULL }
1303 };
1304 #endif  /* CONFIG_IDE_PROC_FS */
1305
1306 static int ide_floppy_probe(ide_drive_t *);
1307
1308 static ide_driver_t idefloppy_driver = {
1309         .gen_driver = {
1310                 .owner          = THIS_MODULE,
1311                 .name           = "ide-floppy",
1312                 .bus            = &ide_bus_type,
1313         },
1314         .probe                  = ide_floppy_probe,
1315         .remove                 = ide_floppy_remove,
1316         .version                = IDEFLOPPY_VERSION,
1317         .media                  = ide_floppy,
1318         .supports_dsc_overlap   = 0,
1319         .do_request             = idefloppy_do_request,
1320         .end_request            = idefloppy_end_request,
1321         .error                  = __ide_error,
1322         .abort                  = __ide_abort,
1323 #ifdef CONFIG_IDE_PROC_FS
1324         .proc                   = idefloppy_proc,
1325 #endif
1326 };
1327
1328 static int idefloppy_open(struct inode *inode, struct file *filp)
1329 {
1330         struct gendisk *disk = inode->i_bdev->bd_disk;
1331         struct ide_floppy_obj *floppy;
1332         ide_drive_t *drive;
1333         struct ide_atapi_pc pc;
1334         int ret = 0;
1335
1336         debug_log("Reached %s\n", __func__);
1337
1338         floppy = ide_floppy_get(disk);
1339         if (!floppy)
1340                 return -ENXIO;
1341
1342         drive = floppy->drive;
1343
1344         floppy->openers++;
1345
1346         if (floppy->openers == 1) {
1347                 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1348                 /* Just in case */
1349
1350                 idefloppy_create_test_unit_ready_cmd(&pc);
1351                 if (idefloppy_queue_pc_tail(drive, &pc)) {
1352                         idefloppy_create_start_stop_cmd(&pc, 1);
1353                         (void) idefloppy_queue_pc_tail(drive, &pc);
1354                 }
1355
1356                 if (ide_floppy_get_capacity(drive)
1357                    && (filp->f_flags & O_NDELAY) == 0
1358                     /*
1359                      * Allow O_NDELAY to open a drive without a disk, or with an
1360                      * unreadable disk, so that we can get the format capacity
1361                      * of the drive or begin the format - Sam
1362                      */
1363                     ) {
1364                         ret = -EIO;
1365                         goto out_put_floppy;
1366                 }
1367
1368                 if (floppy->wp && (filp->f_mode & 2)) {
1369                         ret = -EROFS;
1370                         goto out_put_floppy;
1371                 }
1372                 floppy->flags |= IDEFLOPPY_FLAG_MEDIA_CHANGED;
1373                 /* IOMEGA Clik! drives do not support lock/unlock commands */
1374                 if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1375                         idefloppy_create_prevent_cmd(&pc, 1);
1376                         (void) idefloppy_queue_pc_tail(drive, &pc);
1377                 }
1378                 check_disk_change(inode->i_bdev);
1379         } else if (floppy->flags & IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS) {
1380                 ret = -EBUSY;
1381                 goto out_put_floppy;
1382         }
1383         return 0;
1384
1385 out_put_floppy:
1386         floppy->openers--;
1387         ide_floppy_put(floppy);
1388         return ret;
1389 }
1390
1391 static int idefloppy_release(struct inode *inode, struct file *filp)
1392 {
1393         struct gendisk *disk = inode->i_bdev->bd_disk;
1394         struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1395         ide_drive_t *drive = floppy->drive;
1396         struct ide_atapi_pc pc;
1397
1398         debug_log("Reached %s\n", __func__);
1399
1400         if (floppy->openers == 1) {
1401                 /* IOMEGA Clik! drives do not support lock/unlock commands */
1402                 if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1403                         idefloppy_create_prevent_cmd(&pc, 0);
1404                         (void) idefloppy_queue_pc_tail(drive, &pc);
1405                 }
1406
1407                 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1408         }
1409
1410         floppy->openers--;
1411
1412         ide_floppy_put(floppy);
1413
1414         return 0;
1415 }
1416
1417 static int idefloppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1418 {
1419         struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1420         ide_drive_t *drive = floppy->drive;
1421
1422         geo->heads = drive->bios_head;
1423         geo->sectors = drive->bios_sect;
1424         geo->cylinders = (u16)drive->bios_cyl; /* truncate */
1425         return 0;
1426 }
1427
1428 static int ide_floppy_lockdoor(idefloppy_floppy_t *floppy,
1429                 struct ide_atapi_pc *pc, unsigned long arg, unsigned int cmd)
1430 {
1431         if (floppy->openers > 1)
1432                 return -EBUSY;
1433
1434         /* The IOMEGA Clik! Drive doesn't support this command -
1435          * no room for an eject mechanism */
1436         if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1437                 int prevent = arg ? 1 : 0;
1438
1439                 if (cmd == CDROMEJECT)
1440                         prevent = 0;
1441
1442                 idefloppy_create_prevent_cmd(pc, prevent);
1443                 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1444         }
1445
1446         if (cmd == CDROMEJECT) {
1447                 idefloppy_create_start_stop_cmd(pc, 2);
1448                 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1449         }
1450
1451         return 0;
1452 }
1453
1454 static int ide_floppy_format_unit(idefloppy_floppy_t *floppy,
1455                                   int __user *arg)
1456 {
1457         int blocks, length, flags, err = 0;
1458         struct ide_atapi_pc pc;
1459
1460         if (floppy->openers > 1) {
1461                 /* Don't format if someone is using the disk */
1462                 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1463                 return -EBUSY;
1464         }
1465
1466         floppy->flags |= IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1467
1468         /*
1469          * Send ATAPI_FORMAT_UNIT to the drive.
1470          *
1471          * Userland gives us the following structure:
1472          *
1473          * struct idefloppy_format_command {
1474          *        int nblocks;
1475          *        int blocksize;
1476          *        int flags;
1477          *        } ;
1478          *
1479          * flags is a bitmask, currently, the only defined flag is:
1480          *
1481          *        0x01 - verify media after format.
1482          */
1483         if (get_user(blocks, arg) ||
1484                         get_user(length, arg+1) ||
1485                         get_user(flags, arg+2)) {
1486                 err = -EFAULT;
1487                 goto out;
1488         }
1489
1490         (void) idefloppy_get_sfrp_bit(floppy->drive);
1491         idefloppy_create_format_unit_cmd(&pc, blocks, length, flags);
1492
1493         if (idefloppy_queue_pc_tail(floppy->drive, &pc))
1494                 err = -EIO;
1495
1496 out:
1497         if (err)
1498                 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1499         return err;
1500 }
1501
1502
1503 static int idefloppy_ioctl(struct inode *inode, struct file *file,
1504                         unsigned int cmd, unsigned long arg)
1505 {
1506         struct block_device *bdev = inode->i_bdev;
1507         struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1508         ide_drive_t *drive = floppy->drive;
1509         struct ide_atapi_pc pc;
1510         void __user *argp = (void __user *)arg;
1511         int err;
1512
1513         switch (cmd) {
1514         case CDROMEJECT:
1515                 /* fall through */
1516         case CDROM_LOCKDOOR:
1517                 return ide_floppy_lockdoor(floppy, &pc, arg, cmd);
1518         case IDEFLOPPY_IOCTL_FORMAT_SUPPORTED:
1519                 return 0;
1520         case IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY:
1521                 return ide_floppy_get_format_capacities(drive, argp);
1522         case IDEFLOPPY_IOCTL_FORMAT_START:
1523                 if (!(file->f_mode & 2))
1524                         return -EPERM;
1525
1526                 return ide_floppy_format_unit(floppy, (int __user *)arg);
1527         case IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS:
1528                 return idefloppy_get_format_progress(drive, argp);
1529         }
1530
1531         /*
1532          * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
1533          * and CDROM_SEND_PACKET (legacy) ioctls
1534          */
1535         if (cmd != CDROM_SEND_PACKET && cmd != SCSI_IOCTL_SEND_COMMAND)
1536                 err = scsi_cmd_ioctl(file, bdev->bd_disk->queue,
1537                                         bdev->bd_disk, cmd, argp);
1538         else
1539                 err = -ENOTTY;
1540
1541         if (err == -ENOTTY)
1542                 err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
1543
1544         return err;
1545 }
1546
1547 static int idefloppy_media_changed(struct gendisk *disk)
1548 {
1549         struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1550         ide_drive_t *drive = floppy->drive;
1551         int ret;
1552
1553         /* do not scan partitions twice if this is a removable device */
1554         if (drive->attach) {
1555                 drive->attach = 0;
1556                 return 0;
1557         }
1558         ret = !!(floppy->flags & IDEFLOPPY_FLAG_MEDIA_CHANGED);
1559         floppy->flags &= ~IDEFLOPPY_FLAG_MEDIA_CHANGED;
1560         return ret;
1561 }
1562
1563 static int idefloppy_revalidate_disk(struct gendisk *disk)
1564 {
1565         struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1566         set_capacity(disk, idefloppy_capacity(floppy->drive));
1567         return 0;
1568 }
1569
1570 static struct block_device_operations idefloppy_ops = {
1571         .owner                  = THIS_MODULE,
1572         .open                   = idefloppy_open,
1573         .release                = idefloppy_release,
1574         .ioctl                  = idefloppy_ioctl,
1575         .getgeo                 = idefloppy_getgeo,
1576         .media_changed          = idefloppy_media_changed,
1577         .revalidate_disk        = idefloppy_revalidate_disk
1578 };
1579
1580 static int ide_floppy_probe(ide_drive_t *drive)
1581 {
1582         idefloppy_floppy_t *floppy;
1583         struct gendisk *g;
1584
1585         if (!strstr("ide-floppy", drive->driver_req))
1586                 goto failed;
1587         if (!drive->present)
1588                 goto failed;
1589         if (drive->media != ide_floppy)
1590                 goto failed;
1591         if (!idefloppy_identify_device(drive, drive->id)) {
1592                 printk(KERN_ERR "ide-floppy: %s: not supported by this version"
1593                                 " of ide-floppy\n", drive->name);
1594                 goto failed;
1595         }
1596         if (drive->scsi) {
1597                 printk(KERN_INFO "ide-floppy: passing drive %s to ide-scsi"
1598                                 " emulation.\n", drive->name);
1599                 goto failed;
1600         }
1601         floppy = kzalloc(sizeof(idefloppy_floppy_t), GFP_KERNEL);
1602         if (!floppy) {
1603                 printk(KERN_ERR "ide-floppy: %s: Can't allocate a floppy"
1604                                 " structure\n", drive->name);
1605                 goto failed;
1606         }
1607
1608         g = alloc_disk(1 << PARTN_BITS);
1609         if (!g)
1610                 goto out_free_floppy;
1611
1612         ide_init_disk(g, drive);
1613
1614         ide_proc_register_driver(drive, &idefloppy_driver);
1615
1616         kref_init(&floppy->kref);
1617
1618         floppy->drive = drive;
1619         floppy->driver = &idefloppy_driver;
1620         floppy->disk = g;
1621
1622         g->private_data = &floppy->driver;
1623
1624         drive->driver_data = floppy;
1625
1626         idefloppy_setup(drive, floppy);
1627
1628         g->minors = 1 << PARTN_BITS;
1629         g->driverfs_dev = &drive->gendev;
1630         g->flags = drive->removable ? GENHD_FL_REMOVABLE : 0;
1631         g->fops = &idefloppy_ops;
1632         drive->attach = 1;
1633         add_disk(g);
1634         return 0;
1635
1636 out_free_floppy:
1637         kfree(floppy);
1638 failed:
1639         return -ENODEV;
1640 }
1641
1642 static void __exit idefloppy_exit(void)
1643 {
1644         driver_unregister(&idefloppy_driver.gen_driver);
1645 }
1646
1647 static int __init idefloppy_init(void)
1648 {
1649         printk("ide-floppy driver " IDEFLOPPY_VERSION "\n");
1650         return driver_register(&idefloppy_driver.gen_driver);
1651 }
1652
1653 MODULE_ALIAS("ide:*m-floppy*");
1654 module_init(idefloppy_init);
1655 module_exit(idefloppy_exit);
1656 MODULE_LICENSE("GPL");
1657 MODULE_DESCRIPTION("ATAPI FLOPPY Driver");
1658