DevBusLogic.cpp@ 38188

Last change on this file since 38188 was 37636, checked in by vboxsync, 13 years ago
Changed FNIOMMMIOWRITE to take a const buffer pointer.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 124.0 KB

Line
1	/* $Id: DevBusLogic.cpp 37636 2011-06-24 14:59:59Z vboxsync $ */
2	/** @file
3	* VBox storage devices: BusLogic SCSI host adapter BT-958.
4	*/
5
6	/*
7	* Copyright (C) 2006-2009 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	/* Implemented looking at the driver source in the linux kernel (drivers/scsi/BusLogic.[ch]).
19	* See also: http://www.drdobbs.com/184410111
20	*/
21
22	/*******************************************************************************
23	* Header Files *
24	*******************************************************************************/
25	//#define DEBUG
26	#define LOG_GROUP LOG_GROUP_DEV_BUSLOGIC
27	#include <VBox/vmm/pdmdev.h>
28	#include <VBox/vmm/pdmifs.h>
29	#include <VBox/vmm/pdmcritsect.h>
30	#include <VBox/scsi.h>
31	#include <iprt/asm.h>
32	#include <iprt/assert.h>
33	#include <iprt/string.h>
34	#include <iprt/log.h>
35	#ifdef IN_RING3
36	# include <iprt/alloc.h>
37	# include <iprt/memcache.h>
38	# include <iprt/param.h>
39	# include <iprt/uuid.h>
40	#endif
41
42	#include "VBoxSCSI.h"
43	#include "VBoxDD.h"
44
45	/* Maximum number of attached devices the adapter can handle. */
46	#define BUSLOGIC_MAX_DEVICES 16
47
48	/* Maximum number of scatter gather elements this device can handle. */
49	#define BUSLOGIC_MAX_SCATTER_GATHER_LIST_SIZE 128
50
51	/* Size of the command buffer. */
52	#define BUSLOGIC_COMMAND_SIZE_MAX 5
53
54	/* Size of the reply buffer. */
55	#define BUSLOGIC_REPLY_SIZE_MAX 64
56
57	/* I/O port registered in the ISA compatible range to let the BIOS access
58	* the controller.
59	*/
60	#define BUSLOGIC_ISA_IO_PORT 0x330
61
62	/** State saved version. */
63	#define BUSLOGIC_SAVED_STATE_MINOR_VERSION 2
64
65	/** Saved state version before the suspend on error feature was implemented. */
66	#define BUSLOGIC_SAVED_STATE_MINOR_PRE_ERROR_HANDLING 1
67
68	/**
69	* State of a device attached to the buslogic host adapter.
70	*
71	* @implements PDMIBASE
72	* @implements PDMISCSIPORT
73	* @implements PDMILEDPORTS
74	*/
75	typedef struct BUSLOGICDEVICE
76	{
77	/** Pointer to the owning buslogic device instance. - R3 pointer */
78	R3PTRTYPE(struct BUSLOGIC *) pBusLogicR3;
79	/** Pointer to the owning buslogic device instance. - R0 pointer */
80	R0PTRTYPE(struct BUSLOGIC *) pBusLogicR0;
81	/** Pointer to the owning buslogic device instance. - RC pointer */
82	RCPTRTYPE(struct BUSLOGIC *) pBusLogicRC;
83
84	/** Flag whether device is present. */
85	bool fPresent;
86	/** LUN of the device. */
87	RTUINT iLUN;
88
89	#if HC_ARCH_BITS == 64
90	uint32_t Alignment0;
91	#endif
92
93	/** Our base interface. */
94	PDMIBASE IBase;
95	/** SCSI port interface. */
96	PDMISCSIPORT ISCSIPort;
97	/** Led interface. */
98	PDMILEDPORTS ILed;
99	/** Pointer to the attached driver's base interface. */
100	R3PTRTYPE(PPDMIBASE) pDrvBase;
101	/** Pointer to the underlying SCSI connector interface. */
102	R3PTRTYPE(PPDMISCSICONNECTOR) pDrvSCSIConnector;
103	/** The status LED state for this device. */
104	PDMLED Led;
105
106	#if HC_ARCH_BITS == 64
107	uint32_t Alignment1;
108	#endif
109
110	/** Number of outstanding tasks on the port. */
111	volatile uint32_t cOutstandingRequests;
112
113	} BUSLOGICDEVICE, *PBUSLOGICDEVICE;
114
115	/*
116	* Commands the BusLogic adapter supports.
117	*/
118	enum BUSLOGICCOMMAND
119	{
120	BUSLOGICCOMMAND_TEST_COMMAND_COMPLETE_INTERRUPT = 0x00,
121	BUSLOGICCOMMAND_INITIALIZE_MAILBOX = 0x01,
122	BUSLOGICCOMMAND_EXECUTE_MAILBOX_COMMAND = 0x02,
123	BUSLOGICCOMMAND_EXECUTE_BIOS_COMMAND = 0x03,
124	BUSLOGICCOMMAND_INQUIRE_BOARD_ID = 0x04,
125	BUSLOGICCOMMAND_ENABLE_OUTGOING_MAILBOX_AVAILABLE_INTERRUPT = 0x05,
126	BUSLOGICCOMMAND_SET_SCSI_SELECTION_TIMEOUT = 0x06,
127	BUSLOGICCOMMAND_SET_PREEMPT_TIME_ON_BUS = 0x07,
128	BUSLOGICCOMMAND_SET_TIME_OFF_BUS = 0x08,
129	BUSLOGICCOMMAND_SET_BUS_TRANSFER_RATE = 0x09,
130	BUSLOGICCOMMAND_INQUIRE_INSTALLED_DEVICES_ID_0_TO_7 = 0x0a,
131	BUSLOGICCOMMAND_INQUIRE_CONFIGURATION = 0x0b,
132	BUSLOGICCOMMAND_ENABLE_TARGET_MODE = 0x0c,
133	BUSLOGICCOMMAND_INQUIRE_SETUP_INFORMATION = 0x0d,
134	BUSLOGICCOMMAND_WRITE_ADAPTER_LOCAL_RAM = 0x1a,
135	BUSLOGICCOMMAND_READ_ADAPTER_LOCAL_RAM = 0x1b,
136	BUSLOGICCOMMAND_WRITE_BUSMASTER_CHIP_FIFO = 0x1c,
137	BUSLOGICCOMMAND_READ_BUSMASTER_CHIP_FIFO = 0x1d,
138	BUSLOGICCOMMAND_ECHO_COMMAND_DATA = 0x1f,
139	BUSLOGICCOMMAND_HOST_ADAPTER_DIAGNOSTIC = 0x20,
140	BUSLOGICCOMMAND_SET_ADAPTER_OPTIONS = 0x21,
141	BUSLOGICCOMMAND_INQUIRE_INSTALLED_DEVICES_ID_8_TO_15 = 0x23,
142	BUSLOGICCOMMAND_INQUIRE_TARGET_DEVICES = 0x24,
143	BUSLOGICCOMMAND_DISABLE_HOST_ADAPTER_INTERRUPT = 0x25,
144	BUSLOGICCOMMAND_EXT_BIOS_INFO = 0x28,
145	BUSLOGICCOMMAND_UNLOCK_MAILBOX = 0x29,
146	BUSLOGICCOMMAND_INITIALIZE_EXTENDED_MAILBOX = 0x81,
147	BUSLOGICCOMMAND_EXECUTE_SCSI_COMMAND = 0x83,
148	BUSLOGICCOMMAND_INQUIRE_FIRMWARE_VERSION_3RD_LETTER = 0x84,
149	BUSLOGICCOMMAND_INQUIRE_FIRMWARE_VERSION_LETTER = 0x85,
150	BUSLOGICCOMMAND_INQUIRE_PCI_HOST_ADAPTER_INFORMATION = 0x86,
151	BUSLOGICCOMMAND_INQUIRE_HOST_ADAPTER_MODEL_NUMBER = 0x8b,
152	BUSLOGICCOMMAND_INQUIRE_SYNCHRONOUS_PERIOD = 0x8c,
153	BUSLOGICCOMMAND_INQUIRE_EXTENDED_SETUP_INFORMATION = 0x8d,
154	BUSLOGICCOMMAND_ENABLE_STRICT_ROUND_ROBIN_MODE = 0x8f,
155	BUSLOGICCOMMAND_STORE_HOST_ADAPTER_LOCAL_RAM = 0x90,
156	BUSLOGICCOMMAND_FETCH_HOST_ADAPTER_LOCAL_RAM = 0x91,
157	BUSLOGICCOMMAND_STORE_LOCAL_DATA_IN_EEPROM = 0x92,
158	BUSLOGICCOMMAND_UPLOAD_AUTO_SCSI_CODE = 0x94,
159	BUSLOGICCOMMAND_MODIFY_IO_ADDRESS = 0x95,
160	BUSLOGICCOMMAND_SET_CCB_FORMAT = 0x96,
161	BUSLOGICCOMMAND_WRITE_INQUIRY_BUFFER = 0x9a,
162	BUSLOGICCOMMAND_READ_INQUIRY_BUFFER = 0x9b,
163	BUSLOGICCOMMAND_FLASH_ROM_UPLOAD_DOWNLOAD = 0xa7,
164	BUSLOGICCOMMAND_READ_SCAM_DATA = 0xa8,
165	BUSLOGICCOMMAND_WRITE_SCAM_DATA = 0xa9
166	} BUSLOGICCOMMAND;
167
168	#pragma pack(1)
169	/**
170	* Auto SCSI structure which is located
171	* in host adapter RAM and contains several
172	* configuration parameters.
173	*/
174	typedef struct AutoSCSIRam
175	{
176	uint8_t aInternalSignature[2];
177	uint8_t cbInformation;
178	uint8_t aHostAdaptertype[6];
179	uint8_t uReserved1;
180	bool fFloppyEnabled: 1;
181	bool fFloppySecondary: 1;
182	bool fLevelSensitiveInterrupt: 1;
183	unsigned char uReserved2: 2;
184	unsigned char uSystemRAMAreForBIOS: 3;
185	unsigned char uDMAChannel: 7;
186	bool fDMAAutoConfiguration: 1;
187	unsigned char uIrqChannel: 7;
188	bool fIrqAutoConfiguration: 1;
189	uint8_t uDMATransferRate;
190	uint8_t uSCSIId;
191	bool fLowByteTerminated: 1;
192	bool fParityCheckingEnabled: 1;
193	bool fHighByteTerminated: 1;
194	bool fNoisyCablingEnvironment: 1;
195	bool fFastSynchronousNeogtiation: 1;
196	bool fBusResetEnabled: 1;
197	bool fReserved3: 1;
198	bool fActiveNegotiationEnabled: 1;
199	uint8_t uBusOnDelay;
200	uint8_t uBusOffDelay;
201	bool fHostAdapterBIOSEnabled: 1;
202	bool fBIOSRedirectionOfInt19: 1;
203	bool fExtendedTranslation: 1;
204	bool fMapRemovableAsFixed: 1;
205	bool fReserved4: 1;
206	bool fBIOSSupportsMoreThan2Drives: 1;
207	bool fBIOSInterruptMode: 1;
208	bool fFlopticalSupport: 1;
209	uint16_t u16DeviceEnabledMask;
210	uint16_t u16WidePermittedMask;
211	uint16_t u16FastPermittedMask;
212	uint16_t u16SynchronousPermittedMask;
213	uint16_t u16DisconnectPermittedMask;
214	uint16_t u16SendStartUnitCommandMask;
215	uint16_t u16IgnoreInBIOSScanMask;
216	unsigned char uPCIInterruptPin: 2;
217	unsigned char uHostAdapterIoPortAddress: 2;
218	bool fStrictRoundRobinMode: 1;
219	bool fVesaBusSpeedGreaterThan33MHz: 1;
220	bool fVesaBurstWrite: 1;
221	bool fVesaBurstRead: 1;
222	uint16_t u16UltraPermittedMask;
223	uint32_t uReserved5;
224	uint8_t uReserved6;
225	uint8_t uAutoSCSIMaximumLUN;
226	bool fReserved7: 1;
227	bool fSCAMDominant: 1;
228	bool fSCAMenabled: 1;
229	bool fSCAMLevel2: 1;
230	unsigned char uReserved8: 4;
231	bool fInt13Extension: 1;
232	bool fReserved9: 1;
233	bool fCDROMBoot: 1;
234	unsigned char uReserved10: 5;
235	unsigned char uBootTargetId: 4;
236	unsigned char uBootChannel: 4;
237	bool fForceBusDeviceScanningOrder: 1;
238	unsigned char uReserved11: 7;
239	uint16_t u16NonTaggedToAlternateLunPermittedMask;
240	uint16_t u16RenegotiateSyncAfterCheckConditionMask;
241	uint8_t aReserved12[10];
242	uint8_t aManufacturingDiagnostic[2];
243	uint16_t u16Checksum;
244	} AutoSCSIRam, *PAutoSCSIRam;
245	AssertCompileSize(AutoSCSIRam, 64);
246	#pragma pack()
247
248	#pragma pack(1)
249	/**
250	* The local Ram.
251	*/
252	typedef union HostAdapterLocalRam
253	{
254	/* Byte view. */
255	uint8_t u8View[256];
256	/* Structured view. */
257	struct
258	{
259	/** Offset 0 - 63 is for BIOS. */
260	uint8_t u8Bios[64];
261	/** Auto SCSI structure. */
262	AutoSCSIRam autoSCSIData;
263	} structured;
264	} HostAdapterLocalRam, *PHostAdapterLocalRam;
265	AssertCompileSize(HostAdapterLocalRam, 256);
266	#pragma pack()
267
268	/** Pointer to a task state structure. */
269	typedef struct BUSLOGICTASKSTATE *PBUSLOGICTASKSTATE;
270
271	/**
272	* Main BusLogic device state.
273	*
274	* @extends PCIDEVICE
275	* @implements PDMILEDPORTS
276	*/
277	typedef struct BUSLOGIC
278	{
279	/** The PCI device structure. */
280	PCIDEVICE dev;
281	/** Pointer to the device instance - HC ptr */
282	PPDMDEVINSR3 pDevInsR3;
283	/** Pointer to the device instance - R0 ptr */
284	PPDMDEVINSR0 pDevInsR0;
285	/** Pointer to the device instance - RC ptr. */
286	PPDMDEVINSRC pDevInsRC;
287
288	/** Whether R0 is enabled. */
289	bool fR0Enabled;
290	/** Whether RC is enabled. */
291	bool fGCEnabled;
292
293	/** Base address of the I/O ports. */
294	RTIOPORT IOPortBase;
295	/** Base address of the memory mapping. */
296	RTGCPHYS MMIOBase;
297	/** Status register - Readonly. */
298	volatile uint8_t regStatus;
299	/** Interrupt register - Readonly. */
300	volatile uint8_t regInterrupt;
301	/** Geometry register - Readonly. */
302	volatile uint8_t regGeometry;
303
304	/** Local RAM for the fetch hostadapter local RAM request.
305	* I don't know how big the buffer really is but the maximum
306	* seems to be 256 bytes because the offset and count field in the command request
307	* are only one byte big.
308	*/
309	HostAdapterLocalRam LocalRam;
310
311	/** Command code the guest issued. */
312	uint8_t uOperationCode;
313	/** Buffer for the command parameters the adapter is currently receiving from the guest.
314	* Size of the largest command which is possible.
315	*/
316	uint8_t aCommandBuffer[BUSLOGIC_COMMAND_SIZE_MAX]; /* Size of the biggest request. */
317	/** Current position in the command buffer. */
318	uint8_t iParameter;
319	/** Parameters left until the command is complete. */
320	uint8_t cbCommandParametersLeft;
321
322	/** Whether we are using the RAM or reply buffer. */
323	bool fUseLocalRam;
324	/** Buffer to store reply data from the controller to the guest. */
325	uint8_t aReplyBuffer[BUSLOGIC_REPLY_SIZE_MAX]; /* Size of the biggest reply. */
326	/** Position in the buffer we are reading next. */
327	uint8_t iReply;
328	/** Bytes left until the reply buffer is empty. */
329	uint8_t cbReplyParametersLeft;
330
331	/** Flag whether IRQs are enabled. */
332	bool fIRQEnabled;
333	/** Flag whether the ISA I/O port range is disabled
334	* to prevent the BIOs to access the device. */
335	bool fISAEnabled;
336
337	/** Number of mailboxes the guest set up. */
338	uint32_t cMailbox;
339
340	#if HC_ARCH_BITS == 64
341	uint32_t Alignment0;
342	#endif
343
344	/** Physical base address of the outgoing mailboxes. */
345	RTGCPHYS GCPhysAddrMailboxOutgoingBase;
346	/** Current outgoing mailbox position. */
347	uint32_t uMailboxOutgoingPositionCurrent;
348	/** Number of mailboxes ready. */
349	volatile uint32_t cMailboxesReady;
350	/** Whether a notification to R3 was send. */
351	volatile bool fNotificationSend;
352
353	#if HC_ARCH_BITS == 64
354	uint32_t Alignment1;
355	#endif
356
357	/** Physical base address of the incoming mailboxes. */
358	RTGCPHYS GCPhysAddrMailboxIncomingBase;
359	/** Current incoming mailbox position. */
360	uint32_t uMailboxIncomingPositionCurrent;
361
362	/** Whether strict round robin is enabled. */
363	bool fStrictRoundRobinMode;
364	/** Whether the extended LUN CCB format is enabled for 32 possible logical units. */
365	bool fExtendedLunCCBFormat;
366
367	/** Queue to send tasks to R3. - HC ptr */
368	R3PTRTYPE(PPDMQUEUE) pNotifierQueueR3;
369	/** Queue to send tasks to R3. - HC ptr */
370	R0PTRTYPE(PPDMQUEUE) pNotifierQueueR0;
371	/** Queue to send tasks to R3. - RC ptr */
372	RCPTRTYPE(PPDMQUEUE) pNotifierQueueRC;
373
374	uint32_t Alignment2;
375
376	/** Critical section protecting access to the interrupt status register. */
377	PDMCRITSECT CritSectIntr;
378
379	/** Cache for task states. */
380	R3PTRTYPE(RTMEMCACHE) hTaskCache;
381
382	/** Device state for BIOS access. */
383	VBOXSCSI VBoxSCSI;
384
385	/** BusLogic device states. */
386	BUSLOGICDEVICE aDeviceStates[BUSLOGIC_MAX_DEVICES];
387
388	/** The base interface.
389	* @todo use PDMDEVINS::IBase */
390	PDMIBASE IBase;
391	/** Status Port - Leds interface. */
392	PDMILEDPORTS ILeds;
393	/** Partner of ILeds. */
394	R3PTRTYPE(PPDMILEDCONNECTORS) pLedsConnector;
395
396	#if HC_ARCH_BITS == 64
397	uint32_t Alignment3;
398	#endif
399
400	/** Indicates that PDMDevHlpAsyncNotificationCompleted should be called when
401	* a port is entering the idle state. */
402	bool volatile fSignalIdle;
403	/** Flag whether we have tasks which need to be processed again- */
404	bool volatile fRedo;
405	/** List of tasks which can be redone. */
406	R3PTRTYPE(volatile PBUSLOGICTASKSTATE) pTasksRedoHead;
407
408	#ifdef LOG_ENABLED
409	# if HC_ARCH_BITS == 64
410	uint32_t Alignment4;
411	# endif
412
413	volatile uint32_t cInMailboxesReady;
414	#endif
415
416	} BUSLOGIC, *PBUSLOGIC;
417
418	/** Register offsets in the I/O port space. */
419	#define BUSLOGIC_REGISTER_CONTROL 0 /* Writeonly */
420	/** Fields for the control register. */
421	# define BUSLOGIC_REGISTER_CONTROL_SCSI_BUSRESET RT_BIT(4)
422	# define BUSLOGIC_REGISTER_CONTROL_INTERRUPT_RESET RT_BIT(5)
423	# define BUSLOGIC_REGISTER_CONTROL_SOFT_RESET RT_BIT(6)
424	# define BUSLOGIC_REGISTER_CONTROL_HARD_RESET RT_BIT(7)
425
426	#define BUSLOGIC_REGISTER_STATUS 0 /* Readonly */
427	/** Fields for the status register. */
428	# define BUSLOGIC_REGISTER_STATUS_COMMAND_INVALID RT_BIT(0)
429	# define BUSLOGIC_REGISTER_STATUS_DATA_IN_REGISTER_READY RT_BIT(2)
430	# define BUSLOGIC_REGISTER_STATUS_COMMAND_PARAMETER_REGISTER_BUSY RT_BIT(3)
431	# define BUSLOGIC_REGISTER_STATUS_HOST_ADAPTER_READY RT_BIT(4)
432	# define BUSLOGIC_REGISTER_STATUS_INITIALIZATION_REQUIRED RT_BIT(5)
433	# define BUSLOGIC_REGISTER_STATUS_DIAGNOSTIC_FAILURE RT_BIT(6)
434	# define BUSLOGIC_REGISTER_STATUS_DIAGNOSTIC_ACTIVE RT_BIT(7)
435
436	#define BUSLOGIC_REGISTER_COMMAND 1 /* Writeonly */
437	#define BUSLOGIC_REGISTER_DATAIN 1 /* Readonly */
438	#define BUSLOGIC_REGISTER_INTERRUPT 2 /* Readonly */
439	/** Fields for the interrupt register. */
440	# define BUSLOGIC_REGISTER_INTERRUPT_INCOMING_MAILBOX_LOADED RT_BIT(0)
441	# define BUSLOGIC_REGISTER_INTERRUPT_OUTCOMING_MAILBOX_AVAILABLE RT_BIT(1)
442	# define BUSLOGIC_REGISTER_INTERRUPT_COMMAND_COMPLETE RT_BIT(2)
443	# define BUSLOGIC_REGISTER_INTERRUPT_EXTERNAL_BUS_RESET RT_BIT(3)
444	# define BUSLOGIC_REGISTER_INTERRUPT_INTERRUPT_VALID RT_BIT(7)
445
446	#define BUSLOGIC_REGISTER_GEOMETRY 3 /* Readonly */
447	# define BUSLOGIC_REGISTER_GEOMETRY_EXTENTED_TRANSLATION_ENABLED RT_BIT(7)
448
449	/* Structure for the INQUIRE_PCI_HOST_ADAPTER_INFORMATION reply. */
450	#pragma pack(1)
451	typedef struct ReplyInquirePCIHostAdapterInformation
452	{
453	uint8_t IsaIOPort;
454	uint8_t IRQ;
455	unsigned char LowByteTerminated:1;
456	unsigned char HighByteTerminated:1;
457	unsigned char uReserved:2; /* Reserved. */
458	unsigned char JP1:1; /* Whatever that means. */
459	unsigned char JP2:1; /* Whatever that means. */
460	unsigned char JP3:1; /* Whatever that means. */
461	/** Whether the provided info is valid. */
462	unsigned char InformationIsValid: 1;
463	uint8_t uReserved2; /* Reserved. */
464	} ReplyInquirePCIHostAdapterInformation, *PReplyInquirePCIHostAdapterInformation;
465	AssertCompileSize(ReplyInquirePCIHostAdapterInformation, 4);
466	#pragma pack()
467
468	/* Structure for the INQUIRE_CONFIGURATION reply. */
469	#pragma pack(1)
470	typedef struct ReplyInquireConfiguration
471	{
472	unsigned char uReserved1: 5;
473	bool fDmaChannel5: 1;
474	bool fDmaChannel6: 1;
475	bool fDmaChannel7: 1;
476	bool fIrqChannel9: 1;
477	bool fIrqChannel10: 1;
478	bool fIrqChannel11: 1;
479	bool fIrqChannel12: 1;
480	unsigned char uReserved2: 1;
481	bool fIrqChannel14: 1;
482	bool fIrqChannel15: 1;
483	unsigned char uReserved3: 1;
484	unsigned char uHostAdapterId: 4;
485	unsigned char uReserved4: 4;
486	} ReplyInquireConfiguration, *PReplyInquireConfiguration;
487	AssertCompileSize(ReplyInquireConfiguration, 3);
488	#pragma pack()
489
490	/* Structure for the INQUIRE_SETUP_INFORMATION reply. */
491	#pragma pack(1)
492	typedef struct ReplyInquireSetupInformationSynchronousValue
493	{
494	unsigned char uOffset: 4;
495	unsigned char uTransferPeriod: 3;
496	bool fSynchronous: 1;
497	}ReplyInquireSetupInformationSynchronousValue, *PReplyInquireSetupInformationSynchronousValue;
498	AssertCompileSize(ReplyInquireSetupInformationSynchronousValue, 1);
499	#pragma pack()
500
501	#pragma pack(1)
502	typedef struct ReplyInquireSetupInformation
503	{
504	bool fSynchronousInitiationEnabled: 1;
505	bool fParityCheckingEnabled: 1;
506	unsigned char uReserved1: 6;
507	uint8_t uBusTransferRate;
508	uint8_t uPreemptTimeOnBus;
509	uint8_t uTimeOffBus;
510	uint8_t cMailbox;
511	uint8_t MailboxAddress[3];
512	ReplyInquireSetupInformationSynchronousValue SynchronousValuesId0To7[8];
513	uint8_t uDisconnectPermittedId0To7;
514	uint8_t uSignature;
515	uint8_t uCharacterD;
516	uint8_t uHostBusType;
517	uint8_t uWideTransferPermittedId0To7;
518	uint8_t uWideTransfersActiveId0To7;
519	ReplyInquireSetupInformationSynchronousValue SynchronousValuesId8To15[8];
520	uint8_t uDisconnectPermittedId8To15;
521	uint8_t uReserved2;
522	uint8_t uWideTransferPermittedId8To15;
523	uint8_t uWideTransfersActiveId8To15;
524	} ReplyInquireSetupInformation, *PReplyInquireSetupInformation;
525	AssertCompileSize(ReplyInquireSetupInformation, 34);
526	#pragma pack()
527
528	/* Structure for the INQUIRE_EXTENDED_SETUP_INFORMATION. */
529	#pragma pack(1)
530	typedef struct ReplyInquireExtendedSetupInformation
531	{
532	uint8_t uBusType;
533	uint8_t uBiosAddress;
534	uint16_t u16ScatterGatherLimit;
535	uint8_t cMailbox;
536	uint32_t uMailboxAddressBase;
537	unsigned char uReserved1: 2;
538	bool fFastEISA: 1;
539	unsigned char uReserved2: 3;
540	bool fLevelSensitiveInterrupt: 1;
541	unsigned char uReserved3: 1;
542	unsigned char aFirmwareRevision[3];
543	bool fHostWideSCSI: 1;
544	bool fHostDifferentialSCSI: 1;
545	bool fHostSupportsSCAM: 1;
546	bool fHostUltraSCSI: 1;
547	bool fHostSmartTermination: 1;
548	unsigned char uReserved4: 3;
549	} ReplyInquireExtendedSetupInformation, *PReplyInquireExtendedSetupInformation;
550	AssertCompileSize(ReplyInquireExtendedSetupInformation, 14);
551	#pragma pack()
552
553	/* Structure for the INITIALIZE EXTENDED MAILBOX request. */
554	#pragma pack(1)
555	typedef struct RequestInitializeExtendedMailbox
556	{
557	/** Number of mailboxes in guest memory. */
558	uint8_t cMailbox;
559	/** Physical address of the first mailbox. */
560	uint32_t uMailboxBaseAddress;
561	} RequestInitializeExtendedMailbox, *PRequestInitializeExtendedMailbox;
562	AssertCompileSize(RequestInitializeExtendedMailbox, 5);
563	#pragma pack()
564
565	/*
566	* Structure of a mailbox in guest memory.
567	* The incoming and outgoing mailbox have the same size
568	* but the incoming one has some more fields defined which
569	* are marked as reserved in the outgoing one.
570	* The last field is also different from the type.
571	* For outgoing mailboxes it is the action and
572	* for incoming ones the completion status code for the task.
573	* We use one structure for both types.
574	*/
575	#pragma pack(1)
576	typedef struct Mailbox
577	{
578	/** Physical address of the CCB structure in the guest memory. */
579	uint32_t u32PhysAddrCCB;
580	/** Type specific data. */
581	union
582	{
583	/** For outgoing mailboxes. */
584	struct
585	{
586	/** Reserved */
587	uint8_t uReserved[3];
588	/** Action code. */
589	uint8_t uActionCode;
590	} out;
591	/** For incoming mailboxes. */
592	struct
593	{
594	/** The host adapter status after finishing the request. */
595	uint8_t uHostAdapterStatus;
596	/** The status of the device which executed the request after executing it. */
597	uint8_t uTargetDeviceStatus;
598	/** Reserved. */
599	uint8_t uReserved;
600	/** The completion status code of the request. */
601	uint8_t uCompletionCode;
602	} in;
603	} u;
604	} Mailbox, *PMailbox;
605	AssertCompileSize(Mailbox, 8);
606	#pragma pack()
607
608	/*
609	* Action codes for outgoing mailboxes.
610	*/
611	enum BUSLOGIC_MAILBOX_OUTGOING_ACTION
612	{
613	BUSLOGIC_MAILBOX_OUTGOING_ACTION_FREE = 0x00,
614	BUSLOGIC_MAILBOX_OUTGOING_ACTION_START_COMMAND = 0x01,
615	BUSLOGIC_MAILBOX_OUTGOING_ACTION_ABORT_COMMAND = 0x02
616	};
617
618	/*
619	* Completion codes for incoming mailboxes.
620	*/
621	enum BUSLOGIC_MAILBOX_INCOMING_COMPLETION
622	{
623	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_FREE = 0x00,
624	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_WITHOUT_ERROR = 0x01,
625	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_ABORTED = 0x02,
626	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_ABORTED_NOT_FOUND = 0x03,
627	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_WITH_ERROR = 0x04,
628	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_INVALID_CCB = 0x05
629	};
630
631	/*
632	* Host adapter status for incoming mailboxes.
633	*/
634	enum BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS
635	{
636	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_CMD_COMPLETED = 0x00,
637	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_LINKED_CMD_COMPLETED = 0x0a,
638	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_LINKED_CMD_COMPLETED_WITH_FLAG = 0x0b,
639	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_DATA_UNDERUN = 0x0c,
640	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_SCSI_SELECTION_TIMEOUT = 0x11,
641	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_DATA_OVERRUN = 0x12,
642	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_UNEXPECTED_BUS_FREE = 0x13,
643	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_INVALID_BUS_PHASE_REQUESTED = 0x14,
644	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_INVALID_OUTGOING_MAILBOX_ACTION_CODE = 0x15,
645	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_INVALID_COMMAND_OPERATION_CODE = 0x16,
646	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_LINKED_CCB_HAS_INVALID_LUN = 0x17,
647	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_INVALID_COMMAND_PARAMETER = 0x1a,
648	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_AUTO_REQUEST_SENSE_FAILED = 0x1b,
649	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_TAGGED_QUEUING_MESSAGE_REJECTED = 0x1c,
650	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_UNSUPPORTED_MESSAGE_RECEIVED = 0x1d,
651	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_HOST_ADAPTER_HARDWARE_FAILED = 0x20,
652	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_TARGET_FAILED_RESPONSE_TO_ATN = 0x21,
653	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_HOST_ADAPTER_ASSERTED_RST = 0x22,
654	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_OTHER_DEVICE_ASSERTED_RST = 0x23,
655	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_TARGET_DEVICE_RECONNECTED_IMPROPERLY = 0x24,
656	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_HOST_ADAPTER_ASSERTED_BUS_DEVICE_RESET = 0x25,
657	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_ABORT_QUEUE_GENERATED = 0x26,
658	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_HOST_ADAPTER_SOFTWARE_ERROR = 0x27,
659	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_HOST_ADAPTER_HARDWARE_TIMEOUT_ERROR = 0x30,
660	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_SCSI_PARITY_ERROR_DETECTED = 0x34
661	};
662
663	/*
664	* Device status codes for incoming mailboxes.
665	*/
666	enum BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS
667	{
668	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_OPERATION_GOOD = 0x00,
669	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_CHECK_CONDITION = 0x02,
670	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_DEVICE_BUSY = 0x08
671	};
672
673	/*
674	* Opcode types for CCB.
675	*/
676	enum BUSLOGIC_CCB_OPCODE
677	{
678	BUSLOGIC_CCB_OPCODE_INITIATOR_CCB = 0x00,
679	BUSLOGIC_CCB_OPCODE_TARGET_CCB = 0x01,
680	BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_SCATTER_GATHER = 0x02,
681	BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_DATA_LENGTH = 0x03,
682	BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_SCATTER_GATHER = 0x04,
683	BUSLOGIC_CCB_OPCODE_BUS_DEVICE_RESET = 0x81
684	};
685
686	/*
687	* Data transfer direction.
688	*/
689	enum BUSLOGIC_CCB_DIRECTION
690	{
691	BUSLOGIC_CCB_DIRECTION_UNKNOWN = 0x00,
692	BUSLOGIC_CCB_DIRECTION_IN = 0x01,
693	BUSLOGIC_CCB_DIRECTION_OUT = 0x02,
694	BUSLOGIC_CCB_DIRECTION_NO_DATA = 0x03
695	};
696
697	/*
698	* The command control block for a SCSI request.
699	*/
700	#pragma pack(1)
701	typedef struct CommandControlBlock
702	{
703	/** Opcode. */
704	uint8_t uOpcode;
705	/** Reserved */
706	unsigned char uReserved1: 3;
707	/** Data direction for the request. */
708	unsigned char uDataDirection: 2;
709	/** Whether the request is tag queued. */
710	bool fTagQueued: 1;
711	/** Queue tag mode. */
712	unsigned char uQueueTag: 2;
713	/** Length of the SCSI CDB. */
714	uint8_t cbCDB;
715	/** Sense data length. */
716	uint8_t cbSenseData;
717	/** Data length. */
718	uint32_t cbData;
719	/** Data pointer.
720	* This points to the data region or a scatter gather list based on the opcode.
721	*/
722	uint32_t u32PhysAddrData;
723	/** Reserved. */
724	uint8_t uReserved2[2];
725	/** Host adapter status. */
726	uint8_t uHostAdapterStatus;
727	/** Device adapter status. */
728	uint8_t uDeviceStatus;
729	/** The device the request is send to. */
730	uint8_t uTargetId;
731	/*The LUN in the device. /
732	unsigned char uLogicalUnit: 5;
733	/** Legacy tag. */
734	bool fLegacyTagEnable: 1;
735	/** Legacy queue tag. */
736	unsigned char uLegacyQueueTag: 2;
737	/** The SCSI CDB. */
738	uint8_t aCDB[12]; /* A CDB can be 12 bytes long. */
739	/** Reserved. */
740	uint8_t uReserved3[6];
741	/** Sense data pointer. */
742	uint32_t u32PhysAddrSenseData;
743	} CommandControlBlock, *PCommandControlBlock;
744	AssertCompileSize(CommandControlBlock, 40);
745	#pragma pack()
746
747	#pragma pack(1)
748	typedef struct ScatterGatherEntry
749	{
750	uint32_t cbSegment;
751	uint32_t u32PhysAddrSegmentBase;
752	} ScatterGatherEntry, *PScatterGatherEntry;
753	AssertCompileSize(ScatterGatherEntry, 8);
754	#pragma pack()
755
756	/*
757	* Task state for a CCB request.
758	*/
759	typedef struct BUSLOGICTASKSTATE
760	{
761	/** Next in the redo list. */
762	PBUSLOGICTASKSTATE pRedoNext;
763	/** Device this task is assigned to. */
764	R3PTRTYPE(PBUSLOGICDEVICE) pTargetDeviceR3;
765	/** The command control block from the guest. */
766	CommandControlBlock CommandControlBlockGuest;
767	/** Mailbox read from guest memory. */
768	Mailbox MailboxGuest;
769	/** The SCSI request we pass to the underlying SCSI engine. */
770	PDMSCSIREQUEST PDMScsiRequest;
771	/** Data buffer segment */
772	RTSGSEG DataSeg;
773	/** Pointer to the R3 sense buffer. */
774	uint8_t *pbSenseBuffer;
775	/** Flag whether this is a request from the BIOS. */
776	bool fBIOS;
777	} BUSLOGICTASKSTATE;
778
779	#ifndef VBOX_DEVICE_STRUCT_TESTCASE
780
781	#define PDMIBASE_2_PBUSLOGICDEVICE(pInterface) ( (PBUSLOGICDEVICE)((uintptr_t)(pInterface) - RT_OFFSETOF(BUSLOGICDEVICE, IBase)) )
782	#define PDMISCSIPORT_2_PBUSLOGICDEVICE(pInterface) ( (PBUSLOGICDEVICE)((uintptr_t)(pInterface) - RT_OFFSETOF(BUSLOGICDEVICE, ISCSIPort)) )
783	#define PDMILEDPORTS_2_PBUSLOGICDEVICE(pInterface) ( (PBUSLOGICDEVICE)((uintptr_t)(pInterface) - RT_OFFSETOF(BUSLOGICDEVICE, ILed)) )
784	#define PDMIBASE_2_PBUSLOGIC(pInterface) ( (PBUSLOGIC)((uintptr_t)(pInterface) - RT_OFFSETOF(BUSLOGIC, IBase)) )
785	#define PDMILEDPORTS_2_PBUSLOGIC(pInterface) ( (PBUSLOGIC)((uintptr_t)(pInterface) - RT_OFFSETOF(BUSLOGIC, ILeds)) )
786
787	/**
788	* Deasserts the interrupt line of the BusLogic adapter.
789	*
790	* @returns nothing
791	* @param pBuslogic Pointer to the BusLogic device instance.
792	*/
793	static void buslogicClearInterrupt(PBUSLOGIC pBusLogic)
794	{
795	LogFlowFunc(("pBusLogic=%#p\n", pBusLogic));
796	pBusLogic->regInterrupt = 0;
797	PDMDevHlpPCISetIrq(pBusLogic->CTX_SUFF(pDevIns), 0, 0);
798	}
799
800	/**
801	* Assert IRQ line of the BusLogic adapter.
802	*
803	* @returns nothing.
804	* @param pBusLogic Pointer to the BusLogic device instance.
805	* @param fSuppressIrq Flag to suppress IRQ generation regardless of fIRQEnabled
806	*/
807	static void buslogicSetInterrupt(PBUSLOGIC pBusLogic, bool fSuppressIrq)
808	{
809	LogFlowFunc(("pBusLogic=%#p\n", pBusLogic));
810	pBusLogic->regInterrupt \|= BUSLOGIC_REGISTER_INTERRUPT_INTERRUPT_VALID;
811	if (pBusLogic->fIRQEnabled && !fSuppressIrq)
812	PDMDevHlpPCISetIrq(pBusLogic->CTX_SUFF(pDevIns), 0, 1);
813	}
814
815	#if defined(IN_RING3)
816
817	/**
818	* Advances the mailbox pointer to the next slot.
819	*/
820	DECLINLINE(void) buslogicOutgoingMailboxAdvance(PBUSLOGIC pBusLogic)
821	{
822	pBusLogic->uMailboxOutgoingPositionCurrent = (pBusLogic->uMailboxOutgoingPositionCurrent + 1) % pBusLogic->cMailbox;
823	}
824
825	/**
826	* Returns the physical address of the next outgoing mailbox to process.
827	*/
828	DECLINLINE(RTGCPHYS) buslogicOutgoingMailboxGetGCPhys(PBUSLOGIC pBusLogic)
829	{
830	return pBusLogic->GCPhysAddrMailboxOutgoingBase + (pBusLogic->uMailboxOutgoingPositionCurrent * sizeof(Mailbox));
831	}
832
833	/**
834	* Initialize local RAM of host adapter with default values.
835	*
836	* @returns nothing.
837	* @param pBusLogic.
838	*/
839	static void buslogicInitializeLocalRam(PBUSLOGIC pBusLogic)
840	{
841	/*
842	* These values are mostly from what I think is right
843	* looking at the dmesg output from a Linux guest inside
844	* a VMware server VM.
845	*
846	* So they don't have to be right :)
847	*/
848	memset(pBusLogic->LocalRam.u8View, 0, sizeof(HostAdapterLocalRam));
849	pBusLogic->LocalRam.structured.autoSCSIData.fLevelSensitiveInterrupt = true;
850	pBusLogic->LocalRam.structured.autoSCSIData.fParityCheckingEnabled = true;
851	pBusLogic->LocalRam.structured.autoSCSIData.fExtendedTranslation = true; /* Same as in geometry register. */
852	pBusLogic->LocalRam.structured.autoSCSIData.u16DeviceEnabledMask = ~0; /* All enabled. Maybe mask out non present devices? */
853	pBusLogic->LocalRam.structured.autoSCSIData.u16WidePermittedMask = ~0;
854	pBusLogic->LocalRam.structured.autoSCSIData.u16FastPermittedMask = ~0;
855	pBusLogic->LocalRam.structured.autoSCSIData.u16SynchronousPermittedMask = ~0;
856	pBusLogic->LocalRam.structured.autoSCSIData.u16DisconnectPermittedMask = ~0;
857	pBusLogic->LocalRam.structured.autoSCSIData.fStrictRoundRobinMode = pBusLogic->fStrictRoundRobinMode;
858	pBusLogic->LocalRam.structured.autoSCSIData.u16UltraPermittedMask = ~0;
859	/* @todo calculate checksum? */
860	}
861
862	/**
863	* Do a hardware reset of the buslogic adapter.
864	*
865	* @returns VBox status code.
866	* @param pBusLogic Pointer to the BusLogic device instance.
867	*/
868	static int buslogicHwReset(PBUSLOGIC pBusLogic)
869	{
870	LogFlowFunc(("pBusLogic=%#p\n", pBusLogic));
871
872	/* Reset registers to default value. */
873	pBusLogic->regStatus = BUSLOGIC_REGISTER_STATUS_HOST_ADAPTER_READY \| BUSLOGIC_REGISTER_STATUS_INITIALIZATION_REQUIRED;
874	pBusLogic->regInterrupt = 0;
875	pBusLogic->regGeometry = BUSLOGIC_REGISTER_GEOMETRY_EXTENTED_TRANSLATION_ENABLED;
876	pBusLogic->uOperationCode = 0xff; /* No command executing. */
877	pBusLogic->iParameter = 0;
878	pBusLogic->cbCommandParametersLeft = 0;
879	pBusLogic->fIRQEnabled = true;
880	pBusLogic->fISAEnabled = true;
881	pBusLogic->uMailboxOutgoingPositionCurrent = 0;
882	pBusLogic->uMailboxIncomingPositionCurrent = 0;
883
884	buslogicInitializeLocalRam(pBusLogic);
885	vboxscsiInitialize(&pBusLogic->VBoxSCSI);
886
887	return VINF_SUCCESS;
888	}
889	#endif
890
891	/**
892	* Resets the command state machine for the next command and notifies the guest.
893	*
894	* @returns nothing.
895	* @param pBusLogic Pointer to the BusLogic device instance
896	* @param fSuppressIrq Flag to suppress IRQ generation regardless of current state
897	*/
898	static void buslogicCommandComplete(PBUSLOGIC pBusLogic, bool fSuppressIrq)
899	{
900	LogFlowFunc(("pBusLogic=%#p\n", pBusLogic));
901
902	pBusLogic->fUseLocalRam = false;
903	pBusLogic->regStatus \|= BUSLOGIC_REGISTER_STATUS_HOST_ADAPTER_READY;
904	pBusLogic->iReply = 0;
905
906	/* Modify I/O address does not generate an interrupt. */
907	if (pBusLogic->uOperationCode != BUSLOGICCOMMAND_EXECUTE_MAILBOX_COMMAND)
908	{
909	/* Notify that the command is complete. */
910	pBusLogic->regStatus &= ~BUSLOGIC_REGISTER_STATUS_DATA_IN_REGISTER_READY;
911	pBusLogic->regInterrupt \|= BUSLOGIC_REGISTER_INTERRUPT_COMMAND_COMPLETE;
912
913	buslogicSetInterrupt(pBusLogic, fSuppressIrq);
914	}
915
916	pBusLogic->uOperationCode = 0xff;
917	pBusLogic->iParameter = 0;
918	}
919
920	#if defined(IN_RING3)
921	/**
922	* Initiates a hard reset which was issued from the guest.
923	*
924	* @returns nothing
925	* @param pBusLogic Pointer to the BusLogic device instance.
926	*/
927	static void buslogicIntiateHardReset(PBUSLOGIC pBusLogic)
928	{
929	LogFlowFunc(("pBusLogic=%#p\n", pBusLogic));
930
931	buslogicHwReset(pBusLogic);
932
933	/* We set the diagnostic active in the status register. */
934	pBusLogic->regStatus \|= BUSLOGIC_REGISTER_STATUS_DIAGNOSTIC_ACTIVE;
935	}
936
937	/**
938	* Send a mailbox with set status codes to the guest.
939	*
940	* @returns nothing.
941	* @param pBusLogicR Pointer to the BubsLogic device instance.
942	* @param pTaskState Pointer to the task state with the mailbox to send.
943	* @param uHostAdapterStatus The host adapter status code to set.
944	* @param uDeviceStatus The target device status to set.
945	* @param uMailboxCompletionCode Completion status code to set in the mailbox.
946	*/
947	static void buslogicSendIncomingMailbox(PBUSLOGIC pBusLogic, PBUSLOGICTASKSTATE pTaskState,
948	uint8_t uHostAdapterStatus, uint8_t uDeviceStatus,
949	uint8_t uMailboxCompletionCode)
950	{
951	pTaskState->MailboxGuest.u.in.uHostAdapterStatus = uHostAdapterStatus;
952	pTaskState->MailboxGuest.u.in.uTargetDeviceStatus = uDeviceStatus;
953	pTaskState->MailboxGuest.u.in.uCompletionCode = uMailboxCompletionCode;
954
955	int rc = PDMCritSectEnter(&pBusLogic->CritSectIntr, VINF_SUCCESS);
956	AssertRC(rc);
957	RTGCPHYS GCPhysAddrMailboxIncoming = pBusLogic->GCPhysAddrMailboxIncomingBase + (pBusLogic->uMailboxIncomingPositionCurrent * sizeof(Mailbox));
958	RTGCPHYS GCPhysAddrCCB = (RTGCPHYS)pTaskState->MailboxGuest.u32PhysAddrCCB;
959
960	LogFlowFunc(("Completing CCB %RGp\n", GCPhysAddrCCB));
961
962	/* Update CCB. */
963	pTaskState->CommandControlBlockGuest.uHostAdapterStatus = uHostAdapterStatus;
964	pTaskState->CommandControlBlockGuest.uDeviceStatus = uDeviceStatus;
965	PDMDevHlpPhysWrite(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrCCB, &pTaskState->CommandControlBlockGuest, sizeof(CommandControlBlock));
966
967	#ifdef RT_STRICT
968	Mailbox Tmp;
969	PDMDevHlpPhysRead(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrMailboxIncoming, &Tmp, sizeof(Mailbox));
970	Assert(Tmp.u.in.uCompletionCode == BUSLOGIC_MAILBOX_INCOMING_COMPLETION_FREE);
971	#endif
972
973	/* Update mailbox. */
974	PDMDevHlpPhysWrite(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrMailboxIncoming, &pTaskState->MailboxGuest, sizeof(Mailbox));
975
976	/* Advance to next mailbox position. */
977	pBusLogic->uMailboxIncomingPositionCurrent++;
978	if (pBusLogic->uMailboxIncomingPositionCurrent >= pBusLogic->cMailbox)
979	pBusLogic->uMailboxIncomingPositionCurrent = 0;
980
981	#ifdef LOG_ENABLED
982	ASMAtomicIncU32(&pBusLogic->cInMailboxesReady);
983	#endif
984
985	pBusLogic->regInterrupt \|= BUSLOGIC_REGISTER_INTERRUPT_INCOMING_MAILBOX_LOADED;
986	buslogicSetInterrupt(pBusLogic, false);
987
988	PDMCritSectLeave(&pBusLogic->CritSectIntr);
989	}
990
991	#if defined(DEBUG)
992	/**
993	* Dumps the content of a mailbox for debugging purposes.
994	*
995	* @return nothing
996	* @param pMailbox The mialbox to dump.
997	* @param fOutgoing true if dumping the outgoing state.
998	* false if dumping the incoming state.
999	*/
1000	static void buslogicDumpMailboxInfo(PMailbox pMailbox, bool fOutgoing)
1001	{
1002	Log(("%s: Dump for %s mailbox:\n", __FUNCTION__, fOutgoing ? "outgoing" : "incoming"));
1003	Log(("%s: u32PhysAddrCCB=%#x\n", __FUNCTION__, pMailbox->u32PhysAddrCCB));
1004	if (fOutgoing)
1005	{
1006	Log(("%s: uActionCode=%u\n", __FUNCTION__, pMailbox->u.out.uActionCode));
1007	}
1008	else
1009	{
1010	Log(("%s: uHostAdapterStatus=%u\n", __FUNCTION__, pMailbox->u.in.uHostAdapterStatus));
1011	Log(("%s: uTargetDeviceStatus=%u\n", __FUNCTION__, pMailbox->u.in.uTargetDeviceStatus));
1012	Log(("%s: uCompletionCode=%u\n", __FUNCTION__, pMailbox->u.in.uCompletionCode));
1013	}
1014	}
1015
1016	/**
1017	* Dumps the content of a command control block for debugging purposes.
1018	*
1019	* @returns nothing.
1020	* @param pCCB Pointer to the command control block to dump.
1021	*/
1022	static void buslogicDumpCCBInfo(PCommandControlBlock pCCB)
1023	{
1024	Log(("%s: Dump for Command Control Block:\n", __FUNCTION__));
1025	Log(("%s: uOpCode=%#x\n", __FUNCTION__, pCCB->uOpcode));
1026	Log(("%s: uDataDirection=%u\n", __FUNCTION__, pCCB->uDataDirection));
1027	Log(("%s: fTagQueued=%d\n", __FUNCTION__, pCCB->fTagQueued));
1028	Log(("%s: uQueueTag=%u\n", __FUNCTION__, pCCB->uQueueTag));
1029	Log(("%s: cbCDB=%u\n", __FUNCTION__, pCCB->cbCDB));
1030	Log(("%s: cbSenseData=%u\n", __FUNCTION__, pCCB->cbSenseData));
1031	Log(("%s: cbData=%u\n", __FUNCTION__, pCCB->cbData));
1032	Log(("%s: u32PhysAddrData=%#x\n", __FUNCTION__, pCCB->u32PhysAddrData));
1033	Log(("%s: uHostAdapterStatus=%u\n", __FUNCTION__, pCCB->uHostAdapterStatus));
1034	Log(("%s: uDeviceStatus=%u\n", __FUNCTION__, pCCB->uDeviceStatus));
1035	Log(("%s: uTargetId=%u\n", __FUNCTION__, pCCB->uTargetId));
1036	Log(("%s: uLogicalUnit=%u\n", __FUNCTION__, pCCB->uLogicalUnit));
1037	Log(("%s: fLegacyTagEnable=%u\n", __FUNCTION__, pCCB->fLegacyTagEnable));
1038	Log(("%s: uLegacyQueueTag=%u\n", __FUNCTION__, pCCB->uLegacyQueueTag));
1039	Log(("%s: uCDB[0]=%#x\n", __FUNCTION__, pCCB->aCDB[0]));
1040	for (int i = 1; i < pCCB->cbCDB; i++)
1041	Log(("%s: uCDB[%d]=%u\n", __FUNCTION__, i, pCCB->aCDB[i]));
1042	Log(("%s: u32PhysAddrSenseData=%#x\n", __FUNCTION__, pCCB->u32PhysAddrSenseData));
1043	}
1044	#endif
1045
1046	/**
1047	* Allocate data buffer.
1048	*
1049	* @returns VBox status code.
1050	* @param pTaskState Pointer to the task state.
1051	*/
1052	static int buslogicDataBufferAlloc(PBUSLOGICTASKSTATE pTaskState)
1053	{
1054	PPDMDEVINS pDevIns = pTaskState->CTX_SUFF(pTargetDevice)->CTX_SUFF(pBusLogic)->CTX_SUFF(pDevIns);
1055
1056	if ( (pTaskState->CommandControlBlockGuest.uDataDirection != BUSLOGIC_CCB_DIRECTION_NO_DATA)
1057	&& (pTaskState->CommandControlBlockGuest.cbData > 0))
1058	{
1059	/*
1060	* @todo: Check following assumption and what residual means.
1061	*
1062	* The BusLogic adapter can handle two different data buffer formats.
1063	* The first one is that the data pointer entry in the CCB points to
1064	* the buffer directly. In second mode the data pointer points to a
1065	* scatter gather list which describes the buffer.
1066	*/
1067	if ( (pTaskState->CommandControlBlockGuest.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_SCATTER_GATHER)
1068	\|\| (pTaskState->CommandControlBlockGuest.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_SCATTER_GATHER))
1069	{
1070	uint32_t cScatterGatherGCRead;
1071	uint32_t iScatterGatherEntry;
1072	ScatterGatherEntry aScatterGatherReadGC[32]; /* Number of scatter gather list entries read from guest memory. */
1073	uint32_t cScatterGatherGCLeft = pTaskState->CommandControlBlockGuest.cbData / sizeof(ScatterGatherEntry);
1074	RTGCPHYS GCPhysAddrScatterGatherCurrent = (RTGCPHYS)pTaskState->CommandControlBlockGuest.u32PhysAddrData;
1075	size_t cbDataToTransfer = 0;
1076
1077	/* Count number of bytes to transfer. */
1078	do
1079	{
1080	cScatterGatherGCRead = (cScatterGatherGCLeft < RT_ELEMENTS(aScatterGatherReadGC))
1081	? cScatterGatherGCLeft
1082	: RT_ELEMENTS(aScatterGatherReadGC);
1083	cScatterGatherGCLeft -= cScatterGatherGCRead;
1084
1085	/* Read the SG entries. */
1086	PDMDevHlpPhysRead(pDevIns, GCPhysAddrScatterGatherCurrent, &aScatterGatherReadGC[0],
1087	cScatterGatherGCRead * sizeof(ScatterGatherEntry));
1088
1089	for (iScatterGatherEntry = 0; iScatterGatherEntry < cScatterGatherGCRead; iScatterGatherEntry++)
1090	{
1091	RTGCPHYS GCPhysAddrDataBase;
1092
1093	Log(("%s: iScatterGatherEntry=%u\n", __FUNCTION__, iScatterGatherEntry));
1094
1095	GCPhysAddrDataBase = (RTGCPHYS)aScatterGatherReadGC[iScatterGatherEntry].u32PhysAddrSegmentBase;
1096	cbDataToTransfer += aScatterGatherReadGC[iScatterGatherEntry].cbSegment;
1097
1098	Log(("%s: GCPhysAddrDataBase=%RGp cbDataToTransfer=%u\n",
1099	__FUNCTION__, GCPhysAddrDataBase,
1100	aScatterGatherReadGC[iScatterGatherEntry].cbSegment));
1101	}
1102
1103	/* Set address to the next entries to read. */
1104	GCPhysAddrScatterGatherCurrent += cScatterGatherGCRead * sizeof(ScatterGatherEntry);
1105	} while (cScatterGatherGCLeft > 0);
1106
1107	Log(("%s: cbDataToTransfer=%d\n", __FUNCTION__, cbDataToTransfer));
1108
1109	/* Allocate buffer */
1110	pTaskState->DataSeg.cbSeg = cbDataToTransfer;
1111	pTaskState->DataSeg.pvSeg = RTMemAlloc(pTaskState->DataSeg.cbSeg);
1112	if (!pTaskState->DataSeg.pvSeg)
1113	return VERR_NO_MEMORY;
1114
1115	/* Copy the data if needed */
1116	if (pTaskState->CommandControlBlockGuest.uDataDirection == BUSLOGIC_CCB_DIRECTION_OUT)
1117	{
1118	cScatterGatherGCLeft = pTaskState->CommandControlBlockGuest.cbData / sizeof(ScatterGatherEntry);
1119	GCPhysAddrScatterGatherCurrent = (RTGCPHYS)pTaskState->CommandControlBlockGuest.u32PhysAddrData;
1120	uint8_t pbData = (uint8_t )pTaskState->DataSeg.pvSeg;
1121
1122	do
1123	{
1124	cScatterGatherGCRead = (cScatterGatherGCLeft < RT_ELEMENTS(aScatterGatherReadGC))
1125	? cScatterGatherGCLeft
1126	: RT_ELEMENTS(aScatterGatherReadGC);
1127	cScatterGatherGCLeft -= cScatterGatherGCRead;
1128
1129	/* Read the SG entries. */
1130	PDMDevHlpPhysRead(pDevIns, GCPhysAddrScatterGatherCurrent, &aScatterGatherReadGC[0],
1131	cScatterGatherGCRead * sizeof(ScatterGatherEntry));
1132
1133	for (iScatterGatherEntry = 0; iScatterGatherEntry < cScatterGatherGCRead; iScatterGatherEntry++)
1134	{
1135	RTGCPHYS GCPhysAddrDataBase;
1136
1137	Log(("%s: iScatterGatherEntry=%u\n", __FUNCTION__, iScatterGatherEntry));
1138
1139	GCPhysAddrDataBase = (RTGCPHYS)aScatterGatherReadGC[iScatterGatherEntry].u32PhysAddrSegmentBase;
1140	cbDataToTransfer = aScatterGatherReadGC[iScatterGatherEntry].cbSegment;
1141
1142	Log(("%s: GCPhysAddrDataBase=%RGp cbDataToTransfer=%u\n", __FUNCTION__, GCPhysAddrDataBase, cbDataToTransfer));
1143
1144	PDMDevHlpPhysRead(pDevIns, GCPhysAddrDataBase, pbData, cbDataToTransfer);
1145	pbData += cbDataToTransfer;
1146	}
1147
1148	/* Set address to the next entries to read. */
1149	GCPhysAddrScatterGatherCurrent += cScatterGatherGCRead * sizeof(ScatterGatherEntry);
1150	} while (cScatterGatherGCLeft > 0);
1151	}
1152
1153	}
1154	else if ( pTaskState->CommandControlBlockGuest.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB
1155	\|\| pTaskState->CommandControlBlockGuest.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_DATA_LENGTH)
1156	{
1157	/* The buffer is not scattered. */
1158	RTGCPHYS GCPhysAddrDataBase = (RTGCPHYS)pTaskState->CommandControlBlockGuest.u32PhysAddrData;
1159
1160	AssertMsg(GCPhysAddrDataBase != 0, ("Physical address is 0\n"));
1161
1162	pTaskState->DataSeg.cbSeg = pTaskState->CommandControlBlockGuest.cbData;
1163	pTaskState->DataSeg.pvSeg = RTMemAlloc(pTaskState->DataSeg.cbSeg);
1164	if (!pTaskState->DataSeg.pvSeg)
1165	return VERR_NO_MEMORY;
1166
1167	Log(("Non scattered buffer:\n"));
1168	Log(("u32PhysAddrData=%#x\n", pTaskState->CommandControlBlockGuest.u32PhysAddrData));
1169	Log(("cbData=%u\n", pTaskState->CommandControlBlockGuest.cbData));
1170	Log(("GCPhysAddrDataBase=0x%RGp\n", GCPhysAddrDataBase));
1171
1172	/* Copy the data into the buffer. */
1173	PDMDevHlpPhysRead(pDevIns, GCPhysAddrDataBase, pTaskState->DataSeg.pvSeg, pTaskState->DataSeg.cbSeg);
1174	}
1175	}
1176
1177	return VINF_SUCCESS;
1178	}
1179
1180	/**
1181	* Free allocated resources used for the scatter gather list.
1182	*
1183	* @returns nothing.
1184	* @param pTaskState Pointer to the task state.
1185	*/
1186	static void buslogicDataBufferFree(PBUSLOGICTASKSTATE pTaskState)
1187	{
1188	PPDMDEVINS pDevIns = pTaskState->CTX_SUFF(pTargetDevice)->CTX_SUFF(pBusLogic)->CTX_SUFF(pDevIns);
1189
1190	if ( (pTaskState->CommandControlBlockGuest.cbData > 0)
1191	&& ( (pTaskState->CommandControlBlockGuest.uDataDirection == BUSLOGIC_CCB_DIRECTION_IN)
1192	\|\| (pTaskState->CommandControlBlockGuest.uDataDirection == BUSLOGIC_CCB_DIRECTION_UNKNOWN)))
1193	{
1194	if ( (pTaskState->CommandControlBlockGuest.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_SCATTER_GATHER)
1195	\|\| (pTaskState->CommandControlBlockGuest.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_SCATTER_GATHER))
1196	{
1197	uint32_t cScatterGatherGCRead;
1198	uint32_t iScatterGatherEntry;
1199	ScatterGatherEntry aScatterGatherReadGC[32]; /* Number of scatter gather list entries read from guest memory. */
1200	uint32_t cScatterGatherGCLeft = pTaskState->CommandControlBlockGuest.cbData / sizeof(ScatterGatherEntry);
1201	RTGCPHYS GCPhysAddrScatterGatherCurrent = (RTGCPHYS)pTaskState->CommandControlBlockGuest.u32PhysAddrData;
1202	uint8_t pbData = (uint8_t )pTaskState->DataSeg.pvSeg;
1203
1204	do
1205	{
1206	cScatterGatherGCRead = (cScatterGatherGCLeft < RT_ELEMENTS(aScatterGatherReadGC))
1207	? cScatterGatherGCLeft
1208	: RT_ELEMENTS(aScatterGatherReadGC);
1209	cScatterGatherGCLeft -= cScatterGatherGCRead;
1210
1211	/* Read the SG entries. */
1212	PDMDevHlpPhysRead(pDevIns, GCPhysAddrScatterGatherCurrent, &aScatterGatherReadGC[0],
1213	cScatterGatherGCRead * sizeof(ScatterGatherEntry));
1214
1215	for (iScatterGatherEntry = 0; iScatterGatherEntry < cScatterGatherGCRead; iScatterGatherEntry++)
1216	{
1217	RTGCPHYS GCPhysAddrDataBase;
1218	size_t cbDataToTransfer;
1219
1220	Log(("%s: iScatterGatherEntry=%u\n", __FUNCTION__, iScatterGatherEntry));
1221
1222	GCPhysAddrDataBase = (RTGCPHYS)aScatterGatherReadGC[iScatterGatherEntry].u32PhysAddrSegmentBase;
1223	cbDataToTransfer = aScatterGatherReadGC[iScatterGatherEntry].cbSegment;
1224
1225	Log(("%s: GCPhysAddrDataBase=%RGp cbDataToTransfer=%u\n", __FUNCTION__, GCPhysAddrDataBase, cbDataToTransfer));
1226
1227	PDMDevHlpPhysWrite(pDevIns, GCPhysAddrDataBase, pbData, cbDataToTransfer);
1228	pbData += cbDataToTransfer;
1229	}
1230
1231	/* Set address to the next entries to read. */
1232	GCPhysAddrScatterGatherCurrent += cScatterGatherGCRead * sizeof(ScatterGatherEntry);
1233	} while (cScatterGatherGCLeft > 0);
1234
1235	}
1236	else if ( pTaskState->CommandControlBlockGuest.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB
1237	\|\| pTaskState->CommandControlBlockGuest.uOpcode == BUSLOGIC_CCB_OPCODE_INITIATOR_CCB_RESIDUAL_DATA_LENGTH)
1238	{
1239	/* The buffer is not scattered. */
1240	RTGCPHYS GCPhysAddrDataBase = (RTGCPHYS)pTaskState->CommandControlBlockGuest.u32PhysAddrData;
1241
1242	AssertMsg(GCPhysAddrDataBase != 0, ("Physical address is 0\n"));
1243
1244	Log(("Non scattered buffer:\n"));
1245	Log(("u32PhysAddrData=%#x\n", pTaskState->CommandControlBlockGuest.u32PhysAddrData));
1246	Log(("cbData=%u\n", pTaskState->CommandControlBlockGuest.cbData));
1247	Log(("GCPhysAddrDataBase=0x%RGp\n", GCPhysAddrDataBase));
1248
1249	/* Copy the data into the guest memory. */
1250	PDMDevHlpPhysWrite(pDevIns, GCPhysAddrDataBase, pTaskState->DataSeg.pvSeg, pTaskState->DataSeg.cbSeg);
1251	}
1252	}
1253
1254	RTMemFree(pTaskState->DataSeg.pvSeg);
1255	pTaskState->DataSeg.pvSeg = NULL;
1256	pTaskState->DataSeg.cbSeg = 0;
1257	}
1258
1259	/**
1260	* Free the sense buffer.
1261	*
1262	* @returns nothing.
1263	* @param pTaskState Pointer to the task state.
1264	* @param fCopy If sense data should be copied to guest memory.
1265	*/
1266	static void buslogicSenseBufferFree(PBUSLOGICTASKSTATE pTaskState, bool fCopy)
1267	{
1268	PPDMDEVINS pDevIns = pTaskState->CTX_SUFF(pTargetDevice)->CTX_SUFF(pBusLogic)->CTX_SUFF(pDevIns);
1269	RTGCPHYS GCPhysAddrSenseBuffer = (RTGCPHYS)pTaskState->CommandControlBlockGuest.u32PhysAddrSenseData;
1270	uint32_t cbSenseBuffer = pTaskState->CommandControlBlockGuest.cbSenseData;
1271
1272	/* Copy into guest memory. */
1273	if (fCopy)
1274	PDMDevHlpPhysWrite(pDevIns, GCPhysAddrSenseBuffer, pTaskState->pbSenseBuffer, cbSenseBuffer);
1275
1276	RTMemFree(pTaskState->pbSenseBuffer);
1277	pTaskState->pbSenseBuffer = NULL;
1278	}
1279
1280	/**
1281	* Alloc the sense buffer.
1282	*
1283	* @returns VBox status code.
1284	* @param pTaskState Pointer to the task state.
1285	* @note Current assumption is that the sense buffer is not scattered and does not cross a page boundary.
1286	*/
1287	static int buslogicSenseBufferAlloc(PBUSLOGICTASKSTATE pTaskState)
1288	{
1289	PPDMDEVINS pDevIns = pTaskState->CTX_SUFF(pTargetDevice)->CTX_SUFF(pBusLogic)->CTX_SUFF(pDevIns);
1290	uint32_t cbSenseBuffer = pTaskState->CommandControlBlockGuest.cbSenseData;
1291
1292	pTaskState->pbSenseBuffer = (uint8_t *)RTMemAllocZ(cbSenseBuffer);
1293	if (!pTaskState->pbSenseBuffer)
1294	return VERR_NO_MEMORY;
1295
1296	return VINF_SUCCESS;
1297	}
1298	#endif /* IN_RING3 */
1299
1300	/**
1301	* Parses the command buffer and executes it.
1302	*
1303	* @returns VBox status code.
1304	* @param pBusLogic Pointer to the BusLogic device instance.
1305	*/
1306	static int buslogicProcessCommand(PBUSLOGIC pBusLogic)
1307	{
1308	int rc = VINF_SUCCESS;
1309	bool fSuppressIrq = false;
1310
1311	LogFlowFunc(("pBusLogic=%#p\n", pBusLogic));
1312	AssertMsg(pBusLogic->uOperationCode != 0xff, ("There is no command to execute\n"));
1313
1314	switch (pBusLogic->uOperationCode)
1315	{
1316	case BUSLOGICCOMMAND_INQUIRE_PCI_HOST_ADAPTER_INFORMATION:
1317	{
1318	PReplyInquirePCIHostAdapterInformation pReply = (PReplyInquirePCIHostAdapterInformation)pBusLogic->aReplyBuffer;
1319	memset(pReply, 0, sizeof(ReplyInquirePCIHostAdapterInformation));
1320
1321	/* It seems VMware does not provide valid information here too, lets do the same :) */
1322	pReply->InformationIsValid = 0;
1323	pReply->IsaIOPort = 0xff; /* Make it invalid. */
1324	pBusLogic->cbReplyParametersLeft = sizeof(ReplyInquirePCIHostAdapterInformation);
1325	break;
1326	}
1327	case BUSLOGICCOMMAND_MODIFY_IO_ADDRESS:
1328	{
1329	pBusLogic->cbReplyParametersLeft = 0;
1330	if (pBusLogic->aCommandBuffer[0] == 0x06)
1331	{
1332	Log(("Disabling ISA I/O ports.\n"));
1333	pBusLogic->fISAEnabled = false;
1334	}
1335	fSuppressIrq = true;
1336	break;
1337	}
1338	case BUSLOGICCOMMAND_INQUIRE_BOARD_ID:
1339	{
1340	/* The special option byte is important: If it is '0' or 'B', Windows NT drivers
1341	* for Adaptec AHA-154x may claim the adapter. The BusLogic drivers will claim
1342	* the adapter only when the byte is not '0' or 'B'.
1343	*/
1344	pBusLogic->aReplyBuffer[0] = 'A'; /* Firmware option bytes */
1345	pBusLogic->aReplyBuffer[1] = 'A'; /* Special option byte */
1346
1347	/* We report version 5.07B. This reply will provide the first two digits. */
1348	pBusLogic->aReplyBuffer[2] = '5'; /* Major version 5 */
1349	pBusLogic->aReplyBuffer[3] = '0'; /* Minor version 0 */
1350	pBusLogic->cbReplyParametersLeft = 4; /* Reply is 4 bytes long */
1351	break;
1352	}
1353	case BUSLOGICCOMMAND_INQUIRE_FIRMWARE_VERSION_3RD_LETTER:
1354	{
1355	pBusLogic->aReplyBuffer[0] = '7';
1356	pBusLogic->cbReplyParametersLeft = 1;
1357	break;
1358	}
1359	case BUSLOGICCOMMAND_INQUIRE_FIRMWARE_VERSION_LETTER:
1360	{
1361	pBusLogic->aReplyBuffer[0] = 'B';
1362	pBusLogic->cbReplyParametersLeft = 1;
1363	break;
1364	}
1365	case BUSLOGICCOMMAND_INQUIRE_HOST_ADAPTER_MODEL_NUMBER:
1366	{
1367	/* The reply length is set by the guest and is found in the first byte of the command buffer. */
1368	pBusLogic->cbReplyParametersLeft = pBusLogic->aCommandBuffer[0];
1369	memset(pBusLogic->aReplyBuffer, ' ', pBusLogic->cbReplyParametersLeft);
1370	const char aModelName[] = "958";
1371	int cCharsToTransfer = (pBusLogic->cbReplyParametersLeft <= (sizeof(aModelName) - 1))
1372	? pBusLogic->cbReplyParametersLeft
1373	: sizeof(aModelName) - 1;
1374
1375	for (int i = 0; i < cCharsToTransfer; i++)
1376	pBusLogic->aReplyBuffer[i] = aModelName[i];
1377
1378	break;
1379	}
1380	case BUSLOGICCOMMAND_INQUIRE_CONFIGURATION:
1381	{
1382	pBusLogic->cbReplyParametersLeft = sizeof(ReplyInquireConfiguration);
1383	PReplyInquireConfiguration pReply = (PReplyInquireConfiguration)pBusLogic->aReplyBuffer;
1384	memset(pReply, 0, sizeof(ReplyInquireConfiguration));
1385
1386	pReply->uHostAdapterId = 7; /* The controller has always 7 as ID. */
1387	/*
1388	* The rest of this reply only applies for ISA adapters.
1389	* This is a PCI adapter so they are not important and are skipped.
1390	*/
1391	break;
1392	}
1393	case BUSLOGICCOMMAND_INQUIRE_EXTENDED_SETUP_INFORMATION:
1394	{
1395	/* The reply length is set by the guest and is found in the first byte of the command buffer. */
1396	pBusLogic->cbReplyParametersLeft = pBusLogic->aCommandBuffer[0];
1397	PReplyInquireExtendedSetupInformation pReply = (PReplyInquireExtendedSetupInformation)pBusLogic->aReplyBuffer;
1398	memset(pReply, 0, sizeof(ReplyInquireExtendedSetupInformation));
1399
1400	//@todo: should this reflect the RAM contents (AutoSCSIRam)?
1401	pReply->uBusType = 'E'; /* EISA style */
1402	pReply->u16ScatterGatherLimit = 8192;
1403	pReply->fLevelSensitiveInterrupt = true;
1404	pReply->fHostWideSCSI = true;
1405	pReply->fHostUltraSCSI = true;
1406	memcpy(pReply->aFirmwareRevision, "07B", sizeof(pReply->aFirmwareRevision));
1407
1408	break;
1409	}
1410	case BUSLOGICCOMMAND_INQUIRE_SETUP_INFORMATION:
1411	{
1412	/* The reply length is set by the guest and is found in the first byte of the command buffer. */
1413	pBusLogic->cbReplyParametersLeft = pBusLogic->aCommandBuffer[0];
1414	PReplyInquireSetupInformation pReply = (PReplyInquireSetupInformation)pBusLogic->aReplyBuffer;
1415	memset(pReply, 0, sizeof(ReplyInquireSetupInformation));
1416	break;
1417	}
1418	case BUSLOGICCOMMAND_FETCH_HOST_ADAPTER_LOCAL_RAM:
1419	{
1420	/*
1421	* First element in the command buffer contains start offset to read from
1422	* and second one the number of bytes to read.
1423	*/
1424	uint8_t uOffset = pBusLogic->aCommandBuffer[0];
1425	pBusLogic->cbReplyParametersLeft = pBusLogic->aCommandBuffer[1];
1426
1427	pBusLogic->fUseLocalRam = true;
1428	pBusLogic->iReply = uOffset;
1429	break;
1430	}
1431	case BUSLOGICCOMMAND_INITIALIZE_EXTENDED_MAILBOX:
1432	{
1433	PRequestInitializeExtendedMailbox pRequest = (PRequestInitializeExtendedMailbox)pBusLogic->aCommandBuffer;
1434
1435	pBusLogic->cMailbox = pRequest->cMailbox;
1436	pBusLogic->GCPhysAddrMailboxOutgoingBase = (RTGCPHYS)pRequest->uMailboxBaseAddress;
1437	/* The area for incoming mailboxes is right after the last entry of outgoing mailboxes. */
1438	pBusLogic->GCPhysAddrMailboxIncomingBase = (RTGCPHYS)pRequest->uMailboxBaseAddress + (pBusLogic->cMailbox * sizeof(Mailbox));
1439
1440	Log(("GCPhysAddrMailboxOutgoingBase=%RGp\n", pBusLogic->GCPhysAddrMailboxOutgoingBase));
1441	Log(("GCPhysAddrMailboxOutgoingBase=%RGp\n", pBusLogic->GCPhysAddrMailboxIncomingBase));
1442	Log(("cMailboxes=%u\n", pBusLogic->cMailbox));
1443
1444	pBusLogic->regStatus &= ~BUSLOGIC_REGISTER_STATUS_INITIALIZATION_REQUIRED;
1445	pBusLogic->cbReplyParametersLeft = 0;
1446	break;
1447	}
1448	case BUSLOGICCOMMAND_ENABLE_STRICT_ROUND_ROBIN_MODE:
1449	{
1450	if (pBusLogic->aCommandBuffer[0] == 0)
1451	pBusLogic->fStrictRoundRobinMode = false;
1452	else if (pBusLogic->aCommandBuffer[0] == 1)
1453	pBusLogic->fStrictRoundRobinMode = true;
1454	else
1455	AssertMsgFailed(("Invalid round robin mode %d\n", pBusLogic->aCommandBuffer[0]));
1456
1457	pBusLogic->cbReplyParametersLeft = 0;
1458	break;
1459	}
1460	case BUSLOGICCOMMAND_SET_CCB_FORMAT:
1461	{
1462	if (pBusLogic->aCommandBuffer[0] == 0)
1463	pBusLogic->fExtendedLunCCBFormat = false;
1464	else if (pBusLogic->aCommandBuffer[0] == 1)
1465	pBusLogic->fExtendedLunCCBFormat = true;
1466	else
1467	AssertMsgFailed(("Invalid CCB format %d\n", pBusLogic->aCommandBuffer[0]));
1468
1469	pBusLogic->cbReplyParametersLeft = 0;
1470	break;
1471	}
1472	case BUSLOGICCOMMAND_INQUIRE_TARGET_DEVICES:
1473	{
1474	/* Each bit which is set in the 16bit wide variable means a present device. */
1475	uint16_t u16TargetsPresentMask = 0;
1476
1477	for (uint8_t i = 0; i < RT_ELEMENTS(pBusLogic->aDeviceStates); i++)
1478	{
1479	if (pBusLogic->aDeviceStates[i].fPresent)
1480	u16TargetsPresentMask \|= (1 << i);
1481	}
1482	pBusLogic->aReplyBuffer[0] = (uint8_t)u16TargetsPresentMask;
1483	pBusLogic->aReplyBuffer[1] = (uint8_t)(u16TargetsPresentMask >> 8);
1484	pBusLogic->cbReplyParametersLeft = 2;
1485	break;
1486	}
1487	case BUSLOGICCOMMAND_INQUIRE_SYNCHRONOUS_PERIOD:
1488	{
1489	pBusLogic->cbReplyParametersLeft = pBusLogic->aCommandBuffer[0];
1490
1491	for (uint8_t i = 0; i < pBusLogic->cbReplyParametersLeft; i++)
1492	pBusLogic->aReplyBuffer[i] = 0; /* @todo Figure if we need something other here. It's not needed for the linux driver */
1493
1494	break;
1495	}
1496	case BUSLOGICCOMMAND_DISABLE_HOST_ADAPTER_INTERRUPT:
1497	{
1498	if (pBusLogic->aCommandBuffer[0] == 0)
1499	pBusLogic->fIRQEnabled = false;
1500	else
1501	pBusLogic->fIRQEnabled = true;
1502	/* No interrupt signaled regardless of enable/disable. */
1503	fSuppressIrq = true;
1504	break;
1505	}
1506	case BUSLOGICCOMMAND_ECHO_COMMAND_DATA:
1507	{
1508	pBusLogic->aReplyBuffer[0] = pBusLogic->aCommandBuffer[0];
1509	pBusLogic->cbReplyParametersLeft = 1;
1510	break;
1511	}
1512	case BUSLOGICCOMMAND_SET_PREEMPT_TIME_ON_BUS:
1513	{
1514	pBusLogic->cbReplyParametersLeft = 0;
1515	pBusLogic->LocalRam.structured.autoSCSIData.uBusOnDelay = pBusLogic->aCommandBuffer[0];
1516	Log(("Bus-on time: %d\n", pBusLogic->aCommandBuffer[0]));
1517	break;
1518	}
1519	case BUSLOGICCOMMAND_SET_TIME_OFF_BUS:
1520	{
1521	pBusLogic->cbReplyParametersLeft = 0;
1522	pBusLogic->LocalRam.structured.autoSCSIData.uBusOffDelay = pBusLogic->aCommandBuffer[0];
1523	Log(("Bus-off time: %d\n", pBusLogic->aCommandBuffer[0]));
1524	break;
1525	}
1526	case BUSLOGICCOMMAND_EXT_BIOS_INFO:
1527	case BUSLOGICCOMMAND_UNLOCK_MAILBOX:
1528	/* Commands valid for Adaptec 154xC which we don't handle since
1529	* we pretend being 154xB compatible. Just mark the command as invalid.
1530	*/
1531	Log(("Command %#x not valid for this adapter\n", pBusLogic->uOperationCode));
1532	pBusLogic->cbReplyParametersLeft = 0;
1533	pBusLogic->regStatus \|= BUSLOGIC_REGISTER_STATUS_COMMAND_INVALID;
1534	break;
1535	case BUSLOGICCOMMAND_EXECUTE_MAILBOX_COMMAND: /* Should be handled already. */
1536	default:
1537	AssertMsgFailed(("Invalid command %#x\n", pBusLogic->uOperationCode));
1538	}
1539
1540	Log(("uOperationCode=%#x, cbReplyParametersLeft=%d\n", pBusLogic->uOperationCode, pBusLogic->cbReplyParametersLeft));
1541
1542	/* Set the data in ready bit in the status register in case the command has a reply. */
1543	if (pBusLogic->cbReplyParametersLeft)
1544	pBusLogic->regStatus \|= BUSLOGIC_REGISTER_STATUS_DATA_IN_REGISTER_READY;
1545	else
1546	buslogicCommandComplete(pBusLogic, fSuppressIrq);
1547
1548	return rc;
1549	}
1550
1551	/**
1552	* Read a register from the BusLogic adapter.
1553	*
1554	* @returns VBox status code.
1555	* @param pBusLogic Pointer to the BusLogic instance data.
1556	* @param iRegister The index of the register to read.
1557	* @param pu32 Where to store the register content.
1558	*/
1559	static int buslogicRegisterRead(PBUSLOGIC pBusLogic, unsigned iRegister, uint32_t *pu32)
1560	{
1561	int rc = VINF_SUCCESS;
1562
1563	switch (iRegister)
1564	{
1565	case BUSLOGIC_REGISTER_STATUS:
1566	{
1567	*pu32 = pBusLogic->regStatus;
1568	/*
1569	* If the diagnostic active bit is set we are in a hard reset initiated from the guest.
1570	* The guest reads the status register and waits that the host adapter ready bit is set.
1571	*/
1572	if (pBusLogic->regStatus & BUSLOGIC_REGISTER_STATUS_DIAGNOSTIC_ACTIVE)
1573	{
1574	pBusLogic->regStatus &= ~BUSLOGIC_REGISTER_STATUS_DIAGNOSTIC_ACTIVE;
1575	pBusLogic->regStatus \|= BUSLOGIC_REGISTER_STATUS_HOST_ADAPTER_READY;
1576	}
1577	break;
1578	}
1579	case BUSLOGIC_REGISTER_DATAIN:
1580	{
1581	if (pBusLogic->fUseLocalRam)
1582	*pu32 = pBusLogic->LocalRam.u8View[pBusLogic->iReply];
1583	else
1584	*pu32 = pBusLogic->aReplyBuffer[pBusLogic->iReply];
1585
1586	pBusLogic->iReply++;
1587	pBusLogic->cbReplyParametersLeft--;
1588
1589	LogFlowFunc(("cbReplyParametersLeft=%u\n", pBusLogic->cbReplyParametersLeft));
1590	if (!pBusLogic->cbReplyParametersLeft)
1591	{
1592	/*
1593	* Reply finished, set command complete bit, unset data in ready bit and
1594	* interrupt the guest if enabled.
1595	*/
1596	buslogicCommandComplete(pBusLogic, false);
1597	}
1598	break;
1599	}
1600	case BUSLOGIC_REGISTER_INTERRUPT:
1601	{
1602	*pu32 = pBusLogic->regInterrupt;
1603	break;
1604	}
1605	case BUSLOGIC_REGISTER_GEOMETRY:
1606	{
1607	*pu32 = pBusLogic->regGeometry;
1608	break;
1609	}
1610	default:
1611	*pu32 = UINT32_C(0xffffffff);
1612	}
1613
1614	Log2(("%s: pu32=%p:{%.*Rhxs} iRegister=%d rc=%Rrc\n",
1615	__FUNCTION__, pu32, 1, pu32, iRegister, rc));
1616
1617	return rc;
1618	}
1619
1620	/**
1621	* Write a value to a register.
1622	*
1623	* @returns VBox status code.
1624	* @param pBusLogic Pointer to the BusLogic instance data.
1625	* @param iRegister The index of the register to read.
1626	* @param uVal The value to write.
1627	*/
1628	static int buslogicRegisterWrite(PBUSLOGIC pBusLogic, unsigned iRegister, uint8_t uVal)
1629	{
1630	int rc = VINF_SUCCESS;
1631
1632	switch (iRegister)
1633	{
1634	case BUSLOGIC_REGISTER_CONTROL:
1635	{
1636	rc = PDMCritSectEnter(&pBusLogic->CritSectIntr, VINF_IOM_HC_IOPORT_WRITE);
1637	if (rc != VINF_SUCCESS)
1638	return rc;
1639
1640	#ifdef LOG_ENABLED
1641	uint32_t cMailboxesReady = ASMAtomicXchgU32(&pBusLogic->cInMailboxesReady, 0);
1642	Log(("%u incoming mailboxes are ready when this interrupt was cleared\n", cMailboxesReady));
1643	#endif
1644
1645	if (uVal & BUSLOGIC_REGISTER_CONTROL_INTERRUPT_RESET)
1646	buslogicClearInterrupt(pBusLogic);
1647
1648	PDMCritSectLeave(&pBusLogic->CritSectIntr);
1649
1650	if ((uVal & BUSLOGIC_REGISTER_CONTROL_HARD_RESET) \|\| (uVal & BUSLOGIC_REGISTER_CONTROL_SOFT_RESET))
1651	{
1652	#ifdef IN_RING3
1653	buslogicIntiateHardReset(pBusLogic);
1654	#else
1655	rc = VINF_IOM_HC_IOPORT_WRITE;
1656	#endif
1657	}
1658
1659	break;
1660	}
1661	case BUSLOGIC_REGISTER_COMMAND:
1662	{
1663	/* Fast path for mailbox execution command. */
1664	if ((uVal == BUSLOGICCOMMAND_EXECUTE_MAILBOX_COMMAND) && (pBusLogic->uOperationCode == 0xff))
1665	{
1666	ASMAtomicIncU32(&pBusLogic->cMailboxesReady);
1667	if (!ASMAtomicXchgBool(&pBusLogic->fNotificationSend, true))
1668	{
1669	/* Send new notification to the queue. */
1670	PPDMQUEUEITEMCORE pItem = PDMQueueAlloc(pBusLogic->CTX_SUFF(pNotifierQueue));
1671	AssertMsg(pItem, ("Allocating item for queue failed\n"));
1672	PDMQueueInsert(pBusLogic->CTX_SUFF(pNotifierQueue), (PPDMQUEUEITEMCORE)pItem);
1673	}
1674
1675	return rc;
1676	}
1677
1678	/*
1679	* Check if we are already fetch command parameters from the guest.
1680	* If not we initialize executing a new command.
1681	*/
1682	if (pBusLogic->uOperationCode == 0xff)
1683	{
1684	pBusLogic->uOperationCode = uVal;
1685	pBusLogic->iParameter = 0;
1686
1687	/* Mark host adapter as busy and clear the invalid status bit. */
1688	pBusLogic->regStatus &= ~(BUSLOGIC_REGISTER_STATUS_HOST_ADAPTER_READY \| BUSLOGIC_REGISTER_STATUS_COMMAND_INVALID);
1689
1690	/* Get the number of bytes for parameters from the command code. */
1691	switch (pBusLogic->uOperationCode)
1692	{
1693	case BUSLOGICCOMMAND_INQUIRE_FIRMWARE_VERSION_LETTER:
1694	case BUSLOGICCOMMAND_INQUIRE_BOARD_ID:
1695	case BUSLOGICCOMMAND_INQUIRE_FIRMWARE_VERSION_3RD_LETTER:
1696	case BUSLOGICCOMMAND_INQUIRE_PCI_HOST_ADAPTER_INFORMATION:
1697	case BUSLOGICCOMMAND_INQUIRE_CONFIGURATION:
1698	case BUSLOGICCOMMAND_INQUIRE_TARGET_DEVICES:
1699	pBusLogic->cbCommandParametersLeft = 0;
1700	break;
1701	case BUSLOGICCOMMAND_MODIFY_IO_ADDRESS:
1702	case BUSLOGICCOMMAND_INQUIRE_EXTENDED_SETUP_INFORMATION:
1703	case BUSLOGICCOMMAND_INQUIRE_SETUP_INFORMATION:
1704	case BUSLOGICCOMMAND_INQUIRE_HOST_ADAPTER_MODEL_NUMBER:
1705	case BUSLOGICCOMMAND_ENABLE_STRICT_ROUND_ROBIN_MODE:
1706	case BUSLOGICCOMMAND_SET_CCB_FORMAT:
1707	case BUSLOGICCOMMAND_INQUIRE_SYNCHRONOUS_PERIOD:
1708	case BUSLOGICCOMMAND_DISABLE_HOST_ADAPTER_INTERRUPT:
1709	case BUSLOGICCOMMAND_ECHO_COMMAND_DATA:
1710	case BUSLOGICCOMMAND_SET_PREEMPT_TIME_ON_BUS:
1711	case BUSLOGICCOMMAND_SET_TIME_OFF_BUS:
1712	pBusLogic->cbCommandParametersLeft = 1;
1713	break;
1714	case BUSLOGICCOMMAND_FETCH_HOST_ADAPTER_LOCAL_RAM:
1715	pBusLogic->cbCommandParametersLeft = 2;
1716	break;
1717	case BUSLOGICCOMMAND_INITIALIZE_EXTENDED_MAILBOX:
1718	pBusLogic->cbCommandParametersLeft = sizeof(RequestInitializeExtendedMailbox);
1719	break;
1720	case BUSLOGICCOMMAND_EXT_BIOS_INFO:
1721	case BUSLOGICCOMMAND_UNLOCK_MAILBOX:
1722	/* Invalid commands. */
1723	pBusLogic->cbCommandParametersLeft = 0;
1724	break;
1725	case BUSLOGICCOMMAND_EXECUTE_MAILBOX_COMMAND: /* Should not come here anymore. */
1726	default:
1727	AssertMsgFailed(("Invalid operation code %#x\n", uVal));
1728	}
1729	}
1730	else
1731	{
1732	/*
1733	* The real adapter would set the Command register busy bit in the status register.
1734	* The guest has to wait until it is unset.
1735	* We don't need to do it because the guest does not continue execution while we are in this
1736	* function.
1737	*/
1738	pBusLogic->aCommandBuffer[pBusLogic->iParameter] = uVal;
1739	pBusLogic->iParameter++;
1740	pBusLogic->cbCommandParametersLeft--;
1741	}
1742
1743	/* Start execution of command if there are no parameters left. */
1744	if (!pBusLogic->cbCommandParametersLeft)
1745	{
1746	rc = buslogicProcessCommand(pBusLogic);
1747	AssertMsgRC(rc, ("Processing command failed rc=%Rrc\n", rc));
1748	}
1749	break;
1750	}
1751	default:
1752	AssertMsgFailed(("Register not available\n"));
1753	rc = VERR_IOM_IOPORT_UNUSED;
1754	}
1755
1756	return rc;
1757	}
1758
1759	/**
1760	* Memory mapped I/O Handler for read operations.
1761	*
1762	* @returns VBox status code.
1763	*
1764	* @param pDevIns The device instance.
1765	* @param pvUser User argument.
1766	* @param GCPhysAddr Physical address (in GC) where the read starts.
1767	* @param pv Where to store the result.
1768	* @param cb Number of bytes read.
1769	*/
1770	PDMBOTHCBDECL(int) buslogicMMIORead(PPDMDEVINS pDevIns, void *pvUser,
1771	RTGCPHYS GCPhysAddr, void *pv, unsigned cb)
1772	{
1773	/* the linux driver does not make use of the MMIO area. */
1774	AssertMsgFailed(("MMIO Read\n"));
1775	return VINF_SUCCESS;
1776	}
1777
1778	/**
1779	* Memory mapped I/O Handler for write operations.
1780	*
1781	* @returns VBox status code.
1782	*
1783	* @param pDevIns The device instance.
1784	* @param pvUser User argument.
1785	* @param GCPhysAddr Physical address (in GC) where the read starts.
1786	* @param pv Where to fetch the result.
1787	* @param cb Number of bytes to write.
1788	*/
1789	PDMBOTHCBDECL(int) buslogicMMIOWrite(PPDMDEVINS pDevIns, void *pvUser,
1790	RTGCPHYS GCPhysAddr, void const *pv, unsigned cb)
1791	{
1792	/* the linux driver does not make use of the MMIO area. */
1793	AssertMsgFailed(("MMIO Write\n"));
1794	return VINF_SUCCESS;
1795	}
1796
1797	/**
1798	* Port I/O Handler for IN operations.
1799	*
1800	* @returns VBox status code.
1801	*
1802	* @param pDevIns The device instance.
1803	* @param pvUser User argument.
1804	* @param uPort Port number used for the IN operation.
1805	* @param pu32 Where to store the result.
1806	* @param cb Number of bytes read.
1807	*/
1808	PDMBOTHCBDECL(int) buslogicIOPortRead (PPDMDEVINS pDevIns, void *pvUser,
1809	RTIOPORT Port, uint32_t *pu32, unsigned cb)
1810	{
1811	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);;
1812	unsigned iRegister = Port - pBusLogic->IOPortBase;
1813
1814	Assert(cb == 1);
1815
1816	return buslogicRegisterRead(pBusLogic, iRegister, pu32);
1817	}
1818
1819	/**
1820	* Port I/O Handler for OUT operations.
1821	*
1822	* @returns VBox status code.
1823	*
1824	* @param pDevIns The device instance.
1825	* @param pvUser User argument.
1826	* @param uPort Port number used for the IN operation.
1827	* @param u32 The value to output.
1828	* @param cb The value size in bytes.
1829	*/
1830	PDMBOTHCBDECL(int) buslogicIOPortWrite (PPDMDEVINS pDevIns, void *pvUser,
1831	RTIOPORT Port, uint32_t u32, unsigned cb)
1832	{
1833	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
1834	int rc = VINF_SUCCESS;
1835	unsigned iRegister = Port - pBusLogic->IOPortBase;
1836	uint8_t uVal = (uint8_t)u32;
1837
1838	Assert(cb == 1);
1839
1840	rc = buslogicRegisterWrite(pBusLogic, iRegister, (uint8_t)uVal);
1841
1842	Log2(("#%d %s: pvUser=%#p cb=%d u32=%#x Port=%#x rc=%Rrc\n",
1843	pDevIns->iInstance, __FUNCTION__, pvUser, cb, u32, Port, rc));
1844
1845	return rc;
1846	}
1847
1848	#ifdef IN_RING3
1849	/**
1850	* Port I/O Handler for IN operations - legacy port.
1851	*
1852	* @returns VBox status code.
1853	*
1854	* @param pDevIns The device instance.
1855	* @param pvUser User argument.
1856	* @param uPort Port number used for the IN operation.
1857	* @param pu32 Where to store the result.
1858	* @param cb Number of bytes read.
1859	*/
1860	static int buslogicIsaIOPortRead (PPDMDEVINS pDevIns, void *pvUser,
1861	RTIOPORT Port, uint32_t *pu32, unsigned cb)
1862	{
1863	int rc;
1864	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
1865
1866	Assert(cb == 1);
1867
1868	if (!pBusLogic->fISAEnabled)
1869	return VINF_SUCCESS;
1870
1871	rc = vboxscsiReadRegister(&pBusLogic->VBoxSCSI, (Port - BUSLOGIC_ISA_IO_PORT), pu32);
1872
1873	//Log2(("%s: pu32=%p:{%.*Rhxs} iRegister=%d rc=%Rrc\n",
1874	// __FUNCTION__, pu32, 1, pu32, (Port - BUSLOGIC_ISA_IO_PORT), rc));
1875
1876	return rc;
1877	}
1878
1879	static void buslogicWarningDiskFull(PPDMDEVINS pDevIns)
1880	{
1881	int rc;
1882	LogRel(("BusLogic#%d: Host disk full\n", pDevIns->iInstance));
1883	rc = PDMDevHlpVMSetRuntimeError(pDevIns, VMSETRTERR_FLAGS_SUSPEND \| VMSETRTERR_FLAGS_NO_WAIT, "DevBusLogic_DISKFULL",
1884	N_("Host system reported disk full. VM execution is suspended. You can resume after freeing some space"));
1885	AssertRC(rc);
1886	}
1887
1888	static void buslogicWarningFileTooBig(PPDMDEVINS pDevIns)
1889	{
1890	int rc;
1891	LogRel(("BusLogic#%d: File too big\n", pDevIns->iInstance));
1892	rc = PDMDevHlpVMSetRuntimeError(pDevIns, VMSETRTERR_FLAGS_SUSPEND \| VMSETRTERR_FLAGS_NO_WAIT, "DevBusLogic_FILETOOBIG",
1893	N_("Host system reported that the file size limit of the host file system has been exceeded. VM execution is suspended. You need to move your virtual hard disk to a filesystem which allows bigger files"));
1894	AssertRC(rc);
1895	}
1896
1897	static void buslogicWarningISCSI(PPDMDEVINS pDevIns)
1898	{
1899	int rc;
1900	LogRel(("BusLogic#%d: iSCSI target unavailable\n", pDevIns->iInstance));
1901	rc = PDMDevHlpVMSetRuntimeError(pDevIns, VMSETRTERR_FLAGS_SUSPEND \| VMSETRTERR_FLAGS_NO_WAIT, "DevBusLogic_ISCSIDOWN",
1902	N_("The iSCSI target has stopped responding. VM execution is suspended. You can resume when it is available again"));
1903	AssertRC(rc);
1904	}
1905
1906	static void buslogicWarningUnknown(PPDMDEVINS pDevIns, int rc)
1907	{
1908	int rc2;
1909	LogRel(("BusLogic#%d: Unknown but recoverable error has occurred (rc=%Rrc)\n", pDevIns->iInstance, rc));
1910	rc2 = PDMDevHlpVMSetRuntimeError(pDevIns, VMSETRTERR_FLAGS_SUSPEND \| VMSETRTERR_FLAGS_NO_WAIT, "DevBusLogic_UNKNOWN",
1911	N_("An unknown but recoverable I/O error has occurred (rc=%Rrc). VM execution is suspended. You can resume when the error is fixed"), rc);
1912	AssertRC(rc2);
1913	}
1914
1915	static void buslogicRedoSetWarning(PBUSLOGIC pThis, int rc)
1916	{
1917	if (rc == VERR_DISK_FULL)
1918	buslogicWarningDiskFull(pThis->CTX_SUFF(pDevIns));
1919	else if (rc == VERR_FILE_TOO_BIG)
1920	buslogicWarningFileTooBig(pThis->CTX_SUFF(pDevIns));
1921	else if (rc == VERR_BROKEN_PIPE \|\| rc == VERR_NET_CONNECTION_REFUSED)
1922	{
1923	/* iSCSI connection abort (first error) or failure to reestablish
1924	* connection (second error). Pause VM. On resume we'll retry. */
1925	buslogicWarningISCSI(pThis->CTX_SUFF(pDevIns));
1926	}
1927	else
1928	buslogicWarningUnknown(pThis->CTX_SUFF(pDevIns), rc);
1929	}
1930
1931
1932	static int buslogicPrepareBIOSSCSIRequest(PBUSLOGIC pBusLogic)
1933	{
1934	int rc;
1935	PBUSLOGICTASKSTATE pTaskState;
1936	uint32_t uTargetDevice;
1937
1938	rc = RTMemCacheAllocEx(pBusLogic->hTaskCache, (void **)&pTaskState);
1939	AssertMsgRCReturn(rc, ("Getting task from cache failed rc=%Rrc\n", rc), rc);
1940
1941	pTaskState->fBIOS = true;
1942
1943	rc = vboxscsiSetupRequest(&pBusLogic->VBoxSCSI, &pTaskState->PDMScsiRequest, &uTargetDevice);
1944	AssertMsgRCReturn(rc, ("Setting up SCSI request failed rc=%Rrc\n", rc), rc);
1945
1946	pTaskState->PDMScsiRequest.pvUser = pTaskState;
1947
1948	pTaskState->CTX_SUFF(pTargetDevice) = &pBusLogic->aDeviceStates[uTargetDevice];
1949
1950	if (!pTaskState->CTX_SUFF(pTargetDevice)->fPresent)
1951	{
1952	/* Device is not present. */
1953	AssertMsg(pTaskState->PDMScsiRequest.pbCDB[0] == SCSI_INQUIRY,
1954	("Device is not present but command is not inquiry\n"));
1955
1956	SCSIINQUIRYDATA ScsiInquiryData;
1957
1958	memset(&ScsiInquiryData, 0, sizeof(SCSIINQUIRYDATA));
1959	ScsiInquiryData.u5PeripheralDeviceType = SCSI_INQUIRY_DATA_PERIPHERAL_DEVICE_TYPE_UNKNOWN;
1960	ScsiInquiryData.u3PeripheralQualifier = SCSI_INQUIRY_DATA_PERIPHERAL_QUALIFIER_NOT_CONNECTED_NOT_SUPPORTED;
1961
1962	memcpy(pBusLogic->VBoxSCSI.pBuf, &ScsiInquiryData, 5);
1963
1964	rc = vboxscsiRequestFinished(&pBusLogic->VBoxSCSI, &pTaskState->PDMScsiRequest);
1965	AssertMsgRCReturn(rc, ("Finishing BIOS SCSI request failed rc=%Rrc\n", rc), rc);
1966
1967	RTMemCacheFree(pBusLogic->hTaskCache, pTaskState);
1968	}
1969	else
1970	{
1971	LogFlowFunc(("before increment %u\n", pTaskState->CTX_SUFF(pTargetDevice)->cOutstandingRequests));
1972	ASMAtomicIncU32(&pTaskState->CTX_SUFF(pTargetDevice)->cOutstandingRequests);
1973	LogFlowFunc(("after increment %u\n", pTaskState->CTX_SUFF(pTargetDevice)->cOutstandingRequests));
1974
1975	rc = pTaskState->CTX_SUFF(pTargetDevice)->pDrvSCSIConnector->pfnSCSIRequestSend(pTaskState->CTX_SUFF(pTargetDevice)->pDrvSCSIConnector,
1976	&pTaskState->PDMScsiRequest);
1977	AssertMsgRC(rc, ("Sending request to SCSI layer failed rc=%Rrc\n", rc));
1978	}
1979
1980	return rc;
1981	}
1982
1983	/**
1984	* Port I/O Handler for OUT operations - legacy port.
1985	*
1986	* @returns VBox status code.
1987	*
1988	* @param pDevIns The device instance.
1989	* @param pvUser User argument.
1990	* @param uPort Port number used for the IN operation.
1991	* @param u32 The value to output.
1992	* @param cb The value size in bytes.
1993	*/
1994	static int buslogicIsaIOPortWrite (PPDMDEVINS pDevIns, void *pvUser,
1995	RTIOPORT Port, uint32_t u32, unsigned cb)
1996	{
1997	int rc;
1998	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
1999
2000	Log2(("#%d %s: pvUser=%#p cb=%d u32=%#x Port=%#x\n",
2001	pDevIns->iInstance, __FUNCTION__, pvUser, cb, u32, Port));
2002
2003	Assert(cb == 1);
2004
2005	if (!pBusLogic->fISAEnabled)
2006	return VINF_SUCCESS;
2007
2008	rc = vboxscsiWriteRegister(&pBusLogic->VBoxSCSI, (Port - BUSLOGIC_ISA_IO_PORT), (uint8_t)u32);
2009	if (rc == VERR_MORE_DATA)
2010	{
2011	rc = buslogicPrepareBIOSSCSIRequest(pBusLogic);
2012	AssertRC(rc);
2013	}
2014	else if (RT_FAILURE(rc))
2015	AssertMsgFailed(("Writing BIOS register failed %Rrc\n", rc));
2016
2017	return VINF_SUCCESS;
2018	}
2019
2020	/**
2021	* Port I/O Handler for primary port range OUT string operations.
2022	* @see FNIOMIOPORTOUTSTRING for details.
2023	*/
2024	static DECLCALLBACK(int) buslogicIsaIOPortWriteStr(PPDMDEVINS pDevIns, void pvUser, RTIOPORT Port, RTGCPTR pGCPtrSrc, PRTGCUINTREG pcTransfer, unsigned cb)
2025	{
2026	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2027	int rc;
2028
2029	Log2(("#%d %s: pvUser=%#p cb=%d Port=%#x\n",
2030	pDevIns->iInstance, __FUNCTION__, pvUser, cb, Port));
2031
2032	rc = vboxscsiWriteString(pDevIns, &pBusLogic->VBoxSCSI, (Port - BUSLOGIC_ISA_IO_PORT),
2033	pGCPtrSrc, pcTransfer, cb);
2034	if (rc == VERR_MORE_DATA)
2035	{
2036	rc = buslogicPrepareBIOSSCSIRequest(pBusLogic);
2037	AssertRC(rc);
2038	}
2039	else if (RT_FAILURE(rc))
2040	AssertMsgFailed(("Writing BIOS register failed %Rrc\n", rc));
2041
2042	return rc;
2043	}
2044
2045	/**
2046	* Port I/O Handler for primary port range IN string operations.
2047	* @see FNIOMIOPORTINSTRING for details.
2048	*/
2049	static DECLCALLBACK(int) buslogicIsaIOPortReadStr(PPDMDEVINS pDevIns, void pvUser, RTIOPORT Port, RTGCPTR pGCPtrDst, PRTGCUINTREG pcTransfer, unsigned cb)
2050	{
2051	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2052
2053	LogFlowFunc(("#%d %s: pvUser=%#p cb=%d Port=%#x\n",
2054	pDevIns->iInstance, __FUNCTION__, pvUser, cb, Port));
2055
2056	return vboxscsiReadString(pDevIns, &pBusLogic->VBoxSCSI, (Port - BUSLOGIC_ISA_IO_PORT),
2057	pGCPtrDst, pcTransfer, cb);
2058	}
2059
2060	static DECLCALLBACK(int) buslogicMMIOMap(PPCIDEVICE pPciDev, /unsigned/ int iRegion,
2061	RTGCPHYS GCPhysAddress, uint32_t cb,
2062	PCIADDRESSSPACE enmType)
2063	{
2064	PPDMDEVINS pDevIns = pPciDev->pDevIns;
2065	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2066	int rc = VINF_SUCCESS;
2067
2068	Log2(("%s: registering MMIO area at GCPhysAddr=%RGp cb=%u\n", __FUNCTION__, GCPhysAddress, cb));
2069
2070	Assert(cb >= 32);
2071
2072	if (enmType == PCI_ADDRESS_SPACE_MEM)
2073	{
2074	/* We use the assigned size here, because we currently only support page aligned MMIO ranges. */
2075	rc = PDMDevHlpMMIORegister(pDevIns, GCPhysAddress, cb, NULL,
2076	buslogicMMIOWrite, buslogicMMIORead, NULL, "BusLogic");
2077	if (RT_FAILURE(rc))
2078	return rc;
2079
2080	if (pThis->fR0Enabled)
2081	{
2082	rc = PDMDevHlpMMIORegisterR0(pDevIns, GCPhysAddress, cb, 0,
2083	"buslogicMMIOWrite", "buslogicMMIORead", NULL);
2084	if (RT_FAILURE(rc))
2085	return rc;
2086	}
2087
2088	if (pThis->fGCEnabled)
2089	{
2090	rc = PDMDevHlpMMIORegisterRC(pDevIns, GCPhysAddress, cb, 0,
2091	"buslogicMMIOWrite", "buslogicMMIORead", NULL);
2092	if (RT_FAILURE(rc))
2093	return rc;
2094	}
2095
2096	pThis->MMIOBase = GCPhysAddress;
2097	}
2098	else if (enmType == PCI_ADDRESS_SPACE_IO)
2099	{
2100	rc = PDMDevHlpIOPortRegister(pDevIns, (RTIOPORT)GCPhysAddress, 32,
2101	NULL, buslogicIOPortWrite, buslogicIOPortRead, NULL, NULL, "BusLogic");
2102	if (RT_FAILURE(rc))
2103	return rc;
2104
2105	if (pThis->fR0Enabled)
2106	{
2107	rc = PDMDevHlpIOPortRegisterR0(pDevIns, (RTIOPORT)GCPhysAddress, 32,
2108	0, "buslogicIOPortWrite", "buslogicIOPortRead", NULL, NULL, "BusLogic");
2109	if (RT_FAILURE(rc))
2110	return rc;
2111	}
2112
2113	if (pThis->fGCEnabled)
2114	{
2115	rc = PDMDevHlpIOPortRegisterRC(pDevIns, (RTIOPORT)GCPhysAddress, 32,
2116	0, "buslogicIOPortWrite", "buslogicIOPortRead", NULL, NULL, "BusLogic");
2117	if (RT_FAILURE(rc))
2118	return rc;
2119	}
2120
2121	pThis->IOPortBase = (RTIOPORT)GCPhysAddress;
2122	}
2123	else
2124	AssertMsgFailed(("Invalid enmType=%d\n", enmType));
2125
2126	return rc;
2127	}
2128
2129	static DECLCALLBACK(int) buslogicDeviceSCSIRequestCompleted(PPDMISCSIPORT pInterface, PPDMSCSIREQUEST pSCSIRequest,
2130	int rcCompletion, bool fRedo, int rcReq)
2131	{
2132	int rc;
2133	PBUSLOGICTASKSTATE pTaskState = (PBUSLOGICTASKSTATE)pSCSIRequest->pvUser;
2134	PBUSLOGICDEVICE pBusLogicDevice = pTaskState->CTX_SUFF(pTargetDevice);
2135	PBUSLOGIC pBusLogic = pBusLogicDevice->CTX_SUFF(pBusLogic);
2136
2137	LogFlowFunc(("before decrement %u\n", pBusLogicDevice->cOutstandingRequests));
2138	ASMAtomicDecU32(&pBusLogicDevice->cOutstandingRequests);
2139	LogFlowFunc(("after decrement %u\n", pBusLogicDevice->cOutstandingRequests));
2140
2141	if (fRedo)
2142	{
2143	if (!pTaskState->fBIOS)
2144	{
2145	buslogicDataBufferFree(pTaskState);
2146
2147	if (pTaskState->pbSenseBuffer)
2148	buslogicSenseBufferFree(pTaskState, false /* fCopy */);
2149	}
2150
2151	/* Add to the list. */
2152	do
2153	{
2154	pTaskState->pRedoNext = ASMAtomicReadPtrT(&pBusLogic->pTasksRedoHead, PBUSLOGICTASKSTATE);
2155	} while (!ASMAtomicCmpXchgPtr(&pBusLogic->pTasksRedoHead, pTaskState, pTaskState->pRedoNext));
2156
2157	/* Suspend the VM if not done already. */
2158	if (!ASMAtomicXchgBool(&pBusLogic->fRedo, true))
2159	buslogicRedoSetWarning(pBusLogic, rcReq);
2160	}
2161	else
2162	{
2163	if (pTaskState->fBIOS)
2164	{
2165	rc = vboxscsiRequestFinished(&pBusLogic->VBoxSCSI, pSCSIRequest);
2166	AssertMsgRC(rc, ("Finishing BIOS SCSI request failed rc=%Rrc\n", rc));
2167	}
2168	else
2169	{
2170	buslogicDataBufferFree(pTaskState);
2171
2172	if (pTaskState->pbSenseBuffer)
2173	buslogicSenseBufferFree(pTaskState, (rcCompletion != SCSI_STATUS_OK));
2174
2175	buslogicSendIncomingMailbox(pBusLogic, pTaskState,
2176	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_CMD_COMPLETED,
2177	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_OPERATION_GOOD,
2178	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_WITHOUT_ERROR);
2179	}
2180
2181	/* Add task to the cache. */
2182	RTMemCacheFree(pBusLogic->hTaskCache, pTaskState);
2183	}
2184
2185	if (pBusLogicDevice->cOutstandingRequests == 0 && pBusLogic->fSignalIdle)
2186	PDMDevHlpAsyncNotificationCompleted(pBusLogic->pDevInsR3);
2187
2188	return VINF_SUCCESS;
2189	}
2190
2191	static DECLCALLBACK(int) buslogicQueryDeviceLocation(PPDMISCSIPORT pInterface, const char **ppcszController,
2192	uint32_t piInstance, uint32_t piLUN)
2193	{
2194	PBUSLOGICDEVICE pBusLogicDevice = PDMISCSIPORT_2_PBUSLOGICDEVICE(pInterface);
2195	PPDMDEVINS pDevIns = pBusLogicDevice->CTX_SUFF(pBusLogic)->CTX_SUFF(pDevIns);
2196
2197	AssertPtrReturn(ppcszController, VERR_INVALID_POINTER);
2198	AssertPtrReturn(piInstance, VERR_INVALID_POINTER);
2199	AssertPtrReturn(piLUN, VERR_INVALID_POINTER);
2200
2201	*ppcszController = pDevIns->pReg->szName;
2202	*piInstance = pDevIns->iInstance;
2203	*piLUN = pBusLogicDevice->iLUN;
2204
2205	return VINF_SUCCESS;
2206	}
2207
2208	static int buslogicDeviceSCSIRequestSetup(PBUSLOGIC pBusLogic, PBUSLOGICTASKSTATE pTaskState)
2209	{
2210	int rc = VINF_SUCCESS;
2211
2212	/* Fetch CCB. */
2213	RTGCPHYS GCPhysAddrCCB = (RTGCPHYS)pTaskState->MailboxGuest.u32PhysAddrCCB;
2214	PDMDevHlpPhysRead(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrCCB,
2215	&pTaskState->CommandControlBlockGuest, sizeof(CommandControlBlock));
2216
2217	PBUSLOGICDEVICE pTargetDevice = &pBusLogic->aDeviceStates[pTaskState->CommandControlBlockGuest.uTargetId];
2218	pTaskState->CTX_SUFF(pTargetDevice) = pTargetDevice;
2219
2220	#ifdef DEBUG
2221	buslogicDumpCCBInfo(&pTaskState->CommandControlBlockGuest);
2222	#endif
2223
2224	/* Alloc required buffers. */
2225	rc = buslogicDataBufferAlloc(pTaskState);
2226	AssertMsgRC(rc, ("Alloc failed rc=%Rrc\n", rc));
2227
2228	if (pTaskState->CommandControlBlockGuest.cbSenseData)
2229	{
2230	rc = buslogicSenseBufferAlloc(pTaskState);
2231	AssertMsgRC(rc, ("Mapping sense buffer failed rc=%Rrc\n", rc));
2232	}
2233
2234	/* Check if device is present on bus. If not return error immediately and don't process this further. */
2235	if (!pBusLogic->aDeviceStates[pTaskState->CommandControlBlockGuest.uTargetId].fPresent)
2236	{
2237	buslogicDataBufferFree(pTaskState);
2238
2239	if (pTaskState->pbSenseBuffer)
2240	buslogicSenseBufferFree(pTaskState, true);
2241
2242	buslogicSendIncomingMailbox(pBusLogic, pTaskState,
2243	BUSLOGIC_MAILBOX_INCOMING_ADAPTER_STATUS_SCSI_SELECTION_TIMEOUT,
2244	BUSLOGIC_MAILBOX_INCOMING_DEVICE_STATUS_OPERATION_GOOD,
2245	BUSLOGIC_MAILBOX_INCOMING_COMPLETION_WITH_ERROR);
2246
2247	RTMemCacheFree(pBusLogic->hTaskCache, pTaskState);
2248	}
2249	else
2250	{
2251	/* Setup SCSI request. */
2252	pTaskState->PDMScsiRequest.uLogicalUnit = pTaskState->CommandControlBlockGuest.uLogicalUnit;
2253
2254	if (pTaskState->CommandControlBlockGuest.uDataDirection == BUSLOGIC_CCB_DIRECTION_UNKNOWN)
2255	pTaskState->PDMScsiRequest.uDataDirection = PDMSCSIREQUESTTXDIR_UNKNOWN;
2256	else if (pTaskState->CommandControlBlockGuest.uDataDirection == BUSLOGIC_CCB_DIRECTION_IN)
2257	pTaskState->PDMScsiRequest.uDataDirection = PDMSCSIREQUESTTXDIR_FROM_DEVICE;
2258	else if (pTaskState->CommandControlBlockGuest.uDataDirection == BUSLOGIC_CCB_DIRECTION_OUT)
2259	pTaskState->PDMScsiRequest.uDataDirection = PDMSCSIREQUESTTXDIR_TO_DEVICE;
2260	else if (pTaskState->CommandControlBlockGuest.uDataDirection == BUSLOGIC_CCB_DIRECTION_NO_DATA)
2261	pTaskState->PDMScsiRequest.uDataDirection = PDMSCSIREQUESTTXDIR_NONE;
2262	else
2263	AssertMsgFailed(("Invalid data direction type %d\n", pTaskState->CommandControlBlockGuest.uDataDirection));
2264
2265	pTaskState->PDMScsiRequest.cbCDB = pTaskState->CommandControlBlockGuest.cbCDB;
2266	pTaskState->PDMScsiRequest.pbCDB = pTaskState->CommandControlBlockGuest.aCDB;
2267	if (pTaskState->DataSeg.cbSeg)
2268	{
2269	pTaskState->PDMScsiRequest.cbScatterGather = pTaskState->DataSeg.cbSeg;
2270	pTaskState->PDMScsiRequest.cScatterGatherEntries = 1;
2271	pTaskState->PDMScsiRequest.paScatterGatherHead = &pTaskState->DataSeg;
2272	}
2273	else
2274	{
2275	pTaskState->PDMScsiRequest.cbScatterGather = 0;
2276	pTaskState->PDMScsiRequest.cScatterGatherEntries = 0;
2277	pTaskState->PDMScsiRequest.paScatterGatherHead = NULL;
2278	}
2279	pTaskState->PDMScsiRequest.cbSenseBuffer = pTaskState->CommandControlBlockGuest.cbSenseData;
2280	pTaskState->PDMScsiRequest.pbSenseBuffer = pTaskState->pbSenseBuffer;
2281	pTaskState->PDMScsiRequest.pvUser = pTaskState;
2282
2283	ASMAtomicIncU32(&pTargetDevice->cOutstandingRequests);
2284	rc = pTargetDevice->pDrvSCSIConnector->pfnSCSIRequestSend(pTargetDevice->pDrvSCSIConnector, &pTaskState->PDMScsiRequest);
2285	AssertMsgRC(rc, ("Sending request to SCSI layer failed rc=%Rrc\n", rc));
2286	}
2287
2288	return rc;
2289	}
2290
2291	/**
2292	* Read mailbox from the guest and execute command.
2293	*
2294	* @returns VBox status code.
2295	* @param pBusLogic Pointer to the BusLogic instance data.
2296	*/
2297	static int buslogicProcessMailboxNext(PBUSLOGIC pBusLogic)
2298	{
2299	PBUSLOGICTASKSTATE pTaskState = NULL;
2300	RTGCPHYS GCPhysAddrMailboxCurrent;
2301	int rc;
2302
2303	rc = RTMemCacheAllocEx(pBusLogic->hTaskCache, (void **)&pTaskState);
2304	AssertMsgReturn(RT_SUCCESS(rc) && (pTaskState != NULL), ("Failed to get task state from cache\n"), rc);
2305
2306	pTaskState->fBIOS = false;
2307
2308	if (!pBusLogic->fStrictRoundRobinMode)
2309	{
2310	/* Search for a filled mailbox - stop if we have scanned all mailboxes. */
2311	uint8_t uMailboxPosCur = pBusLogic->uMailboxOutgoingPositionCurrent;
2312
2313	do
2314	{
2315	/* Fetch mailbox from guest memory. */
2316	GCPhysAddrMailboxCurrent = buslogicOutgoingMailboxGetGCPhys(pBusLogic);
2317
2318	PDMDevHlpPhysRead(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrMailboxCurrent,
2319	&pTaskState->MailboxGuest, sizeof(Mailbox));
2320
2321	/* Check the next mailbox. */
2322	buslogicOutgoingMailboxAdvance(pBusLogic);
2323	} while ( pTaskState->MailboxGuest.u.out.uActionCode == BUSLOGIC_MAILBOX_OUTGOING_ACTION_FREE
2324	&& uMailboxPosCur != pBusLogic->uMailboxOutgoingPositionCurrent);
2325	}
2326	else
2327	{
2328	/* Fetch mailbox from guest memory. */
2329	GCPhysAddrMailboxCurrent = buslogicOutgoingMailboxGetGCPhys(pBusLogic);
2330
2331	PDMDevHlpPhysRead(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrMailboxCurrent,
2332	&pTaskState->MailboxGuest, sizeof(Mailbox));
2333	}
2334
2335	/*
2336	* Check if the mailbox is actually loaded.
2337	* It might be possible that the guest notified us without
2338	* a loaded mailbox. Do nothing in that case but leave a
2339	* log entry.
2340	*/
2341	if (pTaskState->MailboxGuest.u.out.uActionCode == BUSLOGIC_MAILBOX_OUTGOING_ACTION_FREE)
2342	{
2343	Log(("No loaded mailbox left\n"));
2344	RTMemCacheFree(pBusLogic->hTaskCache, pTaskState);
2345	return VERR_NO_DATA;
2346	}
2347
2348	LogFlow(("Got loaded mailbox at slot %u, CCB phys %RGp\n", pBusLogic->uMailboxOutgoingPositionCurrent, pTaskState->MailboxGuest.u32PhysAddrCCB));
2349	#ifdef DEBUG
2350	buslogicDumpMailboxInfo(&pTaskState->MailboxGuest, true);
2351	#endif
2352
2353	/* We got the mailbox, mark it as free in the guest. */
2354	uint8_t uActionCode = BUSLOGIC_MAILBOX_OUTGOING_ACTION_FREE;
2355	PDMDevHlpPhysWrite(pBusLogic->CTX_SUFF(pDevIns), GCPhysAddrMailboxCurrent + RT_OFFSETOF(Mailbox, u.out.uActionCode), &uActionCode, sizeof(uActionCode));
2356
2357	if (pTaskState->MailboxGuest.u.out.uActionCode == BUSLOGIC_MAILBOX_OUTGOING_ACTION_START_COMMAND)
2358	rc = buslogicDeviceSCSIRequestSetup(pBusLogic, pTaskState);
2359	else if (pTaskState->MailboxGuest.u.out.uActionCode == BUSLOGIC_MAILBOX_OUTGOING_ACTION_ABORT_COMMAND)
2360	{
2361	AssertMsgFailed(("Not implemented yet\n"));
2362	}
2363	else
2364	AssertMsgFailed(("Invalid outgoing mailbox action code %u\n", pTaskState->MailboxGuest.u.out.uActionCode));
2365
2366	AssertRC(rc);
2367
2368	/* Advance to the next mailbox. */
2369	if (pBusLogic->fStrictRoundRobinMode)
2370	buslogicOutgoingMailboxAdvance(pBusLogic);
2371
2372	return rc;
2373	}
2374
2375	/**
2376	* Transmit queue consumer
2377	* Queue a new async task.
2378	*
2379	* @returns Success indicator.
2380	* If false the item will not be removed and the flushing will stop.
2381	* @param pDevIns The device instance.
2382	* @param pItem The item to consume. Upon return this item will be freed.
2383	*/
2384	static DECLCALLBACK(bool) buslogicNotifyQueueConsumer(PPDMDEVINS pDevIns, PPDMQUEUEITEMCORE pItem)
2385	{
2386	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2387
2388	/* Reset notification send flag now. */
2389	Assert(pBusLogic->fNotificationSend);
2390	ASMAtomicXchgBool(&pBusLogic->fNotificationSend, false);
2391	ASMAtomicXchgU32(&pBusLogic->cMailboxesReady, 0); /* @todo: Actually not required anymore but to stay compatible with older saved states. */
2392
2393	/* Process mailboxes. */
2394	int rc;
2395	do
2396	{
2397	rc = buslogicProcessMailboxNext(pBusLogic);
2398	AssertMsg(RT_SUCCESS(rc) \|\| rc == VERR_NO_DATA, ("Processing mailbox failed rc=%Rrc\n", rc));
2399	} while (RT_SUCCESS(rc));
2400
2401	return true;
2402	}
2403
2404	/**
2405	* Kicks the controller to process pending tasks after the VM was resumed
2406	* or loaded from a saved state.
2407	*
2408	* @returns nothing.
2409	* @param pThis The LsiLogic device instance.
2410	*/
2411	static void buslogicKick(PBUSLOGIC pThis)
2412	{
2413	if (pThis->fRedo)
2414	{
2415	pThis->fRedo = false;
2416	if (pThis->VBoxSCSI.fBusy)
2417	{
2418
2419	/* The BIOS had a request active when we got suspended. Resume it. */
2420	int rc = buslogicPrepareBIOSSCSIRequest(pThis);
2421	AssertRC(rc);
2422	}
2423	else
2424	{
2425	/* Queue all pending tasks again. */
2426	PBUSLOGICTASKSTATE pTaskState = pThis->pTasksRedoHead;
2427
2428	pThis->pTasksRedoHead = NULL;
2429
2430	while (pTaskState)
2431	{
2432	PBUSLOGICTASKSTATE pCur = pTaskState;
2433
2434	int rc = buslogicDeviceSCSIRequestSetup(pThis, pCur);
2435	AssertRC(rc);
2436
2437	pTaskState = pTaskState->pRedoNext;
2438	}
2439	}
2440	}
2441	}
2442
2443	static DECLCALLBACK(int) buslogicLiveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uPass)
2444	{
2445	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2446
2447	/* Save the device config. */
2448	for (unsigned i = 0; i < RT_ELEMENTS(pThis->aDeviceStates); i++)
2449	SSMR3PutBool(pSSM, pThis->aDeviceStates[i].fPresent);
2450
2451	return VINF_SSM_DONT_CALL_AGAIN;
2452	}
2453
2454	static DECLCALLBACK(int) buslogicSaveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
2455	{
2456	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2457
2458	/* Every device first. */
2459	for (unsigned i = 0; i < RT_ELEMENTS(pBusLogic->aDeviceStates); i++)
2460	{
2461	PBUSLOGICDEVICE pDevice = &pBusLogic->aDeviceStates[i];
2462
2463	AssertMsg(!pDevice->cOutstandingRequests,
2464	("There are still outstanding requests on this device\n"));
2465	SSMR3PutBool(pSSM, pDevice->fPresent);
2466	SSMR3PutU32(pSSM, pDevice->cOutstandingRequests);
2467	}
2468	/* Now the main device state. */
2469	SSMR3PutU8 (pSSM, pBusLogic->regStatus);
2470	SSMR3PutU8 (pSSM, pBusLogic->regInterrupt);
2471	SSMR3PutU8 (pSSM, pBusLogic->regGeometry);
2472	SSMR3PutMem (pSSM, &pBusLogic->LocalRam, sizeof(pBusLogic->LocalRam));
2473	SSMR3PutU8 (pSSM, pBusLogic->uOperationCode);
2474	SSMR3PutMem (pSSM, &pBusLogic->aCommandBuffer, sizeof(pBusLogic->aCommandBuffer));
2475	SSMR3PutU8 (pSSM, pBusLogic->iParameter);
2476	SSMR3PutU8 (pSSM, pBusLogic->cbCommandParametersLeft);
2477	SSMR3PutBool (pSSM, pBusLogic->fUseLocalRam);
2478	SSMR3PutMem (pSSM, pBusLogic->aReplyBuffer, sizeof(pBusLogic->aReplyBuffer));
2479	SSMR3PutU8 (pSSM, pBusLogic->iReply);
2480	SSMR3PutU8 (pSSM, pBusLogic->cbReplyParametersLeft);
2481	SSMR3PutBool (pSSM, pBusLogic->fIRQEnabled);
2482	SSMR3PutBool (pSSM, pBusLogic->fISAEnabled);
2483	SSMR3PutU32 (pSSM, pBusLogic->cMailbox);
2484	SSMR3PutGCPhys(pSSM, pBusLogic->GCPhysAddrMailboxOutgoingBase);
2485	SSMR3PutU32 (pSSM, pBusLogic->uMailboxOutgoingPositionCurrent);
2486	SSMR3PutU32 (pSSM, pBusLogic->cMailboxesReady);
2487	SSMR3PutBool (pSSM, pBusLogic->fNotificationSend);
2488	SSMR3PutGCPhys(pSSM, pBusLogic->GCPhysAddrMailboxIncomingBase);
2489	SSMR3PutU32 (pSSM, pBusLogic->uMailboxIncomingPositionCurrent);
2490	SSMR3PutBool (pSSM, pBusLogic->fStrictRoundRobinMode);
2491	SSMR3PutBool (pSSM, pBusLogic->fExtendedLunCCBFormat);
2492	/* Now the data for the BIOS interface. */
2493	SSMR3PutU8 (pSSM, pBusLogic->VBoxSCSI.regIdentify);
2494	SSMR3PutU8 (pSSM, pBusLogic->VBoxSCSI.uTargetDevice);
2495	SSMR3PutU8 (pSSM, pBusLogic->VBoxSCSI.uTxDir);
2496	SSMR3PutU8 (pSSM, pBusLogic->VBoxSCSI.cbCDB);
2497	SSMR3PutMem (pSSM, pBusLogic->VBoxSCSI.aCDB, sizeof(pBusLogic->VBoxSCSI.aCDB));
2498	SSMR3PutU8 (pSSM, pBusLogic->VBoxSCSI.iCDB);
2499	SSMR3PutU32 (pSSM, pBusLogic->VBoxSCSI.cbBuf);
2500	SSMR3PutU32 (pSSM, pBusLogic->VBoxSCSI.iBuf);
2501	SSMR3PutBool (pSSM, pBusLogic->VBoxSCSI.fBusy);
2502	SSMR3PutU8 (pSSM, pBusLogic->VBoxSCSI.enmState);
2503	if (pBusLogic->VBoxSCSI.cbBuf)
2504	SSMR3PutMem(pSSM, pBusLogic->VBoxSCSI.pBuf, pBusLogic->VBoxSCSI.cbBuf);
2505
2506	/*
2507	* Save the physical addresses of the command control blocks of still pending tasks.
2508	* They are processed again on resume.
2509	*
2510	* The number of pending tasks needs to be determined first.
2511	*/
2512	uint32_t cTasks = 0;
2513
2514	PBUSLOGICTASKSTATE pTaskState = pBusLogic->pTasksRedoHead;
2515	if (pBusLogic->fRedo)
2516	{
2517	while (pTaskState)
2518	{
2519	cTasks++;
2520	pTaskState = pTaskState->pRedoNext;
2521	}
2522	}
2523	SSMR3PutU32(pSSM, cTasks);
2524
2525	/* Write the address of every task now. */
2526	pTaskState = pBusLogic->pTasksRedoHead;
2527	while (pTaskState)
2528	{
2529	SSMR3PutU32(pSSM, pTaskState->MailboxGuest.u32PhysAddrCCB);
2530	pTaskState = pTaskState->pRedoNext;
2531	}
2532
2533	return SSMR3PutU32(pSSM, ~0);
2534	}
2535
2536	static DECLCALLBACK(int) buslogicLoadDone(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
2537	{
2538	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2539
2540	buslogicKick(pThis);
2541	return VINF_SUCCESS;
2542	}
2543
2544	static DECLCALLBACK(int) buslogicLoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
2545	{
2546	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2547	int rc = VINF_SUCCESS;
2548
2549	/* We support saved states only from this and older versions. */
2550	if (uVersion > BUSLOGIC_SAVED_STATE_MINOR_VERSION)
2551	return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
2552
2553	/* Every device first. */
2554	for (unsigned i = 0; i < RT_ELEMENTS(pBusLogic->aDeviceStates); i++)
2555	{
2556	PBUSLOGICDEVICE pDevice = &pBusLogic->aDeviceStates[i];
2557
2558	AssertMsg(!pDevice->cOutstandingRequests,
2559	("There are still outstanding requests on this device\n"));
2560	bool fPresent;
2561	rc = SSMR3GetBool(pSSM, &fPresent);
2562	AssertRCReturn(rc, rc);
2563	if (pDevice->fPresent != fPresent)
2564	return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("Target %u config mismatch: config=%RTbool state=%RTbool"), i, pDevice->fPresent, fPresent);
2565
2566	if (uPass == SSM_PASS_FINAL)
2567	SSMR3GetU32(pSSM, (uint32_t *)&pDevice->cOutstandingRequests);
2568	}
2569
2570	if (uPass != SSM_PASS_FINAL)
2571	return VINF_SUCCESS;
2572
2573	/* Now the main device state. */
2574	SSMR3GetU8 (pSSM, (uint8_t *)&pBusLogic->regStatus);
2575	SSMR3GetU8 (pSSM, (uint8_t *)&pBusLogic->regInterrupt);
2576	SSMR3GetU8 (pSSM, (uint8_t *)&pBusLogic->regGeometry);
2577	SSMR3GetMem (pSSM, &pBusLogic->LocalRam, sizeof(pBusLogic->LocalRam));
2578	SSMR3GetU8 (pSSM, &pBusLogic->uOperationCode);
2579	SSMR3GetMem (pSSM, &pBusLogic->aCommandBuffer, sizeof(pBusLogic->aCommandBuffer));
2580	SSMR3GetU8 (pSSM, &pBusLogic->iParameter);
2581	SSMR3GetU8 (pSSM, &pBusLogic->cbCommandParametersLeft);
2582	SSMR3GetBool (pSSM, &pBusLogic->fUseLocalRam);
2583	SSMR3GetMem (pSSM, pBusLogic->aReplyBuffer, sizeof(pBusLogic->aReplyBuffer));
2584	SSMR3GetU8 (pSSM, &pBusLogic->iReply);
2585	SSMR3GetU8 (pSSM, &pBusLogic->cbReplyParametersLeft);
2586	SSMR3GetBool (pSSM, &pBusLogic->fIRQEnabled);
2587	SSMR3GetBool (pSSM, &pBusLogic->fISAEnabled);
2588	SSMR3GetU32 (pSSM, &pBusLogic->cMailbox);
2589	SSMR3GetGCPhys(pSSM, &pBusLogic->GCPhysAddrMailboxOutgoingBase);
2590	SSMR3GetU32 (pSSM, &pBusLogic->uMailboxOutgoingPositionCurrent);
2591	SSMR3GetU32 (pSSM, (uint32_t *)&pBusLogic->cMailboxesReady);
2592	SSMR3GetBool (pSSM, (bool *)&pBusLogic->fNotificationSend);
2593	SSMR3GetGCPhys(pSSM, &pBusLogic->GCPhysAddrMailboxIncomingBase);
2594	SSMR3GetU32 (pSSM, &pBusLogic->uMailboxIncomingPositionCurrent);
2595	SSMR3GetBool (pSSM, &pBusLogic->fStrictRoundRobinMode);
2596	SSMR3GetBool (pSSM, &pBusLogic->fExtendedLunCCBFormat);
2597	/* Now the data for the BIOS interface. */
2598	SSMR3GetU8 (pSSM, &pBusLogic->VBoxSCSI.regIdentify);
2599	SSMR3GetU8 (pSSM, &pBusLogic->VBoxSCSI.uTargetDevice);
2600	SSMR3GetU8 (pSSM, &pBusLogic->VBoxSCSI.uTxDir);
2601	SSMR3GetU8 (pSSM, &pBusLogic->VBoxSCSI.cbCDB);
2602	SSMR3GetMem (pSSM, pBusLogic->VBoxSCSI.aCDB, sizeof(pBusLogic->VBoxSCSI.aCDB));
2603	SSMR3GetU8 (pSSM, &pBusLogic->VBoxSCSI.iCDB);
2604	SSMR3GetU32 (pSSM, &pBusLogic->VBoxSCSI.cbBuf);
2605	SSMR3GetU32 (pSSM, &pBusLogic->VBoxSCSI.iBuf);
2606	SSMR3GetBool(pSSM, (bool *)&pBusLogic->VBoxSCSI.fBusy);
2607	SSMR3GetU8 (pSSM, (uint8_t *)&pBusLogic->VBoxSCSI.enmState);
2608	if (pBusLogic->VBoxSCSI.cbBuf)
2609	{
2610	pBusLogic->VBoxSCSI.pBuf = (uint8_t *)RTMemAllocZ(pBusLogic->VBoxSCSI.cbBuf);
2611	if (!pBusLogic->VBoxSCSI.pBuf)
2612	{
2613	LogRel(("BusLogic: Out of memory during restore.\n"));
2614	return PDMDEV_SET_ERROR(pDevIns, VERR_NO_MEMORY,
2615	N_("BusLogic: Out of memory during restore\n"));
2616	}
2617	SSMR3GetMem(pSSM, pBusLogic->VBoxSCSI.pBuf, pBusLogic->VBoxSCSI.cbBuf);
2618	}
2619
2620	if (pBusLogic->VBoxSCSI.fBusy)
2621	pBusLogic->fRedo = true;
2622
2623	if (uVersion > BUSLOGIC_SAVED_STATE_MINOR_PRE_ERROR_HANDLING)
2624	{
2625	/* Check if there are pending tasks saved. */
2626	uint32_t cTasks = 0;
2627
2628	SSMR3GetU32(pSSM, &cTasks);
2629
2630	if (cTasks)
2631	pBusLogic->fRedo = true;
2632
2633	for (uint32_t i = 0; i < cTasks; i++)
2634	{
2635	PBUSLOGICTASKSTATE pTaskState = (PBUSLOGICTASKSTATE)RTMemCacheAlloc(pBusLogic->hTaskCache);
2636	if (!pTaskState)
2637	{
2638	rc = VERR_NO_MEMORY;
2639	break;
2640	}
2641
2642	rc = SSMR3GetU32(pSSM, &pTaskState->MailboxGuest.u32PhysAddrCCB);
2643	if (RT_FAILURE(rc))
2644	{
2645	RTMemCacheFree(pBusLogic->hTaskCache, pTaskState);
2646	break;
2647	}
2648
2649	/* Link into the list. */
2650	pTaskState->pRedoNext = pBusLogic->pTasksRedoHead;
2651	pBusLogic->pTasksRedoHead = pTaskState;
2652	}
2653	}
2654
2655	if (RT_SUCCESS(rc))
2656	{
2657	uint32_t u32;
2658	rc = SSMR3GetU32(pSSM, &u32);
2659	if (RT_SUCCESS(rc))
2660	AssertMsgReturn(u32 == ~0U, ("%#x\n", u32), VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
2661	}
2662
2663	return rc;
2664	}
2665
2666	/**
2667	* Gets the pointer to the status LED of a device - called from the SCSi driver.
2668	*
2669	* @returns VBox status code.
2670	* @param pInterface Pointer to the interface structure containing the called function pointer.
2671	* @param iLUN The unit which status LED we desire. Always 0 here as the driver
2672	* doesn't know about other LUN's.
2673	* @param ppLed Where to store the LED pointer.
2674	*/
2675	static DECLCALLBACK(int) buslogicDeviceQueryStatusLed(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed)
2676	{
2677	PBUSLOGICDEVICE pDevice = PDMILEDPORTS_2_PBUSLOGICDEVICE(pInterface);
2678	if (iLUN == 0)
2679	{
2680	*ppLed = &pDevice->Led;
2681	Assert((*ppLed)->u32Magic == PDMLED_MAGIC);
2682	return VINF_SUCCESS;
2683	}
2684	return VERR_PDM_LUN_NOT_FOUND;
2685	}
2686
2687	/**
2688	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
2689	*/
2690	static DECLCALLBACK(void ) buslogicDeviceQueryInterface(PPDMIBASE pInterface, const char pszIID)
2691	{
2692	PBUSLOGICDEVICE pDevice = PDMIBASE_2_PBUSLOGICDEVICE(pInterface);
2693	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDevice->IBase);
2694	PDMIBASE_RETURN_INTERFACE(pszIID, PDMISCSIPORT, &pDevice->ISCSIPort);
2695	PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pDevice->ILed);
2696	return NULL;
2697	}
2698
2699	/**
2700	* Gets the pointer to the status LED of a unit.
2701	*
2702	* @returns VBox status code.
2703	* @param pInterface Pointer to the interface structure containing the called function pointer.
2704	* @param iLUN The unit which status LED we desire.
2705	* @param ppLed Where to store the LED pointer.
2706	*/
2707	static DECLCALLBACK(int) buslogicStatusQueryStatusLed(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed)
2708	{
2709	PBUSLOGIC pBusLogic = PDMILEDPORTS_2_PBUSLOGIC(pInterface);
2710	if (iLUN < BUSLOGIC_MAX_DEVICES)
2711	{
2712	*ppLed = &pBusLogic->aDeviceStates[iLUN].Led;
2713	Assert((*ppLed)->u32Magic == PDMLED_MAGIC);
2714	return VINF_SUCCESS;
2715	}
2716	return VERR_PDM_LUN_NOT_FOUND;
2717	}
2718
2719	/**
2720	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
2721	*/
2722	static DECLCALLBACK(void ) buslogicStatusQueryInterface(PPDMIBASE pInterface, const char pszIID)
2723	{
2724	PBUSLOGIC pThis = PDMIBASE_2_PBUSLOGIC(pInterface);
2725	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pThis->IBase);
2726	PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pThis->ILeds);
2727	return NULL;
2728	}
2729
2730	/* -=-=-=-=- Helper -=-=-=-=- */
2731
2732	/**
2733	* Checks if all asynchronous I/O is finished.
2734	*
2735	* Used by lsilogicReset, lsilogicSuspend and lsilogicPowerOff.
2736	*
2737	* @returns true if quiesced, false if busy.
2738	* @param pDevIns The device instance.
2739	*/
2740	static bool buslogicR3AllAsyncIOIsFinished(PPDMDEVINS pDevIns)
2741	{
2742	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2743
2744	for (uint32_t i = 0; i < RT_ELEMENTS(pThis->aDeviceStates); i++)
2745	{
2746	PBUSLOGICDEVICE pThisDevice = &pThis->aDeviceStates[i];
2747	if (pThisDevice->pDrvBase)
2748	{
2749	if (pThisDevice->cOutstandingRequests != 0)
2750	return false;
2751	}
2752	}
2753
2754	return true;
2755	}
2756
2757	/**
2758	* Callback employed by lsilogicR3Suspend and lsilogicR3PowerOff..
2759	*
2760	* @returns true if we've quiesced, false if we're still working.
2761	* @param pDevIns The device instance.
2762	*/
2763	static DECLCALLBACK(bool) buslogicR3IsAsyncSuspendOrPowerOffDone(PPDMDEVINS pDevIns)
2764	{
2765	if (!buslogicR3AllAsyncIOIsFinished(pDevIns))
2766	return false;
2767
2768	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2769	ASMAtomicWriteBool(&pThis->fSignalIdle, false);
2770	return true;
2771	}
2772
2773	/**
2774	* Common worker for ahciR3Suspend and ahciR3PowerOff.
2775	*/
2776	static void buslogicR3SuspendOrPowerOff(PPDMDEVINS pDevIns, bool fPowerOff)
2777	{
2778	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2779
2780	ASMAtomicWriteBool(&pThis->fSignalIdle, true);
2781	if (!buslogicR3AllAsyncIOIsFinished(pDevIns))
2782	PDMDevHlpSetAsyncNotification(pDevIns, buslogicR3IsAsyncSuspendOrPowerOffDone);
2783	else
2784	{
2785	ASMAtomicWriteBool(&pThis->fSignalIdle, false);
2786
2787	AssertMsg(!pThis->fNotificationSend, ("The PDM Queue should be empty at this point\n"));
2788
2789	if (pThis->fRedo)
2790	{
2791	if (fPowerOff)
2792	{
2793	/* Free tasks which would have been queued again on resume. */
2794	PBUSLOGICTASKSTATE pTaskState = pThis->pTasksRedoHead;
2795
2796	pThis->pTasksRedoHead = NULL;
2797
2798	while (pTaskState)
2799	{
2800	PBUSLOGICTASKSTATE pFree;
2801
2802	pFree = pTaskState;
2803	pTaskState = pTaskState->pRedoNext;
2804
2805	RTMemCacheFree(pThis->hTaskCache, pFree);
2806	}
2807	pThis->fRedo = false;
2808	}
2809	else if (pThis->VBoxSCSI.fBusy)
2810	{
2811	/* Destroy the task because the BIOS interface has all necessary information. */
2812	Assert(pThis->pTasksRedoHead->fBIOS);
2813	Assert(!pThis->pTasksRedoHead->pRedoNext);
2814
2815	RTMemCacheFree(pThis->hTaskCache, pThis->pTasksRedoHead);
2816	pThis->pTasksRedoHead = NULL;
2817	}
2818	}
2819	}
2820	}
2821
2822	/**
2823	* Suspend notification.
2824	*
2825	* @param pDevIns The device instance data.
2826	*/
2827	static DECLCALLBACK(void) buslogicSuspend(PPDMDEVINS pDevIns)
2828	{
2829	Log(("buslogicSuspend\n"));
2830	buslogicR3SuspendOrPowerOff(pDevIns, false /* fPoweroff */);
2831	}
2832
2833	/**
2834	* Resume notification.
2835	*
2836	* @param pDevIns The device instance data.
2837	*/
2838	static DECLCALLBACK(void) buslogicResume(PPDMDEVINS pDevIns)
2839	{
2840	Log(("buslogicResume\n"));
2841	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2842	buslogicKick(pThis);
2843	}
2844
2845
2846	/**
2847	* Detach notification.
2848	*
2849	* One harddisk at one port has been unplugged.
2850	* The VM is suspended at this point.
2851	*
2852	* @param pDevIns The device instance.
2853	* @param iLUN The logical unit which is being detached.
2854	* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
2855	*/
2856	static DECLCALLBACK(void) buslogicDetach(PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags)
2857	{
2858	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2859	PBUSLOGICDEVICE pDevice = &pThis->aDeviceStates[iLUN];
2860
2861	Log(("%s:\n", __FUNCTION__));
2862
2863	AssertMsg(fFlags & PDM_TACH_FLAGS_NOT_HOT_PLUG,
2864	("BusLogic: Device does not support hotplugging\n"));
2865
2866	/*
2867	* Zero some important members.
2868	*/
2869	pDevice->pDrvBase = NULL;
2870	pDevice->fPresent = false;
2871	pDevice->pDrvSCSIConnector = NULL;
2872	}
2873
2874	/**
2875	* Attach command.
2876	*
2877	* This is called when we change block driver.
2878	*
2879	* @returns VBox status code.
2880	* @param pDevIns The device instance.
2881	* @param iLUN The logical unit which is being detached.
2882	* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
2883	*/
2884	static DECLCALLBACK(int) buslogicAttach(PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags)
2885	{
2886	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2887	PBUSLOGICDEVICE pDevice = &pThis->aDeviceStates[iLUN];
2888	int rc;
2889
2890	AssertMsgReturn(fFlags & PDM_TACH_FLAGS_NOT_HOT_PLUG,
2891	("BusLogic: Device does not support hotplugging\n"),
2892	VERR_INVALID_PARAMETER);
2893
2894	/* the usual paranoia */
2895	AssertRelease(!pDevice->pDrvBase);
2896	AssertRelease(!pDevice->pDrvSCSIConnector);
2897	Assert(pDevice->iLUN == iLUN);
2898
2899	/*
2900	* Try attach the block device and get the interfaces,
2901	* required as well as optional.
2902	*/
2903	rc = PDMDevHlpDriverAttach(pDevIns, pDevice->iLUN, &pDevice->IBase, &pDevice->pDrvBase, NULL);
2904	if (RT_SUCCESS(rc))
2905	{
2906	/* Get SCSI connector interface. */
2907	pDevice->pDrvSCSIConnector = PDMIBASE_QUERY_INTERFACE(pDevice->pDrvBase, PDMISCSICONNECTOR);
2908	AssertMsgReturn(pDevice->pDrvSCSIConnector, ("Missing SCSI interface below\n"), VERR_PDM_MISSING_INTERFACE);
2909	pDevice->fPresent = true;
2910	}
2911	else
2912	AssertMsgFailed(("Failed to attach LUN#%d. rc=%Rrc\n", pDevice->iLUN, rc));
2913
2914	if (RT_FAILURE(rc))
2915	{
2916	pDevice->pDrvBase = NULL;
2917	pDevice->pDrvSCSIConnector = NULL;
2918	}
2919	return rc;
2920	}
2921
2922	/**
2923	* Callback employed by buslogicR3Reset.
2924	*
2925	* @returns true if we've quiesced, false if we're still working.
2926	* @param pDevIns The device instance.
2927	*/
2928	static DECLCALLBACK(bool) buslogicR3IsAsyncResetDone(PPDMDEVINS pDevIns)
2929	{
2930	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2931
2932	if (!buslogicR3AllAsyncIOIsFinished(pDevIns))
2933	return false;
2934	ASMAtomicWriteBool(&pThis->fSignalIdle, false);
2935
2936	buslogicHwReset(pThis);
2937	return true;
2938	}
2939
2940	/**
2941	* @copydoc FNPDMDEVRESET
2942	*/
2943	static DECLCALLBACK(void) buslogicReset(PPDMDEVINS pDevIns)
2944	{
2945	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2946
2947	ASMAtomicWriteBool(&pThis->fSignalIdle, true);
2948	if (!buslogicR3AllAsyncIOIsFinished(pDevIns))
2949	PDMDevHlpSetAsyncNotification(pDevIns, buslogicR3IsAsyncResetDone);
2950	else
2951	{
2952	ASMAtomicWriteBool(&pThis->fSignalIdle, false);
2953	buslogicHwReset(pThis);
2954	}
2955	}
2956
2957	static DECLCALLBACK(void) buslogicRelocate(PPDMDEVINS pDevIns, RTGCINTPTR offDelta)
2958	{
2959	uint32_t i;
2960	PBUSLOGIC pBusLogic = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2961
2962	pBusLogic->pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns);
2963	pBusLogic->pNotifierQueueRC = PDMQueueRCPtr(pBusLogic->pNotifierQueueR3);
2964
2965	for (i = 0; i < BUSLOGIC_MAX_DEVICES; i++)
2966	{
2967	PBUSLOGICDEVICE pDevice = &pBusLogic->aDeviceStates[i];
2968
2969	pDevice->pBusLogicRC = PDMINS_2_DATA_RCPTR(pDevIns);
2970	}
2971
2972	}
2973
2974	/**
2975	* Poweroff notification.
2976	*
2977	* @param pDevIns Pointer to the device instance
2978	*/
2979	static DECLCALLBACK(void) buslogicPowerOff(PPDMDEVINS pDevIns)
2980	{
2981	Log(("buslogicPowerOff\n"));
2982	buslogicR3SuspendOrPowerOff(pDevIns, true /* fPoweroff */);
2983	}
2984
2985	/**
2986	* Destroy a driver instance.
2987	*
2988	* Most VM resources are freed by the VM. This callback is provided so that any non-VM
2989	* resources can be freed correctly.
2990	*
2991	* @param pDevIns The device instance data.
2992	*/
2993	static DECLCALLBACK(int) buslogicDestruct(PPDMDEVINS pDevIns)
2994	{
2995	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
2996	PDMDEV_CHECK_VERSIONS_RETURN_QUIET(pDevIns);
2997
2998	PDMR3CritSectDelete(&pThis->CritSectIntr);
2999
3000	/*
3001	* Free all tasks which are still hanging around
3002	* (Power off after the VM was suspended).
3003	*/
3004	if (pThis->fRedo)
3005	{
3006	/* Free tasks which would have been queued again on resume. */
3007	PBUSLOGICTASKSTATE pTaskState = pThis->pTasksRedoHead;
3008
3009	pThis->pTasksRedoHead = NULL;
3010
3011	while (pTaskState)
3012	{
3013	PBUSLOGICTASKSTATE pFree;
3014
3015	pFree = pTaskState;
3016	pTaskState = pTaskState->pRedoNext;
3017
3018	RTMemCacheFree(pThis->hTaskCache, pFree);
3019	}
3020	pThis->fRedo = false;
3021	}
3022
3023	int rc = RTMemCacheDestroy(pThis->hTaskCache);
3024	AssertMsgRC(rc, ("Destroying task cache failed rc=%Rrc\n", rc));
3025
3026	return rc;
3027	}
3028
3029	/**
3030	* @interface_method_impl{PDMDEVREG,pfnConstruct}
3031	*/
3032	static DECLCALLBACK(int) buslogicConstruct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
3033	{
3034	PBUSLOGIC pThis = PDMINS_2_DATA(pDevIns, PBUSLOGIC);
3035	int rc = VINF_SUCCESS;
3036	bool fBootable = true;
3037	PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
3038
3039	/*
3040	* Validate and read configuration.
3041	*/
3042	if (!CFGMR3AreValuesValid(pCfg,
3043	"GCEnabled\0"
3044	"R0Enabled\0"
3045	"Bootable\0"))
3046	return PDMDEV_SET_ERROR(pDevIns, VERR_PDM_DEVINS_UNKNOWN_CFG_VALUES,
3047	N_("BusLogic configuration error: unknown option specified"));
3048
3049	rc = CFGMR3QueryBoolDef(pCfg, "GCEnabled", &pThis->fGCEnabled, true);
3050	if (RT_FAILURE(rc))
3051	return PDMDEV_SET_ERROR(pDevIns, rc,
3052	N_("BusLogic configuration error: failed to read GCEnabled as boolean"));
3053	Log(("%s: fGCEnabled=%d\n", __FUNCTION__, pThis->fGCEnabled));
3054
3055	rc = CFGMR3QueryBoolDef(pCfg, "R0Enabled", &pThis->fR0Enabled, true);
3056	if (RT_FAILURE(rc))
3057	return PDMDEV_SET_ERROR(pDevIns, rc,
3058	N_("BusLogic configuration error: failed to read R0Enabled as boolean"));
3059	Log(("%s: fR0Enabled=%d\n", __FUNCTION__, pThis->fR0Enabled));
3060	rc = CFGMR3QueryBoolDef(pCfg, "Bootable", &fBootable, true);
3061	if (RT_FAILURE(rc))
3062	return PDMDEV_SET_ERROR(pDevIns, rc,
3063	N_("BusLogic configuration error: failed to read Bootable as boolean"));
3064	Log(("%s: fBootable=%RTbool\n", __FUNCTION__, fBootable));
3065
3066	pThis->pDevInsR3 = pDevIns;
3067	pThis->pDevInsR0 = PDMDEVINS_2_R0PTR(pDevIns);
3068	pThis->pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns);
3069	pThis->IBase.pfnQueryInterface = buslogicStatusQueryInterface;
3070	pThis->ILeds.pfnQueryStatusLed = buslogicStatusQueryStatusLed;
3071
3072	PCIDevSetVendorId (&pThis->dev, 0x104b); /* BusLogic */
3073	PCIDevSetDeviceId (&pThis->dev, 0x1040); /* BT-958 */
3074	PCIDevSetCommand (&pThis->dev, 0x0003);
3075	PCIDevSetRevisionId (&pThis->dev, 0x01);
3076	PCIDevSetClassProg (&pThis->dev, 0x00); /* SCSI */
3077	PCIDevSetClassSub (&pThis->dev, 0x00); /* SCSI */
3078	PCIDevSetClassBase (&pThis->dev, 0x01); /* Mass storage */
3079	PCIDevSetBaseAddress (&pThis->dev, 0, true /IO/, false /Pref/, false /64-bit/, 0x00000000);
3080	PCIDevSetBaseAddress (&pThis->dev, 1, false /IO/, false /Pref/, false /64-bit/, 0x00000000);
3081	PCIDevSetSubSystemVendorId(&pThis->dev, 0x104b);
3082	PCIDevSetSubSystemId (&pThis->dev, 0x1040);
3083	PCIDevSetInterruptLine (&pThis->dev, 0x00);
3084	PCIDevSetInterruptPin (&pThis->dev, 0x01);
3085
3086	/*
3087	* Register the PCI device, it's I/O regions.
3088	*/
3089	rc = PDMDevHlpPCIRegister (pDevIns, &pThis->dev);
3090	if (RT_FAILURE(rc))
3091	return rc;
3092
3093	rc = PDMDevHlpPCIIORegionRegister(pDevIns, 0, 32, PCI_ADDRESS_SPACE_IO, buslogicMMIOMap);
3094	if (RT_FAILURE(rc))
3095	return rc;
3096
3097	rc = PDMDevHlpPCIIORegionRegister(pDevIns, 1, 32, PCI_ADDRESS_SPACE_MEM, buslogicMMIOMap);
3098	if (RT_FAILURE(rc))
3099	return rc;
3100
3101	if (fBootable)
3102	{
3103	/* Register I/O port space in ISA region for BIOS access. */
3104	rc = PDMDevHlpIOPortRegister(pDevIns, BUSLOGIC_ISA_IO_PORT, 3, NULL,
3105	buslogicIsaIOPortWrite, buslogicIsaIOPortRead,
3106	buslogicIsaIOPortWriteStr, buslogicIsaIOPortReadStr,
3107	"BusLogic BIOS");
3108	if (RT_FAILURE(rc))
3109	return PDMDEV_SET_ERROR(pDevIns, rc, N_("BusLogic cannot register legacy I/O handlers"));
3110	}
3111
3112	/* Initialize task cache. */
3113	rc = RTMemCacheCreate(&pThis->hTaskCache, sizeof(BUSLOGICTASKSTATE), 0, UINT32_MAX,
3114	NULL, NULL, NULL, 0);
3115	if (RT_FAILURE(rc))
3116	return PDMDEV_SET_ERROR(pDevIns, rc,
3117	N_("BusLogic: Failed to initialize task cache\n"));
3118
3119	/* Initialize task queue. */
3120	rc = PDMDevHlpQueueCreate(pDevIns, sizeof(PDMQUEUEITEMCORE), 5, 0,
3121	buslogicNotifyQueueConsumer, true, "BugLogicTask", &pThis->pNotifierQueueR3);
3122	if (RT_FAILURE(rc))
3123	return rc;
3124	pThis->pNotifierQueueR0 = PDMQueueR0Ptr(pThis->pNotifierQueueR3);
3125	pThis->pNotifierQueueRC = PDMQueueRCPtr(pThis->pNotifierQueueR3);
3126
3127	rc = PDMDevHlpCritSectInit(pDevIns, &pThis->CritSectIntr, RT_SRC_POS, "BusLogic-Intr#%u", pDevIns->iInstance);
3128	if (RT_FAILURE(rc))
3129	return PDMDEV_SET_ERROR(pDevIns, rc,
3130	N_("BusLogic: cannot create critical section"));
3131
3132	/* Initialize per device state. */
3133	for (unsigned i = 0; i < RT_ELEMENTS(pThis->aDeviceStates); i++)
3134	{
3135	char szName[24];
3136	PBUSLOGICDEVICE pDevice = &pThis->aDeviceStates[i];
3137
3138	RTStrPrintf(szName, sizeof(szName), "Device%d", i);
3139
3140	/* Initialize static parts of the device. */
3141	pDevice->iLUN = i;
3142	pDevice->pBusLogicR3 = pThis;
3143	pDevice->pBusLogicR0 = PDMINS_2_DATA_R0PTR(pDevIns);
3144	pDevice->pBusLogicRC = PDMINS_2_DATA_RCPTR(pDevIns);
3145	pDevice->Led.u32Magic = PDMLED_MAGIC;
3146	pDevice->IBase.pfnQueryInterface = buslogicDeviceQueryInterface;
3147	pDevice->ISCSIPort.pfnSCSIRequestCompleted = buslogicDeviceSCSIRequestCompleted;
3148	pDevice->ISCSIPort.pfnQueryDeviceLocation = buslogicQueryDeviceLocation;
3149	pDevice->ILed.pfnQueryStatusLed = buslogicDeviceQueryStatusLed;
3150
3151	/* Attach SCSI driver. */
3152	rc = PDMDevHlpDriverAttach(pDevIns, pDevice->iLUN, &pDevice->IBase, &pDevice->pDrvBase, szName);
3153	if (RT_SUCCESS(rc))
3154	{
3155	/* Get SCSI connector interface. */
3156	pDevice->pDrvSCSIConnector = PDMIBASE_QUERY_INTERFACE(pDevice->pDrvBase, PDMISCSICONNECTOR);
3157	AssertMsgReturn(pDevice->pDrvSCSIConnector, ("Missing SCSI interface below\n"), VERR_PDM_MISSING_INTERFACE);
3158
3159	pDevice->fPresent = true;
3160	}
3161	else if (rc == VERR_PDM_NO_ATTACHED_DRIVER)
3162	{
3163	pDevice->pDrvBase = NULL;
3164	pDevice->fPresent = false;
3165	rc = VINF_SUCCESS;
3166	Log(("BusLogic: no driver attached to device %s\n", szName));
3167	}
3168	else
3169	{
3170	AssertLogRelMsgFailed(("BusLogic: Failed to attach %s\n", szName));
3171	return rc;
3172	}
3173	}
3174
3175	/*
3176	* Attach status driver (optional).
3177	*/
3178	PPDMIBASE pBase;
3179	rc = PDMDevHlpDriverAttach(pDevIns, PDM_STATUS_LUN, &pThis->IBase, &pBase, "Status Port");
3180	if (RT_SUCCESS(rc))
3181	pThis->pLedsConnector = PDMIBASE_QUERY_INTERFACE(pBase, PDMILEDCONNECTORS);
3182	else if (rc != VERR_PDM_NO_ATTACHED_DRIVER)
3183	{
3184	AssertMsgFailed(("Failed to attach to status driver. rc=%Rrc\n", rc));
3185	return PDMDEV_SET_ERROR(pDevIns, rc, N_("BusLogic cannot attach to status driver"));
3186	}
3187
3188	rc = PDMDevHlpSSMRegisterEx(pDevIns, BUSLOGIC_SAVED_STATE_MINOR_VERSION, sizeof(*pThis), NULL,
3189	NULL, buslogicLiveExec, NULL,
3190	NULL, buslogicSaveExec, NULL,
3191	NULL, buslogicLoadExec, buslogicLoadDone);
3192	if (RT_FAILURE(rc))
3193	return PDMDEV_SET_ERROR(pDevIns, rc, N_("BusLogic cannot register save state handlers"));
3194
3195	rc = buslogicHwReset(pThis);
3196	AssertMsgRC(rc, ("hardware reset of BusLogic host adapter failed rc=%Rrc\n", rc));
3197
3198	return rc;
3199	}
3200
3201	/**
3202	* The device registration structure.
3203	*/
3204	const PDMDEVREG g_DeviceBusLogic =
3205	{
3206	/* u32Version */
3207	PDM_DEVREG_VERSION,
3208	/* szName */
3209	"buslogic",
3210	/* szRCMod */
3211	"VBoxDDGC.gc",
3212	/* szR0Mod */
3213	"VBoxDDR0.r0",
3214	/* pszDescription */
3215	"BusLogic BT-958 SCSI host adapter.\n",
3216	/* fFlags */
3217	PDM_DEVREG_FLAGS_DEFAULT_BITS \| PDM_DEVREG_FLAGS_RC \| PDM_DEVREG_FLAGS_R0 \|
3218	PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION \| PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION,
3219	/* fClass */
3220	PDM_DEVREG_CLASS_STORAGE,
3221	/* cMaxInstances */
3222	~0,
3223	/* cbInstance */
3224	sizeof(BUSLOGIC),
3225	/* pfnConstruct */
3226	buslogicConstruct,
3227	/* pfnDestruct */
3228	buslogicDestruct,
3229	/* pfnRelocate */
3230	buslogicRelocate,
3231	/* pfnIOCtl */
3232	NULL,
3233	/* pfnPowerOn */
3234	NULL,
3235	/* pfnReset */
3236	buslogicReset,
3237	/* pfnSuspend */
3238	buslogicSuspend,
3239	/* pfnResume */
3240	buslogicResume,
3241	/* pfnAttach */
3242	buslogicAttach,
3243	/* pfnDetach */
3244	buslogicDetach,
3245	/* pfnQueryInterface. */
3246	NULL,
3247	/* pfnInitComplete */
3248	NULL,
3249	/* pfnPowerOff */
3250	buslogicPowerOff,
3251	/* pfnSoftReset */
3252	NULL,
3253	/* u32VersionEnd */
3254	PDM_DEVREG_VERSION
3255	};
3256
3257	#endif /* IN_RING3 */
3258	#endif /* !VBOX_DEVICE_STRUCT_TESTCASE */
3259

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

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

Download in other formats: