- New implementation of SendMessage, ReceiveMessage, ReplyMessage functions
[wine] / dlls / winaspi / winaspi16.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 <string.h>
11 #include "winbase.h"
12 #include "aspi.h"
13 #include "winaspi.h"
14 #include "options.h"
15 #include "heap.h"
16 #include "debug.h"
17 #include "selectors.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_OpenDevice16(SRB_ExecSCSICmd16 *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_DebugPrintCmd(SRB_ExecSCSICmd16 *prb, UINT16 mode)
86 {
87   BYTE  cmd;
88   int   i;
89   BYTE *cdb;
90   BYTE *lpBuf = 0;
91   dbg_decl_str(aspi, 512);
92
93   switch (mode)
94   {
95       case ASPI_DOS:
96         /* translate real mode address */
97         if (prb->SRB_BufPointer)
98             lpBuf = (BYTE *)DOSMEM_MapRealToLinear((UINT32)prb->SRB_BufPointer);
99         break;
100       case ASPI_WIN16:
101         lpBuf = PTR_SEG_TO_LIN(prb->SRB_BufPointer);
102         break;
103   }
104
105   switch (prb->CDBByte[0]) {
106   case CMD_INQUIRY:
107     TRACE(aspi, "{\n");
108     TRACE(aspi, "\tEVPD: %d\n", prb->CDBByte[1] & 1);
109     TRACE(aspi, "\tLUN: %d\n", (prb->CDBByte[1] & 0xc) >> 1);
110     TRACE(aspi, "\tPAGE CODE: %d\n", prb->CDBByte[2]);
111     TRACE(aspi, "\tALLOCATION LENGTH: %d\n", prb->CDBByte[4]);
112     TRACE(aspi, "\tCONTROL: %d\n", prb->CDBByte[5]);
113     TRACE(aspi, "}\n");
114     break;
115   case CMD_SCAN_SCAN:
116     TRACE(aspi, "Transfer Length: %d\n", prb->CDBByte[4]);
117     break;
118   }
119
120   TRACE(aspi, "Host Adapter: %d\n", prb->SRB_HaId);
121   TRACE(aspi, "Flags: %d\n", prb->SRB_Flags);
122   if (TARGET_TO_HOST(prb)) {
123     TRACE(aspi, "\tData transfer: Target to host. Length checked.\n");
124   }
125   else if (HOST_TO_TARGET(prb)) {
126     TRACE(aspi, "\tData transfer: Host to target. Length checked.\n");
127   }
128   else if (NO_DATA_TRANSFERED(prb)) {
129     TRACE(aspi, "\tData transfer: none\n");
130   }
131   else {
132     WARN(aspi, "\tTransfer by scsi cmd. Length not checked\n");
133   }
134
135   TRACE(aspi, "\tResidual byte length reporting %s\n", prb->SRB_Flags & 0x4 ? "enabled" : "disabled");
136   TRACE(aspi, "\tLinking %s\n", prb->SRB_Flags & 0x2 ? "enabled" : "disabled");
137   TRACE(aspi, "\tPosting %s\n", prb->SRB_Flags & 0x1 ? "enabled" : "disabled");
138   TRACE(aspi, "Target: %d\n", prb->SRB_Target);
139   TRACE(aspi, "Lun: %d\n", prb->SRB_Lun);
140   TRACE(aspi, "BufLen: %ld\n", prb->SRB_BufLen);
141   TRACE(aspi, "SenseLen: %d\n", prb->SRB_SenseLen);
142   TRACE(aspi, "BufPtr: %lx (%p)\n", prb->SRB_BufPointer, lpBuf);
143   TRACE(aspi, "LinkPointer %lx\n", prb->SRB_Rsvd1);
144   TRACE(aspi, "CDB Length: %d\n", prb->SRB_CDBLen);
145   TRACE(aspi, "POST Proc: %lx\n", (DWORD) prb->SRB_PostProc);
146   cdb = &prb->CDBByte[0];
147   cmd = prb->CDBByte[0];
148   for (i = 0; i < prb->SRB_CDBLen; i++) {
149     if (i != 0) dsprintf(aspi, ",");
150     dsprintf(aspi, "%02x", *cdb++);
151   }
152   TRACE(aspi, "CDB buffer[%s]\n", dbg_str(aspi));
153 }
154
155 static void
156 ASPI_PrintSenseArea16(SRB_ExecSCSICmd16 *prb)
157 {
158   int   i;
159   BYTE *cdb;
160   dbg_decl_str(aspi, 512);
161
162   cdb = &prb->CDBByte[0];
163   for (i = 0; i < prb->SRB_SenseLen; i++) {
164     if (i) dsprintf(aspi, ",");
165     dsprintf(aspi, "%02x", *cdb++);
166   }
167   TRACE(aspi, "SenseArea[%s]\n", dbg_str(aspi));
168 }
169
170 static void
171 ASPI_DebugPrintResult(SRB_ExecSCSICmd16 *prb, UINT16 mode)
172 {
173   BYTE *lpBuf = 0;
174
175   switch (mode)
176   {
177       case ASPI_DOS:
178         /* translate real mode address */
179         if (prb->SRB_BufPointer)
180             lpBuf = (BYTE *)DOSMEM_MapRealToLinear((UINT32)prb->SRB_BufPointer);
181         break;
182       case ASPI_WIN16:
183         lpBuf = PTR_SEG_TO_LIN(prb->SRB_BufPointer);
184         break;
185   }
186
187   switch (prb->CDBByte[0]) {
188   case CMD_INQUIRY:
189     TRACE(aspi, "Vendor: '%s'\n", lpBuf + INQUIRY_VENDOR);
190     break;
191   case CMD_TEST_UNIT_READY:
192     ASPI_PrintSenseArea16(prb);
193     break;
194   }
195 }
196
197 static WORD
198 ASPI_ExecScsiCmd(DWORD ptrPRB, UINT16 mode)
199 {
200   SRB_ExecSCSICmd16 *lpPRB = 0;
201   struct sg_header *sg_hd, *sg_reply_hdr;
202   int   status;
203   BYTE *lpBuf = 0;
204   int   in_len, out_len;
205   int   error_code = 0;
206   int   fd;
207
208   switch (mode)
209   {
210       case ASPI_DOS:
211         if (ptrPRB)
212             lpPRB = (SRB_ExecSCSICmd16 *)DOSMEM_MapRealToLinear(ptrPRB);
213         break;
214       case ASPI_WIN16:
215         lpPRB = PTR_SEG_TO_LIN(ptrPRB);
216         break;
217   }
218
219   ASPI_DebugPrintCmd(lpPRB, mode);
220
221   fd = ASPI_OpenDevice16(lpPRB);
222   if (fd == -1) {
223       WARN(aspi, "Failed: could not open device. Device permissions !?\n");
224       lpPRB->SRB_Status = SS_ERR;
225       return SS_ERR;
226   }
227
228   sg_hd = NULL;
229   sg_reply_hdr = NULL;
230
231   lpPRB->SRB_Status = SS_PENDING;
232
233   switch (mode)
234   {
235       case ASPI_DOS:
236         /* translate real mode address */
237         if (ptrPRB)
238             lpBuf = (BYTE *)DOSMEM_MapRealToLinear((UINT32)lpPRB->SRB_BufPointer);
239         break;
240       case ASPI_WIN16:
241         lpBuf = PTR_SEG_TO_LIN(lpPRB->SRB_BufPointer);
242         break;
243   }
244
245   if (!lpPRB->SRB_CDBLen) {
246       WARN(aspi, "Failed: lpPRB->SRB_CDBLen = 0.\n");
247       lpPRB->SRB_Status = SS_ERR;
248       return SS_ERR;
249   }
250
251   /* build up sg_header + scsi cmd */
252   if (HOST_TO_TARGET(lpPRB)) {
253     /* send header, command, and then data */
254     in_len = SCSI_OFF + lpPRB->SRB_CDBLen + lpPRB->SRB_BufLen;
255     sg_hd = (struct sg_header *) malloc(in_len);
256     memset(sg_hd, 0, SCSI_OFF);
257     memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
258     if (lpPRB->SRB_BufLen) {
259       memcpy(((BYTE *) sg_hd) + SCSI_OFF + lpPRB->SRB_CDBLen, lpBuf, lpPRB->SRB_BufLen);
260     }
261   }
262   else {
263     /* send header and command - no data */
264     in_len = SCSI_OFF + lpPRB->SRB_CDBLen;
265     sg_hd = (struct sg_header *) malloc(in_len);
266     memset(sg_hd, 0, SCSI_OFF);
267     memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
268   }
269
270   if (TARGET_TO_HOST(lpPRB)) {
271     out_len = SCSI_OFF + lpPRB->SRB_BufLen;
272     sg_reply_hdr = (struct sg_header *) malloc(out_len);
273     memset(sg_reply_hdr, 0, SCSI_OFF);
274     sg_hd->reply_len = out_len;
275   }
276   else {
277     out_len = SCSI_OFF;
278     sg_reply_hdr = (struct sg_header *) malloc(out_len);
279     memset(sg_reply_hdr, 0, SCSI_OFF);
280     sg_hd->reply_len = out_len;
281   }
282
283   status = write(fd, sg_hd, in_len);
284   if (status < 0 || status != in_len) {
285       int save_error = errno;
286
287     WARN(aspi, "Not enough bytes written to scsi device bytes=%d .. %d\n", in_len, status);
288     if (status < 0) {
289                 if (save_error == ENOMEM) {
290             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");
291         }
292 #ifdef HAVE_STRERROR
293                 WARN(aspi, "error:= '%s'\n", strerror(save_error));
294 #else
295                 WARN(aspi, "error:= %d\n", save_error);
296 #endif
297     }
298     goto error_exit;
299   }
300
301   status = read(fd, sg_reply_hdr, out_len);
302   if (status < 0 || status != out_len) {
303     WARN(aspi, "not enough bytes read from scsi device%d\n", status);
304     goto error_exit;
305   }
306
307   if (sg_reply_hdr->result != 0) {
308     error_code = sg_reply_hdr->result;
309     WARN(aspi, "reply header error (%d)\n", sg_reply_hdr->result);
310     goto error_exit;
311   }
312
313   if (TARGET_TO_HOST(lpPRB) && lpPRB->SRB_BufLen) {
314     memcpy(lpBuf, sg_reply_hdr + 1, lpPRB->SRB_BufLen);
315   }
316
317   /* copy in sense buffer to amount that is available in client */
318   if (lpPRB->SRB_SenseLen) {
319     int sense_len = lpPRB->SRB_SenseLen;
320     if (lpPRB->SRB_SenseLen > 16)
321       sense_len = 16;
322     memcpy(SENSE_BUFFER(lpPRB), &sg_reply_hdr->sense_buffer[0], sense_len);
323   }
324
325
326   lpPRB->SRB_Status = SS_COMP;
327   lpPRB->SRB_HaStat = HASTAT_OK;
328   lpPRB->SRB_TargStat = STATUS_GOOD;
329
330   /* now do posting */
331
332   if (ASPI_POSTING(lpPRB) && lpPRB->SRB_PostProc) {
333     TRACE(aspi, "Post Routine (%lx) called\n", (DWORD) lpPRB->SRB_PostProc);
334     switch (mode)
335     {
336       case ASPI_DOS:
337       {
338         SEGPTR spPRB = MapLS(lpPRB);
339
340         Callbacks->CallASPIPostProc(lpPRB->SRB_PostProc, spPRB);        
341         UnMapLS(spPRB);
342         break;
343       }
344       case ASPI_WIN16:
345         Callbacks->CallASPIPostProc(lpPRB->SRB_PostProc, ptrPRB);
346         break;
347     }
348   }
349
350   free(sg_reply_hdr);
351   free(sg_hd);
352   ASPI_DebugPrintResult(lpPRB, mode);
353   return SS_COMP;
354   
355 error_exit:
356   if (error_code == EBUSY) {
357       lpPRB->SRB_Status = SS_ASPI_IS_BUSY;
358       TRACE(aspi, "Device busy\n");
359   }
360   else {
361       WARN(aspi, "Failed\n");
362       lpPRB->SRB_Status = SS_ERR;
363   }
364
365   /* I'm not sure exactly error codes work here
366    * We probably should set lpPRB->SRB_TargStat, SRB_HaStat ?
367    */
368   WARN(aspi, "error_exit\n");
369   free(sg_reply_hdr);
370   free(sg_hd);
371   return lpPRB->SRB_Status;
372 }
373 #endif
374
375
376 /***********************************************************************
377  *             GetASPISupportInfo16   (WINASPI.1)
378  */
379
380 WORD WINAPI GetASPISupportInfo16()
381 {
382 #ifdef linux
383     TRACE(aspi, "GETASPISupportInfo16\n");
384     /* high byte SS_COMP - low byte number of host adapters.
385      * FIXME!!! The number of host adapters is incorrect.
386      * I'm not sure how to determine this under linux etc.
387      */
388     return ((SS_COMP << 8) | 1);
389 #else
390     return ((SS_COMP << 8) | 0);
391 #endif
392 }
393
394
395 DWORD ASPI_SendASPICommand(DWORD ptrSRB, UINT16 mode)
396 {
397 #ifdef linux
398   LPSRB16 lpSRB = 0;
399
400   switch (mode)
401   {
402       case ASPI_DOS:
403         if (ptrSRB)
404             lpSRB = (LPSRB16)DOSMEM_MapRealToLinear(ptrSRB);
405         break;
406       case ASPI_WIN16:
407         lpSRB = PTR_SEG_TO_LIN(ptrSRB);
408         break;
409   }
410
411   switch (lpSRB->common.SRB_Cmd) {
412   case SC_HA_INQUIRY:
413     lpSRB->inquiry.SRB_Status = SS_COMP;       /* completed successfully */
414     if (lpSRB->inquiry.SRB_55AASignature == 0x55aa) {
415         TRACE(aspi, "Extended request detected (Adaptec's ASPIxDOS).\nWe don't support it at the moment.\n");
416     }
417     lpSRB->inquiry.SRB_ExtBufferSize = 0x2000; /* bogus value */
418     lpSRB->inquiry.HA_Count = 1;               /* not always */
419     lpSRB->inquiry.HA_SCSI_ID = 7;             /* not always ID 7 */
420     strcat(lpSRB->inquiry.HA_ManagerId, "Wine ASPI16"); /* max 15 chars */
421     strcat(lpSRB->inquiry.HA_Identifier, "Wine host"); /* FIXME: return host
422 adapter name */
423     memset(lpSRB->inquiry.HA_Unique, 0, 16); /* default HA_Unique content */
424     lpSRB->inquiry.HA_Unique[6] = 0x02; /* Maximum Transfer Length (128K, Byte> 4-7) */
425     FIXME(aspi, "ASPI: Partially implemented SC_HA_INQUIRY for adapter %d.\n", lpSRB->inquiry.SRB_HaId);
426     return SS_COMP;
427   case SC_GET_DEV_TYPE:
428     FIXME(aspi, "Not implemented SC_GET_DEV_TYPE\n");
429     break;
430   case SC_EXEC_SCSI_CMD:
431     return ASPI_ExecScsiCmd((DWORD)ptrSRB, mode);
432     break;
433   case SC_RESET_DEV:
434     FIXME(aspi, "Not implemented SC_RESET_DEV\n");
435     break;
436   default:
437     WARN(aspi, "Unknown command %d\n", lpSRB->common.SRB_Cmd);
438   }
439   return SS_INVALID_SRB;
440 #else
441   return SS_INVALID_SRB;
442 #endif
443 }
444
445
446 /***********************************************************************
447  *             SendASPICommand16   (WINASPI.2)
448  */
449 WORD WINAPI SendASPICommand16(SEGPTR segptr_srb)
450 {
451 #ifdef linux
452     return ASPI_SendASPICommand(segptr_srb, ASPI_WIN16);
453 #else
454     return 0; 
455 #endif
456 }
457
458
459 /***********************************************************************
460  *             GetASPIDLLVersion16   (WINASPI.4)
461  */
462
463 DWORD WINAPI GetASPIDLLVersion16()
464 {
465 #ifdef linux
466         return (DWORD)2;
467 #else
468         return (DWORD)0;
469 #endif
470 }
471
472
473 void WINAPI ASPI_DOS_func(CONTEXT *context)
474 {
475         WORD *stack = CTX_SEG_OFF_TO_LIN(context, SS_reg(context), ESP_reg(context));
476         DWORD ptrSRB = *(DWORD *)&stack[2];
477
478         ASPI_SendASPICommand(ptrSRB, ASPI_DOS);
479
480         /* simulate a normal RETF sequence as required by DPMI CallRMProcFar */
481         IP_reg(context) = *(stack++);
482         CS_reg(context) = *(stack++);
483         SP_reg(context) += 2*sizeof(WORD);
484 }
485
486
487 /* returns the address of a real mode callback to ASPI_DOS_func() */
488 void ASPI_DOS_HandleInt(CONTEXT *context)
489 {
490 #ifdef linux
491         FARPROC16 *p = (FARPROC16 *)CTX_SEG_OFF_TO_LIN(context, DS_reg(context), EDX_reg(context));
492         if ((CX_reg(context) == 4) || (CX_reg(context) == 5))
493         {
494         *p = DPMI_AllocInternalRMCB(ASPI_DOS_func);
495         TRACE(aspi, "allocated real mode proc %p\n", *p);
496             AX_reg(context) = CX_reg(context);
497         }
498         else
499         SET_CFLAG(context);
500 #else
501        SET_CFLAG(context);
502 #endif
503 }