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