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
73 * With each packet command, we allocate a buffer of IDEFLOPPY_PC_BUFFER_SIZE
76 #define IDEFLOPPY_PC_BUFFER_SIZE 256
78 /* format capacities descriptor codes */
79 #define CAPACITY_INVALID 0x00
80 #define CAPACITY_UNFORMATTED 0x01
81 #define CAPACITY_CURRENT 0x02
82 #define CAPACITY_NO_CARTRIDGE 0x03
85 * Most of our global data which we need to save even as we leave the driver
86 * due to an interrupt or a timer event is stored in a variable of type
87 * idefloppy_floppy_t, defined below.
89 typedef struct ide_floppy_obj
{
94 unsigned int openers
; /* protected by BKL for now */
96 /* Current packet command */
97 struct ide_atapi_pc
*pc
;
98 /* Last failed packet command */
99 struct ide_atapi_pc
*failed_pc
;
100 /* used for blk_{fs,pc}_request() requests */
101 struct ide_atapi_pc queued_pc
;
103 struct ide_atapi_pc request_sense_pc
;
104 struct request request_sense_rq
;
106 /* Last error information */
107 u8 sense_key
, asc
, ascq
;
108 /* delay this long before sending packet command */
110 int progress_indication
;
112 /* Device information */
114 int blocks
, block_size
, bs_factor
;
115 /* Last format capacity descriptor */
117 /* Copy of the flexible disk page */
118 u8 flexible_disk_page
[32];
121 /* Supports format progress report */
123 } idefloppy_floppy_t
;
125 #define IDEFLOPPY_TICKS_DELAY HZ/20 /* default delay for ZIP 100 (50ms) */
127 /* IOCTLs used in low-level formatting. */
128 #define IDEFLOPPY_IOCTL_FORMAT_SUPPORTED 0x4600
129 #define IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY 0x4601
130 #define IDEFLOPPY_IOCTL_FORMAT_START 0x4602
131 #define IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS 0x4603
133 /* Error code returned in rq->errors to the higher part of the driver. */
134 #define IDEFLOPPY_ERROR_GENERAL 101
137 * Pages of the SELECT SENSE / MODE SENSE packet commands.
138 * See SFF-8070i spec.
140 #define IDEFLOPPY_CAPABILITIES_PAGE 0x1b
141 #define IDEFLOPPY_FLEXIBLE_DISK_PAGE 0x05
143 static DEFINE_MUTEX(idefloppy_ref_mutex
);
145 #define to_ide_floppy(obj) container_of(obj, struct ide_floppy_obj, kref)
147 #define ide_floppy_g(disk) \
148 container_of((disk)->private_data, struct ide_floppy_obj, driver)
150 static void idefloppy_cleanup_obj(struct kref
*);
152 static struct ide_floppy_obj
*ide_floppy_get(struct gendisk
*disk
)
154 struct ide_floppy_obj
*floppy
= NULL
;
156 mutex_lock(&idefloppy_ref_mutex
);
157 floppy
= ide_floppy_g(disk
);
159 if (ide_device_get(floppy
->drive
))
162 kref_get(&floppy
->kref
);
164 mutex_unlock(&idefloppy_ref_mutex
);
168 static void ide_floppy_put(struct ide_floppy_obj
*floppy
)
170 ide_drive_t
*drive
= floppy
->drive
;
172 mutex_lock(&idefloppy_ref_mutex
);
173 kref_put(&floppy
->kref
, idefloppy_cleanup_obj
);
174 ide_device_put(drive
);
175 mutex_unlock(&idefloppy_ref_mutex
);
179 * Used to finish servicing a request. For read/write requests, we will call
180 * ide_end_request to pass to the next buffer.
182 static int idefloppy_end_request(ide_drive_t
*drive
, int uptodate
, int nsecs
)
184 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
185 struct request
*rq
= HWGROUP(drive
)->rq
;
188 debug_log("Reached %s\n", __func__
);
191 case 0: error
= IDEFLOPPY_ERROR_GENERAL
; break;
192 case 1: error
= 0; break;
193 default: error
= uptodate
;
196 floppy
->failed_pc
= NULL
;
197 /* Why does this happen? */
200 if (!blk_special_request(rq
)) {
201 /* our real local end request function */
202 ide_end_request(drive
, uptodate
, nsecs
);
206 /* fixme: need to move this local also */
207 ide_end_drive_cmd(drive
, 0, 0);
211 static void ide_floppy_io_buffers(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
,
212 unsigned int bcount
, int direction
)
214 ide_hwif_t
*hwif
= drive
->hwif
;
215 const struct ide_tp_ops
*tp_ops
= hwif
->tp_ops
;
216 xfer_func_t
*xf
= direction
? tp_ops
->output_data
: tp_ops
->input_data
;
217 struct scatterlist
*sg
= pc
->sg
;
222 count
= min(sg
->length
- pc
->b_count
, bcount
);
223 if (PageHighMem(sg_page(sg
))) {
226 local_irq_save(flags
);
227 buf
= kmap_atomic(sg_page(sg
), KM_IRQ0
) + sg
->offset
;
228 xf(drive
, NULL
, buf
+ pc
->b_count
, count
);
229 kunmap_atomic(buf
- sg
->offset
, KM_IRQ0
);
230 local_irq_restore(flags
);
233 xf(drive
, NULL
, buf
+ pc
->b_count
, count
);
236 pc
->b_count
+= count
;
239 if (pc
->b_count
== sg
->length
) {
242 pc
->sg
= sg
= sg_next(sg
);
247 idefloppy_end_request(drive
, 1, done
>> 9);
250 printk(KERN_ERR
"%s: leftover data in %s, bcount == %d\n",
251 drive
->name
, __func__
, bcount
);
252 ide_pad_transfer(drive
, direction
, bcount
);
256 static void idefloppy_update_buffers(ide_drive_t
*drive
,
257 struct ide_atapi_pc
*pc
)
259 struct request
*rq
= pc
->rq
;
260 struct bio
*bio
= rq
->bio
;
262 while ((bio
= rq
->bio
) != NULL
)
263 idefloppy_end_request(drive
, 1, 0);
267 * Generate a new packet command request in front of the request queue, before
268 * the current request so that it will be processed immediately, on the next
269 * pass through the driver.
271 static void idefloppy_queue_pc_head(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
,
274 struct ide_floppy_obj
*floppy
= drive
->driver_data
;
276 blk_rq_init(NULL
, rq
);
277 rq
->buffer
= (char *) pc
;
278 rq
->cmd_type
= REQ_TYPE_SPECIAL
;
279 rq
->cmd_flags
|= REQ_PREEMPT
;
280 rq
->rq_disk
= floppy
->disk
;
281 memcpy(rq
->cmd
, pc
->c
, 12);
282 ide_do_drive_cmd(drive
, rq
);
285 static void ide_floppy_callback(ide_drive_t
*drive
)
287 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
288 struct ide_atapi_pc
*pc
= floppy
->pc
;
289 int uptodate
= pc
->error
? 0 : 1;
291 debug_log("Reached %s\n", __func__
);
293 if (floppy
->failed_pc
== pc
)
294 floppy
->failed_pc
= NULL
;
296 if (pc
->c
[0] == GPCMD_READ_10
|| pc
->c
[0] == GPCMD_WRITE_10
||
297 (pc
->rq
&& blk_pc_request(pc
->rq
)))
298 uptodate
= 1; /* FIXME */
299 else if (pc
->c
[0] == GPCMD_REQUEST_SENSE
) {
300 u8
*buf
= floppy
->pc
->buf
;
303 floppy
->sense_key
= buf
[2] & 0x0F;
304 floppy
->asc
= buf
[12];
305 floppy
->ascq
= buf
[13];
306 floppy
->progress_indication
= buf
[15] & 0x80 ?
307 (u16
)get_unaligned((u16
*)&buf
[16]) : 0x10000;
309 if (floppy
->failed_pc
)
310 debug_log("pc = %x, ", floppy
->failed_pc
->c
[0]);
312 debug_log("sense key = %x, asc = %x, ascq = %x\n",
313 floppy
->sense_key
, floppy
->asc
, floppy
->ascq
);
315 printk(KERN_ERR
"Error in REQUEST SENSE itself - "
316 "Aborting request!\n");
319 idefloppy_end_request(drive
, uptodate
, 0);
322 static void idefloppy_init_pc(struct ide_atapi_pc
*pc
)
324 memset(pc
, 0, sizeof(*pc
));
325 pc
->buf
= pc
->pc_buf
;
326 pc
->buf_size
= IDEFLOPPY_PC_BUFFER_SIZE
;
329 static void idefloppy_create_request_sense_cmd(struct ide_atapi_pc
*pc
)
331 idefloppy_init_pc(pc
);
332 pc
->c
[0] = GPCMD_REQUEST_SENSE
;
338 * Called when an error was detected during the last packet command. We queue a
339 * request sense packet command in the head of the request list.
341 static void idefloppy_retry_pc(ide_drive_t
*drive
)
343 struct ide_floppy_obj
*floppy
= drive
->driver_data
;
344 struct request
*rq
= &floppy
->request_sense_rq
;
345 struct ide_atapi_pc
*pc
= &floppy
->request_sense_pc
;
347 (void)ide_read_error(drive
);
348 idefloppy_create_request_sense_cmd(pc
);
349 idefloppy_queue_pc_head(drive
, pc
, rq
);
352 /* The usual interrupt handler called during a packet command. */
353 static ide_startstop_t
idefloppy_pc_intr(ide_drive_t
*drive
)
355 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
357 return ide_pc_intr(drive
, floppy
->pc
, idefloppy_pc_intr
,
358 IDEFLOPPY_WAIT_CMD
, NULL
, idefloppy_update_buffers
,
359 idefloppy_retry_pc
, NULL
, ide_floppy_io_buffers
);
363 * What we have here is a classic case of a top half / bottom half interrupt
364 * service routine. In interrupt mode, the device sends an interrupt to signal
365 * that it is ready to receive a packet. However, we need to delay about 2-3
366 * ticks before issuing the packet or we gets in trouble.
368 static int idefloppy_transfer_pc(ide_drive_t
*drive
)
370 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
372 /* Send the actual packet */
373 drive
->hwif
->tp_ops
->output_data(drive
, NULL
, floppy
->pc
->c
, 12);
375 /* Timeout for the packet command */
376 return IDEFLOPPY_WAIT_CMD
;
381 * Called as an interrupt (or directly). When the device says it's ready for a
382 * packet, we schedule the packet transfer to occur about 2-3 ticks later in
385 static ide_startstop_t
idefloppy_start_pc_transfer(ide_drive_t
*drive
)
387 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
388 struct ide_atapi_pc
*pc
= floppy
->pc
;
389 ide_expiry_t
*expiry
;
390 unsigned int timeout
;
393 * The following delay solves a problem with ATAPI Zip 100 drives
394 * where the Busy flag was apparently being deasserted before the
395 * unit was ready to receive data. This was happening on a
396 * 1200 MHz Athlon system. 10/26/01 25msec is too short,
397 * 40 and 50msec work well. idefloppy_pc_intr will not be actually
398 * used until after the packet is moved in about 50 msec.
400 if (drive
->atapi_flags
& IDE_AFLAG_ZIP_DRIVE
) {
401 timeout
= floppy
->ticks
;
402 expiry
= &idefloppy_transfer_pc
;
404 timeout
= IDEFLOPPY_WAIT_CMD
;
408 return ide_transfer_pc(drive
, pc
, idefloppy_pc_intr
, timeout
, expiry
);
411 static void ide_floppy_report_error(idefloppy_floppy_t
*floppy
,
412 struct ide_atapi_pc
*pc
)
414 /* supress error messages resulting from Medium not present */
415 if (floppy
->sense_key
== 0x02 &&
416 floppy
->asc
== 0x3a &&
417 floppy
->ascq
== 0x00)
420 printk(KERN_ERR
"ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
421 "asc = %2x, ascq = %2x\n",
422 floppy
->drive
->name
, pc
->c
[0], floppy
->sense_key
,
423 floppy
->asc
, floppy
->ascq
);
427 static ide_startstop_t
idefloppy_issue_pc(ide_drive_t
*drive
,
428 struct ide_atapi_pc
*pc
)
430 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
432 if (floppy
->failed_pc
== NULL
&&
433 pc
->c
[0] != GPCMD_REQUEST_SENSE
)
434 floppy
->failed_pc
= pc
;
435 /* Set the current packet command */
438 if (pc
->retries
> IDEFLOPPY_MAX_PC_RETRIES
) {
439 if (!(pc
->flags
& PC_FLAG_SUPPRESS_ERROR
))
440 ide_floppy_report_error(floppy
, pc
);
442 pc
->error
= IDEFLOPPY_ERROR_GENERAL
;
444 floppy
->failed_pc
= NULL
;
445 drive
->pc_callback(drive
);
449 debug_log("Retry number - %d\n", pc
->retries
);
453 return ide_issue_pc(drive
, pc
, idefloppy_start_pc_transfer
,
454 IDEFLOPPY_WAIT_CMD
, NULL
);
457 static void idefloppy_create_prevent_cmd(struct ide_atapi_pc
*pc
, int prevent
)
459 debug_log("creating prevent removal command, prevent = %d\n", prevent
);
461 idefloppy_init_pc(pc
);
462 pc
->c
[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL
;
466 static void idefloppy_create_read_capacity_cmd(struct ide_atapi_pc
*pc
)
468 idefloppy_init_pc(pc
);
469 pc
->c
[0] = GPCMD_READ_FORMAT_CAPACITIES
;
475 static void idefloppy_create_format_unit_cmd(struct ide_atapi_pc
*pc
, int b
,
478 idefloppy_init_pc(pc
);
479 pc
->c
[0] = GPCMD_FORMAT_UNIT
;
482 memset(pc
->buf
, 0, 12);
484 /* Default format list header, u8 1: FOV/DCRT/IMM bits set */
486 if (flags
& 1) /* Verify bit on... */
487 pc
->buf
[1] ^= 0x20; /* ... turn off DCRT bit */
490 put_unaligned(cpu_to_be32(b
), (unsigned int *)(&pc
->buf
[4]));
491 put_unaligned(cpu_to_be32(l
), (unsigned int *)(&pc
->buf
[8]));
493 pc
->flags
|= PC_FLAG_WRITING
;
496 /* A mode sense command is used to "sense" floppy parameters. */
497 static void idefloppy_create_mode_sense_cmd(struct ide_atapi_pc
*pc
,
500 u16 length
= 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
502 idefloppy_init_pc(pc
);
503 pc
->c
[0] = GPCMD_MODE_SENSE_10
;
505 pc
->c
[2] = page_code
;
508 case IDEFLOPPY_CAPABILITIES_PAGE
:
511 case IDEFLOPPY_FLEXIBLE_DISK_PAGE
:
515 printk(KERN_ERR
"ide-floppy: unsupported page code "
516 "in create_mode_sense_cmd\n");
518 put_unaligned(cpu_to_be16(length
), (u16
*) &pc
->c
[7]);
519 pc
->req_xfer
= length
;
522 static void idefloppy_create_start_stop_cmd(struct ide_atapi_pc
*pc
, int start
)
524 idefloppy_init_pc(pc
);
525 pc
->c
[0] = GPCMD_START_STOP_UNIT
;
529 static void idefloppy_create_rw_cmd(idefloppy_floppy_t
*floppy
,
530 struct ide_atapi_pc
*pc
, struct request
*rq
,
531 unsigned long sector
)
533 int block
= sector
/ floppy
->bs_factor
;
534 int blocks
= rq
->nr_sectors
/ floppy
->bs_factor
;
535 int cmd
= rq_data_dir(rq
);
537 debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
540 idefloppy_init_pc(pc
);
541 pc
->c
[0] = cmd
== READ
? GPCMD_READ_10
: GPCMD_WRITE_10
;
542 put_unaligned(cpu_to_be16(blocks
), (unsigned short *)&pc
->c
[7]);
543 put_unaligned(cpu_to_be32(block
), (unsigned int *) &pc
->c
[2]);
545 memcpy(rq
->cmd
, pc
->c
, 12);
549 if (rq
->cmd_flags
& REQ_RW
)
550 pc
->flags
|= PC_FLAG_WRITING
;
552 pc
->req_xfer
= pc
->buf_size
= blocks
* floppy
->block_size
;
553 pc
->flags
|= PC_FLAG_DMA_OK
;
556 static void idefloppy_blockpc_cmd(idefloppy_floppy_t
*floppy
,
557 struct ide_atapi_pc
*pc
, struct request
*rq
)
559 idefloppy_init_pc(pc
);
560 memcpy(pc
->c
, rq
->cmd
, sizeof(pc
->c
));
563 if (rq
->data_len
&& rq_data_dir(rq
) == WRITE
)
564 pc
->flags
|= PC_FLAG_WRITING
;
567 pc
->flags
|= PC_FLAG_DMA_OK
;
569 * possibly problematic, doesn't look like ide-floppy correctly
570 * handled scattered requests if dma fails...
572 pc
->req_xfer
= pc
->buf_size
= rq
->data_len
;
575 static ide_startstop_t
idefloppy_do_request(ide_drive_t
*drive
,
576 struct request
*rq
, sector_t block_s
)
578 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
579 ide_hwif_t
*hwif
= drive
->hwif
;
580 struct ide_atapi_pc
*pc
;
581 unsigned long block
= (unsigned long)block_s
;
583 debug_log("%s: dev: %s, cmd: 0x%x, cmd_type: %x, errors: %d\n",
584 __func__
, rq
->rq_disk
? rq
->rq_disk
->disk_name
: "?",
585 rq
->cmd
[0], rq
->cmd_type
, rq
->errors
);
587 debug_log("%s: sector: %ld, nr_sectors: %ld, current_nr_sectors: %d\n",
588 __func__
, (long)rq
->sector
, rq
->nr_sectors
,
589 rq
->current_nr_sectors
);
591 if (rq
->errors
>= ERROR_MAX
) {
592 if (floppy
->failed_pc
)
593 ide_floppy_report_error(floppy
, floppy
->failed_pc
);
595 printk(KERN_ERR
"ide-floppy: %s: I/O error\n",
597 idefloppy_end_request(drive
, 0, 0);
600 if (blk_fs_request(rq
)) {
601 if (((long)rq
->sector
% floppy
->bs_factor
) ||
602 (rq
->nr_sectors
% floppy
->bs_factor
)) {
603 printk(KERN_ERR
"%s: unsupported r/w request size\n",
605 idefloppy_end_request(drive
, 0, 0);
608 pc
= &floppy
->queued_pc
;
609 idefloppy_create_rw_cmd(floppy
, pc
, rq
, block
);
610 } else if (blk_special_request(rq
)) {
611 pc
= (struct ide_atapi_pc
*) rq
->buffer
;
612 } else if (blk_pc_request(rq
)) {
613 pc
= &floppy
->queued_pc
;
614 idefloppy_blockpc_cmd(floppy
, pc
, rq
);
616 blk_dump_rq_flags(rq
,
617 "ide-floppy: unsupported command in queue");
618 idefloppy_end_request(drive
, 0, 0);
622 ide_init_sg_cmd(drive
, rq
);
623 ide_map_sg(drive
, rq
);
625 pc
->sg
= hwif
->sg_table
;
626 pc
->sg_cnt
= hwif
->sg_nents
;
630 return idefloppy_issue_pc(drive
, pc
);
634 * Add a special packet command request to the tail of the request queue,
635 * and wait for it to be serviced.
637 static int idefloppy_queue_pc_tail(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
)
639 struct ide_floppy_obj
*floppy
= drive
->driver_data
;
643 rq
= blk_get_request(drive
->queue
, READ
, __GFP_WAIT
);
644 rq
->buffer
= (char *) pc
;
645 rq
->cmd_type
= REQ_TYPE_SPECIAL
;
646 memcpy(rq
->cmd
, pc
->c
, 12);
647 error
= blk_execute_rq(drive
->queue
, floppy
->disk
, rq
, 0);
654 * Look at the flexible disk page parameters. We ignore the CHS capacity
655 * parameters and use the LBA parameters instead.
657 static int ide_floppy_get_flexible_disk_page(ide_drive_t
*drive
)
659 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
660 struct ide_atapi_pc pc
;
662 int capacity
, lba_capacity
;
663 u16 transfer_rate
, sector_size
, cyls
, rpm
;
666 idefloppy_create_mode_sense_cmd(&pc
, IDEFLOPPY_FLEXIBLE_DISK_PAGE
);
668 if (idefloppy_queue_pc_tail(drive
, &pc
)) {
669 printk(KERN_ERR
"ide-floppy: Can't get flexible disk page"
673 floppy
->wp
= !!(pc
.buf
[3] & 0x80);
674 set_disk_ro(floppy
->disk
, floppy
->wp
);
677 transfer_rate
= be16_to_cpup((__be16
*)&pc
.buf
[8 + 2]);
678 sector_size
= be16_to_cpup((__be16
*)&pc
.buf
[8 + 6]);
679 cyls
= be16_to_cpup((__be16
*)&pc
.buf
[8 + 8]);
680 rpm
= be16_to_cpup((__be16
*)&pc
.buf
[8 + 28]);
681 heads
= pc
.buf
[8 + 4];
682 sectors
= pc
.buf
[8 + 5];
684 capacity
= cyls
* heads
* sectors
* sector_size
;
686 if (memcmp(page
, &floppy
->flexible_disk_page
, 32))
687 printk(KERN_INFO
"%s: %dkB, %d/%d/%d CHS, %d kBps, "
688 "%d sector size, %d rpm\n",
689 drive
->name
, capacity
/ 1024, cyls
, heads
,
690 sectors
, transfer_rate
/ 8, sector_size
, rpm
);
692 memcpy(&floppy
->flexible_disk_page
, page
, 32);
693 drive
->bios_cyl
= cyls
;
694 drive
->bios_head
= heads
;
695 drive
->bios_sect
= sectors
;
696 lba_capacity
= floppy
->blocks
* floppy
->block_size
;
698 if (capacity
< lba_capacity
) {
699 printk(KERN_NOTICE
"%s: The disk reports a capacity of %d "
700 "bytes, but the drive only handles %d\n",
701 drive
->name
, lba_capacity
, capacity
);
702 floppy
->blocks
= floppy
->block_size
?
703 capacity
/ floppy
->block_size
: 0;
708 static int idefloppy_get_sfrp_bit(ide_drive_t
*drive
)
710 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
711 struct ide_atapi_pc pc
;
715 idefloppy_create_mode_sense_cmd(&pc
, IDEFLOPPY_CAPABILITIES_PAGE
);
716 pc
.flags
|= PC_FLAG_SUPPRESS_ERROR
;
718 if (idefloppy_queue_pc_tail(drive
, &pc
))
721 floppy
->srfp
= pc
.buf
[8 + 2] & 0x40;
726 * Determine if a media is present in the floppy drive, and if so, its LBA
729 static int ide_floppy_get_capacity(ide_drive_t
*drive
)
731 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
732 struct ide_atapi_pc pc
;
734 u8 header_len
, desc_cnt
;
735 int i
, rc
= 1, blocks
, length
;
738 drive
->bios_head
= drive
->bios_sect
= 0;
740 floppy
->bs_factor
= 1;
741 set_capacity(floppy
->disk
, 0);
743 idefloppy_create_read_capacity_cmd(&pc
);
744 if (idefloppy_queue_pc_tail(drive
, &pc
)) {
745 printk(KERN_ERR
"ide-floppy: Can't get floppy parameters\n");
748 header_len
= pc
.buf
[3];
749 cap_desc
= &pc
.buf
[4];
750 desc_cnt
= header_len
/ 8; /* capacity descriptor of 8 bytes */
752 for (i
= 0; i
< desc_cnt
; i
++) {
753 unsigned int desc_start
= 4 + i
*8;
755 blocks
= be32_to_cpup((__be32
*)&pc
.buf
[desc_start
]);
756 length
= be16_to_cpup((__be16
*)&pc
.buf
[desc_start
+ 6]);
758 debug_log("Descriptor %d: %dkB, %d blocks, %d sector size\n",
759 i
, blocks
* length
/ 1024, blocks
, length
);
764 * the code below is valid only for the 1st descriptor, ie i=0
767 switch (pc
.buf
[desc_start
+ 4] & 0x03) {
768 /* Clik! drive returns this instead of CAPACITY_CURRENT */
769 case CAPACITY_UNFORMATTED
:
770 if (!(drive
->atapi_flags
& IDE_AFLAG_CLIK_DRIVE
))
772 * If it is not a clik drive, break out
773 * (maintains previous driver behaviour)
776 case CAPACITY_CURRENT
:
777 /* Normal Zip/LS-120 disks */
778 if (memcmp(cap_desc
, &floppy
->cap_desc
, 8))
779 printk(KERN_INFO
"%s: %dkB, %d blocks, %d "
780 "sector size\n", drive
->name
,
781 blocks
* length
/ 1024, blocks
, length
);
782 memcpy(&floppy
->cap_desc
, cap_desc
, 8);
784 if (!length
|| length
% 512) {
785 printk(KERN_NOTICE
"%s: %d bytes block size "
786 "not supported\n", drive
->name
, length
);
788 floppy
->blocks
= blocks
;
789 floppy
->block_size
= length
;
790 floppy
->bs_factor
= length
/ 512;
791 if (floppy
->bs_factor
!= 1)
792 printk(KERN_NOTICE
"%s: warning: non "
793 "512 bytes block size not "
799 case CAPACITY_NO_CARTRIDGE
:
801 * This is a KERN_ERR so it appears on screen
802 * for the user to see
804 printk(KERN_ERR
"%s: No disk in drive\n", drive
->name
);
806 case CAPACITY_INVALID
:
807 printk(KERN_ERR
"%s: Invalid capacity for disk "
808 "in drive\n", drive
->name
);
811 debug_log("Descriptor 0 Code: %d\n",
812 pc
.buf
[desc_start
+ 4] & 0x03);
815 /* Clik! disk does not support get_flexible_disk_page */
816 if (!(drive
->atapi_flags
& IDE_AFLAG_CLIK_DRIVE
))
817 (void) ide_floppy_get_flexible_disk_page(drive
);
819 set_capacity(floppy
->disk
, floppy
->blocks
* floppy
->bs_factor
);
824 * Obtain the list of formattable capacities.
825 * Very similar to ide_floppy_get_capacity, except that we push the capacity
826 * descriptors to userland, instead of our own structures.
828 * Userland gives us the following structure:
830 * struct idefloppy_format_capacities {
838 * userland initializes nformats to the number of allocated formats[] records.
839 * On exit we set nformats to the number of records we've actually initialized.
842 static int ide_floppy_get_format_capacities(ide_drive_t
*drive
, int __user
*arg
)
844 struct ide_atapi_pc pc
;
845 u8 header_len
, desc_cnt
;
846 int i
, blocks
, length
, u_array_size
, u_index
;
849 if (get_user(u_array_size
, arg
))
852 if (u_array_size
<= 0)
855 idefloppy_create_read_capacity_cmd(&pc
);
856 if (idefloppy_queue_pc_tail(drive
, &pc
)) {
857 printk(KERN_ERR
"ide-floppy: Can't get floppy parameters\n");
861 header_len
= pc
.buf
[3];
862 desc_cnt
= header_len
/ 8; /* capacity descriptor of 8 bytes */
868 * We always skip the first capacity descriptor. That's the current
869 * capacity. We are interested in the remaining descriptors, the
870 * formattable capacities.
872 for (i
= 1; i
< desc_cnt
; i
++) {
873 unsigned int desc_start
= 4 + i
*8;
875 if (u_index
>= u_array_size
)
876 break; /* User-supplied buffer too small */
878 blocks
= be32_to_cpup((__be32
*)&pc
.buf
[desc_start
]);
879 length
= be16_to_cpup((__be16
*)&pc
.buf
[desc_start
+ 6]);
881 if (put_user(blocks
, argp
))
886 if (put_user(length
, argp
))
894 if (put_user(u_index
, arg
))
901 * Get ATAPI_FORMAT_UNIT progress indication.
903 * Userland gives a pointer to an int. The int is set to a progress
904 * indicator 0-65536, with 65536=100%.
906 * If the drive does not support format progress indication, we just check
907 * the dsc bit, and return either 0 or 65536.
910 static int ide_floppy_get_format_progress(ide_drive_t
*drive
, int __user
*arg
)
912 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
913 struct ide_atapi_pc pc
;
914 int progress_indication
= 0x10000;
917 idefloppy_create_request_sense_cmd(&pc
);
918 if (idefloppy_queue_pc_tail(drive
, &pc
))
921 if (floppy
->sense_key
== 2 &&
924 progress_indication
= floppy
->progress_indication
;
926 /* Else assume format_unit has finished, and we're at 0x10000 */
928 ide_hwif_t
*hwif
= drive
->hwif
;
932 local_irq_save(flags
);
933 stat
= hwif
->tp_ops
->read_status(hwif
);
934 local_irq_restore(flags
);
936 progress_indication
= ((stat
& ATA_DSC
) == 0) ? 0 : 0x10000;
939 if (put_user(progress_indication
, arg
))
945 static sector_t
idefloppy_capacity(ide_drive_t
*drive
)
947 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
948 unsigned long capacity
= floppy
->blocks
* floppy
->bs_factor
;
953 #ifdef CONFIG_IDE_PROC_FS
954 ide_devset_rw(bios_cyl
, 0, 1023, bios_cyl
);
955 ide_devset_rw(bios_head
, 0, 255, bios_head
);
956 ide_devset_rw(bios_sect
, 0, 63, bios_sect
);
958 static int get_ticks(ide_drive_t
*drive
)
960 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
961 return floppy
->ticks
;
964 static int set_ticks(ide_drive_t
*drive
, int arg
)
966 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
971 IDE_DEVSET(ticks
, S_RW
, 0, 255, get_ticks
, set_ticks
);
973 static const struct ide_devset
*idefloppy_settings
[] = {
974 &ide_devset_bios_cyl
,
975 &ide_devset_bios_head
,
976 &ide_devset_bios_sect
,
982 static void idefloppy_setup(ide_drive_t
*drive
, idefloppy_floppy_t
*floppy
)
987 *((u16
*)&gcw
) = id
[ATA_ID_CONFIG
];
989 drive
->pc_callback
= ide_floppy_callback
;
991 if (((gcw
[0] & 0x60) >> 5) == 1)
992 drive
->atapi_flags
|= IDE_AFLAG_DRQ_INTERRUPT
;
994 * We used to check revisions here. At this point however I'm giving up.
995 * Just assume they are all broken, its easier.
997 * The actual reason for the workarounds was likely a driver bug after
998 * all rather than a firmware bug, and the workaround below used to hide
999 * it. It should be fixed as of version 1.9, but to be on the safe side
1000 * we'll leave the limitation below for the 2.2.x tree.
1002 if (!strncmp((char *)&id
[ATA_ID_PROD
], "IOMEGA ZIP 100 ATAPI", 20)) {
1003 drive
->atapi_flags
|= IDE_AFLAG_ZIP_DRIVE
;
1004 /* This value will be visible in the /proc/ide/hdx/settings */
1005 floppy
->ticks
= IDEFLOPPY_TICKS_DELAY
;
1006 blk_queue_max_sectors(drive
->queue
, 64);
1010 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
1011 * nasty clicking noises without it, so please don't remove this.
1013 if (strncmp((char *)&id
[ATA_ID_PROD
], "IOMEGA Clik!", 11) == 0) {
1014 blk_queue_max_sectors(drive
->queue
, 64);
1015 drive
->atapi_flags
|= IDE_AFLAG_CLIK_DRIVE
;
1018 (void) ide_floppy_get_capacity(drive
);
1020 ide_proc_register_driver(drive
, floppy
->driver
);
1023 static void ide_floppy_remove(ide_drive_t
*drive
)
1025 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
1026 struct gendisk
*g
= floppy
->disk
;
1028 ide_proc_unregister_driver(drive
, floppy
->driver
);
1032 ide_floppy_put(floppy
);
1035 static void idefloppy_cleanup_obj(struct kref
*kref
)
1037 struct ide_floppy_obj
*floppy
= to_ide_floppy(kref
);
1038 ide_drive_t
*drive
= floppy
->drive
;
1039 struct gendisk
*g
= floppy
->disk
;
1041 drive
->driver_data
= NULL
;
1042 g
->private_data
= NULL
;
1047 #ifdef CONFIG_IDE_PROC_FS
1048 static int proc_idefloppy_read_capacity(char *page
, char **start
, off_t off
,
1049 int count
, int *eof
, void *data
)
1051 ide_drive_t
*drive
= (ide_drive_t
*)data
;
1054 len
= sprintf(page
, "%llu\n", (long long)idefloppy_capacity(drive
));
1055 PROC_IDE_READ_RETURN(page
, start
, off
, count
, eof
, len
);
1058 static ide_proc_entry_t idefloppy_proc
[] = {
1059 { "capacity", S_IFREG
|S_IRUGO
, proc_idefloppy_read_capacity
, NULL
},
1060 { "geometry", S_IFREG
|S_IRUGO
, proc_ide_read_geometry
, NULL
},
1061 { NULL
, 0, NULL
, NULL
}
1063 #endif /* CONFIG_IDE_PROC_FS */
1065 static int ide_floppy_probe(ide_drive_t
*);
1067 static ide_driver_t idefloppy_driver
= {
1069 .owner
= THIS_MODULE
,
1070 .name
= "ide-floppy",
1071 .bus
= &ide_bus_type
,
1073 .probe
= ide_floppy_probe
,
1074 .remove
= ide_floppy_remove
,
1075 .version
= IDEFLOPPY_VERSION
,
1076 .media
= ide_floppy
,
1077 .do_request
= idefloppy_do_request
,
1078 .end_request
= idefloppy_end_request
,
1079 .error
= __ide_error
,
1080 #ifdef CONFIG_IDE_PROC_FS
1081 .proc
= idefloppy_proc
,
1082 .settings
= idefloppy_settings
,
1086 static int idefloppy_open(struct inode
*inode
, struct file
*filp
)
1088 struct gendisk
*disk
= inode
->i_bdev
->bd_disk
;
1089 struct ide_floppy_obj
*floppy
;
1091 struct ide_atapi_pc pc
;
1094 debug_log("Reached %s\n", __func__
);
1096 floppy
= ide_floppy_get(disk
);
1100 drive
= floppy
->drive
;
1104 if (floppy
->openers
== 1) {
1105 drive
->atapi_flags
&= ~IDE_AFLAG_FORMAT_IN_PROGRESS
;
1108 idefloppy_init_pc(&pc
);
1109 pc
.c
[0] = GPCMD_TEST_UNIT_READY
;
1111 if (idefloppy_queue_pc_tail(drive
, &pc
)) {
1112 idefloppy_create_start_stop_cmd(&pc
, 1);
1113 (void) idefloppy_queue_pc_tail(drive
, &pc
);
1116 if (ide_floppy_get_capacity(drive
)
1117 && (filp
->f_flags
& O_NDELAY
) == 0
1119 * Allow O_NDELAY to open a drive without a disk, or with an
1120 * unreadable disk, so that we can get the format capacity
1121 * of the drive or begin the format - Sam
1125 goto out_put_floppy
;
1128 if (floppy
->wp
&& (filp
->f_mode
& 2)) {
1130 goto out_put_floppy
;
1132 drive
->atapi_flags
|= IDE_AFLAG_MEDIA_CHANGED
;
1133 /* IOMEGA Clik! drives do not support lock/unlock commands */
1134 if (!(drive
->atapi_flags
& IDE_AFLAG_CLIK_DRIVE
)) {
1135 idefloppy_create_prevent_cmd(&pc
, 1);
1136 (void) idefloppy_queue_pc_tail(drive
, &pc
);
1138 check_disk_change(inode
->i_bdev
);
1139 } else if (drive
->atapi_flags
& IDE_AFLAG_FORMAT_IN_PROGRESS
) {
1141 goto out_put_floppy
;
1147 ide_floppy_put(floppy
);
1151 static int idefloppy_release(struct inode
*inode
, struct file
*filp
)
1153 struct gendisk
*disk
= inode
->i_bdev
->bd_disk
;
1154 struct ide_floppy_obj
*floppy
= ide_floppy_g(disk
);
1155 ide_drive_t
*drive
= floppy
->drive
;
1156 struct ide_atapi_pc pc
;
1158 debug_log("Reached %s\n", __func__
);
1160 if (floppy
->openers
== 1) {
1161 /* IOMEGA Clik! drives do not support lock/unlock commands */
1162 if (!(drive
->atapi_flags
& IDE_AFLAG_CLIK_DRIVE
)) {
1163 idefloppy_create_prevent_cmd(&pc
, 0);
1164 (void) idefloppy_queue_pc_tail(drive
, &pc
);
1167 drive
->atapi_flags
&= ~IDE_AFLAG_FORMAT_IN_PROGRESS
;
1172 ide_floppy_put(floppy
);
1177 static int idefloppy_getgeo(struct block_device
*bdev
, struct hd_geometry
*geo
)
1179 struct ide_floppy_obj
*floppy
= ide_floppy_g(bdev
->bd_disk
);
1180 ide_drive_t
*drive
= floppy
->drive
;
1182 geo
->heads
= drive
->bios_head
;
1183 geo
->sectors
= drive
->bios_sect
;
1184 geo
->cylinders
= (u16
)drive
->bios_cyl
; /* truncate */
1188 static int ide_floppy_lockdoor(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
,
1189 unsigned long arg
, unsigned int cmd
)
1191 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
1193 if (floppy
->openers
> 1)
1196 /* The IOMEGA Clik! Drive doesn't support this command -
1197 * no room for an eject mechanism */
1198 if (!(drive
->atapi_flags
& IDE_AFLAG_CLIK_DRIVE
)) {
1199 int prevent
= arg
? 1 : 0;
1201 if (cmd
== CDROMEJECT
)
1204 idefloppy_create_prevent_cmd(pc
, prevent
);
1205 (void) idefloppy_queue_pc_tail(floppy
->drive
, pc
);
1208 if (cmd
== CDROMEJECT
) {
1209 idefloppy_create_start_stop_cmd(pc
, 2);
1210 (void) idefloppy_queue_pc_tail(floppy
->drive
, pc
);
1216 static int ide_floppy_format_unit(ide_drive_t
*drive
, int __user
*arg
)
1218 idefloppy_floppy_t
*floppy
= drive
->driver_data
;
1219 struct ide_atapi_pc pc
;
1220 int blocks
, length
, flags
, err
= 0;
1222 if (floppy
->openers
> 1) {
1223 /* Don't format if someone is using the disk */
1224 drive
->atapi_flags
&= ~IDE_AFLAG_FORMAT_IN_PROGRESS
;
1228 drive
->atapi_flags
|= IDE_AFLAG_FORMAT_IN_PROGRESS
;
1231 * Send ATAPI_FORMAT_UNIT to the drive.
1233 * Userland gives us the following structure:
1235 * struct idefloppy_format_command {
1241 * flags is a bitmask, currently, the only defined flag is:
1243 * 0x01 - verify media after format.
1245 if (get_user(blocks
, arg
) ||
1246 get_user(length
, arg
+1) ||
1247 get_user(flags
, arg
+2)) {
1252 (void) idefloppy_get_sfrp_bit(drive
);
1253 idefloppy_create_format_unit_cmd(&pc
, blocks
, length
, flags
);
1255 if (idefloppy_queue_pc_tail(drive
, &pc
))
1260 drive
->atapi_flags
&= ~IDE_AFLAG_FORMAT_IN_PROGRESS
;
1264 static int ide_floppy_format_ioctl(ide_drive_t
*drive
, struct file
*file
,
1265 unsigned int cmd
, void __user
*argp
)
1268 case IDEFLOPPY_IOCTL_FORMAT_SUPPORTED
:
1270 case IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY
:
1271 return ide_floppy_get_format_capacities(drive
, argp
);
1272 case IDEFLOPPY_IOCTL_FORMAT_START
:
1273 if (!(file
->f_mode
& 2))
1275 return ide_floppy_format_unit(drive
, (int __user
*)argp
);
1276 case IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS
:
1277 return ide_floppy_get_format_progress(drive
, argp
);
1283 static int idefloppy_ioctl(struct inode
*inode
, struct file
*file
,
1284 unsigned int cmd
, unsigned long arg
)
1286 struct block_device
*bdev
= inode
->i_bdev
;
1287 struct ide_floppy_obj
*floppy
= ide_floppy_g(bdev
->bd_disk
);
1288 ide_drive_t
*drive
= floppy
->drive
;
1289 struct ide_atapi_pc pc
;
1290 void __user
*argp
= (void __user
*)arg
;
1293 if (cmd
== CDROMEJECT
|| cmd
== CDROM_LOCKDOOR
)
1294 return ide_floppy_lockdoor(drive
, &pc
, arg
, cmd
);
1296 err
= ide_floppy_format_ioctl(drive
, file
, cmd
, argp
);
1301 * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
1302 * and CDROM_SEND_PACKET (legacy) ioctls
1304 if (cmd
!= CDROM_SEND_PACKET
&& cmd
!= SCSI_IOCTL_SEND_COMMAND
)
1305 err
= scsi_cmd_ioctl(file
, bdev
->bd_disk
->queue
,
1306 bdev
->bd_disk
, cmd
, argp
);
1309 err
= generic_ide_ioctl(drive
, file
, bdev
, cmd
, arg
);
1314 static int idefloppy_media_changed(struct gendisk
*disk
)
1316 struct ide_floppy_obj
*floppy
= ide_floppy_g(disk
);
1317 ide_drive_t
*drive
= floppy
->drive
;
1320 /* do not scan partitions twice if this is a removable device */
1321 if (drive
->attach
) {
1325 ret
= !!(drive
->atapi_flags
& IDE_AFLAG_MEDIA_CHANGED
);
1326 drive
->atapi_flags
&= ~IDE_AFLAG_MEDIA_CHANGED
;
1330 static int idefloppy_revalidate_disk(struct gendisk
*disk
)
1332 struct ide_floppy_obj
*floppy
= ide_floppy_g(disk
);
1333 set_capacity(disk
, idefloppy_capacity(floppy
->drive
));
1337 static struct block_device_operations idefloppy_ops
= {
1338 .owner
= THIS_MODULE
,
1339 .open
= idefloppy_open
,
1340 .release
= idefloppy_release
,
1341 .ioctl
= idefloppy_ioctl
,
1342 .getgeo
= idefloppy_getgeo
,
1343 .media_changed
= idefloppy_media_changed
,
1344 .revalidate_disk
= idefloppy_revalidate_disk
1347 static int ide_floppy_probe(ide_drive_t
*drive
)
1349 idefloppy_floppy_t
*floppy
;
1352 if (!strstr("ide-floppy", drive
->driver_req
))
1355 if (drive
->media
!= ide_floppy
)
1358 if (!ide_check_atapi_device(drive
, DRV_NAME
)) {
1359 printk(KERN_ERR
"ide-floppy: %s: not supported by this version"
1360 " of ide-floppy\n", drive
->name
);
1363 floppy
= kzalloc(sizeof(idefloppy_floppy_t
), GFP_KERNEL
);
1365 printk(KERN_ERR
"ide-floppy: %s: Can't allocate a floppy"
1366 " structure\n", drive
->name
);
1370 g
= alloc_disk(1 << PARTN_BITS
);
1372 goto out_free_floppy
;
1374 ide_init_disk(g
, drive
);
1376 kref_init(&floppy
->kref
);
1378 floppy
->drive
= drive
;
1379 floppy
->driver
= &idefloppy_driver
;
1382 g
->private_data
= &floppy
->driver
;
1384 drive
->driver_data
= floppy
;
1386 idefloppy_setup(drive
, floppy
);
1388 g
->minors
= 1 << PARTN_BITS
;
1389 g
->driverfs_dev
= &drive
->gendev
;
1390 g
->flags
= drive
->removable
? GENHD_FL_REMOVABLE
: 0;
1391 g
->fops
= &idefloppy_ops
;
1402 static void __exit
idefloppy_exit(void)
1404 driver_unregister(&idefloppy_driver
.gen_driver
);
1407 static int __init
idefloppy_init(void)
1409 printk("ide-floppy driver " IDEFLOPPY_VERSION
"\n");
1410 return driver_register(&idefloppy_driver
.gen_driver
);
1413 MODULE_ALIAS("ide:*m-floppy*");
1414 module_init(idefloppy_init
);
1415 module_exit(idefloppy_exit
);
1416 MODULE_LICENSE("GPL");
1417 MODULE_DESCRIPTION("ATAPI FLOPPY Driver");