- New implementation of SendMessage, ReceiveMessage, ReplyMessage functions
[wine] / dlls / wnaspi32 / winaspi32.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
11 #include "winbase.h"
12 #include "aspi.h"
13 #include "wnaspi32.h"
14 #include "options.h"
15 #include "heap.h"
16 #include "debug.h"
17
18
19 /* FIXME!
20  * 1) Residual byte length reporting not handled
21  * 2) Make this code re-entrant for multithreading
22  * 3) Only linux supported so far
23  */
24
25 #ifdef linux
26 static int
27 ASPI_OpenDevice32(SRB_ExecSCSICmd32 *prb)
28 {
29     int fd;
30     char        idstr[20];
31     char        device_str[50];
32     ASPI_DEVICE_INFO *curr;
33
34     /* search list of devices to see if we've opened it already.
35      * There is not an explicit open/close in ASPI land, so hopefully
36      * keeping a device open won't be a problem.
37      */
38
39     for (curr = ASPI_open_devices; curr; curr = curr->next) {
40         if (curr->hostId == prb->SRB_HaId &&
41             curr->target == prb->SRB_Target &&
42             curr->lun == prb->SRB_Lun) {
43             return curr->fd;
44         }
45     }
46
47     /* device wasn't cached, go ahead and open it */
48     sprintf(idstr, "scsi c%1dt%1dd%1d", prb->SRB_HaId, prb->SRB_Target, prb->SRB_Lun);
49
50     if (!PROFILE_GetWineIniString(idstr, "Device", "", device_str, sizeof(device_str))) {
51         TRACE(aspi, "Trying to open unlisted scsi device %s\n", idstr);
52         return -1;
53     }
54
55     TRACE(aspi, "Opening device %s=%s\n", idstr, device_str);
56
57     fd = open(device_str, O_RDWR);
58     if (fd == -1) {
59         int save_error = errno;
60 #ifdef HAVE_STRERROR
61     ERR(aspi, "Error opening device %s, error '%s'\n", device_str, strerror(save_error));
62 #else
63     ERR(aspi, "Error opening device %s, error %d\n", device_str, save_error);
64 #endif
65         return -1;
66     }
67
68     /* device is now open */
69     curr = HeapAlloc( SystemHeap, 0, sizeof(ASPI_DEVICE_INFO) );
70     curr->fd = fd;
71     curr->hostId = prb->SRB_HaId;
72     curr->target = prb->SRB_Target;
73     curr->lun = prb->SRB_Lun;
74
75     /* insert new record at beginning of open device list */
76     curr->next = ASPI_open_devices;
77     ASPI_open_devices = curr;
78     return fd;
79 }
80
81
82 static void
83 ASPI_DebugPrintCmd32(SRB_ExecSCSICmd32 *prb)
84 {
85   BYTE  cmd;
86   int   i;
87   BYTE *cdb;
88   dbg_decl_str(aspi, 512);
89
90   switch (prb->CDBByte[0]) {
91   case CMD_INQUIRY:
92     TRACE(aspi, "{\n");
93     TRACE(aspi, "\tEVPD: %d\n", prb->CDBByte[1] & 1);
94     TRACE(aspi, "\tLUN: %d\n", (prb->CDBByte[1] & 0xc) >> 1);
95     TRACE(aspi, "\tPAGE CODE: %d\n", prb->CDBByte[2]);
96     TRACE(aspi, "\tALLOCATION LENGTH: %d\n", prb->CDBByte[4]);
97     TRACE(aspi, "\tCONTROL: %d\n", prb->CDBByte[5]);
98     TRACE(aspi, "}\n");
99     break;
100   case CMD_SCAN_SCAN:
101     TRACE(aspi, "Transfer Length: %d\n", prb->CDBByte[4]);
102     break;
103   }
104
105   TRACE(aspi, "Host Adapter: %d\n", prb->SRB_HaId);
106   TRACE(aspi, "Flags: %d\n", prb->SRB_Flags);
107   if (TARGET_TO_HOST(prb)) {
108     TRACE(aspi, "\tData transfer: Target to host. Length checked.\n");
109   }
110   else if (HOST_TO_TARGET(prb)) {
111     TRACE(aspi, "\tData transfer: Host to target. Length checked.\n");
112   }
113   else if (NO_DATA_TRANSFERED(prb)) {
114     TRACE(aspi, "\tData transfer: none\n");
115   }
116   else {
117     WARN(aspi, "\tTransfer by scsi cmd. Length not checked.\n");
118   }
119
120   TRACE(aspi, "\tResidual byte length reporting %s\n", prb->SRB_Flags & 0x4 ? "enabled" : "disabled");
121   TRACE(aspi, "\tLinking %s\n", prb->SRB_Flags & 0x2 ? "enabled" : "disabled");
122   TRACE(aspi, "\tPosting %s\n", prb->SRB_Flags & 0x1 ? "enabled" : "disabled");
123   TRACE(aspi, "Target: %d\n", prb->SRB_Target);
124   TRACE(aspi, "Lun: %d\n", prb->SRB_Lun);
125   TRACE(aspi, "BufLen: %ld\n", prb->SRB_BufLen);
126   TRACE(aspi, "SenseLen: %d\n", prb->SRB_SenseLen);
127   TRACE(aspi, "BufPtr: %p\n", prb->SRB_BufPointer);
128   TRACE(aspi, "CDB Length: %d\n", prb->SRB_CDBLen);
129   TRACE(aspi, "POST Proc: %lx\n", (DWORD) prb->SRB_PostProc);
130   cdb = &prb->CDBByte[0];
131   cmd = prb->CDBByte[0];
132   for (i = 0; i < prb->SRB_CDBLen; i++) {
133     if (i != 0) dsprintf(aspi, ",");
134     dsprintf(aspi, "%02x", *cdb++);
135   }
136   TRACE(aspi, "CDB buffer[%s]\n", dbg_str(aspi));
137 }
138
139 static void
140 ASPI_PrintSenseArea32(SRB_ExecSCSICmd32 *prb)
141 {
142   int   i;
143   BYTE *cdb;
144   dbg_decl_str(aspi, 512);
145
146   cdb = &prb->CDBByte[0];
147   for (i = 0; i < prb->SRB_SenseLen; i++) {
148     if (i) dsprintf(aspi, ",");
149     dsprintf(aspi, "%02x", *cdb++);
150   }
151   TRACE(aspi, "SenseArea[%s]\n", dbg_str(aspi));
152 }
153
154 static void
155 ASPI_DebugPrintResult32(SRB_ExecSCSICmd32 *prb)
156 {
157
158   switch (prb->CDBByte[0]) {
159   case CMD_INQUIRY:
160     TRACE(aspi, "Vendor: '%s'\n", prb->SRB_BufPointer + INQUIRY_VENDOR);
161     break;
162   case CMD_TEST_UNIT_READY:
163     ASPI_PrintSenseArea32(prb);
164     break;
165   }
166 }
167
168 static WORD
169 ASPI_ExecScsiCmd32(SRB_ExecSCSICmd32 *lpPRB)
170 {
171   struct sg_header *sg_hd, *sg_reply_hdr;
172   int   status;
173   int   in_len, out_len;
174   int   error_code = 0;
175   int   fd;
176
177   ASPI_DebugPrintCmd32(lpPRB);
178
179   fd = ASPI_OpenDevice32(lpPRB);
180   if (fd == -1) {
181       ERR(aspi, "Failed: could not open device. Device permissions !?\n");
182       lpPRB->SRB_Status = SS_ERR;
183       return SS_ERR;
184   }
185
186   sg_hd = NULL;
187   sg_reply_hdr = NULL;
188
189   lpPRB->SRB_Status = SS_PENDING;
190
191   if (!lpPRB->SRB_CDBLen) {
192       WARN(aspi, "Failed: lpPRB->SRB_CDBLen = 0.\n");
193       lpPRB->SRB_Status = SS_ERR;
194       return SS_ERR;
195   }
196
197   /* build up sg_header + scsi cmd */
198   if (HOST_TO_TARGET(lpPRB)) {
199     /* send header, command, and then data */
200     in_len = SCSI_OFF + lpPRB->SRB_CDBLen + lpPRB->SRB_BufLen;
201     sg_hd = (struct sg_header *) malloc(in_len);
202     memset(sg_hd, 0, SCSI_OFF);
203     memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
204     if (lpPRB->SRB_BufLen) {
205       memcpy(((BYTE *) sg_hd) + SCSI_OFF + lpPRB->SRB_CDBLen, lpPRB->SRB_BufPointer, lpPRB->SRB_BufLen);
206     }
207   }
208   else {
209     /* send header and command - no data */
210     in_len = SCSI_OFF + lpPRB->SRB_CDBLen;
211     sg_hd = (struct sg_header *) malloc(in_len);
212     memset(sg_hd, 0, SCSI_OFF);
213     memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
214   }
215
216   if (TARGET_TO_HOST(lpPRB)) {
217     out_len = SCSI_OFF + lpPRB->SRB_BufLen;
218     sg_reply_hdr = (struct sg_header *) malloc(out_len);
219     memset(sg_reply_hdr, 0, SCSI_OFF);
220     sg_hd->reply_len = out_len;
221   }
222   else {
223     out_len = SCSI_OFF;
224     sg_reply_hdr = (struct sg_header *) malloc(out_len);
225     memset(sg_reply_hdr, 0, SCSI_OFF);
226     sg_hd->reply_len = out_len;
227   }
228
229   status = write(fd, sg_hd, in_len);
230   if (status < 0 || status != in_len) {
231       int save_error = errno;
232
233     WARN(aspi, "Not enough bytes written to scsi device bytes=%d .. %d\n", in_len, status);
234     if (status < 0) {
235                 if (save_error == ENOMEM) {
236             MSG("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");
237         }
238 #ifdef HAVE_STRERROR
239                 WARN(aspi, "error:= '%s'\n", strerror(save_error));
240 #else
241                 WARN(aspi, "error:= %d\n", save_error);
242 #endif
243     }
244     goto error_exit;
245   }
246
247   status = read(fd, sg_reply_hdr, out_len);
248   if (status < 0 || status != out_len) {
249     WARN(aspi, "not enough bytes read from scsi device%d\n", status);
250     goto error_exit;
251   }
252
253   if (sg_reply_hdr->result != 0) {
254     error_code = sg_reply_hdr->result;
255     WARN(aspi, "reply header error (%d)\n", sg_reply_hdr->result);
256     goto error_exit;
257   }
258
259   if (TARGET_TO_HOST(lpPRB) && lpPRB->SRB_BufLen) {
260     memcpy(lpPRB->SRB_BufPointer, sg_reply_hdr + 1, lpPRB->SRB_BufLen);
261   }
262
263   /* copy in sense buffer to amount that is available in client */
264   if (lpPRB->SRB_SenseLen) {
265     int sense_len = lpPRB->SRB_SenseLen;
266     if (lpPRB->SRB_SenseLen > 16)
267       sense_len = 16;
268     memcpy(SENSE_BUFFER(lpPRB), &sg_reply_hdr->sense_buffer[0], sense_len);
269   }
270
271
272   lpPRB->SRB_Status = SS_COMP;
273   lpPRB->SRB_HaStat = HASTAT_OK;
274   lpPRB->SRB_TargStat = STATUS_GOOD;
275
276   /* now do posting */
277
278   if (lpPRB->SRB_PostProc) {
279     if (ASPI_POSTING(lpPRB)) {
280       TRACE(aspi, "Post Routine (%lx) called\n", (DWORD) lpPRB->SRB_PostProc);
281       (*lpPRB->SRB_PostProc)(lpPRB);
282     }
283     else
284     if (lpPRB->SRB_Flags & SRB_EVENT_NOTIFY) {
285       TRACE(aspi, "Setting event %04x\n", (HANDLE32)lpPRB->SRB_PostProc);
286       SetEvent((HANDLE32)lpPRB->SRB_PostProc); /* FIXME: correct ? */
287     }
288   }
289   free(sg_reply_hdr);
290   free(sg_hd);
291   ASPI_DebugPrintResult32(lpPRB);
292   return SS_COMP;
293   
294 error_exit:
295   if (error_code == EBUSY) {
296       lpPRB->SRB_Status = SS_ASPI_IS_BUSY;
297       TRACE(aspi, "Device busy\n");
298   }
299   else {
300       WARN(aspi, "Failed\n");
301       lpPRB->SRB_Status = SS_ERR;
302   }
303
304   /* I'm not sure exactly error codes work here
305    * We probably should set lpPRB->SRB_TargStat, SRB_HaStat ?
306    */
307   WARN(aspi, "error_exit\n");
308   free(sg_reply_hdr);
309   free(sg_hd);
310   return lpPRB->SRB_Status;
311 }
312 #endif
313
314
315 /*******************************************************************
316  *     GetASPI32SupportInfo32           [WNASPI32.0]
317  *
318  * Checks if the ASPI subsystem is initialized correctly.
319  *
320  * RETURNS
321  *    HIWORD: 0.
322  *    HIBYTE of LOWORD: status (SS_COMP or SS_FAILED_INIT)
323  *    LOBYTE of LOWORD: # of host adapters.  
324  */
325 DWORD WINAPI GetASPI32SupportInfo32()
326 {
327     return ((SS_COMP << 8) | 1); /* FIXME: get # of host adapters installed */
328 }
329
330
331 /***********************************************************************
332  *             SendASPI32Command32 (WNASPI32.1)
333  */
334 DWORD __cdecl SendASPI32Command32(LPSRB32 lpSRB)
335 {
336 #ifdef linux
337   switch (lpSRB->common.SRB_Cmd) {
338   case SC_HA_INQUIRY:
339     lpSRB->inquiry.SRB_Status = SS_COMP;       /* completed successfully */
340     lpSRB->inquiry.HA_Count = 1;               /* not always */
341     lpSRB->inquiry.HA_SCSI_ID = 7;             /* not always ID 7 */
342     strcat(lpSRB->inquiry.HA_ManagerId, "ASPI for WIN32"); /* max 15 chars, don't change */
343     strcat(lpSRB->inquiry.HA_Identifier, "Wine host"); /* FIXME: return host adapter name */
344     memset(lpSRB->inquiry.HA_Unique, 0, 16); /* default HA_Unique content */
345     lpSRB->inquiry.HA_Unique[6] = 0x02; /* Maximum Transfer Length (128K, Byte> 4-7) */
346     FIXME(aspi, "ASPI: Partially implemented SC_HA_INQUIRY for adapter %d.\n", lpSRB->inquiry.SRB_HaId);
347     return SS_COMP;
348   case SC_GET_DEV_TYPE:
349     FIXME(aspi, "Not implemented SC_GET_DEV_TYPE\n");
350     break;
351   case SC_EXEC_SCSI_CMD:
352     return ASPI_ExecScsiCmd32(&lpSRB->cmd);
353     break;
354   case SC_RESET_DEV:
355     FIXME(aspi, "Not implemented SC_RESET_DEV\n");
356     break;
357   default:
358     WARN(aspi, "Unknown command %d\n", lpSRB->common.SRB_Cmd);
359   }
360   return SS_INVALID_SRB;
361 #else
362   return SS_INVALID_SRB;
363 #endif
364 }
365
366
367 /***********************************************************************
368  *             GetASPI32DLLVersion32   (WNASPI32.3)
369  */
370
371 DWORD WINAPI GetASPI32DLLVersion32()
372 {
373 #ifdef linux
374         return (DWORD)1;
375 #else
376         return (DWORD)0;
377 #endif
378 }
379