drivers/ide/ide-floppy.c

   1 /*
   2  * IDE ATAPI floppy driver.
   3  *
   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
   7  *
   8  * This driver supports the following IDE floppy drives:
   9  *
  10  * LS-120/240 SuperDisk
  11  * Iomega Zip 100/250
  12  * Iomega PC Card Clik!/PocketZip
  13  *
  14  * For a historical changelog see
  15  * Documentation/ide/ChangeLog.ide-floppy.1996-2002
  16  */
  17
  18 #define DRV_NAME "ide-floppy"
  19 #define PFX DRV_NAME ": "
  20
  21 #define IDEFLOPPY_VERSION "1.00"
  22
  23 #include <linux/module.h>
  24 #include <linux/types.h>
  25 #include <linux/string.h>
  26 #include <linux/kernel.h>
  27 #include <linux/delay.h>
  28 #include <linux/timer.h>
  29 #include <linux/mm.h>
  30 #include <linux/interrupt.h>
  31 #include <linux/major.h>
  32 #include <linux/errno.h>
  33 #include <linux/genhd.h>
  34 #include <linux/slab.h>
  35 #include <linux/cdrom.h>
  36 #include <linux/ide.h>
  37 #include <linux/hdreg.h>
  38 #include <linux/bitops.h>
  39 #include <linux/mutex.h>
  40 #include <linux/scatterlist.h>
  41
  42 #include <scsi/scsi_ioctl.h>
  43
  44 #include <asm/byteorder.h>
  45 #include <linux/irq.h>
  46 #include <linux/uaccess.h>
  47 #include <linux/io.h>
  48 #include <asm/unaligned.h>
  49
  50 #include "ide-floppy.h"
  51
  52 /* module parameters */
  53 static unsigned long debug_mask;
  54 module_param(debug_mask, ulong, 0644);
  55
  56 /* define to see debug info */
  57 #define IDEFLOPPY_DEBUG_LOG     0
  58
  59 #if IDEFLOPPY_DEBUG_LOG
  60 #define ide_debug_log(lvl, fmt, args...) __ide_debug_log(lvl, fmt, args)
  61 #else
  62 #define ide_debug_log(lvl, fmt, args...) do {} while (0)
  63 #endif
  64
  65 /*
  66  * After each failed packet command we issue a request sense command and retry
  67  * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
  68  */
  69 #define IDEFLOPPY_MAX_PC_RETRIES        3
  70
  71 /* format capacities descriptor codes */
  72 #define CAPACITY_INVALID        0x00
  73 #define CAPACITY_UNFORMATTED    0x01
  74 #define CAPACITY_CURRENT        0x02
  75 #define CAPACITY_NO_CARTRIDGE   0x03
  76
  77 /*
  78  * The following delay solves a problem with ATAPI Zip 100 drive where BSY bit
  79  * was apparently being deasserted before the unit was ready to receive data.
  80  */
  81 #define IDEFLOPPY_PC_DELAY      (HZ/20) /* default delay for ZIP 100 (50ms) */
  82
  83 /* Error code returned in rq->errors to the higher part of the driver. */
  84 #define IDEFLOPPY_ERROR_GENERAL         101
  85
  86 static DEFINE_MUTEX(idefloppy_ref_mutex);
  87
  88 static void idefloppy_cleanup_obj(struct kref *);
  89
  90 static struct ide_floppy_obj *ide_floppy_get(struct gendisk *disk)
  91 {
  92         struct ide_floppy_obj *floppy = NULL;
  93
  94         mutex_lock(&idefloppy_ref_mutex);
  95         floppy = ide_drv_g(disk, ide_floppy_obj);
  96         if (floppy) {
  97                 if (ide_device_get(floppy->drive))
  98                         floppy = NULL;
  99                 else
 100                         kref_get(&floppy->kref);
 101         }
 102         mutex_unlock(&idefloppy_ref_mutex);
 103         return floppy;
 104 }
 105
 106 static void ide_floppy_put(struct ide_floppy_obj *floppy)
 107 {
 108         ide_drive_t *drive = floppy->drive;
 109
 110         mutex_lock(&idefloppy_ref_mutex);
 111         kref_put(&floppy->kref, idefloppy_cleanup_obj);
 112         ide_device_put(drive);
 113         mutex_unlock(&idefloppy_ref_mutex);
 114 }
 115
 116 /*
 117  * Used to finish servicing a request. For read/write requests, we will call
 118  * ide_end_request to pass to the next buffer.
 119  */
 120 static int idefloppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
 121 {
 122         idefloppy_floppy_t *floppy = drive->driver_data;
 123         struct request *rq = HWGROUP(drive)->rq;
 124         int error;
 125
 126         ide_debug_log(IDE_DBG_FUNC, "Call %s\n", __func__);
 127
 128         switch (uptodate) {
 129         case 0:
 130                 error = IDEFLOPPY_ERROR_GENERAL;
 131                 break;
 132
 133         case 1:
 134                 error = 0;
 135                 break;
 136
 137         default:
 138                 error = uptodate;
 139         }
 140
 141         if (error)
 142                 floppy->failed_pc = NULL;
 143         /* Why does this happen? */
 144         if (!rq)
 145                 return 0;
 146         if (!blk_special_request(rq)) {
 147                 /* our real local end request function */
 148                 ide_end_request(drive, uptodate, nsecs);
 149                 return 0;
 150         }
 151         rq->errors = error;
 152         /* fixme: need to move this local also */
 153         ide_end_drive_cmd(drive, 0, 0);
 154         return 0;
 155 }
 156
 157 static void idefloppy_update_buffers(ide_drive_t *drive,
 158                                 struct ide_atapi_pc *pc)
 159 {
 160         struct request *rq = pc->rq;
 161         struct bio *bio = rq->bio;
 162
 163         while ((bio = rq->bio) != NULL)
 164                 idefloppy_end_request(drive, 1, 0);
 165 }
 166
 167 static void ide_floppy_callback(ide_drive_t *drive, int dsc)
 168 {
 169         idefloppy_floppy_t *floppy = drive->driver_data;
 170         struct ide_atapi_pc *pc = drive->pc;
 171         int uptodate = pc->error ? 0 : 1;
 172
 173         ide_debug_log(IDE_DBG_FUNC, "Call %s\n", __func__);
 174
 175         if (floppy->failed_pc == pc)
 176                 floppy->failed_pc = NULL;
 177
 178         if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
 179             (pc->rq && blk_pc_request(pc->rq)))
 180                 uptodate = 1; /* FIXME */
 181         else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
 182                 u8 *buf = pc->buf;
 183
 184                 if (!pc->error) {
 185                         floppy->sense_key = buf[2] & 0x0F;
 186                         floppy->asc = buf[12];
 187                         floppy->ascq = buf[13];
 188                         floppy->progress_indication = buf[15] & 0x80 ?
 189                                 (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
 190
 191                         if (floppy->failed_pc)
 192                                 ide_debug_log(IDE_DBG_PC, "pc = %x, ",
 193                                               floppy->failed_pc->c[0]);
 194
 195                         ide_debug_log(IDE_DBG_SENSE, "sense key = %x, asc = %x,"
 196                                       "ascq = %x\n", floppy->sense_key,
 197                                       floppy->asc, floppy->ascq);
 198                 } else
 199                         printk(KERN_ERR PFX "Error in REQUEST SENSE itself - "
 200                                "Aborting request!\n");
 201         }
 202
 203         idefloppy_end_request(drive, uptodate, 0);
 204 }
 205
 206 static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
 207                                     struct ide_atapi_pc *pc)
 208 {
 209         /* supress error messages resulting from Medium not present */
 210         if (floppy->sense_key == 0x02 &&
 211             floppy->asc       == 0x3a &&
 212             floppy->ascq      == 0x00)
 213                 return;
 214
 215         printk(KERN_ERR PFX "%s: I/O error, pc = %2x, key = %2x, "
 216                         "asc = %2x, ascq = %2x\n",
 217                         floppy->drive->name, pc->c[0], floppy->sense_key,
 218                         floppy->asc, floppy->ascq);
 219
 220 }
 221
 222 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
 223                 struct ide_atapi_pc *pc)
 224 {
 225         idefloppy_floppy_t *floppy = drive->driver_data;
 226
 227         if (floppy->failed_pc == NULL &&
 228             pc->c[0] != GPCMD_REQUEST_SENSE)
 229                 floppy->failed_pc = pc;
 230
 231         /* Set the current packet command */
 232         drive->pc = pc;
 233
 234         if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
 235                 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
 236                         ide_floppy_report_error(floppy, pc);
 237                 /* Giving up */
 238                 pc->error = IDEFLOPPY_ERROR_GENERAL;
 239
 240                 floppy->failed_pc = NULL;
 241                 drive->pc_callback(drive, 0);
 242                 return ide_stopped;
 243         }
 244
 245         ide_debug_log(IDE_DBG_FUNC, "%s: Retry #%d\n", __func__, pc->retries);
 246
 247         pc->retries++;
 248
 249         return ide_issue_pc(drive, WAIT_FLOPPY_CMD, NULL);
 250 }
 251
 252 void ide_floppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
 253 {
 254         ide_init_pc(pc);
 255         pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
 256         pc->c[7] = 255;
 257         pc->c[8] = 255;
 258         pc->req_xfer = 255;
 259 }
 260
 261 /* A mode sense command is used to "sense" floppy parameters. */
 262 void ide_floppy_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
 263 {
 264         u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
 265
 266         ide_init_pc(pc);
 267         pc->c[0] = GPCMD_MODE_SENSE_10;
 268         pc->c[1] = 0;
 269         pc->c[2] = page_code;
 270
 271         switch (page_code) {
 272         case IDEFLOPPY_CAPABILITIES_PAGE:
 273                 length += 12;
 274                 break;
 275         case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
 276                 length += 32;
 277                 break;
 278         default:
 279                 printk(KERN_ERR PFX "unsupported page code in %s\n", __func__);
 280         }
 281         put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
 282         pc->req_xfer = length;
 283 }
 284
 285 static void idefloppy_create_rw_cmd(ide_drive_t *drive,
 286                                     struct ide_atapi_pc *pc, struct request *rq,
 287                                     unsigned long sector)
 288 {
 289         idefloppy_floppy_t *floppy = drive->driver_data;
 290         int block = sector / floppy->bs_factor;
 291         int blocks = rq->nr_sectors / floppy->bs_factor;
 292         int cmd = rq_data_dir(rq);
 293
 294         ide_debug_log(IDE_DBG_FUNC, "%s: block: %d, blocks: %d\n", __func__,
 295                       block, blocks);
 296
 297         ide_init_pc(pc);
 298         pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
 299         put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
 300         put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
 301
 302         memcpy(rq->cmd, pc->c, 12);
 303
 304         pc->rq = rq;
 305         pc->b_count = 0;
 306         if (rq->cmd_flags & REQ_RW)
 307                 pc->flags |= PC_FLAG_WRITING;
 308         pc->buf = NULL;
 309         pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
 310         pc->flags |= PC_FLAG_DMA_OK;
 311 }
 312
 313 static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
 314                 struct ide_atapi_pc *pc, struct request *rq)
 315 {
 316         ide_init_pc(pc);
 317         memcpy(pc->c, rq->cmd, sizeof(pc->c));
 318         pc->rq = rq;
 319         pc->b_count = 0;
 320         if (rq->data_len && rq_data_dir(rq) == WRITE)
 321                 pc->flags |= PC_FLAG_WRITING;
 322         pc->buf = rq->data;
 323         if (rq->bio)
 324                 pc->flags |= PC_FLAG_DMA_OK;
 325         /*
 326          * possibly problematic, doesn't look like ide-floppy correctly
 327          * handled scattered requests if dma fails...
 328          */
 329         pc->req_xfer = pc->buf_size = rq->data_len;
 330 }
 331
 332 static ide_startstop_t idefloppy_do_request(ide_drive_t *drive,
 333                 struct request *rq, sector_t block_s)
 334 {
 335         idefloppy_floppy_t *floppy = drive->driver_data;
 336         ide_hwif_t *hwif = drive->hwif;
 337         struct ide_atapi_pc *pc;
 338         unsigned long block = (unsigned long)block_s;
 339
 340         ide_debug_log(IDE_DBG_FUNC, "%s: dev: %s, cmd: 0x%x, cmd_type: %x, "
 341                       "errors: %d\n",
 342                       __func__, rq->rq_disk ? rq->rq_disk->disk_name : "?",
 343                       rq->cmd[0], rq->cmd_type, rq->errors);
 344
 345         ide_debug_log(IDE_DBG_FUNC, "%s: sector: %ld, nr_sectors: %ld, "
 346                       "current_nr_sectors: %d\n",
 347                       __func__, (long)rq->sector, rq->nr_sectors,
 348                       rq->current_nr_sectors);
 349
 350         if (rq->errors >= ERROR_MAX) {
 351                 if (floppy->failed_pc)
 352                         ide_floppy_report_error(floppy, floppy->failed_pc);
 353                 else
 354                         printk(KERN_ERR PFX "%s: I/O error\n", drive->name);
 355
 356                 idefloppy_end_request(drive, 0, 0);
 357                 return ide_stopped;
 358         }
 359         if (blk_fs_request(rq)) {
 360                 if (((long)rq->sector % floppy->bs_factor) ||
 361                     (rq->nr_sectors % floppy->bs_factor)) {
 362                         printk(KERN_ERR PFX "%s: unsupported r/w rq size\n",
 363                                 drive->name);
 364                         idefloppy_end_request(drive, 0, 0);
 365                         return ide_stopped;
 366                 }
 367                 pc = &floppy->queued_pc;
 368                 idefloppy_create_rw_cmd(drive, pc, rq, block);
 369         } else if (blk_special_request(rq)) {
 370                 pc = (struct ide_atapi_pc *) rq->buffer;
 371         } else if (blk_pc_request(rq)) {
 372                 pc = &floppy->queued_pc;
 373                 idefloppy_blockpc_cmd(floppy, pc, rq);
 374         } else {
 375                 blk_dump_rq_flags(rq, PFX "unsupported command in queue");
 376                 idefloppy_end_request(drive, 0, 0);
 377                 return ide_stopped;
 378         }
 379
 380         ide_init_sg_cmd(drive, rq);
 381         ide_map_sg(drive, rq);
 382
 383         pc->sg = hwif->sg_table;
 384         pc->sg_cnt = hwif->sg_nents;
 385
 386         pc->rq = rq;
 387
 388         return idefloppy_issue_pc(drive, pc);
 389 }
 390
 391 /*
 392  * Look at the flexible disk page parameters. We ignore the CHS capacity
 393  * parameters and use the LBA parameters instead.
 394  */
 395 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive)
 396 {
 397         idefloppy_floppy_t *floppy = drive->driver_data;
 398         struct gendisk *disk = floppy->disk;
 399         struct ide_atapi_pc pc;
 400         u8 *page;
 401         int capacity, lba_capacity;
 402         u16 transfer_rate, sector_size, cyls, rpm;
 403         u8 heads, sectors;
 404
 405         ide_floppy_create_mode_sense_cmd(&pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE);
 406
 407         if (ide_queue_pc_tail(drive, disk, &pc)) {
 408                 printk(KERN_ERR PFX "Can't get flexible disk page params\n");
 409                 return 1;
 410         }
 411
 412         if (pc.buf[3] & 0x80)
 413                 drive->atapi_flags |= IDE_AFLAG_WP;
 414         else
 415                 drive->atapi_flags &= ~IDE_AFLAG_WP;
 416
 417         set_disk_ro(disk, !!(drive->atapi_flags & IDE_AFLAG_WP));
 418
 419         page = &pc.buf[8];
 420
 421         transfer_rate = be16_to_cpup((__be16 *)&pc.buf[8 + 2]);
 422         sector_size   = be16_to_cpup((__be16 *)&pc.buf[8 + 6]);
 423         cyls          = be16_to_cpup((__be16 *)&pc.buf[8 + 8]);
 424         rpm           = be16_to_cpup((__be16 *)&pc.buf[8 + 28]);
 425         heads         = pc.buf[8 + 4];
 426         sectors       = pc.buf[8 + 5];
 427
 428         capacity = cyls * heads * sectors * sector_size;
 429
 430         if (memcmp(page, &floppy->flexible_disk_page, 32))
 431                 printk(KERN_INFO PFX "%s: %dkB, %d/%d/%d CHS, %d kBps, "
 432                                 "%d sector size, %d rpm\n",
 433                                 drive->name, capacity / 1024, cyls, heads,
 434                                 sectors, transfer_rate / 8, sector_size, rpm);
 435
 436         memcpy(&floppy->flexible_disk_page, page, 32);
 437         drive->bios_cyl = cyls;
 438         drive->bios_head = heads;
 439         drive->bios_sect = sectors;
 440         lba_capacity = floppy->blocks * floppy->block_size;
 441
 442         if (capacity < lba_capacity) {
 443                 printk(KERN_NOTICE PFX "%s: The disk reports a capacity of %d "
 444                         "bytes, but the drive only handles %d\n",
 445                         drive->name, lba_capacity, capacity);
 446                 floppy->blocks = floppy->block_size ?
 447                         capacity / floppy->block_size : 0;
 448         }
 449         return 0;
 450 }
 451
 452 /*
 453  * Determine if a media is present in the floppy drive, and if so, its LBA
 454  * capacity.
 455  */
 456 static int ide_floppy_get_capacity(ide_drive_t *drive)
 457 {
 458         idefloppy_floppy_t *floppy = drive->driver_data;
 459         struct gendisk *disk = floppy->disk;
 460         struct ide_atapi_pc pc;
 461         u8 *cap_desc;
 462         u8 header_len, desc_cnt;
 463         int i, rc = 1, blocks, length;
 464
 465         drive->bios_cyl = 0;
 466         drive->bios_head = drive->bios_sect = 0;
 467         floppy->blocks = 0;
 468         floppy->bs_factor = 1;
 469         set_capacity(floppy->disk, 0);
 470
 471         ide_floppy_create_read_capacity_cmd(&pc);
 472         if (ide_queue_pc_tail(drive, disk, &pc)) {
 473                 printk(KERN_ERR PFX "Can't get floppy parameters\n");
 474                 return 1;
 475         }
 476         header_len = pc.buf[3];
 477         cap_desc = &pc.buf[4];
 478         desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
 479
 480         for (i = 0; i < desc_cnt; i++) {
 481                 unsigned int desc_start = 4 + i*8;
 482
 483                 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
 484                 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
 485
 486                 ide_debug_log(IDE_DBG_PROBE, "Descriptor %d: %dkB, %d blocks, "
 487                               "%d sector size\n",
 488                               i, blocks * length / 1024, blocks, length);
 489
 490                 if (i)
 491                         continue;
 492                 /*
 493                  * the code below is valid only for the 1st descriptor, ie i=0
 494                  */
 495
 496                 switch (pc.buf[desc_start + 4] & 0x03) {
 497                 /* Clik! drive returns this instead of CAPACITY_CURRENT */
 498                 case CAPACITY_UNFORMATTED:
 499                         if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
 500                                 /*
 501                                  * If it is not a clik drive, break out
 502                                  * (maintains previous driver behaviour)
 503                                  */
 504                                 break;
 505                 case CAPACITY_CURRENT:
 506                         /* Normal Zip/LS-120 disks */
 507                         if (memcmp(cap_desc, &floppy->cap_desc, 8))
 508                                 printk(KERN_INFO PFX "%s: %dkB, %d blocks, %d "
 509                                        "sector size\n",
 510                                        drive->name, blocks * length / 1024,
 511                                        blocks, length);
 512                         memcpy(&floppy->cap_desc, cap_desc, 8);
 513
 514                         if (!length || length % 512) {
 515                                 printk(KERN_NOTICE PFX "%s: %d bytes block size"
 516                                        " not supported\n", drive->name, length);
 517                         } else {
 518                                 floppy->blocks = blocks;
 519                                 floppy->block_size = length;
 520                                 floppy->bs_factor = length / 512;
 521                                 if (floppy->bs_factor != 1)
 522                                         printk(KERN_NOTICE PFX "%s: Warning: "
 523                                                "non 512 bytes block size not "
 524                                                "fully supported\n",
 525                                                drive->name);
 526                                 rc = 0;
 527                         }
 528                         break;
 529                 case CAPACITY_NO_CARTRIDGE:
 530                         /*
 531                          * This is a KERN_ERR so it appears on screen
 532                          * for the user to see
 533                          */
 534                         printk(KERN_ERR PFX "%s: No disk in drive\n",
 535                                drive->name);
 536                         break;
 537                 case CAPACITY_INVALID:
 538                         printk(KERN_ERR PFX "%s: Invalid capacity for disk "
 539                                 "in drive\n", drive->name);
 540                         break;
 541                 }
 542                 ide_debug_log(IDE_DBG_PROBE, "Descriptor 0 Code: %d\n",
 543                               pc.buf[desc_start + 4] & 0x03);
 544         }
 545
 546         /* Clik! disk does not support get_flexible_disk_page */
 547         if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
 548                 (void) ide_floppy_get_flexible_disk_page(drive);
 549
 550         set_capacity(disk, floppy->blocks * floppy->bs_factor);
 551
 552         return rc;
 553 }
 554
 555 static sector_t idefloppy_capacity(ide_drive_t *drive)
 556 {
 557         idefloppy_floppy_t *floppy = drive->driver_data;
 558         unsigned long capacity = floppy->blocks * floppy->bs_factor;
 559
 560         return capacity;
 561 }
 562
 563 #ifdef CONFIG_IDE_PROC_FS
 564 ide_devset_rw_field(bios_cyl, bios_cyl);
 565 ide_devset_rw_field(bios_head, bios_head);
 566 ide_devset_rw_field(bios_sect, bios_sect);
 567 ide_devset_rw_field(ticks, pc_delay);
 568
 569 static const struct ide_proc_devset idefloppy_settings[] = {
 570         IDE_PROC_DEVSET(bios_cyl,  0, 1023),
 571         IDE_PROC_DEVSET(bios_head, 0,  255),
 572         IDE_PROC_DEVSET(bios_sect, 0,   63),
 573         IDE_PROC_DEVSET(ticks,     0,  255),
 574         { 0 },
 575 };
 576 #endif
 577
 578 static void idefloppy_setup(ide_drive_t *drive, idefloppy_floppy_t *floppy)
 579 {
 580         u16 *id = drive->id;
 581
 582         drive->pc_callback       = ide_floppy_callback;
 583         drive->pc_update_buffers = idefloppy_update_buffers;
 584         drive->pc_io_buffers     = ide_io_buffers;
 585
 586         /*
 587          * We used to check revisions here. At this point however I'm giving up.
 588          * Just assume they are all broken, its easier.
 589          *
 590          * The actual reason for the workarounds was likely a driver bug after
 591          * all rather than a firmware bug, and the workaround below used to hide
 592          * it. It should be fixed as of version 1.9, but to be on the safe side
 593          * we'll leave the limitation below for the 2.2.x tree.
 594          */
 595         if (!strncmp((char *)&id[ATA_ID_PROD], "IOMEGA ZIP 100 ATAPI", 20)) {
 596                 drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE;
 597                 /* This value will be visible in the /proc/ide/hdx/settings */
 598                 drive->pc_delay = IDEFLOPPY_PC_DELAY;
 599                 blk_queue_max_sectors(drive->queue, 64);
 600         }
 601
 602         /*
 603          * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
 604          * nasty clicking noises without it, so please don't remove this.
 605          */
 606         if (strncmp((char *)&id[ATA_ID_PROD], "IOMEGA Clik!", 11) == 0) {
 607                 blk_queue_max_sectors(drive->queue, 64);
 608                 drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE;
 609                 /* IOMEGA Clik! drives do not support lock/unlock commands */
 610                 drive->atapi_flags |= IDE_AFLAG_NO_DOORLOCK;
 611         }
 612
 613         (void) ide_floppy_get_capacity(drive);
 614
 615         ide_proc_register_driver(drive, floppy->driver);
 616 }
 617
 618 static void ide_floppy_remove(ide_drive_t *drive)
 619 {
 620         idefloppy_floppy_t *floppy = drive->driver_data;
 621         struct gendisk *g = floppy->disk;
 622
 623         ide_proc_unregister_driver(drive, floppy->driver);
 624
 625         del_gendisk(g);
 626
 627         ide_floppy_put(floppy);
 628 }
 629
 630 static void idefloppy_cleanup_obj(struct kref *kref)
 631 {
 632         struct ide_floppy_obj *floppy = to_ide_drv(kref, ide_floppy_obj);
 633         ide_drive_t *drive = floppy->drive;
 634         struct gendisk *g = floppy->disk;
 635
 636         drive->driver_data = NULL;
 637         g->private_data = NULL;
 638         put_disk(g);
 639         kfree(floppy);
 640 }
 641
 642 #ifdef CONFIG_IDE_PROC_FS
 643 static int proc_idefloppy_read_capacity(char *page, char **start, off_t off,
 644                 int count, int *eof, void *data)
 645 {
 646         ide_drive_t*drive = (ide_drive_t *)data;
 647         int len;
 648
 649         len = sprintf(page, "%llu\n", (long long)idefloppy_capacity(drive));
 650         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
 651 }
 652
 653 static ide_proc_entry_t idefloppy_proc[] = {
 654         { "capacity",   S_IFREG|S_IRUGO, proc_idefloppy_read_capacity,  NULL },
 655         { "geometry",   S_IFREG|S_IRUGO, proc_ide_read_geometry,        NULL },
 656         { NULL, 0, NULL, NULL }
 657 };
 658 #endif  /* CONFIG_IDE_PROC_FS */
 659
 660 static int ide_floppy_probe(ide_drive_t *);
 661
 662 static ide_driver_t idefloppy_driver = {
 663         .gen_driver = {
 664                 .owner          = THIS_MODULE,
 665                 .name           = "ide-floppy",
 666                 .bus            = &ide_bus_type,
 667         },
 668         .probe                  = ide_floppy_probe,
 669         .remove                 = ide_floppy_remove,
 670         .version                = IDEFLOPPY_VERSION,
 671         .do_request             = idefloppy_do_request,
 672         .end_request            = idefloppy_end_request,
 673         .error                  = __ide_error,
 674 #ifdef CONFIG_IDE_PROC_FS
 675         .proc                   = idefloppy_proc,
 676         .settings               = idefloppy_settings,
 677 #endif
 678 };
 679
 680 static int idefloppy_open(struct inode *inode, struct file *filp)
 681 {
 682         struct gendisk *disk = inode->i_bdev->bd_disk;
 683         struct ide_floppy_obj *floppy;
 684         ide_drive_t *drive;
 685         int ret = 0;
 686
 687         floppy = ide_floppy_get(disk);
 688         if (!floppy)
 689                 return -ENXIO;
 690
 691         drive = floppy->drive;
 692
 693         ide_debug_log(IDE_DBG_FUNC, "Call %s\n", __func__);
 694
 695         floppy->openers++;
 696
 697         if (floppy->openers == 1) {
 698                 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
 699                 /* Just in case */
 700
 701                 if (ide_do_test_unit_ready(drive, disk))
 702                         ide_do_start_stop(drive, disk, 1);
 703
 704                 if (ide_floppy_get_capacity(drive)
 705                    && (filp->f_flags & O_NDELAY) == 0
 706                     /*
 707                      * Allow O_NDELAY to open a drive without a disk, or with an
 708                      * unreadable disk, so that we can get the format capacity
 709                      * of the drive or begin the format - Sam
 710                      */
 711                     ) {
 712                         ret = -EIO;
 713                         goto out_put_floppy;
 714                 }
 715
 716                 if ((drive->atapi_flags & IDE_AFLAG_WP) && (filp->f_mode & 2)) {
 717                         ret = -EROFS;
 718                         goto out_put_floppy;
 719                 }
 720
 721                 drive->atapi_flags |= IDE_AFLAG_MEDIA_CHANGED;
 722                 ide_set_media_lock(drive, disk, 1);
 723                 check_disk_change(inode->i_bdev);
 724         } else if (drive->atapi_flags & IDE_AFLAG_FORMAT_IN_PROGRESS) {
 725                 ret = -EBUSY;
 726                 goto out_put_floppy;
 727         }
 728         return 0;
 729
 730 out_put_floppy:
 731         floppy->openers--;
 732         ide_floppy_put(floppy);
 733         return ret;
 734 }
 735
 736 static int idefloppy_release(struct inode *inode, struct file *filp)
 737 {
 738         struct gendisk *disk = inode->i_bdev->bd_disk;
 739         struct ide_floppy_obj *floppy = ide_drv_g(disk, ide_floppy_obj);
 740         ide_drive_t *drive = floppy->drive;
 741
 742         ide_debug_log(IDE_DBG_FUNC, "Call %s\n", __func__);
 743
 744         if (floppy->openers == 1) {
 745                 ide_set_media_lock(drive, disk, 0);
 746                 drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
 747         }
 748
 749         floppy->openers--;
 750
 751         ide_floppy_put(floppy);
 752
 753         return 0;
 754 }
 755
 756 static int idefloppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
 757 {
 758         struct ide_floppy_obj *floppy = ide_drv_g(bdev->bd_disk,
 759                                                      ide_floppy_obj);
 760         ide_drive_t *drive = floppy->drive;
 761
 762         geo->heads = drive->bios_head;
 763         geo->sectors = drive->bios_sect;
 764         geo->cylinders = (u16)drive->bios_cyl; /* truncate */
 765         return 0;
 766 }
 767
 768 static int ide_floppy_lockdoor(ide_drive_t *drive, struct ide_atapi_pc *pc,
 769                                unsigned long arg, unsigned int cmd)
 770 {
 771         idefloppy_floppy_t *floppy = drive->driver_data;
 772         struct gendisk *disk = floppy->disk;
 773         int prevent = (arg && cmd != CDROMEJECT) ? 1 : 0;
 774
 775         if (floppy->openers > 1)
 776                 return -EBUSY;
 777
 778         ide_set_media_lock(drive, disk, prevent);
 779
 780         if (cmd == CDROMEJECT)
 781                 ide_do_start_stop(drive, disk, 2);
 782
 783         return 0;
 784 }
 785
 786 static int idefloppy_ioctl(struct inode *inode, struct file *file,
 787                         unsigned int cmd, unsigned long arg)
 788 {
 789         struct block_device *bdev = inode->i_bdev;
 790         struct ide_floppy_obj *floppy = ide_drv_g(bdev->bd_disk,
 791                                                      ide_floppy_obj);
 792         ide_drive_t *drive = floppy->drive;
 793         struct ide_atapi_pc pc;
 794         void __user *argp = (void __user *)arg;
 795         int err;
 796
 797         if (cmd == CDROMEJECT || cmd == CDROM_LOCKDOOR)
 798                 return ide_floppy_lockdoor(drive, &pc, arg, cmd);
 799
 800         err = ide_floppy_format_ioctl(drive, file, cmd, argp);
 801         if (err != -ENOTTY)
 802                 return err;
 803
 804         /*
 805          * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
 806          * and CDROM_SEND_PACKET (legacy) ioctls
 807          */
 808         if (cmd != CDROM_SEND_PACKET && cmd != SCSI_IOCTL_SEND_COMMAND)
 809                 err = scsi_cmd_ioctl(file, bdev->bd_disk->queue,
 810                                         bdev->bd_disk, cmd, argp);
 811
 812         if (err == -ENOTTY)
 813                 err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
 814
 815         return err;
 816 }
 817
 818 static int idefloppy_media_changed(struct gendisk *disk)
 819 {
 820         struct ide_floppy_obj *floppy = ide_drv_g(disk, ide_floppy_obj);
 821         ide_drive_t *drive = floppy->drive;
 822         int ret;
 823
 824         /* do not scan partitions twice if this is a removable device */
 825         if (drive->dev_flags & IDE_DFLAG_ATTACH) {
 826                 drive->dev_flags &= ~IDE_DFLAG_ATTACH;
 827                 return 0;
 828         }
 829         ret = !!(drive->atapi_flags & IDE_AFLAG_MEDIA_CHANGED);
 830         drive->atapi_flags &= ~IDE_AFLAG_MEDIA_CHANGED;
 831         return ret;
 832 }
 833
 834 static int idefloppy_revalidate_disk(struct gendisk *disk)
 835 {
 836         struct ide_floppy_obj *floppy = ide_drv_g(disk, ide_floppy_obj);
 837         set_capacity(disk, idefloppy_capacity(floppy->drive));
 838         return 0;
 839 }
 840
 841 static struct block_device_operations idefloppy_ops = {
 842         .owner                  = THIS_MODULE,
 843         .open                   = idefloppy_open,
 844         .release                = idefloppy_release,
 845         .ioctl                  = idefloppy_ioctl,
 846         .getgeo                 = idefloppy_getgeo,
 847         .media_changed          = idefloppy_media_changed,
 848         .revalidate_disk        = idefloppy_revalidate_disk
 849 };
 850
 851 static int ide_floppy_probe(ide_drive_t *drive)
 852 {
 853         idefloppy_floppy_t *floppy;
 854         struct gendisk *g;
 855
 856         if (!strstr("ide-floppy", drive->driver_req))
 857                 goto failed;
 858
 859         if (drive->media != ide_floppy)
 860                 goto failed;
 861
 862         if (!ide_check_atapi_device(drive, DRV_NAME)) {
 863                 printk(KERN_ERR PFX "%s: not supported by this version of "
 864                        DRV_NAME "\n", drive->name);
 865                 goto failed;
 866         }
 867         floppy = kzalloc(sizeof(idefloppy_floppy_t), GFP_KERNEL);
 868         if (!floppy) {
 869                 printk(KERN_ERR PFX "%s: Can't allocate a floppy structure\n",
 870                        drive->name);
 871                 goto failed;
 872         }
 873
 874         g = alloc_disk(1 << PARTN_BITS);
 875         if (!g)
 876                 goto out_free_floppy;
 877
 878         ide_init_disk(g, drive);
 879
 880         kref_init(&floppy->kref);
 881
 882         floppy->drive = drive;
 883         floppy->driver = &idefloppy_driver;
 884         floppy->disk = g;
 885
 886         g->private_data = &floppy->driver;
 887
 888         drive->driver_data = floppy;
 889
 890         drive->debug_mask = debug_mask;
 891
 892         idefloppy_setup(drive, floppy);
 893         drive->dev_flags |= IDE_DFLAG_ATTACH;
 894
 895         g->minors = 1 << PARTN_BITS;
 896         g->driverfs_dev = &drive->gendev;
 897         if (drive->dev_flags & IDE_DFLAG_REMOVABLE)
 898                 g->flags = GENHD_FL_REMOVABLE;
 899         g->fops = &idefloppy_ops;
 900         add_disk(g);
 901         return 0;
 902
 903 out_free_floppy:
 904         kfree(floppy);
 905 failed:
 906         return -ENODEV;
 907 }
 908
 909 static void __exit idefloppy_exit(void)
 910 {
 911         driver_unregister(&idefloppy_driver.gen_driver);
 912 }
 913
 914 static int __init idefloppy_init(void)
 915 {
 916         printk(KERN_INFO DRV_NAME " driver " IDEFLOPPY_VERSION "\n");
 917         return driver_register(&idefloppy_driver.gen_driver);
 918 }
 919
 920 MODULE_ALIAS("ide:*m-floppy*");
 921 MODULE_ALIAS("ide-floppy");
 922 module_init(idefloppy_init);
 923 module_exit(idefloppy_exit);
 924 MODULE_LICENSE("GPL");
 925 MODULE_DESCRIPTION("ATAPI FLOPPY Driver");
 926