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

   1 #include "config.h"
   2
   3 #include <stdlib.h>
   4 #include <stdio.h>
   5 #include <sys/types.h>
   6 #include <sys/stat.h>
   7 #include <errno.h>
   8 #include <fcntl.h>
   9 #include <memory.h>
  10 #include <unistd.h>
  11
  12 #include "winbase.h"
  13 #include "aspi.h"
  14 #include "wnaspi32.h"
  15 #include "winescsi.h"
  16 #include "options.h"
  17 #include "heap.h"
  18 #include "debugtools.h"
  19 #include "ldt.h"
  20 #include "callback.h"
  21
  22 DEFAULT_DEBUG_CHANNEL(aspi);
  23
  24 /* FIXME!
  25  * 1) Residual byte length reporting not handled
  26  * 2) Make this code re-entrant for multithreading
  27  *    -- Added CriticalSection to OpenDevices function
  28  * 3) Only linux supported so far
  29  * 4) Leaves sg devices open. This may or may not be okay.  A better solution
  30  *    would be to close the file descriptors when the thread/process using
  31  *    them no longer needs them.
  32  */
  33
  34 #ifdef linux
  35
  36 static ASPI_DEVICE_INFO *ASPI_open_devices = NULL;
  37 static CRITICAL_SECTION ASPI_CritSection;
  38
  39 #endif /* defined(linux) */
  40
  41
  42 BOOL WINAPI WNASPI32_LibMain(HINSTANCE hInstDLL, DWORD fdwReason, LPVOID fImpLoad)
  43 {
  44 #ifdef linux
  45         static BOOL     bInitDone=FALSE;
  46 #if 0
  47         TRACE("0x%x 0x%1x %p\n", hInstDLL, fdwReason, fImpLoad);
  48 #endif
  49         switch( fdwReason )
  50         {
  51         case DLL_PROCESS_ATTACH:
  52                 /* Create instance data */
  53                 if(!bInitDone)
  54                 {
  55                         bInitDone=TRUE;
  56                         /* Initialize global stuff just once */
  57                         InitializeCriticalSection(&ASPI_CritSection);
  58                         SCSI_Init();
  59                 }
  60                 break;
  61         case DLL_PROCESS_DETACH:
  62                 /* Destroy instance data */
  63                 break;
  64         case DLL_THREAD_ATTACH:
  65         case DLL_THREAD_DETACH:
  66                 break;
  67         }
  68         return TRUE;
  69 #else /* defined(linux) */
  70         return TRUE;
  71 #endif /* defined(linux) */
  72 }
  73
  74 #ifdef linux
  75
  76 static int
  77 ASPI_OpenDevice(SRB_ExecSCSICmd *prb)
  78 {
  79     int fd;
  80     DWORD       hc;
  81     ASPI_DEVICE_INFO *curr;
  82
  83     /* search list of devices to see if we've opened it already.
  84      * There is not an explicit open/close in ASPI land, so hopefully
  85      * keeping a device open won't be a problem.
  86      */
  87
  88     EnterCriticalSection(&ASPI_CritSection);
  89     for (curr = ASPI_open_devices; curr; curr = curr->next) {
  90         if (curr->hostId == prb->SRB_HaId &&
  91             curr->target == prb->SRB_Target &&
  92             curr->lun == prb->SRB_Lun) {
  93             LeaveCriticalSection(&ASPI_CritSection);
  94             return curr->fd;
  95         }
  96     }
  97     LeaveCriticalSection(&ASPI_CritSection);
  98
  99     hc = ASPI_GetHCforController( prb->SRB_HaId );
 100     fd = SCSI_OpenDevice( HIWORD(hc), LOWORD(hc), prb->SRB_Target, prb->SRB_Lun);
 101
 102     if (fd == -1) {
 103         return -1;
 104     }
 105
 106     /* device is now open */
 107     /* FIXME: Let users specify SCSI timeout in registry */
 108     SCSI_LinuxSetTimeout( fd, SCSI_DEFAULT_TIMEOUT );
 109
 110     curr = HeapAlloc( GetProcessHeap(), 0, sizeof(ASPI_DEVICE_INFO) );
 111     curr->fd = fd;
 112     curr->hostId = prb->SRB_HaId;
 113     curr->target = prb->SRB_Target;
 114     curr->lun = prb->SRB_Lun;
 115
 116     /* insert new record at beginning of open device list */
 117     EnterCriticalSection(&ASPI_CritSection);
 118     curr->next = ASPI_open_devices;
 119     ASPI_open_devices = curr;
 120     LeaveCriticalSection(&ASPI_CritSection);
 121     return fd;
 122 }
 123
 124
 125 static void
 126 ASPI_DebugPrintCmd(SRB_ExecSCSICmd *prb)
 127 {
 128   BYTE  cmd;
 129   int   i;
 130   BYTE *cdb;
 131
 132   switch (prb->CDBByte[0]) {
 133   case CMD_INQUIRY:
 134     TRACE("{\n");
 135     TRACE("\tEVPD: %d\n", prb->CDBByte[1] & 1);
 136     TRACE("\tLUN: %d\n", (prb->CDBByte[1] & 0xc) >> 1);
 137     TRACE("\tPAGE CODE: %d\n", prb->CDBByte[2]);
 138     TRACE("\tALLOCATION LENGTH: %d\n", prb->CDBByte[4]);
 139     TRACE("\tCONTROL: %d\n", prb->CDBByte[5]);
 140     TRACE("}\n");
 141     break;
 142   case CMD_SCAN_SCAN:
 143     TRACE("Transfer Length: %d\n", prb->CDBByte[4]);
 144     break;
 145   }
 146
 147   TRACE("Host Adapter: %d\n", prb->SRB_HaId);
 148   TRACE("Flags: %d\n", prb->SRB_Flags);
 149   if (TARGET_TO_HOST(prb)) {
 150     TRACE("\tData transfer: Target to host. Length checked.\n");
 151   }
 152   else if (HOST_TO_TARGET(prb)) {
 153     TRACE("\tData transfer: Host to target. Length checked.\n");
 154   }
 155   else if (NO_DATA_TRANSFERED(prb)) {
 156     TRACE("\tData transfer: none\n");
 157   }
 158   else {
 159     WARN("\tTransfer by scsi cmd. Length not checked.\n");
 160   }
 161
 162   TRACE("\tResidual byte length reporting %s\n", prb->SRB_Flags & 0x4 ? "enabled" : "disabled");
 163   TRACE("\tLinking %s\n", prb->SRB_Flags & 0x2 ? "enabled" : "disabled");
 164   TRACE("\tPosting %s\n", prb->SRB_Flags & 0x1 ? "enabled" : "disabled");
 165   TRACE("Target: %d\n", prb->SRB_Target);
 166   TRACE("Lun: %d\n", prb->SRB_Lun);
 167   TRACE("BufLen: %ld\n", prb->SRB_BufLen);
 168   TRACE("SenseLen: %d\n", prb->SRB_SenseLen);
 169   TRACE("BufPtr: %p\n", prb->SRB_BufPointer);
 170   TRACE("CDB Length: %d\n", prb->SRB_CDBLen);
 171   TRACE("POST Proc: %lx\n", (DWORD) prb->SRB_PostProc);
 172   cdb = &prb->CDBByte[0];
 173   cmd = prb->CDBByte[0];
 174   if (TRACE_ON(aspi))
 175   {
 176       DPRINTF("CDB buffer[");
 177       for (i = 0; i < prb->SRB_CDBLen; i++) {
 178           if (i != 0) DPRINTF(",");
 179           DPRINTF("%02x", *cdb++);
 180       }
 181       DPRINTF("]\n");
 182   }
 183 }
 184
 185 static void
 186 ASPI_PrintSenseArea(SRB_ExecSCSICmd *prb)
 187 {
 188   int   i;
 189   BYTE *cdb;
 190
 191   if (TRACE_ON(aspi))
 192   {
 193       cdb = &prb->CDBByte[16];
 194       DPRINTF("SenseArea[");
 195       for (i = 0; i < prb->SRB_SenseLen; i++) {
 196           if (i) DPRINTF(",");
 197           DPRINTF("%02x", *cdb++);
 198       }
 199       DPRINTF("]\n");
 200   }
 201 }
 202
 203 static void
 204 ASPI_DebugPrintResult(SRB_ExecSCSICmd *prb)
 205 {
 206
 207   TRACE("SRB_Status: %x\n", prb->SRB_Status);
 208   TRACE("SRB_HaStat: %x\n", prb->SRB_HaStat);
 209   TRACE("SRB_TargStat: %x\n", prb->SRB_TargStat);
 210   switch (prb->CDBByte[0]) {
 211   case CMD_INQUIRY:
 212     TRACE("Vendor: '%s'\n", prb->SRB_BufPointer + INQUIRY_VENDOR);
 213     break;
 214   case CMD_TEST_UNIT_READY:
 215     ASPI_PrintSenseArea(prb);
 216     break;
 217   }
 218 }
 219
 220 /* Posting must be done in such a way that as soon as the SRB_Status is set
 221  * we don't touch the SRB anymore because it could possibly be freed
 222  * if the app is doing ASPI polling
 223  */
 224 static DWORD
 225 WNASPI32_DoPosting( SRB_ExecSCSICmd *lpPRB, DWORD status )
 226 {
 227         void (*SRB_PostProc)() = lpPRB->SRB_PostProc;
 228         BYTE SRB_Flags = lpPRB->SRB_Flags;
 229         if( status == SS_PENDING )
 230         {
 231                 WARN("Tried posting SS_PENDING\n");
 232                 return SS_PENDING;
 233         }
 234         lpPRB->SRB_Status = status;
 235         /* lpPRB is NOT safe, it could be freed in another thread */
 236
 237         if (SRB_PostProc)
 238         {
 239                 if (SRB_Flags & 0x1)
 240                 {
 241                         TRACE("Post Routine (%lx) called\n", (DWORD) SRB_PostProc);
 242                         /* Even though lpPRB could have been freed by
 243                          * the program.. that's unlikely if it planned
 244                          * to use it in the PostProc
 245                          */
 246                         (*SRB_PostProc)(lpPRB);
 247                 }
 248                 else if (SRB_Flags & SRB_EVENT_NOTIFY) {
 249                         TRACE("Setting event %04x\n", (HANDLE)SRB_PostProc);
 250                         SetEvent((HANDLE)SRB_PostProc);
 251                 }
 252         }
 253         return SS_PENDING;
 254 }
 255
 256 static WORD
 257 ASPI_ExecScsiCmd(SRB_ExecSCSICmd *lpPRB)
 258 {
 259   struct sg_header *sg_hd, *sg_reply_hdr;
 260   DWORD status;
 261   int   in_len, out_len;
 262   int   error_code = 0;
 263   int   fd;
 264   DWORD SRB_Status;
 265
 266   ASPI_DebugPrintCmd(lpPRB);
 267
 268   fd = ASPI_OpenDevice(lpPRB);
 269   if (fd == -1) {
 270       ERR("Failed: could not open device c%01dt%01dd%01d. Device permissions !?\n",
 271           lpPRB->SRB_HaId,lpPRB->SRB_Target,lpPRB->SRB_Lun);
 272       return WNASPI32_DoPosting( lpPRB, SS_NO_DEVICE );
 273   }
 274
 275   sg_hd = NULL;
 276   sg_reply_hdr = NULL;
 277
 278   lpPRB->SRB_Status = SS_PENDING;
 279
 280   if (!lpPRB->SRB_CDBLen) {
 281       WARN("Failed: lpPRB->SRB_CDBLen = 0.\n");
 282       return WNASPI32_DoPosting( lpPRB, SS_INVALID_SRB );
 283   }
 284
 285   /* build up sg_header + scsi cmd */
 286   if (HOST_TO_TARGET(lpPRB)) {
 287     /* send header, command, and then data */
 288     in_len = SCSI_OFF + lpPRB->SRB_CDBLen + lpPRB->SRB_BufLen;
 289     sg_hd = (struct sg_header *) HeapAlloc(GetProcessHeap(), 0, in_len);
 290     memset(sg_hd, 0, SCSI_OFF);
 291     memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
 292     if (lpPRB->SRB_BufLen) {
 293       memcpy(((BYTE *) sg_hd) + SCSI_OFF + lpPRB->SRB_CDBLen, lpPRB->SRB_BufPointer, lpPRB->SRB_BufLen);
 294     }
 295   }
 296   else {
 297     /* send header and command - no data */
 298     in_len = SCSI_OFF + lpPRB->SRB_CDBLen;
 299     sg_hd = (struct sg_header *) HeapAlloc(GetProcessHeap(), 0, in_len);
 300     memset(sg_hd, 0, SCSI_OFF);
 301     memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
 302   }
 303
 304   if (TARGET_TO_HOST(lpPRB)) {
 305     out_len = SCSI_OFF + lpPRB->SRB_BufLen;
 306     sg_reply_hdr = (struct sg_header *) HeapAlloc(GetProcessHeap(), 0, out_len);
 307     memset(sg_reply_hdr, 0, SCSI_OFF);
 308     sg_hd->reply_len = out_len;
 309   }
 310   else {
 311     out_len = SCSI_OFF;
 312     sg_reply_hdr = (struct sg_header *) HeapAlloc(GetProcessHeap(), 0, out_len);
 313     memset(sg_reply_hdr, 0, SCSI_OFF);
 314     sg_hd->reply_len = out_len;
 315   }
 316
 317   if(!SCSI_LinuxDeviceIo( fd,
 318                           sg_hd, in_len,
 319                           sg_reply_hdr, out_len,
 320                           &status) )
 321   {
 322     goto error_exit;
 323   }
 324
 325   if (sg_reply_hdr->result != 0) {
 326     error_code = sg_reply_hdr->result;
 327     WARN("reply header error (%d)\n", sg_reply_hdr->result);
 328     goto error_exit;
 329   }
 330
 331   if (TARGET_TO_HOST(lpPRB) && lpPRB->SRB_BufLen) {
 332     memcpy(lpPRB->SRB_BufPointer, sg_reply_hdr + 1, lpPRB->SRB_BufLen);
 333   }
 334
 335   /* copy in sense buffer to amount that is available in client */
 336   if (lpPRB->SRB_SenseLen) {
 337     int sense_len = lpPRB->SRB_SenseLen;
 338     if (lpPRB->SRB_SenseLen > 16)
 339       sense_len = 16;
 340
 341     /* CDB is fixed in WNASPI32 */
 342     memcpy(&lpPRB->CDBByte[16], &sg_reply_hdr->sense_buffer[0], sense_len);
 343
 344     TRACE("CDB is %d bytes long\n", lpPRB->SRB_CDBLen );
 345     ASPI_PrintSenseArea(lpPRB);
 346   }
 347
 348   SRB_Status = SS_COMP;
 349   lpPRB->SRB_HaStat = HASTAT_OK;
 350   lpPRB->SRB_TargStat = sg_reply_hdr->target_status << 1;
 351
 352   HeapFree(GetProcessHeap(), 0, sg_reply_hdr);
 353   HeapFree(GetProcessHeap(), 0, sg_hd);
 354
 355   /* FIXME: Should this be != 0 maybe? */
 356   if( lpPRB->SRB_TargStat == 2 )
 357     SRB_Status = SS_ERR;
 358
 359   ASPI_DebugPrintResult(lpPRB);
 360   /* now do posting */
 361   return WNASPI32_DoPosting( lpPRB, SRB_Status );
 362   /* In real WNASPI32 stuff really is always pending because ASPI does things
 363      in the background, but we are not doing that (yet) */
 364
 365 error_exit:
 366   SRB_Status = SS_ERR;
 367   if (error_code == EBUSY) {
 368       WNASPI32_DoPosting( lpPRB, SS_ASPI_IS_BUSY );
 369       TRACE("Device busy\n");
 370   }
 371   else {
 372       WARN("Failed\n");
 373   }
 374
 375   /* I'm not sure exactly error codes work here
 376    * We probably should set lpPRB->SRB_TargStat, SRB_HaStat ?
 377    */
 378   WARN("error_exit\n");
 379   HeapFree(GetProcessHeap(), 0, sg_reply_hdr);
 380   HeapFree(GetProcessHeap(), 0, sg_hd);
 381   WNASPI32_DoPosting( lpPRB, SRB_Status );
 382   return SS_PENDING;
 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