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)
147 switch (prb->CDBByte[0]) {
149 TRACE("INQUIRY {\n");
150 TRACE("\tEVPD: %d\n", prb->CDBByte[1] & 1);
151 TRACE("\tLUN: %d\n", (prb->CDBByte[1] & 0xc) >> 1);
152 TRACE("\tPAGE CODE: %d\n", prb->CDBByte[2]);
153 TRACE("\tALLOCATION LENGTH: %d\n", prb->CDBByte[4]);
154 TRACE("\tCONTROL: %d\n", prb->CDBByte[5]);
158 TRACE("Transfer Length: %d\n", prb->CDBByte[4]);
162 TRACE("Host Adapter: %d\n", prb->SRB_HaId);
163 TRACE("Flags: %d\n", prb->SRB_Flags);
164 if (TARGET_TO_HOST(prb)) {
165 TRACE("\tData transfer: Target to host. Length checked.\n");
167 else if (HOST_TO_TARGET(prb)) {
168 TRACE("\tData transfer: Host to target. Length checked.\n");
170 else if (NO_DATA_TRANSFERRED(prb)) {
171 TRACE("\tData transfer: none\n");
174 WARN("\tTransfer by scsi cmd. Length not checked.\n");
177 TRACE("\tResidual byte length reporting %s\n", prb->SRB_Flags & 0x4 ? "enabled" : "disabled");
178 TRACE("\tLinking %s\n", prb->SRB_Flags & 0x2 ? "enabled" : "disabled");
179 TRACE("\tPosting %s\n", prb->SRB_Flags & 0x1 ? "enabled" : "disabled");
180 TRACE("Target: %d\n", prb->SRB_Target);
181 TRACE("Lun: %d\n", prb->SRB_Lun);
182 TRACE("BufLen: %d\n", prb->SRB_BufLen);
183 TRACE("SenseLen: %d\n", prb->SRB_SenseLen);
184 TRACE("BufPtr: %p\n", prb->SRB_BufPointer);
185 TRACE("CDB Length: %d\n", prb->SRB_CDBLen);
186 TRACE("POST Proc: %p\n", prb->SRB_PostProc);
187 cdb = &prb->CDBByte[0];
188 cmd = prb->CDBByte[0];
189 if (TRACE_ON(aspi)) {
190 TRACE("CDB buffer[");
191 for (i = 0; i < prb->SRB_CDBLen; i++) {
192 if (i != 0) TRACE(",");
193 TRACE("%02x", *cdb++);
200 ASPI_PrintCDBArea(SRB_ExecSCSICmd *prb)
206 for (i = 0; i < prb->SRB_CDBLen; i++) {
208 TRACE("%02x", prb->CDBByte[i]);
215 ASPI_PrintSenseArea(SRB_ExecSCSICmd *prb)
218 BYTE *rqbuf = prb->SenseArea;
222 TRACE("Request Sense reports:\n");
223 if ((rqbuf[0]&0x7f)!=0x70) {
224 TRACE("\tInvalid sense header: 0x%02x instead of 0x70\n", rqbuf[0]&0x7f);
227 TRACE("\tCurrent command read filemark: %s\n",(rqbuf[2]&0x80)?"yes":"no");
228 TRACE("\tEarly warning passed: %s\n",(rqbuf[2]&0x40)?"yes":"no");
229 TRACE("\tIncorrect blocklength: %s\n",(rqbuf[2]&0x20)?"yes":"no");
230 TRACE("\tSense Key: %d\n",rqbuf[2]&0xf);
232 TRACE("\tResidual Length: %d\n",rqbuf[3]*0x1000000+rqbuf[4]*0x10000+rqbuf[5]*0x100+rqbuf[6]);
233 TRACE("\tAdditional Sense Length: %d\n",rqbuf[7]);
234 TRACE("\tAdditional Sense Code: %d\n",rqbuf[12]);
235 TRACE("\tAdditional Sense Code Qualifier: %d\n",rqbuf[13]);
236 if (rqbuf[15]&0x80) {
237 TRACE("\tIllegal Param is in %s\n",(rqbuf[15]&0x40)?"the CDB":"the Data Out Phase");
239 TRACE("Pointer at %d, bit %d\n",rqbuf[16]*256+rqbuf[17],rqbuf[15]&0x7);
243 for (i = 0; i < prb->SRB_SenseLen; i++) {
245 TRACE("%02x", *rqbuf++);
252 ASPI_DebugPrintResult(SRB_ExecSCSICmd *prb)
255 TRACE("SRB_Status: %x\n", prb->SRB_Status);
256 TRACE("SRB_HaStat: %x\n", prb->SRB_HaStat);
257 TRACE("SRB_TargStat: %x\n", prb->SRB_TargStat);
258 switch (prb->CDBByte[0]) {
260 TRACE("Vendor: '%s'\n", prb->SRB_BufPointer + INQUIRY_VENDOR);
262 case CMD_TEST_UNIT_READY:
263 ASPI_PrintSenseArea(prb);
268 /* Posting must be done in such a way that as soon as the SRB_Status is set
269 * we don't touch the SRB anymore because it could possibly be freed
270 * if the app is doing ASPI polling
273 WNASPI32_DoPosting( SRB_ExecSCSICmd *lpPRB, DWORD status )
275 void (*SRB_PostProc)() = lpPRB->SRB_PostProc;
276 BYTE SRB_Flags = lpPRB->SRB_Flags;
277 if( status == SS_PENDING )
279 WARN("Tried posting SS_PENDING\n");
282 lpPRB->SRB_Status = status;
283 /* lpPRB is NOT safe, it could be freed in another thread */
289 TRACE("Post Routine (%p) called\n", SRB_PostProc);
290 /* Even though lpPRB could have been freed by
291 * the program.. that's unlikely if it planned
292 * to use it in the PostProc
294 (*SRB_PostProc)(lpPRB);
296 else if (SRB_Flags & SRB_EVENT_NOTIFY) {
297 TRACE("Setting event %p\n", (HANDLE)SRB_PostProc);
298 SetEvent((HANDLE)SRB_PostProc);
305 ASPI_ExecScsiCmd(SRB_ExecSCSICmd *lpPRB)
307 struct sg_header *sg_hd, *sg_reply_hdr;
315 /* FIXME: hackmode */
316 #define MAKE_TARGET_TO_HOST(lpPRB) \
317 if (!TARGET_TO_HOST(lpPRB)) { \
318 WARN("program was not sending target_to_host for cmd %x (flags=%x),correcting.\n",lpPRB->CDBByte[0],lpPRB->SRB_Flags); \
319 lpPRB->SRB_Flags |= 0x08; \
321 #define MAKE_HOST_TO_TARGET(lpPRB) \
322 if (!HOST_TO_TARGET(lpPRB)) { \
323 WARN("program was not sending host_to_target for cmd %x (flags=%x),correcting.\n",lpPRB->CDBByte[0],lpPRB->SRB_Flags); \
324 lpPRB->SRB_Flags |= 0x10; \
326 switch (lpPRB->CDBByte[0]) {
327 case 0x12: /* INQUIRY */
328 case 0x5a: /* MODE_SENSE_10 */
329 case 0xa4: /* REPORT_KEY (DVD) MMC-2 */
330 case 0xad: /* READ DVD STRUCTURE MMC-2 */
331 MAKE_TARGET_TO_HOST(lpPRB)
333 case 0xa3: /* SEND KEY (DVD) MMC-2 */
334 MAKE_HOST_TO_TARGET(lpPRB)
337 if ((((lpPRB->SRB_Flags & 0x18) == 0x00) ||
338 ((lpPRB->SRB_Flags & 0x18) == 0x18)
339 ) && lpPRB->SRB_BufLen
341 FIXME("command 0x%02x, no data transfer specified, but buflen is %d!!!\n",lpPRB->CDBByte[0],lpPRB->SRB_BufLen);
345 ASPI_DebugPrintCmd(lpPRB);
346 if (lpPRB->SRB_HaId > ASPI_GetNumControllers()) {
347 ERR("Failed: Wanted hostadapter %d, but we have only %d.\n",
348 lpPRB->SRB_HaId,ASPI_GetNumControllers()
350 return WNASPI32_DoPosting( lpPRB, SS_INVALID_HA );
352 fd = ASPI_OpenDevice(lpPRB);
354 return WNASPI32_DoPosting( lpPRB, SS_NO_DEVICE );
360 lpPRB->SRB_Status = SS_PENDING;
362 if (!lpPRB->SRB_CDBLen) {
363 ERR("Failed: lpPRB->SRB_CDBLen = 0.\n");
364 return WNASPI32_DoPosting( lpPRB, SS_INVALID_SRB );
367 /* build up sg_header + scsi cmd */
368 if (HOST_TO_TARGET(lpPRB)) {
369 /* send header, command, and then data */
370 in_len = SCSI_OFF + lpPRB->SRB_CDBLen + lpPRB->SRB_BufLen;
371 sg_hd = HeapAlloc(GetProcessHeap(), 0, in_len);
372 memset(sg_hd, 0, SCSI_OFF);
373 memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
374 if (lpPRB->SRB_BufLen) {
375 memcpy(((BYTE *) sg_hd) + SCSI_OFF + lpPRB->SRB_CDBLen, lpPRB->SRB_BufPointer, lpPRB->SRB_BufLen);
379 /* send header and command - no data */
380 in_len = SCSI_OFF + lpPRB->SRB_CDBLen;
381 sg_hd = HeapAlloc(GetProcessHeap(), 0, in_len);
382 memset(sg_hd, 0, SCSI_OFF);
383 memcpy(sg_hd + 1, &lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
386 if (TARGET_TO_HOST(lpPRB)) {
387 out_len = SCSI_OFF + lpPRB->SRB_BufLen;
388 sg_reply_hdr = HeapAlloc(GetProcessHeap(), 0, out_len);
389 memset(sg_reply_hdr, 0, SCSI_OFF);
390 sg_hd->reply_len = out_len;
394 sg_reply_hdr = HeapAlloc(GetProcessHeap(), 0, out_len);
395 memset(sg_reply_hdr, 0, SCSI_OFF);
396 sg_hd->reply_len = out_len;
399 SCSI_Fix_CMD_LEN(fd, lpPRB->CDBByte[0], lpPRB->SRB_CDBLen);
401 if(!SCSI_LinuxDeviceIo( fd,
403 sg_reply_hdr, out_len,
409 if (sg_reply_hdr->result != 0) {
410 error_code = sg_reply_hdr->result;
411 WARN("reply header error (%d)\n", sg_reply_hdr->result);
415 if (TARGET_TO_HOST(lpPRB) && lpPRB->SRB_BufLen) {
416 memcpy(lpPRB->SRB_BufPointer, sg_reply_hdr + 1, lpPRB->SRB_BufLen);
419 /* copy in sense buffer to amount that is available in client */
420 if (lpPRB->SRB_SenseLen) {
421 int sense_len = lpPRB->SRB_SenseLen;
422 if (lpPRB->SRB_SenseLen > 16)
425 /* CDB is fixed in WNASPI32 */
426 memcpy(lpPRB->SenseArea, &sg_reply_hdr->sense_buffer[0], sense_len);
428 ASPI_PrintCDBArea(lpPRB);
429 ASPI_PrintSenseArea(lpPRB);
432 SRB_Status = SS_COMP;
433 lpPRB->SRB_HaStat = HASTAT_OK;
434 lpPRB->SRB_TargStat = sg_reply_hdr->target_status << 1;
436 HeapFree(GetProcessHeap(), 0, sg_reply_hdr);
437 HeapFree(GetProcessHeap(), 0, sg_hd);
439 /* FIXME: Should this be != 0 maybe? */
440 if( lpPRB->SRB_TargStat == 2 ) {
442 switch (lpPRB->CDBByte[0]) {
443 case 0xa4: /* REPORT_KEY (DVD) MMC-2 */
444 case 0xa3: /* SEND KEY (DVD) MMC-2 */
445 SRB_Status = SS_COMP;
446 lpPRB->SRB_TargStat = 0;
447 FIXME("Program wants to do DVD Region switching, but fails (non compliant DVD drive). Ignoring....\n");
452 ASPI_DebugPrintResult(lpPRB);
454 ret = WNASPI32_DoPosting( lpPRB, SRB_Status );
456 switch (lpPRB->CDBByte[0]) {
458 if (SRB_Status == SS_COMP)
459 return SS_COMP; /* some junk expects ss_comp here. */
465 /* In real WNASPI32 stuff really is always pending because ASPI does things
466 in the background, but we are not doing that (yet) */
472 if (error_code == EBUSY) {
473 WNASPI32_DoPosting( lpPRB, SS_ASPI_IS_BUSY );
474 TRACE("Device busy\n");
478 /* I'm not sure exactly error codes work here
479 * We probably should set lpPRB->SRB_TargStat, SRB_HaStat ?
481 WARN("error_exit\n");
482 HeapFree(GetProcessHeap(), 0, sg_reply_hdr);
483 HeapFree(GetProcessHeap(), 0, sg_hd);
484 WNASPI32_DoPosting( lpPRB, SRB_Status );
488 #endif /* defined(linux) */
491 /*******************************************************************
492 * GetASPI32SupportInfo [WNASPI32.1]
494 * Checks if the ASPI subsystem is initialized correctly.
498 * HIBYTE of LOWORD: status (SS_COMP or SS_FAILED_INIT)
499 * LOBYTE of LOWORD: # of host adapters.
501 DWORD __cdecl GetASPI32SupportInfo(void)
503 DWORD controllers = ASPI_GetNumControllers();
506 return SS_NO_ADAPTERS << 8;
507 return (SS_COMP << 8) | controllers ;
510 /***********************************************************************
511 * SendASPI32Command (WNASPI32.2)
513 DWORD __cdecl SendASPI32Command(LPSRB lpSRB)
516 static const char szId[] = "ASPI for WIN32";
517 static const char szWh[] = "Wine host";
518 switch (lpSRB->common.SRB_Cmd) {
520 lpSRB->inquiry.SRB_Status = SS_COMP; /* completed successfully */
521 lpSRB->inquiry.HA_Count = ASPI_GetNumControllers();
522 lpSRB->inquiry.HA_SCSI_ID = 7; /* not always ID 7 */
523 memcpy(lpSRB->inquiry.HA_ManagerId, szId, sizeof szId); /* max 15 chars, don't change */
524 memcpy(lpSRB->inquiry.HA_Identifier, szWh, sizeof szWh); /* FIXME: return host adapter name */
525 memset(lpSRB->inquiry.HA_Unique, 0, 16); /* default HA_Unique content */
526 lpSRB->inquiry.HA_Unique[6] = 0x02; /* Maximum Transfer Length (128K, Byte> 4-7) */
527 lpSRB->inquiry.HA_Unique[3] = 0x08; /* Maximum number of SCSI targets */
528 FIXME("ASPI: Partially implemented SC_HA_INQUIRY for adapter %d.\n", lpSRB->inquiry.SRB_HaId);
531 case SC_GET_DEV_TYPE: {
532 /* FIXME: We should return SS_NO_DEVICE if the device is not configured */
533 /* FIXME: We should return SS_INVALID_HA if HostAdapter!=0 */
535 unsigned char inqbuf[200];
538 memset(&tmpsrb,0,sizeof(tmpsrb));
541 memcpy(&tmpsrb.common,&(lpSRB->common),sizeof(tmpsrb.common));
543 tmpsrb.cmd.SRB_Flags |= 8; /* target to host */
544 tmpsrb.cmd.SRB_Cmd = SC_EXEC_SCSI_CMD;
545 tmpsrb.cmd.SRB_Target = lpSRB->devtype.SRB_Target;
546 tmpsrb.cmd.SRB_Lun = lpSRB->devtype.SRB_Lun;
547 tmpsrb.cmd.SRB_BufLen = sizeof(inqbuf);
548 tmpsrb.cmd.SRB_BufPointer = inqbuf;
549 tmpsrb.cmd.CDBByte[0] = 0x12; /* INQUIRY */
550 /* FIXME: handle lun */
551 tmpsrb.cmd.CDBByte[4] = sizeof(inqbuf);
552 tmpsrb.cmd.SRB_CDBLen = 6;
554 ret = ASPI_ExecScsiCmd(&tmpsrb.cmd);
556 lpSRB->devtype.SRB_Status = tmpsrb.cmd.SRB_Status;
557 lpSRB->devtype.SRB_DeviceType = inqbuf[0]&0x1f;
559 TRACE("returning devicetype %d for target %d\n",inqbuf[0]&0x1f,tmpsrb.cmd.SRB_Target);
560 if (ret!=SS_PENDING) /* Any error is passed down directly */
562 /* FIXME: knows that the command is finished already, pass final Status */
563 return tmpsrb.cmd.SRB_Status;
565 case SC_EXEC_SCSI_CMD:
566 return ASPI_ExecScsiCmd(&lpSRB->cmd);
568 FIXME("Not implemented SC_ABORT_SRB\n");
571 FIXME("Not implemented SC_RESET_DEV\n");
573 case SC_GET_DISK_INFO:
574 /* here we have to find out the int13 / bios association.
575 * We just say we do not have any.
577 FIXME("SC_GET_DISK_INFO always return 'int13 unassociated disk'.\n");
578 lpSRB->diskinfo.SRB_DriveFlags = 0; /* disk is not int13 served */
581 FIXME("Unknown command %d\n", lpSRB->common.SRB_Cmd);
583 return SS_INVALID_SRB;
585 return SS_INVALID_SRB;
590 /***********************************************************************
591 * GetASPI32DLLVersion (WNASPI32.4)
593 DWORD __cdecl GetASPI32DLLVersion(void)
596 TRACE("Returning version 1\n");
599 FIXME("Please add SCSI support for your operating system, returning 0\n");
604 /***********************************************************************
605 * GetASPI32Buffer (WNASPI32.8)
606 * Supposed to return a DMA capable large SCSI buffer.
607 * Our implementation does not use those at all, all buffer stuff is
608 * done in the kernel SG device layer. So we just heapalloc the buffer.
610 BOOL __cdecl GetASPI32Buffer(PASPI32BUFF pab)
612 pab->AB_BufPointer = HeapAlloc(GetProcessHeap(),
613 pab->AB_ZeroFill?HEAP_ZERO_MEMORY:0,
616 if (!pab->AB_BufPointer) return FALSE;
620 /***********************************************************************
621 * FreeASPI32Buffer (WNASPI32.14)
623 BOOL __cdecl FreeASPI32Buffer(PASPI32BUFF pab)
625 HeapFree(GetProcessHeap(),0,pab->AB_BufPointer);
629 /***********************************************************************
630 * TranslateASPI32Address (WNASPI32.7)
632 BOOL __cdecl TranslateASPI32Address(LPDWORD pdwPath, LPDWORD pdwDEVNODE)
634 FIXME("(%p, %p), stub !\n", pdwPath, pdwDEVNODE);