arch/ia64/hp/sim/simscsi.c

   1 /*
   2  * Simulated SCSI driver.
   3  *
   4  * Copyright (C) 1999, 2001-2003 Hewlett-Packard Co
   5  *      David Mosberger-Tang <davidm@hpl.hp.com>
   6  *      Stephane Eranian <eranian@hpl.hp.com>
   7  *
   8  * 02/01/15 David Mosberger     Updated for v2.5.1
   9  * 99/12/18 David Mosberger     Added support for READ10/WRITE10 needed by linux v2.3.33
  10  */
  11 #include <linux/config.h>
  12 #include <linux/blk.h>
  13 #include <linux/init.h>
  14 #include <linux/interrupt.h>
  15 #include <linux/kernel.h>
  16 #include <linux/timer.h>
  17
  18 #include <scsi/scsi.h>
  19
  20 #include <asm/irq.h>
  21
  22 #include "../drivers/scsi/scsi.h"
  23 #include "../drivers/scsi/hosts.h"
  24 #include "simscsi.h"
  25
  26 #define DEBUG_SIMSCSI   0
  27
  28 /* Simulator system calls: */
  29
  30 #define SSC_OPEN                        50
  31 #define SSC_CLOSE                       51
  32 #define SSC_READ                        52
  33 #define SSC_WRITE                       53
  34 #define SSC_GET_COMPLETION              54
  35 #define SSC_WAIT_COMPLETION             55
  36
  37 #define SSC_WRITE_ACCESS                2
  38 #define SSC_READ_ACCESS                 1
  39
  40 #if DEBUG_SIMSCSI
  41   int simscsi_debug;
  42 # define DBG    simscsi_debug
  43 #else
  44 # define DBG    0
  45 #endif
  46
  47 static struct Scsi_Host *host;
  48
  49 static void simscsi_interrupt (unsigned long val);
  50 DECLARE_TASKLET(simscsi_tasklet, simscsi_interrupt, 0);
  51
  52 struct disk_req {
  53         unsigned long addr;
  54         unsigned len;
  55 };
  56
  57 struct disk_stat {
  58         int fd;
  59         unsigned count;
  60 };
  61
  62 extern long ia64_ssc (long arg0, long arg1, long arg2, long arg3, int nr);
  63
  64 static int desc[16] = {
  65         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1
  66 };
  67
  68 static struct queue_entry {
  69         Scsi_Cmnd *sc;
  70 } queue[SIMSCSI_REQ_QUEUE_LEN];
  71
  72 static int rd, wr;
  73 static atomic_t num_reqs = ATOMIC_INIT(0);
  74
  75 /* base name for default disks */
  76 static char *simscsi_root = DEFAULT_SIMSCSI_ROOT;
  77
  78 #define MAX_ROOT_LEN    128
  79
  80 /*
  81  * used to setup a new base for disk images
  82  * to use /foo/bar/disk[a-z] as disk images
  83  * you have to specify simscsi=/foo/bar/disk on the command line
  84  */
  85 static int __init
  86 simscsi_setup (char *s)
  87 {
  88         /* XXX Fix me we may need to strcpy() ? */
  89         if (strlen(s) > MAX_ROOT_LEN) {
  90                 printk(KERN_ERR "simscsi_setup: prefix too long---using default %s\n",
  91                        simscsi_root);
  92         }
  93         simscsi_root = s;
  94         return 1;
  95 }
  96
  97 __setup("simscsi=", simscsi_setup);
  98
  99 static void
 100 simscsi_interrupt (unsigned long val)
 101 {
 102         Scsi_Cmnd *sc;
 103
 104         while ((sc = queue[rd].sc) != 0) {
 105                 atomic_dec(&num_reqs);
 106                 queue[rd].sc = 0;
 107                 if (DBG)
 108                         printk("simscsi_interrupt: done with %ld\n", sc->serial_number);
 109                 (*sc->scsi_done)(sc);
 110                 rd = (rd + 1) % SIMSCSI_REQ_QUEUE_LEN;
 111         }
 112 }
 113
 114 int
 115 simscsi_detect (Scsi_Host_Template *templ)
 116 {
 117         templ->proc_name = "simscsi";
 118         host = scsi_register(templ, 0);
 119         if(host == NULL)
 120                 return 0;
 121
 122         return 1;       /* fake one SCSI host adapter */
 123 }
 124
 125 int
 126 simscsi_release (struct Scsi_Host *host)
 127 {
 128         return 0;       /* this is easy...  */
 129 }
 130
 131 const char *
 132 simscsi_info (struct Scsi_Host *host)
 133 {
 134         return "simulated SCSI host adapter";
 135 }
 136
 137 int
 138 simscsi_biosparam (struct scsi_device *sdev, struct block_device *n,
 139                 sector_t capacity, int ip[])
 140 {
 141         ip[0] = 64;             /* heads */
 142         ip[1] = 32;             /* sectors */
 143         ip[2] = capacity >> 11; /* cylinders */
 144         return 0;
 145 }
 146
 147 static void
 148 simscsi_readwrite (Scsi_Cmnd *sc, int mode, unsigned long offset, unsigned long len)
 149 {
 150         struct disk_stat stat;
 151         struct disk_req req;
 152
 153         req.addr = __pa(sc->request_buffer);
 154         req.len  = len;                 /* # of bytes to transfer */
 155
 156         if (sc->request_bufflen < req.len)
 157                 return;
 158
 159         stat.fd = desc[sc->device->id];
 160         if (DBG)
 161                 printk("simscsi_%s @ %lx (off %lx)\n",
 162                        mode == SSC_READ ? "read":"write", req.addr, offset);
 163         ia64_ssc(stat.fd, 1, __pa(&req), offset, mode);
 164         ia64_ssc(__pa(&stat), 0, 0, 0, SSC_WAIT_COMPLETION);
 165
 166         if (stat.count == req.len) {
 167                 sc->result = GOOD;
 168         } else {
 169                 sc->result = DID_ERROR << 16;
 170         }
 171 }
 172
 173 static void
 174 simscsi_sg_readwrite (Scsi_Cmnd *sc, int mode, unsigned long offset)
 175 {
 176         int list_len = sc->use_sg;
 177         struct scatterlist *sl = (struct scatterlist *)sc->buffer;
 178         struct disk_stat stat;
 179         struct disk_req req;
 180
 181         stat.fd = desc[sc->device->id];
 182
 183         while (list_len) {
 184                 req.addr = __pa(page_address(sl->page) + sl->offset);
 185                 req.len  = sl->length;
 186                 if (DBG)
 187                         printk("simscsi_sg_%s @ %lx (off %lx) use_sg=%d len=%d\n",
 188                                mode == SSC_READ ? "read":"write", req.addr, offset,
 189                                list_len, sl->length);
 190                 ia64_ssc(stat.fd, 1, __pa(&req), offset, mode);
 191                 ia64_ssc(__pa(&stat), 0, 0, 0, SSC_WAIT_COMPLETION);
 192
 193                 /* should not happen in our case */
 194                 if (stat.count != req.len) {
 195                         sc->result = DID_ERROR << 16;
 196                         return;
 197                 }
 198                 offset +=  sl->length;
 199                 sl++;
 200                 list_len--;
 201         }
 202         sc->result = GOOD;
 203 }
 204
 205 /*
 206  * function handling both READ_6/WRITE_6 (non-scatter/gather mode)
 207  * commands.
 208  * Added 02/26/99 S.Eranian
 209  */
 210 static void
 211 simscsi_readwrite6 (Scsi_Cmnd *sc, int mode)
 212 {
 213         unsigned long offset;
 214
 215         offset = (((sc->cmnd[1] & 0x1f) << 16) | (sc->cmnd[2] << 8) | sc->cmnd[3])*512;
 216         if (sc->use_sg > 0)
 217                 simscsi_sg_readwrite(sc, mode, offset);
 218         else
 219                 simscsi_readwrite(sc, mode, offset, sc->cmnd[4]*512);
 220 }
 221
 222 static size_t
 223 simscsi_get_disk_size (int fd)
 224 {
 225         struct disk_stat stat;
 226         size_t bit, sectors = 0;
 227         struct disk_req req;
 228         char buf[512];
 229
 230         /*
 231          * This is a bit kludgey: the simulator doesn't provide a direct way of determining
 232          * the disk size, so we do a binary search, assuming a maximum disk size of 4GB.
 233          */
 234         for (bit = (4UL << 30)/512; bit != 0; bit >>= 1) {
 235                 req.addr = __pa(&buf);
 236                 req.len = sizeof(buf);
 237                 ia64_ssc(fd, 1, __pa(&req), ((sectors | bit) - 1)*512, SSC_READ);
 238                 stat.fd = fd;
 239                 ia64_ssc(__pa(&stat), 0, 0, 0, SSC_WAIT_COMPLETION);
 240                 if (stat.count == sizeof(buf))
 241                         sectors |= bit;
 242         }
 243         return sectors - 1;     /* return last valid sector number */
 244 }
 245
 246 static void
 247 simscsi_readwrite10 (Scsi_Cmnd *sc, int mode)
 248 {
 249         unsigned long offset;
 250
 251         offset = (  (sc->cmnd[2] << 24) | (sc->cmnd[3] << 16)
 252                   | (sc->cmnd[4] <<  8) | (sc->cmnd[5] <<  0))*512;
 253         if (sc->use_sg > 0)
 254                 simscsi_sg_readwrite(sc, mode, offset);
 255         else
 256                 simscsi_readwrite(sc, mode, offset, ((sc->cmnd[7] << 8) | sc->cmnd[8])*512);
 257 }
 258
 259 int
 260 simscsi_queuecommand (Scsi_Cmnd *sc, void (*done)(Scsi_Cmnd *))
 261 {
 262         unsigned int target_id = sc->device->id;
 263         char fname[MAX_ROOT_LEN+16];
 264         size_t disk_size;
 265         char *buf;
 266 #if DEBUG_SIMSCSI
 267         register long sp asm ("sp");
 268
 269         if (DBG)
 270                 printk("simscsi_queuecommand: target=%d,cmnd=%u,sc=%lu,sp=%lx,done=%p\n",
 271                        target_id, sc->cmnd[0], sc->serial_number, sp, done);
 272 #endif
 273
 274         sc->result = DID_BAD_TARGET << 16;
 275         sc->scsi_done = done;
 276         if (target_id <= 15 && sc->device->lun == 0) {
 277                 switch (sc->cmnd[0]) {
 278                       case INQUIRY:
 279                         if (sc->request_bufflen < 35) {
 280                                 break;
 281                         }
 282                         sprintf (fname, "%s%c", simscsi_root, 'a' + target_id);
 283                         desc[target_id] = ia64_ssc(__pa(fname), SSC_READ_ACCESS|SSC_WRITE_ACCESS,
 284                                                    0, 0, SSC_OPEN);
 285                         if (desc[target_id] < 0) {
 286                                 /* disk doesn't exist... */
 287                                 break;
 288                         }
 289                         buf = sc->request_buffer;
 290                         buf[0] = 0;     /* magnetic disk */
 291                         buf[1] = 0;     /* not a removable medium */
 292                         buf[2] = 2;     /* SCSI-2 compliant device */
 293                         buf[3] = 2;     /* SCSI-2 response data format */
 294                         buf[4] = 31;    /* additional length (bytes) */
 295                         buf[5] = 0;     /* reserved */
 296                         buf[6] = 0;     /* reserved */
 297                         buf[7] = 0;     /* various flags */
 298                         memcpy(buf + 8, "HP      SIMULATED DISK  0.00",  28);
 299                         sc->result = GOOD;
 300                         break;
 301
 302                       case TEST_UNIT_READY:
 303                         sc->result = GOOD;
 304                         break;
 305
 306                       case READ_6:
 307                         if (desc[target_id] < 0 )
 308                                 break;
 309                         simscsi_readwrite6(sc, SSC_READ);
 310                         break;
 311
 312                       case READ_10:
 313                         if (desc[target_id] < 0 )
 314                                 break;
 315                         simscsi_readwrite10(sc, SSC_READ);
 316                         break;
 317
 318                       case WRITE_6:
 319                         if (desc[target_id] < 0)
 320                                 break;
 321                         simscsi_readwrite6(sc, SSC_WRITE);
 322                         break;
 323
 324                       case WRITE_10:
 325                         if (desc[target_id] < 0)
 326                                 break;
 327                         simscsi_readwrite10(sc, SSC_WRITE);
 328                         break;
 329
 330
 331                       case READ_CAPACITY:
 332                         if (desc[target_id] < 0 || sc->request_bufflen < 8) {
 333                                 break;
 334                         }
 335                         buf = sc->request_buffer;
 336
 337                         disk_size = simscsi_get_disk_size(desc[target_id]);
 338
 339                         /* pretend to be a 1GB disk (partition table contains real stuff): */
 340                         buf[0] = (disk_size >> 24) & 0xff;
 341                         buf[1] = (disk_size >> 16) & 0xff;
 342                         buf[2] = (disk_size >>  8) & 0xff;
 343                         buf[3] = (disk_size >>  0) & 0xff;
 344                         /* set block size of 512 bytes: */
 345                         buf[4] = 0;
 346                         buf[5] = 0;
 347                         buf[6] = 2;
 348                         buf[7] = 0;
 349                         sc->result = GOOD;
 350                         break;
 351
 352                       case MODE_SENSE:
 353                       case MODE_SENSE_10:
 354                         /* sd.c uses this to determine whether disk does write-caching. */
 355                         memset(sc->request_buffer, 0, 128);
 356                         sc->result = GOOD;
 357                         break;
 358
 359                       case START_STOP:
 360                         printk(KERN_ERR "START_STOP\n");
 361                         break;
 362
 363                       default:
 364                         panic("simscsi: unknown SCSI command %u\n", sc->cmnd[0]);
 365                 }
 366         }
 367         if (sc->result == DID_BAD_TARGET) {
 368                 sc->result |= DRIVER_SENSE << 24;
 369                 sc->sense_buffer[0] = 0x70;
 370                 sc->sense_buffer[2] = 0x00;
 371         }
 372         if (atomic_read(&num_reqs) >= SIMSCSI_REQ_QUEUE_LEN) {
 373                 panic("Attempt to queue command while command is pending!!");
 374         }
 375         atomic_inc(&num_reqs);
 376         queue[wr].sc = sc;
 377         wr = (wr + 1) % SIMSCSI_REQ_QUEUE_LEN;
 378
 379         tasklet_schedule(&simscsi_tasklet);
 380         return 0;
 381 }
 382
 383 int
 384 simscsi_host_reset (Scsi_Cmnd *sc)
 385 {
 386         printk(KERN_ERR "simscsi_host_reset: not implemented\n");
 387         return 0;
 388 }
 389
 390 static Scsi_Host_Template driver_template = {
 391         .name                   = "simscsi",
 392         .detect                 = simscsi_detect,
 393         .release                = simscsi_release,
 394         .info                   = simscsi_info,
 395         .queuecommand           = simscsi_queuecommand,
 396         .eh_host_reset_handler  = simscsi_host_reset,
 397         .bios_param             = simscsi_biosparam,
 398         .can_queue              = SIMSCSI_REQ_QUEUE_LEN,
 399         .this_id                = -1,
 400         .sg_tablesize           = SG_ALL,
 401         .max_sectors            = 1024,
 402         .cmd_per_lun            = SIMSCSI_REQ_QUEUE_LEN,
 403         .use_clustering         = DISABLE_CLUSTERING,
 404 };
 405 #include "../drivers/scsi/scsi_module.c"