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