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