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
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>
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>
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 void idefloppy_update_buffers(ide_drive_t
*drive
,
65 struct ide_atapi_pc
*pc
)
67 struct request
*rq
= pc
->rq
;
68 struct bio
*bio
= rq
->bio
;
70 while ((bio
= rq
->bio
) != NULL
)
71 ide_end_request(drive
, 1, 0);
74 static int ide_floppy_callback(ide_drive_t
*drive
, int dsc
)
76 struct ide_disk_obj
*floppy
= drive
->driver_data
;
77 struct ide_atapi_pc
*pc
= drive
->pc
;
78 struct request
*rq
= pc
->rq
;
79 int uptodate
= pc
->error
? 0 : 1;
81 ide_debug_log(IDE_DBG_FUNC
, "enter");
83 if (drive
->failed_pc
== pc
)
84 drive
->failed_pc
= NULL
;
86 if (pc
->c
[0] == GPCMD_READ_10
|| pc
->c
[0] == GPCMD_WRITE_10
||
87 (rq
&& blk_pc_request(rq
)))
88 uptodate
= 1; /* FIXME */
89 else if (pc
->c
[0] == GPCMD_REQUEST_SENSE
) {
93 floppy
->sense_key
= buf
[2] & 0x0F;
94 floppy
->asc
= buf
[12];
95 floppy
->ascq
= buf
[13];
96 floppy
->progress_indication
= buf
[15] & 0x80 ?
97 (u16
)get_unaligned((u16
*)&buf
[16]) : 0x10000;
100 ide_debug_log(IDE_DBG_PC
, "pc = %x",
101 drive
->failed_pc
->c
[0]);
103 ide_debug_log(IDE_DBG_SENSE
, "sense key = %x, asc = %x,"
104 "ascq = %x", floppy
->sense_key
,
105 floppy
->asc
, floppy
->ascq
);
107 printk(KERN_ERR PFX
"Error in REQUEST SENSE itself - "
108 "Aborting request!\n");
111 if (blk_special_request(rq
))
112 rq
->errors
= uptodate
? 0 : IDE_DRV_ERROR_GENERAL
;
117 static void ide_floppy_report_error(struct ide_disk_obj
*floppy
,
118 struct ide_atapi_pc
*pc
)
120 /* supress error messages resulting from Medium not present */
121 if (floppy
->sense_key
== 0x02 &&
122 floppy
->asc
== 0x3a &&
123 floppy
->ascq
== 0x00)
126 printk(KERN_ERR PFX
"%s: I/O error, pc = %2x, key = %2x, "
127 "asc = %2x, ascq = %2x\n",
128 floppy
->drive
->name
, pc
->c
[0], floppy
->sense_key
,
129 floppy
->asc
, floppy
->ascq
);
133 static ide_startstop_t
idefloppy_issue_pc(ide_drive_t
*drive
,
134 struct ide_atapi_pc
*pc
)
136 struct ide_disk_obj
*floppy
= drive
->driver_data
;
138 if (drive
->failed_pc
== NULL
&&
139 pc
->c
[0] != GPCMD_REQUEST_SENSE
)
140 drive
->failed_pc
= pc
;
142 /* Set the current packet command */
145 if (pc
->retries
> IDEFLOPPY_MAX_PC_RETRIES
) {
146 if (!(pc
->flags
& PC_FLAG_SUPPRESS_ERROR
))
147 ide_floppy_report_error(floppy
, pc
);
149 pc
->error
= IDE_DRV_ERROR_GENERAL
;
151 drive
->failed_pc
= NULL
;
152 drive
->pc_callback(drive
, 0);
156 ide_debug_log(IDE_DBG_FUNC
, "retry #%d", pc
->retries
);
160 return ide_issue_pc(drive
);
163 void ide_floppy_create_read_capacity_cmd(struct ide_atapi_pc
*pc
)
166 pc
->c
[0] = GPCMD_READ_FORMAT_CAPACITIES
;
172 /* A mode sense command is used to "sense" floppy parameters. */
173 void ide_floppy_create_mode_sense_cmd(struct ide_atapi_pc
*pc
, u8 page_code
)
175 u16 length
= 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
178 pc
->c
[0] = GPCMD_MODE_SENSE_10
;
180 pc
->c
[2] = page_code
;
183 case IDEFLOPPY_CAPABILITIES_PAGE
:
186 case IDEFLOPPY_FLEXIBLE_DISK_PAGE
:
190 printk(KERN_ERR PFX
"unsupported page code in %s\n", __func__
);
192 put_unaligned(cpu_to_be16(length
), (u16
*) &pc
->c
[7]);
193 pc
->req_xfer
= length
;
196 static void idefloppy_create_rw_cmd(ide_drive_t
*drive
,
197 struct ide_atapi_pc
*pc
, struct request
*rq
,
198 unsigned long sector
)
200 struct ide_disk_obj
*floppy
= drive
->driver_data
;
201 int block
= sector
/ floppy
->bs_factor
;
202 int blocks
= rq
->nr_sectors
/ floppy
->bs_factor
;
203 int cmd
= rq_data_dir(rq
);
205 ide_debug_log(IDE_DBG_FUNC
, "block: %d, blocks: %d", block
, blocks
);
208 pc
->c
[0] = cmd
== READ
? GPCMD_READ_10
: GPCMD_WRITE_10
;
209 put_unaligned(cpu_to_be16(blocks
), (unsigned short *)&pc
->c
[7]);
210 put_unaligned(cpu_to_be32(block
), (unsigned int *) &pc
->c
[2]);
212 memcpy(rq
->cmd
, pc
->c
, 12);
216 if (rq
->cmd_flags
& REQ_RW
)
217 pc
->flags
|= PC_FLAG_WRITING
;
219 pc
->req_xfer
= pc
->buf_size
= blocks
* floppy
->block_size
;
220 pc
->flags
|= PC_FLAG_DMA_OK
;
223 static void idefloppy_blockpc_cmd(struct ide_disk_obj
*floppy
,
224 struct ide_atapi_pc
*pc
, struct request
*rq
)
227 memcpy(pc
->c
, rq
->cmd
, sizeof(pc
->c
));
230 if (rq
->data_len
&& rq_data_dir(rq
) == WRITE
)
231 pc
->flags
|= PC_FLAG_WRITING
;
234 pc
->flags
|= PC_FLAG_DMA_OK
;
236 * possibly problematic, doesn't look like ide-floppy correctly
237 * handled scattered requests if dma fails...
239 pc
->req_xfer
= pc
->buf_size
= rq
->data_len
;
242 static ide_startstop_t
ide_floppy_do_request(ide_drive_t
*drive
,
243 struct request
*rq
, sector_t block
)
245 struct ide_disk_obj
*floppy
= drive
->driver_data
;
246 ide_hwif_t
*hwif
= drive
->hwif
;
247 struct ide_cmd
*cmd
= &hwif
->cmd
;
248 struct ide_atapi_pc
*pc
;
250 if (drive
->debug_mask
& IDE_DBG_RQ
)
251 blk_dump_rq_flags(rq
, (rq
->rq_disk
252 ? rq
->rq_disk
->disk_name
255 if (rq
->errors
>= ERROR_MAX
) {
256 if (drive
->failed_pc
) {
257 ide_floppy_report_error(floppy
, drive
->failed_pc
);
258 drive
->failed_pc
= NULL
;
260 printk(KERN_ERR PFX
"%s: I/O error\n", drive
->name
);
262 if (blk_special_request(rq
)) {
264 ide_complete_rq(drive
, 0);
269 if (blk_fs_request(rq
)) {
270 if (((long)rq
->sector
% floppy
->bs_factor
) ||
271 (rq
->nr_sectors
% floppy
->bs_factor
)) {
272 printk(KERN_ERR PFX
"%s: unsupported r/w rq size\n",
276 pc
= &floppy
->queued_pc
;
277 idefloppy_create_rw_cmd(drive
, pc
, rq
, (unsigned long)block
);
278 } else if (blk_special_request(rq
)) {
279 pc
= (struct ide_atapi_pc
*) rq
->buffer
;
280 } else if (blk_pc_request(rq
)) {
281 pc
= &floppy
->queued_pc
;
282 idefloppy_blockpc_cmd(floppy
, pc
, rq
);
284 blk_dump_rq_flags(rq
, PFX
"unsupported command in queue");
288 if (blk_fs_request(rq
) || pc
->req_xfer
) {
289 ide_init_sg_cmd(cmd
, rq
->nr_sectors
);
290 ide_map_sg(drive
, rq
);
293 pc
->sg
= hwif
->sg_table
;
294 pc
->sg_cnt
= cmd
->sg_nents
;
298 return idefloppy_issue_pc(drive
, pc
);
300 drive
->failed_pc
= NULL
;
301 ide_end_request(drive
, 0, 0);
306 * Look at the flexible disk page parameters. We ignore the CHS capacity
307 * parameters and use the LBA parameters instead.
309 static int ide_floppy_get_flexible_disk_page(ide_drive_t
*drive
,
310 struct ide_atapi_pc
*pc
)
312 struct ide_disk_obj
*floppy
= drive
->driver_data
;
313 struct gendisk
*disk
= floppy
->disk
;
315 int capacity
, lba_capacity
;
316 u16 transfer_rate
, sector_size
, cyls
, rpm
;
319 ide_floppy_create_mode_sense_cmd(pc
, IDEFLOPPY_FLEXIBLE_DISK_PAGE
);
321 if (ide_queue_pc_tail(drive
, disk
, pc
)) {
322 printk(KERN_ERR PFX
"Can't get flexible disk page params\n");
326 if (pc
->buf
[3] & 0x80)
327 drive
->dev_flags
|= IDE_DFLAG_WP
;
329 drive
->dev_flags
&= ~IDE_DFLAG_WP
;
331 set_disk_ro(disk
, !!(drive
->dev_flags
& IDE_DFLAG_WP
));
335 transfer_rate
= be16_to_cpup((__be16
*)&pc
->buf
[8 + 2]);
336 sector_size
= be16_to_cpup((__be16
*)&pc
->buf
[8 + 6]);
337 cyls
= be16_to_cpup((__be16
*)&pc
->buf
[8 + 8]);
338 rpm
= be16_to_cpup((__be16
*)&pc
->buf
[8 + 28]);
339 heads
= pc
->buf
[8 + 4];
340 sectors
= pc
->buf
[8 + 5];
342 capacity
= cyls
* heads
* sectors
* sector_size
;
344 if (memcmp(page
, &floppy
->flexible_disk_page
, 32))
345 printk(KERN_INFO PFX
"%s: %dkB, %d/%d/%d CHS, %d kBps, "
346 "%d sector size, %d rpm\n",
347 drive
->name
, capacity
/ 1024, cyls
, heads
,
348 sectors
, transfer_rate
/ 8, sector_size
, rpm
);
350 memcpy(&floppy
->flexible_disk_page
, page
, 32);
351 drive
->bios_cyl
= cyls
;
352 drive
->bios_head
= heads
;
353 drive
->bios_sect
= sectors
;
354 lba_capacity
= floppy
->blocks
* floppy
->block_size
;
356 if (capacity
< lba_capacity
) {
357 printk(KERN_NOTICE PFX
"%s: The disk reports a capacity of %d "
358 "bytes, but the drive only handles %d\n",
359 drive
->name
, lba_capacity
, capacity
);
360 floppy
->blocks
= floppy
->block_size
?
361 capacity
/ floppy
->block_size
: 0;
362 drive
->capacity64
= floppy
->blocks
* floppy
->bs_factor
;
369 * Determine if a media is present in the floppy drive, and if so, its LBA
372 static int ide_floppy_get_capacity(ide_drive_t
*drive
)
374 struct ide_disk_obj
*floppy
= drive
->driver_data
;
375 struct gendisk
*disk
= floppy
->disk
;
376 struct ide_atapi_pc pc
;
378 u8 header_len
, desc_cnt
;
379 int i
, rc
= 1, blocks
, length
;
382 drive
->bios_head
= drive
->bios_sect
= 0;
384 floppy
->bs_factor
= 1;
385 drive
->capacity64
= 0;
387 ide_floppy_create_read_capacity_cmd(&pc
);
388 if (ide_queue_pc_tail(drive
, disk
, &pc
)) {
389 printk(KERN_ERR PFX
"Can't get floppy parameters\n");
392 header_len
= pc
.buf
[3];
393 cap_desc
= &pc
.buf
[4];
394 desc_cnt
= header_len
/ 8; /* capacity descriptor of 8 bytes */
396 for (i
= 0; i
< desc_cnt
; i
++) {
397 unsigned int desc_start
= 4 + i
*8;
399 blocks
= be32_to_cpup((__be32
*)&pc
.buf
[desc_start
]);
400 length
= be16_to_cpup((__be16
*)&pc
.buf
[desc_start
+ 6]);
402 ide_debug_log(IDE_DBG_PROBE
, "Descriptor %d: %dkB, %d blocks, "
404 i
, blocks
* length
/ 1024,
410 * the code below is valid only for the 1st descriptor, ie i=0
413 switch (pc
.buf
[desc_start
+ 4] & 0x03) {
414 /* Clik! drive returns this instead of CAPACITY_CURRENT */
415 case CAPACITY_UNFORMATTED
:
416 if (!(drive
->atapi_flags
& IDE_AFLAG_CLIK_DRIVE
))
418 * If it is not a clik drive, break out
419 * (maintains previous driver behaviour)
422 case CAPACITY_CURRENT
:
423 /* Normal Zip/LS-120 disks */
424 if (memcmp(cap_desc
, &floppy
->cap_desc
, 8))
425 printk(KERN_INFO PFX
"%s: %dkB, %d blocks, %d "
427 drive
->name
, blocks
* length
/ 1024,
429 memcpy(&floppy
->cap_desc
, cap_desc
, 8);
431 if (!length
|| length
% 512) {
432 printk(KERN_NOTICE PFX
"%s: %d bytes block size"
433 " not supported\n", drive
->name
, length
);
435 floppy
->blocks
= blocks
;
436 floppy
->block_size
= length
;
437 floppy
->bs_factor
= length
/ 512;
438 if (floppy
->bs_factor
!= 1)
439 printk(KERN_NOTICE PFX
"%s: Warning: "
440 "non 512 bytes block size not "
444 floppy
->blocks
* floppy
->bs_factor
;
448 case CAPACITY_NO_CARTRIDGE
:
450 * This is a KERN_ERR so it appears on screen
451 * for the user to see
453 printk(KERN_ERR PFX
"%s: No disk in drive\n",
456 case CAPACITY_INVALID
:
457 printk(KERN_ERR PFX
"%s: Invalid capacity for disk "
458 "in drive\n", drive
->name
);
461 ide_debug_log(IDE_DBG_PROBE
, "Descriptor 0 Code: %d",
462 pc
.buf
[desc_start
+ 4] & 0x03);
465 /* Clik! disk does not support get_flexible_disk_page */
466 if (!(drive
->atapi_flags
& IDE_AFLAG_CLIK_DRIVE
))
467 (void) ide_floppy_get_flexible_disk_page(drive
, &pc
);
472 static void ide_floppy_setup(ide_drive_t
*drive
)
474 struct ide_disk_obj
*floppy
= drive
->driver_data
;
477 drive
->pc_callback
= ide_floppy_callback
;
478 drive
->pc_update_buffers
= idefloppy_update_buffers
;
479 drive
->pc_io_buffers
= ide_io_buffers
;
482 * We used to check revisions here. At this point however I'm giving up.
483 * Just assume they are all broken, its easier.
485 * The actual reason for the workarounds was likely a driver bug after
486 * all rather than a firmware bug, and the workaround below used to hide
487 * it. It should be fixed as of version 1.9, but to be on the safe side
488 * we'll leave the limitation below for the 2.2.x tree.
490 if (!strncmp((char *)&id
[ATA_ID_PROD
], "IOMEGA ZIP 100 ATAPI", 20)) {
491 drive
->atapi_flags
|= IDE_AFLAG_ZIP_DRIVE
;
492 /* This value will be visible in the /proc/ide/hdx/settings */
493 drive
->pc_delay
= IDEFLOPPY_PC_DELAY
;
494 blk_queue_max_sectors(drive
->queue
, 64);
498 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
499 * nasty clicking noises without it, so please don't remove this.
501 if (strncmp((char *)&id
[ATA_ID_PROD
], "IOMEGA Clik!", 11) == 0) {
502 blk_queue_max_sectors(drive
->queue
, 64);
503 drive
->atapi_flags
|= IDE_AFLAG_CLIK_DRIVE
;
504 /* IOMEGA Clik! drives do not support lock/unlock commands */
505 drive
->dev_flags
&= ~IDE_DFLAG_DOORLOCKING
;
508 (void) ide_floppy_get_capacity(drive
);
510 ide_proc_register_driver(drive
, floppy
->driver
);
512 drive
->dev_flags
|= IDE_DFLAG_ATTACH
;
515 static void ide_floppy_flush(ide_drive_t
*drive
)
519 static int ide_floppy_init_media(ide_drive_t
*drive
, struct gendisk
*disk
)
523 if (ide_do_test_unit_ready(drive
, disk
))
524 ide_do_start_stop(drive
, disk
, 1);
526 ret
= ide_floppy_get_capacity(drive
);
528 set_capacity(disk
, ide_gd_capacity(drive
));
533 const struct ide_disk_ops ide_atapi_disk_ops
= {
534 .check
= ide_check_atapi_device
,
535 .get_capacity
= ide_floppy_get_capacity
,
536 .setup
= ide_floppy_setup
,
537 .flush
= ide_floppy_flush
,
538 .init_media
= ide_floppy_init_media
,
539 .set_doorlock
= ide_set_media_lock
,
540 .do_request
= ide_floppy_do_request
,
541 .ioctl
= ide_floppy_ioctl
,