-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathlisting3.html
executable file
·737 lines (608 loc) · 26.2 KB
/
listing3.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<!-- BEGIN META TAG INFO -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="home" href="http://developer.apple.com/">
<link rel="find" href="http://developer.apple.com/search/">
<link rel="stylesheet" type="text/css" href="../../documentation/css/adcstyle.css" title="fonts">
<script language="JavaScript" src="../../documentation/js/adc.js" type="text/javascript"></script>
<!-- END META TAG INFO -->
<!-- BEGIN TITLE -->
<title>SCSIHBAEmulator - /SCSIEmulatorAdapter.cpp</title>
<!-- END TITLE -->
<script language="JavaScript">
function JumpToNewPage() {
window.location=document.scpopupmenu.gotop.value;
return true;
}
</script>
</head>
<!-- BEGIN BODY OPEN -->
<body>
<!--END BODY OPEN -->
<!-- START CENTER OPEN -->
<center>
<!-- END CENTER OPEN -->
<!-- BEGIN LOGO AND SEARCH -->
<!--#include virtual="/includes/adcnavbar"-->
<!-- END LOGO AND SEARCH -->
<!-- START BREADCRUMB -->
<div id="breadcrumb">
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td scope="row"><img width="340" height="10" src="images/1dot.gif" alt=""></td>
<td><img width="340" height="10" src="images/1dot.gif" alt=""></td>
</tr>
<tr valign="middle">
<td align="left" colspan="2">
<a href="http://developer.apple.com/">ADC Home</a> > <a href="../../referencelibrary/index.html">Reference Library</a> > <a href="../../samplecode/index.html">Sample Code</a> > <a href="../../samplecode/HardwareDrivers/index.html">Hardware & Drivers</a> > <a href="../../samplecode/HardwareDrivers/idxSCSI-date.html">SCSI</a> > <A HREF="javascript:location.replace('index.html');">SCSIHBAEmulator</A> >
</td>
</tr>
<tr>
<td colspan="2" scope="row"><img width="680" height="35" src="images/1dot.gif" alt=""></td>
</tr>
</table>
</div>
<!-- END BREADCRUMB -->
<!-- START MAIN CONTENT -->
<!-- START TITLE GRAPHIC AND INTRO-->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td><h1><div id="pagehead">SCSIHBAEmulator</div></h1></td>
</tr>
</table>
<!-- END TITLE GRAPHIC AND INTRO -->
<!-- START WIDE COLUMN -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td id="scdetails">
<h2>/SCSIEmulatorAdapter.cpp</h2>
<form name="scpopupmenu" onSubmit="return false;" method=post>
<p><strong>View Source Code:</strong>
<select name="gotop" onChange="JumpToNewPage();" style="width:340px"><option selected value="ingnore">Select File</option>
<option value="listing1.html">/SCSIEmulator.cpp</option>
<option value="listing2.html">/SCSIEmulator.h</option>
<option value="listing3.html">/SCSIEmulatorAdapter.cpp</option>
<option value="listing4.html">/SCSIEmulatorAdapter.h</option>
<option value="listing5.html">/SCSIEmulatorAdapterNub.cpp</option>
<option value="listing6.html">/SCSIEmulatorAdapterNub.h</option>
<option value="listing7.html">/SCSIEmulatorEventSource.cpp</option>
<option value="listing8.html">/SCSIEmulatorEventSource.h</option>
<option value="listing9.html">/SCSIEmulatorIOKitDriver.cpp</option>
<option value="listing10.html">/SCSIEmulatorIOKitDriver.h</option></select>
</p>
</form>
<p><strong><a href="SCSIHBAEmulator.zip">Download Sample</a></strong> (“SCSIHBAEmulator.zip”, 128.5K)<BR>
<strong><a href="SCSIHBAEmulator.dmg">Download Sample</a></strong> (“SCSIHBAEmulator.dmg”, 182.3K)</p>
<!--
<p><strong><a href="#">Download Sample</a></strong> (“filename.sit”, 500K)</p>
-->
</td>
</tr>
<tr>
<td scope="row"><img width="680" height="10" src="images/1dot.gif" alt=""><br>
<img height="1" width="680" src="images/1dot_919699.gif" alt=""><br>
<img width="680" height="20" src="images/1dot.gif" alt=""></td>
</tr>
<tr>
<td scope="row">
<!--googleon: index -->
<pre class="sourcecodebox">/*
File:SCSIEmulatorAdapter.cpp
Abstract: Implementation of the core a virtual SCSI HBA based off of
IOSCSIParallelInterfaceController
Version: 1.0
Disclaimer: IMPORTANT: This Apple software is supplied to you by
Apple Inc. ("Apple") in consideration of your agreement to the
following terms, and your use, installation, modification or
redistribution of this Apple software constitutes acceptance of these
terms. If you do not agree with these terms, please do not use,
install, modify or redistribute this Apple software.
In consideration of your agreement to abide by the following terms, and
subject to these terms, Apple grants you a personal, non-exclusive
license, under Apple's copyrights in this original Apple software (the
"Apple Software"), to use, reproduce, modify and redistribute the Apple
Software, with or without modifications, in source and/or binary forms;
provided that if you redistribute the Apple Software in its entirety and
without modifications, you must retain this notice and the following
text and disclaimers in all such redistributions of the Apple Software.
Neither the name, trademarks, service marks or logos of Apple Inc.
may be used to endorse or promote products derived from the Apple
Software without specific prior written permission from Apple. Except
as expressly stated in this notice, no other rights or licenses, express
or implied, are granted by Apple herein, including but not limited to
any patent rights that may be infringed by your derivative works or by
other works in which the Apple Software may be incorporated.
The Apple Software is provided by Apple on an "AS IS" basis. APPLE
MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
Copyright (C) 2007 Apple Inc. All Rights Reserved.
*/
#include <IOKit/IOTypes.h>
#include <IOKit/IOMessage.h>
#include <IOKit/scsi/SCSICommandOperationCodes.h>
#include <IOKit/storage/IOStorageProtocolCharacteristics.h>
#include <IOKit/scsi/spi/IOSCSIParallelInterfaceController.h>
#include "SCSIEmulator.h"
#include "SCSIEmulatorAdapter.h"
#include "SCSIEmulatorAdapterNub.h"
#include "SCSIEmulatorIOKitDriver.h"
#include "SCSIEmulatorEventSource.h"
#ifndef MAX_TARGET_ID
#define kMaxTargetID 256
#else
#define kMaxTargetID MAX_TARGET_ID
#endif
#ifndef MAX_LUNS
#define kMaxLUNs 64
#else
#define kMaxLUNs MAX_LUNS
#endif
#ifndef MAX_TASKS
#define kMaxTasks 32 // Arbitrary number. This sample code will work with anything >= 1
#else
#define kMaxTasks MAX_TASKS
#endif
#ifndef SENSE_BUFFER_LEN
#define kSenseBufferLen 128
#else
#define kSenseBufferLen SENSE_BUFFER_LEN
#endif
#define INITIATOR_IDENTIFIER 0x87654321
// Define superclass
#define super IOSCSIParallelInterfaceController
// REQUIRED! This macro defines the class's constructors, destructors,
// and several other methods I/O Kit requires. Do NOT use super as the
// second parameter. You must use the literal name of the superclass.
OSDefineMetaClassAndStructors(com_apple_dts_SCSIEmulatorAdapter, IOSCSIParallelInterfaceController)
// Only present to provide a debug checkpoint
bool com_apple_dts_SCSIEmulatorAdapter::willTerminate(IOService *provider, IOOptionBits options)
{
return super::willTerminate(provider, options);
}
// Only present to provide a debug checkpoint
bool com_apple_dts_SCSIEmulatorAdapter::didTerminate(IOService *provider, IOOptionBits options, bool *defer)
{
return super::didTerminate(provider, options, defer);
}
// Only present to provide a debug checkpoint
bool
com_apple_dts_SCSIEmulatorAdapter::terminate( IOOptionBits options)
{
bool res = super::terminate(options);
return res;
}
IOReturn
com_apple_dts_SCSIEmulatorAdapter::message(UInt32 type, IOService *provider, void *argument)
{
IOReturn ret;
#if 1 // Work-around for bug in IOSCSIParallelFamily. Radar:4914658
switch (type) {
case kIOMessageServiceIsRequestingClose:
{
// As the provider is opened by IOSCSIParallelInterfaceController itself, it should
// be responsible for closing it, not us. Currently, this is not the case
ret = super::message(type, provider, argument);
if (getProvider()->isOpen(this))
getProvider()->close(this);
return (getProvider()->isOpen(this) == false) ? ret : kIOReturnError;
break;
}
default:
{
break;
}
}
#endif
ret = super::message(type, provider, argument);
return ret;
}
SCSILogicalUnitNumber
com_apple_dts_SCSIEmulatorAdapter::ReportHBAHighestLogicalUnitNumber ( void )
{
// Report the highest LUN number devices on this HBA are allowed to have.
// 0 is a valid response for HBAs that only allow a single LUN per device
SCSILogicalUnitNumber maxLUN = kMaxLUNs - 1; // Report LUNs for our sample
return maxLUN;
}
bool
com_apple_dts_SCSIEmulatorAdapter::DoesHBASupportSCSIParallelFeature ( SCSIParallelFeature theFeature )
{
bool ret = false; // return false for any unimplemented or unknown features
switch (theFeature) {
case kSCSIParallelFeature_WideDataTransfer:
ret = true;
break;
case kSCSIParallelFeature_SynchronousDataTransfer:
ret = true;
break;
case kSCSIParallelFeature_QuickArbitrationAndSelection:
ret = true;
break;
case kSCSIParallelFeature_DoubleTransitionDataTransfers:
ret = true;
break;
case kSCSIParallelFeature_InformationUnitTransfers:
ret = true;
break;
}
return ret;
}
bool
com_apple_dts_SCSIEmulatorAdapter::InitializeTargetForID ( SCSITargetIdentifier targetID )
{
bool retVal = false;
com_apple_dts_SCSIEmulatorAdapterNub *nub = OSDynamicCast(com_apple_dts_SCSIEmulatorAdapterNub, getProvider());
if (nub) {
com_apple_dts_SCSIEmulator *emulator = nub->getEmulator(this, targetID);
if (emulator) {
if (mTargetsArray)
mTargetsArray->setObject(targetID, emulator);
retVal = true;
}
}
return retVal;
}
SCSIServiceResponse
com_apple_dts_SCSIEmulatorAdapter::AbortTaskRequest (
SCSITargetIdentifier theT,
SCSILogicalUnitNumber theL,
SCSITaggedTaskIdentifier theQ )
{
// Returning general failure for AbortTaskRequest as this isn't yet supported by our HBA
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
}
SCSIServiceResponse
com_apple_dts_SCSIEmulatorAdapter::AbortTaskSetRequest (
SCSITargetIdentifier theT,
SCSILogicalUnitNumber theL )
{
// Returning general failure for AbortTaskSetRequest as this isn't yet supported by our HBA
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
}
SCSIServiceResponse
com_apple_dts_SCSIEmulatorAdapter::ClearACARequest (
SCSITargetIdentifier theT,
SCSILogicalUnitNumber theL )
{
// Returning general failure for ClearACARequest as this isn't yet supported by our HBA
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
}
SCSIServiceResponse
com_apple_dts_SCSIEmulatorAdapter::ClearTaskSetRequest (
SCSITargetIdentifier theT,
SCSILogicalUnitNumber theL )
{
// Returning general failure for ClearTaskSetRequest as this isn't yet supported by our HBA
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
}
SCSIServiceResponse
com_apple_dts_SCSIEmulatorAdapter::LogicalUnitResetRequest (
SCSITargetIdentifier theT,
SCSILogicalUnitNumber theL )
{
// Returning general failure for LogicalUnitResetRequest as this isn't yet supported by our HBA
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
}
SCSIServiceResponse
com_apple_dts_SCSIEmulatorAdapter::TargetResetRequest (
SCSITargetIdentifier theT )
{
// Returning general failure for TargetResetRequest as this isn't yet supported by our HBA
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
}
SCSIInitiatorIdentifier
com_apple_dts_SCSIEmulatorAdapter::ReportInitiatorIdentifier ( void )
{
// What device ID does our HBA occupy on the bus?
SCSIInitiatorIdentifier ourIdentity = INITIATOR_IDENTIFIER;
return ourIdentity;
}
SCSIDeviceIdentifier
com_apple_dts_SCSIEmulatorAdapter::ReportHighestSupportedDeviceID ( void )
{
// This HBA can handle how many attached devices? The actual number can be lower
SCSIDeviceIdentifier highestValidDevice = kMaxTargetID;
return highestValidDevice;
}
UInt32
com_apple_dts_SCSIEmulatorAdapter::ReportMaximumTaskCount ( void )
{
// How many concurrent tasks does our HBA support?
// Given that this is the parallel tasking SCSI family, you'd
// expect this to be greater than 1, but single task HBAs are
// supported as well
UInt32 maxTasks = kMaxTasks;
return maxTasks;
}
UInt32
com_apple_dts_SCSIEmulatorAdapter::ReportHBASpecificTaskDataSize ( void )
{
// How much space do we need allocated internally for each task?
UInt32 taskDataSize = sizeof(SCSIEmulatorRequestBlock);
return taskDataSize;
}
UInt32
com_apple_dts_SCSIEmulatorAdapter::ReportHBASpecificDeviceDataSize ( void )
{
// How much space do we need allocated internally for each attached device?
UInt32 hbaDataSize = sizeof(com_apple_dts_SCSIEmulator *);
return hbaDataSize;
}
bool
com_apple_dts_SCSIEmulatorAdapter::DoesHBAPerformDeviceManagement ( void )
{
// Report that we *DO NOT* manage our own devices
// We will have the system query each possible target during startup
// and do not expect or handle changes to this list while running
// If you know that the bus is static and won't change, you can report false here and let the
// OS handle discovering any attached devices. If this is a SCSI bus where devices can be
// dynamically added/removed, then you will need to return true and have a mechanism for
// detecting, adding and removing devices as needed.
#if 0
// If you were to do device management yourself, you would have to do something like:
SCSIDeviceIdentifier index = 0
CreateTargetForID(index++);
// Use DestroyTargetForID() to remove targets as they disappear
#endif
// This HBA does not support a mechanism for device attach/detach
// notification, go ahead and create target devices.
return false;
}
bool
com_apple_dts_SCSIEmulatorAdapter::InitializeController ( void )
{
com_apple_dts_SCSIEmulatorAdapterNub *nub = NULL;
IOReturn ret = kIOReturnSuccess;
nub = OSDynamicCast(com_apple_dts_SCSIEmulatorAdapterNub, getProvider());
if (!nub) {
IOLog("InitializeController: failed to cast provider\n");
goto failed;
}
mTargetsArray = OSArray::withCapacity(kMaxTargetID);
mResponderEventSource = OSTypeAlloc(com_apple_dts_SCSIEmulatorEventSource);
if (!mResponderEventSource) {
IOLog("InitializeController: failed to alloc mResponderEventSource\n");
goto failed;
}
if (!mResponderEventSource->init(this, &com_apple_dts_SCSIEmulatorAdapter::TaskComplete)) {
IOLog("InitializeController: failed to init mResponderEventSource\n");
mResponderEventSource->release();
goto failed;
}
ret = GetWorkLoop()->addEventSource(mResponderEventSource);
if (ret != kIOReturnSuccess) {
IOLog("InitializeController: failed to add event source. ret = 0x%X\n", ret);
mResponderEventSource->release();
goto failed;
}
goto success;
failed:
return false;
success:
// The controller is now initialized and ready for operation
return true;
}
void
com_apple_dts_SCSIEmulatorAdapter::TerminateController ( void )
{
if (GetWorkLoop()->removeEventSource(mResponderEventSource) != kIOReturnSuccess) {
IOLog("TerminateController: failed to de-register eventsource?\n");
}
if (mResponderEventSource)
mResponderEventSource->release();
if (mTargetsArray)
mTargetsArray->release();
}
bool
com_apple_dts_SCSIEmulatorAdapter::StartController ( void )
{
// Start providing HBA services. Re-init anything needed and go
return true;
}
void
com_apple_dts_SCSIEmulatorAdapter::StopController ( void )
{
// We've been requested to stop providing HBA services. Clean up and shut down
}
void
com_apple_dts_SCSIEmulatorAdapter::HandleInterruptRequest ( void )
{
// OK, odds are, your driver will want to do something here to get info from the HBA.
// Usually, this will be pulling task completion info, etc. and then calling TaskCompleted().
//
// this->TaskCompleted(task, transportSucceeded, scsiStatus, transferredDataLength, senseData, senseDataLength);
//
// Since this example operates without using a real primary interrupt, this will never get called
IOLog("HandleInterruptRequest: captured interrupt?");
}
SCSIServiceResponse
com_apple_dts_SCSIEmulatorAdapter::ProcessParallelTask ( SCSIParallelTaskIdentifier parallelRequest )
{
// Not all of these may be required. Unused ones are commented out to avoid compiler warnings
SCSITargetIdentifier targetID = GetTargetIdentifier(parallelRequest);
// SCSITaskIdentifier task = GetSCSITaskIdentifier(parallelRequest);
// SCSITaggedTaskIdentifier taggedTask = GetTaggedTaskIdentifier(parallelRequest);
SCSILogicalUnitNumber lun = GetLogicalUnitNumber(parallelRequest);
// SCSITaskAttribute taskAttribute = GetTaskAttribute(parallelRequest);
UInt8 transferDir = GetDataTransferDirection(parallelRequest);
UInt64 transferSize = GetRequestedDataTransferCount(parallelRequest);
IOMemoryDescriptor * transferMemDesc = GetDataBuffer(parallelRequest);
// UInt64 transferMemDescOffset = GetDataBufferOffset(parallelRequest);
// Get the CDB
UInt8 cdbLength = GetCommandDescriptorBlockSize(parallelRequest);
SCSICommandDescriptorBlock cdbData;
SCSITaskStatus scsiStatus = kSCSITaskStatus_GOOD;
UInt64 dataLen = 0;
UInt8 senseBuffer[kSenseBufferLen];
UInt64 senseBufferLen = sizeof(senseBuffer);
com_apple_dts_SCSIEmulator *emulator = (com_apple_dts_SCSIEmulator *)mTargetsArray->getObject(targetID);
// Fail if we don't have a SCSI emulator backing this target
if (!emulator) {
IOLog("ProcessParallelTask: ABORT - !emulator for targetID = %ud\n", targetID);
goto failure_exit;
}
// Fail if we're supposed to transfer data and don't have a data buffer
if (!transferMemDesc && (transferDir != kSCSIDataTransfer_NoDataTransfer)) {
IOLog("ProcessParallelTask: ABORT - !transferMemDesc && (transferDir != kSCSIDataTransfer_NoDataTransfer) - %p and %d\n", transferMemDesc, transferDir);
goto failure_exit;
}
// Fail if we don't have a large enough CDB buffer set aside
if (cdbLength > sizeof(cdbData)) {
IOLog("ProcessParallelTask: ABORT - cdbLength > sizeof(cdbData) - %d vs. %d\n", cdbLength, sizeof(cdbData));
goto failure_exit;
}
if (!GetCommandDescriptorBlock(parallelRequest, &cdbData)) {
IOLog("ProcessParallelTask: ABORT - !GetCommandDescriptorBlock(parallelRequest, &cdbData)\n");
goto failure_exit;
}
if (transferMemDesc && (transferDir != kSCSIDataTransfer_NoDataTransfer)) {
#if 0
// This block isn't necessary as memory descriptors passed in are always autoprepared for us.
// Remember: Any memory descriptors allocated and used internally should be prepared before sending
// or receiving data to/from real hardware
IOReturn res = transferMemDesc->prepare();
if (res != kIOReturnSuccess) {
goto failure_exit;
}
#endif
// We are guaranteed that the memory descriptor will always be sized large enough by
// by SAM/STUC to hold the transfer size requested
dataLen = transferSize;
}
// This is where the "real" work should get done by your hardware. The individual parameters
// are being sent instead of just the task reference as the task is opaque by design and
// the getter/setter methods are protected and available within this class, but not within
// the emulator itself.
emulator->sendCommand(cdbData, cdbLength, transferMemDesc, &dataLen, lun, &scsiStatus, senseBuffer, &senseBufferLen);
// Real hardware should be doing the task processing internally and providing responses
// via an interrupt mechanism. IOSCSIParallelInterfaceController expects this and you
// should always do your task completions from the workloop thread.
CompleteTaskOnWorkloopThread(parallelRequest, true, scsiStatus, dataLen, senseBuffer, senseBufferLen);
return kSCSIServiceResponse_Request_In_Process;
failure_exit:
CompleteTaskOnWorkloopThread(parallelRequest, false, scsiStatus, dataLen, senseBuffer, senseBufferLen);
return kSCSIServiceResponse_Request_In_Process;
}
void
com_apple_dts_SCSIEmulatorAdapter::CompleteTaskOnWorkloopThread (
SCSIParallelTaskIdentifier parallelRequest,
bool transportSuccessful,
SCSITaskStatus scsiStatus,
UInt64 actuallyTransferred,
UInt8* senseBuffer,
int senseLength)
{
// SCSITargetIdentifier target = GetTargetIdentifier(parallelRequest);
UInt8 transferDir = GetDataTransferDirection(parallelRequest);
UInt64 transferSizeMax = GetRequestedDataTransferCount(parallelRequest);
// IOMemoryDescriptor * transferMemDesc = GetDataBuffer(parallelRequest);
SCSIEmulatorRequestBlock * srb = ( SCSIEmulatorRequestBlock * ) GetHBADataPointer ( parallelRequest );
if (transportSuccessful && (scsiStatus != kSCSITaskStatus_TASK_SET_FULL)) {
// set the realized transfer counts
switch (transferDir) {
case kSCSIDataTransfer_FromTargetToInitiator:
{
if (actuallyTransferred > transferSizeMax) {
actuallyTransferred = transferSizeMax;
}
if (!SetRealizedDataTransferCount(parallelRequest, actuallyTransferred)) {
IOLog("CompleteTaskOnWorkloopThread: SetRealizedDataTransferCount (%d bytes) returned FAIL\n", actuallyTransferred);
}
break;
}
case kSCSIDataTransfer_FromInitiatorToTarget:
{
if (actuallyTransferred > transferSizeMax) {
actuallyTransferred = transferSizeMax;
}
if (!SetRealizedDataTransferCount(parallelRequest, actuallyTransferred)) {
IOLog("CompleteTaskOnWorkloopThread: SetRealizedDataTransferCount (%d bytes) returned FAIL\n", actuallyTransferred);
}
break;
}
case kSCSIDataTransfer_NoDataTransfer:
default:
{
break;
}
}
}
// Now, add the completion to the queue to be checked by the workloop thread. The completion needs
// to be done on the workloop to allow the stack to unwind itself or you risk running into a panic.
// The addItemToQueue method in the event source signals the workloop to check the queue after the task
// is added.
if (!transportSuccessful) {
IOLog("CompleteTaskOnWorkloopThread: Failed transport - task = %p, transferDir = %d, transferSize = %lld, scsiStatus = 0x%X\n", parallelRequest, transferDir, transferSizeMax, scsiStatus);
queue_init(&srb->fQueueChain);
srb->fTask = parallelRequest;
srb->fTaskStatus = scsiStatus;
srb->fServiceResponse = kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
mResponderEventSource->addItemToQueue(srb);
} else {
// handle sense data in common fashion and complete the task
if (senseLength > 0) {
if (!SetAutoSenseData(parallelRequest, (SCSI_Sense_Data*) senseBuffer, senseLength)) {
IOLog("CompleteTaskOnWorkloopThread: Could not set sense data in parallel task\n");
}
}
queue_init(&srb->fQueueChain);
srb->fTask = parallelRequest;
srb->fTaskStatus = scsiStatus;
srb->fServiceResponse = kSCSIServiceResponse_TASK_COMPLETE;
mResponderEventSource->addItemToQueue(srb);
}
}
void
com_apple_dts_SCSIEmulatorAdapter::TaskComplete (com_apple_dts_SCSIEmulatorAdapter *owner, SCSIEmulatorRequestBlock response)
{
owner->CompleteParallelTask(response.fTask, response.fTaskStatus, response.fServiceResponse);
}
</pre>
<!--googleoff: index -->
</td>
</tr>
</table>
<!-- END WIDE COLUMN -->
<!-- END MAIN CONTENT -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><div style="width: 100%; height: 1px; background-color: #919699; margin-top: 5px; margin-bottom: 15px"></div></td>
</tr>
<tr>
<td align="center"><br/>
<table border="0" cellpadding="0" cellspacing="0" class="graybox">
<tr>
<th>Did this document help you?</th>
</tr>
<tr>
<td>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=1&url=/samplecode/SCSIHBAEmulator/listing3.html%3Fid%3DDTS10004195-1.0&media=dvd" target=_new>Yes</a>: Tell us what works for you.</div>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=2&url=/samplecode/SCSIHBAEmulator/listing3.html%3Fid%3DDTS10004195-1.0&media=dvd" target=_new>It’s good, but:</a> Report typos, inaccuracies, and so forth.</div>
<div><a href="http://developer.apple.com/feedback/?v=3&url=/samplecode/SCSIHBAEmulator/listing3.html%3Fid%3DDTS10004195-1.0&media=dvd" target=_new>It wasn’t helpful</a>: Tell us what would have helped.</div>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- START BOTTOM APPLE NAVIGATION -->
<!--#include virtual="/includes/footer"-->
<!-- END BOTTOM APPLE NAVIGATION -->
<!-- START CENTER CLOSE -->
</center>
<!-- END CENTER CLOSE -->
</body>
</html>