[PATCH] radix-tree documentation cleanups
[linux-2.6/mini2440.git] / drivers / scsi / ide-scsi.c
blob39b760a2424160c518d3415ef0fc9f4e44843762
1 /*
2 * linux/drivers/scsi/ide-scsi.c Version 0.9 Jul 4, 1999
4 * Copyright (C) 1996 - 1999 Gadi Oxman <gadio@netvision.net.il>
5 */
7 /*
8 * Emulation of a SCSI host adapter for IDE ATAPI devices.
10 * With this driver, one can use the Linux SCSI drivers instead of the
11 * native IDE ATAPI drivers.
13 * Ver 0.1 Dec 3 96 Initial version.
14 * Ver 0.2 Jan 26 97 Fixed bug in cleanup_module() and added emulation
15 * of MODE_SENSE_6/MODE_SELECT_6 for cdroms. Thanks
16 * to Janos Farkas for pointing this out.
17 * Avoid using bitfields in structures for m68k.
18 * Added Scatter/Gather and DMA support.
19 * Ver 0.4 Dec 7 97 Add support for ATAPI PD/CD drives.
20 * Use variable timeout for each command.
21 * Ver 0.5 Jan 2 98 Fix previous PD/CD support.
22 * Allow disabling of SCSI-6 to SCSI-10 transformation.
23 * Ver 0.6 Jan 27 98 Allow disabling of SCSI command translation layer
24 * for access through /dev/sg.
25 * Fix MODE_SENSE_6/MODE_SELECT_6/INQUIRY translation.
26 * Ver 0.7 Dec 04 98 Ignore commands where lun != 0 to avoid multiple
27 * detection of devices with CONFIG_SCSI_MULTI_LUN
28 * Ver 0.8 Feb 05 99 Optical media need translation too. Reverse 0.7.
29 * Ver 0.9 Jul 04 99 Fix a bug in SG_SET_TRANSFORM.
30 * Ver 0.91 Jun 10 02 Fix "off by one" error in transforms
31 * Ver 0.92 Dec 31 02 Implement new SCSI mid level API
34 #define IDESCSI_VERSION "0.92"
36 #include <linux/module.h>
37 #include <linux/config.h>
38 #include <linux/types.h>
39 #include <linux/string.h>
40 #include <linux/kernel.h>
41 #include <linux/mm.h>
42 #include <linux/ioport.h>
43 #include <linux/blkdev.h>
44 #include <linux/errno.h>
45 #include <linux/hdreg.h>
46 #include <linux/slab.h>
47 #include <linux/ide.h>
48 #include <linux/scatterlist.h>
49 #include <linux/delay.h>
50 #include <linux/mutex.h>
52 #include <asm/io.h>
53 #include <asm/bitops.h>
54 #include <asm/uaccess.h>
56 #include <scsi/scsi.h>
57 #include <scsi/scsi_cmnd.h>
58 #include <scsi/scsi_device.h>
59 #include <scsi/scsi_host.h>
60 #include <scsi/scsi_tcq.h>
61 #include <scsi/sg.h>
63 #define IDESCSI_DEBUG_LOG 0
65 typedef struct idescsi_pc_s {
66 u8 c[12]; /* Actual packet bytes */
67 int request_transfer; /* Bytes to transfer */
68 int actually_transferred; /* Bytes actually transferred */
69 int buffer_size; /* Size of our data buffer */
70 struct request *rq; /* The corresponding request */
71 u8 *buffer; /* Data buffer */
72 u8 *current_position; /* Pointer into the above buffer */
73 struct scatterlist *sg; /* Scatter gather table */
74 int b_count; /* Bytes transferred from current entry */
75 struct scsi_cmnd *scsi_cmd; /* SCSI command */
76 void (*done)(struct scsi_cmnd *); /* Scsi completion routine */
77 unsigned long flags; /* Status/Action flags */
78 unsigned long timeout; /* Command timeout */
79 } idescsi_pc_t;
82 * Packet command status bits.
84 #define PC_DMA_IN_PROGRESS 0 /* 1 while DMA in progress */
85 #define PC_WRITING 1 /* Data direction */
86 #define PC_TRANSFORM 2 /* transform SCSI commands */
87 #define PC_TIMEDOUT 3 /* command timed out */
88 #define PC_DMA_OK 4 /* Use DMA */
91 * SCSI command transformation layer
93 #define IDESCSI_TRANSFORM 0 /* Enable/Disable transformation */
94 #define IDESCSI_SG_TRANSFORM 1 /* /dev/sg transformation */
97 * Log flags
99 #define IDESCSI_LOG_CMD 0 /* Log SCSI commands */
101 typedef struct ide_scsi_obj {
102 ide_drive_t *drive;
103 ide_driver_t *driver;
104 struct gendisk *disk;
105 struct Scsi_Host *host;
107 idescsi_pc_t *pc; /* Current packet command */
108 unsigned long flags; /* Status/Action flags */
109 unsigned long transform; /* SCSI cmd translation layer */
110 unsigned long log; /* log flags */
111 } idescsi_scsi_t;
113 static DEFINE_MUTEX(idescsi_ref_mutex);
115 #define ide_scsi_g(disk) \
116 container_of((disk)->private_data, struct ide_scsi_obj, driver)
118 static struct ide_scsi_obj *ide_scsi_get(struct gendisk *disk)
120 struct ide_scsi_obj *scsi = NULL;
122 mutex_lock(&idescsi_ref_mutex);
123 scsi = ide_scsi_g(disk);
124 if (scsi)
125 scsi_host_get(scsi->host);
126 mutex_unlock(&idescsi_ref_mutex);
127 return scsi;
130 static void ide_scsi_put(struct ide_scsi_obj *scsi)
132 mutex_lock(&idescsi_ref_mutex);
133 scsi_host_put(scsi->host);
134 mutex_unlock(&idescsi_ref_mutex);
137 static inline idescsi_scsi_t *scsihost_to_idescsi(struct Scsi_Host *host)
139 return (idescsi_scsi_t*) (&host[1]);
142 static inline idescsi_scsi_t *drive_to_idescsi(ide_drive_t *ide_drive)
144 return scsihost_to_idescsi(ide_drive->driver_data);
148 * Per ATAPI device status bits.
150 #define IDESCSI_DRQ_INTERRUPT 0 /* DRQ interrupt device */
153 * ide-scsi requests.
155 #define IDESCSI_PC_RQ 90
157 static void idescsi_discard_data (ide_drive_t *drive, unsigned int bcount)
159 while (bcount--)
160 (void) HWIF(drive)->INB(IDE_DATA_REG);
163 static void idescsi_output_zeros (ide_drive_t *drive, unsigned int bcount)
165 while (bcount--)
166 HWIF(drive)->OUTB(0, IDE_DATA_REG);
170 * PIO data transfer routines using the scatter gather table.
172 static void idescsi_input_buffers (ide_drive_t *drive, idescsi_pc_t *pc, unsigned int bcount)
174 int count;
175 char *buf;
177 while (bcount) {
178 if (pc->sg - (struct scatterlist *) pc->scsi_cmd->request_buffer > pc->scsi_cmd->use_sg) {
179 printk (KERN_ERR "ide-scsi: scatter gather table too small, discarding data\n");
180 idescsi_discard_data (drive, bcount);
181 return;
183 count = min(pc->sg->length - pc->b_count, bcount);
184 if (PageHighMem(pc->sg->page)) {
185 unsigned long flags;
187 local_irq_save(flags);
188 buf = kmap_atomic(pc->sg->page, KM_IRQ0) +
189 pc->sg->offset;
190 drive->hwif->atapi_input_bytes(drive,
191 buf + pc->b_count, count);
192 kunmap_atomic(buf - pc->sg->offset, KM_IRQ0);
193 local_irq_restore(flags);
194 } else {
195 buf = page_address(pc->sg->page) + pc->sg->offset;
196 drive->hwif->atapi_input_bytes(drive,
197 buf + pc->b_count, count);
199 bcount -= count; pc->b_count += count;
200 if (pc->b_count == pc->sg->length) {
201 pc->sg++;
202 pc->b_count = 0;
207 static void idescsi_output_buffers (ide_drive_t *drive, idescsi_pc_t *pc, unsigned int bcount)
209 int count;
210 char *buf;
212 while (bcount) {
213 if (pc->sg - (struct scatterlist *) pc->scsi_cmd->request_buffer > pc->scsi_cmd->use_sg) {
214 printk (KERN_ERR "ide-scsi: scatter gather table too small, padding with zeros\n");
215 idescsi_output_zeros (drive, bcount);
216 return;
218 count = min(pc->sg->length - pc->b_count, bcount);
219 if (PageHighMem(pc->sg->page)) {
220 unsigned long flags;
222 local_irq_save(flags);
223 buf = kmap_atomic(pc->sg->page, KM_IRQ0) +
224 pc->sg->offset;
225 drive->hwif->atapi_output_bytes(drive,
226 buf + pc->b_count, count);
227 kunmap_atomic(buf - pc->sg->offset, KM_IRQ0);
228 local_irq_restore(flags);
229 } else {
230 buf = page_address(pc->sg->page) + pc->sg->offset;
231 drive->hwif->atapi_output_bytes(drive,
232 buf + pc->b_count, count);
234 bcount -= count; pc->b_count += count;
235 if (pc->b_count == pc->sg->length) {
236 pc->sg++;
237 pc->b_count = 0;
243 * Most of the SCSI commands are supported directly by ATAPI devices.
244 * idescsi_transform_pc handles the few exceptions.
246 static inline void idescsi_transform_pc1 (ide_drive_t *drive, idescsi_pc_t *pc)
248 u8 *c = pc->c, *scsi_buf = pc->buffer, *sc = pc->scsi_cmd->cmnd;
249 char *atapi_buf;
251 if (!test_bit(PC_TRANSFORM, &pc->flags))
252 return;
253 if (drive->media == ide_cdrom || drive->media == ide_optical) {
254 if (c[0] == READ_6 || c[0] == WRITE_6) {
255 c[8] = c[4]; c[5] = c[3]; c[4] = c[2];
256 c[3] = c[1] & 0x1f; c[2] = 0; c[1] &= 0xe0;
257 c[0] += (READ_10 - READ_6);
259 if (c[0] == MODE_SENSE || c[0] == MODE_SELECT) {
260 unsigned short new_len;
261 if (!scsi_buf)
262 return;
263 if ((atapi_buf = kmalloc(pc->buffer_size + 4, GFP_ATOMIC)) == NULL)
264 return;
265 memset(atapi_buf, 0, pc->buffer_size + 4);
266 memset (c, 0, 12);
267 c[0] = sc[0] | 0x40;
268 c[1] = sc[1];
269 c[2] = sc[2];
270 new_len = sc[4] + 4;
271 c[8] = new_len;
272 c[7] = new_len >> 8;
273 c[9] = sc[5];
274 if (c[0] == MODE_SELECT_10) {
275 atapi_buf[1] = scsi_buf[0]; /* Mode data length */
276 atapi_buf[2] = scsi_buf[1]; /* Medium type */
277 atapi_buf[3] = scsi_buf[2]; /* Device specific parameter */
278 atapi_buf[7] = scsi_buf[3]; /* Block descriptor length */
279 memcpy(atapi_buf + 8, scsi_buf + 4, pc->buffer_size - 4);
281 pc->buffer = atapi_buf;
282 pc->request_transfer += 4;
283 pc->buffer_size += 4;
288 static inline void idescsi_transform_pc2 (ide_drive_t *drive, idescsi_pc_t *pc)
290 u8 *atapi_buf = pc->buffer;
291 u8 *sc = pc->scsi_cmd->cmnd;
292 u8 *scsi_buf = pc->scsi_cmd->request_buffer;
294 if (!test_bit(PC_TRANSFORM, &pc->flags))
295 return;
296 if (drive->media == ide_cdrom || drive->media == ide_optical) {
297 if (pc->c[0] == MODE_SENSE_10 && sc[0] == MODE_SENSE) {
298 scsi_buf[0] = atapi_buf[1]; /* Mode data length */
299 scsi_buf[1] = atapi_buf[2]; /* Medium type */
300 scsi_buf[2] = atapi_buf[3]; /* Device specific parameter */
301 scsi_buf[3] = atapi_buf[7]; /* Block descriptor length */
302 memcpy(scsi_buf + 4, atapi_buf + 8, pc->request_transfer - 8);
304 if (pc->c[0] == INQUIRY) {
305 scsi_buf[2] |= 2; /* ansi_revision */
306 scsi_buf[3] = (scsi_buf[3] & 0xf0) | 2; /* response data format */
309 if (atapi_buf && atapi_buf != scsi_buf)
310 kfree(atapi_buf);
313 static void hexdump(u8 *x, int len)
315 int i;
317 printk("[ ");
318 for (i = 0; i < len; i++)
319 printk("%x ", x[i]);
320 printk("]\n");
323 static int idescsi_check_condition(ide_drive_t *drive, struct request *failed_command)
325 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
326 idescsi_pc_t *pc;
327 struct request *rq;
328 u8 *buf;
330 /* stuff a sense request in front of our current request */
331 pc = kmalloc (sizeof (idescsi_pc_t), GFP_ATOMIC);
332 rq = kmalloc (sizeof (struct request), GFP_ATOMIC);
333 buf = kmalloc(SCSI_SENSE_BUFFERSIZE, GFP_ATOMIC);
334 if (pc == NULL || rq == NULL || buf == NULL) {
335 kfree(buf);
336 kfree(rq);
337 kfree(pc);
338 return -ENOMEM;
340 memset (pc, 0, sizeof (idescsi_pc_t));
341 memset (buf, 0, SCSI_SENSE_BUFFERSIZE);
342 ide_init_drive_cmd(rq);
343 rq->special = (char *) pc;
344 pc->rq = rq;
345 pc->buffer = buf;
346 pc->c[0] = REQUEST_SENSE;
347 pc->c[4] = pc->request_transfer = pc->buffer_size = SCSI_SENSE_BUFFERSIZE;
348 rq->flags = REQ_SENSE;
349 pc->timeout = jiffies + WAIT_READY;
350 /* NOTE! Save the failed packet command in "rq->buffer" */
351 rq->buffer = (void *) failed_command->special;
352 pc->scsi_cmd = ((idescsi_pc_t *) failed_command->special)->scsi_cmd;
353 if (test_bit(IDESCSI_LOG_CMD, &scsi->log)) {
354 printk ("ide-scsi: %s: queue cmd = ", drive->name);
355 hexdump(pc->c, 6);
357 rq->rq_disk = scsi->disk;
358 return ide_do_drive_cmd(drive, rq, ide_preempt);
361 static int idescsi_end_request(ide_drive_t *, int, int);
363 static ide_startstop_t
364 idescsi_atapi_error(ide_drive_t *drive, struct request *rq, u8 stat, u8 err)
366 if (HWIF(drive)->INB(IDE_STATUS_REG) & (BUSY_STAT|DRQ_STAT))
367 /* force an abort */
368 HWIF(drive)->OUTB(WIN_IDLEIMMEDIATE,IDE_COMMAND_REG);
370 rq->errors++;
372 idescsi_end_request(drive, 0, 0);
374 return ide_stopped;
377 static ide_startstop_t
378 idescsi_atapi_abort(ide_drive_t *drive, struct request *rq)
380 #if IDESCSI_DEBUG_LOG
381 printk(KERN_WARNING "idescsi_atapi_abort called for %lu\n",
382 ((idescsi_pc_t *) rq->special)->scsi_cmd->serial_number);
383 #endif
384 rq->errors |= ERROR_MAX;
386 idescsi_end_request(drive, 0, 0);
388 return ide_stopped;
391 static int idescsi_end_request (ide_drive_t *drive, int uptodate, int nrsecs)
393 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
394 struct request *rq = HWGROUP(drive)->rq;
395 idescsi_pc_t *pc = (idescsi_pc_t *) rq->special;
396 int log = test_bit(IDESCSI_LOG_CMD, &scsi->log);
397 struct Scsi_Host *host;
398 u8 *scsi_buf;
399 int errors = rq->errors;
400 unsigned long flags;
402 if (!(rq->flags & (REQ_SPECIAL|REQ_SENSE))) {
403 ide_end_request(drive, uptodate, nrsecs);
404 return 0;
406 ide_end_drive_cmd (drive, 0, 0);
407 if (rq->flags & REQ_SENSE) {
408 idescsi_pc_t *opc = (idescsi_pc_t *) rq->buffer;
409 if (log) {
410 printk ("ide-scsi: %s: wrap up check %lu, rst = ", drive->name, opc->scsi_cmd->serial_number);
411 hexdump(pc->buffer,16);
413 memcpy((void *) opc->scsi_cmd->sense_buffer, pc->buffer, SCSI_SENSE_BUFFERSIZE);
414 kfree(pc->buffer);
415 kfree(pc);
416 kfree(rq);
417 pc = opc;
418 rq = pc->rq;
419 pc->scsi_cmd->result = (CHECK_CONDITION << 1) |
420 ((test_bit(PC_TIMEDOUT, &pc->flags)?DID_TIME_OUT:DID_OK) << 16);
421 } else if (test_bit(PC_TIMEDOUT, &pc->flags)) {
422 if (log)
423 printk (KERN_WARNING "ide-scsi: %s: timed out for %lu\n",
424 drive->name, pc->scsi_cmd->serial_number);
425 pc->scsi_cmd->result = DID_TIME_OUT << 16;
426 } else if (errors >= ERROR_MAX) {
427 pc->scsi_cmd->result = DID_ERROR << 16;
428 if (log)
429 printk ("ide-scsi: %s: I/O error for %lu\n", drive->name, pc->scsi_cmd->serial_number);
430 } else if (errors) {
431 if (log)
432 printk ("ide-scsi: %s: check condition for %lu\n", drive->name, pc->scsi_cmd->serial_number);
433 if (!idescsi_check_condition(drive, rq))
434 /* we started a request sense, so we'll be back, exit for now */
435 return 0;
436 pc->scsi_cmd->result = (CHECK_CONDITION << 1) | (DID_OK << 16);
437 } else {
438 pc->scsi_cmd->result = DID_OK << 16;
439 idescsi_transform_pc2 (drive, pc);
440 if (log) {
441 printk ("ide-scsi: %s: suc %lu", drive->name, pc->scsi_cmd->serial_number);
442 if (!test_bit(PC_WRITING, &pc->flags) && pc->actually_transferred && pc->actually_transferred <= 1024 && pc->buffer) {
443 printk(", rst = ");
444 scsi_buf = pc->scsi_cmd->request_buffer;
445 hexdump(scsi_buf, min_t(unsigned, 16, pc->scsi_cmd->request_bufflen));
446 } else printk("\n");
449 host = pc->scsi_cmd->device->host;
450 spin_lock_irqsave(host->host_lock, flags);
451 pc->done(pc->scsi_cmd);
452 spin_unlock_irqrestore(host->host_lock, flags);
453 kfree(pc);
454 kfree(rq);
455 scsi->pc = NULL;
456 return 0;
459 static inline unsigned long get_timeout(idescsi_pc_t *pc)
461 return max_t(unsigned long, WAIT_CMD, pc->timeout - jiffies);
464 static int idescsi_expiry(ide_drive_t *drive)
466 idescsi_scsi_t *scsi = drive->driver_data;
467 idescsi_pc_t *pc = scsi->pc;
469 #if IDESCSI_DEBUG_LOG
470 printk(KERN_WARNING "idescsi_expiry called for %lu at %lu\n", pc->scsi_cmd->serial_number, jiffies);
471 #endif
472 set_bit(PC_TIMEDOUT, &pc->flags);
474 return 0; /* we do not want the ide subsystem to retry */
478 * Our interrupt handler.
480 static ide_startstop_t idescsi_pc_intr (ide_drive_t *drive)
482 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
483 idescsi_pc_t *pc=scsi->pc;
484 struct request *rq = pc->rq;
485 atapi_bcount_t bcount;
486 atapi_status_t status;
487 atapi_ireason_t ireason;
488 atapi_feature_t feature;
490 unsigned int temp;
492 #if IDESCSI_DEBUG_LOG
493 printk (KERN_INFO "ide-scsi: Reached idescsi_pc_intr interrupt handler\n");
494 #endif /* IDESCSI_DEBUG_LOG */
496 if (test_bit(PC_TIMEDOUT, &pc->flags)){
497 #if IDESCSI_DEBUG_LOG
498 printk(KERN_WARNING "idescsi_pc_intr: got timed out packet %lu at %lu\n",
499 pc->scsi_cmd->serial_number, jiffies);
500 #endif
501 /* end this request now - scsi should retry it*/
502 idescsi_end_request (drive, 1, 0);
503 return ide_stopped;
505 if (test_and_clear_bit (PC_DMA_IN_PROGRESS, &pc->flags)) {
506 #if IDESCSI_DEBUG_LOG
507 printk ("ide-scsi: %s: DMA complete\n", drive->name);
508 #endif /* IDESCSI_DEBUG_LOG */
509 pc->actually_transferred=pc->request_transfer;
510 (void) HWIF(drive)->ide_dma_end(drive);
513 feature.all = 0;
514 /* Clear the interrupt */
515 status.all = HWIF(drive)->INB(IDE_STATUS_REG);
517 if (!status.b.drq) {
518 /* No more interrupts */
519 if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
520 printk (KERN_INFO "Packet command completed, %d bytes transferred\n", pc->actually_transferred);
521 local_irq_enable();
522 if (status.b.check)
523 rq->errors++;
524 idescsi_end_request (drive, 1, 0);
525 return ide_stopped;
527 bcount.b.low = HWIF(drive)->INB(IDE_BCOUNTL_REG);
528 bcount.b.high = HWIF(drive)->INB(IDE_BCOUNTH_REG);
529 ireason.all = HWIF(drive)->INB(IDE_IREASON_REG);
531 if (ireason.b.cod) {
532 printk(KERN_ERR "ide-scsi: CoD != 0 in idescsi_pc_intr\n");
533 return ide_do_reset (drive);
535 if (ireason.b.io) {
536 temp = pc->actually_transferred + bcount.all;
537 if (temp > pc->request_transfer) {
538 if (temp > pc->buffer_size) {
539 printk(KERN_ERR "ide-scsi: The scsi wants to "
540 "send us more data than expected "
541 "- discarding data\n");
542 temp = pc->buffer_size - pc->actually_transferred;
543 if (temp) {
544 clear_bit(PC_WRITING, &pc->flags);
545 if (pc->sg)
546 idescsi_input_buffers(drive, pc, temp);
547 else
548 drive->hwif->atapi_input_bytes(drive, pc->current_position, temp);
549 printk(KERN_ERR "ide-scsi: transferred %d of %d bytes\n", temp, bcount.all);
551 pc->actually_transferred += temp;
552 pc->current_position += temp;
553 idescsi_discard_data(drive, bcount.all - temp);
554 ide_set_handler(drive, &idescsi_pc_intr, get_timeout(pc), idescsi_expiry);
555 return ide_started;
557 #if IDESCSI_DEBUG_LOG
558 printk (KERN_NOTICE "ide-scsi: The scsi wants to send us more data than expected - allowing transfer\n");
559 #endif /* IDESCSI_DEBUG_LOG */
562 if (ireason.b.io) {
563 clear_bit(PC_WRITING, &pc->flags);
564 if (pc->sg)
565 idescsi_input_buffers(drive, pc, bcount.all);
566 else
567 HWIF(drive)->atapi_input_bytes(drive, pc->current_position, bcount.all);
568 } else {
569 set_bit(PC_WRITING, &pc->flags);
570 if (pc->sg)
571 idescsi_output_buffers (drive, pc, bcount.all);
572 else
573 HWIF(drive)->atapi_output_bytes(drive, pc->current_position, bcount.all);
575 /* Update the current position */
576 pc->actually_transferred += bcount.all;
577 pc->current_position += bcount.all;
579 /* And set the interrupt handler again */
580 ide_set_handler(drive, &idescsi_pc_intr, get_timeout(pc), idescsi_expiry);
581 return ide_started;
584 static ide_startstop_t idescsi_transfer_pc(ide_drive_t *drive)
586 ide_hwif_t *hwif = drive->hwif;
587 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
588 idescsi_pc_t *pc = scsi->pc;
589 atapi_ireason_t ireason;
590 ide_startstop_t startstop;
592 if (ide_wait_stat(&startstop,drive,DRQ_STAT,BUSY_STAT,WAIT_READY)) {
593 printk(KERN_ERR "ide-scsi: Strange, packet command "
594 "initiated yet DRQ isn't asserted\n");
595 return startstop;
597 ireason.all = HWIF(drive)->INB(IDE_IREASON_REG);
598 if (!ireason.b.cod || ireason.b.io) {
599 printk(KERN_ERR "ide-scsi: (IO,CoD) != (0,1) while "
600 "issuing a packet command\n");
601 return ide_do_reset (drive);
603 if (HWGROUP(drive)->handler != NULL)
604 BUG();
605 /* Set the interrupt routine */
606 ide_set_handler(drive, &idescsi_pc_intr, get_timeout(pc), idescsi_expiry);
607 /* Send the actual packet */
608 drive->hwif->atapi_output_bytes(drive, scsi->pc->c, 12);
609 if (test_bit (PC_DMA_OK, &pc->flags)) {
610 set_bit (PC_DMA_IN_PROGRESS, &pc->flags);
611 hwif->dma_start(drive);
613 return ide_started;
616 static inline int idescsi_set_direction(idescsi_pc_t *pc)
618 switch (pc->c[0]) {
619 case READ_6: case READ_10: case READ_12:
620 clear_bit(PC_WRITING, &pc->flags);
621 return 0;
622 case WRITE_6: case WRITE_10: case WRITE_12:
623 set_bit(PC_WRITING, &pc->flags);
624 return 0;
625 default:
626 return 1;
630 static int idescsi_map_sg(ide_drive_t *drive, idescsi_pc_t *pc)
632 ide_hwif_t *hwif = drive->hwif;
633 struct scatterlist *sg, *scsi_sg;
634 int segments;
636 if (!pc->request_transfer || pc->request_transfer % 1024)
637 return 1;
639 if (idescsi_set_direction(pc))
640 return 1;
642 sg = hwif->sg_table;
643 scsi_sg = pc->scsi_cmd->request_buffer;
644 segments = pc->scsi_cmd->use_sg;
646 if (segments > hwif->sg_max_nents)
647 return 1;
649 if (!segments) {
650 hwif->sg_nents = 1;
651 sg_init_one(sg, pc->scsi_cmd->request_buffer, pc->request_transfer);
652 } else {
653 hwif->sg_nents = segments;
654 memcpy(sg, scsi_sg, sizeof(*sg) * segments);
657 return 0;
661 * Issue a packet command
663 static ide_startstop_t idescsi_issue_pc (ide_drive_t *drive, idescsi_pc_t *pc)
665 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
666 ide_hwif_t *hwif = drive->hwif;
667 atapi_feature_t feature;
668 atapi_bcount_t bcount;
670 scsi->pc=pc; /* Set the current packet command */
671 pc->actually_transferred=0; /* We haven't transferred any data yet */
672 pc->current_position=pc->buffer;
673 bcount.all = min(pc->request_transfer, 63 * 1024); /* Request to transfer the entire buffer at once */
675 feature.all = 0;
676 if (drive->using_dma && !idescsi_map_sg(drive, pc)) {
677 hwif->sg_mapped = 1;
678 feature.b.dma = !hwif->dma_setup(drive);
679 hwif->sg_mapped = 0;
682 SELECT_DRIVE(drive);
683 if (IDE_CONTROL_REG)
684 HWIF(drive)->OUTB(drive->ctl, IDE_CONTROL_REG);
686 HWIF(drive)->OUTB(feature.all, IDE_FEATURE_REG);
687 HWIF(drive)->OUTB(bcount.b.high, IDE_BCOUNTH_REG);
688 HWIF(drive)->OUTB(bcount.b.low, IDE_BCOUNTL_REG);
690 if (feature.b.dma)
691 set_bit(PC_DMA_OK, &pc->flags);
693 if (test_bit(IDESCSI_DRQ_INTERRUPT, &scsi->flags)) {
694 if (HWGROUP(drive)->handler != NULL)
695 BUG();
696 ide_set_handler(drive, &idescsi_transfer_pc,
697 get_timeout(pc), idescsi_expiry);
698 /* Issue the packet command */
699 HWIF(drive)->OUTB(WIN_PACKETCMD, IDE_COMMAND_REG);
700 return ide_started;
701 } else {
702 /* Issue the packet command */
703 HWIF(drive)->OUTB(WIN_PACKETCMD, IDE_COMMAND_REG);
704 return idescsi_transfer_pc(drive);
709 * idescsi_do_request is our request handling function.
711 static ide_startstop_t idescsi_do_request (ide_drive_t *drive, struct request *rq, sector_t block)
713 #if IDESCSI_DEBUG_LOG
714 printk (KERN_INFO "rq_status: %d, dev: %s, cmd: %x, errors: %d\n",rq->rq_status, rq->rq_disk->disk_name,rq->cmd[0],rq->errors);
715 printk (KERN_INFO "sector: %ld, nr_sectors: %ld, current_nr_sectors: %d\n",rq->sector,rq->nr_sectors,rq->current_nr_sectors);
716 #endif /* IDESCSI_DEBUG_LOG */
718 if (rq->flags & (REQ_SPECIAL|REQ_SENSE)) {
719 return idescsi_issue_pc (drive, (idescsi_pc_t *) rq->special);
721 blk_dump_rq_flags(rq, "ide-scsi: unsup command");
722 idescsi_end_request (drive, 0, 0);
723 return ide_stopped;
726 static void idescsi_add_settings(ide_drive_t *drive)
728 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
731 * drive setting name read/write ioctl ioctl data type min max mul_factor div_factor data pointer set function
733 ide_add_setting(drive, "bios_cyl", SETTING_RW, -1, -1, TYPE_INT, 0, 1023, 1, 1, &drive->bios_cyl, NULL);
734 ide_add_setting(drive, "bios_head", SETTING_RW, -1, -1, TYPE_BYTE, 0, 255, 1, 1, &drive->bios_head, NULL);
735 ide_add_setting(drive, "bios_sect", SETTING_RW, -1, -1, TYPE_BYTE, 0, 63, 1, 1, &drive->bios_sect, NULL);
736 ide_add_setting(drive, "transform", SETTING_RW, -1, -1, TYPE_INT, 0, 3, 1, 1, &scsi->transform, NULL);
737 ide_add_setting(drive, "log", SETTING_RW, -1, -1, TYPE_INT, 0, 1, 1, 1, &scsi->log, NULL);
741 * Driver initialization.
743 static void idescsi_setup (ide_drive_t *drive, idescsi_scsi_t *scsi)
745 if (drive->id && (drive->id->config & 0x0060) == 0x20)
746 set_bit (IDESCSI_DRQ_INTERRUPT, &scsi->flags);
747 set_bit(IDESCSI_TRANSFORM, &scsi->transform);
748 clear_bit(IDESCSI_SG_TRANSFORM, &scsi->transform);
749 #if IDESCSI_DEBUG_LOG
750 set_bit(IDESCSI_LOG_CMD, &scsi->log);
751 #endif /* IDESCSI_DEBUG_LOG */
752 idescsi_add_settings(drive);
755 static void ide_scsi_remove(ide_drive_t *drive)
757 struct Scsi_Host *scsihost = drive->driver_data;
758 struct ide_scsi_obj *scsi = scsihost_to_idescsi(scsihost);
759 struct gendisk *g = scsi->disk;
761 ide_unregister_subdriver(drive, scsi->driver);
763 ide_unregister_region(g);
765 drive->driver_data = NULL;
766 g->private_data = NULL;
767 put_disk(g);
769 scsi_remove_host(scsihost);
770 ide_scsi_put(scsi);
773 static int ide_scsi_probe(ide_drive_t *);
775 #ifdef CONFIG_PROC_FS
776 static ide_proc_entry_t idescsi_proc[] = {
777 { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
778 { NULL, 0, NULL, NULL }
780 #else
781 # define idescsi_proc NULL
782 #endif
784 static ide_driver_t idescsi_driver = {
785 .gen_driver = {
786 .owner = THIS_MODULE,
787 .name = "ide-scsi",
788 .bus = &ide_bus_type,
790 .probe = ide_scsi_probe,
791 .remove = ide_scsi_remove,
792 .version = IDESCSI_VERSION,
793 .media = ide_scsi,
794 .supports_dsc_overlap = 0,
795 .proc = idescsi_proc,
796 .do_request = idescsi_do_request,
797 .end_request = idescsi_end_request,
798 .error = idescsi_atapi_error,
799 .abort = idescsi_atapi_abort,
802 static int idescsi_ide_open(struct inode *inode, struct file *filp)
804 struct gendisk *disk = inode->i_bdev->bd_disk;
805 struct ide_scsi_obj *scsi;
806 ide_drive_t *drive;
808 if (!(scsi = ide_scsi_get(disk)))
809 return -ENXIO;
811 drive = scsi->drive;
813 drive->usage++;
815 return 0;
818 static int idescsi_ide_release(struct inode *inode, struct file *filp)
820 struct gendisk *disk = inode->i_bdev->bd_disk;
821 struct ide_scsi_obj *scsi = ide_scsi_g(disk);
822 ide_drive_t *drive = scsi->drive;
824 drive->usage--;
826 ide_scsi_put(scsi);
828 return 0;
831 static int idescsi_ide_ioctl(struct inode *inode, struct file *file,
832 unsigned int cmd, unsigned long arg)
834 struct block_device *bdev = inode->i_bdev;
835 struct ide_scsi_obj *scsi = ide_scsi_g(bdev->bd_disk);
836 return generic_ide_ioctl(scsi->drive, file, bdev, cmd, arg);
839 static struct block_device_operations idescsi_ops = {
840 .owner = THIS_MODULE,
841 .open = idescsi_ide_open,
842 .release = idescsi_ide_release,
843 .ioctl = idescsi_ide_ioctl,
846 static int idescsi_slave_configure(struct scsi_device * sdp)
848 /* Configure detected device */
849 scsi_adjust_queue_depth(sdp, MSG_SIMPLE_TAG, sdp->host->cmd_per_lun);
850 return 0;
853 static const char *idescsi_info (struct Scsi_Host *host)
855 return "SCSI host adapter emulation for IDE ATAPI devices";
858 static int idescsi_ioctl (struct scsi_device *dev, int cmd, void __user *arg)
860 idescsi_scsi_t *scsi = scsihost_to_idescsi(dev->host);
862 if (cmd == SG_SET_TRANSFORM) {
863 if (arg)
864 set_bit(IDESCSI_SG_TRANSFORM, &scsi->transform);
865 else
866 clear_bit(IDESCSI_SG_TRANSFORM, &scsi->transform);
867 return 0;
868 } else if (cmd == SG_GET_TRANSFORM)
869 return put_user(test_bit(IDESCSI_SG_TRANSFORM, &scsi->transform), (int __user *) arg);
870 return -EINVAL;
873 static inline int should_transform(ide_drive_t *drive, struct scsi_cmnd *cmd)
875 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
877 /* this was a layering violation and we can't support it
878 anymore, sorry. */
879 #if 0
880 struct gendisk *disk = cmd->request->rq_disk;
882 if (disk) {
883 struct struct scsi_device_Template **p = disk->private_data;
884 if (strcmp((*p)->scsi_driverfs_driver.name, "sg") == 0)
885 return test_bit(IDESCSI_SG_TRANSFORM, &scsi->transform);
887 #endif
888 return test_bit(IDESCSI_TRANSFORM, &scsi->transform);
891 static int idescsi_queue (struct scsi_cmnd *cmd,
892 void (*done)(struct scsi_cmnd *))
894 struct Scsi_Host *host = cmd->device->host;
895 idescsi_scsi_t *scsi = scsihost_to_idescsi(host);
896 ide_drive_t *drive = scsi->drive;
897 struct request *rq = NULL;
898 idescsi_pc_t *pc = NULL;
900 if (!drive) {
901 scmd_printk (KERN_ERR, cmd, "drive not present\n");
902 goto abort;
904 scsi = drive_to_idescsi(drive);
905 pc = kmalloc (sizeof (idescsi_pc_t), GFP_ATOMIC);
906 rq = kmalloc (sizeof (struct request), GFP_ATOMIC);
907 if (rq == NULL || pc == NULL) {
908 printk (KERN_ERR "ide-scsi: %s: out of memory\n", drive->name);
909 goto abort;
912 memset (pc->c, 0, 12);
913 pc->flags = 0;
914 pc->rq = rq;
915 memcpy (pc->c, cmd->cmnd, cmd->cmd_len);
916 if (cmd->use_sg) {
917 pc->buffer = NULL;
918 pc->sg = cmd->request_buffer;
919 } else {
920 pc->buffer = cmd->request_buffer;
921 pc->sg = NULL;
923 pc->b_count = 0;
924 pc->request_transfer = pc->buffer_size = cmd->request_bufflen;
925 pc->scsi_cmd = cmd;
926 pc->done = done;
927 pc->timeout = jiffies + cmd->timeout_per_command;
929 if (should_transform(drive, cmd))
930 set_bit(PC_TRANSFORM, &pc->flags);
931 idescsi_transform_pc1 (drive, pc);
933 if (test_bit(IDESCSI_LOG_CMD, &scsi->log)) {
934 printk ("ide-scsi: %s: que %lu, cmd = ", drive->name, cmd->serial_number);
935 hexdump(cmd->cmnd, cmd->cmd_len);
936 if (memcmp(pc->c, cmd->cmnd, cmd->cmd_len)) {
937 printk ("ide-scsi: %s: que %lu, tsl = ", drive->name, cmd->serial_number);
938 hexdump(pc->c, 12);
942 ide_init_drive_cmd (rq);
943 rq->special = (char *) pc;
944 rq->flags = REQ_SPECIAL;
945 spin_unlock_irq(host->host_lock);
946 rq->rq_disk = scsi->disk;
947 (void) ide_do_drive_cmd (drive, rq, ide_end);
948 spin_lock_irq(host->host_lock);
949 return 0;
950 abort:
951 kfree (pc);
952 kfree (rq);
953 cmd->result = DID_ERROR << 16;
954 done(cmd);
955 return 0;
958 static int idescsi_eh_abort (struct scsi_cmnd *cmd)
960 idescsi_scsi_t *scsi = scsihost_to_idescsi(cmd->device->host);
961 ide_drive_t *drive = scsi->drive;
962 int busy;
963 int ret = FAILED;
965 /* In idescsi_eh_abort we try to gently pry our command from the ide subsystem */
967 if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
968 printk (KERN_WARNING "ide-scsi: abort called for %lu\n", cmd->serial_number);
970 if (!drive) {
971 printk (KERN_WARNING "ide-scsi: Drive not set in idescsi_eh_abort\n");
972 WARN_ON(1);
973 goto no_drive;
976 /* First give it some more time, how much is "right" is hard to say :-( */
978 busy = ide_wait_not_busy(HWIF(drive), 100); /* FIXME - uses mdelay which causes latency? */
979 if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
980 printk (KERN_WARNING "ide-scsi: drive did%s become ready\n", busy?" not":"");
982 spin_lock_irq(&ide_lock);
984 /* If there is no pc running we're done (our interrupt took care of it) */
985 if (!scsi->pc) {
986 ret = SUCCESS;
987 goto ide_unlock;
990 /* It's somewhere in flight. Does ide subsystem agree? */
991 if (scsi->pc->scsi_cmd->serial_number == cmd->serial_number && !busy &&
992 elv_queue_empty(drive->queue) && HWGROUP(drive)->rq != scsi->pc->rq) {
994 * FIXME - not sure this condition can ever occur
996 printk (KERN_ERR "ide-scsi: cmd aborted!\n");
998 if (scsi->pc->rq->flags & REQ_SENSE)
999 kfree(scsi->pc->buffer);
1000 kfree(scsi->pc->rq);
1001 kfree(scsi->pc);
1002 scsi->pc = NULL;
1004 ret = SUCCESS;
1007 ide_unlock:
1008 spin_unlock_irq(&ide_lock);
1009 no_drive:
1010 if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
1011 printk (KERN_WARNING "ide-scsi: abort returns %s\n", ret == SUCCESS?"success":"failed");
1013 return ret;
1016 static int idescsi_eh_reset (struct scsi_cmnd *cmd)
1018 struct request *req;
1019 idescsi_scsi_t *scsi = scsihost_to_idescsi(cmd->device->host);
1020 ide_drive_t *drive = scsi->drive;
1021 int ready = 0;
1022 int ret = SUCCESS;
1024 /* In idescsi_eh_reset we forcefully remove the command from the ide subsystem and reset the device. */
1026 if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
1027 printk (KERN_WARNING "ide-scsi: reset called for %lu\n", cmd->serial_number);
1029 if (!drive) {
1030 printk (KERN_WARNING "ide-scsi: Drive not set in idescsi_eh_reset\n");
1031 WARN_ON(1);
1032 return FAILED;
1035 spin_lock_irq(cmd->device->host->host_lock);
1036 spin_lock(&ide_lock);
1038 if (!scsi->pc || (req = scsi->pc->rq) != HWGROUP(drive)->rq || !HWGROUP(drive)->handler) {
1039 printk (KERN_WARNING "ide-scsi: No active request in idescsi_eh_reset\n");
1040 spin_unlock(&ide_lock);
1041 spin_unlock_irq(cmd->device->host->host_lock);
1042 return FAILED;
1045 /* kill current request */
1046 blkdev_dequeue_request(req);
1047 end_that_request_last(req, 0);
1048 if (req->flags & REQ_SENSE)
1049 kfree(scsi->pc->buffer);
1050 kfree(scsi->pc);
1051 scsi->pc = NULL;
1052 kfree(req);
1054 /* now nuke the drive queue */
1055 while ((req = elv_next_request(drive->queue))) {
1056 blkdev_dequeue_request(req);
1057 end_that_request_last(req, 0);
1060 HWGROUP(drive)->rq = NULL;
1061 HWGROUP(drive)->handler = NULL;
1062 HWGROUP(drive)->busy = 1; /* will set this to zero when ide reset finished */
1063 spin_unlock(&ide_lock);
1065 ide_do_reset(drive);
1067 /* ide_do_reset starts a polling handler which restarts itself every 50ms until the reset finishes */
1069 do {
1070 spin_unlock_irq(cmd->device->host->host_lock);
1071 msleep(50);
1072 spin_lock_irq(cmd->device->host->host_lock);
1073 } while ( HWGROUP(drive)->handler );
1075 ready = drive_is_ready(drive);
1076 HWGROUP(drive)->busy--;
1077 if (!ready) {
1078 printk (KERN_ERR "ide-scsi: reset failed!\n");
1079 ret = FAILED;
1082 spin_unlock_irq(cmd->device->host->host_lock);
1083 return ret;
1086 static int idescsi_bios(struct scsi_device *sdev, struct block_device *bdev,
1087 sector_t capacity, int *parm)
1089 idescsi_scsi_t *idescsi = scsihost_to_idescsi(sdev->host);
1090 ide_drive_t *drive = idescsi->drive;
1092 if (drive->bios_cyl && drive->bios_head && drive->bios_sect) {
1093 parm[0] = drive->bios_head;
1094 parm[1] = drive->bios_sect;
1095 parm[2] = drive->bios_cyl;
1097 return 0;
1100 static struct scsi_host_template idescsi_template = {
1101 .module = THIS_MODULE,
1102 .name = "idescsi",
1103 .info = idescsi_info,
1104 .slave_configure = idescsi_slave_configure,
1105 .ioctl = idescsi_ioctl,
1106 .queuecommand = idescsi_queue,
1107 .eh_abort_handler = idescsi_eh_abort,
1108 .eh_host_reset_handler = idescsi_eh_reset,
1109 .bios_param = idescsi_bios,
1110 .can_queue = 40,
1111 .this_id = -1,
1112 .sg_tablesize = 256,
1113 .cmd_per_lun = 5,
1114 .max_sectors = 128,
1115 .use_clustering = DISABLE_CLUSTERING,
1116 .emulated = 1,
1117 .proc_name = "ide-scsi",
1120 static int ide_scsi_probe(ide_drive_t *drive)
1122 idescsi_scsi_t *idescsi;
1123 struct Scsi_Host *host;
1124 struct gendisk *g;
1125 static int warned;
1126 int err = -ENOMEM;
1128 if (!warned && drive->media == ide_cdrom) {
1129 printk(KERN_WARNING "ide-scsi is deprecated for cd burning! Use ide-cd and give dev=/dev/hdX as device\n");
1130 warned = 1;
1133 if (!strstr("ide-scsi", drive->driver_req) ||
1134 !drive->present ||
1135 drive->media == ide_disk ||
1136 !(host = scsi_host_alloc(&idescsi_template,sizeof(idescsi_scsi_t))))
1137 return -ENODEV;
1139 g = alloc_disk(1 << PARTN_BITS);
1140 if (!g)
1141 goto out_host_put;
1143 ide_init_disk(g, drive);
1145 host->max_id = 1;
1147 #if IDESCSI_DEBUG_LOG
1148 if (drive->id->last_lun)
1149 printk(KERN_NOTICE "%s: id->last_lun=%u\n", drive->name, drive->id->last_lun);
1150 #endif
1151 if ((drive->id->last_lun & 0x7) != 7)
1152 host->max_lun = (drive->id->last_lun & 0x7) + 1;
1153 else
1154 host->max_lun = 1;
1156 drive->driver_data = host;
1157 idescsi = scsihost_to_idescsi(host);
1158 idescsi->drive = drive;
1159 idescsi->driver = &idescsi_driver;
1160 idescsi->host = host;
1161 idescsi->disk = g;
1162 g->private_data = &idescsi->driver;
1163 ide_register_subdriver(drive, &idescsi_driver);
1164 err = 0;
1165 idescsi_setup(drive, idescsi);
1166 g->fops = &idescsi_ops;
1167 ide_register_region(g);
1168 err = scsi_add_host(host, &drive->gendev);
1169 if (!err) {
1170 scsi_scan_host(host);
1171 return 0;
1173 /* fall through on error */
1174 ide_unregister_region(g);
1175 ide_unregister_subdriver(drive, &idescsi_driver);
1177 put_disk(g);
1178 out_host_put:
1179 scsi_host_put(host);
1180 return err;
1183 static int __init init_idescsi_module(void)
1185 return driver_register(&idescsi_driver.gen_driver);
1188 static void __exit exit_idescsi_module(void)
1190 driver_unregister(&idescsi_driver.gen_driver);
1193 module_init(init_idescsi_module);
1194 module_exit(exit_idescsi_module);
1195 MODULE_LICENSE("GPL");