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/cdrom.h> 29#include <linux/ide.h> 30#include <linux/hdreg.h> 31#include <linux/bitops.h> 32#include <linux/mutex.h> 33#include <linux/scatterlist.h> 34 35#include <scsi/scsi_ioctl.h> 36 37#include <asm/byteorder.h> 38#include <linux/irq.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 (rq && rq->cmd_type == REQ_TYPE_BLOCK_PC)) 77 uptodate = 1; 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 (rq->cmd_type == REQ_TYPE_SPECIAL) 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 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, -EIO, 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(rq->cmd, pc->c, 12); 208 209 pc->rq = rq; 210 if (rq->cmd_flags & REQ_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, 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 (rq->errors >= 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 (rq->cmd_type == REQ_TYPE_SPECIAL) { 251 rq->errors = 0; 252 ide_complete_rq(drive, 0, blk_rq_bytes(rq)); 253 return ide_stopped; 254 } else 255 goto out_end; 256 } 257 258 switch (rq->cmd_type) { 259 case REQ_TYPE_FS: 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_TYPE_SPECIAL: 270 case REQ_TYPE_SENSE: 271 pc = (struct ide_atapi_pc *)rq->special; 272 break; 273 case REQ_TYPE_BLOCK_PC: 274 pc = &floppy->queued_pc; 275 idefloppy_blockpc_cmd(floppy, pc, rq); 276 break; 277 default: 278 BUG(); 279 } 280 281 ide_prep_sense(drive, rq); 282 283 memset(&cmd, 0, sizeof(cmd)); 284 285 if (rq_data_dir(rq)) 286 cmd.tf_flags |= IDE_TFLAG_WRITE; 287 288 cmd.rq = rq; 289 290 if (rq->cmd_type == REQ_TYPE_FS || blk_rq_bytes(rq)) { 291 ide_init_sg_cmd(&cmd, blk_rq_bytes(rq)); 292 ide_map_sg(drive, &cmd); 293 } 294 295 pc->rq = rq; 296 297 return ide_floppy_issue_pc(drive, &cmd, pc); 298out_end: 299 drive->failed_pc = NULL; 300 if (rq->cmd_type != REQ_TYPE_FS && rq->errors == 0) 301 rq->errors = -EIO; 302 ide_complete_rq(drive, -EIO, blk_rq_bytes(rq)); 303 return ide_stopped; 304} 305 306/* 307 * Look at the flexible disk page parameters. We ignore the CHS capacity 308 * parameters and use the LBA parameters instead. 309 */ 310static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive, 311 struct ide_atapi_pc *pc) 312{ 313 struct ide_disk_obj *floppy = drive->driver_data; 314 struct gendisk *disk = floppy->disk; 315 u8 *page, buf[40]; 316 int capacity, lba_capacity; 317 u16 transfer_rate, sector_size, cyls, rpm; 318 u8 heads, sectors; 319 320 ide_floppy_create_mode_sense_cmd(pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE); 321 322 if (ide_queue_pc_tail(drive, disk, pc, buf, pc->req_xfer)) { 323 printk(KERN_ERR PFX "Can't get flexible disk page params\n"); 324 return 1; 325 } 326 327 if (buf[3] & 0x80) 328 drive->dev_flags |= IDE_DFLAG_WP; 329 else 330 drive->dev_flags &= ~IDE_DFLAG_WP; 331 332 set_disk_ro(disk, !!(drive->dev_flags & IDE_DFLAG_WP)); 333 334 page = &buf[8]; 335 336 transfer_rate = be16_to_cpup((__be16 *)&buf[8 + 2]); 337 sector_size = be16_to_cpup((__be16 *)&buf[8 + 6]); 338 cyls = be16_to_cpup((__be16 *)&buf[8 + 8]); 339 rpm = be16_to_cpup((__be16 *)&buf[8 + 28]); 340 heads = buf[8 + 4]; 341 sectors = buf[8 + 5]; 342 343 capacity = cyls * heads * sectors * sector_size; 344 345 if (memcmp(page, &floppy->flexible_disk_page, 32)) 346 printk(KERN_INFO PFX "%s: %dkB, %d/%d/%d CHS, %d kBps, " 347 "%d sector size, %d rpm\n", 348 drive->name, capacity / 1024, cyls, heads, 349 sectors, transfer_rate / 8, sector_size, rpm); 350 351 memcpy(&floppy->flexible_disk_page, page, 32); 352 drive->bios_cyl = cyls; 353 drive->bios_head = heads; 354 drive->bios_sect = sectors; 355 lba_capacity = floppy->blocks * floppy->block_size; 356 357 if (capacity < lba_capacity) { 358 printk(KERN_NOTICE PFX "%s: The disk reports a capacity of %d " 359 "bytes, but the drive only handles %d\n", 360 drive->name, lba_capacity, capacity); 361 floppy->blocks = floppy->block_size ? 362 capacity / floppy->block_size : 0; 363 drive->capacity64 = floppy->blocks * floppy->bs_factor; 364 } 365 366 return 0; 367} 368 369/* 370 * Determine if a media is present in the floppy drive, and if so, its LBA 371 * capacity. 372 */ 373static int ide_floppy_get_capacity(ide_drive_t *drive) 374{ 375 struct ide_disk_obj *floppy = drive->driver_data; 376 struct gendisk *disk = floppy->disk; 377 struct ide_atapi_pc pc; 378 u8 *cap_desc; 379 u8 pc_buf[256], header_len, desc_cnt; 380 int i, rc = 1, blocks, length; 381 382 ide_debug_log(IDE_DBG_FUNC, "enter"); 383 384 drive->bios_cyl = 0; 385 drive->bios_head = drive->bios_sect = 0; 386 floppy->blocks = 0; 387 floppy->bs_factor = 1; 388 drive->capacity64 = 0; 389 390 ide_floppy_create_read_capacity_cmd(&pc); 391 if (ide_queue_pc_tail(drive, disk, &pc, pc_buf, pc.req_xfer)) { 392 printk(KERN_ERR PFX "Can't get floppy parameters\n"); 393 return 1; 394 } 395 header_len = pc_buf[3]; 396 cap_desc = &pc_buf[4]; 397 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */ 398 399 for (i = 0; i < desc_cnt; i++) { 400 unsigned int desc_start = 4 + i*8; 401 402 blocks = be32_to_cpup((__be32 *)&pc_buf[desc_start]); 403 length = be16_to_cpup((__be16 *)&pc_buf[desc_start + 6]); 404 405 ide_debug_log(IDE_DBG_PROBE, "Descriptor %d: %dkB, %d blocks, " 406 "%d sector size", 407 i, blocks * length / 1024, 408 blocks, length); 409 410 if (i) 411 continue; 412 /* 413 * the code below is valid only for the 1st descriptor, ie i=0 414 */ 415 416 switch (pc_buf[desc_start + 4] & 0x03) { 417 /* Clik! drive returns this instead of CAPACITY_CURRENT */ 418 case CAPACITY_UNFORMATTED: 419 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) 420 /* 421 * If it is not a clik drive, break out 422 * (maintains previous driver behaviour) 423 */ 424 break; 425 case CAPACITY_CURRENT: 426 /* Normal Zip/LS-120 disks */ 427 if (memcmp(cap_desc, &floppy->cap_desc, 8)) 428 printk(KERN_INFO PFX "%s: %dkB, %d blocks, %d " 429 "sector size\n", 430 drive->name, blocks * length / 1024, 431 blocks, length); 432 memcpy(&floppy->cap_desc, cap_desc, 8); 433 434 if (!length || length % 512) { 435 printk(KERN_NOTICE PFX "%s: %d bytes block size" 436 " not supported\n", drive->name, length); 437 } else { 438 floppy->blocks = blocks; 439 floppy->block_size = length; 440 floppy->bs_factor = length / 512; 441 if (floppy->bs_factor != 1) 442 printk(KERN_NOTICE PFX "%s: Warning: " 443 "non 512 bytes block size not " 444 "fully supported\n", 445 drive->name); 446 drive->capacity64 = 447 floppy->blocks * floppy->bs_factor; 448 rc = 0; 449 } 450 break; 451 case CAPACITY_NO_CARTRIDGE: 452 /* 453 * This is a KERN_ERR so it appears on screen 454 * for the user to see 455 */ 456 printk(KERN_ERR PFX "%s: No disk in drive\n", 457 drive->name); 458 break; 459 case CAPACITY_INVALID: 460 printk(KERN_ERR PFX "%s: Invalid capacity for disk " 461 "in drive\n", drive->name); 462 break; 463 } 464 ide_debug_log(IDE_DBG_PROBE, "Descriptor 0 Code: %d", 465 pc_buf[desc_start + 4] & 0x03); 466 } 467 468 /* Clik! disk does not support get_flexible_disk_page */ 469 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE)) 470 (void) ide_floppy_get_flexible_disk_page(drive, &pc); 471 472 return rc; 473} 474 475static void ide_floppy_setup(ide_drive_t *drive) 476{ 477 struct ide_disk_obj *floppy = drive->driver_data; 478 u16 *id = drive->id; 479 480 drive->pc_callback = ide_floppy_callback; 481 482 if (!strncmp((char *)&id[ATA_ID_PROD], "IOMEGA ZIP 100 ATAPI", 20)) { 483 drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE; 484 /* This value will be visible in the /proc/ide/hdx/settings */ 485 drive->pc_delay = IDEFLOPPY_PC_DELAY; 486 blk_queue_max_hw_sectors(drive->queue, 64); 487 } 488 489 /* 490 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes 491 * nasty clicking noises without it, so please don't remove this. 492 */ 493 if (strncmp((char *)&id[ATA_ID_PROD], "IOMEGA Clik!", 11) == 0) { 494 blk_queue_max_hw_sectors(drive->queue, 64); 495 drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE; 496 /* IOMEGA Clik! drives do not support lock/unlock commands */ 497 drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING; 498 } 499 500 (void) ide_floppy_get_capacity(drive); 501 502 ide_proc_register_driver(drive, floppy->driver); 503 504 drive->dev_flags |= IDE_DFLAG_ATTACH; 505} 506 507static void ide_floppy_flush(ide_drive_t *drive) 508{ 509} 510 511static int ide_floppy_init_media(ide_drive_t *drive, struct gendisk *disk) 512{ 513 int ret = 0; 514 515 if (ide_do_test_unit_ready(drive, disk)) 516 ide_do_start_stop(drive, disk, 1); 517 518 ret = ide_floppy_get_capacity(drive); 519 520 set_capacity(disk, ide_gd_capacity(drive)); 521 522 return ret; 523} 524 525const struct ide_disk_ops ide_atapi_disk_ops = { 526 .check = ide_check_atapi_device, 527 .get_capacity = ide_floppy_get_capacity, 528 .setup = ide_floppy_setup, 529 .flush = ide_floppy_flush, 530 .init_media = ide_floppy_init_media, 531 .set_doorlock = ide_set_media_lock, 532 .do_request = ide_floppy_do_request, 533 .ioctl = ide_floppy_ioctl, 534}; 535