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