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 } idefloppy_floppy_t;
130 #define IDEFLOPPY_TICKS_DELAY HZ/20 /* default delay for ZIP 100 (50ms) */
132 /* Defines for the MODE SENSE command */
133 #define MODE_SENSE_CURRENT 0x00
134 #define MODE_SENSE_CHANGEABLE 0x01
135 #define MODE_SENSE_DEFAULT 0x02
136 #define MODE_SENSE_SAVED 0x03
138 /* IOCTLs used in low-level formatting. */
139 #define IDEFLOPPY_IOCTL_FORMAT_SUPPORTED 0x4600
140 #define IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY 0x4601
141 #define IDEFLOPPY_IOCTL_FORMAT_START 0x4602
142 #define IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS 0x4603
144 /* Error code returned in rq->errors to the higher part of the driver. */
145 #define IDEFLOPPY_ERROR_GENERAL 101
148 * Pages of the SELECT SENSE / MODE SENSE packet commands.
149 * See SFF-8070i spec.
151 #define IDEFLOPPY_CAPABILITIES_PAGE 0x1b
152 #define IDEFLOPPY_FLEXIBLE_DISK_PAGE 0x05
154 static DEFINE_MUTEX(idefloppy_ref_mutex);
156 #define to_ide_floppy(obj) container_of(obj, struct ide_floppy_obj, kref)
158 #define ide_floppy_g(disk) \
159 container_of((disk)->private_data, struct ide_floppy_obj, driver)
161 static void idefloppy_cleanup_obj(struct kref *);
163 static struct ide_floppy_obj *ide_floppy_get(struct gendisk *disk)
165 struct ide_floppy_obj *floppy = NULL;
167 mutex_lock(&idefloppy_ref_mutex);
168 floppy = ide_floppy_g(disk);
170 if (ide_device_get(floppy->drive))
173 kref_get(&floppy->kref);
175 mutex_unlock(&idefloppy_ref_mutex);
179 static void ide_floppy_put(struct ide_floppy_obj *floppy)
181 ide_drive_t *drive = floppy->drive;
183 mutex_lock(&idefloppy_ref_mutex);
184 kref_put(&floppy->kref, idefloppy_cleanup_obj);
185 ide_device_put(drive);
186 mutex_unlock(&idefloppy_ref_mutex);
190 * Used to finish servicing a request. For read/write requests, we will call
191 * ide_end_request to pass to the next buffer.
193 static int idefloppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
195 idefloppy_floppy_t *floppy = drive->driver_data;
196 struct request *rq = HWGROUP(drive)->rq;
199 debug_log("Reached %s\n", __func__);
202 case 0: error = IDEFLOPPY_ERROR_GENERAL; break;
203 case 1: error = 0; break;
204 default: error = uptodate;
207 floppy->failed_pc = NULL;
208 /* Why does this happen? */
211 if (!blk_special_request(rq)) {
212 /* our real local end request function */
213 ide_end_request(drive, uptodate, nsecs);
217 /* fixme: need to move this local also */
218 ide_end_drive_cmd(drive, 0, 0);
222 static void ide_floppy_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
223 unsigned int bcount, int direction)
225 ide_hwif_t *hwif = drive->hwif;
226 struct request *rq = pc->rq;
227 struct req_iterator iter;
228 struct bio_vec *bvec;
233 rq_for_each_segment(bvec, rq, iter) {
237 count = min(bvec->bv_len, bcount);
239 data = bvec_kmap_irq(bvec, &flags);
241 hwif->tp_ops->output_data(drive, NULL, data, count);
243 hwif->tp_ops->input_data(drive, NULL, data, count);
244 bvec_kunmap_irq(data, &flags);
247 pc->b_count += count;
251 idefloppy_end_request(drive, 1, done >> 9);
254 printk(KERN_ERR "%s: leftover data in %s, bcount == %d\n",
255 drive->name, __func__, bcount);
256 ide_pad_transfer(drive, direction, bcount);
260 static void idefloppy_update_buffers(ide_drive_t *drive,
261 struct ide_atapi_pc *pc)
263 struct request *rq = pc->rq;
264 struct bio *bio = rq->bio;
266 while ((bio = rq->bio) != NULL)
267 idefloppy_end_request(drive, 1, 0);
271 * Generate a new packet command request in front of the request queue, before
272 * the current request so that it will be processed immediately, on the next
273 * pass through the driver.
275 static void idefloppy_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
278 struct ide_floppy_obj *floppy = drive->driver_data;
280 blk_rq_init(NULL, rq);
281 rq->buffer = (char *) pc;
282 rq->cmd_type = REQ_TYPE_SPECIAL;
283 rq->cmd_flags |= REQ_PREEMPT;
284 rq->rq_disk = floppy->disk;
285 memcpy(rq->cmd, pc->c, 12);
286 ide_do_drive_cmd(drive, rq);
289 static struct ide_atapi_pc *idefloppy_next_pc_storage(ide_drive_t *drive)
291 idefloppy_floppy_t *floppy = drive->driver_data;
293 if (floppy->pc_stack_index == IDEFLOPPY_PC_STACK)
294 floppy->pc_stack_index = 0;
295 return (&floppy->pc_stack[floppy->pc_stack_index++]);
298 static struct request *idefloppy_next_rq_storage(ide_drive_t *drive)
300 idefloppy_floppy_t *floppy = drive->driver_data;
302 if (floppy->rq_stack_index == IDEFLOPPY_PC_STACK)
303 floppy->rq_stack_index = 0;
304 return (&floppy->rq_stack[floppy->rq_stack_index++]);
307 static void ide_floppy_callback(ide_drive_t *drive)
309 idefloppy_floppy_t *floppy = drive->driver_data;
310 struct ide_atapi_pc *pc = floppy->pc;
311 int uptodate = pc->error ? 0 : 1;
313 debug_log("Reached %s\n", __func__);
315 if (floppy->failed_pc == pc)
316 floppy->failed_pc = NULL;
318 if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
319 (pc->rq && blk_pc_request(pc->rq)))
320 uptodate = 1; /* FIXME */
321 else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
322 u8 *buf = floppy->pc->buf;
325 floppy->sense_key = buf[2] & 0x0F;
326 floppy->asc = buf[12];
327 floppy->ascq = buf[13];
328 floppy->progress_indication = buf[15] & 0x80 ?
329 (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
331 if (floppy->failed_pc)
332 debug_log("pc = %x, ", floppy->failed_pc->c[0]);
334 debug_log("sense key = %x, asc = %x, ascq = %x\n",
335 floppy->sense_key, floppy->asc, floppy->ascq);
337 printk(KERN_ERR "Error in REQUEST SENSE itself - "
338 "Aborting request!\n");
341 idefloppy_end_request(drive, uptodate, 0);
344 static void idefloppy_init_pc(struct ide_atapi_pc *pc)
346 memset(pc, 0, sizeof(*pc));
347 pc->buf = pc->pc_buf;
348 pc->buf_size = IDEFLOPPY_PC_BUFFER_SIZE;
351 static void idefloppy_create_request_sense_cmd(struct ide_atapi_pc *pc)
353 idefloppy_init_pc(pc);
354 pc->c[0] = GPCMD_REQUEST_SENSE;
360 * Called when an error was detected during the last packet command. We queue a
361 * request sense packet command in the head of the request list.
363 static void idefloppy_retry_pc(ide_drive_t *drive)
365 struct ide_atapi_pc *pc;
368 (void)ide_read_error(drive);
369 pc = idefloppy_next_pc_storage(drive);
370 rq = idefloppy_next_rq_storage(drive);
371 idefloppy_create_request_sense_cmd(pc);
372 idefloppy_queue_pc_head(drive, pc, rq);
375 /* The usual interrupt handler called during a packet command. */
376 static ide_startstop_t idefloppy_pc_intr(ide_drive_t *drive)
378 idefloppy_floppy_t *floppy = drive->driver_data;
380 return ide_pc_intr(drive, floppy->pc, idefloppy_pc_intr,
381 IDEFLOPPY_WAIT_CMD, NULL, idefloppy_update_buffers,
382 idefloppy_retry_pc, NULL, ide_floppy_io_buffers);
386 * What we have here is a classic case of a top half / bottom half interrupt
387 * service routine. In interrupt mode, the device sends an interrupt to signal
388 * that it is ready to receive a packet. However, we need to delay about 2-3
389 * ticks before issuing the packet or we gets in trouble.
391 static int idefloppy_transfer_pc(ide_drive_t *drive)
393 idefloppy_floppy_t *floppy = drive->driver_data;
395 /* Send the actual packet */
396 drive->hwif->tp_ops->output_data(drive, NULL, floppy->pc->c, 12);
398 /* Timeout for the packet command */
399 return IDEFLOPPY_WAIT_CMD;
404 * Called as an interrupt (or directly). When the device says it's ready for a
405 * packet, we schedule the packet transfer to occur about 2-3 ticks later in
408 static ide_startstop_t idefloppy_start_pc_transfer(ide_drive_t *drive)
410 idefloppy_floppy_t *floppy = drive->driver_data;
411 struct ide_atapi_pc *pc = floppy->pc;
412 ide_expiry_t *expiry;
413 unsigned int timeout;
416 * The following delay solves a problem with ATAPI Zip 100 drives
417 * where the Busy flag was apparently being deasserted before the
418 * unit was ready to receive data. This was happening on a
419 * 1200 MHz Athlon system. 10/26/01 25msec is too short,
420 * 40 and 50msec work well. idefloppy_pc_intr will not be actually
421 * used until after the packet is moved in about 50 msec.
423 if (drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) {
424 timeout = floppy->ticks;
425 expiry = &idefloppy_transfer_pc;
427 timeout = IDEFLOPPY_WAIT_CMD;
431 return ide_transfer_pc(drive, pc, idefloppy_pc_intr, timeout, expiry);
434 static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
435 struct ide_atapi_pc *pc)
437 /* supress error messages resulting from Medium not present */
438 if (floppy->sense_key == 0x02 &&
439 floppy->asc == 0x3a &&
440 floppy->ascq == 0x00)
443 printk(KERN_ERR "ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
444 "asc = %2x, ascq = %2x\n",
445 floppy->drive->name, pc->c[0], floppy->sense_key,
446 floppy->asc, floppy->ascq);
450 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
451 struct ide_atapi_pc *pc)
453 idefloppy_floppy_t *floppy = drive->driver_data;
455 if (floppy->failed_pc == NULL &&
456 pc->c[0] != GPCMD_REQUEST_SENSE)
457 floppy->failed_pc = pc;
458 /* Set the current packet command */
461 if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
462 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
463 ide_floppy_report_error(floppy, pc);
465 pc->error = IDEFLOPPY_ERROR_GENERAL;
467 floppy->failed_pc = NULL;
468 drive->pc_callback(drive);
472 debug_log("Retry number - %d\n", pc->retries);
476 return ide_issue_pc(drive, pc, idefloppy_start_pc_transfer,
477 IDEFLOPPY_WAIT_CMD, NULL);
480 static void idefloppy_create_prevent_cmd(struct ide_atapi_pc *pc, int prevent)
482 debug_log("creating prevent removal command, prevent = %d\n", prevent);
484 idefloppy_init_pc(pc);
485 pc->c[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL;
489 static void idefloppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
491 idefloppy_init_pc(pc);
492 pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
498 static void idefloppy_create_format_unit_cmd(struct ide_atapi_pc *pc, int b,
501 idefloppy_init_pc(pc);
502 pc->c[0] = GPCMD_FORMAT_UNIT;
505 memset(pc->buf, 0, 12);
507 /* Default format list header, u8 1: FOV/DCRT/IMM bits set */
509 if (flags & 1) /* Verify bit on... */
510 pc->buf[1] ^= 0x20; /* ... turn off DCRT bit */
513 put_unaligned(cpu_to_be32(b), (unsigned int *)(&pc->buf[4]));
514 put_unaligned(cpu_to_be32(l), (unsigned int *)(&pc->buf[8]));
516 pc->flags |= PC_FLAG_WRITING;
519 /* A mode sense command is used to "sense" floppy parameters. */
520 static void idefloppy_create_mode_sense_cmd(struct ide_atapi_pc *pc,
521 u8 page_code, u8 type)
523 u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
525 idefloppy_init_pc(pc);
526 pc->c[0] = GPCMD_MODE_SENSE_10;
528 pc->c[2] = page_code + (type << 6);
531 case IDEFLOPPY_CAPABILITIES_PAGE:
534 case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
538 printk(KERN_ERR "ide-floppy: unsupported page code "
539 "in create_mode_sense_cmd\n");
541 put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
542 pc->req_xfer = length;
545 static void idefloppy_create_start_stop_cmd(struct ide_atapi_pc *pc, int start)
547 idefloppy_init_pc(pc);
548 pc->c[0] = GPCMD_START_STOP_UNIT;
552 static void idefloppy_create_rw_cmd(idefloppy_floppy_t *floppy,
553 struct ide_atapi_pc *pc, struct request *rq,
554 unsigned long sector)
556 int block = sector / floppy->bs_factor;
557 int blocks = rq->nr_sectors / floppy->bs_factor;
558 int cmd = rq_data_dir(rq);
560 debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
563 idefloppy_init_pc(pc);
564 pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
565 put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
566 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
568 memcpy(rq->cmd, pc->c, 12);
571 pc->b_count = cmd == READ ? 0 : rq->bio->bi_size;
572 if (rq->cmd_flags & REQ_RW)
573 pc->flags |= PC_FLAG_WRITING;
575 pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
576 pc->flags |= PC_FLAG_DMA_OK;
579 static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
580 struct ide_atapi_pc *pc, struct request *rq)
582 idefloppy_init_pc(pc);
583 memcpy(pc->c, rq->cmd, sizeof(pc->c));
585 pc->b_count = rq->data_len;
586 if (rq->data_len && rq_data_dir(rq) == WRITE)
587 pc->flags |= PC_FLAG_WRITING;
590 pc->flags |= PC_FLAG_DMA_OK;
592 * possibly problematic, doesn't look like ide-floppy correctly
593 * handled scattered requests if dma fails...
595 pc->req_xfer = pc->buf_size = rq->data_len;
598 static ide_startstop_t idefloppy_do_request(ide_drive_t *drive,
599 struct request *rq, sector_t block_s)
601 idefloppy_floppy_t *floppy = drive->driver_data;
602 struct ide_atapi_pc *pc;
603 unsigned long block = (unsigned long)block_s;
605 debug_log("dev: %s, cmd_type: %x, errors: %d\n",
606 rq->rq_disk ? rq->rq_disk->disk_name : "?",
607 rq->cmd_type, rq->errors);
608 debug_log("sector: %ld, nr_sectors: %ld, "
609 "current_nr_sectors: %d\n", (long)rq->sector,
610 rq->nr_sectors, rq->current_nr_sectors);
612 if (rq->errors >= ERROR_MAX) {
613 if (floppy->failed_pc)
614 ide_floppy_report_error(floppy, floppy->failed_pc);
616 printk(KERN_ERR "ide-floppy: %s: I/O error\n",
618 idefloppy_end_request(drive, 0, 0);
621 if (blk_fs_request(rq)) {
622 if (((long)rq->sector % floppy->bs_factor) ||
623 (rq->nr_sectors % floppy->bs_factor)) {
624 printk(KERN_ERR "%s: unsupported r/w request size\n",
626 idefloppy_end_request(drive, 0, 0);
629 pc = idefloppy_next_pc_storage(drive);
630 idefloppy_create_rw_cmd(floppy, pc, rq, block);
631 } else if (blk_special_request(rq)) {
632 pc = (struct ide_atapi_pc *) rq->buffer;
633 } else if (blk_pc_request(rq)) {
634 pc = idefloppy_next_pc_storage(drive);
635 idefloppy_blockpc_cmd(floppy, pc, rq);
637 blk_dump_rq_flags(rq,
638 "ide-floppy: unsupported command in queue");
639 idefloppy_end_request(drive, 0, 0);
645 return idefloppy_issue_pc(drive, pc);
649 * Add a special packet command request to the tail of the request queue,
650 * and wait for it to be serviced.
652 static int idefloppy_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
654 struct ide_floppy_obj *floppy = drive->driver_data;
658 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
659 rq->buffer = (char *) pc;
660 rq->cmd_type = REQ_TYPE_SPECIAL;
661 memcpy(rq->cmd, pc->c, 12);
662 error = blk_execute_rq(drive->queue, floppy->disk, rq, 0);
669 * Look at the flexible disk page parameters. We ignore the CHS capacity
670 * parameters and use the LBA parameters instead.
672 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive)
674 idefloppy_floppy_t *floppy = drive->driver_data;
675 struct ide_atapi_pc pc;
677 int capacity, lba_capacity;
678 u16 transfer_rate, sector_size, cyls, rpm;
681 idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE,
684 if (idefloppy_queue_pc_tail(drive, &pc)) {
685 printk(KERN_ERR "ide-floppy: Can't get flexible disk page"
689 floppy->wp = !!(pc.buf[3] & 0x80);
690 set_disk_ro(floppy->disk, floppy->wp);
693 transfer_rate = be16_to_cpup((__be16 *)&pc.buf[8 + 2]);
694 sector_size = be16_to_cpup((__be16 *)&pc.buf[8 + 6]);
695 cyls = be16_to_cpup((__be16 *)&pc.buf[8 + 8]);
696 rpm = be16_to_cpup((__be16 *)&pc.buf[8 + 28]);
697 heads = pc.buf[8 + 4];
698 sectors = pc.buf[8 + 5];
700 capacity = cyls * heads * sectors * sector_size;
702 if (memcmp(page, &floppy->flexible_disk_page, 32))
703 printk(KERN_INFO "%s: %dkB, %d/%d/%d CHS, %d kBps, "
704 "%d sector size, %d rpm\n",
705 drive->name, capacity / 1024, cyls, heads,
706 sectors, transfer_rate / 8, sector_size, rpm);
708 memcpy(&floppy->flexible_disk_page, page, 32);
709 drive->bios_cyl = cyls;
710 drive->bios_head = heads;
711 drive->bios_sect = sectors;
712 lba_capacity = floppy->blocks * floppy->block_size;
714 if (capacity < lba_capacity) {
715 printk(KERN_NOTICE "%s: The disk reports a capacity of %d "
716 "bytes, but the drive only handles %d\n",
717 drive->name, lba_capacity, capacity);
718 floppy->blocks = floppy->block_size ?
719 capacity / floppy->block_size : 0;
724 static int idefloppy_get_sfrp_bit(ide_drive_t *drive)
726 idefloppy_floppy_t *floppy = drive->driver_data;
727 struct ide_atapi_pc pc;
730 idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_CAPABILITIES_PAGE,
733 pc.flags |= PC_FLAG_SUPPRESS_ERROR;
734 if (idefloppy_queue_pc_tail(drive, &pc))
737 floppy->srfp = pc.buf[8 + 2] & 0x40;
742 * Determine if a media is present in the floppy drive, and if so, its LBA
745 static int ide_floppy_get_capacity(ide_drive_t *drive)
747 idefloppy_floppy_t *floppy = drive->driver_data;
748 struct ide_atapi_pc pc;
750 u8 header_len, desc_cnt;
751 int i, rc = 1, blocks, length;
754 drive->bios_head = drive->bios_sect = 0;
756 floppy->bs_factor = 1;
757 set_capacity(floppy->disk, 0);
759 idefloppy_create_read_capacity_cmd(&pc);
760 if (idefloppy_queue_pc_tail(drive, &pc)) {
761 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
764 header_len = pc.buf[3];
765 cap_desc = &pc.buf[4];
766 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
768 for (i = 0; i < desc_cnt; i++) {
769 unsigned int desc_start = 4 + i*8;
771 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
772 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
774 debug_log("Descriptor %d: %dkB, %d blocks, %d sector size\n",
775 i, blocks * length / 1024, blocks, length);
780 * the code below is valid only for the 1st descriptor, ie i=0
783 switch (pc.buf[desc_start + 4] & 0x03) {
784 /* Clik! drive returns this instead of CAPACITY_CURRENT */
785 case CAPACITY_UNFORMATTED:
786 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
788 * If it is not a clik drive, break out
789 * (maintains previous driver behaviour)
792 case CAPACITY_CURRENT:
793 /* Normal Zip/LS-120 disks */
794 if (memcmp(cap_desc, &floppy->cap_desc, 8))
795 printk(KERN_INFO "%s: %dkB, %d blocks, %d "
796 "sector size\n", drive->name,
797 blocks * length / 1024, blocks, length);
798 memcpy(&floppy->cap_desc, cap_desc, 8);
800 if (!length || length % 512) {
801 printk(KERN_NOTICE "%s: %d bytes block size "
802 "not supported\n", drive->name, length);
804 floppy->blocks = blocks;
805 floppy->block_size = length;
806 floppy->bs_factor = length / 512;
807 if (floppy->bs_factor != 1)
808 printk(KERN_NOTICE "%s: warning: non "
809 "512 bytes block size not "
815 case CAPACITY_NO_CARTRIDGE:
817 * This is a KERN_ERR so it appears on screen
818 * for the user to see
820 printk(KERN_ERR "%s: No disk in drive\n", drive->name);
822 case CAPACITY_INVALID:
823 printk(KERN_ERR "%s: Invalid capacity for disk "
824 "in drive\n", drive->name);
827 debug_log("Descriptor 0 Code: %d\n",
828 pc.buf[desc_start + 4] & 0x03);
831 /* Clik! disk does not support get_flexible_disk_page */
832 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
833 (void) ide_floppy_get_flexible_disk_page(drive);
835 set_capacity(floppy->disk, floppy->blocks * floppy->bs_factor);
840 * Obtain the list of formattable capacities.
841 * Very similar to ide_floppy_get_capacity, except that we push the capacity
842 * descriptors to userland, instead of our own structures.
844 * Userland gives us the following structure:
846 * struct idefloppy_format_capacities {
854 * userland initializes nformats to the number of allocated formats[] records.
855 * On exit we set nformats to the number of records we've actually initialized.
858 static int ide_floppy_get_format_capacities(ide_drive_t *drive, int __user *arg)
860 struct ide_atapi_pc pc;
861 u8 header_len, desc_cnt;
862 int i, blocks, length, u_array_size, u_index;
865 if (get_user(u_array_size, arg))
868 if (u_array_size <= 0)
871 idefloppy_create_read_capacity_cmd(&pc);
872 if (idefloppy_queue_pc_tail(drive, &pc)) {
873 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
876 header_len = pc.buf[3];
877 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
883 * We always skip the first capacity descriptor. That's the current
884 * capacity. We are interested in the remaining descriptors, the
885 * formattable capacities.
887 for (i = 1; i < desc_cnt; i++) {
888 unsigned int desc_start = 4 + i*8;
890 if (u_index >= u_array_size)
891 break; /* User-supplied buffer too small */
893 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
894 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
896 if (put_user(blocks, argp))
900 if (put_user(length, argp))
907 if (put_user(u_index, arg))
913 * Get ATAPI_FORMAT_UNIT progress indication.
915 * Userland gives a pointer to an int. The int is set to a progress
916 * indicator 0-65536, with 65536=100%.
918 * If the drive does not support format progress indication, we just check
919 * the dsc bit, and return either 0 or 65536.
922 static int idefloppy_get_format_progress(ide_drive_t *drive, int __user *arg)
924 idefloppy_floppy_t *floppy = drive->driver_data;
925 struct ide_atapi_pc pc;
926 int progress_indication = 0x10000;
929 idefloppy_create_request_sense_cmd(&pc);
930 if (idefloppy_queue_pc_tail(drive, &pc))
933 if (floppy->sense_key == 2 &&
936 progress_indication = floppy->progress_indication;
938 /* Else assume format_unit has finished, and we're at 0x10000 */
940 ide_hwif_t *hwif = drive->hwif;
944 local_irq_save(flags);
945 stat = hwif->tp_ops->read_status(hwif);
946 local_irq_restore(flags);
948 progress_indication = ((stat & SEEK_STAT) == 0) ? 0 : 0x10000;
950 if (put_user(progress_indication, arg))
956 static sector_t idefloppy_capacity(ide_drive_t *drive)
958 idefloppy_floppy_t *floppy = drive->driver_data;
959 unsigned long capacity = floppy->blocks * floppy->bs_factor;
965 * Check whether we can support a drive, based on the ATAPI IDENTIFY command
968 static int idefloppy_identify_device(ide_drive_t *drive, struct hd_driveid *id)
971 u8 device_type, protocol, removable, drq_type, packet_size;
973 *((u16 *) &gcw) = id->config;
975 device_type = gcw[1] & 0x1F;
976 removable = (gcw[0] & 0x80) >> 7;
977 protocol = (gcw[1] & 0xC0) >> 6;
978 drq_type = (gcw[0] & 0x60) >> 5;
979 packet_size = gcw[0] & 0x03;
982 /* kludge for Apple PowerBook internal zip */
983 if (device_type == 5 &&
984 !strstr(id->model, "CD-ROM") && strstr(id->model, "ZIP"))
989 printk(KERN_ERR "ide-floppy: Protocol (0x%02x) is not ATAPI\n",
991 else if (device_type != 0)
992 printk(KERN_ERR "ide-floppy: Device type (0x%02x) is not set "
993 "to floppy\n", device_type);
995 printk(KERN_ERR "ide-floppy: The removable flag is not set\n");
996 else if (drq_type == 3)
997 printk(KERN_ERR "ide-floppy: Sorry, DRQ type (0x%02x) not "
998 "supported\n", drq_type);
999 else if (packet_size != 0)
1000 printk(KERN_ERR "ide-floppy: Packet size (0x%02x) is not 12 "
1001 "bytes\n", packet_size);
1007 #ifdef CONFIG_IDE_PROC_FS
1008 static void idefloppy_add_settings(ide_drive_t *drive)
1010 idefloppy_floppy_t *floppy = drive->driver_data;
1012 ide_add_setting(drive, "bios_cyl", SETTING_RW, TYPE_INT, 0, 1023, 1, 1,
1013 &drive->bios_cyl, NULL);
1014 ide_add_setting(drive, "bios_head", SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1015 &drive->bios_head, NULL);
1016 ide_add_setting(drive, "bios_sect", SETTING_RW, TYPE_BYTE, 0, 63, 1, 1,
1017 &drive->bios_sect, NULL);
1018 ide_add_setting(drive, "ticks", SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1019 &floppy->ticks, NULL);
1022 static inline void idefloppy_add_settings(ide_drive_t *drive) { ; }
1025 static void idefloppy_setup(ide_drive_t *drive, idefloppy_floppy_t *floppy)
1029 *((u16 *) &gcw) = drive->id->config;
1030 floppy->pc = floppy->pc_stack;
1031 drive->pc_callback = ide_floppy_callback;
1033 if (((gcw[0] & 0x60) >> 5) == 1)
1034 drive->atapi_flags |= IDE_AFLAG_DRQ_INTERRUPT;
1036 * We used to check revisions here. At this point however I'm giving up.
1037 * Just assume they are all broken, its easier.
1039 * The actual reason for the workarounds was likely a driver bug after
1040 * all rather than a firmware bug, and the workaround below used to hide
1041 * it. It should be fixed as of version 1.9, but to be on the safe side
1042 * we'll leave the limitation below for the 2.2.x tree.
1044 if (!strncmp(drive->id->model, "IOMEGA ZIP 100 ATAPI", 20)) {
1045 drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE;
1046 /* This value will be visible in the /proc/ide/hdx/settings */
1047 floppy->ticks = IDEFLOPPY_TICKS_DELAY;
1048 blk_queue_max_sectors(drive->queue, 64);
1052 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
1053 * nasty clicking noises without it, so please don't remove this.
1055 if (strncmp(drive->id->model, "IOMEGA Clik!", 11) == 0) {
1056 blk_queue_max_sectors(drive->queue, 64);
1057 drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE;
1060 (void) ide_floppy_get_capacity(drive);
1061 idefloppy_add_settings(drive);
1064 static void ide_floppy_remove(ide_drive_t *drive)
1066 idefloppy_floppy_t *floppy = drive->driver_data;
1067 struct gendisk *g = floppy->disk;
1069 ide_proc_unregister_driver(drive, floppy->driver);
1073 ide_floppy_put(floppy);
1076 static void idefloppy_cleanup_obj(struct kref *kref)
1078 struct ide_floppy_obj *floppy = to_ide_floppy(kref);
1079 ide_drive_t *drive = floppy->drive;
1080 struct gendisk *g = floppy->disk;
1082 drive->driver_data = NULL;
1083 g->private_data = NULL;
1088 #ifdef CONFIG_IDE_PROC_FS
1089 static int proc_idefloppy_read_capacity(char *page, char **start, off_t off,
1090 int count, int *eof, void *data)
1092 ide_drive_t*drive = (ide_drive_t *)data;
1095 len = sprintf(page, "%llu\n", (long long)idefloppy_capacity(drive));
1096 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1099 static ide_proc_entry_t idefloppy_proc[] = {
1100 { "capacity", S_IFREG|S_IRUGO, proc_idefloppy_read_capacity, NULL },
1101 { "geometry", S_IFREG|S_IRUGO, proc_ide_read_geometry, NULL },
1102 { NULL, 0, NULL, NULL }
1104 #endif /* CONFIG_IDE_PROC_FS */
1106 static int ide_floppy_probe(ide_drive_t *);
1108 static ide_driver_t idefloppy_driver = {
1110 .owner = THIS_MODULE,
1111 .name = "ide-floppy",
1112 .bus = &ide_bus_type,
1114 .probe = ide_floppy_probe,
1115 .remove = ide_floppy_remove,
1116 .version = IDEFLOPPY_VERSION,
1117 .media = ide_floppy,
1118 .supports_dsc_overlap = 0,
1119 .do_request = idefloppy_do_request,
1120 .end_request = idefloppy_end_request,
1121 .error = __ide_error,
1122 #ifdef CONFIG_IDE_PROC_FS
1123 .proc = idefloppy_proc,
1127 static int idefloppy_open(struct inode *inode, struct file *filp)
1129 struct gendisk *disk = inode->i_bdev->bd_disk;
1130 struct ide_floppy_obj *floppy;
1132 struct ide_atapi_pc pc;
1135 debug_log("Reached %s\n", __func__);
1137 floppy = ide_floppy_get(disk);
1141 drive = floppy->drive;
1145 if (floppy->openers == 1) {
1146 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1149 idefloppy_init_pc(&pc);
1150 pc.c[0] = GPCMD_TEST_UNIT_READY;
1152 if (idefloppy_queue_pc_tail(drive, &pc)) {
1153 idefloppy_create_start_stop_cmd(&pc, 1);
1154 (void) idefloppy_queue_pc_tail(drive, &pc);
1157 if (ide_floppy_get_capacity(drive)
1158 && (filp->f_flags & O_NDELAY) == 0
1160 * Allow O_NDELAY to open a drive without a disk, or with an
1161 * unreadable disk, so that we can get the format capacity
1162 * of the drive or begin the format - Sam
1166 goto out_put_floppy;
1169 if (floppy->wp && (filp->f_mode & 2)) {
1171 goto out_put_floppy;
1173 drive->atapi_flags |= IDE_AFLAG_MEDIA_CHANGED;
1174 /* IOMEGA Clik! drives do not support lock/unlock commands */
1175 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1176 idefloppy_create_prevent_cmd(&pc, 1);
1177 (void) idefloppy_queue_pc_tail(drive, &pc);
1179 check_disk_change(inode->i_bdev);
1180 } else if (drive->atapi_flags & IDE_AFLAG_FORMAT_IN_PROGRESS) {
1182 goto out_put_floppy;
1188 ide_floppy_put(floppy);
1192 static int idefloppy_release(struct inode *inode, struct file *filp)
1194 struct gendisk *disk = inode->i_bdev->bd_disk;
1195 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1196 ide_drive_t *drive = floppy->drive;
1197 struct ide_atapi_pc pc;
1199 debug_log("Reached %s\n", __func__);
1201 if (floppy->openers == 1) {
1202 /* IOMEGA Clik! drives do not support lock/unlock commands */
1203 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1204 idefloppy_create_prevent_cmd(&pc, 0);
1205 (void) idefloppy_queue_pc_tail(drive, &pc);
1208 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1213 ide_floppy_put(floppy);
1218 static int idefloppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1220 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1221 ide_drive_t *drive = floppy->drive;
1223 geo->heads = drive->bios_head;
1224 geo->sectors = drive->bios_sect;
1225 geo->cylinders = (u16)drive->bios_cyl; /* truncate */
1229 static int ide_floppy_lockdoor(ide_drive_t *drive, struct ide_atapi_pc *pc,
1230 unsigned long arg, unsigned int cmd)
1232 idefloppy_floppy_t *floppy = drive->driver_data;
1234 if (floppy->openers > 1)
1237 /* The IOMEGA Clik! Drive doesn't support this command -
1238 * no room for an eject mechanism */
1239 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1240 int prevent = arg ? 1 : 0;
1242 if (cmd == CDROMEJECT)
1245 idefloppy_create_prevent_cmd(pc, prevent);
1246 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1249 if (cmd == CDROMEJECT) {
1250 idefloppy_create_start_stop_cmd(pc, 2);
1251 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1257 static int ide_floppy_format_unit(idefloppy_floppy_t *floppy,
1260 struct ide_atapi_pc pc;
1261 ide_drive_t *drive = floppy->drive;
1262 int blocks, length, flags, err = 0;
1264 if (floppy->openers > 1) {
1265 /* Don't format if someone is using the disk */
1266 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1270 drive->atapi_flags |= IDE_AFLAG_FORMAT_IN_PROGRESS;
1273 * Send ATAPI_FORMAT_UNIT to the drive.
1275 * Userland gives us the following structure:
1277 * struct idefloppy_format_command {
1283 * flags is a bitmask, currently, the only defined flag is:
1285 * 0x01 - verify media after format.
1287 if (get_user(blocks, arg) ||
1288 get_user(length, arg+1) ||
1289 get_user(flags, arg+2)) {
1294 (void) idefloppy_get_sfrp_bit(drive);
1295 idefloppy_create_format_unit_cmd(&pc, blocks, length, flags);
1297 if (idefloppy_queue_pc_tail(drive, &pc))
1302 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1307 static int idefloppy_ioctl(struct inode *inode, struct file *file,
1308 unsigned int cmd, unsigned long arg)
1310 struct block_device *bdev = inode->i_bdev;
1311 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1312 ide_drive_t *drive = floppy->drive;
1313 struct ide_atapi_pc pc;
1314 void __user *argp = (void __user *)arg;
1320 case CDROM_LOCKDOOR:
1321 return ide_floppy_lockdoor(drive, &pc, arg, cmd);
1322 case IDEFLOPPY_IOCTL_FORMAT_SUPPORTED:
1324 case IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY:
1325 return ide_floppy_get_format_capacities(drive, argp);
1326 case IDEFLOPPY_IOCTL_FORMAT_START:
1327 if (!(file->f_mode & 2))
1330 return ide_floppy_format_unit(floppy, (int __user *)arg);
1331 case IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS:
1332 return idefloppy_get_format_progress(drive, argp);
1336 * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
1337 * and CDROM_SEND_PACKET (legacy) ioctls
1339 if (cmd != CDROM_SEND_PACKET && cmd != SCSI_IOCTL_SEND_COMMAND)
1340 err = scsi_cmd_ioctl(file, bdev->bd_disk->queue,
1341 bdev->bd_disk, cmd, argp);
1346 err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
1351 static int idefloppy_media_changed(struct gendisk *disk)
1353 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1354 ide_drive_t *drive = floppy->drive;
1357 /* do not scan partitions twice if this is a removable device */
1358 if (drive->attach) {
1362 ret = !!(drive->atapi_flags & IDE_AFLAG_MEDIA_CHANGED);
1363 drive->atapi_flags &= ~IDE_AFLAG_MEDIA_CHANGED;
1367 static int idefloppy_revalidate_disk(struct gendisk *disk)
1369 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1370 set_capacity(disk, idefloppy_capacity(floppy->drive));
1374 static struct block_device_operations idefloppy_ops = {
1375 .owner = THIS_MODULE,
1376 .open = idefloppy_open,
1377 .release = idefloppy_release,
1378 .ioctl = idefloppy_ioctl,
1379 .getgeo = idefloppy_getgeo,
1380 .media_changed = idefloppy_media_changed,
1381 .revalidate_disk = idefloppy_revalidate_disk
1384 static int ide_floppy_probe(ide_drive_t *drive)
1386 idefloppy_floppy_t *floppy;
1389 if (!strstr("ide-floppy", drive->driver_req))
1391 if (!drive->present)
1393 if (drive->media != ide_floppy)
1395 if (!idefloppy_identify_device(drive, drive->id)) {
1396 printk(KERN_ERR "ide-floppy: %s: not supported by this version"
1397 " of ide-floppy\n", drive->name);
1400 floppy = kzalloc(sizeof(idefloppy_floppy_t), GFP_KERNEL);
1402 printk(KERN_ERR "ide-floppy: %s: Can't allocate a floppy"
1403 " structure\n", drive->name);
1407 g = alloc_disk(1 << PARTN_BITS);
1409 goto out_free_floppy;
1411 ide_init_disk(g, drive);
1413 ide_proc_register_driver(drive, &idefloppy_driver);
1415 kref_init(&floppy->kref);
1417 floppy->drive = drive;
1418 floppy->driver = &idefloppy_driver;
1421 g->private_data = &floppy->driver;
1423 drive->driver_data = floppy;
1425 idefloppy_setup(drive, floppy);
1427 g->minors = 1 << PARTN_BITS;
1428 g->driverfs_dev = &drive->gendev;
1429 g->flags = drive->removable ? GENHD_FL_REMOVABLE : 0;
1430 g->fops = &idefloppy_ops;
1441 static void __exit idefloppy_exit(void)
1443 driver_unregister(&idefloppy_driver.gen_driver);
1446 static int __init idefloppy_init(void)
1448 printk("ide-floppy driver " IDEFLOPPY_VERSION "\n");
1449 return driver_register(&idefloppy_driver.gen_driver);
1452 MODULE_ALIAS("ide:*m-floppy*");
1453 module_init(idefloppy_init);
1454 module_exit(idefloppy_exit);
1455 MODULE_LICENSE("GPL");
1456 MODULE_DESCRIPTION("ATAPI FLOPPY Driver");