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 int ide_floppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
73 idefloppy_floppy_t *floppy = drive->driver_data;
74 struct request *rq = HWGROUP(drive)->rq;
77 ide_debug_log(IDE_DBG_FUNC, "Call %s\n", __func__);
81 error = IDEFLOPPY_ERROR_GENERAL;
93 floppy->failed_pc = NULL;
94 /* Why does this happen? */
97 if (!blk_special_request(rq)) {
98 /* our real local end request function */
99 ide_end_request(drive, uptodate, nsecs);
103 /* fixme: need to move this local also */
104 ide_end_drive_cmd(drive, 0, 0);
108 static void idefloppy_update_buffers(ide_drive_t *drive,
109 struct ide_atapi_pc *pc)
111 struct request *rq = pc->rq;
112 struct bio *bio = rq->bio;
114 while ((bio = rq->bio) != NULL)
115 ide_floppy_end_request(drive, 1, 0);
118 static void ide_floppy_callback(ide_drive_t *drive, int dsc)
120 idefloppy_floppy_t *floppy = drive->driver_data;
121 struct ide_atapi_pc *pc = drive->pc;
122 int uptodate = pc->error ? 0 : 1;
124 ide_debug_log(IDE_DBG_FUNC, "Call %s\n", __func__);
126 if (floppy->failed_pc == pc)
127 floppy->failed_pc = NULL;
129 if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
130 (pc->rq && blk_pc_request(pc->rq)))
131 uptodate = 1; /* FIXME */
132 else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
136 floppy->sense_key = buf[2] & 0x0F;
137 floppy->asc = buf[12];
138 floppy->ascq = buf[13];
139 floppy->progress_indication = buf[15] & 0x80 ?
140 (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
142 if (floppy->failed_pc)
143 ide_debug_log(IDE_DBG_PC, "pc = %x, ",
144 floppy->failed_pc->c[0]);
146 ide_debug_log(IDE_DBG_SENSE, "sense key = %x, asc = %x,"
147 "ascq = %x\n", floppy->sense_key,
148 floppy->asc, floppy->ascq);
150 printk(KERN_ERR PFX "Error in REQUEST SENSE itself - "
151 "Aborting request!\n");
154 ide_floppy_end_request(drive, uptodate, 0);
157 static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
158 struct ide_atapi_pc *pc)
160 /* supress error messages resulting from Medium not present */
161 if (floppy->sense_key == 0x02 &&
162 floppy->asc == 0x3a &&
163 floppy->ascq == 0x00)
166 printk(KERN_ERR PFX "%s: I/O error, pc = %2x, key = %2x, "
167 "asc = %2x, ascq = %2x\n",
168 floppy->drive->name, pc->c[0], floppy->sense_key,
169 floppy->asc, floppy->ascq);
173 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
174 struct ide_atapi_pc *pc)
176 idefloppy_floppy_t *floppy = drive->driver_data;
178 if (floppy->failed_pc == NULL &&
179 pc->c[0] != GPCMD_REQUEST_SENSE)
180 floppy->failed_pc = pc;
182 /* Set the current packet command */
185 if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
186 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
187 ide_floppy_report_error(floppy, pc);
189 pc->error = IDEFLOPPY_ERROR_GENERAL;
191 floppy->failed_pc = NULL;
192 drive->pc_callback(drive, 0);
196 ide_debug_log(IDE_DBG_FUNC, "%s: Retry #%d\n", __func__, pc->retries);
200 return ide_issue_pc(drive, WAIT_FLOPPY_CMD, NULL);
203 void ide_floppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
206 pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
212 /* A mode sense command is used to "sense" floppy parameters. */
213 void ide_floppy_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
215 u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
218 pc->c[0] = GPCMD_MODE_SENSE_10;
220 pc->c[2] = page_code;
223 case IDEFLOPPY_CAPABILITIES_PAGE:
226 case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
230 printk(KERN_ERR PFX "unsupported page code in %s\n", __func__);
232 put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
233 pc->req_xfer = length;
236 static void idefloppy_create_rw_cmd(ide_drive_t *drive,
237 struct ide_atapi_pc *pc, struct request *rq,
238 unsigned long sector)
240 idefloppy_floppy_t *floppy = drive->driver_data;
241 int block = sector / floppy->bs_factor;
242 int blocks = rq->nr_sectors / floppy->bs_factor;
243 int cmd = rq_data_dir(rq);
245 ide_debug_log(IDE_DBG_FUNC, "%s: block: %d, blocks: %d\n", __func__,
249 pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
250 put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
251 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
253 memcpy(rq->cmd, pc->c, 12);
257 if (rq->cmd_flags & REQ_RW)
258 pc->flags |= PC_FLAG_WRITING;
260 pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
261 pc->flags |= PC_FLAG_DMA_OK;
264 static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
265 struct ide_atapi_pc *pc, struct request *rq)
268 memcpy(pc->c, rq->cmd, sizeof(pc->c));
271 if (rq->data_len && rq_data_dir(rq) == WRITE)
272 pc->flags |= PC_FLAG_WRITING;
275 pc->flags |= PC_FLAG_DMA_OK;
277 * possibly problematic, doesn't look like ide-floppy correctly
278 * handled scattered requests if dma fails...
280 pc->req_xfer = pc->buf_size = rq->data_len;
283 ide_startstop_t ide_floppy_do_request(ide_drive_t *drive, struct request *rq,
286 idefloppy_floppy_t *floppy = drive->driver_data;
287 ide_hwif_t *hwif = drive->hwif;
288 struct ide_atapi_pc *pc;
289 unsigned long block = (unsigned long)block_s;
291 ide_debug_log(IDE_DBG_FUNC, "%s: dev: %s, cmd: 0x%x, cmd_type: %x, "
293 __func__, rq->rq_disk ? rq->rq_disk->disk_name : "?",
294 rq->cmd[0], rq->cmd_type, rq->errors);
296 ide_debug_log(IDE_DBG_FUNC, "%s: sector: %ld, nr_sectors: %ld, "
297 "current_nr_sectors: %d\n",
298 __func__, (long)rq->sector, rq->nr_sectors,
299 rq->current_nr_sectors);
301 if (rq->errors >= ERROR_MAX) {
302 if (floppy->failed_pc)
303 ide_floppy_report_error(floppy, floppy->failed_pc);
305 printk(KERN_ERR PFX "%s: I/O error\n", drive->name);
307 ide_floppy_end_request(drive, 0, 0);
310 if (blk_fs_request(rq)) {
311 if (((long)rq->sector % floppy->bs_factor) ||
312 (rq->nr_sectors % floppy->bs_factor)) {
313 printk(KERN_ERR PFX "%s: unsupported r/w rq size\n",
315 ide_floppy_end_request(drive, 0, 0);
318 pc = &floppy->queued_pc;
319 idefloppy_create_rw_cmd(drive, pc, rq, block);
320 } else if (blk_special_request(rq)) {
321 pc = (struct ide_atapi_pc *) rq->buffer;
322 } else if (blk_pc_request(rq)) {
323 pc = &floppy->queued_pc;
324 idefloppy_blockpc_cmd(floppy, pc, rq);
326 blk_dump_rq_flags(rq, PFX "unsupported command in queue");
327 ide_floppy_end_request(drive, 0, 0);
331 ide_init_sg_cmd(drive, rq);
332 ide_map_sg(drive, rq);
334 pc->sg = hwif->sg_table;
335 pc->sg_cnt = hwif->sg_nents;
339 return idefloppy_issue_pc(drive, pc);
343 * Look at the flexible disk page parameters. We ignore the CHS capacity
344 * parameters and use the LBA parameters instead.
346 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive)
348 idefloppy_floppy_t *floppy = drive->driver_data;
349 struct gendisk *disk = floppy->disk;
350 struct ide_atapi_pc pc;
352 int capacity, lba_capacity;
353 u16 transfer_rate, sector_size, cyls, rpm;
356 ide_floppy_create_mode_sense_cmd(&pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE);
358 if (ide_queue_pc_tail(drive, disk, &pc)) {
359 printk(KERN_ERR PFX "Can't get flexible disk page params\n");
363 if (pc.buf[3] & 0x80)
364 drive->dev_flags |= IDE_DFLAG_WP;
366 drive->dev_flags &= ~IDE_DFLAG_WP;
368 set_disk_ro(disk, !!(drive->dev_flags & IDE_DFLAG_WP));
372 transfer_rate = be16_to_cpup((__be16 *)&pc.buf[8 + 2]);
373 sector_size = be16_to_cpup((__be16 *)&pc.buf[8 + 6]);
374 cyls = be16_to_cpup((__be16 *)&pc.buf[8 + 8]);
375 rpm = be16_to_cpup((__be16 *)&pc.buf[8 + 28]);
376 heads = pc.buf[8 + 4];
377 sectors = pc.buf[8 + 5];
379 capacity = cyls * heads * sectors * sector_size;
381 if (memcmp(page, &floppy->flexible_disk_page, 32))
382 printk(KERN_INFO PFX "%s: %dkB, %d/%d/%d CHS, %d kBps, "
383 "%d sector size, %d rpm\n",
384 drive->name, capacity / 1024, cyls, heads,
385 sectors, transfer_rate / 8, sector_size, rpm);
387 memcpy(&floppy->flexible_disk_page, page, 32);
388 drive->bios_cyl = cyls;
389 drive->bios_head = heads;
390 drive->bios_sect = sectors;
391 lba_capacity = floppy->blocks * floppy->block_size;
393 if (capacity < lba_capacity) {
394 printk(KERN_NOTICE PFX "%s: The disk reports a capacity of %d "
395 "bytes, but the drive only handles %d\n",
396 drive->name, lba_capacity, capacity);
397 floppy->blocks = floppy->block_size ?
398 capacity / floppy->block_size : 0;
399 drive->capacity64 = floppy->blocks * floppy->bs_factor;
406 * Determine if a media is present in the floppy drive, and if so, its LBA
409 int ide_floppy_get_capacity(ide_drive_t *drive)
411 idefloppy_floppy_t *floppy = drive->driver_data;
412 struct gendisk *disk = floppy->disk;
413 struct ide_atapi_pc pc;
415 u8 header_len, desc_cnt;
416 int i, rc = 1, blocks, length;
419 drive->bios_head = drive->bios_sect = 0;
421 floppy->bs_factor = 1;
422 drive->capacity64 = 0;
424 ide_floppy_create_read_capacity_cmd(&pc);
425 if (ide_queue_pc_tail(drive, disk, &pc)) {
426 printk(KERN_ERR PFX "Can't get floppy parameters\n");
429 header_len = pc.buf[3];
430 cap_desc = &pc.buf[4];
431 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
433 for (i = 0; i < desc_cnt; i++) {
434 unsigned int desc_start = 4 + i*8;
436 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
437 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
439 ide_debug_log(IDE_DBG_PROBE, "Descriptor %d: %dkB, %d blocks, "
441 i, blocks * length / 1024, blocks, length);
446 * the code below is valid only for the 1st descriptor, ie i=0
449 switch (pc.buf[desc_start + 4] & 0x03) {
450 /* Clik! drive returns this instead of CAPACITY_CURRENT */
451 case CAPACITY_UNFORMATTED:
452 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
454 * If it is not a clik drive, break out
455 * (maintains previous driver behaviour)
458 case CAPACITY_CURRENT:
459 /* Normal Zip/LS-120 disks */
460 if (memcmp(cap_desc, &floppy->cap_desc, 8))
461 printk(KERN_INFO PFX "%s: %dkB, %d blocks, %d "
463 drive->name, blocks * length / 1024,
465 memcpy(&floppy->cap_desc, cap_desc, 8);
467 if (!length || length % 512) {
468 printk(KERN_NOTICE PFX "%s: %d bytes block size"
469 " not supported\n", drive->name, length);
471 floppy->blocks = blocks;
472 floppy->block_size = length;
473 floppy->bs_factor = length / 512;
474 if (floppy->bs_factor != 1)
475 printk(KERN_NOTICE PFX "%s: Warning: "
476 "non 512 bytes block size not "
480 floppy->blocks * floppy->bs_factor;
484 case CAPACITY_NO_CARTRIDGE:
486 * This is a KERN_ERR so it appears on screen
487 * for the user to see
489 printk(KERN_ERR PFX "%s: No disk in drive\n",
492 case CAPACITY_INVALID:
493 printk(KERN_ERR PFX "%s: Invalid capacity for disk "
494 "in drive\n", drive->name);
497 ide_debug_log(IDE_DBG_PROBE, "Descriptor 0 Code: %d\n",
498 pc.buf[desc_start + 4] & 0x03);
501 /* Clik! disk does not support get_flexible_disk_page */
502 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
503 (void) ide_floppy_get_flexible_disk_page(drive);
508 void ide_floppy_setup(ide_drive_t *drive)
510 struct ide_floppy_obj *floppy = drive->driver_data;
513 drive->pc_callback = ide_floppy_callback;
514 drive->pc_update_buffers = idefloppy_update_buffers;
515 drive->pc_io_buffers = ide_io_buffers;
518 * We used to check revisions here. At this point however I'm giving up.
519 * Just assume they are all broken, its easier.
521 * The actual reason for the workarounds was likely a driver bug after
522 * all rather than a firmware bug, and the workaround below used to hide
523 * it. It should be fixed as of version 1.9, but to be on the safe side
524 * we'll leave the limitation below for the 2.2.x tree.
526 if (!strncmp((char *)&id[ATA_ID_PROD], "IOMEGA ZIP 100 ATAPI", 20)) {
527 drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE;
528 /* This value will be visible in the /proc/ide/hdx/settings */
529 drive->pc_delay = IDEFLOPPY_PC_DELAY;
530 blk_queue_max_sectors(drive->queue, 64);
534 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
535 * nasty clicking noises without it, so please don't remove this.
537 if (strncmp((char *)&id[ATA_ID_PROD], "IOMEGA Clik!", 11) == 0) {
538 blk_queue_max_sectors(drive->queue, 64);
539 drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE;
540 /* IOMEGA Clik! drives do not support lock/unlock commands */
541 drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING;
544 (void) ide_floppy_get_capacity(drive);
546 ide_proc_register_driver(drive, floppy->driver);
548 drive->dev_flags |= IDE_DFLAG_ATTACH;