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