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 IDEFLOPPY_VERSION "1.00"
  19
  20 #include <linux/module.h>
  21 #include <linux/types.h>
  22 #include <linux/string.h>
  23 #include <linux/kernel.h>
  24 #include <linux/delay.h>
  25 #include <linux/timer.h>
  26 #include <linux/mm.h>
  27 #include <linux/interrupt.h>
  28 #include <linux/major.h>
  29 #include <linux/errno.h>
  30 #include <linux/genhd.h>
  31 #include <linux/slab.h>
  32 #include <linux/cdrom.h>
  33 #include <linux/ide.h>
  34 #include <linux/bitops.h>
  35 #include <linux/mutex.h>
  36
  37 #include <scsi/scsi_ioctl.h>
  38
  39 #include <asm/byteorder.h>
  40 #include <linux/irq.h>
  41 #include <linux/uaccess.h>
  42 #include <linux/io.h>
  43 #include <asm/unaligned.h>
  44
  45 /* define to see debug info */
  46 #define IDEFLOPPY_DEBUG_LOG             0
  47
  48 /* #define IDEFLOPPY_DEBUG(fmt, args...) printk(KERN_INFO fmt, ## args) */
  49 #define IDEFLOPPY_DEBUG(fmt, args...)
  50
  51 #if IDEFLOPPY_DEBUG_LOG
  52 #define debug_log(fmt, args...) \
  53         printk(KERN_INFO "ide-floppy: " fmt, ## args)
  54 #else
  55 #define debug_log(fmt, args...) do {} while (0)
  56 #endif
  57
  58
  59 /* Some drives require a longer irq timeout. */
  60 #define IDEFLOPPY_WAIT_CMD              (5 * WAIT_CMD)
  61
  62 /*
  63  * After each failed packet command we issue a request sense command and retry
  64  * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
  65  */
  66 #define IDEFLOPPY_MAX_PC_RETRIES        3
  67
  68 /*
  69  * With each packet command, we allocate a buffer of IDEFLOPPY_PC_BUFFER_SIZE
  70  * bytes.
  71  */
  72 #define IDEFLOPPY_PC_BUFFER_SIZE        256
  73
  74 /*
  75  * In various places in the driver, we need to allocate storage for packet
  76  * commands and requests, which will remain valid while we leave the driver to
  77  * wait for an interrupt or a timeout event.
  78  */
  79 #define IDEFLOPPY_PC_STACK              (10 + IDEFLOPPY_MAX_PC_RETRIES)
  80
  81 /* format capacities descriptor codes */
  82 #define CAPACITY_INVALID        0x00
  83 #define CAPACITY_UNFORMATTED    0x01
  84 #define CAPACITY_CURRENT        0x02
  85 #define CAPACITY_NO_CARTRIDGE   0x03
  86
  87 /*
  88  * Most of our global data which we need to save even as we leave the driver
  89  * due to an interrupt or a timer event is stored in a variable of type
  90  * idefloppy_floppy_t, defined below.
  91  */
  92 typedef struct ide_floppy_obj {
  93         ide_drive_t     *drive;
  94         ide_driver_t    *driver;
  95         struct gendisk  *disk;
  96         struct kref     kref;
  97         unsigned int    openers;        /* protected by BKL for now */
  98
  99         /* Current packet command */
 100         struct ide_atapi_pc *pc;
 101         /* Last failed packet command */
 102         struct ide_atapi_pc *failed_pc;
 103         /* Packet command stack */
 104         struct ide_atapi_pc pc_stack[IDEFLOPPY_PC_STACK];
 105         /* Next free packet command storage space */
 106         int pc_stack_index;
 107         struct request rq_stack[IDEFLOPPY_PC_STACK];
 108         /* We implement a circular array */
 109         int rq_stack_index;
 110
 111         /* Last error information */
 112         u8 sense_key, asc, ascq;
 113         /* delay this long before sending packet command */
 114         u8 ticks;
 115         int progress_indication;
 116
 117         /* Device information */
 118         /* Current format */
 119         int blocks, block_size, bs_factor;
 120         /* Last format capacity descriptor */
 121         u8 cap_desc[8];
 122         /* Copy of the flexible disk page */
 123         u8 flexible_disk_page[32];
 124         /* Write protect */
 125         int wp;
 126         /* Supports format progress report */
 127         int srfp;
 128         /* Status/Action flags */
 129         unsigned long flags;
 130 } idefloppy_floppy_t;
 131
 132 #define IDEFLOPPY_TICKS_DELAY   HZ/20   /* default delay for ZIP 100 (50ms) */
 133
 134 /* Floppy flag bits values. */
 135 enum {
 136         /* DRQ interrupt device */
 137         IDEFLOPPY_FLAG_DRQ_INTERRUPT            = (1 << 0),
 138         /* Media may have changed */
 139         IDEFLOPPY_FLAG_MEDIA_CHANGED            = (1 << 1),
 140         /* Format in progress */
 141         IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS       = (1 << 2),
 142         /* Avoid commands not supported in Clik drive */
 143         IDEFLOPPY_FLAG_CLIK_DRIVE               = (1 << 3),
 144         /* Requires BH algorithm for packets */
 145         IDEFLOPPY_FLAG_ZIP_DRIVE                = (1 << 4),
 146 };
 147
 148 /* Defines for the MODE SENSE command */
 149 #define MODE_SENSE_CURRENT              0x00
 150 #define MODE_SENSE_CHANGEABLE           0x01
 151 #define MODE_SENSE_DEFAULT              0x02
 152 #define MODE_SENSE_SAVED                0x03
 153
 154 /* IOCTLs used in low-level formatting. */
 155 #define IDEFLOPPY_IOCTL_FORMAT_SUPPORTED        0x4600
 156 #define IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY     0x4601
 157 #define IDEFLOPPY_IOCTL_FORMAT_START            0x4602
 158 #define IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS     0x4603
 159
 160 /* Error code returned in rq->errors to the higher part of the driver. */
 161 #define IDEFLOPPY_ERROR_GENERAL         101
 162
 163 /*
 164  * Pages of the SELECT SENSE / MODE SENSE packet commands.
 165  * See SFF-8070i spec.
 166  */
 167 #define IDEFLOPPY_CAPABILITIES_PAGE     0x1b
 168 #define IDEFLOPPY_FLEXIBLE_DISK_PAGE    0x05
 169
 170 static DEFINE_MUTEX(idefloppy_ref_mutex);
 171
 172 #define to_ide_floppy(obj) container_of(obj, struct ide_floppy_obj, kref)
 173
 174 #define ide_floppy_g(disk) \
 175         container_of((disk)->private_data, struct ide_floppy_obj, driver)
 176
 177 static struct ide_floppy_obj *ide_floppy_get(struct gendisk *disk)
 178 {
 179         struct ide_floppy_obj *floppy = NULL;
 180
 181         mutex_lock(&idefloppy_ref_mutex);
 182         floppy = ide_floppy_g(disk);
 183         if (floppy)
 184                 kref_get(&floppy->kref);
 185         mutex_unlock(&idefloppy_ref_mutex);
 186         return floppy;
 187 }
 188
 189 static void idefloppy_cleanup_obj(struct kref *);
 190
 191 static void ide_floppy_put(struct ide_floppy_obj *floppy)
 192 {
 193         mutex_lock(&idefloppy_ref_mutex);
 194         kref_put(&floppy->kref, idefloppy_cleanup_obj);
 195         mutex_unlock(&idefloppy_ref_mutex);
 196 }
 197
 198 /*
 199  * Used to finish servicing a request. For read/write requests, we will call
 200  * ide_end_request to pass to the next buffer.
 201  */
 202 static int idefloppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
 203 {
 204         idefloppy_floppy_t *floppy = drive->driver_data;
 205         struct request *rq = HWGROUP(drive)->rq;
 206         int error;
 207
 208         debug_log("Reached %s\n", __func__);
 209
 210         switch (uptodate) {
 211         case 0: error = IDEFLOPPY_ERROR_GENERAL; break;
 212         case 1: error = 0; break;
 213         default: error = uptodate;
 214         }
 215         if (error)
 216                 floppy->failed_pc = NULL;
 217         /* Why does this happen? */
 218         if (!rq)
 219                 return 0;
 220         if (!blk_special_request(rq)) {
 221                 /* our real local end request function */
 222                 ide_end_request(drive, uptodate, nsecs);
 223                 return 0;
 224         }
 225         rq->errors = error;
 226         /* fixme: need to move this local also */
 227         ide_end_drive_cmd(drive, 0, 0);
 228         return 0;
 229 }
 230
 231 static void ide_floppy_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
 232                                   unsigned int bcount, int direction)
 233 {
 234         ide_hwif_t *hwif = drive->hwif;
 235         struct request *rq = pc->rq;
 236         struct req_iterator iter;
 237         struct bio_vec *bvec;
 238         unsigned long flags;
 239         int count, done = 0;
 240         char *data;
 241
 242         rq_for_each_segment(bvec, rq, iter) {
 243                 if (!bcount)
 244                         break;
 245
 246                 count = min(bvec->bv_len, bcount);
 247
 248                 data = bvec_kmap_irq(bvec, &flags);
 249                 if (direction)
 250                         hwif->output_data(drive, NULL, data, count);
 251                 else
 252                         hwif->input_data(drive, NULL, data, count);
 253                 bvec_kunmap_irq(data, &flags);
 254
 255                 bcount -= count;
 256                 pc->b_count += count;
 257                 done += count;
 258         }
 259
 260         idefloppy_end_request(drive, 1, done >> 9);
 261
 262         if (bcount) {
 263                 printk(KERN_ERR "%s: leftover data in %s, bcount == %d\n",
 264                                 drive->name, __func__, bcount);
 265                 ide_pad_transfer(drive, direction, bcount);
 266         }
 267 }
 268
 269 static void idefloppy_update_buffers(ide_drive_t *drive,
 270                                 struct ide_atapi_pc *pc)
 271 {
 272         struct request *rq = pc->rq;
 273         struct bio *bio = rq->bio;
 274
 275         while ((bio = rq->bio) != NULL)
 276                 idefloppy_end_request(drive, 1, 0);
 277 }
 278
 279 /*
 280  * Generate a new packet command request in front of the request queue, before
 281  * the current request so that it will be processed immediately, on the next
 282  * pass through the driver.
 283  */
 284 static void idefloppy_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
 285                 struct request *rq)
 286 {
 287         struct ide_floppy_obj *floppy = drive->driver_data;
 288
 289         blk_rq_init(NULL, rq);
 290         rq->buffer = (char *) pc;
 291         rq->cmd_type = REQ_TYPE_SPECIAL;
 292         rq->cmd_flags |= REQ_PREEMPT;
 293         rq->rq_disk = floppy->disk;
 294         ide_do_drive_cmd(drive, rq);
 295 }
 296
 297 static struct ide_atapi_pc *idefloppy_next_pc_storage(ide_drive_t *drive)
 298 {
 299         idefloppy_floppy_t *floppy = drive->driver_data;
 300
 301         if (floppy->pc_stack_index == IDEFLOPPY_PC_STACK)
 302                 floppy->pc_stack_index = 0;
 303         return (&floppy->pc_stack[floppy->pc_stack_index++]);
 304 }
 305
 306 static struct request *idefloppy_next_rq_storage(ide_drive_t *drive)
 307 {
 308         idefloppy_floppy_t *floppy = drive->driver_data;
 309
 310         if (floppy->rq_stack_index == IDEFLOPPY_PC_STACK)
 311                 floppy->rq_stack_index = 0;
 312         return (&floppy->rq_stack[floppy->rq_stack_index++]);
 313 }
 314
 315 static void ide_floppy_callback(ide_drive_t *drive)
 316 {
 317         idefloppy_floppy_t *floppy = drive->driver_data;
 318         struct ide_atapi_pc *pc = floppy->pc;
 319         int uptodate = pc->error ? 0 : 1;
 320
 321         debug_log("Reached %s\n", __func__);
 322
 323         if (floppy->failed_pc == pc)
 324                 floppy->failed_pc = NULL;
 325
 326         if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
 327             (pc->rq && blk_pc_request(pc->rq)))
 328                 uptodate = 1; /* FIXME */
 329         else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
 330                 u8 *buf = floppy->pc->buf;
 331
 332                 if (!pc->error) {
 333                         floppy->sense_key = buf[2] & 0x0F;
 334                         floppy->asc = buf[12];
 335                         floppy->ascq = buf[13];
 336                         floppy->progress_indication = buf[15] & 0x80 ?
 337                                 (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
 338
 339                         if (floppy->failed_pc)
 340                                 debug_log("pc = %x, ", floppy->failed_pc->c[0]);
 341
 342                         debug_log("sense key = %x, asc = %x, ascq = %x\n",
 343                                   floppy->sense_key, floppy->asc, floppy->ascq);
 344                 } else
 345                         printk(KERN_ERR "Error in REQUEST SENSE itself - "
 346                                         "Aborting request!\n");
 347         }
 348
 349         idefloppy_end_request(drive, uptodate, 0);
 350 }
 351
 352 static void idefloppy_init_pc(struct ide_atapi_pc *pc)
 353 {
 354         memset(pc->c, 0, 12);
 355         pc->retries = 0;
 356         pc->flags = 0;
 357         pc->req_xfer = 0;
 358         pc->buf = pc->pc_buf;
 359         pc->buf_size = IDEFLOPPY_PC_BUFFER_SIZE;
 360         pc->callback = ide_floppy_callback;
 361 }
 362
 363 static void idefloppy_create_request_sense_cmd(struct ide_atapi_pc *pc)
 364 {
 365         idefloppy_init_pc(pc);
 366         pc->c[0] = GPCMD_REQUEST_SENSE;
 367         pc->c[4] = 255;
 368         pc->req_xfer = 18;
 369 }
 370
 371 /*
 372  * Called when an error was detected during the last packet command. We queue a
 373  * request sense packet command in the head of the request list.
 374  */
 375 static void idefloppy_retry_pc(ide_drive_t *drive)
 376 {
 377         struct ide_atapi_pc *pc;
 378         struct request *rq;
 379
 380         (void)ide_read_error(drive);
 381         pc = idefloppy_next_pc_storage(drive);
 382         rq = idefloppy_next_rq_storage(drive);
 383         idefloppy_create_request_sense_cmd(pc);
 384         idefloppy_queue_pc_head(drive, pc, rq);
 385 }
 386
 387 /* The usual interrupt handler called during a packet command. */
 388 static ide_startstop_t idefloppy_pc_intr(ide_drive_t *drive)
 389 {
 390         idefloppy_floppy_t *floppy = drive->driver_data;
 391         ide_hwif_t *hwif = drive->hwif;
 392         struct ide_atapi_pc *pc = floppy->pc;
 393         struct request *rq = pc->rq;
 394         xfer_func_t *xferfunc;
 395         unsigned int temp;
 396         int dma_error = 0;
 397         u16 bcount;
 398         u8 stat, ireason;
 399
 400         debug_log("Enter %s - interrupt handler\n", __func__);
 401
 402         /* Clear the interrupt */
 403         stat = ide_read_status(drive);
 404
 405         if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
 406                 dma_error = hwif->dma_ops->dma_end(drive);
 407                 if (dma_error) {
 408                         printk(KERN_ERR "%s: DMA %s error\n", drive->name,
 409                                         rq_data_dir(rq) ? "write" : "read");
 410                         pc->flags |= PC_FLAG_DMA_ERROR;
 411                 } else {
 412                         pc->xferred = pc->req_xfer;
 413                         idefloppy_update_buffers(drive, pc);
 414                 }
 415                 debug_log("%s: DMA finished\n", drive->name);
 416         }
 417
 418         /* No more interrupts */
 419         if ((stat & DRQ_STAT) == 0) {
 420                 debug_log("Packet command completed, %d bytes transferred\n",
 421                                 pc->xferred);
 422                 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
 423
 424                 local_irq_enable_in_hardirq();
 425
 426                 if ((stat & ERR_STAT) || (pc->flags & PC_FLAG_DMA_ERROR)) {
 427                         /* Error detected */
 428                         debug_log("%s: I/O error\n", drive->name);
 429                         rq->errors++;
 430                         if (pc->c[0] == GPCMD_REQUEST_SENSE) {
 431                                 printk(KERN_ERR "%s: I/O error in request sense"
 432                                                 " command\n", drive->name);
 433                                 return ide_do_reset(drive);
 434                         }
 435
 436                         debug_log("[cmd %x]: check condition\n", pc->c[0]);
 437
 438                         /* Retry operation */
 439                         idefloppy_retry_pc(drive);
 440                         /* queued, but not started */
 441                         return ide_stopped;
 442                 }
 443                 pc->error = 0;
 444                 /* Command finished - Call the callback function */
 445                 pc->callback(drive);
 446                 return ide_stopped;
 447         }
 448
 449         if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
 450                 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
 451                 printk(KERN_ERR "%s: The device wants to issue more interrupts "
 452                                 "in DMA mode\n", drive->name);
 453                 ide_dma_off(drive);
 454                 return ide_do_reset(drive);
 455         }
 456
 457         /* Get the number of bytes to transfer */
 458         bcount = (hwif->INB(hwif->io_ports.lbah_addr) << 8) |
 459                   hwif->INB(hwif->io_ports.lbam_addr);
 460         /* on this interrupt */
 461         ireason = hwif->INB(hwif->io_ports.nsect_addr);
 462
 463         if (ireason & CD) {
 464                 printk(KERN_ERR "%s: CoD != 0 in %s\n", drive->name, __func__);
 465                 return ide_do_reset(drive);
 466         }
 467         if (((ireason & IO) == IO) == !!(pc->flags & PC_FLAG_WRITING)) {
 468                 /* Hopefully, we will never get here */
 469                 printk(KERN_ERR "%s: We wanted to %s, but the device wants us "
 470                                 "to %s!\n", drive->name,
 471                                 (ireason & IO) ? "Write" : "Read",
 472                                 (ireason & IO) ? "Read" : "Write");
 473                 return ide_do_reset(drive);
 474         }
 475         if (!(pc->flags & PC_FLAG_WRITING)) {
 476                 /* Reading - Check that we have enough space */
 477                 temp = pc->xferred + bcount;
 478                 if (temp > pc->req_xfer) {
 479                         if (temp > pc->buf_size) {
 480                                 printk(KERN_ERR "%s: The device wants to send "
 481                                                 "us more data than expected - "
 482                                                 "discarding data\n",
 483                                                 drive->name);
 484                                 ide_pad_transfer(drive, 0, bcount);
 485
 486                                 ide_set_handler(drive,
 487                                                 &idefloppy_pc_intr,
 488                                                 IDEFLOPPY_WAIT_CMD,
 489                                                 NULL);
 490                                 return ide_started;
 491                         }
 492                         debug_log("The device wants to send us more data than "
 493                                   "expected - allowing transfer\n");
 494                 }
 495         }
 496         if (pc->flags & PC_FLAG_WRITING)
 497                 xferfunc = hwif->output_data;
 498         else
 499                 xferfunc = hwif->input_data;
 500
 501         if (pc->buf)
 502                 xferfunc(drive, NULL, pc->cur_pos, bcount);
 503         else
 504                 ide_floppy_io_buffers(drive, pc, bcount,
 505                                       !!(pc->flags & PC_FLAG_WRITING));
 506
 507         /* Update the current position */
 508         pc->xferred += bcount;
 509         pc->cur_pos += bcount;
 510
 511         debug_log("[cmd %x] transferred %d bytes on that intr.\n",
 512                   pc->c[0], bcount);
 513
 514         /* And set the interrupt handler again */
 515         ide_set_handler(drive, &idefloppy_pc_intr, IDEFLOPPY_WAIT_CMD, NULL);
 516         return ide_started;
 517 }
 518
 519 /*
 520  * What we have here is a classic case of a top half / bottom half interrupt
 521  * service routine. In interrupt mode, the device sends an interrupt to signal
 522  * that it is ready to receive a packet. However, we need to delay about 2-3
 523  * ticks before issuing the packet or we gets in trouble.
 524  *
 525  * So, follow carefully. transfer_pc1 is called as an interrupt (or directly).
 526  * In either case, when the device says it's ready for a packet, we schedule
 527  * the packet transfer to occur about 2-3 ticks later in transfer_pc2.
 528  */
 529 static int idefloppy_transfer_pc2(ide_drive_t *drive)
 530 {
 531         idefloppy_floppy_t *floppy = drive->driver_data;
 532
 533         /* Send the actual packet */
 534         drive->hwif->output_data(drive, NULL, floppy->pc->c, 12);
 535
 536         /* Timeout for the packet command */
 537         return IDEFLOPPY_WAIT_CMD;
 538 }
 539
 540 static ide_startstop_t idefloppy_transfer_pc1(ide_drive_t *drive)
 541 {
 542         idefloppy_floppy_t *floppy = drive->driver_data;
 543         struct ide_atapi_pc *pc = floppy->pc;
 544         ide_expiry_t *expiry;
 545         unsigned int timeout;
 546
 547         /*
 548          * The following delay solves a problem with ATAPI Zip 100 drives
 549          * where the Busy flag was apparently being deasserted before the
 550          * unit was ready to receive data. This was happening on a
 551          * 1200 MHz Athlon system. 10/26/01 25msec is too short,
 552          * 40 and 50msec work well. idefloppy_pc_intr will not be actually
 553          * used until after the packet is moved in about 50 msec.
 554          */
 555         if (pc->flags & PC_FLAG_ZIP_DRIVE) {
 556                 timeout = floppy->ticks;
 557                 expiry = &idefloppy_transfer_pc2;
 558         } else {
 559                 timeout = IDEFLOPPY_WAIT_CMD;
 560                 expiry = NULL;
 561         }
 562
 563         return ide_transfer_pc(drive, pc, idefloppy_pc_intr, timeout, expiry);
 564 }
 565
 566 static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
 567                                     struct ide_atapi_pc *pc)
 568 {
 569         /* supress error messages resulting from Medium not present */
 570         if (floppy->sense_key == 0x02 &&
 571             floppy->asc       == 0x3a &&
 572             floppy->ascq      == 0x00)
 573                 return;
 574
 575         printk(KERN_ERR "ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
 576                         "asc = %2x, ascq = %2x\n",
 577                         floppy->drive->name, pc->c[0], floppy->sense_key,
 578                         floppy->asc, floppy->ascq);
 579
 580 }
 581
 582 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
 583                 struct ide_atapi_pc *pc)
 584 {
 585         idefloppy_floppy_t *floppy = drive->driver_data;
 586
 587         if (floppy->failed_pc == NULL &&
 588             pc->c[0] != GPCMD_REQUEST_SENSE)
 589                 floppy->failed_pc = pc;
 590         /* Set the current packet command */
 591         floppy->pc = pc;
 592
 593         if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
 594                 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
 595                         ide_floppy_report_error(floppy, pc);
 596                 /* Giving up */
 597                 pc->error = IDEFLOPPY_ERROR_GENERAL;
 598
 599                 floppy->failed_pc = NULL;
 600                 pc->callback(drive);
 601                 return ide_stopped;
 602         }
 603
 604         debug_log("Retry number - %d\n", pc->retries);
 605
 606         pc->retries++;
 607
 608         return ide_issue_pc(drive, pc, idefloppy_transfer_pc1,
 609                             IDEFLOPPY_WAIT_CMD, NULL);
 610 }
 611
 612 static void idefloppy_create_prevent_cmd(struct ide_atapi_pc *pc, int prevent)
 613 {
 614         debug_log("creating prevent removal command, prevent = %d\n", prevent);
 615
 616         idefloppy_init_pc(pc);
 617         pc->c[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL;
 618         pc->c[4] = prevent;
 619 }
 620
 621 static void idefloppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
 622 {
 623         idefloppy_init_pc(pc);
 624         pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
 625         pc->c[7] = 255;
 626         pc->c[8] = 255;
 627         pc->req_xfer = 255;
 628 }
 629
 630 static void idefloppy_create_format_unit_cmd(struct ide_atapi_pc *pc, int b,
 631                 int l, int flags)
 632 {
 633         idefloppy_init_pc(pc);
 634         pc->c[0] = GPCMD_FORMAT_UNIT;
 635         pc->c[1] = 0x17;
 636
 637         memset(pc->buf, 0, 12);
 638         pc->buf[1] = 0xA2;
 639         /* Default format list header, u8 1: FOV/DCRT/IMM bits set */
 640
 641         if (flags & 1)                          /* Verify bit on... */
 642                 pc->buf[1] ^= 0x20;             /* ... turn off DCRT bit */
 643         pc->buf[3] = 8;
 644
 645         put_unaligned(cpu_to_be32(b), (unsigned int *)(&pc->buf[4]));
 646         put_unaligned(cpu_to_be32(l), (unsigned int *)(&pc->buf[8]));
 647         pc->buf_size = 12;
 648         pc->flags |= PC_FLAG_WRITING;
 649 }
 650
 651 /* A mode sense command is used to "sense" floppy parameters. */
 652 static void idefloppy_create_mode_sense_cmd(struct ide_atapi_pc *pc,
 653                 u8 page_code, u8 type)
 654 {
 655         u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
 656
 657         idefloppy_init_pc(pc);
 658         pc->c[0] = GPCMD_MODE_SENSE_10;
 659         pc->c[1] = 0;
 660         pc->c[2] = page_code + (type << 6);
 661
 662         switch (page_code) {
 663         case IDEFLOPPY_CAPABILITIES_PAGE:
 664                 length += 12;
 665                 break;
 666         case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
 667                 length += 32;
 668                 break;
 669         default:
 670                 printk(KERN_ERR "ide-floppy: unsupported page code "
 671                                 "in create_mode_sense_cmd\n");
 672         }
 673         put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
 674         pc->req_xfer = length;
 675 }
 676
 677 static void idefloppy_create_start_stop_cmd(struct ide_atapi_pc *pc, int start)
 678 {
 679         idefloppy_init_pc(pc);
 680         pc->c[0] = GPCMD_START_STOP_UNIT;
 681         pc->c[4] = start;
 682 }
 683
 684 static void idefloppy_create_test_unit_ready_cmd(struct ide_atapi_pc *pc)
 685 {
 686         idefloppy_init_pc(pc);
 687         pc->c[0] = GPCMD_TEST_UNIT_READY;
 688 }
 689
 690 static void idefloppy_create_rw_cmd(idefloppy_floppy_t *floppy,
 691                                     struct ide_atapi_pc *pc, struct request *rq,
 692                                     unsigned long sector)
 693 {
 694         int block = sector / floppy->bs_factor;
 695         int blocks = rq->nr_sectors / floppy->bs_factor;
 696         int cmd = rq_data_dir(rq);
 697
 698         debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
 699                 block, blocks);
 700
 701         idefloppy_init_pc(pc);
 702         pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
 703         put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
 704         put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
 705
 706         pc->rq = rq;
 707         pc->b_count = cmd == READ ? 0 : rq->bio->bi_size;
 708         if (rq->cmd_flags & REQ_RW)
 709                 pc->flags |= PC_FLAG_WRITING;
 710         pc->buf = NULL;
 711         pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
 712         pc->flags |= PC_FLAG_DMA_OK;
 713 }
 714
 715 static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
 716                 struct ide_atapi_pc *pc, struct request *rq)
 717 {
 718         idefloppy_init_pc(pc);
 719         memcpy(pc->c, rq->cmd, sizeof(pc->c));
 720         pc->rq = rq;
 721         pc->b_count = rq->data_len;
 722         if (rq->data_len && rq_data_dir(rq) == WRITE)
 723                 pc->flags |= PC_FLAG_WRITING;
 724         pc->buf = rq->data;
 725         if (rq->bio)
 726                 pc->flags |= PC_FLAG_DMA_OK;
 727         /*
 728          * possibly problematic, doesn't look like ide-floppy correctly
 729          * handled scattered requests if dma fails...
 730          */
 731         pc->req_xfer = pc->buf_size = rq->data_len;
 732 }
 733
 734 static ide_startstop_t idefloppy_do_request(ide_drive_t *drive,
 735                 struct request *rq, sector_t block_s)
 736 {
 737         idefloppy_floppy_t *floppy = drive->driver_data;
 738         struct ide_atapi_pc *pc;
 739         unsigned long block = (unsigned long)block_s;
 740
 741         debug_log("dev: %s, cmd_type: %x, errors: %d\n",
 742                         rq->rq_disk ? rq->rq_disk->disk_name : "?",
 743                         rq->cmd_type, rq->errors);
 744         debug_log("sector: %ld, nr_sectors: %ld, "
 745                         "current_nr_sectors: %d\n", (long)rq->sector,
 746                         rq->nr_sectors, rq->current_nr_sectors);
 747
 748         if (rq->errors >= ERROR_MAX) {
 749                 if (floppy->failed_pc)
 750                         ide_floppy_report_error(floppy, floppy->failed_pc);
 751                 else
 752                         printk(KERN_ERR "ide-floppy: %s: I/O error\n",
 753                                 drive->name);
 754                 idefloppy_end_request(drive, 0, 0);
 755                 return ide_stopped;
 756         }
 757         if (blk_fs_request(rq)) {
 758                 if (((long)rq->sector % floppy->bs_factor) ||
 759                     (rq->nr_sectors % floppy->bs_factor)) {
 760                         printk(KERN_ERR "%s: unsupported r/w request size\n",
 761                                         drive->name);
 762                         idefloppy_end_request(drive, 0, 0);
 763                         return ide_stopped;
 764                 }
 765                 pc = idefloppy_next_pc_storage(drive);
 766                 idefloppy_create_rw_cmd(floppy, pc, rq, block);
 767         } else if (blk_special_request(rq)) {
 768                 pc = (struct ide_atapi_pc *) rq->buffer;
 769         } else if (blk_pc_request(rq)) {
 770                 pc = idefloppy_next_pc_storage(drive);
 771                 idefloppy_blockpc_cmd(floppy, pc, rq);
 772         } else {
 773                 blk_dump_rq_flags(rq,
 774                         "ide-floppy: unsupported command in queue");
 775                 idefloppy_end_request(drive, 0, 0);
 776                 return ide_stopped;
 777         }
 778
 779         if (floppy->flags & IDEFLOPPY_FLAG_DRQ_INTERRUPT)
 780                 pc->flags |= PC_FLAG_DRQ_INTERRUPT;
 781
 782         if (floppy->flags & IDEFLOPPY_FLAG_ZIP_DRIVE)
 783                 pc->flags |= PC_FLAG_ZIP_DRIVE;
 784
 785         pc->rq = rq;
 786
 787         return idefloppy_issue_pc(drive, pc);
 788 }
 789
 790 /*
 791  * Add a special packet command request to the tail of the request queue,
 792  * and wait for it to be serviced.
 793  */
 794 static int idefloppy_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
 795 {
 796         struct ide_floppy_obj *floppy = drive->driver_data;
 797         struct request *rq;
 798         int error;
 799
 800         rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
 801         rq->buffer = (char *) pc;
 802         rq->cmd_type = REQ_TYPE_SPECIAL;
 803         error = blk_execute_rq(drive->queue, floppy->disk, rq, 0);
 804         blk_put_request(rq);
 805
 806         return error;
 807 }
 808
 809 /*
 810  * Look at the flexible disk page parameters. We ignore the CHS capacity
 811  * parameters and use the LBA parameters instead.
 812  */
 813 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive)
 814 {
 815         idefloppy_floppy_t *floppy = drive->driver_data;
 816         struct ide_atapi_pc pc;
 817         u8 *page;
 818         int capacity, lba_capacity;
 819         u16 transfer_rate, sector_size, cyls, rpm;
 820         u8 heads, sectors;
 821
 822         idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE,
 823                                         MODE_SENSE_CURRENT);
 824
 825         if (idefloppy_queue_pc_tail(drive, &pc)) {
 826                 printk(KERN_ERR "ide-floppy: Can't get flexible disk page"
 827                                 " parameters\n");
 828                 return 1;
 829         }
 830         floppy->wp = !!(pc.buf[3] & 0x80);
 831         set_disk_ro(floppy->disk, floppy->wp);
 832         page = &pc.buf[8];
 833
 834         transfer_rate = be16_to_cpu(*(u16 *)&pc.buf[8 + 2]);
 835         sector_size   = be16_to_cpu(*(u16 *)&pc.buf[8 + 6]);
 836         cyls          = be16_to_cpu(*(u16 *)&pc.buf[8 + 8]);
 837         rpm           = be16_to_cpu(*(u16 *)&pc.buf[8 + 28]);
 838         heads         = pc.buf[8 + 4];
 839         sectors       = pc.buf[8 + 5];
 840
 841         capacity = cyls * heads * sectors * sector_size;
 842
 843         if (memcmp(page, &floppy->flexible_disk_page, 32))
 844                 printk(KERN_INFO "%s: %dkB, %d/%d/%d CHS, %d kBps, "
 845                                 "%d sector size, %d rpm\n",
 846                                 drive->name, capacity / 1024, cyls, heads,
 847                                 sectors, transfer_rate / 8, sector_size, rpm);
 848
 849         memcpy(&floppy->flexible_disk_page, page, 32);
 850         drive->bios_cyl = cyls;
 851         drive->bios_head = heads;
 852         drive->bios_sect = sectors;
 853         lba_capacity = floppy->blocks * floppy->block_size;
 854
 855         if (capacity < lba_capacity) {
 856                 printk(KERN_NOTICE "%s: The disk reports a capacity of %d "
 857                         "bytes, but the drive only handles %d\n",
 858                         drive->name, lba_capacity, capacity);
 859                 floppy->blocks = floppy->block_size ?
 860                         capacity / floppy->block_size : 0;
 861         }
 862         return 0;
 863 }
 864
 865 static int idefloppy_get_sfrp_bit(ide_drive_t *drive)
 866 {
 867         idefloppy_floppy_t *floppy = drive->driver_data;
 868         struct ide_atapi_pc pc;
 869
 870         floppy->srfp = 0;
 871         idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_CAPABILITIES_PAGE,
 872                                                  MODE_SENSE_CURRENT);
 873
 874         pc.flags |= PC_FLAG_SUPPRESS_ERROR;
 875         if (idefloppy_queue_pc_tail(drive, &pc))
 876                 return 1;
 877
 878         floppy->srfp = pc.buf[8 + 2] & 0x40;
 879         return (0);
 880 }
 881
 882 /*
 883  * Determine if a media is present in the floppy drive, and if so, its LBA
 884  * capacity.
 885  */
 886 static int ide_floppy_get_capacity(ide_drive_t *drive)
 887 {
 888         idefloppy_floppy_t *floppy = drive->driver_data;
 889         struct ide_atapi_pc pc;
 890         u8 *cap_desc;
 891         u8 header_len, desc_cnt;
 892         int i, rc = 1, blocks, length;
 893
 894         drive->bios_cyl = 0;
 895         drive->bios_head = drive->bios_sect = 0;
 896         floppy->blocks = 0;
 897         floppy->bs_factor = 1;
 898         set_capacity(floppy->disk, 0);
 899
 900         idefloppy_create_read_capacity_cmd(&pc);
 901         if (idefloppy_queue_pc_tail(drive, &pc)) {
 902                 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
 903                 return 1;
 904         }
 905         header_len = pc.buf[3];
 906         cap_desc = &pc.buf[4];
 907         desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
 908
 909         for (i = 0; i < desc_cnt; i++) {
 910                 unsigned int desc_start = 4 + i*8;
 911
 912                 blocks = be32_to_cpu(*(u32 *)&pc.buf[desc_start]);
 913                 length = be16_to_cpu(*(u16 *)&pc.buf[desc_start + 6]);
 914
 915                 debug_log("Descriptor %d: %dkB, %d blocks, %d sector size\n",
 916                                 i, blocks * length / 1024, blocks, length);
 917
 918                 if (i)
 919                         continue;
 920                 /*
 921                  * the code below is valid only for the 1st descriptor, ie i=0
 922                  */
 923
 924                 switch (pc.buf[desc_start + 4] & 0x03) {
 925                 /* Clik! drive returns this instead of CAPACITY_CURRENT */
 926                 case CAPACITY_UNFORMATTED:
 927                         if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE))
 928                                 /*
 929                                  * If it is not a clik drive, break out
 930                                  * (maintains previous driver behaviour)
 931                                  */
 932                                 break;
 933                 case CAPACITY_CURRENT:
 934                         /* Normal Zip/LS-120 disks */
 935                         if (memcmp(cap_desc, &floppy->cap_desc, 8))
 936                                 printk(KERN_INFO "%s: %dkB, %d blocks, %d "
 937                                         "sector size\n", drive->name,
 938                                         blocks * length / 1024, blocks, length);
 939                         memcpy(&floppy->cap_desc, cap_desc, 8);
 940
 941                         if (!length || length % 512) {
 942                                 printk(KERN_NOTICE "%s: %d bytes block size "
 943                                         "not supported\n", drive->name, length);
 944                         } else {
 945                                 floppy->blocks = blocks;
 946                                 floppy->block_size = length;
 947                                 floppy->bs_factor = length / 512;
 948                                 if (floppy->bs_factor != 1)
 949                                         printk(KERN_NOTICE "%s: warning: non "
 950                                                 "512 bytes block size not "
 951                                                 "fully supported\n",
 952                                                 drive->name);
 953                                 rc = 0;
 954                         }
 955                         break;
 956                 case CAPACITY_NO_CARTRIDGE:
 957                         /*
 958                          * This is a KERN_ERR so it appears on screen
 959                          * for the user to see
 960                          */
 961                         printk(KERN_ERR "%s: No disk in drive\n", drive->name);
 962                         break;
 963                 case CAPACITY_INVALID:
 964                         printk(KERN_ERR "%s: Invalid capacity for disk "
 965                                 "in drive\n", drive->name);
 966                         break;
 967                 }
 968                 debug_log("Descriptor 0 Code: %d\n",
 969                           pc.buf[desc_start + 4] & 0x03);
 970         }
 971
 972         /* Clik! disk does not support get_flexible_disk_page */
 973         if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE))
 974                 (void) ide_floppy_get_flexible_disk_page(drive);
 975
 976         set_capacity(floppy->disk, floppy->blocks * floppy->bs_factor);
 977         return rc;
 978 }
 979
 980 /*
 981  * Obtain the list of formattable capacities.
 982  * Very similar to ide_floppy_get_capacity, except that we push the capacity
 983  * descriptors to userland, instead of our own structures.
 984  *
 985  * Userland gives us the following structure:
 986  *
 987  * struct idefloppy_format_capacities {
 988  *      int nformats;
 989  *      struct {
 990  *              int nblocks;
 991  *              int blocksize;
 992  *      } formats[];
 993  * };
 994  *
 995  * userland initializes nformats to the number of allocated formats[] records.
 996  * On exit we set nformats to the number of records we've actually initialized.
 997  */
 998
 999 static int ide_floppy_get_format_capacities(ide_drive_t *drive, int __user *arg)
