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