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
73 * With each packet command, we allocate a buffer of IDEFLOPPY_PC_BUFFER_SIZE
76 #define IDEFLOPPY_PC_BUFFER_SIZE 256
78 /* format capacities descriptor codes */
79 #define CAPACITY_INVALID 0x00
80 #define CAPACITY_UNFORMATTED 0x01
81 #define CAPACITY_CURRENT 0x02
82 #define CAPACITY_NO_CARTRIDGE 0x03
85 * Most of our global data which we need to save even as we leave the driver
86 * due to an interrupt or a timer event is stored in a variable of type
87 * idefloppy_floppy_t, defined below.
89 typedef struct ide_floppy_obj {
94 unsigned int openers; /* protected by BKL for now */
96 /* Current packet command */
97 struct ide_atapi_pc *pc;
98 /* Last failed packet command */
99 struct ide_atapi_pc *failed_pc;
100 /* used for blk_{fs,pc}_request() requests */
101 struct ide_atapi_pc queued_pc;
103 struct ide_atapi_pc request_sense_pc;
104 struct request request_sense_rq;
106 /* Last error information */
107 u8 sense_key, asc, ascq;
108 /* delay this long before sending packet command */
110 int progress_indication;
112 /* Device information */
114 int blocks, block_size, bs_factor;
115 /* Last format capacity descriptor */
117 /* Copy of the flexible disk page */
118 u8 flexible_disk_page[32];
121 /* Supports format progress report */
123 } idefloppy_floppy_t;
125 #define IDEFLOPPY_TICKS_DELAY HZ/20 /* default delay for ZIP 100 (50ms) */
127 /* Defines for the MODE SENSE command */
128 #define MODE_SENSE_CURRENT 0x00
129 #define MODE_SENSE_CHANGEABLE 0x01
130 #define MODE_SENSE_DEFAULT 0x02
131 #define MODE_SENSE_SAVED 0x03
133 /* IOCTLs used in low-level formatting. */
134 #define IDEFLOPPY_IOCTL_FORMAT_SUPPORTED 0x4600
135 #define IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY 0x4601
136 #define IDEFLOPPY_IOCTL_FORMAT_START 0x4602
137 #define IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS 0x4603
139 /* Error code returned in rq->errors to the higher part of the driver. */
140 #define IDEFLOPPY_ERROR_GENERAL 101
143 * Pages of the SELECT SENSE / MODE SENSE packet commands.
144 * See SFF-8070i spec.
146 #define IDEFLOPPY_CAPABILITIES_PAGE 0x1b
147 #define IDEFLOPPY_FLEXIBLE_DISK_PAGE 0x05
149 static DEFINE_MUTEX(idefloppy_ref_mutex);
151 #define to_ide_floppy(obj) container_of(obj, struct ide_floppy_obj, kref)
153 #define ide_floppy_g(disk) \
154 container_of((disk)->private_data, struct ide_floppy_obj, driver)
156 static void idefloppy_cleanup_obj(struct kref *);
158 static struct ide_floppy_obj *ide_floppy_get(struct gendisk *disk)
160 struct ide_floppy_obj *floppy = NULL;
162 mutex_lock(&idefloppy_ref_mutex);
163 floppy = ide_floppy_g(disk);
165 if (ide_device_get(floppy->drive))
168 kref_get(&floppy->kref);
170 mutex_unlock(&idefloppy_ref_mutex);
174 static void ide_floppy_put(struct ide_floppy_obj *floppy)
176 ide_drive_t *drive = floppy->drive;
178 mutex_lock(&idefloppy_ref_mutex);
179 kref_put(&floppy->kref, idefloppy_cleanup_obj);
180 ide_device_put(drive);
181 mutex_unlock(&idefloppy_ref_mutex);
185 * Used to finish servicing a request. For read/write requests, we will call
186 * ide_end_request to pass to the next buffer.
188 static int idefloppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
190 idefloppy_floppy_t *floppy = drive->driver_data;
191 struct request *rq = HWGROUP(drive)->rq;
194 debug_log("Reached %s\n", __func__);
197 case 0: error = IDEFLOPPY_ERROR_GENERAL; break;
198 case 1: error = 0; break;
199 default: error = uptodate;
202 floppy->failed_pc = NULL;
203 /* Why does this happen? */
206 if (!blk_special_request(rq)) {
207 /* our real local end request function */
208 ide_end_request(drive, uptodate, nsecs);
212 /* fixme: need to move this local also */
213 ide_end_drive_cmd(drive, 0, 0);
217 static void ide_floppy_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
218 unsigned int bcount, int direction)
220 ide_hwif_t *hwif = drive->hwif;
221 const struct ide_tp_ops *tp_ops = hwif->tp_ops;
222 xfer_func_t *xf = direction ? tp_ops->output_data : tp_ops->input_data;
223 struct scatterlist *sg = pc->sg;
228 count = min(sg->length - pc->b_count, bcount);
229 if (PageHighMem(sg_page(sg))) {
232 local_irq_save(flags);
233 buf = kmap_atomic(sg_page(sg), KM_IRQ0) + sg->offset;
234 xf(drive, NULL, buf + pc->b_count, count);
235 kunmap_atomic(buf - sg->offset, KM_IRQ0);
236 local_irq_restore(flags);
239 xf(drive, NULL, buf + pc->b_count, count);
242 pc->b_count += count;
245 if (pc->b_count == sg->length) {
248 pc->sg = sg = sg_next(sg);
253 idefloppy_end_request(drive, 1, done >> 9);
256 printk(KERN_ERR "%s: leftover data in %s, bcount == %d\n",
257 drive->name, __func__, bcount);
258 ide_pad_transfer(drive, direction, bcount);
262 static void idefloppy_update_buffers(ide_drive_t *drive,
263 struct ide_atapi_pc *pc)
265 struct request *rq = pc->rq;
266 struct bio *bio = rq->bio;
268 while ((bio = rq->bio) != NULL)
269 idefloppy_end_request(drive, 1, 0);
273 * Generate a new packet command request in front of the request queue, before
274 * the current request so that it will be processed immediately, on the next
275 * pass through the driver.
277 static void idefloppy_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
280 struct ide_floppy_obj *floppy = drive->driver_data;
282 blk_rq_init(NULL, rq);
283 rq->buffer = (char *) pc;
284 rq->cmd_type = REQ_TYPE_SPECIAL;
285 rq->cmd_flags |= REQ_PREEMPT;
286 rq->rq_disk = floppy->disk;
287 memcpy(rq->cmd, pc->c, 12);
288 ide_do_drive_cmd(drive, rq);
291 static void ide_floppy_callback(ide_drive_t *drive)
293 idefloppy_floppy_t *floppy = drive->driver_data;
294 struct ide_atapi_pc *pc = floppy->pc;
295 int uptodate = pc->error ? 0 : 1;
297 debug_log("Reached %s\n", __func__);
299 if (floppy->failed_pc == pc)
300 floppy->failed_pc = NULL;
302 if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
303 (pc->rq && blk_pc_request(pc->rq)))
304 uptodate = 1; /* FIXME */
305 else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
306 u8 *buf = floppy->pc->buf;
309 floppy->sense_key = buf[2] & 0x0F;
310 floppy->asc = buf[12];
311 floppy->ascq = buf[13];
312 floppy->progress_indication = buf[15] & 0x80 ?
313 (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
315 if (floppy->failed_pc)
316 debug_log("pc = %x, ", floppy->failed_pc->c[0]);
318 debug_log("sense key = %x, asc = %x, ascq = %x\n",
319 floppy->sense_key, floppy->asc, floppy->ascq);
321 printk(KERN_ERR "Error in REQUEST SENSE itself - "
322 "Aborting request!\n");
325 idefloppy_end_request(drive, uptodate, 0);
328 static void idefloppy_init_pc(struct ide_atapi_pc *pc)
330 memset(pc, 0, sizeof(*pc));
331 pc->buf = pc->pc_buf;
332 pc->buf_size = IDEFLOPPY_PC_BUFFER_SIZE;
335 static void idefloppy_create_request_sense_cmd(struct ide_atapi_pc *pc)
337 idefloppy_init_pc(pc);
338 pc->c[0] = GPCMD_REQUEST_SENSE;
344 * Called when an error was detected during the last packet command. We queue a
345 * request sense packet command in the head of the request list.
347 static void idefloppy_retry_pc(ide_drive_t *drive)
349 struct ide_floppy_obj *floppy = drive->driver_data;
350 struct request *rq = &floppy->request_sense_rq;
351 struct ide_atapi_pc *pc = &floppy->request_sense_pc;
353 (void)ide_read_error(drive);
354 idefloppy_create_request_sense_cmd(pc);
355 idefloppy_queue_pc_head(drive, pc, rq);
358 /* The usual interrupt handler called during a packet command. */
359 static ide_startstop_t idefloppy_pc_intr(ide_drive_t *drive)
361 idefloppy_floppy_t *floppy = drive->driver_data;
363 return ide_pc_intr(drive, floppy->pc, idefloppy_pc_intr,
364 IDEFLOPPY_WAIT_CMD, NULL, idefloppy_update_buffers,
365 idefloppy_retry_pc, NULL, ide_floppy_io_buffers);
369 * What we have here is a classic case of a top half / bottom half interrupt
370 * service routine. In interrupt mode, the device sends an interrupt to signal
371 * that it is ready to receive a packet. However, we need to delay about 2-3
372 * ticks before issuing the packet or we gets in trouble.
374 static int idefloppy_transfer_pc(ide_drive_t *drive)
376 idefloppy_floppy_t *floppy = drive->driver_data;
378 /* Send the actual packet */
379 drive->hwif->tp_ops->output_data(drive, NULL, floppy->pc->c, 12);
381 /* Timeout for the packet command */
382 return IDEFLOPPY_WAIT_CMD;
387 * Called as an interrupt (or directly). When the device says it's ready for a
388 * packet, we schedule the packet transfer to occur about 2-3 ticks later in
391 static ide_startstop_t idefloppy_start_pc_transfer(ide_drive_t *drive)
393 idefloppy_floppy_t *floppy = drive->driver_data;
394 struct ide_atapi_pc *pc = floppy->pc;
395 ide_expiry_t *expiry;
396 unsigned int timeout;
399 * The following delay solves a problem with ATAPI Zip 100 drives
400 * where the Busy flag was apparently being deasserted before the
401 * unit was ready to receive data. This was happening on a
402 * 1200 MHz Athlon system. 10/26/01 25msec is too short,
403 * 40 and 50msec work well. idefloppy_pc_intr will not be actually
404 * used until after the packet is moved in about 50 msec.
406 if (drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) {
407 timeout = floppy->ticks;
408 expiry = &idefloppy_transfer_pc;
410 timeout = IDEFLOPPY_WAIT_CMD;
414 return ide_transfer_pc(drive, pc, idefloppy_pc_intr, timeout, expiry);
417 static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
418 struct ide_atapi_pc *pc)
420 /* supress error messages resulting from Medium not present */
421 if (floppy->sense_key == 0x02 &&
422 floppy->asc == 0x3a &&
423 floppy->ascq == 0x00)
426 printk(KERN_ERR "ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
427 "asc = %2x, ascq = %2x\n",
428 floppy->drive->name, pc->c[0], floppy->sense_key,
429 floppy->asc, floppy->ascq);
433 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
434 struct ide_atapi_pc *pc)
436 idefloppy_floppy_t *floppy = drive->driver_data;
438 if (floppy->failed_pc == NULL &&
439 pc->c[0] != GPCMD_REQUEST_SENSE)
440 floppy->failed_pc = pc;
441 /* Set the current packet command */
444 if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
445 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
446 ide_floppy_report_error(floppy, pc);
448 pc->error = IDEFLOPPY_ERROR_GENERAL;
450 floppy->failed_pc = NULL;
451 drive->pc_callback(drive);
455 debug_log("Retry number - %d\n", pc->retries);
459 return ide_issue_pc(drive, pc, idefloppy_start_pc_transfer,
460 IDEFLOPPY_WAIT_CMD, NULL);
463 static void idefloppy_create_prevent_cmd(struct ide_atapi_pc *pc, int prevent)
465 debug_log("creating prevent removal command, prevent = %d\n", prevent);
467 idefloppy_init_pc(pc);
468 pc->c[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL;
472 static void idefloppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
474 idefloppy_init_pc(pc);
475 pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
481 static void idefloppy_create_format_unit_cmd(struct ide_atapi_pc *pc, int b,
484 idefloppy_init_pc(pc);
485 pc->c[0] = GPCMD_FORMAT_UNIT;
488 memset(pc->buf, 0, 12);
490 /* Default format list header, u8 1: FOV/DCRT/IMM bits set */
492 if (flags & 1) /* Verify bit on... */
493 pc->buf[1] ^= 0x20; /* ... turn off DCRT bit */
496 put_unaligned(cpu_to_be32(b), (unsigned int *)(&pc->buf[4]));
497 put_unaligned(cpu_to_be32(l), (unsigned int *)(&pc->buf[8]));
499 pc->flags |= PC_FLAG_WRITING;
502 /* A mode sense command is used to "sense" floppy parameters. */
503 static void idefloppy_create_mode_sense_cmd(struct ide_atapi_pc *pc,
504 u8 page_code, u8 type)
506 u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
508 idefloppy_init_pc(pc);
509 pc->c[0] = GPCMD_MODE_SENSE_10;
511 pc->c[2] = page_code + (type << 6);
514 case IDEFLOPPY_CAPABILITIES_PAGE:
517 case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
521 printk(KERN_ERR "ide-floppy: unsupported page code "
522 "in create_mode_sense_cmd\n");
524 put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
525 pc->req_xfer = length;
528 static void idefloppy_create_start_stop_cmd(struct ide_atapi_pc *pc, int start)
530 idefloppy_init_pc(pc);
531 pc->c[0] = GPCMD_START_STOP_UNIT;
535 static void idefloppy_create_rw_cmd(idefloppy_floppy_t *floppy,
536 struct ide_atapi_pc *pc, struct request *rq,
537 unsigned long sector)
539 int block = sector / floppy->bs_factor;
540 int blocks = rq->nr_sectors / floppy->bs_factor;
541 int cmd = rq_data_dir(rq);
543 debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
546 idefloppy_init_pc(pc);
547 pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
548 put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
549 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
551 memcpy(rq->cmd, pc->c, 12);
555 if (rq->cmd_flags & REQ_RW)
556 pc->flags |= PC_FLAG_WRITING;
558 pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
559 pc->flags |= PC_FLAG_DMA_OK;
562 static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
563 struct ide_atapi_pc *pc, struct request *rq)
565 idefloppy_init_pc(pc);
566 memcpy(pc->c, rq->cmd, sizeof(pc->c));
569 if (rq->data_len && rq_data_dir(rq) == WRITE)
570 pc->flags |= PC_FLAG_WRITING;
573 pc->flags |= PC_FLAG_DMA_OK;
575 * possibly problematic, doesn't look like ide-floppy correctly
576 * handled scattered requests if dma fails...
578 pc->req_xfer = pc->buf_size = rq->data_len;
581 static ide_startstop_t idefloppy_do_request(ide_drive_t *drive,
582 struct request *rq, sector_t block_s)
584 idefloppy_floppy_t *floppy = drive->driver_data;
585 ide_hwif_t *hwif = drive->hwif;
586 struct ide_atapi_pc *pc;
587 unsigned long block = (unsigned long)block_s;
589 debug_log("%s: dev: %s, cmd: 0x%x, cmd_type: %x, errors: %d\n",
590 __func__, rq->rq_disk ? rq->rq_disk->disk_name : "?",
591 rq->cmd[0], rq->cmd_type, rq->errors);
593 debug_log("%s: sector: %ld, nr_sectors: %ld, current_nr_sectors: %d\n",
594 __func__, (long)rq->sector, rq->nr_sectors,
595 rq->current_nr_sectors);
597 if (rq->errors >= ERROR_MAX) {
598 if (floppy->failed_pc)
599 ide_floppy_report_error(floppy, floppy->failed_pc);
601 printk(KERN_ERR "ide-floppy: %s: I/O error\n",
603 idefloppy_end_request(drive, 0, 0);
606 if (blk_fs_request(rq)) {
607 if (((long)rq->sector % floppy->bs_factor) ||
608 (rq->nr_sectors % floppy->bs_factor)) {
609 printk(KERN_ERR "%s: unsupported r/w request size\n",
611 idefloppy_end_request(drive, 0, 0);
614 pc = &floppy->queued_pc;
615 idefloppy_create_rw_cmd(floppy, pc, rq, block);
616 } else if (blk_special_request(rq)) {
617 pc = (struct ide_atapi_pc *) rq->buffer;
618 } else if (blk_pc_request(rq)) {
619 pc = &floppy->queued_pc;
620 idefloppy_blockpc_cmd(floppy, pc, rq);
622 blk_dump_rq_flags(rq,
623 "ide-floppy: unsupported command in queue");
624 idefloppy_end_request(drive, 0, 0);
628 ide_init_sg_cmd(drive, rq);
629 ide_map_sg(drive, rq);
631 pc->sg = hwif->sg_table;
632 pc->sg_cnt = hwif->sg_nents;
636 return idefloppy_issue_pc(drive, pc);
640 * Add a special packet command request to the tail of the request queue,
641 * and wait for it to be serviced.
643 static int idefloppy_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
645 struct ide_floppy_obj *floppy = drive->driver_data;
649 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
650 rq->buffer = (char *) pc;
651 rq->cmd_type = REQ_TYPE_SPECIAL;
652 memcpy(rq->cmd, pc->c, 12);
653 error = blk_execute_rq(drive->queue, floppy->disk, rq, 0);
660 * Look at the flexible disk page parameters. We ignore the CHS capacity
661 * parameters and use the LBA parameters instead.
663 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive)
665 idefloppy_floppy_t *floppy = drive->driver_data;
666 struct ide_atapi_pc pc;
668 int capacity, lba_capacity;
669 u16 transfer_rate, sector_size, cyls, rpm;
672 idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE,
675 if (idefloppy_queue_pc_tail(drive, &pc)) {
676 printk(KERN_ERR "ide-floppy: Can't get flexible disk page"
680 floppy->wp = !!(pc.buf[3] & 0x80);
681 set_disk_ro(floppy->disk, floppy->wp);
684 transfer_rate = be16_to_cpup((__be16 *)&pc.buf[8 + 2]);
685 sector_size = be16_to_cpup((__be16 *)&pc.buf[8 + 6]);
686 cyls = be16_to_cpup((__be16 *)&pc.buf[8 + 8]);
687 rpm = be16_to_cpup((__be16 *)&pc.buf[8 + 28]);
688 heads = pc.buf[8 + 4];
689 sectors = pc.buf[8 + 5];
691 capacity = cyls * heads * sectors * sector_size;
693 if (memcmp(page, &floppy->flexible_disk_page, 32))
694 printk(KERN_INFO "%s: %dkB, %d/%d/%d CHS, %d kBps, "
695 "%d sector size, %d rpm\n",
696 drive->name, capacity / 1024, cyls, heads,
697 sectors, transfer_rate / 8, sector_size, rpm);
699 memcpy(&floppy->flexible_disk_page, page, 32);
700 drive->bios_cyl = cyls;
701 drive->bios_head = heads;
702 drive->bios_sect = sectors;
703 lba_capacity = floppy->blocks * floppy->block_size;
705 if (capacity < lba_capacity) {
706 printk(KERN_NOTICE "%s: The disk reports a capacity of %d "
707 "bytes, but the drive only handles %d\n",
708 drive->name, lba_capacity, capacity);
709 floppy->blocks = floppy->block_size ?
710 capacity / floppy->block_size : 0;
715 static int idefloppy_get_sfrp_bit(ide_drive_t *drive)
717 idefloppy_floppy_t *floppy = drive->driver_data;
718 struct ide_atapi_pc pc;
721 idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_CAPABILITIES_PAGE,
724 pc.flags |= PC_FLAG_SUPPRESS_ERROR;
725 if (idefloppy_queue_pc_tail(drive, &pc))
728 floppy->srfp = pc.buf[8 + 2] & 0x40;
733 * Determine if a media is present in the floppy drive, and if so, its LBA
736 static int ide_floppy_get_capacity(ide_drive_t *drive)
738 idefloppy_floppy_t *floppy = drive->driver_data;
739 struct ide_atapi_pc pc;
741 u8 header_len, desc_cnt;
742 int i, rc = 1, blocks, length;
745 drive->bios_head = drive->bios_sect = 0;
747 floppy->bs_factor = 1;
748 set_capacity(floppy->disk, 0);
750 idefloppy_create_read_capacity_cmd(&pc);
751 if (idefloppy_queue_pc_tail(drive, &pc)) {
752 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
755 header_len = pc.buf[3];
756 cap_desc = &pc.buf[4];
757 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
759 for (i = 0; i < desc_cnt; i++) {
760 unsigned int desc_start = 4 + i*8;
762 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
763 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
765 debug_log("Descriptor %d: %dkB, %d blocks, %d sector size\n",
766 i, blocks * length / 1024, blocks, length);
771 * the code below is valid only for the 1st descriptor, ie i=0
774 switch (pc.buf[desc_start + 4] & 0x03) {
775 /* Clik! drive returns this instead of CAPACITY_CURRENT */
776 case CAPACITY_UNFORMATTED:
777 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
779 * If it is not a clik drive, break out
780 * (maintains previous driver behaviour)
783 case CAPACITY_CURRENT:
784 /* Normal Zip/LS-120 disks */
785 if (memcmp(cap_desc, &floppy->cap_desc, 8))
786 printk(KERN_INFO "%s: %dkB, %d blocks, %d "
787 "sector size\n", drive->name,
788 blocks * length / 1024, blocks, length);
789 memcpy(&floppy->cap_desc, cap_desc, 8);
791 if (!length || length % 512) {
792 printk(KERN_NOTICE "%s: %d bytes block size "
793 "not supported\n", drive->name, length);
795 floppy->blocks = blocks;
796 floppy->block_size = length;
797 floppy->bs_factor = length / 512;
798 if (floppy->bs_factor != 1)
799 printk(KERN_NOTICE "%s: warning: non "
800 "512 bytes block size not "
806 case CAPACITY_NO_CARTRIDGE:
808 * This is a KERN_ERR so it appears on screen
809 * for the user to see
811 printk(KERN_ERR "%s: No disk in drive\n", drive->name);
813 case CAPACITY_INVALID:
814 printk(KERN_ERR "%s: Invalid capacity for disk "
815 "in drive\n", drive->name);
818 debug_log("Descriptor 0 Code: %d\n",
819 pc.buf[desc_start + 4] & 0x03);
822 /* Clik! disk does not support get_flexible_disk_page */
823 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
824 (void) ide_floppy_get_flexible_disk_page(drive);
826 set_capacity(floppy->disk, floppy->blocks * floppy->bs_factor);
831 * Obtain the list of formattable capacities.
832 * Very similar to ide_floppy_get_capacity, except that we push the capacity
833 * descriptors to userland, instead of our own structures.
835 * Userland gives us the following structure:
837 * struct idefloppy_format_capacities {
845 * userland initializes nformats to the number of allocated formats[] records.
846 * On exit we set nformats to the number of records we've actually initialized.
849 static int ide_floppy_get_format_capacities(ide_drive_t *drive, int __user *arg)
851 struct ide_atapi_pc pc;
852 u8 header_len, desc_cnt;
853 int i, blocks, length, u_array_size, u_index;
856 if (get_user(u_array_size, arg))
859 if (u_array_size <= 0)
862 idefloppy_create_read_capacity_cmd(&pc);
863 if (idefloppy_queue_pc_tail(drive, &pc)) {
864 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
868 header_len = pc.buf[3];
869 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
875 * We always skip the first capacity descriptor. That's the current
876 * capacity. We are interested in the remaining descriptors, the
877 * formattable capacities.
879 for (i = 1; i < desc_cnt; i++) {
880 unsigned int desc_start = 4 + i*8;
882 if (u_index >= u_array_size)
883 break; /* User-supplied buffer too small */
885 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
886 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
888 if (put_user(blocks, argp))
893 if (put_user(length, argp))
901 if (put_user(u_index, arg))
908 * Get ATAPI_FORMAT_UNIT progress indication.
910 * Userland gives a pointer to an int. The int is set to a progress
911 * indicator 0-65536, with 65536=100%.
913 * If the drive does not support format progress indication, we just check
914 * the dsc bit, and return either 0 or 65536.
917 static int ide_floppy_get_format_progress(ide_drive_t *drive, int __user *arg)
919 idefloppy_floppy_t *floppy = drive->driver_data;
920 struct ide_atapi_pc pc;
921 int progress_indication = 0x10000;
924 idefloppy_create_request_sense_cmd(&pc);
925 if (idefloppy_queue_pc_tail(drive, &pc))
928 if (floppy->sense_key == 2 &&
931 progress_indication = floppy->progress_indication;
933 /* Else assume format_unit has finished, and we're at 0x10000 */
935 ide_hwif_t *hwif = drive->hwif;
939 local_irq_save(flags);
940 stat = hwif->tp_ops->read_status(hwif);
941 local_irq_restore(flags);
943 progress_indication = ((stat & ATA_DSC) == 0) ? 0 : 0x10000;
946 if (put_user(progress_indication, arg))
952 static sector_t idefloppy_capacity(ide_drive_t *drive)
954 idefloppy_floppy_t *floppy = drive->driver_data;
955 unsigned long capacity = floppy->blocks * floppy->bs_factor;
960 #ifdef CONFIG_IDE_PROC_FS
961 ide_devset_rw(bios_cyl, 0, 1023, bios_cyl);
962 ide_devset_rw(bios_head, 0, 255, bios_head);
963 ide_devset_rw(bios_sect, 0, 63, bios_sect);
965 static int get_ticks(ide_drive_t *drive)
967 idefloppy_floppy_t *floppy = drive->driver_data;
968 return floppy->ticks;
971 static int set_ticks(ide_drive_t *drive, int arg)
973 idefloppy_floppy_t *floppy = drive->driver_data;
978 IDE_DEVSET(ticks, S_RW, 0, 255, get_ticks, set_ticks);
980 static const struct ide_devset *idefloppy_settings[] = {
981 &ide_devset_bios_cyl,
982 &ide_devset_bios_head,
983 &ide_devset_bios_sect,
989 static void idefloppy_setup(ide_drive_t *drive, idefloppy_floppy_t *floppy)
994 *((u16 *)&gcw) = id[ATA_ID_CONFIG];
996 drive->pc_callback = ide_floppy_callback;
998 if (((gcw[0] & 0x60) >> 5) == 1)
999 drive->atapi_flags |= IDE_AFLAG_DRQ_INTERRUPT;
1001 * We used to check revisions here. At this point however I'm giving up.
1002 * Just assume they are all broken, its easier.
1004 * The actual reason for the workarounds was likely a driver bug after
1005 * all rather than a firmware bug, and the workaround below used to hide
1006 * it. It should be fixed as of version 1.9, but to be on the safe side
1007 * we'll leave the limitation below for the 2.2.x tree.
1009 if (!strncmp((char *)&id[ATA_ID_PROD], "IOMEGA ZIP 100 ATAPI", 20)) {
1010 drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE;
1011 /* This value will be visible in the /proc/ide/hdx/settings */
1012 floppy->ticks = IDEFLOPPY_TICKS_DELAY;
1013 blk_queue_max_sectors(drive->queue, 64);
1017 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
1018 * nasty clicking noises without it, so please don't remove this.
1020 if (strncmp((char *)&id[ATA_ID_PROD], "IOMEGA Clik!", 11) == 0) {
1021 blk_queue_max_sectors(drive->queue, 64);
1022 drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE;
1025 (void) ide_floppy_get_capacity(drive);
1027 ide_proc_register_driver(drive, floppy->driver);
1030 static void ide_floppy_remove(ide_drive_t *drive)
1032 idefloppy_floppy_t *floppy = drive->driver_data;
1033 struct gendisk *g = floppy->disk;
1035 ide_proc_unregister_driver(drive, floppy->driver);
1039 ide_floppy_put(floppy);
1042 static void idefloppy_cleanup_obj(struct kref *kref)
1044 struct ide_floppy_obj *floppy = to_ide_floppy(kref);
1045 ide_drive_t *drive = floppy->drive;
1046 struct gendisk *g = floppy->disk;
1048 drive->driver_data = NULL;
1049 g->private_data = NULL;
1054 #ifdef CONFIG_IDE_PROC_FS
1055 static int proc_idefloppy_read_capacity(char *page, char **start, off_t off,
1056 int count, int *eof, void *data)
1058 ide_drive_t*drive = (ide_drive_t *)data;
1061 len = sprintf(page, "%llu\n", (long long)idefloppy_capacity(drive));
1062 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1065 static ide_proc_entry_t idefloppy_proc[] = {
1066 { "capacity", S_IFREG|S_IRUGO, proc_idefloppy_read_capacity, NULL },
1067 { "geometry", S_IFREG|S_IRUGO, proc_ide_read_geometry, NULL },
1068 { NULL, 0, NULL, NULL }
1070 #endif /* CONFIG_IDE_PROC_FS */
1072 static int ide_floppy_probe(ide_drive_t *);
1074 static ide_driver_t idefloppy_driver = {
1076 .owner = THIS_MODULE,
1077 .name = "ide-floppy",
1078 .bus = &ide_bus_type,
1080 .probe = ide_floppy_probe,
1081 .remove = ide_floppy_remove,
1082 .version = IDEFLOPPY_VERSION,
1083 .media = ide_floppy,
1084 .do_request = idefloppy_do_request,
1085 .end_request = idefloppy_end_request,
1086 .error = __ide_error,
1087 #ifdef CONFIG_IDE_PROC_FS
1088 .proc = idefloppy_proc,
1089 .settings = idefloppy_settings,
1093 static int idefloppy_open(struct inode *inode, struct file *filp)
1095 struct gendisk *disk = inode->i_bdev->bd_disk;
1096 struct ide_floppy_obj *floppy;
1098 struct ide_atapi_pc pc;
1101 debug_log("Reached %s\n", __func__);
1103 floppy = ide_floppy_get(disk);
1107 drive = floppy->drive;
1111 if (floppy->openers == 1) {
1112 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1115 idefloppy_init_pc(&pc);
1116 pc.c[0] = GPCMD_TEST_UNIT_READY;
1118 if (idefloppy_queue_pc_tail(drive, &pc)) {
1119 idefloppy_create_start_stop_cmd(&pc, 1);
1120 (void) idefloppy_queue_pc_tail(drive, &pc);
1123 if (ide_floppy_get_capacity(drive)
1124 && (filp->f_flags & O_NDELAY) == 0
1126 * Allow O_NDELAY to open a drive without a disk, or with an
1127 * unreadable disk, so that we can get the format capacity
1128 * of the drive or begin the format - Sam
1132 goto out_put_floppy;
1135 if (floppy->wp && (filp->f_mode & 2)) {
1137 goto out_put_floppy;
1139 drive->atapi_flags |= IDE_AFLAG_MEDIA_CHANGED;
1140 /* IOMEGA Clik! drives do not support lock/unlock commands */
1141 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1142 idefloppy_create_prevent_cmd(&pc, 1);
1143 (void) idefloppy_queue_pc_tail(drive, &pc);
1145 check_disk_change(inode->i_bdev);
1146 } else if (drive->atapi_flags & IDE_AFLAG_FORMAT_IN_PROGRESS) {
1148 goto out_put_floppy;
1154 ide_floppy_put(floppy);
1158 static int idefloppy_release(struct inode *inode, struct file *filp)
1160 struct gendisk *disk = inode->i_bdev->bd_disk;
1161 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1162 ide_drive_t *drive = floppy->drive;
1163 struct ide_atapi_pc pc;
1165 debug_log("Reached %s\n", __func__);
1167 if (floppy->openers == 1) {
1168 /* IOMEGA Clik! drives do not support lock/unlock commands */
1169 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1170 idefloppy_create_prevent_cmd(&pc, 0);
1171 (void) idefloppy_queue_pc_tail(drive, &pc);
1174 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1179 ide_floppy_put(floppy);
1184 static int idefloppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1186 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1187 ide_drive_t *drive = floppy->drive;
1189 geo->heads = drive->bios_head;
1190 geo->sectors = drive->bios_sect;
1191 geo->cylinders = (u16)drive->bios_cyl; /* truncate */
1195 static int ide_floppy_lockdoor(ide_drive_t *drive, struct ide_atapi_pc *pc,
1196 unsigned long arg, unsigned int cmd)
1198 idefloppy_floppy_t *floppy = drive->driver_data;
1200 if (floppy->openers > 1)
1203 /* The IOMEGA Clik! Drive doesn't support this command -
1204 * no room for an eject mechanism */
1205 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1206 int prevent = arg ? 1 : 0;
1208 if (cmd == CDROMEJECT)
1211 idefloppy_create_prevent_cmd(pc, prevent);
1212 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1215 if (cmd == CDROMEJECT) {
1216 idefloppy_create_start_stop_cmd(pc, 2);
1217 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1223 static int ide_floppy_format_unit(ide_drive_t *drive, int __user *arg)
1225 idefloppy_floppy_t *floppy = drive->driver_data;
1226 struct ide_atapi_pc pc;
1227 int blocks, length, flags, err = 0;
1229 if (floppy->openers > 1) {
1230 /* Don't format if someone is using the disk */
1231 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1235 drive->atapi_flags |= IDE_AFLAG_FORMAT_IN_PROGRESS;
1238 * Send ATAPI_FORMAT_UNIT to the drive.
1240 * Userland gives us the following structure:
1242 * struct idefloppy_format_command {
1248 * flags is a bitmask, currently, the only defined flag is:
1250 * 0x01 - verify media after format.
1252 if (get_user(blocks, arg) ||
1253 get_user(length, arg+1) ||
1254 get_user(flags, arg+2)) {
1259 (void) idefloppy_get_sfrp_bit(drive);
1260 idefloppy_create_format_unit_cmd(&pc, blocks, length, flags);
1262 if (idefloppy_queue_pc_tail(drive, &pc))
1267 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1271 static int ide_floppy_format_ioctl(ide_drive_t *drive, struct file *file,
1272 unsigned int cmd, void __user *argp)
1275 case IDEFLOPPY_IOCTL_FORMAT_SUPPORTED:
1277 case IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY:
1278 return ide_floppy_get_format_capacities(drive, argp);
1279 case IDEFLOPPY_IOCTL_FORMAT_START:
1280 if (!(file->f_mode & 2))
1282 return ide_floppy_format_unit(drive, (int __user *)argp);
1283 case IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS:
1284 return ide_floppy_get_format_progress(drive, argp);
1290 static int idefloppy_ioctl(struct inode *inode, struct file *file,
1291 unsigned int cmd, unsigned long arg)
1293 struct block_device *bdev = inode->i_bdev;
1294 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1295 ide_drive_t *drive = floppy->drive;
1296 struct ide_atapi_pc pc;
1297 void __user *argp = (void __user *)arg;
1300 if (cmd == CDROMEJECT || cmd == CDROM_LOCKDOOR)
1301 return ide_floppy_lockdoor(drive, &pc, arg, cmd);
1303 err = ide_floppy_format_ioctl(drive, file, cmd, argp);
1308 * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
1309 * and CDROM_SEND_PACKET (legacy) ioctls
1311 if (cmd != CDROM_SEND_PACKET && cmd != SCSI_IOCTL_SEND_COMMAND)
1312 err = scsi_cmd_ioctl(file, bdev->bd_disk->queue,
1313 bdev->bd_disk, cmd, argp);
1316 err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
1321 static int idefloppy_media_changed(struct gendisk *disk)
1323 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1324 ide_drive_t *drive = floppy->drive;
1327 /* do not scan partitions twice if this is a removable device */
1328 if (drive->attach) {
1332 ret = !!(drive->atapi_flags & IDE_AFLAG_MEDIA_CHANGED);
1333 drive->atapi_flags &= ~IDE_AFLAG_MEDIA_CHANGED;
1337 static int idefloppy_revalidate_disk(struct gendisk *disk)
1339 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1340 set_capacity(disk, idefloppy_capacity(floppy->drive));
1344 static struct block_device_operations idefloppy_ops = {
1345 .owner = THIS_MODULE,
1346 .open = idefloppy_open,
1347 .release = idefloppy_release,
1348 .ioctl = idefloppy_ioctl,
1349 .getgeo = idefloppy_getgeo,
1350 .media_changed = idefloppy_media_changed,
1351 .revalidate_disk = idefloppy_revalidate_disk
1354 static int ide_floppy_probe(ide_drive_t *drive)
1356 idefloppy_floppy_t *floppy;
1359 if (!strstr("ide-floppy", drive->driver_req))
1362 if (drive->media != ide_floppy)
1365 if (!ide_check_atapi_device(drive, DRV_NAME)) {
1366 printk(KERN_ERR "ide-floppy: %s: not supported by this version"
1367 " of ide-floppy\n", drive->name);
1370 floppy = kzalloc(sizeof(idefloppy_floppy_t), GFP_KERNEL);
1372 printk(KERN_ERR "ide-floppy: %s: Can't allocate a floppy"
1373 " structure\n", drive->name);
1377 g = alloc_disk(1 << PARTN_BITS);
1379 goto out_free_floppy;
1381 ide_init_disk(g, drive);
1383 kref_init(&floppy->kref);
1385 floppy->drive = drive;
1386 floppy->driver = &idefloppy_driver;
1389 g->private_data = &floppy->driver;
1391 drive->driver_data = floppy;
1393 idefloppy_setup(drive, floppy);
1395 g->minors = 1 << PARTN_BITS;
1396 g->driverfs_dev = &drive->gendev;
1397 g->flags = drive->removable ? GENHD_FL_REMOVABLE : 0;
1398 g->fops = &idefloppy_ops;
1409 static void __exit idefloppy_exit(void)
1411 driver_unregister(&idefloppy_driver.gen_driver);
1414 static int __init idefloppy_init(void)
1416 printk("ide-floppy driver " IDEFLOPPY_VERSION "\n");
1417 return driver_register(&idefloppy_driver.gen_driver);
1420 MODULE_ALIAS("ide:*m-floppy*");
1421 module_init(idefloppy_init);
1422 module_exit(idefloppy_exit);
1423 MODULE_LICENSE("GPL");
1424 MODULE_DESCRIPTION("ATAPI FLOPPY Driver");