1000 {
1001         struct ide_atapi_pc pc;
1002         u8 header_len, desc_cnt;
1003         int i, blocks, length, u_array_size, u_index;
1004         int __user *argp;
1005
1006         if (get_user(u_array_size, arg))
1007                 return (-EFAULT);
1008
1009         if (u_array_size <= 0)
1010                 return (-EINVAL);
1011
1012         idefloppy_create_read_capacity_cmd(&pc);
1013         if (idefloppy_queue_pc_tail(drive, &pc)) {
1014                 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
1015                 return (-EIO);
1016         }
1017         header_len = pc.buf[3];
1018         desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
1019
1020         u_index = 0;
1021         argp = arg + 1;
1022
1023         /*
1024          * We always skip the first capacity descriptor.  That's the current
1025          * capacity.  We are interested in the remaining descriptors, the
1026          * formattable capacities.
1027          */
1028         for (i = 1; i < desc_cnt; i++) {
1029                 unsigned int desc_start = 4 + i*8;
1030
1031                 if (u_index >= u_array_size)
1032                         break;  /* User-supplied buffer too small */
1033
1034                 blocks = be32_to_cpu(*(u32 *)&pc.buf[desc_start]);
1035                 length = be16_to_cpu(*(u16 *)&pc.buf[desc_start + 6]);
1036
1037                 if (put_user(blocks, argp))
1038                         return(-EFAULT);
1039                 ++argp;
1040
1041                 if (put_user(length, argp))
1042                         return (-EFAULT);
1043                 ++argp;
1044
1045                 ++u_index;
1046         }
1047
1048         if (put_user(u_index, arg))
1049                 return (-EFAULT);
1050         return (0);
1051 }
1052
1053 /*
1054  * Get ATAPI_FORMAT_UNIT progress indication.
1055  *
1056  * Userland gives a pointer to an int.  The int is set to a progress
1057  * indicator 0-65536, with 65536=100%.
1058  *
1059  * If the drive does not support format progress indication, we just check
1060  * the dsc bit, and return either 0 or 65536.
1061  */
1062
1063 static int idefloppy_get_format_progress(ide_drive_t *drive, int __user *arg)
1064 {
1065         idefloppy_floppy_t *floppy = drive->driver_data;
1066         struct ide_atapi_pc pc;
1067         int progress_indication = 0x10000;
1068
1069         if (floppy->srfp) {
1070                 idefloppy_create_request_sense_cmd(&pc);
1071                 if (idefloppy_queue_pc_tail(drive, &pc))
1072                         return (-EIO);
1073
1074                 if (floppy->sense_key == 2 &&
1075                     floppy->asc == 4 &&
1076                     floppy->ascq == 4)
1077                         progress_indication = floppy->progress_indication;
1078
1079                 /* Else assume format_unit has finished, and we're at 0x10000 */
1080         } else {
1081                 unsigned long flags;
1082                 u8 stat;
1083
1084                 local_irq_save(flags);
1085                 stat = ide_read_status(drive);
1086                 local_irq_restore(flags);
1087
1088                 progress_indication = ((stat & SEEK_STAT) == 0) ? 0 : 0x10000;
1089         }
1090         if (put_user(progress_indication, arg))
1091                 return (-EFAULT);
1092
1093         return (0);
1094 }
1095
1096 static sector_t idefloppy_capacity(ide_drive_t *drive)
1097 {
1098         idefloppy_floppy_t *floppy = drive->driver_data;
1099         unsigned long capacity = floppy->blocks * floppy->bs_factor;
1100
1101         return capacity;
1102 }
1103
1104 /*
1105  * Check whether we can support a drive, based on the ATAPI IDENTIFY command
1106  * results.
1107  */
1108 static int idefloppy_identify_device(ide_drive_t *drive, struct hd_driveid *id)
1109 {
1110         u8 gcw[2];
1111         u8 device_type, protocol, removable, drq_type, packet_size;
1112
1113         *((u16 *) &gcw) = id->config;
1114
1115         device_type =  gcw[1] & 0x1F;
1116         removable   = (gcw[0] & 0x80) >> 7;
1117         protocol    = (gcw[1] & 0xC0) >> 6;
1118         drq_type    = (gcw[0] & 0x60) >> 5;
1119         packet_size =  gcw[0] & 0x03;
1120
1121 #ifdef CONFIG_PPC
1122         /* kludge for Apple PowerBook internal zip */
1123         if (device_type == 5 &&
1124             !strstr(id->model, "CD-ROM") && strstr(id->model, "ZIP"))
1125                 device_type = 0;
1126 #endif
1127
1128         if (protocol != 2)
1129                 printk(KERN_ERR "ide-floppy: Protocol (0x%02x) is not ATAPI\n",
1130                         protocol);
1131         else if (device_type != 0)
1132                 printk(KERN_ERR "ide-floppy: Device type (0x%02x) is not set "
1133                                 "to floppy\n", device_type);
1134         else if (!removable)
1135                 printk(KERN_ERR "ide-floppy: The removable flag is not set\n");
1136         else if (drq_type == 3)
1137                 printk(KERN_ERR "ide-floppy: Sorry, DRQ type (0x%02x) not "
1138                                 "supported\n", drq_type);
1139         else if (packet_size != 0)
1140                 printk(KERN_ERR "ide-floppy: Packet size (0x%02x) is not 12 "
1141                                 "bytes\n", packet_size);
1142         else
1143                 return 1;
1144         return 0;
1145 }
1146
1147 #ifdef CONFIG_IDE_PROC_FS
1148 static void idefloppy_add_settings(ide_drive_t *drive)
1149 {
1150         idefloppy_floppy_t *floppy = drive->driver_data;
1151
1152         ide_add_setting(drive, "bios_cyl", SETTING_RW, TYPE_INT, 0, 1023, 1, 1,
1153                         &drive->bios_cyl, NULL);
1154         ide_add_setting(drive, "bios_head", SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1155                         &drive->bios_head, NULL);
1156         ide_add_setting(drive, "bios_sect", SETTING_RW, TYPE_BYTE, 0,  63, 1, 1,
1157                         &drive->bios_sect, NULL);
1158         ide_add_setting(drive, "ticks",    SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1159                         &floppy->ticks,  NULL);
1160 }
1161 #else
1162 static inline void idefloppy_add_settings(ide_drive_t *drive) { ; }
1163 #endif
1164
1165 static void idefloppy_setup(ide_drive_t *drive, idefloppy_floppy_t *floppy)
1166 {
1167         u8 gcw[2];
1168
1169         *((u16 *) &gcw) = drive->id->config;
1170         floppy->pc = floppy->pc_stack;
1171
1172         if (((gcw[0] & 0x60) >> 5) == 1)
1173                 floppy->flags |= IDEFLOPPY_FLAG_DRQ_INTERRUPT;
1174         /*
1175          * We used to check revisions here. At this point however I'm giving up.
1176          * Just assume they are all broken, its easier.
1177          *
1178          * The actual reason for the workarounds was likely a driver bug after
1179          * all rather than a firmware bug, and the workaround below used to hide
1180          * it. It should be fixed as of version 1.9, but to be on the safe side
1181          * we'll leave the limitation below for the 2.2.x tree.
1182          */
1183         if (!strncmp(drive->id->model, "IOMEGA ZIP 100 ATAPI", 20)) {
1184                 floppy->flags |= IDEFLOPPY_FLAG_ZIP_DRIVE;
1185                 /* This value will be visible in the /proc/ide/hdx/settings */
1186                 floppy->ticks = IDEFLOPPY_TICKS_DELAY;
1187                 blk_queue_max_sectors(drive->queue, 64);
1188         }
1189
1190         /*
1191          * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
1192          * nasty clicking noises without it, so please don't remove this.
1193          */
1194         if (strncmp(drive->id->model, "IOMEGA Clik!", 11) == 0) {
1195                 blk_queue_max_sectors(drive->queue, 64);
1196                 floppy->flags |= IDEFLOPPY_FLAG_CLIK_DRIVE;
1197         }
1198
1199         (void) ide_floppy_get_capacity(drive);
1200         idefloppy_add_settings(drive);
1201 }
1202
1203 static void ide_floppy_remove(ide_drive_t *drive)
1204 {
1205         idefloppy_floppy_t *floppy = drive->driver_data;
1206         struct gendisk *g = floppy->disk;
1207
1208         ide_proc_unregister_driver(drive, floppy->driver);
1209
1210         del_gendisk(g);
1211
1212         ide_floppy_put(floppy);
1213 }
1214
1215 static void idefloppy_cleanup_obj(struct kref *kref)
1216 {
1217         struct ide_floppy_obj *floppy = to_ide_floppy(kref);
1218         ide_drive_t *drive = floppy->drive;
1219         struct gendisk *g = floppy->disk;
1220
1221         drive->driver_data = NULL;
1222         g->private_data = NULL;
1223         put_disk(g);
1224         kfree(floppy);
1225 }
1226
1227 #ifdef CONFIG_IDE_PROC_FS
1228 static int proc_idefloppy_read_capacity(char *page, char **start, off_t off,
1229                 int count, int *eof, void *data)
1230 {
1231         ide_drive_t*drive = (ide_drive_t *)data;
1232         int len;
1233
1234         len = sprintf(page, "%llu\n", (long long)idefloppy_capacity(drive));
1235         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1236 }
1237
1238 static ide_proc_entry_t idefloppy_proc[] = {
1239         { "capacity",   S_IFREG|S_IRUGO, proc_idefloppy_read_capacity,  NULL },
1240         { "geometry",   S_IFREG|S_IRUGO, proc_ide_read_geometry,        NULL },
1241         { NULL, 0, NULL, NULL }
1242 };
1243 #endif  /* CONFIG_IDE_PROC_FS */
1244
1245 static int ide_floppy_probe(ide_drive_t *);
1246
1247 static ide_driver_t idefloppy_driver = {
1248         .gen_driver = {
1249                 .owner          = THIS_MODULE,
1250                 .name           = "ide-floppy",
1251                 .bus            = &ide_bus_type,
1252         },
1253         .probe                  = ide_floppy_probe,
1254         .remove                 = ide_floppy_remove,
1255         .version                = IDEFLOPPY_VERSION,
1256         .media                  = ide_floppy,
1257         .supports_dsc_overlap   = 0,
1258         .do_request             = idefloppy_do_request,
1259         .end_request            = idefloppy_end_request,
1260         .error                  = __ide_error,
1261         .abort                  = __ide_abort,
1262 #ifdef CONFIG_IDE_PROC_FS
1263         .proc                   = idefloppy_proc,
1264 #endif
1265 };
1266
1267 static int idefloppy_open(struct inode *inode, struct file *filp)
1268 {
1269         struct gendisk *disk = inode->i_bdev->bd_disk;
1270         struct ide_floppy_obj *floppy;
1271         ide_drive_t *drive;
1272         struct ide_atapi_pc pc;
1273         int ret = 0;
1274
1275         debug_log("Reached %s\n", __func__);
1276
1277         floppy = ide_floppy_get(disk);
1278         if (!floppy)
1279                 return -ENXIO;
1280
1281         drive = floppy->drive;
1282
1283         floppy->openers++;
1284
1285         if (floppy->openers == 1) {
1286                 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1287                 /* Just in case */
1288
1289                 idefloppy_create_test_unit_ready_cmd(&pc);
1290                 if (idefloppy_queue_pc_tail(drive, &pc)) {
1291                         idefloppy_create_start_stop_cmd(&pc, 1);
1292                         (void) idefloppy_queue_pc_tail(drive, &pc);
1293                 }
1294
1295                 if (ide_floppy_get_capacity(drive)
1296                    && (filp->f_flags & O_NDELAY) == 0
1297                     /*
1298                      * Allow O_NDELAY to open a drive without a disk, or with an
1299                      * unreadable disk, so that we can get the format capacity
1300                      * of the drive or begin the format - Sam
1301                      */
1302                     ) {
1303                         ret = -EIO;
1304                         goto out_put_floppy;
1305                 }
1306
1307                 if (floppy->wp && (filp->f_mode & 2)) {
1308                         ret = -EROFS;
1309                         goto out_put_floppy;
1310                 }
1311                 floppy->flags |= IDEFLOPPY_FLAG_MEDIA_CHANGED;
1312                 /* IOMEGA Clik! drives do not support lock/unlock commands */
1313                 if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1314                         idefloppy_create_prevent_cmd(&pc, 1);
1315                         (void) idefloppy_queue_pc_tail(drive, &pc);
1316                 }
1317                 check_disk_change(inode->i_bdev);
1318         } else if (floppy->flags & IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS) {
1319                 ret = -EBUSY;
1320                 goto out_put_floppy;
1321         }
1322         return 0;
1323
1324 out_put_floppy:
1325         floppy->openers--;
1326         ide_floppy_put(floppy);
1327         return ret;
1328 }
1329
1330 static int idefloppy_release(struct inode *inode, struct file *filp)
1331 {
1332         struct gendisk *disk = inode->i_bdev->bd_disk;
1333         struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1334         ide_drive_t *drive = floppy->drive;
1335         struct ide_atapi_pc pc;
1336
1337         debug_log("Reached %s\n", __func__);
1338
1339         if (floppy->openers == 1) {
1340                 /* IOMEGA Clik! drives do not support lock/unlock commands */
1341                 if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1342                         idefloppy_create_prevent_cmd(&pc, 0);
1343                         (void) idefloppy_queue_pc_tail(drive, &pc);
1344                 }
1345
1346                 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1347         }
1348
1349         floppy->openers--;
1350
1351         ide_floppy_put(floppy);
1352
1353         return 0;
1354 }
1355
1356 static int idefloppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1357 {
1358         struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1359         ide_drive_t *drive = floppy->drive;
1360
1361         geo->heads = drive->bios_head;
1362         geo->sectors = drive->bios_sect;
1363         geo->cylinders = (u16)drive->bios_cyl; /* truncate */
1364         return 0;
1365 }
1366
1367 static int ide_floppy_lockdoor(idefloppy_floppy_t *floppy,
1368                 struct ide_atapi_pc *pc, unsigned long arg, unsigned int cmd)
1369 {
1370         if (floppy->openers > 1)
1371                 return -EBUSY;
1372
1373         /* The IOMEGA Clik! Drive doesn't support this command -
1374          * no room for an eject mechanism */
1375         if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1376                 int prevent = arg ? 1 : 0;
1377
1378                 if (cmd == CDROMEJECT)
1379                         prevent = 0;
1380
1381                 idefloppy_create_prevent_cmd(pc, prevent);
1382                 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1383         }
1384
1385         if (cmd == CDROMEJECT) {
1386                 idefloppy_create_start_stop_cmd(pc, 2);
1387                 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1388         }
1389
1390         return 0;
1391 }
1392
1393 static int ide_floppy_format_unit(idefloppy_floppy_t *floppy,
1394                                   int __user *arg)
1395 {
1396         int blocks, length, flags, err = 0;
1397         struct ide_atapi_pc pc;
1398
1399         if (floppy->openers > 1) {
1400                 /* Don't format if someone is using the disk */
1401                 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1402                 return -EBUSY;
1403         }
1404
1405         floppy->flags |= IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1406
1407         /*
1408          * Send ATAPI_FORMAT_UNIT to the drive.
1409          *
1410          * Userland gives us the following structure:
1411          *
1412          * struct idefloppy_format_command {
1413          *        int nblocks;
1414          *        int blocksize;
1415          *        int flags;
1416          *        } ;
1417          *
1418          * flags is a bitmask, currently, the only defined flag is:
1419          *
1420          *        0x01 - verify media after format.
1421          */
1422         if (get_user(blocks, arg) ||
1423                         get_user(length, arg+1) ||
1424                         get_user(flags, arg+2)) {
1425                 err = -EFAULT;
1426                 goto out;
1427         }
1428
1429         (void) idefloppy_get_sfrp_bit(floppy->drive);
1430         idefloppy_create_format_unit_cmd(&pc, blocks, length, flags);
1431
1432         if (idefloppy_queue_pc_tail(floppy->drive, &pc))
1433                 err = -EIO;
1434
1435 out:
1436         if (err)
1437                 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1438         return err;
1439 }
1440
1441
1442 static int idefloppy_ioctl(struct inode *inode, struct file *file,
1443                         unsigned int cmd, unsigned long arg)
1444 {
1445         struct block_device *bdev = inode->i_bdev;
1446         struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1447         ide_drive_t *drive = floppy->drive;
1448         struct ide_atapi_pc pc;
1449         void __user *argp = (void __user *)arg;
1450         int err;
1451
1452         switch (cmd) {
1453         case CDROMEJECT:
1454                 /* fall through */
1455         case CDROM_LOCKDOOR:
1456                 return ide_floppy_lockdoor(floppy, &pc, arg, cmd);
1457         case IDEFLOPPY_IOCTL_FORMAT_SUPPORTED:
1458                 return 0;
1459         case IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY:
1460                 return ide_floppy_get_format_capacities(drive, argp);
1461         case IDEFLOPPY_IOCTL_FORMAT_START:
1462                 if (!(file->f_mode & 2))
1463                         return -EPERM;
1464
1465                 return ide_floppy_format_unit(floppy, (int __user *)arg);
1466         case IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS:
1467                 return idefloppy_get_format_progress(drive, argp);
1468         }
1469
1470         /*
1471          * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
1472          * and CDROM_SEND_PACKET (legacy) ioctls
1473          */
1474         if (cmd != CDROM_SEND_PACKET && cmd != SCSI_IOCTL_SEND_COMMAND)
1475                 err = scsi_cmd_ioctl(file, bdev->bd_disk->queue,
1476                                         bdev->bd_disk, cmd, argp);
1477         else
1478                 err = -ENOTTY;
1479
1480         if (err == -ENOTTY)
1481                 err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
1482
1483         return err;
1484 }
1485
1486 static int idefloppy_media_changed(struct gendisk *disk)
1487 {
1488         struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1489         ide_drive_t *drive = floppy->drive;
1490         int ret;
1491
1492         /* do not scan partitions twice if this is a removable device */
1493         if (drive->attach) {
1494                 drive->attach = 0;
1495                 return 0;
1496         }
1497         ret = !!(floppy->flags & IDEFLOPPY_FLAG_MEDIA_CHANGED);
1498         floppy->flags &= ~IDEFLOPPY_FLAG_MEDIA_CHANGED;
1499         return ret;
1500 }
1501
1502 static int idefloppy_revalidate_disk(struct gendisk *disk)
1503 {
1504         struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1505         set_capacity(disk, idefloppy_capacity(floppy->drive));
1506         return 0;
1507 }
1508
1509 static struct block_device_operations idefloppy_ops = {
1510         .owner                  = THIS_MODULE,
1511         .open                   = idefloppy_open,
1512         .release                = idefloppy_release,
1513         .ioctl                  = idefloppy_ioctl,
1514         .getgeo                 = idefloppy_getgeo,
1515         .media_changed          = idefloppy_media_changed,
1516         .revalidate_disk        = idefloppy_revalidate_disk
1517 };
1518
1519 static int ide_floppy_probe(ide_drive_t *drive)
1520 {
1521         idefloppy_floppy_t *floppy;
1522         struct gendisk *g;
1523
1524         if (!strstr("ide-floppy", drive->driver_req))
1525                 goto failed;
1526         if (!drive->present)
1527                 goto failed;
1528         if (drive->media != ide_floppy)
1529                 goto failed;
1530         if (!idefloppy_identify_device(drive, drive->id)) {
1531                 printk(KERN_ERR "ide-floppy: %s: not supported by this version"
1532                                 " of ide-floppy\n", drive->name);
1533                 goto failed;
1534         }
1535         floppy = kzalloc(sizeof(idefloppy_floppy_t), GFP_KERNEL);
1536         if (!floppy) {
1537                 printk(KERN_ERR "ide-floppy: %s: Can't allocate a floppy"
1538                                 " structure\n", drive->name);
1539                 goto failed;
1540         }
1541
1542         g = alloc_disk(1 << PARTN_BITS);
1543         if (!g)
1544                 goto out_free_floppy;
1545
1546         ide_init_disk(g, drive);
1547
1548         ide_proc_register_driver(drive, &idefloppy_driver);
1549
1550         kref_init(&floppy->kref);
1551
1552         floppy->drive = drive;
1553         floppy->driver = &idefloppy_driver;
1554         floppy->disk = g;
1555
1556         g->private_data = &floppy->driver;
1557
1558         drive->driver_data = floppy;
1559
1560         idefloppy_setup(drive, floppy);
1561
1562         g->minors = 1 << PARTN_BITS;
1563         g->driverfs_dev = &drive->gendev;
1564         g->flags = drive->removable ? GENHD_FL_REMOVABLE : 0;
1565         g->fops = &idefloppy_ops;
1566         drive->attach = 1;
1567         add_disk(g);
1568         return 0;
1569
1570 out_free_floppy:
1571         kfree(floppy);
1572 failed:
1573         return -ENODEV;
1574 }
1575
1576 static void __exit idefloppy_exit(void)
1577 {
1578         driver_unregister(&idefloppy_driver.gen_driver);
1579 }
1580
1581 static int __init idefloppy_init(void)
1582 {
1583         printk("ide-floppy driver " IDEFLOPPY_VERSION "\n");
1584         return driver_register(&idefloppy_driver.gen_driver);
1585 }
1586
1587 MODULE_ALIAS("ide:*m-floppy*");
1588 module_init(idefloppy_init);
1589 module_exit(idefloppy_exit);
1590 MODULE_LICENSE("GPL");
1591 MODULE_DESCRIPTION("ATAPI FLOPPY Driver");
1592