Removed some unnecessary includes.
[wine.git] / dlls / winaspi / winaspi32.c
blob3f490b0c36783b40f2e3a931b7d20106a231e783
1 #include "config.h"
3 #include <assert.h>
4 #include <stdlib.h>
5 #include <stdio.h>
6 #include <sys/types.h>
7 #include <sys/stat.h>
8 #include <errno.h>
9 #include <fcntl.h>
10 #include <memory.h>
11 #include <unistd.h>
13 #include "winbase.h"
14 #include "aspi.h"
15 #include "wnaspi32.h"
16 #include "winescsi.h"
17 #include "options.h"
18 #include "heap.h"
19 #include "debugtools.h"
21 DEFAULT_DEBUG_CHANNEL(aspi);
23 /* FIXME!
24 * 1) Residual byte length reporting not handled
25 * 2) Make this code re-entrant for multithreading
26 * -- Added CriticalSection to OpenDevices function
27 * 3) Only linux supported so far
28 * 4) Leaves sg devices open. This may or may not be okay. A better solution
29 * would be to close the file descriptors when the thread/process using
30 * them no longer needs them.
33 #ifdef linux
35 static ASPI_DEVICE_INFO *ASPI_open_devices = NULL;
36 static CRITICAL_SECTION ASPI_CritSection;
38 #endif /* defined(linux) */
41 BOOL WINAPI WNASPI32_LibMain(HINSTANCE hInstDLL, DWORD fdwReason, LPVOID fImpLoad)
43 #ifdef linux
44 static BOOL bInitDone=FALSE;
45 #if 0
46 TRACE("0x%x 0x%1x %p\n", hInstDLL, fdwReason, fImpLoad);
47 #endif
48 switch( fdwReason )
50 case DLL_PROCESS_ATTACH:
51 /* Create instance data */
52 if(!bInitDone)
54 bInitDone=TRUE;
55 /* Initialize global stuff just once */
56 InitializeCriticalSection(&ASPI_CritSection);
57 SCSI_Init();
59 break;
60 case DLL_PROCESS_DETACH:
61 /* Destroy instance data */
62 break;
63 case DLL_THREAD_ATTACH:
64 case DLL_THREAD_DETACH:
65 break;
67 return TRUE;
68 #else /* defined(linux) */
69 return TRUE;
70 #endif /* defined(linux) */
74 #ifdef linux
76 static int
77 ASPI_OpenDevice(SRB_ExecSCSICmd *prb)
79 int fd;
80 DWORD hc;
81 ASPI_DEVICE_INFO *curr;
83 /* search list of devices to see if we've opened it already.
84 * There is not an explicit open/close in ASPI land, so hopefully
85 * keeping a device open won't be a problem.
88 EnterCriticalSection(&ASPI_CritSection);
89 for (curr = ASPI_open_devices; curr; curr = curr->next) {
90 if (curr->hostId == prb->SRB_HaId &&
91 curr->target == prb->SRB_Target &&
92 curr->lun == prb->SRB_Lun) {
93 LeaveCriticalSection(&ASPI_CritSection);
94 return curr->fd;
97 LeaveCriticalSection(&ASPI_CritSection);
99 hc = ASPI_GetHCforController( prb->SRB_HaId );
100 fd = SCSI_OpenDevice( HIWORD(hc), LOWORD(hc), prb->SRB_Target, prb->SRB_Lun);
102 if (fd == -1) {
103 return -1;
106 /* device is now open */
107 /* FIXME: Let users specify SCSI timeout in registry */
108 SCSI_LinuxSetTimeout( fd, SCSI_DEFAULT_TIMEOUT );
110 curr = HeapAlloc( GetProcessHeap(), 0, sizeof(ASPI_DEVICE_INFO) );
111 curr->fd = fd;
112 curr->hostId = prb->SRB_HaId;
113 curr->target = prb->SRB_Target;
114 curr->lun = prb->SRB_Lun;
116 /* insert new record at beginning of open device list */
117 EnterCriticalSection(&ASPI_CritSection);
118 curr->next = ASPI_open_devices;
119 ASPI_open_devices = curr;
120 LeaveCriticalSection(&ASPI_CritSection);
121 return fd;
125 static void
126 ASPI_DebugPrintCmd(SRB_ExecSCSICmd *prb)
128 BYTE cmd;
129 int i;
130 BYTE *cdb;
132 switch (prb->CDBByte[0]) {
133 case CMD_INQUIRY:
134 TRACE("INQUIRY {\n");
135 TRACE("\tEVPD: %d\n", prb->CDBByte[1] & 1);
136 TRACE("\tLUN: %d\n", (prb->CDBByte[1] & 0xc) >> 1);
137 TRACE("\tPAGE CODE: %d\n", prb->CDBByte[2]);
138 TRACE("\tALLOCATION LENGTH: %d\n", prb->CDBByte[4]);
139 TRACE("\tCONTROL: %d\n", prb->CDBByte[5]);
140 TRACE("}\n");
141 break;
142 case CMD_SCAN_SCAN:
143 TRACE("Transfer Length: %d\n", prb->CDBByte[4]);
144 break;
147 TRACE("Host Adapter: %d\n", prb->SRB_HaId);
148 TRACE("Flags: %d\n", prb->SRB_Flags);
149 if (TARGET_TO_HOST(prb)) {
150 TRACE("\tData transfer: Target to host. Length checked.\n");
152 else if (HOST_TO_TARGET(prb)) {
153 TRACE("\tData transfer: Host to target. Length checked.\n");
155 else if (NO_DATA_TRANSFERED(prb)) {
156 TRACE("\tData transfer: none\n");
158 else {
159 WARN("\tTransfer by scsi cmd. Length not checked.\n");
162 TRACE("\tResidual byte length reporting %s\n", prb->SRB_Flags & 0x4 ? "enabled" : "disabled");
163 TRACE("\tLinking %s\n", prb->SRB_Flags & 0x2 ? "enabled" : "disabled");
164 TRACE("\tPosting %s\n", prb->SRB_Flags & 0x1 ? "enabled" : "disabled");
165 TRACE("Target: %d\n", prb->SRB_Target);
166 TRACE("Lun: %d\n", prb->SRB_Lun);
167 TRACE("BufLen: %ld\n", prb->SRB_BufLen);
168 TRACE("SenseLen: %d\n", prb->SRB_SenseLen);
169 TRACE("BufPtr: %p\n", prb->SRB_BufPointer);
170 TRACE("CDB Length: %d\n", prb->SRB_CDBLen);
171 TRACE("POST Proc: %lx\n", (DWORD) prb->SRB_PostProc);
172 cdb = &prb->CDBByte[0];
173 cmd = prb->CDBByte[0];
174 if (TRACE_ON(aspi)) {
175 DPRINTF("CDB buffer[");
176 for (i = 0; i < prb->SRB_CDBLen; i++) {
177 if (i != 0) DPRINTF(",");
178 DPRINTF("%02x", *cdb++);
180 DPRINTF("]\n");
184 static void
185 ASPI_PrintCDBArea(SRB_ExecSCSICmd *prb)
187 if (TRACE_ON(aspi))
189 int i;
190 DPRINTF("CDB[");
191 for (i = 0; i < prb->SRB_CDBLen; i++) {
192 if (i) DPRINTF(",");
193 DPRINTF("%02x", prb->CDBByte[i]);
195 DPRINTF("]\n");
199 static void
200 ASPI_PrintSenseArea(SRB_ExecSCSICmd *prb)
202 int i;
203 BYTE *rqbuf = prb->SenseArea;
205 if (TRACE_ON(aspi))
207 DPRINTF("Request Sense reports:\n");
208 if ((rqbuf[0]&0x7f)!=0x70) {
209 DPRINTF("\tInvalid sense header: 0x%02x instead of 0x70\n", rqbuf[0]&0x7f);
210 return;
212 DPRINTF("\tCurrent command read filemark: %s\n",(rqbuf[2]&0x80)?"yes":"no");
213 DPRINTF("\tEarly warning passed: %s\n",(rqbuf[2]&0x40)?"yes":"no");
214 DPRINTF("\tIncorrect blocklength: %s\n",(rqbuf[2]&0x20)?"yes":"no");
215 DPRINTF("\tSense Key: %d\n",rqbuf[2]&0xf);
216 if (rqbuf[0]&0x80)
217 DPRINTF("\tResidual Length: %d\n",rqbuf[3]*0x1000000+rqbuf[4]*0x10000+rqbuf[5]*0x100+rqbuf[6]);
218 DPRINTF("\tAdditional Sense Length: %d\n",rqbuf[7]);
219 DPRINTF("\tAdditional Sense Code: %d\n",rqbuf[12]);
220 DPRINTF("\tAdditional Sense Code Qualifier: %d\n",rqbuf[13]);
221 if (rqbuf[15]&0x80) {
222 DPRINTF("\tIllegal Param is in %s\n",(rqbuf[15]&0x40)?"the CDB":"the Data Out Phase");
223 if (rqbuf[15]&0x8) {
224 DPRINTF("Pointer at %d, bit %d\n",rqbuf[16]*256+rqbuf[17],rqbuf[15]&0x7);
227 DPRINTF("SenseArea[");
228 for (i = 0; i < prb->SRB_SenseLen; i++) {
229 if (i) DPRINTF(",");
230 DPRINTF("%02x", *rqbuf++);
232 DPRINTF("]\n");
236 static void
237 ASPI_DebugPrintResult(SRB_ExecSCSICmd *prb)
240 TRACE("SRB_Status: %x\n", prb->SRB_Status);
241 TRACE("SRB_HaStat: %x\n", prb->SRB_HaStat);
242 TRACE("SRB_TargStat: %x\n", prb->SRB_TargStat);
243 switch (prb->CDBByte[0]) {
244 case CMD_INQUIRY:
245 TRACE("Vendor: '%s'\n", prb->SRB_BufPointer + INQUIRY_VENDOR);
246 break;
247 case CMD_TEST_UNIT_READY:
248 ASPI_PrintSenseArea(prb);
249 break;
253 /* Posting must be done in such a way that as soon as the SRB_Status is set
254 * we don't touch the SRB anymore because it could possibly be freed
255 * if the app is doing ASPI polling
257 static DWORD
258 WNASPI32_DoPosting( SRB_ExecSCSICmd *lpPRB, DWORD status )
260 void (*SRB_PostProc)() = lpPRB->SRB_PostProc;
261 BYTE SRB_Flags = lpPRB->SRB_Flags;
262 if( status == SS_PENDING )
264 WARN("Tried posting SS_PENDING\n");
265 return SS_PENDING;
267 lpPRB->SRB_Status = status;
268 /* lpPRB is NOT safe, it could be freed in another thread */
270 if (SRB_PostProc)
272 if (SRB_Flags & 0x1)
274 TRACE("Post Routine (%lx) called\n", (DWORD) SRB_PostProc);
275 /* Even though lpPRB could have been freed by
276 * the program.. that's unlikely if it planned
277 * to use it in the PostProc
279 (*SRB_PostProc)(lpPRB);
281 else if (SRB_Flags & SRB_EVENT_NOTIFY) {
282 TRACE("Setting event %04x\n", (HANDLE)SRB_PostProc);
283 SetEvent((HANDLE)SRB_PostProc);
286 return SS_PENDING;
289 static WORD
290 ASPI_ExecScsiCmd(SRB_ExecSCSICmd *lpPRB)
292 struct sg_header *sg_hd, *sg_reply_hdr;
293 DWORD status;
294 int in_len, out_len;
295 int error_code = 0;
296 int fd;
297 DWORD SRB_Status;
299 /* FIXME: hackmode */
300 #define MAKE_TARGET_TO_HOST(lpPRB) \
301 if (!TARGET_TO_HOST(lpPRB)) { \
302 WARN("program was not sending target_to_host for cmd %x (flags=%x),correcting.\n",lpPRB->CDBByte[0],lpPRB->SRB_Flags); \
303 lpPRB->SRB_Flags |= 8; \
305 #define MAKE_HOST_TO_TARGET(lpPRB) \
306 if (!HOST_TO_TARGET(lpPRB)) { \
307 WARN("program was not sending host_to_target for cmd %x (flags=%x),correcting.\n",lpPRB->CDBByte[0],lpPRB->SRB_Flags); \
308 lpPRB->SRB_Flags |= 0x10; \
310 switch (lpPRB->CDBByte[0]) {
311 case 0x12: /* INQUIRY */
312 case 0x5a: /* MODE_SENSE_10 */
313 case 0xa4: /* REPORT_KEY (DVD) MMC-2 */
314 case 0xad: /* READ DVD STRUCTURE MMC-2 */
315 MAKE_TARGET_TO_HOST(lpPRB)
316 break;
317 case 0xa3: /* SEND KEY (DVD) MMC-2 */
318 MAKE_HOST_TO_TARGET(lpPRB)
319 break;
320 default:
321 if ((((lpPRB->SRB_Flags & 0x18) == 0x00) ||
322 ((lpPRB->SRB_Flags & 0x18) == 0x18)
323 ) && lpPRB->SRB_BufLen
325 FIXME("command 0x%02x, no data transfer specified, but buflen is %ld!!!\n",lpPRB->CDBByte[0],lpPRB->SRB_BufLen);
327 break;
329 ASPI_DebugPrintCmd(lpPRB);
330 fd = ASPI_OpenDevice(lpPRB);
331 if (fd == -1) {
332 return WNASPI32_DoPosting( lpPRB, SS_NO_DEVICE );
335 sg_hd = NULL;
336 sg_reply_hdr = NULL;
338 lpPRB->SRB_Status = SS_PENDING;
340 if (!lpPRB->SRB_CDBLen) {
341 ERR("Failed: lpPRB->SRB_CDBLen = 0.\n");
342 return WNASPI32_DoPosting( lpPRB, SS_INVALID_SRB );
345 /* build up sg_header + scsi cmd */
346 if (HOST_TO_TARGET(lpPRB)) {
347 /* send header, command, and then data */
348 in_len = SCSI_OFF + lpPRB->SRB_CDBLen + lpPRB->SRB_BufLen;
349 sg_hd = (struct sg_header *) HeapAlloc(GetProcessHeap(), 0, in_len);
350 memset(sg_hd, 0, SCSI_OFF);
351 memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
352 if (lpPRB->SRB_BufLen) {
353 memcpy(((BYTE *) sg_hd) + SCSI_OFF + lpPRB->SRB_CDBLen, lpPRB->SRB_BufPointer, lpPRB->SRB_BufLen);
356 else {
357 /* send header and command - no data */
358 in_len = SCSI_OFF + lpPRB->SRB_CDBLen;
359 sg_hd = (struct sg_header *) HeapAlloc(GetProcessHeap(), 0, in_len);
360 memset(sg_hd, 0, SCSI_OFF);
361 memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
364 if (TARGET_TO_HOST(lpPRB)) {
365 out_len = SCSI_OFF + lpPRB->SRB_BufLen;
366 sg_reply_hdr = (struct sg_header *) HeapAlloc(GetProcessHeap(), 0, out_len);
367 memset(sg_reply_hdr, 0, SCSI_OFF);
368 sg_hd->reply_len = out_len;
370 else {
371 out_len = SCSI_OFF;
372 sg_reply_hdr = (struct sg_header *) HeapAlloc(GetProcessHeap(), 0, out_len);
373 memset(sg_reply_hdr, 0, SCSI_OFF);
374 sg_hd->reply_len = out_len;
377 SCSI_Fix_CMD_LEN(fd, lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
379 if(!SCSI_LinuxDeviceIo( fd,
380 sg_hd, in_len,
381 sg_reply_hdr, out_len,
382 &status) )
384 goto error_exit;
387 if (sg_reply_hdr->result != 0) {
388 error_code = sg_reply_hdr->result;
389 WARN("reply header error (%d)\n", sg_reply_hdr->result);
390 goto error_exit;
393 if (TARGET_TO_HOST(lpPRB) && lpPRB->SRB_BufLen) {
394 memcpy(lpPRB->SRB_BufPointer, sg_reply_hdr + 1, lpPRB->SRB_BufLen);
397 /* copy in sense buffer to amount that is available in client */
398 if (lpPRB->SRB_SenseLen) {
399 int sense_len = lpPRB->SRB_SenseLen;
400 if (lpPRB->SRB_SenseLen > 16)
401 sense_len = 16;
403 /* CDB is fixed in WNASPI32 */
404 memcpy(lpPRB->SenseArea, &sg_reply_hdr->sense_buffer[0], sense_len);
406 ASPI_PrintCDBArea(lpPRB);
407 ASPI_PrintSenseArea(lpPRB);
410 SRB_Status = SS_COMP;
411 lpPRB->SRB_HaStat = HASTAT_OK;
412 lpPRB->SRB_TargStat = sg_reply_hdr->target_status << 1;
414 HeapFree(GetProcessHeap(), 0, sg_reply_hdr);
415 HeapFree(GetProcessHeap(), 0, sg_hd);
417 /* FIXME: Should this be != 0 maybe? */
418 if( lpPRB->SRB_TargStat == 2 ) {
419 SRB_Status = SS_ERR;
420 switch (lpPRB->CDBByte[0]) {
421 case 0xa4: /* REPORT_KEY (DVD) MMC-2 */
422 case 0xa3: /* SEND KEY (DVD) MMC-2 */
423 SRB_Status = SS_COMP;
424 lpPRB->SRB_TargStat = 0;
425 FIXME("Program wants to do DVD Region switching, but fails (non compliant DVD drive). Ignoring....\n");
426 break;
430 ASPI_DebugPrintResult(lpPRB);
431 /* now do posting */
432 return WNASPI32_DoPosting( lpPRB, SRB_Status );
433 /* In real WNASPI32 stuff really is always pending because ASPI does things
434 in the background, but we are not doing that (yet) */
436 error_exit:
437 SRB_Status = SS_ERR;
438 if (error_code == EBUSY) {
439 WNASPI32_DoPosting( lpPRB, SS_ASPI_IS_BUSY );
440 TRACE("Device busy\n");
441 } else
442 FIXME("Failed\n");
444 /* I'm not sure exactly error codes work here
445 * We probably should set lpPRB->SRB_TargStat, SRB_HaStat ?
447 WARN("error_exit\n");
448 HeapFree(GetProcessHeap(), 0, sg_reply_hdr);
449 HeapFree(GetProcessHeap(), 0, sg_hd);
450 WNASPI32_DoPosting( lpPRB, SRB_Status );
451 return SS_PENDING;
454 #endif /* defined(linux) */
457 /*******************************************************************
458 * GetASPI32SupportInfo [WNASPI32.0]
460 * Checks if the ASPI subsystem is initialized correctly.
462 * RETURNS
463 * HIWORD: 0.
464 * HIBYTE of LOWORD: status (SS_COMP or SS_FAILED_INIT)
465 * LOBYTE of LOWORD: # of host adapters.
467 DWORD __cdecl GetASPI32SupportInfo(void)
469 return ((SS_COMP << 8) | ASPI_GetNumControllers());
473 /***********************************************************************
474 * SendASPI32Command (WNASPI32.1)
476 DWORD __cdecl SendASPI32Command(LPSRB lpSRB)
478 #ifdef linux
479 switch (lpSRB->common.SRB_Cmd) {
480 case SC_HA_INQUIRY:
481 lpSRB->inquiry.SRB_Status = SS_COMP; /* completed successfully */
482 lpSRB->inquiry.HA_Count = 1; /* not always */
483 lpSRB->inquiry.HA_SCSI_ID = 7; /* not always ID 7 */
484 strcpy(lpSRB->inquiry.HA_ManagerId, "ASPI for WIN32"); /* max 15 chars, don't change */
485 strcpy(lpSRB->inquiry.HA_Identifier, "Wine host"); /* FIXME: return host adapter name */
486 memset(lpSRB->inquiry.HA_Unique, 0, 16); /* default HA_Unique content */
487 lpSRB->inquiry.HA_Unique[6] = 0x02; /* Maximum Transfer Length (128K, Byte> 4-7) */
488 lpSRB->inquiry.HA_Unique[3] = 0x08; /* Maximum number of SCSI targets */
489 FIXME("ASPI: Partially implemented SC_HA_INQUIRY for adapter %d.\n", lpSRB->inquiry.SRB_HaId);
490 return SS_COMP;
492 case SC_GET_DEV_TYPE: {
493 /* FIXME: We should return SS_NO_DEVICE if the device is not configured */
494 /* FIXME: We should return SS_INVALID_HA if HostAdapter!=0 */
495 SRB tmpsrb;
496 char inqbuf[200];
497 DWORD ret;
499 memset(&tmpsrb,0,sizeof(tmpsrb));
501 /* Copy header */
502 memcpy(&tmpsrb.common,&(lpSRB->common),sizeof(tmpsrb.common));
504 tmpsrb.cmd.SRB_Flags |= 8; /* target to host */
505 tmpsrb.cmd.SRB_Cmd = SC_EXEC_SCSI_CMD;
506 tmpsrb.cmd.SRB_Target = lpSRB->devtype.SRB_Target;
507 tmpsrb.cmd.SRB_Lun = lpSRB->devtype.SRB_Lun;
508 tmpsrb.cmd.SRB_BufLen = sizeof(inqbuf);
509 tmpsrb.cmd.SRB_BufPointer = inqbuf;
510 tmpsrb.cmd.CDBByte[0] = 0x12; /* INQUIRY */
511 /* FIXME: handle lun */
512 tmpsrb.cmd.CDBByte[4] = sizeof(inqbuf);
513 tmpsrb.cmd.SRB_CDBLen = 6;
515 ret = ASPI_ExecScsiCmd(&tmpsrb.cmd);
517 lpSRB->devtype.SRB_Status = tmpsrb.cmd.SRB_Status;
518 lpSRB->devtype.SRB_DeviceType = inqbuf[0]&0x1f;
520 TRACE("returning devicetype %d for target %d\n",inqbuf[0]&0x1f,tmpsrb.cmd.SRB_Target);
521 if (ret!=SS_PENDING) /* Any error is passed down directly */
522 return ret;
523 /* FIXME: knows that the command is finished already, pass final Status */
524 return tmpsrb.cmd.SRB_Status;
526 case SC_EXEC_SCSI_CMD:
527 return ASPI_ExecScsiCmd(&lpSRB->cmd);
528 case SC_ABORT_SRB:
529 FIXME("Not implemented SC_ABORT_SRB\n");
530 break;
531 case SC_RESET_DEV:
532 FIXME("Not implemented SC_RESET_DEV\n");
533 break;
534 #ifdef SC_GET_DISK_INFO
535 case SC_GET_DISK_INFO:
536 /* NT Doesn't implement this either.. so don't feel bad */
537 FIXME("Not implemented SC_GET_DISK_INFO\n");
538 break;
539 #endif
540 default:
541 FIXME("Unknown command %d\n", lpSRB->common.SRB_Cmd);
543 return SS_INVALID_SRB;
544 #else
545 return SS_INVALID_SRB;
546 #endif
550 /***********************************************************************
551 * GetASPI32DLLVersion (WNASPI32.3)
553 DWORD __cdecl GetASPI32DLLVersion(void)
555 #ifdef linux
556 TRACE("Returning version 1\n");
557 return (DWORD)1;
558 #else
559 FIXME("Please add SCSI support for your operating system, returning 0\n");
560 return (DWORD)0;
561 #endif
564 /***********************************************************************
565 * GetASPI32Buffer (WNASPI32.@)
567 BOOL __cdecl GetASPI32Buffer(LPVOID pab) /* [???] FIXME: PASPI32BUFF */
569 FIXME("(%p), stub !\n", pab);
570 return TRUE;
573 /***********************************************************************
574 * FreeASPI32Buffer (WNASPI32.@)
576 BOOL __cdecl FreeASPI32Buffer(LPVOID pab) /* [???] FIXME: PASPI32BUFF */
578 FIXME("(%p), stub !\n", pab);
579 return TRUE;
582 /***********************************************************************
583 * TranslateASPI32Address (WNASPI32.@)
585 BOOL __cdecl TranslateASPI32Address(LPDWORD pdwPath, LPDWORD pdwDEVNODE)
587 FIXME("(%p, %p), stub !\n", pdwPath, pdwDEVNODE);
588 return TRUE;