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