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