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