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
79 * In various places in the driver, we need to allocate storage for packet
80 * commands and requests, which will remain valid while we leave the driver to
81 * wait for an interrupt or a timeout event.
83 #define IDEFLOPPY_PC_STACK (10 + IDEFLOPPY_MAX_PC_RETRIES)
85 /* format capacities descriptor codes */
86 #define CAPACITY_INVALID 0x00
87 #define CAPACITY_UNFORMATTED 0x01
88 #define CAPACITY_CURRENT 0x02
89 #define CAPACITY_NO_CARTRIDGE 0x03
92 * Most of our global data which we need to save even as we leave the driver
93 * due to an interrupt or a timer event is stored in a variable of type
94 * idefloppy_floppy_t, defined below.
96 typedef struct ide_floppy_obj {
101 unsigned int openers; /* protected by BKL for now */
103 /* Current packet command */
104 struct ide_atapi_pc *pc;
105 /* Last failed packet command */
106 struct ide_atapi_pc *failed_pc;
107 /* Packet command stack */
108 struct ide_atapi_pc pc_stack[IDEFLOPPY_PC_STACK];
109 /* Next free packet command storage space */
111 struct request rq_stack[IDEFLOPPY_PC_STACK];
112 /* We implement a circular array */
115 /* Last error information */
116 u8 sense_key, asc, ascq;
117 /* delay this long before sending packet command */
119 int progress_indication;
121 /* Device information */
123 int blocks, block_size, bs_factor;
124 /* Last format capacity descriptor */
126 /* Copy of the flexible disk page */
127 u8 flexible_disk_page[32];
130 /* Supports format progress report */
132 } idefloppy_floppy_t;
134 #define IDEFLOPPY_TICKS_DELAY HZ/20 /* default delay for ZIP 100 (50ms) */
136 /* Defines for the MODE SENSE command */
137 #define MODE_SENSE_CURRENT 0x00
138 #define MODE_SENSE_CHANGEABLE 0x01
139 #define MODE_SENSE_DEFAULT 0x02
140 #define MODE_SENSE_SAVED 0x03
142 /* IOCTLs used in low-level formatting. */
143 #define IDEFLOPPY_IOCTL_FORMAT_SUPPORTED 0x4600
144 #define IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY 0x4601
145 #define IDEFLOPPY_IOCTL_FORMAT_START 0x4602
146 #define IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS 0x4603
148 /* Error code returned in rq->errors to the higher part of the driver. */
149 #define IDEFLOPPY_ERROR_GENERAL 101
152 * Pages of the SELECT SENSE / MODE SENSE packet commands.
153 * See SFF-8070i spec.
155 #define IDEFLOPPY_CAPABILITIES_PAGE 0x1b
156 #define IDEFLOPPY_FLEXIBLE_DISK_PAGE 0x05
158 static DEFINE_MUTEX(idefloppy_ref_mutex);
160 #define to_ide_floppy(obj) container_of(obj, struct ide_floppy_obj, kref)
162 #define ide_floppy_g(disk) \
163 container_of((disk)->private_data, struct ide_floppy_obj, driver)
165 static void idefloppy_cleanup_obj(struct kref *);
167 static struct ide_floppy_obj *ide_floppy_get(struct gendisk *disk)
169 struct ide_floppy_obj *floppy = NULL;
171 mutex_lock(&idefloppy_ref_mutex);
172 floppy = ide_floppy_g(disk);
174 if (ide_device_get(floppy->drive))
177 kref_get(&floppy->kref);
179 mutex_unlock(&idefloppy_ref_mutex);
183 static void ide_floppy_put(struct ide_floppy_obj *floppy)
185 ide_drive_t *drive = floppy->drive;
187 mutex_lock(&idefloppy_ref_mutex);
188 kref_put(&floppy->kref, idefloppy_cleanup_obj);
189 ide_device_put(drive);
190 mutex_unlock(&idefloppy_ref_mutex);
194 * Used to finish servicing a request. For read/write requests, we will call
195 * ide_end_request to pass to the next buffer.
197 static int idefloppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
199 idefloppy_floppy_t *floppy = drive->driver_data;
200 struct request *rq = HWGROUP(drive)->rq;
203 debug_log("Reached %s\n", __func__);
206 case 0: error = IDEFLOPPY_ERROR_GENERAL; break;
207 case 1: error = 0; break;
208 default: error = uptodate;
211 floppy->failed_pc = NULL;
212 /* Why does this happen? */
215 if (!blk_special_request(rq)) {
216 /* our real local end request function */
217 ide_end_request(drive, uptodate, nsecs);
221 /* fixme: need to move this local also */
222 ide_end_drive_cmd(drive, 0, 0);
226 static void ide_floppy_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
227 unsigned int bcount, int direction)
229 ide_hwif_t *hwif = drive->hwif;
230 const struct ide_tp_ops *tp_ops = hwif->tp_ops;
231 xfer_func_t *xf = direction ? tp_ops->output_data : tp_ops->input_data;
232 struct scatterlist *sg = pc->sg;
237 count = min(sg->length - pc->b_count, bcount);
238 if (PageHighMem(sg_page(sg))) {
241 local_irq_save(flags);
242 buf = kmap_atomic(sg_page(sg), KM_IRQ0) + sg->offset;
243 xf(drive, NULL, buf + pc->b_count, count);
244 kunmap_atomic(buf - sg->offset, KM_IRQ0);
245 local_irq_restore(flags);
248 xf(drive, NULL, buf + pc->b_count, count);
251 pc->b_count += count;
254 if (pc->b_count == sg->length) {
257 pc->sg = sg = sg_next(sg);
262 idefloppy_end_request(drive, 1, done >> 9);
265 printk(KERN_ERR "%s: leftover data in %s, bcount == %d\n",
266 drive->name, __func__, bcount);
267 ide_pad_transfer(drive, direction, bcount);
271 static void idefloppy_update_buffers(ide_drive_t *drive,
272 struct ide_atapi_pc *pc)
274 struct request *rq = pc->rq;
275 struct bio *bio = rq->bio;
277 while ((bio = rq->bio) != NULL)
278 idefloppy_end_request(drive, 1, 0);
282 * Generate a new packet command request in front of the request queue, before
283 * the current request so that it will be processed immediately, on the next
284 * pass through the driver.
286 static void idefloppy_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
289 struct ide_floppy_obj *floppy = drive->driver_data;
291 blk_rq_init(NULL, rq);
292 rq->buffer = (char *) pc;
293 rq->cmd_type = REQ_TYPE_SPECIAL;
294 rq->cmd_flags |= REQ_PREEMPT;
295 rq->rq_disk = floppy->disk;
296 memcpy(rq->cmd, pc->c, 12);
297 ide_do_drive_cmd(drive, rq);
300 static struct ide_atapi_pc *idefloppy_next_pc_storage(ide_drive_t *drive)
302 idefloppy_floppy_t *floppy = drive->driver_data;
304 if (floppy->pc_stack_index == IDEFLOPPY_PC_STACK)
305 floppy->pc_stack_index = 0;
306 return (&floppy->pc_stack[floppy->pc_stack_index++]);
309 static struct request *idefloppy_next_rq_storage(ide_drive_t *drive)
311 idefloppy_floppy_t *floppy = drive->driver_data;
313 if (floppy->rq_stack_index == IDEFLOPPY_PC_STACK)
314 floppy->rq_stack_index = 0;
315 return (&floppy->rq_stack[floppy->rq_stack_index++]);
318 static void ide_floppy_callback(ide_drive_t *drive)
320 idefloppy_floppy_t *floppy = drive->driver_data;
321 struct ide_atapi_pc *pc = floppy->pc;
322 int uptodate = pc->error ? 0 : 1;
324 debug_log("Reached %s\n", __func__);
326 if (floppy->failed_pc == pc)
327 floppy->failed_pc = NULL;
329 if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
330 (pc->rq && blk_pc_request(pc->rq)))
331 uptodate = 1; /* FIXME */
332 else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
333 u8 *buf = floppy->pc->buf;
336 floppy->sense_key = buf[2] & 0x0F;
337 floppy->asc = buf[12];
338 floppy->ascq = buf[13];
339 floppy->progress_indication = buf[15] & 0x80 ?
340 (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
342 if (floppy->failed_pc)
343 debug_log("pc = %x, ", floppy->failed_pc->c[0]);
345 debug_log("sense key = %x, asc = %x, ascq = %x\n",
346 floppy->sense_key, floppy->asc, floppy->ascq);
348 printk(KERN_ERR "Error in REQUEST SENSE itself - "
349 "Aborting request!\n");
352 idefloppy_end_request(drive, uptodate, 0);
355 static void idefloppy_init_pc(struct ide_atapi_pc *pc)
357 memset(pc, 0, sizeof(*pc));
358 pc->buf = pc->pc_buf;
359 pc->buf_size = IDEFLOPPY_PC_BUFFER_SIZE;
362 static void idefloppy_create_request_sense_cmd(struct ide_atapi_pc *pc)
364 idefloppy_init_pc(pc);
365 pc->c[0] = GPCMD_REQUEST_SENSE;
371 * Called when an error was detected during the last packet command. We queue a
372 * request sense packet command in the head of the request list.
374 static void idefloppy_retry_pc(ide_drive_t *drive)
376 struct ide_atapi_pc *pc;
379 (void)ide_read_error(drive);
380 pc = idefloppy_next_pc_storage(drive);
381 rq = idefloppy_next_rq_storage(drive);
382 idefloppy_create_request_sense_cmd(pc);
383 idefloppy_queue_pc_head(drive, pc, rq);
386 /* The usual interrupt handler called during a packet command. */
387 static ide_startstop_t idefloppy_pc_intr(ide_drive_t *drive)
389 idefloppy_floppy_t *floppy = drive->driver_data;
391 return ide_pc_intr(drive, floppy->pc, idefloppy_pc_intr,
392 IDEFLOPPY_WAIT_CMD, NULL, idefloppy_update_buffers,
393 idefloppy_retry_pc, NULL, ide_floppy_io_buffers);
397 * What we have here is a classic case of a top half / bottom half interrupt
398 * service routine. In interrupt mode, the device sends an interrupt to signal
399 * that it is ready to receive a packet. However, we need to delay about 2-3
400 * ticks before issuing the packet or we gets in trouble.
402 static int idefloppy_transfer_pc(ide_drive_t *drive)
404 idefloppy_floppy_t *floppy = drive->driver_data;
406 /* Send the actual packet */
407 drive->hwif->tp_ops->output_data(drive, NULL, floppy->pc->c, 12);
409 /* Timeout for the packet command */
410 return IDEFLOPPY_WAIT_CMD;
415 * Called as an interrupt (or directly). When the device says it's ready for a
416 * packet, we schedule the packet transfer to occur about 2-3 ticks later in
419 static ide_startstop_t idefloppy_start_pc_transfer(ide_drive_t *drive)
421 idefloppy_floppy_t *floppy = drive->driver_data;
422 struct ide_atapi_pc *pc = floppy->pc;
423 ide_expiry_t *expiry;
424 unsigned int timeout;
427 * The following delay solves a problem with ATAPI Zip 100 drives
428 * where the Busy flag was apparently being deasserted before the
429 * unit was ready to receive data. This was happening on a
430 * 1200 MHz Athlon system. 10/26/01 25msec is too short,
431 * 40 and 50msec work well. idefloppy_pc_intr will not be actually
432 * used until after the packet is moved in about 50 msec.
434 if (drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) {
435 timeout = floppy->ticks;
436 expiry = &idefloppy_transfer_pc;
438 timeout = IDEFLOPPY_WAIT_CMD;
442 return ide_transfer_pc(drive, pc, idefloppy_pc_intr, timeout, expiry);
445 static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
446 struct ide_atapi_pc *pc)
448 /* supress error messages resulting from Medium not present */
449 if (floppy->sense_key == 0x02 &&
450 floppy->asc == 0x3a &&
451 floppy->ascq == 0x00)
454 printk(KERN_ERR "ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
455 "asc = %2x, ascq = %2x\n",
456 floppy->drive->name, pc->c[0], floppy->sense_key,
457 floppy->asc, floppy->ascq);
461 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
462 struct ide_atapi_pc *pc)
464 idefloppy_floppy_t *floppy = drive->driver_data;
466 if (floppy->failed_pc == NULL &&
467 pc->c[0] != GPCMD_REQUEST_SENSE)
468 floppy->failed_pc = pc;
469 /* Set the current packet command */
472 if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
473 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
474 ide_floppy_report_error(floppy, pc);
476 pc->error = IDEFLOPPY_ERROR_GENERAL;
478 floppy->failed_pc = NULL;
479 drive->pc_callback(drive);
483 debug_log("Retry number - %d\n", pc->retries);
487 return ide_issue_pc(drive, pc, idefloppy_start_pc_transfer,
488 IDEFLOPPY_WAIT_CMD, NULL);
491 static void idefloppy_create_prevent_cmd(struct ide_atapi_pc *pc, int prevent)
493 debug_log("creating prevent removal command, prevent = %d\n", prevent);
495 idefloppy_init_pc(pc);
496 pc->c[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL;
500 static void idefloppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
502 idefloppy_init_pc(pc);
503 pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
509 static void idefloppy_create_format_unit_cmd(struct ide_atapi_pc *pc, int b,
512 idefloppy_init_pc(pc);
513 pc->c[0] = GPCMD_FORMAT_UNIT;
516 memset(pc->buf, 0, 12);
518 /* Default format list header, u8 1: FOV/DCRT/IMM bits set */
520 if (flags & 1) /* Verify bit on... */
521 pc->buf[1] ^= 0x20; /* ... turn off DCRT bit */
524 put_unaligned(cpu_to_be32(b), (unsigned int *)(&pc->buf[4]));
525 put_unaligned(cpu_to_be32(l), (unsigned int *)(&pc->buf[8]));
527 pc->flags |= PC_FLAG_WRITING;
530 /* A mode sense command is used to "sense" floppy parameters. */
531 static void idefloppy_create_mode_sense_cmd(struct ide_atapi_pc *pc,
532 u8 page_code, u8 type)
534 u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
536 idefloppy_init_pc(pc);
537 pc->c[0] = GPCMD_MODE_SENSE_10;
539 pc->c[2] = page_code + (type << 6);
542 case IDEFLOPPY_CAPABILITIES_PAGE:
545 case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
549 printk(KERN_ERR "ide-floppy: unsupported page code "
550 "in create_mode_sense_cmd\n");
552 put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
553 pc->req_xfer = length;
556 static void idefloppy_create_start_stop_cmd(struct ide_atapi_pc *pc, int start)
558 idefloppy_init_pc(pc);
559 pc->c[0] = GPCMD_START_STOP_UNIT;
563 static void idefloppy_create_rw_cmd(idefloppy_floppy_t *floppy,
564 struct ide_atapi_pc *pc, struct request *rq,
565 unsigned long sector)
567 int block = sector / floppy->bs_factor;
568 int blocks = rq->nr_sectors / floppy->bs_factor;
569 int cmd = rq_data_dir(rq);
571 debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
574 idefloppy_init_pc(pc);
575 pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
576 put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
577 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
579 memcpy(rq->cmd, pc->c, 12);
583 if (rq->cmd_flags & REQ_RW)
584 pc->flags |= PC_FLAG_WRITING;
586 pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
587 pc->flags |= PC_FLAG_DMA_OK;
590 static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
591 struct ide_atapi_pc *pc, struct request *rq)
593 idefloppy_init_pc(pc);
594 memcpy(pc->c, rq->cmd, sizeof(pc->c));
597 if (rq->data_len && rq_data_dir(rq) == WRITE)
598 pc->flags |= PC_FLAG_WRITING;
601 pc->flags |= PC_FLAG_DMA_OK;
603 * possibly problematic, doesn't look like ide-floppy correctly
604 * handled scattered requests if dma fails...
606 pc->req_xfer = pc->buf_size = rq->data_len;
609 static ide_startstop_t idefloppy_do_request(ide_drive_t *drive,
610 struct request *rq, sector_t block_s)
612 idefloppy_floppy_t *floppy = drive->driver_data;
613 ide_hwif_t *hwif = drive->hwif;
614 struct ide_atapi_pc *pc;
615 unsigned long block = (unsigned long)block_s;
617 debug_log("%s: dev: %s, cmd: 0x%x, cmd_type: %x, errors: %d\n",
618 __func__, rq->rq_disk ? rq->rq_disk->disk_name : "?",
619 rq->cmd[0], rq->cmd_type, rq->errors);
621 debug_log("%s: sector: %ld, nr_sectors: %ld, current_nr_sectors: %d\n",
622 __func__, (long)rq->sector, rq->nr_sectors,
623 rq->current_nr_sectors);
625 if (rq->errors >= ERROR_MAX) {
626 if (floppy->failed_pc)
627 ide_floppy_report_error(floppy, floppy->failed_pc);
629 printk(KERN_ERR "ide-floppy: %s: I/O error\n",
631 idefloppy_end_request(drive, 0, 0);
634 if (blk_fs_request(rq)) {
635 if (((long)rq->sector % floppy->bs_factor) ||
636 (rq->nr_sectors % floppy->bs_factor)) {
637 printk(KERN_ERR "%s: unsupported r/w request size\n",
639 idefloppy_end_request(drive, 0, 0);
642 pc = idefloppy_next_pc_storage(drive);
643 idefloppy_create_rw_cmd(floppy, pc, rq, block);
644 } else if (blk_special_request(rq)) {
645 pc = (struct ide_atapi_pc *) rq->buffer;
646 } else if (blk_pc_request(rq)) {
647 pc = idefloppy_next_pc_storage(drive);
648 idefloppy_blockpc_cmd(floppy, pc, rq);
650 blk_dump_rq_flags(rq,
651 "ide-floppy: unsupported command in queue");
652 idefloppy_end_request(drive, 0, 0);
656 ide_init_sg_cmd(drive, rq);
657 ide_map_sg(drive, rq);
659 pc->sg = hwif->sg_table;
660 pc->sg_cnt = hwif->sg_nents;
664 return idefloppy_issue_pc(drive, pc);
668 * Add a special packet command request to the tail of the request queue,
669 * and wait for it to be serviced.
671 static int idefloppy_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
673 struct ide_floppy_obj *floppy = drive->driver_data;
677 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
678 rq->buffer = (char *) pc;
679 rq->cmd_type = REQ_TYPE_SPECIAL;
680 memcpy(rq->cmd, pc->c, 12);
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_cpup((__be16 *)&pc.buf[8 + 2]);
713 sector_size = be16_to_cpup((__be16 *)&pc.buf[8 + 6]);
714 cyls = be16_to_cpup((__be16 *)&pc.buf[8 + 8]);
715 rpm = be16_to_cpup((__be16 *)&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_cpup((__be32 *)&pc.buf[desc_start]);
791 length = be16_to_cpup((__be16 *)&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 (!(drive->atapi_flags & IDE_AFLAG_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 (!(drive->atapi_flags & IDE_AFLAG_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");
896 header_len = pc.buf[3];
897 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
903 * We always skip the first capacity descriptor. That's the current
904 * capacity. We are interested in the remaining descriptors, the
905 * formattable capacities.
907 for (i = 1; i < desc_cnt; i++) {
908 unsigned int desc_start = 4 + i*8;
910 if (u_index >= u_array_size)
911 break; /* User-supplied buffer too small */
913 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
914 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
916 if (put_user(blocks, argp))
921 if (put_user(length, argp))
929 if (put_user(u_index, arg))
936 * Get ATAPI_FORMAT_UNIT progress indication.
938 * Userland gives a pointer to an int. The int is set to a progress
939 * indicator 0-65536, with 65536=100%.
941 * If the drive does not support format progress indication, we just check
942 * the dsc bit, and return either 0 or 65536.
945 static int ide_floppy_get_format_progress(ide_drive_t *drive, int __user *arg)
947 idefloppy_floppy_t *floppy = drive->driver_data;
948 struct ide_atapi_pc pc;
949 int progress_indication = 0x10000;
952 idefloppy_create_request_sense_cmd(&pc);
953 if (idefloppy_queue_pc_tail(drive, &pc))
956 if (floppy->sense_key == 2 &&
959 progress_indication = floppy->progress_indication;
961 /* Else assume format_unit has finished, and we're at 0x10000 */
963 ide_hwif_t *hwif = drive->hwif;
967 local_irq_save(flags);
968 stat = hwif->tp_ops->read_status(hwif);
969 local_irq_restore(flags);
971 progress_indication = ((stat & ATA_DSC) == 0) ? 0 : 0x10000;
974 if (put_user(progress_indication, arg))
980 static sector_t idefloppy_capacity(ide_drive_t *drive)
982 idefloppy_floppy_t *floppy = drive->driver_data;
983 unsigned long capacity = floppy->blocks * floppy->bs_factor;
988 #ifdef CONFIG_IDE_PROC_FS
989 ide_devset_rw(bios_cyl, 0, 1023, bios_cyl);
990 ide_devset_rw(bios_head, 0, 255, bios_head);
991 ide_devset_rw(bios_sect, 0, 63, bios_sect);
993 static int get_ticks(ide_drive_t *drive)
995 idefloppy_floppy_t *floppy = drive->driver_data;
996 return floppy->ticks;
999 static int set_ticks(ide_drive_t *drive, int arg)
1001 idefloppy_floppy_t *floppy = drive->driver_data;
1002 floppy->ticks = arg;
1006 IDE_DEVSET(ticks, S_RW, 0, 255, get_ticks, set_ticks);
1008 static const struct ide_devset *idefloppy_settings[] = {
1009 &ide_devset_bios_cyl,
1010 &ide_devset_bios_head,
1011 &ide_devset_bios_sect,
1017 static void idefloppy_setup(ide_drive_t *drive, idefloppy_floppy_t *floppy)
1019 u16 *id = drive->id;
1022 *((u16 *)&gcw) = id[ATA_ID_CONFIG];
1023 floppy->pc = floppy->pc_stack;
1024 drive->pc_callback = ide_floppy_callback;
1026 if (((gcw[0] & 0x60) >> 5) == 1)
1027 drive->atapi_flags |= IDE_AFLAG_DRQ_INTERRUPT;
1029 * We used to check revisions here. At this point however I'm giving up.
1030 * Just assume they are all broken, its easier.
1032 * The actual reason for the workarounds was likely a driver bug after
1033 * all rather than a firmware bug, and the workaround below used to hide
1034 * it. It should be fixed as of version 1.9, but to be on the safe side
1035 * we'll leave the limitation below for the 2.2.x tree.
1037 if (!strncmp((char *)&id[ATA_ID_PROD], "IOMEGA ZIP 100 ATAPI", 20)) {
1038 drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE;
1039 /* This value will be visible in the /proc/ide/hdx/settings */
1040 floppy->ticks = IDEFLOPPY_TICKS_DELAY;
1041 blk_queue_max_sectors(drive->queue, 64);
1045 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
1046 * nasty clicking noises without it, so please don't remove this.
1048 if (strncmp((char *)&id[ATA_ID_PROD], "IOMEGA Clik!", 11) == 0) {
1049 blk_queue_max_sectors(drive->queue, 64);
1050 drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE;
1053 (void) ide_floppy_get_capacity(drive);
1055 ide_proc_register_driver(drive, floppy->driver);
1058 static void ide_floppy_remove(ide_drive_t *drive)
1060 idefloppy_floppy_t *floppy = drive->driver_data;
1061 struct gendisk *g = floppy->disk;
1063 ide_proc_unregister_driver(drive, floppy->driver);
1067 ide_floppy_put(floppy);
1070 static void idefloppy_cleanup_obj(struct kref *kref)
1072 struct ide_floppy_obj *floppy = to_ide_floppy(kref);
1073 ide_drive_t *drive = floppy->drive;
1074 struct gendisk *g = floppy->disk;
1076 drive->driver_data = NULL;
1077 g->private_data = NULL;
1082 #ifdef CONFIG_IDE_PROC_FS
1083 static int proc_idefloppy_read_capacity(char *page, char **start, off_t off,
1084 int count, int *eof, void *data)
1086 ide_drive_t*drive = (ide_drive_t *)data;
1089 len = sprintf(page, "%llu\n", (long long)idefloppy_capacity(drive));
1090 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1093 static ide_proc_entry_t idefloppy_proc[] = {
1094 { "capacity", S_IFREG|S_IRUGO, proc_idefloppy_read_capacity, NULL },
1095 { "geometry", S_IFREG|S_IRUGO, proc_ide_read_geometry, NULL },
1096 { NULL, 0, NULL, NULL }
1098 #endif /* CONFIG_IDE_PROC_FS */
1100 static int ide_floppy_probe(ide_drive_t *);
1102 static ide_driver_t idefloppy_driver = {
1104 .owner = THIS_MODULE,
1105 .name = "ide-floppy",
1106 .bus = &ide_bus_type,
1108 .probe = ide_floppy_probe,
1109 .remove = ide_floppy_remove,
1110 .version = IDEFLOPPY_VERSION,
1111 .media = ide_floppy,
1112 .do_request = idefloppy_do_request,
1113 .end_request = idefloppy_end_request,
1114 .error = __ide_error,
1115 #ifdef CONFIG_IDE_PROC_FS
1116 .proc = idefloppy_proc,
1117 .settings = idefloppy_settings,
1121 static int idefloppy_open(struct inode *inode, struct file *filp)
1123 struct gendisk *disk = inode->i_bdev->bd_disk;
1124 struct ide_floppy_obj *floppy;
1126 struct ide_atapi_pc pc;
1129 debug_log("Reached %s\n", __func__);
1131 floppy = ide_floppy_get(disk);
1135 drive = floppy->drive;
1139 if (floppy->openers == 1) {
1140 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1143 idefloppy_init_pc(&pc);
1144 pc.c[0] = GPCMD_TEST_UNIT_READY;
1146 if (idefloppy_queue_pc_tail(drive, &pc)) {
1147 idefloppy_create_start_stop_cmd(&pc, 1);
1148 (void) idefloppy_queue_pc_tail(drive, &pc);
1151 if (ide_floppy_get_capacity(drive)
1152 && (filp->f_flags & O_NDELAY) == 0
1154 * Allow O_NDELAY to open a drive without a disk, or with an
1155 * unreadable disk, so that we can get the format capacity
1156 * of the drive or begin the format - Sam
1160 goto out_put_floppy;
1163 if (floppy->wp && (filp->f_mode & 2)) {
1165 goto out_put_floppy;
1167 drive->atapi_flags |= IDE_AFLAG_MEDIA_CHANGED;
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, 1);
1171 (void) idefloppy_queue_pc_tail(drive, &pc);
1173 check_disk_change(inode->i_bdev);
1174 } else if (drive->atapi_flags & IDE_AFLAG_FORMAT_IN_PROGRESS) {
1176 goto out_put_floppy;
1182 ide_floppy_put(floppy);
1186 static int idefloppy_release(struct inode *inode, struct file *filp)
1188 struct gendisk *disk = inode->i_bdev->bd_disk;
1189 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1190 ide_drive_t *drive = floppy->drive;
1191 struct ide_atapi_pc pc;
1193 debug_log("Reached %s\n", __func__);
1195 if (floppy->openers == 1) {
1196 /* IOMEGA Clik! drives do not support lock/unlock commands */
1197 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1198 idefloppy_create_prevent_cmd(&pc, 0);
1199 (void) idefloppy_queue_pc_tail(drive, &pc);
1202 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1207 ide_floppy_put(floppy);
1212 static int idefloppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1214 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1215 ide_drive_t *drive = floppy->drive;
1217 geo->heads = drive->bios_head;
1218 geo->sectors = drive->bios_sect;
1219 geo->cylinders = (u16)drive->bios_cyl; /* truncate */
1223 static int ide_floppy_lockdoor(ide_drive_t *drive, struct ide_atapi_pc *pc,
1224 unsigned long arg, unsigned int cmd)
1226 idefloppy_floppy_t *floppy = drive->driver_data;
1228 if (floppy->openers > 1)
1231 /* The IOMEGA Clik! Drive doesn't support this command -
1232 * no room for an eject mechanism */
1233 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1234 int prevent = arg ? 1 : 0;
1236 if (cmd == CDROMEJECT)
1239 idefloppy_create_prevent_cmd(pc, prevent);
1240 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1243 if (cmd == CDROMEJECT) {
1244 idefloppy_create_start_stop_cmd(pc, 2);
1245 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1251 static int ide_floppy_format_unit(ide_drive_t *drive, int __user *arg)
1253 idefloppy_floppy_t *floppy = drive->driver_data;
1254 struct ide_atapi_pc pc;
1255 int blocks, length, flags, err = 0;
1257 if (floppy->openers > 1) {
1258 /* Don't format if someone is using the disk */
1259 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1263 drive->atapi_flags |= IDE_AFLAG_FORMAT_IN_PROGRESS;
1266 * Send ATAPI_FORMAT_UNIT to the drive.
1268 * Userland gives us the following structure:
1270 * struct idefloppy_format_command {
1276 * flags is a bitmask, currently, the only defined flag is:
1278 * 0x01 - verify media after format.
1280 if (get_user(blocks, arg) ||
1281 get_user(length, arg+1) ||
1282 get_user(flags, arg+2)) {
1287 (void) idefloppy_get_sfrp_bit(drive);
1288 idefloppy_create_format_unit_cmd(&pc, blocks, length, flags);
1290 if (idefloppy_queue_pc_tail(drive, &pc))
1295 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1299 static int ide_floppy_format_ioctl(ide_drive_t *drive, struct file *file,
1300 unsigned int cmd, void __user *argp)
1303 case IDEFLOPPY_IOCTL_FORMAT_SUPPORTED:
1305 case IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY:
1306 return ide_floppy_get_format_capacities(drive, argp);
1307 case IDEFLOPPY_IOCTL_FORMAT_START:
1308 if (!(file->f_mode & 2))
1310 return ide_floppy_format_unit(drive, (int __user *)argp);
1311 case IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS:
1312 return ide_floppy_get_format_progress(drive, argp);
1318 static int idefloppy_ioctl(struct inode *inode, struct file *file,
1319 unsigned int cmd, unsigned long arg)
1321 struct block_device *bdev = inode->i_bdev;
1322 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1323 ide_drive_t *drive = floppy->drive;
1324 struct ide_atapi_pc pc;
1325 void __user *argp = (void __user *)arg;
1328 if (cmd == CDROMEJECT || cmd == CDROM_LOCKDOOR)
1329 return ide_floppy_lockdoor(drive, &pc, arg, cmd);
1331 err = ide_floppy_format_ioctl(drive, file, cmd, 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);
1344 err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
1349 static int idefloppy_media_changed(struct gendisk *disk)
1351 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1352 ide_drive_t *drive = floppy->drive;
1355 /* do not scan partitions twice if this is a removable device */
1356 if (drive->attach) {
1360 ret = !!(drive->atapi_flags & IDE_AFLAG_MEDIA_CHANGED);
1361 drive->atapi_flags &= ~IDE_AFLAG_MEDIA_CHANGED;
1365 static int idefloppy_revalidate_disk(struct gendisk *disk)
1367 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1368 set_capacity(disk, idefloppy_capacity(floppy->drive));
1372 static struct block_device_operations idefloppy_ops = {
1373 .owner = THIS_MODULE,
1374 .open = idefloppy_open,
1375 .release = idefloppy_release,
1376 .ioctl = idefloppy_ioctl,
1377 .getgeo = idefloppy_getgeo,
1378 .media_changed = idefloppy_media_changed,
1379 .revalidate_disk = idefloppy_revalidate_disk
1382 static int ide_floppy_probe(ide_drive_t *drive)
1384 idefloppy_floppy_t *floppy;
1387 if (!strstr("ide-floppy", drive->driver_req))
1390 if (drive->media != ide_floppy)
1393 if (!ide_check_atapi_device(drive, DRV_NAME)) {
1394 printk(KERN_ERR "ide-floppy: %s: not supported by this version"
1395 " of ide-floppy\n", drive->name);
1398 floppy = kzalloc(sizeof(idefloppy_floppy_t), GFP_KERNEL);
1400 printk(KERN_ERR "ide-floppy: %s: Can't allocate a floppy"
1401 " structure\n", drive->name);
1405 g = alloc_disk(1 << PARTN_BITS);
1407 goto out_free_floppy;
1409 ide_init_disk(g, drive);
1411 kref_init(&floppy->kref);
1413 floppy->drive = drive;
1414 floppy->driver = &idefloppy_driver;
1417 g->private_data = &floppy->driver;
1419 drive->driver_data = floppy;
1421 idefloppy_setup(drive, floppy);
1423 g->minors = 1 << PARTN_BITS;
1424 g->driverfs_dev = &drive->gendev;
1425 g->flags = drive->removable ? GENHD_FL_REMOVABLE : 0;
1426 g->fops = &idefloppy_ops;
1437 static void __exit idefloppy_exit(void)
1439 driver_unregister(&idefloppy_driver.gen_driver);
1442 static int __init idefloppy_init(void)
1444 printk("ide-floppy driver " IDEFLOPPY_VERSION "\n");
1445 return driver_register(&idefloppy_driver.gen_driver);
1448 MODULE_ALIAS("ide:*m-floppy*");
1449 module_init(idefloppy_init);
1450 module_exit(idefloppy_exit);
1451 MODULE_LICENSE("GPL");
1452 MODULE_DESCRIPTION("ATAPI FLOPPY Driver");