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