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