ide-floppy.c revision de699ad595fb45022d1b049ed91ffd06fdd16c13
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 DRV_NAME "ide-floppy"
19
20#define IDEFLOPPY_VERSION "1.00"
21
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>
28#include <linux/mm.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>
40
41#include <scsi/scsi_ioctl.h>
42
43#include <asm/byteorder.h>
44#include <linux/irq.h>
45#include <linux/uaccess.h>
46#include <linux/io.h>
47#include <asm/unaligned.h>
48
49#include "ide-floppy.h"
50
51/* define to see debug info */
52#define IDEFLOPPY_DEBUG_LOG		0
53
54/* #define IDEFLOPPY_DEBUG(fmt, args...) printk(KERN_INFO fmt, ## args) */
55#define IDEFLOPPY_DEBUG(fmt, args...)
56
57#if IDEFLOPPY_DEBUG_LOG
58#define debug_log(fmt, args...) \
59	printk(KERN_INFO "ide-floppy: " fmt, ## args)
60#else
61#define debug_log(fmt, args...) do {} while (0)
62#endif
63
64
65/* Some drives require a longer irq timeout. */
66#define IDEFLOPPY_WAIT_CMD		(5 * WAIT_CMD)
67
68/*
69 * After each failed packet command we issue a request sense command and retry
70 * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
71 */
72#define IDEFLOPPY_MAX_PC_RETRIES	3
73
74/* format capacities descriptor codes */
75#define CAPACITY_INVALID	0x00
76#define CAPACITY_UNFORMATTED	0x01
77#define CAPACITY_CURRENT	0x02
78#define CAPACITY_NO_CARTRIDGE	0x03
79
80#define IDEFLOPPY_TICKS_DELAY	HZ/20	/* default delay for ZIP 100 (50ms) */
81
82/* Error code returned in rq->errors to the higher part of the driver. */
83#define	IDEFLOPPY_ERROR_GENERAL		101
84
85static DEFINE_MUTEX(idefloppy_ref_mutex);
86
87#define to_ide_floppy(obj) container_of(obj, struct ide_floppy_obj, kref)
88
89#define ide_floppy_g(disk) \
90	container_of((disk)->private_data, struct ide_floppy_obj, driver)
91
92static void idefloppy_cleanup_obj(struct kref *);
93
94static struct ide_floppy_obj *ide_floppy_get(struct gendisk *disk)
95{
96	struct ide_floppy_obj *floppy = NULL;
97
98	mutex_lock(&idefloppy_ref_mutex);
99	floppy = ide_floppy_g(disk);
100	if (floppy) {
101		if (ide_device_get(floppy->drive))
102			floppy = NULL;
103		else
104			kref_get(&floppy->kref);
105	}
106	mutex_unlock(&idefloppy_ref_mutex);
107	return floppy;
108}
109
110static void ide_floppy_put(struct ide_floppy_obj *floppy)
111{
112	ide_drive_t *drive = floppy->drive;
113
114	mutex_lock(&idefloppy_ref_mutex);
115	kref_put(&floppy->kref, idefloppy_cleanup_obj);
116	ide_device_put(drive);
117	mutex_unlock(&idefloppy_ref_mutex);
118}
119
120/*
121 * Used to finish servicing a request. For read/write requests, we will call
122 * ide_end_request to pass to the next buffer.
123 */
124static int idefloppy_end_request(ide_drive_t *drive, int uptodate, int nsecs)
125{
126	idefloppy_floppy_t *floppy = drive->driver_data;
127	struct request *rq = HWGROUP(drive)->rq;
128	int error;
129
130	debug_log("Reached %s\n", __func__);
131
132	switch (uptodate) {
133	case 0: error = IDEFLOPPY_ERROR_GENERAL; break;
134	case 1: error = 0; break;
135	default: error = uptodate;
136	}
137	if (error)
138		floppy->failed_pc = NULL;
139	/* Why does this happen? */
140	if (!rq)
141		return 0;
142	if (!blk_special_request(rq)) {
143		/* our real local end request function */
144		ide_end_request(drive, uptodate, nsecs);
145		return 0;
146	}
147	rq->errors = error;
148	/* fixme: need to move this local also */
149	ide_end_drive_cmd(drive, 0, 0);
150	return 0;
151}
152
153static void idefloppy_update_buffers(ide_drive_t *drive,
154				struct ide_atapi_pc *pc)
155{
156	struct request *rq = pc->rq;
157	struct bio *bio = rq->bio;
158
159	while ((bio = rq->bio) != NULL)
160		idefloppy_end_request(drive, 1, 0);
161}
162
163static void ide_floppy_callback(ide_drive_t *drive)
164{
165	idefloppy_floppy_t *floppy = drive->driver_data;
166	struct ide_atapi_pc *pc = floppy->pc;
167	int uptodate = pc->error ? 0 : 1;
168
169	debug_log("Reached %s\n", __func__);
170
171	if (floppy->failed_pc == pc)
172		floppy->failed_pc = NULL;
173
174	if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
175	    (pc->rq && blk_pc_request(pc->rq)))
176		uptodate = 1; /* FIXME */
177	else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
178		u8 *buf = floppy->pc->buf;
179
180		if (!pc->error) {
181			floppy->sense_key = buf[2] & 0x0F;
182			floppy->asc = buf[12];
183			floppy->ascq = buf[13];
184			floppy->progress_indication = buf[15] & 0x80 ?
185				(u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
186
187			if (floppy->failed_pc)
188				debug_log("pc = %x, ", floppy->failed_pc->c[0]);
189
190			debug_log("sense key = %x, asc = %x, ascq = %x\n",
191				  floppy->sense_key, floppy->asc, floppy->ascq);
192		} else
193			printk(KERN_ERR "Error in REQUEST SENSE itself - "
194					"Aborting request!\n");
195	}
196
197	idefloppy_end_request(drive, uptodate, 0);
198}
199
200void ide_floppy_create_request_sense_cmd(struct ide_atapi_pc *pc)
201{
202	ide_init_pc(pc);
203	pc->c[0] = GPCMD_REQUEST_SENSE;
204	pc->c[4] = 255;
205	pc->req_xfer = 18;
206}
207
208/*
209 * Called when an error was detected during the last packet command. We queue a
210 * request sense packet command in the head of the request list.
211 */
212static void idefloppy_retry_pc(ide_drive_t *drive)
213{
214	struct ide_floppy_obj *floppy = drive->driver_data;
215	struct request *rq = &floppy->request_sense_rq;
216	struct ide_atapi_pc *pc = &floppy->request_sense_pc;
217
218	(void)ide_read_error(drive);
219	ide_floppy_create_request_sense_cmd(pc);
220	ide_queue_pc_head(drive, floppy->disk, pc, rq);
221}
222
223/* The usual interrupt handler called during a packet command. */
224static ide_startstop_t idefloppy_pc_intr(ide_drive_t *drive)
225{
226	idefloppy_floppy_t *floppy = drive->driver_data;
227
228	return ide_pc_intr(drive, floppy->pc, idefloppy_pc_intr,
229			   IDEFLOPPY_WAIT_CMD, NULL, idefloppy_update_buffers,
230			   idefloppy_retry_pc, NULL, ide_io_buffers);
231}
232
233/*
234 * What we have here is a classic case of a top half / bottom half interrupt
235 * service routine. In interrupt mode, the device sends an interrupt to signal
236 * that it is ready to receive a packet. However, we need to delay about 2-3
237 * ticks before issuing the packet or we gets in trouble.
238 */
239static int idefloppy_transfer_pc(ide_drive_t *drive)
240{
241	idefloppy_floppy_t *floppy = drive->driver_data;
242
243	/* Send the actual packet */
244	drive->hwif->tp_ops->output_data(drive, NULL, floppy->pc->c, 12);
245
246	/* Timeout for the packet command */
247	return IDEFLOPPY_WAIT_CMD;
248}
249
250
251/*
252 * Called as an interrupt (or directly). When the device says it's ready for a
253 * packet, we schedule the packet transfer to occur about 2-3 ticks later in
254 * transfer_pc.
255 */
256static ide_startstop_t idefloppy_start_pc_transfer(ide_drive_t *drive)
257{
258	idefloppy_floppy_t *floppy = drive->driver_data;
259	struct ide_atapi_pc *pc = floppy->pc;
260	ide_expiry_t *expiry;
261	unsigned int timeout;
262
263	/*
264	 * The following delay solves a problem with ATAPI Zip 100 drives
265	 * where the Busy flag was apparently being deasserted before the
266	 * unit was ready to receive data. This was happening on a
267	 * 1200 MHz Athlon system. 10/26/01 25msec is too short,
268	 * 40 and 50msec work well. idefloppy_pc_intr will not be actually
269	 * used until after the packet is moved in about 50 msec.
270	 */
271	if (drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) {
272		timeout = floppy->ticks;
273		expiry = &idefloppy_transfer_pc;
274	} else {
275		timeout = IDEFLOPPY_WAIT_CMD;
276		expiry = NULL;
277	}
278
279	return ide_transfer_pc(drive, pc, idefloppy_pc_intr, timeout, expiry);
280}
281
282static void ide_floppy_report_error(idefloppy_floppy_t *floppy,
283				    struct ide_atapi_pc *pc)
284{
285	/* supress error messages resulting from Medium not present */
286	if (floppy->sense_key == 0x02 &&
287	    floppy->asc       == 0x3a &&
288	    floppy->ascq      == 0x00)
289		return;
290
291	printk(KERN_ERR "ide-floppy: %s: I/O error, pc = %2x, key = %2x, "
292			"asc = %2x, ascq = %2x\n",
293			floppy->drive->name, pc->c[0], floppy->sense_key,
294			floppy->asc, floppy->ascq);
295
296}
297
298static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
299		struct ide_atapi_pc *pc)
300{
301	idefloppy_floppy_t *floppy = drive->driver_data;
302
303	if (floppy->failed_pc == NULL &&
304	    pc->c[0] != GPCMD_REQUEST_SENSE)
305		floppy->failed_pc = pc;
306	/* Set the current packet command */
307	floppy->pc = pc;
308
309	if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
310		if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
311			ide_floppy_report_error(floppy, pc);
312		/* Giving up */
313		pc->error = IDEFLOPPY_ERROR_GENERAL;
314
315		floppy->failed_pc = NULL;
316		drive->pc_callback(drive);
317		return ide_stopped;
318	}
319
320	debug_log("Retry number - %d\n", pc->retries);
321
322	pc->retries++;
323
324	return ide_issue_pc(drive, pc, idefloppy_start_pc_transfer,
325			    IDEFLOPPY_WAIT_CMD, NULL);
326}
327
328void ide_floppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
329{
330	ide_init_pc(pc);
331	pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
332	pc->c[7] = 255;
333	pc->c[8] = 255;
334	pc->req_xfer = 255;
335}
336
337/* A mode sense command is used to "sense" floppy parameters. */
338void ide_floppy_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
339{
340	u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
341
342	ide_init_pc(pc);
343	pc->c[0] = GPCMD_MODE_SENSE_10;
344	pc->c[1] = 0;
345	pc->c[2] = page_code;
346
347	switch (page_code) {
348	case IDEFLOPPY_CAPABILITIES_PAGE:
349		length += 12;
350		break;
351	case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
352		length += 32;
353		break;
354	default:
355		printk(KERN_ERR "ide-floppy: unsupported page code "
356				"in create_mode_sense_cmd\n");
357	}
358	put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
359	pc->req_xfer = length;
360}
361
362static void idefloppy_create_rw_cmd(idefloppy_floppy_t *floppy,
363				    struct ide_atapi_pc *pc, struct request *rq,
364				    unsigned long sector)
365{
366	int block = sector / floppy->bs_factor;
367	int blocks = rq->nr_sectors / floppy->bs_factor;
368	int cmd = rq_data_dir(rq);
369
370	debug_log("create_rw10_cmd: block == %d, blocks == %d\n",
371		block, blocks);
372
373	ide_init_pc(pc);
374	pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
375	put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
376	put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
377
378	memcpy(rq->cmd, pc->c, 12);
379
380	pc->rq = rq;
381	pc->b_count = 0;
382	if (rq->cmd_flags & REQ_RW)
383		pc->flags |= PC_FLAG_WRITING;
384	pc->buf = NULL;
385	pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
386	pc->flags |= PC_FLAG_DMA_OK;
387}
388
389static void idefloppy_blockpc_cmd(idefloppy_floppy_t *floppy,
390		struct ide_atapi_pc *pc, struct request *rq)
391{
392	ide_init_pc(pc);
393	memcpy(pc->c, rq->cmd, sizeof(pc->c));
394	pc->rq = rq;
395	pc->b_count = 0;
396	if (rq->data_len && rq_data_dir(rq) == WRITE)
397		pc->flags |= PC_FLAG_WRITING;
398	pc->buf = rq->data;
399	if (rq->bio)
400		pc->flags |= PC_FLAG_DMA_OK;
401	/*
402	 * possibly problematic, doesn't look like ide-floppy correctly
403	 * handled scattered requests if dma fails...
404	 */
405	pc->req_xfer = pc->buf_size = rq->data_len;
406}
407
408static ide_startstop_t idefloppy_do_request(ide_drive_t *drive,
409		struct request *rq, sector_t block_s)
410{
411	idefloppy_floppy_t *floppy = drive->driver_data;
412	ide_hwif_t *hwif = drive->hwif;
413	struct ide_atapi_pc *pc;
414	unsigned long block = (unsigned long)block_s;
415
416	debug_log("%s: dev: %s, cmd: 0x%x, cmd_type: %x, errors: %d\n",
417		  __func__, rq->rq_disk ? rq->rq_disk->disk_name : "?",
418		  rq->cmd[0], rq->cmd_type, rq->errors);
419
420	debug_log("%s: sector: %ld, nr_sectors: %ld, current_nr_sectors: %d\n",
421		  __func__, (long)rq->sector, rq->nr_sectors,
422		  rq->current_nr_sectors);
423
424	if (rq->errors >= ERROR_MAX) {
425		if (floppy->failed_pc)
426			ide_floppy_report_error(floppy, floppy->failed_pc);
427		else
428			printk(KERN_ERR "ide-floppy: %s: I/O error\n",
429				drive->name);
430		idefloppy_end_request(drive, 0, 0);
431		return ide_stopped;
432	}
433	if (blk_fs_request(rq)) {
434		if (((long)rq->sector % floppy->bs_factor) ||
435		    (rq->nr_sectors % floppy->bs_factor)) {
436			printk(KERN_ERR "%s: unsupported r/w request size\n",
437					drive->name);
438			idefloppy_end_request(drive, 0, 0);
439			return ide_stopped;
440		}
441		pc = &floppy->queued_pc;
442		idefloppy_create_rw_cmd(floppy, pc, rq, block);
443	} else if (blk_special_request(rq)) {
444		pc = (struct ide_atapi_pc *) rq->buffer;
445	} else if (blk_pc_request(rq)) {
446		pc = &floppy->queued_pc;
447		idefloppy_blockpc_cmd(floppy, pc, rq);
448	} else {
449		blk_dump_rq_flags(rq,
450			"ide-floppy: unsupported command in queue");
451		idefloppy_end_request(drive, 0, 0);
452		return ide_stopped;
453	}
454
455	ide_init_sg_cmd(drive, rq);
456	ide_map_sg(drive, rq);
457
458	pc->sg = hwif->sg_table;
459	pc->sg_cnt = hwif->sg_nents;
460
461	pc->rq = rq;
462
463	return idefloppy_issue_pc(drive, pc);
464}
465
466/*
467 * Look at the flexible disk page parameters. We ignore the CHS capacity
468 * parameters and use the LBA parameters instead.
469 */
470static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive)
471{
472	idefloppy_floppy_t *floppy = drive->driver_data;
473	struct gendisk *disk = floppy->disk;
474	struct ide_atapi_pc pc;
475	u8 *page;
476	int capacity, lba_capacity;
477	u16 transfer_rate, sector_size, cyls, rpm;
478	u8 heads, sectors;
479
480	ide_floppy_create_mode_sense_cmd(&pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE);
481
482	if (ide_queue_pc_tail(drive, disk, &pc)) {
483		printk(KERN_ERR "ide-floppy: Can't get flexible disk page"
484				" parameters\n");
485		return 1;
486	}
487
488	if (pc.buf[3] & 0x80)
489		drive->atapi_flags |= IDE_AFLAG_WP;
490	else
491		drive->atapi_flags &= ~IDE_AFLAG_WP;
492
493	set_disk_ro(disk, !!(drive->atapi_flags & IDE_AFLAG_WP));
494
495	page = &pc.buf[8];
496
497	transfer_rate = be16_to_cpup((__be16 *)&pc.buf[8 + 2]);
498	sector_size   = be16_to_cpup((__be16 *)&pc.buf[8 + 6]);
499	cyls          = be16_to_cpup((__be16 *)&pc.buf[8 + 8]);
500	rpm           = be16_to_cpup((__be16 *)&pc.buf[8 + 28]);
501	heads         = pc.buf[8 + 4];
502	sectors       = pc.buf[8 + 5];
503
504	capacity = cyls * heads * sectors * sector_size;
505
506	if (memcmp(page, &floppy->flexible_disk_page, 32))
507		printk(KERN_INFO "%s: %dkB, %d/%d/%d CHS, %d kBps, "
508				"%d sector size, %d rpm\n",
509				drive->name, capacity / 1024, cyls, heads,
510				sectors, transfer_rate / 8, sector_size, rpm);
511
512	memcpy(&floppy->flexible_disk_page, page, 32);
513	drive->bios_cyl = cyls;
514	drive->bios_head = heads;
515	drive->bios_sect = sectors;
516	lba_capacity = floppy->blocks * floppy->block_size;
517
518	if (capacity < lba_capacity) {
519		printk(KERN_NOTICE "%s: The disk reports a capacity of %d "
520			"bytes, but the drive only handles %d\n",
521			drive->name, lba_capacity, capacity);
522		floppy->blocks = floppy->block_size ?
523			capacity / floppy->block_size : 0;
524	}
525	return 0;
526}
527
528/*
529 * Determine if a media is present in the floppy drive, and if so, its LBA
530 * capacity.
531 */
532static int ide_floppy_get_capacity(ide_drive_t *drive)
533{
534	idefloppy_floppy_t *floppy = drive->driver_data;
535	struct gendisk *disk = floppy->disk;
536	struct ide_atapi_pc pc;
537	u8 *cap_desc;
538	u8 header_len, desc_cnt;
539	int i, rc = 1, blocks, length;
540
541	drive->bios_cyl = 0;
542	drive->bios_head = drive->bios_sect = 0;
543	floppy->blocks = 0;
544	floppy->bs_factor = 1;
545	set_capacity(floppy->disk, 0);
546
547	ide_floppy_create_read_capacity_cmd(&pc);
548	if (ide_queue_pc_tail(drive, disk, &pc)) {
549		printk(KERN_ERR "ide-floppy: Can't get floppy parameters\n");
550		return 1;
551	}
552	header_len = pc.buf[3];
553	cap_desc = &pc.buf[4];
554	desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
555
556	for (i = 0; i < desc_cnt; i++) {
557		unsigned int desc_start = 4 + i*8;
558
559		blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
560		length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
561
562		debug_log("Descriptor %d: %dkB, %d blocks, %d sector size\n",
563				i, blocks * length / 1024, blocks, length);
564
565		if (i)
566			continue;
567		/*
568		 * the code below is valid only for the 1st descriptor, ie i=0
569		 */
570
571		switch (pc.buf[desc_start + 4] & 0x03) {
572		/* Clik! drive returns this instead of CAPACITY_CURRENT */
573		case CAPACITY_UNFORMATTED:
574			if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
575				/*
576				 * If it is not a clik drive, break out
577				 * (maintains previous driver behaviour)
578				 */
579				break;
580		case CAPACITY_CURRENT:
581			/* Normal Zip/LS-120 disks */
582			if (memcmp(cap_desc, &floppy->cap_desc, 8))
583				printk(KERN_INFO "%s: %dkB, %d blocks, %d "
584					"sector size\n", drive->name,
585					blocks * length / 1024, blocks, length);
586			memcpy(&floppy->cap_desc, cap_desc, 8);
587
588			if (!length || length % 512) {
589				printk(KERN_NOTICE "%s: %d bytes block size "
590					"not supported\n", drive->name, length);
591			} else {
592				floppy->blocks = blocks;
593				floppy->block_size = length;
594				floppy->bs_factor = length / 512;
595				if (floppy->bs_factor != 1)
596					printk(KERN_NOTICE "%s: warning: non "
597						"512 bytes block size not "
598						"fully supported\n",
599						drive->name);
600				rc = 0;
601			}
602			break;
603		case CAPACITY_NO_CARTRIDGE:
604			/*
605			 * This is a KERN_ERR so it appears on screen
606			 * for the user to see
607			 */
608			printk(KERN_ERR "%s: No disk in drive\n", drive->name);
609			break;
610		case CAPACITY_INVALID:
611			printk(KERN_ERR "%s: Invalid capacity for disk "
612				"in drive\n", drive->name);
613			break;
614		}
615		debug_log("Descriptor 0 Code: %d\n",
616			  pc.buf[desc_start + 4] & 0x03);
617	}
618
619	/* Clik! disk does not support get_flexible_disk_page */
620	if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
621		(void) ide_floppy_get_flexible_disk_page(drive);
622
623	set_capacity(disk, floppy->blocks * floppy->bs_factor);
624
625	return rc;
626}
627
628static sector_t idefloppy_capacity(ide_drive_t *drive)
629{
630	idefloppy_floppy_t *floppy = drive->driver_data;
631	unsigned long capacity = floppy->blocks * floppy->bs_factor;
632
633	return capacity;
634}
635
636#ifdef CONFIG_IDE_PROC_FS
637ide_devset_rw(bios_cyl,  0, 1023, bios_cyl);
638ide_devset_rw(bios_head, 0,  255, bios_head);
639ide_devset_rw(bios_sect, 0,   63, bios_sect);
640
641static int get_ticks(ide_drive_t *drive)
642{
643	idefloppy_floppy_t *floppy = drive->driver_data;
644	return floppy->ticks;
645}
646
647static int set_ticks(ide_drive_t *drive, int arg)
648{
649	idefloppy_floppy_t *floppy = drive->driver_data;
650	floppy->ticks = arg;
651	return 0;
652}
653
654IDE_DEVSET(ticks, S_RW, 0, 255, get_ticks, set_ticks);
655
656static const struct ide_devset *idefloppy_settings[] = {
657	&ide_devset_bios_cyl,
658	&ide_devset_bios_head,
659	&ide_devset_bios_sect,
660	&ide_devset_ticks,
661	NULL
662};
663#endif
664
665static void idefloppy_setup(ide_drive_t *drive, idefloppy_floppy_t *floppy)
666{
667	u16 *id = drive->id;
668	u8 gcw[2];
669
670	*((u16 *)&gcw) = id[ATA_ID_CONFIG];
671
672	drive->pc_callback = ide_floppy_callback;
673
674	if (((gcw[0] & 0x60) >> 5) == 1)
675		drive->atapi_flags |= IDE_AFLAG_DRQ_INTERRUPT;
676	/*
677	 * We used to check revisions here. At this point however I'm giving up.
678	 * Just assume they are all broken, its easier.
679	 *
680	 * The actual reason for the workarounds was likely a driver bug after
681	 * all rather than a firmware bug, and the workaround below used to hide
682	 * it. It should be fixed as of version 1.9, but to be on the safe side
683	 * we'll leave the limitation below for the 2.2.x tree.
684	 */
685	if (!strncmp((char *)&id[ATA_ID_PROD], "IOMEGA ZIP 100 ATAPI", 20)) {
686		drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE;
687		/* This value will be visible in the /proc/ide/hdx/settings */
688		floppy->ticks = IDEFLOPPY_TICKS_DELAY;
689		blk_queue_max_sectors(drive->queue, 64);
690	}
691
692	/*
693	 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
694	 * nasty clicking noises without it, so please don't remove this.
695	 */
696	if (strncmp((char *)&id[ATA_ID_PROD], "IOMEGA Clik!", 11) == 0) {
697		blk_queue_max_sectors(drive->queue, 64);
698		drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE;
699		/* IOMEGA Clik! drives do not support lock/unlock commands */
700		drive->atapi_flags |= IDE_AFLAG_NO_DOORLOCK;
701	}
702
703	(void) ide_floppy_get_capacity(drive);
704
705	ide_proc_register_driver(drive, floppy->driver);
706}
707
708static void ide_floppy_remove(ide_drive_t *drive)
709{
710	idefloppy_floppy_t *floppy = drive->driver_data;
711	struct gendisk *g = floppy->disk;
712
713	ide_proc_unregister_driver(drive, floppy->driver);
714
715	del_gendisk(g);
716
717	ide_floppy_put(floppy);
718}
719
720static void idefloppy_cleanup_obj(struct kref *kref)
721{
722	struct ide_floppy_obj *floppy = to_ide_floppy(kref);
723	ide_drive_t *drive = floppy->drive;
724	struct gendisk *g = floppy->disk;
725
726	drive->driver_data = NULL;
727	g->private_data = NULL;
728	put_disk(g);
729	kfree(floppy);
730}
731
732#ifdef CONFIG_IDE_PROC_FS
733static int proc_idefloppy_read_capacity(char *page, char **start, off_t off,
734		int count, int *eof, void *data)
735{
736	ide_drive_t*drive = (ide_drive_t *)data;
737	int len;
738
739	len = sprintf(page, "%llu\n", (long long)idefloppy_capacity(drive));
740	PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
741}
742
743static ide_proc_entry_t idefloppy_proc[] = {
744	{ "capacity",	S_IFREG|S_IRUGO, proc_idefloppy_read_capacity,	NULL },
745	{ "geometry",	S_IFREG|S_IRUGO, proc_ide_read_geometry,	NULL },
746	{ NULL, 0, NULL, NULL }
747};
748#endif	/* CONFIG_IDE_PROC_FS */
749
750static int ide_floppy_probe(ide_drive_t *);
751
752static ide_driver_t idefloppy_driver = {
753	.gen_driver = {
754		.owner		= THIS_MODULE,
755		.name		= "ide-floppy",
756		.bus		= &ide_bus_type,
757	},
758	.probe			= ide_floppy_probe,
759	.remove			= ide_floppy_remove,
760	.version		= IDEFLOPPY_VERSION,
761	.media			= ide_floppy,
762	.do_request		= idefloppy_do_request,
763	.end_request		= idefloppy_end_request,
764	.error			= __ide_error,
765#ifdef CONFIG_IDE_PROC_FS
766	.proc			= idefloppy_proc,
767	.settings		= idefloppy_settings,
768#endif
769};
770
771static int idefloppy_open(struct inode *inode, struct file *filp)
772{
773	struct gendisk *disk = inode->i_bdev->bd_disk;
774	struct ide_floppy_obj *floppy;
775	ide_drive_t *drive;
776	int ret = 0;
777
778	debug_log("Reached %s\n", __func__);
779
780	floppy = ide_floppy_get(disk);
781	if (!floppy)
782		return -ENXIO;
783
784	drive = floppy->drive;
785
786	floppy->openers++;
787
788	if (floppy->openers == 1) {
789		drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
790		/* Just in case */
791
792		if (ide_do_test_unit_ready(drive, disk))
793			ide_do_start_stop(drive, disk, 1);
794
795		if (ide_floppy_get_capacity(drive)
796		   && (filp->f_flags & O_NDELAY) == 0
797		    /*
798		     * Allow O_NDELAY to open a drive without a disk, or with an
799		     * unreadable disk, so that we can get the format capacity
800		     * of the drive or begin the format - Sam
801		     */
802		    ) {
803			ret = -EIO;
804			goto out_put_floppy;
805		}
806
807		if ((drive->atapi_flags & IDE_AFLAG_WP) && (filp->f_mode & 2)) {
808			ret = -EROFS;
809			goto out_put_floppy;
810		}
811
812		drive->atapi_flags |= IDE_AFLAG_MEDIA_CHANGED;
813		ide_set_media_lock(drive, disk, 1);
814		check_disk_change(inode->i_bdev);
815	} else if (drive->atapi_flags & IDE_AFLAG_FORMAT_IN_PROGRESS) {
816		ret = -EBUSY;
817		goto out_put_floppy;
818	}
819	return 0;
820
821out_put_floppy:
822	floppy->openers--;
823	ide_floppy_put(floppy);
824	return ret;
825}
826
827static int idefloppy_release(struct inode *inode, struct file *filp)
828{
829	struct gendisk *disk = inode->i_bdev->bd_disk;
830	struct ide_floppy_obj *floppy = ide_floppy_g(disk);
831	ide_drive_t *drive = floppy->drive;
832
833	debug_log("Reached %s\n", __func__);
834
835	if (floppy->openers == 1) {
836		ide_set_media_lock(drive, disk, 0);
837		drive->atapi_flags &= ~IDE_AFLAG_FORMAT_IN_PROGRESS;
838	}
839
840	floppy->openers--;
841
842	ide_floppy_put(floppy);
843
844	return 0;
845}
846
847static int idefloppy_getgeo(struct block_device *bdev, struct hd_geometry *geo)
848{
849	struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
850	ide_drive_t *drive = floppy->drive;
851
852	geo->heads = drive->bios_head;
853	geo->sectors = drive->bios_sect;
854	geo->cylinders = (u16)drive->bios_cyl; /* truncate */
855	return 0;
856}
857
858static int ide_floppy_lockdoor(ide_drive_t *drive, struct ide_atapi_pc *pc,
859			       unsigned long arg, unsigned int cmd)
860{
861	idefloppy_floppy_t *floppy = drive->driver_data;
862	struct gendisk *disk = floppy->disk;
863	int prevent = (arg && cmd != CDROMEJECT) ? 1 : 0;
864
865	if (floppy->openers > 1)
866		return -EBUSY;
867
868	ide_set_media_lock(drive, disk, prevent);
869
870	if (cmd == CDROMEJECT)
871		ide_do_start_stop(drive, disk, 2);
872
873	return 0;
874}
875
876static int idefloppy_ioctl(struct inode *inode, struct file *file,
877			unsigned int cmd, unsigned long arg)
878{
879	struct block_device *bdev = inode->i_bdev;
880	struct ide_floppy_obj *floppy = ide_floppy_g(bdev->bd_disk);
881	ide_drive_t *drive = floppy->drive;
882	struct ide_atapi_pc pc;
883	void __user *argp = (void __user *)arg;
884	int err;
885
886	if (cmd == CDROMEJECT || cmd == CDROM_LOCKDOOR)
887		return ide_floppy_lockdoor(drive, &pc, arg, cmd);
888
889	err = ide_floppy_format_ioctl(drive, file, cmd, argp);
890	if (err != -ENOTTY)
891		return err;
892
893	/*
894	 * skip SCSI_IOCTL_SEND_COMMAND (deprecated)
895	 * and CDROM_SEND_PACKET (legacy) ioctls
896	 */
897	if (cmd != CDROM_SEND_PACKET && cmd != SCSI_IOCTL_SEND_COMMAND)
898		err = scsi_cmd_ioctl(file, bdev->bd_disk->queue,
899					bdev->bd_disk, cmd, argp);
900
901	if (err == -ENOTTY)
902		err = generic_ide_ioctl(drive, file, bdev, cmd, arg);
903
904	return err;
905}
906
907static int idefloppy_media_changed(struct gendisk *disk)
908{
909	struct ide_floppy_obj *floppy = ide_floppy_g(disk);
910	ide_drive_t *drive = floppy->drive;
911	int ret;
912
913	/* do not scan partitions twice if this is a removable device */
914	if (drive->attach) {
915		drive->attach = 0;
916		return 0;
917	}
918	ret = !!(drive->atapi_flags & IDE_AFLAG_MEDIA_CHANGED);
919	drive->atapi_flags &= ~IDE_AFLAG_MEDIA_CHANGED;
920	return ret;
921}
922
923static int idefloppy_revalidate_disk(struct gendisk *disk)
924{
925	struct ide_floppy_obj *floppy = ide_floppy_g(disk);
926	set_capacity(disk, idefloppy_capacity(floppy->drive));
927	return 0;
928}
929
930static struct block_device_operations idefloppy_ops = {
931	.owner			= THIS_MODULE,
932	.open			= idefloppy_open,
933	.release		= idefloppy_release,
934	.ioctl			= idefloppy_ioctl,
935	.getgeo			= idefloppy_getgeo,
936	.media_changed		= idefloppy_media_changed,
937	.revalidate_disk	= idefloppy_revalidate_disk
938};
939
940static int ide_floppy_probe(ide_drive_t *drive)
941{
942	idefloppy_floppy_t *floppy;
943	struct gendisk *g;
944
945	if (!strstr("ide-floppy", drive->driver_req))
946		goto failed;
947
948	if (drive->media != ide_floppy)
949		goto failed;
950
951	if (!ide_check_atapi_device(drive, DRV_NAME)) {
952		printk(KERN_ERR "ide-floppy: %s: not supported by this version"
953				" of ide-floppy\n", drive->name);
954		goto failed;
955	}
956	floppy = kzalloc(sizeof(idefloppy_floppy_t), GFP_KERNEL);
957	if (!floppy) {
958		printk(KERN_ERR "ide-floppy: %s: Can't allocate a floppy"
959				" structure\n", drive->name);
960		goto failed;
961	}
962
963	g = alloc_disk(1 << PARTN_BITS);
964	if (!g)
965		goto out_free_floppy;
966
967	ide_init_disk(g, drive);
968
969	kref_init(&floppy->kref);
970
971	floppy->drive = drive;
972	floppy->driver = &idefloppy_driver;
973	floppy->disk = g;
974
975	g->private_data = &floppy->driver;
976
977	drive->driver_data = floppy;
978
979	idefloppy_setup(drive, floppy);
980
981	g->minors = 1 << PARTN_BITS;
982	g->driverfs_dev = &drive->gendev;
983	g->flags = drive->removable ? GENHD_FL_REMOVABLE : 0;
984	g->fops = &idefloppy_ops;
985	drive->attach = 1;
986	add_disk(g);
987	return 0;
988
989out_free_floppy:
990	kfree(floppy);
991failed:
992	return -ENODEV;
993}
994
995static void __exit idefloppy_exit(void)
996{
997	driver_unregister(&idefloppy_driver.gen_driver);
998}
999
1000static int __init idefloppy_init(void)
1001{
1002	printk("ide-floppy driver " IDEFLOPPY_VERSION "\n");
1003	return driver_register(&idefloppy_driver.gen_driver);
1004}
1005
1006MODULE_ALIAS("ide:*m-floppy*");
1007MODULE_ALIAS("ide-floppy");
1008module_init(idefloppy_init);
1009module_exit(idefloppy_exit);
1010MODULE_LICENSE("GPL");
1011MODULE_DESCRIPTION("ATAPI FLOPPY Driver");
1012
1013