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 IDEFLOPPY_VERSION "1.00"
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>
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>
37 #include <scsi/scsi_ioctl.h>
39 #include <asm/byteorder.h>
40 #include <linux/irq.h>
41 #include <linux/uaccess.h>
43 #include <asm/unaligned.h>
45 /* define to see debug info */
46 #define IDEFLOPPY_DEBUG_LOG 0
48 /* #define IDEFLOPPY_DEBUG(fmt, args...) printk(KERN_INFO fmt, ## args) */
49 #define IDEFLOPPY_DEBUG(fmt, args...)
51 #if IDEFLOPPY_DEBUG_LOG
52 #define debug_log(fmt, args...) \
53 printk(KERN_INFO "ide-floppy: " fmt, ## args)
55 #define debug_log(fmt, args...) do {} while (0)
59 /* Some drives require a longer irq timeout. */
60 #define IDEFLOPPY_WAIT_CMD (5 * WAIT_CMD)
63 * After each failed packet command we issue a request sense command and retry
64 * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
66 #define IDEFLOPPY_MAX_PC_RETRIES 3
69 * With each packet command, we allocate a buffer of IDEFLOPPY_PC_BUFFER_SIZE
72 #define IDEFLOPPY_PC_BUFFER_SIZE 256
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.
79 #define IDEFLOPPY_PC_STACK (10 + IDEFLOPPY_MAX_PC_RETRIES)
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
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.
92 typedef struct ide_floppy_obj {
97 unsigned int openers; /* protected by BKL for now */
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 */
107 struct request rq_stack[IDEFLOPPY_PC_STACK];
108 /* We implement a circular array */
111 /* Last error information */
112 u8 sense_key, asc, ascq;
113 /* delay this long before sending packet command */
115 int progress_indication;
117 /* Device information */
119 int blocks, block_size, bs_factor;
120 /* Last format capacity descriptor */
122 /* Copy of the flexible disk page */
123 u8 flexible_disk_page[32];
126 /* Supports format progress report */
128 /* Status/Action flags */
130 } idefloppy_floppy_t;
132 #define IDEFLOPPY_TICKS_DELAY HZ/20 /* default delay for ZIP 100 (50ms) */
134 /* Floppy flag bits values. */
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),
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
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
160 /* Error code returned in rq->errors to the higher part of the driver. */
161 #define IDEFLOPPY_ERROR_GENERAL 101
164 * Pages of the SELECT SENSE / MODE SENSE packet commands.
165 * See SFF-8070i spec.
167 #define IDEFLOPPY_CAPABILITIES_PAGE 0x1b
168 #define IDEFLOPPY_FLEXIBLE_DISK_PAGE 0x05
170 static DEFINE_MUTEX(idefloppy_ref_mutex);
172 #define to_ide_floppy(obj) container_of(obj, struct ide_floppy_obj, kref)
174 #define ide_floppy_g(disk) \
175 container_of((disk)->private_data, struct ide_floppy_obj, driver)
177 static struct ide_floppy_obj *ide_floppy_get(struct gendisk *disk)
179 struct ide_floppy_obj *floppy = NULL;
181 mutex_lock(&idefloppy_ref_mutex);
182 floppy = ide_floppy_g(disk);
184 kref_get(&floppy->kref);
185 mutex_unlock(&idefloppy_ref_mutex);
189 static void idefloppy_cleanup_obj(struct kref *);
191 static void ide_floppy_put(struct ide_floppy_obj *floppy)
193 mutex_lock(&idefloppy_ref_mutex);
194 kref_put(&floppy->kref, idefloppy_cleanup_obj);
195 mutex_unlock(&idefloppy_ref_mutex);
199 * Used to finish servicing a request. For read/write requests, we will call
200 * ide_end_request to pass to the next buffer.
202 static int idefloppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
204 idefloppy_floppy_t *floppy = drive->driver_data;
205 struct request *rq = HWGROUP(drive)->rq;
208 debug_log("Reached %s\n", __func__);
211 case 0: error = IDEFLOPPY_ERROR_GENERAL; break;
212 case 1: error = 0; break;
213 default: error = uptodate;
216 floppy->failed_pc = NULL;
217 /* Why does this happen? */
220 if (!blk_special_request(rq)) {
221 /* our real local end request function */
222 ide_end_request(drive, uptodate, nsecs);
226 /* fixme: need to move this local also */
227 ide_end_drive_cmd(drive, 0, 0);
231 static void ide_floppy_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
232 unsigned int bcount, int direction)
234 ide_hwif_t *hwif = drive->hwif;
235 struct request *rq = pc->rq;
236 struct req_iterator iter;
237 struct bio_vec *bvec;
242 rq_for_each_segment(bvec, rq, iter) {
246 count = min(bvec->bv_len, bcount);
248 data = bvec_kmap_irq(bvec, &flags);
250 hwif->output_data(drive, NULL, data, count);
252 hwif->input_data(drive, NULL, data, count);
253 bvec_kunmap_irq(data, &flags);
256 pc->b_count += count;
260 idefloppy_end_request(drive, 1, done >> 9);
263 printk(KERN_ERR "%s: leftover data in %s, bcount == %d\n",
264 drive->name, __func__, bcount);
265 ide_pad_transfer(drive, direction, bcount);
269 static void idefloppy_update_buffers(ide_drive_t *drive,
270 struct ide_atapi_pc *pc)
272 struct request *rq = pc->rq;
273 struct bio *bio = rq->bio;
275 while ((bio = rq->bio) != NULL)
276 idefloppy_end_request(drive, 1, 0);
280 * Generate a new packet command request in front of the request queue, before
281 * the current request so that it will be processed immediately, on the next
282 * pass through the driver.
284 static void idefloppy_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
287 struct ide_floppy_obj *floppy = drive->driver_data;
289 blk_rq_init(NULL, rq);
290 rq->buffer = (char *) pc;
291 rq->cmd_type = REQ_TYPE_SPECIAL;
292 rq->cmd_flags |= REQ_PREEMPT;
293 rq->rq_disk = floppy->disk;
294 ide_do_drive_cmd(drive, rq);
297 static struct ide_atapi_pc *idefloppy_next_pc_storage(ide_drive_t *drive)
299 idefloppy_floppy_t *floppy = drive->driver_data;
301 if (floppy->pc_stack_index == IDEFLOPPY_PC_STACK)
302 floppy->pc_stack_index = 0;
303 return (&floppy->pc_stack[floppy->pc_stack_index++]);
306 static struct request *idefloppy_next_rq_storage(ide_drive_t *drive)
308 idefloppy_floppy_t *floppy = drive->driver_data;
310 if (floppy->rq_stack_index == IDEFLOPPY_PC_STACK)
311 floppy->rq_stack_index = 0;
312 return (&floppy->rq_stack[floppy->rq_stack_index++]);
315 static void ide_floppy_callback(ide_drive_t *drive)
317 idefloppy_floppy_t *floppy = drive->driver_data;
318 struct ide_atapi_pc *pc = floppy->pc;
319 int uptodate = pc->error ? 0 : 1;
321 debug_log("Reached %s\n", __func__);
323 if (floppy->failed_pc == pc)
324 floppy->failed_pc = NULL;
326 if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
327 (pc->rq && blk_pc_request(pc->rq)))
328 uptodate = 1; /* FIXME */
329 else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
330 u8 *buf = floppy->pc->buf;
333 floppy->sense_key = buf[2] & 0x0F;
334 floppy->asc = buf[12];
335 floppy->ascq = buf[13];
336 floppy->progress_indication = buf[15] & 0x80 ?
337 (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
339 if (floppy->failed_pc)
340 debug_log("pc = %x, ", floppy->failed_pc->c[0]);
342 debug_log("sense key = %x, asc = %x, ascq = %x\n",
343 floppy->sense_key, floppy->asc, floppy->ascq);
345 printk(KERN_ERR "Error in REQUEST SENSE itself - "
346 "Aborting request!\n");
349 idefloppy_end_request(drive, uptodate, 0);
352 static void idefloppy_init_pc(struct ide_atapi_pc *pc)
354 memset(pc->c, 0, 12);
358 pc->buf = pc->pc_buf;
359 pc->buf_size = IDEFLOPPY_PC_BUFFER_SIZE;
360 pc->callback = ide_floppy_callback;
363 static void idefloppy_create_request_sense_cmd(struct ide_atapi_pc *pc)
365 idefloppy_init_pc(pc);
366 pc->c[0] = GPCMD_REQUEST_SENSE;
372 * Called when an error was detected during the last packet command. We queue a
373 * request sense packet command in the head of the request list.
375 static void idefloppy_retry_pc(ide_drive_t *drive)
377 struct ide_atapi_pc *pc;
380 (void)ide_read_error(drive);
381 pc = idefloppy_next_pc_storage(drive);
382 rq = idefloppy_next_rq_storage(drive);
383 idefloppy_create_request_sense_cmd(pc);
384 idefloppy_queue_pc_head(drive, pc, rq);
387 /* The usual interrupt handler called during a packet command. */
388 static ide_startstop_t idefloppy_pc_intr(ide_drive_t *drive)
390 idefloppy_floppy_t *floppy = drive->driver_data;
392 return ide_pc_intr(drive, floppy->pc, idefloppy_pc_intr,
393 IDEFLOPPY_WAIT_CMD, NULL, idefloppy_update_buffers,
394 idefloppy_retry_pc, NULL, ide_floppy_io_buffers);
398 * What we have here is a classic case of a top half / bottom half interrupt
399 * service routine. In interrupt mode, the device sends an interrupt to signal
400 * that it is ready to receive a packet. However, we need to delay about 2-3
401 * ticks before issuing the packet or we gets in trouble.
403 * So, follow carefully. transfer_pc1 is called as an interrupt (or directly).
404 * In either case, when the device says it's ready for a packet, we schedule
405 * the packet transfer to occur about 2-3 ticks later in transfer_pc2.
407 static int idefloppy_transfer_pc2(ide_drive_t *drive)
409 idefloppy_floppy_t *floppy = drive->driver_data;
411 /* Send the actual packet */
412 drive->hwif->output_data(drive, NULL, floppy->pc->c, 12);
414 /* Timeout for the packet command */
415 return IDEFLOPPY_WAIT_CMD;
418 static ide_startstop_t idefloppy_transfer_pc1(ide_drive_t *drive)
420 idefloppy_floppy_t *floppy = drive->driver_data;
421 struct ide_atapi_pc *pc = floppy->pc;
422 ide_expiry_t *expiry;
423 unsigned int timeout;
426 * The following delay solves a problem with ATAPI Zip 100 drives
427 * where the Busy flag was apparently being deasserted before the
428 * unit was ready to receive data. This was happening on a
429 * 1200 MHz Athlon system. 10/26/01 25msec is too short,
430 * 40 and 50msec work well. idefloppy_pc_intr will not be actually
431 * used until after the packet is moved in about 50 msec.
433 if (pc->flags & PC_FLAG_ZIP_DRIVE) {
434 timeout = floppy->ticks;
435 expiry = &idefloppy_transfer_pc2;
437 timeout = IDEFLOPPY_WAIT_CMD;
441 return ide_transfer_pc(drive, pc, idefloppy_pc_intr, timeout, expiry);
444 static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
445 struct ide_atapi_pc *pc)
447 /* supress error messages resulting from Medium not present */
448 if (floppy->sense_key == 0x02 &&
449 floppy->asc == 0x3a &&
450 floppy->ascq == 0x00)
453 printk(KERN_ERR "ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
454 "asc = %2x, ascq = %2x\n",
455 floppy->drive->name, pc->c[0], floppy->sense_key,
456 floppy->asc, floppy->ascq);
460 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
461 struct ide_atapi_pc *pc)
463 idefloppy_floppy_t *floppy = drive->driver_data;
465 if (floppy->failed_pc == NULL &&
466 pc->c[0] != GPCMD_REQUEST_SENSE)
467 floppy->failed_pc = pc;
468 /* Set the current packet command */
471 if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
472 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
473 ide_floppy_report_error(floppy, pc);
475 pc->error = IDEFLOPPY_ERROR_GENERAL;
477 floppy->failed_pc = NULL;
482 debug_log("Retry number - %d\n", pc->retries);
486 return ide_issue_pc(drive, pc, idefloppy_transfer_pc1,
487 IDEFLOPPY_WAIT_CMD, NULL);
490 static void idefloppy_create_prevent_cmd(struct ide_atapi_pc *pc, int prevent)
492 debug_log("creating prevent removal command, prevent = %d\n", prevent);
494 idefloppy_init_pc(pc);
495 pc->c[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL;
499 static void idefloppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
501 idefloppy_init_pc(pc);
502 pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
508 static void idefloppy_create_format_unit_cmd(struct ide_atapi_pc *pc, int b,
511 idefloppy_init_pc(pc);
512 pc->c[0] = GPCMD_FORMAT_UNIT;
515 memset(pc->buf, 0, 12);
517 /* Default format list header, u8 1: FOV/DCRT/IMM bits set */
519 if (flags & 1) /* Verify bit on... */
520 pc->buf[1] ^= 0x20; /* ... turn off DCRT bit */
523 put_unaligned(cpu_to_be32(b), (unsigned int *)(&pc->buf[4]));
524 put_unaligned(cpu_to_be32(l), (unsigned int *)(&pc->buf[8]));
526 pc->flags |= PC_FLAG_WRITING;
529 /* A mode sense command is used to "sense" floppy parameters. */
530 static void idefloppy_create_mode_sense_cmd(struct ide_atapi_pc *pc,
531 u8 page_code, u8 type)
533 u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
535 idefloppy_init_pc(pc);
536 pc->c[0] = GPCMD_MODE_SENSE_10;
538 pc->c[2] = page_code + (type << 6);
541 case IDEFLOPPY_CAPABILITIES_PAGE:
544 case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
548 printk(KERN_ERR "ide-floppy: unsupported page code "
549 "in create_mode_sense_cmd\n");
551 put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
552 pc->req_xfer = length;
555 static void idefloppy_create_start_stop_cmd(struct ide_atapi_pc *pc, int start)
557 idefloppy_init_pc(pc);
558 pc->c[0] = GPCMD_START_STOP_UNIT;
562 static void idefloppy_create_test_unit_ready_cmd(struct ide_atapi_pc *pc)
564 idefloppy_init_pc(pc);
565 pc->c[0] = GPCMD_TEST_UNIT_READY;
568 static void idefloppy_create_rw_cmd(idefloppy_floppy_t *floppy,
569 struct ide_atapi_pc *pc, struct request *rq,
570 unsigned long sector)
572 int block = sector / floppy->bs_factor;
573 int blocks = rq->nr_sectors / floppy->bs_factor;
574 int cmd = rq_data_dir(rq);
576 debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
579 idefloppy_init_pc(pc);
580 pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
581 put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
582 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
585 pc->b_count = cmd == READ ? 0 : rq->bio->bi_size;
586 if (rq->cmd_flags & REQ_RW)
587 pc->flags |= PC_FLAG_WRITING;
589 pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
590 pc->flags |= PC_FLAG_DMA_OK;
593 static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
594 struct ide_atapi_pc *pc, struct request *rq)
596 idefloppy_init_pc(pc);
597 memcpy(pc->c, rq->cmd, sizeof(pc->c));
599 pc->b_count = rq->data_len;
600 if (rq->data_len && rq_data_dir(rq) == WRITE)
601 pc->flags |= PC_FLAG_WRITING;
604 pc->flags |= PC_FLAG_DMA_OK;
606 * possibly problematic, doesn't look like ide-floppy correctly
607 * handled scattered requests if dma fails...
609 pc->req_xfer = pc->buf_size = rq->data_len;
612 static ide_startstop_t idefloppy_do_request(ide_drive_t *drive,
613 struct request *rq, sector_t block_s)
615 idefloppy_floppy_t *floppy = drive->driver_data;
616 struct ide_atapi_pc *pc;
617 unsigned long block = (unsigned long)block_s;
619 debug_log("dev: %s, cmd_type: %x, errors: %d\n",
620 rq->rq_disk ? rq->rq_disk->disk_name : "?",
621 rq->cmd_type, rq->errors);
622 debug_log("sector: %ld, nr_sectors: %ld, "
623 "current_nr_sectors: %d\n", (long)rq->sector,
624 rq->nr_sectors, rq->current_nr_sectors);
626 if (rq->errors >= ERROR_MAX) {
627 if (floppy->failed_pc)
628 ide_floppy_report_error(floppy, floppy->failed_pc);
630 printk(KERN_ERR "ide-floppy: %s: I/O error\n",
632 idefloppy_end_request(drive, 0, 0);
635 if (blk_fs_request(rq)) {
636 if (((long)rq->sector % floppy->bs_factor) ||
637 (rq->nr_sectors % floppy->bs_factor)) {
638 printk(KERN_ERR "%s: unsupported r/w request size\n",
640 idefloppy_end_request(drive, 0, 0);
643 pc = idefloppy_next_pc_storage(drive);
644 idefloppy_create_rw_cmd(floppy, pc, rq, block);
645 } else if (blk_special_request(rq)) {
646 pc = (struct ide_atapi_pc *) rq->buffer;
647 } else if (blk_pc_request(rq)) {
648 pc = idefloppy_next_pc_storage(drive);
649 idefloppy_blockpc_cmd(floppy, pc, rq);
651 blk_dump_rq_flags(rq,
652 "ide-floppy: unsupported command in queue");
653 idefloppy_end_request(drive, 0, 0);
657 if (floppy->flags & IDEFLOPPY_FLAG_DRQ_INTERRUPT)
658 pc->flags |= PC_FLAG_DRQ_INTERRUPT;
660 if (floppy->flags & IDEFLOPPY_FLAG_ZIP_DRIVE)
661 pc->flags |= PC_FLAG_ZIP_DRIVE;
665 return idefloppy_issue_pc(drive, pc);
669 * Add a special packet command request to the tail of the request queue,
670 * and wait for it to be serviced.
672 static int idefloppy_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
674 struct ide_floppy_obj *floppy = drive->driver_data;
678 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
679 rq->buffer = (char *) pc;
680 rq->cmd_type = REQ_TYPE_SPECIAL;
681 error = blk_execute_rq(drive->queue, floppy->disk, rq, 0);
688 * Look at the flexible disk page parameters. We ignore the CHS capacity
689 * parameters and use the LBA parameters instead.
691 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive)
693 idefloppy_floppy_t *floppy = drive->driver_data;
694 struct ide_atapi_pc pc;
696 int capacity, lba_capacity;
697 u16 transfer_rate, sector_size, cyls, rpm;
700 idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE,
703 if (idefloppy_queue_pc_tail(drive, &pc)) {
704 printk(KERN_ERR "ide-floppy: Can't get flexible disk page"
708 floppy->wp = !!(pc.buf[3] & 0x80);
709 set_disk_ro(floppy->disk, floppy->wp);
712 transfer_rate = be16_to_cpu(*(u16 *)&pc.buf[8 + 2]);
713 sector_size = be16_to_cpu(*(u16 *)&pc.buf[8 + 6]);
714 cyls = be16_to_cpu(*(u16 *)&pc.buf[8 + 8]);
715 rpm = be16_to_cpu(*(u16 *)&pc.buf[8 + 28]);
716 heads = pc.buf[8 + 4];
717 sectors = pc.buf[8 + 5];
719 capacity = cyls * heads * sectors * sector_size;
721 if (memcmp(page, &floppy->flexible_disk_page, 32))
722 printk(KERN_INFO "%s: %dkB, %d/%d/%d CHS, %d kBps, "
723 "%d sector size, %d rpm\n",
724 drive->name, capacity / 1024, cyls, heads,
725 sectors, transfer_rate / 8, sector_size, rpm);
727 memcpy(&floppy->flexible_disk_page, page, 32);
728 drive->bios_cyl = cyls;
729 drive->bios_head = heads;
730 drive->bios_sect = sectors;
731 lba_capacity = floppy->blocks * floppy->block_size;
733 if (capacity < lba_capacity) {
734 printk(KERN_NOTICE "%s: The disk reports a capacity of %d "
735 "bytes, but the drive only handles %d\n",
736 drive->name, lba_capacity, capacity);
737 floppy->blocks = floppy->block_size ?
738 capacity / floppy->block_size : 0;
743 static int idefloppy_get_sfrp_bit(ide_drive_t *drive)
745 idefloppy_floppy_t *floppy = drive->driver_data;
746 struct ide_atapi_pc pc;
749 idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_CAPABILITIES_PAGE,
752 pc.flags |= PC_FLAG_SUPPRESS_ERROR;
753 if (idefloppy_queue_pc_tail(drive, &pc))
756 floppy->srfp = pc.buf[8 + 2] & 0x40;
761 * Determine if a media is present in the floppy drive, and if so, its LBA
764 static int ide_floppy_get_capacity(ide_drive_t *drive)
766 idefloppy_floppy_t *floppy = drive->driver_data;
767 struct ide_atapi_pc pc;
769 u8 header_len, desc_cnt;
770 int i, rc = 1, blocks, length;
773 drive->bios_head = drive->bios_sect = 0;
775 floppy->bs_factor = 1;
776 set_capacity(floppy->disk, 0);
778 idefloppy_create_read_capacity_cmd(&pc);
779 if (idefloppy_queue_pc_tail(drive, &pc)) {
780 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
783 header_len = pc.buf[3];
784 cap_desc = &pc.buf[4];
785 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
787 for (i = 0; i < desc_cnt; i++) {
788 unsigned int desc_start = 4 + i*8;
790 blocks = be32_to_cpu(*(u32 *)&pc.buf[desc_start]);
791 length = be16_to_cpu(*(u16 *)&pc.buf[desc_start + 6]);
793 debug_log("Descriptor %d: %dkB, %d blocks, %d sector size\n",
794 i, blocks * length / 1024, blocks, length);
799 * the code below is valid only for the 1st descriptor, ie i=0
802 switch (pc.buf[desc_start + 4] & 0x03) {
803 /* Clik! drive returns this instead of CAPACITY_CURRENT */
804 case CAPACITY_UNFORMATTED:
805 if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE))
807 * If it is not a clik drive, break out
808 * (maintains previous driver behaviour)
811 case CAPACITY_CURRENT:
812 /* Normal Zip/LS-120 disks */
813 if (memcmp(cap_desc, &floppy->cap_desc, 8))
814 printk(KERN_INFO "%s: %dkB, %d blocks, %d "
815 "sector size\n", drive->name,
816 blocks * length / 1024, blocks, length);
817 memcpy(&floppy->cap_desc, cap_desc, 8);
819 if (!length || length % 512) {
820 printk(KERN_NOTICE "%s: %d bytes block size "
821 "not supported\n", drive->name, length);
823 floppy->blocks = blocks;
824 floppy->block_size = length;
825 floppy->bs_factor = length / 512;
826 if (floppy->bs_factor != 1)
827 printk(KERN_NOTICE "%s: warning: non "
828 "512 bytes block size not "
834 case CAPACITY_NO_CARTRIDGE:
836 * This is a KERN_ERR so it appears on screen
837 * for the user to see
839 printk(KERN_ERR "%s: No disk in drive\n", drive->name);
841 case CAPACITY_INVALID:
842 printk(KERN_ERR "%s: Invalid capacity for disk "
843 "in drive\n", drive->name);
846 debug_log("Descriptor 0 Code: %d\n",
847 pc.buf[desc_start + 4] & 0x03);
850 /* Clik! disk does not support get_flexible_disk_page */
851 if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE))
852 (void) ide_floppy_get_flexible_disk_page(drive);
854 set_capacity(floppy->disk, floppy->blocks * floppy->bs_factor);
859 * Obtain the list of formattable capacities.
860 * Very similar to ide_floppy_get_capacity, except that we push the capacity
861 * descriptors to userland, instead of our own structures.
863 * Userland gives us the following structure:
865 * struct idefloppy_format_capacities {
873 * userland initializes nformats to the number of allocated formats[] records.
874 * On exit we set nformats to the number of records we've actually initialized.
877 static int ide_floppy_get_format_capacities(ide_drive_t *drive, int __user *arg)
879 struct ide_atapi_pc pc;
880 u8 header_len, desc_cnt;
881 int i, blocks, length, u_array_size, u_index;
884 if (get_user(u_array_size, arg))
887 if (u_array_size <= 0)
890 idefloppy_create_read_capacity_cmd(&pc);
891 if (idefloppy_queue_pc_tail(drive, &pc)) {
892 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
895 header_len = pc.buf[3];
896 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
902 * We always skip the first capacity descriptor. That's the current
903 * capacity. We are interested in the remaining descriptors, the
904 * formattable capacities.
906 for (i = 1; i < desc_cnt; i++) {
907 unsigned int desc_start = 4 + i*8;
909 if (u_index >= u_array_size)
910 break; /* User-supplied buffer too small */
912 blocks = be32_to_cpu(*(u32 *)&pc.buf[desc_start]);
913 length = be16_to_cpu(*(u16 *)&pc.buf[desc_start + 6]);
915 if (put_user(blocks, argp))
919 if (put_user(length, argp))
926 if (put_user(u_index, arg))
932 * Get ATAPI_FORMAT_UNIT progress indication.
934 * Userland gives a pointer to an int. The int is set to a progress
935 * indicator 0-65536, with 65536=100%.
937 * If the drive does not support format progress indication, we just check
938 * the dsc bit, and return either 0 or 65536.
941 static int idefloppy_get_format_progress(ide_drive_t *drive, int __user *arg)
943 idefloppy_floppy_t *floppy = drive->driver_data;
944 struct ide_atapi_pc pc;
945 int progress_indication = 0x10000;
948 idefloppy_create_request_sense_cmd(&pc);
949 if (idefloppy_queue_pc_tail(drive, &pc))
952 if (floppy->sense_key == 2 &&
955 progress_indication = floppy->progress_indication;
957 /* Else assume format_unit has finished, and we're at 0x10000 */
962 local_irq_save(flags);
963 stat = ide_read_status(drive);
964 local_irq_restore(flags);
966 progress_indication = ((stat & SEEK_STAT) == 0) ? 0 : 0x10000;
968 if (put_user(progress_indication, arg))
974 static sector_t idefloppy_capacity(ide_drive_t *drive)
976 idefloppy_floppy_t *floppy = drive->driver_data;
977 unsigned long capacity = floppy->blocks * floppy->bs_factor;
983 * Check whether we can support a drive, based on the ATAPI IDENTIFY command
986 static int idefloppy_identify_device(ide_drive_t *drive, struct hd_driveid *id)
989 u8 device_type, protocol, removable, drq_type, packet_size;
991 *((u16 *) &gcw) = id->config;
993 device_type = gcw[1] & 0x1F;
994 removable = (gcw[0] & 0x80) >> 7;
995 protocol = (gcw[1] & 0xC0) >> 6;
996 drq_type = (gcw[0] & 0x60) >> 5;
997 packet_size = gcw[0] & 0x03;
1000 /* kludge for Apple PowerBook internal zip */
1001 if (device_type == 5 &&
1002 !strstr(id->model, "CD-ROM") && strstr(id->model, "ZIP"))
1007 printk(KERN_ERR "ide-floppy: Protocol (0x%02x) is not ATAPI\n",
1009 else if (device_type != 0)
1010 printk(KERN_ERR "ide-floppy: Device type (0x%02x) is not set "
1011 "to floppy\n", device_type);
1012 else if (!removable)
1013 printk(KERN_ERR "ide-floppy: The removable flag is not set\n");
1014 else if (drq_type == 3)
1015 printk(KERN_ERR "ide-floppy: Sorry, DRQ type (0x%02x) not "
1016 "supported\n", drq_type);
1017 else if (packet_size != 0)
1018 printk(KERN_ERR "ide-floppy: Packet size (0x%02x) is not 12 "
1019 "bytes\n", packet_size);
1025 #ifdef CONFIG_IDE_PROC_FS
1026 static void idefloppy_add_settings(ide_drive_t *drive)
1028 idefloppy_floppy_t *floppy = drive->driver_data;
1030 ide_add_setting(drive, "bios_cyl", SETTING_RW, TYPE_INT, 0, 1023, 1, 1,
1031 &drive->bios_cyl, NULL);
1032 ide_add_setting(drive, "bios_head", SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1033 &drive->bios_head, NULL);
1034 ide_add_setting(drive, "bios_sect", SETTING_RW, TYPE_BYTE, 0, 63, 1, 1,
1035 &drive->bios_sect, NULL);
1036 ide_add_setting(drive, "ticks", SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1037 &floppy->ticks, NULL);
1040 static inline void idefloppy_add_settings(ide_drive_t *drive) { ; }
1043 static void idefloppy_setup(ide_drive_t *drive, idefloppy_floppy_t *floppy)
1047 *((u16 *) &gcw) = drive->id->config;
1048 floppy->pc = floppy->pc_stack;
1050 if (((gcw[0] & 0x60) >> 5) == 1)
1051 floppy->flags |= IDEFLOPPY_FLAG_DRQ_INTERRUPT;
1053 * We used to check revisions here. At this point however I'm giving up.
1054 * Just assume they are all broken, its easier.
1056 * The actual reason for the workarounds was likely a driver bug after
1057 * all rather than a firmware bug, and the workaround below used to hide
1058 * it. It should be fixed as of version 1.9, but to be on the safe side
1059 * we'll leave the limitation below for the 2.2.x tree.
1061 if (!strncmp(drive->id->model, "IOMEGA ZIP 100 ATAPI", 20)) {
1062 floppy->flags |= IDEFLOPPY_FLAG_ZIP_DRIVE;
1063 /* This value will be visible in the /proc/ide/hdx/settings */
1064 floppy->ticks = IDEFLOPPY_TICKS_DELAY;
1065 blk_queue_max_sectors(drive->queue, 64);
1069 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
1070 * nasty clicking noises without it, so please don't remove this.
1072 if (strncmp(drive->id->model, "IOMEGA Clik!", 11) == 0) {
1073 blk_queue_max_sectors(drive->queue, 64);
1074 floppy->flags |= IDEFLOPPY_FLAG_CLIK_DRIVE;
1077 (void) ide_floppy_get_capacity(drive);
1078 idefloppy_add_settings(drive);
1081 static void ide_floppy_remove(ide_drive_t *drive)
1083 idefloppy_floppy_t *floppy = drive->driver_data;
1084 struct gendisk *g = floppy->disk;
1086 ide_proc_unregister_driver(drive, floppy->driver);
1090 ide_floppy_put(floppy);
1093 static void idefloppy_cleanup_obj(struct kref *kref)
1095 struct ide_floppy_obj *floppy = to_ide_floppy(kref);
1096 ide_drive_t *drive = floppy->drive;
1097 struct gendisk *g = floppy->disk;
1099 drive->driver_data = NULL;
1100 g->private_data = NULL;
1105 #ifdef CONFIG_IDE_PROC_FS
1106 static int proc_idefloppy_read_capacity(char *page, char **start, off_t off,
1107 int count, int *eof, void *data)
1109 ide_drive_t*drive = (ide_drive_t *)data;
1112 len = sprintf(page, "%llu\n", (long long)idefloppy_capacity(drive));
1113 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1116 static ide_proc_entry_t idefloppy_proc[] = {
1117 { "capacity", S_IFREG|S_IRUGO, proc_idefloppy_read_capacity, NULL },
1118 { "geometry", S_IFREG|S_IRUGO, proc_ide_read_geometry, NULL },
1119 { NULL, 0, NULL, NULL }
1121 #endif /* CONFIG_IDE_PROC_FS */
1123 static int ide_floppy_probe(ide_drive_t *);
1125 static ide_driver_t idefloppy_driver = {
1127 .owner = THIS_MODULE,
1128 .name = "ide-floppy",
1129 .bus = &ide_bus_type,
1131 .probe = ide_floppy_probe,
1132 .remove = ide_floppy_remove,
1133 .version = IDEFLOPPY_VERSION,
1134 .media = ide_floppy,
1135 .supports_dsc_overlap = 0,
1136 .do_request = idefloppy_do_request,
1137 .end_request = idefloppy_end_request,
1138 .error = __ide_error,
1139 .abort = __ide_abort,
1140 #ifdef CONFIG_IDE_PROC_FS
1141 .proc = idefloppy_proc,
1145 static int idefloppy_open(struct inode *inode, struct file *filp)
1147 struct gendisk *disk = inode->i_bdev->bd_disk;
1148 struct ide_floppy_obj *floppy;
1150 struct ide_atapi_pc pc;
1153 debug_log("Reached %s\n", __func__);
1155 floppy = ide_floppy_get(disk);
1159 drive = floppy->drive;
1163 if (floppy->openers == 1) {
1164 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1167 idefloppy_create_test_unit_ready_cmd(&pc);
1168 if (idefloppy_queue_pc_tail(drive, &pc)) {
1169 idefloppy_create_start_stop_cmd(&pc, 1);
1170 (void) idefloppy_queue_pc_tail(drive, &pc);
1173 if (ide_floppy_get_capacity(drive)
1174 && (filp->f_flags & O_NDELAY) == 0
1176 * Allow O_NDELAY to open a drive without a disk, or with an
1177 * unreadable disk, so that we can get the format capacity
1178 * of the drive or begin the format - Sam
1182 goto out_put_floppy;
1185 if (floppy->wp && (filp->f_mode & 2)) {
1187 goto out_put_floppy;
1189 floppy->flags |= IDEFLOPPY_FLAG_MEDIA_CHANGED;
1190 /* IOMEGA Clik! drives do not support lock/unlock commands */
1191 if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1192 idefloppy_create_prevent_cmd(&pc, 1);
1193 (void) idefloppy_queue_pc_tail(drive, &pc);
1195 check_disk_change(inode->i_bdev);
1196 } else if (floppy->flags & IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS) {
1198 goto out_put_floppy;
1204 ide_floppy_put(floppy);
1208 static int idefloppy_release(struct inode *inode, struct file *filp)
1210 struct gendisk *disk = inode->i_bdev->bd_disk;
1211 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1212 ide_drive_t *drive = floppy->drive;
1213 struct ide_atapi_pc pc;
1215 debug_log("Reached %s\n", __func__);
1217 if (floppy->openers == 1) {
1218 /* IOMEGA Clik! drives do not support lock/unlock commands */
1219 if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1220 idefloppy_create_prevent_cmd(&pc, 0);
1221 (void) idefloppy_queue_pc_tail(drive, &pc);
1224 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1229 ide_floppy_put(floppy);
1234 static int idefloppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1236 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1237 ide_drive_t *drive = floppy->drive;
1239 geo->heads = drive->bios_head;
1240 geo->sectors = drive->bios_sect;
1241 geo->cylinders = (u16)drive->bios_cyl; /* truncate */
1245 static int ide_floppy_lockdoor(idefloppy_floppy_t *floppy,
1246 struct ide_atapi_pc *pc, unsigned long arg, unsigned int cmd)
1248 if (floppy->openers > 1)
1251 /* The IOMEGA Clik! Drive doesn't support this command -
1252 * no room for an eject mechanism */
1253 if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1254 int prevent = arg ? 1 : 0;
1256 if (cmd == CDROMEJECT)
1259 idefloppy_create_prevent_cmd(pc, prevent);
1260 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1263 if (cmd == CDROMEJECT) {
1264 idefloppy_create_start_stop_cmd(pc, 2);
1265 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1271 static int ide_floppy_format_unit(idefloppy_floppy_t *floppy,
1274 int blocks, length, flags, err = 0;
1275 struct ide_atapi_pc pc;
1277 if (floppy->openers > 1) {
1278 /* Don't format if someone is using the disk */
1279 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1283 floppy->flags |= IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1286 * Send ATAPI_FORMAT_UNIT to the drive.
1288 * Userland gives us the following structure:
1290 * struct idefloppy_format_command {
1296 * flags is a bitmask, currently, the only defined flag is:
1298 * 0x01 - verify media after format.
1300 if (get_user(blocks, arg) ||
1301 get_user(length, arg+1) ||
1302 get_user(flags, arg+2)) {
1307 (void) idefloppy_get_sfrp_bit(floppy->drive);
1308 idefloppy_create_format_unit_cmd(&pc, blocks, length, flags);
1310 if (idefloppy_queue_pc_tail(floppy->drive, &pc))
1315 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1320 static int idefloppy_ioctl(struct inode *inode, struct file *file,
1321 unsigned int cmd, unsigned long arg)
1323 struct block_device *bdev = inode->i_bdev;
1324 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1325 ide_drive_t *drive = floppy->drive;
1326 struct ide_atapi_pc pc;
1327 void __user *argp = (void __user *)arg;
1333 case CDROM_LOCKDOOR:
1334 return ide_floppy_lockdoor(floppy, &pc, arg, cmd);
1335 case IDEFLOPPY_IOCTL_FORMAT_SUPPORTED:
1337 case IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY:
1338 return ide_floppy_get_format_capacities(drive, argp);
1339 case IDEFLOPPY_IOCTL_FORMAT_START:
1340 if (!(file->f_mode & 2))
1343 return ide_floppy_format_unit(floppy, (int __user *)arg);
1344 case IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS:
1345 return idefloppy_get_format_progress(drive, argp);
1349 * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
1350 * and CDROM_SEND_PACKET (legacy) ioctls
1352 if (cmd != CDROM_SEND_PACKET && cmd != SCSI_IOCTL_SEND_COMMAND)
1353 err = scsi_cmd_ioctl(file, bdev->bd_disk->queue,
1354 bdev->bd_disk, cmd, argp);
1359 err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
1364 static int idefloppy_media_changed(struct gendisk *disk)
1366 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1367 ide_drive_t *drive = floppy->drive;
1370 /* do not scan partitions twice if this is a removable device */
1371 if (drive->attach) {
1375 ret = !!(floppy->flags & IDEFLOPPY_FLAG_MEDIA_CHANGED);
1376 floppy->flags &= ~IDEFLOPPY_FLAG_MEDIA_CHANGED;
1380 static int idefloppy_revalidate_disk(struct gendisk *disk)
1382 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1383 set_capacity(disk, idefloppy_capacity(floppy->drive));
1387 static struct block_device_operations idefloppy_ops = {
1388 .owner = THIS_MODULE,
1389 .open = idefloppy_open,
1390 .release = idefloppy_release,
1391 .ioctl = idefloppy_ioctl,
1392 .getgeo = idefloppy_getgeo,
1393 .media_changed = idefloppy_media_changed,
1394 .revalidate_disk = idefloppy_revalidate_disk
1397 static int ide_floppy_probe(ide_drive_t *drive)
1399 idefloppy_floppy_t *floppy;
1402 if (!strstr("ide-floppy", drive->driver_req))
1404 if (!drive->present)
1406 if (drive->media != ide_floppy)
1408 if (!idefloppy_identify_device(drive, drive->id)) {
1409 printk(KERN_ERR "ide-floppy: %s: not supported by this version"
1410 " of ide-floppy\n", drive->name);
1413 floppy = kzalloc(sizeof(idefloppy_floppy_t), GFP_KERNEL);
1415 printk(KERN_ERR "ide-floppy: %s: Can't allocate a floppy"
1416 " structure\n", drive->name);
1420 g = alloc_disk(1 << PARTN_BITS);
1422 goto out_free_floppy;
1424 ide_init_disk(g, drive);
1426 ide_proc_register_driver(drive, &idefloppy_driver);
1428 kref_init(&floppy->kref);
1430 floppy->drive = drive;
1431 floppy->driver = &idefloppy_driver;
1434 g->private_data = &floppy->driver;
1436 drive->driver_data = floppy;
1438 idefloppy_setup(drive, floppy);
1440 g->minors = 1 << PARTN_BITS;
1441 g->driverfs_dev = &drive->gendev;
1442 g->flags = drive->removable ? GENHD_FL_REMOVABLE : 0;
1443 g->fops = &idefloppy_ops;
1454 static void __exit idefloppy_exit(void)
1456 driver_unregister(&idefloppy_driver.gen_driver);
1459 static int __init idefloppy_init(void)
1461 printk("ide-floppy driver " IDEFLOPPY_VERSION "\n");
1462 return driver_register(&idefloppy_driver.gen_driver);
1465 MODULE_ALIAS("ide:*m-floppy*");
1466 module_init(idefloppy_init);
1467 module_exit(idefloppy_exit);
1468 MODULE_LICENSE("GPL");
1469 MODULE_DESCRIPTION("ATAPI FLOPPY Driver");