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