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 #define DRV_NAME "ide-floppy"
20 #define IDEFLOPPY_VERSION "1.00"
22 #include <linux/module.h>
23 #include <linux/types.h>
24 #include <linux/string.h>
25 #include <linux/kernel.h>
26 #include <linux/delay.h>
27 #include <linux/timer.h>
29 #include <linux/interrupt.h>
30 #include <linux/major.h>
31 #include <linux/errno.h>
32 #include <linux/genhd.h>
33 #include <linux/slab.h>
34 #include <linux/cdrom.h>
35 #include <linux/ide.h>
36 #include <linux/hdreg.h>
37 #include <linux/bitops.h>
38 #include <linux/mutex.h>
39 #include <linux/scatterlist.h>
41 #include <scsi/scsi_ioctl.h>
43 #include <asm/byteorder.h>
44 #include <linux/irq.h>
45 #include <linux/uaccess.h>
47 #include <asm/unaligned.h>
49 /* define to see debug info */
50 #define IDEFLOPPY_DEBUG_LOG 0
52 /* #define IDEFLOPPY_DEBUG(fmt, args...) printk(KERN_INFO fmt, ## args) */
53 #define IDEFLOPPY_DEBUG(fmt, args...)
55 #if IDEFLOPPY_DEBUG_LOG
56 #define debug_log(fmt, args...) \
57 printk(KERN_INFO "ide-floppy: " fmt, ## args)
59 #define debug_log(fmt, args...) do {} while (0)
63 /* Some drives require a longer irq timeout. */
64 #define IDEFLOPPY_WAIT_CMD (5 * WAIT_CMD)
67 * After each failed packet command we issue a request sense command and retry
68 * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
70 #define IDEFLOPPY_MAX_PC_RETRIES 3
72 /* format capacities descriptor codes */
73 #define CAPACITY_INVALID 0x00
74 #define CAPACITY_UNFORMATTED 0x01
75 #define CAPACITY_CURRENT 0x02
76 #define CAPACITY_NO_CARTRIDGE 0x03
79 * Most of our global data which we need to save even as we leave the driver
80 * due to an interrupt or a timer event is stored in a variable of type
81 * idefloppy_floppy_t, defined below.
83 typedef struct ide_floppy_obj
{
88 unsigned int openers
; /* protected by BKL for now */
90 /* Current packet command */
91 struct ide_atapi_pc
*pc
;
92 /* Last failed packet command */
93 struct ide_atapi_pc
*failed_pc
;
94 /* used for blk_{fs,pc}_request() requests */
95 struct ide_atapi_pc queued_pc
;
97 struct ide_atapi_pc request_sense_pc
;
98 struct request request_sense_rq
;
100 /* Last error information */
101 u8 sense_key
, asc
, ascq
;
102 /* delay this long before sending packet command */
104 int progress_indication
;
106 /* Device information */
108 int blocks
, block_size
, bs_factor
;
109 /* Last format capacity descriptor */
111 /* Copy of the flexible disk page */
112 u8 flexible_disk_page
[32];
113 } idefloppy_floppy_t
;
115 #define IDEFLOPPY_TICKS_DELAY HZ/20 /* default delay for ZIP 100 (50ms) */
117 /* IOCTLs used in low-level formatting. */
118 #define IDEFLOPPY_IOCTL_FORMAT_SUPPORTED 0x4600
119 #define IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY 0x4601
120 #define IDEFLOPPY_IOCTL_FORMAT_START 0x4602
121 #define IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS 0x4603
123 /* Error code returned in rq->errors to the higher part of the driver. */
124 #define IDEFLOPPY_ERROR_GENERAL 101
127 * Pages of the SELECT SENSE / MODE SENSE packet commands.
128 * See SFF-8070i spec.
130 #define IDEFLOPPY_CAPABILITIES_PAGE 0x1b
131 #define IDEFLOPPY_FLEXIBLE_DISK_PAGE 0x05
133 static DEFINE_MUTEX(idefloppy_ref_mutex
);
135 #define to_ide_floppy(obj) container_of(obj, struct ide_floppy_obj, kref)
137 #define ide_floppy_g(disk) \
138 container_of((disk)->private_data, struct ide_floppy_obj, driver)
140 static void idefloppy_cleanup_obj(struct kref
*);
142 static struct ide_floppy_obj
*ide_floppy_get(struct gendisk
*disk
)
144 struct ide_floppy_obj
*floppy
= NULL
;
146 mutex_lock(&idefloppy_ref_mutex
);
147 floppy
= ide_floppy_g(disk
);
149 if (ide_device_get(floppy
->drive
))
152 kref_get(&floppy
->kref
);
154 mutex_unlock(&idefloppy_ref_mutex
);
158 static void ide_floppy_put(struct ide_floppy_obj
*floppy
)
160 ide_drive_t
*drive
= floppy
->drive
;
162 mutex_lock(&idefloppy_ref_mutex
);
163 kref_put(&floppy
->kref
, idefloppy_cleanup_obj
);
164 ide_device_put(drive
);
165 mutex_unlock(&idefloppy_ref_mutex
);
169 * Used to finish servicing a request. For read/write requests, we will call
170 * ide_end_request to pass to the next buffer.
172 static int idefloppy_end_request(ide_drive_t
*drive
, int uptodate
, int nsecs
)
174 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
175 struct request
*rq
= HWGROUP(drive
)->rq
;
178 debug_log("Reached %s\n", __func__
);
181 case 0: error
= IDEFLOPPY_ERROR_GENERAL
; break;
182 case 1: error
= 0; break;
183 default: error
= uptodate
;
186 floppy
->failed_pc
= NULL
;
187 /* Why does this happen? */
190 if (!blk_special_request(rq
)) {
191 /* our real local end request function */
192 ide_end_request(drive
, uptodate
, nsecs
);
196 /* fixme: need to move this local also */
197 ide_end_drive_cmd(drive
, 0, 0);
201 static void idefloppy_update_buffers(ide_drive_t
*drive
,
202 struct ide_atapi_pc
*pc
)
204 struct request
*rq
= pc
->rq
;
205 struct bio
*bio
= rq
->bio
;
207 while ((bio
= rq
->bio
) != NULL
)
208 idefloppy_end_request(drive
, 1, 0);
211 static void ide_floppy_callback(ide_drive_t
*drive
)
213 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
214 struct ide_atapi_pc
*pc
= floppy
->pc
;
215 int uptodate
= pc
->error
? 0 : 1;
217 debug_log("Reached %s\n", __func__
);
219 if (floppy
->failed_pc
== pc
)
220 floppy
->failed_pc
= NULL
;
222 if (pc
->c
[0] == GPCMD_READ_10
|| pc
->c
[0] == GPCMD_WRITE_10
||
223 (pc
->rq
&& blk_pc_request(pc
->rq
)))
224 uptodate
= 1; /* FIXME */
225 else if (pc
->c
[0] == GPCMD_REQUEST_SENSE
) {
226 u8
*buf
= floppy
->pc
->buf
;
229 floppy
->sense_key
= buf
[2] & 0x0F;
230 floppy
->asc
= buf
[12];
231 floppy
->ascq
= buf
[13];
232 floppy
->progress_indication
= buf
[15] & 0x80 ?
233 (u16
)get_unaligned((u16
*)&buf
[16]) : 0x10000;
235 if (floppy
->failed_pc
)
236 debug_log("pc = %x, ", floppy
->failed_pc
->c
[0]);
238 debug_log("sense key = %x, asc = %x, ascq = %x\n",
239 floppy
->sense_key
, floppy
->asc
, floppy
->ascq
);
241 printk(KERN_ERR
"Error in REQUEST SENSE itself - "
242 "Aborting request!\n");
245 idefloppy_end_request(drive
, uptodate
, 0);
248 static void idefloppy_create_request_sense_cmd(struct ide_atapi_pc
*pc
)
251 pc
->c
[0] = GPCMD_REQUEST_SENSE
;
257 * Called when an error was detected during the last packet command. We queue a
258 * request sense packet command in the head of the request list.
260 static void idefloppy_retry_pc(ide_drive_t
*drive
)
262 struct ide_floppy_obj
*floppy
= drive
->driver_data
;
263 struct request
*rq
= &floppy
->request_sense_rq
;
264 struct ide_atapi_pc
*pc
= &floppy
->request_sense_pc
;
266 (void)ide_read_error(drive
);
267 idefloppy_create_request_sense_cmd(pc
);
268 ide_queue_pc_head(drive
, floppy
->disk
, pc
, rq
);
271 /* The usual interrupt handler called during a packet command. */
272 static ide_startstop_t
idefloppy_pc_intr(ide_drive_t
*drive
)
274 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
276 return ide_pc_intr(drive
, floppy
->pc
, idefloppy_pc_intr
,
277 IDEFLOPPY_WAIT_CMD
, NULL
, idefloppy_update_buffers
,
278 idefloppy_retry_pc
, NULL
, ide_io_buffers
);
282 * What we have here is a classic case of a top half / bottom half interrupt
283 * service routine. In interrupt mode, the device sends an interrupt to signal
284 * that it is ready to receive a packet. However, we need to delay about 2-3
285 * ticks before issuing the packet or we gets in trouble.
287 static int idefloppy_transfer_pc(ide_drive_t
*drive
)
289 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
291 /* Send the actual packet */
292 drive
->hwif
->tp_ops
->output_data(drive
, NULL
, floppy
->pc
->c
, 12);
294 /* Timeout for the packet command */
295 return IDEFLOPPY_WAIT_CMD
;
300 * Called as an interrupt (or directly). When the device says it's ready for a
301 * packet, we schedule the packet transfer to occur about 2-3 ticks later in
304 static ide_startstop_t
idefloppy_start_pc_transfer(ide_drive_t
*drive
)
306 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
307 struct ide_atapi_pc
*pc
= floppy
->pc
;
308 ide_expiry_t
*expiry
;
309 unsigned int timeout
;
312 * The following delay solves a problem with ATAPI Zip 100 drives
313 * where the Busy flag was apparently being deasserted before the
314 * unit was ready to receive data. This was happening on a
315 * 1200 MHz Athlon system. 10/26/01 25msec is too short,
316 * 40 and 50msec work well. idefloppy_pc_intr will not be actually
317 * used until after the packet is moved in about 50 msec.
319 if (drive
->atapi_flags
& IDE_AFLAG_ZIP_DRIVE
) {
320 timeout
= floppy
->ticks
;
321 expiry
= &idefloppy_transfer_pc
;
323 timeout
= IDEFLOPPY_WAIT_CMD
;
327 return ide_transfer_pc(drive
, pc
, idefloppy_pc_intr
, timeout
, expiry
);
330 static void ide_floppy_report_error(idefloppy_floppy_t
*floppy
,
331 struct ide_atapi_pc
*pc
)
333 /* supress error messages resulting from Medium not present */
334 if (floppy
->sense_key
== 0x02 &&
335 floppy
->asc
== 0x3a &&
336 floppy
->ascq
== 0x00)
339 printk(KERN_ERR
"ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
340 "asc = %2x, ascq = %2x\n",
341 floppy
->drive
->name
, pc
->c
[0], floppy
->sense_key
,
342 floppy
->asc
, floppy
->ascq
);
346 static ide_startstop_t
idefloppy_issue_pc(ide_drive_t
*drive
,
347 struct ide_atapi_pc
*pc
)
349 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
351 if (floppy
->failed_pc
== NULL
&&
352 pc
->c
[0] != GPCMD_REQUEST_SENSE
)
353 floppy
->failed_pc
= pc
;
354 /* Set the current packet command */
357 if (pc
->retries
> IDEFLOPPY_MAX_PC_RETRIES
) {
358 if (!(pc
->flags
& PC_FLAG_SUPPRESS_ERROR
))
359 ide_floppy_report_error(floppy
, pc
);
361 pc
->error
= IDEFLOPPY_ERROR_GENERAL
;
363 floppy
->failed_pc
= NULL
;
364 drive
->pc_callback(drive
);
368 debug_log("Retry number - %d\n", pc
->retries
);
372 return ide_issue_pc(drive
, pc
, idefloppy_start_pc_transfer
,
373 IDEFLOPPY_WAIT_CMD
, NULL
);
376 static void idefloppy_create_prevent_cmd(struct ide_atapi_pc
*pc
, int prevent
)
378 debug_log("creating prevent removal command, prevent = %d\n", prevent
);
381 pc
->c
[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL
;
385 static void idefloppy_create_read_capacity_cmd(struct ide_atapi_pc
*pc
)
388 pc
->c
[0] = GPCMD_READ_FORMAT_CAPACITIES
;
394 static void idefloppy_create_format_unit_cmd(struct ide_atapi_pc
*pc
, int b
,
398 pc
->c
[0] = GPCMD_FORMAT_UNIT
;
401 memset(pc
->buf
, 0, 12);
403 /* Default format list header, u8 1: FOV/DCRT/IMM bits set */
405 if (flags
& 1) /* Verify bit on... */
406 pc
->buf
[1] ^= 0x20; /* ... turn off DCRT bit */
409 put_unaligned(cpu_to_be32(b
), (unsigned int *)(&pc
->buf
[4]));
410 put_unaligned(cpu_to_be32(l
), (unsigned int *)(&pc
->buf
[8]));
412 pc
->flags
|= PC_FLAG_WRITING
;
415 /* A mode sense command is used to "sense" floppy parameters. */
416 static void idefloppy_create_mode_sense_cmd(struct ide_atapi_pc
*pc
,
419 u16 length
= 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
422 pc
->c
[0] = GPCMD_MODE_SENSE_10
;
424 pc
->c
[2] = page_code
;
427 case IDEFLOPPY_CAPABILITIES_PAGE
:
430 case IDEFLOPPY_FLEXIBLE_DISK_PAGE
:
434 printk(KERN_ERR
"ide-floppy: unsupported page code "
435 "in create_mode_sense_cmd\n");
437 put_unaligned(cpu_to_be16(length
), (u16
*) &pc
->c
[7]);
438 pc
->req_xfer
= length
;
441 static void idefloppy_create_start_stop_cmd(struct ide_atapi_pc
*pc
, int start
)
444 pc
->c
[0] = GPCMD_START_STOP_UNIT
;
448 static void idefloppy_create_rw_cmd(idefloppy_floppy_t
*floppy
,
449 struct ide_atapi_pc
*pc
, struct request
*rq
,
450 unsigned long sector
)
452 int block
= sector
/ floppy
->bs_factor
;
453 int blocks
= rq
->nr_sectors
/ floppy
->bs_factor
;
454 int cmd
= rq_data_dir(rq
);
456 debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
460 pc
->c
[0] = cmd
== READ
? GPCMD_READ_10
: GPCMD_WRITE_10
;
461 put_unaligned(cpu_to_be16(blocks
), (unsigned short *)&pc
->c
[7]);
462 put_unaligned(cpu_to_be32(block
), (unsigned int *) &pc
->c
[2]);
464 memcpy(rq
->cmd
, pc
->c
, 12);
468 if (rq
->cmd_flags
& REQ_RW
)
469 pc
->flags
|= PC_FLAG_WRITING
;
471 pc
->req_xfer
= pc
->buf_size
= blocks
* floppy
->block_size
;
472 pc
->flags
|= PC_FLAG_DMA_OK
;
475 static void idefloppy_blockpc_cmd(idefloppy_floppy_t
*floppy
,
476 struct ide_atapi_pc
*pc
, struct request
*rq
)
479 memcpy(pc
->c
, rq
->cmd
, sizeof(pc
->c
));
482 if (rq
->data_len
&& rq_data_dir(rq
) == WRITE
)
483 pc
->flags
|= PC_FLAG_WRITING
;
486 pc
->flags
|= PC_FLAG_DMA_OK
;
488 * possibly problematic, doesn't look like ide-floppy correctly
489 * handled scattered requests if dma fails...
491 pc
->req_xfer
= pc
->buf_size
= rq
->data_len
;
494 static ide_startstop_t
idefloppy_do_request(ide_drive_t
*drive
,
495 struct request
*rq
, sector_t block_s
)
497 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
498 ide_hwif_t
*hwif
= drive
->hwif
;
499 struct ide_atapi_pc
*pc
;
500 unsigned long block
= (unsigned long)block_s
;
502 debug_log("%s: dev: %s, cmd: 0x%x, cmd_type: %x, errors: %d\n",
503 __func__
, rq
->rq_disk
? rq
->rq_disk
->disk_name
: "?",
504 rq
->cmd
[0], rq
->cmd_type
, rq
->errors
);
506 debug_log("%s: sector: %ld, nr_sectors: %ld, current_nr_sectors: %d\n",
507 __func__
, (long)rq
->sector
, rq
->nr_sectors
,
508 rq
->current_nr_sectors
);
510 if (rq
->errors
>= ERROR_MAX
) {
511 if (floppy
->failed_pc
)
512 ide_floppy_report_error(floppy
, floppy
->failed_pc
);
514 printk(KERN_ERR
"ide-floppy: %s: I/O error\n",
516 idefloppy_end_request(drive
, 0, 0);
519 if (blk_fs_request(rq
)) {
520 if (((long)rq
->sector
% floppy
->bs_factor
) ||
521 (rq
->nr_sectors
% floppy
->bs_factor
)) {
522 printk(KERN_ERR
"%s: unsupported r/w request size\n",
524 idefloppy_end_request(drive
, 0, 0);
527 pc
= &floppy
->queued_pc
;
528 idefloppy_create_rw_cmd(floppy
, pc
, rq
, block
);
529 } else if (blk_special_request(rq
)) {
530 pc
= (struct ide_atapi_pc
*) rq
->buffer
;
531 } else if (blk_pc_request(rq
)) {
532 pc
= &floppy
->queued_pc
;
533 idefloppy_blockpc_cmd(floppy
, pc
, rq
);
535 blk_dump_rq_flags(rq
,
536 "ide-floppy: unsupported command in queue");
537 idefloppy_end_request(drive
, 0, 0);
541 ide_init_sg_cmd(drive
, rq
);
542 ide_map_sg(drive
, rq
);
544 pc
->sg
= hwif
->sg_table
;
545 pc
->sg_cnt
= hwif
->sg_nents
;
549 return idefloppy_issue_pc(drive
, pc
);
553 * Look at the flexible disk page parameters. We ignore the CHS capacity
554 * parameters and use the LBA parameters instead.
556 static int ide_floppy_get_flexible_disk_page(ide_drive_t
*drive
)
558 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
559 struct gendisk
*disk
= floppy
->disk
;
560 struct ide_atapi_pc pc
;
562 int capacity
, lba_capacity
;
563 u16 transfer_rate
, sector_size
, cyls
, rpm
;
566 idefloppy_create_mode_sense_cmd(&pc
, IDEFLOPPY_FLEXIBLE_DISK_PAGE
);
568 if (ide_queue_pc_tail(drive
, disk
, &pc
)) {
569 printk(KERN_ERR
"ide-floppy: Can't get flexible disk page"
574 if (pc
.buf
[3] & 0x80)
575 drive
->atapi_flags
|= IDE_AFLAG_WP
;
577 drive
->atapi_flags
&= ~IDE_AFLAG_WP
;
579 set_disk_ro(disk
, !!(drive
->atapi_flags
& IDE_AFLAG_WP
));
583 transfer_rate
= be16_to_cpup((__be16
*)&pc
.buf
[8 + 2]);
584 sector_size
= be16_to_cpup((__be16
*)&pc
.buf
[8 + 6]);
585 cyls
= be16_to_cpup((__be16
*)&pc
.buf
[8 + 8]);
586 rpm
= be16_to_cpup((__be16
*)&pc
.buf
[8 + 28]);
587 heads
= pc
.buf
[8 + 4];
588 sectors
= pc
.buf
[8 + 5];
590 capacity
= cyls
* heads
* sectors
* sector_size
;
592 if (memcmp(page
, &floppy
->flexible_disk_page
, 32))
593 printk(KERN_INFO
"%s: %dkB, %d/%d/%d CHS, %d kBps, "
594 "%d sector size, %d rpm\n",
595 drive
->name
, capacity
/ 1024, cyls
, heads
,
596 sectors
, transfer_rate
/ 8, sector_size
, rpm
);
598 memcpy(&floppy
->flexible_disk_page
, page
, 32);
599 drive
->bios_cyl
= cyls
;
600 drive
->bios_head
= heads
;
601 drive
->bios_sect
= sectors
;
602 lba_capacity
= floppy
->blocks
* floppy
->block_size
;
604 if (capacity
< lba_capacity
) {
605 printk(KERN_NOTICE
"%s: The disk reports a capacity of %d "
606 "bytes, but the drive only handles %d\n",
607 drive
->name
, lba_capacity
, capacity
);
608 floppy
->blocks
= floppy
->block_size
?
609 capacity
/ floppy
->block_size
: 0;
614 static int idefloppy_get_sfrp_bit(ide_drive_t
*drive
)
616 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
617 struct ide_atapi_pc pc
;
619 drive
->atapi_flags
&= ~IDE_AFLAG_SRFP
;
621 idefloppy_create_mode_sense_cmd(&pc
, IDEFLOPPY_CAPABILITIES_PAGE
);
622 pc
.flags
|= PC_FLAG_SUPPRESS_ERROR
;
624 if (ide_queue_pc_tail(drive
, floppy
->disk
, &pc
))
627 if (pc
.buf
[8 + 2] & 0x40)
628 drive
->atapi_flags
|= IDE_AFLAG_SRFP
;
634 * Determine if a media is present in the floppy drive, and if so, its LBA
637 static int ide_floppy_get_capacity(ide_drive_t
*drive
)
639 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
640 struct gendisk
*disk
= floppy
->disk
;
641 struct ide_atapi_pc pc
;
643 u8 header_len
, desc_cnt
;
644 int i
, rc
= 1, blocks
, length
;
647 drive
->bios_head
= drive
->bios_sect
= 0;
649 floppy
->bs_factor
= 1;
650 set_capacity(floppy
->disk
, 0);
652 idefloppy_create_read_capacity_cmd(&pc
);
653 if (ide_queue_pc_tail(drive
, disk
, &pc
)) {
654 printk(KERN_ERR
"ide-floppy: Can't get floppy parameters\n");
657 header_len
= pc
.buf
[3];
658 cap_desc
= &pc
.buf
[4];
659 desc_cnt
= header_len
/ 8; /* capacity descriptor of 8 bytes */
661 for (i
= 0; i
< desc_cnt
; i
++) {
662 unsigned int desc_start
= 4 + i
*8;
664 blocks
= be32_to_cpup((__be32
*)&pc
.buf
[desc_start
]);
665 length
= be16_to_cpup((__be16
*)&pc
.buf
[desc_start
+ 6]);
667 debug_log("Descriptor %d: %dkB, %d blocks, %d sector size\n",
668 i
, blocks
* length
/ 1024, blocks
, length
);
673 * the code below is valid only for the 1st descriptor, ie i=0
676 switch (pc
.buf
[desc_start
+ 4] & 0x03) {
677 /* Clik! drive returns this instead of CAPACITY_CURRENT */
678 case CAPACITY_UNFORMATTED
:
679 if (!(drive
->atapi_flags
& IDE_AFLAG_CLIK_DRIVE
))
681 * If it is not a clik drive, break out
682 * (maintains previous driver behaviour)
685 case CAPACITY_CURRENT
:
686 /* Normal Zip/LS-120 disks */
687 if (memcmp(cap_desc
, &floppy
->cap_desc
, 8))
688 printk(KERN_INFO
"%s: %dkB, %d blocks, %d "
689 "sector size\n", drive
->name
,
690 blocks
* length
/ 1024, blocks
, length
);
691 memcpy(&floppy
->cap_desc
, cap_desc
, 8);
693 if (!length
|| length
% 512) {
694 printk(KERN_NOTICE
"%s: %d bytes block size "
695 "not supported\n", drive
->name
, length
);
697 floppy
->blocks
= blocks
;
698 floppy
->block_size
= length
;
699 floppy
->bs_factor
= length
/ 512;
700 if (floppy
->bs_factor
!= 1)
701 printk(KERN_NOTICE
"%s: warning: non "
702 "512 bytes block size not "
708 case CAPACITY_NO_CARTRIDGE
:
710 * This is a KERN_ERR so it appears on screen
711 * for the user to see
713 printk(KERN_ERR
"%s: No disk in drive\n", drive
->name
);
715 case CAPACITY_INVALID
:
716 printk(KERN_ERR
"%s: Invalid capacity for disk "
717 "in drive\n", drive
->name
);
720 debug_log("Descriptor 0 Code: %d\n",
721 pc
.buf
[desc_start
+ 4] & 0x03);
724 /* Clik! disk does not support get_flexible_disk_page */
725 if (!(drive
->atapi_flags
& IDE_AFLAG_CLIK_DRIVE
))
726 (void) ide_floppy_get_flexible_disk_page(drive
);
728 set_capacity(disk
, floppy
->blocks
* floppy
->bs_factor
);
734 * Obtain the list of formattable capacities.
735 * Very similar to ide_floppy_get_capacity, except that we push the capacity
736 * descriptors to userland, instead of our own structures.
738 * Userland gives us the following structure:
740 * struct idefloppy_format_capacities {
748 * userland initializes nformats to the number of allocated formats[] records.
749 * On exit we set nformats to the number of records we've actually initialized.
752 static int ide_floppy_get_format_capacities(ide_drive_t
*drive
, int __user
*arg
)
754 struct ide_floppy_obj
*floppy
= drive
->driver_data
;
755 struct ide_atapi_pc pc
;
756 u8 header_len
, desc_cnt
;
757 int i
, blocks
, length
, u_array_size
, u_index
;
760 if (get_user(u_array_size
, arg
))
763 if (u_array_size
<= 0)
766 idefloppy_create_read_capacity_cmd(&pc
);
767 if (ide_queue_pc_tail(drive
, floppy
->disk
, &pc
)) {
768 printk(KERN_ERR
"ide-floppy: Can't get floppy parameters\n");
772 header_len
= pc
.buf
[3];
773 desc_cnt
= header_len
/ 8; /* capacity descriptor of 8 bytes */
779 * We always skip the first capacity descriptor. That's the current
780 * capacity. We are interested in the remaining descriptors, the
781 * formattable capacities.
783 for (i
= 1; i
< desc_cnt
; i
++) {
784 unsigned int desc_start
= 4 + i
*8;
786 if (u_index
>= u_array_size
)
787 break; /* User-supplied buffer too small */
789 blocks
= be32_to_cpup((__be32
*)&pc
.buf
[desc_start
]);
790 length
= be16_to_cpup((__be16
*)&pc
.buf
[desc_start
+ 6]);
792 if (put_user(blocks
, argp
))
797 if (put_user(length
, argp
))
805 if (put_user(u_index
, arg
))
812 * Get ATAPI_FORMAT_UNIT progress indication.
814 * Userland gives a pointer to an int. The int is set to a progress
815 * indicator 0-65536, with 65536=100%.
817 * If the drive does not support format progress indication, we just check
818 * the dsc bit, and return either 0 or 65536.
821 static int ide_floppy_get_format_progress(ide_drive_t
*drive
, int __user
*arg
)
823 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
824 struct ide_atapi_pc pc
;
825 int progress_indication
= 0x10000;
827 if (drive
->atapi_flags
& IDE_AFLAG_SRFP
) {
828 idefloppy_create_request_sense_cmd(&pc
);
829 if (ide_queue_pc_tail(drive
, floppy
->disk
, &pc
))
832 if (floppy
->sense_key
== 2 &&
835 progress_indication
= floppy
->progress_indication
;
837 /* Else assume format_unit has finished, and we're at 0x10000 */
839 ide_hwif_t
*hwif
= drive
->hwif
;
843 local_irq_save(flags
);
844 stat
= hwif
->tp_ops
->read_status(hwif
);
845 local_irq_restore(flags
);
847 progress_indication
= ((stat
& ATA_DSC
) == 0) ? 0 : 0x10000;
850 if (put_user(progress_indication
, arg
))
856 static sector_t
idefloppy_capacity(ide_drive_t
*drive
)
858 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
859 unsigned long capacity
= floppy
->blocks
* floppy
->bs_factor
;
864 #ifdef CONFIG_IDE_PROC_FS
865 ide_devset_rw(bios_cyl
, 0, 1023, bios_cyl
);
866 ide_devset_rw(bios_head
, 0, 255, bios_head
);
867 ide_devset_rw(bios_sect
, 0, 63, bios_sect
);
869 static int get_ticks(ide_drive_t
*drive
)
871 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
872 return floppy
->ticks
;
875 static int set_ticks(ide_drive_t
*drive
, int arg
)
877 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
882 IDE_DEVSET(ticks
, S_RW
, 0, 255, get_ticks
, set_ticks
);
884 static const struct ide_devset
*idefloppy_settings
[] = {
885 &ide_devset_bios_cyl
,
886 &ide_devset_bios_head
,
887 &ide_devset_bios_sect
,
893 static void idefloppy_setup(ide_drive_t
*drive
, idefloppy_floppy_t
*floppy
)
898 *((u16
*)&gcw
) = id
[ATA_ID_CONFIG
];
900 drive
->pc_callback
= ide_floppy_callback
;
902 if (((gcw
[0] & 0x60) >> 5) == 1)
903 drive
->atapi_flags
|= IDE_AFLAG_DRQ_INTERRUPT
;
905 * We used to check revisions here. At this point however I'm giving up.
906 * Just assume they are all broken, its easier.
908 * The actual reason for the workarounds was likely a driver bug after
909 * all rather than a firmware bug, and the workaround below used to hide
910 * it. It should be fixed as of version 1.9, but to be on the safe side
911 * we'll leave the limitation below for the 2.2.x tree.
913 if (!strncmp((char *)&id
[ATA_ID_PROD
], "IOMEGA ZIP 100 ATAPI", 20)) {
914 drive
->atapi_flags
|= IDE_AFLAG_ZIP_DRIVE
;
915 /* This value will be visible in the /proc/ide/hdx/settings */
916 floppy
->ticks
= IDEFLOPPY_TICKS_DELAY
;
917 blk_queue_max_sectors(drive
->queue
, 64);
921 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
922 * nasty clicking noises without it, so please don't remove this.
924 if (strncmp((char *)&id
[ATA_ID_PROD
], "IOMEGA Clik!", 11) == 0) {
925 blk_queue_max_sectors(drive
->queue
, 64);
926 drive
->atapi_flags
|= IDE_AFLAG_CLIK_DRIVE
;
929 (void) ide_floppy_get_capacity(drive
);
931 ide_proc_register_driver(drive
, floppy
->driver
);
934 static void ide_floppy_remove(ide_drive_t
*drive
)
936 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
937 struct gendisk
*g
= floppy
->disk
;
939 ide_proc_unregister_driver(drive
, floppy
->driver
);
943 ide_floppy_put(floppy
);
946 static void idefloppy_cleanup_obj(struct kref
*kref
)
948 struct ide_floppy_obj
*floppy
= to_ide_floppy(kref
);
949 ide_drive_t
*drive
= floppy
->drive
;
950 struct gendisk
*g
= floppy
->disk
;
952 drive
->driver_data
= NULL
;
953 g
->private_data
= NULL
;
958 #ifdef CONFIG_IDE_PROC_FS
959 static int proc_idefloppy_read_capacity(char *page
, char **start
, off_t off
,
960 int count
, int *eof
, void *data
)
962 ide_drive_t
*drive
= (ide_drive_t
*)data
;
965 len
= sprintf(page
, "%llu\n", (long long)idefloppy_capacity(drive
));
966 PROC_IDE_READ_RETURN(page
, start
, off
, count
, eof
, len
);
969 static ide_proc_entry_t idefloppy_proc
[] = {
970 { "capacity", S_IFREG
|S_IRUGO
, proc_idefloppy_read_capacity
, NULL
},
971 { "geometry", S_IFREG
|S_IRUGO
, proc_ide_read_geometry
, NULL
},
972 { NULL
, 0, NULL
, NULL
}
974 #endif /* CONFIG_IDE_PROC_FS */
976 static int ide_floppy_probe(ide_drive_t
*);
978 static ide_driver_t idefloppy_driver
= {
980 .owner
= THIS_MODULE
,
981 .name
= "ide-floppy",
982 .bus
= &ide_bus_type
,
984 .probe
= ide_floppy_probe
,
985 .remove
= ide_floppy_remove
,
986 .version
= IDEFLOPPY_VERSION
,
988 .do_request
= idefloppy_do_request
,
989 .end_request
= idefloppy_end_request
,
990 .error
= __ide_error
,
991 #ifdef CONFIG_IDE_PROC_FS
992 .proc
= idefloppy_proc
,
993 .settings
= idefloppy_settings
,
997 static void ide_floppy_set_media_lock(ide_drive_t
*drive
, int on
)
999 struct ide_floppy_obj
*floppy
= drive
->driver_data
;
1000 struct ide_atapi_pc pc
;
1002 /* IOMEGA Clik! drives do not support lock/unlock commands */
1003 if ((drive
->atapi_flags
& IDE_AFLAG_CLIK_DRIVE
) == 0) {
1004 idefloppy_create_prevent_cmd(&pc
, on
);
1005 (void)ide_queue_pc_tail(drive
, floppy
->disk
, &pc
);
1009 static int idefloppy_open(struct inode
*inode
, struct file
*filp
)
1011 struct gendisk
*disk
= inode
->i_bdev
->bd_disk
;
1012 struct ide_floppy_obj
*floppy
;
1014 struct ide_atapi_pc pc
;
1017 debug_log("Reached %s\n", __func__
);
1019 floppy
= ide_floppy_get(disk
);
1023 drive
= floppy
->drive
;
1027 if (floppy
->openers
== 1) {
1028 drive
->atapi_flags
&= ~IDE_AFLAG_FORMAT_IN_PROGRESS
;
1032 pc
.c
[0] = GPCMD_TEST_UNIT_READY
;
1034 if (ide_queue_pc_tail(drive
, disk
, &pc
)) {
1035 idefloppy_create_start_stop_cmd(&pc
, 1);
1036 (void)ide_queue_pc_tail(drive
, disk
, &pc
);
1039 if (ide_floppy_get_capacity(drive
)
1040 && (filp
->f_flags
& O_NDELAY
) == 0
1042 * Allow O_NDELAY to open a drive without a disk, or with an
1043 * unreadable disk, so that we can get the format capacity
1044 * of the drive or begin the format - Sam
1048 goto out_put_floppy
;
1051 if ((drive
->atapi_flags
& IDE_AFLAG_WP
) && (filp
->f_mode
& 2)) {
1053 goto out_put_floppy
;
1056 drive
->atapi_flags
|= IDE_AFLAG_MEDIA_CHANGED
;
1057 ide_floppy_set_media_lock(drive
, 1);
1058 check_disk_change(inode
->i_bdev
);
1059 } else if (drive
->atapi_flags
& IDE_AFLAG_FORMAT_IN_PROGRESS
) {
1061 goto out_put_floppy
;
1067 ide_floppy_put(floppy
);
1071 static int idefloppy_release(struct inode
*inode
, struct file
*filp
)
1073 struct gendisk
*disk
= inode
->i_bdev
->bd_disk
;
1074 struct ide_floppy_obj
*floppy
= ide_floppy_g(disk
);
1075 ide_drive_t
*drive
= floppy
->drive
;
1077 debug_log("Reached %s\n", __func__
);
1079 if (floppy
->openers
== 1) {
1080 ide_floppy_set_media_lock(drive
, 0);
1081 drive
->atapi_flags
&= ~IDE_AFLAG_FORMAT_IN_PROGRESS
;
1086 ide_floppy_put(floppy
);
1091 static int idefloppy_getgeo(struct block_device
*bdev
, struct hd_geometry
*geo
)
1093 struct ide_floppy_obj
*floppy
= ide_floppy_g(bdev
->bd_disk
);
1094 ide_drive_t
*drive
= floppy
->drive
;
1096 geo
->heads
= drive
->bios_head
;
1097 geo
->sectors
= drive
->bios_sect
;
1098 geo
->cylinders
= (u16
)drive
->bios_cyl
; /* truncate */
1102 static int ide_floppy_lockdoor(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
,
1103 unsigned long arg
, unsigned int cmd
)
1105 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
1106 int prevent
= (arg
&& cmd
!= CDROMEJECT
) ? 1 : 0;
1108 if (floppy
->openers
> 1)
1111 ide_floppy_set_media_lock(drive
, prevent
);
1113 if (cmd
== CDROMEJECT
) {
1114 idefloppy_create_start_stop_cmd(pc
, 2);
1115 (void)ide_queue_pc_tail(drive
, floppy
->disk
, pc
);
1121 static int ide_floppy_format_unit(ide_drive_t
*drive
, int __user
*arg
)
1123 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
1124 struct ide_atapi_pc pc
;
1125 int blocks
, length
, flags
, err
= 0;
1127 if (floppy
->openers
> 1) {
1128 /* Don't format if someone is using the disk */
1129 drive
->atapi_flags
&= ~IDE_AFLAG_FORMAT_IN_PROGRESS
;
1133 drive
->atapi_flags
|= IDE_AFLAG_FORMAT_IN_PROGRESS
;
1136 * Send ATAPI_FORMAT_UNIT to the drive.
1138 * Userland gives us the following structure:
1140 * struct idefloppy_format_command {
1146 * flags is a bitmask, currently, the only defined flag is:
1148 * 0x01 - verify media after format.
1150 if (get_user(blocks
, arg
) ||
1151 get_user(length
, arg
+1) ||
1152 get_user(flags
, arg
+2)) {
1157 (void) idefloppy_get_sfrp_bit(drive
);
1158 idefloppy_create_format_unit_cmd(&pc
, blocks
, length
, flags
);
1160 if (ide_queue_pc_tail(drive
, floppy
->disk
, &pc
))
1165 drive
->atapi_flags
&= ~IDE_AFLAG_FORMAT_IN_PROGRESS
;
1169 static int ide_floppy_format_ioctl(ide_drive_t
*drive
, struct file
*file
,
1170 unsigned int cmd
, void __user
*argp
)
1173 case IDEFLOPPY_IOCTL_FORMAT_SUPPORTED
:
1175 case IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY
:
1176 return ide_floppy_get_format_capacities(drive
, argp
);
1177 case IDEFLOPPY_IOCTL_FORMAT_START
:
1178 if (!(file
->f_mode
& 2))
1180 return ide_floppy_format_unit(drive
, (int __user
*)argp
);
1181 case IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS
:
1182 return ide_floppy_get_format_progress(drive
, argp
);
1188 static int idefloppy_ioctl(struct inode
*inode
, struct file
*file
,
1189 unsigned int cmd
, unsigned long arg
)
1191 struct block_device
*bdev
= inode
->i_bdev
;
1192 struct ide_floppy_obj
*floppy
= ide_floppy_g(bdev
->bd_disk
);
1193 ide_drive_t
*drive
= floppy
->drive
;
1194 struct ide_atapi_pc pc
;
1195 void __user
*argp
= (void __user
*)arg
;
1198 if (cmd
== CDROMEJECT
|| cmd
== CDROM_LOCKDOOR
)
1199 return ide_floppy_lockdoor(drive
, &pc
, arg
, cmd
);
1201 err
= ide_floppy_format_ioctl(drive
, file
, cmd
, argp
);
1206 * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
1207 * and CDROM_SEND_PACKET (legacy) ioctls
1209 if (cmd
!= CDROM_SEND_PACKET
&& cmd
!= SCSI_IOCTL_SEND_COMMAND
)
1210 err
= scsi_cmd_ioctl(file
, bdev
->bd_disk
->queue
,
1211 bdev
->bd_disk
, cmd
, argp
);
1214 err
= generic_ide_ioctl(drive
, file
, bdev
, cmd
, arg
);
1219 static int idefloppy_media_changed(struct gendisk
*disk
)
1221 struct ide_floppy_obj
*floppy
= ide_floppy_g(disk
);
1222 ide_drive_t
*drive
= floppy
->drive
;
1225 /* do not scan partitions twice if this is a removable device */
1226 if (drive
->attach
) {
1230 ret
= !!(drive
->atapi_flags
& IDE_AFLAG_MEDIA_CHANGED
);
1231 drive
->atapi_flags
&= ~IDE_AFLAG_MEDIA_CHANGED
;
1235 static int idefloppy_revalidate_disk(struct gendisk
*disk
)
1237 struct ide_floppy_obj
*floppy
= ide_floppy_g(disk
);
1238 set_capacity(disk
, idefloppy_capacity(floppy
->drive
));
1242 static struct block_device_operations idefloppy_ops
= {
1243 .owner
= THIS_MODULE
,
1244 .open
= idefloppy_open
,
1245 .release
= idefloppy_release
,
1246 .ioctl
= idefloppy_ioctl
,
1247 .getgeo
= idefloppy_getgeo
,
1248 .media_changed
= idefloppy_media_changed
,
1249 .revalidate_disk
= idefloppy_revalidate_disk
1252 static int ide_floppy_probe(ide_drive_t
*drive
)
1254 idefloppy_floppy_t
*floppy
;
1257 if (!strstr("ide-floppy", drive
->driver_req
))
1260 if (drive
->media
!= ide_floppy
)
1263 if (!ide_check_atapi_device(drive
, DRV_NAME
)) {
1264 printk(KERN_ERR
"ide-floppy: %s: not supported by this version"
1265 " of ide-floppy\n", drive
->name
);
1268 floppy
= kzalloc(sizeof(idefloppy_floppy_t
), GFP_KERNEL
);
1270 printk(KERN_ERR
"ide-floppy: %s: Can't allocate a floppy"
1271 " structure\n", drive
->name
);
1275 g
= alloc_disk(1 << PARTN_BITS
);
1277 goto out_free_floppy
;
1279 ide_init_disk(g
, drive
);
1281 kref_init(&floppy
->kref
);
1283 floppy
->drive
= drive
;
1284 floppy
->driver
= &idefloppy_driver
;
1287 g
->private_data
= &floppy
->driver
;
1289 drive
->driver_data
= floppy
;
1291 idefloppy_setup(drive
, floppy
);
1293 g
->minors
= 1 << PARTN_BITS
;
1294 g
->driverfs_dev
= &drive
->gendev
;
1295 g
->flags
= drive
->removable
? GENHD_FL_REMOVABLE
: 0;
1296 g
->fops
= &idefloppy_ops
;
1307 static void __exit
idefloppy_exit(void)
1309 driver_unregister(&idefloppy_driver
.gen_driver
);
1312 static int __init
idefloppy_init(void)
1314 printk("ide-floppy driver " IDEFLOPPY_VERSION
"\n");
1315 return driver_register(&idefloppy_driver
.gen_driver
);
1318 MODULE_ALIAS("ide:*m-floppy*");
1319 module_init(idefloppy_init
);
1320 module_exit(idefloppy_exit
);
1321 MODULE_LICENSE("GPL");
1322 MODULE_DESCRIPTION("ATAPI FLOPPY Driver");