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