ide-scsi: convert driver to using generic ide_atapi_pc
[safe/jmp/linux-2.6] / drivers / scsi / ide-scsi.c
1 /*
2  * Copyright (C) 1996-1999  Gadi Oxman <gadio@netvision.net.il>
3  * Copyright (C) 2004-2005  Bartlomiej Zolnierkiewicz
4  */
5
6 /*
7  * Emulation of a SCSI host adapter for IDE ATAPI devices.
8  *
9  * With this driver, one can use the Linux SCSI drivers instead of the
10  * native IDE ATAPI drivers.
11  *
12  * Ver 0.1   Dec  3 96   Initial version.
13  * Ver 0.2   Jan 26 97   Fixed bug in cleanup_module() and added emulation
14  *                        of MODE_SENSE_6/MODE_SELECT_6 for cdroms. Thanks
15  *                        to Janos Farkas for pointing this out.
16  *                       Avoid using bitfields in structures for m68k.
17  *                       Added Scatter/Gather and DMA support.
18  * Ver 0.4   Dec  7 97   Add support for ATAPI PD/CD drives.
19  *                       Use variable timeout for each command.
20  * Ver 0.5   Jan  2 98   Fix previous PD/CD support.
21  *                       Allow disabling of SCSI-6 to SCSI-10 transformation.
22  * Ver 0.6   Jan 27 98   Allow disabling of SCSI command translation layer
23  *                        for access through /dev/sg.
24  *                       Fix MODE_SENSE_6/MODE_SELECT_6/INQUIRY translation.
25  * Ver 0.7   Dec 04 98   Ignore commands where lun != 0 to avoid multiple
26  *                        detection of devices with CONFIG_SCSI_MULTI_LUN
27  * Ver 0.8   Feb 05 99   Optical media need translation too. Reverse 0.7.
28  * Ver 0.9   Jul 04 99   Fix a bug in SG_SET_TRANSFORM.
29  * Ver 0.91  Jun 10 02   Fix "off by one" error in transforms
30  * Ver 0.92  Dec 31 02   Implement new SCSI mid level API
31  */
32
33 #define IDESCSI_VERSION "0.92"
34
35 #include <linux/module.h>
36 #include <linux/types.h>
37 #include <linux/string.h>
38 #include <linux/kernel.h>
39 #include <linux/mm.h>
40 #include <linux/ioport.h>
41 #include <linux/blkdev.h>
42 #include <linux/errno.h>
43 #include <linux/hdreg.h>
44 #include <linux/slab.h>
45 #include <linux/ide.h>
46 #include <linux/scatterlist.h>
47 #include <linux/delay.h>
48 #include <linux/mutex.h>
49 #include <linux/bitops.h>
50
51 #include <asm/io.h>
52 #include <asm/uaccess.h>
53
54 #include <scsi/scsi.h>
55 #include <scsi/scsi_cmnd.h>
56 #include <scsi/scsi_device.h>
57 #include <scsi/scsi_host.h>
58 #include <scsi/scsi_tcq.h>
59 #include <scsi/sg.h>
60
61 #define IDESCSI_DEBUG_LOG               0
62
63 /*
64  *      Packet command status bits.
65  */
66 #define PC_DMA_IN_PROGRESS              0       /* 1 while DMA in progress */
67 #define PC_WRITING                      1       /* Data direction */
68 #define PC_TIMEDOUT                     3       /* command timed out */
69 #define PC_DMA_OK                       4       /* Use DMA */
70
71 /*
72  *      SCSI command transformation layer
73  */
74 #define IDESCSI_SG_TRANSFORM            1       /* /dev/sg transformation */
75
76 /*
77  *      Log flags
78  */
79 #define IDESCSI_LOG_CMD                 0       /* Log SCSI commands */
80
81 typedef struct ide_scsi_obj {
82         ide_drive_t             *drive;
83         ide_driver_t            *driver;
84         struct gendisk          *disk;
85         struct Scsi_Host        *host;
86
87         struct ide_atapi_pc *pc;                /* Current packet command */
88         unsigned long flags;                    /* Status/Action flags */
89         unsigned long transform;                /* SCSI cmd translation layer */
90         unsigned long log;                      /* log flags */
91 } idescsi_scsi_t;
92
93 static DEFINE_MUTEX(idescsi_ref_mutex);
94 /* Set by module param to skip cd */
95 static int idescsi_nocd;
96
97 #define ide_scsi_g(disk) \
98         container_of((disk)->private_data, struct ide_scsi_obj, driver)
99
100 static struct ide_scsi_obj *ide_scsi_get(struct gendisk *disk)
101 {
102         struct ide_scsi_obj *scsi = NULL;
103
104         mutex_lock(&idescsi_ref_mutex);
105         scsi = ide_scsi_g(disk);
106         if (scsi)
107                 scsi_host_get(scsi->host);
108         mutex_unlock(&idescsi_ref_mutex);
109         return scsi;
110 }
111
112 static void ide_scsi_put(struct ide_scsi_obj *scsi)
113 {
114         mutex_lock(&idescsi_ref_mutex);
115         scsi_host_put(scsi->host);
116         mutex_unlock(&idescsi_ref_mutex);
117 }
118
119 static inline idescsi_scsi_t *scsihost_to_idescsi(struct Scsi_Host *host)
120 {
121         return (idescsi_scsi_t*) (&host[1]);
122 }
123
124 static inline idescsi_scsi_t *drive_to_idescsi(ide_drive_t *ide_drive)
125 {
126         return scsihost_to_idescsi(ide_drive->driver_data);
127 }
128
129 /*
130  *      Per ATAPI device status bits.
131  */
132 #define IDESCSI_DRQ_INTERRUPT           0       /* DRQ interrupt device */
133
134 /*
135  *      ide-scsi requests.
136  */
137 #define IDESCSI_PC_RQ                   90
138
139 /*
140  *      PIO data transfer routines using the scatter gather table.
141  */
142 static void idescsi_input_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
143                 unsigned int bcount)
144 {
145         int count;
146         char *buf;
147
148         while (bcount) {
149                 count = min(pc->sg->length - pc->b_count, bcount);
150                 if (PageHighMem(sg_page(pc->sg))) {
151                         unsigned long flags;
152
153                         local_irq_save(flags);
154                         buf = kmap_atomic(sg_page(pc->sg), KM_IRQ0) +
155                                         pc->sg->offset;
156                         drive->hwif->atapi_input_bytes(drive,
157                                                 buf + pc->b_count, count);
158                         kunmap_atomic(buf - pc->sg->offset, KM_IRQ0);
159                         local_irq_restore(flags);
160                 } else {
161                         buf = sg_virt(pc->sg);
162                         drive->hwif->atapi_input_bytes(drive,
163                                                 buf + pc->b_count, count);
164                 }
165                 bcount -= count; pc->b_count += count;
166                 if (pc->b_count == pc->sg->length) {
167                         if (!--pc->sg_cnt)
168                                 break;
169                         pc->sg = sg_next(pc->sg);
170                         pc->b_count = 0;
171                 }
172         }
173
174         if (bcount) {
175                 printk (KERN_ERR "ide-scsi: scatter gather table too small, discarding data\n");
176                 ide_atapi_discard_data(drive, bcount);
177         }
178 }
179
180 static void idescsi_output_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
181                 unsigned int bcount)
182 {
183         int count;
184         char *buf;
185
186         while (bcount) {
187                 count = min(pc->sg->length - pc->b_count, bcount);
188                 if (PageHighMem(sg_page(pc->sg))) {
189                         unsigned long flags;
190
191                         local_irq_save(flags);
192                         buf = kmap_atomic(sg_page(pc->sg), KM_IRQ0) +
193                                                 pc->sg->offset;
194                         drive->hwif->atapi_output_bytes(drive,
195                                                 buf + pc->b_count, count);
196                         kunmap_atomic(buf - pc->sg->offset, KM_IRQ0);
197                         local_irq_restore(flags);
198                 } else {
199                         buf = sg_virt(pc->sg);
200                         drive->hwif->atapi_output_bytes(drive,
201                                                 buf + pc->b_count, count);
202                 }
203                 bcount -= count; pc->b_count += count;
204                 if (pc->b_count == pc->sg->length) {
205                         if (!--pc->sg_cnt)
206                                 break;
207                         pc->sg = sg_next(pc->sg);
208                         pc->b_count = 0;
209                 }
210         }
211
212         if (bcount) {
213                 printk (KERN_ERR "ide-scsi: scatter gather table too small, padding with zeros\n");
214                 ide_atapi_write_zeros(drive, bcount);
215         }
216 }
217
218 static void ide_scsi_hex_dump(u8 *data, int len)
219 {
220         print_hex_dump(KERN_CONT, "", DUMP_PREFIX_NONE, 16, 1, data, len, 0);
221 }
222
223 static int idescsi_check_condition(ide_drive_t *drive,
224                 struct request *failed_cmd)
225 {
226         idescsi_scsi_t *scsi = drive_to_idescsi(drive);
227         struct ide_atapi_pc   *pc;
228         struct request *rq;
229         u8             *buf;
230
231         /* stuff a sense request in front of our current request */
232         pc = kzalloc(sizeof(struct ide_atapi_pc), GFP_ATOMIC);
233         rq = kmalloc(sizeof(struct request), GFP_ATOMIC);
234         buf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_ATOMIC);
235         if (!pc || !rq || !buf) {
236                 kfree(buf);
237                 kfree(rq);
238                 kfree(pc);
239                 return -ENOMEM;
240         }
241         ide_init_drive_cmd(rq);
242         rq->special = (char *) pc;
243         pc->rq = rq;
244         pc->buf = buf;
245         pc->c[0] = REQUEST_SENSE;
246         pc->c[4] = pc->req_xfer = pc->buf_size = SCSI_SENSE_BUFFERSIZE;
247         rq->cmd_type = REQ_TYPE_SENSE;
248         pc->timeout = jiffies + WAIT_READY;
249         /* NOTE! Save the failed packet command in "rq->buffer" */
250         rq->buffer = (void *) failed_cmd->special;
251         pc->scsi_cmd = ((struct ide_atapi_pc *) failed_cmd->special)->scsi_cmd;
252         if (test_bit(IDESCSI_LOG_CMD, &scsi->log)) {
253                 printk ("ide-scsi: %s: queue cmd = ", drive->name);
254                 ide_scsi_hex_dump(pc->c, 6);
255         }
256         rq->rq_disk = scsi->disk;
257         return ide_do_drive_cmd(drive, rq, ide_preempt);
258 }
259
260 static int idescsi_end_request(ide_drive_t *, int, int);
261
262 static ide_startstop_t
263 idescsi_atapi_error(ide_drive_t *drive, struct request *rq, u8 stat, u8 err)
264 {
265         ide_hwif_t *hwif = drive->hwif;
266
267         if (ide_read_status(drive) & (BUSY_STAT | DRQ_STAT))
268                 /* force an abort */
269                 hwif->OUTB(WIN_IDLEIMMEDIATE,
270                            hwif->io_ports[IDE_COMMAND_OFFSET]);
271
272         rq->errors++;
273
274         idescsi_end_request(drive, 0, 0);
275
276         return ide_stopped;
277 }
278
279 static ide_startstop_t
280 idescsi_atapi_abort(ide_drive_t *drive, struct request *rq)
281 {
282 #if IDESCSI_DEBUG_LOG
283         printk(KERN_WARNING "idescsi_atapi_abort called for %lu\n",
284                 ((struct ide_atapi_pc *) rq->special)->scsi_cmd->serial_number);
285 #endif
286         rq->errors |= ERROR_MAX;
287
288         idescsi_end_request(drive, 0, 0);
289
290         return ide_stopped;
291 }
292
293 static int idescsi_end_request (ide_drive_t *drive, int uptodate, int nrsecs)
294 {
295         idescsi_scsi_t *scsi = drive_to_idescsi(drive);
296         struct request *rq = HWGROUP(drive)->rq;
297         struct ide_atapi_pc *pc = (struct ide_atapi_pc *) rq->special;
298         int log = test_bit(IDESCSI_LOG_CMD, &scsi->log);
299         struct Scsi_Host *host;
300         int errors = rq->errors;
301         unsigned long flags;
302
303         if (!blk_special_request(rq) && !blk_sense_request(rq)) {
304                 ide_end_request(drive, uptodate, nrsecs);
305                 return 0;
306         }
307         ide_end_drive_cmd (drive, 0, 0);
308         if (blk_sense_request(rq)) {
309                 struct ide_atapi_pc *opc = (struct ide_atapi_pc *) rq->buffer;
310                 if (log) {
311                         printk ("ide-scsi: %s: wrap up check %lu, rst = ", drive->name, opc->scsi_cmd->serial_number);
312                         ide_scsi_hex_dump(pc->buf, 16);
313                 }
314                 memcpy((void *) opc->scsi_cmd->sense_buffer, pc->buf,
315                         SCSI_SENSE_BUFFERSIZE);
316                 kfree(pc->buf);
317                 kfree(pc);
318                 kfree(rq);
319                 pc = opc;
320                 rq = pc->rq;
321                 pc->scsi_cmd->result = (CHECK_CONDITION << 1) |
322                                         ((test_bit(PC_TIMEDOUT, &pc->flags)?DID_TIME_OUT:DID_OK) << 16);
323         } else if (test_bit(PC_TIMEDOUT, &pc->flags)) {
324                 if (log)
325                         printk (KERN_WARNING "ide-scsi: %s: timed out for %lu\n",
326                                         drive->name, pc->scsi_cmd->serial_number);
327                 pc->scsi_cmd->result = DID_TIME_OUT << 16;
328         } else if (errors >= ERROR_MAX) {
329                 pc->scsi_cmd->result = DID_ERROR << 16;
330                 if (log)
331                         printk ("ide-scsi: %s: I/O error for %lu\n", drive->name, pc->scsi_cmd->serial_number);
332         } else if (errors) {
333                 if (log)
334                         printk ("ide-scsi: %s: check condition for %lu\n", drive->name, pc->scsi_cmd->serial_number);
335                 if (!idescsi_check_condition(drive, rq))
336                         /* we started a request sense, so we'll be back, exit for now */
337                         return 0;
338                 pc->scsi_cmd->result = (CHECK_CONDITION << 1) | (DID_OK << 16);
339         } else {
340                 pc->scsi_cmd->result = DID_OK << 16;
341         }
342         host = pc->scsi_cmd->device->host;
343         spin_lock_irqsave(host->host_lock, flags);
344         pc->done(pc->scsi_cmd);
345         spin_unlock_irqrestore(host->host_lock, flags);
346         kfree(pc);
347         kfree(rq);
348         scsi->pc = NULL;
349         return 0;
350 }
351
352 static inline unsigned long get_timeout(struct ide_atapi_pc *pc)
353 {
354         return max_t(unsigned long, WAIT_CMD, pc->timeout - jiffies);
355 }
356
357 static int idescsi_expiry(ide_drive_t *drive)
358 {
359         idescsi_scsi_t *scsi = drive_to_idescsi(drive);
360         struct ide_atapi_pc   *pc   = scsi->pc;
361
362 #if IDESCSI_DEBUG_LOG
363         printk(KERN_WARNING "idescsi_expiry called for %lu at %lu\n", pc->scsi_cmd->serial_number, jiffies);
364 #endif
365         set_bit(PC_TIMEDOUT, &pc->flags);
366
367         return 0;                                       /* we do not want the ide subsystem to retry */
368 }
369
370 /*
371  *      Our interrupt handler.
372  */
373 static ide_startstop_t idescsi_pc_intr (ide_drive_t *drive)
374 {
375         idescsi_scsi_t *scsi = drive_to_idescsi(drive);
376         ide_hwif_t *hwif = drive->hwif;
377         struct ide_atapi_pc *pc = scsi->pc;
378         struct request *rq = pc->rq;
379         unsigned int temp;
380         u16 bcount;
381         u8 stat, ireason;
382
383 #if IDESCSI_DEBUG_LOG
384         printk (KERN_INFO "ide-scsi: Reached idescsi_pc_intr interrupt handler\n");
385 #endif /* IDESCSI_DEBUG_LOG */
386
387         if (test_bit(PC_TIMEDOUT, &pc->flags)){
388 #if IDESCSI_DEBUG_LOG
389                 printk(KERN_WARNING "idescsi_pc_intr: got timed out packet  %lu at %lu\n",
390                                 pc->scsi_cmd->serial_number, jiffies);
391 #endif
392                 /* end this request now - scsi should retry it*/
393                 idescsi_end_request (drive, 1, 0);
394                 return ide_stopped;
395         }
396         if (test_and_clear_bit (PC_DMA_IN_PROGRESS, &pc->flags)) {
397 #if IDESCSI_DEBUG_LOG
398                 printk ("ide-scsi: %s: DMA complete\n", drive->name);
399 #endif /* IDESCSI_DEBUG_LOG */
400                 pc->xferred = pc->req_xfer;
401                 (void) HWIF(drive)->ide_dma_end(drive);
402         }
403
404         /* Clear the interrupt */
405         stat = ide_read_status(drive);
406
407         if ((stat & DRQ_STAT) == 0) {
408                 /* No more interrupts */
409                 if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
410                         printk(KERN_INFO "Packet command completed, %d bytes"
411                                         " transferred\n", pc->xferred);
412                 local_irq_enable_in_hardirq();
413                 if (stat & ERR_STAT)
414                         rq->errors++;
415                 idescsi_end_request (drive, 1, 0);
416                 return ide_stopped;
417         }
418         bcount = (hwif->INB(hwif->io_ports[IDE_BCOUNTH_OFFSET]) << 8) |
419                   hwif->INB(hwif->io_ports[IDE_BCOUNTL_OFFSET]);
420         ireason = hwif->INB(hwif->io_ports[IDE_IREASON_OFFSET]);
421
422         if (ireason & CD) {
423                 printk(KERN_ERR "ide-scsi: CoD != 0 in idescsi_pc_intr\n");
424                 return ide_do_reset (drive);
425         }
426         if (ireason & IO) {
427                 temp = pc->xferred + bcount;
428                 if (temp > pc->req_xfer) {
429                         if (temp > pc->buf_size) {
430                                 printk(KERN_ERR "ide-scsi: The scsi wants to "
431                                         "send us more data than expected "
432                                         "- discarding data\n");
433                                 temp = pc->buf_size - pc->xferred;
434                                 if (temp) {
435                                         clear_bit(PC_WRITING, &pc->flags);
436                                         if (pc->sg)
437                                                 idescsi_input_buffers(drive, pc,
438                                                                         temp);
439                                         else
440                                                 drive->hwif->atapi_input_bytes(drive, pc->cur_pos, temp);
441                                         printk(KERN_ERR "ide-scsi: transferred"
442                                                         " %d of %d bytes\n",
443                                                         temp, bcount);
444                                 }
445                                 pc->xferred += temp;
446                                 pc->cur_pos += temp;
447                                 ide_atapi_discard_data(drive, bcount - temp);
448                                 ide_set_handler(drive, &idescsi_pc_intr, get_timeout(pc), idescsi_expiry);
449                                 return ide_started;
450                         }
451 #if IDESCSI_DEBUG_LOG
452                         printk (KERN_NOTICE "ide-scsi: The scsi wants to send us more data than expected - allowing transfer\n");
453 #endif /* IDESCSI_DEBUG_LOG */
454                 }
455         }
456         if (ireason & IO) {
457                 clear_bit(PC_WRITING, &pc->flags);
458                 if (pc->sg)
459                         idescsi_input_buffers(drive, pc, bcount);
460                 else
461                         hwif->atapi_input_bytes(drive, pc->cur_pos,
462                                                 bcount);
463         } else {
464                 set_bit(PC_WRITING, &pc->flags);
465                 if (pc->sg)
466                         idescsi_output_buffers(drive, pc, bcount);
467                 else
468                         hwif->atapi_output_bytes(drive, pc->cur_pos,
469                                                  bcount);
470         }
471         /* Update the current position */
472         pc->xferred += bcount;
473         pc->cur_pos += bcount;
474
475         /* And set the interrupt handler again */
476         ide_set_handler(drive, &idescsi_pc_intr, get_timeout(pc), idescsi_expiry);
477         return ide_started;
478 }
479
480 static ide_startstop_t idescsi_transfer_pc(ide_drive_t *drive)
481 {
482         ide_hwif_t *hwif = drive->hwif;
483         idescsi_scsi_t *scsi = drive_to_idescsi(drive);
484         struct ide_atapi_pc *pc = scsi->pc;
485         ide_startstop_t startstop;
486         u8 ireason;
487
488         if (ide_wait_stat(&startstop,drive,DRQ_STAT,BUSY_STAT,WAIT_READY)) {
489                 printk(KERN_ERR "ide-scsi: Strange, packet command "
490                         "initiated yet DRQ isn't asserted\n");
491                 return startstop;
492         }
493         ireason = hwif->INB(hwif->io_ports[IDE_IREASON_OFFSET]);
494         if ((ireason & CD) == 0 || (ireason & IO)) {
495                 printk(KERN_ERR "ide-scsi: (IO,CoD) != (0,1) while "
496                                 "issuing a packet command\n");
497                 return ide_do_reset (drive);
498         }
499         BUG_ON(HWGROUP(drive)->handler != NULL);
500         /* Set the interrupt routine */
501         ide_set_handler(drive, &idescsi_pc_intr, get_timeout(pc), idescsi_expiry);
502         /* Send the actual packet */
503         drive->hwif->atapi_output_bytes(drive, scsi->pc->c, 12);
504         if (test_bit (PC_DMA_OK, &pc->flags)) {
505                 set_bit (PC_DMA_IN_PROGRESS, &pc->flags);
506                 hwif->dma_start(drive);
507         }
508         return ide_started;
509 }
510
511 static inline int idescsi_set_direction(struct ide_atapi_pc *pc)
512 {
513         switch (pc->c[0]) {
514                 case READ_6: case READ_10: case READ_12:
515                         clear_bit(PC_WRITING, &pc->flags);
516                         return 0;
517                 case WRITE_6: case WRITE_10: case WRITE_12:
518                         set_bit(PC_WRITING, &pc->flags);
519                         return 0;
520                 default:
521                         return 1;
522         }
523 }
524
525 static int idescsi_map_sg(ide_drive_t *drive, struct ide_atapi_pc *pc)
526 {
527         ide_hwif_t *hwif = drive->hwif;
528         struct scatterlist *sg, *scsi_sg;
529         int segments;
530
531         if (!pc->req_xfer || pc->req_xfer % 1024)
532                 return 1;
533
534         if (idescsi_set_direction(pc))
535                 return 1;
536
537         sg = hwif->sg_table;
538         scsi_sg = scsi_sglist(pc->scsi_cmd);
539         segments = scsi_sg_count(pc->scsi_cmd);
540
541         if (segments > hwif->sg_max_nents)
542                 return 1;
543
544         hwif->sg_nents = segments;
545         memcpy(sg, scsi_sg, sizeof(*sg) * segments);
546
547         return 0;
548 }
549
550 static ide_startstop_t idescsi_issue_pc(ide_drive_t *drive,
551                 struct ide_atapi_pc *pc)
552 {
553         idescsi_scsi_t *scsi = drive_to_idescsi(drive);
554         ide_hwif_t *hwif = drive->hwif;
555         u16 bcount;
556         u8 dma = 0;
557
558         /* Set the current packet command */
559         scsi->pc = pc;
560         /* We haven't transferred any data yet */
561         pc->xferred = 0;
562         pc->cur_pos = pc->buf;
563         /* Request to transfer the entire buffer at once */
564         bcount = min(pc->req_xfer, 63 * 1024);
565
566         if (drive->using_dma && !idescsi_map_sg(drive, pc)) {
567                 hwif->sg_mapped = 1;
568                 dma = !hwif->dma_setup(drive);
569                 hwif->sg_mapped = 0;
570         }
571
572         ide_pktcmd_tf_load(drive, IDE_TFLAG_NO_SELECT_MASK, bcount, dma);
573
574         if (dma)
575                 set_bit(PC_DMA_OK, &pc->flags);
576
577         if (test_bit(IDESCSI_DRQ_INTERRUPT, &scsi->flags)) {
578                 ide_execute_command(drive, WIN_PACKETCMD, &idescsi_transfer_pc,
579                                     get_timeout(pc), idescsi_expiry);
580                 return ide_started;
581         } else {
582                 /* Issue the packet command */
583                 hwif->OUTB(WIN_PACKETCMD, hwif->io_ports[IDE_COMMAND_OFFSET]);
584                 return idescsi_transfer_pc(drive);
585         }
586 }
587
588 /*
589  *      idescsi_do_request is our request handling function.
590  */
591 static ide_startstop_t idescsi_do_request (ide_drive_t *drive, struct request *rq, sector_t block)
592 {
593 #if IDESCSI_DEBUG_LOG
594         printk (KERN_INFO "dev: %s, cmd: %x, errors: %d\n", rq->rq_disk->disk_name,rq->cmd[0],rq->errors);
595         printk (KERN_INFO "sector: %ld, nr_sectors: %ld, current_nr_sectors: %d\n",rq->sector,rq->nr_sectors,rq->current_nr_sectors);
596 #endif /* IDESCSI_DEBUG_LOG */
597
598         if (blk_sense_request(rq) || blk_special_request(rq)) {
599                 return idescsi_issue_pc(drive,
600                                 (struct ide_atapi_pc *) rq->special);
601         }
602         blk_dump_rq_flags(rq, "ide-scsi: unsup command");
603         idescsi_end_request (drive, 0, 0);
604         return ide_stopped;
605 }
606
607 #ifdef CONFIG_IDE_PROC_FS
608 static void idescsi_add_settings(ide_drive_t *drive)
609 {
610         idescsi_scsi_t *scsi = drive_to_idescsi(drive);
611
612 /*
613  *                      drive   setting name    read/write      data type       min     max     mul_factor      div_factor      data pointer            set function
614  */
615         ide_add_setting(drive,  "bios_cyl",     SETTING_RW,     TYPE_INT,       0,      1023,   1,              1,              &drive->bios_cyl,       NULL);
616         ide_add_setting(drive,  "bios_head",    SETTING_RW,     TYPE_BYTE,      0,      255,    1,              1,              &drive->bios_head,      NULL);
617         ide_add_setting(drive,  "bios_sect",    SETTING_RW,     TYPE_BYTE,      0,      63,     1,              1,              &drive->bios_sect,      NULL);
618         ide_add_setting(drive,  "transform",    SETTING_RW,     TYPE_INT,       0,      3,      1,              1,              &scsi->transform,       NULL);
619         ide_add_setting(drive,  "log",          SETTING_RW,     TYPE_INT,       0,      1,      1,              1,              &scsi->log,             NULL);
620 }
621 #else
622 static inline void idescsi_add_settings(ide_drive_t *drive) { ; }
623 #endif
624
625 /*
626  *      Driver initialization.
627  */
628 static void idescsi_setup (ide_drive_t *drive, idescsi_scsi_t *scsi)
629 {
630         if (drive->id && (drive->id->config & 0x0060) == 0x20)
631                 set_bit (IDESCSI_DRQ_INTERRUPT, &scsi->flags);
632         clear_bit(IDESCSI_SG_TRANSFORM, &scsi->transform);
633 #if IDESCSI_DEBUG_LOG
634         set_bit(IDESCSI_LOG_CMD, &scsi->log);
635 #endif /* IDESCSI_DEBUG_LOG */
636         idescsi_add_settings(drive);
637 }
638
639 static void ide_scsi_remove(ide_drive_t *drive)
640 {
641         struct Scsi_Host *scsihost = drive->driver_data;
642         struct ide_scsi_obj *scsi = scsihost_to_idescsi(scsihost);
643         struct gendisk *g = scsi->disk;
644
645         scsi_remove_host(scsihost);
646         ide_proc_unregister_driver(drive, scsi->driver);
647
648         ide_unregister_region(g);
649
650         drive->driver_data = NULL;
651         g->private_data = NULL;
652         put_disk(g);
653
654         ide_scsi_put(scsi);
655 }
656
657 static int ide_scsi_probe(ide_drive_t *);
658
659 #ifdef CONFIG_IDE_PROC_FS
660 static ide_proc_entry_t idescsi_proc[] = {
661         { "capacity", S_IFREG|S_IRUGO, proc_ide_read_capacity, NULL },
662         { NULL, 0, NULL, NULL }
663 };
664 #endif
665
666 static ide_driver_t idescsi_driver = {
667         .gen_driver = {
668                 .owner          = THIS_MODULE,
669                 .name           = "ide-scsi",
670                 .bus            = &ide_bus_type,
671         },
672         .probe                  = ide_scsi_probe,
673         .remove                 = ide_scsi_remove,
674         .version                = IDESCSI_VERSION,
675         .media                  = ide_scsi,
676         .supports_dsc_overlap   = 0,
677         .do_request             = idescsi_do_request,
678         .end_request            = idescsi_end_request,
679         .error                  = idescsi_atapi_error,
680         .abort                  = idescsi_atapi_abort,
681 #ifdef CONFIG_IDE_PROC_FS
682         .proc                   = idescsi_proc,
683 #endif
684 };
685
686 static int idescsi_ide_open(struct inode *inode, struct file *filp)
687 {
688         struct gendisk *disk = inode->i_bdev->bd_disk;
689         struct ide_scsi_obj *scsi;
690
691         if (!(scsi = ide_scsi_get(disk)))
692                 return -ENXIO;
693
694         return 0;
695 }
696
697 static int idescsi_ide_release(struct inode *inode, struct file *filp)
698 {
699         struct gendisk *disk = inode->i_bdev->bd_disk;
700         struct ide_scsi_obj *scsi = ide_scsi_g(disk);
701
702         ide_scsi_put(scsi);
703
704         return 0;
705 }
706
707 static int idescsi_ide_ioctl(struct inode *inode, struct file *file,
708                         unsigned int cmd, unsigned long arg)
709 {
710         struct block_device *bdev = inode->i_bdev;
711         struct ide_scsi_obj *scsi = ide_scsi_g(bdev->bd_disk);
712         return generic_ide_ioctl(scsi->drive, file, bdev, cmd, arg);
713 }
714
715 static struct block_device_operations idescsi_ops = {
716         .owner          = THIS_MODULE,
717         .open           = idescsi_ide_open,
718         .release        = idescsi_ide_release,
719         .ioctl          = idescsi_ide_ioctl,
720 };
721
722 static int idescsi_slave_configure(struct scsi_device * sdp)
723 {
724         /* Configure detected device */
725         sdp->use_10_for_rw = 1;
726         sdp->use_10_for_ms = 1;
727         scsi_adjust_queue_depth(sdp, MSG_SIMPLE_TAG, sdp->host->cmd_per_lun);
728         return 0;
729 }
730
731 static const char *idescsi_info (struct Scsi_Host *host)
732 {
733         return "SCSI host adapter emulation for IDE ATAPI devices";
734 }
735
736 static int idescsi_ioctl (struct scsi_device *dev, int cmd, void __user *arg)
737 {
738         idescsi_scsi_t *scsi = scsihost_to_idescsi(dev->host);
739
740         if (cmd == SG_SET_TRANSFORM) {
741                 if (arg)
742                         set_bit(IDESCSI_SG_TRANSFORM, &scsi->transform);
743                 else
744                         clear_bit(IDESCSI_SG_TRANSFORM, &scsi->transform);
745                 return 0;
746         } else if (cmd == SG_GET_TRANSFORM)
747                 return put_user(test_bit(IDESCSI_SG_TRANSFORM, &scsi->transform), (int __user *) arg);
748         return -EINVAL;
749 }
750
751 static int idescsi_queue (struct scsi_cmnd *cmd,
752                 void (*done)(struct scsi_cmnd *))
753 {
754         struct Scsi_Host *host = cmd->device->host;
755         idescsi_scsi_t *scsi = scsihost_to_idescsi(host);
756         ide_drive_t *drive = scsi->drive;
757         struct request *rq = NULL;
758         struct ide_atapi_pc *pc = NULL;
759
760         if (!drive) {
761                 scmd_printk (KERN_ERR, cmd, "drive not present\n");
762                 goto abort;
763         }
764         scsi = drive_to_idescsi(drive);
765         pc = kmalloc(sizeof(struct ide_atapi_pc), GFP_ATOMIC);
766         rq = kmalloc(sizeof(struct request), GFP_ATOMIC);
767         if (rq == NULL || pc == NULL) {
768                 printk (KERN_ERR "ide-scsi: %s: out of memory\n", drive->name);
769                 goto abort;
770         }
771
772         memset (pc->c, 0, 12);
773         pc->flags = 0;
774         pc->rq = rq;
775         memcpy (pc->c, cmd->cmnd, cmd->cmd_len);
776         pc->buf = NULL;
777         pc->sg = scsi_sglist(cmd);
778         pc->sg_cnt = scsi_sg_count(cmd);
779         pc->b_count = 0;
780         pc->req_xfer = pc->buf_size = scsi_bufflen(cmd);
781         pc->scsi_cmd = cmd;
782         pc->done = done;
783         pc->timeout = jiffies + cmd->timeout_per_command;
784
785         if (test_bit(IDESCSI_LOG_CMD, &scsi->log)) {
786                 printk ("ide-scsi: %s: que %lu, cmd = ", drive->name, cmd->serial_number);
787                 ide_scsi_hex_dump(cmd->cmnd, cmd->cmd_len);
788                 if (memcmp(pc->c, cmd->cmnd, cmd->cmd_len)) {
789                         printk ("ide-scsi: %s: que %lu, tsl = ", drive->name, cmd->serial_number);
790                         ide_scsi_hex_dump(pc->c, 12);
791                 }
792         }
793
794         ide_init_drive_cmd (rq);
795         rq->special = (char *) pc;
796         rq->cmd_type = REQ_TYPE_SPECIAL;
797         spin_unlock_irq(host->host_lock);
798         rq->rq_disk = scsi->disk;
799         (void) ide_do_drive_cmd (drive, rq, ide_end);
800         spin_lock_irq(host->host_lock);
801         return 0;
802 abort:
803         kfree (pc);
804         kfree (rq);
805         cmd->result = DID_ERROR << 16;
806         done(cmd);
807         return 0;
808 }
809
810 static int idescsi_eh_abort (struct scsi_cmnd *cmd)
811 {
812         idescsi_scsi_t *scsi  = scsihost_to_idescsi(cmd->device->host);
813         ide_drive_t    *drive = scsi->drive;
814         int             busy;
815         int             ret   = FAILED;
816
817         /* In idescsi_eh_abort we try to gently pry our command from the ide subsystem */
818
819         if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
820                 printk (KERN_WARNING "ide-scsi: abort called for %lu\n", cmd->serial_number);
821
822         if (!drive) {
823                 printk (KERN_WARNING "ide-scsi: Drive not set in idescsi_eh_abort\n");
824                 WARN_ON(1);
825                 goto no_drive;
826         }
827
828         /* First give it some more time, how much is "right" is hard to say :-( */
829
830         busy = ide_wait_not_busy(HWIF(drive), 100);     /* FIXME - uses mdelay which causes latency? */
831         if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
832                 printk (KERN_WARNING "ide-scsi: drive did%s become ready\n", busy?" not":"");
833
834         spin_lock_irq(&ide_lock);
835
836         /* If there is no pc running we're done (our interrupt took care of it) */
837         if (!scsi->pc) {
838                 ret = SUCCESS;
839                 goto ide_unlock;
840         }
841
842         /* It's somewhere in flight. Does ide subsystem agree? */
843         if (scsi->pc->scsi_cmd->serial_number == cmd->serial_number && !busy &&
844             elv_queue_empty(drive->queue) && HWGROUP(drive)->rq != scsi->pc->rq) {
845                 /*
846                  * FIXME - not sure this condition can ever occur
847                  */
848                 printk (KERN_ERR "ide-scsi: cmd aborted!\n");
849
850                 if (blk_sense_request(scsi->pc->rq))
851                         kfree(scsi->pc->buf);
852                 kfree(scsi->pc->rq);
853                 kfree(scsi->pc);
854                 scsi->pc = NULL;
855
856                 ret = SUCCESS;
857         }
858
859 ide_unlock:
860         spin_unlock_irq(&ide_lock);
861 no_drive:
862         if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
863                 printk (KERN_WARNING "ide-scsi: abort returns %s\n", ret == SUCCESS?"success":"failed");
864
865         return ret;
866 }
867
868 static int idescsi_eh_reset (struct scsi_cmnd *cmd)
869 {
870         struct request *req;
871         idescsi_scsi_t *scsi  = scsihost_to_idescsi(cmd->device->host);
872         ide_drive_t    *drive = scsi->drive;
873         int             ready = 0;
874         int             ret   = SUCCESS;
875
876         /* In idescsi_eh_reset we forcefully remove the command from the ide subsystem and reset the device. */
877
878         if (test_bit(IDESCSI_LOG_CMD, &scsi->log))
879                 printk (KERN_WARNING "ide-scsi: reset called for %lu\n", cmd->serial_number);
880
881         if (!drive) {
882                 printk (KERN_WARNING "ide-scsi: Drive not set in idescsi_eh_reset\n");
883                 WARN_ON(1);
884                 return FAILED;
885         }
886
887         spin_lock_irq(cmd->device->host->host_lock);
888         spin_lock(&ide_lock);
889
890         if (!scsi->pc || (req = scsi->pc->rq) != HWGROUP(drive)->rq || !HWGROUP(drive)->handler) {
891                 printk (KERN_WARNING "ide-scsi: No active request in idescsi_eh_reset\n");
892                 spin_unlock(&ide_lock);
893                 spin_unlock_irq(cmd->device->host->host_lock);
894                 return FAILED;
895         }
896
897         /* kill current request */
898         if (__blk_end_request(req, -EIO, 0))
899                 BUG();
900         if (blk_sense_request(req))
901                 kfree(scsi->pc->buf);
902         kfree(scsi->pc);
903         scsi->pc = NULL;
904         kfree(req);
905
906         /* now nuke the drive queue */
907         while ((req = elv_next_request(drive->queue))) {
908                 if (__blk_end_request(req, -EIO, 0))
909                         BUG();
910         }
911
912         HWGROUP(drive)->rq = NULL;
913         HWGROUP(drive)->handler = NULL;
914         HWGROUP(drive)->busy = 1;               /* will set this to zero when ide reset finished */
915         spin_unlock(&ide_lock);
916
917         ide_do_reset(drive);
918
919         /* ide_do_reset starts a polling handler which restarts itself every 50ms until the reset finishes */
920
921         do {
922                 spin_unlock_irq(cmd->device->host->host_lock);
923                 msleep(50);
924                 spin_lock_irq(cmd->device->host->host_lock);
925         } while ( HWGROUP(drive)->handler );
926
927         ready = drive_is_ready(drive);
928         HWGROUP(drive)->busy--;
929         if (!ready) {
930                 printk (KERN_ERR "ide-scsi: reset failed!\n");
931                 ret = FAILED;
932         }
933
934         spin_unlock_irq(cmd->device->host->host_lock);
935         return ret;
936 }
937
938 static int idescsi_bios(struct scsi_device *sdev, struct block_device *bdev,
939                 sector_t capacity, int *parm)
940 {
941         idescsi_scsi_t *idescsi = scsihost_to_idescsi(sdev->host);
942         ide_drive_t *drive = idescsi->drive;
943
944         if (drive->bios_cyl && drive->bios_head && drive->bios_sect) {
945                 parm[0] = drive->bios_head;
946                 parm[1] = drive->bios_sect;
947                 parm[2] = drive->bios_cyl;
948         }
949         return 0;
950 }
951
952 static struct scsi_host_template idescsi_template = {
953         .module                 = THIS_MODULE,
954         .name                   = "idescsi",
955         .info                   = idescsi_info,
956         .slave_configure        = idescsi_slave_configure,
957         .ioctl                  = idescsi_ioctl,
958         .queuecommand           = idescsi_queue,
959         .eh_abort_handler       = idescsi_eh_abort,
960         .eh_host_reset_handler  = idescsi_eh_reset,
961         .bios_param             = idescsi_bios,
962         .can_queue              = 40,
963         .this_id                = -1,
964         .sg_tablesize           = 256,
965         .cmd_per_lun            = 5,
966         .max_sectors            = 128,
967         .use_clustering         = DISABLE_CLUSTERING,
968         .emulated               = 1,
969         .proc_name              = "ide-scsi",
970 };
971
972 static int ide_scsi_probe(ide_drive_t *drive)
973 {
974         idescsi_scsi_t *idescsi;
975         struct Scsi_Host *host;
976         struct gendisk *g;
977         static int warned;
978         int err = -ENOMEM;
979
980         if (!warned && drive->media == ide_cdrom) {
981                 printk(KERN_WARNING "ide-scsi is deprecated for cd burning! Use ide-cd and give dev=/dev/hdX as device\n");
982                 warned = 1;
983         }
984
985         if (idescsi_nocd && drive->media == ide_cdrom)
986                 return -ENODEV;
987
988         if (!strstr("ide-scsi", drive->driver_req) ||
989             !drive->present ||
990             drive->media == ide_disk ||
991             !(host = scsi_host_alloc(&idescsi_template,sizeof(idescsi_scsi_t))))
992                 return -ENODEV;
993
994         g = alloc_disk(1 << PARTN_BITS);
995         if (!g)
996                 goto out_host_put;
997
998         ide_init_disk(g, drive);
999
1000         host->max_id = 1;
1001
1002 #if IDESCSI_DEBUG_LOG
1003         if (drive->id->last_lun)
1004                 printk(KERN_NOTICE "%s: id->last_lun=%u\n", drive->name, drive->id->last_lun);
1005 #endif
1006         if ((drive->id->last_lun & 0x7) != 7)
1007                 host->max_lun = (drive->id->last_lun & 0x7) + 1;
1008         else
1009                 host->max_lun = 1;
1010
1011         drive->driver_data = host;
1012         idescsi = scsihost_to_idescsi(host);
1013         idescsi->drive = drive;
1014         idescsi->driver = &idescsi_driver;
1015         idescsi->host = host;
1016         idescsi->disk = g;
1017         g->private_data = &idescsi->driver;
1018         ide_proc_register_driver(drive, &idescsi_driver);
1019         err = 0;
1020         idescsi_setup(drive, idescsi);
1021         g->fops = &idescsi_ops;
1022         ide_register_region(g);
1023         err = scsi_add_host(host, &drive->gendev);
1024         if (!err) {
1025                 scsi_scan_host(host);
1026                 return 0;
1027         }
1028         /* fall through on error */
1029         ide_unregister_region(g);
1030         ide_proc_unregister_driver(drive, &idescsi_driver);
1031
1032         put_disk(g);
1033 out_host_put:
1034         scsi_host_put(host);
1035         return err;
1036 }
1037
1038 static int __init init_idescsi_module(void)
1039 {
1040         return driver_register(&idescsi_driver.gen_driver);
1041 }
1042
1043 static void __exit exit_idescsi_module(void)
1044 {
1045         driver_unregister(&idescsi_driver.gen_driver);
1046 }
1047
1048 module_param(idescsi_nocd, int, 0600);
1049 MODULE_PARM_DESC(idescsi_nocd, "Disable handling of CD-ROMs so they may be driven by ide-cd");
1050 module_init(init_idescsi_module);
1051 module_exit(exit_idescsi_module);
1052 MODULE_LICENSE("GPL");