git.oblomov.eu Git - wine/blob - dlls/wnaspi32/winaspi32.c

   1 #include "config.h"
   2
   3 #include <stdlib.h>
   4 #include <sys/types.h>
   5 #include <sys/stat.h>
   6 #include <errno.h>
   7 #include <fcntl.h>
   8 #include <memory.h>
   9 #include <unistd.h>
  10
  11 #include "winbase.h"
  12 #include "aspi.h"
  13 #include "wnaspi32.h"
  14 #include "options.h"
  15 #include "heap.h"
  16 #include "debugtools.h"
  17 #include "ldt.h"
  18 #include "callback.h"
  19
  20 DEFAULT_DEBUG_CHANNEL(aspi)
  21
  22 /* FIXME!
  23  * 1) Residual byte length reporting not handled
  24  * 2) Make this code re-entrant for multithreading
  25  *    -- Added CriticalSection to OpenDevices function
  26  * 3) Only linux supported so far
  27  * 4) Leaves sg devices open. This may or may not be okay.  A better solution
  28  *    would be to close the file descriptors when the thread/process using
  29  *    them no longer needs them.
  30  */
  31
  32 #ifdef linux
  33
  34 static ASPI_DEVICE_INFO *ASPI_open_devices = NULL;
  35 static CRITICAL_SECTION ASPI_CritSection;
  36
  37 #endif /* defined(linux) */
  38
  39
  40 BOOL WINAPI WNASPI32_LibMain(HINSTANCE hInstDLL, DWORD fdwReason, LPVOID fImpLoad)
  41 {
  42 #ifdef linux
  43         static BOOL     bInitDone=FALSE;
  44 #if 0
  45         TRACE("0x%x 0x%1x %p\n", hInstDLL, fdwReason, fImpLoad);
  46 #endif
  47         switch( fdwReason )
  48         {
  49         case DLL_PROCESS_ATTACH:
  50                 /* Create instance data */
  51                 if(!bInitDone)
  52                 {
  53                         /* Initialize global stuff just once */
  54                         InitializeCriticalSection(&ASPI_CritSection);
  55                         bInitDone=TRUE;
  56                 }
  57                 break;
  58         case DLL_PROCESS_DETACH:
  59                 /* Destroy instance data */
  60                 break;
  61         case DLL_THREAD_ATTACH:
  62         case DLL_THREAD_DETACH:
  63                 break;
  64         }
  65         return TRUE;
  66 #else /* defined(linux) */
  67         return TRUE;
  68 #endif /* defined(linux) */
  69 }
  70
  71 #ifdef linux
  72
  73 static int
  74 ASPI_OpenDevice(SRB_ExecSCSICmd *prb)
  75 {
  76     int fd;
  77     char        idstr[20];
  78     char        device_str[50];
  79     ASPI_DEVICE_INFO *curr;
  80
  81     /* search list of devices to see if we've opened it already.
  82      * There is not an explicit open/close in ASPI land, so hopefully
  83      * keeping a device open won't be a problem.
  84      */
  85
  86     EnterCriticalSection(&ASPI_CritSection);
  87     for (curr = ASPI_open_devices; curr; curr = curr->next) {
  88         if (curr->hostId == prb->SRB_HaId &&
  89             curr->target == prb->SRB_Target &&
  90             curr->lun == prb->SRB_Lun) {
  91             LeaveCriticalSection(&ASPI_CritSection);
  92             return curr->fd;
  93         }
  94     }
  95     LeaveCriticalSection(&ASPI_CritSection);
  96
  97     /* device wasn't cached, go ahead and open it */
  98     sprintf(idstr, "scsi c%1dt%1dd%1d", prb->SRB_HaId, prb->SRB_Target, prb->SRB_Lun);
  99
 100     if (!PROFILE_GetWineIniString(idstr, "Device", "", device_str, sizeof(device_str))) {
 101         TRACE("Trying to open unlisted scsi device %s\n", idstr);
 102         return -1;
 103     }
 104
 105     TRACE("Opening device %s=%s\n", idstr, device_str);
 106
 107     fd = open(device_str, O_RDWR);
 108     if (fd == -1) {
 109         int save_error = errno;
 110 #ifdef HAVE_STRERROR
 111     ERR("Error opening device %s, error '%s'\n", device_str, strerror(save_error));
 112 #else
 113     ERR("Error opening device %s, error %d\n", device_str, save_error);
 114 #endif
 115         return -1;
 116     }
 117
 118     /* device is now open */
 119     curr = HeapAlloc( SystemHeap, 0, sizeof(ASPI_DEVICE_INFO) );
 120     curr->fd = fd;
 121     curr->hostId = prb->SRB_HaId;
 122     curr->target = prb->SRB_Target;
 123     curr->lun = prb->SRB_Lun;
 124
 125     /* insert new record at beginning of open device list */
 126     EnterCriticalSection(&ASPI_CritSection);
 127     curr->next = ASPI_open_devices;
 128     ASPI_open_devices = curr;
 129     LeaveCriticalSection(&ASPI_CritSection);
 130     return fd;
 131 }
 132
 133
 134 static void
 135 ASPI_DebugPrintCmd(SRB_ExecSCSICmd *prb)
 136 {
 137   BYTE  cmd;
 138   int   i;
 139   BYTE *cdb;
 140
 141   switch (prb->CDBByte[0]) {
 142   case CMD_INQUIRY:
 143     TRACE("{\n");
 144     TRACE("\tEVPD: %d\n", prb->CDBByte[1] & 1);
 145     TRACE("\tLUN: %d\n", (prb->CDBByte[1] & 0xc) >> 1);
 146     TRACE("\tPAGE CODE: %d\n", prb->CDBByte[2]);
 147     TRACE("\tALLOCATION LENGTH: %d\n", prb->CDBByte[4]);
 148     TRACE("\tCONTROL: %d\n", prb->CDBByte[5]);
 149     TRACE("}\n");
 150     break;
 151   case CMD_SCAN_SCAN:
 152     TRACE("Transfer Length: %d\n", prb->CDBByte[4]);
 153     break;
 154   }
 155
 156   TRACE("Host Adapter: %d\n", prb->SRB_HaId);
 157   TRACE("Flags: %d\n", prb->SRB_Flags);
 158   if (TARGET_TO_HOST(prb)) {
 159     TRACE("\tData transfer: Target to host. Length checked.\n");
 160   }
 161   else if (HOST_TO_TARGET(prb)) {
 162     TRACE("\tData transfer: Host to target. Length checked.\n");
 163   }
 164   else if (NO_DATA_TRANSFERED(prb)) {
 165     TRACE("\tData transfer: none\n");
 166   }
 167   else {
 168     WARN("\tTransfer by scsi cmd. Length not checked.\n");
 169   }
 170
 171   TRACE("\tResidual byte length reporting %s\n", prb->SRB_Flags & 0x4 ? "enabled" : "disabled");
 172   TRACE("\tLinking %s\n", prb->SRB_Flags & 0x2 ? "enabled" : "disabled");
 173   TRACE("\tPosting %s\n", prb->SRB_Flags & 0x1 ? "enabled" : "disabled");
 174   TRACE("Target: %d\n", prb->SRB_Target);
 175   TRACE("Lun: %d\n", prb->SRB_Lun);
 176   TRACE("BufLen: %ld\n", prb->SRB_BufLen);
 177   TRACE("SenseLen: %d\n", prb->SRB_SenseLen);
 178   TRACE("BufPtr: %p\n", prb->SRB_BufPointer);
 179   TRACE("CDB Length: %d\n", prb->SRB_CDBLen);
 180   TRACE("POST Proc: %lx\n", (DWORD) prb->SRB_PostProc);
 181   cdb = &prb->CDBByte[0];
 182   cmd = prb->CDBByte[0];
 183   if (TRACE_ON(aspi))
 184   {
 185       DPRINTF("CDB buffer[");
 186       for (i = 0; i < prb->SRB_CDBLen; i++) {
 187           if (i != 0) DPRINTF(",");
 188           DPRINTF("%02x", *cdb++);
 189       }
 190       DPRINTF("]\n");
 191   }
 192 }
 193
 194 static void
 195 ASPI_PrintSenseArea(SRB_ExecSCSICmd *prb)
 196 {
 197   int   i;
 198   BYTE *cdb;
 199
 200   if (TRACE_ON(aspi))
 201   {
 202       cdb = &prb->CDBByte[16];
 203       DPRINTF("SenseArea[");
 204       for (i = 0; i < prb->SRB_SenseLen; i++) {
 205           if (i) DPRINTF(",");
 206           DPRINTF("%02x", *cdb++);
 207       }
 208       DPRINTF("]\n");
 209   }
 210 }
 211
 212 static void
 213 ASPI_DebugPrintResult(SRB_ExecSCSICmd *prb)
 214 {
 215
 216   TRACE("SRB_Status: %x\n", prb->SRB_Status);
 217   TRACE("SRB_HaStat: %x\n", prb->SRB_HaStat);
 218   TRACE("SRB_TargStat: %x\n", prb->SRB_TargStat);
 219   switch (prb->CDBByte[0]) {
 220   case CMD_INQUIRY:
 221     TRACE("Vendor: '%s'\n", prb->SRB_BufPointer + INQUIRY_VENDOR);
 222     break;
 223   case CMD_TEST_UNIT_READY:
 224     ASPI_PrintSenseArea(prb);
 225     break;
 226   }
 227 }
 228
 229 static WORD
 230 ASPI_ExecScsiCmd(SRB_ExecSCSICmd *lpPRB)
 231 {
 232   struct sg_header *sg_hd, *sg_reply_hdr;
 233   int   status;
 234   int   in_len, out_len;
 235   int   error_code = 0;
 236   int   fd;
 237
 238   ASPI_DebugPrintCmd(lpPRB);
 239
 240   fd = ASPI_OpenDevice(lpPRB);
 241   if (fd == -1) {
 242       ERR("Failed: could not open device c%01dt%01dd%01d. Device permissions !?\n",
 243           lpPRB->SRB_HaId,lpPRB->SRB_Target,lpPRB->SRB_Lun);
 244       lpPRB->SRB_Status = SS_NO_DEVICE;
 245       return SS_NO_DEVICE;
 246   }
 247
 248   sg_hd = NULL;
 249   sg_reply_hdr = NULL;
 250
 251   lpPRB->SRB_Status = SS_PENDING;
 252
 253   if (!lpPRB->SRB_CDBLen) {
 254       WARN("Failed: lpPRB->SRB_CDBLen = 0.\n");
 255       lpPRB->SRB_Status = SS_ERR;
 256       return SS_ERR;
 257   }
 258
 259   /* build up sg_header + scsi cmd */
 260   if (HOST_TO_TARGET(lpPRB)) {
 261     /* send header, command, and then data */
 262     in_len = SCSI_OFF + lpPRB->SRB_CDBLen + lpPRB->SRB_BufLen;
 263     sg_hd = (struct sg_header *) HeapAlloc(GetProcessHeap(), 0, in_len);
 264     memset(sg_hd, 0, SCSI_OFF);
 265     memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
 266     if (lpPRB->SRB_BufLen) {
 267       memcpy(((BYTE *) sg_hd) + SCSI_OFF + lpPRB->SRB_CDBLen, lpPRB->SRB_BufPointer, lpPRB->SRB_BufLen);
 268     }
 269   }
 270   else {
 271     /* send header and command - no data */
 272     in_len = SCSI_OFF + lpPRB->SRB_CDBLen;
 273     sg_hd = (struct sg_header *) HeapAlloc(GetProcessHeap(), 0, in_len);
 274     memset(sg_hd, 0, SCSI_OFF);
 275     memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
 276   }
 277
 278   if (TARGET_TO_HOST(lpPRB)) {
 279     out_len = SCSI_OFF + lpPRB->SRB_BufLen;
 280     sg_reply_hdr = (struct sg_header *) HeapAlloc(GetProcessHeap(), 0, out_len);
 281     memset(sg_reply_hdr, 0, SCSI_OFF);
 282     sg_hd->reply_len = out_len;
 283   }
 284   else {
 285     out_len = SCSI_OFF;
 286     sg_reply_hdr = (struct sg_header *) HeapAlloc(GetProcessHeap(), 0, out_len);
 287     memset(sg_reply_hdr, 0, SCSI_OFF);
 288     sg_hd->reply_len = out_len;
 289   }
 290
 291   status = write(fd, sg_hd, in_len);
 292   if (status < 0 || status != in_len) {
 293       int save_error = errno;
 294
 295     WARN("Not enough bytes written to scsi device bytes=%d .. %d\n", in_len, status);
 296     if (status < 0) {
 297                 if (save_error == ENOMEM) {
 298             MESSAGE("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");
 299         }
 300 #ifdef HAVE_STRERROR
 301                 WARN("error:= '%s'\n", strerror(save_error));
 302 #else
 303                 WARN("error:= %d\n", save_error);
 304 #endif
 305     }
 306     goto error_exit;
 307   }
 308
 309   status = read(fd, sg_reply_hdr, out_len);
 310   if (status < 0 || status != out_len) {
 311     WARN("not enough bytes read from scsi device%d\n", status);
 312     goto error_exit;
 313   }
 314
 315   if (sg_reply_hdr->result != 0) {
 316     error_code = sg_reply_hdr->result;
 317     WARN("reply header error (%d)\n", sg_reply_hdr->result);
 318     goto error_exit;
 319   }
 320
 321   if (TARGET_TO_HOST(lpPRB) && lpPRB->SRB_BufLen) {
 322     memcpy(lpPRB->SRB_BufPointer, sg_reply_hdr + 1, lpPRB->SRB_BufLen);
 323   }
 324
 325   /* copy in sense buffer to amount that is available in client */
 326   if (lpPRB->SRB_SenseLen) {
 327     int sense_len = lpPRB->SRB_SenseLen;
 328     if (lpPRB->SRB_SenseLen > 16)
 329       sense_len = 16;
 330
 331     /* CDB is fixed in WNASPI32 */
 332     memcpy(&lpPRB->CDBByte[16], &sg_reply_hdr->sense_buffer[0], sense_len);
 333
 334     TRACE("CDB is %d bytes long\n", lpPRB->SRB_CDBLen );
 335     ASPI_PrintSenseArea(lpPRB);
 336   }
 337
 338   lpPRB->SRB_Status = SS_COMP;
 339   lpPRB->SRB_HaStat = HASTAT_OK;
 340   lpPRB->SRB_TargStat = sg_reply_hdr->target_status << 1;
 341
 342   /* FIXME: Should this be != 0 maybe? */
 343   if( lpPRB->SRB_TargStat == 2 )
 344     lpPRB->SRB_Status = SS_ERR;
 345
 346   ASPI_DebugPrintResult(lpPRB);
 347   /* now do posting */
 348
 349   if (lpPRB->SRB_PostProc) {
 350     if (ASPI_POSTING(lpPRB)) {
 351       TRACE("Post Routine (%lx) called\n", (DWORD) lpPRB->SRB_PostProc);
 352       (*lpPRB->SRB_PostProc)(lpPRB);
 353     }
 354     else
 355     if (lpPRB->SRB_Flags & SRB_EVENT_NOTIFY) {
 356       TRACE("Setting event %04x\n", (HANDLE)lpPRB->SRB_PostProc);
 357       SetEvent((HANDLE)lpPRB->SRB_PostProc); /* FIXME: correct ? */
 358     }
 359   }
 360   HeapFree(GetProcessHeap(), 0, sg_reply_hdr);
 361   HeapFree(GetProcessHeap(), 0, sg_hd);
 362   return SS_PENDING;
 363   /* In real WNASPI32 stuff really is always pending because ASPI does things
 364      in the background, but we are not doing that (yet) */
 365
 366 error_exit:
 367   if (error_code == EBUSY) {
 368       lpPRB->SRB_Status = SS_ASPI_IS_BUSY;
 369       TRACE("Device busy\n");
 370   }
 371   else {
 372       WARN("Failed\n");
 373       lpPRB->SRB_Status = SS_ERR;
 374   }
 375
 376   /* I'm not sure exactly error codes work here
 377    * We probably should set lpPRB->SRB_TargStat, SRB_HaStat ?
 378    */
 379   WARN("error_exit\n");
 380   HeapFree(GetProcessHeap(), 0, sg_reply_hdr);
 381   HeapFree(GetProcessHeap(), 0, sg_hd);
 382   return lpPRB->SRB_Status;
 383 }
 384
 385 #endif /* defined(linux) */
 386
 387
 388 /*******************************************************************
 389  *     GetASPI32SupportInfo32           [WNASPI32.0]
 390  *
 391  * Checks if the ASPI subsystem is initialized correctly.
 392  *
 393  * RETURNS
 394  *    HIWORD: 0.
 395  *    HIBYTE of LOWORD: status (SS_COMP or SS_FAILED_INIT)
 396  *    LOBYTE of LOWORD: # of host adapters.
 397  */
 398 DWORD WINAPI GetASPI32SupportInfo()
 399 {
 400     return ((SS_COMP << 8) | 1); /* FIXME: get # of host adapters installed */
 401 }
 402
 403
 404 /***********************************************************************
 405  *             SendASPI32Command32 (WNASPI32.1)
 406  */
 407 DWORD __cdecl SendASPI32Command(LPSRB lpSRB)
 408 {
 409 #ifdef linux
 410   switch (lpSRB->common.SRB_Cmd) {
 411   case SC_HA_INQUIRY:
 412     lpSRB->inquiry.SRB_Status = SS_COMP;       /* completed successfully */
 413     lpSRB->inquiry.HA_Count = 1;               /* not always */
 414     lpSRB->inquiry.HA_SCSI_ID = 7;             /* not always ID 7 */
 415     strcat(lpSRB->inquiry.HA_ManagerId, "ASPI for WIN32"); /* max 15 chars, don't change */
 416     strcat(lpSRB->inquiry.HA_Identifier, "Wine host"); /* FIXME: return host adapter name */
 417     memset(lpSRB->inquiry.HA_Unique, 0, 16); /* default HA_Unique content */
 418     lpSRB->inquiry.HA_Unique[6] = 0x02; /* Maximum Transfer Length (128K, Byte> 4-7) */
 419     FIXME("ASPI: Partially implemented SC_HA_INQUIRY for adapter %d.\n", lpSRB->inquiry.SRB_HaId);
 420     return SS_COMP;
 421   case SC_GET_DEV_TYPE: {
 422     /* FIXME: We should return SS_NO_DEVICE if the device is not configured */
 423     /* FIXME: We should return SS_INVALID_HA if HostAdapter!=0 */
 424     SRB         tmpsrb;
 425     char        inqbuf[200];
 426
 427     memset(&tmpsrb,0,sizeof(tmpsrb));
 428
 429     tmpsrb.cmd.SRB_Cmd = SC_EXEC_SCSI_CMD;
 430 #define X(x) tmpsrb.cmd.SRB_##x = lpSRB->devtype.SRB_##x
 431     X(Status);X(HaId);X(Flags);X(Target);X(Lun);
 432 #undef X
 433     tmpsrb.cmd.SRB_BufLen       = sizeof(inqbuf);
 434     tmpsrb.cmd.SRB_Flags        = 8;/*target->host data. FIXME: anything more?*/
 435     tmpsrb.cmd.SRB_BufPointer   = inqbuf;
 436     tmpsrb.cmd.CDBByte[0]       = 0x12; /* INQUIRY  */
 437     tmpsrb.cmd.CDBByte[4]       = sizeof(inqbuf);
 438     tmpsrb.cmd.SRB_CDBLen       = 6;
 439     ASPI_ExecScsiCmd(&tmpsrb.cmd);
 440 #define X(x) lpSRB->devtype.SRB_##x = tmpsrb.cmd.SRB_##x
 441     X(Status);
 442 #undef X
 443     lpSRB->devtype.SRB_DeviceType = inqbuf[0]&0x1f;
 444     TRACE("returning devicetype %d for target %d\n",inqbuf[0]&0x1f,tmpsrb.cmd.SRB_Target);
 445     break;
 446   }
 447   case SC_EXEC_SCSI_CMD:
 448     return ASPI_ExecScsiCmd(&lpSRB->cmd);
 449     break;
 450   case SC_ABORT_SRB:
 451     FIXME("Not implemented SC_ABORT_SRB\n");
 452     break;
 453   case SC_RESET_DEV:
 454     FIXME("Not implemented SC_RESET_DEV\n");
 455     break;
 456 #ifdef SC_GET_DISK_INFO
 457   case SC_GET_DISK_INFO:
 458     /* NT Doesn't implement this either.. so don't feel bad */
 459     WARN("Not implemented SC_GET_DISK_INFO\n");
 460     break;
 461 #endif
 462   default:
 463     WARN("Unknown command %d\n", lpSRB->common.SRB_Cmd);
 464   }
 465   return SS_INVALID_SRB;
 466 #else
 467   return SS_INVALID_SRB;
 468 #endif
 469 }
 470
 471
 472 /***********************************************************************
 473  *             GetASPI32DLLVersion32   (WNASPI32.3)
 474  */
 475
 476 DWORD WINAPI GetASPI32DLLVersion()
 477 {
 478 #ifdef linux
 479         return (DWORD)1;
 480 #else
 481         return (DWORD)0;
 482 #endif
 483 }
 484