ide-floppy.c revision 568ca92774d2f6be4a7e2f8357559bfdc9424056
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#define IDEFLOPPY_VERSION "1.00"
19
20#include <linux/module.h>
21#include <linux/types.h>
22#include <linux/string.h>
23#include <linux/kernel.h>
24#include <linux/delay.h>
25#include <linux/timer.h>
26#include <linux/mm.h>
27#include <linux/interrupt.h>
28#include <linux/major.h>
29#include <linux/errno.h>
30#include <linux/genhd.h>
31#include <linux/slab.h>
32#include <linux/cdrom.h>
33#include <linux/ide.h>
34#include <linux/bitops.h>
35#include <linux/mutex.h>
36
37#include <scsi/scsi_ioctl.h>
38
39#include <asm/byteorder.h>
40#include <linux/irq.h>
41#include <linux/uaccess.h>
42#include <linux/io.h>
43#include <asm/unaligned.h>
44
45/* define to see debug info */
46#define IDEFLOPPY_DEBUG_LOG		0
47
48/* #define IDEFLOPPY_DEBUG(fmt, args...) printk(KERN_INFO fmt, ## args) */
49#define IDEFLOPPY_DEBUG(fmt, args...)
50
51#if IDEFLOPPY_DEBUG_LOG
52#define debug_log(fmt, args...) \
53	printk(KERN_INFO "ide-floppy: " fmt, ## args)
54#else
55#define debug_log(fmt, args...) do {} while (0)
56#endif
57
58
59/* Some drives require a longer irq timeout. */
60#define IDEFLOPPY_WAIT_CMD		(5 * WAIT_CMD)
61
62/*
63 * After each failed packet command we issue a request sense command and retry
64 * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
65 */
66#define IDEFLOPPY_MAX_PC_RETRIES	3
67
68/*
69 * With each packet command, we allocate a buffer of IDEFLOPPY_PC_BUFFER_SIZE
70 * bytes.
71 */
72#define IDEFLOPPY_PC_BUFFER_SIZE	256
73
74/*
75 * In various places in the driver, we need to allocate storage for packet
76 * commands and requests, which will remain valid while	we leave the driver to
77 * wait for an interrupt or a timeout event.
78 */
79#define IDEFLOPPY_PC_STACK		(10 + IDEFLOPPY_MAX_PC_RETRIES)
80
81/* format capacities descriptor codes */
82#define CAPACITY_INVALID	0x00
83#define CAPACITY_UNFORMATTED	0x01
84#define CAPACITY_CURRENT	0x02
85#define CAPACITY_NO_CARTRIDGE	0x03
86
87/*
88 * Most of our global data which we need to save even as we leave the driver
89 * due to an interrupt or a timer event is stored in a variable of type
90 * idefloppy_floppy_t, defined below.
91 */
92typedef struct ide_floppy_obj {
93	ide_drive_t	*drive;
94	ide_driver_t	*driver;
95	struct gendisk	*disk;
96	struct kref	kref;
97	unsigned int	openers;	/* protected by BKL for now */
98
99	/* Current packet command */
100	struct ide_atapi_pc *pc;
101	/* Last failed packet command */
102	struct ide_atapi_pc *failed_pc;
103	/* Packet command stack */
104	struct ide_atapi_pc pc_stack[IDEFLOPPY_PC_STACK];
105	/* Next free packet command storage space */
106	int pc_stack_index;
107	struct request rq_stack[IDEFLOPPY_PC_STACK];
108	/* We implement a circular array */
109	int rq_stack_index;
110
111	/* Last error information */
112	u8 sense_key, asc, ascq;
113	/* delay this long before sending packet command */
114	u8 ticks;
115	int progress_indication;
116
117	/* Device information */
118	/* Current format */
119	int blocks, block_size, bs_factor;
120	/* Last format capacity descriptor */
121	u8 cap_desc[8];
122	/* Copy of the flexible disk page */
123	u8 flexible_disk_page[32];
124	/* Write protect */
125	int wp;
126	/* Supports format progress report */
127	int srfp;
128	/* Status/Action flags */
129	unsigned long flags;
130} idefloppy_floppy_t;
131
132#define IDEFLOPPY_TICKS_DELAY	HZ/20	/* default delay for ZIP 100 (50ms) */
133
134/* Floppy flag bits values. */
135enum {
136	/* DRQ interrupt device */
137	IDEFLOPPY_FLAG_DRQ_INTERRUPT		= (1 <<	0),
138	/* Media may have changed */
139	IDEFLOPPY_FLAG_MEDIA_CHANGED		= (1 << 1),
140	/* Format in progress */
141	IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS	= (1 << 2),
142	/* Avoid commands not supported in Clik drive */
143	IDEFLOPPY_FLAG_CLIK_DRIVE		= (1 << 3),
144	/* Requires BH algorithm for packets */
145	IDEFLOPPY_FLAG_ZIP_DRIVE		= (1 << 4),
146};
147
148/* Defines for the MODE SENSE command */
149#define MODE_SENSE_CURRENT		0x00
150#define MODE_SENSE_CHANGEABLE		0x01
151#define MODE_SENSE_DEFAULT		0x02
152#define MODE_SENSE_SAVED		0x03
153
154/* IOCTLs used in low-level formatting. */
155#define	IDEFLOPPY_IOCTL_FORMAT_SUPPORTED	0x4600
156#define	IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY	0x4601
157#define	IDEFLOPPY_IOCTL_FORMAT_START		0x4602
158#define IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS	0x4603
159
160/* Error code returned in rq->errors to the higher part of the driver. */
161#define	IDEFLOPPY_ERROR_GENERAL		101
162
163/*
164 * Pages of the SELECT SENSE / MODE SENSE packet commands.
165 * See SFF-8070i spec.
166 */
167#define	IDEFLOPPY_CAPABILITIES_PAGE	0x1b
168#define IDEFLOPPY_FLEXIBLE_DISK_PAGE	0x05
169
170static DEFINE_MUTEX(idefloppy_ref_mutex);
171
172#define to_ide_floppy(obj) container_of(obj, struct ide_floppy_obj, kref)
173
174#define ide_floppy_g(disk) \
175	container_of((disk)->private_data, struct ide_floppy_obj, driver)
176
177static struct ide_floppy_obj *ide_floppy_get(struct gendisk *disk)
178{
179	struct ide_floppy_obj *floppy = NULL;
180
181	mutex_lock(&idefloppy_ref_mutex);
182	floppy = ide_floppy_g(disk);
183	if (floppy)
184		kref_get(&floppy->kref);
185	mutex_unlock(&idefloppy_ref_mutex);
186	return floppy;
187}
188
189static void idefloppy_cleanup_obj(struct kref *);
190
191static void ide_floppy_put(struct ide_floppy_obj *floppy)
192{
193	mutex_lock(&idefloppy_ref_mutex);
194	kref_put(&floppy->kref, idefloppy_cleanup_obj);
195	mutex_unlock(&idefloppy_ref_mutex);
196}
197
198/*
199 * Used to finish servicing a request. For read/write requests, we will call
200 * ide_end_request to pass to the next buffer.
201 */
202static int idefloppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
203{
204	idefloppy_floppy_t *floppy = drive->driver_data;
205	struct request *rq = HWGROUP(drive)->rq;
206	int error;
207
208	debug_log("Reached %s\n", __func__);
209
210	switch (uptodate) {
211	case 0: error = IDEFLOPPY_ERROR_GENERAL; break;
212	case 1: error = 0; break;
213	default: error = uptodate;
214	}
215	if (error)
216		floppy->failed_pc = NULL;
217	/* Why does this happen? */
218	if (!rq)
219		return 0;
220	if (!blk_special_request(rq)) {
221		/* our real local end request function */
222		ide_end_request(drive, uptodate, nsecs);
223		return 0;
224	}
225	rq->errors = error;
226	/* fixme: need to move this local also */
227	ide_end_drive_cmd(drive, 0, 0);
228	return 0;
229}
230
231static void ide_floppy_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
232				  unsigned int bcount, int direction)
233{
234	ide_hwif_t *hwif = drive->hwif;
235	struct request *rq = pc->rq;
236	struct req_iterator iter;
237	struct bio_vec *bvec;
238	unsigned long flags;
239	int count, done = 0;
240	char *data;
241
242	rq_for_each_segment(bvec, rq, iter) {
243		if (!bcount)
244			break;
245
246		count = min(bvec->bv_len, bcount);
247
248		data = bvec_kmap_irq(bvec, &flags);
249		if (direction)
250			hwif->output_data(drive, NULL, data, count);
251		else
252			hwif->input_data(drive, NULL, data, count);
253		bvec_kunmap_irq(data, &flags);
254
255		bcount -= count;
256		pc->b_count += count;
257		done += count;
258	}
259
260	idefloppy_end_request(drive, 1, done >> 9);
261
262	if (bcount) {
263		printk(KERN_ERR "%s: leftover data in %s, bcount == %d\n",
264				drive->name, __func__, bcount);
265		ide_pad_transfer(drive, direction, bcount);
266	}
267}
268
269static void idefloppy_update_buffers(ide_drive_t *drive,
270				struct ide_atapi_pc *pc)
271{
272	struct request *rq = pc->rq;
273	struct bio *bio = rq->bio;
274
275	while ((bio = rq->bio) != NULL)
276		idefloppy_end_request(drive, 1, 0);
277}
278
279/*
280 * Generate a new packet command request in front of the request queue, before
281 * the current request so that it will be processed immediately, on the next
282 * pass through the driver.
283 */
284static void idefloppy_queue_pc_head(ide_drive_t *drive, struct ide_atapi_pc *pc,
285		struct request *rq)
286{
287	struct ide_floppy_obj *floppy = drive->driver_data;
288
289	blk_rq_init(NULL, rq);
290	rq->buffer = (char *) pc;
291	rq->cmd_type = REQ_TYPE_SPECIAL;
292	rq->cmd_flags |= REQ_PREEMPT;
293	rq->rq_disk = floppy->disk;
294	ide_do_drive_cmd(drive, rq);
295}
296
297static struct ide_atapi_pc *idefloppy_next_pc_storage(ide_drive_t *drive)
298{
299	idefloppy_floppy_t *floppy = drive->driver_data;
300
301	if (floppy->pc_stack_index == IDEFLOPPY_PC_STACK)
302		floppy->pc_stack_index = 0;
303	return (&floppy->pc_stack[floppy->pc_stack_index++]);
304}
305
306static struct request *idefloppy_next_rq_storage(ide_drive_t *drive)
307{
308	idefloppy_floppy_t *floppy = drive->driver_data;
309
310	if (floppy->rq_stack_index == IDEFLOPPY_PC_STACK)
311		floppy->rq_stack_index = 0;
312	return (&floppy->rq_stack[floppy->rq_stack_index++]);
313}
314
315static void idefloppy_request_sense_callback(ide_drive_t *drive)
316{
317	idefloppy_floppy_t *floppy = drive->driver_data;
318	u8 *buf = floppy->pc->buf;
319
320	debug_log("Reached %s\n", __func__);
321
322	if (!floppy->pc->error) {
323		floppy->sense_key = buf[2] & 0x0F;
324		floppy->asc = buf[12];
325		floppy->ascq = buf[13];
326		floppy->progress_indication = buf[15] & 0x80 ?
327			(u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
328
329		if (floppy->failed_pc)
330			debug_log("pc = %x, sense key = %x, asc = %x,"
331					" ascq = %x\n",
332					floppy->failed_pc->c[0],
333					floppy->sense_key,
334					floppy->asc,
335					floppy->ascq);
336		else
337			debug_log("sense key = %x, asc = %x, ascq = %x\n",
338					floppy->sense_key,
339					floppy->asc,
340					floppy->ascq);
341
342
343		idefloppy_end_request(drive, 1, 0);
344	} else {
345		printk(KERN_ERR "Error in REQUEST SENSE itself - Aborting"
346				" request!\n");
347		idefloppy_end_request(drive, 0, 0);
348	}
349}
350
351/* General packet command callback function. */
352static void idefloppy_pc_callback(ide_drive_t *drive)
353{
354	idefloppy_floppy_t *floppy = drive->driver_data;
355
356	debug_log("Reached %s\n", __func__);
357
358	idefloppy_end_request(drive, floppy->pc->error ? 0 : 1, 0);
359}
360
361static void idefloppy_init_pc(struct ide_atapi_pc *pc)
362{
363	memset(pc->c, 0, 12);
364	pc->retries = 0;
365	pc->flags = 0;
366	pc->req_xfer = 0;
367	pc->buf = pc->pc_buf;
368	pc->buf_size = IDEFLOPPY_PC_BUFFER_SIZE;
369	pc->idefloppy_callback = &idefloppy_pc_callback;
370}
371
372static void idefloppy_create_request_sense_cmd(struct ide_atapi_pc *pc)
373{
374	idefloppy_init_pc(pc);
375	pc->c[0] = GPCMD_REQUEST_SENSE;
376	pc->c[4] = 255;
377	pc->req_xfer = 18;
378	pc->idefloppy_callback = &idefloppy_request_sense_callback;
379}
380
381/*
382 * Called when an error was detected during the last packet command. We queue a
383 * request sense packet command in the head of the request list.
384 */
385static void idefloppy_retry_pc(ide_drive_t *drive)
386{
387	struct ide_atapi_pc *pc;
388	struct request *rq;
389
390	(void)ide_read_error(drive);
391	pc = idefloppy_next_pc_storage(drive);
392	rq = idefloppy_next_rq_storage(drive);
393	idefloppy_create_request_sense_cmd(pc);
394	idefloppy_queue_pc_head(drive, pc, rq);
395}
396
397/* The usual interrupt handler called during a packet command. */
398static ide_startstop_t idefloppy_pc_intr(ide_drive_t *drive)
399{
400	idefloppy_floppy_t *floppy = drive->driver_data;
401	ide_hwif_t *hwif = drive->hwif;
402	struct ide_atapi_pc *pc = floppy->pc;
403	struct request *rq = pc->rq;
404	xfer_func_t *xferfunc;
405	unsigned int temp;
406	int dma_error = 0;
407	u16 bcount;
408	u8 stat, ireason;
409
410	debug_log("Reached %s interrupt handler\n", __func__);
411
412	if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
413		dma_error = hwif->dma_ops->dma_end(drive);
414		if (dma_error) {
415			printk(KERN_ERR "%s: DMA %s error\n", drive->name,
416					rq_data_dir(rq) ? "write" : "read");
417			pc->flags |= PC_FLAG_DMA_ERROR;
418		} else {
419			pc->xferred = pc->req_xfer;
420			idefloppy_update_buffers(drive, pc);
421		}
422		debug_log("DMA finished\n");
423	}
424
425	/* Clear the interrupt */
426	stat = ide_read_status(drive);
427
428	/* No more interrupts */
429	if ((stat & DRQ_STAT) == 0) {
430		debug_log("Packet command completed, %d bytes transferred\n",
431				pc->xferred);
432		pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
433
434		local_irq_enable_in_hardirq();
435
436		if ((stat & ERR_STAT) || (pc->flags & PC_FLAG_DMA_ERROR)) {
437			/* Error detected */
438			debug_log("%s: I/O error\n", drive->name);
439			rq->errors++;
440			if (pc->c[0] == GPCMD_REQUEST_SENSE) {
441				printk(KERN_ERR "%s: I/O error in request sense"
442						" command\n", drive->name);
443				return ide_do_reset(drive);
444			}
445			/* Retry operation */
446			idefloppy_retry_pc(drive);
447			/* queued, but not started */
448			return ide_stopped;
449		}
450		pc->error = 0;
451		if (floppy->failed_pc == pc)
452			floppy->failed_pc = NULL;
453		/* Command finished - Call the callback function */
454		pc->idefloppy_callback(drive);
455		return ide_stopped;
456	}
457
458	if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
459		pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
460		printk(KERN_ERR "%s: The device wants to issue more interrupts "
461				"in DMA mode\n", drive->name);
462		ide_dma_off(drive);
463		return ide_do_reset(drive);
464	}
465
466	/* Get the number of bytes to transfer */
467	bcount = (hwif->INB(hwif->io_ports.lbah_addr) << 8) |
468		  hwif->INB(hwif->io_ports.lbam_addr);
469	/* on this interrupt */
470	ireason = hwif->INB(hwif->io_ports.nsect_addr);
471
472	if (ireason & CD) {
473		printk(KERN_ERR "%s: CoD != 0 in %s\n", drive->name, __func__);
474		return ide_do_reset(drive);
475	}
476	if (((ireason & IO) == IO) == !!(pc->flags & PC_FLAG_WRITING)) {
477		/* Hopefully, we will never get here */
478		printk(KERN_ERR "%s: We wanted to %s, but the device wants us "
479				"to %s!\n", drive->name,
480				(ireason & IO) ? "Write" : "Read",
481				(ireason & IO) ? "Read" : "Write");
482		return ide_do_reset(drive);
483	}
484	if (!(pc->flags & PC_FLAG_WRITING)) {
485		/* Reading - Check that we have enough space */
486		temp = pc->xferred + bcount;
487		if (temp > pc->req_xfer) {
488			if (temp > pc->buf_size) {
489				printk(KERN_ERR "%s: The device wants to send "
490						"us more data than expected - "
491						"discarding data\n",
492						drive->name);
493				ide_pad_transfer(drive, 0, bcount);
494
495				ide_set_handler(drive,
496						&idefloppy_pc_intr,
497						IDEFLOPPY_WAIT_CMD,
498						NULL);
499				return ide_started;
500			}
501			debug_log("The device wants to send us more data than "
502				  "expected - allowing transfer\n");
503		}
504	}
505	if (pc->flags & PC_FLAG_WRITING)
506		xferfunc = hwif->output_data;
507	else
508		xferfunc = hwif->input_data;
509
510	if (pc->buf)
511		xferfunc(drive, NULL, pc->cur_pos, bcount);
512	else
513		ide_floppy_io_buffers(drive, pc, bcount,
514				      !!(pc->flags & PC_FLAG_WRITING));
515
516	/* Update the current position */
517	pc->xferred += bcount;
518	pc->cur_pos += bcount;
519
520	/* And set the interrupt handler again */
521	ide_set_handler(drive, &idefloppy_pc_intr, IDEFLOPPY_WAIT_CMD, NULL);
522	return ide_started;
523}
524
525/*
526 * What we have here is a classic case of a top half / bottom half interrupt
527 * service routine. In interrupt mode, the device sends an interrupt to signal
528 * that it is ready to receive a packet. However, we need to delay about 2-3
529 * ticks before issuing the packet or we gets in trouble.
530 *
531 * So, follow carefully. transfer_pc1 is called as an interrupt (or directly).
532 * In either case, when the device says it's ready for a packet, we schedule
533 * the packet transfer to occur about 2-3 ticks later in transfer_pc2.
534 */
535static int idefloppy_transfer_pc2(ide_drive_t *drive)
536{
537	idefloppy_floppy_t *floppy = drive->driver_data;
538
539	/* Send the actual packet */
540	drive->hwif->output_data(drive, NULL, floppy->pc->c, 12);
541
542	/* Timeout for the packet command */
543	return IDEFLOPPY_WAIT_CMD;
544}
545
546static ide_startstop_t idefloppy_transfer_pc1(ide_drive_t *drive)
547{
548	ide_hwif_t *hwif = drive->hwif;
549	idefloppy_floppy_t *floppy = drive->driver_data;
550	ide_expiry_t *expiry;
551	unsigned int timeout;
552	ide_startstop_t startstop;
553	u8 ireason;
554
555	if (ide_wait_stat(&startstop, drive, DRQ_STAT, BUSY_STAT, WAIT_READY)) {
556		printk(KERN_ERR "%s: Strange, packet command initiated yet "
557				"DRQ isn't asserted\n", drive->name);
558		return startstop;
559	}
560	ireason = hwif->INB(hwif->io_ports.nsect_addr);
561	if ((ireason & CD) == 0 || (ireason & IO)) {
562		printk(KERN_ERR "%s: (IO,CoD) != (0,1) while issuing "
563				"a packet command\n", drive->name);
564		return ide_do_reset(drive);
565	}
566	/*
567	 * The following delay solves a problem with ATAPI Zip 100 drives
568	 * where the Busy flag was apparently being deasserted before the
569	 * unit was ready to receive data. This was happening on a
570	 * 1200 MHz Athlon system. 10/26/01 25msec is too short,
571	 * 40 and 50msec work well. idefloppy_pc_intr will not be actually
572	 * used until after the packet is moved in about 50 msec.
573	 */
574	if (floppy->flags & IDEFLOPPY_FLAG_ZIP_DRIVE) {
575		timeout = floppy->ticks;
576		expiry = &idefloppy_transfer_pc2;
577	} else {
578		timeout = IDEFLOPPY_WAIT_CMD;
579		expiry = NULL;
580	}
581
582	ide_set_handler(drive, &idefloppy_pc_intr, timeout, expiry);
583
584	if ((floppy->flags & IDEFLOPPY_FLAG_ZIP_DRIVE) == 0)
585		/* Send the actual packet */
586		hwif->output_data(drive, NULL, floppy->pc->c, 12);
587
588	return ide_started;
589}
590
591static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
592				    struct ide_atapi_pc *pc)
593{
594	/* supress error messages resulting from Medium not present */
595	if (floppy->sense_key == 0x02 &&
596	    floppy->asc       == 0x3a &&
597	    floppy->ascq      == 0x00)
598		return;
599
600	printk(KERN_ERR "ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
601			"asc = %2x, ascq = %2x\n",
602			floppy->drive->name, pc->c[0], floppy->sense_key,
603			floppy->asc, floppy->ascq);
604
605}
606
607static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
608		struct ide_atapi_pc *pc)
609{
610	idefloppy_floppy_t *floppy = drive->driver_data;
611	ide_hwif_t *hwif = drive->hwif;
612	u16 bcount;
613	u8 dma;
614
615	if (floppy->failed_pc == NULL &&
616	    pc->c[0] != GPCMD_REQUEST_SENSE)
617		floppy->failed_pc = pc;
618	/* Set the current packet command */
619	floppy->pc = pc;
620
621	if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
622		if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
623			ide_floppy_report_error(floppy, pc);
624		/* Giving up */
625		pc->error = IDEFLOPPY_ERROR_GENERAL;
626
627		floppy->failed_pc = NULL;
628		pc->idefloppy_callback(drive);
629		return ide_stopped;
630	}
631
632	debug_log("Retry number - %d\n", pc->retries);
633
634	pc->retries++;
635	/* We haven't transferred any data yet */
636	pc->xferred = 0;
637	pc->cur_pos = pc->buf;
638	bcount = min(pc->req_xfer, 63 * 1024);
639
640	if (pc->flags & PC_FLAG_DMA_ERROR) {
641		pc->flags &= ~PC_FLAG_DMA_ERROR;
642		ide_dma_off(drive);
643	}
644	dma = 0;
645
646	if ((pc->flags & PC_FLAG_DMA_RECOMMENDED) && drive->using_dma)
647		dma = !hwif->dma_ops->dma_setup(drive);
648
649	ide_pktcmd_tf_load(drive, IDE_TFLAG_OUT_DEVICE, bcount, dma);
650
651	if (dma) {
652		/* Begin DMA, if necessary */
653		pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
654		hwif->dma_ops->dma_start(drive);
655	}
656
657	if (floppy->flags & IDEFLOPPY_FLAG_DRQ_INTERRUPT) {
658		/* Issue the packet command */
659		ide_execute_command(drive, WIN_PACKETCMD,
660				&idefloppy_transfer_pc1,
661				IDEFLOPPY_WAIT_CMD,
662				NULL);
663		return ide_started;
664	} else {
665		/* Issue the packet command */
666		ide_execute_pkt_cmd(drive);
667		return idefloppy_transfer_pc1(drive);
668	}
669}
670
671static void idefloppy_rw_callback(ide_drive_t *drive)
672{
673	debug_log("Reached %s\n", __func__);
674
675	idefloppy_end_request(drive, 1, 0);
676	return;
677}
678
679static void idefloppy_create_prevent_cmd(struct ide_atapi_pc *pc, int prevent)
680{
681	debug_log("creating prevent removal command, prevent = %d\n", prevent);
682
683	idefloppy_init_pc(pc);
684	pc->c[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL;
685	pc->c[4] = prevent;
686}
687
688static void idefloppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
689{
690	idefloppy_init_pc(pc);
691	pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
692	pc->c[7] = 255;
693	pc->c[8] = 255;
694	pc->req_xfer = 255;
695}
696
697static void idefloppy_create_format_unit_cmd(struct ide_atapi_pc *pc, int b,
698		int l, int flags)
699{
700	idefloppy_init_pc(pc);
701	pc->c[0] = GPCMD_FORMAT_UNIT;
702	pc->c[1] = 0x17;
703
704	memset(pc->buf, 0, 12);
705	pc->buf[1] = 0xA2;
706	/* Default format list header, u8 1: FOV/DCRT/IMM bits set */
707
708	if (flags & 1)				/* Verify bit on... */
709		pc->buf[1] ^= 0x20;		/* ... turn off DCRT bit */
710	pc->buf[3] = 8;
711
712	put_unaligned(cpu_to_be32(b), (unsigned int *)(&pc->buf[4]));
713	put_unaligned(cpu_to_be32(l), (unsigned int *)(&pc->buf[8]));
714	pc->buf_size = 12;
715	pc->flags |= PC_FLAG_WRITING;
716}
717
718/* A mode sense command is used to "sense" floppy parameters. */
719static void idefloppy_create_mode_sense_cmd(struct ide_atapi_pc *pc,
720		u8 page_code, u8 type)
721{
722	u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
723
724	idefloppy_init_pc(pc);
725	pc->c[0] = GPCMD_MODE_SENSE_10;
726	pc->c[1] = 0;
727	pc->c[2] = page_code + (type << 6);
728
729	switch (page_code) {
730	case IDEFLOPPY_CAPABILITIES_PAGE:
731		length += 12;
732		break;
733	case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
734		length += 32;
735		break;
736	default:
737		printk(KERN_ERR "ide-floppy: unsupported page code "
738				"in create_mode_sense_cmd\n");
739	}
740	put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
741	pc->req_xfer = length;
742}
743
744static void idefloppy_create_start_stop_cmd(struct ide_atapi_pc *pc, int start)
745{
746	idefloppy_init_pc(pc);
747	pc->c[0] = GPCMD_START_STOP_UNIT;
748	pc->c[4] = start;
749}
750
751static void idefloppy_create_test_unit_ready_cmd(struct ide_atapi_pc *pc)
752{
753	idefloppy_init_pc(pc);
754	pc->c[0] = GPCMD_TEST_UNIT_READY;
755}
756
757static void idefloppy_create_rw_cmd(idefloppy_floppy_t *floppy,
758				    struct ide_atapi_pc *pc, struct request *rq,
759				    unsigned long sector)
760{
761	int block = sector / floppy->bs_factor;
762	int blocks = rq->nr_sectors / floppy->bs_factor;
763	int cmd = rq_data_dir(rq);
764
765	debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
766		block, blocks);
767
768	idefloppy_init_pc(pc);
769	pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
770	put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
771	put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
772
773	pc->idefloppy_callback = &idefloppy_rw_callback;
774	pc->rq = rq;
775	pc->b_count = cmd == READ ? 0 : rq->bio->bi_size;
776	if (rq->cmd_flags & REQ_RW)
777		pc->flags |= PC_FLAG_WRITING;
778	pc->buf = NULL;
779	pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
780	pc->flags |= PC_FLAG_DMA_RECOMMENDED;
781}
782
783static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
784		struct ide_atapi_pc *pc, struct request *rq)
785{
786	idefloppy_init_pc(pc);
787	pc->idefloppy_callback = &idefloppy_rw_callback;
788	memcpy(pc->c, rq->cmd, sizeof(pc->c));
789	pc->rq = rq;
790	pc->b_count = rq->data_len;
791	if (rq->data_len && rq_data_dir(rq) == WRITE)
792		pc->flags |= PC_FLAG_WRITING;
793	pc->buf = rq->data;
794	if (rq->bio)
795		pc->flags |= PC_FLAG_DMA_RECOMMENDED;
796	/*
797	 * possibly problematic, doesn't look like ide-floppy correctly
798	 * handled scattered requests if dma fails...
799	 */
800	pc->req_xfer = pc->buf_size = rq->data_len;
801}
802
803static ide_startstop_t idefloppy_do_request(ide_drive_t *drive,
804		struct request *rq, sector_t block_s)
805{
806	idefloppy_floppy_t *floppy = drive->driver_data;
807	struct ide_atapi_pc *pc;
808	unsigned long block = (unsigned long)block_s;
809
810	debug_log("dev: %s, cmd_type: %x, errors: %d\n",
811			rq->rq_disk ? rq->rq_disk->disk_name : "?",
812			rq->cmd_type, rq->errors);
813	debug_log("sector: %ld, nr_sectors: %ld, "
814			"current_nr_sectors: %d\n", (long)rq->sector,
815			rq->nr_sectors, rq->current_nr_sectors);
816
817	if (rq->errors >= ERROR_MAX) {
818		if (floppy->failed_pc)
819			ide_floppy_report_error(floppy, floppy->failed_pc);
820		else
821			printk(KERN_ERR "ide-floppy: %s: I/O error\n",
822				drive->name);
823		idefloppy_end_request(drive, 0, 0);
824		return ide_stopped;
825	}
826	if (blk_fs_request(rq)) {
827		if (((long)rq->sector % floppy->bs_factor) ||
828		    (rq->nr_sectors % floppy->bs_factor)) {
829			printk(KERN_ERR "%s: unsupported r/w request size\n",
830					drive->name);
831			idefloppy_end_request(drive, 0, 0);
832			return ide_stopped;
833		}
834		pc = idefloppy_next_pc_storage(drive);
835		idefloppy_create_rw_cmd(floppy, pc, rq, block);
836	} else if (blk_special_request(rq)) {
837		pc = (struct ide_atapi_pc *) rq->buffer;
838	} else if (blk_pc_request(rq)) {
839		pc = idefloppy_next_pc_storage(drive);
840		idefloppy_blockpc_cmd(floppy, pc, rq);
841	} else {
842		blk_dump_rq_flags(rq,
843			"ide-floppy: unsupported command in queue");
844		idefloppy_end_request(drive, 0, 0);
845		return ide_stopped;
846	}
847
848	pc->rq = rq;
849	return idefloppy_issue_pc(drive, pc);
850}
851
852/*
853 * Add a special packet command request to the tail of the request queue,
854 * and wait for it to be serviced.
855 */
856static int idefloppy_queue_pc_tail(ide_drive_t *drive, struct ide_atapi_pc *pc)
857{
858	struct ide_floppy_obj *floppy = drive->driver_data;
859	struct request *rq;
860	int error;
861
862	rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
863	rq->buffer = (char *) pc;
864	rq->cmd_type = REQ_TYPE_SPECIAL;
865	error = blk_execute_rq(drive->queue, floppy->disk, rq, 0);
866	blk_put_request(rq);
867
868	return error;
869}
870
871/*
872 * Look at the flexible disk page parameters. We ignore the CHS capacity
873 * parameters and use the LBA parameters instead.
874 */
875static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive)
876{
877	idefloppy_floppy_t *floppy = drive->driver_data;
878	struct ide_atapi_pc pc;
879	u8 *page;
880	int capacity, lba_capacity;
881	u16 transfer_rate, sector_size, cyls, rpm;
882	u8 heads, sectors;
883
884	idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE,
885					MODE_SENSE_CURRENT);
886
887	if (idefloppy_queue_pc_tail(drive, &pc)) {
888		printk(KERN_ERR "ide-floppy: Can't get flexible disk page"
889				" parameters\n");
890		return 1;
891	}
892	floppy->wp = !!(pc.buf[3] & 0x80);
893	set_disk_ro(floppy->disk, floppy->wp);
894	page = &pc.buf[8];
895
896	transfer_rate = be16_to_cpu(*(u16 *)&pc.buf[8 + 2]);
897	sector_size   = be16_to_cpu(*(u16 *)&pc.buf[8 + 6]);
898	cyls          = be16_to_cpu(*(u16 *)&pc.buf[8 + 8]);
899	rpm           = be16_to_cpu(*(u16 *)&pc.buf[8 + 28]);
900	heads         = pc.buf[8 + 4];
901	sectors       = pc.buf[8 + 5];
902
903	capacity = cyls * heads * sectors * sector_size;
904
905	if (memcmp(page, &floppy->flexible_disk_page, 32))
906		printk(KERN_INFO "%s: %dkB, %d/%d/%d CHS, %d kBps, "
907				"%d sector size, %d rpm\n",
908				drive->name, capacity / 1024, cyls, heads,
909				sectors, transfer_rate / 8, sector_size, rpm);
910
911	memcpy(&floppy->flexible_disk_page, page, 32);
912	drive->bios_cyl = cyls;
913	drive->bios_head = heads;
914	drive->bios_sect = sectors;
915	lba_capacity = floppy->blocks * floppy->block_size;
916
917	if (capacity < lba_capacity) {
918		printk(KERN_NOTICE "%s: The disk reports a capacity of %d "
919			"bytes, but the drive only handles %d\n",
920			drive->name, lba_capacity, capacity);
921		floppy->blocks = floppy->block_size ?
922			capacity / floppy->block_size : 0;
923	}
924	return 0;
925}
926
927static int idefloppy_get_sfrp_bit(ide_drive_t *drive)
928{
929	idefloppy_floppy_t *floppy = drive->driver_data;
930	struct ide_atapi_pc pc;
931
932	floppy->srfp = 0;
933	idefloppy_create_mode_sense_cmd(&pc, IDEFLOPPY_CAPABILITIES_PAGE,
934						 MODE_SENSE_CURRENT);
935
936	pc.flags |= PC_FLAG_SUPPRESS_ERROR;
937	if (idefloppy_queue_pc_tail(drive, &pc))
938		return 1;
939
940	floppy->srfp = pc.buf[8 + 2] & 0x40;
941	return (0);
942}
943
944/*
945 * Determine if a media is present in the floppy drive, and if so, its LBA
946 * capacity.
947 */
948static int ide_floppy_get_capacity(ide_drive_t *drive)
949{
950	idefloppy_floppy_t *floppy = drive->driver_data;
951	struct ide_atapi_pc pc;
952	u8 *cap_desc;
953	u8 header_len, desc_cnt;
954	int i, rc = 1, blocks, length;
955
956	drive->bios_cyl = 0;
957	drive->bios_head = drive->bios_sect = 0;
958	floppy->blocks = 0;
959	floppy->bs_factor = 1;
960	set_capacity(floppy->disk, 0);
961
962	idefloppy_create_read_capacity_cmd(&pc);
963	if (idefloppy_queue_pc_tail(drive, &pc)) {
964		printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
965		return 1;
966	}
967	header_len = pc.buf[3];
968	cap_desc = &pc.buf[4];
969	desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
970
971	for (i = 0; i < desc_cnt; i++) {
972		unsigned int desc_start = 4 + i*8;
973
974		blocks = be32_to_cpu(*(u32 *)&pc.buf[desc_start]);
975		length = be16_to_cpu(*(u16 *)&pc.buf[desc_start + 6]);
976
977		debug_log("Descriptor %d: %dkB, %d blocks, %d sector size\n",
978				i, blocks * length / 1024, blocks, length);
979
980		if (i)
981			continue;
982		/*
983		 * the code below is valid only for the 1st descriptor, ie i=0
984		 */
985
986		switch (pc.buf[desc_start + 4] & 0x03) {
987		/* Clik! drive returns this instead of CAPACITY_CURRENT */
988		case CAPACITY_UNFORMATTED:
989			if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE))
990				/*
991				 * If it is not a clik drive, break out
992				 * (maintains previous driver behaviour)
993				 */
994				break;
995		case CAPACITY_CURRENT:
996			/* Normal Zip/LS-120 disks */
997			if (memcmp(cap_desc, &floppy->cap_desc, 8))
998				printk(KERN_INFO "%s: %dkB, %d blocks, %d "
999					"sector size\n", drive->name,
1000					blocks * length / 1024, blocks, length);
1001			memcpy(&floppy->cap_desc, cap_desc, 8);
1002
1003			if (!length || length % 512) {
1004				printk(KERN_NOTICE "%s: %d bytes block size "
1005					"not supported\n", drive->name, length);
1006			} else {
1007				floppy->blocks = blocks;
1008				floppy->block_size = length;
1009				floppy->bs_factor = length / 512;
1010				if (floppy->bs_factor != 1)
1011					printk(KERN_NOTICE "%s: warning: non "
1012						"512 bytes block size not "
1013						"fully supported\n",
1014						drive->name);
1015				rc = 0;
1016			}
1017			break;
1018		case CAPACITY_NO_CARTRIDGE:
1019			/*
1020			 * This is a KERN_ERR so it appears on screen
1021			 * for the user to see
1022			 */
1023			printk(KERN_ERR "%s: No disk in drive\n", drive->name);
1024			break;
1025		case CAPACITY_INVALID:
1026			printk(KERN_ERR "%s: Invalid capacity for disk "
1027				"in drive\n", drive->name);
1028			break;
1029		}
1030		debug_log("Descriptor 0 Code: %d\n",
1031			  pc.buf[desc_start + 4] & 0x03);
1032	}
1033
1034	/* Clik! disk does not support get_flexible_disk_page */
1035	if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE))
1036		(void) ide_floppy_get_flexible_disk_page(drive);
1037
1038	set_capacity(floppy->disk, floppy->blocks * floppy->bs_factor);
1039	return rc;
1040}
1041
1042/*
1043 * Obtain the list of formattable capacities.
1044 * Very similar to ide_floppy_get_capacity, except that we push the capacity
1045 * descriptors to userland, instead of our own structures.
1046 *
1047 * Userland gives us the following structure:
1048 *
1049 * struct idefloppy_format_capacities {
1050 *	int nformats;
1051 *	struct {
1052 *		int nblocks;
1053 *		int blocksize;
1054 *	} formats[];
1055 * };
1056 *
1057 * userland initializes nformats to the number of allocated formats[] records.
1058 * On exit we set nformats to the number of records we've actually initialized.
1059 */
1060
1061static int ide_floppy_get_format_capacities(ide_drive_t *drive, int __user *arg)
1062{
1063	struct ide_atapi_pc pc;
1064	u8 header_len, desc_cnt;
1065	int i, blocks, length, u_array_size, u_index;
1066	int __user *argp;
1067
1068	if (get_user(u_array_size, arg))
1069		return (-EFAULT);
1070
1071	if (u_array_size <= 0)
1072		return (-EINVAL);
1073
1074	idefloppy_create_read_capacity_cmd(&pc);
1075	if (idefloppy_queue_pc_tail(drive, &pc)) {
1076		printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
1077		return (-EIO);
1078	}
1079	header_len = pc.buf[3];
1080	desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
1081
1082	u_index = 0;
1083	argp = arg + 1;
1084
1085	/*
1086	 * We always skip the first capacity descriptor.  That's the current
1087	 * capacity.  We are interested in the remaining descriptors, the
1088	 * formattable capacities.
1089	 */
1090	for (i = 1; i < desc_cnt; i++) {
1091		unsigned int desc_start = 4 + i*8;
1092
1093		if (u_index >= u_array_size)
1094			break;	/* User-supplied buffer too small */
1095
1096		blocks = be32_to_cpu(*(u32 *)&pc.buf[desc_start]);
1097		length = be16_to_cpu(*(u16 *)&pc.buf[desc_start + 6]);
1098
1099		if (put_user(blocks, argp))
1100			return(-EFAULT);
1101		++argp;
1102
1103		if (put_user(length, argp))
1104			return (-EFAULT);
1105		++argp;
1106
1107		++u_index;
1108	}
1109
1110	if (put_user(u_index, arg))
1111		return (-EFAULT);
1112	return (0);
1113}
1114
1115/*
1116 * Get ATAPI_FORMAT_UNIT progress indication.
1117 *
1118 * Userland gives a pointer to an int.  The int is set to a progress
1119 * indicator 0-65536, with 65536=100%.
1120 *
1121 * If the drive does not support format progress indication, we just check
1122 * the dsc bit, and return either 0 or 65536.
1123 */
1124
1125static int idefloppy_get_format_progress(ide_drive_t *drive, int __user *arg)
1126{
1127	idefloppy_floppy_t *floppy = drive->driver_data;
1128	struct ide_atapi_pc pc;
1129	int progress_indication = 0x10000;
1130
1131	if (floppy->srfp) {
1132		idefloppy_create_request_sense_cmd(&pc);
1133		if (idefloppy_queue_pc_tail(drive, &pc))
1134			return (-EIO);
1135
1136		if (floppy->sense_key == 2 &&
1137		    floppy->asc == 4 &&
1138		    floppy->ascq == 4)
1139			progress_indication = floppy->progress_indication;
1140
1141		/* Else assume format_unit has finished, and we're at 0x10000 */
1142	} else {
1143		unsigned long flags;
1144		u8 stat;
1145
1146		local_irq_save(flags);
1147		stat = ide_read_status(drive);
1148		local_irq_restore(flags);
1149
1150		progress_indication = ((stat & SEEK_STAT) == 0) ? 0 : 0x10000;
1151	}
1152	if (put_user(progress_indication, arg))
1153		return (-EFAULT);
1154
1155	return (0);
1156}
1157
1158static sector_t idefloppy_capacity(ide_drive_t *drive)
1159{
1160	idefloppy_floppy_t *floppy = drive->driver_data;
1161	unsigned long capacity = floppy->blocks * floppy->bs_factor;
1162
1163	return capacity;
1164}
1165
1166/*
1167 * Check whether we can support a drive, based on the ATAPI IDENTIFY command
1168 * results.
1169 */
1170static int idefloppy_identify_device(ide_drive_t *drive, struct hd_driveid *id)
1171{
1172	u8 gcw[2];
1173	u8 device_type, protocol, removable, drq_type, packet_size;
1174
1175	*((u16 *) &gcw) = id->config;
1176
1177	device_type =  gcw[1] & 0x1F;
1178	removable   = (gcw[0] & 0x80) >> 7;
1179	protocol    = (gcw[1] & 0xC0) >> 6;
1180	drq_type    = (gcw[0] & 0x60) >> 5;
1181	packet_size =  gcw[0] & 0x03;
1182
1183#ifdef CONFIG_PPC
1184	/* kludge for Apple PowerBook internal zip */
1185	if (device_type == 5 &&
1186	    !strstr(id->model, "CD-ROM") && strstr(id->model, "ZIP"))
1187		device_type = 0;
1188#endif
1189
1190	if (protocol != 2)
1191		printk(KERN_ERR "ide-floppy: Protocol (0x%02x) is not ATAPI\n",
1192			protocol);
1193	else if (device_type != 0)
1194		printk(KERN_ERR "ide-floppy: Device type (0x%02x) is not set "
1195				"to floppy\n", device_type);
1196	else if (!removable)
1197		printk(KERN_ERR "ide-floppy: The removable flag is not set\n");
1198	else if (drq_type == 3)
1199		printk(KERN_ERR "ide-floppy: Sorry, DRQ type (0x%02x) not "
1200				"supported\n", drq_type);
1201	else if (packet_size != 0)
1202		printk(KERN_ERR "ide-floppy: Packet size (0x%02x) is not 12 "
1203				"bytes\n", packet_size);
1204	else
1205		return 1;
1206	return 0;
1207}
1208
1209#ifdef CONFIG_IDE_PROC_FS
1210static void idefloppy_add_settings(ide_drive_t *drive)
1211{
1212	idefloppy_floppy_t *floppy = drive->driver_data;
1213
1214	ide_add_setting(drive, "bios_cyl", SETTING_RW, TYPE_INT, 0, 1023, 1, 1,
1215			&drive->bios_cyl, NULL);
1216	ide_add_setting(drive, "bios_head", SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1217			&drive->bios_head, NULL);
1218	ide_add_setting(drive, "bios_sect", SETTING_RW,	TYPE_BYTE, 0,  63, 1, 1,
1219			&drive->bios_sect, NULL);
1220	ide_add_setting(drive, "ticks",	   SETTING_RW, TYPE_BYTE, 0, 255, 1, 1,
1221			&floppy->ticks,	 NULL);
1222}
1223#else
1224static inline void idefloppy_add_settings(ide_drive_t *drive) { ; }
1225#endif
1226
1227static void idefloppy_setup(ide_drive_t *drive, idefloppy_floppy_t *floppy)
1228{
1229	u8 gcw[2];
1230
1231	*((u16 *) &gcw) = drive->id->config;
1232	floppy->pc = floppy->pc_stack;
1233
1234	if (((gcw[0] & 0x60) >> 5) == 1)
1235		floppy->flags |= IDEFLOPPY_FLAG_DRQ_INTERRUPT;
1236	/*
1237	 * We used to check revisions here. At this point however I'm giving up.
1238	 * Just assume they are all broken, its easier.
1239	 *
1240	 * The actual reason for the workarounds was likely a driver bug after
1241	 * all rather than a firmware bug, and the workaround below used to hide
1242	 * it. It should be fixed as of version 1.9, but to be on the safe side
1243	 * we'll leave the limitation below for the 2.2.x tree.
1244	 */
1245	if (!strncmp(drive->id->model, "IOMEGA ZIP 100 ATAPI", 20)) {
1246		floppy->flags |= IDEFLOPPY_FLAG_ZIP_DRIVE;
1247		/* This value will be visible in the /proc/ide/hdx/settings */
1248		floppy->ticks = IDEFLOPPY_TICKS_DELAY;
1249		blk_queue_max_sectors(drive->queue, 64);
1250	}
1251
1252	/*
1253	 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
1254	 * nasty clicking noises without it, so please don't remove this.
1255	 */
1256	if (strncmp(drive->id->model, "IOMEGA Clik!", 11) == 0) {
1257		blk_queue_max_sectors(drive->queue, 64);
1258		floppy->flags |= IDEFLOPPY_FLAG_CLIK_DRIVE;
1259	}
1260
1261	(void) ide_floppy_get_capacity(drive);
1262	idefloppy_add_settings(drive);
1263}
1264
1265static void ide_floppy_remove(ide_drive_t *drive)
1266{
1267	idefloppy_floppy_t *floppy = drive->driver_data;
1268	struct gendisk *g = floppy->disk;
1269
1270	ide_proc_unregister_driver(drive, floppy->driver);
1271
1272	del_gendisk(g);
1273
1274	ide_floppy_put(floppy);
1275}
1276
1277static void idefloppy_cleanup_obj(struct kref *kref)
1278{
1279	struct ide_floppy_obj *floppy = to_ide_floppy(kref);
1280	ide_drive_t *drive = floppy->drive;
1281	struct gendisk *g = floppy->disk;
1282
1283	drive->driver_data = NULL;
1284	g->private_data = NULL;
1285	put_disk(g);
1286	kfree(floppy);
1287}
1288
1289#ifdef CONFIG_IDE_PROC_FS
1290static int proc_idefloppy_read_capacity(char *page, char **start, off_t off,
1291		int count, int *eof, void *data)
1292{
1293	ide_drive_t*drive = (ide_drive_t *)data;
1294	int len;
1295
1296	len = sprintf(page, "%llu\n", (long long)idefloppy_capacity(drive));
1297	PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1298}
1299
1300static ide_proc_entry_t idefloppy_proc[] = {
1301	{ "capacity",	S_IFREG|S_IRUGO, proc_idefloppy_read_capacity,	NULL },
1302	{ "geometry",	S_IFREG|S_IRUGO, proc_ide_read_geometry,	NULL },
1303	{ NULL, 0, NULL, NULL }
1304};
1305#endif	/* CONFIG_IDE_PROC_FS */
1306
1307static int ide_floppy_probe(ide_drive_t *);
1308
1309static ide_driver_t idefloppy_driver = {
1310	.gen_driver = {
1311		.owner		= THIS_MODULE,
1312		.name		= "ide-floppy",
1313		.bus		= &ide_bus_type,
1314	},
1315	.probe			= ide_floppy_probe,
1316	.remove			= ide_floppy_remove,
1317	.version		= IDEFLOPPY_VERSION,
1318	.media			= ide_floppy,
1319	.supports_dsc_overlap	= 0,
1320	.do_request		= idefloppy_do_request,
1321	.end_request		= idefloppy_end_request,
1322	.error			= __ide_error,
1323	.abort			= __ide_abort,
1324#ifdef CONFIG_IDE_PROC_FS
1325	.proc			= idefloppy_proc,
1326#endif
1327};
1328
1329static int idefloppy_open(struct inode *inode, struct file *filp)
1330{
1331	struct gendisk *disk = inode->i_bdev->bd_disk;
1332	struct ide_floppy_obj *floppy;
1333	ide_drive_t *drive;
1334	struct ide_atapi_pc pc;
1335	int ret = 0;
1336
1337	debug_log("Reached %s\n", __func__);
1338
1339	floppy = ide_floppy_get(disk);
1340	if (!floppy)
1341		return -ENXIO;
1342
1343	drive = floppy->drive;
1344
1345	floppy->openers++;
1346
1347	if (floppy->openers == 1) {
1348		floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1349		/* Just in case */
1350
1351		idefloppy_create_test_unit_ready_cmd(&pc);
1352		if (idefloppy_queue_pc_tail(drive, &pc)) {
1353			idefloppy_create_start_stop_cmd(&pc, 1);
1354			(void) idefloppy_queue_pc_tail(drive, &pc);
1355		}
1356
1357		if (ide_floppy_get_capacity(drive)
1358		   && (filp->f_flags & O_NDELAY) == 0
1359		    /*
1360		     * Allow O_NDELAY to open a drive without a disk, or with an
1361		     * unreadable disk, so that we can get the format capacity
1362		     * of the drive or begin the format - Sam
1363		     */
1364		    ) {
1365			ret = -EIO;
1366			goto out_put_floppy;
1367		}
1368
1369		if (floppy->wp && (filp->f_mode & 2)) {
1370			ret = -EROFS;
1371			goto out_put_floppy;
1372		}
1373		floppy->flags |= IDEFLOPPY_FLAG_MEDIA_CHANGED;
1374		/* IOMEGA Clik! drives do not support lock/unlock commands */
1375		if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1376			idefloppy_create_prevent_cmd(&pc, 1);
1377			(void) idefloppy_queue_pc_tail(drive, &pc);
1378		}
1379		check_disk_change(inode->i_bdev);
1380	} else if (floppy->flags & IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS) {
1381		ret = -EBUSY;
1382		goto out_put_floppy;
1383	}
1384	return 0;
1385
1386out_put_floppy:
1387	floppy->openers--;
1388	ide_floppy_put(floppy);
1389	return ret;
1390}
1391
1392static int idefloppy_release(struct inode *inode, struct file *filp)
1393{
1394	struct gendisk *disk = inode->i_bdev->bd_disk;
1395	struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1396	ide_drive_t *drive = floppy->drive;
1397	struct ide_atapi_pc pc;
1398
1399	debug_log("Reached %s\n", __func__);
1400
1401	if (floppy->openers == 1) {
1402		/* IOMEGA Clik! drives do not support lock/unlock commands */
1403		if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1404			idefloppy_create_prevent_cmd(&pc, 0);
1405			(void) idefloppy_queue_pc_tail(drive, &pc);
1406		}
1407
1408		floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1409	}
1410
1411	floppy->openers--;
1412
1413	ide_floppy_put(floppy);
1414
1415	return 0;
1416}
1417
1418static int idefloppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1419{
1420	struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1421	ide_drive_t *drive = floppy->drive;
1422
1423	geo->heads = drive->bios_head;
1424	geo->sectors = drive->bios_sect;
1425	geo->cylinders = (u16)drive->bios_cyl; /* truncate */
1426	return 0;
1427}
1428
1429static int ide_floppy_lockdoor(idefloppy_floppy_t *floppy,
1430		struct ide_atapi_pc *pc, unsigned long arg, unsigned int cmd)
1431{
1432	if (floppy->openers > 1)
1433		return -EBUSY;
1434
1435	/* The IOMEGA Clik! Drive doesn't support this command -
1436	 * no room for an eject mechanism */
1437	if (!(floppy->flags & IDEFLOPPY_FLAG_CLIK_DRIVE)) {
1438		int prevent = arg ? 1 : 0;
1439
1440		if (cmd == CDROMEJECT)
1441			prevent = 0;
1442
1443		idefloppy_create_prevent_cmd(pc, prevent);
1444		(void) idefloppy_queue_pc_tail(floppy->drive, pc);
1445	}
1446
1447	if (cmd == CDROMEJECT) {
1448		idefloppy_create_start_stop_cmd(pc, 2);
1449		(void) idefloppy_queue_pc_tail(floppy->drive, pc);
1450	}
1451
1452	return 0;
1453}
1454
1455static int ide_floppy_format_unit(idefloppy_floppy_t *floppy,
1456				  int __user *arg)
1457{
1458	int blocks, length, flags, err = 0;
1459	struct ide_atapi_pc pc;
1460
1461	if (floppy->openers > 1) {
1462		/* Don't format if someone is using the disk */
1463		floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1464		return -EBUSY;
1465	}
1466
1467	floppy->flags |= IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1468
1469	/*
1470	 * Send ATAPI_FORMAT_UNIT to the drive.
1471	 *
1472	 * Userland gives us the following structure:
1473	 *
1474	 * struct idefloppy_format_command {
1475	 *        int nblocks;
1476	 *        int blocksize;
1477	 *        int flags;
1478	 *        } ;
1479	 *
1480	 * flags is a bitmask, currently, the only defined flag is:
1481	 *
1482	 *        0x01 - verify media after format.
1483	 */
1484	if (get_user(blocks, arg) ||
1485			get_user(length, arg+1) ||
1486			get_user(flags, arg+2)) {
1487		err = -EFAULT;
1488		goto out;
1489	}
1490
1491	(void) idefloppy_get_sfrp_bit(floppy->drive);
1492	idefloppy_create_format_unit_cmd(&pc, blocks, length, flags);
1493
1494	if (idefloppy_queue_pc_tail(floppy->drive, &pc))
1495		err = -EIO;
1496
1497out:
1498	if (err)
1499		floppy->flags &= ~IDEFLOPPY_FLAG_FORMAT_IN_PROGRESS;
1500	return err;
1501}
1502
1503
1504static int idefloppy_ioctl(struct inode *inode, struct file *file,
1505			unsigned int cmd, unsigned long arg)
1506{
1507	struct block_device *bdev = inode->i_bdev;
1508	struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
1509	ide_drive_t *drive = floppy->drive;
1510	struct ide_atapi_pc pc;
1511	void __user *argp = (void __user *)arg;
1512	int err;
1513
1514	switch (cmd) {
1515	case CDROMEJECT:
1516		/* fall through */
1517	case CDROM_LOCKDOOR:
1518		return ide_floppy_lockdoor(floppy, &pc, arg, cmd);
1519	case IDEFLOPPY_IOCTL_FORMAT_SUPPORTED:
1520		return 0;
1521	case IDEFLOPPY_IOCTL_FORMAT_GET_CAPACITY:
1522		return ide_floppy_get_format_capacities(drive, argp);
1523	case IDEFLOPPY_IOCTL_FORMAT_START:
1524		if (!(file->f_mode & 2))
1525			return -EPERM;
1526
1527		return ide_floppy_format_unit(floppy, (int __user *)arg);
1528	case IDEFLOPPY_IOCTL_FORMAT_GET_PROGRESS:
1529		return idefloppy_get_format_progress(drive, argp);
1530	}
1531
1532	/*
1533	 * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
1534	 * and CDROM_SEND_PACKET (legacy) ioctls
1535	 */
1536	if (cmd != CDROM_SEND_PACKET && cmd != SCSI_IOCTL_SEND_COMMAND)
1537		err = scsi_cmd_ioctl(file, bdev->bd_disk->queue,
1538					bdev->bd_disk, cmd, argp);
1539	else
1540		err = -ENOTTY;
1541
1542	if (err == -ENOTTY)
1543		err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
1544
1545	return err;
1546}
1547
1548static int idefloppy_media_changed(struct gendisk *disk)
1549{
1550	struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1551	ide_drive_t *drive = floppy->drive;
1552	int ret;
1553
1554	/* do not scan partitions twice if this is a removable device */
1555	if (drive->attach) {
1556		drive->attach = 0;
1557		return 0;
1558	}
1559	ret = !!(floppy->flags & IDEFLOPPY_FLAG_MEDIA_CHANGED);
1560	floppy->flags &= ~IDEFLOPPY_FLAG_MEDIA_CHANGED;
1561	return ret;
1562}
1563
1564static int idefloppy_revalidate_disk(struct gendisk *disk)
1565{
1566	struct ide_floppy_obj *floppy = ide_floppy_g(disk);
1567	set_capacity(disk, idefloppy_capacity(floppy->drive));
1568	return 0;
1569}
1570
1571static struct block_device_operations idefloppy_ops = {
1572	.owner			= THIS_MODULE,
1573	.open			= idefloppy_open,
1574	.release		= idefloppy_release,
1575	.ioctl			= idefloppy_ioctl,
1576	.getgeo			= idefloppy_getgeo,
1577	.media_changed		= idefloppy_media_changed,
1578	.revalidate_disk	= idefloppy_revalidate_disk
1579};
1580
1581static int ide_floppy_probe(ide_drive_t *drive)
1582{
1583	idefloppy_floppy_t *floppy;
1584	struct gendisk *g;
1585
1586	if (!strstr("ide-floppy", drive->driver_req))
1587		goto failed;
1588	if (!drive->present)
1589		goto failed;
1590	if (drive->media != ide_floppy)
1591		goto failed;
1592	if (!idefloppy_identify_device(drive, drive->id)) {
1593		printk(KERN_ERR "ide-floppy: %s: not supported by this version"
1594				" of ide-floppy\n", drive->name);
1595		goto failed;
1596	}
1597	if (drive->scsi) {
1598		printk(KERN_INFO "ide-floppy: passing drive %s to ide-scsi"
1599				" emulation.\n", drive->name);
1600		goto failed;
1601	}
1602	floppy = kzalloc(sizeof(idefloppy_floppy_t), GFP_KERNEL);
1603	if (!floppy) {
1604		printk(KERN_ERR "ide-floppy: %s: Can't allocate a floppy"
1605				" structure\n", drive->name);
1606		goto failed;
1607	}
1608
1609	g = alloc_disk(1 << PARTN_BITS);
1610	if (!g)
1611		goto out_free_floppy;
1612
1613	ide_init_disk(g, drive);
1614
1615	ide_proc_register_driver(drive, &idefloppy_driver);
1616
1617	kref_init(&floppy->kref);
1618
1619	floppy->drive = drive;
1620	floppy->driver = &idefloppy_driver;
1621	floppy->disk = g;
1622
1623	g->private_data = &floppy->driver;
1624
1625	drive->driver_data = floppy;
1626
1627	idefloppy_setup(drive, floppy);
1628
1629	g->minors = 1 << PARTN_BITS;
1630	g->driverfs_dev = &drive->gendev;
1631	g->flags = drive->removable ? GENHD_FL_REMOVABLE : 0;
1632	g->fops = &idefloppy_ops;
1633	drive->attach = 1;
1634	add_disk(g);
1635	return 0;
1636
1637out_free_floppy:
1638	kfree(floppy);
1639failed:
1640	return -ENODEV;
1641}
1642
1643static void __exit idefloppy_exit(void)
1644{
1645	driver_unregister(&idefloppy_driver.gen_driver);
1646}
1647
1648static int __init idefloppy_init(void)
1649{
1650	printk("ide-floppy driver " IDEFLOPPY_VERSION "\n");
1651	return driver_register(&idefloppy_driver.gen_driver);
1652}
1653
1654MODULE_ALIAS("ide:*m-floppy*");
1655module_init(idefloppy_init);
1656module_exit(idefloppy_exit);
1657MODULE_LICENSE("GPL");
1658MODULE_DESCRIPTION("ATAPI FLOPPY Driver");
1659
1660