drivers/ide/ide-floppy.c

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