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