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 int ide_floppy_callback(ide_drive_t *drive, int dsc)
  65 {
  66         struct ide_disk_obj *floppy = drive->driver_data;
  67         struct ide_atapi_pc *pc = drive->pc;
  68         struct request *rq = pc->rq;
  69         int uptodate = pc->error ? 0 : 1;
  70
  71         ide_debug_log(IDE_DBG_FUNC, "enter");
  72
  73         if (drive->failed_pc == pc)
  74                 drive->failed_pc = NULL;
  75
  76         if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
  77             (rq && blk_pc_request(rq)))
  78                 uptodate = 1; /* FIXME */
  79         else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
  80                 u8 *buf = pc->buf;
  81
  82                 if (!pc->error) {
  83                         floppy->sense_key = buf[2] & 0x0F;
  84                         floppy->asc = buf[12];
  85                         floppy->ascq = buf[13];
  86                         floppy->progress_indication = buf[15] & 0x80 ?
  87                                 (u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
  88
  89                         if (drive->failed_pc)
  90                                 ide_debug_log(IDE_DBG_PC, "pc = %x",
  91                                               drive->failed_pc->c[0]);
  92
  93                         ide_debug_log(IDE_DBG_SENSE, "sense key = %x, asc = %x,"
  94                                       "ascq = %x", floppy->sense_key,
  95                                       floppy->asc, floppy->ascq);
  96                 } else
  97                         printk(KERN_ERR PFX "Error in REQUEST SENSE itself - "
  98                                "Aborting request!\n");
  99         }
 100
 101         if (blk_special_request(rq))
 102                 rq->errors = uptodate ? 0 : IDE_DRV_ERROR_GENERAL;
 103
 104         return uptodate;
 105 }
 106
 107 static void ide_floppy_report_error(struct ide_disk_obj *floppy,
 108                                     struct ide_atapi_pc *pc)
 109 {
 110         /* supress error messages resulting from Medium not present */
 111         if (floppy->sense_key == 0x02 &&
 112             floppy->asc       == 0x3a &&
 113             floppy->ascq      == 0x00)
 114                 return;
 115
 116         printk(KERN_ERR PFX "%s: I/O error, pc = %2x, key = %2x, "
 117                         "asc = %2x, ascq = %2x\n",
 118                         floppy->drive->name, pc->c[0], floppy->sense_key,
 119                         floppy->asc, floppy->ascq);
 120
 121 }
 122
 123 static ide_startstop_t ide_floppy_issue_pc(ide_drive_t *drive,
 124                                            struct ide_cmd *cmd,
 125                                            struct ide_atapi_pc *pc)
 126 {
 127         struct ide_disk_obj *floppy = drive->driver_data;
 128
 129         if (drive->failed_pc == NULL &&
 130             pc->c[0] != GPCMD_REQUEST_SENSE)
 131                 drive->failed_pc = pc;
 132
 133         /* Set the current packet command */
 134         drive->pc = pc;
 135
 136         if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
 137                 unsigned int done = blk_rq_bytes(drive->hwif->rq);
 138
 139                 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
 140                         ide_floppy_report_error(floppy, pc);
 141
 142                 /* Giving up */
 143                 pc->error = IDE_DRV_ERROR_GENERAL;
 144
 145                 drive->failed_pc = NULL;
 146                 drive->pc_callback(drive, 0);
 147                 ide_complete_rq(drive, -EIO, done);
 148                 return ide_stopped;
 149         }
 150
 151         ide_debug_log(IDE_DBG_FUNC, "retry #%d", pc->retries);
 152
 153         pc->retries++;
 154
 155         return ide_issue_pc(drive, cmd);
 156 }
 157
 158 void ide_floppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
 159 {
 160         ide_init_pc(pc);
 161         pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
 162         pc->c[7] = 255;
 163         pc->c[8] = 255;
 164         pc->req_xfer = 255;
 165 }
 166
 167 /* A mode sense command is used to "sense" floppy parameters. */
 168 void ide_floppy_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
 169 {
 170         u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
 171
 172         ide_init_pc(pc);
 173         pc->c[0] = GPCMD_MODE_SENSE_10;
 174         pc->c[1] = 0;
 175         pc->c[2] = page_code;
 176
 177         switch (page_code) {
 178         case IDEFLOPPY_CAPABILITIES_PAGE:
 179                 length += 12;
 180                 break;
 181         case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
 182                 length += 32;
 183                 break;
 184         default:
 185                 printk(KERN_ERR PFX "unsupported page code in %s\n", __func__);
 186         }
 187         put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
 188         pc->req_xfer = length;
 189 }
 190
 191 static void idefloppy_create_rw_cmd(ide_drive_t *drive,
 192                                     struct ide_atapi_pc *pc, struct request *rq,
 193                                     unsigned long sector)
 194 {
 195         struct ide_disk_obj *floppy = drive->driver_data;
 196         int block = sector / floppy->bs_factor;
 197         int blocks = blk_rq_sectors(rq) / floppy->bs_factor;
 198         int cmd = rq_data_dir(rq);
 199
 200         ide_debug_log(IDE_DBG_FUNC, "block: %d, blocks: %d", block, blocks);
 201
 202         ide_init_pc(pc);
 203         pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
 204         put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
 205         put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
 206
 207         memcpy(rq->cmd, pc->c, 12);
 208
 209         pc->rq = rq;
 210         if (rq->cmd_flags & REQ_RW)
 211                 pc->flags |= PC_FLAG_WRITING;
 212         pc->buf = NULL;
 213         pc->buf_size = blk_rq_bytes(rq);
 214         pc->flags |= PC_FLAG_DMA_OK;
 215 }
 216
 217 static void idefloppy_blockpc_cmd(struct ide_disk_obj *floppy,
 218                 struct ide_atapi_pc *pc, struct request *rq)
 219 {
 220         ide_init_pc(pc);
 221         memcpy(pc->c, rq->cmd, sizeof(pc->c));
 222         pc->rq = rq;
 223         if (blk_rq_bytes(rq)) {
 224                 pc->flags |= PC_FLAG_DMA_OK;
 225                 if (rq_data_dir(rq) == WRITE)
 226                         pc->flags |= PC_FLAG_WRITING;
 227         }
 228         /* pio will be performed by ide_pio_bytes() which handles sg fine */
 229         pc->buf = NULL;
 230         pc->buf_size = blk_rq_bytes(rq);
 231 }
 232
 233 static ide_startstop_t ide_floppy_do_request(ide_drive_t *drive,
 234                                              struct request *rq, sector_t block)
 235 {
 236         struct ide_disk_obj *floppy = drive->driver_data;
 237         struct ide_cmd cmd;
 238         struct ide_atapi_pc *pc;
 239
 240         ide_debug_log(IDE_DBG_FUNC, "enter, cmd: 0x%x\n", rq->cmd[0]);
 241
 242         if (drive->debug_mask & IDE_DBG_RQ)
 243                 blk_dump_rq_flags(rq, (rq->rq_disk
 244                                         ? rq->rq_disk->disk_name
 245                                         : "dev?"));
 246
 247         if (rq->errors >= ERROR_MAX) {
 248                 if (drive->failed_pc) {
 249                         ide_floppy_report_error(floppy, drive->failed_pc);
 250                         drive->failed_pc = NULL;
 251                 } else
 252                         printk(KERN_ERR PFX "%s: I/O error\n", drive->name);
 253
 254                 if (blk_special_request(rq)) {
 255                         rq->errors = 0;
 256                         ide_complete_rq(drive, 0, blk_rq_bytes(rq));
 257                         return ide_stopped;
 258                 } else
 259                         goto out_end;
 260         }
 261         if (blk_fs_request(rq)) {
 262                 if (((long)blk_rq_pos(rq) % floppy->bs_factor) ||
 263                     (blk_rq_sectors(rq) % floppy->bs_factor)) {
 264                         printk(KERN_ERR PFX "%s: unsupported r/w rq size\n",
 265                                 drive->name);
 266                         goto out_end;
 267                 }
 268                 pc = &floppy->queued_pc;
 269                 idefloppy_create_rw_cmd(drive, pc, rq, (unsigned long)block);
 270         } else if (blk_special_request(rq) || blk_sense_request(rq)) {
 271                 pc = (struct ide_atapi_pc *)rq->special;
 272         } else if (blk_pc_request(rq)) {
 273                 pc = &floppy->queued_pc;
 274                 idefloppy_blockpc_cmd(floppy, pc, rq);
 275         } else {
 276                 blk_dump_rq_flags(rq, PFX "unsupported command in queue");
 277                 goto out_end;
 278         }
 279
 280         ide_prep_sense(drive, rq);
 281
 282         memset(&cmd, 0, sizeof(cmd));
 283
 284         if (rq_data_dir(rq))
 285                 cmd.tf_flags |= IDE_TFLAG_WRITE;
 286
 287         cmd.rq = rq;
 288
 289         if (blk_fs_request(rq) || blk_rq_bytes(rq)) {
 290                 ide_init_sg_cmd(&cmd, blk_rq_bytes(rq));
 291                 ide_map_sg(drive, &cmd);
 292         }
 293
 294         pc->rq = rq;
 295
 296         return ide_floppy_issue_pc(drive, &cmd, pc);
 297 out_end:
 298         drive->failed_pc = NULL;
 299         if (blk_fs_request(rq) == 0 && rq->errors == 0)
 300                 rq->errors = -EIO;
 301         ide_complete_rq(drive, -EIO, ide_rq_bytes(rq));
 302         return ide_stopped;
 303 }
 304
 305 /*
 306  * Look at the flexible disk page parameters. We ignore the CHS capacity
 307  * parameters and use the LBA parameters instead.
 308  */
 309 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive,
 310                                              struct ide_atapi_pc *pc)
 311 {
 312         struct ide_disk_obj *floppy = drive->driver_data;
 313         struct gendisk *disk = floppy->disk;
 314         u8 *page;
 315         int capacity, lba_capacity;
 316         u16 transfer_rate, sector_size, cyls, rpm;
 317         u8 heads, sectors;
 318
 319         ide_floppy_create_mode_sense_cmd(pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE);
 320
 321         if (ide_queue_pc_tail(drive, disk, pc, pc->buf, pc->req_xfer)) {
 322                 printk(KERN_ERR PFX "Can't get flexible disk page params\n");
 323                 return 1;
 324         }
 325
 326         if (pc->buf[3] & 0x80)
 327                 drive->dev_flags |= IDE_DFLAG_WP;
 328         else
 329                 drive->dev_flags &= ~IDE_DFLAG_WP;
 330
 331         set_disk_ro(disk, !!(drive->dev_flags & IDE_DFLAG_WP));
 332
 333         page = &pc->buf[8];
 334
 335         transfer_rate = be16_to_cpup((__be16 *)&pc->buf[8 + 2]);
 336         sector_size   = be16_to_cpup((__be16 *)&pc->buf[8 + 6]);
 337         cyls          = be16_to_cpup((__be16 *)&pc->buf[8 + 8]);
 338         rpm           = be16_to_cpup((__be16 *)&pc->buf[8 + 28]);
 339         heads         = pc->buf[8 + 4];
 340         sectors       = pc->buf[8 + 5];
 341
 342         capacity = cyls * heads * sectors * sector_size;
 343
 344         if (memcmp(page, &floppy->flexible_disk_page, 32))
 345                 printk(KERN_INFO PFX "%s: %dkB, %d/%d/%d CHS, %d kBps, "
 346                                 "%d sector size, %d rpm\n",
 347                                 drive->name, capacity / 1024, cyls, heads,
 348                                 sectors, transfer_rate / 8, sector_size, rpm);
 349
 350         memcpy(&floppy->flexible_disk_page, page, 32);
 351         drive->bios_cyl = cyls;
 352         drive->bios_head = heads;
 353         drive->bios_sect = sectors;
 354         lba_capacity = floppy->blocks * floppy->block_size;
 355
 356         if (capacity < lba_capacity) {
 357                 printk(KERN_NOTICE PFX "%s: The disk reports a capacity of %d "
 358                         "bytes, but the drive only handles %d\n",
 359                         drive->name, lba_capacity, capacity);
 360                 floppy->blocks = floppy->block_size ?
 361                         capacity / floppy->block_size : 0;
 362                 drive->capacity64 = floppy->blocks * floppy->bs_factor;
 363         }
 364
 365         return 0;
 366 }
 367
 368 /*
 369  * Determine if a media is present in the floppy drive, and if so, its LBA
 370  * capacity.
 371  */
 372 static int ide_floppy_get_capacity(ide_drive_t *drive)
 373 {
 374         struct ide_disk_obj *floppy = drive->driver_data;
 375         struct gendisk *disk = floppy->disk;
 376         struct ide_atapi_pc pc;
 377         u8 *cap_desc;
 378         u8 pc_buf[256], header_len, desc_cnt;
 379         int i, rc = 1, blocks, length;
 380
 381         ide_debug_log(IDE_DBG_FUNC, "enter");
 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         pc.buf_size = sizeof(pc_buf);
 391
 392         if (ide_queue_pc_tail(drive, disk, &pc, pc_buf, pc.req_xfer)) {
 393                 printk(KERN_ERR PFX "Can't get floppy parameters\n");
 394                 return 1;
 395         }
 396         header_len = pc_buf[3];
 397         cap_desc = &pc_buf[4];
 398         desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
 399
 400         for (i = 0; i < desc_cnt; i++) {
 401                 unsigned int desc_start = 4 + i*8;
 402
 403                 blocks = be32_to_cpup((__be32 *)&pc_buf[desc_start]);
 404                 length = be16_to_cpup((__be16 *)&pc_buf[desc_start + 6]);
 405
 406                 ide_debug_log(IDE_DBG_PROBE, "Descriptor %d: %dkB, %d blocks, "
 407                                              "%d sector size",
 408                                              i, blocks * length / 1024,
 409                                              blocks, length);
 410
 411                 if (i)
 412                         continue;
 413                 /*
 414                  * the code below is valid only for the 1st descriptor, ie i=0
 415                  */
 416
 417                 switch (pc_buf[desc_start + 4] & 0x03) {
 418                 /* Clik! drive returns this instead of CAPACITY_CURRENT */
 419                 case CAPACITY_UNFORMATTED:
 420                         if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
 421                                 /*
 422                                  * If it is not a clik drive, break out
 423                                  * (maintains previous driver behaviour)
 424                                  */
 425                                 break;
 426                 case CAPACITY_CURRENT:
 427                         /* Normal Zip/LS-120 disks */
 428                         if (memcmp(cap_desc, &floppy->cap_desc, 8))
 429                                 printk(KERN_INFO PFX "%s: %dkB, %d blocks, %d "
 430                                        "sector size\n",
 431                                        drive->name, blocks * length / 1024,
 432                                        blocks, length);
 433                         memcpy(&floppy->cap_desc, cap_desc, 8);
 434
 435                         if (!length || length % 512) {
 436                                 printk(KERN_NOTICE PFX "%s: %d bytes block size"
 437                                        " not supported\n", drive->name, length);
 438                         } else {
 439                                 floppy->blocks = blocks;
 440                                 floppy->block_size = length;
 441                                 floppy->bs_factor = length / 512;
 442                                 if (floppy->bs_factor != 1)
 443                                         printk(KERN_NOTICE PFX "%s: Warning: "
 444                                                "non 512 bytes block size not "
 445                                                "fully supported\n",
 446                                                drive->name);
 447                                 drive->capacity64 =
 448                                         floppy->blocks * floppy->bs_factor;
 449                                 rc = 0;
 450                         }
 451                         break;
 452                 case CAPACITY_NO_CARTRIDGE:
 453                         /*
 454                          * This is a KERN_ERR so it appears on screen
 455                          * for the user to see
 456                          */
 457                         printk(KERN_ERR PFX "%s: No disk in drive\n",
 458                                drive->name);
 459                         break;
 460                 case CAPACITY_INVALID:
 461                         printk(KERN_ERR PFX "%s: Invalid capacity for disk "
 462                                 "in drive\n", drive->name);
 463                         break;
 464                 }
 465                 ide_debug_log(IDE_DBG_PROBE, "Descriptor 0 Code: %d",
 466                                              pc_buf[desc_start + 4] & 0x03);
 467         }
 468
 469         /* Clik! disk does not support get_flexible_disk_page */
 470         if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
 471                 (void) ide_floppy_get_flexible_disk_page(drive, &pc);
 472
 473         return rc;
 474 }
 475
 476 static void ide_floppy_setup(ide_drive_t *drive)
 477 {
 478         struct ide_disk_obj *floppy = drive->driver_data;
 479         u16 *id = drive->id;
 480
 481         drive->pc_callback       = ide_floppy_callback;
 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 };