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