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