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