[PATCH] lockdep: annotate idescsi_pc_intr()
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / scsi / ide-scsi.c
blob94d1de55607f2dc00a05605259b0d8e864937062
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/types.h>
38 #include <linux/string.h>
39 #include <linux/kernel.h>
40 #include <linux/mm.h>
41 #include <linux/ioport.h>
42 #include <linux/blkdev.h>
43 #include <linux/errno.h>
44 #include <linux/hdreg.h>
45 #include <linux/slab.h>
46 #include <linux/ide.h>
47 #include <linux/scatterlist.h>
48 #include <linux/delay.h>
49 #include <linux/mutex.h>
51 #include <asm/io.h>
52 #include <asm/bitops.h>
53 #include <asm/uaccess.h>
55 #include <scsi/scsi.h>
56 #include <scsi/scsi_cmnd.h>
57 #include <scsi/scsi_device.h>
58 #include <scsi/scsi_host.h>
59 #include <scsi/scsi_tcq.h>
60 #include <scsi/sg.h>
62 #define IDESCSI_DEBUG_LOG 0
64 typedef struct idescsi_pc_s {
65 u8 c[12]; /* Actual packet bytes */
66 int request_transfer; /* Bytes to transfer */
67 int actually_transferred; /* Bytes actually transferred */
68 int buffer_size; /* Size of our data buffer */
69 struct request *rq; /* The corresponding request */
70 u8 *buffer; /* Data buffer */
71 u8 *current_position; /* Pointer into the above buffer */
72 struct scatterlist *sg; /* Scatter gather table */
73 int b_count; /* Bytes transferred from current entry */
74 struct scsi_cmnd *scsi_cmd; /* SCSI command */
75 void (*done)(struct scsi_cmnd *); /* Scsi completion routine */
76 unsigned long flags; /* Status/Action flags */
77 unsigned long timeout; /* Command timeout */
78 } idescsi_pc_t;
81 * Packet command status bits.
83 #define PC_DMA_IN_PROGRESS 0 /* 1 while DMA in progress */
84 #define PC_WRITING 1 /* Data direction */
85 #define PC_TRANSFORM 2 /* transform SCSI commands */
86 #define PC_TIMEDOUT 3 /* command timed out */
87 #define PC_DMA_OK 4 /* Use DMA */
90 * SCSI command transformation layer
92 #define IDESCSI_TRANSFORM 0 /* Enable/Disable transformation */
93 #define IDESCSI_SG_TRANSFORM 1 /* /dev/sg transformation */
96 * Log flags
98 #define IDESCSI_LOG_CMD 0 /* Log SCSI commands */
100 typedef struct ide_scsi_obj {
101 ide_drive_t *drive;
102 ide_driver_t *driver;
103 struct gendisk *disk;
104 struct Scsi_Host *host;
106 idescsi_pc_t *pc; /* Current packet command */
107 unsigned long flags; /* Status/Action flags */
108 unsigned long transform; /* SCSI cmd translation layer */
109 unsigned long log; /* log flags */
110 } idescsi_scsi_t;
112 static DEFINE_MUTEX(idescsi_ref_mutex);
114 #define ide_scsi_g(disk) \
115 container_of((disk)->private_data, struct ide_scsi_obj, driver)
117 static struct ide_scsi_obj *ide_scsi_get(struct gendisk *disk)
119 struct ide_scsi_obj *scsi = NULL;
121 mutex_lock(&idescsi_ref_mutex);
122 scsi = ide_scsi_g(disk);
123 if (scsi)
124 scsi_host_get(scsi->host);
125 mutex_unlock(&idescsi_ref_mutex);
126 return scsi;
129 static void ide_scsi_put(struct ide_scsi_obj *scsi)
131 mutex_lock(&idescsi_ref_mutex);
132 scsi_host_put(scsi->host);
133 mutex_unlock(&idescsi_ref_mutex);
136 static inline idescsi_scsi_t *scsihost_to_idescsi(struct Scsi_Host *host)
138 return (idescsi_scsi_t*) (&host[1]);
141 static inline idescsi_scsi_t *drive_to_idescsi(ide_drive_t *ide_drive)
143 return scsihost_to_idescsi(ide_drive->driver_data);
147 * Per ATAPI device status bits.
149 #define IDESCSI_DRQ_INTERRUPT 0 /* DRQ interrupt device */
152 * ide-scsi requests.
154 #define IDESCSI_PC_RQ 90
156 static void idescsi_discard_data (ide_drive_t *drive, unsigned int bcount)
158 while (bcount--)
159 (void) HWIF(drive)->INB(IDE_DATA_REG);
162 static void idescsi_output_zeros (ide_drive_t *drive, unsigned int bcount)
164 while (bcount--)
165 HWIF(drive)->OUTB(0, IDE_DATA_REG);
169 * PIO data transfer routines using the scatter gather table.
171 static void idescsi_input_buffers (ide_drive_t *drive, idescsi_pc_t *pc, unsigned int bcount)
173 int count;
174 char *buf;
176 while (bcount) {
177 if (pc->sg - (struct scatterlist *) pc->scsi_cmd->request_buffer > pc->scsi_cmd->use_sg) {
178 printk (KERN_ERR "ide-scsi: scatter gather table too small, discarding data\n");
179 idescsi_discard_data (drive, bcount);
180 return;
182 count = min(pc->sg->length - pc->b_count, bcount);
183 if (PageHighMem(pc->sg->page)) {
184 unsigned long flags;
186 local_irq_save(flags);
187 buf = kmap_atomic(pc->sg->page, KM_IRQ0) +
188 pc->sg->offset;
189 drive->hwif->atapi_input_bytes(drive,
190 buf + pc->b_count, count);
191 kunmap_atomic(buf - pc->sg->offset, KM_IRQ0);
192 local_irq_restore(flags);
193 } else {
194 buf = page_address(pc->sg->page) + pc->sg->offset;
195 drive->hwif->atapi_input_bytes(drive,
196 buf + pc->b_count, count);
198 bcount -= count; pc->b_count += count;
199 if (pc->b_count == pc->sg->length) {
200 pc->sg++;
201 pc->b_count = 0;
206 static void idescsi_output_buffers (ide_drive_t *drive, idescsi_pc_t *pc, unsigned int bcount)
208 int count;
209 char *buf;
211 while (bcount) {
212 if (pc->sg - (struct scatterlist *) pc->scsi_cmd->request_buffer > pc->scsi_cmd->use_sg) {
213 printk (KERN_ERR "ide-scsi: scatter gather table too small, padding with zeros\n");
214 idescsi_output_zeros (drive, bcount);
215 return;
217 count = min(pc->sg->length - pc->b_count, bcount);
218 if (PageHighMem(pc->sg->page)) {
219 unsigned long flags;
221 local_irq_save(flags);
222 buf = kmap_atomic(pc->sg->page, KM_IRQ0) +
223 pc->sg->offset;
224 drive->hwif->atapi_output_bytes(drive,
225 buf + pc->b_count, count);
226 kunmap_atomic(buf - pc->sg->offset, KM_IRQ0);
227 local_irq_restore(flags);
228 } else {
229 buf = page_address(pc->sg->page) + pc->sg->offset;
230 drive->hwif->atapi_output_bytes(drive,
231 buf + pc->b_count, count);
233 bcount -= count; pc->b_count += count;
234 if (pc->b_count == pc->sg->length) {
235 pc->sg++;
236 pc->b_count = 0;
242 * Most of the SCSI commands are supported directly by ATAPI devices.
243 * idescsi_transform_pc handles the few exceptions.
245 static inline void idescsi_transform_pc1 (ide_drive_t *drive, idescsi_pc_t *pc)
247 u8 *c = pc->c, *scsi_buf = pc->buffer, *sc = pc->scsi_cmd->cmnd;
248 char *atapi_buf;
250 if (!test_bit(PC_TRANSFORM, &pc->flags))
251 return;
252 if (drive->media == ide_cdrom || drive->media == ide_optical) {
253 if (c[0] == READ_6 || c[0] == WRITE_6) {
254 c[8] = c[4]; c[5] = c[3]; c[4] = c[2];
255 c[3] = c[1] & 0x1f; c[2] = 0; c[1] &= 0xe0;
256 c[0] += (READ_10 - READ_6);
258 if (c[0] == MODE_SENSE || c[0] == MODE_SELECT) {
259 unsigned short new_len;
260 if (!scsi_buf)
261 return;
262 if ((atapi_buf = kmalloc(pc->buffer_size + 4, GFP_ATOMIC)) == NULL)
263 return;
264 memset(atapi_buf, 0, pc->buffer_size + 4);
265 memset (c, 0, 12);
266 c[0] = sc[0] | 0x40;
267 c[1] = sc[1];
268 c[2] = sc[2];
269 new_len = sc[4] + 4;
270 c[8] = new_len;
271 c[7] = new_len >> 8;
272 c[9] = sc[5];
273 if (c[0] == MODE_SELECT_10) {
274 atapi_buf[1] = scsi_buf[0]; /* Mode data length */
275 atapi_buf[2] = scsi_buf[1]; /* Medium type */
276 atapi_buf[3] = scsi_buf[2]; /* Device specific parameter */
277 atapi_buf[7] = scsi_buf[3]; /* Block descriptor length */
278 memcpy(atapi_buf + 8, scsi_buf + 4, pc->buffer_size - 4);
280 pc->buffer = atapi_buf;
281 pc->request_transfer += 4;
282 pc->buffer_size += 4;
287 static inline void idescsi_transform_pc2 (ide_drive_t *drive, idescsi_pc_t *pc)
289 u8 *atapi_buf = pc->buffer;
290 u8 *sc = pc->scsi_cmd->cmnd;
291 u8 *scsi_buf = pc->scsi_cmd->request_buffer;
293 if (!test_bit(PC_TRANSFORM, &pc->flags))
294 return;
295 if (drive->media == ide_cdrom || drive->media == ide_optical) {
296 if (pc->c[0] == MODE_SENSE_10 && sc[0] == MODE_SENSE) {
297 scsi_buf[0] = atapi_buf[1]; /* Mode data length */
298 scsi_buf[1] = atapi_buf[2]; /* Medium type */
299 scsi_buf[2] = atapi_buf[3]; /* Device specific parameter */
300 scsi_buf[3] = atapi_buf[7]; /* Block descriptor length */
301 memcpy(scsi_buf + 4, atapi_buf + 8, pc->request_transfer - 8);
303 if (pc->c[0] == INQUIRY) {
304 scsi_buf[2] |= 2; /* ansi_revision */
305 scsi_buf[3] = (scsi_buf[3] & 0xf0) | 2; /* response data format */
308 if (atapi_buf && atapi_buf != scsi_buf)
309 kfree(atapi_buf);
312 static void hexdump(u8 *x, int len)
314 int i;
316 printk("[ ");
317 for (i = 0; i < len; i++)
318 printk("%x ", x[i]);
319 printk("]\n");
322 static int idescsi_check_condition(ide_drive_t *drive, struct request *failed_command)
324 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
325 idescsi_pc_t *pc;
326 struct request *rq;
327 u8 *buf;
329 /* stuff a sense request in front of our current request */
330 pc = kmalloc (sizeof (idescsi_pc_t), GFP_ATOMIC);
331 rq = kmalloc (sizeof (struct request), GFP_ATOMIC);
332 buf = kmalloc(SCSI_SENSE_BUFFERSIZE, GFP_ATOMIC);
333 if (pc == NULL || rq == NULL || buf == NULL) {
334 kfree(buf);
335 kfree(rq);
336 kfree(pc);
337 return -ENOMEM;
339 memset (pc, 0, sizeof (idescsi_pc_t));
340 memset (buf, 0, SCSI_SENSE_BUFFERSIZE);
341 ide_init_drive_cmd(rq);
342 rq->special = (char *) pc;
343 pc->rq = rq;
344 pc->buffer = buf;
345 pc->c[0] = REQUEST_SENSE;
346 pc->c[4] = pc->request_transfer = pc->buffer_size = SCSI_SENSE_BUFFERSIZE;
347 rq->flags = REQ_SENSE;
348 pc->timeout = jiffies + WAIT_READY;
349 /* NOTE! Save the failed packet command in "rq->buffer" */
350 rq->buffer = (void *) failed_command->special;
351 pc->scsi_cmd = ((idescsi_pc_t *) failed_command->special)->scsi_cmd;
352 if (test_bit(IDESCSI_LOG_CMD, &scsi->log)) {
353 printk ("ide-scsi: %s: queue cmd = ", drive->name);
354 hexdump(pc->c, 6);
356 rq->rq_disk = scsi->disk;
357 return ide_do_drive_cmd(drive, rq, ide_preempt);
360 static int idescsi_end_request(ide_drive_t *, int, int);
362 static ide_startstop_t
363 idescsi_atapi_error(ide_drive_t *drive, struct request *rq, u8 stat, u8 err)
365 if (HWIF(drive)->INB(IDE_STATUS_REG) & (BUSY_STAT|DRQ_STAT))
366 /* force an abort */
367 HWIF(drive)->OUTB(WIN_IDLEIMMEDIATE,IDE_COMMAND_REG);
369 rq->errors++;
371 idescsi_end_request(drive, 0, 0);
373 return ide_stopped;
376 static ide_startstop_t
377 idescsi_atapi_abort(ide_drive_t *drive, struct request *rq)
379 #if IDESCSI_DEBUG_LOG
380 printk(KERN_WARNING "idescsi_atapi_abort called for %lu\n",
381 ((idescsi_pc_t *) rq->special)->scsi_cmd->serial_number);
382 #endif
383 rq->errors |= ERROR_MAX;
385 idescsi_end_request(drive, 0, 0);
387 return ide_stopped;
390 static int idescsi_end_request (ide_drive_t *drive, int uptodate, int nrsecs)
392 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
393 struct request *rq = HWGROUP(drive)->rq;
394 idescsi_pc_t *pc = (idescsi_pc_t *) rq->special;
395 int log = test_bit(IDESCSI_LOG_CMD, &scsi->log);
396 struct Scsi_Host *host;
397 u8 *scsi_buf;
398 int errors = rq->errors;
399 unsigned long flags;
401 if (!(rq->flags & (REQ_SPECIAL|REQ_SENSE))) {
402 ide_end_request(drive, uptodate, nrsecs);
403 return 0;
405 ide_end_drive_cmd (drive, 0, 0);
406 if (rq->flags & REQ_SENSE) {
407 idescsi_pc_t *opc = (idescsi_pc_t *) rq->buffer;
408 if (log) {
409 printk ("ide-scsi: %s: wrap up check %lu, rst = ", drive->name, opc->scsi_cmd->serial_number);
410 hexdump(pc->buffer,16);
412 memcpy((void *) opc->scsi_cmd->sense_buffer, pc->buffer, SCSI_SENSE_BUFFERSIZE);
413 kfree(pc->buffer);
414 kfree(pc);
415 kfree(rq);
416 pc = opc;
417 rq = pc->rq;
418 pc->scsi_cmd->result = (CHECK_CONDITION << 1) |
419 ((test_bit(PC_TIMEDOUT, &pc->flags)?DID_TIME_OUT:DID_OK) << 16);
420 } else if (test_bit(PC_TIMEDOUT, &pc->flags)) {
421 if (log)
422 printk (KERN_WARNING "ide-scsi: %s: timed out for %lu\n",
423 drive->name, pc->scsi_cmd->serial_number);
424 pc->scsi_cmd->result = DID_TIME_OUT << 16;
425 } else if (errors >= ERROR_MAX) {
426 pc->scsi_cmd->result = DID_ERROR << 16;
427 if (log)
428 printk ("ide-scsi: %s: I/O error for %lu\n", drive->name, pc->scsi_cmd->serial_number);
429 } else if (errors) {
430 if (log)
431 printk ("ide-scsi: %s: check condition for %lu\n", drive->name, pc->scsi_cmd->serial_number);
432 if (!idescsi_check_condition(drive, rq))
433 /* we started a request sense, so we'll be back, exit for now */
434 return 0;
435 pc->scsi_cmd->result = (CHECK_CONDITION << 1) | (DID_OK << 16);
436 } else {
437 pc->scsi_cmd->result = DID_OK << 16;
438 idescsi_transform_pc2 (drive, pc);
439 if (log) {
440 printk ("ide-scsi: %s: suc %lu", drive->name, pc->scsi_cmd->serial_number);
441 if (!test_bit(PC_WRITING, &pc->flags) && pc->actually_transferred && pc->actually_transferred <= 1024 && pc->buffer) {
442 printk(", rst = ");
443 scsi_buf = pc->scsi_cmd->request_buffer;
444 hexdump(scsi_buf, min_t(unsigned, 16, pc->scsi_cmd->request_bufflen));
445 } else printk("\n");
448 host = pc->scsi_cmd->device->host;
449 spin_lock_irqsave(host->host_lock, flags);
450 pc->done(pc->scsi_cmd);
451 spin_unlock_irqrestore(host->host_lock, flags);
452 kfree(pc);
453 kfree(rq);
454 scsi->pc = NULL;
455 return 0;
458 static inline unsigned long get_timeout(idescsi_pc_t *pc)
460 return max_t(unsigned long, WAIT_CMD, pc->timeout - jiffies);
463 static int idescsi_expiry(ide_drive_t *drive)
465 idescsi_scsi_t *scsi = drive->driver_data;
466 idescsi_pc_t *pc = scsi->pc;
468 #if IDESCSI_DEBUG_LOG
469 printk(KERN_WARNING "idescsi_expiry called for %lu at %lu\n", pc->scsi_cmd->serial_number, jiffies);
470 #endif
471 set_bit(PC_TIMEDOUT, &pc->flags);
473 return 0; /* we do not want the ide subsystem to retry */
477 * Our interrupt handler.
479 static ide_startstop_t idescsi_pc_intr (ide_drive_t *drive)
481 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
482 idescsi_pc_t *pc=scsi->pc;
483 struct request *rq = pc->rq;
484 atapi_bcount_t bcount;
485 atapi_status_t status;
486 atapi_ireason_t ireason;
487 atapi_feature_t feature;
489 unsigned int temp;
491 #if IDESCSI_DEBUG_LOG
492 printk (KERN_INFO "ide-scsi: Reached idescsi_pc_intr interrupt handler\n");
493 #endif /* IDESCSI_DEBUG_LOG */
495 if (test_bit(PC_TIMEDOUT, &pc->flags)){
496 #if IDESCSI_DEBUG_LOG
497 printk(KERN_WARNING "idescsi_pc_intr: got timed out packet %lu at %lu\n",
498 pc->scsi_cmd->serial_number, jiffies);
499 #endif
500 /* end this request now - scsi should retry it*/
501 idescsi_end_request (drive, 1, 0);
502 return ide_stopped;
504 if (test_and_clear_bit (PC_DMA_IN_PROGRESS, &pc->flags)) {
505 #if IDESCSI_DEBUG_LOG
506 printk ("ide-scsi: %s: DMA complete\n", drive->name);
507 #endif /* IDESCSI_DEBUG_LOG */
508 pc->actually_transferred=pc->request_transfer;
509 (void) HWIF(drive)->ide_dma_end(drive);
512 feature.all = 0;
513 /* Clear the interrupt */
514 status.all = HWIF(drive)->INB(IDE_STATUS_REG);
516 if (!status.b.drq) {
517 /* No more interrupts */
518 if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
519 printk (KERN_INFO "Packet command completed, %d bytes transferred\n", pc->actually_transferred);
520 local_irq_enable_in_hardirq();
521 if (status.b.check)
522 rq->errors++;
523 idescsi_end_request (drive, 1, 0);
524 return ide_stopped;
526 bcount.b.low = HWIF(drive)->INB(IDE_BCOUNTL_REG);
527 bcount.b.high = HWIF(drive)->INB(IDE_BCOUNTH_REG);
528 ireason.all = HWIF(drive)->INB(IDE_IREASON_REG);
530 if (ireason.b.cod) {
531 printk(KERN_ERR "ide-scsi: CoD != 0 in idescsi_pc_intr\n");
532 return ide_do_reset (drive);
534 if (ireason.b.io) {
535 temp = pc->actually_transferred + bcount.all;
536 if (temp > pc->request_transfer) {
537 if (temp > pc->buffer_size) {
538 printk(KERN_ERR "ide-scsi: The scsi wants to "
539 "send us more data than expected "
540 "- discarding data\n");
541 temp = pc->buffer_size - pc->actually_transferred;
542 if (temp) {
543 clear_bit(PC_WRITING, &pc->flags);
544 if (pc->sg)
545 idescsi_input_buffers(drive, pc, temp);
546 else
547 drive->hwif->atapi_input_bytes(drive, pc->current_position, temp);
548 printk(KERN_ERR "ide-scsi: transferred %d of %d bytes\n", temp, bcount.all);
550 pc->actually_transferred += temp;
551 pc->current_position += temp;
552 idescsi_discard_data(drive, bcount.all - temp);
553 ide_set_handler(drive, &idescsi_pc_intr, get_timeout(pc), idescsi_expiry);
554 return ide_started;
556 #if IDESCSI_DEBUG_LOG
557 printk (KERN_NOTICE "ide-scsi: The scsi wants to send us more data than expected - allowing transfer\n");
558 #endif /* IDESCSI_DEBUG_LOG */
561 if (ireason.b.io) {
562 clear_bit(PC_WRITING, &pc->flags);
563 if (pc->sg)
564 idescsi_input_buffers(drive, pc, bcount.all);
565 else
566 HWIF(drive)->atapi_input_bytes(drive, pc->current_position, bcount.all);
567 } else {
568 set_bit(PC_WRITING, &pc->flags);
569 if (pc->sg)
570 idescsi_output_buffers (drive, pc, bcount.all);
571 else
572 HWIF(drive)->atapi_output_bytes(drive, pc->current_position, bcount.all);
574 /* Update the current position */
575 pc->actually_transferred += bcount.all;
576 pc->current_position += bcount.all;
578 /* And set the interrupt handler again */
579 ide_set_handler(drive, &idescsi_pc_intr, get_timeout(pc), idescsi_expiry);
580 return ide_started;
583 static ide_startstop_t idescsi_transfer_pc(ide_drive_t *drive)
585 ide_hwif_t *hwif = drive->hwif;
586 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
587 idescsi_pc_t *pc = scsi->pc;
588 atapi_ireason_t ireason;
589 ide_startstop_t startstop;
591 if (ide_wait_stat(&startstop,drive,DRQ_STAT,BUSY_STAT,WAIT_READY)) {
592 printk(KERN_ERR "ide-scsi: Strange, packet command "
593 "initiated yet DRQ isn't asserted\n");
594 return startstop;
596 ireason.all = HWIF(drive)->INB(IDE_IREASON_REG);
597 if (!ireason.b.cod || ireason.b.io) {
598 printk(KERN_ERR "ide-scsi: (IO,CoD) != (0,1) while "
599 "issuing a packet command\n");
600 return ide_do_reset (drive);
602 BUG_ON(HWGROUP(drive)->handler != NULL);
603 /* Set the interrupt routine */
604 ide_set_handler(drive, &idescsi_pc_intr, get_timeout(pc), idescsi_expiry);
605 /* Send the actual packet */
606 drive->hwif->atapi_output_bytes(drive, scsi->pc->c, 12);
607 if (test_bit (PC_DMA_OK, &pc->flags)) {
608 set_bit (PC_DMA_IN_PROGRESS, &pc->flags);
609 hwif->dma_start(drive);
611 return ide_started;
614 static inline int idescsi_set_direction(idescsi_pc_t *pc)
616 switch (pc->c[0]) {
617 case READ_6: case READ_10: case READ_12:
618 clear_bit(PC_WRITING, &pc->flags);
619 return 0;
620 case WRITE_6: case WRITE_10: case WRITE_12:
621 set_bit(PC_WRITING, &pc->flags);
622 return 0;
623 default:
624 return 1;
628 static int idescsi_map_sg(ide_drive_t *drive, idescsi_pc_t *pc)
630 ide_hwif_t *hwif = drive->hwif;
631 struct scatterlist *sg, *scsi_sg;
632 int segments;
634 if (!pc->request_transfer || pc->request_transfer % 1024)
635 return 1;
637 if (idescsi_set_direction(pc))
638 return 1;
640 sg = hwif->sg_table;
641 scsi_sg = pc->scsi_cmd->request_buffer;
642 segments = pc->scsi_cmd->use_sg;
644 if (segments > hwif->sg_max_nents)
645 return 1;
647 if (!segments) {
648 hwif->sg_nents = 1;
649 sg_init_one(sg, pc->scsi_cmd->request_buffer, pc->request_transfer);
650 } else {
651 hwif->sg_nents = segments;
652 memcpy(sg, scsi_sg, sizeof(*sg) * segments);
655 return 0;
659 * Issue a packet command
661 static ide_startstop_t idescsi_issue_pc (ide_drive_t *drive, idescsi_pc_t *pc)
663 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
664 ide_hwif_t *hwif = drive->hwif;
665 atapi_feature_t feature;
666 atapi_bcount_t bcount;
668 scsi->pc=pc; /* Set the current packet command */
669 pc->actually_transferred=0; /* We haven't transferred any data yet */
670 pc->current_position=pc->buffer;
671 bcount.all = min(pc->request_transfer, 63 * 1024); /* Request to transfer the entire buffer at once */
673 feature.all = 0;
674 if (drive->using_dma && !idescsi_map_sg(drive, pc)) {
675 hwif->sg_mapped = 1;
676 feature.b.dma = !hwif->dma_setup(drive);
677 hwif->sg_mapped = 0;
680 SELECT_DRIVE(drive);
681 if (IDE_CONTROL_REG)
682 HWIF(drive)->OUTB(drive->ctl, IDE_CONTROL_REG);
684 HWIF(drive)->OUTB(feature.all, IDE_FEATURE_REG);
685 HWIF(drive)->OUTB(bcount.b.high, IDE_BCOUNTH_REG);
686 HWIF(drive)->OUTB(bcount.b.low, IDE_BCOUNTL_REG);
688 if (feature.b.dma)
689 set_bit(PC_DMA_OK, &pc->flags);
691 if (test_bit(IDESCSI_DRQ_INTERRUPT, &scsi->flags)) {
692 BUG_ON(HWGROUP(drive)->handler != NULL);
693 ide_set_handler(drive, &idescsi_transfer_pc,
694 get_timeout(pc), idescsi_expiry);
695 /* Issue the packet command */
696 HWIF(drive)->OUTB(WIN_PACKETCMD, IDE_COMMAND_REG);
697 return ide_started;
698 } else {
699 /* Issue the packet command */
700 HWIF(drive)->OUTB(WIN_PACKETCMD, IDE_COMMAND_REG);
701 return idescsi_transfer_pc(drive);
706 * idescsi_do_request is our request handling function.
708 static ide_startstop_t idescsi_do_request (ide_drive_t *drive, struct request *rq, sector_t block)
710 #if IDESCSI_DEBUG_LOG
711 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);
712 printk (KERN_INFO "sector: %ld, nr_sectors: %ld, current_nr_sectors: %d\n",rq->sector,rq->nr_sectors,rq->current_nr_sectors);
713 #endif /* IDESCSI_DEBUG_LOG */
715 if (rq->flags & (REQ_SPECIAL|REQ_SENSE)) {
716 return idescsi_issue_pc (drive, (idescsi_pc_t *) rq->special);
718 blk_dump_rq_flags(rq, "ide-scsi: unsup command");
719 idescsi_end_request (drive, 0, 0);
720 return ide_stopped;
723 static void idescsi_add_settings(ide_drive_t *drive)
725 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
728 * drive setting name read/write ioctl ioctl data type min max mul_factor div_factor data pointer set function
730 ide_add_setting(drive, "bios_cyl", SETTING_RW, -1, -1, TYPE_INT, 0, 1023, 1, 1, &drive->bios_cyl, NULL);
731 ide_add_setting(drive, "bios_head", SETTING_RW, -1, -1, TYPE_BYTE, 0, 255, 1, 1, &drive->bios_head, NULL);
732 ide_add_setting(drive, "bios_sect", SETTING_RW, -1, -1, TYPE_BYTE, 0, 63, 1, 1, &drive->bios_sect, NULL);
733 ide_add_setting(drive, "transform", SETTING_RW, -1, -1, TYPE_INT, 0, 3, 1, 1, &scsi->transform, NULL);
734 ide_add_setting(drive, "log", SETTING_RW, -1, -1, TYPE_INT, 0, 1, 1, 1, &scsi->log, NULL);
738 * Driver initialization.
740 static void idescsi_setup (ide_drive_t *drive, idescsi_scsi_t *scsi)
742 if (drive->id && (drive->id->config & 0x0060) == 0x20)
743 set_bit (IDESCSI_DRQ_INTERRUPT, &scsi->flags);
744 set_bit(IDESCSI_TRANSFORM, &scsi->transform);
745 clear_bit(IDESCSI_SG_TRANSFORM, &scsi->transform);
746 #if IDESCSI_DEBUG_LOG
747 set_bit(IDESCSI_LOG_CMD, &scsi->log);
748 #endif /* IDESCSI_DEBUG_LOG */
749 idescsi_add_settings(drive);
752 static void ide_scsi_remove(ide_drive_t *drive)
754 struct Scsi_Host *scsihost = drive->driver_data;
755 struct ide_scsi_obj *scsi = scsihost_to_idescsi(scsihost);
756 struct gendisk *g = scsi->disk;
758 ide_unregister_subdriver(drive, scsi->driver);
760 ide_unregister_region(g);
762 drive->driver_data = NULL;
763 g->private_data = NULL;
764 put_disk(g);
766 scsi_remove_host(scsihost);
767 ide_scsi_put(scsi);
770 static int ide_scsi_probe(ide_drive_t *);
772 #ifdef CONFIG_PROC_FS
773 static ide_proc_entry_t idescsi_proc[] = {
774 { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
775 { NULL, 0, NULL, NULL }
777 #else
778 # define idescsi_proc NULL
779 #endif
781 static ide_driver_t idescsi_driver = {
782 .gen_driver = {
783 .owner = THIS_MODULE,
784 .name = "ide-scsi",
785 .bus = &ide_bus_type,
787 .probe = ide_scsi_probe,
788 .remove = ide_scsi_remove,
789 .version = IDESCSI_VERSION,
790 .media = ide_scsi,
791 .supports_dsc_overlap = 0,
792 .proc = idescsi_proc,
793 .do_request = idescsi_do_request,
794 .end_request = idescsi_end_request,
795 .error = idescsi_atapi_error,
796 .abort = idescsi_atapi_abort,
799 static int idescsi_ide_open(struct inode *inode, struct file *filp)
801 struct gendisk *disk = inode->i_bdev->bd_disk;
802 struct ide_scsi_obj *scsi;
803 ide_drive_t *drive;
805 if (!(scsi = ide_scsi_get(disk)))
806 return -ENXIO;
808 drive = scsi->drive;
810 drive->usage++;
812 return 0;
815 static int idescsi_ide_release(struct inode *inode, struct file *filp)
817 struct gendisk *disk = inode->i_bdev->bd_disk;
818 struct ide_scsi_obj *scsi = ide_scsi_g(disk);
819 ide_drive_t *drive = scsi->drive;
821 drive->usage--;
823 ide_scsi_put(scsi);
825 return 0;
828 static int idescsi_ide_ioctl(struct inode *inode, struct file *file,
829 unsigned int cmd, unsigned long arg)
831 struct block_device *bdev = inode->i_bdev;
832 struct ide_scsi_obj *scsi = ide_scsi_g(bdev->bd_disk);
833 return generic_ide_ioctl(scsi->drive, file, bdev, cmd, arg);
836 static struct block_device_operations idescsi_ops = {
837 .owner = THIS_MODULE,
838 .open = idescsi_ide_open,
839 .release = idescsi_ide_release,
840 .ioctl = idescsi_ide_ioctl,
843 static int idescsi_slave_configure(struct scsi_device * sdp)
845 /* Configure detected device */
846 scsi_adjust_queue_depth(sdp, MSG_SIMPLE_TAG, sdp->host->cmd_per_lun);
847 return 0;
850 static const char *idescsi_info (struct Scsi_Host *host)
852 return "SCSI host adapter emulation for IDE ATAPI devices";
855 static int idescsi_ioctl (struct scsi_device *dev, int cmd, void __user *arg)
857 idescsi_scsi_t *scsi = scsihost_to_idescsi(dev->host);
859 if (cmd == SG_SET_TRANSFORM) {
860 if (arg)
861 set_bit(IDESCSI_SG_TRANSFORM, &scsi->transform);
862 else
863 clear_bit(IDESCSI_SG_TRANSFORM, &scsi->transform);
864 return 0;
865 } else if (cmd == SG_GET_TRANSFORM)
866 return put_user(test_bit(IDESCSI_SG_TRANSFORM, &scsi->transform), (int __user *) arg);
867 return -EINVAL;
870 static inline int should_transform(ide_drive_t *drive, struct scsi_cmnd *cmd)
872 idescsi_scsi_t *scsi = drive_to_idescsi(drive);
874 /* this was a layering violation and we can't support it
875 anymore, sorry. */
876 #if 0
877 struct gendisk *disk = cmd->request->rq_disk;
879 if (disk) {
880 struct struct scsi_device_Template **p = disk->private_data;
881 if (strcmp((*p)->scsi_driverfs_driver.name, "sg") == 0)
882 return test_bit(IDESCSI_SG_TRANSFORM, &scsi->transform);
884 #endif
885 return test_bit(IDESCSI_TRANSFORM, &scsi->transform);
888 static int idescsi_queue (struct scsi_cmnd *cmd,
889 void (*done)(struct scsi_cmnd *))
891 struct Scsi_Host *host = cmd->device->host;
892 idescsi_scsi_t *scsi = scsihost_to_idescsi(host);
893 ide_drive_t *drive = scsi->drive;
894 struct request *rq = NULL;
895 idescsi_pc_t *pc = NULL;
897 if (!drive) {
898 scmd_printk (KERN_ERR, cmd, "drive not present\n");
899 goto abort;
901 scsi = drive_to_idescsi(drive);
902 pc = kmalloc (sizeof (idescsi_pc_t), GFP_ATOMIC);
903 rq = kmalloc (sizeof (struct request), GFP_ATOMIC);
904 if (rq == NULL || pc == NULL) {
905 printk (KERN_ERR "ide-scsi: %s: out of memory\n", drive->name);
906 goto abort;
909 memset (pc->c, 0, 12);
910 pc->flags = 0;
911 pc->rq = rq;
912 memcpy (pc->c, cmd->cmnd, cmd->cmd_len);
913 if (cmd->use_sg) {
914 pc->buffer = NULL;
915 pc->sg = cmd->request_buffer;
916 } else {
917 pc->buffer = cmd->request_buffer;
918 pc->sg = NULL;
920 pc->b_count = 0;
921 pc->request_transfer = pc->buffer_size = cmd->request_bufflen;
922 pc->scsi_cmd = cmd;
923 pc->done = done;
924 pc->timeout = jiffies + cmd->timeout_per_command;
926 if (should_transform(drive, cmd))
927 set_bit(PC_TRANSFORM, &pc->flags);
928 idescsi_transform_pc1 (drive, pc);
930 if (test_bit(IDESCSI_LOG_CMD, &scsi->log)) {
931 printk ("ide-scsi: %s: que %lu, cmd = ", drive->name, cmd->serial_number);
932 hexdump(cmd->cmnd, cmd->cmd_len);
933 if (memcmp(pc->c, cmd->cmnd, cmd->cmd_len)) {
934 printk ("ide-scsi: %s: que %lu, tsl = ", drive->name, cmd->serial_number);
935 hexdump(pc->c, 12);
939 ide_init_drive_cmd (rq);
940 rq->special = (char *) pc;
941 rq->flags = REQ_SPECIAL;
942 spin_unlock_irq(host->host_lock);
943 rq->rq_disk = scsi->disk;
944 (void) ide_do_drive_cmd (drive, rq, ide_end);
945 spin_lock_irq(host->host_lock);
946 return 0;
947 abort:
948 kfree (pc);
949 kfree (rq);
950 cmd->result = DID_ERROR << 16;
951 done(cmd);
952 return 0;
955 static int idescsi_eh_abort (struct scsi_cmnd *cmd)
957 idescsi_scsi_t *scsi = scsihost_to_idescsi(cmd->device->host);
958 ide_drive_t *drive = scsi->drive;
959 int busy;
960 int ret = FAILED;
962 /* In idescsi_eh_abort we try to gently pry our command from the ide subsystem */
964 if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
965 printk (KERN_WARNING "ide-scsi: abort called for %lu\n", cmd->serial_number);
967 if (!drive) {
968 printk (KERN_WARNING "ide-scsi: Drive not set in idescsi_eh_abort\n");
969 WARN_ON(1);
970 goto no_drive;
973 /* First give it some more time, how much is "right" is hard to say :-( */
975 busy = ide_wait_not_busy(HWIF(drive), 100); /* FIXME - uses mdelay which causes latency? */
976 if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
977 printk (KERN_WARNING "ide-scsi: drive did%s become ready\n", busy?" not":"");
979 spin_lock_irq(&ide_lock);
981 /* If there is no pc running we're done (our interrupt took care of it) */
982 if (!scsi->pc) {
983 ret = SUCCESS;
984 goto ide_unlock;
987 /* It's somewhere in flight. Does ide subsystem agree? */
988 if (scsi->pc->scsi_cmd->serial_number == cmd->serial_number && !busy &&
989 elv_queue_empty(drive->queue) && HWGROUP(drive)->rq != scsi->pc->rq) {
991 * FIXME - not sure this condition can ever occur
993 printk (KERN_ERR "ide-scsi: cmd aborted!\n");
995 if (scsi->pc->rq->flags & REQ_SENSE)
996 kfree(scsi->pc->buffer);
997 kfree(scsi->pc->rq);
998 kfree(scsi->pc);
999 scsi->pc = NULL;
1001 ret = SUCCESS;
1004 ide_unlock:
1005 spin_unlock_irq(&ide_lock);
1006 no_drive:
1007 if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
1008 printk (KERN_WARNING "ide-scsi: abort returns %s\n", ret == SUCCESS?"success":"failed");
1010 return ret;
1013 static int idescsi_eh_reset (struct scsi_cmnd *cmd)
1015 struct request *req;
1016 idescsi_scsi_t *scsi = scsihost_to_idescsi(cmd->device->host);
1017 ide_drive_t *drive = scsi->drive;
1018 int ready = 0;
1019 int ret = SUCCESS;
1021 /* In idescsi_eh_reset we forcefully remove the command from the ide subsystem and reset the device. */
1023 if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
1024 printk (KERN_WARNING "ide-scsi: reset called for %lu\n", cmd->serial_number);
1026 if (!drive) {
1027 printk (KERN_WARNING "ide-scsi: Drive not set in idescsi_eh_reset\n");
1028 WARN_ON(1);
1029 return FAILED;
1032 spin_lock_irq(cmd->device->host->host_lock);
1033 spin_lock(&ide_lock);
1035 if (!scsi->pc || (req = scsi->pc->rq) != HWGROUP(drive)->rq || !HWGROUP(drive)->handler) {
1036 printk (KERN_WARNING "ide-scsi: No active request in idescsi_eh_reset\n");
1037 spin_unlock(&ide_lock);
1038 spin_unlock_irq(cmd->device->host->host_lock);
1039 return FAILED;
1042 /* kill current request */
1043 blkdev_dequeue_request(req);
1044 end_that_request_last(req, 0);
1045 if (req->flags & REQ_SENSE)
1046 kfree(scsi->pc->buffer);
1047 kfree(scsi->pc);
1048 scsi->pc = NULL;
1049 kfree(req);
1051 /* now nuke the drive queue */
1052 while ((req = elv_next_request(drive->queue))) {
1053 blkdev_dequeue_request(req);
1054 end_that_request_last(req, 0);
1057 HWGROUP(drive)->rq = NULL;
1058 HWGROUP(drive)->handler = NULL;
1059 HWGROUP(drive)->busy = 1; /* will set this to zero when ide reset finished */
1060 spin_unlock(&ide_lock);
1062 ide_do_reset(drive);
1064 /* ide_do_reset starts a polling handler which restarts itself every 50ms until the reset finishes */
1066 do {
1067 spin_unlock_irq(cmd->device->host->host_lock);
1068 msleep(50);
1069 spin_lock_irq(cmd->device->host->host_lock);
1070 } while ( HWGROUP(drive)->handler );
1072 ready = drive_is_ready(drive);
1073 HWGROUP(drive)->busy--;
1074 if (!ready) {
1075 printk (KERN_ERR "ide-scsi: reset failed!\n");
1076 ret = FAILED;
1079 spin_unlock_irq(cmd->device->host->host_lock);
1080 return ret;
1083 static int idescsi_bios(struct scsi_device *sdev, struct block_device *bdev,
1084 sector_t capacity, int *parm)
1086 idescsi_scsi_t *idescsi = scsihost_to_idescsi(sdev->host);
1087 ide_drive_t *drive = idescsi->drive;
1089 if (drive->bios_cyl && drive->bios_head && drive->bios_sect) {
1090 parm[0] = drive->bios_head;
1091 parm[1] = drive->bios_sect;
1092 parm[2] = drive->bios_cyl;
1094 return 0;
1097 static struct scsi_host_template idescsi_template = {
1098 .module = THIS_MODULE,
1099 .name = "idescsi",
1100 .info = idescsi_info,
1101 .slave_configure = idescsi_slave_configure,
1102 .ioctl = idescsi_ioctl,
1103 .queuecommand = idescsi_queue,
1104 .eh_abort_handler = idescsi_eh_abort,
1105 .eh_host_reset_handler = idescsi_eh_reset,
1106 .bios_param = idescsi_bios,
1107 .can_queue = 40,
1108 .this_id = -1,
1109 .sg_tablesize = 256,
1110 .cmd_per_lun = 5,
1111 .max_sectors = 128,
1112 .use_clustering = DISABLE_CLUSTERING,
1113 .emulated = 1,
1114 .proc_name = "ide-scsi",
1117 static int ide_scsi_probe(ide_drive_t *drive)
1119 idescsi_scsi_t *idescsi;
1120 struct Scsi_Host *host;
1121 struct gendisk *g;
1122 static int warned;
1123 int err = -ENOMEM;
1125 if (!warned && drive->media == ide_cdrom) {
1126 printk(KERN_WARNING "ide-scsi is deprecated for cd burning! Use ide-cd and give dev=/dev/hdX as device\n");
1127 warned = 1;
1130 if (!strstr("ide-scsi", drive->driver_req) ||
1131 !drive->present ||
1132 drive->media == ide_disk ||
1133 !(host = scsi_host_alloc(&idescsi_template,sizeof(idescsi_scsi_t))))
1134 return -ENODEV;
1136 g = alloc_disk(1 << PARTN_BITS);
1137 if (!g)
1138 goto out_host_put;
1140 ide_init_disk(g, drive);
1142 host->max_id = 1;
1144 #if IDESCSI_DEBUG_LOG
1145 if (drive->id->last_lun)
1146 printk(KERN_NOTICE "%s: id->last_lun=%u\n", drive->name, drive->id->last_lun);
1147 #endif
1148 if ((drive->id->last_lun & 0x7) != 7)
1149 host->max_lun = (drive->id->last_lun & 0x7) + 1;
1150 else
1151 host->max_lun = 1;
1153 drive->driver_data = host;
1154 idescsi = scsihost_to_idescsi(host);
1155 idescsi->drive = drive;
1156 idescsi->driver = &idescsi_driver;
1157 idescsi->host = host;
1158 idescsi->disk = g;
1159 g->private_data = &idescsi->driver;
1160 ide_register_subdriver(drive, &idescsi_driver);
1161 err = 0;
1162 idescsi_setup(drive, idescsi);
1163 g->fops = &idescsi_ops;
1164 ide_register_region(g);
1165 err = scsi_add_host(host, &drive->gendev);
1166 if (!err) {
1167 scsi_scan_host(host);
1168 return 0;
1170 /* fall through on error */
1171 ide_unregister_region(g);
1172 ide_unregister_subdriver(drive, &idescsi_driver);
1174 put_disk(g);
1175 out_host_put:
1176 scsi_host_put(host);
1177 return err;
1180 static int __init init_idescsi_module(void)
1182 return driver_register(&idescsi_driver.gen_driver);
1185 static void __exit exit_idescsi_module(void)
1187 driver_unregister(&idescsi_driver.gen_driver);
1190 module_init(init_idescsi_module);
1191 module_exit(exit_idescsi_module);
1192 MODULE_LICENSE("GPL");