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