2 * IDE ATAPI floppy driver.
4 * Copyright (C) 1996-1999 Gadi Oxman <gadio@netvision.net.il>
5 * Copyright (C) 2000-2002 Paul Bristow <paul@paulbristow.net>
6 * Copyright (C) 2005 Bartlomiej Zolnierkiewicz
8 * This driver supports the following IDE floppy drives:
10 * LS-120/240 SuperDisk
12 * Iomega PC Card Clik!/PocketZip
14 * For a historical changelog see
15 * Documentation/ide/ChangeLog.ide-floppy.1996-2002
18 #define IDEFLOPPY_VERSION "1.00"
20 #include <linux/module.h>
21 #include <linux/types.h>
22 #include <linux/string.h>
23 #include <linux/kernel.h>
24 #include <linux/delay.h>
25 #include <linux/timer.h>
27 #include <linux/interrupt.h>
28 #include <linux/major.h>
29 #include <linux/errno.h>
30 #include <linux/genhd.h>
31 #include <linux/slab.h>
32 #include <linux/cdrom.h>
33 #include <linux/ide.h>
34 #include <linux/bitops.h>
35 #include <linux/mutex.h>
37 #include <scsi/scsi_ioctl.h>
39 #include <asm/byteorder.h>
40 #include <linux/irq.h>
41 #include <linux/uaccess.h>
43 #include <asm/unaligned.h>
45 /* define to see debug info */
46 #define IDEFLOPPY_DEBUG_LOG 0
48 /* #define IDEFLOPPY_DEBUG(fmt, args...) printk(KERN_INFO fmt, ## args) */
49 #define IDEFLOPPY_DEBUG(fmt, args...)
51 #if IDEFLOPPY_DEBUG_LOG
52 #define debug_log(fmt, args...) \
53 printk(KERN_INFO "ide-floppy: " fmt, ## args)
55 #define debug_log(fmt, args...) do {} while (0)
59 /* Some drives require a longer irq timeout. */
60 #define IDEFLOPPY_WAIT_CMD (5 * WAIT_CMD)
63 * After each failed packet command we issue a request sense command and retry
64 * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
66 #define IDEFLOPPY_MAX_PC_RETRIES 3
69 * With each packet command, we allocate a buffer of IDEFLOPPY_PC_BUFFER_SIZE
72 #define IDEFLOPPY_PC_BUFFER_SIZE 256
75 * In various places in the driver, we need to allocate storage for packet
76 * commands and requests, which will remain valid while we leave the driver to
77 * wait for an interrupt or a timeout event.
79 #define IDEFLOPPY_PC_STACK (10 + IDEFLOPPY_MAX_PC_RETRIES)
81 /* format capacities descriptor codes */
82 #define CAPACITY_INVALID 0x00
83 #define CAPACITY_UNFORMATTED 0x01
84 #define CAPACITY_CURRENT 0x02
85 #define CAPACITY_NO_CARTRIDGE 0x03
88 * Most of our global data which we need to save even as we leave the driver
89 * due to an interrupt or a timer event is stored in a variable of type
90 * idefloppy_floppy_t, defined below.
92 typedef struct ide_floppy_obj {
97 unsigned int openers; /* protected by BKL for now */
99 /* Current packet command */
100 struct ide_atapi_pc *pc;
101 /* Last failed packet command */
102 struct ide_atapi_pc *failed_pc;
103 /* Packet command stack */
104 struct ide_atapi_pc pc_stack[IDEFLOPPY_PC_STACK];
105 /* Next free packet command storage space */
107 struct request rq_stack[IDEFLOPPY_PC_STACK];
108 /* We implement a circular array */
111 /* Last error information */
112 u8 sense_key, asc, ascq;
113 /* delay this long before sending packet command */
115 int progress_indication;
117 /* Device information */
119 int blocks, block_size, bs_factor;
120 /* Last format capacity descriptor */
122 /* Copy of the flexible disk page */
123 u8 flexible_disk_page[32];
126 /* Supports format progress report */
128 } idefloppy_floppy_t;
130 #define IDEFLOPPY_TICKS_DELAY HZ/20 /* default delay for ZIP 100 (50ms) */
132 /* Defines for the MODE SENSE command */
133 #define MODE_SENSE_CURRENT 0x00
134 #define MODE_SENSE_CHANGEABLE 0x01
135 #define MODE_SENSE_DEFAULT 0x02
136 #define MODE_SENSE_SAVED 0x03
138 /* IOCTLs used in low-level formatting. */
139 #define IDEFLOPPY_IOCTL_FORMAT_SUPPORTED 0x4600
140 #define IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY 0x4601
141 #define IDEFLOPPY_IOCTL_FORMAT_START 0x4602
142 #define IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS 0x4603
144 /* Error code returned in rq->errors to the higher part of the driver. */
145 #define IDEFLOPPY_ERROR_GENERAL 101
148 * Pages of the SELECT SENSE / MODE SENSE packet commands.
149 * See SFF-8070i spec.
151 #define IDEFLOPPY_CAPABILITIES_PAGE 0x1b
152 #define IDEFLOPPY_FLEXIBLE_DISK_PAGE 0x05
154 static DEFINE_MUTEX(idefloppy_ref_mutex);
156 #define to_ide_floppy(obj) container_of(obj, struct ide_floppy_obj, kref)
158 #define ide_floppy_g(disk) \
159 container_of((disk)->private_data, struct ide_floppy_obj, driver)
161 static void idefloppy_cleanup_obj(struct kref *);
163 static struct ide_floppy_obj *ide_floppy_get(struct gendisk *disk)
165 struct ide_floppy_obj *floppy = NULL;
167 mutex_lock(&idefloppy_ref_mutex);
168 floppy = ide_floppy_g(disk);
170 kref_get(&floppy->kref);
171 if (ide_device_get(floppy->drive)) {
172 kref_put(&floppy->kref, idefloppy_cleanup_obj);
176 mutex_unlock(&idefloppy_ref_mutex);
180 static void ide_floppy_put(struct ide_floppy_obj *floppy)
182 mutex_lock(&idefloppy_ref_mutex);
183 ide_device_put(floppy->drive);
184 kref_put(&floppy->kref, idefloppy_cleanup_obj);
185 mutex_unlock(&idefloppy_ref_mutex);
189 * Used to finish servicing a request. For read/write requests, we will call
190 * ide_end_request to pass to the next buffer.
192 static int idefloppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
194 idefloppy_floppy_t *floppy = drive->driver_data;
195 struct request *rq = HWGROUP(drive)->rq;
198 debug_log("Reached %s\n", __func__);
201 case 0: error = IDEFLOPPY_ERROR_GENERAL; break;
202 case 1: error = 0; break;
203 default: error = uptodate;
206 floppy->failed_pc = NULL;
207 /* Why does this happen? */
210 if (!blk_special_request(rq)) {
211 /* our real local end request function */
212 ide_end_request(drive, uptodate, nsecs);
216 /* fixme: need to move this local also */
217 ide_end_drive_cmd(drive, 0, 0);
221 static void ide_floppy_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
222 unsigned int bcount, int direction)
224 ide_hwif_t *hwif = drive->hwif;
225 struct request *rq = pc->rq;
226 struct req_iterator iter;
227 struct bio_vec *bvec;
232 rq_for_each_segment(bvec, rq, iter) {
236 count = min(bvec->bv_len, bcount);
238 data = bvec_kmap_irq(bvec, &flags);
240 hwif->tp_ops->output_data(drive, NULL, data, count);
242 hwif->tp_ops->input_data(drive, NULL, data, count);
243 bvec_kunmap_irq(data, &flags);
246 pc->b_count += count;
250 idefloppy_end_request(drive, 1, done >> 9);
253 printk(KERN_ERR "%s: leftover data in %s, bcount == %d\n",
254 drive->name, __func__, bcount);
255 ide_pad_transfer(drive, direction, bcount);
259 static void idefloppy_update_buffers(ide_drive_t *drive,
260 struct ide_atapi_pc *pc)
262 struct request *rq = pc->rq;
263 struct bio *bio = rq->bio;
265 while ((bio = rq->bio) != NULL)
266 idefloppy_end_request(drive, 1, 0);
270 * Generate a new packet command request in front of the request queue, before
271 * the current request so that it will be processed immediately, on the next
272 * pass through the driver.
274 static void idefloppy_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
277 struct ide_floppy_obj *floppy = drive->driver_data;
279 blk_rq_init(NULL, rq);
280 rq->buffer = (char *) pc;
281 rq->cmd_type = REQ_TYPE_SPECIAL;
282 rq->cmd_flags |= REQ_PREEMPT;
283 rq->rq_disk = floppy->disk;
284 memcpy(rq->cmd, pc->c, 12);
285 ide_do_drive_cmd(drive, rq);
288 static struct ide_atapi_pc *idefloppy_next_pc_storage(ide_drive_t *drive)
290 idefloppy_floppy_t *floppy = drive->driver_data;
292 if (floppy->pc_stack_index == IDEFLOPPY_PC_STACK)
293 floppy->pc_stack_index = 0;
294 return (&floppy->pc_stack[floppy->pc_stack_index++]);
297 static struct request *idefloppy_next_rq_storage(ide_drive_t *drive)
299 idefloppy_floppy_t *floppy = drive->driver_data;
301 if (floppy->rq_stack_index == IDEFLOPPY_PC_STACK)
302 floppy->rq_stack_index = 0;
303 return (&floppy->rq_stack[floppy->rq_stack_index++]);
306 static void ide_floppy_callback(ide_drive_t *drive)
308 idefloppy_floppy_t *floppy = drive->driver_data;
309 struct ide_atapi_pc *pc = floppy->pc;
310 int uptodate = pc->error ? 0 : 1;
312 debug_log("Reached %s\n", __func__);
314 if (floppy->failed_pc == pc)
315 floppy->failed_pc = NULL;
317 if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
318 (pc->rq && blk_pc_request(pc->rq)))
319 uptodate = 1; /* FIXME */
320 else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
321 u8 *buf = floppy->pc->buf;
324 floppy->sense_key = buf[2] & 0x0F;
325 floppy->asc = buf[12];
326 floppy->ascq = buf[13];
327 floppy->progress_indication = buf[15] & 0x80 ?
328 (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
330 if (floppy->failed_pc)
331 debug_log("pc = %x, ", floppy->failed_pc->c[0]);
333 debug_log("sense key = %x, asc = %x, ascq = %x\n",
334 floppy->sense_key, floppy->asc, floppy->ascq);
336 printk(KERN_ERR "Error in REQUEST SENSE itself - "
337 "Aborting request!\n");
340 idefloppy_end_request(drive, uptodate, 0);
343 static void idefloppy_init_pc(struct ide_atapi_pc *pc)
345 memset(pc, 0, sizeof(*pc));
346 pc->buf = pc->pc_buf;
347 pc->buf_size = IDEFLOPPY_PC_BUFFER_SIZE;
350 static void idefloppy_create_request_sense_cmd(struct ide_atapi_pc *pc)
352 idefloppy_init_pc(pc);
353 pc->c[0] = GPCMD_REQUEST_SENSE;
359 * Called when an error was detected during the last packet command. We queue a
360 * request sense packet command in the head of the request list.
362 static void idefloppy_retry_pc(ide_drive_t *drive)
364 struct ide_atapi_pc *pc;
367 (void)ide_read_error(drive);
368 pc = idefloppy_next_pc_storage(drive);
369 rq = idefloppy_next_rq_storage(drive);
370 idefloppy_create_request_sense_cmd(pc);
371 idefloppy_queue_pc_head(drive, pc, rq);
374 /* The usual interrupt handler called during a packet command. */
375 static ide_startstop_t idefloppy_pc_intr(ide_drive_t *drive)
377 idefloppy_floppy_t *floppy = drive->driver_data;
379 return ide_pc_intr(drive, floppy->pc, idefloppy_pc_intr,
380 IDEFLOPPY_WAIT_CMD, NULL, idefloppy_update_buffers,
381 idefloppy_retry_pc, NULL, ide_floppy_io_buffers);
385 * What we have here is a classic case of a top half / bottom half interrupt
386 * service routine. In interrupt mode, the device sends an interrupt to signal
387 * that it is ready to receive a packet. However, we need to delay about 2-3
388 * ticks before issuing the packet or we gets in trouble.
390 static int idefloppy_transfer_pc(ide_drive_t *drive)
392 idefloppy_floppy_t *floppy = drive->driver_data;
394 /* Send the actual packet */
395 drive->hwif->tp_ops->output_data(drive, NULL, floppy->pc->c, 12);
397 /* Timeout for the packet command */
398 return IDEFLOPPY_WAIT_CMD;
403 * Called as an interrupt (or directly). When the device says it's ready for a
404 * packet, we schedule the packet transfer to occur about 2-3 ticks later in
407 static ide_startstop_t idefloppy_start_pc_transfer(ide_drive_t *drive)
409 idefloppy_floppy_t *floppy = drive->driver_data;
410 struct ide_atapi_pc *pc = floppy->pc;
411 ide_expiry_t *expiry;
412 unsigned int timeout;
415 * The following delay solves a problem with ATAPI Zip 100 drives
416 * where the Busy flag was apparently being deasserted before the
417 * unit was ready to receive data. This was happening on a
418 * 1200 MHz Athlon system. 10/26/01 25msec is too short,
419 * 40 and 50msec work well. idefloppy_pc_intr will not be actually
420 * used until after the packet is moved in about 50 msec.
422 if (drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) {
423 timeout = floppy->ticks;
424 expiry = &idefloppy_transfer_pc;
426 timeout = IDEFLOPPY_WAIT_CMD;
430 return ide_transfer_pc(drive, pc, idefloppy_pc_intr, timeout, expiry);
433 static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
434 struct ide_atapi_pc *pc)
436 /* supress error messages resulting from Medium not present */
437 if (floppy->sense_key == 0x02 &&
438 floppy->asc == 0x3a &&
439 floppy->ascq == 0x00)
442 printk(KERN_ERR "ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
443 "asc = %2x, ascq = %2x\n",
444 floppy->drive->name, pc->c[0], floppy->sense_key,
445 floppy->asc, floppy->ascq);
449 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
450 struct ide_atapi_pc *pc)
452 idefloppy_floppy_t *floppy = drive->driver_data;
454 if (floppy->failed_pc == NULL &&
455 pc->c[0] != GPCMD_REQUEST_SENSE)
456 floppy->failed_pc = pc;
457 /* Set the current packet command */
460 if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
461 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
462 ide_floppy_report_error(floppy, pc);
464 pc->error = IDEFLOPPY_ERROR_GENERAL;
466 floppy->failed_pc = NULL;
467 drive->pc_callback(drive);
471 debug_log("Retry number - %d\n", pc->retries);
475 return ide_issue_pc(drive, pc, idefloppy_start_pc_transfer,
476 IDEFLOPPY_WAIT_CMD, NULL);
479 static void idefloppy_create_prevent_cmd(struct ide_atapi_pc *pc, int prevent)
481 debug_log("creating prevent removal command, prevent = %d\n", prevent);
483 idefloppy_init_pc(pc);
484 pc->c[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL;
488 static void idefloppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
490 idefloppy_init_pc(pc);
491 pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
497 static void idefloppy_create_format_unit_cmd(struct ide_atapi_pc *pc, int b,
500 idefloppy_init_pc(pc);
501 pc->c[0] = GPCMD_FORMAT_UNIT;
504 memset(pc->buf, 0, 12);
506 /* Default format list header, u8 1: FOV/DCRT/IMM bits set */
508 if (flags & 1) /* Verify bit on... */
509 pc->buf[1] ^= 0x20; /* ... turn off DCRT bit */
512 put_unaligned(cpu_to_be32(b), (unsigned int *)(&pc->buf[4]));
513 put_unaligned(cpu_to_be32(l), (unsigned int *)(&pc->buf[8]));
515 pc->flags |= PC_FLAG_WRITING;
518 /* A mode sense command is used to "sense" floppy parameters. */
519 static void idefloppy_create_mode_sense_cmd(struct ide_atapi_pc *pc,
520 u8 page_code, u8 type)
522 u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
524 idefloppy_init_pc(pc);
525 pc->c[0] = GPCMD_MODE_SENSE_10;
527 pc->c[2] = page_code + (type << 6);
530 case IDEFLOPPY_CAPABILITIES_PAGE:
533 case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
537 printk(KERN_ERR "ide-floppy: unsupported page code "
538 "in create_mode_sense_cmd\n");
540 put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
541 pc->req_xfer = length;
544 static void idefloppy_create_start_stop_cmd(struct ide_atapi_pc *pc, int start)
546 idefloppy_init_pc(pc);
547 pc->c[0] = GPCMD_START_STOP_UNIT;
551 static void idefloppy_create_rw_cmd(idefloppy_floppy_t *floppy,
552 struct ide_atapi_pc *pc, struct request *rq,
553 unsigned long sector)
555 int block = sector / floppy->bs_factor;
556 int blocks = rq->nr_sectors / floppy->bs_factor;
557 int cmd = rq_data_dir(rq);
559 debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
562 idefloppy_init_pc(pc);
563 pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
564 put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
565 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
567 memcpy(rq->cmd, pc->c, 12);
570 pc->b_count = cmd == READ ? 0 : rq->bio->bi_size;
571 if (rq->cmd_flags & REQ_RW)
572 pc->flags |= PC_FLAG_WRITING;
574 pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
575 pc->flags |= PC_FLAG_DMA_OK;
578 static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
579 struct ide_atapi_pc *pc, struct request *rq)
581 idefloppy_init_pc(pc);
582 memcpy(pc->c, rq->cmd, sizeof(pc->c));
584 pc->b_count = rq->data_len;
585 if (rq->data_len && rq_data_dir(rq) == WRITE)
586 pc->flags |= PC_FLAG_WRITING;
589 pc->flags |= PC_FLAG_DMA_OK;
591 * possibly problematic, doesn't look like ide-floppy correctly
592 * handled scattered requests if dma fails...
594 pc->req_xfer = pc->buf_size = rq->data_len;
597 static ide_startstop_t idefloppy_do_request(ide_drive_t *drive,
598 struct request *rq, sector_t block_s)
600 idefloppy_floppy_t *floppy = drive->driver_data;
601 struct ide_atapi_pc *pc;
602 unsigned long block = (unsigned long)block_s;
604 debug_log("dev: %s, cmd_type: %x, errors: %d\n",
605 rq->rq_disk ? rq->rq_disk->disk_name : "?",
606 rq->cmd_type, rq->errors);
607 debug_log("sector: %ld, nr_sectors: %ld, "
608 "current_nr_sectors: %d\n", (long)rq->sector,
609 rq->nr_sectors, rq->current_nr_sectors);
611 if (rq->errors >= ERROR_MAX) {
612 if (floppy->failed_pc)
613 ide_floppy_report_error(floppy, floppy->failed_pc);
615 printk(KERN_ERR "ide-floppy: %s: I/O error\n",
617 idefloppy_end_request(drive, 0, 0);
620 if (blk_fs_request(rq)) {
621 if (((long)rq->sector % floppy->bs_factor) ||
622 (rq->nr_sectors % floppy->bs_factor)) {
623 printk(KERN_ERR "%s: unsupported r/w request size\n",
625 idefloppy_end_request(drive, 0, 0);
628 pc = idefloppy_next_pc_storage(drive);
629 idefloppy_create_rw_cmd(floppy, pc, rq, block);
630 } else if (blk_special_request(rq)) {
631 pc = (struct ide_atapi_pc *) rq->buffer;
632 } else if (blk_pc_request(rq)) {
633 pc = idefloppy_next_pc_storage(drive);
634 idefloppy_blockpc_cmd(floppy, pc, rq);
636 blk_dump_rq_flags(rq,
637 "ide-floppy: unsupported command in queue");
638 idefloppy_end_request(drive, 0, 0);
644 return idefloppy_issue_pc(drive, pc);
648 * Add a special packet command request to the tail of the request queue,
649 * and wait for it to be serviced.
651 static int idefloppy_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
653 struct ide_floppy_obj *floppy = drive->driver_data;
657 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
658 rq->buffer = (char *) pc;
659 rq->cmd_type = REQ_TYPE_SPECIAL;
660 memcpy(rq->cmd, pc->c, 12);
661 error = blk_execute_rq(drive->queue, floppy->disk, rq, 0);
668 * Look at the flexible disk page parameters. We ignore the CHS capacity
669 * parameters and use the LBA parameters instead.
671 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive)
673 idefloppy_floppy_t *floppy = drive->driver_data;
674 struct ide_atapi_pc pc;
676 int capacity, lba_capacity;
677 u16 transfer_rate, sector_size, cyls, rpm;
680 idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE,
683 if (idefloppy_queue_pc_tail(drive, &pc)) {
684 printk(KERN_ERR "ide-floppy: Can't get flexible disk page"
688 floppy->wp = !!(pc.buf[3] & 0x80);
689 set_disk_ro(floppy->disk, floppy->wp);
692 transfer_rate = be16_to_cpup((__be16 *)&pc.buf[8 + 2]);
693 sector_size = be16_to_cpup((__be16 *)&pc.buf[8 + 6]);
694 cyls = be16_to_cpup((__be16 *)&pc.buf[8 + 8]);
695 rpm = be16_to_cpup((__be16 *)&pc.buf[8 + 28]);
696 heads = pc.buf[8 + 4];
697 sectors = pc.buf[8 + 5];
699 capacity = cyls * heads * sectors * sector_size;
701 if (memcmp(page, &floppy->flexible_disk_page, 32))
702 printk(KERN_INFO "%s: %dkB, %d/%d/%d CHS, %d kBps, "
703 "%d sector size, %d rpm\n",
704 drive->name, capacity / 1024, cyls, heads,
705 sectors, transfer_rate / 8, sector_size, rpm);
707 memcpy(&floppy->flexible_disk_page, page, 32);
708 drive->bios_cyl = cyls;
709 drive->bios_head = heads;
710 drive->bios_sect = sectors;
711 lba_capacity = floppy->blocks * floppy->block_size;
713 if (capacity < lba_capacity) {
714 printk(KERN_NOTICE "%s: The disk reports a capacity of %d "
715 "bytes, but the drive only handles %d\n",
716 drive->name, lba_capacity, capacity);
717 floppy->blocks = floppy->block_size ?
718 capacity / floppy->block_size : 0;
723 static int idefloppy_get_sfrp_bit(ide_drive_t *drive)
725 idefloppy_floppy_t *floppy = drive->driver_data;
726 struct ide_atapi_pc pc;
729 idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_CAPABILITIES_PAGE,
732 pc.flags |= PC_FLAG_SUPPRESS_ERROR;
733 if (idefloppy_queue_pc_tail(drive, &pc))
736 floppy->srfp = pc.buf[8 + 2] & 0x40;
741 * Determine if a media is present in the floppy drive, and if so, its LBA
744 static int ide_floppy_get_capacity(ide_drive_t *drive)
746 idefloppy_floppy_t *floppy = drive->driver_data;
747 struct ide_atapi_pc pc;
749 u8 header_len, desc_cnt;
750 int i, rc = 1, blocks, length;
753 drive->bios_head = drive->bios_sect = 0;
755 floppy->bs_factor = 1;
756 set_capacity(floppy->disk, 0);
758 idefloppy_create_read_capacity_cmd(&pc);
759 if (idefloppy_queue_pc_tail(drive, &pc)) {
760 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
763 header_len = pc.buf[3];
764 cap_desc = &pc.buf[4];
765 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
767 for (i = 0; i < desc_cnt; i++) {
768 unsigned int desc_start = 4 + i*8;
770 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
771 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
773 debug_log("Descriptor %d: %dkB, %d blocks, %d sector size\n",
774 i, blocks * length / 1024, blocks, length);
779 * the code below is valid only for the 1st descriptor, ie i=0
782 switch (pc.buf[desc_start + 4] & 0x03) {
783 /* Clik! drive returns this instead of CAPACITY_CURRENT */
784 case CAPACITY_UNFORMATTED:
785 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
787 * If it is not a clik drive, break out
788 * (maintains previous driver behaviour)
791 case CAPACITY_CURRENT:
792 /* Normal Zip/LS-120 disks */
793 if (memcmp(cap_desc, &floppy->cap_desc, 8))
794 printk(KERN_INFO "%s: %dkB, %d blocks, %d "
795 "sector size\n", drive->name,
796 blocks * length / 1024, blocks, length);
797 memcpy(&floppy->cap_desc, cap_desc, 8);
799 if (!length || length % 512) {
800 printk(KERN_NOTICE "%s: %d bytes block size "
801 "not supported\n", drive->name, length);
803 floppy->blocks = blocks;
804 floppy->block_size = length;
805 floppy->bs_factor = length / 512;
806 if (floppy->bs_factor != 1)
807 printk(KERN_NOTICE "%s: warning: non "
808 "512 bytes block size not "
814 case CAPACITY_NO_CARTRIDGE:
816 * This is a KERN_ERR so it appears on screen
817 * for the user to see
819 printk(KERN_ERR "%s: No disk in drive\n", drive->name);
821 case CAPACITY_INVALID:
822 printk(KERN_ERR "%s: Invalid capacity for disk "
823 "in drive\n", drive->name);
826 debug_log("Descriptor 0 Code: %d\n",
827 pc.buf[desc_start + 4] & 0x03);
830 /* Clik! disk does not support get_flexible_disk_page */
831 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
832 (void) ide_floppy_get_flexible_disk_page(drive);
834 set_capacity(floppy->disk, floppy->blocks * floppy->bs_factor);
839 * Obtain the list of formattable capacities.
840 * Very similar to ide_floppy_get_capacity, except that we push the capacity
841 * descriptors to userland, instead of our own structures.
843 * Userland gives us the following structure:
845 * struct idefloppy_format_capacities {
853 * userland initializes nformats to the number of allocated formats[] records.
854 * On exit we set nformats to the number of records we've actually initialized.
857 static int ide_floppy_get_format_capacities(ide_drive_t *drive, int __user *arg)
859 struct ide_atapi_pc pc;
860 u8 header_len, desc_cnt;
861 int i, blocks, length, u_array_size, u_index;
864 if (get_user(u_array_size, arg))
867 if (u_array_size <= 0)
870 idefloppy_create_read_capacity_cmd(&pc);
871 if (idefloppy_queue_pc_tail(drive, &pc)) {
872 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
875 header_len = pc.buf[3];
876 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
882 * We always skip the first capacity descriptor. That's the current
883 * capacity. We are interested in the remaining descriptors, the
884 * formattable capacities.
886 for (i = 1; i < desc_cnt; i++) {
887 unsigned int desc_start = 4 + i*8;
889 if (u_index >= u_array_size)
890 break; /* User-supplied buffer too small */
892 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
893 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
895 if (put_user(blocks, argp))
899 if (put_user(length, argp))
906 if (put_user(u_index, arg))
912 * Get ATAPI_FORMAT_UNIT progress indication.
914 * Userland gives a pointer to an int. The int is set to a progress
915 * indicator 0-65536, with 65536=100%.
917 * If the drive does not support format progress indication, we just check
918 * the dsc bit, and return either 0 or 65536.
921 static int idefloppy_get_format_progress(ide_drive_t *drive, int __user *arg)
923 idefloppy_floppy_t *floppy = drive->driver_data;
924 struct ide_atapi_pc pc;
925 int progress_indication = 0x10000;
928 idefloppy_create_request_sense_cmd(&pc);
929 if (idefloppy_queue_pc_tail(drive, &pc))
932 if (floppy->sense_key == 2 &&
935 progress_indication = floppy->progress_indication;
937 /* Else assume format_unit has finished, and we're at 0x10000 */
939 ide_hwif_t *hwif = drive->hwif;
943 local_irq_save(flags);
944 stat = hwif->tp_ops->read_status(hwif);
945 local_irq_restore(flags);
947 progress_indication = ((stat & SEEK_STAT) == 0) ? 0 : 0x10000;
949 if (put_user(progress_indication, arg))
955 static sector_t idefloppy_capacity(ide_drive_t *drive)
957 idefloppy_floppy_t *floppy = drive->driver_data;
958 unsigned long capacity = floppy->blocks * floppy->bs_factor;
964 * Check whether we can support a drive, based on the ATAPI IDENTIFY command
967 static int idefloppy_identify_device(ide_drive_t *drive, struct hd_driveid *id)
970 u8 device_type, protocol, removable, drq_type, packet_size;
972 *((u16 *) &gcw) = id->config;
974 device_type = gcw[1] & 0x1F;
975 removable = (gcw[0] & 0x80) >> 7;
976 protocol = (gcw[1] & 0xC0) >> 6;
977 drq_type = (gcw[0] & 0x60) >> 5;
978 packet_size = gcw[0] & 0x03;
981 /* kludge for Apple PowerBook internal zip */
982 if (device_type == 5 &&
983 !strstr(id->model, "CD-ROM") && strstr(id->model, "ZIP"))
988 printk(KERN_ERR "ide-floppy: Protocol (0x%02x) is not ATAPI\n",
990 else if (device_type != 0)
991 printk(KERN_ERR "ide-floppy: Device type (0x%02x) is not set "
992 "to floppy\n", device_type);
994 printk(KERN_ERR "ide-floppy: The removable flag is not set\n");
995 else if (drq_type == 3)
996 printk(KERN_ERR "ide-floppy: Sorry, DRQ type (0x%02x) not "
997 "supported\n", drq_type);
998 else if (packet_size != 0)
999 printk(KERN_ERR "ide-floppy: Packet size (0x%02x) is not 12 "
1000 "bytes\n", packet_size);
1006 #ifdef CONFIG_IDE_PROC_FS
1007 static void idefloppy_add_settings(ide_drive_t *drive)
1009 idefloppy_floppy_t *floppy = drive->driver_data;
1011 ide_add_setting(drive, "bios_cyl", SETTING_RW, TYPE_INT, 0, 1023, 1, 1,
1012 &drive->bios_cyl, NULL);
1013 ide_add_setting(drive, "bios_head", SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1014 &drive->bios_head, NULL);
1015 ide_add_setting(drive, "bios_sect", SETTING_RW, TYPE_BYTE, 0, 63, 1, 1,
1016 &drive->bios_sect, NULL);
1017 ide_add_setting(drive, "ticks", SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1018 &floppy->ticks, NULL);
1021 static inline void idefloppy_add_settings(ide_drive_t *drive) { ; }
1024 static void idefloppy_setup(ide_drive_t *drive, idefloppy_floppy_t *floppy)
1028 *((u16 *) &gcw) = drive->id->config;
1029 floppy->pc = floppy->pc_stack;
1030 drive->pc_callback = ide_floppy_callback;
1032 if (((gcw[0] & 0x60) >> 5) == 1)
1033 drive->atapi_flags |= IDE_AFLAG_DRQ_INTERRUPT;
1035 * We used to check revisions here. At this point however I'm giving up.
1036 * Just assume they are all broken, its easier.
1038 * The actual reason for the workarounds was likely a driver bug after
1039 * all rather than a firmware bug, and the workaround below used to hide
1040 * it. It should be fixed as of version 1.9, but to be on the safe side
1041 * we'll leave the limitation below for the 2.2.x tree.
1043 if (!strncmp(drive->id->model, "IOMEGA ZIP 100 ATAPI", 20)) {
1044 drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE;
1045 /* This value will be visible in the /proc/ide/hdx/settings */
1046 floppy->ticks = IDEFLOPPY_TICKS_DELAY;
1047 blk_queue_max_sectors(drive->queue, 64);
1051 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
1052 * nasty clicking noises without it, so please don't remove this.
1054 if (strncmp(drive->id->model, "IOMEGA Clik!", 11) == 0) {
1055 blk_queue_max_sectors(drive->queue, 64);
1056 drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE;
1059 (void) ide_floppy_get_capacity(drive);
1060 idefloppy_add_settings(drive);
1063 static void ide_floppy_remove(ide_drive_t *drive)
1065 idefloppy_floppy_t *floppy = drive->driver_data;
1066 struct gendisk *g = floppy->disk;
1068 ide_proc_unregister_driver(drive, floppy->driver);
1072 ide_floppy_put(floppy);
1075 static void idefloppy_cleanup_obj(struct kref *kref)
1077 struct ide_floppy_obj *floppy = to_ide_floppy(kref);
1078 ide_drive_t *drive = floppy->drive;
1079 struct gendisk *g = floppy->disk;
1081 drive->driver_data = NULL;
1082 g->private_data = NULL;
1087 #ifdef CONFIG_IDE_PROC_FS
1088 static int proc_idefloppy_read_capacity(char *page, char **start, off_t off,
1089 int count, int *eof, void *data)
1091 ide_drive_t*drive = (ide_drive_t *)data;
1094 len = sprintf(page, "%llu\n", (long long)idefloppy_capacity(drive));
1095 PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1098 static ide_proc_entry_t idefloppy_proc[] = {
1099 { "capacity", S_IFREG|S_IRUGO, proc_idefloppy_read_capacity, NULL },
1100 { "geometry", S_IFREG|S_IRUGO, proc_ide_read_geometry, NULL },
1101 { NULL, 0, NULL, NULL }
1103 #endif /* CONFIG_IDE_PROC_FS */
1105 static int ide_floppy_probe(ide_drive_t *);
1107 static ide_driver_t idefloppy_driver = {
1109 .owner = THIS_MODULE,
1110 .name = "ide-floppy",
1111 .bus = &ide_bus_type,
1113 .probe = ide_floppy_probe,
1114 .remove = ide_floppy_remove,
1115 .version = IDEFLOPPY_VERSION,
1116 .media = ide_floppy,
1117 .supports_dsc_overlap = 0,
1118 .do_request = idefloppy_do_request,
1119 .end_request = idefloppy_end_request,
1120 .error = __ide_error,
1121 #ifdef CONFIG_IDE_PROC_FS
1122 .proc = idefloppy_proc,
1126 static int idefloppy_open(struct inode *inode, struct file *filp)
1128 struct gendisk *disk = inode->i_bdev->bd_disk;
1129 struct ide_floppy_obj *floppy;
1131 struct ide_atapi_pc pc;
1134 debug_log("Reached %s\n", __func__);
1136 floppy = ide_floppy_get(disk);
1140 drive = floppy->drive;
1144 if (floppy->openers == 1) {
1145 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1148 idefloppy_init_pc(&pc);
1149 pc.c[0] = GPCMD_TEST_UNIT_READY;
1151 if (idefloppy_queue_pc_tail(drive, &pc)) {
1152 idefloppy_create_start_stop_cmd(&pc, 1);
1153 (void) idefloppy_queue_pc_tail(drive, &pc);
1156 if (ide_floppy_get_capacity(drive)
1157 && (filp->f_flags & O_NDELAY) == 0
1159 * Allow O_NDELAY to open a drive without a disk, or with an
1160 * unreadable disk, so that we can get the format capacity
1161 * of the drive or begin the format - Sam
1165 goto out_put_floppy;
1168 if (floppy->wp && (filp->f_mode & 2)) {
1170 goto out_put_floppy;
1172 drive->atapi_flags |= IDE_AFLAG_MEDIA_CHANGED;
1173 /* IOMEGA Clik! drives do not support lock/unlock commands */
1174 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1175 idefloppy_create_prevent_cmd(&pc, 1);
1176 (void) idefloppy_queue_pc_tail(drive, &pc);
1178 check_disk_change(inode->i_bdev);
1179 } else if (drive->atapi_flags & IDE_AFLAG_FORMAT_IN_PROGRESS) {
1181 goto out_put_floppy;
1187 ide_floppy_put(floppy);
1191 static int idefloppy_release(struct inode *inode, struct file *filp)
1193 struct gendisk *disk = inode->i_bdev->bd_disk;
1194 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1195 ide_drive_t *drive = floppy->drive;
1196 struct ide_atapi_pc pc;
1198 debug_log("Reached %s\n", __func__);
1200 if (floppy->openers == 1) {
1201 /* IOMEGA Clik! drives do not support lock/unlock commands */
1202 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1203 idefloppy_create_prevent_cmd(&pc, 0);
1204 (void) idefloppy_queue_pc_tail(drive, &pc);
1207 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1212 ide_floppy_put(floppy);
1217 static int idefloppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1219 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1220 ide_drive_t *drive = floppy->drive;
1222 geo->heads = drive->bios_head;
1223 geo->sectors = drive->bios_sect;
1224 geo->cylinders = (u16)drive->bios_cyl; /* truncate */
1228 static int ide_floppy_lockdoor(ide_drive_t *drive, struct ide_atapi_pc *pc,
1229 unsigned long arg, unsigned int cmd)
1231 idefloppy_floppy_t *floppy = drive->driver_data;
1233 if (floppy->openers > 1)
1236 /* The IOMEGA Clik! Drive doesn't support this command -
1237 * no room for an eject mechanism */
1238 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) {
1239 int prevent = arg ? 1 : 0;
1241 if (cmd == CDROMEJECT)
1244 idefloppy_create_prevent_cmd(pc, prevent);
1245 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1248 if (cmd == CDROMEJECT) {
1249 idefloppy_create_start_stop_cmd(pc, 2);
1250 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1256 static int ide_floppy_format_unit(idefloppy_floppy_t *floppy,
1259 struct ide_atapi_pc pc;
1260 ide_drive_t *drive = floppy->drive;
1261 int blocks, length, flags, err = 0;
1263 if (floppy->openers > 1) {
1264 /* Don't format if someone is using the disk */
1265 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1269 drive->atapi_flags |= IDE_AFLAG_FORMAT_IN_PROGRESS;
1272 * Send ATAPI_FORMAT_UNIT to the drive.
1274 * Userland gives us the following structure:
1276 * struct idefloppy_format_command {
1282 * flags is a bitmask, currently, the only defined flag is:
1284 * 0x01 - verify media after format.
1286 if (get_user(blocks, arg) ||
1287 get_user(length, arg+1) ||
1288 get_user(flags, arg+2)) {
1293 (void) idefloppy_get_sfrp_bit(drive);
1294 idefloppy_create_format_unit_cmd(&pc, blocks, length, flags);
1296 if (idefloppy_queue_pc_tail(drive, &pc))
1301 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
1306 static int idefloppy_ioctl(struct inode *inode, struct file *file,
1307 unsigned int cmd, unsigned long arg)
1309 struct block_device *bdev = inode->i_bdev;
1310 struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1311 ide_drive_t *drive = floppy->drive;
1312 struct ide_atapi_pc pc;
1313 void __user *argp = (void __user *)arg;
1319 case CDROM_LOCKDOOR:
1320 return ide_floppy_lockdoor(drive, &pc, arg, cmd);
1321 case IDEFLOPPY_IOCTL_FORMAT_SUPPORTED:
1323 case IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY:
1324 return ide_floppy_get_format_capacities(drive, argp);
1325 case IDEFLOPPY_IOCTL_FORMAT_START:
1326 if (!(file->f_mode & 2))
1329 return ide_floppy_format_unit(floppy, (int __user *)arg);
1330 case IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS:
1331 return idefloppy_get_format_progress(drive, argp);
1335 * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
1336 * and CDROM_SEND_PACKET (legacy) ioctls
1338 if (cmd != CDROM_SEND_PACKET && cmd != SCSI_IOCTL_SEND_COMMAND)
1339 err = scsi_cmd_ioctl(file, bdev->bd_disk->queue,
1340 bdev->bd_disk, cmd, argp);
1345 err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
1350 static int idefloppy_media_changed(struct gendisk *disk)
1352 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1353 ide_drive_t *drive = floppy->drive;
1356 /* do not scan partitions twice if this is a removable device */
1357 if (drive->attach) {
1361 ret = !!(drive->atapi_flags & IDE_AFLAG_MEDIA_CHANGED);
1362 drive->atapi_flags &= ~IDE_AFLAG_MEDIA_CHANGED;
1366 static int idefloppy_revalidate_disk(struct gendisk *disk)
1368 struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1369 set_capacity(disk, idefloppy_capacity(floppy->drive));
1373 static struct block_device_operations idefloppy_ops = {
1374 .owner = THIS_MODULE,
1375 .open = idefloppy_open,
1376 .release = idefloppy_release,
1377 .ioctl = idefloppy_ioctl,
1378 .getgeo = idefloppy_getgeo,
1379 .media_changed = idefloppy_media_changed,
1380 .revalidate_disk = idefloppy_revalidate_disk
1383 static int ide_floppy_probe(ide_drive_t *drive)
1385 idefloppy_floppy_t *floppy;
1388 if (!strstr("ide-floppy", drive->driver_req))
1390 if (!drive->present)
1392 if (drive->media != ide_floppy)
1394 if (!idefloppy_identify_device(drive, drive->id)) {
1395 printk(KERN_ERR "ide-floppy: %s: not supported by this version"
1396 " of ide-floppy\n", drive->name);
1399 floppy = kzalloc(sizeof(idefloppy_floppy_t), GFP_KERNEL);
1401 printk(KERN_ERR "ide-floppy: %s: Can't allocate a floppy"
1402 " structure\n", drive->name);
1406 g = alloc_disk(1 << PARTN_BITS);
1408 goto out_free_floppy;
1410 ide_init_disk(g, drive);
1412 ide_proc_register_driver(drive, &idefloppy_driver);
1414 kref_init(&floppy->kref);
1416 floppy->drive = drive;
1417 floppy->driver = &idefloppy_driver;
1420 g->private_data = &floppy->driver;
1422 drive->driver_data = floppy;
1424 idefloppy_setup(drive, floppy);
1426 g->minors = 1 << PARTN_BITS;
1427 g->driverfs_dev = &drive->gendev;
1428 g->flags = drive->removable ? GENHD_FL_REMOVABLE : 0;
1429 g->fops = &idefloppy_ops;
1440 static void __exit idefloppy_exit(void)
1442 driver_unregister(&idefloppy_driver.gen_driver);
1445 static int __init idefloppy_init(void)
1447 printk("ide-floppy driver " IDEFLOPPY_VERSION "\n");
1448 return driver_register(&idefloppy_driver.gen_driver);
1451 MODULE_ALIAS("ide:*m-floppy*");
1452 module_init(idefloppy_init);
1453 module_exit(idefloppy_exit);
1454 MODULE_LICENSE("GPL");
1455 MODULE_DESCRIPTION("ATAPI FLOPPY Driver");