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