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