ide-floppy.c revision ea7066afcd590e4663e6dc010f93704164050f48
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 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 (rq && blk_pc_request(rq))) 78 uptodate = 1; /* FIXME */ 79 else if (pc->c[0] == GPCMD_REQUEST_SENSE) { 80 u8 *buf = pc->buf; 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 (blk_special_request(rq)) 102 rq->errors = 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 /* supress 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 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR)) 138 ide_floppy_report_error(floppy, pc); 139 /* Giving up */ 140 pc->error = IDE_DRV_ERROR_GENERAL; 141 142 drive->failed_pc = NULL; 143 drive->pc_callback(drive, 0); 144 ide_complete_rq(drive, -EIO, blk_rq_bytes(drive->hwif->rq)); 145 return ide_stopped; 146 } 147 148 ide_debug_log(IDE_DBG_FUNC, "retry #%d", pc->retries); 149 150 pc->retries++; 151 152 return ide_issue_pc(drive, cmd); 153} 154 155void ide_floppy_create_read_capacity_cmd(struct ide_atapi_pc *pc) 156{ 157 ide_init_pc(pc); 158 pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES; 159 pc->c[7] = 255; 160 pc->c[8] = 255; 161 pc->req_xfer = 255; 162} 163 164/* A mode sense command is used to "sense" floppy parameters. */ 165void ide_floppy_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code) 166{ 167 u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */ 168 169 ide_init_pc(pc); 170 pc->c[0] = GPCMD_MODE_SENSE_10; 171 pc->c[1] = 0; 172 pc->c[2] = page_code; 173 174 switch (page_code) { 175 case IDEFLOPPY_CAPABILITIES_PAGE: 176 length += 12; 177 break; 178 case IDEFLOPPY_FLEXIBLE_DISK_PAGE: 179 length += 32; 180 break; 181 default: 182 printk(KERN_ERR PFX "unsupported page code in %s\n", __func__); 183 } 184 put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]); 185 pc->req_xfer = length; 186} 187 188static void idefloppy_create_rw_cmd(ide_drive_t *drive, 189 struct ide_atapi_pc *pc, struct request *rq, 190 unsigned long sector) 191{ 192 struct ide_disk_obj *floppy = drive->driver_data; 193 int block = sector / floppy->bs_factor; 194 int blocks = rq->nr_sectors / floppy->bs_factor; 195 int cmd = rq_data_dir(rq); 196 197 ide_debug_log(IDE_DBG_FUNC, "block: %d, blocks: %d", block, blocks); 198 199 ide_init_pc(pc); 200 pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10; 201 put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]); 202 put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]); 203 204 memcpy(rq->cmd, pc->c, 12); 205 206 pc->rq = rq; 207 if (rq->cmd_flags & REQ_RW) 208 pc->flags |= PC_FLAG_WRITING; 209 pc->buf = NULL; 210 pc->req_xfer = pc->buf_size = blocks * floppy->block_size; 211 pc->flags |= PC_FLAG_DMA_OK; 212} 213 214static void idefloppy_blockpc_cmd(struct ide_disk_obj *floppy, 215 struct ide_atapi_pc *pc, struct request *rq) 216{ 217 ide_init_pc(pc); 218 memcpy(pc->c, rq->cmd, sizeof(pc->c)); 219 pc->rq = rq; 220 if (rq->data_len) { 221 pc->flags |= PC_FLAG_DMA_OK; 222 if (rq_data_dir(rq) == WRITE) 223 pc->flags |= PC_FLAG_WRITING; 224 } 225 /* pio will be performed by ide_pio_bytes() which handles sg fine */ 226 pc->buf = NULL; 227 pc->req_xfer = pc->buf_size = rq->data_len; 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 (rq->errors >= 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 (blk_special_request(rq)) { 252 rq->errors = 0; 253 ide_complete_rq(drive, 0, blk_rq_bytes(rq)); 254 return ide_stopped; 255 } else 256 goto out_end; 257 } 258 if (blk_fs_request(rq)) { 259 if (((long)rq->sector % floppy->bs_factor) || 260 (rq->nr_sectors % floppy->bs_factor)) { 261 printk(KERN_ERR PFX "%s: unsupported r/w rq size\n", 262 drive->name); 263 goto out_end; 264 } 265 pc = &floppy->queued_pc; 266 idefloppy_create_rw_cmd(drive, pc, rq, (unsigned long)block); 267 } else if (blk_special_request(rq) || blk_sense_request(rq)) { 268 pc = (struct ide_atapi_pc *)rq->special; 269 } else if (blk_pc_request(rq)) { 270 pc = &floppy->queued_pc; 271 idefloppy_blockpc_cmd(floppy, pc, rq); 272 } else { 273 blk_dump_rq_flags(rq, PFX "unsupported command in queue"); 274 goto out_end; 275 } 276 277 ide_prep_sense(drive, rq); 278 279 memset(&cmd, 0, sizeof(cmd)); 280 281 if (rq_data_dir(rq)) 282 cmd.tf_flags |= IDE_TFLAG_WRITE; 283 284 cmd.rq = rq; 285 286 if (blk_fs_request(rq) || pc->req_xfer) { 287 ide_init_sg_cmd(&cmd, pc->req_xfer); 288 ide_map_sg(drive, &cmd); 289 } 290 291 pc->rq = rq; 292 293 return ide_floppy_issue_pc(drive, &cmd, pc); 294out_end: 295 drive->failed_pc = NULL; 296 if (blk_fs_request(rq) == 0 && rq->errors == 0) 297 rq->errors = -EIO; 298 ide_complete_rq(drive, -EIO, ide_rq_bytes(rq)); 299 return ide_stopped; 300} 301 302/* 303 * Look at the flexible disk page parameters. We ignore the CHS capacity 304 * parameters and use the LBA parameters instead. 305 */ 306static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive, 307 struct ide_atapi_pc *pc) 308{ 309 struct ide_disk_obj *floppy = drive->driver_data; 310 struct gendisk *disk = floppy->disk; 311 u8 *page; 312 int capacity, lba_capacity; 313 u16 transfer_rate, sector_size, cyls, rpm; 314 u8 heads, sectors; 315 316 ide_floppy_create_mode_sense_cmd(pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE); 317 318 if (ide_queue_pc_tail(drive, disk, pc)) { 319 printk(KERN_ERR PFX "Can't get flexible disk page params\n"); 320 return 1; 321 } 322 323 if (pc->buf[3] & 0x80) 324 drive->dev_flags |= IDE_DFLAG_WP; 325 else 326 drive->dev_flags &= ~IDE_DFLAG_WP; 327 328 set_disk_ro(disk, !!(drive->dev_flags & IDE_DFLAG_WP)); 329 330 page = &pc->buf[8]; 331 332 transfer_rate = be16_to_cpup((__be16 *)&pc->buf[8 + 2]); 333 sector_size = be16_to_cpup((__be16 *)&pc->buf[8 + 6]); 334 cyls = be16_to_cpup((__be16 *)&pc->buf[8 + 8]); 335 rpm = be16_to_cpup((__be16 *)&pc->buf[8 + 28]); 336 heads = pc->buf[8 + 4]; 337 sectors = pc->buf[8 + 5]; 338 339 capacity = cyls * heads * sectors * sector_size; 340 341 if (memcmp(page, &floppy->flexible_disk_page, 32)) 342 printk(KERN_INFO PFX "%s: %dkB, %d/%d/%d CHS, %d kBps, " 343 "%d sector size, %d rpm\n", 344 drive->name, capacity / 1024, cyls, heads, 345 sectors, transfer_rate / 8, sector_size, rpm); 346 347 memcpy(&floppy->flexible_disk_page, page, 32); 348 drive->bios_cyl = cyls; 349 drive->bios_head = heads; 350 drive->bios_sect = sectors; 351 lba_capacity = floppy->blocks * floppy->block_size; 352 353 if (capacity < lba_capacity) { 354 printk(KERN_NOTICE PFX "%s: The disk reports a capacity of %d " 355 "bytes, but the drive only handles %d\n", 356 drive->name, lba_capacity, capacity); 357 floppy->blocks = floppy->block_size ? 358 capacity / floppy->block_size : 0; 359 drive->capacity64 = floppy->blocks * floppy->bs_factor; 360 } 361 362 return 0; 363} 364 365/* 366 * Determine if a media is present in the floppy drive, and if so, its LBA 367 * capacity. 368 */ 369static int ide_floppy_get_capacity(ide_drive_t *drive) 370{ 371 struct ide_disk_obj *floppy = drive->driver_data; 372 struct gendisk *disk = floppy->disk; 373 struct ide_atapi_pc pc; 374 u8 *cap_desc; 375 u8 pc_buf[256], header_len, desc_cnt; 376 int i, rc = 1, blocks, length; 377 378 ide_debug_log(IDE_DBG_FUNC, "enter"); 379 380 drive->bios_cyl = 0; 381 drive->bios_head = drive->bios_sect = 0; 382 floppy->blocks = 0; 383 floppy->bs_factor = 1; 384 drive->capacity64 = 0; 385 386 ide_floppy_create_read_capacity_cmd(&pc); 387 pc.buf = &pc_buf[0]; 388 pc.buf_size = sizeof(pc_buf); 389 390 if (ide_queue_pc_tail(drive, disk, &pc)) { 391 printk(KERN_ERR PFX "Can't get floppy parameters\n"); 392 return 1; 393 } 394 header_len = pc.buf[3]; 395 cap_desc = &pc.buf[4]; 396 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */ 397 398 for (i = 0; i < desc_cnt; i++) { 399 unsigned int desc_start = 4 + i*8; 400 401 blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]); 402 length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]); 403 404 ide_debug_log(IDE_DBG_PROBE, "Descriptor %d: %dkB, %d blocks, " 405 "%d sector size", 406 i, blocks * length / 1024, 407 blocks, length); 408 409 if (i) 410 continue; 411 /* 412 * the code below is valid only for the 1st descriptor, ie i=0 413 */ 414 415 switch (pc.buf[desc_start + 4] & 0x03) { 416 /* Clik! drive returns this instead of CAPACITY_CURRENT */ 417 case CAPACITY_UNFORMATTED: 418 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) 419 /* 420 * If it is not a clik drive, break out 421 * (maintains previous driver behaviour) 422 */ 423 break; 424 case CAPACITY_CURRENT: 425 /* Normal Zip/LS-120 disks */ 426 if (memcmp(cap_desc, &floppy->cap_desc, 8)) 427 printk(KERN_INFO PFX "%s: %dkB, %d blocks, %d " 428 "sector size\n", 429 drive->name, blocks * length / 1024, 430 blocks, length); 431 memcpy(&floppy->cap_desc, cap_desc, 8); 432 433 if (!length || length % 512) { 434 printk(KERN_NOTICE PFX "%s: %d bytes block size" 435 " not supported\n", drive->name, length); 436 } else { 437 floppy->blocks = blocks; 438 floppy->block_size = length; 439 floppy->bs_factor = length / 512; 440 if (floppy->bs_factor != 1) 441 printk(KERN_NOTICE PFX "%s: Warning: " 442 "non 512 bytes block size not " 443 "fully supported\n", 444 drive->name); 445 drive->capacity64 = 446 floppy->blocks * floppy->bs_factor; 447 rc = 0; 448 } 449 break; 450 case CAPACITY_NO_CARTRIDGE: 451 /* 452 * This is a KERN_ERR so it appears on screen 453 * for the user to see 454 */ 455 printk(KERN_ERR PFX "%s: No disk in drive\n", 456 drive->name); 457 break; 458 case CAPACITY_INVALID: 459 printk(KERN_ERR PFX "%s: Invalid capacity for disk " 460 "in drive\n", drive->name); 461 break; 462 } 463 ide_debug_log(IDE_DBG_PROBE, "Descriptor 0 Code: %d", 464 pc.buf[desc_start + 4] & 0x03); 465 } 466 467 /* Clik! disk does not support get_flexible_disk_page */ 468 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) 469 (void) ide_floppy_get_flexible_disk_page(drive, &pc); 470 471 return rc; 472} 473 474static void ide_floppy_setup(ide_drive_t *drive) 475{ 476 struct ide_disk_obj *floppy = drive->driver_data; 477 u16 *id = drive->id; 478 479 drive->pc_callback = ide_floppy_callback; 480 481 /* 482 * We used to check revisions here. At this point however I'm giving up. 483 * Just assume they are all broken, its easier. 484 * 485 * The actual reason for the workarounds was likely a driver bug after 486 * all rather than a firmware bug, and the workaround below used to hide 487 * it. It should be fixed as of version 1.9, but to be on the safe side 488 * we'll leave the limitation below for the 2.2.x tree. 489 */ 490 if (!strncmp((char *)&id[ATA_ID_PROD], "IOMEGA ZIP 100 ATAPI", 20)) { 491 drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE; 492 /* This value will be visible in the /proc/ide/hdx/settings */ 493 drive->pc_delay = IDEFLOPPY_PC_DELAY; 494 blk_queue_max_sectors(drive->queue, 64); 495 } 496 497 /* 498 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes 499 * nasty clicking noises without it, so please don't remove this. 500 */ 501 if (strncmp((char *)&id[ATA_ID_PROD], "IOMEGA Clik!", 11) == 0) { 502 blk_queue_max_sectors(drive->queue, 64); 503 drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE; 504 /* IOMEGA Clik! drives do not support lock/unlock commands */ 505 drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING; 506 } 507 508 (void) ide_floppy_get_capacity(drive); 509 510 ide_proc_register_driver(drive, floppy->driver); 511 512 drive->dev_flags |= IDE_DFLAG_ATTACH; 513} 514 515static void ide_floppy_flush(ide_drive_t *drive) 516{ 517} 518 519static int ide_floppy_init_media(ide_drive_t *drive, struct gendisk *disk) 520{ 521 int ret = 0; 522 523 if (ide_do_test_unit_ready(drive, disk)) 524 ide_do_start_stop(drive, disk, 1); 525 526 ret = ide_floppy_get_capacity(drive); 527 528 set_capacity(disk, ide_gd_capacity(drive)); 529 530 return ret; 531} 532 533const struct ide_disk_ops ide_atapi_disk_ops = { 534 .check = ide_check_atapi_device, 535 .get_capacity = ide_floppy_get_capacity, 536 .setup = ide_floppy_setup, 537 .flush = ide_floppy_flush, 538 .init_media = ide_floppy_init_media, 539 .set_doorlock = ide_set_media_lock, 540 .do_request = ide_floppy_do_request, 541 .ioctl = ide_floppy_ioctl, 542}; 543