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