dlls/winaspi/winaspi16.c

   1 /*
   2  * Copyright 1997 Bruce Milner
   3  * Copyright 1998 Andreas Mohr
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  */
  19
  20 #include "config.h"
  21
  22 #include <stdlib.h>
  23 #include <sys/types.h>
  24 #include <errno.h>
  25 #include <fcntl.h>
  26 #include <memory.h>
  27 #ifdef HAVE_UNISTD_H
  28 # include <unistd.h>
  29 #endif
  30 #include <string.h>
  31 #include <stdarg.h>
  32 #include <stdio.h>
  33
  34 #include "windef.h"
  35 #include "winbase.h"
  36 #include "wine/windef16.h"
  37 #include "winreg.h"
  38 #include "wownt32.h"
  39 #include "aspi.h"
  40 #include "winescsi.h"
  41 #include "wine/winaspi.h"
  42 #include "wine/debug.h"
  43 #include "miscemu.h"
  44
  45 WINE_DEFAULT_DEBUG_CHANNEL(aspi);
  46
  47
  48 /* FIXME!
  49  * 1) Residual byte length reporting not handled
  50  * 2) Make this code re-entrant for multithreading
  51  * 3) Only linux supported so far
  52  */
  53
  54 #ifdef linux
  55
  56 static ASPI_DEVICE_INFO *ASPI_open_devices = NULL;
  57
  58 static FARPROC16 ASPIChainFunc = NULL;
  59 static WORD HA_Count = 1; /* host adapter count; FIXME: detect it */
  60
  61 static int
  62 ASPI_OpenDevice16(SRB_ExecSCSICmd16 *prb)
  63 {
  64     HKEY hkey;
  65     int fd;
  66     char        idstr[50];
  67     char        device_str[50];
  68     ASPI_DEVICE_INFO *curr;
  69
  70     /* search list of devices to see if we've opened it already.
  71      * There is not an explicit open/close in ASPI land, so hopefully
  72      * keeping a device open won't be a problem.
  73      */
  74
  75     for (curr = ASPI_open_devices; curr; curr = curr->next) {
  76         if (curr->hostId == prb->SRB_HaId &&
  77             curr->target == prb->SRB_Target &&
  78             curr->lun == prb->SRB_Lun) {
  79             return curr->fd;
  80         }
  81     }
  82
  83     /* device wasn't cached, go ahead and open it */
  84     sprintf( idstr, "Software\\Wine\\Wine\\Config\\scsi c%1dt%1dd%1d",
  85              prb->SRB_HaId, prb->SRB_Target, prb->SRB_Lun);
  86
  87     device_str[0] = 0;
  88     if (!RegOpenKeyExA( HKEY_LOCAL_MACHINE, idstr, 0, KEY_ALL_ACCESS, &hkey ))
  89     {
  90         DWORD type, count = sizeof(device_str);
  91         if (RegQueryValueExA( hkey, "Device", 0, &type, device_str, &count )) device_str[0] = 0;
  92         RegCloseKey( hkey );
  93     }
  94
  95     if (!device_str[0])
  96     {
  97         TRACE("Trying to open unlisted scsi device %s\n", idstr);
  98         return -1;
  99     }
 100
 101     TRACE("Opening device %s=%s\n", idstr, device_str);
 102
 103     fd = open(device_str, O_RDWR);
 104     if (fd == -1) {
 105         int save_error = errno;
 106         ERR("Error opening device %s, error '%s'\n", device_str, strerror(save_error));
 107         return -1;
 108     }
 109
 110     /* device is now open */
 111     curr = HeapAlloc( GetProcessHeap(), 0, sizeof(ASPI_DEVICE_INFO) );
 112     curr->fd = fd;
 113     curr->hostId = prb->SRB_HaId;
 114     curr->target = prb->SRB_Target;
 115     curr->lun = prb->SRB_Lun;
 116
 117     /* insert new record at beginning of open device list */
 118     curr->next = ASPI_open_devices;
 119     ASPI_open_devices = curr;
 120     return fd;
 121 }
 122
 123
 124 static void
 125 ASPI_DebugPrintCmd(SRB_ExecSCSICmd16 *prb, UINT16 mode)
 126 {
 127   BYTE  cmd;
 128   int   i;
 129   BYTE *cdb;
 130   BYTE *lpBuf = 0;
 131
 132   switch (mode)
 133   {
 134       case ASPI_DOS:
 135         /* translate real mode address */
 136         if (prb->SRB_BufPointer)
 137             lpBuf = PTR_REAL_TO_LIN( SELECTOROF(prb->SRB_BufPointer), OFFSETOF(prb->SRB_BufPointer));
 138         break;
 139       case ASPI_WIN16:
 140         lpBuf = MapSL(prb->SRB_BufPointer);
 141         break;
 142   }
 143
 144   switch (prb->CDBByte[0]) {
 145   case CMD_INQUIRY:
 146     TRACE("{\n");
 147     TRACE("\tEVPD: %d\n", prb->CDBByte[1] & 1);
 148     TRACE("\tLUN: %d\n", (prb->CDBByte[1] & 0xc) >> 1);
 149     TRACE("\tPAGE CODE: %d\n", prb->CDBByte[2]);
 150     TRACE("\tALLOCATION LENGTH: %d\n", prb->CDBByte[4]);
 151     TRACE("\tCONTROL: %d\n", prb->CDBByte[5]);
 152     TRACE("}\n");
 153     break;
 154   case CMD_SCAN_SCAN:
 155     TRACE("Transfer Length: %d\n", prb->CDBByte[4]);
 156     break;
 157   }
 158
 159   TRACE("Host Adapter: %d\n", prb->SRB_HaId);
 160   TRACE("Flags: %d\n", prb->SRB_Flags);
 161   if (TARGET_TO_HOST(prb)) {
 162     TRACE("\tData transfer: Target to host. Length checked.\n");
 163   }
 164   else if (HOST_TO_TARGET(prb)) {
 165     TRACE("\tData transfer: Host to target. Length checked.\n");
 166   }
 167   else if (NO_DATA_TRANSFERED(prb)) {
 168     TRACE("\tData transfer: none\n");
 169   }
 170   else {
 171     WARN("\tTransfer by scsi cmd. Length not checked\n");
 172   }
 173
 174   TRACE("\tResidual byte length reporting %s\n", prb->SRB_Flags & 0x4 ? "enabled" : "disabled");
 175   TRACE("\tLinking %s\n", prb->SRB_Flags & 0x2 ? "enabled" : "disabled");
 176   TRACE("\tPosting %s\n", prb->SRB_Flags & 0x1 ? "enabled" : "disabled");
 177   TRACE("Target: %d\n", prb->SRB_Target);
 178   TRACE("Lun: %d\n", prb->SRB_Lun);
 179   TRACE("BufLen: %ld\n", prb->SRB_BufLen);
 180   TRACE("SenseLen: %d\n", prb->SRB_SenseLen);
 181   TRACE("BufPtr: %lx (%p)\n", prb->SRB_BufPointer, lpBuf);
 182   TRACE("LinkPointer %lx\n", prb->SRB_Rsvd1);
 183   TRACE("CDB Length: %d\n", prb->SRB_CDBLen);
 184   TRACE("POST Proc: %lx\n", (DWORD) prb->SRB_PostProc);
 185   cdb = &prb->CDBByte[0];
 186   cmd = prb->CDBByte[0];
 187   if (TRACE_ON(aspi))
 188   {
 189       TRACE("CDB buffer[");
 190       for (i = 0; i < prb->SRB_CDBLen; i++) {
 191           if (i != 0) TRACE(",");
 192           TRACE("%02x", *cdb++);
 193       }
 194       TRACE("]\n");
 195   }
 196 }
 197
 198 static void
 199 ASPI_PrintSenseArea16(SRB_ExecSCSICmd16 *prb)
 200 {
 201   int   i;
 202   BYTE *cdb;
 203
 204   if (TRACE_ON(aspi))
 205   {
 206       cdb = &prb->CDBByte[0];
 207       TRACE("SenseArea[");
 208       for (i = 0; i < prb->SRB_SenseLen; i++) {
 209           if (i) TRACE(",");
 210           TRACE("%02x", *cdb++);
 211       }
 212       TRACE("]\n");
 213   }
 214 }
 215
 216 static void
 217 ASPI_DebugPrintResult(SRB_ExecSCSICmd16 *prb, UINT16 mode)
 218 {
 219   BYTE *lpBuf = 0;
 220
 221   switch (mode)
 222   {
 223       case ASPI_DOS:
 224         /* translate real mode address */
 225         if (prb->SRB_BufPointer)
 226             lpBuf = PTR_REAL_TO_LIN( SELECTOROF(prb->SRB_BufPointer), OFFSETOF(prb->SRB_BufPointer));
 227         break;
 228       case ASPI_WIN16:
 229         lpBuf = MapSL(prb->SRB_BufPointer);
 230         break;
 231   }
 232
 233   switch (prb->CDBByte[0]) {
 234   case CMD_INQUIRY:
 235     TRACE("Vendor: '%s'\n", lpBuf + INQUIRY_VENDOR);
 236     break;
 237   case CMD_TEST_UNIT_READY:
 238     ASPI_PrintSenseArea16(prb);
 239     break;
 240   }
 241 }
 242
 243 static WORD
 244 ASPI_ExecScsiCmd(DWORD ptrPRB, UINT16 mode)
 245 {
 246   SRB_ExecSCSICmd16 *lpPRB = 0;
 247   struct sg_header *sg_hd, *sg_reply_hdr;
 248   int   status;
 249   BYTE *lpBuf = 0;
 250   int   in_len, out_len;
 251   int   error_code = 0;
 252   int   fd;
 253
 254   switch (mode)
 255   {
 256       case ASPI_DOS:
 257         if (ptrPRB)
 258             lpPRB = PTR_REAL_TO_LIN( SELECTOROF(ptrPRB), OFFSETOF(ptrPRB));
 259         break;
 260       case ASPI_WIN16:
 261         lpPRB = MapSL(ptrPRB);
 262         break;
 263   }
 264
 265   ASPI_DebugPrintCmd(lpPRB, mode);
 266
 267   fd = ASPI_OpenDevice16(lpPRB);
 268   if (fd == -1) {
 269       WARN("Failed: could not open device. Device permissions !?\n");
 270       lpPRB->SRB_Status = SS_ERR;
 271       return SS_ERR;
 272   }
 273
 274   sg_hd = NULL;
 275   sg_reply_hdr = NULL;
 276
 277   lpPRB->SRB_Status = SS_PENDING;
 278
 279   switch (mode)
 280   {
 281       case ASPI_DOS:
 282         /* translate real mode address */
 283         if (ptrPRB)
 284             lpBuf = PTR_REAL_TO_LIN( SELECTOROF(lpPRB->SRB_BufPointer),
 285                                      OFFSETOF(lpPRB->SRB_BufPointer));
 286         break;
 287       case ASPI_WIN16:
 288         lpBuf = MapSL(lpPRB->SRB_BufPointer);
 289         break;
 290   }
 291
 292   if (!lpPRB->SRB_CDBLen) {
 293       WARN("Failed: lpPRB->SRB_CDBLen = 0.\n");
 294       lpPRB->SRB_Status = SS_ERR;
 295       return SS_ERR;
 296   }
 297
 298   /* build up sg_header + scsi cmd */
 299   if (HOST_TO_TARGET(lpPRB)) {
 300     /* send header, command, and then data */
 301     in_len = SCSI_OFF + lpPRB->SRB_CDBLen + lpPRB->SRB_BufLen;
 302     sg_hd = (struct sg_header *) malloc(in_len);
 303     memset(sg_hd, 0, SCSI_OFF);
 304     memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
 305     if (lpPRB->SRB_BufLen) {
 306       memcpy(((BYTE *) sg_hd) + SCSI_OFF + lpPRB->SRB_CDBLen, lpBuf, lpPRB->SRB_BufLen);
 307     }
 308   }
 309   else {
 310     /* send header and command - no data */
 311     in_len = SCSI_OFF + lpPRB->SRB_CDBLen;
 312     sg_hd = (struct sg_header *) malloc(in_len);
 313     memset(sg_hd, 0, SCSI_OFF);
 314     memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
 315   }
 316
 317   if (TARGET_TO_HOST(lpPRB)) {
 318     out_len = SCSI_OFF + lpPRB->SRB_BufLen;
 319     sg_reply_hdr = (struct sg_header *) malloc(out_len);
 320     memset(sg_reply_hdr, 0, SCSI_OFF);
 321     sg_hd->reply_len = out_len;
 322   }
 323   else {
 324     out_len = SCSI_OFF;
 325     sg_reply_hdr = (struct sg_header *) malloc(out_len);
 326     memset(sg_reply_hdr, 0, SCSI_OFF);
 327     sg_hd->reply_len = out_len;
 328   }
 329
 330   status = write(fd, sg_hd, in_len);
 331   if (status < 0 || status != in_len) {
 332       int save_error = errno;
 333
 334     WARN("Not enough bytes written to scsi device bytes=%d .. %d\n", in_len, status);
 335     if (status < 0) {
 336                 if (save_error == ENOMEM) {
 337             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");
 338         }
 339                 WARN("error:= '%s'\n", strerror(save_error));
 340     }
 341     goto error_exit;
 342   }
 343
 344   status = read(fd, sg_reply_hdr, out_len);
 345   if (status < 0 || status != out_len) {
 346     WARN("not enough bytes read from scsi device%d\n", status);
 347     goto error_exit;
 348   }
 349
 350   if (sg_reply_hdr->result != 0) {
 351     error_code = sg_reply_hdr->result;
 352     WARN("reply header error (%d)\n", sg_reply_hdr->result);
 353     goto error_exit;
 354   }
 355
 356   if (TARGET_TO_HOST(lpPRB) && lpPRB->SRB_BufLen) {
 357     memcpy(lpBuf, sg_reply_hdr + 1, lpPRB->SRB_BufLen);
 358   }
 359
 360   /* copy in sense buffer to amount that is available in client */
 361   if (lpPRB->SRB_SenseLen) {
 362     int sense_len = lpPRB->SRB_SenseLen;
 363     if (lpPRB->SRB_SenseLen > 16)
 364       sense_len = 16;
 365     memcpy(SENSE_BUFFER(lpPRB), &sg_reply_hdr->sense_buffer[0], sense_len);
 366   }
 367
 368
 369   lpPRB->SRB_Status = SS_COMP;
 370   lpPRB->SRB_HaStat = HASTAT_OK;
 371   lpPRB->SRB_TargStat = STATUS_GOOD;
 372
 373   /* now do posting */
 374
 375   if (ASPI_POSTING(lpPRB) && lpPRB->SRB_PostProc) {
 376     TRACE("Post Routine (%lx) called\n", (DWORD) lpPRB->SRB_PostProc);
 377     switch (mode)
 378     {
 379       case ASPI_DOS:
 380       {
 381         SEGPTR spPRB = MapLS(lpPRB);
 382
 383         WOWCallback16((DWORD)lpPRB->SRB_PostProc, spPRB);
 384         UnMapLS(spPRB);
 385         break;
 386       }
 387       case ASPI_WIN16:
 388         WOWCallback16((DWORD)lpPRB->SRB_PostProc, ptrPRB);
 389         break;
 390     }
 391   }
 392
 393   free(sg_reply_hdr);
 394   free(sg_hd);
 395   ASPI_DebugPrintResult(lpPRB, mode);
 396   return SS_COMP;
 397
 398 error_exit:
 399   if (error_code == EBUSY) {
 400       lpPRB->SRB_Status = SS_ASPI_IS_BUSY;
 401       TRACE("Device busy\n");
 402   }
 403   else {
 404       WARN("Failed\n");
 405       lpPRB->SRB_Status = SS_ERR;
 406   }
 407
 408   /* I'm not sure exactly error codes work here
 409    * We probably should set lpPRB->SRB_TargStat, SRB_HaStat ?
 410    */
 411   WARN("error_exit\n");
 412   free(sg_reply_hdr);
 413   free(sg_hd);
 414   return lpPRB->SRB_Status;
 415 }
 416 #endif
 417
 418
 419 /***********************************************************************
 420  *             GetASPISupportInfo   (WINASPI.1)
 421  */
 422
 423 WORD WINAPI GetASPISupportInfo16(void)
 424 {
 425 #ifdef linux
 426     TRACE("GETASPISupportInfo16\n");
 427     /* high byte SS_COMP - low byte number of host adapters */
 428     return ((SS_COMP << 8) | HA_Count);
 429 #else
 430     return ((SS_NO_ASPI << 8) | 0);
 431 #endif
 432 }
 433
 434
 435 DWORD ASPI_SendASPICommand(DWORD ptrSRB, UINT16 mode)
 436 {
 437 #ifdef linux
 438   LPSRB16 lpSRB = 0;
 439
 440   switch (mode)
 441   {
 442       case ASPI_DOS:
 443         if (ptrSRB)
 444             lpSRB = PTR_REAL_TO_LIN( SELECTOROF(ptrSRB), OFFSETOF(ptrSRB));
 445         break;
 446       case ASPI_WIN16:
 447         lpSRB = MapSL(ptrSRB);
 448         if (ASPIChainFunc)
 449         {
 450             /* This is not the post proc, it's the chain proc this time */
 451             DWORD ret = WOWCallback16((DWORD)ASPIChainFunc, ptrSRB);
 452             if (ret)
 453             {
 454                 lpSRB->inquiry.SRB_Status = SS_INVALID_SRB;
 455                 return ret;
 456             }
 457         }
 458         break;
 459   }
 460
 461   switch (lpSRB->common.SRB_Cmd) {
 462   case SC_HA_INQUIRY:
 463     lpSRB->inquiry.SRB_Status = SS_COMP;       /* completed successfully */
 464     if (lpSRB->inquiry.SRB_55AASignature == 0x55aa) {
 465         TRACE("Extended request detected (Adaptec's ASPIxDOS).\nWe don't support it at the moment.\n");
 466     }
 467     lpSRB->inquiry.SRB_ExtBufferSize = 0x2000; /* bogus value */
 468     lpSRB->inquiry.HA_Count = HA_Count;
 469     lpSRB->inquiry.HA_SCSI_ID = 7;             /* not always ID 7 */
 470     strcat(lpSRB->inquiry.HA_ManagerId, "Wine ASPI16"); /* max 15 chars */
 471     strcat(lpSRB->inquiry.HA_Identifier, "Wine host"); /* FIXME: return host
 472 adapter name */
 473     memset(lpSRB->inquiry.HA_Unique, 0, 16); /* default HA_Unique content */
 474     lpSRB->inquiry.HA_Unique[6] = 0x02; /* Maximum Transfer Length (128K, Byte> 4-7) */
 475     FIXME("ASPI: Partially implemented SC_HA_INQUIRY for adapter %d.\n", lpSRB->inquiry.SRB_HaId);
 476     return SS_COMP;
 477   case SC_GET_DEV_TYPE:
 478     FIXME("Not implemented SC_GET_DEV_TYPE\n");
 479     break;
 480   case SC_EXEC_SCSI_CMD:
 481     return ASPI_ExecScsiCmd((DWORD)ptrSRB, mode);
 482     break;
 483   case SC_RESET_DEV:
 484     FIXME("Not implemented SC_RESET_DEV\n");
 485     break;
 486   default:
 487     FIXME("Unknown command %d\n", lpSRB->common.SRB_Cmd);
 488   }
 489 #endif
 490   return SS_INVALID_SRB;
 491 }
 492
 493
 494 /***********************************************************************
 495  *             SendASPICommand   (WINASPI.2)
 496  */
 497 WORD WINAPI SendASPICommand16(SEGPTR segptr_srb)
 498 {
 499 #ifdef linux
 500     return ASPI_SendASPICommand(segptr_srb, ASPI_WIN16);
 501 #else
 502     return 0;
 503 #endif
 504 }
 505
 506
 507 /***********************************************************************
 508  *             InsertInASPIChain   (WINASPI.3)
 509  */
 510 WORD WINAPI InsertInASPIChain16(BOOL16 remove, FARPROC16 pASPIChainFunc)
 511 {
 512 #ifdef linux
 513     if (remove == TRUE) /* Remove */
 514     {
 515         if (ASPIChainFunc == pASPIChainFunc)
 516         {
 517             ASPIChainFunc = NULL;
 518             return SS_COMP;
 519         }
 520     }
 521     else
 522     if (remove == FALSE) /* Insert */
 523     {
 524         if (ASPIChainFunc == NULL)
 525         {
 526             ASPIChainFunc = pASPIChainFunc;
 527             return SS_COMP;
 528         }
 529     }
 530 #endif
 531     return SS_ERR;
 532 }
 533
 534
 535 /***********************************************************************
 536  *             GETASPIDLLVERSION   (WINASPI.4)
 537  */
 538
 539 DWORD WINAPI GetASPIDLLVersion16()
 540 {
 541 #ifdef linux
 542         return 2;
 543 #else
 544         return 0;
 545 #endif
 546 }