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