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 #include <linux/types.h>
19 #include <linux/string.h>
20 #include <linux/kernel.h>
21 #include <linux/delay.h>
22 #include <linux/timer.h>
24 #include <linux/interrupt.h>
25 #include <linux/major.h>
26 #include <linux/errno.h>
27 #include <linux/genhd.h>
28 #include <linux/slab.h>
29 #include <linux/cdrom.h>
30 #include <linux/ide.h>
31 #include <linux/hdreg.h>
32 #include <linux/bitops.h>
33 #include <linux/mutex.h>
34 #include <linux/scatterlist.h>
36 #include <scsi/scsi_ioctl.h>
38 #include <asm/byteorder.h>
39 #include <linux/irq.h>
40 #include <linux/uaccess.h>
42 #include <asm/unaligned.h>
44 #include "ide-floppy.h"
47 * After each failed packet command we issue a request sense command and retry
48 * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
50 #define IDEFLOPPY_MAX_PC_RETRIES 3
52 /* format capacities descriptor codes */
53 #define CAPACITY_INVALID 0x00
54 #define CAPACITY_UNFORMATTED 0x01
55 #define CAPACITY_CURRENT 0x02
56 #define CAPACITY_NO_CARTRIDGE 0x03
59 * The following delay solves a problem with ATAPI Zip 100 drive where BSY bit
60 * was apparently being deasserted before the unit was ready to receive data.
62 #define IDEFLOPPY_PC_DELAY (HZ/20) /* default delay for ZIP 100 (50ms) */
64 /* Error code returned in rq->errors to the higher part of the driver. */
65 #define IDEFLOPPY_ERROR_GENERAL 101
68 * Used to finish servicing a request. For read/write requests, we will call
69 * ide_end_request to pass to the next buffer.
71 static int ide_floppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
73 struct ide_disk_obj *floppy = drive->driver_data;
74 struct request *rq = drive->hwif->rq;
77 ide_debug_log(IDE_DBG_FUNC, "enter");
81 error = IDEFLOPPY_ERROR_GENERAL;
93 floppy->failed_pc = NULL;
95 if (!blk_special_request(rq)) {
96 /* our real local end request function */
97 ide_end_request(drive, uptodate, nsecs);
101 /* fixme: need to move this local also */
102 ide_complete_rq(drive, 0);
106 static void idefloppy_update_buffers(ide_drive_t *drive,
107 struct ide_atapi_pc *pc)
109 struct request *rq = pc->rq;
110 struct bio *bio = rq->bio;
112 while ((bio = rq->bio) != NULL)
113 ide_floppy_end_request(drive, 1, 0);
116 static void ide_floppy_callback(ide_drive_t *drive, int dsc)
118 struct ide_disk_obj *floppy = drive->driver_data;
119 struct ide_atapi_pc *pc = drive->pc;
120 int uptodate = pc->error ? 0 : 1;
122 ide_debug_log(IDE_DBG_FUNC, "enter");
124 if (floppy->failed_pc == pc)
125 floppy->failed_pc = NULL;
127 if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
128 (pc->rq && blk_pc_request(pc->rq)))
129 uptodate = 1; /* FIXME */
130 else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
134 floppy->sense_key = buf[2] & 0x0F;
135 floppy->asc = buf[12];
136 floppy->ascq = buf[13];
137 floppy->progress_indication = buf[15] & 0x80 ?
138 (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
140 if (floppy->failed_pc)
141 ide_debug_log(IDE_DBG_PC, "pc = %x",
142 floppy->failed_pc->c[0]);
144 ide_debug_log(IDE_DBG_SENSE, "sense key = %x, asc = %x,"
145 "ascq = %x", floppy->sense_key,
146 floppy->asc, floppy->ascq);
148 printk(KERN_ERR PFX "Error in REQUEST SENSE itself - "
149 "Aborting request!\n");
152 ide_floppy_end_request(drive, uptodate, 0);
155 static void ide_floppy_report_error(struct ide_disk_obj *floppy,
156 struct ide_atapi_pc *pc)
158 /* supress error messages resulting from Medium not present */
159 if (floppy->sense_key == 0x02 &&
160 floppy->asc == 0x3a &&
161 floppy->ascq == 0x00)
164 printk(KERN_ERR PFX "%s: I/O error, pc = %2x, key = %2x, "
165 "asc = %2x, ascq = %2x\n",
166 floppy->drive->name, pc->c[0], floppy->sense_key,
167 floppy->asc, floppy->ascq);
171 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
172 struct ide_atapi_pc *pc)
174 struct ide_disk_obj *floppy = drive->driver_data;
176 if (floppy->failed_pc == NULL &&
177 pc->c[0] != GPCMD_REQUEST_SENSE)
178 floppy->failed_pc = pc;
180 /* Set the current packet command */
183 if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
184 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
185 ide_floppy_report_error(floppy, pc);
187 pc->error = IDEFLOPPY_ERROR_GENERAL;
189 floppy->failed_pc = NULL;
190 drive->pc_callback(drive, 0);
194 ide_debug_log(IDE_DBG_FUNC, "retry #%d", pc->retries);
198 return ide_issue_pc(drive);
201 void ide_floppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
204 pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
210 /* A mode sense command is used to "sense" floppy parameters. */
211 void ide_floppy_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
213 u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
216 pc->c[0] = GPCMD_MODE_SENSE_10;
218 pc->c[2] = page_code;
221 case IDEFLOPPY_CAPABILITIES_PAGE:
224 case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
228 printk(KERN_ERR PFX "unsupported page code in %s\n", __func__);
230 put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
231 pc->req_xfer = length;
234 static void idefloppy_create_rw_cmd(ide_drive_t *drive,
235 struct ide_atapi_pc *pc, struct request *rq,
236 unsigned long sector)
238 struct ide_disk_obj *floppy = drive->driver_data;
239 int block = sector / floppy->bs_factor;
240 int blocks = rq->nr_sectors / floppy->bs_factor;
241 int cmd = rq_data_dir(rq);
243 ide_debug_log(IDE_DBG_FUNC, "block: %d, blocks: %d", block, blocks);
246 pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
247 put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
248 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
250 memcpy(rq->cmd, pc->c, 12);
254 if (rq->cmd_flags & REQ_RW)
255 pc->flags |= PC_FLAG_WRITING;
257 pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
258 pc->flags |= PC_FLAG_DMA_OK;
261 static void idefloppy_blockpc_cmd(struct ide_disk_obj *floppy,
262 struct ide_atapi_pc *pc, struct request *rq)
265 memcpy(pc->c, rq->cmd, sizeof(pc->c));
268 if (rq->data_len && rq_data_dir(rq) == WRITE)
269 pc->flags |= PC_FLAG_WRITING;
272 pc->flags |= PC_FLAG_DMA_OK;
274 * possibly problematic, doesn't look like ide-floppy correctly
275 * handled scattered requests if dma fails...
277 pc->req_xfer = pc->buf_size = rq->data_len;
280 static ide_startstop_t ide_floppy_do_request(ide_drive_t *drive,
281 struct request *rq, sector_t block)
283 struct ide_disk_obj *floppy = drive->driver_data;
284 ide_hwif_t *hwif = drive->hwif;
285 struct ide_atapi_pc *pc;
287 if (drive->debug_mask & IDE_DBG_RQ)
288 blk_dump_rq_flags(rq, (rq->rq_disk
289 ? rq->rq_disk->disk_name
292 if (rq->errors >= ERROR_MAX) {
293 if (floppy->failed_pc)
294 ide_floppy_report_error(floppy, floppy->failed_pc);
296 printk(KERN_ERR PFX "%s: I/O error\n", drive->name);
298 ide_floppy_end_request(drive, 0, 0);
301 if (blk_fs_request(rq)) {
302 if (((long)rq->sector % floppy->bs_factor) ||
303 (rq->nr_sectors % floppy->bs_factor)) {
304 printk(KERN_ERR PFX "%s: unsupported r/w rq size\n",
306 ide_floppy_end_request(drive, 0, 0);
309 pc = &floppy->queued_pc;
310 idefloppy_create_rw_cmd(drive, pc, rq, (unsigned long)block);
311 } else if (blk_special_request(rq)) {
312 pc = (struct ide_atapi_pc *) rq->buffer;
313 } else if (blk_pc_request(rq)) {
314 pc = &floppy->queued_pc;
315 idefloppy_blockpc_cmd(floppy, pc, rq);
317 blk_dump_rq_flags(rq, PFX "unsupported command in queue");
318 ide_floppy_end_request(drive, 0, 0);
322 if (blk_fs_request(rq) || pc->req_xfer) {
323 ide_init_sg_cmd(drive, rq);
324 ide_map_sg(drive, rq);
327 pc->sg = hwif->sg_table;
328 pc->sg_cnt = hwif->sg_nents;
332 return idefloppy_issue_pc(drive, pc);
336 * Look at the flexible disk page parameters. We ignore the CHS capacity
337 * parameters and use the LBA parameters instead.
339 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive,
340 struct ide_atapi_pc *pc)
342 struct ide_disk_obj *floppy = drive->driver_data;
343 struct gendisk *disk = floppy->disk;
345 int capacity, lba_capacity;
346 u16 transfer_rate, sector_size, cyls, rpm;
349 ide_floppy_create_mode_sense_cmd(pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE);
351 if (ide_queue_pc_tail(drive, disk, pc)) {
352 printk(KERN_ERR PFX "Can't get flexible disk page params\n");
356 if (pc->buf[3] & 0x80)
357 drive->dev_flags |= IDE_DFLAG_WP;
359 drive->dev_flags &= ~IDE_DFLAG_WP;
361 set_disk_ro(disk, !!(drive->dev_flags & IDE_DFLAG_WP));
365 transfer_rate = be16_to_cpup((__be16 *)&pc->buf[8 + 2]);
366 sector_size = be16_to_cpup((__be16 *)&pc->buf[8 + 6]);
367 cyls = be16_to_cpup((__be16 *)&pc->buf[8 + 8]);
368 rpm = be16_to_cpup((__be16 *)&pc->buf[8 + 28]);
369 heads = pc->buf[8 + 4];
370 sectors = pc->buf[8 + 5];
372 capacity = cyls * heads * sectors * sector_size;
374 if (memcmp(page, &floppy->flexible_disk_page, 32))
375 printk(KERN_INFO PFX "%s: %dkB, %d/%d/%d CHS, %d kBps, "
376 "%d sector size, %d rpm\n",
377 drive->name, capacity / 1024, cyls, heads,
378 sectors, transfer_rate / 8, sector_size, rpm);
380 memcpy(&floppy->flexible_disk_page, page, 32);
381 drive->bios_cyl = cyls;
382 drive->bios_head = heads;
383 drive->bios_sect = sectors;
384 lba_capacity = floppy->blocks * floppy->block_size;
386 if (capacity < lba_capacity) {
387 printk(KERN_NOTICE PFX "%s: The disk reports a capacity of %d "
388 "bytes, but the drive only handles %d\n",
389 drive->name, lba_capacity, capacity);
390 floppy->blocks = floppy->block_size ?
391 capacity / floppy->block_size : 0;
392 drive->capacity64 = floppy->blocks * floppy->bs_factor;
399 * Determine if a media is present in the floppy drive, and if so, its LBA
402 static int ide_floppy_get_capacity(ide_drive_t *drive)
404 struct ide_disk_obj *floppy = drive->driver_data;
405 struct gendisk *disk = floppy->disk;
406 struct ide_atapi_pc pc;
408 u8 header_len, desc_cnt;
409 int i, rc = 1, blocks, length;
412 drive->bios_head = drive->bios_sect = 0;
414 floppy->bs_factor = 1;
415 drive->capacity64 = 0;
417 ide_floppy_create_read_capacity_cmd(&pc);
418 if (ide_queue_pc_tail(drive, disk, &pc)) {
419 printk(KERN_ERR PFX "Can't get floppy parameters\n");
422 header_len = pc.buf[3];
423 cap_desc = &pc.buf[4];
424 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
426 for (i = 0; i < desc_cnt; i++) {
427 unsigned int desc_start = 4 + i*8;
429 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
430 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
432 ide_debug_log(IDE_DBG_PROBE, "Descriptor %d: %dkB, %d blocks, "
434 i, blocks * length / 1024,
440 * the code below is valid only for the 1st descriptor, ie i=0
443 switch (pc.buf[desc_start + 4] & 0x03) {
444 /* Clik! drive returns this instead of CAPACITY_CURRENT */
445 case CAPACITY_UNFORMATTED:
446 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
448 * If it is not a clik drive, break out
449 * (maintains previous driver behaviour)
452 case CAPACITY_CURRENT:
453 /* Normal Zip/LS-120 disks */
454 if (memcmp(cap_desc, &floppy->cap_desc, 8))
455 printk(KERN_INFO PFX "%s: %dkB, %d blocks, %d "
457 drive->name, blocks * length / 1024,
459 memcpy(&floppy->cap_desc, cap_desc, 8);
461 if (!length || length % 512) {
462 printk(KERN_NOTICE PFX "%s: %d bytes block size"
463 " not supported\n", drive->name, length);
465 floppy->blocks = blocks;
466 floppy->block_size = length;
467 floppy->bs_factor = length / 512;
468 if (floppy->bs_factor != 1)
469 printk(KERN_NOTICE PFX "%s: Warning: "
470 "non 512 bytes block size not "
474 floppy->blocks * floppy->bs_factor;
478 case CAPACITY_NO_CARTRIDGE:
480 * This is a KERN_ERR so it appears on screen
481 * for the user to see
483 printk(KERN_ERR PFX "%s: No disk in drive\n",
486 case CAPACITY_INVALID:
487 printk(KERN_ERR PFX "%s: Invalid capacity for disk "
488 "in drive\n", drive->name);
491 ide_debug_log(IDE_DBG_PROBE, "Descriptor 0 Code: %d",
492 pc.buf[desc_start + 4] & 0x03);
495 /* Clik! disk does not support get_flexible_disk_page */
496 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
497 (void) ide_floppy_get_flexible_disk_page(drive, &pc);
502 static void ide_floppy_setup(ide_drive_t *drive)
504 struct ide_disk_obj *floppy = drive->driver_data;
507 drive->pc_callback = ide_floppy_callback;
508 drive->pc_update_buffers = idefloppy_update_buffers;
509 drive->pc_io_buffers = ide_io_buffers;
512 * We used to check revisions here. At this point however I'm giving up.
513 * Just assume they are all broken, its easier.
515 * The actual reason for the workarounds was likely a driver bug after
516 * all rather than a firmware bug, and the workaround below used to hide
517 * it. It should be fixed as of version 1.9, but to be on the safe side
518 * we'll leave the limitation below for the 2.2.x tree.
520 if (!strncmp((char *)&id[ATA_ID_PROD], "IOMEGA ZIP 100 ATAPI", 20)) {
521 drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE;
522 /* This value will be visible in the /proc/ide/hdx/settings */
523 drive->pc_delay = IDEFLOPPY_PC_DELAY;
524 blk_queue_max_sectors(drive->queue, 64);
528 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
529 * nasty clicking noises without it, so please don't remove this.
531 if (strncmp((char *)&id[ATA_ID_PROD], "IOMEGA Clik!", 11) == 0) {
532 blk_queue_max_sectors(drive->queue, 64);
533 drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE;
534 /* IOMEGA Clik! drives do not support lock/unlock commands */
535 drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING;
538 (void) ide_floppy_get_capacity(drive);
540 ide_proc_register_driver(drive, floppy->driver);
542 drive->dev_flags |= IDE_DFLAG_ATTACH;
545 static void ide_floppy_flush(ide_drive_t *drive)
549 static int ide_floppy_init_media(ide_drive_t *drive, struct gendisk *disk)
553 if (ide_do_test_unit_ready(drive, disk))
554 ide_do_start_stop(drive, disk, 1);
556 ret = ide_floppy_get_capacity(drive);
558 set_capacity(disk, ide_gd_capacity(drive));
563 const struct ide_disk_ops ide_atapi_disk_ops = {
564 .check = ide_check_atapi_device,
565 .get_capacity = ide_floppy_get_capacity,
566 .setup = ide_floppy_setup,
567 .flush = ide_floppy_flush,
568 .init_media = ide_floppy_init_media,
569 .set_doorlock = ide_set_media_lock,
570 .do_request = ide_floppy_do_request,
571 .end_request = ide_floppy_end_request,
572 .ioctl = ide_floppy_ioctl,