linux/drivers/ide/ide-floppy.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0
   2/*
   3 * IDE ATAPI floppy driver.
   4 *
   5 * Copyright (C) 1996-1999  Gadi Oxman <gadio@netvision.net.il>
   6 * Copyright (C) 2000-2002  Paul Bristow <paul@paulbristow.net>
   7 * Copyright (C) 2005       Bartlomiej Zolnierkiewicz
   8 *
   9 * This driver supports the following IDE floppy drives:
  10 *
  11 * LS-120/240 SuperDisk
  12 * Iomega Zip 100/250
  13 * Iomega PC Card Clik!/PocketZip
  14 *
  15 * For a historical changelog see
  16 * Documentation/ide/ChangeLog.ide-floppy.1996-2002
  17 */
  18
  19#include <linux/types.h>
  20#include <linux/string.h>
  21#include <linux/kernel.h>
  22#include <linux/delay.h>
  23#include <linux/timer.h>
  24#include <linux/mm.h>
  25#include <linux/interrupt.h>
  26#include <linux/major.h>
  27#include <linux/errno.h>
  28#include <linux/genhd.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/uaccess.h>
  40#include <linux/io.h>
  41#include <asm/unaligned.h>
  42
  43#include "ide-floppy.h"
  44
  45/*
  46 * After each failed packet command we issue a request sense command and retry
  47 * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
  48 */
  49#define IDEFLOPPY_MAX_PC_RETRIES        3
  50
  51/* format capacities descriptor codes */
  52#define CAPACITY_INVALID        0x00
  53#define CAPACITY_UNFORMATTED    0x01
  54#define CAPACITY_CURRENT        0x02
  55#define CAPACITY_NO_CARTRIDGE   0x03
  56
  57/*
  58 * The following delay solves a problem with ATAPI Zip 100 drive where BSY bit
  59 * was apparently being deasserted before the unit was ready to receive data.
  60 */
  61#define IDEFLOPPY_PC_DELAY      (HZ/20) /* default delay for ZIP 100 (50ms) */
  62
  63static int ide_floppy_callback(ide_drive_t *drive, int dsc)
  64{
  65        struct ide_disk_obj *floppy = drive->driver_data;
  66        struct ide_atapi_pc *pc = drive->pc;
  67        struct request *rq = pc->rq;
  68        int uptodate = pc->error ? 0 : 1;
  69
  70        ide_debug_log(IDE_DBG_FUNC, "enter");
  71
  72        if (drive->failed_pc == pc)
  73                drive->failed_pc = NULL;
  74
  75        if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
  76            blk_rq_is_scsi(rq))
  77                uptodate = 1; /* FIXME */
  78        else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
  79
  80                u8 *buf = bio_data(rq->bio);
  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 (ata_misc_request(rq))
 102                scsi_req(rq)->result = uptodate ? 0 : IDE_DRV_ERROR_GENERAL;
 103
 104        return uptodate;
 105}
 106
 107static void ide_floppy_report_error(struct ide_disk_obj *floppy,
 108                                    struct ide_atapi_pc *pc)
 109{
 110        /* suppress 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
 123static 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, BLK_STS_IOERR, 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
 158void 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. */
 168void 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
 191static 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(scsi_req(rq)->cmd, pc->c, 12);
 208
 209        pc->rq = rq;
 210        if (cmd == WRITE)
 211                pc->flags |= PC_FLAG_WRITING;
 212
 213        pc->flags |= PC_FLAG_DMA_OK;
 214}
 215
 216static void idefloppy_blockpc_cmd(struct ide_disk_obj *floppy,
 217                struct ide_atapi_pc *pc, struct request *rq)
 218{
 219        ide_init_pc(pc);
 220        memcpy(pc->c, scsi_req(rq)->cmd, sizeof(pc->c));
 221        pc->rq = rq;
 222        if (blk_rq_bytes(rq)) {
 223                pc->flags |= PC_FLAG_DMA_OK;
 224                if (rq_data_dir(rq) == WRITE)
 225                        pc->flags |= PC_FLAG_WRITING;
 226        }
 227}
 228
 229static ide_startstop_t ide_floppy_do_request(ide_drive_t *drive,
 230                                             struct request *rq, sector_t block)
 231{
 232        struct ide_disk_obj *floppy = drive->driver_data;
 233        struct ide_cmd cmd;
 234        struct ide_atapi_pc *pc;
 235
 236        ide_debug_log(IDE_DBG_FUNC, "enter, cmd: 0x%x\n", rq->cmd[0]);
 237
 238        if (drive->debug_mask & IDE_DBG_RQ)
 239                blk_dump_rq_flags(rq, (rq->rq_disk
 240                                        ? rq->rq_disk->disk_name
 241                                        : "dev?"));
 242
 243        if (scsi_req(rq)->result >= ERROR_MAX) {
 244                if (drive->failed_pc) {
 245                        ide_floppy_report_error(floppy, drive->failed_pc);
 246                        drive->failed_pc = NULL;
 247                } else
 248                        printk(KERN_ERR PFX "%s: I/O error\n", drive->name);
 249
 250                if (ata_misc_request(rq)) {
 251                        scsi_req(rq)->result = 0;
 252                        ide_complete_rq(drive, BLK_STS_OK, blk_rq_bytes(rq));
 253                        return ide_stopped;
 254                } else
 255                        goto out_end;
 256        }
 257
 258        switch (req_op(rq)) {
 259        default:
 260                if (((long)blk_rq_pos(rq) % floppy->bs_factor) ||
 261                    (blk_rq_sectors(rq) % floppy->bs_factor)) {
 262                        printk(KERN_ERR PFX "%s: unsupported r/w rq size\n",
 263                                drive->name);
 264                        goto out_end;
 265                }
 266                pc = &floppy->queued_pc;
 267                idefloppy_create_rw_cmd(drive, pc, rq, (unsigned long)block);
 268                break;
 269        case REQ_OP_SCSI_IN:
 270        case REQ_OP_SCSI_OUT:
 271                pc = &floppy->queued_pc;
 272                idefloppy_blockpc_cmd(floppy, pc, rq);
 273                break;
 274        case REQ_OP_DRV_IN:
 275        case REQ_OP_DRV_OUT:
 276                switch (ide_req(rq)->type) {
 277                case ATA_PRIV_MISC:
 278                case ATA_PRIV_SENSE:
 279                        pc = (struct ide_atapi_pc *)ide_req(rq)->special;
 280                        break;
 281                default:
 282                        BUG();
 283                }
 284        }
 285
 286        ide_prep_sense(drive, rq);
 287
 288        memset(&cmd, 0, sizeof(cmd));
 289
 290        if (rq_data_dir(rq))
 291                cmd.tf_flags |= IDE_TFLAG_WRITE;
 292
 293        cmd.rq = rq;
 294
 295        if (!blk_rq_is_passthrough(rq) || blk_rq_bytes(rq)) {
 296                ide_init_sg_cmd(&cmd, blk_rq_bytes(rq));
 297                ide_map_sg(drive, &cmd);
 298        }
 299
 300        pc->rq = rq;
 301
 302        return ide_floppy_issue_pc(drive, &cmd, pc);
 303out_end:
 304        drive->failed_pc = NULL;
 305        if (blk_rq_is_passthrough(rq) && scsi_req(rq)->result == 0)
 306                scsi_req(rq)->result = -EIO;
 307        ide_complete_rq(drive, BLK_STS_IOERR, blk_rq_bytes(rq));
 308        return ide_stopped;
 309}
 310
 311/*
 312 * Look at the flexible disk page parameters. We ignore the CHS capacity
 313 * parameters and use the LBA parameters instead.
 314 */
 315static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive,
 316                                             struct ide_atapi_pc *pc)
 317{
 318        struct ide_disk_obj *floppy = drive->driver_data;
 319        struct gendisk *disk = floppy->disk;
 320        u8 *page, buf[40];
 321        int capacity, lba_capacity;
 322        u16 transfer_rate, sector_size, cyls, rpm;
 323        u8 heads, sectors;
 324
 325        ide_floppy_create_mode_sense_cmd(pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE);
 326
 327        if (ide_queue_pc_tail(drive, disk, pc, buf, pc->req_xfer)) {
 328                printk(KERN_ERR PFX "Can't get flexible disk page params\n");
 329                return 1;
 330        }
 331
 332        if (buf[3] & 0x80)
 333                drive->dev_flags |= IDE_DFLAG_WP;
 334        else
 335                drive->dev_flags &= ~IDE_DFLAG_WP;
 336
 337        set_disk_ro(disk, !!(drive->dev_flags & IDE_DFLAG_WP));
 338
 339        page = &buf[8];
 340
 341        transfer_rate = be16_to_cpup((__be16 *)&buf[8 + 2]);
 342        sector_size   = be16_to_cpup((__be16 *)&buf[8 + 6]);
 343        cyls          = be16_to_cpup((__be16 *)&buf[8 + 8]);
 344        rpm           = be16_to_cpup((__be16 *)&buf[8 + 28]);
 345        heads         = buf[8 + 4];
 346        sectors       = buf[8 + 5];
 347
 348        capacity = cyls * heads * sectors * sector_size;
 349
 350        if (memcmp(page, &floppy->flexible_disk_page, 32))
 351                printk(KERN_INFO PFX "%s: %dkB, %d/%d/%d CHS, %d kBps, "
 352                                "%d sector size, %d rpm\n",
 353                                drive->name, capacity / 1024, cyls, heads,
 354                                sectors, transfer_rate / 8, sector_size, rpm);
 355
 356        memcpy(&floppy->flexible_disk_page, page, 32);
 357        drive->bios_cyl = cyls;
 358        drive->bios_head = heads;
 359        drive->bios_sect = sectors;
 360        lba_capacity = floppy->blocks * floppy->block_size;
 361
 362        if (capacity < lba_capacity) {
 363                printk(KERN_NOTICE PFX "%s: The disk reports a capacity of %d "
 364                        "bytes, but the drive only handles %d\n",
 365                        drive->name, lba_capacity, capacity);
 366                floppy->blocks = floppy->block_size ?
 367                        capacity / floppy->block_size : 0;
 368                drive->capacity64 = floppy->blocks * floppy->bs_factor;
 369        }
 370
 371        return 0;
 372}
 373
 374/*
 375 * Determine if a media is present in the floppy drive, and if so, its LBA
 376 * capacity.
 377 */
 378static int ide_floppy_get_capacity(ide_drive_t *drive)
 379{
 380        struct ide_disk_obj *floppy = drive->driver_data;
 381        struct gendisk *disk = floppy->disk;
 382        struct ide_atapi_pc pc;
 383        u8 *cap_desc;
 384        u8 pc_buf[256], header_len, desc_cnt;
 385        int i, rc = 1, blocks, length;
 386
 387        ide_debug_log(IDE_DBG_FUNC, "enter");
 388
 389        drive->bios_cyl = 0;
 390        drive->bios_head = drive->bios_sect = 0;
 391        floppy->blocks = 0;
 392        floppy->bs_factor = 1;
 393        drive->capacity64 = 0;
 394
 395        ide_floppy_create_read_capacity_cmd(&pc);
 396        if (ide_queue_pc_tail(drive, disk, &pc, pc_buf, pc.req_xfer)) {
 397                printk(KERN_ERR PFX "Can't get floppy parameters\n");
 398                return 1;
 399        }
 400        header_len = pc_buf[3];
 401        cap_desc = &pc_buf[4];
 402        desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
 403
 404        for (i = 0; i < desc_cnt; i++) {
 405                unsigned int desc_start = 4 + i*8;
 406
 407                blocks = be32_to_cpup((__be32 *)&pc_buf[desc_start]);
 408                length = be16_to_cpup((__be16 *)&pc_buf[desc_start + 6]);
 409
 410                ide_debug_log(IDE_DBG_PROBE, "Descriptor %d: %dkB, %d blocks, "
 411                                             "%d sector size",
 412                                             i, blocks * length / 1024,
 413                                             blocks, length);
 414
 415                if (i)
 416                        continue;
 417                /*
 418                 * the code below is valid only for the 1st descriptor, ie i=0
 419                 */
 420
 421                switch (pc_buf[desc_start + 4] & 0x03) {
 422                /* Clik! drive returns this instead of CAPACITY_CURRENT */
 423                case CAPACITY_UNFORMATTED:
 424                        if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
 425                                /*
 426                                 * If it is not a clik drive, break out
 427                                 * (maintains previous driver behaviour)
 428                                 */
 429                                break;
 430                        /* fall through */
 431                case CAPACITY_CURRENT:
 432                        /* Normal Zip/LS-120 disks */
 433                        if (memcmp(cap_desc, &floppy->cap_desc, 8))
 434                                printk(KERN_INFO PFX "%s: %dkB, %d blocks, %d "
 435                                       "sector size\n",
 436                                       drive->name, blocks * length / 1024,
 437                                       blocks, length);
 438                        memcpy(&floppy->cap_desc, cap_desc, 8);
 439
 440                        if (!length || length % 512) {
 441                                printk(KERN_NOTICE PFX "%s: %d bytes block size"
 442                                       " not supported\n", drive->name, length);
 443                        } else {
 444                                floppy->blocks = blocks;
 445                                floppy->block_size = length;
 446                                floppy->bs_factor = length / 512;
 447                                if (floppy->bs_factor != 1)
 448                                        printk(KERN_NOTICE PFX "%s: Warning: "
 449                                               "non 512 bytes block size not "
 450                                               "fully supported\n",
 451                                               drive->name);
 452                                drive->capacity64 =
 453                                        floppy->blocks * floppy->bs_factor;
 454                                rc = 0;
 455                        }
 456                        break;
 457                case CAPACITY_NO_CARTRIDGE:
 458                        /*
 459                         * This is a KERN_ERR so it appears on screen
 460                         * for the user to see
 461                         */
 462                        printk(KERN_ERR PFX "%s: No disk in drive\n",
 463                               drive->name);
 464                        break;
 465                case CAPACITY_INVALID:
 466                        printk(KERN_ERR PFX "%s: Invalid capacity for disk "
 467                                "in drive\n", drive->name);
 468                        break;
 469                }
 470                ide_debug_log(IDE_DBG_PROBE, "Descriptor 0 Code: %d",
 471                                             pc_buf[desc_start + 4] & 0x03);
 472        }
 473
 474        /* Clik! disk does not support get_flexible_disk_page */
 475        if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
 476                (void) ide_floppy_get_flexible_disk_page(drive, &pc);
 477
 478        return rc;
 479}
 480
 481static void ide_floppy_setup(ide_drive_t *drive)
 482{
 483        struct ide_disk_obj *floppy = drive->driver_data;
 484        u16 *id = drive->id;
 485
 486        drive->pc_callback       = ide_floppy_callback;
 487
 488        /*
 489         * We used to check revisions here. At this point however I'm giving up.
 490         * Just assume they are all broken, its easier.
 491         *
 492         * The actual reason for the workarounds was likely a driver bug after
 493         * all rather than a firmware bug, and the workaround below used to hide
 494         * it. It should be fixed as of version 1.9, but to be on the safe side
 495         * we'll leave the limitation below for the 2.2.x tree.
 496         */
 497        if (strstarts((char *)&id[ATA_ID_PROD], "IOMEGA ZIP 100 ATAPI")) {
 498                drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE;
 499                /* This value will be visible in the /proc/ide/hdx/settings */
 500                drive->pc_delay = IDEFLOPPY_PC_DELAY;
 501                blk_queue_max_hw_sectors(drive->queue, 64);
 502        }
 503
 504        /*
 505         * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
 506         * nasty clicking noises without it, so please don't remove this.
 507         */
 508        if (strstarts((char *)&id[ATA_ID_PROD], "IOMEGA Clik!")) {
 509                blk_queue_max_hw_sectors(drive->queue, 64);
 510                drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE;
 511                /* IOMEGA Clik! drives do not support lock/unlock commands */
 512                drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING;
 513        }
 514
 515        (void) ide_floppy_get_capacity(drive);
 516
 517        ide_proc_register_driver(drive, floppy->driver);
 518
 519        drive->dev_flags |= IDE_DFLAG_ATTACH;
 520}
 521
 522static void ide_floppy_flush(ide_drive_t *drive)
 523{
 524}
 525
 526static int ide_floppy_init_media(ide_drive_t *drive, struct gendisk *disk)
 527{
 528        int ret = 0;
 529
 530        if (ide_do_test_unit_ready(drive, disk))
 531                ide_do_start_stop(drive, disk, 1);
 532
 533        ret = ide_floppy_get_capacity(drive);
 534
 535        set_capacity(disk, ide_gd_capacity(drive));
 536
 537        return ret;
 538}
 539
 540const struct ide_disk_ops ide_atapi_disk_ops = {
 541        .check          = ide_check_atapi_device,
 542        .get_capacity   = ide_floppy_get_capacity,
 543        .setup          = ide_floppy_setup,
 544        .flush          = ide_floppy_flush,
 545        .init_media     = ide_floppy_init_media,
 546        .set_doorlock   = ide_set_media_lock,
 547        .do_request     = ide_floppy_do_request,
 548        .ioctl          = ide_floppy_ioctl,
 549};
 550