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