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