dlls/wnaspi32/winaspi32.c

   1 #include <stdlib.h>
   2 #include <sys/types.h>
   3 #include <sys/stat.h>
   4 #include <errno.h>
   5 #include <fcntl.h>
   6 #include <ldt.h>
   7 #include <memory.h>
   8 #include <unistd.h>
   9 #include <callback.h>
  10 #include "windows.h"
  11 #include "aspi.h"
  12 #include "wnaspi32.h"
  13 #include "options.h"
  14 #include "heap.h"
  15 #include "debug.h"
  16 #include "selectors.h"
  17 #include "module.h"
  18 #include "miscemu.h"
  19
  20
  21 /* FIXME!
  22  * 1) Residual byte length reporting not handled
  23  * 2) Make this code re-entrant for multithreading
  24  * 3) Only linux supported so far
  25  */
  26
  27 #ifdef linux
  28 static int
  29 ASPI_OpenDevice32(SRB_ExecSCSICmd32 *prb)
  30 {
  31     int fd;
  32     char        idstr[20];
  33     char        device_str[50];
  34     ASPI_DEVICE_INFO *curr;
  35
  36     /* search list of devices to see if we've opened it already.
  37      * There is not an explicit open/close in ASPI land, so hopefully
  38      * keeping a device open won't be a problem.
  39      */
  40
  41     for (curr = ASPI_open_devices; curr; curr = curr->next) {
  42         if (curr->hostId == prb->SRB_HaId &&
  43             curr->target == prb->SRB_Target &&
  44             curr->lun == prb->SRB_Lun) {
  45             return curr->fd;
  46         }
  47     }
  48
  49     /* device wasn't cached, go ahead and open it */
  50     sprintf(idstr, "scsi c%1dt%1dd%1d", prb->SRB_HaId, prb->SRB_Target, prb->SRB_Lun);
  51
  52     if (!PROFILE_GetWineIniString(idstr, "Device", "", device_str, sizeof(device_str))) {
  53         TRACE(aspi, "Trying to open unlisted scsi device %s\n", idstr);
  54         return -1;
  55     }
  56
  57     TRACE(aspi, "Opening device %s=%s\n", idstr, device_str);
  58
  59     fd = open(device_str, O_RDWR);
  60     if (fd == -1) {
  61         int save_error = errno;
  62 #ifdef HAVE_STRERROR
  63     ERR(aspi, "Error opening device %s, error '%s'\n", device_str, strerror(save_error));
  64 #else
  65     ERR(aspi, "Error opening device %s, error %d\n", device_str, save_error);
  66 #endif
  67         return -1;
  68     }
  69
  70     /* device is now open */
  71     curr = HeapAlloc( SystemHeap, 0, sizeof(ASPI_DEVICE_INFO) );
  72     curr->fd = fd;
  73     curr->hostId = prb->SRB_HaId;
  74     curr->target = prb->SRB_Target;
  75     curr->lun = prb->SRB_Lun;
  76
  77     /* insert new record at beginning of open device list */
  78     curr->next = ASPI_open_devices;
  79     ASPI_open_devices = curr;
  80     return fd;
  81 }
  82
  83
  84 static void
  85 ASPI_DebugPrintCmd32(SRB_ExecSCSICmd32 *prb)
  86 {
  87   BYTE  cmd;
  88   int   i;
  89   BYTE *cdb;
  90   dbg_decl_str(aspi, 512);
  91
  92   switch (prb->CDBByte[0]) {
  93   case CMD_INQUIRY:
  94     TRACE(aspi, "{\n");
  95     TRACE(aspi, "\tEVPD: %d\n", prb->CDBByte[1] & 1);
  96     TRACE(aspi, "\tLUN: %d\n", (prb->CDBByte[1] & 0xc) >> 1);
  97     TRACE(aspi, "\tPAGE CODE: %d\n", prb->CDBByte[2]);
  98     TRACE(aspi, "\tALLOCATION LENGTH: %d\n", prb->CDBByte[4]);
  99     TRACE(aspi, "\tCONTROL: %d\n", prb->CDBByte[5]);
 100     TRACE(aspi, "}\n");
 101     break;
 102   case CMD_SCAN_SCAN:
 103     TRACE(aspi, "Transfer Length: %d\n", prb->CDBByte[4]);
 104     break;
 105   }
 106
 107   TRACE(aspi, "Host Adapter: %d\n", prb->SRB_HaId);
 108   TRACE(aspi, "Flags: %d\n", prb->SRB_Flags);
 109   if (TARGET_TO_HOST(prb)) {
 110     TRACE(aspi, "\tData transfer: Target to host. Length checked.\n");
 111   }
 112   else if (HOST_TO_TARGET(prb)) {
 113     TRACE(aspi, "\tData transfer: Host to target. Length checked.\n");
 114   }
 115   else if (NO_DATA_TRANSFERED(prb)) {
 116     TRACE(aspi, "\tData transfer: none\n");
 117   }
 118   else {
 119     WARN(aspi, "\tTransfer by scsi cmd. Length not checked.\n");
 120   }
 121
 122   TRACE(aspi, "\tResidual byte length reporting %s\n", prb->SRB_Flags & 0x4 ? "enabled" : "disabled");
 123   TRACE(aspi, "\tLinking %s\n", prb->SRB_Flags & 0x2 ? "enabled" : "disabled");
 124   TRACE(aspi, "\tPosting %s\n", prb->SRB_Flags & 0x1 ? "enabled" : "disabled");
 125   TRACE(aspi, "Target: %d\n", prb->SRB_Target);
 126   TRACE(aspi, "Lun: %d\n", prb->SRB_Lun);
 127   TRACE(aspi, "BufLen: %ld\n", prb->SRB_BufLen);
 128   TRACE(aspi, "SenseLen: %d\n", prb->SRB_SenseLen);
 129   TRACE(aspi, "BufPtr: %p\n", prb->SRB_BufPointer);
 130   TRACE(aspi, "CDB Length: %d\n", prb->SRB_CDBLen);
 131   TRACE(aspi, "POST Proc: %lx\n", (DWORD) prb->SRB_PostProc);
 132   cdb = &prb->CDBByte[0];
 133   cmd = prb->CDBByte[0];
 134   for (i = 0; i < prb->SRB_CDBLen; i++) {
 135     if (i != 0) dsprintf(aspi, ",");
 136     dsprintf(aspi, "%02x", *cdb++);
 137   }
 138   TRACE(aspi, "CDB buffer[%s]\n", dbg_str(aspi));
 139 }
 140
 141 static void
 142 ASPI_PrintSenseArea32(SRB_ExecSCSICmd32 *prb)
 143 {
 144   int   i;
 145   BYTE *cdb;
 146   dbg_decl_str(aspi, 512);
 147
 148   cdb = &prb->CDBByte[0];
 149   for (i = 0; i < prb->SRB_SenseLen; i++) {
 150     if (i) dsprintf(aspi, ",");
 151     dsprintf(aspi, "%02x", *cdb++);
 152   }
 153   TRACE(aspi, "SenseArea[%s]\n", dbg_str(aspi));
 154 }
 155
 156 static void
 157 ASPI_DebugPrintResult32(SRB_ExecSCSICmd32 *prb)
 158 {
 159
 160   switch (prb->CDBByte[0]) {
 161   case CMD_INQUIRY:
 162     TRACE(aspi, "Vendor: '%s'\n", prb->SRB_BufPointer + INQUIRY_VENDOR);
 163     break;
 164   case CMD_TEST_UNIT_READY:
 165     ASPI_PrintSenseArea32(prb);
 166     break;
 167   }
 168 }
 169
 170 static WORD
 171 ASPI_ExecScsiCmd32(SRB_ExecSCSICmd32 *lpPRB)
 172 {
 173   struct sg_header *sg_hd, *sg_reply_hdr;
 174   int   status;
 175   int   in_len, out_len;
 176   int   error_code = 0;
 177   int   fd;
 178
 179   ASPI_DebugPrintCmd32(lpPRB);
 180
 181   fd = ASPI_OpenDevice32(lpPRB);
 182   if (fd == -1) {
 183       ERR(aspi, "Failed: could not open device. Device permissions !?\n");
 184       lpPRB->SRB_Status = SS_ERR;
 185       return SS_ERR;
 186   }
 187
 188   sg_hd = NULL;
 189   sg_reply_hdr = NULL;
 190
 191   lpPRB->SRB_Status = SS_PENDING;
 192
 193   if (!lpPRB->SRB_CDBLen) {
 194       WARN(aspi, "Failed: lpPRB->SRB_CDBLen = 0.\n");
 195       lpPRB->SRB_Status = SS_ERR;
 196       return SS_ERR;
 197   }
 198
 199   /* build up sg_header + scsi cmd */
 200   if (HOST_TO_TARGET(lpPRB)) {
 201     /* send header, command, and then data */
 202     in_len = SCSI_OFF + lpPRB->SRB_CDBLen + lpPRB->SRB_BufLen;
 203     sg_hd = (struct sg_header *) malloc(in_len);
 204     memset(sg_hd, 0, SCSI_OFF);
 205     memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
 206     if (lpPRB->SRB_BufLen) {
 207       memcpy(((BYTE *) sg_hd) + SCSI_OFF + lpPRB->SRB_CDBLen, lpPRB->SRB_BufPointer, lpPRB->SRB_BufLen);
 208     }
 209   }
 210   else {
 211     /* send header and command - no data */
 212     in_len = SCSI_OFF + lpPRB->SRB_CDBLen;
 213     sg_hd = (struct sg_header *) malloc(in_len);
 214     memset(sg_hd, 0, SCSI_OFF);
 215     memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
 216   }
 217
 218   if (TARGET_TO_HOST(lpPRB)) {
 219     out_len = SCSI_OFF + lpPRB->SRB_BufLen;
 220     sg_reply_hdr = (struct sg_header *) malloc(out_len);
 221     memset(sg_reply_hdr, 0, SCSI_OFF);
 222     sg_hd->reply_len = out_len;
 223   }
 224   else {
 225     out_len = SCSI_OFF;
 226     sg_reply_hdr = (struct sg_header *) malloc(out_len);
 227     memset(sg_reply_hdr, 0, SCSI_OFF);
 228     sg_hd->reply_len = out_len;
 229   }
 230
 231   status = write(fd, sg_hd, in_len);
 232   if (status < 0 || status != in_len) {
 233       int save_error = errno;
 234
 235     WARN(aspi, "Not enough bytes written to scsi device bytes=%d .. %d\n", in_len, status);
 236     if (status < 0) {
 237                 if (save_error == ENOMEM) {
 238             MSG("ASPI: Linux generic scsi driver\n  You probably need to re-compile your kernel with a larger SG_BIG_BUFF value (sg.h)\n  Suggest 130560\n");
 239         }
 240 #ifdef HAVE_STRERROR
 241                 WARN(aspi, "error:= '%s'\n", strerror(save_error));
 242 #else
 243                 WARN(aspi, "error:= %d\n", save_error);
 244 #endif
 245     }
 246     goto error_exit;
 247   }
 248
 249   status = read(fd, sg_reply_hdr, out_len);
 250   if (status < 0 || status != out_len) {
 251     WARN(aspi, "not enough bytes read from scsi device%d\n", status);
 252     goto error_exit;
 253   }
 254
 255   if (sg_reply_hdr->result != 0) {
 256     error_code = sg_reply_hdr->result;
 257     WARN(aspi, "reply header error (%d)\n", sg_reply_hdr->result);
 258     goto error_exit;
 259   }
 260
 261   if (TARGET_TO_HOST(lpPRB) && lpPRB->SRB_BufLen) {
 262     memcpy(lpPRB->SRB_BufPointer, sg_reply_hdr + 1, lpPRB->SRB_BufLen);
 263   }
 264
 265   /* copy in sense buffer to amount that is available in client */
 266   if (lpPRB->SRB_SenseLen) {
 267     int sense_len = lpPRB->SRB_SenseLen;
 268     if (lpPRB->SRB_SenseLen > 16)
 269       sense_len = 16;
 270     memcpy(SENSE_BUFFER(lpPRB), &sg_reply_hdr->sense_buffer[0], sense_len);
 271   }
 272
 273
 274   lpPRB->SRB_Status = SS_COMP;
 275   lpPRB->SRB_HaStat = HASTAT_OK;
 276   lpPRB->SRB_TargStat = STATUS_GOOD;
 277
 278   /* now do posting */
 279
 280   if (lpPRB->SRB_PostProc) {
 281     if (ASPI_POSTING(lpPRB)) {
 282       TRACE(aspi, "Post Routine (%lx) called\n", (DWORD) lpPRB->SRB_PostProc);
 283       (*lpPRB->SRB_PostProc)(lpPRB);
 284     }
 285     else
 286     if (lpPRB->SRB_Flags & SRB_EVENT_NOTIFY) {
 287       TRACE(aspi, "Setting event %04x\n", (HANDLE32)lpPRB->SRB_PostProc);
 288       SetEvent((HANDLE32)lpPRB->SRB_PostProc); /* FIXME: correct ? */
 289     }
 290   }
 291   free(sg_reply_hdr);
 292   free(sg_hd);
 293   ASPI_DebugPrintResult32(lpPRB);
 294   return SS_COMP;
 295
 296 error_exit:
 297   if (error_code == EBUSY) {
 298       lpPRB->SRB_Status = SS_ASPI_IS_BUSY;
 299       TRACE(aspi, "Device busy\n");
 300   }
 301   else {
 302       WARN(aspi, "Failed\n");
 303       lpPRB->SRB_Status = SS_ERR;
 304   }
 305
 306   /* I'm not sure exactly error codes work here
 307    * We probably should set lpPRB->SRB_TargStat, SRB_HaStat ?
 308    */
 309   WARN(aspi, "error_exit\n");
 310   free(sg_reply_hdr);
 311   free(sg_hd);
 312   return lpPRB->SRB_Status;
 313 }
 314 #endif
 315
 316
 317 /*******************************************************************
 318  *     GetASPI32SupportInfo32           [WNASPI32.0]
 319  *
 320  * Checks if the ASPI subsystem is initialized correctly.
 321  *
 322  * RETURNS
 323  *    HIWORD: 0.
 324  *    HIBYTE of LOWORD: status (SS_COMP or SS_FAILED_INIT)
 325  *    LOBYTE of LOWORD: # of host adapters.
 326  */
 327 DWORD WINAPI GetASPI32SupportInfo32()
 328 {
 329     return ((SS_COMP << 8) | 1); /* FIXME: get # of host adapters installed */
 330 }
 331
 332
 333 /***********************************************************************
 334  *             SendASPI32Command32 (WNASPI32.1)
 335  */
 336 DWORD WINAPI SendASPI32Command32(LPSRB32 lpSRB)
 337 {
 338 #ifdef linux
 339   switch (lpSRB->common.SRB_Cmd) {
 340   case SC_HA_INQUIRY:
 341     lpSRB->inquiry.SRB_Status = SS_COMP;       /* completed successfully */
 342     lpSRB->inquiry.HA_Count = 1;               /* not always */
 343     lpSRB->inquiry.HA_SCSI_ID = 7;             /* not always ID 7 */
 344     strcat(lpSRB->inquiry.HA_ManagerId, "ASPI for WIN32"); /* max 15 chars, don't change */
 345     strcat(lpSRB->inquiry.HA_Identifier, "Wine host"); /* FIXME: return host adapter name */
 346     memset(lpSRB->inquiry.HA_Unique, 0, 16); /* default HA_Unique content */
 347     lpSRB->inquiry.HA_Unique[6] = 0x02; /* Maximum Transfer Length (128K, Byte> 4-7) */
 348     FIXME(aspi, "ASPI: Partially implemented SC_HA_INQUIRY for adapter %d.\n", lpSRB->inquiry.SRB_HaId);
 349     return SS_COMP;
 350   case SC_GET_DEV_TYPE:
 351     FIXME(aspi, "Not implemented SC_GET_DEV_TYPE\n");
 352     break;
 353   case SC_EXEC_SCSI_CMD:
 354     return ASPI_ExecScsiCmd32(&lpSRB->cmd);
 355     break;
 356   case SC_RESET_DEV:
 357     FIXME(aspi, "Not implemented SC_RESET_DEV\n");
 358     break;
 359   default:
 360     WARN(aspi, "Unknown command %d\n", lpSRB->common.SRB_Cmd);
 361   }
 362   return SS_INVALID_SRB;
 363 #else
 364   return SS_INVALID_SRB;
 365 #endif
 366 }
 367
 368
 369 /***********************************************************************
 370  *             GetASPI32DLLVersion32   (WNASPI32.3)
 371  */
 372
 373 DWORD WINAPI GetASPI32DLLVersion32()
 374 {
 375 #ifdef linux
 376         return (DWORD)1;
 377 #else
 378         return (DWORD)0;
 379 #endif
 380 }
 381