DevBusLogic.cpp@ 83127

Last change on this file since 83127 was 83127, checked in by vboxsync, 5 years ago
DevBusLogic: Generalized commands that do not set CMDC.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 176.0 KB

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

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

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

Download in other formats: