2 * Copyright 1997 Bruce Milner
3 * Copyright 1998 Andreas Mohr
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
26 #include <sys/types.h>
39 #include "wine/debug.h"
41 WINE_DEFAULT_DEBUG_CHANNEL(aspi);
44 * 1) Residual byte length reporting not handled
45 * 2) Make this code re-entrant for multithreading
46 * -- Added CriticalSection to OpenDevices function
47 * 3) Only linux supported so far
48 * 4) Leaves sg devices open. This may or may not be okay. A better solution
49 * would be to close the file descriptors when the thread/process using
50 * them no longer needs them.
55 static ASPI_DEVICE_INFO *ASPI_open_devices = NULL;
57 static CRITICAL_SECTION ASPI_CritSection;
58 static CRITICAL_SECTION_DEBUG critsect_debug =
60 0, 0, &ASPI_CritSection,
61 { &critsect_debug.ProcessLocksList, &critsect_debug.ProcessLocksList },
62 0, 0, { (DWORD_PTR)(__FILE__ ": ASPI_CritSection") }
64 static CRITICAL_SECTION ASPI_CritSection = { &critsect_debug, -1, 0, 0, 0, 0 };
66 #endif /* defined(linux) */
69 BOOL WINAPI DllMain(HINSTANCE hInstDLL, DWORD fdwReason, LPVOID fImpLoad)
74 case DLL_PROCESS_ATTACH:
75 DisableThreadLibraryCalls(hInstDLL);
78 case DLL_PROCESS_DETACH:
79 DeleteCriticalSection( &ASPI_CritSection );
82 #endif /* defined(linux) */
90 ASPI_OpenDevice(SRB_ExecSCSICmd *prb)
94 ASPI_DEVICE_INFO *curr;
96 /* search list of devices to see if we've opened it already.
97 * There is not an explicit open/close in ASPI land, so hopefully
98 * keeping a device open won't be a problem.
101 EnterCriticalSection(&ASPI_CritSection);
102 for (curr = ASPI_open_devices; curr; curr = curr->next) {
103 if (curr->hostId == prb->SRB_HaId &&
104 curr->target == prb->SRB_Target &&
105 curr->lun == prb->SRB_Lun) {
106 LeaveCriticalSection(&ASPI_CritSection);
110 LeaveCriticalSection(&ASPI_CritSection);
112 if (prb->SRB_HaId >= ASPI_GetNumControllers())
115 hc = ASPI_GetHCforController( prb->SRB_HaId );
116 fd = SCSI_OpenDevice( HIWORD(hc), LOWORD(hc), prb->SRB_Target, prb->SRB_Lun);
121 /* device is now open */
122 /* FIXME: Let users specify SCSI timeout in registry */
123 SCSI_LinuxSetTimeout( fd, SCSI_DEFAULT_TIMEOUT );
125 curr = HeapAlloc( GetProcessHeap(), 0, sizeof(ASPI_DEVICE_INFO) );
127 curr->hostId = prb->SRB_HaId;
128 curr->target = prb->SRB_Target;
129 curr->lun = prb->SRB_Lun;
131 /* insert new record at beginning of open device list */
132 EnterCriticalSection(&ASPI_CritSection);
133 curr->next = ASPI_open_devices;
134 ASPI_open_devices = curr;
135 LeaveCriticalSection(&ASPI_CritSection);
141 ASPI_DebugPrintCmd(SRB_ExecSCSICmd *prb)
146 switch (prb->CDBByte[0]) {
148 TRACE("INQUIRY {\n");
149 TRACE("\tEVPD: %d\n", prb->CDBByte[1] & 1);
150 TRACE("\tLUN: %d\n", (prb->CDBByte[1] & 0xc) >> 1);
151 TRACE("\tPAGE CODE: %d\n", prb->CDBByte[2]);
152 TRACE("\tALLOCATION LENGTH: %d\n", prb->CDBByte[4]);
153 TRACE("\tCONTROL: %d\n", prb->CDBByte[5]);
157 TRACE("Transfer Length: %d\n", prb->CDBByte[4]);
161 TRACE("Host Adapter: %d\n", prb->SRB_HaId);
162 TRACE("Flags: %d\n", prb->SRB_Flags);
163 if (TARGET_TO_HOST(prb)) {
164 TRACE("\tData transfer: Target to host. Length checked.\n");
166 else if (HOST_TO_TARGET(prb)) {
167 TRACE("\tData transfer: Host to target. Length checked.\n");
169 else if (NO_DATA_TRANSFERRED(prb)) {
170 TRACE("\tData transfer: none\n");
173 WARN("\tTransfer by scsi cmd. Length not checked.\n");
176 TRACE("\tResidual byte length reporting %s\n", prb->SRB_Flags & 0x4 ? "enabled" : "disabled");
177 TRACE("\tLinking %s\n", prb->SRB_Flags & 0x2 ? "enabled" : "disabled");
178 TRACE("\tPosting %s\n", prb->SRB_Flags & 0x1 ? "enabled" : "disabled");
179 TRACE("Target: %d\n", prb->SRB_Target);
180 TRACE("Lun: %d\n", prb->SRB_Lun);
181 TRACE("BufLen: %d\n", prb->SRB_BufLen);
182 TRACE("SenseLen: %d\n", prb->SRB_SenseLen);
183 TRACE("BufPtr: %p\n", prb->SRB_BufPointer);
184 TRACE("CDB Length: %d\n", prb->SRB_CDBLen);
185 TRACE("POST Proc: %p\n", prb->SRB_PostProc);
186 cdb = &prb->CDBByte[0];
187 if (TRACE_ON(aspi)) {
188 TRACE("CDB buffer[");
189 for (i = 0; i < prb->SRB_CDBLen; i++) {
190 if (i != 0) TRACE(",");
191 TRACE("%02x", *cdb++);
198 ASPI_PrintCDBArea(SRB_ExecSCSICmd *prb)
204 for (i = 0; i < prb->SRB_CDBLen; i++) {
206 TRACE("%02x", prb->CDBByte[i]);
213 ASPI_PrintSenseArea(SRB_ExecSCSICmd *prb)
216 BYTE *rqbuf = prb->SenseArea;
220 TRACE("Request Sense reports:\n");
221 if ((rqbuf[0]&0x7f)!=0x70) {
222 TRACE("\tInvalid sense header: 0x%02x instead of 0x70\n", rqbuf[0]&0x7f);
225 TRACE("\tCurrent command read filemark: %s\n",(rqbuf[2]&0x80)?"yes":"no");
226 TRACE("\tEarly warning passed: %s\n",(rqbuf[2]&0x40)?"yes":"no");
227 TRACE("\tIncorrect blocklength: %s\n",(rqbuf[2]&0x20)?"yes":"no");
228 TRACE("\tSense Key: %d\n",rqbuf[2]&0xf);
230 TRACE("\tResidual Length: %d\n",rqbuf[3]*0x1000000+rqbuf[4]*0x10000+rqbuf[5]*0x100+rqbuf[6]);
231 TRACE("\tAdditional Sense Length: %d\n",rqbuf[7]);
232 TRACE("\tAdditional Sense Code: %d\n",rqbuf[12]);
233 TRACE("\tAdditional Sense Code Qualifier: %d\n",rqbuf[13]);
234 if (rqbuf[15]&0x80) {
235 TRACE("\tIllegal Param is in %s\n",(rqbuf[15]&0x40)?"the CDB":"the Data Out Phase");
237 TRACE("Pointer at %d, bit %d\n",rqbuf[16]*256+rqbuf[17],rqbuf[15]&0x7);
241 for (i = 0; i < prb->SRB_SenseLen; i++) {
243 TRACE("%02x", *rqbuf++);
250 ASPI_DebugPrintResult(SRB_ExecSCSICmd *prb)
253 TRACE("SRB_Status: %x\n", prb->SRB_Status);
254 TRACE("SRB_HaStat: %x\n", prb->SRB_HaStat);
255 TRACE("SRB_TargStat: %x\n", prb->SRB_TargStat);
256 switch (prb->CDBByte[0]) {
258 TRACE("Vendor: '%s'\n", prb->SRB_BufPointer + INQUIRY_VENDOR);
260 case CMD_TEST_UNIT_READY:
261 ASPI_PrintSenseArea(prb);
266 /* Posting must be done in such a way that as soon as the SRB_Status is set
267 * we don't touch the SRB anymore because it could possibly be freed
268 * if the app is doing ASPI polling
271 WNASPI32_DoPosting( SRB_ExecSCSICmd *lpPRB, DWORD status )
273 void (*SRB_PostProc)() = lpPRB->SRB_PostProc;
274 BYTE SRB_Flags = lpPRB->SRB_Flags;
275 if( status == SS_PENDING )
277 WARN("Tried posting SS_PENDING\n");
280 lpPRB->SRB_Status = status;
281 /* lpPRB is NOT safe, it could be freed in another thread */
287 TRACE("Post Routine (%p) called\n", SRB_PostProc);
288 /* Even though lpPRB could have been freed by
289 * the program.. that's unlikely if it planned
290 * to use it in the PostProc
292 (*SRB_PostProc)(lpPRB);
294 else if (SRB_Flags & SRB_EVENT_NOTIFY) {
295 TRACE("Setting event %p\n", (HANDLE)SRB_PostProc);
296 SetEvent((HANDLE)SRB_PostProc);
303 ASPI_ExecScsiCmd(SRB_ExecSCSICmd *lpPRB)
305 struct sg_header *sg_hd, *sg_reply_hdr;
309 int num_controllers = 0;
314 num_controllers = ASPI_GetNumControllers();
315 if (lpPRB->SRB_HaId >= num_controllers) {
316 WARN("Failed: Wanted hostadapter with index %d, but we have only %d.\n",
317 lpPRB->SRB_HaId, num_controllers
319 return WNASPI32_DoPosting( lpPRB, SS_INVALID_HA );
321 fd = ASPI_OpenDevice(lpPRB);
323 return WNASPI32_DoPosting( lpPRB, SS_NO_DEVICE );
326 /* FIXME: hackmode */
327 #define MAKE_TARGET_TO_HOST(lpPRB) \
328 if (!TARGET_TO_HOST(lpPRB)) { \
329 WARN("program was not sending target_to_host for cmd %x (flags=%x),correcting.\n",lpPRB->CDBByte[0],lpPRB->SRB_Flags); \
330 lpPRB->SRB_Flags |= 0x08; \
332 #define MAKE_HOST_TO_TARGET(lpPRB) \
333 if (!HOST_TO_TARGET(lpPRB)) { \
334 WARN("program was not sending host_to_target for cmd %x (flags=%x),correcting.\n",lpPRB->CDBByte[0],lpPRB->SRB_Flags); \
335 lpPRB->SRB_Flags |= 0x10; \
337 switch (lpPRB->CDBByte[0]) {
338 case 0x12: /* INQUIRY */
339 case 0x5a: /* MODE_SENSE_10 */
340 case 0xa4: /* REPORT_KEY (DVD) MMC-2 */
341 case 0xad: /* READ DVD STRUCTURE MMC-2 */
342 MAKE_TARGET_TO_HOST(lpPRB)
344 case 0xa3: /* SEND KEY (DVD) MMC-2 */
345 MAKE_HOST_TO_TARGET(lpPRB)
348 if ((((lpPRB->SRB_Flags & 0x18) == 0x00) ||
349 ((lpPRB->SRB_Flags & 0x18) == 0x18)
350 ) && lpPRB->SRB_BufLen
352 FIXME("command 0x%02x, no data transfer specified, but buflen is %d!!!\n",lpPRB->CDBByte[0],lpPRB->SRB_BufLen);
356 ASPI_DebugPrintCmd(lpPRB);
361 lpPRB->SRB_Status = SS_PENDING;
363 if (!lpPRB->SRB_CDBLen) {
364 ERR("Failed: lpPRB->SRB_CDBLen = 0.\n");
365 return WNASPI32_DoPosting( lpPRB, SS_INVALID_SRB );
368 /* build up sg_header + scsi cmd */
369 if (HOST_TO_TARGET(lpPRB)) {
370 /* send header, command, and then data */
371 in_len = SCSI_OFF + lpPRB->SRB_CDBLen + lpPRB->SRB_BufLen;
372 sg_hd = HeapAlloc(GetProcessHeap(), 0, in_len);
373 memset(sg_hd, 0, SCSI_OFF);
374 memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
375 if (lpPRB->SRB_BufLen) {
376 memcpy(((BYTE *) sg_hd) + SCSI_OFF + lpPRB->SRB_CDBLen, lpPRB->SRB_BufPointer, lpPRB->SRB_BufLen);
380 /* send header and command - no data */
381 in_len = SCSI_OFF + lpPRB->SRB_CDBLen;
382 sg_hd = HeapAlloc(GetProcessHeap(), 0, in_len);
383 memset(sg_hd, 0, SCSI_OFF);
384 memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
387 if (TARGET_TO_HOST(lpPRB)) {
388 out_len = SCSI_OFF + lpPRB->SRB_BufLen;
389 sg_reply_hdr = HeapAlloc(GetProcessHeap(), 0, out_len);
390 memset(sg_reply_hdr, 0, SCSI_OFF);
391 sg_hd->reply_len = out_len;
395 sg_reply_hdr = HeapAlloc(GetProcessHeap(), 0, out_len);
396 memset(sg_reply_hdr, 0, SCSI_OFF);
397 sg_hd->reply_len = out_len;
400 SCSI_Fix_CMD_LEN(fd, lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
402 if(!SCSI_LinuxDeviceIo( fd,
404 sg_reply_hdr, out_len,
410 if (sg_reply_hdr->result != 0) {
411 error_code = sg_reply_hdr->result;
412 WARN("reply header error (%d)\n", sg_reply_hdr->result);
416 if (TARGET_TO_HOST(lpPRB) && lpPRB->SRB_BufLen) {
417 memcpy(lpPRB->SRB_BufPointer, sg_reply_hdr + 1, lpPRB->SRB_BufLen);
420 /* copy in sense buffer to amount that is available in client */
421 if (lpPRB->SRB_SenseLen) {
422 int sense_len = lpPRB->SRB_SenseLen;
423 if (lpPRB->SRB_SenseLen > 16)
426 /* CDB is fixed in WNASPI32 */
427 memcpy(lpPRB->SenseArea, &sg_reply_hdr->sense_buffer[0], sense_len);
429 ASPI_PrintCDBArea(lpPRB);
430 ASPI_PrintSenseArea(lpPRB);
433 SRB_Status = SS_COMP;
434 lpPRB->SRB_HaStat = HASTAT_OK;
435 lpPRB->SRB_TargStat = sg_reply_hdr->target_status << 1;
437 HeapFree(GetProcessHeap(), 0, sg_reply_hdr);
438 HeapFree(GetProcessHeap(), 0, sg_hd);
440 /* FIXME: Should this be != 0 maybe? */
441 if( lpPRB->SRB_TargStat == 2 ) {
443 switch (lpPRB->CDBByte[0]) {
444 case 0xa4: /* REPORT_KEY (DVD) MMC-2 */
445 case 0xa3: /* SEND KEY (DVD) MMC-2 */
446 SRB_Status = SS_COMP;
447 lpPRB->SRB_TargStat = 0;
448 FIXME("Program wants to do DVD Region switching, but fails (non compliant DVD drive). Ignoring....\n");
453 ASPI_DebugPrintResult(lpPRB);
455 ret = WNASPI32_DoPosting( lpPRB, SRB_Status );
457 switch (lpPRB->CDBByte[0]) {
459 if (SRB_Status == SS_COMP)
460 return SS_COMP; /* some junk expects ss_comp here. */
466 /* In real WNASPI32 stuff really is always pending because ASPI does things
467 in the background, but we are not doing that (yet) */
473 if (error_code == EBUSY) {
474 WNASPI32_DoPosting( lpPRB, SS_ASPI_IS_BUSY );
475 TRACE("Device busy\n");
479 /* I'm not sure exactly error codes work here
480 * We probably should set lpPRB->SRB_TargStat, SRB_HaStat ?
482 WARN("error_exit\n");
483 HeapFree(GetProcessHeap(), 0, sg_reply_hdr);
484 HeapFree(GetProcessHeap(), 0, sg_hd);
485 WNASPI32_DoPosting( lpPRB, SRB_Status );
489 #endif /* defined(linux) */
492 /*******************************************************************
493 * GetASPI32SupportInfo [WNASPI32.1]
495 * Checks if the ASPI subsystem is initialized correctly.
499 * HIBYTE of LOWORD: status (SS_COMP or SS_FAILED_INIT)
500 * LOBYTE of LOWORD: # of host adapters.
502 DWORD __cdecl GetASPI32SupportInfo(void)
504 DWORD controllers = ASPI_GetNumControllers();
507 return SS_NO_ADAPTERS << 8;
508 return (SS_COMP << 8) | controllers ;
511 /***********************************************************************
512 * SendASPI32Command (WNASPI32.2)
514 DWORD __cdecl SendASPI32Command(LPSRB lpSRB)
517 static const char szId[] = "ASPI for WIN32";
518 static const char szWh[] = "Wine host";
519 switch (lpSRB->common.SRB_Cmd) {
521 lpSRB->inquiry.SRB_Status = SS_COMP; /* completed successfully */
522 lpSRB->inquiry.HA_Count = ASPI_GetNumControllers();
523 lpSRB->inquiry.HA_SCSI_ID = 7; /* not always ID 7 */
524 memcpy(lpSRB->inquiry.HA_ManagerId, szId, sizeof szId); /* max 15 chars, don't change */
525 memcpy(lpSRB->inquiry.HA_Identifier, szWh, sizeof szWh); /* FIXME: return host adapter name */
526 memset(lpSRB->inquiry.HA_Unique, 0, 16); /* default HA_Unique content */
527 lpSRB->inquiry.HA_Unique[6] = 0x02; /* Maximum Transfer Length (128K, Byte> 4-7) */
528 lpSRB->inquiry.HA_Unique[3] = 0x08; /* Maximum number of SCSI targets */
529 FIXME("ASPI: Partially implemented SC_HA_INQUIRY for adapter %d.\n", lpSRB->inquiry.SRB_HaId);
532 case SC_GET_DEV_TYPE: {
533 /* FIXME: We should return SS_NO_DEVICE if the device is not configured */
534 /* FIXME: We should return SS_INVALID_HA if HostAdapter!=0 */
536 unsigned char inqbuf[200];
539 memset(&tmpsrb,0,sizeof(tmpsrb));
542 tmpsrb.common = lpSRB->common;
544 tmpsrb.cmd.SRB_Flags |= 8; /* target to host */
545 tmpsrb.cmd.SRB_Cmd = SC_EXEC_SCSI_CMD;
546 tmpsrb.cmd.SRB_Target = lpSRB->devtype.SRB_Target;
547 tmpsrb.cmd.SRB_Lun = lpSRB->devtype.SRB_Lun;
548 tmpsrb.cmd.SRB_BufLen = sizeof(inqbuf);
549 tmpsrb.cmd.SRB_BufPointer = inqbuf;
550 tmpsrb.cmd.CDBByte[0] = 0x12; /* INQUIRY */
551 /* FIXME: handle lun */
552 tmpsrb.cmd.CDBByte[4] = sizeof(inqbuf);
553 tmpsrb.cmd.SRB_CDBLen = 6;
555 ret = ASPI_ExecScsiCmd(&tmpsrb.cmd);
557 lpSRB->devtype.SRB_Status = tmpsrb.cmd.SRB_Status;
558 lpSRB->devtype.SRB_DeviceType = inqbuf[0]&0x1f;
560 TRACE("returning devicetype %d for target %d\n",inqbuf[0]&0x1f,tmpsrb.cmd.SRB_Target);
561 if (ret!=SS_PENDING) /* Any error is passed down directly */
563 /* FIXME: knows that the command is finished already, pass final Status */
564 return tmpsrb.cmd.SRB_Status;
566 case SC_EXEC_SCSI_CMD:
567 return ASPI_ExecScsiCmd(&lpSRB->cmd);
569 FIXME("Not implemented SC_ABORT_SRB\n");
572 FIXME("Not implemented SC_RESET_DEV\n");
574 case SC_GET_DISK_INFO:
575 /* here we have to find out the int13 / bios association.
576 * We just say we do not have any.
578 FIXME("SC_GET_DISK_INFO always return 'int13 unassociated disk'.\n");
579 lpSRB->diskinfo.SRB_DriveFlags = 0; /* disk is not int13 served */
582 FIXME("Unknown command %d\n", lpSRB->common.SRB_Cmd);
584 return SS_INVALID_SRB;
586 return SS_INVALID_SRB;
591 /***********************************************************************
592 * GetASPI32DLLVersion (WNASPI32.4)
594 DWORD __cdecl GetASPI32DLLVersion(void)
597 TRACE("Returning version 1\n");
600 FIXME("Please add SCSI support for your operating system, returning 0\n");
605 /***********************************************************************
606 * GetASPI32Buffer (WNASPI32.8)
607 * Supposed to return a DMA capable large SCSI buffer.
608 * Our implementation does not use those at all, all buffer stuff is
609 * done in the kernel SG device layer. So we just heapalloc the buffer.
611 BOOL __cdecl GetASPI32Buffer(PASPI32BUFF pab)
613 pab->AB_BufPointer = HeapAlloc(GetProcessHeap(),
614 pab->AB_ZeroFill?HEAP_ZERO_MEMORY:0,
617 if (!pab->AB_BufPointer) return FALSE;
621 /***********************************************************************
622 * FreeASPI32Buffer (WNASPI32.14)
624 BOOL __cdecl FreeASPI32Buffer(PASPI32BUFF pab)
626 HeapFree(GetProcessHeap(),0,pab->AB_BufPointer);
630 /***********************************************************************
631 * TranslateASPI32Address (WNASPI32.7)
633 BOOL __cdecl TranslateASPI32Address(LPDWORD pdwPath, LPDWORD pdwDEVNODE)
635 FIXME("(%p, %p), stub !\n", pdwPath, pdwDEVNODE);