ide-floppy.c revision 3ee38302ffc63da93eb0313053a990bb3466e275 
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#include <linux/types.h>
19#include <linux/string.h>
20#include <linux/kernel.h>
21#include <linux/delay.h>
22#include <linux/timer.h>
23#include <linux/mm.h>
24#include <linux/interrupt.h>
25#include <linux/major.h>
26#include <linux/errno.h>
27#include <linux/genhd.h>
28#include <linux/slab.h>
29#include <linux/cdrom.h>
30#include <linux/ide.h>
31#include <linux/hdreg.h>
32#include <linux/bitops.h>
33#include <linux/mutex.h>
34#include <linux/scatterlist.h>
35
36#include <scsi/scsi_ioctl.h>
37
38#include <asm/byteorder.h>
39#include <linux/irq.h>
40#include <linux/uaccess.h>
41#include <linux/io.h>
42#include <asm/unaligned.h>
43
44#include "ide-floppy.h"
45
46/*
47 * After each failed packet command we issue a request sense command and retry
48 * the packet command IDEFLOPPY_MAX_PC_RETRIES times.
49 */
50#define IDEFLOPPY_MAX_PC_RETRIES	3
51
52/* format capacities descriptor codes */
53#define CAPACITY_INVALID	0x00
54#define CAPACITY_UNFORMATTED	0x01
55#define CAPACITY_CURRENT	0x02
56#define CAPACITY_NO_CARTRIDGE	0x03
57
58/*
59 * The following delay solves a problem with ATAPI Zip 100 drive where BSY bit
60 * was apparently being deasserted before the unit was ready to receive data.
61 */
62#define IDEFLOPPY_PC_DELAY	(HZ/20)	/* default delay for ZIP 100 (50ms) */
63
64static void idefloppy_update_buffers(ide_drive_t *drive,
65				struct ide_atapi_pc *pc)
66{
67	struct request *rq = pc->rq;
68	struct bio *bio = rq->bio;
69
70	while ((bio = rq->bio) != NULL)
71		ide_end_request(drive, 1, 0);
72}
73
74static void ide_floppy_callback(ide_drive_t *drive, int dsc)
75{
76	struct ide_disk_obj *floppy = drive->driver_data;
77	struct ide_atapi_pc *pc = drive->pc;
78	struct request *rq = pc->rq;
79	int uptodate = pc->error ? 0 : 1;
80
81	ide_debug_log(IDE_DBG_FUNC, "enter");
82
83	if (drive->failed_pc == pc)
84		drive->failed_pc = NULL;
85
86	if (pc->c[0] == GPCMD_READ_10 || pc->c[0] == GPCMD_WRITE_10 ||
87	    (rq && blk_pc_request(rq)))
88		uptodate = 1; /* FIXME */
89	else if (pc->c[0] == GPCMD_REQUEST_SENSE) {
90		u8 *buf = pc->buf;
91
92		if (!pc->error) {
93			floppy->sense_key = buf[2] & 0x0F;
94			floppy->asc = buf[12];
95			floppy->ascq = buf[13];
96			floppy->progress_indication = buf[15] & 0x80 ?
97				(u16)get_unaligned((u16 *)&buf[16]) : 0x10000;
98
99			if (drive->failed_pc)
100				ide_debug_log(IDE_DBG_PC, "pc = %x",
101					      drive->failed_pc->c[0]);
102
103			ide_debug_log(IDE_DBG_SENSE, "sense key = %x, asc = %x,"
104				      "ascq = %x", floppy->sense_key,
105				      floppy->asc, floppy->ascq);
106		} else
107			printk(KERN_ERR PFX "Error in REQUEST SENSE itself - "
108			       "Aborting request!\n");
109	}
110
111	if (uptodate == 0)
112		drive->failed_pc = NULL;
113
114	if (blk_special_request(rq)) {
115		rq->errors = uptodate ? 0 : IDE_DRV_ERROR_GENERAL;
116		ide_complete_rq(drive, 0);
117	} else
118		ide_end_request(drive, uptodate, 0);
119}
120
121static void ide_floppy_report_error(struct ide_disk_obj *floppy,
122				    struct ide_atapi_pc *pc)
123{
124	/* supress error messages resulting from Medium not present */
125	if (floppy->sense_key == 0x02 &&
126	    floppy->asc       == 0x3a &&
127	    floppy->ascq      == 0x00)
128		return;
129
130	printk(KERN_ERR PFX "%s: I/O error, pc = %2x, key = %2x, "
131			"asc = %2x, ascq = %2x\n",
132			floppy->drive->name, pc->c[0], floppy->sense_key,
133			floppy->asc, floppy->ascq);
134
135}
136
137static ide_startstop_t idefloppy_issue_pc(ide_drive_t *drive,
138		struct ide_atapi_pc *pc)
139{
140	struct ide_disk_obj *floppy = drive->driver_data;
141
142	if (drive->failed_pc == NULL &&
143	    pc->c[0] != GPCMD_REQUEST_SENSE)
144		drive->failed_pc = pc;
145
146	/* Set the current packet command */
147	drive->pc = pc;
148
149	if (pc->retries > IDEFLOPPY_MAX_PC_RETRIES) {
150		if (!(pc->flags & PC_FLAG_SUPPRESS_ERROR))
151			ide_floppy_report_error(floppy, pc);
152		/* Giving up */
153		pc->error = IDE_DRV_ERROR_GENERAL;
154
155		drive->failed_pc = NULL;
156		drive->pc_callback(drive, 0);
157		return ide_stopped;
158	}
159
160	ide_debug_log(IDE_DBG_FUNC, "retry #%d", pc->retries);
161
162	pc->retries++;
163
164	return ide_issue_pc(drive);
165}
166
167void ide_floppy_create_read_capacity_cmd(struct ide_atapi_pc *pc)
168{
169	ide_init_pc(pc);
170	pc->c[0] = GPCMD_READ_FORMAT_CAPACITIES;
171	pc->c[7] = 255;
172	pc->c[8] = 255;
173	pc->req_xfer = 255;
174}
175
176/* A mode sense command is used to "sense" floppy parameters. */
177void ide_floppy_create_mode_sense_cmd(struct ide_atapi_pc *pc, u8 page_code)
178{
179	u16 length = 8; /* sizeof(Mode Parameter Header) = 8 Bytes */
180
181	ide_init_pc(pc);
182	pc->c[0] = GPCMD_MODE_SENSE_10;
183	pc->c[1] = 0;
184	pc->c[2] = page_code;
185
186	switch (page_code) {
187	case IDEFLOPPY_CAPABILITIES_PAGE:
188		length += 12;
189		break;
190	case IDEFLOPPY_FLEXIBLE_DISK_PAGE:
191		length += 32;
192		break;
193	default:
194		printk(KERN_ERR PFX "unsupported page code in %s\n", __func__);
195	}
196	put_unaligned(cpu_to_be16(length), (u16 *) &pc->c[7]);
197	pc->req_xfer = length;
198}
199
200static void idefloppy_create_rw_cmd(ide_drive_t *drive,
201				    struct ide_atapi_pc *pc, struct request *rq,
202				    unsigned long sector)
203{
204	struct ide_disk_obj *floppy = drive->driver_data;
205	int block = sector / floppy->bs_factor;
206	int blocks = rq->nr_sectors / floppy->bs_factor;
207	int cmd = rq_data_dir(rq);
208
209	ide_debug_log(IDE_DBG_FUNC, "block: %d, blocks: %d", block, blocks);
210
211	ide_init_pc(pc);
212	pc->c[0] = cmd == READ ? GPCMD_READ_10 : GPCMD_WRITE_10;
213	put_unaligned(cpu_to_be16(blocks), (unsigned short *)&pc->c[7]);
214	put_unaligned(cpu_to_be32(block), (unsigned int *) &pc->c[2]);
215
216	memcpy(rq->cmd, pc->c, 12);
217
218	pc->rq = rq;
219	pc->b_count = 0;
220	if (rq->cmd_flags & REQ_RW)
221		pc->flags |= PC_FLAG_WRITING;
222	pc->buf = NULL;
223	pc->req_xfer = pc->buf_size = blocks * floppy->block_size;
224	pc->flags |= PC_FLAG_DMA_OK;
225}
226
227static void idefloppy_blockpc_cmd(struct ide_disk_obj *floppy,
228		struct ide_atapi_pc *pc, struct request *rq)
229{
230	ide_init_pc(pc);
231	memcpy(pc->c, rq->cmd, sizeof(pc->c));
232	pc->rq = rq;
233	pc->b_count = 0;
234	if (rq->data_len && rq_data_dir(rq) == WRITE)
235		pc->flags |= PC_FLAG_WRITING;
236	pc->buf = rq->data;
237	if (rq->bio)
238		pc->flags |= PC_FLAG_DMA_OK;
239	/*
240	 * possibly problematic, doesn't look like ide-floppy correctly
241	 * handled scattered requests if dma fails...
242	 */
243	pc->req_xfer = pc->buf_size = rq->data_len;
244}
245
246static ide_startstop_t ide_floppy_do_request(ide_drive_t *drive,
247					     struct request *rq, sector_t block)
248{
249	struct ide_disk_obj *floppy = drive->driver_data;
250	ide_hwif_t *hwif = drive->hwif;
251	struct ide_atapi_pc *pc;
252
253	if (drive->debug_mask & IDE_DBG_RQ)
254		blk_dump_rq_flags(rq, (rq->rq_disk
255					? rq->rq_disk->disk_name
256					: "dev?"));
257
258	if (rq->errors >= ERROR_MAX) {
259		if (drive->failed_pc) {
260			ide_floppy_report_error(floppy, drive->failed_pc);
261			drive->failed_pc = NULL;
262		} else
263			printk(KERN_ERR PFX "%s: I/O error\n", drive->name);
264
265		if (blk_special_request(rq)) {
266			rq->errors = IDE_DRV_ERROR_GENERAL;
267			ide_complete_rq(drive, 0);
268			return ide_stopped;
269		} else
270			goto out_end;
271	}
272	if (blk_fs_request(rq)) {
273		if (((long)rq->sector % floppy->bs_factor) ||
274		    (rq->nr_sectors % floppy->bs_factor)) {
275			printk(KERN_ERR PFX "%s: unsupported r/w rq size\n",
276				drive->name);
277			goto out_end;
278		}
279		pc = &floppy->queued_pc;
280		idefloppy_create_rw_cmd(drive, pc, rq, (unsigned long)block);
281	} else if (blk_special_request(rq)) {
282		pc = (struct ide_atapi_pc *) rq->buffer;
283	} else if (blk_pc_request(rq)) {
284		pc = &floppy->queued_pc;
285		idefloppy_blockpc_cmd(floppy, pc, rq);
286	} else {
287		blk_dump_rq_flags(rq, PFX "unsupported command in queue");
288		goto out_end;
289	}
290
291	if (blk_fs_request(rq) || pc->req_xfer) {
292		ide_init_sg_cmd(drive, rq);
293		ide_map_sg(drive, rq);
294	}
295
296	pc->sg = hwif->sg_table;
297	pc->sg_cnt = hwif->sg_nents;
298
299	pc->rq = rq;
300
301	return idefloppy_issue_pc(drive, pc);
302out_end:
303	drive->failed_pc = NULL;
304	ide_end_request(drive, 0, 0);
305	return ide_stopped;
306}
307
308/*
309 * Look at the flexible disk page parameters. We ignore the CHS capacity
310 * parameters and use the LBA parameters instead.
311 */
312static int ide_floppy_get_flexible_disk_page(ide_drive_t *drive,
313					     struct ide_atapi_pc *pc)
314{
315	struct ide_disk_obj *floppy = drive->driver_data;
316	struct gendisk *disk = floppy->disk;
317	u8 *page;
318	int capacity, lba_capacity;
319	u16 transfer_rate, sector_size, cyls, rpm;
320	u8 heads, sectors;
321
322	ide_floppy_create_mode_sense_cmd(pc, IDEFLOPPY_FLEXIBLE_DISK_PAGE);
323
324	if (ide_queue_pc_tail(drive, disk, pc)) {
325		printk(KERN_ERR PFX "Can't get flexible disk page params\n");
326		return 1;
327	}
328
329	if (pc->buf[3] & 0x80)
330		drive->dev_flags |= IDE_DFLAG_WP;
331	else
332		drive->dev_flags &= ~IDE_DFLAG_WP;
333
334	set_disk_ro(disk, !!(drive->dev_flags & IDE_DFLAG_WP));
335
336	page = &pc->buf[8];
337
338	transfer_rate = be16_to_cpup((__be16 *)&pc->buf[8 + 2]);
339	sector_size   = be16_to_cpup((__be16 *)&pc->buf[8 + 6]);
340	cyls          = be16_to_cpup((__be16 *)&pc->buf[8 + 8]);
341	rpm           = be16_to_cpup((__be16 *)&pc->buf[8 + 28]);
342	heads         = pc->buf[8 + 4];
343	sectors       = pc->buf[8 + 5];
344
345	capacity = cyls * heads * sectors * sector_size;
346
347	if (memcmp(page, &floppy->flexible_disk_page, 32))
348		printk(KERN_INFO PFX "%s: %dkB, %d/%d/%d CHS, %d kBps, "
349				"%d sector size, %d rpm\n",
350				drive->name, capacity / 1024, cyls, heads,
351				sectors, transfer_rate / 8, sector_size, rpm);
352
353	memcpy(&floppy->flexible_disk_page, page, 32);
354	drive->bios_cyl = cyls;
355	drive->bios_head = heads;
356	drive->bios_sect = sectors;
357	lba_capacity = floppy->blocks * floppy->block_size;
358
359	if (capacity < lba_capacity) {
360		printk(KERN_NOTICE PFX "%s: The disk reports a capacity of %d "
361			"bytes, but the drive only handles %d\n",
362			drive->name, lba_capacity, capacity);
363		floppy->blocks = floppy->block_size ?
364			capacity / floppy->block_size : 0;
365		drive->capacity64 = floppy->blocks * floppy->bs_factor;
366	}
367
368	return 0;
369}
370
371/*
372 * Determine if a media is present in the floppy drive, and if so, its LBA
373 * capacity.
374 */
375static int ide_floppy_get_capacity(ide_drive_t *drive)
376{
377	struct ide_disk_obj *floppy = drive->driver_data;
378	struct gendisk *disk = floppy->disk;
379	struct ide_atapi_pc pc;
380	u8 *cap_desc;
381	u8 header_len, desc_cnt;
382	int i, rc = 1, blocks, length;
383
384	drive->bios_cyl = 0;
385	drive->bios_head = drive->bios_sect = 0;
386	floppy->blocks = 0;
387	floppy->bs_factor = 1;
388	drive->capacity64 = 0;
389
390	ide_floppy_create_read_capacity_cmd(&pc);
391	if (ide_queue_pc_tail(drive, disk, &pc)) {
392		printk(KERN_ERR PFX "Can't get floppy parameters\n");
393		return 1;
394	}
395	header_len = pc.buf[3];
396	cap_desc = &pc.buf[4];
397	desc_cnt = header_len / 8; /* capacity descriptor of 8 bytes */
398
399	for (i = 0; i < desc_cnt; i++) {
400		unsigned int desc_start = 4 + i*8;
401
402		blocks = be32_to_cpup((__be32 *)&pc.buf[desc_start]);
403		length = be16_to_cpup((__be16 *)&pc.buf[desc_start + 6]);
404
405		ide_debug_log(IDE_DBG_PROBE, "Descriptor %d: %dkB, %d blocks, "
406					     "%d sector size",
407					     i, blocks * length / 1024,
408					     blocks, length);
409
410		if (i)
411			continue;
412		/*
413		 * the code below is valid only for the 1st descriptor, ie i=0
414		 */
415
416		switch (pc.buf[desc_start + 4] & 0x03) {
417		/* Clik! drive returns this instead of CAPACITY_CURRENT */
418		case CAPACITY_UNFORMATTED:
419			if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
420				/*
421				 * If it is not a clik drive, break out
422				 * (maintains previous driver behaviour)
423				 */
424				break;
425		case CAPACITY_CURRENT:
426			/* Normal Zip/LS-120 disks */
427			if (memcmp(cap_desc, &floppy->cap_desc, 8))
428				printk(KERN_INFO PFX "%s: %dkB, %d blocks, %d "
429				       "sector size\n",
430				       drive->name, blocks * length / 1024,
431				       blocks, length);
432			memcpy(&floppy->cap_desc, cap_desc, 8);
433
434			if (!length || length % 512) {
435				printk(KERN_NOTICE PFX "%s: %d bytes block size"
436				       " not supported\n", drive->name, length);
437			} else {
438				floppy->blocks = blocks;
439				floppy->block_size = length;
440				floppy->bs_factor = length / 512;
441				if (floppy->bs_factor != 1)
442					printk(KERN_NOTICE PFX "%s: Warning: "
443					       "non 512 bytes block size not "
444					       "fully supported\n",
445					       drive->name);
446				drive->capacity64 =
447					floppy->blocks * floppy->bs_factor;
448				rc = 0;
449			}
450			break;
451		case CAPACITY_NO_CARTRIDGE:
452			/*
453			 * This is a KERN_ERR so it appears on screen
454			 * for the user to see
455			 */
456			printk(KERN_ERR PFX "%s: No disk in drive\n",
457			       drive->name);
458			break;
459		case CAPACITY_INVALID:
460			printk(KERN_ERR PFX "%s: Invalid capacity for disk "
461				"in drive\n", drive->name);
462			break;
463		}
464		ide_debug_log(IDE_DBG_PROBE, "Descriptor 0 Code: %d",
465					     pc.buf[desc_start + 4] & 0x03);
466	}
467
468	/* Clik! disk does not support get_flexible_disk_page */
469	if (!(drive->atapi_flags & IDE_AFLAG_CLIK_DRIVE))
470		(void) ide_floppy_get_flexible_disk_page(drive, &pc);
471
472	return rc;
473}
474
475static void ide_floppy_setup(ide_drive_t *drive)
476{
477	struct ide_disk_obj *floppy = drive->driver_data;
478	u16 *id = drive->id;
479
480	drive->pc_callback	 = ide_floppy_callback;
481	drive->pc_update_buffers = idefloppy_update_buffers;
482	drive->pc_io_buffers	 = ide_io_buffers;
483
484	/*
485	 * We used to check revisions here. At this point however I'm giving up.
486	 * Just assume they are all broken, its easier.
487	 *
488	 * The actual reason for the workarounds was likely a driver bug after
489	 * all rather than a firmware bug, and the workaround below used to hide
490	 * it. It should be fixed as of version 1.9, but to be on the safe side
491	 * we'll leave the limitation below for the 2.2.x tree.
492	 */
493	if (!strncmp((char *)&id[ATA_ID_PROD], "IOMEGA ZIP 100 ATAPI", 20)) {
494		drive->atapi_flags |= IDE_AFLAG_ZIP_DRIVE;
495		/* This value will be visible in the /proc/ide/hdx/settings */
496		drive->pc_delay = IDEFLOPPY_PC_DELAY;
497		blk_queue_max_sectors(drive->queue, 64);
498	}
499
500	/*
501	 * Guess what? The IOMEGA Clik! drive also needs the above fix. It makes
502	 * nasty clicking noises without it, so please don't remove this.
503	 */
504	if (strncmp((char *)&id[ATA_ID_PROD], "IOMEGA Clik!", 11) == 0) {
505		blk_queue_max_sectors(drive->queue, 64);
506		drive->atapi_flags |= IDE_AFLAG_CLIK_DRIVE;
507		/* IOMEGA Clik! drives do not support lock/unlock commands */
508		drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING;
509	}
510
511	(void) ide_floppy_get_capacity(drive);
512
513	ide_proc_register_driver(drive, floppy->driver);
514
515	drive->dev_flags |= IDE_DFLAG_ATTACH;
516}
517
518static void ide_floppy_flush(ide_drive_t *drive)
519{
520}
521
522static int ide_floppy_init_media(ide_drive_t *drive, struct gendisk *disk)
523{
524	int ret = 0;
525
526	if (ide_do_test_unit_ready(drive, disk))
527		ide_do_start_stop(drive, disk, 1);
528
529	ret = ide_floppy_get_capacity(drive);
530
531	set_capacity(disk, ide_gd_capacity(drive));
532
533	return ret;
534}
535
536const struct ide_disk_ops ide_atapi_disk_ops = {
537	.check		= ide_check_atapi_device,
538	.get_capacity	= ide_floppy_get_capacity,
539	.setup		= ide_floppy_setup,
540	.flush		= ide_floppy_flush,
541	.init_media	= ide_floppy_init_media,
542	.set_doorlock	= ide_set_media_lock,
543	.do_request	= ide_floppy_do_request,
544	.ioctl		= ide_floppy_ioctl,
545};
546