On Tue, Nov 06, 2007 at 02:33:53AM -0800, akpm@linux-foundation.org wrote:
[mmotm.git] / drivers / ide / ide-floppy.c
blobfefbdfc8db068868afe0dadb0914a948219ea824
1 /*
2 * IDE ATAPI floppy driver.
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
8 * This driver supports the following IDE floppy drives:
10 * LS-120/240 SuperDisk
11 * Iomega Zip 100/250
12 * Iomega PC Card Clik!/PocketZip
14 * For a historical changelog see
15 * Documentation/ide/ChangeLog.ide-floppy.1996-2002
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>
36 #include <scsi/scsi_ioctl.h>
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>
44 #include "ide-floppy.h"
47 * After each failed packet command we issue a request sense command and retry
48 * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
50 #define IDEFLOPPY_MAX_PC_RETRIES 3
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
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.
62 #define IDEFLOPPY_PC_DELAY (HZ/20) /* default delay for ZIP 100 (50ms) */
64 static int ide_floppy_callback(ide_drive_t *drive, int dsc)
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;
71 ide_debug_log(IDE_DBG_FUNC, "enter");
73 if (drive->failed_pc == pc)
74 drive->failed_pc = NULL;
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) {
81 u8 *buf = bio_data(rq->bio);
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;
90 if (drive->failed_pc)
91 ide_debug_log(IDE_DBG_PC, "pc = %x",
92 drive->failed_pc->c[0]);
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");
102 if (blk_special_request(rq))
103 rq->errors = uptodate ? 0 : IDE_DRV_ERROR_GENERAL;
105 return uptodate;
108 static void ide_floppy_report_error(struct ide_disk_obj *floppy,
109 struct ide_atapi_pc *pc)
111 /* supress error messages resulting from Medium not present */
112 if (floppy->sense_key == 0x02 &&
113 floppy->asc == 0x3a &&
114 floppy->ascq == 0x00)
115 return;
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);
124 static ide_startstop_t ide_floppy_issue_pc(ide_drive_t *drive,
125 struct ide_cmd *cmd,
126 struct ide_atapi_pc *pc)
128 struct ide_disk_obj *floppy = drive->driver_data;
130 if (drive->failed_pc == NULL &&
131 pc->c[0] != GPCMD_REQUEST_SENSE)
132 drive->failed_pc = pc;
134 /* Set the current packet command */
135 drive->pc = pc;
137 if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
138 unsigned int done = blk_rq_bytes(drive->hwif->rq);
140 if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
141 ide_floppy_report_error(floppy, pc);
143 /* Giving up */
144 pc->error = IDE_DRV_ERROR_GENERAL;
146 drive->failed_pc = NULL;
147 drive->pc_callback(drive, 0);
148 ide_complete_rq(drive, -EIO, done);
149 return ide_stopped;
152 ide_debug_log(IDE_DBG_FUNC, "retry #%d", pc->retries);
154 pc->retries++;
156 return ide_issue_pc(drive, cmd);
159 void ide_floppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
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;
168 /* A mode sense command is used to "sense" floppy parameters. */
169 void ide_floppy_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
171 u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
173 ide_init_pc(pc);
174 pc->c[0] = GPCMD_MODE_SENSE_10;
175 pc->c[1] = 0;
176 pc->c[2] = page_code;
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__);
188 put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
189 pc->req_xfer = length;
192 static void idefloppy_create_rw_cmd(ide_drive_t *drive,
193 struct ide_atapi_pc *pc, struct request *rq,
194 unsigned long sector)
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);
201 ide_debug_log(IDE_DBG_FUNC, "block: %d, blocks: %d", block, blocks);
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]);
208 memcpy(rq->cmd, pc->c, 12);
210 pc->rq = rq;
211 if (rq->cmd_flags & REQ_RW)
212 pc->flags |= PC_FLAG_WRITING;
214 pc->flags |= PC_FLAG_DMA_OK;
217 static void idefloppy_blockpc_cmd(struct ide_disk_obj *floppy,
218 struct ide_atapi_pc *pc, struct request *rq)
220 ide_init_pc(pc);
221 memcpy(pc->c, 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;
230 static ide_startstop_t ide_floppy_do_request(ide_drive_t *drive,
231 struct request *rq, sector_t block)
233 struct ide_disk_obj *floppy = drive->driver_data;
234 struct ide_cmd cmd;
235 struct ide_atapi_pc *pc;
237 ide_debug_log(IDE_DBG_FUNC, "enter, cmd: 0x%x\n", rq->cmd[0]);
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?"));
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);
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;
258 if (blk_fs_request(rq)) {
259 if (((long)blk_rq_pos(rq) % floppy->bs_factor) ||
260 (blk_rq_sectors(rq) % floppy->bs_factor)) {
261 printk(KERN_ERR PFX "%s: unsupported r/w rq size\n",
262 drive->name);
263 goto out_end;
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 BUG();
275 ide_prep_sense(drive, rq);
277 memset(&cmd, 0, sizeof(cmd));
279 if (rq_data_dir(rq))
280 cmd.tf_flags |= IDE_TFLAG_WRITE;
282 cmd.rq = rq;
284 if (blk_fs_request(rq) || blk_rq_bytes(rq)) {
285 ide_init_sg_cmd(&cmd, blk_rq_bytes(rq));
286 ide_map_sg(drive, &cmd);
289 pc->rq = rq;
291 return ide_floppy_issue_pc(drive, &cmd, pc);
292 out_end:
293 drive->failed_pc = NULL;
294 if (blk_fs_request(rq) == 0 && rq->errors == 0)
295 rq->errors = -EIO;
296 ide_complete_rq(drive, -EIO, blk_rq_bytes(rq));
297 return ide_stopped;
301 * Look at the flexible disk page parameters. We ignore the CHS capacity
302 * parameters and use the LBA parameters instead.
304 static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive,
305 struct ide_atapi_pc *pc)
307 struct ide_disk_obj *floppy = drive->driver_data;
308 struct gendisk *disk = floppy->disk;
309 u8 *page, buf[40];
310 int capacity, lba_capacity;
311 u16 transfer_rate, sector_size, cyls, rpm;
312 u8 heads, sectors;
314 ide_floppy_create_mode_sense_cmd(pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE);
316 if (ide_queue_pc_tail(drive, disk, pc, buf, pc->req_xfer)) {
317 printk(KERN_ERR PFX "Can't get flexible disk page params\n");
318 return 1;
321 if (buf[3] & 0x80)
322 drive->dev_flags |= IDE_DFLAG_WP;
323 else
324 drive->dev_flags &= ~IDE_DFLAG_WP;
326 set_disk_ro(disk, !!(drive->dev_flags & IDE_DFLAG_WP));
328 page = &buf[8];
330 transfer_rate = be16_to_cpup((__be16 *)&buf[8 + 2]);
331 sector_size = be16_to_cpup((__be16 *)&buf[8 + 6]);
332 cyls = be16_to_cpup((__be16 *)&buf[8 + 8]);
333 rpm = be16_to_cpup((__be16 *)&buf[8 + 28]);
334 heads = buf[8 + 4];
335 sectors = buf[8 + 5];
337 capacity = cyls * heads * sectors * sector_size;
339 if (memcmp(page, &floppy->flexible_disk_page, 32))
340 printk(KERN_INFO PFX "%s: %dkB, %d/%d/%d CHS, %d kBps, "
341 "%d sector size, %d rpm\n",
342 drive->name, capacity / 1024, cyls, heads,
343 sectors, transfer_rate / 8, sector_size, rpm);
345 memcpy(&floppy->flexible_disk_page, page, 32);
346 drive->bios_cyl = cyls;
347 drive->bios_head = heads;
348 drive->bios_sect = sectors;
349 lba_capacity = floppy->blocks * floppy->block_size;
351 if (capacity < lba_capacity) {
352 printk(KERN_NOTICE PFX "%s: The disk reports a capacity of %d "
353 "bytes, but the drive only handles %d\n",
354 drive->name, lba_capacity, capacity);
355 floppy->blocks = floppy->block_size ?
356 capacity / floppy->block_size : 0;
357 drive->capacity64 = floppy->blocks * floppy->bs_factor;
360 return 0;
364 * Determine if a media is present in the floppy drive, and if so, its LBA
365 * capacity.
367 static int ide_floppy_get_capacity(ide_drive_t *drive)
369 struct ide_disk_obj *floppy = drive->driver_data;
370 struct gendisk *disk = floppy->disk;
371 struct ide_atapi_pc pc;
372 u8 *cap_desc;
373 u8 pc_buf[256], header_len, desc_cnt;
374 int i, rc = 1, blocks, length;
376 ide_debug_log(IDE_DBG_FUNC, "enter");
378 drive->bios_cyl = 0;
379 drive->bios_head = drive->bios_sect = 0;
380 floppy->blocks = 0;
381 floppy->bs_factor = 1;
382 drive->capacity64 = 0;
384 ide_floppy_create_read_capacity_cmd(&pc);
385 if (ide_queue_pc_tail(drive, disk, &pc, pc_buf, pc.req_xfer)) {
386 printk(KERN_ERR PFX "Can't get floppy parameters\n");
387 return 1;
389 header_len = pc_buf[3];
390 cap_desc = &pc_buf[4];
391 desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
393 for (i = 0; i < desc_cnt; i++) {
394 unsigned int desc_start = 4 + i*8;
396 blocks = be32_to_cpup((__be32 *)&pc_buf[desc_start]);
397 length = be16_to_cpup((__be16 *)&pc_buf[desc_start + 6]);
399 ide_debug_log(IDE_DBG_PROBE, "Descriptor %d: %dkB, %d blocks, "
400 "%d sector size",
401 i, blocks * length / 1024,
402 blocks, length);
404 if (i)
405 continue;
407 * the code below is valid only for the 1st descriptor, ie i=0
410 switch (pc_buf[desc_start + 4] & 0x03) {
411 /* Clik! drive returns this instead of CAPACITY_CURRENT */
412 case CAPACITY_UNFORMATTED:
413 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
415 * If it is not a clik drive, break out
416 * (maintains previous driver behaviour)
418 break;
419 case CAPACITY_CURRENT:
420 /* Normal Zip/LS-120 disks */
421 if (memcmp(cap_desc, &floppy->cap_desc, 8))
422 printk(KERN_INFO PFX "%s: %dkB, %d blocks, %d "
423 "sector size\n",
424 drive->name, blocks * length / 1024,
425 blocks, length);
426 memcpy(&floppy->cap_desc, cap_desc, 8);
428 if (!length || length % 512) {
429 printk(KERN_NOTICE PFX "%s: %d bytes block size"
430 " not supported\n", drive->name, length);
431 } else {
432 floppy->blocks = blocks;
433 floppy->block_size = length;
434 floppy->bs_factor = length / 512;
435 if (floppy->bs_factor != 1)
436 printk(KERN_NOTICE PFX "%s: Warning: "
437 "non 512 bytes block size not "
438 "fully supported\n",
439 drive->name);
440 drive->capacity64 =
441 floppy->blocks * floppy->bs_factor;
442 rc = 0;
444 break;
445 case CAPACITY_NO_CARTRIDGE:
447 * This is a KERN_ERR so it appears on screen
448 * for the user to see
450 printk(KERN_ERR PFX "%s: No disk in drive\n",
451 drive->name);
452 break;
453 case CAPACITY_INVALID:
454 printk(KERN_ERR PFX "%s: Invalid capacity for disk "
455 "in drive\n", drive->name);
456 break;
458 ide_debug_log(IDE_DBG_PROBE, "Descriptor 0 Code: %d",
459 pc_buf[desc_start + 4] & 0x03);
462 /* Clik! disk does not support get_flexible_disk_page */
463 if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
464 (void) ide_floppy_get_flexible_disk_page(drive, &pc);
466 return rc;
469 static void ide_floppy_setup(ide_drive_t *drive)
471 struct ide_disk_obj *floppy = drive->driver_data;
472 u16 *id = drive->id;
474 drive->pc_callback = ide_floppy_callback;
477 * We used to check revisions here. At this point however I'm giving up.
478 * Just assume they are all broken, its easier.
480 * The actual reason for the workarounds was likely a driver bug after
481 * all rather than a firmware bug, and the workaround below used to hide
482 * it. It should be fixed as of version 1.9, but to be on the safe side
483 * we'll leave the limitation below for the 2.2.x tree.
485 if (!strncmp((char *)&id[ATA_ID_PROD], "IOMEGA ZIP 100 ATAPI", 20)) {
486 drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE;
487 /* This value will be visible in the /proc/ide/hdx/settings */
488 drive->pc_delay = IDEFLOPPY_PC_DELAY;
489 blk_queue_max_sectors(drive->queue, 64);
493 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
494 * nasty clicking noises without it, so please don't remove this.
496 if (strncmp((char *)&id[ATA_ID_PROD], "IOMEGA Clik!", 11) == 0) {
497 blk_queue_max_sectors(drive->queue, 64);
498 drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE;
499 /* IOMEGA Clik! drives do not support lock/unlock commands */
500 drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING;
503 (void) ide_floppy_get_capacity(drive);
505 ide_proc_register_driver(drive, floppy->driver);
507 drive->dev_flags |= IDE_DFLAG_ATTACH;
510 static void ide_floppy_flush(ide_drive_t *drive)
514 static int ide_floppy_init_media(ide_drive_t *drive, struct gendisk *disk)
516 int ret = 0;
518 if (ide_do_test_unit_ready(drive, disk))
519 ide_do_start_stop(drive, disk, 1);
521 ret = ide_floppy_get_capacity(drive);
523 set_capacity(disk, ide_gd_capacity(drive));
525 return ret;
528 const struct ide_disk_ops ide_atapi_disk_ops = {
529 .check = ide_check_atapi_device,
530 .get_capacity = ide_floppy_get_capacity,
531 .setup = ide_floppy_setup,
532 .flush = ide_floppy_flush,
533 .init_media = ide_floppy_init_media,
534 .set_doorlock = ide_set_media_lock,
535 .do_request = ide_floppy_do_request,
536 .ioctl = ide_floppy_ioctl,