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 #include <linux/types.h>
  19 #include <linux/string.h>
  20 #include <linux/kernel.h>
  21 #include <linux/delay.h>
  22 #include <linux/timer.h>
  23 #include <linux/mm.h>
  24 #include <linux/interrupt.h>
  25 #include <linux/major.h>
  26 #include <linux/errno.h>
  27 #include <linux/genhd.h>
  28 #include <linux/slab.h>
  29 #include <linux/cdrom.h>
  30 #include <linux/ide.h>
  31 #include <linux/hdreg.h>
  32 #include <linux/bitops.h>
  33 #include <linux/mutex.h>
  34 #include <linux/scatterlist.h>
  35
  36 #include <scsi/scsi_ioctl.h>
  37
  38 #include <asm/byteorder.h>
  39 #include <linux/irq.h>
  40 #include <linux/uaccess.h>
  41 #include <linux/io.h>
  42 #include <asm/unaligned.h>
  43
  44 #include "ide-floppy.h"
  45
  46 /*
  47  * After each failed packet command we issue a request sense command and retry
  48  * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
  49  */
  50 #define IDEFLOPPY_MAX_PC_RETRIES        3
  51
  52 /* format capacities descriptor codes */
  53 #define CAPACITY_INVALID        0x00
  54 #define CAPACITY_UNFORMATTED    0x01
  55 #define CAPACITY_CURRENT        0x02
  56 #define CAPACITY_NO_CARTRIDGE   0x03
  57
  58 /*
  59  * The following delay solves a problem with ATAPI Zip 100 drive where BSY bit
  60  * was apparently being deasserted before the unit was ready to receive data.
  61  */
  62 #define IDEFLOPPY_PC_DELAY      (HZ/20) /* default delay for ZIP 100 (50ms) */
  63
  64 /* Error code returned in rq->errors to the higher part of the driver. */
  65 #define IDEFLOPPY_ERROR_GENERAL         101
  66
  67 /*
  68  * Used to finish servicing a request. For read/write requests, we will call
  69  * ide_end_request to pass to the next buffer.
  70  */
  71 static int ide_floppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
  72 {
  73         struct ide_disk_obj *floppy = drive->driver_data;
  74         struct request *rq = drive->hwif->rq;
  75         int error;
  76
  77         ide_debug_log(IDE_DBG_FUNC, "enter");
  78
  79         switch (uptodate) {
  80         case 0:
  81                 error = IDEFLOPPY_ERROR_GENERAL;
  82                 break;
  83
  84         case 1:
  85                 error = 0;
  86                 break;
  87
  88         default:
  89                 error = uptodate;
  90         }
  91
  92         if (error)
  93                 floppy->failed_pc = NULL;
  94         /* Why does this happen? */
  95         if (!rq)
  96                 return 0;
  97         if (!blk_special_request(rq)) {
  98                 /* our real local end request function */
  99                 ide_end_request(drive, uptodate, nsecs);
 100                 return 0;
 101         }
 102         rq->errors = error;
 103         /* fixme: need to move this local also */
 104         ide_complete_rq(drive, 0);
 105         return 0;
 106 }
 107
 108 static void idefloppy_update_buffers(ide_drive_t *drive,
 109                                 struct ide_atapi_pc *pc)
 110 {
 111         struct request *rq = pc->rq;
 112         struct bio *bio = rq->bio;
 113
 114         while ((bio = rq->bio) != NULL)
 115                 ide_floppy_end_request(drive, 1, 0);
 116 }
 117
 118 static void ide_floppy_callback(ide_drive_t *drive, int dsc)
 119 {
 120         struct ide_disk_obj *floppy = drive->driver_data;
 121         struct ide_atapi_pc *pc = drive->pc;
 122         int uptodate = pc->error ? 0 : 1;
 123
 124         ide_debug_log(IDE_DBG_FUNC, "enter");
 125
 126         if (floppy->failed_pc == pc)
 127                 floppy->failed_pc = NULL;
 128
 129         if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
 130             (pc->rq && blk_pc_request(pc->rq)))
 131                 uptodate = 1; /* FIXME */
 132         else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
 133                 u8 *buf = pc->buf;
 134
 135                 if (!pc->error) {
 136                         floppy->sense_key = buf[2] & 0x0F;
 137                         floppy->asc = buf[12];
 138                         floppy->ascq = buf[13];
 139                         floppy->progress_indication = buf[15] & 0x80 ?
 140                                 (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
 141
 142                         if (floppy->failed_pc)
 143                                 ide_debug_log(IDE_DBG_PC, "pc = %x",
 144                                               floppy->failed_pc->c[0]);
 145
 146                         ide_debug_log(IDE_DBG_SENSE, "sense key = %x, asc = %x,"
 147                                       "ascq = %x", floppy->sense_key,
 148                                       floppy->asc, floppy->ascq);
 149                 } else
 150                         printk(KERN_ERR PFX "Error in REQUEST SENSE itself - "
 151                                "Aborting request!\n");
 152         }
 153
 154         ide_floppy_end_request(drive, uptodate, 0);
 155 }
 156
 157 static void ide_floppy_report_error(struct ide_disk_obj *floppy,
 158                                     struct ide_atapi_pc *pc)
 159 {
 160         /* supress error messages resulting from Medium not present */
 161         if (floppy->sense_key == 0x02 &&
 162             floppy->asc       == 0x3a &&
 163             floppy->ascq      == 0x00)
 164                 return;
 165
 166         printk(KERN_ERR PFX "%s: I/O error, pc = %2x, key = %2x, "
 167                         "asc = %2x, ascq = %2x\n",
 168                         floppy->drive->name, pc->c[0], floppy->sense_key,
 169                         floppy->asc, floppy->ascq);
 170
 171 }
 172
 173 static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
 174                 struct ide_atapi_pc *pc)
 175 {
 176         struct ide_disk_obj *floppy = drive->driver_data;
 177
 178         if (floppy->failed_pc == NULL &&
 179             pc->c[0] != GPCMD_REQUEST_SENSE)
 180                 floppy->failed_pc = pc;
 181
 182         /* Set the current packet command */
 183         drive->pc = pc;
 184
 185         if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
 186                 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
 187                         ide_floppy_report_error(floppy, pc);
 188                 /* Giving up */
 189                 pc->error = IDEFLOPPY_ERROR_GENERAL;
 190
 191                 floppy->failed_pc = NULL;
 192                 drive->pc_callback(drive, 0);
 193                 return ide_stopped;
 194         }
 195
 196         ide_debug_log(IDE_DBG_FUNC, "retry #%d", pc->retries);
 197
 198         pc->retries++;
 199
 200         return ide_issue_pc(drive);
 201 }
 202
 203 void ide_floppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
 204 {
 205         ide_init_pc(pc);
 206         pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
 207         pc->c[7] = 255;
 208         pc->c[8] = 255;
 209         pc->req_xfer = 255;
 210 }
 211
 212 /* A mode sense command is used to "sense" floppy parameters. */
 213 void ide_floppy_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
 214 {
 215         u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
 216
 217         ide_init_pc(pc);
 218         pc->c[0] = GPCMD_MODE_SENSE_10;
 219         pc->c[1] = 0;
 220         pc->c[2] = page_code;
 221
 222         switch (page_code) {
 223         case IDEFLOPPY_CAPABILITIES_PAGE:
 224                 length += 12;
 225                 break;
 226         case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
 227                 length += 32;
 228                 break;
 229         default:
 230                 printk(KERN_ERR PFX "unsupported page code in %s\n", __func__);
 231         }
 232         put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
 233         pc->req_xfer = length;
 234 }
 235
 236 static void idefloppy_create_rw_cmd(ide_drive_t *drive,
 237                                     struct ide_atapi_pc *pc, struct request *rq,
 238                                     unsigned long sector)
 239 {
 240         struct ide_disk_obj *floppy = drive->driver_data;
 241         int block = sector / floppy->bs_factor;
 242         int blocks = rq->nr_sectors / floppy->bs_factor;
 243         int cmd = rq_data_dir(rq);
 244
 245         ide_debug_log(IDE_DBG_FUNC, "block: %d, blocks: %d", block, blocks);
 246
 247         ide_init_pc(pc);
 248         pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
 249         put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
 250         put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
 251
 252         memcpy(rq->cmd, pc->c, 12);
 253
 254         pc->rq = rq;
 255         pc->b_count = 0;
 256         if (rq->cmd_flags & REQ_RW)
 257                 pc->flags |= PC_FLAG_WRITING;
 258         pc->buf = NULL;
 259         pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
 260         pc->flags |= PC_FLAG_DMA_OK;
 261 }
 262
 263 static void idefloppy_blockpc_cmd(struct ide_disk_obj *floppy,
 264                 struct ide_atapi_pc *pc, struct request *rq)
 265 {
 266         ide_init_pc(pc);
 267         memcpy(pc->c, rq->cmd, sizeof(pc->c));
 268         pc->rq = rq;
 269         pc->b_count = 0;
 270         if (rq->data_len && rq_data_dir(rq) == WRITE)
 271                 pc->flags |= PC_FLAG_WRITING;
 272         pc->buf = rq->data;
 273         if (rq->bio)
 274                 pc->flags |= PC_FLAG_DMA_OK;
 275         /*
 276          * possibly problematic, doesn't look like ide-floppy correctly
 277          * handled scattered requests if dma fails...
 278          */
 279         pc->req_xfer = pc->buf_size = rq->data_len;
 280 }
 281
 282 static ide_startstop_t ide_floppy_do_request(ide_drive_t *drive,
 283                                              struct request *rq, sector_t block)
 284 {
 285         struct ide_disk_obj *floppy = drive->driver_data;
 286         ide_hwif_t *hwif = drive->hwif;
 287         struct ide_atapi_pc *pc;
 288
 289         if (drive->debug_mask & IDE_DBG_RQ)
 290                 blk_dump_rq_flags(rq, (rq->rq_disk
 291                                         ? rq->rq_disk->disk_name
 292                                         : "dev?"));
 293
 294         if (rq->errors >= ERROR_MAX) {
 295                 if (floppy->failed_pc)
 296                         ide_floppy_report_error(floppy, floppy->failed_pc);
 297                 else
 298                         printk(KERN_ERR PFX "%s: I/O error\n", drive->name);
 299
 300                 ide_floppy_end_request(drive, 0, 0);
 301                 return ide_stopped;
 302         }
 303         if (blk_fs_request(rq)) {
 304                 if (((long)rq->sector % floppy->bs_factor) ||
 305                     (rq->nr_sectors % floppy->bs_factor)) {
 306                         printk(KERN_ERR PFX "%s: unsupported r/w rq size\n",
 307                                 drive->name);
 308                         ide_floppy_end_request(drive, 0, 0);
 309                         return ide_stopped;
 310                 }
 311                 pc = &floppy->queued_pc;
 312                 idefloppy_create_rw_cmd(drive, pc, rq, (unsigned long)block);
 313         } else if (blk_special_request(rq)) {
 314                 pc = (struct ide_atapi_pc *) rq->buffer;
 315         } else if (blk_pc_request(rq)) {
 316                 pc = &floppy->queued_pc;
 317                 idefloppy_blockpc_cmd(floppy, pc, rq);
 318         } else {
 319                 blk_dump_rq_flags(rq, PFX "unsupported command in queue");
 320                 ide_floppy_end_request(drive, 0, 0);
 321                 return ide_stopped;
 322         }
 323
 324         if (blk_fs_request(rq) || pc->req_xfer) {
 325                 ide_init_sg_cmd(drive, rq);
 326                 ide_map_sg(drive, rq);
 327         }
 328
 329         pc->sg = hwif->sg_table;
 330         pc->sg_cnt = hwif->sg_nents;
 331
 332         pc->rq = rq;
 333
 334         return idefloppy_issue_pc(drive, pc);
 335 }
 336
 337 /*
 338  * Look at the flexible disk page parameters. We ignore the CHS capacity
 339  * parameters and use the LBA parameters instead.
 340  */
 341 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive,
 342                                              struct ide_atapi_pc *pc)
 343 {
 344         struct ide_disk_obj *floppy = drive->driver_data;
 345         struct gendisk *disk = floppy->disk;
 346         u8 *page;
 347         int capacity, lba_capacity;
 348         u16 transfer_rate, sector_size, cyls, rpm;
 349         u8 heads, sectors;
 350
 351         ide_floppy_create_mode_sense_cmd(pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE);
 352
 353         if (ide_queue_pc_tail(drive, disk, pc)) {
 354                 printk(KERN_ERR PFX "Can't get flexible disk page params\n");
 355                 return 1;
 356         }
 357
 358         if (pc->buf[3] & 0x80)
 359                 drive->dev_flags |= IDE_DFLAG_WP;
 360         else
 361                 drive->dev_flags &= ~IDE_DFLAG_WP;
 362
 363         set_disk_ro(disk, !!(drive->dev_flags & IDE_DFLAG_WP));
 364
 365         page = &pc->buf[8];
 366
 367         transfer_rate = be16_to_cpup((__be16 *)&pc->buf[8 + 2]);
 368         sector_size   = be16_to_cpup((__be16 *)&pc->buf[8 + 6]);
 369         cyls          = be16_to_cpup((__be16 *)&pc->buf[8 + 8]);
 370         rpm           = be16_to_cpup((__be16 *)&pc->buf[8 + 28]);
 371         heads         = pc->buf[8 + 4];
 372         sectors       = pc->buf[8 + 5];
 373
 374         capacity = cyls * heads * sectors * sector_size;
 375
 376         if (memcmp(page, &floppy->flexible_disk_page, 32))
 377                 printk(KERN_INFO PFX "%s: %dkB, %d/%d/%d CHS, %d kBps, "
 378                                 "%d sector size, %d rpm\n",
 379                                 drive->name, capacity / 1024, cyls, heads,
 380                                 sectors, transfer_rate / 8, sector_size, rpm);
 381
 382         memcpy(&floppy->flexible_disk_page, page, 32);
 383         drive->bios_cyl = cyls;
 384         drive->bios_head = heads;
 385         drive->bios_sect = sectors;
 386         lba_capacity = floppy->blocks * floppy->block_size;
 387
 388         if (capacity < lba_capacity) {
 389                 printk(KERN_NOTICE PFX "%s: The disk reports a capacity of %d "
 390                         "bytes, but the drive only handles %d\n",
 391                         drive->name, lba_capacity, capacity);
 392                 floppy->blocks = floppy->block_size ?
 393                         capacity / floppy->block_size : 0;
 394                 drive->capacity64 = floppy->blocks * floppy->bs_factor;
 395         }
 396
 397         return 0;
 398 }
 399
 400 /*
 401  * Determine if a media is present in the floppy drive, and if so, its LBA
 402  * capacity.
 403  */
 404 static int ide_floppy_get_capacity(ide_drive_t *drive)
 405 {
 406         struct ide_disk_obj *floppy = drive->driver_data;
 407         struct gendisk *disk = floppy->disk;
 408         struct ide_atapi_pc pc;
 409         u8 *cap_desc;
 410         u8 header_len, desc_cnt;
 411         int i, rc = 1, blocks, length;
 412
 413         drive->bios_cyl = 0;
 414         drive->bios_head = drive->bios_sect = 0;
 415         floppy->blocks = 0;
 416         floppy->bs_factor = 1;
 417         drive->capacity64 = 0;
 418
 419         ide_floppy_create_read_capacity_cmd(&pc);
 420         if (ide_queue_pc_tail(drive, disk, &pc)) {
 421                 printk(KERN_ERR PFX "Can't get floppy parameters\n");
 422                 return 1;
 423         }
 424         header_len = pc.buf[3];
 425         cap_desc = &pc.buf[4];
 426         desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
 427
 428         for (i = 0; i < desc_cnt; i++) {
 429                 unsigned int desc_start = 4 + i*8;
 430
 431                 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
 432                 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
 433
 434                 ide_debug_log(IDE_DBG_PROBE, "Descriptor %d: %dkB, %d blocks, "
 435                                              "%d sector size",
 436                                              i, blocks * length / 1024,
 437                                              blocks, length);
 438
 439                 if (i)
 440                         continue;
 441                 /*
 442                  * the code below is valid only for the 1st descriptor, ie i=0
 443                  */
 444
 445                 switch (pc.buf[desc_start + 4] & 0x03) {
 446                 /* Clik! drive returns this instead of CAPACITY_CURRENT */
 447                 case CAPACITY_UNFORMATTED:
 448                         if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
 449                                 /*
 450                                  * If it is not a clik drive, break out
 451                                  * (maintains previous driver behaviour)
 452                                  */
 453                                 break;
 454                 case CAPACITY_CURRENT:
 455                         /* Normal Zip/LS-120 disks */
 456                         if (memcmp(cap_desc, &floppy->cap_desc, 8))
 457                                 printk(KERN_INFO PFX "%s: %dkB, %d blocks, %d "
 458                                        "sector size\n",
 459                                        drive->name, blocks * length / 1024,
 460                                        blocks, length);
 461                         memcpy(&floppy->cap_desc, cap_desc, 8);
 462
 463                         if (!length || length % 512) {
 464                                 printk(KERN_NOTICE PFX "%s: %d bytes block size"
 465                                        " not supported\n", drive->name, length);
 466                         } else {
 467                                 floppy->blocks = blocks;
 468                                 floppy->block_size = length;
 469                                 floppy->bs_factor = length / 512;
 470                                 if (floppy->bs_factor != 1)
 471                                         printk(KERN_NOTICE PFX "%s: Warning: "
 472                                                "non 512 bytes block size not "
 473                                                "fully supported\n",
 474                                                drive->name);
 475                                 drive->capacity64 =
 476                                         floppy->blocks * floppy->bs_factor;
 477                                 rc = 0;
 478                         }
 479                         break;
 480                 case CAPACITY_NO_CARTRIDGE:
 481                         /*
 482                          * This is a KERN_ERR so it appears on screen
 483                          * for the user to see
 484                          */
 485                         printk(KERN_ERR PFX "%s: No disk in drive\n",
 486                                drive->name);
 487                         break;
 488                 case CAPACITY_INVALID:
 489                         printk(KERN_ERR PFX "%s: Invalid capacity for disk "
 490                                 "in drive\n", drive->name);
 491                         break;
 492                 }
 493                 ide_debug_log(IDE_DBG_PROBE, "Descriptor 0 Code: %d",
 494                                              pc.buf[desc_start + 4] & 0x03);
 495         }
 496
 497         /* Clik! disk does not support get_flexible_disk_page */
 498         if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
 499                 (void) ide_floppy_get_flexible_disk_page(drive, &pc);
 500
 501         return rc;
 502 }
 503
 504 static void ide_floppy_setup(ide_drive_t *drive)
 505 {
 506         struct ide_disk_obj *floppy = drive->driver_data;
 507         u16 *id = drive->id;
 508
 509         drive->pc_callback       = ide_floppy_callback;
 510         drive->pc_update_buffers = idefloppy_update_buffers;
 511         drive->pc_io_buffers     = ide_io_buffers;
 512
 513         /*
 514          * We used to check revisions here. At this point however I'm giving up.
 515          * Just assume they are all broken, its easier.
 516          *
 517          * The actual reason for the workarounds was likely a driver bug after
 518          * all rather than a firmware bug, and the workaround below used to hide
 519          * it. It should be fixed as of version 1.9, but to be on the safe side
 520          * we'll leave the limitation below for the 2.2.x tree.
 521          */
 522         if (!strncmp((char *)&id[ATA_ID_PROD], "IOMEGA ZIP 100 ATAPI", 20)) {
 523                 drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE;
 524                 /* This value will be visible in the /proc/ide/hdx/settings */
 525                 drive->pc_delay = IDEFLOPPY_PC_DELAY;
 526                 blk_queue_max_sectors(drive->queue, 64);
 527         }
 528
 529         /*
 530          * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
 531          * nasty clicking noises without it, so please don't remove this.
 532          */
 533         if (strncmp((char *)&id[ATA_ID_PROD], "IOMEGA Clik!", 11) == 0) {
 534                 blk_queue_max_sectors(drive->queue, 64);
 535                 drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE;
 536                 /* IOMEGA Clik! drives do not support lock/unlock commands */
 537                 drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING;
 538         }
 539
 540         (void) ide_floppy_get_capacity(drive);
 541
 542         ide_proc_register_driver(drive, floppy->driver);
 543
 544         drive->dev_flags |= IDE_DFLAG_ATTACH;
 545 }
 546
 547 static void ide_floppy_flush(ide_drive_t *drive)
 548 {
 549 }
 550
 551 static int ide_floppy_init_media(ide_drive_t *drive, struct gendisk *disk)
 552 {
 553         int ret = 0;
 554
 555         if (ide_do_test_unit_ready(drive, disk))
 556                 ide_do_start_stop(drive, disk, 1);
 557
 558         ret = ide_floppy_get_capacity(drive);
 559
 560         set_capacity(disk, ide_gd_capacity(drive));
 561
 562         return ret;
 563 }
 564
 565 const struct ide_disk_ops ide_atapi_disk_ops = {
 566         .check          = ide_check_atapi_device,
 567         .get_capacity   = ide_floppy_get_capacity,
 568         .setup          = ide_floppy_setup,
 569         .flush          = ide_floppy_flush,
 570         .init_media     = ide_floppy_init_media,
 571         .set_doorlock   = ide_set_media_lock,
 572         .do_request     = ide_floppy_do_request,
 573         .end_request    = ide_floppy_end_request,
 574         .ioctl          = ide_floppy_ioctl,
 575 };