VirtualBox

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

Last change on this file since 22793 was 22793, checked in by vboxsync, 15 years ago

SSM,*: Renamed phase to pass (uPhase/SSM_PHASE_FINAL) and wrote the remainder of the live snapshot / migration SSM code.

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette