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         ide_init_drive_cmd(rq);
 290         rq->buffer = (char *) pc;
 291         rq->cmd_type = REQ_TYPE_SPECIAL;
 292         rq->rq_disk = floppy->disk;
 293         (void) ide_do_drive_cmd(drive, rq, ide_preempt);
 294 }
 295
 296 static struct ide_atapi_pc *idefloppy_next_pc_storage(ide_drive_t *drive)
 297 {
 298         idefloppy_floppy_t *floppy = drive->driver_data;
 299
 300         if (floppy->pc_stack_index == IDEFLOPPY_PC_STACK)
 301                 floppy->pc_stack_index = 0;
 302         return (&floppy->pc_stack[floppy->pc_stack_index++]);
 303 }
 304
 305 static struct request *idefloppy_next_rq_storage(ide_drive_t *drive)
 306 {
 307         idefloppy_floppy_t *floppy = drive->driver_data;
 308
 309         if (floppy->rq_stack_index == IDEFLOPPY_PC_STACK)
 310                 floppy->rq_stack_index = 0;
 311         return (&floppy->rq_stack[floppy->rq_stack_index++]);
 312 }
 313
 314 static void idefloppy_request_sense_callback(ide_drive_t *drive)
 315 {
 316         idefloppy_floppy_t *floppy = drive->driver_data;
 317         u8 *buf = floppy->pc->buf;
 318
 319         debug_log("Reached %s\n", __func__);
 320
 321         if (!floppy->pc->error) {
 322                 floppy->sense_key = buf[2] & 0x0F;
 323                 floppy->asc = buf[12];
 324                 floppy->ascq = buf[13];
 325                 floppy->progress_indication = buf[15] & 0x80 ?
 326                         (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
 327
 328                 if (floppy->failed_pc)
 329                         debug_log("pc = %x, sense key = %x, asc = %x,"
 330                                         " ascq = %x\n",
 331                                         floppy->failed_pc->c[0],
 332                                         floppy->sense_key,
 333                                         floppy->asc,
 334                                         floppy->ascq);
 335                 else
 336                         debug_log("sense key = %x, asc = %x, ascq = %x\n",
 337                                         floppy->sense_key,
 338                                         floppy->asc,
 339                                         floppy->ascq);
 340
 341
 342                 idefloppy_end_request(drive, 1, 0);
 343         } else {
 344                 printk(KERN_ERR "Error in REQUEST SENSE itself - Aborting"
 345                                 " request!\n");
 346                 idefloppy_end_request(drive, 0, 0);
 347         }
 348 }
 349
 350 /* General packet command callback function. */
 351 static void idefloppy_pc_callback(ide_drive_t *drive)
 352 {
 353         idefloppy_floppy_t *floppy = drive->driver_data;
 354
 355         debug_log("Reached %s\n", __func__);
 356
 357         idefloppy_end_request(drive, floppy->pc->error ? 0 : 1, 0);
 358 }
 359
 360 static void idefloppy_init_pc(struct ide_atapi_pc *pc)
 361 {
 362         memset(pc->c, 0, 12);
 363         pc->retries = 0;
 364         pc->flags = 0;
 365         pc->req_xfer = 0;
 366         pc->buf = pc->pc_buf;
 367         pc->buf_size = IDEFLOPPY_PC_BUFFER_SIZE;
 368         pc->idefloppy_callback = &idefloppy_pc_callback;
 369 }
 370
 371 static void idefloppy_create_request_sense_cmd(struct ide_atapi_pc *pc)
 372 {
 373         idefloppy_init_pc(pc);
 374         pc->c[0] = GPCMD_REQUEST_SENSE;
 375         pc->c[4] = 255;
 376         pc->req_xfer = 18;
 377         pc->idefloppy_callback = &idefloppy_request_sense_callback;
 378 }
 379
 380 /*
 381  * Called when an error was detected during the last packet command. We queue a
 382  * request sense packet command in the head of the request list.
 383  */
 384 static void idefloppy_retry_pc(ide_drive_t *drive)
 385 {
 386         struct ide_atapi_pc *pc;
 387         struct request *rq;
 388
 389         (void)ide_read_error(drive);
 390         pc = idefloppy_next_pc_storage(drive);
 391         rq = idefloppy_next_rq_storage(drive);
 392         idefloppy_create_request_sense_cmd(pc);
 393         idefloppy_queue_pc_head(drive, pc, rq);
 394 }
 395
 396 /* The usual interrupt handler called during a packet command. */
 397 static ide_startstop_t idefloppy_pc_intr(ide_drive_t *drive)
 398 {
 399         idefloppy_floppy_t *floppy = drive->driver_data;
 400         ide_hwif_t *hwif = drive->hwif;
 401         struct ide_atapi_pc *pc = floppy->pc;
 402         struct request *rq = pc->rq;
 403         xfer_func_t *xferfunc;
 404         unsigned int temp;
 405         int dma_error = 0;
 406         u16 bcount;
 407         u8 stat, ireason;
 408
 409         debug_log("Reached %s interrupt handler\n", __func__);
 410
 411         if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
 412                 dma_error = hwif->dma_ops->dma_end(drive);
 413                 if (dma_error) {
 414                         printk(KERN_ERR "%s: DMA %s error\n", drive->name,
 415                                         rq_data_dir(rq) ? "write" : "read");
 416                         pc->flags |= PC_FLAG_DMA_ERROR;
 417                 } else {
 418                         pc->xferred = pc->req_xfer;
 419                         idefloppy_update_buffers(drive, pc);
 420                 }
 421                 debug_log("DMA finished\n");
 422         }
 423
 424         /* Clear the interrupt */
 425         stat = ide_read_status(drive);
 426
 427         /* No more interrupts */
 428         if ((stat & DRQ_STAT) == 0) {
 429                 debug_log("Packet command completed, %d bytes transferred\n",
 430                                 pc->xferred);
 431                 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
 432
 433                 local_irq_enable_in_hardirq();
 434
 435                 if ((stat & ERR_STAT) || (pc->flags & PC_FLAG_DMA_ERROR)) {
 436                         /* Error detected */
 437                         debug_log("%s: I/O error\n", drive->name);
 438                         rq->errors++;
 439                         if (pc->c[0] == GPCMD_REQUEST_SENSE) {
 440                                 printk(KERN_ERR "ide-floppy: I/O error in "
 441                                         "request sense command\n");
 442                                 return ide_do_reset(drive);
 443                         }
 444                         /* Retry operation */
 445                         idefloppy_retry_pc(drive);
 446                         /* queued, but not started */
 447                         return ide_stopped;
 448                 }
 449                 pc->error = 0;
 450                 if (floppy->failed_pc == pc)
 451                         floppy->failed_pc = NULL;
 452                 /* Command finished - Call the callback function */
 453                 pc->idefloppy_callback(drive);
 454                 return ide_stopped;
 455         }
 456
 457         if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
 458                 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
 459                 printk(KERN_ERR "ide-floppy: The floppy wants to issue "
 460                         "more interrupts in DMA mode\n");
 461                 ide_dma_off(drive);
 462                 return ide_do_reset(drive);
 463         }
 464
 465         /* Get the number of bytes to transfer */
 466         bcount = (hwif->INB(hwif->io_ports.lbah_addr) << 8) |
 467                   hwif->INB(hwif->io_ports.lbam_addr);
 468         /* on this interrupt */
 469         ireason = hwif->INB(hwif->io_ports.nsect_addr);
 470
 471         if (ireason & CD) {
 472                 printk(KERN_ERR "ide-floppy: CoD != 0 in %s\n", __func__);
 473                 return ide_do_reset(drive);
 474         }
 475         if (((ireason & IO) == IO) == !!(pc->flags & PC_FLAG_WRITING)) {
 476                 /* Hopefully, we will never get here */
 477                 printk(KERN_ERR "ide-floppy: We wanted to %s, ",
 478                                 (ireason & IO) ? "Write" : "Read");
 479                 printk(KERN_ERR "but the floppy wants us to %s !\n",
 480                                 (ireason & IO) ? "Read" : "Write");
 481                 return ide_do_reset(drive);
 482         }
 483         if (!(pc->flags & PC_FLAG_WRITING)) {
 484                 /* Reading - Check that we have enough space */
 485                 temp = pc->xferred + bcount;
 486                 if (temp > pc->req_xfer) {
 487                         if (temp > pc->buf_size) {
 488                                 printk(KERN_ERR "ide-floppy: The floppy wants "
 489                                         "to send us more data than expected "
 490                                         "- discarding data\n");
 491                                 ide_pad_transfer(drive, 0, bcount);
 492
 493                                 ide_set_handler(drive,
 494                                                 &idefloppy_pc_intr,
 495                                                 IDEFLOPPY_WAIT_CMD,
 496                                                 NULL);
 497                                 return ide_started;
 498                         }
 499                         debug_log("The floppy wants to send us more data than"
 500                                         " expected - allowing transfer\n");
 501                 }
 502         }
 503         if (pc->flags & PC_FLAG_WRITING)
 504                 xferfunc = hwif->output_data;
 505         else
 506                 xferfunc = hwif->input_data;
 507
 508         if (pc->buf)
 509                 xferfunc(drive, NULL, pc->cur_pos, bcount);
 510         else
 511                 ide_floppy_io_buffers(drive, pc, bcount,
 512                                       !!(pc->flags & PC_FLAG_WRITING));
 513
 514         /* Update the current position */
 515         pc->xferred += bcount;
 516         pc->cur_pos += bcount;
 517
 518         /* And set the interrupt handler again */
 519         ide_set_handler(drive, &idefloppy_pc_intr, IDEFLOPPY_WAIT_CMD, NULL);
 520         return ide_started;
 521 }
 522
 523 /*
 524  * This is the original routine that did the packet transfer.
 525  * It fails at high speeds on the Iomega ZIP drive, so there's a slower version
 526  * for that drive below. The algorithm is chosen based on drive type
 527  */
 528 static ide_startstop_t idefloppy_transfer_pc(ide_drive_t *drive)
 529 {
 530         ide_hwif_t *hwif = drive->hwif;
 531         ide_startstop_t startstop;
 532         idefloppy_floppy_t *floppy = drive->driver_data;
 533         u8 ireason;
 534
 535         if (ide_wait_stat(&startstop, drive, DRQ_STAT, BUSY_STAT, WAIT_READY)) {
 536                 printk(KERN_ERR "ide-floppy: Strange, packet command "
 537                                 "initiated yet DRQ isn't asserted\n");
 538                 return startstop;
 539         }
 540         ireason = hwif->INB(hwif->io_ports.nsect_addr);
 541         if ((ireason & CD) == 0 || (ireason & IO)) {
 542                 printk(KERN_ERR "ide-floppy: (IO,CoD) != (0,1) while "
 543                                 "issuing a packet command\n");
 544                 return ide_do_reset(drive);
 545         }
 546
 547         /* Set the interrupt routine */
 548         ide_set_handler(drive, &idefloppy_pc_intr, IDEFLOPPY_WAIT_CMD, NULL);
 549
 550         /* Send the actual packet */
 551         hwif->output_data(drive, NULL, floppy->pc->c, 12);
 552
 553         return ide_started;
 554 }
 555
 556
 557 /*
 558  * What we have here is a classic case of a top half / bottom half interrupt
 559  * service routine. In interrupt mode, the device sends an interrupt to signal
 560  * that it is ready to receive a packet. However, we need to delay about 2-3
 561  * ticks before issuing the packet or we gets in trouble.
 562  *
 563  * So, follow carefully. transfer_pc1 is called as an interrupt (or directly).
 564  * In either case, when the device says it's ready for a packet, we schedule
 565  * the packet transfer to occur about 2-3 ticks later in transfer_pc2.
 566  */
 567 static int idefloppy_transfer_pc2(ide_drive_t *drive)
 568 {
 569         idefloppy_floppy_t *floppy = drive->driver_data;
 570
 571         /* Send the actual packet */
 572         drive->hwif->output_data(drive, NULL, floppy->pc->c, 12);
 573
 574         /* Timeout for the packet command */
 575         return IDEFLOPPY_WAIT_CMD;
 576 }
 577
 578 static ide_startstop_t idefloppy_transfer_pc1(ide_drive_t *drive)
 579 {
 580         ide_hwif_t *hwif = drive->hwif;
 581         idefloppy_floppy_t *floppy = drive->driver_data;
 582         ide_startstop_t startstop;
 583         u8 ireason;
 584
 585         if (ide_wait_stat(&startstop, drive, DRQ_STAT, BUSY_STAT, WAIT_READY)) {
 586                 printk(KERN_ERR "ide-floppy: Strange, packet command "
 587                                 "initiated yet DRQ isn't asserted\n");
 588                 return startstop;
 589         }
 590         ireason = hwif->INB(hwif->io_ports.nsect_addr);
 591         if ((ireason & CD) == 0 || (ireason & IO)) {
 592                 printk(KERN_ERR "ide-floppy: (IO,CoD) != (0,1) "
 593                                 "while issuing a packet command\n");
 594                 return ide_do_reset(drive);
 595         }
 596         /*
 597          * The following delay solves a problem with ATAPI Zip 100 drives
 598          * where the Busy flag was apparently being deasserted before the
 599          * unit was ready to receive data. This was happening on a
 600          * 1200 MHz Athlon system. 10/26/01 25msec is too short,
 601          * 40 and 50msec work well. idefloppy_pc_intr will not be actually
 602          * used until after the packet is moved in about 50 msec.
 603          */
 604
 605         ide_set_handler(drive, &idefloppy_pc_intr, floppy->ticks,
 606                         &idefloppy_transfer_pc2);
 607         return ide_started;
 608 }
 609
 610 static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
 611                                     struct ide_atapi_pc *pc)
 612 {
 613         /* supress error messages resulting from Medium not present */
 614         if (floppy->sense_key == 0x02 &&
 615             floppy->asc       == 0x3a &&
 616             floppy->ascq      == 0x00)
 617                 return;
 618
 619         printk(KERN_ERR "ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
 620                         "asc = %2x, ascq = %2x\n",
 621                         floppy->drive->name, pc->c[0], floppy->sense_key,
 622                         floppy->asc, floppy->ascq);
 623
 624 }
 625
 626 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
 627                 struct ide_atapi_pc *pc)
 628 {
 629         idefloppy_floppy_t *floppy = drive->driver_data;
 630         ide_hwif_t *hwif = drive->hwif;
 631         ide_handler_t *pkt_xfer_routine;
 632         u16 bcount;
 633         u8 dma;
 634
 635         if (floppy->failed_pc == NULL &&
 636             pc->c[0] != GPCMD_REQUEST_SENSE)
 637                 floppy->failed_pc = pc;
 638         /* Set the current packet command */
 639         floppy->pc = pc;
 640
 641         if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
 642                 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
 643                         ide_floppy_report_error(floppy, pc);
 644                 /* Giving up */
 645                 pc->error = IDEFLOPPY_ERROR_GENERAL;
 646
 647                 floppy->failed_pc = NULL;
 648                 pc->idefloppy_callback(drive);
 649                 return ide_stopped;
 650         }
 651
 652         debug_log("Retry number - %d\n", pc->retries);
 653
 654         pc->retries++;
 655         /* We haven't transferred any data yet */
 656         pc->xferred = 0;
 657         pc->cur_pos = pc->buf;
 658         bcount = min(pc->req_xfer, 63 * 1024);
 659
 660         if (pc->flags & PC_FLAG_DMA_ERROR) {
 661                 pc->flags &= ~PC_FLAG_DMA_ERROR;
 662                 ide_dma_off(drive);
 663         }
 664         dma = 0;
 665
 666         if ((pc->flags & PC_FLAG_DMA_RECOMMENDED) && drive->using_dma)
 667                 dma = !hwif->dma_ops->dma_setup(drive);
 668
 669         ide_pktcmd_tf_load(drive, IDE_TFLAG_NO_SELECT_MASK |
 670                            IDE_TFLAG_OUT_DEVICE, bcount, dma);
 671
 672         if (dma) {
 673                 /* Begin DMA, if necessary */
 674                 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
 675                 hwif->dma_ops->dma_start(drive);
 676         }
 677
 678         /* Can we transfer the packet when we get the interrupt or wait? */
 679         if (floppy->flags & IDEFLOPPY_FLAG_ZIP_DRIVE) {
 680                 /* wait */
 681                 pkt_xfer_routine = &idefloppy_transfer_pc1;
 682         } else {
 683                 /* immediate */
 684                 pkt_xfer_routine = &idefloppy_transfer_pc;
 685         }
 686
 687         if (floppy->flags & IDEFLOPPY_FLAG_DRQ_INTERRUPT) {
 688                 /* Issue the packet command */
 689                 ide_execute_command(drive, WIN_PACKETCMD,
 690                                 pkt_xfer_routine,
 691                                 IDEFLOPPY_WAIT_CMD,
 692                                 NULL);
 693                 return ide_started;
 694         } else {
 695                 /* Issue the packet command */
 696                 ide_execute_pkt_cmd(drive);
 697                 return (*pkt_xfer_routine) (drive);
 698         }
 699 }
 700
 701 static void idefloppy_rw_callback(ide_drive_t *drive)
 702 {
 703         debug_log("Reached %s\n", __func__);
 704
 705         idefloppy_end_request(drive, 1, 0);
 706         return;
 707 }
 708
 709 static void idefloppy_create_prevent_cmd(struct ide_atapi_pc *pc, int prevent)
 710 {
 711         debug_log("creating prevent removal command, prevent = %d\n", prevent);
 712
 713         idefloppy_init_pc(pc);
 714         pc->c[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL;
 715         pc->c[4] = prevent;
 716 }
 717
 718 static void idefloppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
 719 {
 720         idefloppy_init_pc(pc);
 721         pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
 722         pc->c[7] = 255;
 723         pc->c[8] = 255;
 724         pc->req_xfer = 255;
 725 }
 726
 727 static void idefloppy_create_format_unit_cmd(struct ide_atapi_pc *pc, int b,
 728                 int l, int flags)
 729 {
 730         idefloppy_init_pc(pc);
 731         pc->c[0] = GPCMD_FORMAT_UNIT;
 732         pc->c[1] = 0x17;
 733
 734         memset(pc->buf, 0, 12);
 735         pc->buf[1] = 0xA2;
 736         /* Default format list header, u8 1: FOV/DCRT/IMM bits set */
 737
 738         if (flags & 1)                          /* Verify bit on... */
 739                 pc->buf[1] ^= 0x20;             /* ... turn off DCRT bit */
 740         pc->buf[3] = 8;
 741
 742         put_unaligned(cpu_to_be32(b), (unsigned int *)(&pc->buf[4]));
 743         put_unaligned(cpu_to_be32(l), (unsigned int *)(&pc->buf[8]));
 744         pc->buf_size = 12;
 745         pc->flags |= PC_FLAG_WRITING;
 746 }
 747
 748 /* A mode sense command is used to "sense" floppy parameters. */
 749 static void idefloppy_create_mode_sense_cmd(struct ide_atapi_pc *pc,
 750                 u8 page_code, u8 type)
 751 {
 752         u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
 753
 754         idefloppy_init_pc(pc);
 755         pc->c[0] = GPCMD_MODE_SENSE_10;
 756         pc->c[1] = 0;
 757         pc->c[2] = page_code + (type << 6);
 758
 759         switch (page_code) {
 760         case IDEFLOPPY_CAPABILITIES_PAGE:
 761                 length += 12;
 762                 break;
 763         case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
 764                 length += 32;
 765                 break;
 766         default:
 767                 printk(KERN_ERR "ide-floppy: unsupported page code "
 768                                 "in create_mode_sense_cmd\n");
 769         }
 770         put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
 771         pc->req_xfer = length;
 772 }
 773
 774 static void idefloppy_create_start_stop_cmd(struct ide_atapi_pc *pc, int start)
 775 {
 776         idefloppy_init_pc(pc);
 777         pc->c[0] = GPCMD_START_STOP_UNIT;
 778         pc->c[4] = start;
 779 }
 780
 781 static void idefloppy_create_test_unit_ready_cmd(struct ide_atapi_pc *pc)
 782 {
 783         idefloppy_init_pc(pc);
 784         pc->c[0] = GPCMD_TEST_UNIT_READY;
 785 }
 786
 787 static void idefloppy_create_rw_cmd(idefloppy_floppy_t *floppy,
 788                                     struct ide_atapi_pc *pc, struct request *rq,
 789                                     unsigned long sector)
 790 {
 791         int block = sector / floppy->bs_factor;
 792         int blocks = rq->nr_sectors / floppy->bs_factor;
 793         int cmd = rq_data_dir(rq);
 794
 795         debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
 796                 block, blocks);
 797
 798         idefloppy_init_pc(pc);
 799         pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
 800         put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
 801         put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
 802
 803         pc->idefloppy_callback = &idefloppy_rw_callback;
 804         pc->rq = rq;
 805         pc->b_count = cmd == READ ? 0 : rq->bio->bi_size;
 806         if (rq->cmd_flags & REQ_RW)
 807                 pc->flags |= PC_FLAG_WRITING;
 808         pc->buf = NULL;
 809         pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
 810         pc->flags |= PC_FLAG_DMA_RECOMMENDED;
 811 }
 812
 813 static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
 814                 struct ide_atapi_pc *pc, struct request *rq)
 815 {
 816         idefloppy_init_pc(pc);
 817         pc->idefloppy_callback = &idefloppy_rw_callback;
 818         memcpy(pc->c, rq->cmd, sizeof(pc->c));
 819         pc->rq = rq;
 820         pc->b_count = rq->data_len;
 821         if (rq->data_len && rq_data_dir(rq) == WRITE)
 822                 pc->flags |= PC_FLAG_WRITING;
 823         pc->buf = rq->data;
 824         if (rq->bio)
 825                 pc->flags |= PC_FLAG_DMA_RECOMMENDED;
 826         /*
 827          * possibly problematic, doesn't look like ide-floppy correctly
 828          * handled scattered requests if dma fails...
 829          */
 830         pc->req_xfer = pc->buf_size = rq->data_len;
 831 }
 832
 833 static ide_startstop_t idefloppy_do_request(ide_drive_t *drive,
 834                 struct request *rq, sector_t block_s)
 835 {
 836         idefloppy_floppy_t *floppy = drive->driver_data;
 837         struct ide_atapi_pc *pc;
 838         unsigned long block = (unsigned long)block_s;
 839
 840         debug_log("dev: %s, cmd_type: %x, errors: %d\n",
 841                         rq->rq_disk ? rq->rq_disk->disk_name : "?",
 842                         rq->cmd_type, rq->errors);
 843         debug_log("sector: %ld, nr_sectors: %ld, "
 844                         "current_nr_sectors: %d\n", (long)rq->sector,
 845                         rq->nr_sectors, rq->current_nr_sectors);
 846
 847         if (rq->errors >= ERROR_MAX) {
 848                 if (floppy->failed_pc)
 849                         ide_floppy_report_error(floppy, floppy->failed_pc);
 850                 else
 851                         printk(KERN_ERR "ide-floppy: %s: I/O error\n",
 852                                 drive->name);
 853                 idefloppy_end_request(drive, 0, 0);
 854                 return ide_stopped;
 855         }
 856         if (blk_fs_request(rq)) {
 857                 if (((long)rq->sector % floppy->bs_factor) ||
 858                     (rq->nr_sectors % floppy->bs_factor)) {
 859                         printk(KERN_ERR "%s: unsupported r/w request size\n",
 860                                         drive->name);
 861                         idefloppy_end_request(drive, 0, 0);
 862                         return ide_stopped;
 863                 }
 864                 pc = idefloppy_next_pc_storage(drive);
 865                 idefloppy_create_rw_cmd(floppy, pc, rq, block);
 866         } else if (blk_special_request(rq)) {
 867                 pc = (struct ide_atapi_pc *) rq->buffer;
 868         } else if (blk_pc_request(rq)) {
 869                 pc = idefloppy_next_pc_storage(drive);
 870                 idefloppy_blockpc_cmd(floppy, pc, rq);
 871         } else {
 872                 blk_dump_rq_flags(rq,
 873                         "ide-floppy: unsupported command in queue");
 874                 idefloppy_end_request(drive, 0, 0);
 875                 return ide_stopped;
 876         }
 877
 878         pc->rq = rq;
 879         return idefloppy_issue_pc(drive, pc);
 880 }
 881
 882 /*
 883  * Add a special packet command request to the tail of the request queue,
 884  * and wait for it to be serviced.
 885  */
 886 static int idefloppy_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
 887 {
 888         struct ide_floppy_obj *floppy = drive->driver_data;
 889         struct request rq;
 890
 891         ide_init_drive_cmd(&rq);
 892         rq.buffer = (char *) pc;
 893         rq.cmd_type = REQ_TYPE_SPECIAL;
 894         rq.rq_disk = floppy->disk;
 895
 896         return ide_do_drive_cmd(drive, &rq, ide_wait);
 897 }
 898
 899 /*
 900  * Look at the flexible disk page parameters. We ignore the CHS capacity
 901  * parameters and use the LBA parameters instead.
 902  */
 903 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive)
 904 {
 905         idefloppy_floppy_t *floppy = drive->driver_data;
 906         struct ide_atapi_pc pc;
 907         u8 *page;
 908         int capacity, lba_capacity;
 909         u16 transfer_rate, sector_size, cyls, rpm;
 910         u8 heads, sectors;
 911
 912         idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE,
 913                                         MODE_SENSE_CURRENT);
 914
 915         if (idefloppy_queue_pc_tail(drive, &pc)) {
 916                 printk(KERN_ERR "ide-floppy: Can't get flexible disk page"
 917                                 " parameters\n");
 918                 return 1;
 919         }
 920         floppy->wp = !!(pc.buf[3] & 0x80);
 921         set_disk_ro(floppy->disk, floppy->wp);
 922         page = &pc.buf[8];
 923
 924         transfer_rate = be16_to_cpu(*(u16 *)&pc.buf[8 + 2]);
 925         sector_size   = be16_to_cpu(*(u16 *)&pc.buf[8 + 6]);
 926         cyls          = be16_to_cpu(*(u16 *)&pc.buf[8 + 8]);
 927         rpm           = be16_to_cpu(*(u16 *)&pc.buf[8 + 28]);
 928         heads         = pc.buf[8 + 4];
 929         sectors       = pc.buf[8 + 5];
 930
 931         capacity = cyls * heads * sectors * sector_size;
 932
 933         if (memcmp(page, &floppy->flexible_disk_page, 32))
 934                 printk(KERN_INFO "%s: %dkB, %d/%d/%d CHS, %d kBps, "
 935                                 "%d sector size, %d rpm\n",
 936                                 drive->name, capacity / 1024, cyls, heads,
 937                                 sectors, transfer_rate / 8, sector_size, rpm);
 938
 939         memcpy(&floppy->flexible_disk_page, page, 32);
 940         drive->bios_cyl = cyls;
 941         drive->bios_head = heads;
 942         drive->bios_sect = sectors;
 943         lba_capacity = floppy->blocks * floppy->block_size;
 944
 945         if (capacity < lba_capacity) {
 946                 printk(KERN_NOTICE "%s: The disk reports a capacity of %d "
 947                         "bytes, but the drive only handles %d\n",
 948                         drive->name, lba_capacity, capacity);
 949                 floppy->blocks = floppy->block_size ?
 950                         capacity / floppy->block_size : 0;
 951         }
 952         return 0;
 953 }
 954
 955 static int idefloppy_get_sfrp_bit(ide_drive_t *drive)
 956 {
 957         idefloppy_floppy_t *floppy = drive->driver_data;
 958         struct ide_atapi_pc pc;
 959
 960         floppy->srfp = 0;
 961         idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_CAPABILITIES_PAGE,
 962                                                  MODE_SENSE_CURRENT);
 963
 964         pc.flags |= PC_FLAG_SUPPRESS_ERROR;
 965         if (idefloppy_queue_pc_tail(drive, &pc))
 966                 return 1;
 967
 968         floppy->srfp = pc.buf[8 + 2] & 0x40;
 969         return (0);
 970 }
 971
 972 /*
 973  * Determine if a media is present in the floppy drive, and if so, its LBA
 974  * capacity.
 975  */
 976 static int ide_floppy_get_capacity(ide_drive_t *drive)
 977 {
 978         idefloppy_floppy_t *floppy = drive->driver_data;
 979         struct ide_atapi_pc pc;
 980         u8 *cap_desc;
 981         u8 header_len, desc_cnt;
 982         int i, rc = 1, blocks, length;
 983
 984         drive->bios_cyl = 0;
 985         drive->bios_head = drive->bios_sect = 0;
 986         floppy->blocks = 0;
 987         floppy->bs_factor = 1;
 988         set_capacity(floppy->disk, 0);
 989
 990         idefloppy_create_read_capacity_cmd(&pc);
 991         if (idefloppy_queue_pc_tail(drive, &pc)) {
 992                 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
 993                 return 1;
 994         }
 995         header_len = pc.buf[3];
 996         cap_desc = &pc.buf[4];
 997         desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
 998
 999         for (i = 0; i < desc_cnt; i++) {
1000                 unsigned int desc_start = 4 + i*8;
1001
1002                 blocks = be32_to_cpu(*(u32 *)&pc.buf[desc_start]);
1003                 length = be16_to_cpu(*(u16 *)&pc.buf[desc_start + 6]);
1004
1005                 debug_log("Descriptor %d: %dkB, %d blocks, %d sector size\n",
1006                                 i, blocks * length / 1024, blocks, length);
1007
1008                 if (i)
1009                         continue;
1010                 /*
1011                  * the code below is valid only for the 1st descriptor, ie i=0
1012                  */
1013
1014                 switch (pc.buf[desc_start + 4] & 0x03) {
1015                 /* Clik! drive returns this instead of CAPACITY_CURRENT */
1016                 case CAPACITY_UNFORMATTED:
1017                         if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE))
1018                                 /*
1019                                  * If it is not a clik drive, break out
1020                                  * (maintains previous driver behaviour)
1021                                  */
1022                                 break;
1023                 case CAPACITY_CURRENT:
1024                         /* Normal Zip/LS-120 disks */
1025                         if (memcmp(cap_desc, &floppy->cap_desc, 8))
1026                                 printk(KERN_INFO "%s: %dkB, %d blocks, %d "
1027                                         "sector size\n", drive->name,
1028                                         blocks * length / 1024, blocks, length);
1029                         memcpy(&floppy->cap_desc, cap_desc, 8);
1030
1031                         if (!length || length % 512) {
1032                                 printk(KERN_NOTICE "%s: %d bytes block size "
1033                                         "not supported\n", drive->name, length);
1034                         } else {
1035                                 floppy->blocks = blocks;
1036                                 floppy->block_size = length;
1037                                 floppy->bs_factor = length / 512;
1038                                 if (floppy->bs_factor != 1)
1039                                         printk(KERN_NOTICE "%s: warning: non "
1040                                                 "512 bytes block size not "
1041                                                 "fully supported\n",
1042                                                 drive->name);
1043                                 rc = 0;
1044                         }
1045                         break;
1046                 case CAPACITY_NO_CARTRIDGE:
1047                         /*
1048                          * This is a KERN_ERR so it appears on screen
1049                          * for the user to see
1050                          */
1051                         printk(KERN_ERR "%s: No disk in drive\n", drive->name);
1052                         break;
1053                 case CAPACITY_INVALID:
1054                         printk(KERN_ERR "%s: Invalid capacity for disk "
1055                                 "in drive\n", drive->name);
1056                         break;
1057                 }
1058                 debug_log("Descriptor 0 Code: %d\n",
1059                           pc.buf[desc_start + 4] & 0x03);
1060         }
1061
1062         /* Clik! disk does not support get_flexible_disk_page */
1063         if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE))
1064                 (void) ide_floppy_get_flexible_disk_page(drive);
1065
1066         set_capacity(floppy->disk, floppy->blocks * floppy->bs_factor);
1067         return rc;
1068 }
1069
1070 /*
1071  * Obtain the list of formattable capacities.
1072  * Very similar to ide_floppy_get_capacity, except that we push the capacity
1073  * descriptors to userland, instead of our own structures.
1074  *
1075  * Userland gives us the following structure:
1076  *
1077  * struct idefloppy_format_capacities {
1078  *      int nformats;
1079  *      struct {
1080  *              int nblocks;
1081  *              int blocksize;
1082  *      } formats[];
1083  * };
1084  *
1085  * userland initializes nformats to the number of allocated formats[] records.
1086  * On exit we set nformats to the number of records we've actually initialized.
1087  */
1088
1089 static int ide_floppy_get_format_capacities(ide_drive_t *drive, int __user *arg)
1090 {
1091         struct ide_atapi_pc pc;
1092         u8 header_len, desc_cnt;
1093         int i, blocks, length, u_array_size, u_index;
1094         int __user *argp;
1095
1096         if (get_user(u_array_size, arg))
1097                 return (-EFAULT);
1098
1099         if (u_array_size <= 0)
1100                 return (-EINVAL);
1101
1102         idefloppy_create_read_capacity_cmd(&pc);
1103         if (idefloppy_queue_pc_tail(drive, &pc)) {
1104                 printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
1105                 return (-EIO);
1106         }
1107         header_len = pc.buf[3];
1108         desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
1109
1110         u_index = 0;
1111         argp = arg + 1;
1112
1113         /*
1114          * We always skip the first capacity descriptor.  That's the current
1115          * capacity.  We are interested in the remaining descriptors, the
1116          * formattable capacities.
1117          */
1118         for (i = 1; i < desc_cnt; i++) {
1119                 unsigned int desc_start = 4 + i*8;
1120
1121                 if (u_index >= u_array_size)
1122                         break;  /* User-supplied buffer too small */
1123
1124                 blocks = be32_to_cpu(*(u32 *)&pc.buf[desc_start]);
1125                 length = be16_to_cpu(*(u16 *)&pc.buf[desc_start + 6]);
1126
1127                 if (put_user(blocks, argp))
1128                         return(-EFAULT);
1129                 ++argp;
1130
1131                 if (put_user(length, argp))
1132                         return (-EFAULT);
1133                 ++argp;
1134
1135                 ++u_index;
1136         }
1137
1138         if (put_user(u_index, arg))
1139                 return (-EFAULT);
1140         return (0);
1141 }
1142
1143 /*
1144  * Get ATAPI_FORMAT_UNIT progress indication.
1145  *
1146  * Userland gives a pointer to an int.  The int is set to a progress
1147  * indicator 0-65536, with 65536=100%.
1148  *
1149  * If the drive does not support format progress indication, we just check
1150  * the dsc bit, and return either 0 or 65536.
1151  */
1152
1153 static int idefloppy_get_format_progress(ide_drive_t *drive, int __user *arg)
1154 {
1155         idefloppy_floppy_t *floppy = drive->driver_data;
1156         struct ide_atapi_pc pc;
1157         int progress_indication = 0x10000;
1158
1159         if (floppy->srfp) {
1160                 idefloppy_create_request_sense_cmd(&pc);
1161                 if (idefloppy_queue_pc_tail(drive, &pc))
1162                         return (-EIO);
1163
1164                 if (floppy->sense_key == 2 &&
1165                     floppy->asc == 4 &&
1166                     floppy->ascq == 4)
1167                         progress_indication = floppy->progress_indication;
1168
1169                 /* Else assume format_unit has finished, and we're at 0x10000 */
1170         } else {
1171                 unsigned long flags;
1172                 u8 stat;
1173
1174                 local_irq_save(flags);
1175                 stat = ide_read_status(drive);
1176                 local_irq_restore(flags);
1177
1178                 progress_indication = ((stat & SEEK_STAT) == 0) ? 0 : 0x10000;
1179         }
1180         if (put_user(progress_indication, arg))
1181                 return (-EFAULT);
1182
1183         return (0);
1184 }
1185
1186 static sector_t idefloppy_capacity(ide_drive_t *drive)
1187 {
1188         idefloppy_floppy_t *floppy = drive->driver_data;
1189         unsigned long capacity = floppy->blocks * floppy->bs_factor;
1190
1191         return capacity;
1192 }
1193
1194 /*
1195  * Check whether we can support a drive, based on the ATAPI IDENTIFY command
1196  * results.
1197  */
1198 static int idefloppy_identify_device(ide_drive_t *drive, struct hd_driveid *id)
1199 {
1200         u8 gcw[2];
1201         u8 device_type, protocol, removable, drq_type, packet_size;
1202
1203         *((u16 *) &gcw) = id->config;
1204
1205         device_type =  gcw[1] & 0x1F;
1206         removable   = (gcw[0] & 0x80) >> 7;
1207         protocol    = (gcw[1] & 0xC0) >> 6;
1208         drq_type    = (gcw[0] & 0x60) >> 5;
1209         packet_size =  gcw[0] & 0x03;
1210
1211 #ifdef CONFIG_PPC
1212         /* kludge for Apple PowerBook internal zip */
1213         if (device_type == 5 &&
1214             !strstr(id->model, "CD-ROM") && strstr(id->model, "ZIP"))
1215                 device_type = 0;
1216 #endif
1217
1218         if (protocol != 2)
1219                 printk(KERN_ERR "ide-floppy: Protocol (0x%02x) is not ATAPI\n",
1220                         protocol);
1221         else if (device_type != 0)
1222                 printk(KERN_ERR "ide-floppy: Device type (0x%02x) is not set "
1223                                 "to floppy\n", device_type);
1224         else if (!removable)
1225                 printk(KERN_ERR "ide-floppy: The removable flag is not set\n");
1226         else if (drq_type == 3)
1227                 printk(KERN_ERR "ide-floppy: Sorry, DRQ type (0x%02x) not "
1228                                 "supported\n", drq_type);
1229         else if (packet_size != 0)
1230                 printk(KERN_ERR "ide-floppy: Packet size (0x%02x) is not 12 "
1231                                 "bytes\n", packet_size);
1232         else
1233                 return 1;
1234         return 0;
1235 }
1236
1237 #ifdef CONFIG_IDE_PROC_FS
1238 static void idefloppy_add_settings(ide_drive_t *drive)
1239 {
1240         idefloppy_floppy_t *floppy = drive->driver_data;
1241
1242         ide_add_setting(drive, "bios_cyl", SETTING_RW, TYPE_INT, 0, 1023, 1, 1,
1243                         &drive->bios_cyl, NULL);
1244         ide_add_setting(drive, "bios_head", SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1245                         &drive->bios_head, NULL);
1246         ide_add_setting(drive, "bios_sect", SETTING_RW, TYPE_BYTE, 0,  63, 1, 1,
1247                         &drive->bios_sect, NULL);
1248         ide_add_setting(drive, "ticks",    SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1249                         &floppy->ticks,  NULL);
1250 }
1251 #else
1252 static inline void idefloppy_add_settings(ide_drive_t *drive) { ; }
1253 #endif
1254
1255 static void idefloppy_setup(ide_drive_t *drive, idefloppy_floppy_t *floppy)
1256 {
1257         u8 gcw[2];
1258
1259         *((u16 *) &gcw) = drive->id->config;
1260         floppy->pc = floppy->pc_stack;
1261
1262         if (((gcw[0] & 0x60) >> 5) == 1)
1263                 floppy->flags |= IDEFLOPPY_FLAG_DRQ_INTERRUPT;
1264         /*
1265          * We used to check revisions here. At this point however I'm giving up.
1266          * Just assume they are all broken, its easier.
1267          *
1268          * The actual reason for the workarounds was likely a driver bug after
1269          * all rather than a firmware bug, and the workaround below used to hide
1270          * it. It should be fixed as of version 1.9, but to be on the safe side
1271          * we'll leave the limitation below for the 2.2.x tree.
1272          */
1273         if (!strncmp(drive->id->model, "IOMEGA ZIP 100 ATAPI", 20)) {
1274                 floppy->flags |= IDEFLOPPY_FLAG_ZIP_DRIVE;
1275                 /* This value will be visible in the /proc/ide/hdx/settings */
1276                 floppy->ticks = IDEFLOPPY_TICKS_DELAY;
1277                 blk_queue_max_sectors(drive->queue, 64);
1278         }
1279
1280         /*
1281          * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
1282          * nasty clicking noises without it, so please don't remove this.
1283          */
1284         if (strncmp(drive->id->model, "IOMEGA Clik!", 11) == 0) {
1285                 blk_queue_max_sectors(drive->queue, 64);
1286                 floppy->flags |= IDEFLOPPY_FLAG_CLIK_DRIVE;
1287         }
1288
1289         (void) ide_floppy_get_capacity(drive);
1290         idefloppy_add_settings(drive);
1291 }
1292
1293 static void ide_floppy_remove(ide_drive_t *drive)
1294 {
1295         idefloppy_floppy_t *floppy = drive->driver_data;
1296         struct gendisk *g = floppy->disk;
1297
1298         ide_proc_unregister_driver(drive, floppy->driver);
1299
1300         del_gendisk(g);
1301
1302         ide_floppy_put(floppy);
1303 }
1304
1305 static void idefloppy_cleanup_obj(struct kref *kref)
1306 {
1307         struct ide_floppy_obj *floppy = to_ide_floppy(kref);
1308         ide_drive_t *drive = floppy->drive;
1309         struct gendisk *g = floppy->disk;
1310
1311         drive->driver_data = NULL;
1312         g->private_data = NULL;
1313         put_disk(g);
1314         kfree(floppy);
1315 }
1316
1317 #ifdef CONFIG_IDE_PROC_FS
1318 static int proc_idefloppy_read_capacity(char *page, char **start, off_t off,
1319                 int count, int *eof, void *data)
1320 {
1321         ide_drive_t*drive = (ide_drive_t *)data;
1322         int len;
1323
1324         len = sprintf(page, "%llu\n", (long long)idefloppy_capacity(drive));
1325         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1326 }
1327
1328 static ide_proc_entry_t idefloppy_proc[] = {
1329         { "capacity",   S_IFREG|S_IRUGO, proc_idefloppy_read_capacity,  NULL },
1330         { "geometry",   S_IFREG|S_IRUGO, proc_ide_read_geometry,        NULL },
1331         { NULL, 0, NULL, NULL }
1332 };
1333 #endif  /* CONFIG_IDE_PROC_FS */
1334
1335 static int ide_floppy_probe(ide_drive_t *);
1336
1337 static ide_driver_t idefloppy_driver = {
1338         .gen_driver = {
1339                 .owner          = THIS_MODULE,
1340                 .name           = "ide-floppy",
1341                 .bus            = &ide_bus_type,
1342         },
1343         .probe                  = ide_floppy_probe,
1344         .remove                 = ide_floppy_remove,
1345         .version                = IDEFLOPPY_VERSION,
1346         .media                  = ide_floppy,
1347         .supports_dsc_overlap   = 0,
1348         .do_request             = idefloppy_do_request,
1349         .end_request            = idefloppy_end_request,
1350         .error                  = __ide_error,
1351         .abort                  = __ide_abort,
1352 #ifdef CONFIG_IDE_PROC_FS
1353         .proc                   = idefloppy_proc,
1354 #endif
1355 };
1356
1357 static int idefloppy_open(struct inode *inode, struct file *filp)
1358 {
1359         struct gendisk *disk = inode->i_bdev->bd_disk;
1360         struct ide_floppy_obj *floppy;
1361         ide_drive_t *drive;
1362         struct ide_atapi_pc pc;
1363         int ret = 0;
1364
1365         debug_log("Reached %s\n", __func__);
1366
1367         floppy = ide_floppy_get(disk);
1368         if (!floppy)
1369                 return -ENXIO;
1370
1371         drive = floppy->drive;
1372
1373         floppy->openers++;
1374
1375         if (floppy->openers == 1) {
1376                 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1377                 /* Just in case */
1378
1379                 idefloppy_create_test_unit_ready_cmd(&pc);
1380                 if (idefloppy_queue_pc_tail(drive, &pc)) {
1381                         idefloppy_create_start_stop_cmd(&pc, 1);
1382                         (void) idefloppy_queue_pc_tail(drive, &pc);
1383                 }
1384
1385                 if (ide_floppy_get_capacity(drive)
1386                    && (filp->f_flags & O_NDELAY) == 0
1387                     /*
1388                      * Allow O_NDELAY to open a drive without a disk, or with an
1389                      * unreadable disk, so that we can get the format capacity
1390                      * of the drive or begin the format - Sam
1391                      */
1392                     ) {
1393                         ret = -EIO;
1394                         goto out_put_floppy;
1395                 }
1396
1397                 if (floppy->wp && (filp->f_mode & 2)) {
1398                         ret = -EROFS;
1399                         goto out_put_floppy;
1400                 }
1401                 floppy->flags |= IDEFLOPPY_FLAG_MEDIA_CHANGED;
1402                 /* IOMEGA Clik! drives do not support lock/unlock commands */
1403                 if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1404                         idefloppy_create_prevent_cmd(&pc, 1);
1405                         (void) idefloppy_queue_pc_tail(drive, &pc);
1406                 }
1407                 check_disk_change(inode->i_bdev);
1408         } else if (floppy->flags & IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS) {
1409                 ret = -EBUSY;
1410                 goto out_put_floppy;
1411         }
1412         return 0;
1413
1414 out_put_floppy:
1415         floppy->openers--;
1416         ide_floppy_put(floppy);
1417         return ret;
1418 }
1419
1420 static int idefloppy_release(struct inode *inode, struct file *filp)
1421 {
1422         struct gendisk *disk = inode->i_bdev->bd_disk;
1423         struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1424         ide_drive_t *drive = floppy->drive;
1425         struct ide_atapi_pc pc;
1426
1427         debug_log("Reached %s\n", __func__);
1428
1429         if (floppy->openers == 1) {
1430                 /* IOMEGA Clik! drives do not support lock/unlock commands */
1431                 if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1432                         idefloppy_create_prevent_cmd(&pc, 0);
1433                         (void) idefloppy_queue_pc_tail(drive, &pc);
1434                 }
1435
1436                 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1437         }
1438
1439         floppy->openers--;
1440
1441         ide_floppy_put(floppy);
1442
1443         return 0;
1444 }
1445
1446 static int idefloppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1447 {
1448         struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1449         ide_drive_t *drive = floppy->drive;
1450
1451         geo->heads = drive->bios_head;
1452         geo->sectors = drive->bios_sect;
1453         geo->cylinders = (u16)drive->bios_cyl; /* truncate */
1454         return 0;
1455 }
1456
1457 static int ide_floppy_lockdoor(idefloppy_floppy_t *floppy,
1458                 struct ide_atapi_pc *pc, unsigned long arg, unsigned int cmd)
1459 {
1460         if (floppy->openers > 1)
1461                 return -EBUSY;
1462
1463         /* The IOMEGA Clik! Drive doesn't support this command -
1464          * no room for an eject mechanism */
1465         if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1466                 int prevent = arg ? 1 : 0;
1467
1468                 if (cmd == CDROMEJECT)
1469                         prevent = 0;
1470
1471                 idefloppy_create_prevent_cmd(pc, prevent);
1472                 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1473         }
1474
1475         if (cmd == CDROMEJECT) {
1476                 idefloppy_create_start_stop_cmd(pc, 2);
1477                 (void) idefloppy_queue_pc_tail(floppy->drive, pc);
1478         }
1479
1480         return 0;
1481 }
1482
1483 static int ide_floppy_format_unit(idefloppy_floppy_t *floppy,
1484                                   int __user *arg)
1485 {
1486         int blocks, length, flags, err = 0;
1487         struct ide_atapi_pc pc;
1488
1489         if (floppy->openers > 1) {
1490                 /* Don't format if someone is using the disk */
1491                 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1492                 return -EBUSY;
1493         }
1494
1495         floppy->flags |= IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1496
1497         /*
1498          * Send ATAPI_FORMAT_UNIT to the drive.
1499          *
1500          * Userland gives us the following structure:
1501          *
1502          * struct idefloppy_format_command {
1503          *        int nblocks;
1504          *        int blocksize;
1505          *        int flags;
1506          *        } ;
1507          *
1508          * flags is a bitmask, currently, the only defined flag is:
1509          *
1510          *        0x01 - verify media after format.
1511          */
1512         if (get_user(blocks, arg) ||
1513                         get_user(length, arg+1) ||
1514                         get_user(flags, arg+2)) {
1515                 err = -EFAULT;
1516                 goto out;
1517         }
1518
1519         (void) idefloppy_get_sfrp_bit(floppy->drive);
1520         idefloppy_create_format_unit_cmd(&pc, blocks, length, flags);
1521
1522         if (idefloppy_queue_pc_tail(floppy->drive, &pc))
1523                 err = -EIO;
1524
1525 out:
1526         if (err)
1527                 floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1528         return err;
1529 }
1530
1531
1532 static int idefloppy_ioctl(struct inode *inode, struct file *file,
1533                         unsigned int cmd, unsigned long arg)
1534 {
1535         struct block_device *bdev = inode->i_bdev;
1536         struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1537         ide_drive_t *drive = floppy->drive;
1538         struct ide_atapi_pc pc;
1539         void __user *argp = (void __user *)arg;
1540         int err;
1541
1542         switch (cmd) {
1543         case CDROMEJECT:
1544                 /* fall through */
1545         case CDROM_LOCKDOOR:
1546                 return ide_floppy_lockdoor(floppy, &pc, arg, cmd);
1547         case IDEFLOPPY_IOCTL_FORMAT_SUPPORTED:
1548                 return 0;
1549         case IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY:
1550                 return ide_floppy_get_format_capacities(drive, argp);
1551         case IDEFLOPPY_IOCTL_FORMAT_START:
1552                 if (!(file->f_mode & 2))
1553                         return -EPERM;
1554
1555                 return ide_floppy_format_unit(floppy, (int __user *)arg);
1556         case IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS:
1557                 return idefloppy_get_format_progress(drive, argp);
1558         }
1559
1560         /*
1561          * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
1562          * and CDROM_SEND_PACKET (legacy) ioctls
1563          */
1564         if (cmd != CDROM_SEND_PACKET && cmd != SCSI_IOCTL_SEND_COMMAND)
1565                 err = scsi_cmd_ioctl(file, bdev->bd_disk->queue,
1566                                         bdev->bd_disk, cmd, argp);
1567         else
1568                 err = -ENOTTY;
1569
1570         if (err == -ENOTTY)
1571                 err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
1572
1573         return err;
1574 }
1575
1576 static int idefloppy_media_changed(struct gendisk *disk)
1577 {
1578         struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1579         ide_drive_t *drive = floppy->drive;
1580         int ret;
1581
1582         /* do not scan partitions twice if this is a removable device */
1583         if (drive->attach) {
1584                 drive->attach = 0;
1585                 return 0;
1586         }
1587         ret = !!(floppy->flags & IDEFLOPPY_FLAG_MEDIA_CHANGED);
1588         floppy->flags &= ~IDEFLOPPY_FLAG_MEDIA_CHANGED;
1589         return ret;
1590 }
1591
1592 static int idefloppy_revalidate_disk(struct gendisk *disk)
1593 {
1594         struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1595         set_capacity(disk, idefloppy_capacity(floppy->drive));
1596         return 0;
1597 }
1598
1599 static struct block_device_operations idefloppy_ops = {
1600         .owner                  = THIS_MODULE,
1601         .open                   = idefloppy_open,
1602         .release                = idefloppy_release,
1603         .ioctl                  = idefloppy_ioctl,
1604         .getgeo                 = idefloppy_getgeo,
1605         .media_changed          = idefloppy_media_changed,
1606         .revalidate_disk        = idefloppy_revalidate_disk
1607 };
1608
1609 static int ide_floppy_probe(ide_drive_t *drive)
1610 {
1611         idefloppy_floppy_t *floppy;
1612         struct gendisk *g;
1613
1614         if (!strstr("ide-floppy", drive->driver_req))
1615                 goto failed;
1616         if (!drive->present)
1617                 goto failed;
1618         if (drive->media != ide_floppy)
1619                 goto failed;
1620         if (!idefloppy_identify_device(drive, drive->id)) {
1621                 printk(KERN_ERR "ide-floppy: %s: not supported by this version"
1622                                 " of ide-floppy\n", drive->name);
1623                 goto failed;
1624         }
1625         if (drive->scsi) {
1626                 printk(KERN_INFO "ide-floppy: passing drive %s to ide-scsi"
1627                                 " emulation.\n", drive->name);
1628                 goto failed;
1629         }
1630         floppy = kzalloc(sizeof(idefloppy_floppy_t), GFP_KERNEL);
1631         if (!floppy) {
1632                 printk(KERN_ERR "ide-floppy: %s: Can't allocate a floppy"
1633                                 " structure\n", drive->name);
1634                 goto failed;
1635         }
1636
1637         g = alloc_disk(1 << PARTN_BITS);
1638         if (!g)
1639                 goto out_free_floppy;
1640
1641         ide_init_disk(g, drive);
1642
1643         ide_proc_register_driver(drive, &idefloppy_driver);
1644
1645         kref_init(&floppy->kref);
1646
1647         floppy->drive = drive;
1648         floppy->driver = &idefloppy_driver;
1649         floppy->disk = g;
1650
1651         g->private_data = &floppy->driver;
1652
1653         drive->driver_data = floppy;
1654
1655         idefloppy_setup(drive, floppy);
1656
1657         g->minors = 1 << PARTN_BITS;
1658         g->driverfs_dev = &drive->gendev;
1659         g->flags = drive->removable ? GENHD_FL_REMOVABLE : 0;
1660         g->fops = &idefloppy_ops;
1661         drive->attach = 1;
1662         add_disk(g);
1663         return 0;
1664
1665 out_free_floppy:
1666         kfree(floppy);
1667 failed:
1668         return -ENODEV;
1669 }
1670
1671 static void __exit idefloppy_exit(void)
1672 {
1673         driver_unregister(&idefloppy_driver.gen_driver);
1674 }
1675
1676 static int __init idefloppy_init(void)
1677 {
1678         printk("ide-floppy driver " IDEFLOPPY_VERSION "\n");
1679         return driver_register(&idefloppy_driver.gen_driver);
1680 }
1681
1682 MODULE_ALIAS("ide:*m-floppy*");
1683 module_init(idefloppy_init);
1684 module_exit(idefloppy_exit);
1685 MODULE_LICENSE("GPL");
1686 MODULE_DESCRIPTION("ATAPI FLOPPY Driver");
1687