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 struct ide_floppy_obj *ide_floppy_get(struct gendisk *disk)
163 struct ide_floppy_obj *floppy = NULL;
165 mutex_lock(&idefloppy_ref_mutex);
166 floppy = ide_floppy_g(disk);
168 kref_get(&floppy->kref);
169 mutex_unlock(&idefloppy_ref_mutex);
173 static void idefloppy_cleanup_obj(struct kref *);
175 static void ide_floppy_put(struct ide_floppy_obj *floppy)
177 mutex_lock(&idefloppy_ref_mutex);
178 kref_put(&floppy->kref, idefloppy_cleanup_obj);
179 mutex_unlock(&idefloppy_ref_mutex);
183 * Used to finish servicing a request. For read/write requests, we will call
184 * ide_end_request to pass to the next buffer.
186 static int idefloppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
188 idefloppy_floppy_t *floppy = drive->driver_data;
189 struct request *rq = HWGROUP(drive)->rq;
192 debug_log("Reached %s\n", __func__);
195 case 0: error = IDEFLOPPY_ERROR_GENERAL; break;
196 case 1: error = 0; break;
197 default: error = uptodate;
200 floppy->failed_pc = NULL;
201 /* Why does this happen? */
204 if (!blk_special_request(rq)) {
205 /* our real local end request function */
206 ide_end_request(drive, uptodate, nsecs);
210 /* fixme: need to move this local also */
211 ide_end_drive_cmd(drive, 0, 0);
215 static void ide_floppy_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
216 unsigned int bcount, int direction)
218 ide_hwif_t *hwif = drive->hwif;
219 struct request *rq = pc->rq;
220 struct req_iterator iter;
221 struct bio_vec *bvec;
226 rq_for_each_segment(bvec, rq, iter) {
230 count = min(bvec->bv_len, bcount);
232 data = bvec_kmap_irq(bvec, &flags);
234 hwif->tp_ops->output_data(drive, NULL, data, count);
236 hwif->tp_ops->input_data(drive, NULL, data, count);
237 bvec_kunmap_irq(data, &flags);
240 pc->b_count += count;
244 idefloppy_end_request(drive, 1, done >> 9);
247 printk(KERN_ERR "%s: leftover data in %s, bcount == %d\n",
248 drive->name, __func__, bcount);
249 ide_pad_transfer(drive, direction, bcount);
253 static void idefloppy_update_buffers(ide_drive_t *drive,
254 struct ide_atapi_pc *pc)
256 struct request *rq = pc->rq;
257 struct bio *bio = rq->bio;
259 while ((bio = rq->bio) != NULL)
260 idefloppy_end_request(drive, 1, 0);
264 * Generate a new packet command request in front of the request queue, before
265 * the current request so that it will be processed immediately, on the next
266 * pass through the driver.
268 static void idefloppy_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
271 struct ide_floppy_obj *floppy = drive->driver_data;
273 blk_rq_init(NULL, rq);
274 rq->buffer = (char *) pc;
275 rq->cmd_type = REQ_TYPE_SPECIAL;
276 rq->cmd_flags |= REQ_PREEMPT;
277 rq->rq_disk = floppy->disk;
278 memcpy(rq->cmd, pc->c, 12);
279 ide_do_drive_cmd(drive, rq);
282 static struct ide_atapi_pc *idefloppy_next_pc_storage(ide_drive_t *drive)
284 idefloppy_floppy_t *floppy = drive->driver_data;
286 if (floppy->pc_stack_index == IDEFLOPPY_PC_STACK)
287 floppy->pc_stack_index = 0;
288 return (&floppy->pc_stack[floppy->pc_stack_index++]);
291 static struct request *idefloppy_next_rq_storage(ide_drive_t *drive)
293 idefloppy_floppy_t *floppy = drive->driver_data;
295 if (floppy->rq_stack_index == IDEFLOPPY_PC_STACK)
296 floppy->rq_stack_index = 0;
297 return (&floppy->rq_stack[floppy->rq_stack_index++]);
300 static void ide_floppy_callback(ide_drive_t *drive)
302 idefloppy_floppy_t *floppy = drive->driver_data;
303 struct ide_atapi_pc *pc = floppy->pc;
304 int uptodate = pc->error ? 0 : 1;
306 debug_log("Reached %s\n", __func__);
308 if (floppy->failed_pc == pc)
309 floppy->failed_pc = NULL;
311 if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
312 (pc->rq && blk_pc_request(pc->rq)))
313 uptodate = 1; /* FIXME */
314 else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
315 u8 *buf = floppy->pc->buf;
318 floppy->sense_key = buf[2] & 0x0F;
319 floppy->asc = buf[12];
320 floppy->ascq = buf[13];
321 floppy->progress_indication = buf[15] & 0x80 ?
322 (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
324 if (floppy->failed_pc)
325 debug_log("pc = %x, ", floppy->failed_pc->c[0]);
327 debug_log("sense key = %x, asc = %x, ascq = %x\n",
328 floppy->sense_key, floppy->asc, floppy->ascq);
330 printk(KERN_ERR "Error in REQUEST SENSE itself - "
331 "Aborting request!\n");
334 idefloppy_end_request(drive, uptodate, 0);
337 static void idefloppy_init_pc(struct ide_atapi_pc *pc)
339 memset(pc, 0, sizeof(*pc));
340 pc->buf = pc->pc_buf;
341 pc->buf_size = IDEFLOPPY_PC_BUFFER_SIZE;
344 static void idefloppy_create_request_sense_cmd(struct ide_atapi_pc *pc)
346 idefloppy_init_pc(pc);
347 pc->c[0] = GPCMD_REQUEST_SENSE;
353 * Called when an error was detected during the last packet command. We queue a
354 * request sense packet command in the head of the request list.
356 static void idefloppy_retry_pc(ide_drive_t *drive)
358 struct ide_atapi_pc *pc;
361 (void)ide_read_error(drive);
362 pc = idefloppy_next_pc_storage(drive);
363 rq = idefloppy_next_rq_storage(drive);
364 idefloppy_create_request_sense_cmd(pc);
365 idefloppy_queue_pc_head(drive, pc, rq);
368 /* The usual interrupt handler called during a packet command. */
369 static ide_startstop_t idefloppy_pc_intr(ide_drive_t *drive)
371 idefloppy_floppy_t *floppy = drive->driver_data;
373 return ide_pc_intr(drive, floppy->pc, idefloppy_pc_intr,
374 IDEFLOPPY_WAIT_CMD, NULL, idefloppy_update_buffers,
375 idefloppy_retry_pc, NULL, ide_floppy_io_buffers);
379 * What we have here is a classic case of a top half / bottom half interrupt
380 * service routine. In interrupt mode, the device sends an interrupt to signal
381 * that it is ready to receive a packet. However, we need to delay about 2-3
382 * ticks before issuing the packet or we gets in trouble.
384 static int idefloppy_transfer_pc(ide_drive_t *drive)
386 idefloppy_floppy_t *floppy = drive->driver_data;
388 /* Send the actual packet */
389 drive->hwif->tp_ops->output_data(drive, NULL, floppy->pc->c, 12);
391 /* Timeout for the packet command */
392 return IDEFLOPPY_WAIT_CMD;
397 * Called as an interrupt (or directly). When the device says it's ready for a
398 * packet, we schedule the packet transfer to occur about 2-3 ticks later in
401 static ide_startstop_t idefloppy_start_pc_transfer(ide_drive_t *drive)
403 idefloppy_floppy_t *floppy = drive->driver_data;
404 struct ide_atapi_pc *pc = floppy->pc;
405 ide_expiry_t *expiry;
406 unsigned int timeout;
409 * The following delay solves a problem with ATAPI Zip 100 drives
410 * where the Busy flag was apparently being deasserted before the
411 * unit was ready to receive data. This was happening on a
412 * 1200 MHz Athlon system. 10/26/01 25msec is too short,
413 * 40 and 50msec work well. idefloppy_pc_intr will not be actually
414 * used until after the packet is moved in about 50 msec.
416 if (drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) {
417 timeout = floppy->ticks;
418 expiry = &idefloppy_transfer_pc;
420 timeout = IDEFLOPPY_WAIT_CMD;
424 return ide_transfer_pc(drive, pc, idefloppy_pc_intr, timeout, expiry);
427 static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
428 struct ide_atapi_pc *pc)
430 /* supress error messages resulting from Medium not present */
431 if (floppy->sense_key == 0x02 &&
432 floppy->asc == 0x3a &&
433 floppy->ascq == 0x00)
436 printk(KERN_ERR "ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
437 "asc = %2x, ascq = %2x\n",
438 floppy->drive->name, pc->c[0], floppy->sense_key,
439 floppy->asc, floppy->ascq);
443 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
444 struct ide_atapi_pc *pc)
446 idefloppy_floppy_t *floppy = drive->driver_data;
448 if (floppy->failed_pc == NULL &&
449 pc->c[0] != GPCMD_REQUEST_SENSE)
450 floppy->failed_pc = pc;
451 /* Set the current packet command */
454 if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
455 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
456 ide_floppy_report_error(floppy, pc);
458 pc->error = IDEFLOPPY_ERROR_GENERAL;
460 floppy->failed_pc = NULL;
461 drive->pc_callback(drive);
465 debug_log("Retry number - %d\n", pc->retries);
469 return ide_issue_pc(drive, pc, idefloppy_start_pc_transfer,
470 IDEFLOPPY_WAIT_CMD, NULL);
473 static void idefloppy_create_prevent_cmd(struct ide_atapi_pc *pc, int prevent)
475 debug_log("creating prevent removal command, prevent = %d\n", prevent);
477 idefloppy_init_pc(pc);
478 pc->c[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL;
482 static void idefloppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
484 idefloppy_init_pc(pc);
485 pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
491 static void idefloppy_create_format_unit_cmd(struct ide_atapi_pc *pc, int b,
494 idefloppy_init_pc(pc);
495 pc->c[0] = GPCMD_FORMAT_UNIT;
498 memset(pc->buf, 0, 12);
500 /* Default format list header, u8 1: FOV/DCRT/IMM bits set */
502 if (flags & 1) /* Verify bit on... */
503 pc->buf[1] ^= 0x20; /* ... turn off DCRT bit */
506 put_unaligned(cpu_to_be32(b), (unsigned int *)(&pc->buf[4]));
507 put_unaligned(cpu_to_be32(l), (unsigned int *)(&pc->buf[8]));
509 pc->flags |= PC_FLAG_WRITING;
512 /* A mode sense command is used to "sense" floppy parameters. */
513 static void idefloppy_create_mode_sense_cmd(struct ide_atapi_pc *pc,
514 u8 page_code, u8 type)
516 u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
518 idefloppy_init_pc(pc);
519 pc->c[0] = GPCMD_MODE_SENSE_10;
521 pc->c[2] = page_code + (type << 6);
524 case IDEFLOPPY_CAPABILITIES_PAGE:
527 case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
531 printk(KERN_ERR "ide-floppy: unsupported page code "
532 "in create_mode_sense_cmd\n");
534 put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
535 pc->req_xfer = length;
538 static void idefloppy_create_start_stop_cmd(struct ide_atapi_pc *pc, int start)
540 idefloppy_init_pc(pc);
541 pc->c[0] = GPCMD_START_STOP_UNIT;
545 static void idefloppy_create_rw_cmd(idefloppy_floppy_t *floppy,
546 struct ide_atapi_pc *pc, struct request *rq,
547 unsigned long sector)
549 int block = sector / floppy->bs_factor;
550 int blocks = rq->nr_sectors / floppy->bs_factor;
551 int cmd = rq_data_dir(rq);
553 debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
556 idefloppy_init_pc(pc);
557 pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
558 put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
559 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
561 memcpy(rq->cmd, pc->c, 12);
564 pc->b_count = cmd == READ ? 0 : rq->bio->bi_size;
565 if (rq->cmd_flags & REQ_RW)
566 pc->flags |= PC_FLAG_WRITING;
568 pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
569 pc->flags |= PC_FLAG_DMA_OK;
572 static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
573 struct ide_atapi_pc *pc, struct request *rq)
575 idefloppy_init_pc(pc);
576 memcpy(pc->c, rq->cmd, sizeof(pc->c));
578 pc->b_count = rq->data_len;
579 if (rq->data_len && rq_data_dir(rq) == WRITE)
580 pc->flags |= PC_FLAG_WRITING;
583 pc->flags |= PC_FLAG_DMA_OK;
585 * possibly problematic, doesn't look like ide-floppy correctly
586 * handled scattered requests if dma fails...
588 pc->req_xfer = pc->buf_size = rq->data_len;
591 static ide_startstop_t idefloppy_do_request(ide_drive_t *drive,
592 struct request *rq, sector_t block_s)
594 idefloppy_floppy_t *floppy = drive->driver_data;
595 struct ide_atapi_pc *pc;
596 unsigned long block = (unsigned long)block_s;
598 debug_log("dev: %s, cmd_type: %x, errors: %d\n",
599 rq->rq_disk ? rq->rq_disk->disk_name : "?",
600 rq->cmd_type, rq->errors);
601 debug_log("sector: %ld, nr_sectors: %ld, "
602 "current_nr_sectors: %d\n", (long)rq->sector,
603 rq->nr_sectors, rq->current_nr_sectors);
605 if (rq->errors >= ERROR_MAX) {
606 if (floppy->failed_pc)
607 ide_floppy_report_error(floppy, floppy->failed_pc);
609 printk(KERN_ERR "ide-floppy: %s: I/O error\n",
611 idefloppy_end_request(drive, 0, 0);
614 if (blk_fs_request(rq)) {
615 if (((long)rq->sector % floppy->bs_factor) ||
616 (rq->nr_sectors % floppy->bs_factor)) {
617 printk(KERN_ERR "%s: unsupported r/w request size\n",
619 idefloppy_end_request(drive, 0, 0);
622 pc = idefloppy_next_pc_storage(drive);
623 idefloppy_create_rw_cmd(floppy, pc, rq, block);
624 } else if (blk_special_request(rq)) {
625 pc = (struct ide_atapi_pc *) rq->buffer;
626 } else if (blk_pc_request(rq)) {
627 pc = idefloppy_next_pc_storage(drive);
628 idefloppy_blockpc_cmd(floppy, pc, rq);
630 blk_dump_rq_flags(rq,
631 "ide-floppy: unsupported command in queue");
632 idefloppy_end_request(drive, 0, 0);
638 return idefloppy_issue_pc(drive, pc);
642 * Add a special packet command request to the tail of the request queue,
643 * and wait for it to be serviced.
645 static int idefloppy_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
647 struct ide_floppy_obj *floppy = drive->driver_data;
651 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
652 rq->buffer = (char *) pc;
653 rq->cmd_type = REQ_TYPE_SPECIAL;
654 memcpy(rq->cmd, pc->c, 12);
655 error = blk_execute_rq(drive->queue, floppy->disk, rq, 0);
662 * Look at the flexible disk page parameters. We ignore the CHS capacity
663 * parameters and use the LBA parameters instead.
665 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive)
667 idefloppy_floppy_t *floppy = drive->driver_data;
668 struct ide_atapi_pc pc;
670 int capacity, lba_capacity;
671 u16 transfer_rate, sector_size, cyls, rpm;
674 idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE,
677 if (idefloppy_queue_pc_tail(drive, &pc)) {
678 printk(KERN_ERR "ide-floppy: Can't get flexible disk page"
682 floppy->wp = !!(pc.buf[3] & 0x80);
683 set_disk_ro(floppy->disk, floppy->wp);
686 transfer_rate = be16_to_cpup((__be16 *)&pc.buf[8 + 2]);
687 sector_size = be16_to_cpup((__be16 *)&pc.buf[8 + 6]);
688 cyls = be16_to_cpup((__be16 *)&pc.buf[8 + 8]);
689 rpm = be16_to_cpup((__be16 *)&pc.buf[8 + 28]);
690 heads = pc.buf[8 + 4];
691 sectors = pc.buf[8 + 5];
693 capacity = cyls * heads * sectors * sector_size;
695 if (memcmp(page, &floppy->flexible_disk_page, 32))
696 printk(KERN_INFO "%s: %dkB, %d/%d/%d CHS, %d kBps, "
697 "%d sector size, %d rpm\n",
698 drive->name, capacity / 1024, cyls, heads,
699 sectors, transfer_rate / 8, sector_size, rpm);
701 memcpy(&floppy->flexible_disk_page, page, 32);
702 drive->bios_cyl = cyls;
703 drive->bios_head = heads;
704 drive->bios_sect = sectors;
705 lba_capacity = floppy->blocks * floppy->block_size;
707 if (capacity < lba_capacity) {
708 printk(KERN_NOTICE "%s: The disk reports a capacity of %d "
709 "bytes, but the drive only handles %d\n",
710 drive->name, lba_capacity, capacity);
711 floppy->blocks = floppy->block_size ?
712 capacity / floppy->block_size : 0;
717 static int idefloppy_get_sfrp_bit(ide_drive_t *drive)
719 idefloppy_floppy_t *floppy = drive->driver_data;
720 struct ide_atapi_pc pc;
723 idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_CAPABILITIES_PAGE,
726 pc.flags |= PC_FLAG_SUPPRESS_ERROR;
727 if (idefloppy_queue_pc_tail(drive, &pc))
730 floppy->srfp = pc.buf[8 + 2] & 0x40;
735 * Determine if a media is present in the floppy drive, and if so, its LBA
738 static int ide_floppy_get_capacity(ide_drive_t *drive)
740 idefloppy_floppy_t *floppy = drive->driver_data;
741 struct ide_atapi_pc pc;
743 u8 header_len, desc_cnt;
744 int i, rc = 1, blocks, length;
747 drive->bios_head = drive->bios_sect = 0;
749 floppy->bs_factor = 1;
750 set_capacity(floppy->disk, 0);
752 idefloppy_create_read_capacity_cmd(&pc);
753 if (idefloppy_queue_pc_tail(drive, &pc)) {
754 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
757 header_len = pc.buf[3];
758 cap_desc = &pc.buf[4];
759 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
761 for (i = 0; i < desc_cnt; i++) {
762 unsigned int desc_start = 4 + i*8;
764 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
765 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
767 debug_log("Descriptor %d: %dkB, %d blocks, %d sector size\n",
768 i, blocks * length / 1024, blocks, length);
773 * the code below is valid only for the 1st descriptor, ie i=0
776 switch (pc.buf[desc_start + 4] & 0x03) {
777 /* Clik! drive returns this instead of CAPACITY_CURRENT */
778 case CAPACITY_UNFORMATTED:
779 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
781 * If it is not a clik drive, break out
782 * (maintains previous driver behaviour)
785 case CAPACITY_CURRENT:
786 /* Normal Zip/LS-120 disks */
787 if (memcmp(cap_desc, &floppy->cap_desc, 8))
788 printk(KERN_INFO "%s: %dkB, %d blocks, %d "
789 "sector size\n", drive->name,
790 blocks * length / 1024, blocks, length);
791 memcpy(&floppy->cap_desc, cap_desc, 8);
793 if (!length || length % 512) {
794 printk(KERN_NOTICE "%s: %d bytes block size "
795 "not supported\n", drive->name, length);
797 floppy->blocks = blocks;
798 floppy->block_size = length;
799 floppy->bs_factor = length / 512;
800 if (floppy->bs_factor != 1)
801 printk(KERN_NOTICE "%s: warning: non "
802 "512 bytes block size not "
808 case CAPACITY_NO_CARTRIDGE:
810 * This is a KERN_ERR so it appears on screen
811 * for the user to see
813 printk(KERN_ERR "%s: No disk in drive\n", drive->name);
815 case CAPACITY_INVALID:
816 printk(KERN_ERR "%s: Invalid capacity for disk "
817 "in drive\n", drive->name);
820 debug_log("Descriptor 0 Code: %d\n",
821 pc.buf[desc_start + 4] & 0x03);
824 /* Clik! disk does not support get_flexible_disk_page */
825 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
826 (void) ide_floppy_get_flexible_disk_page(drive);
828 set_capacity(floppy->disk, floppy->blocks * floppy->bs_factor);
833 * Obtain the list of formattable capacities.
834 * Very similar to ide_floppy_get_capacity, except that we push the capacity
835 * descriptors to userland, instead of our own structures.
837 * Userland gives us the following structure:
839 * struct idefloppy_format_capacities {
847 * userland initializes nformats to the number of allocated formats[] records.
848 * On exit we set nformats to the number of records we've actually initialized.
851 static int ide_floppy_get_format_capacities(ide_drive_t *drive, int __user *arg)
853 struct ide_atapi_pc pc;
854 u8 header_len, desc_cnt;
855 int i, blocks, length, u_array_size, u_index;
858 if (get_user(u_array_size, arg))
861 if (u_array_size <= 0)
864 idefloppy_create_read_capacity_cmd(&pc);
865 if (idefloppy_queue_pc_tail(drive, &pc)) {
866 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
869 header_len = pc.buf[3];
870 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
876 * We always skip the first capacity descriptor. That's the current
877 * capacity. We are interested in the remaining descriptors, the
878 * formattable capacities.
880 for (i = 1; i < desc_cnt; i++) {
881 unsigned int desc_start = 4 + i*8;
883 if (u_index >= u_array_size)
884 break; /* User-supplied buffer too small */
886 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
887 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
889 if (put_user(blocks, argp))
893 if (put_user(length, argp))
900 if (put_user(u_index, arg))
906 * Get ATAPI_FORMAT_UNIT progress indication.
908 * Userland gives a pointer to an int. The int is set to a progress
909 * indicator 0-65536, with 65536=100%.
911 * If the drive does not support format progress indication, we just check
912 * the dsc bit, and return either 0 or 65536.
915 static int idefloppy_get_format_progress(ide_drive_t *drive, int __user *arg)
917 idefloppy_floppy_t *floppy = drive->driver_data;
918 struct ide_atapi_pc pc;
919 int progress_indication = 0x10000;
922 idefloppy_create_request_sense_cmd(&pc);
923 if (idefloppy_queue_pc_tail(drive, &pc))
926 if (floppy->sense_key == 2 &&
929 progress_indication = floppy->progress_indication;
931 /* Else assume format_unit has finished, and we're at 0x10000 */
933 ide_hwif_t *hwif = drive->hwif;
937 local_irq_save(flags);
938 stat = hwif->tp_ops->read_status(hwif);
939 local_irq_restore(flags);
941 progress_indication = ((stat & SEEK_STAT) == 0) ? 0 : 0x10000;
943 if (put_user(progress_indication, arg))
949 static sector_t idefloppy_capacity(ide_drive_t *drive)
951 idefloppy_floppy_t *floppy = drive->driver_data;
952 unsigned long capacity = floppy->blocks * floppy->bs_factor;
958 * Check whether we can support a drive, based on the ATAPI IDENTIFY command
961 static int idefloppy_identify_device(ide_drive_t *drive, struct hd_driveid *id)
964 u8 device_type, protocol, removable, drq_type, packet_size;
966 *((u16 *) &gcw) = id->config;
968 device_type = gcw[1] & 0x1F;
969 removable = (gcw[0] & 0x80) >> 7;
970 protocol = (gcw[1] & 0xC0) >> 6;
971 drq_type = (gcw[0] & 0x60) >> 5;
972 packet_size = gcw[0] & 0x03;
975 /* kludge for Apple PowerBook internal zip */
976 if (device_type == 5 &&
977 !strstr(id->model, "CD-ROM") && strstr(id->model, "ZIP"))
982 printk(KERN_ERR "ide-floppy: Protocol (0x%02x) is not ATAPI\n",
984 else if (device_type != 0)
985 printk(KERN_ERR "ide-floppy: Device type (0x%02x) is not set "
986 "to floppy\n", device_type);
988 printk(KERN_ERR "ide-floppy: The removable flag is not set\n");
989 else if (drq_type == 3)
990 printk(KERN_ERR "ide-floppy: Sorry, DRQ type (0x%02x) not "
991 "supported\n", drq_type);
992 else if (packet_size != 0)
993 printk(KERN_ERR "ide-floppy: Packet size (0x%02x) is not 12 "
994 "bytes\n", packet_size);
1000 #ifdef CONFIG_IDE_PROC_FS
1001 static void idefloppy_add_settings(ide_drive_t *drive)
1003 idefloppy_floppy_t *floppy = drive->driver_data;
1005 ide_add_setting(drive, "bios_cyl", SETTING_RW, TYPE_INT, 0, 1023, 1, 1,
1006 &drive->bios_cyl, NULL);
1007 ide_add_setting(drive, "bios_head", SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1008 &drive->bios_head, NULL);
1009 ide_add_setting(drive, "bios_sect", SETTING_RW, TYPE_BYTE, 0, 63, 1, 1,
1010 &drive->bios_sect, NULL);
1011 ide_add_setting(drive, "ticks", SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1012 &floppy->ticks, NULL);
1015 static inline void idefloppy_add_settings(ide_drive_t *drive) { ; }
1018 static void idefloppy_setup(ide_drive_t *drive, idefloppy_floppy_t *floppy)
1022 *((u16 *) &gcw) = drive->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(drive->id->model, "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(drive->id->model, "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);
1054 idefloppy_add_settings(drive);
1057 static void ide_floppy_remove(ide_drive_t *drive)
1059 idefloppy_floppy_t *floppy = drive->driver_data;
1060 struct gendisk *g = floppy->disk;
1062 ide_proc_unregister_driver(drive, floppy->driver);
1066 ide_floppy_put(floppy);
1069 static void idefloppy_cleanup_obj(struct kref *kref)
1071 struct ide_floppy_obj *floppy = to_ide_floppy(kref);
1072 ide_drive_t *drive = floppy->drive;
1073 struct gendisk *g = floppy->disk;
1075 drive->driver_data = NULL;
1076 g->private_data = NULL;
1081 #ifdef CONFIG_IDE_PROC_FS
1082 static int proc_idefloppy_read_capacity(char *page, char **start, off_t off,
1083 int count, int *eof, void *data)
1085 ide_drive_t*drive = (ide_drive_t *)data;
1088 len = sprintf(page, "%llu\n", (long long)idefloppy_capacity(drive));
1089 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1092 static ide_proc_entry_t idefloppy_proc[] = {
1093 { "capacity", S_IFREG|S_IRUGO, proc_idefloppy_read_capacity, NULL },
1094 { "geometry", S_IFREG|S_IRUGO, proc_ide_read_geometry, NULL },
1095 { NULL, 0, NULL, NULL }
1097 #endif /* CONFIG_IDE_PROC_FS */
1099 static int ide_floppy_probe(ide_drive_t *);
1101 static ide_driver_t idefloppy_driver = {
1103 .owner = THIS_MODULE,
1104 .name = "ide-floppy",
1105 .bus = &ide_bus_type,
1107 .probe = ide_floppy_probe,
1108 .remove = ide_floppy_remove,
1109 .version = IDEFLOPPY_VERSION,
1110 .media = ide_floppy,
1111 .supports_dsc_overlap = 0,
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,
1120 static int idefloppy_open(struct inode *inode, struct file *filp)
1122 struct gendisk *disk = inode->i_bdev->bd_disk;
1123 struct ide_floppy_obj *floppy;
1125 struct ide_atapi_pc pc;
1128 debug_log("Reached %s\n", __func__);
1130 floppy = ide_floppy_get(disk);
1134 drive = floppy->drive;
1138 if (floppy->openers == 1) {
1139 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1142 idefloppy_init_pc(&pc);
1143 pc.c[0] = GPCMD_TEST_UNIT_READY;
1145 if (idefloppy_queue_pc_tail(drive, &pc)) {
1146 idefloppy_create_start_stop_cmd(&pc, 1);
1147 (void) idefloppy_queue_pc_tail(drive, &pc);
1150 if (ide_floppy_get_capacity(drive)
1151 && (filp->f_flags & O_NDELAY) == 0
1153 * Allow O_NDELAY to open a drive without a disk, or with an
1154 * unreadable disk, so that we can get the format capacity
1155 * of the drive or begin the format - Sam
1159 goto out_put_floppy;
1162 if (floppy->wp && (filp->f_mode & 2)) {
1164 goto out_put_floppy;
1166 drive->atapi_flags |= IDE_AFLAG_MEDIA_CHANGED;
1167 /* IOMEGA Clik! drives do not support lock/unlock commands */
1168 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1169 idefloppy_create_prevent_cmd(&pc, 1);
1170 (void) idefloppy_queue_pc_tail(drive, &pc);
1172 check_disk_change(inode->i_bdev);
1173 } else if (drive->atapi_flags & IDE_AFLAG_FORMAT_IN_PROGRESS) {
1175 goto out_put_floppy;
1181 ide_floppy_put(floppy);
1185 static int idefloppy_release(struct inode *inode, struct file *filp)
1187 struct gendisk *disk = inode->i_bdev->bd_disk;
1188 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1189 ide_drive_t *drive = floppy->drive;
1190 struct ide_atapi_pc pc;
1192 debug_log("Reached %s\n", __func__);
1194 if (floppy->openers == 1) {
1195 /* IOMEGA Clik! drives do not support lock/unlock commands */
1196 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1197 idefloppy_create_prevent_cmd(&pc, 0);
1198 (void) idefloppy_queue_pc_tail(drive, &pc);
1201 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1206 ide_floppy_put(floppy);
1211 static int idefloppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1213 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1214 ide_drive_t *drive = floppy->drive;
1216 geo->heads = drive->bios_head;
1217 geo->sectors = drive->bios_sect;
1218 geo->cylinders = (u16)drive->bios_cyl; /* truncate */
1222 static int ide_floppy_lockdoor(ide_drive_t *drive, struct ide_atapi_pc *pc,
1223 unsigned long arg, unsigned int cmd)
1225 idefloppy_floppy_t *floppy = drive->driver_data;
1227 if (floppy->openers > 1)
1230 /* The IOMEGA Clik! Drive doesn't support this command -
1231 * no room for an eject mechanism */
1232 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1233 int prevent = arg ? 1 : 0;
1235 if (cmd == CDROMEJECT)
1238 idefloppy_create_prevent_cmd(pc, prevent);
1239 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1242 if (cmd == CDROMEJECT) {
1243 idefloppy_create_start_stop_cmd(pc, 2);
1244 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1250 static int ide_floppy_format_unit(idefloppy_floppy_t *floppy,
1253 struct ide_atapi_pc pc;
1254 ide_drive_t *drive = floppy->drive;
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;
1300 static int idefloppy_ioctl(struct inode *inode, struct file *file,
1301 unsigned int cmd, unsigned long arg)
1303 struct block_device *bdev = inode->i_bdev;
1304 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1305 ide_drive_t *drive = floppy->drive;
1306 struct ide_atapi_pc pc;
1307 void __user *argp = (void __user *)arg;
1313 case CDROM_LOCKDOOR:
1314 return ide_floppy_lockdoor(drive, &pc, arg, cmd);
1315 case IDEFLOPPY_IOCTL_FORMAT_SUPPORTED:
1317 case IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY:
1318 return ide_floppy_get_format_capacities(drive, argp);
1319 case IDEFLOPPY_IOCTL_FORMAT_START:
1320 if (!(file->f_mode & 2))
1323 return ide_floppy_format_unit(floppy, (int __user *)arg);
1324 case IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS:
1325 return idefloppy_get_format_progress(drive, argp);
1329 * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
1330 * and CDROM_SEND_PACKET (legacy) ioctls
1332 if (cmd != CDROM_SEND_PACKET && cmd != SCSI_IOCTL_SEND_COMMAND)
1333 err = scsi_cmd_ioctl(file, bdev->bd_disk->queue,
1334 bdev->bd_disk, cmd, argp);
1339 err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
1344 static int idefloppy_media_changed(struct gendisk *disk)
1346 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1347 ide_drive_t *drive = floppy->drive;
1350 /* do not scan partitions twice if this is a removable device */
1351 if (drive->attach) {
1355 ret = !!(drive->atapi_flags & IDE_AFLAG_MEDIA_CHANGED);
1356 drive->atapi_flags &= ~IDE_AFLAG_MEDIA_CHANGED;
1360 static int idefloppy_revalidate_disk(struct gendisk *disk)
1362 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1363 set_capacity(disk, idefloppy_capacity(floppy->drive));
1367 static struct block_device_operations idefloppy_ops = {
1368 .owner = THIS_MODULE,
1369 .open = idefloppy_open,
1370 .release = idefloppy_release,
1371 .ioctl = idefloppy_ioctl,
1372 .getgeo = idefloppy_getgeo,
1373 .media_changed = idefloppy_media_changed,
1374 .revalidate_disk = idefloppy_revalidate_disk
1377 static int ide_floppy_probe(ide_drive_t *drive)
1379 idefloppy_floppy_t *floppy;
1382 if (!strstr("ide-floppy", drive->driver_req))
1384 if (!drive->present)
1386 if (drive->media != ide_floppy)
1388 if (!idefloppy_identify_device(drive, drive->id)) {
1389 printk(KERN_ERR "ide-floppy: %s: not supported by this version"
1390 " of ide-floppy\n", drive->name);
1393 floppy = kzalloc(sizeof(idefloppy_floppy_t), GFP_KERNEL);
1395 printk(KERN_ERR "ide-floppy: %s: Can't allocate a floppy"
1396 " structure\n", drive->name);
1400 g = alloc_disk(1 << PARTN_BITS);
1402 goto out_free_floppy;
1404 ide_init_disk(g, drive);
1406 ide_proc_register_driver(drive, &idefloppy_driver);
1408 kref_init(&floppy->kref);
1410 floppy->drive = drive;
1411 floppy->driver = &idefloppy_driver;
1414 g->private_data = &floppy->driver;
1416 drive->driver_data = floppy;
1418 idefloppy_setup(drive, floppy);
1420 g->minors = 1 << PARTN_BITS;
1421 g->driverfs_dev = &drive->gendev;
1422 g->flags = drive->removable ? GENHD_FL_REMOVABLE : 0;
1423 g->fops = &idefloppy_ops;
1434 static void __exit idefloppy_exit(void)
1436 driver_unregister(&idefloppy_driver.gen_driver);
1439 static int __init idefloppy_init(void)
1441 printk("ide-floppy driver " IDEFLOPPY_VERSION "\n");
1442 return driver_register(&idefloppy_driver.gen_driver);
1445 MODULE_ALIAS("ide:*m-floppy*");
1446 module_init(idefloppy_init);
1447 module_exit(idefloppy_exit);
1448 MODULE_LICENSE("GPL");
1449 MODULE_DESCRIPTION("ATAPI FLOPPY Driver");