VirtualBox

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

Last change on this file since 40754 was 40640, checked in by vboxsync, 12 years ago

Renamed SCSI BIOS constants to elucidate their purpose.

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

© 2023 Oracle
ContactPrivacy policyTerms of Use