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