DevBusLogic.cpp@ 64444

Last change on this file since 64444 was 64444, checked in by vboxsync, 9 years ago
Devices/Storage/BusLogic: Free completed requests
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 166.8 KB

Line
1	/* $Id: DevBusLogic.cpp 64444 2016-10-27 15:27:30Z vboxsync $ */
2	/** @file
3	* VBox storage devices - BusLogic SCSI host adapter BT-958.
4	*
5	* Based on the Multi-Master Ultra SCSI Systems Technical Reference Manual.
6	*/
7
8	/*
9	* Copyright (C) 2006-2016 Oracle Corporation
10	*
11	* This file is part of VirtualBox Open Source Edition (OSE), as
12	* available from http://www.215389.xyz. This file is free software;
13	* you can redistribute it and/or modify it under the terms of the GNU
14	* General Public License (GPL) as published by the Free Software
15	* Foundation, in version 2 as it comes in the "COPYING" file of the
16	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18	*/
19
20
21	/*********************************************************************************************************************************
22	* Header Files *
23	*********************************************************************************************************************************/
24	#define LOG_GROUP LOG_GROUP_DEV_BUSLOGIC
25	#include <VBox/vmm/pdmdev.h>
26	#include <VBox/vmm/pdmstorageifs.h>
27	#include <VBox/vmm/pdmcritsect.h>
28	#include <VBox/scsi.h>
29	#include <iprt/asm.h>
30	#include <iprt/assert.h>
31	#include <iprt/string.h>
32	#include <iprt/log.h>
33	#ifdef IN_RING3
34	# include <iprt/alloc.h>
35	# include <iprt/memcache.h>
36	# include <iprt/param.h>
37	# include <iprt/uuid.h>
38	#endif
39
40	#include "VBoxSCSI.h"
41	#include "VBoxDD.h"
42
43
44	/*********************************************************************************************************************************
45	* Defined Constants And Macros *
46	*********************************************************************************************************************************/
47	/** Maximum number of attached devices the adapter can handle. */
48	#define BUSLOGIC_MAX_DEVICES 16
49
50	/** Maximum number of scatter gather elements this device can handle. */
51	#define BUSLOGIC_MAX_SCATTER_GATHER_LIST_SIZE 128
52
53	/** Size of the command buffer. */
54	#define BUSLOGIC_COMMAND_SIZE_MAX 53
55
56	/** Size of the reply buffer. */
57	#define BUSLOGIC_REPLY_SIZE_MAX 64
58
59	/** Custom fixed I/O ports for BIOS controller access.
60	* Note that these should not be in the ISA range (below 400h) to avoid
61	* conflicts with ISA device probing. Addresses in the 300h-340h range should be
62	* especially avoided.
63	*/
64	#define BUSLOGIC_BIOS_IO_PORT 0x430
65
66	/** State saved version. */
67	#define BUSLOGIC_SAVED_STATE_MINOR_VERSION 4
68
69	/** Saved state version before the suspend on error feature was implemented. */
70	#define BUSLOGIC_SAVED_STATE_MINOR_PRE_ERROR_HANDLING 1
71	/** Saved state version before 24-bit mailbox support was implemented. */
72	#define BUSLOGIC_SAVED_STATE_MINOR_PRE_24BIT_MBOX 2
73	/** Saved state version before command buffer size was raised. */
74	#define BUSLOGIC_SAVED_STATE_MINOR_PRE_CMDBUF_RESIZE 3
75
76	/** Command buffer size in old saved states. */
77	#define BUSLOGIC_COMMAND_SIZE_OLD 5
78
79	/** The duration of software-initiated reset (in nano seconds).
80	* Not documented, set to 50 ms. */
81	#define BUSLOGIC_RESET_DURATION_NS UINT64_C(50000000)
82
83
84	/*********************************************************************************************************************************
85	* Structures and Typedefs *
86	*********************************************************************************************************************************/
87	/**
88	* State of a device attached to the buslogic host adapter.
89	*
90	* @implements PDMIBASE
91	* @implements PDMISCSIPORT
92	* @implements PDMILEDPORTS
93	*/
94	typedef struct BUSLOGICDEVICE
95	{
96	/** Pointer to the owning buslogic device instance. - R3 pointer */
97	R3PTRTYPE(struct BUSLOGIC *) pBusLogicR3;
98	/** Pointer to the owning buslogic device instance. - R0 pointer */
99	R0PTRTYPE(struct BUSLOGIC *) pBusLogicR0;
100	/** Pointer to the owning buslogic device instance. - RC pointer */
101	RCPTRTYPE(struct BUSLOGIC *) pBusLogicRC;
102
103	/** Flag whether device is present. */
104	bool fPresent;
105	/** LUN of the device. */
106	RTUINT iLUN;
107
108	#if HC_ARCH_BITS == 64
109	uint32_t Alignment0;
110	#endif
111
112	/** Our base interface. */
113	PDMIBASE IBase;
114	/** Media port interface. */
115	PDMIMEDIAPORT IMediaPort;
116	/** Extended media port interface. */
117	PDMIMEDIAEXPORT IMediaExPort;
118	/** Led interface. */
119	PDMILEDPORTS ILed;
120	/** Pointer to the attached driver's base interface. */
121	R3PTRTYPE(PPDMIBASE) pDrvBase;
122	/** Pointer to the attached driver's media interface. */
123	R3PTRTYPE(PPDMIMEDIA) pDrvMedia;
124	/** Pointer to the attached driver's extended media interface. */
125	R3PTRTYPE(PPDMIMEDIAEX) pDrvMediaEx;
126	/** The status LED state for this device. */
127	PDMLED Led;
128
129	#if HC_ARCH_BITS == 64
130	uint32_t Alignment1;
131	#endif
132
133	/** Number of outstanding tasks on the port. */
134	volatile uint32_t cOutstandingRequests;
135
136	} BUSLOGICDEVICE, *PBUSLOGICDEVICE;
137
138	/**
139	* Commands the BusLogic adapter supports.
140	*/
141	enum BUSLOGICCOMMAND
142	{
143	BUSLOGICCOMMAND_TEST_CMDC_INTERRUPT = 0x00,
144	BUSLOGICCOMMAND_INITIALIZE_MAILBOX = 0x01,
145	BUSLOGICCOMMAND_EXECUTE_MAILBOX_COMMAND = 0x02,
146	BUSLOGICCOMMAND_EXECUTE_BIOS_COMMAND = 0x03,
147	BUSLOGICCOMMAND_INQUIRE_BOARD_ID = 0x04,
148	BUSLOGICCOMMAND_ENABLE_OUTGOING_MAILBOX_AVAILABLE_INTERRUPT = 0x05,
149	BUSLOGICCOMMAND_SET_SCSI_SELECTION_TIMEOUT = 0x06,
150	BUSLOGICCOMMAND_SET_PREEMPT_TIME_ON_BUS = 0x07,
151	BUSLOGICCOMMAND_SET_TIME_OFF_BUS = 0x08,
152	BUSLOGICCOMMAND_SET_BUS_TRANSFER_RATE = 0x09,
153	BUSLOGICCOMMAND_INQUIRE_INSTALLED_DEVICES_ID_0_TO_7 = 0x0a,
154	BUSLOGICCOMMAND_INQUIRE_CONFIGURATION = 0x0b,
155	BUSLOGICCOMMAND_ENABLE_TARGET_MODE = 0x0c,
156	BUSLOGICCOMMAND_INQUIRE_SETUP_INFORMATION = 0x0d,
157	BUSLOGICCOMMAND_WRITE_ADAPTER_LOCAL_RAM = 0x1a,
158	BUSLOGICCOMMAND_READ_ADAPTER_LOCAL_RAM = 0x1b,
159	BUSLOGICCOMMAND_WRITE_BUSMASTER_CHIP_FIFO = 0x1c,
160	BUSLOGICCOMMAND_READ_BUSMASTER_CHIP_FIFO = 0x1d,
161	BUSLOGICCOMMAND_ECHO_COMMAND_DATA = 0x1f,
162	BUSLOGICCOMMAND_HOST_ADAPTER_DIAGNOSTIC = 0x20,
163	BUSLOGICCOMMAND_SET_ADAPTER_OPTIONS = 0x21,
164	BUSLOGICCOMMAND_INQUIRE_INSTALLED_DEVICES_ID_8_TO_15 = 0x23,
165	BUSLOGICCOMMAND_INQUIRE_TARGET_DEVICES = 0x24,
166	BUSLOGICCOMMAND_DISABLE_HOST_ADAPTER_INTERRUPT = 0x25,
167	BUSLOGICCOMMAND_EXT_BIOS_INFO = 0x28,
168	BUSLOGICCOMMAND_UNLOCK_MAILBOX = 0x29,
169	BUSLOGICCOMMAND_INITIALIZE_EXTENDED_MAILBOX = 0x81,
170	BUSLOGICCOMMAND_EXECUTE_SCSI_COMMAND = 0x83,
171	BUSLOGICCOMMAND_INQUIRE_FIRMWARE_VERSION_3RD_LETTER = 0x84,
172	BUSLOGICCOMMAND_INQUIRE_FIRMWARE_VERSION_LETTER = 0x85,
173	BUSLOGICCOMMAND_INQUIRE_PCI_HOST_ADAPTER_INFORMATION = 0x86,
174	BUSLOGICCOMMAND_INQUIRE_HOST_ADAPTER_MODEL_NUMBER = 0x8b,
175	BUSLOGICCOMMAND_INQUIRE_SYNCHRONOUS_PERIOD = 0x8c,
176	BUSLOGICCOMMAND_INQUIRE_EXTENDED_SETUP_INFORMATION = 0x8d,
177	BUSLOGICCOMMAND_ENABLE_STRICT_ROUND_ROBIN_MODE = 0x8f,
178	BUSLOGICCOMMAND_STORE_HOST_ADAPTER_LOCAL_RAM = 0x90,
179	BUSLOGICCOMMAND_FETCH_HOST_ADAPTER_LOCAL_RAM = 0x91,
180	BUSLOGICCOMMAND_STORE_LOCAL_DATA_IN_EEPROM = 0x92,
181	BUSLOGICCOMMAND_UPLOAD_AUTO_SCSI_CODE = 0x94,
182	BUSLOGICCOMMAND_MODIFY_IO_ADDRESS = 0x95,
183	BUSLOGICCOMMAND_SET_CCB_FORMAT = 0x96,
184	BUSLOGICCOMMAND_WRITE_INQUIRY_BUFFER = 0x9a,
185	BUSLOGICCOMMAND_READ_INQUIRY_BUFFER = 0x9b,
186	BUSLOGICCOMMAND_FLASH_ROM_UPLOAD_DOWNLOAD = 0xa7,
187	BUSLOGICCOMMAND_READ_SCAM_DATA = 0xa8,
188	BUSLOGICCOMMAND_WRITE_SCAM_DATA = 0xa9
189	} BUSLOGICCOMMAND;
190
191	#pragma pack(1)
192	/**
193	* Auto SCSI structure which is located
194	* in host adapter RAM and contains several
195	* configuration parameters.
196	*/
197	typedef struct AutoSCSIRam
198	{
199	uint8_t aInternalSignature[2];
200	uint8_t cbInformation;
201	uint8_t aHostAdaptertype[6];
202	uint8_t uReserved1;
203	bool fFloppyEnabled : 1;
204	bool fFloppySecondary : 1;
205	bool fLevelSensitiveInterrupt : 1;
206	unsigned char uReserved2 : 2;
207	unsigned char uSystemRAMAreForBIOS : 3;
208	unsigned char uDMAChannel : 7;
209	bool fDMAAutoConfiguration : 1;
210	unsigned char uIrqChannel : 7;
211	bool fIrqAutoConfiguration : 1;
212	uint8_t uDMATransferRate;
213	uint8_t uSCSIId;
214	bool fLowByteTerminated : 1;
215	bool fParityCheckingEnabled : 1;
216	bool fHighByteTerminated : 1;
217	bool fNoisyCablingEnvironment : 1;
218	bool fFastSynchronousNeogtiation : 1;
219	bool fBusResetEnabled : 1;
220	bool fReserved3 : 1;
221	bool fActiveNegotiationEnabled : 1;
222	uint8_t uBusOnDelay;
223	uint8_t uBusOffDelay;
224	bool fHostAdapterBIOSEnabled : 1;
225	bool fBIOSRedirectionOfInt19 : 1;
226	bool fExtendedTranslation : 1;
227	bool fMapRemovableAsFixed : 1;
228	bool fReserved4 : 1;
229	bool fBIOSSupportsMoreThan2Drives : 1;
230	bool fBIOSInterruptMode : 1;
231	bool fFlopticalSupport : 1;
232	uint16_t u16DeviceEnabledMask;
233	uint16_t u16WidePermittedMask;
234	uint16_t u16FastPermittedMask;
235	uint16_t u16SynchronousPermittedMask;
236	uint16_t u16DisconnectPermittedMask;
237	uint16_t u16SendStartUnitCommandMask;
238	uint16_t u16IgnoreInBIOSScanMask;
239	unsigned char uPCIInterruptPin : 2;
240	unsigned char uHostAdapterIoPortAddress : 2;
241	bool fStrictRoundRobinMode : 1;
242	bool fVesaBusSpeedGreaterThan33MHz : 1;
243	bool fVesaBurstWrite : 1;
244	bool fVesaBurstRead : 1;
245	uint16_t u16UltraPermittedMask;
246	uint32_t uReserved5;
247	uint8_t uReserved6;
248	uint8_t uAutoSCSIMaximumLUN;
249	bool fReserved7 : 1;
250	bool fSCAMDominant : 1;
251	bool fSCAMenabled : 1;
252	bool fSCAMLevel2 : 1;
253	unsigned char uReserved8 : 4;
254	bool fInt13Extension : 1;
255	bool fReserved9 : 1;
256	bool fCDROMBoot : 1;
257	unsigned char uReserved10 : 5;
258	unsigned char uBootTargetId : 4;
259	unsigned char uBootChannel : 4;
260	bool fForceBusDeviceScanningOrder : 1;
261	unsigned char uReserved11 : 7;
262	uint16_t u16NonTaggedToAlternateLunPermittedMask;
263	uint16_t u16RenegotiateSyncAfterCheckConditionMask;
264	uint8_t aReserved12[10];
265	uint8_t aManufacturingDiagnostic[2];
266	uint16_t u16Checksum;
267	} AutoSCSIRam, *PAutoSCSIRam;
268	AssertCompileSize(AutoSCSIRam, 64);
269	#pragma pack()
270
271	/**
272	* The local Ram.
273	*/
274	typedef union HostAdapterLocalRam
275	{
276	/** Byte view. */
277	uint8_t u8View[256];
278	/** Structured view. */
279	struct
280	{
281	/** Offset 0 - 63 is for BIOS. */
282	uint8_t u8Bios[64];
283	/** Auto SCSI structure. */
284	AutoSCSIRam autoSCSIData;
285	} structured;
286	} HostAdapterLocalRam, *PHostAdapterLocalRam;
287	AssertCompileSize(HostAdapterLocalRam, 256);
288
289
290	/** Ugly 24-bit big-endian addressing. */
291	typedef struct
292	{
293	uint8_t hi;
294	uint8_t mid;
295	uint8_t lo;
296	} Addr24, Len24;
297	AssertCompileSize(Addr24, 3);
298
299	#define ADDR_TO_U32(x) (((x).hi << 16) \| ((x).mid << 8) \| (x).lo)
300	#define LEN_TO_U32 ADDR_TO_U32
301	#define U32_TO_ADDR(a, x) do {(a).hi = (x) >> 16; (a).mid = (x) >> 8; (a).lo = (x);} while(0)
302	#define U32_TO_LEN U32_TO_ADDR
303
304	/** @name Compatible ISA base I/O port addresses. Disabled if zero.
305	* @{ */
306	#define NUM_ISA_BASES 8
307	#define MAX_ISA_BASE (NUM_ISA_BASES - 1)
308	#define ISA_BASE_DISABLED 6
309
310	#ifdef IN_RING3
311	static uint16_t const g_aISABases[NUM_ISA_BASES] =
312	{
313	0x330, 0x334, 0x230, 0x234, 0x130, 0x134, 0, 0
314	};
315	#endif
316	/** @} */
317
318	/** Pointer to a task state structure. */
319	typedef struct BUSLOGICREQ *PBUSLOGICREQ;
320
321	/**
322	* Main BusLogic device state.
323	*
324	* @extends PDMPCIDEV
325	* @implements PDMILEDPORTS
326	*/
327	typedef struct BUSLOGIC
328	{
329	/** The PCI device structure. */
330	PDMPCIDEV dev;
331	/** Pointer to the device instance - HC ptr */
332	PPDMDEVINSR3 pDevInsR3;
333	/** Pointer to the device instance - R0 ptr */
334	PPDMDEVINSR0 pDevInsR0;
335	/** Pointer to the device instance - RC ptr. */
336	PPDMDEVINSRC pDevInsRC;
337
338	/** Whether R0 is enabled. */
339	bool fR0Enabled;
340	/** Whether RC is enabled. */
341	bool fGCEnabled;
342
343	/** Base address of the I/O ports. */
344	RTIOPORT IOPortBase;
345	/** Base address of the memory mapping. */
346	RTGCPHYS MMIOBase;
347	/** Status register - Readonly. */
348	volatile uint8_t regStatus;
349	/** Interrupt register - Readonly. */
350	volatile uint8_t regInterrupt;
351	/** Geometry register - Readonly. */
352	volatile uint8_t regGeometry;
353	/** Pending (delayed) interrupt. */
354	uint8_t uPendingIntr;
355
356	/** Local RAM for the fetch hostadapter local RAM request.
357	* I don't know how big the buffer really is but the maximum
358	* seems to be 256 bytes because the offset and count field in the command request
359	* are only one byte big.
360	*/
361	HostAdapterLocalRam LocalRam;
362
363	/** Command code the guest issued. */
364	uint8_t uOperationCode;
365	/** Buffer for the command parameters the adapter is currently receiving from the guest.
366	* Size of the largest command which is possible.
367	*/
368	uint8_t aCommandBuffer[BUSLOGIC_COMMAND_SIZE_MAX]; /* Size of the biggest request. */
369	/** Current position in the command buffer. */
370	uint8_t iParameter;
371	/** Parameters left until the command is complete. */
372	uint8_t cbCommandParametersLeft;
373
374	/** Whether we are using the RAM or reply buffer. */
375	bool fUseLocalRam;
376	/** Buffer to store reply data from the controller to the guest. */
377	uint8_t aReplyBuffer[BUSLOGIC_REPLY_SIZE_MAX]; /* Size of the biggest reply. */
378	/** Position in the buffer we are reading next. */
379	uint8_t iReply;
380	/** Bytes left until the reply buffer is empty. */
381	uint8_t cbReplyParametersLeft;
382
383	/** Flag whether IRQs are enabled. */
384	bool fIRQEnabled;
385	/** Flag whether the ISA I/O port range is disabled
386	* to prevent the BIOS to access the device. */
387	bool fISAEnabled; /*< @todo unused, to be removed /
388	/** Flag whether 24-bit mailboxes are in use (default is 32-bit). */
389	bool fMbxIs24Bit;
390	/** ISA I/O port base (encoded in FW-compatible format). */
391	uint8_t uISABaseCode;
392
393	/** ISA I/O port base (disabled if zero). */
394	RTIOPORT IOISABase;
395	/** Default ISA I/O port base in FW-compatible format. */
396	uint8_t uDefaultISABaseCode;
397
398	/** Number of mailboxes the guest set up. */
399	uint32_t cMailbox;
400
401	#if HC_ARCH_BITS == 64
402	uint32_t Alignment0;
403	#endif
404
405	/** Time when HBA reset was last initiated. / /< @todo does this need to be saved? /
406	uint64_t u64ResetTime;
407	/** Physical base address of the outgoing mailboxes. */
408	RTGCPHYS GCPhysAddrMailboxOutgoingBase;
409	/** Current outgoing mailbox position. */
410	uint32_t uMailboxOutgoingPositionCurrent;
411	/** Number of mailboxes ready. */
412	volatile uint32_t cMailboxesReady;
413	/** Whether a notification to R3 was sent. */
414	volatile bool fNotificationSent;
415
416	#if HC_ARCH_BITS == 64
417	uint32_t Alignment1;
418	#endif
419
420	/** Physical base address of the incoming mailboxes. */
421	RTGCPHYS GCPhysAddrMailboxIncomingBase;
422	/** Current incoming mailbox position. */
423	uint32_t uMailboxIncomingPositionCurrent;
424
425	/** Whether strict round robin is enabled. */
426	bool fStrictRoundRobinMode;
427	/** Whether the extended LUN CCB format is enabled for 32 possible logical units. */
428	bool fExtendedLunCCBFormat;
429
430	/** Queue to send tasks to R3. - HC ptr */
431	R3PTRTYPE(PPDMQUEUE) pNotifierQueueR3;
432	/** Queue to send tasks to R3. - HC ptr */
433	R0PTRTYPE(PPDMQUEUE) pNotifierQueueR0;
434	/** Queue to send tasks to R3. - RC ptr */
435	RCPTRTYPE(PPDMQUEUE) pNotifierQueueRC;
436
437	uint32_t Alignment2;
438
439	/** Critical section protecting access to the interrupt status register. */
440	PDMCRITSECT CritSectIntr;
441
442	/** Device state for BIOS access. */
443	VBOXSCSI VBoxSCSI;
444
445	/** BusLogic device states. */
446	BUSLOGICDEVICE aDeviceStates[BUSLOGIC_MAX_DEVICES];
447
448	/** The base interface.
449	* @todo use PDMDEVINS::IBase */
450	PDMIBASE IBase;
451	/** Status Port - Leds interface. */
452	PDMILEDPORTS ILeds;
453	/** Partner of ILeds. */
454	R3PTRTYPE(PPDMILEDCONNECTORS) pLedsConnector;
455	/** Status LUN: Media Notifys. */
456	R3PTRTYPE(PPDMIMEDIANOTIFY) pMediaNotify;
457
458	#if HC_ARCH_BITS == 64
459	uint32_t Alignment3;
460	#endif
461
462	/** Indicates that PDMDevHlpAsyncNotificationCompleted should be called when
463	* a port is entering the idle state. */
464	bool volatile fSignalIdle;
465	/** Flag whether the worker thread is sleeping. */
466	volatile bool fWrkThreadSleeping;
467	/** Flag whether a request from the BIOS is pending which the
468	* worker thread needs to process. */
469	volatile bool fBiosReqPending;
470
471	/** The support driver session handle. */
472	R3R0PTRTYPE(PSUPDRVSESSION) pSupDrvSession;
473	/** Worker thread. */
474	R3PTRTYPE(PPDMTHREAD) pThreadWrk;
475	/** The event semaphore the processing thread waits on. */
476	SUPSEMEVENT hEvtProcess;
477
478	/** Pointer to the array of addresses to redo. */
479	R3PTRTYPE(PRTGCPHYS) paGCPhysAddrCCBRedo;
480	/** Number of addresses the redo array holds. */
481	uint32_t cReqsRedo;
482
483	#ifdef LOG_ENABLED
484	volatile uint32_t cInMailboxesReady;
485	#else
486	# if HC_ARCH_BITS == 64
487	uint32_t Alignment4;
488	# endif
489	#endif
490
491	} BUSLOGIC, *PBUSLOGIC;
492
493	/** Register offsets in the I/O port space. */
494	#define BUSLOGIC_REGISTER_CONTROL 0 /*< Writeonly /
495	/** Fields for the control register. */
496	# define BL_CTRL_RSBUS RT_BIT(4) /* Reset SCSI Bus. */
497	# define BL_CTRL_RINT RT_BIT(5) /* Reset Interrupt. */
498	# define BL_CTRL_RSOFT RT_BIT(6) /* Soft Reset. */
499	# define BL_CTRL_RHARD RT_BIT(7) /* Hard Reset. */
500
501	#define BUSLOGIC_REGISTER_STATUS 0 /*< Readonly /
502	/** Fields for the status register. */
503	# define BL_STAT_CMDINV RT_BIT(0) /* Command Invalid. */
504	# define BL_STAT_DIRRDY RT_BIT(2) /* Data In Register Ready. */
505	# define BL_STAT_CPRBSY RT_BIT(3) /* Command/Parameter Out Register Busy. */
506	# define BL_STAT_HARDY RT_BIT(4) /* Host Adapter Ready. */
507	# define BL_STAT_INREQ RT_BIT(5) /* Initialization Required. */
508	# define BL_STAT_DFAIL RT_BIT(6) /* Diagnostic Failure. */
509	# define BL_STAT_DACT RT_BIT(7) /* Diagnistic Active. */
510
511	#define BUSLOGIC_REGISTER_COMMAND 1 /*< Writeonly /
512	#define BUSLOGIC_REGISTER_DATAIN 1 /*< Readonly /
513	#define BUSLOGIC_REGISTER_INTERRUPT 2 /*< Readonly /
514	/** Fields for the interrupt register. */
515	# define BL_INTR_IMBL RT_BIT(0) /* Incoming Mailbox Loaded. */
516	# define BL_INTR_OMBR RT_BIT(1) /* Outgoing Mailbox Available. */
517	# define BL_INTR_CMDC RT_BIT(2) /* Command Complete. */
518	# define BL_INTR_RSTS RT_BIT(3) /* SCSI Bus Reset State. */
519	# define BL_INTR_INTV RT_BIT(7) /* Interrupt Valid. */
520
521	#define BUSLOGIC_REGISTER_GEOMETRY 3 /* Readonly */
522	# define BL_GEOM_XLATEN RT_BIT(7) /* Extended geometry translation enabled. */
523
524	/** Structure for the INQUIRE_PCI_HOST_ADAPTER_INFORMATION reply. */
525	typedef struct ReplyInquirePCIHostAdapterInformation
526	{
527	uint8_t IsaIOPort;
528	uint8_t IRQ;
529	unsigned char LowByteTerminated : 1;
530	unsigned char HighByteTerminated : 1;
531	unsigned char uReserved : 2; /* Reserved. */
532	unsigned char JP1 : 1; /* Whatever that means. */
533	unsigned char JP2 : 1; /* Whatever that means. */
534	unsigned char JP3 : 1; /* Whatever that means. */
535	/** Whether the provided info is valid. */
536	unsigned char InformationIsValid: 1;
537	uint8_t uReserved2; /* Reserved. */
538	} ReplyInquirePCIHostAdapterInformation, *PReplyInquirePCIHostAdapterInformation;
539	AssertCompileSize(ReplyInquirePCIHostAdapterInformation, 4);
540
541	/** Structure for the INQUIRE_CONFIGURATION reply. */
542	typedef struct ReplyInquireConfiguration
543	{
544	unsigned char uReserved1 : 5;
545	bool fDmaChannel5 : 1;
546	bool fDmaChannel6 : 1;
547	bool fDmaChannel7 : 1;
548	bool fIrqChannel9 : 1;
549	bool fIrqChannel10 : 1;
550	bool fIrqChannel11 : 1;
551	bool fIrqChannel12 : 1;
552	unsigned char uReserved2 : 1;
553	bool fIrqChannel14 : 1;
554	bool fIrqChannel15 : 1;
555	unsigned char uReserved3 : 1;
556	unsigned char uHostAdapterId : 4;
557	unsigned char uReserved4 : 4;
558	} ReplyInquireConfiguration, *PReplyInquireConfiguration;
559	AssertCompileSize(ReplyInquireConfiguration, 3);
560
561	/** Structure for the INQUIRE_SETUP_INFORMATION reply. */
562	typedef struct ReplyInquireSetupInformationSynchronousValue
563	{
564	unsigned char uOffset : 4;
565	unsigned char uTransferPeriod : 3;
566	bool fSynchronous : 1;
567	}ReplyInquireSetupInformationSynchronousValue, *PReplyInquireSetupInformationSynchronousValue;
568	AssertCompileSize(ReplyInquireSetupInformationSynchronousValue, 1);
569
570	typedef struct ReplyInquireSetupInformation
571	{
572	bool fSynchronousInitiationEnabled : 1;
573	bool fParityCheckingEnabled : 1;
574	unsigned char uReserved1 : 6;
575	uint8_t uBusTransferRate;
576	uint8_t uPreemptTimeOnBus;
577	uint8_t uTimeOffBus;
578	uint8_t cMailbox;
579	Addr24 MailboxAddress;
580	ReplyInquireSetupInformationSynchronousValue SynchronousValuesId0To7[8];
581	uint8_t uDisconnectPermittedId0To7;
582	uint8_t uSignature;
583	uint8_t uCharacterD;
584	uint8_t uHostBusType;
585	uint8_t uWideTransferPermittedId0To7;
586	uint8_t uWideTransfersActiveId0To7;
587	ReplyInquireSetupInformationSynchronousValue SynchronousValuesId8To15[8];
588	uint8_t uDisconnectPermittedId8To15;
589	uint8_t uReserved2;
590	uint8_t uWideTransferPermittedId8To15;
591	uint8_t uWideTransfersActiveId8To15;
592	} ReplyInquireSetupInformation, *PReplyInquireSetupInformation;
593	AssertCompileSize(ReplyInquireSetupInformation, 34);
594
595	/** Structure for the INQUIRE_EXTENDED_SETUP_INFORMATION. */
596	#pragma pack(1)
597	typedef struct ReplyInquireExtendedSetupInformation
598	{
599	uint8_t uBusType;
600	uint8_t uBiosAddress;
601	uint16_t u16ScatterGatherLimit;
602	uint8_t cMailbox;
603	uint32_t uMailboxAddressBase;
604	unsigned char uReserved1 : 2;
605	bool fFastEISA : 1;
606	unsigned char uReserved2 : 3;
607	bool fLevelSensitiveInterrupt : 1;
608	unsigned char uReserved3 : 1;
609	unsigned char aFirmwareRevision[3];
610	bool fHostWideSCSI : 1;
611	bool fHostDifferentialSCSI : 1;
612	bool fHostSupportsSCAM : 1;
613	bool fHostUltraSCSI : 1;
614	bool fHostSmartTermination : 1;
615	unsigned char uReserved4 : 3;
616	} ReplyInquireExtendedSetupInformation, *PReplyInquireExtendedSetupInformation;
617	AssertCompileSize(ReplyInquireExtendedSetupInformation, 14);
618	#pragma pack()
619
620	/** Structure for the INITIALIZE EXTENDED MAILBOX request. */
621	#pragma pack(1)
622	typedef struct RequestInitializeExtendedMailbox
623	{
624	/** Number of mailboxes in guest memory. */
625	uint8_t cMailbox;
626	/** Physical address of the first mailbox. */
627	uint32_t uMailboxBaseAddress;
628	} RequestInitializeExtendedMailbox, *PRequestInitializeExtendedMailbox;
629	AssertCompileSize(RequestInitializeExtendedMailbox, 5);
630	#pragma pack()
631
632	/** Structure for the INITIALIZE MAILBOX request. */
633	typedef struct
634	{
635	/** Number of mailboxes to set up. */
636	uint8_t cMailbox;
637	/** Physical address of the first mailbox. */
638	Addr24 aMailboxBaseAddr;
639	} RequestInitMbx, *PRequestInitMbx;
640	AssertCompileSize(RequestInitMbx, 4);
641
642	/**
643	* Structure of a mailbox in guest memory.
644	* The incoming and outgoing mailbox have the same size
645	* but the incoming one has some more fields defined which
646	* are marked as reserved in the outgoing one.
647	* The last field is also different from the type.
648	* For outgoing mailboxes it is the action and
649	* for incoming ones the completion status code for the task.
650	* We use one structure for both types.
651	*/
652	typedef struct Mailbox32
653	{
654	/** Physical address of the CCB structure in the guest memory. */
655	uint32_t u32PhysAddrCCB;
656	/** Type specific data. */
657	union
658	{
659	/** For outgoing mailboxes. */
660	struct
661	{
662	/** Reserved */
663	uint8_t uReserved[3];
664	/** Action code. */
665	uint8_t uActionCode;
666	} out;
667	/** For incoming mailboxes. */
668	struct
669	{
670	/** The host adapter status after finishing the request. */
671	uint8_t uHostAdapterStatus;
672	/** The status of the device which executed the request after executing it. */
673	uint8_t uTargetDeviceStatus;
674	/** Reserved. */
675	uint8_t uReserved;
676	/** The completion status code of the request. */
677	uint8_t uCompletionCode;
678	} in;
679	} u;
680	} Mailbox32, *PMailbox32;
681	AssertCompileSize(Mailbox32, 8);
682
683	/** Old style 24-bit mailbox entry. */
684	typedef struct Mailbox24
685	{
686	/** Mailbox command (incoming) or state (outgoing). */
687	uint8_t uCmdState;
688	/** Physical address of the CCB structure in the guest memory. */
689	Addr24 aPhysAddrCCB;
690	} Mailbox24, *PMailbox24;
691	AssertCompileSize(Mailbox24, 4);
692
693	/**
694	* Action codes for outgoing mailboxes.
695	*/
696	enum BUSLOGIC_MAILBOX_OUTGOING_ACTION
697	{
698	BUSLOGIC_MAILBOX_OUTGOING_ACTION_FREE = 0x00,
699	BUSLOGIC_MAILBOX_OUTGOING_ACTION_START_COMMAND = 0x01,
700	BUSLOGIC_MAILBOX_OUTGOING_ACTION_ABORT_COMMAND = 0x02
701	};
702
703	/**
704	* Completion codes for incoming mailboxes.
705	*/
706	enum BUSLOGIC_MAILBOX_INCOMING_COMPLETION
707	{
708	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_FREE = 0x00,
709	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_WITHOUT_ERROR = 0x01,
710	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_ABORTED = 0x02,
711	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_ABORTED_NOT_FOUND = 0x03,
712	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_WITH_ERROR = 0x04,
713	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_INVALID_CCB = 0x05
714	};
715
716	/**
717	* Host adapter status for incoming mailboxes.
718	*/
719	enum BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS
720	{
721	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_CMD_COMPLETED = 0x00,
722	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_LINKED_CMD_COMPLETED = 0x0a,
723	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_LINKED_CMD_COMPLETED_WITH_FLAG = 0x0b,
724	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_DATA_UNDERUN = 0x0c,
725	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_SCSI_SELECTION_TIMEOUT = 0x11,
726	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_DATA_OVERRUN = 0x12,
727	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_UNEXPECTED_BUS_FREE = 0x13,
728	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_INVALID_BUS_PHASE_REQUESTED = 0x14,
729	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_INVALID_OUTGOING_MAILBOX_ACTION_CODE = 0x15,
730	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_INVALID_COMMAND_OPERATION_CODE = 0x16,
731	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_LINKED_CCB_HAS_INVALID_LUN = 0x17,
732	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_INVALID_COMMAND_PARAMETER = 0x1a,
733	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_AUTO_REQUEST_SENSE_FAILED = 0x1b,
734	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_TAGGED_QUEUING_MESSAGE_REJECTED = 0x1c,
735	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_UNSUPPORTED_MESSAGE_RECEIVED = 0x1d,
736	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_HOST_ADAPTER_HARDWARE_FAILED = 0x20,
737	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_TARGET_FAILED_RESPONSE_TO_ATN = 0x21,
738	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_HOST_ADAPTER_ASSERTED_RST = 0x22,
739	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_OTHER_DEVICE_ASSERTED_RST = 0x23,
740	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_TARGET_DEVICE_RECONNECTED_IMPROPERLY = 0x24,
741	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_HOST_ADAPTER_ASSERTED_BUS_DEVICE_RESET = 0x25,
742	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_ABORT_QUEUE_GENERATED = 0x26,
743	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_HOST_ADAPTER_SOFTWARE_ERROR = 0x27,
744	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_HOST_ADAPTER_HARDWARE_TIMEOUT_ERROR = 0x30,
745	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_SCSI_PARITY_ERROR_DETECTED = 0x34
746	};
747
748	/**
749	* Device status codes for incoming mailboxes.
750	*/
751	enum BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS
752	{
753	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_OPERATION_GOOD = 0x00,
754	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_CHECK_CONDITION = 0x02,
755	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_DEVICE_BUSY = 0x08
756	};
757
758	/**
759	* Opcode types for CCB.
760	*/
761	enum BUSLOGIC_CCB_OPCODE
762	{
763	BUSLOGIC_CCB_OPCODE_INITIATOR_CCB = 0x00,
764	BUSLOGIC_CCB_OPCODE_TARGET_CCB = 0x01,
765	BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_SCATTER_GATHER = 0x02,
766	BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_DATA_LENGTH = 0x03,
767	BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_SCATTER_GATHER = 0x04,
768	BUSLOGIC_CCB_OPCODE_BUS_DEVICE_RESET = 0x81
769	};
770
771	/**
772	* Data transfer direction.
773	*/
774	enum BUSLOGIC_CCB_DIRECTION
775	{
776	BUSLOGIC_CCB_DIRECTION_UNKNOWN = 0x00,
777	BUSLOGIC_CCB_DIRECTION_IN = 0x01,
778	BUSLOGIC_CCB_DIRECTION_OUT = 0x02,
779	BUSLOGIC_CCB_DIRECTION_NO_DATA = 0x03
780	};
781
782	/**
783	* The command control block for a SCSI request.
784	*/
785	typedef struct CCB32
786	{
787	/** Opcode. */
788	uint8_t uOpcode;
789	/** Reserved */
790	unsigned char uReserved1 : 3;
791	/** Data direction for the request. */
792	unsigned char uDataDirection : 2;
793	/** Whether the request is tag queued. */
794	bool fTagQueued : 1;
795	/** Queue tag mode. */
796	unsigned char uQueueTag : 2;
797	/** Length of the SCSI CDB. */
798	uint8_t cbCDB;
799	/** Sense data length. */
800	uint8_t cbSenseData;
801	/** Data length. */
802	uint32_t cbData;
803	/** Data pointer.
804	* This points to the data region or a scatter gather list based on the opcode.
805	*/
806	uint32_t u32PhysAddrData;
807	/** Reserved. */
808	uint8_t uReserved2[2];
809	/** Host adapter status. */
810	uint8_t uHostAdapterStatus;
811	/** Device adapter status. */
812	uint8_t uDeviceStatus;
813	/** The device the request is sent to. */
814	uint8_t uTargetId;
815	/*The LUN in the device. /
816	unsigned char uLogicalUnit : 5;
817	/** Legacy tag. */
818	bool fLegacyTagEnable : 1;
819	/** Legacy queue tag. */
820	unsigned char uLegacyQueueTag : 2;
821	/** The SCSI CDB. (A CDB can be 12 bytes long.) */
822	uint8_t abCDB[12];
823	/** Reserved. */
824	uint8_t uReserved3[6];
825	/** Sense data pointer. */
826	uint32_t u32PhysAddrSenseData;
827	} CCB32, *PCCB32;
828	AssertCompileSize(CCB32, 40);
829
830
831	/**
832	* The 24-bit command control block.
833	*/
834	typedef struct CCB24
835	{
836	/** Opcode. */
837	uint8_t uOpcode;
838	/** The LUN in the device. */
839	unsigned char uLogicalUnit : 3;
840	/** Data direction for the request. */
841	unsigned char uDataDirection : 2;
842	/** The target device ID. */
843	unsigned char uTargetId : 3;
844	/** Length of the SCSI CDB. */
845	uint8_t cbCDB;
846	/** Sense data length. */
847	uint8_t cbSenseData;
848	/** Data length. */
849	Len24 acbData;
850	/** Data pointer.
851	* This points to the data region or a scatter gather list based on the opc
852	*/
853	Addr24 aPhysAddrData;
854	/** Pointer to next CCB for linked commands. */
855	Addr24 aPhysAddrLink;
856	/** Command linking identifier. */
857	uint8_t uLinkId;
858	/** Host adapter status. */
859	uint8_t uHostAdapterStatus;
860	/** Device adapter status. */
861	uint8_t uDeviceStatus;
862	/** Two unused bytes. */
863	uint8_t aReserved[2];
864	/** The SCSI CDB. (A CDB can be 12 bytes long.) */
865	uint8_t abCDB[12];
866	} CCB24, *PCCB24;
867	AssertCompileSize(CCB24, 30);
868
869	/**
870	* The common 24-bit/32-bit command control block. The 32-bit CCB is laid out
871	* such that many fields are in the same location as in the older 24-bit CCB.
872	*/
873	typedef struct CCBC
874	{
875	/** Opcode. */
876	uint8_t uOpcode;
877	/** The LUN in the device. */
878	unsigned char uPad1 : 3;
879	/** Data direction for the request. */
880	unsigned char uDataDirection : 2;
881	/** The target device ID. */
882	unsigned char uPad2 : 3;
883	/** Length of the SCSI CDB. */
884	uint8_t cbCDB;
885	/** Sense data length. */
886	uint8_t cbSenseData;
887	uint8_t aPad1[10];
888	/** Host adapter status. */
889	uint8_t uHostAdapterStatus;
890	/** Device adapter status. */
891	uint8_t uDeviceStatus;
892	uint8_t aPad2[2];
893	/** The SCSI CDB (up to 12 bytes). */
894	uint8_t abCDB[12];
895	} CCBC, *PCCBC;
896	AssertCompileSize(CCBC, 30);
897
898	/* Make sure that the 24-bit/32-bit/common CCB offsets match. */
899	AssertCompileMemberOffset(CCBC, cbCDB, 2);
900	AssertCompileMemberOffset(CCB24, cbCDB, 2);
901	AssertCompileMemberOffset(CCB32, cbCDB, 2);
902	AssertCompileMemberOffset(CCBC, uHostAdapterStatus, 14);
903	AssertCompileMemberOffset(CCB24, uHostAdapterStatus, 14);
904	AssertCompileMemberOffset(CCB32, uHostAdapterStatus, 14);
905	AssertCompileMemberOffset(CCBC, abCDB, 18);
906	AssertCompileMemberOffset(CCB24, abCDB, 18);
907	AssertCompileMemberOffset(CCB32, abCDB, 18);
908
909	/** A union of all CCB types (24-bit/32-bit/common). */
910	typedef union CCBU
911	{
912	CCB32 n; /*< New 32-bit CCB. /
913	CCB24 o; /*< Old 24-bit CCB. /
914	CCBC c; /*< Common CCB subset. /
915	} CCBU, *PCCBU;
916
917	/** 32-bit scatter-gather list entry. */
918	typedef struct SGE32
919	{
920	uint32_t cbSegment;
921	uint32_t u32PhysAddrSegmentBase;
922	} SGE32, *PSGE32;
923	AssertCompileSize(SGE32, 8);
924
925	/** 24-bit scatter-gather list entry. */
926	typedef struct SGE24
927	{
928	Len24 acbSegment;
929	Addr24 aPhysAddrSegmentBase;
930	} SGE24, *PSGE24;
931	AssertCompileSize(SGE24, 6);
932
933	/**
934	* The structure for the "Execute SCSI Command" command.
935	*/
936	typedef struct ESCMD
937	{
938	/** Data length. */
939	uint32_t cbData;
940	/** Data pointer. */
941	uint32_t u32PhysAddrData;
942	/** The device the request is sent to. */
943	uint8_t uTargetId;
944	/** The LUN in the device. */
945	uint8_t uLogicalUnit;
946	/** Reserved */
947	unsigned char uReserved1 : 3;
948	/** Data direction for the request. */
949	unsigned char uDataDirection : 2;
950	/** Reserved */
951	unsigned char uReserved2 : 3;
952	/** Length of the SCSI CDB. */
953	uint8_t cbCDB;
954	/** The SCSI CDB. (A CDB can be 12 bytes long.) */
955	uint8_t abCDB[12];
956	} ESCMD, *PESCMD;
957	AssertCompileSize(ESCMD, 24);
958
959	/**
960	* Task state for a CCB request.
961	*/
962	typedef struct BUSLOGICREQ
963	{
964	/** PDM extended media interface I/O request hande. */
965	PDMMEDIAEXIOREQ hIoReq;
966	/** Device this task is assigned to. */
967	PBUSLOGICDEVICE pTargetDevice;
968	/** The command control block from the guest. */
969	CCBU CCBGuest;
970	/** Guest physical address of th CCB. */
971	RTGCPHYS GCPhysAddrCCB;
972	/** Pointer to the R3 sense buffer. */
973	uint8_t *pbSenseBuffer;
974	/** Flag whether this is a request from the BIOS. */
975	bool fBIOS;
976	/** 24-bit request flag (default is 32-bit). */
977	bool fIs24Bit;
978	/** SCSI status code. */
979	uint8_t u8ScsiSts;
980	} BUSLOGICREQ;
981
982	#ifdef IN_RING3
983	/**
984	* Memory buffer callback.
985	*
986	* @returns nothing.
987	* @param pThis The LsiLogic controller instance.
988	* @param GCPhys The guest physical address of the memory buffer.
989	* @param pSgBuf The pointer to the host R3 S/G buffer.
990	* @param cbCopy How many bytes to copy between the two buffers.
991	* @param pcbSkip Initially contains the amount of bytes to skip
992	* starting from the guest physical address before
993	* accessing the S/G buffer and start copying data.
994	* On return this contains the remaining amount if
995	* cbCopy < *pcbSkip or 0 otherwise.
996	*/
997	typedef DECLCALLBACK(void) BUSLOGICR3MEMCOPYCALLBACK(PBUSLOGIC pThis, RTGCPHYS GCPhys, PRTSGBUF pSgBuf, size_t cbCopy,
998	size_t *pcbSkip);
999	/** Pointer to a memory copy buffer callback. */
1000	typedef BUSLOGICR3MEMCOPYCALLBACK *PBUSLOGICR3MEMCOPYCALLBACK;
1001	#endif
1002
1003	#ifndef VBOX_DEVICE_STRUCT_TESTCASE
1004
1005
1006	/*********************************************************************************************************************************
1007	* Internal Functions *
1008	*********************************************************************************************************************************/
1009	#ifdef IN_RING3
1010	static int buslogicR3RegisterISARange(PBUSLOGIC pBusLogic, uint8_t uBaseCode);
1011	#endif
1012
1013
1014	/**
1015	* Assert IRQ line of the BusLogic adapter.
1016	*
1017	* @returns nothing.
1018	* @param pBusLogic Pointer to the BusLogic device instance.
1019	* @param fSuppressIrq Flag to suppress IRQ generation regardless of fIRQEnabled
1020	* @param uIrqType Type of interrupt being generated.
1021	*/
1022	static void buslogicSetInterrupt(PBUSLOGIC pBusLogic, bool fSuppressIrq, uint8_t uIrqType)
1023	{
1024	LogFlowFunc(("pBusLogic=%#p\n", pBusLogic));
1025
1026	/* The CMDC interrupt has priority over IMBL and OMBR. */
1027	if (uIrqType & (BL_INTR_IMBL \| BL_INTR_OMBR))
1028	{
1029	if (!(pBusLogic->regInterrupt & BL_INTR_CMDC))
1030	pBusLogic->regInterrupt \|= uIrqType; /* Report now. */
1031	else
1032	pBusLogic->uPendingIntr \|= uIrqType; /* Report later. */
1033	}
1034	else if (uIrqType & BL_INTR_CMDC)
1035	{
1036	AssertMsg(pBusLogic->regInterrupt == 0 \|\| pBusLogic->regInterrupt == (BL_INTR_INTV \| BL_INTR_CMDC),
1037	("regInterrupt=%02X\n", pBusLogic->regInterrupt));
1038	pBusLogic->regInterrupt \|= uIrqType;
1039	}
1040	else
1041	AssertMsgFailed(("Invalid interrupt state!\n"));
1042
1043	pBusLogic->regInterrupt \|= BL_INTR_INTV;
1044	if (pBusLogic->fIRQEnabled && !fSuppressIrq)
1045	PDMDevHlpPCISetIrq(pBusLogic->CTX_SUFF(pDevIns), 0, 1);
1046	}
1047
1048	/**
1049	* Deasserts the interrupt line of the BusLogic adapter.
1050	*
1051	* @returns nothing.
1052	* @param pBusLogic Pointer to the BusLogic device instance.
1053	*/
1054	static void buslogicClearInterrupt(PBUSLOGIC pBusLogic)
1055	{
1056	LogFlowFunc(("pBusLogic=%#p, clearing %#02x (pending %#02x)\n",
1057	pBusLogic, pBusLogic->regInterrupt, pBusLogic->uPendingIntr));
1058	pBusLogic->regInterrupt = 0;
1059	PDMDevHlpPCISetIrq(pBusLogic->CTX_SUFF(pDevIns), 0, 0);
1060	/* If there's another pending interrupt, report it now. */
1061	if (pBusLogic->uPendingIntr)
1062	{
1063	buslogicSetInterrupt(pBusLogic, false, pBusLogic->uPendingIntr);
1064	pBusLogic->uPendingIntr = 0;
1065	}
1066	}
1067
1068	#if defined(IN_RING3)
1069
1070	/**
1071	* Advances the mailbox pointer to the next slot.
1072	*
1073	* @returns nothing.
1074	* @param pBusLogic The BusLogic controller instance.
1075	*/
1076	DECLINLINE(void) buslogicR3OutgoingMailboxAdvance(PBUSLOGIC pBusLogic)
1077	{
1078	pBusLogic->uMailboxOutgoingPositionCurrent = (pBusLogic->uMailboxOutgoingPositionCurrent + 1) % pBusLogic->cMailbox;
1079	}
1080
1081	/**
1082	* Initialize local RAM of host adapter with default values.
1083	*
1084	* @returns nothing.
1085	* @param pBusLogic The BusLogic controller instance.
1086	*/
1087	static void buslogicR3InitializeLocalRam(PBUSLOGIC pBusLogic)
1088	{
1089	/*
1090	* These values are mostly from what I think is right
1091	* looking at the dmesg output from a Linux guest inside
1092	* a VMware server VM.
1093	*
1094	* So they don't have to be right :)
1095	*/
1096	memset(pBusLogic->LocalRam.u8View, 0, sizeof(HostAdapterLocalRam));
1097	pBusLogic->LocalRam.structured.autoSCSIData.fLevelSensitiveInterrupt = true;
1098	pBusLogic->LocalRam.structured.autoSCSIData.fParityCheckingEnabled = true;
1099	pBusLogic->LocalRam.structured.autoSCSIData.fExtendedTranslation = true; /* Same as in geometry register. */
1100	pBusLogic->LocalRam.structured.autoSCSIData.u16DeviceEnabledMask = UINT16_MAX; /* All enabled. Maybe mask out non present devices? */
1101	pBusLogic->LocalRam.structured.autoSCSIData.u16WidePermittedMask = UINT16_MAX;
1102	pBusLogic->LocalRam.structured.autoSCSIData.u16FastPermittedMask = UINT16_MAX;
1103	pBusLogic->LocalRam.structured.autoSCSIData.u16SynchronousPermittedMask = UINT16_MAX;
1104	pBusLogic->LocalRam.structured.autoSCSIData.u16DisconnectPermittedMask = UINT16_MAX;
1105	pBusLogic->LocalRam.structured.autoSCSIData.fStrictRoundRobinMode = pBusLogic->fStrictRoundRobinMode;
1106	pBusLogic->LocalRam.structured.autoSCSIData.u16UltraPermittedMask = UINT16_MAX;
1107	/** @todo calculate checksum? */
1108	}
1109
1110	/**
1111	* Do a hardware reset of the buslogic adapter.
1112	*
1113	* @returns VBox status code.
1114	* @param pBusLogic Pointer to the BusLogic device instance.
1115	* @param fResetIO Flag determining whether ISA I/O should be reset.
1116	*/
1117	static int buslogicR3HwReset(PBUSLOGIC pBusLogic, bool fResetIO)
1118	{
1119	LogFlowFunc(("pBusLogic=%#p\n", pBusLogic));
1120
1121	/* Reset registers to default values. */
1122	pBusLogic->regStatus = BL_STAT_HARDY \| BL_STAT_INREQ;
1123	pBusLogic->regGeometry = BL_GEOM_XLATEN;
1124	pBusLogic->uOperationCode = 0xff; /* No command executing. */
1125	pBusLogic->iParameter = 0;
1126	pBusLogic->cbCommandParametersLeft = 0;
1127	pBusLogic->fIRQEnabled = true;
1128	pBusLogic->fStrictRoundRobinMode = false;
1129	pBusLogic->fExtendedLunCCBFormat = false;
1130	pBusLogic->uMailboxOutgoingPositionCurrent = 0;
1131	pBusLogic->uMailboxIncomingPositionCurrent = 0;
1132
1133	/* Clear any active/pending interrupts. */
1134	pBusLogic->uPendingIntr = 0;
1135	buslogicClearInterrupt(pBusLogic);
1136
1137	/* Guest-initiated HBA reset does not affect ISA port I/O. */
1138	if (fResetIO)
1139	{
1140	buslogicR3RegisterISARange(pBusLogic, pBusLogic->uDefaultISABaseCode);
1141	}
1142	buslogicR3InitializeLocalRam(pBusLogic);
1143	vboxscsiInitialize(&pBusLogic->VBoxSCSI);
1144
1145	return VINF_SUCCESS;
1146	}
1147
1148	#endif /* IN_RING3 */
1149
1150	/**
1151	* Resets the command state machine for the next command and notifies the guest.
1152	*
1153	* @returns nothing.
1154	* @param pBusLogic Pointer to the BusLogic device instance
1155	* @param fSuppressIrq Flag to suppress IRQ generation regardless of current state
1156	*/
1157	static void buslogicCommandComplete(PBUSLOGIC pBusLogic, bool fSuppressIrq)
1158	{
1159	LogFlowFunc(("pBusLogic=%#p\n", pBusLogic));
1160
1161	pBusLogic->fUseLocalRam = false;
1162	pBusLogic->regStatus \|= BL_STAT_HARDY;
1163	pBusLogic->iReply = 0;
1164
1165	/* Modify I/O address does not generate an interrupt. */
1166	if (pBusLogic->uOperationCode != BUSLOGICCOMMAND_EXECUTE_MAILBOX_COMMAND)
1167	{
1168	/* Notify that the command is complete. */
1169	pBusLogic->regStatus &= ~BL_STAT_DIRRDY;
1170	buslogicSetInterrupt(pBusLogic, fSuppressIrq, BL_INTR_CMDC);
1171	}
1172
1173	pBusLogic->uOperationCode = 0xff;
1174	pBusLogic->iParameter = 0;
1175	}
1176
1177	#if defined(IN_RING3)
1178
1179	/**
1180	* Initiates a hard reset which was issued from the guest.
1181	*
1182	* @returns nothing
1183	* @param pBusLogic Pointer to the BusLogic device instance.
1184	* @param fHardReset Flag initiating a hard (vs. soft) reset.
1185	*/
1186	static void buslogicR3InitiateReset(PBUSLOGIC pBusLogic, bool fHardReset)
1187	{
1188	LogFlowFunc(("pBusLogic=%#p fHardReset=%d\n", pBusLogic, fHardReset));
1189
1190	buslogicR3HwReset(pBusLogic, false);
1191
1192	if (fHardReset)
1193	{
1194	/* Set the diagnostic active bit in the status register and clear the ready state. */
1195	pBusLogic->regStatus \|= BL_STAT_DACT;
1196	pBusLogic->regStatus &= ~BL_STAT_HARDY;
1197
1198	/* Remember when the guest initiated a reset (after we're done resetting). */
1199	pBusLogic->u64ResetTime = PDMDevHlpTMTimeVirtGetNano(pBusLogic->CTX_SUFF(pDevIns));
1200	}
1201	}
1202
1203	/**
1204	* Send a mailbox with set status codes to the guest.
1205	*
1206	* @returns nothing.
1207	* @param pBusLogic Pointer to the BusLogic device instance.
1208	* @param GCPhysAddrCCB The physical guest address of the CCB the mailbox is for.
1209	* @param pCCBGuest The command control block.
1210	* @param uHostAdapterStatus The host adapter status code to set.
1211	* @param uDeviceStatus The target device status to set.
1212	* @param uMailboxCompletionCode Completion status code to set in the mailbox.
1213	*/
1214	static void buslogicR3SendIncomingMailbox(PBUSLOGIC pBusLogic, RTGCPHYS GCPhysAddrCCB,
1215	PCCBU pCCBGuest, uint8_t uHostAdapterStatus,
1216	uint8_t uDeviceStatus, uint8_t uMailboxCompletionCode)
1217	{
1218	Mailbox32 MbxIn;
1219
1220	MbxIn.u32PhysAddrCCB = (uint32_t)GCPhysAddrCCB;
1221	MbxIn.u.in.uHostAdapterStatus = uHostAdapterStatus;
1222	MbxIn.u.in.uTargetDeviceStatus = uDeviceStatus;
1223	MbxIn.u.in.uCompletionCode = uMailboxCompletionCode;
1224
1225	int rc = PDMCritSectEnter(&pBusLogic->CritSectIntr, VINF_SUCCESS);
1226	AssertRC(rc);
1227
1228	RTGCPHYS GCPhysAddrMailboxIncoming = pBusLogic->GCPhysAddrMailboxIncomingBase
1229	+ ( pBusLogic->uMailboxIncomingPositionCurrent
1230	* (pBusLogic->fMbxIs24Bit ? sizeof(Mailbox24) : sizeof(Mailbox32)) );
1231
1232	if (uMailboxCompletionCode != BUSLOGIC_MAILBOX_INCOMING_COMPLETION_ABORTED_NOT_FOUND)
1233	{
1234	LogFlowFunc(("Completing CCB %RGp hstat=%u, dstat=%u, outgoing mailbox at %RGp\n", GCPhysAddrCCB,
1235	uHostAdapterStatus, uDeviceStatus, GCPhysAddrMailboxIncoming));
1236
1237	/* Update CCB. */
1238	pCCBGuest->c.uHostAdapterStatus = uHostAdapterStatus;
1239	pCCBGuest->c.uDeviceStatus = uDeviceStatus;
1240	/* Rewrite CCB up to the CDB; perhaps more than necessary. */
1241	PDMDevHlpPCIPhysWrite(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrCCB,
1242	pCCBGuest, RT_OFFSETOF(CCBC, abCDB));
1243	}
1244
1245	# ifdef RT_STRICT
1246	uint8_t uCode;
1247	unsigned uCodeOffs = pBusLogic->fMbxIs24Bit ? RT_OFFSETOF(Mailbox24, uCmdState) : RT_OFFSETOF(Mailbox32, u.out.uActionCode);
1248	PDMDevHlpPhysRead(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrMailboxIncoming + uCodeOffs, &uCode, sizeof(uCode));
1249	Assert(uCode == BUSLOGIC_MAILBOX_INCOMING_COMPLETION_FREE);
1250	# endif
1251
1252	/* Update mailbox. */
1253	if (pBusLogic->fMbxIs24Bit)
1254	{
1255	Mailbox24 Mbx24;
1256
1257	Mbx24.uCmdState = MbxIn.u.in.uCompletionCode;
1258	U32_TO_ADDR(Mbx24.aPhysAddrCCB, MbxIn.u32PhysAddrCCB);
1259	Log(("24-bit mailbox: completion code=%u, CCB at %RGp\n", Mbx24.uCmdState, (RTGCPHYS)ADDR_TO_U32(Mbx24.aPhysAddrCCB)));
1260	PDMDevHlpPCIPhysWrite(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrMailboxIncoming, &Mbx24, sizeof(Mailbox24));
1261	}
1262	else
1263	{
1264	Log(("32-bit mailbox: completion code=%u, CCB at %RGp\n", MbxIn.u.in.uCompletionCode, GCPhysAddrCCB));
1265	PDMDevHlpPCIPhysWrite(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrMailboxIncoming,
1266	&MbxIn, sizeof(Mailbox32));
1267	}
1268
1269	/* Advance to next mailbox position. */
1270	pBusLogic->uMailboxIncomingPositionCurrent++;
1271	if (pBusLogic->uMailboxIncomingPositionCurrent >= pBusLogic->cMailbox)
1272	pBusLogic->uMailboxIncomingPositionCurrent = 0;
1273
1274	# ifdef LOG_ENABLED
1275	ASMAtomicIncU32(&pBusLogic->cInMailboxesReady);
1276	# endif
1277
1278	buslogicSetInterrupt(pBusLogic, false, BL_INTR_IMBL);
1279
1280	PDMCritSectLeave(&pBusLogic->CritSectIntr);
1281	}
1282
1283	# ifdef LOG_ENABLED
1284
1285	/**
1286	* Dumps the content of a mailbox for debugging purposes.
1287	*
1288	* @return nothing
1289	* @param pMailbox The mailbox to dump.
1290	* @param fOutgoing true if dumping the outgoing state.
1291	* false if dumping the incoming state.
1292	*/
1293	static void buslogicR3DumpMailboxInfo(PMailbox32 pMailbox, bool fOutgoing)
1294	{
1295	Log(("%s: Dump for %s mailbox:\n", __FUNCTION__, fOutgoing ? "outgoing" : "incoming"));
1296	Log(("%s: u32PhysAddrCCB=%#x\n", __FUNCTION__, pMailbox->u32PhysAddrCCB));
1297	if (fOutgoing)
1298	{
1299	Log(("%s: uActionCode=%u\n", __FUNCTION__, pMailbox->u.out.uActionCode));
1300	}
1301	else
1302	{
1303	Log(("%s: uHostAdapterStatus=%u\n", __FUNCTION__, pMailbox->u.in.uHostAdapterStatus));
1304	Log(("%s: uTargetDeviceStatus=%u\n", __FUNCTION__, pMailbox->u.in.uTargetDeviceStatus));
1305	Log(("%s: uCompletionCode=%u\n", __FUNCTION__, pMailbox->u.in.uCompletionCode));
1306	}
1307	}
1308
1309	/**
1310	* Dumps the content of a command control block for debugging purposes.
1311	*
1312	* @returns nothing.
1313	* @param pCCB Pointer to the command control block to dump.
1314	* @param fIs24BitCCB Flag to determine CCB format.
1315	*/
1316	static void buslogicR3DumpCCBInfo(PCCBU pCCB, bool fIs24BitCCB)
1317	{
1318	Log(("%s: Dump for %s Command Control Block:\n", __FUNCTION__, fIs24BitCCB ? "24-bit" : "32-bit"));
1319	Log(("%s: uOpCode=%#x\n", __FUNCTION__, pCCB->c.uOpcode));
1320	Log(("%s: uDataDirection=%u\n", __FUNCTION__, pCCB->c.uDataDirection));
1321	Log(("%s: cbCDB=%u\n", __FUNCTION__, pCCB->c.cbCDB));
1322	Log(("%s: cbSenseData=%u\n", __FUNCTION__, pCCB->c.cbSenseData));
1323	Log(("%s: uHostAdapterStatus=%u\n", __FUNCTION__, pCCB->c.uHostAdapterStatus));
1324	Log(("%s: uDeviceStatus=%u\n", __FUNCTION__, pCCB->c.uDeviceStatus));
1325	if (fIs24BitCCB)
1326	{
1327	Log(("%s: cbData=%u\n", __FUNCTION__, LEN_TO_U32(pCCB->o.acbData)));
1328	Log(("%s: PhysAddrData=%#x\n", __FUNCTION__, ADDR_TO_U32(pCCB->o.aPhysAddrData)));
1329	Log(("%s: uTargetId=%u\n", __FUNCTION__, pCCB->o.uTargetId));
1330	Log(("%s: uLogicalUnit=%u\n", __FUNCTION__, pCCB->o.uLogicalUnit));
1331	}
1332	else
1333	{
1334	Log(("%s: cbData=%u\n", __FUNCTION__, pCCB->n.cbData));
1335	Log(("%s: PhysAddrData=%#x\n", __FUNCTION__, pCCB->n.u32PhysAddrData));
1336	Log(("%s: uTargetId=%u\n", __FUNCTION__, pCCB->n.uTargetId));
1337	Log(("%s: uLogicalUnit=%u\n", __FUNCTION__, pCCB->n.uLogicalUnit));
1338	Log(("%s: fTagQueued=%d\n", __FUNCTION__, pCCB->n.fTagQueued));
1339	Log(("%s: uQueueTag=%u\n", __FUNCTION__, pCCB->n.uQueueTag));
1340	Log(("%s: fLegacyTagEnable=%u\n", __FUNCTION__, pCCB->n.fLegacyTagEnable));
1341	Log(("%s: uLegacyQueueTag=%u\n", __FUNCTION__, pCCB->n.uLegacyQueueTag));
1342	Log(("%s: PhysAddrSenseData=%#x\n", __FUNCTION__, pCCB->n.u32PhysAddrSenseData));
1343	}
1344	Log(("%s: uCDB[0]=%#x\n", __FUNCTION__, pCCB->c.abCDB[0]));
1345	for (int i = 1; i < pCCB->c.cbCDB; i++)
1346	Log(("%s: uCDB[%d]=%u\n", __FUNCTION__, i, pCCB->c.abCDB[i]));
1347	}
1348
1349	# endif /* LOG_ENABLED */
1350
1351	/**
1352	* Allocate data buffer.
1353	*
1354	* @param pDevIns PDM device instance.
1355	* @param fIs24Bit Flag whether the 24bit SG format is used.
1356	* @param GCSGList Guest physical address of S/G list.
1357	* @param cEntries Number of list entries to read.
1358	* @param pSGEList Pointer to 32-bit S/G list storage.
1359	*/
1360	static void buslogicR3ReadSGEntries(PPDMDEVINS pDevIns, bool fIs24Bit, RTGCPHYS GCSGList,
1361	uint32_t cEntries, SGE32 *pSGEList)
1362	{
1363	/* Read the S/G entries. Convert 24-bit entries to 32-bit format. */
1364	if (fIs24Bit)
1365	{
1366	SGE24 aSGE24[32];
1367	Assert(cEntries <= RT_ELEMENTS(aSGE24));
1368
1369	Log2(("Converting %u 24-bit S/G entries to 32-bit\n", cEntries));
1370	PDMDevHlpPhysRead(pDevIns, GCSGList, &aSGE24, cEntries * sizeof(SGE24));
1371	for (uint32_t i = 0; i < cEntries; ++i)
1372	{
1373	pSGEList[i].cbSegment = LEN_TO_U32(aSGE24[i].acbSegment);
1374	pSGEList[i].u32PhysAddrSegmentBase = ADDR_TO_U32(aSGE24[i].aPhysAddrSegmentBase);
1375	}
1376	}
1377	else
1378	PDMDevHlpPhysRead(pDevIns, GCSGList, pSGEList, cEntries * sizeof(SGE32));
1379	}
1380
1381	/**
1382	* Determines the size of th guest data buffer.
1383	*
1384	* @returns VBox status code.
1385	* @param pDevIns PDM device instance.
1386	* @param pCCBGuest The CCB of the guest.
1387	* @param fIs24Bit Flag whether the 24bit SG format is used.
1388	* @param pcbBuf Where to store the size of the guest data buffer on success.
1389	*/
1390	static int buslogicR3QueryDataBufferSize(PPDMDEVINS pDevIns, PCCBU pCCBGuest, bool fIs24Bit, size_t *pcbBuf)
1391	{
1392	int rc = VINF_SUCCESS;
1393	uint32_t cbDataCCB;
1394	uint32_t u32PhysAddrCCB;
1395	size_t cbBuf = 0;
1396
1397	/* Extract the data length and physical address from the CCB. */
1398	if (fIs24Bit)
1399	{
1400	u32PhysAddrCCB = ADDR_TO_U32(pCCBGuest->o.aPhysAddrData);
1401	cbDataCCB = LEN_TO_U32(pCCBGuest->o.acbData);
1402	}
1403	else
1404	{
1405	u32PhysAddrCCB = pCCBGuest->n.u32PhysAddrData;
1406	cbDataCCB = pCCBGuest->n.cbData;
1407	}
1408
1409	if ( (pCCBGuest->c.uDataDirection != BUSLOGIC_CCB_DIRECTION_NO_DATA)
1410	&& cbDataCCB)
1411	{
1412	/*
1413	* The BusLogic adapter can handle two different data buffer formats.
1414	* The first one is that the data pointer entry in the CCB points to
1415	* the buffer directly. In second mode the data pointer points to a
1416	* scatter gather list which describes the buffer.
1417	*/
1418	if ( (pCCBGuest->c.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_SCATTER_GATHER)
1419	\|\| (pCCBGuest->c.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_SCATTER_GATHER))
1420	{
1421	uint32_t cScatterGatherGCRead;
1422	uint32_t iScatterGatherEntry;
1423	SGE32 aScatterGatherReadGC[32]; /* A buffer for scatter gather list entries read from guest memory. */
1424	uint32_t cScatterGatherGCLeft = cbDataCCB / (fIs24Bit ? sizeof(SGE24) : sizeof(SGE32));
1425	RTGCPHYS GCPhysAddrScatterGatherCurrent = u32PhysAddrCCB;
1426
1427	/* Count number of bytes to transfer. */
1428	do
1429	{
1430	cScatterGatherGCRead = (cScatterGatherGCLeft < RT_ELEMENTS(aScatterGatherReadGC))
1431	? cScatterGatherGCLeft
1432	: RT_ELEMENTS(aScatterGatherReadGC);
1433	cScatterGatherGCLeft -= cScatterGatherGCRead;
1434
1435	buslogicR3ReadSGEntries(pDevIns, fIs24Bit, GCPhysAddrScatterGatherCurrent, cScatterGatherGCRead, aScatterGatherReadGC);
1436
1437	for (iScatterGatherEntry = 0; iScatterGatherEntry < cScatterGatherGCRead; iScatterGatherEntry++)
1438	cbBuf += aScatterGatherReadGC[iScatterGatherEntry].cbSegment;
1439
1440	/* Set address to the next entries to read. */
1441	GCPhysAddrScatterGatherCurrent += cScatterGatherGCRead * (fIs24Bit ? sizeof(SGE24) : sizeof(SGE32));
1442	} while (cScatterGatherGCLeft > 0);
1443
1444	Log(("%s: cbBuf=%d\n", __FUNCTION__, cbBuf));
1445	}
1446	else if ( pCCBGuest->c.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB
1447	\|\| pCCBGuest->c.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_DATA_LENGTH)
1448	cbBuf = cbDataCCB;
1449	}
1450
1451	if (RT_SUCCESS(rc))
1452	*pcbBuf = cbBuf;
1453
1454	return rc;
1455	}
1456
1457	/**
1458	* Copy from guest to host memory worker.
1459	*
1460	* @copydoc BUSLOGICR3MEMCOPYCALLBACK
1461	*/
1462	static DECLCALLBACK(void) buslogicR3CopyBufferFromGuestWorker(PBUSLOGIC pThis, RTGCPHYS GCPhys, PRTSGBUF pSgBuf,
1463	size_t cbCopy, size_t *pcbSkip)
1464	{
1465	size_t cbSkipped = RT_MIN(cbCopy, *pcbSkip);
1466	cbCopy -= cbSkipped;
1467	GCPhys += cbSkipped;
1468	*pcbSkip -= cbSkipped;
1469
1470	while (cbCopy)
1471	{
1472	size_t cbSeg = cbCopy;
1473	void *pvSeg = RTSgBufGetNextSegment(pSgBuf, &cbSeg);
1474
1475	AssertPtr(pvSeg);
1476	PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns), GCPhys, pvSeg, cbSeg);
1477	GCPhys += cbSeg;
1478	cbCopy -= cbSeg;
1479	}
1480	}
1481
1482	/**
1483	* Copy from host to guest memory worker.
1484	*
1485	* @copydoc BUSLOGICR3MEMCOPYCALLBACK
1486	*/
1487	static DECLCALLBACK(void) buslogicR3CopyBufferToGuestWorker(PBUSLOGIC pThis, RTGCPHYS GCPhys, PRTSGBUF pSgBuf,
1488	size_t cbCopy, size_t *pcbSkip)
1489	{
1490	size_t cbSkipped = RT_MIN(cbCopy, *pcbSkip);
1491	cbCopy -= cbSkipped;
1492	GCPhys += cbSkipped;
1493	*pcbSkip -= cbSkipped;
1494
1495	while (cbCopy)
1496	{
1497	size_t cbSeg = cbCopy;
1498	void *pvSeg = RTSgBufGetNextSegment(pSgBuf, &cbSeg);
1499
1500	AssertPtr(pvSeg);
1501	PDMDevHlpPCIPhysWrite(pThis->CTX_SUFF(pDevIns), GCPhys, pvSeg, cbSeg);
1502	GCPhys += cbSeg;
1503	cbCopy -= cbSeg;
1504	}
1505	}
1506
1507	/**
1508	* Walks the guest S/G buffer calling the given copy worker for every buffer.
1509	*
1510	* @returns The amout of bytes actually copied.
1511	* @param pThis Pointer to the Buslogic device state.
1512	* @param pReq Pointe to the request state.
1513	* @param pfnCopyWorker The copy method to apply for each guest buffer.
1514	* @param pSgBuf The host S/G buffer.
1515	* @param cbSkip How many bytes to skip in advance before starting to copy.
1516	* @param cbCopy How many bytes to copy.
1517	*/
1518	static size_t buslogicR3SgBufWalker(PBUSLOGIC pThis, PBUSLOGICREQ pReq,
1519	PBUSLOGICR3MEMCOPYCALLBACK pfnCopyWorker,
1520	PRTSGBUF pSgBuf, size_t cbSkip, size_t cbCopy)
1521	{
1522	PPDMDEVINS pDevIns = pThis->CTX_SUFF(pDevIns);
1523	uint32_t cbDataCCB;
1524	uint32_t u32PhysAddrCCB;
1525	size_t cbCopied = 0;
1526
1527	/*
1528	* Add the amount to skip to the host buffer size to avoid a
1529	* few conditionals later on.
1530	*/
1531	cbCopy += cbSkip;
1532
1533	/* Extract the data length and physical address from the CCB. */
1534	if (pReq->fIs24Bit)
1535	{
1536	u32PhysAddrCCB = ADDR_TO_U32(pReq->CCBGuest.o.aPhysAddrData);
1537	cbDataCCB = LEN_TO_U32(pReq->CCBGuest.o.acbData);
1538	}
1539	else
1540	{
1541	u32PhysAddrCCB = pReq->CCBGuest.n.u32PhysAddrData;
1542	cbDataCCB = pReq->CCBGuest.n.cbData;
1543	}
1544
1545	#if 1
1546	/* Hack for NT 10/91: A CCB describes a 2K buffer, but TEST UNIT READY is executed. This command
1547	* returns no data, hence the buffer must be left alone!
1548	*/
1549	if (pReq->CCBGuest.c.abCDB[0] == 0)
1550	cbDataCCB = 0;
1551	#endif
1552
1553	LogFlowFunc(("pReq=%#p cbDataCCB=%u direction=%u cbCopy=%zu\n", pReq, cbDataCCB,
1554	pReq->CCBGuest.c.uDataDirection, cbCopy));
1555
1556	if ( (cbDataCCB > 0)
1557	&& ( pReq->CCBGuest.c.uDataDirection == BUSLOGIC_CCB_DIRECTION_IN
1558	\|\| pReq->CCBGuest.c.uDataDirection == BUSLOGIC_CCB_DIRECTION_OUT
1559	\|\| pReq->CCBGuest.c.uDataDirection == BUSLOGIC_CCB_DIRECTION_UNKNOWN))
1560	{
1561	if ( (pReq->CCBGuest.c.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_SCATTER_GATHER)
1562	\|\| (pReq->CCBGuest.c.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_SCATTER_GATHER))
1563	{
1564	uint32_t cScatterGatherGCRead;
1565	uint32_t iScatterGatherEntry;
1566	SGE32 aScatterGatherReadGC[32]; /* Number of scatter gather list entries read from guest memory. */
1567	uint32_t cScatterGatherGCLeft = cbDataCCB / (pReq->fIs24Bit ? sizeof(SGE24) : sizeof(SGE32));
1568	RTGCPHYS GCPhysAddrScatterGatherCurrent = u32PhysAddrCCB;
1569
1570	do
1571	{
1572	cScatterGatherGCRead = (cScatterGatherGCLeft < RT_ELEMENTS(aScatterGatherReadGC))
1573	? cScatterGatherGCLeft
1574	: RT_ELEMENTS(aScatterGatherReadGC);
1575	cScatterGatherGCLeft -= cScatterGatherGCRead;
1576
1577	buslogicR3ReadSGEntries(pDevIns, pReq->fIs24Bit, GCPhysAddrScatterGatherCurrent,
1578	cScatterGatherGCRead, aScatterGatherReadGC);
1579
1580	for (iScatterGatherEntry = 0; iScatterGatherEntry < cScatterGatherGCRead && cbCopy > 0; iScatterGatherEntry++)
1581	{
1582	RTGCPHYS GCPhysAddrDataBase;
1583	size_t cbCopyThis;
1584
1585	Log(("%s: iScatterGatherEntry=%u\n", __FUNCTION__, iScatterGatherEntry));
1586
1587	GCPhysAddrDataBase = (RTGCPHYS)aScatterGatherReadGC[iScatterGatherEntry].u32PhysAddrSegmentBase;
1588	cbCopyThis = RT_MIN(cbCopy, aScatterGatherReadGC[iScatterGatherEntry].cbSegment);
1589
1590	Log(("%s: GCPhysAddrDataBase=%RGp cbCopyThis=%zu\n", __FUNCTION__, GCPhysAddrDataBase, cbCopyThis));
1591
1592	pfnCopyWorker(pThis, GCPhysAddrDataBase, pSgBuf, cbCopyThis, &cbSkip);
1593	cbCopied += cbCopyThis;
1594	cbCopy -= cbCopyThis;
1595	}
1596
1597	/* Set address to the next entries to read. */
1598	GCPhysAddrScatterGatherCurrent += cScatterGatherGCRead * (pReq->fIs24Bit ? sizeof(SGE24) : sizeof(SGE32));
1599	} while ( cScatterGatherGCLeft > 0
1600	&& cbCopy > 0);
1601
1602	}
1603	else if ( pReq->CCBGuest.c.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB
1604	\|\| pReq->CCBGuest.c.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_DATA_LENGTH)
1605	{
1606	/* The buffer is not scattered. */
1607	RTGCPHYS GCPhysAddrDataBase = u32PhysAddrCCB;
1608
1609	AssertMsg(GCPhysAddrDataBase != 0, ("Physical address is 0\n"));
1610
1611	Log(("Non-scattered buffer:\n"));
1612	Log(("u32PhysAddrData=%#x\n", u32PhysAddrCCB));
1613	Log(("cbData=%u\n", cbDataCCB));
1614	Log(("GCPhysAddrDataBase=0x%RGp\n", GCPhysAddrDataBase));
1615
1616	/* Copy the data into the guest memory. */
1617	pfnCopyWorker(pThis, GCPhysAddrDataBase, pSgBuf, RT_MIN(cbDataCCB, cbCopy), &cbSkip);
1618	cbCopied += RT_MIN(cbDataCCB, cbCopy);
1619	}
1620	}
1621
1622	/* Update residual data length. */
1623	if ( (pReq->CCBGuest.c.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_DATA_LENGTH)
1624	\|\| (pReq->CCBGuest.c.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_SCATTER_GATHER))
1625	{
1626	uint32_t cbResidual;
1627
1628	/** @todo we need to get the actual transfer length from the VSCSI layer?! */
1629	cbResidual = 0; //LEN_TO_U32(pTaskState->CCBGuest.acbData) - ???;
1630	if (pReq->fIs24Bit)
1631	U32_TO_LEN(pReq->CCBGuest.o.acbData, cbResidual);
1632	else
1633	pReq->CCBGuest.n.cbData = cbResidual;
1634	}
1635
1636	return cbCopied - RT_MIN(cbSkip, cbCopied);
1637	}
1638
1639	/**
1640	* Copies a data buffer into the S/G buffer set up by the guest.
1641	*
1642	* @returns Amount of bytes copied to the guest.
1643	* @param pThis The LsiLogic controller device instance.
1644	* @param pReq Request structure.
1645	* @param pSgBuf The S/G buffer to copy from.
1646	* @param cbSkip How many bytes to skip in advance before starting to copy.
1647	* @param cbCopy How many bytes to copy.
1648	*/
1649	static size_t buslogicR3CopySgBufToGuest(PBUSLOGIC pThis, PBUSLOGICREQ pReq, PRTSGBUF pSgBuf,
1650	size_t cbSkip, size_t cbCopy)
1651	{
1652	return buslogicR3SgBufWalker(pThis, pReq, buslogicR3CopyBufferToGuestWorker,
1653	pSgBuf, cbSkip, cbCopy);
1654	}
1655
1656	/**
1657	* Copies the guest S/G buffer into a host data buffer.
1658	*
1659	* @returns Amount of bytes copied from the guest.
1660	* @param pThis The LsiLogic controller device instance.
1661	* @param pReq Request structure.
1662	* @param pSgBuf The S/G buffer to copy into.
1663	* @param cbSkip How many bytes to skip in advance before starting to copy.
1664	* @param cbCopy How many bytes to copy.
1665	*/
1666	static size_t buslogicR3CopySgBufFromGuest(PBUSLOGIC pThis, PBUSLOGICREQ pReq, PRTSGBUF pSgBuf,
1667	size_t cbSkip, size_t cbCopy)
1668	{
1669	return buslogicR3SgBufWalker(pThis, pReq, buslogicR3CopyBufferFromGuestWorker,
1670	pSgBuf, cbSkip, cbCopy);
1671	}
1672
1673	/** Convert sense buffer length taking into account shortcut values. */
1674	static uint32_t buslogicR3ConvertSenseBufferLength(uint32_t cbSense)
1675	{
1676	/* Convert special sense buffer length values. */
1677	if (cbSense == 0)
1678	cbSense = 14; /* 0 means standard 14-byte buffer. */
1679	else if (cbSense == 1)
1680	cbSense = 0; /* 1 means no sense data. */
1681	else if (cbSense < 8)
1682	AssertMsgFailed(("Reserved cbSense value of %d used!\n", cbSense));
1683
1684	return cbSense;
1685	}
1686
1687	/**
1688	* Free the sense buffer.
1689	*
1690	* @returns nothing.
1691	* @param pReq Pointer to the request state.
1692	* @param fCopy If sense data should be copied to guest memory.
1693	*/
1694	static void buslogicR3SenseBufferFree(PBUSLOGICREQ pReq, bool fCopy)
1695	{
1696	uint32_t cbSenseBuffer;
1697
1698	cbSenseBuffer = buslogicR3ConvertSenseBufferLength(pReq->CCBGuest.c.cbSenseData);
1699
1700	/* Copy the sense buffer into guest memory if requested. */
1701	if (fCopy && cbSenseBuffer)
1702	{
1703	PPDMDEVINS pDevIns = pReq->pTargetDevice->CTX_SUFF(pBusLogic)->CTX_SUFF(pDevIns);
1704	RTGCPHYS GCPhysAddrSenseBuffer;
1705
1706	/* With 32-bit CCBs, the (optional) sense buffer physical address is provided separately.
1707	* On the other hand, with 24-bit CCBs, the sense buffer is simply located at the end of
1708	* the CCB, right after the variable-length CDB.
1709	*/
1710	if (pReq->fIs24Bit)
1711	{
1712	GCPhysAddrSenseBuffer = pReq->GCPhysAddrCCB;
1713	GCPhysAddrSenseBuffer += pReq->CCBGuest.c.cbCDB + RT_OFFSETOF(CCB24, abCDB);
1714	}
1715	else
1716	GCPhysAddrSenseBuffer = pReq->CCBGuest.n.u32PhysAddrSenseData;
1717
1718	Log3(("%s: sense buffer: %.*Rhxs\n", __FUNCTION__, cbSenseBuffer, pReq->pbSenseBuffer));
1719	PDMDevHlpPCIPhysWrite(pDevIns, GCPhysAddrSenseBuffer, pReq->pbSenseBuffer, cbSenseBuffer);
1720	}
1721
1722	RTMemFree(pReq->pbSenseBuffer);
1723	pReq->pbSenseBuffer = NULL;
1724	}
1725
1726	/**
1727	* Alloc the sense buffer.
1728	*
1729	* @returns VBox status code.
1730	* @param pReq Pointer to the task state.
1731	*/
1732	static int buslogicR3SenseBufferAlloc(PBUSLOGICREQ pReq)
1733	{
1734	pReq->pbSenseBuffer = NULL;
1735
1736	uint32_t cbSenseBuffer = buslogicR3ConvertSenseBufferLength(pReq->CCBGuest.c.cbSenseData);
1737	if (cbSenseBuffer)
1738	{
1739	pReq->pbSenseBuffer = (uint8_t *)RTMemAllocZ(cbSenseBuffer);
1740	if (!pReq->pbSenseBuffer)
1741	return VERR_NO_MEMORY;
1742	}
1743
1744	return VINF_SUCCESS;
1745	}
1746
1747	#endif /* IN_RING3 */
1748
1749	/**
1750	* Parses the command buffer and executes it.
1751	*
1752	* @returns VBox status code.
1753	* @param pBusLogic Pointer to the BusLogic device instance.
1754	*/
1755	static int buslogicProcessCommand(PBUSLOGIC pBusLogic)
1756	{
1757	int rc = VINF_SUCCESS;
1758	bool fSuppressIrq = false;
1759
1760	LogFlowFunc(("pBusLogic=%#p\n", pBusLogic));
1761	AssertMsg(pBusLogic->uOperationCode != 0xff, ("There is no command to execute\n"));
1762
1763	switch (pBusLogic->uOperationCode)
1764	{
1765	case BUSLOGICCOMMAND_TEST_CMDC_INTERRUPT:
1766	/* Valid command, no reply. */
1767	pBusLogic->cbReplyParametersLeft = 0;
1768	break;
1769	case BUSLOGICCOMMAND_INQUIRE_PCI_HOST_ADAPTER_INFORMATION:
1770	{
1771	PReplyInquirePCIHostAdapterInformation pReply = (PReplyInquirePCIHostAdapterInformation)pBusLogic->aReplyBuffer;
1772	memset(pReply, 0, sizeof(ReplyInquirePCIHostAdapterInformation));
1773
1774	/* It seems VMware does not provide valid information here too, lets do the same :) */
1775	pReply->InformationIsValid = 0;
1776	pReply->IsaIOPort = pBusLogic->uISABaseCode;
1777	pReply->IRQ = PCIDevGetInterruptLine(&pBusLogic->dev);
1778	pBusLogic->cbReplyParametersLeft = sizeof(ReplyInquirePCIHostAdapterInformation);
1779	break;
1780	}
1781	case BUSLOGICCOMMAND_SET_SCSI_SELECTION_TIMEOUT:
1782	{
1783	/* no-op */
1784	pBusLogic->cbReplyParametersLeft = 0;
1785	break;
1786	}
1787	case BUSLOGICCOMMAND_MODIFY_IO_ADDRESS:
1788	{
1789	/* Modify the ISA-compatible I/O port base. Note that this technically
1790	* violates the PCI spec, as this address is not reported through PCI.
1791	* However, it is required for compatibility with old drivers.
1792	*/
1793	#ifdef IN_RING3
1794	Log(("ISA I/O for PCI (code %x)\n", pBusLogic->aCommandBuffer[0]));
1795	buslogicR3RegisterISARange(pBusLogic, pBusLogic->aCommandBuffer[0]);
1796	pBusLogic->cbReplyParametersLeft = 0;
1797	fSuppressIrq = true;
1798	break;
1799	#else
1800	AssertMsgFailed(("Must never get here!\n"));
1801	#endif
1802	}
1803	case BUSLOGICCOMMAND_INQUIRE_BOARD_ID:
1804	{
1805	/* The special option byte is important: If it is '0' or 'B', Windows NT drivers
1806	* for Adaptec AHA-154x may claim the adapter. The BusLogic drivers will claim
1807	* the adapter only when the byte is not '0' or 'B'.
1808	*/
1809	pBusLogic->aReplyBuffer[0] = 'A'; /* Firmware option bytes */
1810	pBusLogic->aReplyBuffer[1] = 'A'; /* Special option byte */
1811
1812	/* We report version 5.07B. This reply will provide the first two digits. */
1813	pBusLogic->aReplyBuffer[2] = '5'; /* Major version 5 */
1814	pBusLogic->aReplyBuffer[3] = '0'; /* Minor version 0 */
1815	pBusLogic->cbReplyParametersLeft = 4; /* Reply is 4 bytes long */
1816	break;
1817	}
1818	case BUSLOGICCOMMAND_INQUIRE_FIRMWARE_VERSION_3RD_LETTER:
1819	{
1820	pBusLogic->aReplyBuffer[0] = '7';
1821	pBusLogic->cbReplyParametersLeft = 1;
1822	break;
1823	}
1824	case BUSLOGICCOMMAND_INQUIRE_FIRMWARE_VERSION_LETTER:
1825	{
1826	pBusLogic->aReplyBuffer[0] = 'B';
1827	pBusLogic->cbReplyParametersLeft = 1;
1828	break;
1829	}
1830	case BUSLOGICCOMMAND_SET_ADAPTER_OPTIONS:
1831	/* The parameter list length is determined by the first byte of the command buffer. */
1832	if (pBusLogic->iParameter == 1)
1833	{
1834	/* First pass - set the number of following parameter bytes. */
1835	pBusLogic->cbCommandParametersLeft = pBusLogic->aCommandBuffer[0];
1836	Log(("Set HA options: %u bytes follow\n", pBusLogic->cbCommandParametersLeft));
1837	}
1838	else
1839	{
1840	/* Second pass - process received data. */
1841	Log(("Set HA options: received %u bytes\n", pBusLogic->aCommandBuffer[0]));
1842	/* We ignore the data - it only concerns the SCSI hardware protocol. */
1843	}
1844	pBusLogic->cbReplyParametersLeft = 0;
1845	break;
1846
1847	case BUSLOGICCOMMAND_EXECUTE_SCSI_COMMAND:
1848	/* The parameter list length is at least 12 bytes; the 12th byte determines
1849	* the number of additional CDB bytes that will follow.
1850	*/
1851	if (pBusLogic->iParameter == 12)
1852	{
1853	/* First pass - set the number of following CDB bytes. */
1854	pBusLogic->cbCommandParametersLeft = pBusLogic->aCommandBuffer[11];
1855	Log(("Execute SCSI cmd: %u more bytes follow\n", pBusLogic->cbCommandParametersLeft));
1856	}
1857	else
1858	{
1859	PESCMD pCmd;
1860
1861	/* Second pass - process received data. */
1862	Log(("Execute SCSI cmd: received %u bytes\n", pBusLogic->aCommandBuffer[0]));
1863
1864	pCmd = (PESCMD)pBusLogic->aCommandBuffer;
1865	Log(("Addr %08X, cbData %08X, cbCDB=%u\n", pCmd->u32PhysAddrData, pCmd->cbData, pCmd->cbCDB));
1866	}
1867	// This is currently a dummy - just fails every command.
1868	pBusLogic->cbReplyParametersLeft = 4;
1869	pBusLogic->aReplyBuffer[0] = pBusLogic->aReplyBuffer[1] = 0;
1870	pBusLogic->aReplyBuffer[2] = 0x11; /* HBA status (timeout). */
1871	pBusLogic->aReplyBuffer[3] = 0; /* Device status. */
1872	break;
1873
1874	case BUSLOGICCOMMAND_INQUIRE_HOST_ADAPTER_MODEL_NUMBER:
1875	{
1876	/* The reply length is set by the guest and is found in the first byte of the command buffer. */
1877	pBusLogic->cbReplyParametersLeft = pBusLogic->aCommandBuffer[0];
1878	memset(pBusLogic->aReplyBuffer, 0, pBusLogic->cbReplyParametersLeft);
1879	const char aModelName[] = "958D "; /* Trailing \0 is fine, that's the filler anyway. */
1880	int cCharsToTransfer = pBusLogic->cbReplyParametersLeft <= sizeof(aModelName)
1881	? pBusLogic->cbReplyParametersLeft
1882	: sizeof(aModelName);
1883
1884	for (int i = 0; i < cCharsToTransfer; i++)
1885	pBusLogic->aReplyBuffer[i] = aModelName[i];
1886
1887	break;
1888	}
1889	case BUSLOGICCOMMAND_INQUIRE_CONFIGURATION:
1890	{
1891	uint8_t uPciIrq = PCIDevGetInterruptLine(&pBusLogic->dev);
1892
1893	pBusLogic->cbReplyParametersLeft = sizeof(ReplyInquireConfiguration);
1894	PReplyInquireConfiguration pReply = (PReplyInquireConfiguration)pBusLogic->aReplyBuffer;
1895	memset(pReply, 0, sizeof(ReplyInquireConfiguration));
1896
1897	pReply->uHostAdapterId = 7; /* The controller has always 7 as ID. */
1898	pReply->fDmaChannel6 = 1; /* DMA channel 6 is a good default. */
1899	/* The PCI IRQ is not necessarily representable in this structure.
1900	* If that is the case, the guest likely won't function correctly,
1901	* therefore we log a warning.
1902	*/
1903	switch (uPciIrq)
1904	{
1905	case 9: pReply->fIrqChannel9 = 1; break;
1906	case 10: pReply->fIrqChannel10 = 1; break;
1907	case 11: pReply->fIrqChannel11 = 1; break;
1908	case 12: pReply->fIrqChannel12 = 1; break;
1909	case 14: pReply->fIrqChannel14 = 1; break;
1910	case 15: pReply->fIrqChannel15 = 1; break;
1911	default:
1912	LogRel(("Warning: PCI IRQ %d cannot be represented as ISA!\n", uPciIrq));
1913	break;
1914	}
1915	break;
1916	}
1917	case BUSLOGICCOMMAND_INQUIRE_EXTENDED_SETUP_INFORMATION:
1918	{
1919	/* Some Adaptec AHA-154x drivers (e.g. OS/2) execute this command and expect
1920	* it to fail. If it succeeds, the drivers refuse to load. However, some newer
1921	* Adaptec 154x models supposedly support it too??
1922	*/
1923
1924	/* The reply length is set by the guest and is found in the first byte of the command buffer. */
1925	pBusLogic->cbReplyParametersLeft = pBusLogic->aCommandBuffer[0];
1926	PReplyInquireExtendedSetupInformation pReply = (PReplyInquireExtendedSetupInformation)pBusLogic->aReplyBuffer;
1927	memset(pReply, 0, sizeof(ReplyInquireExtendedSetupInformation));
1928
1929	/** @todo should this reflect the RAM contents (AutoSCSIRam)? */
1930	pReply->uBusType = 'E'; /* EISA style */
1931	pReply->u16ScatterGatherLimit = 8192;
1932	pReply->cMailbox = pBusLogic->cMailbox;
1933	pReply->uMailboxAddressBase = (uint32_t)pBusLogic->GCPhysAddrMailboxOutgoingBase;
1934	pReply->fLevelSensitiveInterrupt = true;
1935	pReply->fHostWideSCSI = true;
1936	pReply->fHostUltraSCSI = true;
1937	memcpy(pReply->aFirmwareRevision, "07B", sizeof(pReply->aFirmwareRevision));
1938
1939	break;
1940	}
1941	case BUSLOGICCOMMAND_INQUIRE_SETUP_INFORMATION:
1942	{
1943	/* The reply length is set by the guest and is found in the first byte of the command buffer. */
1944	pBusLogic->cbReplyParametersLeft = pBusLogic->aCommandBuffer[0];
1945	PReplyInquireSetupInformation pReply = (PReplyInquireSetupInformation)pBusLogic->aReplyBuffer;
1946	memset(pReply, 0, sizeof(ReplyInquireSetupInformation));
1947	pReply->fSynchronousInitiationEnabled = true;
1948	pReply->fParityCheckingEnabled = true;
1949	pReply->cMailbox = pBusLogic->cMailbox;
1950	U32_TO_ADDR(pReply->MailboxAddress, pBusLogic->GCPhysAddrMailboxOutgoingBase);
1951	pReply->uSignature = 'B';
1952	/* The 'D' signature prevents Adaptec's OS/2 drivers from getting too
1953	* friendly with BusLogic hardware and upsetting the HBA state.
1954	*/
1955	pReply->uCharacterD = 'D'; /* BusLogic model. */
1956	pReply->uHostBusType = 'F'; /* PCI bus. */
1957	break;
1958	}
1959	case BUSLOGICCOMMAND_FETCH_HOST_ADAPTER_LOCAL_RAM:
1960	{
1961	/*
1962	* First element in the command buffer contains start offset to read from
1963	* and second one the number of bytes to read.
1964	*/
1965	uint8_t uOffset = pBusLogic->aCommandBuffer[0];
1966	pBusLogic->cbReplyParametersLeft = pBusLogic->aCommandBuffer[1];
1967
1968	pBusLogic->fUseLocalRam = true;
1969	pBusLogic->iReply = uOffset;
1970	break;
1971	}
1972	case BUSLOGICCOMMAND_INITIALIZE_MAILBOX:
1973	{
1974	PRequestInitMbx pRequest = (PRequestInitMbx)pBusLogic->aCommandBuffer;
1975
1976	pBusLogic->fMbxIs24Bit = true;
1977	pBusLogic->cMailbox = pRequest->cMailbox;
1978	pBusLogic->GCPhysAddrMailboxOutgoingBase = (RTGCPHYS)ADDR_TO_U32(pRequest->aMailboxBaseAddr);
1979	/* The area for incoming mailboxes is right after the last entry of outgoing mailboxes. */
1980	pBusLogic->GCPhysAddrMailboxIncomingBase = pBusLogic->GCPhysAddrMailboxOutgoingBase + (pBusLogic->cMailbox * sizeof(Mailbox24));
1981
1982	Log(("GCPhysAddrMailboxOutgoingBase=%RGp\n", pBusLogic->GCPhysAddrMailboxOutgoingBase));
1983	Log(("GCPhysAddrMailboxIncomingBase=%RGp\n", pBusLogic->GCPhysAddrMailboxIncomingBase));
1984	Log(("cMailboxes=%u (24-bit mode)\n", pBusLogic->cMailbox));
1985	LogRel(("Initialized 24-bit mailbox, %d entries at %08x\n", pRequest->cMailbox, ADDR_TO_U32(pRequest->aMailboxBaseAddr)));
1986
1987	pBusLogic->regStatus &= ~BL_STAT_INREQ;
1988	pBusLogic->cbReplyParametersLeft = 0;
1989	break;
1990	}
1991	case BUSLOGICCOMMAND_INITIALIZE_EXTENDED_MAILBOX:
1992	{
1993	PRequestInitializeExtendedMailbox pRequest = (PRequestInitializeExtendedMailbox)pBusLogic->aCommandBuffer;
1994
1995	pBusLogic->fMbxIs24Bit = false;
1996	pBusLogic->cMailbox = pRequest->cMailbox;
1997	pBusLogic->GCPhysAddrMailboxOutgoingBase = (RTGCPHYS)pRequest->uMailboxBaseAddress;
1998	/* The area for incoming mailboxes is right after the last entry of outgoing mailboxes. */
1999	pBusLogic->GCPhysAddrMailboxIncomingBase = (RTGCPHYS)pRequest->uMailboxBaseAddress + (pBusLogic->cMailbox * sizeof(Mailbox32));
2000
2001	Log(("GCPhysAddrMailboxOutgoingBase=%RGp\n", pBusLogic->GCPhysAddrMailboxOutgoingBase));
2002	Log(("GCPhysAddrMailboxIncomingBase=%RGp\n", pBusLogic->GCPhysAddrMailboxIncomingBase));
2003	Log(("cMailboxes=%u (32-bit mode)\n", pBusLogic->cMailbox));
2004	LogRel(("Initialized 32-bit mailbox, %d entries at %08x\n", pRequest->cMailbox, pRequest->uMailboxBaseAddress));
2005
2006	pBusLogic->regStatus &= ~BL_STAT_INREQ;
2007	pBusLogic->cbReplyParametersLeft = 0;
2008	break;
2009	}
2010	case BUSLOGICCOMMAND_ENABLE_STRICT_ROUND_ROBIN_MODE:
2011	{
2012	if (pBusLogic->aCommandBuffer[0] == 0)
2013	pBusLogic->fStrictRoundRobinMode = false;
2014	else if (pBusLogic->aCommandBuffer[0] == 1)
2015	pBusLogic->fStrictRoundRobinMode = true;
2016	else
2017	AssertMsgFailed(("Invalid round robin mode %d\n", pBusLogic->aCommandBuffer[0]));
2018
2019	pBusLogic->cbReplyParametersLeft = 0;
2020	break;
2021	}
2022	case BUSLOGICCOMMAND_SET_CCB_FORMAT:
2023	{
2024	if (pBusLogic->aCommandBuffer[0] == 0)
2025	pBusLogic->fExtendedLunCCBFormat = false;
2026	else if (pBusLogic->aCommandBuffer[0] == 1)
2027	pBusLogic->fExtendedLunCCBFormat = true;
2028	else
2029	AssertMsgFailed(("Invalid CCB format %d\n", pBusLogic->aCommandBuffer[0]));
2030
2031	pBusLogic->cbReplyParametersLeft = 0;
2032	break;
2033	}
2034	case BUSLOGICCOMMAND_INQUIRE_INSTALLED_DEVICES_ID_0_TO_7:
2035	/* This is supposed to send TEST UNIT READY to each target/LUN.
2036	* We cheat and skip that, since we already know what's attached
2037	*/
2038	memset(pBusLogic->aReplyBuffer, 0, 8);
2039	for (int i = 0; i < 8; ++i)
2040	{
2041	if (pBusLogic->aDeviceStates[i].fPresent)
2042	pBusLogic->aReplyBuffer[i] = 1;
2043	}
2044	pBusLogic->aReplyBuffer[7] = 0; /* HA hardcoded at ID 7. */
2045	pBusLogic->cbReplyParametersLeft = 8;
2046	break;
2047	case BUSLOGICCOMMAND_INQUIRE_INSTALLED_DEVICES_ID_8_TO_15:
2048	/* See note about cheating above. */
2049	memset(pBusLogic->aReplyBuffer, 0, 8);
2050	for (int i = 0; i < 8; ++i)
2051	{
2052	if (pBusLogic->aDeviceStates[i + 8].fPresent)
2053	pBusLogic->aReplyBuffer[i] = 1;
2054	}
2055	pBusLogic->cbReplyParametersLeft = 8;
2056	break;
2057	case BUSLOGICCOMMAND_INQUIRE_TARGET_DEVICES:
2058	{
2059	/* Each bit which is set in the 16bit wide variable means a present device. */
2060	uint16_t u16TargetsPresentMask = 0;
2061
2062	for (uint8_t i = 0; i < RT_ELEMENTS(pBusLogic->aDeviceStates); i++)
2063	{
2064	if (pBusLogic->aDeviceStates[i].fPresent)
2065	u16TargetsPresentMask \|= (1 << i);
2066	}
2067	pBusLogic->aReplyBuffer[0] = (uint8_t)u16TargetsPresentMask;
2068	pBusLogic->aReplyBuffer[1] = (uint8_t)(u16TargetsPresentMask >> 8);
2069	pBusLogic->cbReplyParametersLeft = 2;
2070	break;
2071	}
2072	case BUSLOGICCOMMAND_INQUIRE_SYNCHRONOUS_PERIOD:
2073	{
2074	pBusLogic->cbReplyParametersLeft = pBusLogic->aCommandBuffer[0];
2075
2076	for (uint8_t i = 0; i < pBusLogic->cbReplyParametersLeft; i++)
2077	pBusLogic->aReplyBuffer[i] = 0; /** @todo Figure if we need something other here. It's not needed for the linux driver */
2078
2079	break;
2080	}
2081	case BUSLOGICCOMMAND_DISABLE_HOST_ADAPTER_INTERRUPT:
2082	{
2083	if (pBusLogic->aCommandBuffer[0] == 0)
2084	pBusLogic->fIRQEnabled = false;
2085	else
2086	pBusLogic->fIRQEnabled = true;
2087	/* No interrupt signaled regardless of enable/disable. */
2088	fSuppressIrq = true;
2089	break;
2090	}
2091	case BUSLOGICCOMMAND_ECHO_COMMAND_DATA:
2092	{
2093	pBusLogic->aReplyBuffer[0] = pBusLogic->aCommandBuffer[0];
2094	pBusLogic->cbReplyParametersLeft = 1;
2095	break;
2096	}
2097	case BUSLOGICCOMMAND_SET_PREEMPT_TIME_ON_BUS:
2098	{
2099	pBusLogic->cbReplyParametersLeft = 0;
2100	pBusLogic->LocalRam.structured.autoSCSIData.uBusOnDelay = pBusLogic->aCommandBuffer[0];
2101	Log(("Bus-on time: %d\n", pBusLogic->aCommandBuffer[0]));
2102	break;
2103	}
2104	case BUSLOGICCOMMAND_SET_TIME_OFF_BUS:
2105	{
2106	pBusLogic->cbReplyParametersLeft = 0;
2107	pBusLogic->LocalRam.structured.autoSCSIData.uBusOffDelay = pBusLogic->aCommandBuffer[0];
2108	Log(("Bus-off time: %d\n", pBusLogic->aCommandBuffer[0]));
2109	break;
2110	}
2111	case BUSLOGICCOMMAND_SET_BUS_TRANSFER_RATE:
2112	{
2113	pBusLogic->cbReplyParametersLeft = 0;
2114	pBusLogic->LocalRam.structured.autoSCSIData.uDMATransferRate = pBusLogic->aCommandBuffer[0];
2115	Log(("Bus transfer rate: %02X\n", pBusLogic->aCommandBuffer[0]));
2116	break;
2117	}
2118	case BUSLOGICCOMMAND_WRITE_BUSMASTER_CHIP_FIFO:
2119	{
2120	RTGCPHYS GCPhysFifoBuf;
2121	Addr24 addr;
2122
2123	pBusLogic->cbReplyParametersLeft = 0;
2124	addr.hi = pBusLogic->aCommandBuffer[0];
2125	addr.mid = pBusLogic->aCommandBuffer[1];
2126	addr.lo = pBusLogic->aCommandBuffer[2];
2127	GCPhysFifoBuf = (RTGCPHYS)ADDR_TO_U32(addr);
2128	Log(("Write busmaster FIFO at: %04X\n", ADDR_TO_U32(addr)));
2129	PDMDevHlpPhysRead(pBusLogic->CTX_SUFF(pDevIns), GCPhysFifoBuf,
2130	&pBusLogic->LocalRam.u8View[64], 64);
2131	break;
2132	}
2133	case BUSLOGICCOMMAND_READ_BUSMASTER_CHIP_FIFO:
2134	{
2135	RTGCPHYS GCPhysFifoBuf;
2136	Addr24 addr;
2137
2138	pBusLogic->cbReplyParametersLeft = 0;
2139	addr.hi = pBusLogic->aCommandBuffer[0];
2140	addr.mid = pBusLogic->aCommandBuffer[1];
2141	addr.lo = pBusLogic->aCommandBuffer[2];
2142	GCPhysFifoBuf = (RTGCPHYS)ADDR_TO_U32(addr);
2143	Log(("Read busmaster FIFO at: %04X\n", ADDR_TO_U32(addr)));
2144	PDMDevHlpPCIPhysWrite(pBusLogic->CTX_SUFF(pDevIns), GCPhysFifoBuf,
2145	&pBusLogic->LocalRam.u8View[64], 64);
2146	break;
2147	}
2148	default:
2149	AssertMsgFailed(("Invalid command %#x\n", pBusLogic->uOperationCode));
2150	case BUSLOGICCOMMAND_EXT_BIOS_INFO:
2151	case BUSLOGICCOMMAND_UNLOCK_MAILBOX:
2152	/* Commands valid for Adaptec 154xC which we don't handle since
2153	* we pretend being 154xB compatible. Just mark the command as invalid.
2154	*/
2155	Log(("Command %#x not valid for this adapter\n", pBusLogic->uOperationCode));
2156	pBusLogic->cbReplyParametersLeft = 0;
2157	pBusLogic->regStatus \|= BL_STAT_CMDINV;
2158	break;
2159	case BUSLOGICCOMMAND_EXECUTE_MAILBOX_COMMAND: /* Should be handled already. */
2160	AssertMsgFailed(("Invalid mailbox execute state!\n"));
2161	}
2162
2163	Log(("uOperationCode=%#x, cbReplyParametersLeft=%d\n", pBusLogic->uOperationCode, pBusLogic->cbReplyParametersLeft));
2164
2165	/* Set the data in ready bit in the status register in case the command has a reply. */
2166	if (pBusLogic->cbReplyParametersLeft)
2167	pBusLogic->regStatus \|= BL_STAT_DIRRDY;
2168	else if (!pBusLogic->cbCommandParametersLeft)
2169	buslogicCommandComplete(pBusLogic, fSuppressIrq);
2170
2171	return rc;
2172	}
2173
2174	/**
2175	* Read a register from the BusLogic adapter.
2176	*
2177	* @returns VBox status code.
2178	* @param pBusLogic Pointer to the BusLogic instance data.
2179	* @param iRegister The index of the register to read.
2180	* @param pu32 Where to store the register content.
2181	*/
2182	static int buslogicRegisterRead(PBUSLOGIC pBusLogic, unsigned iRegister, uint32_t *pu32)
2183	{
2184	int rc = VINF_SUCCESS;
2185
2186	switch (iRegister)
2187	{
2188	case BUSLOGIC_REGISTER_STATUS:
2189	{
2190	*pu32 = pBusLogic->regStatus;
2191
2192	/* If the diagnostic active bit is set, we are in a guest-initiated
2193	* hard reset. If the guest reads the status register and waits for
2194	* the host adapter ready bit to be set, we terminate the reset right
2195	* away. However, guests may also expect the reset condition to clear
2196	* automatically after a period of time, in which case we can't show
2197	* the DIAG bit at all.
2198	*/
2199	if (pBusLogic->regStatus & BL_STAT_DACT)
2200	{
2201	uint64_t u64AccessTime = PDMDevHlpTMTimeVirtGetNano(pBusLogic->CTX_SUFF(pDevIns));
2202
2203	pBusLogic->regStatus &= ~BL_STAT_DACT;
2204	pBusLogic->regStatus \|= BL_STAT_HARDY;
2205
2206	if (u64AccessTime - pBusLogic->u64ResetTime > BUSLOGIC_RESET_DURATION_NS)
2207	{
2208	/* If reset already expired, let the guest see that right away. */
2209	*pu32 = pBusLogic->regStatus;
2210	pBusLogic->u64ResetTime = 0;
2211	}
2212	}
2213	break;
2214	}
2215	case BUSLOGIC_REGISTER_DATAIN:
2216	{
2217	if (pBusLogic->fUseLocalRam)
2218	*pu32 = pBusLogic->LocalRam.u8View[pBusLogic->iReply];
2219	else
2220	*pu32 = pBusLogic->aReplyBuffer[pBusLogic->iReply];
2221
2222	/* Careful about underflow - guest can read data register even if
2223	* no data is available.
2224	*/
2225	if (pBusLogic->cbReplyParametersLeft)
2226	{
2227	pBusLogic->iReply++;
2228	pBusLogic->cbReplyParametersLeft--;
2229	if (!pBusLogic->cbReplyParametersLeft)
2230	{
2231	/*
2232	* Reply finished, set command complete bit, unset data-in ready bit and
2233	* interrupt the guest if enabled.
2234	*/
2235	buslogicCommandComplete(pBusLogic, false);
2236	}
2237	}
2238	LogFlowFunc(("data=%02x, iReply=%d, cbReplyParametersLeft=%u\n", *pu32,
2239	pBusLogic->iReply, pBusLogic->cbReplyParametersLeft));
2240	break;
2241	}
2242	case BUSLOGIC_REGISTER_INTERRUPT:
2243	{
2244	*pu32 = pBusLogic->regInterrupt;
2245	break;
2246	}
2247	case BUSLOGIC_REGISTER_GEOMETRY:
2248	{
2249	*pu32 = pBusLogic->regGeometry;
2250	break;
2251	}
2252	default:
2253	*pu32 = UINT32_C(0xffffffff);
2254	}
2255
2256	Log2(("%s: pu32=%p:{%.*Rhxs} iRegister=%d rc=%Rrc\n",
2257	__FUNCTION__, pu32, 1, pu32, iRegister, rc));
2258
2259	return rc;
2260	}
2261
2262	/**
2263	* Write a value to a register.
2264	*
2265	* @returns VBox status code.
2266	* @param pBusLogic Pointer to the BusLogic instance data.
2267	* @param iRegister The index of the register to read.
2268	* @param uVal The value to write.
2269	*/
2270	static int buslogicRegisterWrite(PBUSLOGIC pBusLogic, unsigned iRegister, uint8_t uVal)
2271	{
2272	int rc = VINF_SUCCESS;
2273
2274	switch (iRegister)
2275	{
2276	case BUSLOGIC_REGISTER_CONTROL:
2277	{
2278	if ((uVal & BL_CTRL_RHARD) \|\| (uVal & BL_CTRL_RSOFT))
2279	{
2280	#ifdef IN_RING3
2281	bool fHardReset = !!(uVal & BL_CTRL_RHARD);
2282
2283	LogRel(("BusLogic: %s reset\n", fHardReset ? "hard" : "soft"));
2284	buslogicR3InitiateReset(pBusLogic, fHardReset);
2285	#else
2286	rc = VINF_IOM_R3_IOPORT_WRITE;
2287	#endif
2288	break;
2289	}
2290
2291	rc = PDMCritSectEnter(&pBusLogic->CritSectIntr, VINF_IOM_R3_IOPORT_WRITE);
2292	if (rc != VINF_SUCCESS)
2293	return rc;
2294
2295	#ifdef LOG_ENABLED
2296	uint32_t cMailboxesReady = ASMAtomicXchgU32(&pBusLogic->cInMailboxesReady, 0);
2297	Log(("%u incoming mailboxes were ready when this interrupt was cleared\n", cMailboxesReady));
2298	#endif
2299
2300	if (uVal & BL_CTRL_RINT)
2301	buslogicClearInterrupt(pBusLogic);
2302
2303	PDMCritSectLeave(&pBusLogic->CritSectIntr);
2304
2305	break;
2306	}
2307	case BUSLOGIC_REGISTER_COMMAND:
2308	{
2309	/* Fast path for mailbox execution command. */
2310	if ((uVal == BUSLOGICCOMMAND_EXECUTE_MAILBOX_COMMAND) && (pBusLogic->uOperationCode == 0xff))
2311	{
2312	/* If there are no mailboxes configured, don't even try to do anything. */
2313	if (pBusLogic->cMailbox)
2314	{
2315	ASMAtomicIncU32(&pBusLogic->cMailboxesReady);
2316	if (!ASMAtomicXchgBool(&pBusLogic->fNotificationSent, true))
2317	{
2318	/* Send new notification to the queue. */
2319	PPDMQUEUEITEMCORE pItem = PDMQueueAlloc(pBusLogic->CTX_SUFF(pNotifierQueue));
2320	AssertMsg(pItem, ("Allocating item for queue failed\n"));
2321	PDMQueueInsert(pBusLogic->CTX_SUFF(pNotifierQueue), (PPDMQUEUEITEMCORE)pItem);
2322	}
2323	}
2324
2325	return rc;
2326	}
2327
2328	/*
2329	* Check if we are already fetch command parameters from the guest.
2330	* If not we initialize executing a new command.
2331	*/
2332	if (pBusLogic->uOperationCode == 0xff)
2333	{
2334	pBusLogic->uOperationCode = uVal;
2335	pBusLogic->iParameter = 0;
2336
2337	/* Mark host adapter as busy and clear the invalid status bit. */
2338	pBusLogic->regStatus &= ~(BL_STAT_HARDY \| BL_STAT_CMDINV);
2339
2340	/* Get the number of bytes for parameters from the command code. */
2341	switch (pBusLogic->uOperationCode)
2342	{
2343	case BUSLOGICCOMMAND_TEST_CMDC_INTERRUPT:
2344	case BUSLOGICCOMMAND_INQUIRE_FIRMWARE_VERSION_LETTER:
2345	case BUSLOGICCOMMAND_INQUIRE_BOARD_ID:
2346	case BUSLOGICCOMMAND_INQUIRE_FIRMWARE_VERSION_3RD_LETTER:
2347	case BUSLOGICCOMMAND_INQUIRE_PCI_HOST_ADAPTER_INFORMATION:
2348	case BUSLOGICCOMMAND_INQUIRE_CONFIGURATION:
2349	case BUSLOGICCOMMAND_INQUIRE_INSTALLED_DEVICES_ID_0_TO_7:
2350	case BUSLOGICCOMMAND_INQUIRE_INSTALLED_DEVICES_ID_8_TO_15:
2351	case BUSLOGICCOMMAND_INQUIRE_TARGET_DEVICES:
2352	pBusLogic->cbCommandParametersLeft = 0;
2353	break;
2354	case BUSLOGICCOMMAND_MODIFY_IO_ADDRESS:
2355	case BUSLOGICCOMMAND_INQUIRE_EXTENDED_SETUP_INFORMATION:
2356	case BUSLOGICCOMMAND_INQUIRE_SETUP_INFORMATION:
2357	case BUSLOGICCOMMAND_INQUIRE_HOST_ADAPTER_MODEL_NUMBER:
2358	case BUSLOGICCOMMAND_ENABLE_STRICT_ROUND_ROBIN_MODE:
2359	case BUSLOGICCOMMAND_SET_CCB_FORMAT:
2360	case BUSLOGICCOMMAND_INQUIRE_SYNCHRONOUS_PERIOD:
2361	case BUSLOGICCOMMAND_DISABLE_HOST_ADAPTER_INTERRUPT:
2362	case BUSLOGICCOMMAND_ECHO_COMMAND_DATA:
2363	case BUSLOGICCOMMAND_SET_PREEMPT_TIME_ON_BUS:
2364	case BUSLOGICCOMMAND_SET_TIME_OFF_BUS:
2365	case BUSLOGICCOMMAND_SET_BUS_TRANSFER_RATE:
2366	pBusLogic->cbCommandParametersLeft = 1;
2367	break;
2368	case BUSLOGICCOMMAND_FETCH_HOST_ADAPTER_LOCAL_RAM:
2369	pBusLogic->cbCommandParametersLeft = 2;
2370	break;
2371	case BUSLOGICCOMMAND_READ_BUSMASTER_CHIP_FIFO:
2372	case BUSLOGICCOMMAND_WRITE_BUSMASTER_CHIP_FIFO:
2373	pBusLogic->cbCommandParametersLeft = 3;
2374	break;
2375	case BUSLOGICCOMMAND_SET_SCSI_SELECTION_TIMEOUT:
2376	pBusLogic->cbCommandParametersLeft = 4;
2377	break;
2378	case BUSLOGICCOMMAND_INITIALIZE_MAILBOX:
2379	pBusLogic->cbCommandParametersLeft = sizeof(RequestInitMbx);
2380	break;
2381	case BUSLOGICCOMMAND_INITIALIZE_EXTENDED_MAILBOX:
2382	pBusLogic->cbCommandParametersLeft = sizeof(RequestInitializeExtendedMailbox);
2383	break;
2384	case BUSLOGICCOMMAND_SET_ADAPTER_OPTIONS:
2385	/* There must be at least one byte following this command. */
2386	pBusLogic->cbCommandParametersLeft = 1;
2387	break;
2388	case BUSLOGICCOMMAND_EXECUTE_SCSI_COMMAND:
2389	/* 12 bytes + variable-length CDB. */
2390	pBusLogic->cbCommandParametersLeft = 12;
2391	break;
2392	case BUSLOGICCOMMAND_EXT_BIOS_INFO:
2393	case BUSLOGICCOMMAND_UNLOCK_MAILBOX:
2394	/* Invalid commands. */
2395	pBusLogic->cbCommandParametersLeft = 0;
2396	break;
2397	case BUSLOGICCOMMAND_EXECUTE_MAILBOX_COMMAND: /* Should not come here anymore. */
2398	default:
2399	AssertMsgFailed(("Invalid operation code %#x\n", uVal));
2400	}
2401	}
2402	else
2403	{
2404	#ifndef IN_RING3
2405	/* This command must be executed in R3 as it rehooks the ISA I/O port. */
2406	if (pBusLogic->uOperationCode == BUSLOGICCOMMAND_MODIFY_IO_ADDRESS)
2407	{
2408	rc = VINF_IOM_R3_IOPORT_WRITE;
2409	break;
2410	}
2411	#endif
2412	/*
2413	* The real adapter would set the Command register busy bit in the status register.
2414	* The guest has to wait until it is unset.
2415	* We don't need to do it because the guest does not continue execution while we are in this
2416	* function.
2417	*/
2418	pBusLogic->aCommandBuffer[pBusLogic->iParameter] = uVal;
2419	pBusLogic->iParameter++;
2420	pBusLogic->cbCommandParametersLeft--;
2421	}
2422
2423	/* Start execution of command if there are no parameters left. */
2424	if (!pBusLogic->cbCommandParametersLeft)
2425	{
2426	rc = buslogicProcessCommand(pBusLogic);
2427	AssertMsgRC(rc, ("Processing command failed rc=%Rrc\n", rc));
2428	}
2429	break;
2430	}
2431
2432	/* On BusLogic adapters, the interrupt and geometry registers are R/W.
2433	* That is different from Adaptec 154x where those are read only.
2434	*/
2435	case BUSLOGIC_REGISTER_INTERRUPT:
2436	pBusLogic->regInterrupt = uVal;
2437	break;
2438
2439	case BUSLOGIC_REGISTER_GEOMETRY:
2440	pBusLogic->regGeometry = uVal;
2441	break;
2442
2443	default:
2444	AssertMsgFailed(("Register not available\n"));
2445	rc = VERR_IOM_IOPORT_UNUSED;
2446	}
2447
2448	return rc;
2449	}
2450
2451	/**
2452	* Memory mapped I/O Handler for read operations.
2453	*
2454	* @returns VBox status code.
2455	*
2456	* @param pDevIns The device instance.
2457	* @param pvUser User argument.
2458	* @param GCPhysAddr Physical address (in GC) where the read starts.
2459	* @param pv Where to store the result.
2460	* @param cb Number of bytes read.
2461	*/
2462	PDMBOTHCBDECL(int) buslogicMMIORead(PPDMDEVINS pDevIns, void pvUser, RTGCPHYS GCPhysAddr, void pv, unsigned cb)
2463	{
2464	RT_NOREF_PV(pDevIns); RT_NOREF_PV(pvUser); RT_NOREF_PV(GCPhysAddr); RT_NOREF_PV(pv); RT_NOREF_PV(cb);
2465
2466	/* the linux driver does not make use of the MMIO area. */
2467	AssertMsgFailed(("MMIO Read\n"));
2468	return VINF_SUCCESS;
2469	}
2470
2471	/**
2472	* Memory mapped I/O Handler for write operations.
2473	*
2474	* @returns VBox status code.
2475	*
2476	* @param pDevIns The device instance.
2477	* @param pvUser User argument.
2478	* @param GCPhysAddr Physical address (in GC) where the read starts.
2479	* @param pv Where to fetch the result.
2480	* @param cb Number of bytes to write.
2481	*/
2482	PDMBOTHCBDECL(int) buslogicMMIOWrite(PPDMDEVINS pDevIns, void pvUser, RTGCPHYS GCPhysAddr, void const pv, unsigned cb)
2483	{
2484	RT_NOREF_PV(pDevIns); RT_NOREF_PV(pvUser); RT_NOREF_PV(GCPhysAddr); RT_NOREF_PV(pv); RT_NOREF_PV(cb);
2485
2486	/* the linux driver does not make use of the MMIO area. */
2487	AssertMsgFailed(("MMIO Write\n"));
2488	return VINF_SUCCESS;
2489	}
2490
2491	/**
2492	* Port I/O Handler for IN operations.
2493	*
2494	* @returns VBox status code.
2495	*
2496	* @param pDevIns The device instance.
2497	* @param pvUser User argument.
2498	* @param uPort Port number used for the IN operation.
2499	* @param pu32 Where to store the result.
2500	* @param cb Number of bytes read.
2501	*/
2502	PDMBOTHCBDECL(int) buslogicIOPortRead(PPDMDEVINS pDevIns, void pvUser, RTIOPORT uPort, uint32_t pu32, unsigned cb)
2503	{
2504	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2505	unsigned iRegister = uPort % 4;
2506	RT_NOREF_PV(pvUser); RT_NOREF_PV(cb);
2507
2508	Assert(cb == 1);
2509
2510	return buslogicRegisterRead(pBusLogic, iRegister, pu32);
2511	}
2512
2513	/**
2514	* Port I/O Handler for OUT operations.
2515	*
2516	* @returns VBox status code.
2517	*
2518	* @param pDevIns The device instance.
2519	* @param pvUser User argument.
2520	* @param uPort Port number used for the IN operation.
2521	* @param u32 The value to output.
2522	* @param cb The value size in bytes.
2523	*/
2524	PDMBOTHCBDECL(int) buslogicIOPortWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t u32, unsigned cb)
2525	{
2526	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2527	unsigned iRegister = uPort % 4;
2528	uint8_t uVal = (uint8_t)u32;
2529	RT_NOREF2(pvUser, cb);
2530
2531	Assert(cb == 1);
2532
2533	int rc = buslogicRegisterWrite(pBusLogic, iRegister, (uint8_t)uVal);
2534
2535	Log2(("#%d %s: pvUser=%#p cb=%d u32=%#x uPort=%#x rc=%Rrc\n",
2536	pDevIns->iInstance, __FUNCTION__, pvUser, cb, u32, uPort, rc));
2537
2538	return rc;
2539	}
2540
2541	#ifdef IN_RING3
2542
2543	static int buslogicR3PrepareBIOSSCSIRequest(PBUSLOGIC pThis)
2544	{
2545	uint32_t uTargetDevice;
2546	uint32_t uLun;
2547	uint8_t *pbCdb;
2548	size_t cbCdb;
2549	size_t cbBuf;
2550
2551	int rc = vboxscsiSetupRequest(&pThis->VBoxSCSI, &uLun, &pbCdb, &cbCdb, &cbBuf, &uTargetDevice);
2552	AssertMsgRCReturn(rc, ("Setting up SCSI request failed rc=%Rrc\n", rc), rc);
2553
2554	if ( uTargetDevice < RT_ELEMENTS(pThis->aDeviceStates)
2555	&& pThis->aDeviceStates[uTargetDevice].pDrvBase)
2556	{
2557	PBUSLOGICDEVICE pTgtDev = &pThis->aDeviceStates[uTargetDevice];
2558	PDMMEDIAEXIOREQ hIoReq;
2559	PBUSLOGICREQ pReq;
2560
2561	rc = pTgtDev->pDrvMediaEx->pfnIoReqAlloc(pTgtDev->pDrvMediaEx, &hIoReq, (void **)&pReq,
2562	0, PDMIMEDIAEX_F_SUSPEND_ON_RECOVERABLE_ERR);
2563	AssertMsgRCReturn(rc, ("Getting task from cache failed rc=%Rrc\n", rc), rc);
2564
2565	pReq->fBIOS = true;
2566	pReq->hIoReq = hIoReq;
2567	pReq->pTargetDevice = pTgtDev;
2568
2569	ASMAtomicIncU32(&pTgtDev->cOutstandingRequests);
2570
2571	rc = pTgtDev->pDrvMediaEx->pfnIoReqSendScsiCmd(pTgtDev->pDrvMediaEx, pReq->hIoReq, uLun,
2572	pbCdb, cbCdb, PDMMEDIAEXIOREQSCSITXDIR_UNKNOWN,
2573	cbBuf, NULL, 0, &pReq->u8ScsiSts, 30 * RT_MS_1SEC);
2574	if (rc == VINF_SUCCESS \|\| rc != VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS)
2575	{
2576	uint8_t u8ScsiSts = pReq->u8ScsiSts;
2577	pTgtDev->pDrvMediaEx->pfnIoReqFree(pTgtDev->pDrvMediaEx, pReq->hIoReq);
2578	rc = vboxscsiRequestFinished(&pThis->VBoxSCSI, u8ScsiSts);
2579	}
2580	else if (rc == VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS)
2581	rc = VINF_SUCCESS;
2582
2583	return rc;
2584	}
2585
2586	/* Device is not present. */
2587	AssertMsg(pbCdb[0] == SCSI_INQUIRY,
2588	("Device is not present but command is not inquiry\n"));
2589
2590	SCSIINQUIRYDATA ScsiInquiryData;
2591
2592	memset(&ScsiInquiryData, 0, sizeof(SCSIINQUIRYDATA));
2593	ScsiInquiryData.u5PeripheralDeviceType = SCSI_INQUIRY_DATA_PERIPHERAL_DEVICE_TYPE_UNKNOWN;
2594	ScsiInquiryData.u3PeripheralQualifier = SCSI_INQUIRY_DATA_PERIPHERAL_QUALIFIER_NOT_CONNECTED_NOT_SUPPORTED;
2595
2596	memcpy(pThis->VBoxSCSI.pbBuf, &ScsiInquiryData, 5);
2597
2598	rc = vboxscsiRequestFinished(&pThis->VBoxSCSI, SCSI_STATUS_OK);
2599	AssertMsgRCReturn(rc, ("Finishing BIOS SCSI request failed rc=%Rrc\n", rc), rc);
2600
2601	return rc;
2602	}
2603
2604
2605	/**
2606	* Port I/O Handler for IN operations - BIOS port.
2607	*
2608	* @returns VBox status code.
2609	*
2610	* @param pDevIns The device instance.
2611	* @param pvUser User argument.
2612	* @param uPort Port number used for the IN operation.
2613	* @param pu32 Where to store the result.
2614	* @param cb Number of bytes read.
2615	*/
2616	static DECLCALLBACK(int) buslogicR3BiosIoPortRead(PPDMDEVINS pDevIns, void pvUser, RTIOPORT uPort, uint32_t pu32, unsigned cb)
2617	{
2618	RT_NOREF(pvUser, cb);
2619	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2620
2621	Assert(cb == 1);
2622
2623	int rc = vboxscsiReadRegister(&pBusLogic->VBoxSCSI, (uPort - BUSLOGIC_BIOS_IO_PORT), pu32);
2624
2625	//Log2(("%s: pu32=%p:{%.*Rhxs} iRegister=%d rc=%Rrc\n",
2626	// __FUNCTION__, pu32, 1, pu32, (uPort - BUSLOGIC_BIOS_IO_PORT), rc));
2627
2628	return rc;
2629	}
2630
2631	/**
2632	* Port I/O Handler for OUT operations - BIOS port.
2633	*
2634	* @returns VBox status code.
2635	*
2636	* @param pDevIns The device instance.
2637	* @param pvUser User argument.
2638	* @param uPort Port number used for the IN operation.
2639	* @param u32 The value to output.
2640	* @param cb The value size in bytes.
2641	*/
2642	static DECLCALLBACK(int) buslogicR3BiosIoPortWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t u32, unsigned cb)
2643	{
2644	RT_NOREF(pvUser, cb);
2645	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2646	Log2(("#%d %s: pvUser=%#p cb=%d u32=%#x uPort=%#x\n", pDevIns->iInstance, __FUNCTION__, pvUser, cb, u32, uPort));
2647
2648	/*
2649	* If there is already a request form the BIOS pending ignore this write
2650	* because it should not happen.
2651	*/
2652	if (ASMAtomicReadBool(&pThis->fBiosReqPending))
2653	return VINF_SUCCESS;
2654
2655	Assert(cb == 1);
2656
2657	int rc = vboxscsiWriteRegister(&pThis->VBoxSCSI, (uPort - BUSLOGIC_BIOS_IO_PORT), (uint8_t)u32);
2658	if (rc == VERR_MORE_DATA)
2659	{
2660	ASMAtomicXchgBool(&pThis->fBiosReqPending, true);
2661	/* Send a notifier to the PDM queue that there are pending requests. */
2662	PPDMQUEUEITEMCORE pItem = PDMQueueAlloc(pThis->CTX_SUFF(pNotifierQueue));
2663	AssertMsg(pItem, ("Allocating item for queue failed\n"));
2664	PDMQueueInsert(pThis->CTX_SUFF(pNotifierQueue), (PPDMQUEUEITEMCORE)pItem);
2665	rc = VINF_SUCCESS;
2666	}
2667	else if (RT_FAILURE(rc))
2668	AssertMsgFailed(("Writing BIOS register failed %Rrc\n", rc));
2669
2670	return VINF_SUCCESS;
2671	}
2672
2673	/**
2674	* Port I/O Handler for primary port range OUT string operations.
2675	* @see FNIOMIOPORTOUTSTRING for details.
2676	*/
2677	static DECLCALLBACK(int) buslogicR3BiosIoPortWriteStr(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port,
2678	uint8_t const pbSrc, uint32_t pcTransfers, unsigned cb)
2679	{
2680	RT_NOREF(pvUser);
2681	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2682	Log2(("#%d %s: pvUser=%#p cb=%d Port=%#x\n", pDevIns->iInstance, __FUNCTION__, pvUser, cb, Port));
2683
2684	/*
2685	* If there is already a request form the BIOS pending ignore this write
2686	* because it should not happen.
2687	*/
2688	if (ASMAtomicReadBool(&pThis->fBiosReqPending))
2689	return VINF_SUCCESS;
2690
2691	int rc = vboxscsiWriteString(pDevIns, &pThis->VBoxSCSI, (Port - BUSLOGIC_BIOS_IO_PORT), pbSrc, pcTransfers, cb);
2692	if (rc == VERR_MORE_DATA)
2693	{
2694	ASMAtomicXchgBool(&pThis->fBiosReqPending, true);
2695	/* Send a notifier to the PDM queue that there are pending requests. */
2696	PPDMQUEUEITEMCORE pItem = PDMQueueAlloc(pThis->CTX_SUFF(pNotifierQueue));
2697	AssertMsg(pItem, ("Allocating item for queue failed\n"));
2698	PDMQueueInsert(pThis->CTX_SUFF(pNotifierQueue), (PPDMQUEUEITEMCORE)pItem);
2699	}
2700	else if (RT_FAILURE(rc))
2701	AssertMsgFailed(("Writing BIOS register failed %Rrc\n", rc));
2702
2703	return VINF_SUCCESS;
2704	}
2705
2706	/**
2707	* Port I/O Handler for primary port range IN string operations.
2708	* @see FNIOMIOPORTINSTRING for details.
2709	*/
2710	static DECLCALLBACK(int) buslogicR3BiosIoPortReadStr(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port,
2711	uint8_t pbDst, uint32_t pcTransfers, unsigned cb)
2712	{
2713	RT_NOREF(pvUser);
2714	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2715	LogFlowFunc(("#%d %s: pvUser=%#p cb=%d Port=%#x\n", pDevIns->iInstance, __FUNCTION__, pvUser, cb, Port));
2716
2717	return vboxscsiReadString(pDevIns, &pBusLogic->VBoxSCSI, (Port - BUSLOGIC_BIOS_IO_PORT),
2718	pbDst, pcTransfers, cb);
2719	}
2720
2721	/**
2722	* Update the ISA I/O range.
2723	*
2724	* @returns nothing.
2725	* @param pBusLogic Pointer to the BusLogic device instance.
2726	* @param uBaseCode Encoded ISA I/O base; only low 3 bits are used.
2727	*/
2728	static int buslogicR3RegisterISARange(PBUSLOGIC pBusLogic, uint8_t uBaseCode)
2729	{
2730	uint8_t uCode = uBaseCode & MAX_ISA_BASE;
2731	uint16_t uNewBase = g_aISABases[uCode];
2732	int rc = VINF_SUCCESS;
2733
2734	LogFlowFunc(("ISA I/O code %02X, new base %X\n", uBaseCode, uNewBase));
2735
2736	/* Check if the same port range is already registered. */
2737	if (uNewBase != pBusLogic->IOISABase)
2738	{
2739	/* Unregister the old range, if any. */
2740	if (pBusLogic->IOISABase)
2741	rc = PDMDevHlpIOPortDeregister(pBusLogic->CTX_SUFF(pDevIns), pBusLogic->IOISABase, 4);
2742
2743	if (RT_SUCCESS(rc))
2744	{
2745	pBusLogic->IOISABase = 0; /* First mark as unregistered. */
2746	pBusLogic->uISABaseCode = ISA_BASE_DISABLED;
2747
2748	if (uNewBase)
2749	{
2750	/* Register the new range if requested. */
2751	rc = PDMDevHlpIOPortRegister(pBusLogic->CTX_SUFF(pDevIns), uNewBase, 4, NULL,
2752	buslogicIOPortWrite, buslogicIOPortRead,
2753	NULL, NULL,
2754	"BusLogic ISA");
2755	if (RT_SUCCESS(rc))
2756	{
2757	pBusLogic->IOISABase = uNewBase;
2758	pBusLogic->uISABaseCode = uCode;
2759	}
2760	}
2761	}
2762	if (RT_SUCCESS(rc))
2763	{
2764	if (uNewBase)
2765	{
2766	Log(("ISA I/O base: %x\n", uNewBase));
2767	LogRel(("BusLogic: ISA I/O base: %x\n", uNewBase));
2768	}
2769	else
2770	{
2771	Log(("Disabling ISA I/O ports.\n"));
2772	LogRel(("BusLogic: ISA I/O disabled\n"));
2773	}
2774	}
2775
2776	}
2777	return rc;
2778	}
2779
2780
2781	/**
2782	* @callback_method_impl{FNPCIIOREGIONMAP}
2783	*/
2784	static DECLCALLBACK(int) buslogicR3MmioMap(PPDMDEVINS pDevIns, PPDMPCIDEV pPciDev, uint32_t iRegion,
2785	RTGCPHYS GCPhysAddress, RTGCPHYS cb, PCIADDRESSSPACE enmType)
2786	{
2787	RT_NOREF(pPciDev, iRegion);
2788	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2789	int rc = VINF_SUCCESS;
2790
2791	Log2(("%s: registering MMIO area at GCPhysAddr=%RGp cb=%RGp\n", __FUNCTION__, GCPhysAddress, cb));
2792
2793	Assert(cb >= 32);
2794
2795	if (enmType == PCI_ADDRESS_SPACE_MEM)
2796	{
2797	/* We use the assigned size here, because we currently only support page aligned MMIO ranges. */
2798	rc = PDMDevHlpMMIORegister(pDevIns, GCPhysAddress, cb, NULL /pvUser/,
2799	IOMMMIO_FLAGS_READ_PASSTHRU \| IOMMMIO_FLAGS_WRITE_PASSTHRU,
2800	buslogicMMIOWrite, buslogicMMIORead, "BusLogic MMIO");
2801	if (RT_FAILURE(rc))
2802	return rc;
2803
2804	if (pThis->fR0Enabled)
2805	{
2806	rc = PDMDevHlpMMIORegisterR0(pDevIns, GCPhysAddress, cb, NIL_RTR0PTR /pvUser/,
2807	"buslogicMMIOWrite", "buslogicMMIORead");
2808	if (RT_FAILURE(rc))
2809	return rc;
2810	}
2811
2812	if (pThis->fGCEnabled)
2813	{
2814	rc = PDMDevHlpMMIORegisterRC(pDevIns, GCPhysAddress, cb, NIL_RTRCPTR /pvUser/,
2815	"buslogicMMIOWrite", "buslogicMMIORead");
2816	if (RT_FAILURE(rc))
2817	return rc;
2818	}
2819
2820	pThis->MMIOBase = GCPhysAddress;
2821	}
2822	else if (enmType == PCI_ADDRESS_SPACE_IO)
2823	{
2824	rc = PDMDevHlpIOPortRegister(pDevIns, (RTIOPORT)GCPhysAddress, 32,
2825	NULL, buslogicIOPortWrite, buslogicIOPortRead, NULL, NULL, "BusLogic PCI");
2826	if (RT_FAILURE(rc))
2827	return rc;
2828
2829	if (pThis->fR0Enabled)
2830	{
2831	rc = PDMDevHlpIOPortRegisterR0(pDevIns, (RTIOPORT)GCPhysAddress, 32,
2832	0, "buslogicIOPortWrite", "buslogicIOPortRead", NULL, NULL, "BusLogic PCI");
2833	if (RT_FAILURE(rc))
2834	return rc;
2835	}
2836
2837	if (pThis->fGCEnabled)
2838	{
2839	rc = PDMDevHlpIOPortRegisterRC(pDevIns, (RTIOPORT)GCPhysAddress, 32,
2840	0, "buslogicIOPortWrite", "buslogicIOPortRead", NULL, NULL, "BusLogic PCI");
2841	if (RT_FAILURE(rc))
2842	return rc;
2843	}
2844
2845	pThis->IOPortBase = (RTIOPORT)GCPhysAddress;
2846	}
2847	else
2848	AssertMsgFailed(("Invalid enmType=%d\n", enmType));
2849
2850	return rc;
2851	}
2852
2853	static int buslogicR3ReqComplete(PBUSLOGIC pThis, PBUSLOGICREQ pReq, int rcReq)
2854	{
2855	RT_NOREF(rcReq);
2856	PBUSLOGICDEVICE pTgtDev = pReq->pTargetDevice;
2857
2858	LogFlowFunc(("before decrement %u\n", pTgtDev->cOutstandingRequests));
2859	ASMAtomicDecU32(&pTgtDev->cOutstandingRequests);
2860	LogFlowFunc(("after decrement %u\n", pTgtDev->cOutstandingRequests));
2861
2862	if (pReq->fBIOS)
2863	{
2864	uint8_t u8ScsiSts = pReq->u8ScsiSts;
2865	pTgtDev->pDrvMediaEx->pfnIoReqFree(pTgtDev->pDrvMediaEx, pReq->hIoReq);
2866	int rc = vboxscsiRequestFinished(&pThis->VBoxSCSI, u8ScsiSts);
2867	AssertMsgRC(rc, ("Finishing BIOS SCSI request failed rc=%Rrc\n", rc));
2868	}
2869	else
2870	{
2871	if (pReq->pbSenseBuffer)
2872	buslogicR3SenseBufferFree(pReq, (pReq->u8ScsiSts != SCSI_STATUS_OK));
2873
2874	/*
2875	* Save vital things from the request and free it before posting completion
2876	* to avoid that the guest submits a new request with the same ID as the still
2877	* allocated one.
2878	*/
2879	uint8_t u8ScsiSts = pReq->u8ScsiSts;
2880	RTGCPHYS GCPhysAddrCCB = pReq->GCPhysAddrCCB;
2881	bool fIs24Bit = pReq->fIs24Bit;
2882	CCBU CCBGuest;
2883	memcpy(&CCBGuest, &pReq->CCBGuest, sizeof(CCBU));
2884
2885	pTgtDev->pDrvMediaEx->pfnIoReqFree(pTgtDev->pDrvMediaEx, pReq->hIoReq);
2886	if (u8ScsiSts == SCSI_STATUS_OK)
2887	buslogicR3SendIncomingMailbox(pThis, GCPhysAddrCCB, &CCBGuest,
2888	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_CMD_COMPLETED,
2889	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_OPERATION_GOOD,
2890	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_WITHOUT_ERROR);
2891	else if (u8ScsiSts == SCSI_STATUS_CHECK_CONDITION)
2892	buslogicR3SendIncomingMailbox(pThis, GCPhysAddrCCB, &CCBGuest,
2893	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_CMD_COMPLETED,
2894	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_CHECK_CONDITION,
2895	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_WITH_ERROR);
2896	else
2897	AssertMsgFailed(("invalid completion status %u\n", u8ScsiSts));
2898
2899	#ifdef LOG_ENABLED
2900	buslogicR3DumpCCBInfo(&CCBGuest, fIs24Bit);
2901	#endif
2902	}
2903
2904	if (pTgtDev->cOutstandingRequests == 0 && pThis->fSignalIdle)
2905	PDMDevHlpAsyncNotificationCompleted(pThis->pDevInsR3);
2906
2907	return VINF_SUCCESS;
2908	}
2909
2910	static DECLCALLBACK(int) buslogicR3QueryDeviceLocation(PPDMIMEDIAPORT pInterface, const char **ppcszController,
2911	uint32_t piInstance, uint32_t piLUN)
2912	{
2913	PBUSLOGICDEVICE pBusLogicDevice = RT_FROM_MEMBER(pInterface, BUSLOGICDEVICE, IMediaPort);
2914	PPDMDEVINS pDevIns = pBusLogicDevice->CTX_SUFF(pBusLogic)->CTX_SUFF(pDevIns);
2915
2916	AssertPtrReturn(ppcszController, VERR_INVALID_POINTER);
2917	AssertPtrReturn(piInstance, VERR_INVALID_POINTER);
2918	AssertPtrReturn(piLUN, VERR_INVALID_POINTER);
2919
2920	*ppcszController = pDevIns->pReg->szName;
2921	*piInstance = pDevIns->iInstance;
2922	*piLUN = pBusLogicDevice->iLUN;
2923
2924	return VINF_SUCCESS;
2925	}
2926
2927	/**
2928	* @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqCopyFromBuf}
2929	*/
2930	static DECLCALLBACK(int) buslogicR3IoReqCopyFromBuf(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
2931	void *pvIoReqAlloc, uint32_t offDst, PRTSGBUF pSgBuf,
2932	size_t cbCopy)
2933	{
2934	RT_NOREF1(hIoReq);
2935	PBUSLOGICDEVICE pTgtDev = RT_FROM_MEMBER(pInterface, BUSLOGICDEVICE, IMediaExPort);
2936	PBUSLOGICREQ pReq = (PBUSLOGICREQ)pvIoReqAlloc;
2937
2938	size_t cbCopied = 0;
2939	if (RT_UNLIKELY(pReq->fBIOS))
2940	cbCopied = vboxscsiCopyToBuf(&pTgtDev->CTX_SUFF(pBusLogic)->VBoxSCSI, pSgBuf, offDst, cbCopy);
2941	else
2942	cbCopied = buslogicR3CopySgBufToGuest(pTgtDev->CTX_SUFF(pBusLogic), pReq, pSgBuf, offDst, cbCopy);
2943	return cbCopied == cbCopy ? VINF_SUCCESS : VERR_PDM_MEDIAEX_IOBUF_OVERFLOW;
2944	}
2945
2946	/**
2947	* @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqCopyToBuf}
2948	*/
2949	static DECLCALLBACK(int) buslogicR3IoReqCopyToBuf(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
2950	void *pvIoReqAlloc, uint32_t offSrc, PRTSGBUF pSgBuf,
2951	size_t cbCopy)
2952	{
2953	RT_NOREF1(hIoReq);
2954	PBUSLOGICDEVICE pTgtDev = RT_FROM_MEMBER(pInterface, BUSLOGICDEVICE, IMediaExPort);
2955	PBUSLOGICREQ pReq = (PBUSLOGICREQ)pvIoReqAlloc;
2956
2957	size_t cbCopied = 0;
2958	if (RT_UNLIKELY(pReq->fBIOS))
2959	cbCopied = vboxscsiCopyFromBuf(&pTgtDev->CTX_SUFF(pBusLogic)->VBoxSCSI, pSgBuf, offSrc, cbCopy);
2960	else
2961	cbCopied = buslogicR3CopySgBufFromGuest(pTgtDev->CTX_SUFF(pBusLogic), pReq, pSgBuf, offSrc, cbCopy);
2962	return cbCopied == cbCopy ? VINF_SUCCESS : VERR_PDM_MEDIAEX_IOBUF_UNDERRUN;
2963	}
2964
2965	/**
2966	* @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqCompleteNotify}
2967	*/
2968	static DECLCALLBACK(int) buslogicR3IoReqCompleteNotify(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
2969	void *pvIoReqAlloc, int rcReq)
2970	{
2971	RT_NOREF(hIoReq);
2972	PBUSLOGICDEVICE pTgtDev = RT_FROM_MEMBER(pInterface, BUSLOGICDEVICE, IMediaExPort);
2973	buslogicR3ReqComplete(pTgtDev->CTX_SUFF(pBusLogic), (PBUSLOGICREQ)pvIoReqAlloc, rcReq);
2974	return VINF_SUCCESS;
2975	}
2976
2977	/**
2978	* @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqStateChanged}
2979	*/
2980	static DECLCALLBACK(void) buslogicR3IoReqStateChanged(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
2981	void *pvIoReqAlloc, PDMMEDIAEXIOREQSTATE enmState)
2982	{
2983	RT_NOREF3(hIoReq, pvIoReqAlloc, enmState);
2984	PBUSLOGICDEVICE pTgtDev = RT_FROM_MEMBER(pInterface, BUSLOGICDEVICE, IMediaExPort);
2985
2986	switch (enmState)
2987	{
2988	case PDMMEDIAEXIOREQSTATE_SUSPENDED:
2989	{
2990	/* Make sure the request is not accounted for so the VM can suspend successfully. */
2991	uint32_t cTasksActive = ASMAtomicDecU32(&pTgtDev->cOutstandingRequests);
2992	if (!cTasksActive && pTgtDev->CTX_SUFF(pBusLogic)->fSignalIdle)
2993	PDMDevHlpAsyncNotificationCompleted(pTgtDev->CTX_SUFF(pBusLogic)->pDevInsR3);
2994	break;
2995	}
2996	case PDMMEDIAEXIOREQSTATE_ACTIVE:
2997	/* Make sure the request is accounted for so the VM suspends only when the request is complete. */
2998	ASMAtomicIncU32(&pTgtDev->cOutstandingRequests);
2999	break;
3000	default:
3001	AssertMsgFailed(("Invalid request state given %u\n", enmState));
3002	}
3003	}
3004
3005	/**
3006	* @interface_method_impl{PDMIMEDIAEXPORT,pfnMediumEjected}
3007	*/
3008	static DECLCALLBACK(void) buslogicR3MediumEjected(PPDMIMEDIAEXPORT pInterface)
3009	{
3010	PBUSLOGICDEVICE pTgtDev = RT_FROM_MEMBER(pInterface, BUSLOGICDEVICE, IMediaExPort);
3011	PBUSLOGIC pThis = pTgtDev->CTX_SUFF(pBusLogic);
3012
3013	if (pThis->pMediaNotify)
3014	{
3015	int rc = VMR3ReqCallNoWait(PDMDevHlpGetVM(pThis->CTX_SUFF(pDevIns)), VMCPUID_ANY,
3016	(PFNRT)pThis->pMediaNotify->pfnEjected, 2,
3017	pThis->pMediaNotify, pTgtDev->iLUN);
3018	AssertRC(rc);
3019	}
3020	}
3021
3022	static int buslogicR3DeviceSCSIRequestSetup(PBUSLOGIC pBusLogic, RTGCPHYS GCPhysAddrCCB)
3023	{
3024	int rc = VINF_SUCCESS;
3025	uint8_t uTargetIdCCB;
3026	CCBU CCBGuest;
3027
3028	/* Fetch the CCB from guest memory. */
3029	/** @todo How much do we really have to read? */
3030	PDMDevHlpPhysRead(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrCCB,
3031	&CCBGuest, sizeof(CCB32));
3032
3033	uTargetIdCCB = pBusLogic->fMbxIs24Bit ? CCBGuest.o.uTargetId : CCBGuest.n.uTargetId;
3034	if (RT_LIKELY(uTargetIdCCB < RT_ELEMENTS(pBusLogic->aDeviceStates)))
3035	{
3036	PBUSLOGICDEVICE pTgtDev = &pBusLogic->aDeviceStates[uTargetIdCCB];
3037
3038	#ifdef LOG_ENABLED
3039	buslogicR3DumpCCBInfo(&CCBGuest, pBusLogic->fMbxIs24Bit);
3040	#endif
3041
3042	/* Check if device is present on bus. If not return error immediately and don't process this further. */
3043	if (RT_LIKELY(pTgtDev->fPresent))
3044	{
3045	PDMMEDIAEXIOREQ hIoReq;
3046	PBUSLOGICREQ pReq;
3047	rc = pTgtDev->pDrvMediaEx->pfnIoReqAlloc(pTgtDev->pDrvMediaEx, &hIoReq, (void **)&pReq,
3048	GCPhysAddrCCB, PDMIMEDIAEX_F_SUSPEND_ON_RECOVERABLE_ERR);
3049	if (RT_SUCCESS(rc))
3050	{
3051	pReq->pTargetDevice = pTgtDev;
3052	pReq->GCPhysAddrCCB = GCPhysAddrCCB;
3053	pReq->fBIOS = false;
3054	pReq->hIoReq = hIoReq;
3055	pReq->fIs24Bit = pBusLogic->fMbxIs24Bit;
3056
3057	/* Make a copy of the CCB */
3058	memcpy(&pReq->CCBGuest, &CCBGuest, sizeof(CCBGuest));
3059
3060	/* Alloc required buffers. */
3061	rc = buslogicR3SenseBufferAlloc(pReq);
3062	AssertMsgRC(rc, ("Mapping sense buffer failed rc=%Rrc\n", rc));
3063
3064	size_t cbBuf = 0;
3065	rc = buslogicR3QueryDataBufferSize(pBusLogic->CTX_SUFF(pDevIns), &pReq->CCBGuest, pReq->fIs24Bit, &cbBuf);
3066	AssertRC(rc);
3067
3068	uint32_t uLun = pReq->fIs24Bit ? pReq->CCBGuest.o.uLogicalUnit
3069	: pReq->CCBGuest.n.uLogicalUnit;
3070
3071	PDMMEDIAEXIOREQSCSITXDIR enmXferDir = PDMMEDIAEXIOREQSCSITXDIR_UNKNOWN;
3072	size_t cbSense = buslogicR3ConvertSenseBufferLength(CCBGuest.c.cbSenseData);
3073
3074	if (CCBGuest.c.uDataDirection == BUSLOGIC_CCB_DIRECTION_NO_DATA)
3075	enmXferDir = PDMMEDIAEXIOREQSCSITXDIR_NONE;
3076	else if (CCBGuest.c.uDataDirection == BUSLOGIC_CCB_DIRECTION_OUT)
3077	enmXferDir = PDMMEDIAEXIOREQSCSITXDIR_TO_DEVICE;
3078	else if (CCBGuest.c.uDataDirection == BUSLOGIC_CCB_DIRECTION_IN)
3079	enmXferDir = PDMMEDIAEXIOREQSCSITXDIR_FROM_DEVICE;
3080
3081	ASMAtomicIncU32(&pTgtDev->cOutstandingRequests);
3082	rc = pTgtDev->pDrvMediaEx->pfnIoReqSendScsiCmd(pTgtDev->pDrvMediaEx, pReq->hIoReq, uLun,
3083	&pReq->CCBGuest.c.abCDB[0], pReq->CCBGuest.c.cbCDB,
3084	enmXferDir, cbBuf, pReq->pbSenseBuffer, cbSense,
3085	&pReq->u8ScsiSts, 30 * RT_MS_1SEC);
3086	if (rc != VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS)
3087	buslogicR3ReqComplete(pBusLogic, pReq, rc);
3088	}
3089	else
3090	buslogicR3SendIncomingMailbox(pBusLogic, GCPhysAddrCCB, &CCBGuest,
3091	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_SCSI_SELECTION_TIMEOUT,
3092	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_OPERATION_GOOD,
3093	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_WITH_ERROR);
3094	}
3095	else
3096	buslogicR3SendIncomingMailbox(pBusLogic, GCPhysAddrCCB, &CCBGuest,
3097	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_SCSI_SELECTION_TIMEOUT,
3098	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_OPERATION_GOOD,
3099	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_WITH_ERROR);
3100	}
3101	else
3102	buslogicR3SendIncomingMailbox(pBusLogic, GCPhysAddrCCB, &CCBGuest,
3103	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_INVALID_COMMAND_PARAMETER,
3104	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_OPERATION_GOOD,
3105	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_WITH_ERROR);
3106
3107	return rc;
3108	}
3109
3110	static int buslogicR3DeviceSCSIRequestAbort(PBUSLOGIC pBusLogic, RTGCPHYS GCPhysAddrCCB)
3111	{
3112	int rc = VINF_SUCCESS;
3113	uint8_t uTargetIdCCB;
3114	CCBU CCBGuest;
3115
3116	PDMDevHlpPhysRead(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrCCB,
3117	&CCBGuest, sizeof(CCB32));
3118
3119	uTargetIdCCB = pBusLogic->fMbxIs24Bit ? CCBGuest.o.uTargetId : CCBGuest.n.uTargetId;
3120	if (RT_LIKELY(uTargetIdCCB < RT_ELEMENTS(pBusLogic->aDeviceStates)))
3121	buslogicR3SendIncomingMailbox(pBusLogic, GCPhysAddrCCB, &CCBGuest,
3122	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_ABORT_QUEUE_GENERATED,
3123	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_OPERATION_GOOD,
3124	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_ABORTED_NOT_FOUND);
3125	else
3126	buslogicR3SendIncomingMailbox(pBusLogic, GCPhysAddrCCB, &CCBGuest,
3127	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_INVALID_COMMAND_PARAMETER,
3128	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_OPERATION_GOOD,
3129	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_WITH_ERROR);
3130
3131	return rc;
3132	}
3133
3134	/**
3135	* Read a mailbox from guest memory. Convert 24-bit mailboxes to
3136	* 32-bit format.
3137	*
3138	* @returns Mailbox guest physical address.
3139	* @param pBusLogic Pointer to the BusLogic instance data.
3140	* @param pMbx Pointer to the mailbox to read into.
3141	*/
3142	static RTGCPHYS buslogicR3ReadOutgoingMailbox(PBUSLOGIC pBusLogic, PMailbox32 pMbx)
3143	{
3144	RTGCPHYS GCMailbox;
3145
3146	if (pBusLogic->fMbxIs24Bit)
3147	{
3148	Mailbox24 Mbx24;
3149
3150	GCMailbox = pBusLogic->GCPhysAddrMailboxOutgoingBase + (pBusLogic->uMailboxOutgoingPositionCurrent * sizeof(Mailbox24));
3151	PDMDevHlpPhysRead(pBusLogic->CTX_SUFF(pDevIns), GCMailbox, &Mbx24, sizeof(Mailbox24));
3152	pMbx->u32PhysAddrCCB = ADDR_TO_U32(Mbx24.aPhysAddrCCB);
3153	pMbx->u.out.uActionCode = Mbx24.uCmdState;
3154	}
3155	else
3156	{
3157	GCMailbox = pBusLogic->GCPhysAddrMailboxOutgoingBase + (pBusLogic->uMailboxOutgoingPositionCurrent * sizeof(Mailbox32));
3158	PDMDevHlpPhysRead(pBusLogic->CTX_SUFF(pDevIns), GCMailbox, pMbx, sizeof(Mailbox32));
3159	}
3160
3161	return GCMailbox;
3162	}
3163
3164	/**
3165	* Read mailbox from the guest and execute command.
3166	*
3167	* @returns VBox status code.
3168	* @param pBusLogic Pointer to the BusLogic instance data.
3169	*/
3170	static int buslogicR3ProcessMailboxNext(PBUSLOGIC pBusLogic)
3171	{
3172	RTGCPHYS GCPhysAddrMailboxCurrent;
3173	Mailbox32 MailboxGuest;
3174	int rc = VINF_SUCCESS;
3175
3176	if (!pBusLogic->fStrictRoundRobinMode)
3177	{
3178	/* Search for a filled mailbox - stop if we have scanned all mailboxes. */
3179	uint8_t uMailboxPosCur = pBusLogic->uMailboxOutgoingPositionCurrent;
3180
3181	do
3182	{
3183	/* Fetch mailbox from guest memory. */
3184	GCPhysAddrMailboxCurrent = buslogicR3ReadOutgoingMailbox(pBusLogic, &MailboxGuest);
3185
3186	/* Check the next mailbox. */
3187	buslogicR3OutgoingMailboxAdvance(pBusLogic);
3188	} while ( MailboxGuest.u.out.uActionCode == BUSLOGIC_MAILBOX_OUTGOING_ACTION_FREE
3189	&& uMailboxPosCur != pBusLogic->uMailboxOutgoingPositionCurrent);
3190	}
3191	else
3192	{
3193	/* Fetch mailbox from guest memory. */
3194	GCPhysAddrMailboxCurrent = buslogicR3ReadOutgoingMailbox(pBusLogic, &MailboxGuest);
3195	}
3196
3197	/*
3198	* Check if the mailbox is actually loaded.
3199	* It might be possible that the guest notified us without
3200	* a loaded mailbox. Do nothing in that case but leave a
3201	* log entry.
3202	*/
3203	if (MailboxGuest.u.out.uActionCode == BUSLOGIC_MAILBOX_OUTGOING_ACTION_FREE)
3204	{
3205	Log(("No loaded mailbox left\n"));
3206	return VERR_NO_DATA;
3207	}
3208
3209	LogFlow(("Got loaded mailbox at slot %u, CCB phys %RGp\n", pBusLogic->uMailboxOutgoingPositionCurrent, (RTGCPHYS)MailboxGuest.u32PhysAddrCCB));
3210	#ifdef LOG_ENABLED
3211	buslogicR3DumpMailboxInfo(&MailboxGuest, true);
3212	#endif
3213
3214	/* We got the mailbox, mark it as free in the guest. */
3215	uint8_t uActionCode = BUSLOGIC_MAILBOX_OUTGOING_ACTION_FREE;
3216	unsigned uCodeOffs = pBusLogic->fMbxIs24Bit ? RT_OFFSETOF(Mailbox24, uCmdState) : RT_OFFSETOF(Mailbox32, u.out.uActionCode);
3217	PDMDevHlpPCIPhysWrite(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrMailboxCurrent + uCodeOffs, &uActionCode, sizeof(uActionCode));
3218
3219	if (MailboxGuest.u.out.uActionCode == BUSLOGIC_MAILBOX_OUTGOING_ACTION_START_COMMAND)
3220	rc = buslogicR3DeviceSCSIRequestSetup(pBusLogic, (RTGCPHYS)MailboxGuest.u32PhysAddrCCB);
3221	else if (MailboxGuest.u.out.uActionCode == BUSLOGIC_MAILBOX_OUTGOING_ACTION_ABORT_COMMAND)
3222	{
3223	LogFlow(("Aborting mailbox\n"));
3224	rc = buslogicR3DeviceSCSIRequestAbort(pBusLogic, (RTGCPHYS)MailboxGuest.u32PhysAddrCCB);
3225	}
3226	else
3227	AssertMsgFailed(("Invalid outgoing mailbox action code %u\n", MailboxGuest.u.out.uActionCode));
3228
3229	AssertRC(rc);
3230
3231	/* Advance to the next mailbox. */
3232	if (pBusLogic->fStrictRoundRobinMode)
3233	buslogicR3OutgoingMailboxAdvance(pBusLogic);
3234
3235	return rc;
3236	}
3237
3238	/**
3239	* Transmit queue consumer
3240	* Queue a new async task.
3241	*
3242	* @returns Success indicator.
3243	* If false the item will not be removed and the flushing will stop.
3244	* @param pDevIns The device instance.
3245	* @param pItem The item to consume. Upon return this item will be freed.
3246	*/
3247	static DECLCALLBACK(bool) buslogicR3NotifyQueueConsumer(PPDMDEVINS pDevIns, PPDMQUEUEITEMCORE pItem)
3248	{
3249	RT_NOREF(pItem);
3250	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3251
3252	int rc = SUPSemEventSignal(pThis->pSupDrvSession, pThis->hEvtProcess);
3253	AssertRC(rc);
3254
3255	return true;
3256	}
3257
3258	/** @callback_method_impl{FNSSMDEVLIVEEXEC} */
3259	static DECLCALLBACK(int) buslogicR3LiveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uPass)
3260	{
3261	RT_NOREF(uPass);
3262	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3263
3264	/* Save the device config. */
3265	for (unsigned i = 0; i < RT_ELEMENTS(pThis->aDeviceStates); i++)
3266	SSMR3PutBool(pSSM, pThis->aDeviceStates[i].fPresent);
3267
3268	return VINF_SSM_DONT_CALL_AGAIN;
3269	}
3270
3271	/** @callback_method_impl{FNSSMDEVSAVEEXEC} */
3272	static DECLCALLBACK(int) buslogicR3SaveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
3273	{
3274	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3275	uint32_t cReqsSuspended = 0;
3276
3277	/* Every device first. */
3278	for (unsigned i = 0; i < RT_ELEMENTS(pBusLogic->aDeviceStates); i++)
3279	{
3280	PBUSLOGICDEVICE pDevice = &pBusLogic->aDeviceStates[i];
3281
3282	AssertMsg(!pDevice->cOutstandingRequests,
3283	("There are still outstanding requests on this device\n"));
3284	SSMR3PutBool(pSSM, pDevice->fPresent);
3285	SSMR3PutU32(pSSM, pDevice->cOutstandingRequests);
3286
3287	if (pDevice->fPresent)
3288	cReqsSuspended += pDevice->pDrvMediaEx->pfnIoReqGetSuspendedCount(pDevice->pDrvMediaEx);
3289	}
3290	/* Now the main device state. */
3291	SSMR3PutU8 (pSSM, pBusLogic->regStatus);
3292	SSMR3PutU8 (pSSM, pBusLogic->regInterrupt);
3293	SSMR3PutU8 (pSSM, pBusLogic->regGeometry);
3294	SSMR3PutMem (pSSM, &pBusLogic->LocalRam, sizeof(pBusLogic->LocalRam));
3295	SSMR3PutU8 (pSSM, pBusLogic->uOperationCode);
3296	SSMR3PutMem (pSSM, &pBusLogic->aCommandBuffer, sizeof(pBusLogic->aCommandBuffer));
3297	SSMR3PutU8 (pSSM, pBusLogic->iParameter);
3298	SSMR3PutU8 (pSSM, pBusLogic->cbCommandParametersLeft);
3299	SSMR3PutBool (pSSM, pBusLogic->fUseLocalRam);
3300	SSMR3PutMem (pSSM, pBusLogic->aReplyBuffer, sizeof(pBusLogic->aReplyBuffer));
3301	SSMR3PutU8 (pSSM, pBusLogic->iReply);
3302	SSMR3PutU8 (pSSM, pBusLogic->cbReplyParametersLeft);
3303	SSMR3PutBool (pSSM, pBusLogic->fIRQEnabled);
3304	SSMR3PutU8 (pSSM, pBusLogic->uISABaseCode);
3305	SSMR3PutU32 (pSSM, pBusLogic->cMailbox);
3306	SSMR3PutBool (pSSM, pBusLogic->fMbxIs24Bit);
3307	SSMR3PutGCPhys(pSSM, pBusLogic->GCPhysAddrMailboxOutgoingBase);
3308	SSMR3PutU32 (pSSM, pBusLogic->uMailboxOutgoingPositionCurrent);
3309	SSMR3PutU32 (pSSM, pBusLogic->cMailboxesReady);
3310	SSMR3PutBool (pSSM, pBusLogic->fNotificationSent);
3311	SSMR3PutGCPhys(pSSM, pBusLogic->GCPhysAddrMailboxIncomingBase);
3312	SSMR3PutU32 (pSSM, pBusLogic->uMailboxIncomingPositionCurrent);
3313	SSMR3PutBool (pSSM, pBusLogic->fStrictRoundRobinMode);
3314	SSMR3PutBool (pSSM, pBusLogic->fExtendedLunCCBFormat);
3315
3316	vboxscsiR3SaveExec(&pBusLogic->VBoxSCSI, pSSM);
3317
3318	SSMR3PutU32(pSSM, cReqsSuspended);
3319
3320	/* Save the physical CCB address of all suspended requests. */
3321	for (unsigned i = 0; i < RT_ELEMENTS(pBusLogic->aDeviceStates) && cReqsSuspended; i++)
3322	{
3323	PBUSLOGICDEVICE pDevice = &pBusLogic->aDeviceStates[i];
3324	if (pDevice->fPresent)
3325	{
3326	uint32_t cThisReqsSuspended = pDevice->pDrvMediaEx->pfnIoReqGetSuspendedCount(pDevice->pDrvMediaEx);
3327
3328	cReqsSuspended -= cThisReqsSuspended;
3329	if (cThisReqsSuspended)
3330	{
3331	PDMMEDIAEXIOREQ hIoReq;
3332	PBUSLOGICREQ pReq;
3333	int rc = pDevice->pDrvMediaEx->pfnIoReqQuerySuspendedStart(pDevice->pDrvMediaEx, &hIoReq,
3334	(void **)&pReq);
3335	AssertRCBreak(rc);
3336
3337	for (;;)
3338	{
3339	SSMR3PutU32(pSSM, (uint32_t)pReq->GCPhysAddrCCB);
3340
3341	cThisReqsSuspended--;
3342	if (!cThisReqsSuspended)
3343	break;
3344
3345	rc = pDevice->pDrvMediaEx->pfnIoReqQuerySuspendedNext(pDevice->pDrvMediaEx, hIoReq,
3346	&hIoReq, (void **)&pReq);
3347	AssertRCBreak(rc);
3348	}
3349	}
3350	}
3351	}
3352
3353	return SSMR3PutU32(pSSM, UINT32_MAX);
3354	}
3355
3356	/** @callback_method_impl{FNSSMDEVLOADDONE} */
3357	static DECLCALLBACK(int) buslogicR3LoadDone(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
3358	{
3359	RT_NOREF(pSSM);
3360	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3361
3362	buslogicR3RegisterISARange(pThis, pThis->uISABaseCode);
3363
3364	/* Kick of any requests we might need to redo. */
3365	if (pThis->VBoxSCSI.fBusy)
3366	{
3367
3368	/* The BIOS had a request active when we got suspended. Resume it. */
3369	int rc = buslogicR3PrepareBIOSSCSIRequest(pThis);
3370	AssertRC(rc);
3371	}
3372	else if (pThis->cReqsRedo)
3373	{
3374	for (unsigned i = 0; i < pThis->cReqsRedo; i++)
3375	{
3376	int rc = buslogicR3DeviceSCSIRequestSetup(pThis, pThis->paGCPhysAddrCCBRedo[i]);
3377	AssertRC(rc);
3378	}
3379
3380	RTMemFree(pThis->paGCPhysAddrCCBRedo);
3381	pThis->paGCPhysAddrCCBRedo = NULL;
3382	pThis->cReqsRedo = 0;
3383	}
3384
3385	return VINF_SUCCESS;
3386	}
3387
3388	/** @callback_method_impl{FNSSMDEVLOADEXEC} */
3389	static DECLCALLBACK(int) buslogicR3LoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
3390	{
3391	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3392	int rc = VINF_SUCCESS;
3393
3394	/* We support saved states only from this and older versions. */
3395	if (uVersion > BUSLOGIC_SAVED_STATE_MINOR_VERSION)
3396	return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
3397
3398	/* Every device first. */
3399	for (unsigned i = 0; i < RT_ELEMENTS(pBusLogic->aDeviceStates); i++)
3400	{
3401	PBUSLOGICDEVICE pDevice = &pBusLogic->aDeviceStates[i];
3402
3403	AssertMsg(!pDevice->cOutstandingRequests,
3404	("There are still outstanding requests on this device\n"));
3405	bool fPresent;
3406	rc = SSMR3GetBool(pSSM, &fPresent);
3407	AssertRCReturn(rc, rc);
3408	if (pDevice->fPresent != fPresent)
3409	return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("Target %u config mismatch: config=%RTbool state=%RTbool"), i, pDevice->fPresent, fPresent);
3410
3411	if (uPass == SSM_PASS_FINAL)
3412	SSMR3GetU32(pSSM, (uint32_t *)&pDevice->cOutstandingRequests);
3413	}
3414
3415	if (uPass != SSM_PASS_FINAL)
3416	return VINF_SUCCESS;
3417
3418	/* Now the main device state. */
3419	SSMR3GetU8 (pSSM, (uint8_t *)&pBusLogic->regStatus);
3420	SSMR3GetU8 (pSSM, (uint8_t *)&pBusLogic->regInterrupt);
3421	SSMR3GetU8 (pSSM, (uint8_t *)&pBusLogic->regGeometry);
3422	SSMR3GetMem (pSSM, &pBusLogic->LocalRam, sizeof(pBusLogic->LocalRam));
3423	SSMR3GetU8 (pSSM, &pBusLogic->uOperationCode);
3424	if (uVersion > BUSLOGIC_SAVED_STATE_MINOR_PRE_CMDBUF_RESIZE)
3425	SSMR3GetMem (pSSM, &pBusLogic->aCommandBuffer, sizeof(pBusLogic->aCommandBuffer));
3426	else
3427	SSMR3GetMem (pSSM, &pBusLogic->aCommandBuffer, BUSLOGIC_COMMAND_SIZE_OLD);
3428	SSMR3GetU8 (pSSM, &pBusLogic->iParameter);
3429	SSMR3GetU8 (pSSM, &pBusLogic->cbCommandParametersLeft);
3430	SSMR3GetBool (pSSM, &pBusLogic->fUseLocalRam);
3431	SSMR3GetMem (pSSM, pBusLogic->aReplyBuffer, sizeof(pBusLogic->aReplyBuffer));
3432	SSMR3GetU8 (pSSM, &pBusLogic->iReply);
3433	SSMR3GetU8 (pSSM, &pBusLogic->cbReplyParametersLeft);
3434	SSMR3GetBool (pSSM, &pBusLogic->fIRQEnabled);
3435	SSMR3GetU8 (pSSM, &pBusLogic->uISABaseCode);
3436	SSMR3GetU32 (pSSM, &pBusLogic->cMailbox);
3437	if (uVersion > BUSLOGIC_SAVED_STATE_MINOR_PRE_24BIT_MBOX)
3438	SSMR3GetBool (pSSM, &pBusLogic->fMbxIs24Bit);
3439	SSMR3GetGCPhys(pSSM, &pBusLogic->GCPhysAddrMailboxOutgoingBase);
3440	SSMR3GetU32 (pSSM, &pBusLogic->uMailboxOutgoingPositionCurrent);
3441	SSMR3GetU32 (pSSM, (uint32_t *)&pBusLogic->cMailboxesReady);
3442	SSMR3GetBool (pSSM, (bool *)&pBusLogic->fNotificationSent);
3443	SSMR3GetGCPhys(pSSM, &pBusLogic->GCPhysAddrMailboxIncomingBase);
3444	SSMR3GetU32 (pSSM, &pBusLogic->uMailboxIncomingPositionCurrent);
3445	SSMR3GetBool (pSSM, &pBusLogic->fStrictRoundRobinMode);
3446	SSMR3GetBool (pSSM, &pBusLogic->fExtendedLunCCBFormat);
3447
3448	rc = vboxscsiR3LoadExec(&pBusLogic->VBoxSCSI, pSSM);
3449	if (RT_FAILURE(rc))
3450	{
3451	LogRel(("BusLogic: Failed to restore BIOS state: %Rrc.\n", rc));
3452	return PDMDEV_SET_ERROR(pDevIns, rc,
3453	N_("BusLogic: Failed to restore BIOS state\n"));
3454	}
3455
3456	if (uVersion > BUSLOGIC_SAVED_STATE_MINOR_PRE_ERROR_HANDLING)
3457	{
3458	/* Check if there are pending tasks saved. */
3459	uint32_t cTasks = 0;
3460
3461	SSMR3GetU32(pSSM, &cTasks);
3462
3463	if (cTasks)
3464	{
3465	pBusLogic->paGCPhysAddrCCBRedo = (PRTGCPHYS)RTMemAllocZ(cTasks * sizeof(RTGCPHYS));
3466	if (RT_LIKELY(pBusLogic->paGCPhysAddrCCBRedo))
3467	{
3468	pBusLogic->cReqsRedo = cTasks;
3469
3470	for (uint32_t i = 0; i < cTasks; i++)
3471	{
3472	uint32_t u32PhysAddrCCB;
3473
3474	rc = SSMR3GetU32(pSSM, &u32PhysAddrCCB);
3475	if (RT_FAILURE(rc))
3476	break;
3477
3478	pBusLogic->paGCPhysAddrCCBRedo[i] = u32PhysAddrCCB;
3479	}
3480	}
3481	else
3482	rc = VERR_NO_MEMORY;
3483	}
3484	}
3485
3486	if (RT_SUCCESS(rc))
3487	{
3488	uint32_t u32;
3489	rc = SSMR3GetU32(pSSM, &u32);
3490	if (RT_SUCCESS(rc))
3491	AssertMsgReturn(u32 == UINT32_MAX, ("%#x\n", u32), VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
3492	}
3493
3494	return rc;
3495	}
3496
3497	/**
3498	* Gets the pointer to the status LED of a device - called from the SCSI driver.
3499	*
3500	* @returns VBox status code.
3501	* @param pInterface Pointer to the interface structure containing the called function pointer.
3502	* @param iLUN The unit which status LED we desire. Always 0 here as the driver
3503	* doesn't know about other LUN's.
3504	* @param ppLed Where to store the LED pointer.
3505	*/
3506	static DECLCALLBACK(int) buslogicR3DeviceQueryStatusLed(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed)
3507	{
3508	PBUSLOGICDEVICE pDevice = RT_FROM_MEMBER(pInterface, BUSLOGICDEVICE, ILed);
3509	if (iLUN == 0)
3510	{
3511	*ppLed = &pDevice->Led;
3512	Assert((*ppLed)->u32Magic == PDMLED_MAGIC);
3513	return VINF_SUCCESS;
3514	}
3515	return VERR_PDM_LUN_NOT_FOUND;
3516	}
3517
3518	/**
3519	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
3520	*/
3521	static DECLCALLBACK(void ) buslogicR3DeviceQueryInterface(PPDMIBASE pInterface, const char pszIID)
3522	{
3523	PBUSLOGICDEVICE pDevice = RT_FROM_MEMBER(pInterface, BUSLOGICDEVICE, IBase);
3524	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDevice->IBase);
3525	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIAPORT, &pDevice->IMediaPort);
3526	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIAEXPORT, &pDevice->IMediaExPort);
3527	PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pDevice->ILed);
3528	return NULL;
3529	}
3530
3531	/**
3532	* Gets the pointer to the status LED of a unit.
3533	*
3534	* @returns VBox status code.
3535	* @param pInterface Pointer to the interface structure containing the called function pointer.
3536	* @param iLUN The unit which status LED we desire.
3537	* @param ppLed Where to store the LED pointer.
3538	*/
3539	static DECLCALLBACK(int) buslogicR3StatusQueryStatusLed(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed)
3540	{
3541	PBUSLOGIC pBusLogic = RT_FROM_MEMBER(pInterface, BUSLOGIC, ILeds);
3542	if (iLUN < BUSLOGIC_MAX_DEVICES)
3543	{
3544	*ppLed = &pBusLogic->aDeviceStates[iLUN].Led;
3545	Assert((*ppLed)->u32Magic == PDMLED_MAGIC);
3546	return VINF_SUCCESS;
3547	}
3548	return VERR_PDM_LUN_NOT_FOUND;
3549	}
3550
3551	/**
3552	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
3553	*/
3554	static DECLCALLBACK(void ) buslogicR3StatusQueryInterface(PPDMIBASE pInterface, const char pszIID)
3555	{
3556	PBUSLOGIC pThis = RT_FROM_MEMBER(pInterface, BUSLOGIC, IBase);
3557	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pThis->IBase);
3558	PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pThis->ILeds);
3559	return NULL;
3560	}
3561
3562	/**
3563	* The worker thread processing requests from the guest.
3564	*
3565	* @returns VBox status code.
3566	* @param pDevIns The device instance.
3567	* @param pThread The thread structure.
3568	*/
3569	static DECLCALLBACK(int) buslogicR3Worker(PPDMDEVINS pDevIns, PPDMTHREAD pThread)
3570	{
3571	RT_NOREF(pDevIns);
3572	PBUSLOGIC pThis = (PBUSLOGIC)pThread->pvUser;
3573	int rc = VINF_SUCCESS;
3574
3575	if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
3576	return VINF_SUCCESS;
3577
3578	while (pThread->enmState == PDMTHREADSTATE_RUNNING)
3579	{
3580	ASMAtomicWriteBool(&pThis->fWrkThreadSleeping, true);
3581	bool fNotificationSent = ASMAtomicXchgBool(&pThis->fNotificationSent, false);
3582	if (!fNotificationSent)
3583	{
3584	Assert(ASMAtomicReadBool(&pThis->fWrkThreadSleeping));
3585	rc = SUPSemEventWaitNoResume(pThis->pSupDrvSession, pThis->hEvtProcess, RT_INDEFINITE_WAIT);
3586	AssertLogRelMsgReturn(RT_SUCCESS(rc) \|\| rc == VERR_INTERRUPTED, ("%Rrc\n", rc), rc);
3587	if (RT_UNLIKELY(pThread->enmState != PDMTHREADSTATE_RUNNING))
3588	break;
3589	LogFlowFunc(("Woken up with rc=%Rrc\n", rc));
3590	ASMAtomicWriteBool(&pThis->fNotificationSent, false);
3591	}
3592
3593	ASMAtomicWriteBool(&pThis->fWrkThreadSleeping, false);
3594
3595	/* Check whether there is a BIOS request pending and process it first. */
3596	if (ASMAtomicReadBool(&pThis->fBiosReqPending))
3597	{
3598	rc = buslogicR3PrepareBIOSSCSIRequest(pThis);
3599	AssertRC(rc);
3600	ASMAtomicXchgBool(&pThis->fBiosReqPending, false);
3601	}
3602	else
3603	{
3604	ASMAtomicXchgU32(&pThis->cMailboxesReady, 0); /** @todo Actually not required anymore but to stay compatible with older saved states. */
3605
3606	/* Process mailboxes. */
3607	do
3608	{
3609	rc = buslogicR3ProcessMailboxNext(pThis);
3610	AssertMsg(RT_SUCCESS(rc) \|\| rc == VERR_NO_DATA, ("Processing mailbox failed rc=%Rrc\n", rc));
3611	} while (RT_SUCCESS(rc));
3612	}
3613	} /* While running */
3614
3615	return VINF_SUCCESS;
3616	}
3617
3618
3619	/**
3620	* Unblock the worker thread so it can respond to a state change.
3621	*
3622	* @returns VBox status code.
3623	* @param pDevIns The device instance.
3624	* @param pThread The send thread.
3625	*/
3626	static DECLCALLBACK(int) buslogicR3WorkerWakeUp(PPDMDEVINS pDevIns, PPDMTHREAD pThread)
3627	{
3628	RT_NOREF(pThread);
3629	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3630	return SUPSemEventSignal(pThis->pSupDrvSession, pThis->hEvtProcess);
3631	}
3632
3633	/**
3634	* BusLogic debugger info callback.
3635	*
3636	* @param pDevIns The device instance.
3637	* @param pHlp The output helpers.
3638	* @param pszArgs The arguments.
3639	*/
3640	static DECLCALLBACK(void) buslogicR3Info(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs)
3641	{
3642	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3643	unsigned i;
3644	bool fVerbose = false;
3645
3646	/* Parse arguments. */
3647	if (pszArgs)
3648	fVerbose = strstr(pszArgs, "verbose") != NULL;
3649
3650	/* Show basic information. */
3651	pHlp->pfnPrintf(pHlp,
3652	"%s#%d: PCI I/O=%RTiop ISA I/O=%RTiop MMIO=%RGp IRQ=%u GC=%RTbool R0=%RTbool\n",
3653	pDevIns->pReg->szName,
3654	pDevIns->iInstance,
3655	pThis->IOPortBase, pThis->IOISABase, pThis->MMIOBase,
3656	PCIDevGetInterruptLine(&pThis->dev),
3657	!!pThis->fGCEnabled, !!pThis->fR0Enabled);
3658
3659	/* Print mailbox state. */
3660	if (pThis->regStatus & BL_STAT_INREQ)
3661	pHlp->pfnPrintf(pHlp, "Mailbox not initialized\n");
3662	else
3663	pHlp->pfnPrintf(pHlp, "%u-bit mailbox with %u entries at %RGp (%d LUN CCBs)\n",
3664	pThis->fMbxIs24Bit ? 24 : 32, pThis->cMailbox,
3665	pThis->GCPhysAddrMailboxOutgoingBase,
3666	pThis->fMbxIs24Bit ? 8 : pThis->fExtendedLunCCBFormat ? 64 : 8);
3667
3668	/* Print register contents. */
3669	pHlp->pfnPrintf(pHlp, "Registers: STAT=%02x INTR=%02x GEOM=%02x\n",
3670	pThis->regStatus, pThis->regInterrupt, pThis->regGeometry);
3671
3672	/* Print miscellaneous state. */
3673	pHlp->pfnPrintf(pHlp, "HAC interrupts: %s\n",
3674	pThis->fIRQEnabled ? "on" : "off");
3675
3676	/* Print the current command, if any. */
3677	if (pThis->uOperationCode != 0xff )
3678	pHlp->pfnPrintf(pHlp, "Current command: %02X\n", pThis->uOperationCode);
3679
3680	if (fVerbose && (pThis->regStatus & BL_STAT_INREQ) == 0)
3681	{
3682	RTGCPHYS GCMailbox;
3683
3684	/* Dump the mailbox contents. */
3685	if (pThis->fMbxIs24Bit)
3686	{
3687	Mailbox24 Mbx24;
3688
3689	/* Outgoing mailbox, 24-bit format. */
3690	GCMailbox = pThis->GCPhysAddrMailboxOutgoingBase;
3691	pHlp->pfnPrintf(pHlp, " Outgoing mailbox entries (24-bit) at %06X:\n", GCMailbox);
3692	for (i = 0; i < pThis->cMailbox; ++i)
3693	{
3694	PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns), GCMailbox, &Mbx24, sizeof(Mailbox24));
3695	pHlp->pfnPrintf(pHlp, " slot %03d: CCB at %06X action code %02X", i, ADDR_TO_U32(Mbx24.aPhysAddrCCB), Mbx24.uCmdState);
3696	pHlp->pfnPrintf(pHlp, "%s\n", pThis->uMailboxOutgoingPositionCurrent == i ? " *" : "");
3697	GCMailbox += sizeof(Mailbox24);
3698	}
3699
3700	/* Incoming mailbox, 24-bit format. */
3701	GCMailbox = pThis->GCPhysAddrMailboxOutgoingBase + (pThis->cMailbox * sizeof(Mailbox24));
3702	pHlp->pfnPrintf(pHlp, " Incoming mailbox entries (24-bit) at %06X:\n", GCMailbox);
3703	for (i = 0; i < pThis->cMailbox; ++i)
3704	{
3705	PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns), GCMailbox, &Mbx24, sizeof(Mailbox24));
3706	pHlp->pfnPrintf(pHlp, " slot %03d: CCB at %06X completion code %02X", i, ADDR_TO_U32(Mbx24.aPhysAddrCCB), Mbx24.uCmdState);
3707	pHlp->pfnPrintf(pHlp, "%s\n", pThis->uMailboxIncomingPositionCurrent == i ? " *" : "");
3708	GCMailbox += sizeof(Mailbox24);
3709	}
3710
3711	}
3712	else
3713	{
3714	Mailbox32 Mbx32;
3715
3716	/* Outgoing mailbox, 32-bit format. */
3717	GCMailbox = pThis->GCPhysAddrMailboxOutgoingBase;
3718	pHlp->pfnPrintf(pHlp, " Outgoing mailbox entries (32-bit) at %08X:\n", (uint32_t)GCMailbox);
3719	for (i = 0; i < pThis->cMailbox; ++i)
3720	{
3721	PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns), GCMailbox, &Mbx32, sizeof(Mailbox32));
3722	pHlp->pfnPrintf(pHlp, " slot %03d: CCB at %08X action code %02X", i, Mbx32.u32PhysAddrCCB, Mbx32.u.out.uActionCode);
3723	pHlp->pfnPrintf(pHlp, "%s\n", pThis->uMailboxOutgoingPositionCurrent == i ? " *" : "");
3724	GCMailbox += sizeof(Mailbox32);
3725	}
3726
3727	/* Incoming mailbox, 32-bit format. */
3728	GCMailbox = pThis->GCPhysAddrMailboxOutgoingBase + (pThis->cMailbox * sizeof(Mailbox32));
3729	pHlp->pfnPrintf(pHlp, " Outgoing mailbox entries (32-bit) at %08X:\n", (uint32_t)GCMailbox);
3730	for (i = 0; i < pThis->cMailbox; ++i)
3731	{
3732	PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns), GCMailbox, &Mbx32, sizeof(Mailbox32));
3733	pHlp->pfnPrintf(pHlp, " slot %03d: CCB at %08X completion code %02X BTSTAT %02X SDSTAT %02X", i,
3734	Mbx32.u32PhysAddrCCB, Mbx32.u.in.uCompletionCode, Mbx32.u.in.uHostAdapterStatus, Mbx32.u.in.uTargetDeviceStatus);
3735	pHlp->pfnPrintf(pHlp, "%s\n", pThis->uMailboxOutgoingPositionCurrent == i ? " *" : "");
3736	GCMailbox += sizeof(Mailbox32);
3737	}
3738
3739	}
3740	}
3741	}
3742
3743	/* -=-=-=-=- Helper -=-=-=-=- */
3744
3745	/**
3746	* Checks if all asynchronous I/O is finished.
3747	*
3748	* Used by buslogicR3Reset, buslogicR3Suspend and buslogicR3PowerOff.
3749	*
3750	* @returns true if quiesced, false if busy.
3751	* @param pDevIns The device instance.
3752	*/
3753	static bool buslogicR3AllAsyncIOIsFinished(PPDMDEVINS pDevIns)
3754	{
3755	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3756
3757	for (uint32_t i = 0; i < RT_ELEMENTS(pThis->aDeviceStates); i++)
3758	{
3759	PBUSLOGICDEVICE pThisDevice = &pThis->aDeviceStates[i];
3760	if (pThisDevice->pDrvBase)
3761	{
3762	if (pThisDevice->cOutstandingRequests != 0)
3763	return false;
3764	}
3765	}
3766
3767	return true;
3768	}
3769
3770	/**
3771	* Callback employed by buslogicR3Suspend and buslogicR3PowerOff.
3772	*
3773	* @returns true if we've quiesced, false if we're still working.
3774	* @param pDevIns The device instance.
3775	*/
3776	static DECLCALLBACK(bool) buslogicR3IsAsyncSuspendOrPowerOffDone(PPDMDEVINS pDevIns)
3777	{
3778	if (!buslogicR3AllAsyncIOIsFinished(pDevIns))
3779	return false;
3780
3781	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3782	ASMAtomicWriteBool(&pThis->fSignalIdle, false);
3783	return true;
3784	}
3785
3786	/**
3787	* Common worker for buslogicR3Suspend and buslogicR3PowerOff.
3788	*/
3789	static void buslogicR3SuspendOrPowerOff(PPDMDEVINS pDevIns)
3790	{
3791	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3792
3793	ASMAtomicWriteBool(&pThis->fSignalIdle, true);
3794	if (!buslogicR3AllAsyncIOIsFinished(pDevIns))
3795	PDMDevHlpSetAsyncNotification(pDevIns, buslogicR3IsAsyncSuspendOrPowerOffDone);
3796	else
3797	{
3798	ASMAtomicWriteBool(&pThis->fSignalIdle, false);
3799	AssertMsg(!pThis->fNotificationSent, ("The PDM Queue should be empty at this point\n"));
3800	}
3801	}
3802
3803	/**
3804	* Suspend notification.
3805	*
3806	* @param pDevIns The device instance data.
3807	*/
3808	static DECLCALLBACK(void) buslogicR3Suspend(PPDMDEVINS pDevIns)
3809	{
3810	Log(("buslogicR3Suspend\n"));
3811	buslogicR3SuspendOrPowerOff(pDevIns);
3812	}
3813
3814	/**
3815	* Detach notification.
3816	*
3817	* One harddisk at one port has been unplugged.
3818	* The VM is suspended at this point.
3819	*
3820	* @param pDevIns The device instance.
3821	* @param iLUN The logical unit which is being detached.
3822	* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
3823	*/
3824	static DECLCALLBACK(void) buslogicR3Detach(PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags)
3825	{
3826	RT_NOREF(fFlags);
3827	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3828	PBUSLOGICDEVICE pDevice = &pThis->aDeviceStates[iLUN];
3829
3830	Log(("%s:\n", __FUNCTION__));
3831
3832	AssertMsg(fFlags & PDM_TACH_FLAGS_NOT_HOT_PLUG,
3833	("BusLogic: Device does not support hotplugging\n"));
3834
3835	/*
3836	* Zero some important members.
3837	*/
3838	pDevice->fPresent = false;
3839	pDevice->pDrvBase = NULL;
3840	pDevice->pDrvMedia = NULL;
3841	pDevice->pDrvMediaEx = NULL;
3842	}
3843
3844	/**
3845	* Attach command.
3846	*
3847	* This is called when we change block driver.
3848	*
3849	* @returns VBox status code.
3850	* @param pDevIns The device instance.
3851	* @param iLUN The logical unit which is being detached.
3852	* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
3853	*/
3854	static DECLCALLBACK(int) buslogicR3Attach(PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags)
3855	{
3856	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3857	PBUSLOGICDEVICE pDevice = &pThis->aDeviceStates[iLUN];
3858	int rc;
3859
3860	AssertMsgReturn(fFlags & PDM_TACH_FLAGS_NOT_HOT_PLUG,
3861	("BusLogic: Device does not support hotplugging\n"),
3862	VERR_INVALID_PARAMETER);
3863
3864	/* the usual paranoia */
3865	AssertRelease(!pDevice->pDrvBase);
3866	AssertRelease(!pDevice->pDrvMedia);
3867	AssertRelease(!pDevice->pDrvMediaEx);
3868	Assert(pDevice->iLUN == iLUN);
3869
3870	/*
3871	* Try attach the SCSI driver and get the interfaces,
3872	* required as well as optional.
3873	*/
3874	rc = PDMDevHlpDriverAttach(pDevIns, pDevice->iLUN, &pDevice->IBase, &pDevice->pDrvBase, NULL);
3875	if (RT_SUCCESS(rc))
3876	{
3877	/* Query the media interface. */
3878	pDevice->pDrvMedia = PDMIBASE_QUERY_INTERFACE(pDevice->pDrvBase, PDMIMEDIA);
3879	AssertMsgReturn(VALID_PTR(pDevice->pDrvMedia),
3880	("BusLogic configuration error: LUN#%d misses the basic media interface!\n", pDevice->iLUN),
3881	VERR_PDM_MISSING_INTERFACE);
3882
3883	/* Get the extended media interface. */
3884	pDevice->pDrvMediaEx = PDMIBASE_QUERY_INTERFACE(pDevice->pDrvBase, PDMIMEDIAEX);
3885	AssertMsgReturn(VALID_PTR(pDevice->pDrvMediaEx),
3886	("BusLogic configuration error: LUN#%d misses the extended media interface!\n", pDevice->iLUN),
3887	VERR_PDM_MISSING_INTERFACE);
3888
3889	rc = pDevice->pDrvMediaEx->pfnIoReqAllocSizeSet(pDevice->pDrvMediaEx, sizeof(BUSLOGICREQ));
3890	AssertMsgRCReturn(rc, ("BusLogic configuration error: LUN#%u: Failed to set I/O request size!", pDevice->iLUN),
3891	rc);
3892
3893	pDevice->fPresent = true;
3894	}
3895	else
3896	AssertMsgFailed(("Failed to attach LUN#%d. rc=%Rrc\n", pDevice->iLUN, rc));
3897
3898	if (RT_FAILURE(rc))
3899	{
3900	pDevice->fPresent = false;
3901	pDevice->pDrvBase = NULL;
3902	pDevice->pDrvMedia = NULL;
3903	pDevice->pDrvMediaEx = NULL;
3904	}
3905	return rc;
3906	}
3907
3908	/**
3909	* Callback employed by buslogicR3Reset.
3910	*
3911	* @returns true if we've quiesced, false if we're still working.
3912	* @param pDevIns The device instance.
3913	*/
3914	static DECLCALLBACK(bool) buslogicR3IsAsyncResetDone(PPDMDEVINS pDevIns)
3915	{
3916	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3917
3918	if (!buslogicR3AllAsyncIOIsFinished(pDevIns))
3919	return false;
3920	ASMAtomicWriteBool(&pThis->fSignalIdle, false);
3921
3922	buslogicR3HwReset(pThis, true);
3923	return true;
3924	}
3925
3926	/**
3927	* @copydoc FNPDMDEVRESET
3928	*/
3929	static DECLCALLBACK(void) buslogicR3Reset(PPDMDEVINS pDevIns)
3930	{
3931	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3932
3933	ASMAtomicWriteBool(&pThis->fSignalIdle, true);
3934	if (!buslogicR3AllAsyncIOIsFinished(pDevIns))
3935	PDMDevHlpSetAsyncNotification(pDevIns, buslogicR3IsAsyncResetDone);
3936	else
3937	{
3938	ASMAtomicWriteBool(&pThis->fSignalIdle, false);
3939	buslogicR3HwReset(pThis, true);
3940	}
3941	}
3942
3943	static DECLCALLBACK(void) buslogicR3Relocate(PPDMDEVINS pDevIns, RTGCINTPTR offDelta)
3944	{
3945	RT_NOREF(offDelta);
3946	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3947
3948	pThis->pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns);
3949	pThis->pNotifierQueueRC = PDMQueueRCPtr(pThis->pNotifierQueueR3);
3950
3951	for (uint32_t i = 0; i < BUSLOGIC_MAX_DEVICES; i++)
3952	{
3953	PBUSLOGICDEVICE pDevice = &pThis->aDeviceStates[i];
3954
3955	pDevice->pBusLogicRC = PDMINS_2_DATA_RCPTR(pDevIns);
3956	}
3957
3958	}
3959
3960	/**
3961	* Poweroff notification.
3962	*
3963	* @param pDevIns Pointer to the device instance
3964	*/
3965	static DECLCALLBACK(void) buslogicR3PowerOff(PPDMDEVINS pDevIns)
3966	{
3967	Log(("buslogicR3PowerOff\n"));
3968	buslogicR3SuspendOrPowerOff(pDevIns);
3969	}
3970
3971	/**
3972	* Destroy a driver instance.
3973	*
3974	* Most VM resources are freed by the VM. This callback is provided so that any non-VM
3975	* resources can be freed correctly.
3976	*
3977	* @param pDevIns The device instance data.
3978	*/
3979	static DECLCALLBACK(int) buslogicR3Destruct(PPDMDEVINS pDevIns)
3980	{
3981	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3982	PDMDEV_CHECK_VERSIONS_RETURN_QUIET(pDevIns);
3983
3984	PDMR3CritSectDelete(&pThis->CritSectIntr);
3985
3986	if (pThis->hEvtProcess != NIL_SUPSEMEVENT)
3987	{
3988	SUPSemEventClose(pThis->pSupDrvSession, pThis->hEvtProcess);
3989	pThis->hEvtProcess = NIL_SUPSEMEVENT;
3990	}
3991
3992	return VINF_SUCCESS;
3993	}
3994
3995	/**
3996	* @interface_method_impl{PDMDEVREG,pfnConstruct}
3997	*/
3998	static DECLCALLBACK(int) buslogicR3Construct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
3999	{
4000	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
4001	int rc = VINF_SUCCESS;
4002	bool fBootable = true;
4003	char achISACompat[16];
4004	PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
4005
4006	/*
4007	* Init instance data (do early because of constructor).
4008	*/
4009	pThis->pDevInsR3 = pDevIns;
4010	pThis->pDevInsR0 = PDMDEVINS_2_R0PTR(pDevIns);
4011	pThis->pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns);
4012	pThis->IBase.pfnQueryInterface = buslogicR3StatusQueryInterface;
4013	pThis->ILeds.pfnQueryStatusLed = buslogicR3StatusQueryStatusLed;
4014
4015	PCIDevSetVendorId (&pThis->dev, 0x104b); /* BusLogic */
4016	PCIDevSetDeviceId (&pThis->dev, 0x1040); /* BT-958 */
4017	PCIDevSetCommand (&pThis->dev, 0x0003);
4018	PCIDevSetRevisionId (&pThis->dev, 0x01);
4019	PCIDevSetClassProg (&pThis->dev, 0x00); /* SCSI */
4020	PCIDevSetClassSub (&pThis->dev, 0x00); /* SCSI */
4021	PCIDevSetClassBase (&pThis->dev, 0x01); /* Mass storage */
4022	PCIDevSetBaseAddress (&pThis->dev, 0, true /IO/, false /Pref/, false /64-bit/, 0x00000000);
4023	PCIDevSetBaseAddress (&pThis->dev, 1, false /IO/, false /Pref/, false /64-bit/, 0x00000000);
4024	PCIDevSetSubSystemVendorId(&pThis->dev, 0x104b);
4025	PCIDevSetSubSystemId (&pThis->dev, 0x1040);
4026	PCIDevSetInterruptLine (&pThis->dev, 0x00);
4027	PCIDevSetInterruptPin (&pThis->dev, 0x01);
4028
4029	/*
4030	* Validate and read configuration.
4031	*/
4032	if (!CFGMR3AreValuesValid(pCfg,
4033	"GCEnabled\0"
4034	"R0Enabled\0"
4035	"Bootable\0"
4036	"ISACompat\0"))
4037	return PDMDEV_SET_ERROR(pDevIns, VERR_PDM_DEVINS_UNKNOWN_CFG_VALUES,
4038	N_("BusLogic configuration error: unknown option specified"));
4039
4040	rc = CFGMR3QueryBoolDef(pCfg, "GCEnabled", &pThis->fGCEnabled, true);
4041	if (RT_FAILURE(rc))
4042	return PDMDEV_SET_ERROR(pDevIns, rc,
4043	N_("BusLogic configuration error: failed to read GCEnabled as boolean"));
4044	Log(("%s: fGCEnabled=%d\n", __FUNCTION__, pThis->fGCEnabled));
4045
4046	rc = CFGMR3QueryBoolDef(pCfg, "R0Enabled", &pThis->fR0Enabled, true);
4047	if (RT_FAILURE(rc))
4048	return PDMDEV_SET_ERROR(pDevIns, rc,
4049	N_("BusLogic configuration error: failed to read R0Enabled as boolean"));
4050	Log(("%s: fR0Enabled=%d\n", __FUNCTION__, pThis->fR0Enabled));
4051	rc = CFGMR3QueryBoolDef(pCfg, "Bootable", &fBootable, true);
4052	if (RT_FAILURE(rc))
4053	return PDMDEV_SET_ERROR(pDevIns, rc,
4054	N_("BusLogic configuration error: failed to read Bootable as boolean"));
4055	Log(("%s: fBootable=%RTbool\n", __FUNCTION__, fBootable));
4056
4057	/* Only the first instance defaults to having the ISA compatibility ports enabled. */
4058	if (iInstance == 0)
4059	rc = CFGMR3QueryStringDef(pCfg, "ISACompat", achISACompat, sizeof(achISACompat), "Alternate");
4060	else
4061	rc = CFGMR3QueryStringDef(pCfg, "ISACompat", achISACompat, sizeof(achISACompat), "Disabled");
4062	if (RT_FAILURE(rc))
4063	return PDMDEV_SET_ERROR(pDevIns, rc,
4064	N_("BusLogic configuration error: failed to read ISACompat as string"));
4065	Log(("%s: ISACompat=%s\n", __FUNCTION__, achISACompat));
4066
4067	/* Grok the ISACompat setting. */
4068	if (!strcmp(achISACompat, "Disabled"))
4069	pThis->uDefaultISABaseCode = ISA_BASE_DISABLED;
4070	else if (!strcmp(achISACompat, "Primary"))
4071	pThis->uDefaultISABaseCode = 0; /* I/O base at 330h. */
4072	else if (!strcmp(achISACompat, "Alternate"))
4073	pThis->uDefaultISABaseCode = 1; /* I/O base at 334h. */
4074	else
4075	return PDMDEV_SET_ERROR(pDevIns, VERR_PDM_DEVINS_UNKNOWN_CFG_VALUES,
4076	N_("BusLogic configuration error: invalid ISACompat setting"));
4077
4078	/*
4079	* Register the PCI device and its I/O regions.
4080	*/
4081	rc = PDMDevHlpPCIRegister(pDevIns, &pThis->dev);
4082	if (RT_FAILURE(rc))
4083	return rc;
4084
4085	rc = PDMDevHlpPCIIORegionRegister(pDevIns, 0, 32, PCI_ADDRESS_SPACE_IO, buslogicR3MmioMap);
4086	if (RT_FAILURE(rc))
4087	return rc;
4088
4089	rc = PDMDevHlpPCIIORegionRegister(pDevIns, 1, 32, PCI_ADDRESS_SPACE_MEM, buslogicR3MmioMap);
4090	if (RT_FAILURE(rc))
4091	return rc;
4092
4093	if (fBootable)
4094	{
4095	/* Register I/O port space for BIOS access. */
4096	rc = PDMDevHlpIOPortRegister(pDevIns, BUSLOGIC_BIOS_IO_PORT, 4, NULL,
4097	buslogicR3BiosIoPortWrite, buslogicR3BiosIoPortRead,
4098	buslogicR3BiosIoPortWriteStr, buslogicR3BiosIoPortReadStr,
4099	"BusLogic BIOS");
4100	if (RT_FAILURE(rc))
4101	return PDMDEV_SET_ERROR(pDevIns, rc, N_("BusLogic cannot register BIOS I/O handlers"));
4102	}
4103
4104	/* Set up the compatibility I/O range. */
4105	rc = buslogicR3RegisterISARange(pThis, pThis->uDefaultISABaseCode);
4106	if (RT_FAILURE(rc))
4107	return PDMDEV_SET_ERROR(pDevIns, rc, N_("BusLogic cannot register ISA I/O handlers"));
4108
4109	/* Initialize task queue. */
4110	rc = PDMDevHlpQueueCreate(pDevIns, sizeof(PDMQUEUEITEMCORE), 5, 0,
4111	buslogicR3NotifyQueueConsumer, true, "BusLogicTask", &pThis->pNotifierQueueR3);
4112	if (RT_FAILURE(rc))
4113	return rc;
4114	pThis->pNotifierQueueR0 = PDMQueueR0Ptr(pThis->pNotifierQueueR3);
4115	pThis->pNotifierQueueRC = PDMQueueRCPtr(pThis->pNotifierQueueR3);
4116
4117	rc = PDMDevHlpCritSectInit(pDevIns, &pThis->CritSectIntr, RT_SRC_POS, "BusLogic-Intr#%u", pDevIns->iInstance);
4118	if (RT_FAILURE(rc))
4119	return PDMDEV_SET_ERROR(pDevIns, rc, N_("BusLogic: cannot create critical section"));
4120
4121	/*
4122	* Create event semaphore and worker thread.
4123	*/
4124	rc = SUPSemEventCreate(pThis->pSupDrvSession, &pThis->hEvtProcess);
4125	if (RT_FAILURE(rc))
4126	return PDMDevHlpVMSetError(pDevIns, rc, RT_SRC_POS,
4127	N_("BusLogic: Failed to create SUP event semaphore"));
4128
4129	char szDevTag[20];
4130	RTStrPrintf(szDevTag, sizeof(szDevTag), "BUSLOGIC-%u", iInstance);
4131
4132	rc = PDMDevHlpThreadCreate(pDevIns, &pThis->pThreadWrk, pThis, buslogicR3Worker,
4133	buslogicR3WorkerWakeUp, 0, RTTHREADTYPE_IO, szDevTag);
4134	if (RT_FAILURE(rc))
4135	return PDMDevHlpVMSetError(pDevIns, rc, RT_SRC_POS,
4136	N_("BusLogic: Failed to create worker thread %s"), szDevTag);
4137
4138	/* Initialize per device state. */
4139	for (unsigned i = 0; i < RT_ELEMENTS(pThis->aDeviceStates); i++)
4140	{
4141	char szName[24];
4142	PBUSLOGICDEVICE pDevice = &pThis->aDeviceStates[i];
4143
4144	RTStrPrintf(szName, sizeof(szName), "Device%u", i);
4145
4146	/* Initialize static parts of the device. */
4147	pDevice->iLUN = i;
4148	pDevice->pBusLogicR3 = pThis;
4149	pDevice->pBusLogicR0 = PDMINS_2_DATA_R0PTR(pDevIns);
4150	pDevice->pBusLogicRC = PDMINS_2_DATA_RCPTR(pDevIns);
4151	pDevice->Led.u32Magic = PDMLED_MAGIC;
4152	pDevice->IBase.pfnQueryInterface = buslogicR3DeviceQueryInterface;
4153	pDevice->IMediaPort.pfnQueryDeviceLocation = buslogicR3QueryDeviceLocation;
4154	pDevice->IMediaExPort.pfnIoReqCompleteNotify = buslogicR3IoReqCompleteNotify;
4155	pDevice->IMediaExPort.pfnIoReqCopyFromBuf = buslogicR3IoReqCopyFromBuf;
4156	pDevice->IMediaExPort.pfnIoReqCopyToBuf = buslogicR3IoReqCopyToBuf;
4157	pDevice->IMediaExPort.pfnIoReqQueryDiscardRanges = NULL;
4158	pDevice->IMediaExPort.pfnIoReqStateChanged = buslogicR3IoReqStateChanged;
4159	pDevice->IMediaExPort.pfnMediumEjected = buslogicR3MediumEjected;
4160	pDevice->ILed.pfnQueryStatusLed = buslogicR3DeviceQueryStatusLed;
4161
4162	/* Attach SCSI driver. */
4163	rc = PDMDevHlpDriverAttach(pDevIns, pDevice->iLUN, &pDevice->IBase, &pDevice->pDrvBase, szName);
4164	if (RT_SUCCESS(rc))
4165	{
4166	/* Query the media interface. */
4167	pDevice->pDrvMedia = PDMIBASE_QUERY_INTERFACE(pDevice->pDrvBase, PDMIMEDIA);
4168	AssertMsgReturn(VALID_PTR(pDevice->pDrvMedia),
4169	("Buslogic configuration error: LUN#%d misses the basic media interface!\n", pDevice->iLUN),
4170	VERR_PDM_MISSING_INTERFACE);
4171
4172	/* Get the extended media interface. */
4173	pDevice->pDrvMediaEx = PDMIBASE_QUERY_INTERFACE(pDevice->pDrvBase, PDMIMEDIAEX);
4174	AssertMsgReturn(VALID_PTR(pDevice->pDrvMediaEx),
4175	("Buslogic configuration error: LUN#%d misses the extended media interface!\n", pDevice->iLUN),
4176	VERR_PDM_MISSING_INTERFACE);
4177
4178	rc = pDevice->pDrvMediaEx->pfnIoReqAllocSizeSet(pDevice->pDrvMediaEx, sizeof(BUSLOGICREQ));
4179	if (RT_FAILURE(rc))
4180	return PDMDevHlpVMSetError(pDevIns, rc, RT_SRC_POS,
4181	N_("Buslogic configuration error: LUN#%u: Failed to set I/O request size!"),
4182	pDevice->iLUN);
4183
4184	pDevice->fPresent = true;
4185	}
4186	else if (rc == VERR_PDM_NO_ATTACHED_DRIVER)
4187	{
4188	pDevice->fPresent = false;
4189	pDevice->pDrvBase = NULL;
4190	pDevice->pDrvMedia = NULL;
4191	pDevice->pDrvMediaEx = NULL;
4192	rc = VINF_SUCCESS;
4193	Log(("BusLogic: no driver attached to device %s\n", szName));
4194	}
4195	else
4196	{
4197	AssertLogRelMsgFailed(("BusLogic: Failed to attach %s\n", szName));
4198	return rc;
4199	}
4200	}
4201
4202	/*
4203	* Attach status driver (optional).
4204	*/
4205	PPDMIBASE pBase;
4206	rc = PDMDevHlpDriverAttach(pDevIns, PDM_STATUS_LUN, &pThis->IBase, &pBase, "Status Port");
4207	if (RT_SUCCESS(rc))
4208	{
4209	pThis->pLedsConnector = PDMIBASE_QUERY_INTERFACE(pBase, PDMILEDCONNECTORS);
4210	pThis->pMediaNotify = PDMIBASE_QUERY_INTERFACE(pBase, PDMIMEDIANOTIFY);
4211	}
4212	else if (rc != VERR_PDM_NO_ATTACHED_DRIVER)
4213	{
4214	AssertMsgFailed(("Failed to attach to status driver. rc=%Rrc\n", rc));
4215	return PDMDEV_SET_ERROR(pDevIns, rc, N_("BusLogic cannot attach to status driver"));
4216	}
4217
4218	rc = PDMDevHlpSSMRegisterEx(pDevIns, BUSLOGIC_SAVED_STATE_MINOR_VERSION, sizeof(*pThis), NULL,
4219	NULL, buslogicR3LiveExec, NULL,
4220	NULL, buslogicR3SaveExec, NULL,
4221	NULL, buslogicR3LoadExec, buslogicR3LoadDone);
4222	if (RT_FAILURE(rc))
4223	return PDMDEV_SET_ERROR(pDevIns, rc, N_("BusLogic cannot register save state handlers"));
4224
4225	/*
4226	* Register the debugger info callback.
4227	*/
4228	char szTmp[128];
4229	RTStrPrintf(szTmp, sizeof(szTmp), "%s%d", pDevIns->pReg->szName, pDevIns->iInstance);
4230	PDMDevHlpDBGFInfoRegister(pDevIns, szTmp, "BusLogic HBA info", buslogicR3Info);
4231
4232	rc = buslogicR3HwReset(pThis, true);
4233	AssertMsgRC(rc, ("hardware reset of BusLogic host adapter failed rc=%Rrc\n", rc));
4234
4235	return rc;
4236	}
4237
4238	/**
4239	* The device registration structure.
4240	*/
4241	const PDMDEVREG g_DeviceBusLogic =
4242	{
4243	/* u32Version */
4244	PDM_DEVREG_VERSION,
4245	/* szName */
4246	"buslogic",
4247	/* szRCMod */
4248	"VBoxDDRC.rc",
4249	/* szR0Mod */
4250	"VBoxDDR0.r0",
4251	/* pszDescription */
4252	"BusLogic BT-958 SCSI host adapter.\n",
4253	/* fFlags */
4254	PDM_DEVREG_FLAGS_DEFAULT_BITS \| PDM_DEVREG_FLAGS_RC \| PDM_DEVREG_FLAGS_R0 \|
4255	PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION \| PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION \|
4256	PDM_DEVREG_FLAGS_FIRST_RESET_NOTIFICATION,
4257	/* fClass */
4258	PDM_DEVREG_CLASS_STORAGE,
4259	/* cMaxInstances */
4260	~0U,
4261	/* cbInstance */
4262	sizeof(BUSLOGIC),
4263	/* pfnConstruct */
4264	buslogicR3Construct,
4265	/* pfnDestruct */
4266	buslogicR3Destruct,
4267	/* pfnRelocate */
4268	buslogicR3Relocate,
4269	/* pfnMemSetup */
4270	NULL,
4271	/* pfnPowerOn */
4272	NULL,
4273	/* pfnReset */
4274	buslogicR3Reset,
4275	/* pfnSuspend */
4276	buslogicR3Suspend,
4277	/* pfnResume */
4278	NULL,
4279	/* pfnAttach */
4280	buslogicR3Attach,
4281	/* pfnDetach */
4282	buslogicR3Detach,
4283	/* pfnQueryInterface. */
4284	NULL,
4285	/* pfnInitComplete */
4286	NULL,
4287	/* pfnPowerOff */
4288	buslogicR3PowerOff,
4289	/* pfnSoftReset */
4290	NULL,
4291	/* u32VersionEnd */
4292	PDM_DEVREG_VERSION
4293	};
4294
4295	#endif /* IN_RING3 */
4296	#endif /* !VBOX_DEVICE_STRUCT_TESTCASE */

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Devices/Storage/DevBusLogic.cpp@ 64444

Download in other formats: