2 * IDE ATAPI floppy driver.
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
8 * This driver supports the following IDE floppy drives:
10 * LS-120/240 SuperDisk
12 * Iomega PC Card Clik!/PocketZip
14 * For a historical changelog see
15 * Documentation/ide/ChangeLog.ide-floppy.1996-2002
18 #define DRV_NAME "ide-floppy"
20 #define IDEFLOPPY_VERSION "1.00"
22 #include <linux/module.h>
23 #include <linux/types.h>
24 #include <linux/string.h>
25 #include <linux/kernel.h>
26 #include <linux/delay.h>
27 #include <linux/timer.h>
29 #include <linux/interrupt.h>
30 #include <linux/major.h>
31 #include <linux/errno.h>
32 #include <linux/genhd.h>
33 #include <linux/slab.h>
34 #include <linux/cdrom.h>
35 #include <linux/ide.h>
36 #include <linux/hdreg.h>
37 #include <linux/bitops.h>
38 #include <linux/mutex.h>
39 #include <linux/scatterlist.h>
41 #include <scsi/scsi_ioctl.h>
43 #include <asm/byteorder.h>
44 #include <linux/irq.h>
45 #include <linux/uaccess.h>
47 #include <asm/unaligned.h>
49 /* define to see debug info */
50 #define IDEFLOPPY_DEBUG_LOG 0
52 /* #define IDEFLOPPY_DEBUG(fmt, args...) printk(KERN_INFO fmt, ## args) */
53 #define IDEFLOPPY_DEBUG(fmt, args...)
55 #if IDEFLOPPY_DEBUG_LOG
56 #define debug_log(fmt, args...) \
57 printk(KERN_INFO "ide-floppy: " fmt, ## args)
59 #define debug_log(fmt, args...) do {} while (0)
63 /* Some drives require a longer irq timeout. */
64 #define IDEFLOPPY_WAIT_CMD (5 * WAIT_CMD)
67 * After each failed packet command we issue a request sense command and retry
68 * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
70 #define IDEFLOPPY_MAX_PC_RETRIES 3
72 /* format capacities descriptor codes */
73 #define CAPACITY_INVALID 0x00
74 #define CAPACITY_UNFORMATTED 0x01
75 #define CAPACITY_CURRENT 0x02
76 #define CAPACITY_NO_CARTRIDGE 0x03
79 * Most of our global data which we need to save even as we leave the driver
80 * due to an interrupt or a timer event is stored in a variable of type
81 * idefloppy_floppy_t, defined below.
83 typedef struct ide_floppy_obj {
88 unsigned int openers; /* protected by BKL for now */
90 /* Current packet command */
91 struct ide_atapi_pc *pc;
92 /* Last failed packet command */
93 struct ide_atapi_pc *failed_pc;
94 /* used for blk_{fs,pc}_request() requests */
95 struct ide_atapi_pc queued_pc;
97 struct ide_atapi_pc request_sense_pc;
98 struct request request_sense_rq;
100 /* Last error information */
101 u8 sense_key, asc, ascq;
102 /* delay this long before sending packet command */
104 int progress_indication;
106 /* Device information */
108 int blocks, block_size, bs_factor;
109 /* Last format capacity descriptor */
111 /* Copy of the flexible disk page */
112 u8 flexible_disk_page[32];
115 /* Supports format progress report */
117 } idefloppy_floppy_t;
119 #define IDEFLOPPY_TICKS_DELAY HZ/20 /* default delay for ZIP 100 (50ms) */
121 /* IOCTLs used in low-level formatting. */
122 #define IDEFLOPPY_IOCTL_FORMAT_SUPPORTED 0x4600
123 #define IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY 0x4601
124 #define IDEFLOPPY_IOCTL_FORMAT_START 0x4602
125 #define IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS 0x4603
127 /* Error code returned in rq->errors to the higher part of the driver. */
128 #define IDEFLOPPY_ERROR_GENERAL 101
131 * Pages of the SELECT SENSE / MODE SENSE packet commands.
132 * See SFF-8070i spec.
134 #define IDEFLOPPY_CAPABILITIES_PAGE 0x1b
135 #define IDEFLOPPY_FLEXIBLE_DISK_PAGE 0x05
137 static DEFINE_MUTEX(idefloppy_ref_mutex);
139 #define to_ide_floppy(obj) container_of(obj, struct ide_floppy_obj, kref)
141 #define ide_floppy_g(disk) \
142 container_of((disk)->private_data, struct ide_floppy_obj, driver)
144 static void idefloppy_cleanup_obj(struct kref *);
146 static struct ide_floppy_obj *ide_floppy_get(struct gendisk *disk)
148 struct ide_floppy_obj *floppy = NULL;
150 mutex_lock(&idefloppy_ref_mutex);
151 floppy = ide_floppy_g(disk);
153 if (ide_device_get(floppy->drive))
156 kref_get(&floppy->kref);
158 mutex_unlock(&idefloppy_ref_mutex);
162 static void ide_floppy_put(struct ide_floppy_obj *floppy)
164 ide_drive_t *drive = floppy->drive;
166 mutex_lock(&idefloppy_ref_mutex);
167 kref_put(&floppy->kref, idefloppy_cleanup_obj);
168 ide_device_put(drive);
169 mutex_unlock(&idefloppy_ref_mutex);
173 * Used to finish servicing a request. For read/write requests, we will call
174 * ide_end_request to pass to the next buffer.
176 static int idefloppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
178 idefloppy_floppy_t *floppy = drive->driver_data;
179 struct request *rq = HWGROUP(drive)->rq;
182 debug_log("Reached %s\n", __func__);
185 case 0: error = IDEFLOPPY_ERROR_GENERAL; break;
186 case 1: error = 0; break;
187 default: error = uptodate;
190 floppy->failed_pc = NULL;
191 /* Why does this happen? */
194 if (!blk_special_request(rq)) {
195 /* our real local end request function */
196 ide_end_request(drive, uptodate, nsecs);
200 /* fixme: need to move this local also */
201 ide_end_drive_cmd(drive, 0, 0);
205 static void idefloppy_update_buffers(ide_drive_t *drive,
206 struct ide_atapi_pc *pc)
208 struct request *rq = pc->rq;
209 struct bio *bio = rq->bio;
211 while ((bio = rq->bio) != NULL)
212 idefloppy_end_request(drive, 1, 0);
216 * Generate a new packet command request in front of the request queue, before
217 * the current request so that it will be processed immediately, on the next
218 * pass through the driver.
220 static void idefloppy_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
223 struct ide_floppy_obj *floppy = drive->driver_data;
225 blk_rq_init(NULL, rq);
226 rq->buffer = (char *) pc;
227 rq->cmd_type = REQ_TYPE_SPECIAL;
228 rq->cmd_flags |= REQ_PREEMPT;
229 rq->rq_disk = floppy->disk;
230 memcpy(rq->cmd, pc->c, 12);
231 ide_do_drive_cmd(drive, rq);
234 static void ide_floppy_callback(ide_drive_t *drive)
236 idefloppy_floppy_t *floppy = drive->driver_data;
237 struct ide_atapi_pc *pc = floppy->pc;
238 int uptodate = pc->error ? 0 : 1;
240 debug_log("Reached %s\n", __func__);
242 if (floppy->failed_pc == pc)
243 floppy->failed_pc = NULL;
245 if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
246 (pc->rq && blk_pc_request(pc->rq)))
247 uptodate = 1; /* FIXME */
248 else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
249 u8 *buf = floppy->pc->buf;
252 floppy->sense_key = buf[2] & 0x0F;
253 floppy->asc = buf[12];
254 floppy->ascq = buf[13];
255 floppy->progress_indication = buf[15] & 0x80 ?
256 (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
258 if (floppy->failed_pc)
259 debug_log("pc = %x, ", floppy->failed_pc->c[0]);
261 debug_log("sense key = %x, asc = %x, ascq = %x\n",
262 floppy->sense_key, floppy->asc, floppy->ascq);
264 printk(KERN_ERR "Error in REQUEST SENSE itself - "
265 "Aborting request!\n");
268 idefloppy_end_request(drive, uptodate, 0);
271 static void idefloppy_create_request_sense_cmd(struct ide_atapi_pc *pc)
274 pc->c[0] = GPCMD_REQUEST_SENSE;
280 * Called when an error was detected during the last packet command. We queue a
281 * request sense packet command in the head of the request list.
283 static void idefloppy_retry_pc(ide_drive_t *drive)
285 struct ide_floppy_obj *floppy = drive->driver_data;
286 struct request *rq = &floppy->request_sense_rq;
287 struct ide_atapi_pc *pc = &floppy->request_sense_pc;
289 (void)ide_read_error(drive);
290 idefloppy_create_request_sense_cmd(pc);
291 idefloppy_queue_pc_head(drive, pc, rq);
294 /* The usual interrupt handler called during a packet command. */
295 static ide_startstop_t idefloppy_pc_intr(ide_drive_t *drive)
297 idefloppy_floppy_t *floppy = drive->driver_data;
299 return ide_pc_intr(drive, floppy->pc, idefloppy_pc_intr,
300 IDEFLOPPY_WAIT_CMD, NULL, idefloppy_update_buffers,
301 idefloppy_retry_pc, NULL, ide_io_buffers);
305 * What we have here is a classic case of a top half / bottom half interrupt
306 * service routine. In interrupt mode, the device sends an interrupt to signal
307 * that it is ready to receive a packet. However, we need to delay about 2-3
308 * ticks before issuing the packet or we gets in trouble.
310 static int idefloppy_transfer_pc(ide_drive_t *drive)
312 idefloppy_floppy_t *floppy = drive->driver_data;
314 /* Send the actual packet */
315 drive->hwif->tp_ops->output_data(drive, NULL, floppy->pc->c, 12);
317 /* Timeout for the packet command */
318 return IDEFLOPPY_WAIT_CMD;
323 * Called as an interrupt (or directly). When the device says it's ready for a
324 * packet, we schedule the packet transfer to occur about 2-3 ticks later in
327 static ide_startstop_t idefloppy_start_pc_transfer(ide_drive_t *drive)
329 idefloppy_floppy_t *floppy = drive->driver_data;
330 struct ide_atapi_pc *pc = floppy->pc;
331 ide_expiry_t *expiry;
332 unsigned int timeout;
335 * The following delay solves a problem with ATAPI Zip 100 drives
336 * where the Busy flag was apparently being deasserted before the
337 * unit was ready to receive data. This was happening on a
338 * 1200 MHz Athlon system. 10/26/01 25msec is too short,
339 * 40 and 50msec work well. idefloppy_pc_intr will not be actually
340 * used until after the packet is moved in about 50 msec.
342 if (drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) {
343 timeout = floppy->ticks;
344 expiry = &idefloppy_transfer_pc;
346 timeout = IDEFLOPPY_WAIT_CMD;
350 return ide_transfer_pc(drive, pc, idefloppy_pc_intr, timeout, expiry);
353 static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
354 struct ide_atapi_pc *pc)
356 /* supress error messages resulting from Medium not present */
357 if (floppy->sense_key == 0x02 &&
358 floppy->asc == 0x3a &&
359 floppy->ascq == 0x00)
362 printk(KERN_ERR "ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
363 "asc = %2x, ascq = %2x\n",
364 floppy->drive->name, pc->c[0], floppy->sense_key,
365 floppy->asc, floppy->ascq);
369 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
370 struct ide_atapi_pc *pc)
372 idefloppy_floppy_t *floppy = drive->driver_data;
374 if (floppy->failed_pc == NULL &&
375 pc->c[0] != GPCMD_REQUEST_SENSE)
376 floppy->failed_pc = pc;
377 /* Set the current packet command */
380 if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
381 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
382 ide_floppy_report_error(floppy, pc);
384 pc->error = IDEFLOPPY_ERROR_GENERAL;
386 floppy->failed_pc = NULL;
387 drive->pc_callback(drive);
391 debug_log("Retry number - %d\n", pc->retries);
395 return ide_issue_pc(drive, pc, idefloppy_start_pc_transfer,
396 IDEFLOPPY_WAIT_CMD, NULL);
399 static void idefloppy_create_prevent_cmd(struct ide_atapi_pc *pc, int prevent)
401 debug_log("creating prevent removal command, prevent = %d\n", prevent);
404 pc->c[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL;
408 static void idefloppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
411 pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
417 static void idefloppy_create_format_unit_cmd(struct ide_atapi_pc *pc, int b,
421 pc->c[0] = GPCMD_FORMAT_UNIT;
424 memset(pc->buf, 0, 12);
426 /* Default format list header, u8 1: FOV/DCRT/IMM bits set */
428 if (flags & 1) /* Verify bit on... */
429 pc->buf[1] ^= 0x20; /* ... turn off DCRT bit */
432 put_unaligned(cpu_to_be32(b), (unsigned int *)(&pc->buf[4]));
433 put_unaligned(cpu_to_be32(l), (unsigned int *)(&pc->buf[8]));
435 pc->flags |= PC_FLAG_WRITING;
438 /* A mode sense command is used to "sense" floppy parameters. */
439 static void idefloppy_create_mode_sense_cmd(struct ide_atapi_pc *pc,
442 u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
445 pc->c[0] = GPCMD_MODE_SENSE_10;
447 pc->c[2] = page_code;
450 case IDEFLOPPY_CAPABILITIES_PAGE:
453 case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
457 printk(KERN_ERR "ide-floppy: unsupported page code "
458 "in create_mode_sense_cmd\n");
460 put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
461 pc->req_xfer = length;
464 static void idefloppy_create_start_stop_cmd(struct ide_atapi_pc *pc, int start)
467 pc->c[0] = GPCMD_START_STOP_UNIT;
471 static void idefloppy_create_rw_cmd(idefloppy_floppy_t *floppy,
472 struct ide_atapi_pc *pc, struct request *rq,
473 unsigned long sector)
475 int block = sector / floppy->bs_factor;
476 int blocks = rq->nr_sectors / floppy->bs_factor;
477 int cmd = rq_data_dir(rq);
479 debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
483 pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
484 put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
485 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
487 memcpy(rq->cmd, pc->c, 12);
491 if (rq->cmd_flags & REQ_RW)
492 pc->flags |= PC_FLAG_WRITING;
494 pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
495 pc->flags |= PC_FLAG_DMA_OK;
498 static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
499 struct ide_atapi_pc *pc, struct request *rq)
502 memcpy(pc->c, rq->cmd, sizeof(pc->c));
505 if (rq->data_len && rq_data_dir(rq) == WRITE)
506 pc->flags |= PC_FLAG_WRITING;
509 pc->flags |= PC_FLAG_DMA_OK;
511 * possibly problematic, doesn't look like ide-floppy correctly
512 * handled scattered requests if dma fails...
514 pc->req_xfer = pc->buf_size = rq->data_len;
517 static ide_startstop_t idefloppy_do_request(ide_drive_t *drive,
518 struct request *rq, sector_t block_s)
520 idefloppy_floppy_t *floppy = drive->driver_data;
521 ide_hwif_t *hwif = drive->hwif;
522 struct ide_atapi_pc *pc;
523 unsigned long block = (unsigned long)block_s;
525 debug_log("%s: dev: %s, cmd: 0x%x, cmd_type: %x, errors: %d\n",
526 __func__, rq->rq_disk ? rq->rq_disk->disk_name : "?",
527 rq->cmd[0], rq->cmd_type, rq->errors);
529 debug_log("%s: sector: %ld, nr_sectors: %ld, current_nr_sectors: %d\n",
530 __func__, (long)rq->sector, rq->nr_sectors,
531 rq->current_nr_sectors);
533 if (rq->errors >= ERROR_MAX) {
534 if (floppy->failed_pc)
535 ide_floppy_report_error(floppy, floppy->failed_pc);
537 printk(KERN_ERR "ide-floppy: %s: I/O error\n",
539 idefloppy_end_request(drive, 0, 0);
542 if (blk_fs_request(rq)) {
543 if (((long)rq->sector % floppy->bs_factor) ||
544 (rq->nr_sectors % floppy->bs_factor)) {
545 printk(KERN_ERR "%s: unsupported r/w request size\n",
547 idefloppy_end_request(drive, 0, 0);
550 pc = &floppy->queued_pc;
551 idefloppy_create_rw_cmd(floppy, pc, rq, block);
552 } else if (blk_special_request(rq)) {
553 pc = (struct ide_atapi_pc *) rq->buffer;
554 } else if (blk_pc_request(rq)) {
555 pc = &floppy->queued_pc;
556 idefloppy_blockpc_cmd(floppy, pc, rq);
558 blk_dump_rq_flags(rq,
559 "ide-floppy: unsupported command in queue");
560 idefloppy_end_request(drive, 0, 0);
564 ide_init_sg_cmd(drive, rq);
565 ide_map_sg(drive, rq);
567 pc->sg = hwif->sg_table;
568 pc->sg_cnt = hwif->sg_nents;
572 return idefloppy_issue_pc(drive, pc);
576 * Add a special packet command request to the tail of the request queue,
577 * and wait for it to be serviced.
579 static int idefloppy_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
581 struct ide_floppy_obj *floppy = drive->driver_data;
585 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
586 rq->buffer = (char *) pc;
587 rq->cmd_type = REQ_TYPE_SPECIAL;
588 memcpy(rq->cmd, pc->c, 12);
589 error = blk_execute_rq(drive->queue, floppy->disk, rq, 0);
596 * Look at the flexible disk page parameters. We ignore the CHS capacity
597 * parameters and use the LBA parameters instead.
599 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive)
601 idefloppy_floppy_t *floppy = drive->driver_data;
602 struct ide_atapi_pc pc;
604 int capacity, lba_capacity;
605 u16 transfer_rate, sector_size, cyls, rpm;
608 idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE);
610 if (idefloppy_queue_pc_tail(drive, &pc)) {
611 printk(KERN_ERR "ide-floppy: Can't get flexible disk page"
615 floppy->wp = !!(pc.buf[3] & 0x80);
616 set_disk_ro(floppy->disk, floppy->wp);
619 transfer_rate = be16_to_cpup((__be16 *)&pc.buf[8 + 2]);
620 sector_size = be16_to_cpup((__be16 *)&pc.buf[8 + 6]);
621 cyls = be16_to_cpup((__be16 *)&pc.buf[8 + 8]);
622 rpm = be16_to_cpup((__be16 *)&pc.buf[8 + 28]);
623 heads = pc.buf[8 + 4];
624 sectors = pc.buf[8 + 5];
626 capacity = cyls * heads * sectors * sector_size;
628 if (memcmp(page, &floppy->flexible_disk_page, 32))
629 printk(KERN_INFO "%s: %dkB, %d/%d/%d CHS, %d kBps, "
630 "%d sector size, %d rpm\n",
631 drive->name, capacity / 1024, cyls, heads,
632 sectors, transfer_rate / 8, sector_size, rpm);
634 memcpy(&floppy->flexible_disk_page, page, 32);
635 drive->bios_cyl = cyls;
636 drive->bios_head = heads;
637 drive->bios_sect = sectors;
638 lba_capacity = floppy->blocks * floppy->block_size;
640 if (capacity < lba_capacity) {
641 printk(KERN_NOTICE "%s: The disk reports a capacity of %d "
642 "bytes, but the drive only handles %d\n",
643 drive->name, lba_capacity, capacity);
644 floppy->blocks = floppy->block_size ?
645 capacity / floppy->block_size : 0;
650 static int idefloppy_get_sfrp_bit(ide_drive_t *drive)
652 idefloppy_floppy_t *floppy = drive->driver_data;
653 struct ide_atapi_pc pc;
657 idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_CAPABILITIES_PAGE);
658 pc.flags |= PC_FLAG_SUPPRESS_ERROR;
660 if (idefloppy_queue_pc_tail(drive, &pc))
663 floppy->srfp = pc.buf[8 + 2] & 0x40;
668 * Determine if a media is present in the floppy drive, and if so, its LBA
671 static int ide_floppy_get_capacity(ide_drive_t *drive)
673 idefloppy_floppy_t *floppy = drive->driver_data;
674 struct ide_atapi_pc pc;
676 u8 header_len, desc_cnt;
677 int i, rc = 1, blocks, length;
680 drive->bios_head = drive->bios_sect = 0;
682 floppy->bs_factor = 1;
683 set_capacity(floppy->disk, 0);
685 idefloppy_create_read_capacity_cmd(&pc);
686 if (idefloppy_queue_pc_tail(drive, &pc)) {
687 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
690 header_len = pc.buf[3];
691 cap_desc = &pc.buf[4];
692 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
694 for (i = 0; i < desc_cnt; i++) {
695 unsigned int desc_start = 4 + i*8;
697 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
698 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
700 debug_log("Descriptor %d: %dkB, %d blocks, %d sector size\n",
701 i, blocks * length / 1024, blocks, length);
706 * the code below is valid only for the 1st descriptor, ie i=0
709 switch (pc.buf[desc_start + 4] & 0x03) {
710 /* Clik! drive returns this instead of CAPACITY_CURRENT */
711 case CAPACITY_UNFORMATTED:
712 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
714 * If it is not a clik drive, break out
715 * (maintains previous driver behaviour)
718 case CAPACITY_CURRENT:
719 /* Normal Zip/LS-120 disks */
720 if (memcmp(cap_desc, &floppy->cap_desc, 8))
721 printk(KERN_INFO "%s: %dkB, %d blocks, %d "
722 "sector size\n", drive->name,
723 blocks * length / 1024, blocks, length);
724 memcpy(&floppy->cap_desc, cap_desc, 8);
726 if (!length || length % 512) {
727 printk(KERN_NOTICE "%s: %d bytes block size "
728 "not supported\n", drive->name, length);
730 floppy->blocks = blocks;
731 floppy->block_size = length;
732 floppy->bs_factor = length / 512;
733 if (floppy->bs_factor != 1)
734 printk(KERN_NOTICE "%s: warning: non "
735 "512 bytes block size not "
741 case CAPACITY_NO_CARTRIDGE:
743 * This is a KERN_ERR so it appears on screen
744 * for the user to see
746 printk(KERN_ERR "%s: No disk in drive\n", drive->name);
748 case CAPACITY_INVALID:
749 printk(KERN_ERR "%s: Invalid capacity for disk "
750 "in drive\n", drive->name);
753 debug_log("Descriptor 0 Code: %d\n",
754 pc.buf[desc_start + 4] & 0x03);
757 /* Clik! disk does not support get_flexible_disk_page */
758 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
759 (void) ide_floppy_get_flexible_disk_page(drive);
761 set_capacity(floppy->disk, floppy->blocks * floppy->bs_factor);
766 * Obtain the list of formattable capacities.
767 * Very similar to ide_floppy_get_capacity, except that we push the capacity
768 * descriptors to userland, instead of our own structures.
770 * Userland gives us the following structure:
772 * struct idefloppy_format_capacities {
780 * userland initializes nformats to the number of allocated formats[] records.
781 * On exit we set nformats to the number of records we've actually initialized.
784 static int ide_floppy_get_format_capacities(ide_drive_t *drive, int __user *arg)
786 struct ide_atapi_pc pc;
787 u8 header_len, desc_cnt;
788 int i, blocks, length, u_array_size, u_index;
791 if (get_user(u_array_size, arg))
794 if (u_array_size <= 0)
797 idefloppy_create_read_capacity_cmd(&pc);
798 if (idefloppy_queue_pc_tail(drive, &pc)) {
799 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
803 header_len = pc.buf[3];
804 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
810 * We always skip the first capacity descriptor. That's the current
811 * capacity. We are interested in the remaining descriptors, the
812 * formattable capacities.
814 for (i = 1; i < desc_cnt; i++) {
815 unsigned int desc_start = 4 + i*8;
817 if (u_index >= u_array_size)
818 break; /* User-supplied buffer too small */
820 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
821 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
823 if (put_user(blocks, argp))
828 if (put_user(length, argp))
836 if (put_user(u_index, arg))
843 * Get ATAPI_FORMAT_UNIT progress indication.
845 * Userland gives a pointer to an int. The int is set to a progress
846 * indicator 0-65536, with 65536=100%.
848 * If the drive does not support format progress indication, we just check
849 * the dsc bit, and return either 0 or 65536.
852 static int ide_floppy_get_format_progress(ide_drive_t *drive, int __user *arg)
854 idefloppy_floppy_t *floppy = drive->driver_data;
855 struct ide_atapi_pc pc;
856 int progress_indication = 0x10000;
859 idefloppy_create_request_sense_cmd(&pc);
860 if (idefloppy_queue_pc_tail(drive, &pc))
863 if (floppy->sense_key == 2 &&
866 progress_indication = floppy->progress_indication;
868 /* Else assume format_unit has finished, and we're at 0x10000 */
870 ide_hwif_t *hwif = drive->hwif;
874 local_irq_save(flags);
875 stat = hwif->tp_ops->read_status(hwif);
876 local_irq_restore(flags);
878 progress_indication = ((stat & ATA_DSC) == 0) ? 0 : 0x10000;
881 if (put_user(progress_indication, arg))
887 static sector_t idefloppy_capacity(ide_drive_t *drive)
889 idefloppy_floppy_t *floppy = drive->driver_data;
890 unsigned long capacity = floppy->blocks * floppy->bs_factor;
895 #ifdef CONFIG_IDE_PROC_FS
896 ide_devset_rw(bios_cyl, 0, 1023, bios_cyl);
897 ide_devset_rw(bios_head, 0, 255, bios_head);
898 ide_devset_rw(bios_sect, 0, 63, bios_sect);
900 static int get_ticks(ide_drive_t *drive)
902 idefloppy_floppy_t *floppy = drive->driver_data;
903 return floppy->ticks;
906 static int set_ticks(ide_drive_t *drive, int arg)
908 idefloppy_floppy_t *floppy = drive->driver_data;
913 IDE_DEVSET(ticks, S_RW, 0, 255, get_ticks, set_ticks);
915 static const struct ide_devset *idefloppy_settings[] = {
916 &ide_devset_bios_cyl,
917 &ide_devset_bios_head,
918 &ide_devset_bios_sect,
924 static void idefloppy_setup(ide_drive_t *drive, idefloppy_floppy_t *floppy)
929 *((u16 *)&gcw) = id[ATA_ID_CONFIG];
931 drive->pc_callback = ide_floppy_callback;
933 if (((gcw[0] & 0x60) >> 5) == 1)
934 drive->atapi_flags |= IDE_AFLAG_DRQ_INTERRUPT;
936 * We used to check revisions here. At this point however I'm giving up.
937 * Just assume they are all broken, its easier.
939 * The actual reason for the workarounds was likely a driver bug after
940 * all rather than a firmware bug, and the workaround below used to hide
941 * it. It should be fixed as of version 1.9, but to be on the safe side
942 * we'll leave the limitation below for the 2.2.x tree.
944 if (!strncmp((char *)&id[ATA_ID_PROD], "IOMEGA ZIP 100 ATAPI", 20)) {
945 drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE;
946 /* This value will be visible in the /proc/ide/hdx/settings */
947 floppy->ticks = IDEFLOPPY_TICKS_DELAY;
948 blk_queue_max_sectors(drive->queue, 64);
952 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
953 * nasty clicking noises without it, so please don't remove this.
955 if (strncmp((char *)&id[ATA_ID_PROD], "IOMEGA Clik!", 11) == 0) {
956 blk_queue_max_sectors(drive->queue, 64);
957 drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE;
960 (void) ide_floppy_get_capacity(drive);
962 ide_proc_register_driver(drive, floppy->driver);
965 static void ide_floppy_remove(ide_drive_t *drive)
967 idefloppy_floppy_t *floppy = drive->driver_data;
968 struct gendisk *g = floppy->disk;
970 ide_proc_unregister_driver(drive, floppy->driver);
974 ide_floppy_put(floppy);
977 static void idefloppy_cleanup_obj(struct kref *kref)
979 struct ide_floppy_obj *floppy = to_ide_floppy(kref);
980 ide_drive_t *drive = floppy->drive;
981 struct gendisk *g = floppy->disk;
983 drive->driver_data = NULL;
984 g->private_data = NULL;
989 #ifdef CONFIG_IDE_PROC_FS
990 static int proc_idefloppy_read_capacity(char *page, char **start, off_t off,
991 int count, int *eof, void *data)
993 ide_drive_t*drive = (ide_drive_t *)data;
996 len = sprintf(page, "%llu\n", (long long)idefloppy_capacity(drive));
997 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1000 static ide_proc_entry_t idefloppy_proc[] = {
1001 { "capacity", S_IFREG|S_IRUGO, proc_idefloppy_read_capacity, NULL },
1002 { "geometry", S_IFREG|S_IRUGO, proc_ide_read_geometry, NULL },
1003 { NULL, 0, NULL, NULL }
1005 #endif /* CONFIG_IDE_PROC_FS */
1007 static int ide_floppy_probe(ide_drive_t *);
1009 static ide_driver_t idefloppy_driver = {
1011 .owner = THIS_MODULE,
1012 .name = "ide-floppy",
1013 .bus = &ide_bus_type,
1015 .probe = ide_floppy_probe,
1016 .remove = ide_floppy_remove,
1017 .version = IDEFLOPPY_VERSION,
1018 .media = ide_floppy,
1019 .do_request = idefloppy_do_request,
1020 .end_request = idefloppy_end_request,
1021 .error = __ide_error,
1022 #ifdef CONFIG_IDE_PROC_FS
1023 .proc = idefloppy_proc,
1024 .settings = idefloppy_settings,
1028 static void ide_floppy_set_media_lock(ide_drive_t *drive, int on)
1030 struct ide_atapi_pc pc;
1032 /* IOMEGA Clik! drives do not support lock/unlock commands */
1033 if ((drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE) == 0) {
1034 idefloppy_create_prevent_cmd(&pc, on);
1035 (void)idefloppy_queue_pc_tail(drive, &pc);
1039 static int idefloppy_open(struct inode *inode, struct file *filp)
1041 struct gendisk *disk = inode->i_bdev->bd_disk;
1042 struct ide_floppy_obj *floppy;
1044 struct ide_atapi_pc pc;
1047 debug_log("Reached %s\n", __func__);
1049 floppy = ide_floppy_get(disk);
1053 drive = floppy->drive;
1057 if (floppy->openers == 1) {
1058 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1062 pc.c[0] = GPCMD_TEST_UNIT_READY;
1064 if (idefloppy_queue_pc_tail(drive, &pc)) {
1065 idefloppy_create_start_stop_cmd(&pc, 1);
1066 (void) idefloppy_queue_pc_tail(drive, &pc);
1069 if (ide_floppy_get_capacity(drive)
1070 && (filp->f_flags & O_NDELAY) == 0
1072 * Allow O_NDELAY to open a drive without a disk, or with an
1073 * unreadable disk, so that we can get the format capacity
1074 * of the drive or begin the format - Sam
1078 goto out_put_floppy;
1081 if (floppy->wp && (filp->f_mode & 2)) {
1083 goto out_put_floppy;
1086 drive->atapi_flags |= IDE_AFLAG_MEDIA_CHANGED;
1087 ide_floppy_set_media_lock(drive, 1);
1088 check_disk_change(inode->i_bdev);
1089 } else if (drive->atapi_flags & IDE_AFLAG_FORMAT_IN_PROGRESS) {
1091 goto out_put_floppy;
1097 ide_floppy_put(floppy);
1101 static int idefloppy_release(struct inode *inode, struct file *filp)
1103 struct gendisk *disk = inode->i_bdev->bd_disk;
1104 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1105 ide_drive_t *drive = floppy->drive;
1107 debug_log("Reached %s\n", __func__);
1109 if (floppy->openers == 1) {
1110 ide_floppy_set_media_lock(drive, 0);
1111 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1116 ide_floppy_put(floppy);
1121 static int idefloppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1123 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1124 ide_drive_t *drive = floppy->drive;
1126 geo->heads = drive->bios_head;
1127 geo->sectors = drive->bios_sect;
1128 geo->cylinders = (u16)drive->bios_cyl; /* truncate */
1132 static int ide_floppy_lockdoor(ide_drive_t *drive, struct ide_atapi_pc *pc,
1133 unsigned long arg, unsigned int cmd)
1135 idefloppy_floppy_t *floppy = drive->driver_data;
1136 int prevent = (arg && cmd != CDROMEJECT) ? 1 : 0;
1138 if (floppy->openers > 1)
1141 ide_floppy_set_media_lock(drive, prevent);
1143 if (cmd == CDROMEJECT) {
1144 idefloppy_create_start_stop_cmd(pc, 2);
1145 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1151 static int ide_floppy_format_unit(ide_drive_t *drive, int __user *arg)
1153 idefloppy_floppy_t *floppy = drive->driver_data;
1154 struct ide_atapi_pc pc;
1155 int blocks, length, flags, err = 0;
1157 if (floppy->openers > 1) {
1158 /* Don't format if someone is using the disk */
1159 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1163 drive->atapi_flags |= IDE_AFLAG_FORMAT_IN_PROGRESS;
1166 * Send ATAPI_FORMAT_UNIT to the drive.
1168 * Userland gives us the following structure:
1170 * struct idefloppy_format_command {
1176 * flags is a bitmask, currently, the only defined flag is:
1178 * 0x01 - verify media after format.
1180 if (get_user(blocks, arg) ||
1181 get_user(length, arg+1) ||
1182 get_user(flags, arg+2)) {
1187 (void) idefloppy_get_sfrp_bit(drive);
1188 idefloppy_create_format_unit_cmd(&pc, blocks, length, flags);
1190 if (idefloppy_queue_pc_tail(drive, &pc))
1195 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1199 static int ide_floppy_format_ioctl(ide_drive_t *drive, struct file *file,
1200 unsigned int cmd, void __user *argp)
1203 case IDEFLOPPY_IOCTL_FORMAT_SUPPORTED:
1205 case IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY:
1206 return ide_floppy_get_format_capacities(drive, argp);
1207 case IDEFLOPPY_IOCTL_FORMAT_START:
1208 if (!(file->f_mode & 2))
1210 return ide_floppy_format_unit(drive, (int __user *)argp);
1211 case IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS:
1212 return ide_floppy_get_format_progress(drive, argp);
1218 static int idefloppy_ioctl(struct inode *inode, struct file *file,
1219 unsigned int cmd, unsigned long arg)
1221 struct block_device *bdev = inode->i_bdev;
1222 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1223 ide_drive_t *drive = floppy->drive;
1224 struct ide_atapi_pc pc;
1225 void __user *argp = (void __user *)arg;
1228 if (cmd == CDROMEJECT || cmd == CDROM_LOCKDOOR)
1229 return ide_floppy_lockdoor(drive, &pc, arg, cmd);
1231 err = ide_floppy_format_ioctl(drive, file, cmd, argp);
1236 * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
1237 * and CDROM_SEND_PACKET (legacy) ioctls
1239 if (cmd != CDROM_SEND_PACKET && cmd != SCSI_IOCTL_SEND_COMMAND)
1240 err = scsi_cmd_ioctl(file, bdev->bd_disk->queue,
1241 bdev->bd_disk, cmd, argp);
1244 err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
1249 static int idefloppy_media_changed(struct gendisk *disk)
1251 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1252 ide_drive_t *drive = floppy->drive;
1255 /* do not scan partitions twice if this is a removable device */
1256 if (drive->attach) {
1260 ret = !!(drive->atapi_flags & IDE_AFLAG_MEDIA_CHANGED);
1261 drive->atapi_flags &= ~IDE_AFLAG_MEDIA_CHANGED;
1265 static int idefloppy_revalidate_disk(struct gendisk *disk)
1267 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1268 set_capacity(disk, idefloppy_capacity(floppy->drive));
1272 static struct block_device_operations idefloppy_ops = {
1273 .owner = THIS_MODULE,
1274 .open = idefloppy_open,
1275 .release = idefloppy_release,
1276 .ioctl = idefloppy_ioctl,
1277 .getgeo = idefloppy_getgeo,
1278 .media_changed = idefloppy_media_changed,
1279 .revalidate_disk = idefloppy_revalidate_disk
1282 static int ide_floppy_probe(ide_drive_t *drive)
1284 idefloppy_floppy_t *floppy;
1287 if (!strstr("ide-floppy", drive->driver_req))
1290 if (drive->media != ide_floppy)
1293 if (!ide_check_atapi_device(drive, DRV_NAME)) {
1294 printk(KERN_ERR "ide-floppy: %s: not supported by this version"
1295 " of ide-floppy\n", drive->name);
1298 floppy = kzalloc(sizeof(idefloppy_floppy_t), GFP_KERNEL);
1300 printk(KERN_ERR "ide-floppy: %s: Can't allocate a floppy"
1301 " structure\n", drive->name);
1305 g = alloc_disk(1 << PARTN_BITS);
1307 goto out_free_floppy;
1309 ide_init_disk(g, drive);
1311 kref_init(&floppy->kref);
1313 floppy->drive = drive;
1314 floppy->driver = &idefloppy_driver;
1317 g->private_data = &floppy->driver;
1319 drive->driver_data = floppy;
1321 idefloppy_setup(drive, floppy);
1323 g->minors = 1 << PARTN_BITS;
1324 g->driverfs_dev = &drive->gendev;
1325 g->flags = drive->removable ? GENHD_FL_REMOVABLE : 0;
1326 g->fops = &idefloppy_ops;
1337 static void __exit idefloppy_exit(void)
1339 driver_unregister(&idefloppy_driver.gen_driver);
1342 static int __init idefloppy_init(void)
1344 printk("ide-floppy driver " IDEFLOPPY_VERSION "\n");
1345 return driver_register(&idefloppy_driver.gen_driver);
1348 MODULE_ALIAS("ide:*m-floppy*");
1349 module_init(idefloppy_init);
1350 module_exit(idefloppy_exit);
1351 MODULE_LICENSE("GPL");
1352 MODULE_DESCRIPTION("ATAPI FLOPPY Driver");