/
common.c
9098 lines (7245 loc) · 333 KB
/
common.c
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
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*++
Copyright (C) Microsoft Corporation, 2009
Module Name:
common.c
Abstract:
This file contains common ATA related functions.
Notes:
Revision History:
--*/
#if _MSC_VER >= 1200
#pragma warning(push)
#endif
#pragma warning(disable:4214) // bit field types other than int
#pragma warning(disable:4201) // nameless struct/union
#pragma warning(disable:26015) //26015: "Potential overflow"
#include "generic.h"
//
// This structure is used as a wrapper of a MODE_PARAMETER_HEADER
// or MODE_PARAMETER_HEADER10. Code that uses this structure can be
// agnostic as to the underlying structure.
//
typedef struct _MODE_PARAMETER_HEADER_WRAPPER {
//
// Pointer to the actual MODE_PARAMETER_HEADER/10.
//
PVOID ModePageHeader;
//
// The size in bytes of the structure pointed to by ModePageHeader.
//
ULONG HeaderSize;
//
// A pointer to the DeviceSpecificParameter field of ModePageHeader.
//
PUCHAR DeviceSpecificParameter;
//
// A pointer to the ModeDataLength field of ModePageHeader. If ModePageHeader
// is a pointer to MODE_PARAMETER_HEADER10, then this field points to the least
// significant byte of ModePageHeader's ModeDataLength field.
//
PUCHAR ModeDataLength;
} MODE_PARAMETER_HEADER_WRAPPER, *PMODE_PARAMETER_HEADER_WRAPPER;
VOID
ULong2HexString (
_In_ ULONG Number,
_Inout_updates_bytes_ (Length) PUCHAR StringBuffer,
_In_ ULONG Length
);
VOID
BuildHybridEvictCommand(
_Inout_ PAHCI_H2D_REGISTER_FIS CFIS,
_In_ USHORT BlockCount
);
ULONG
QueryProtocolInfoIoctlProcess(
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb
);
ULONG
QueryTemperatureInfoIoctlProcess(
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb
);
ULONG
QueryPhysicalTopologyIoctlProcess(
_In_ PAHCI_ADAPTER_EXTENSION AdapterExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb
);
VOID
AtaAlwaysSuccessRequestCompletion (
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb
);
__inline
BOOLEAN
IsExceptionCommand(
_In_ PCDB Cdb
)
/*
Return true for enumeration and power transition related command.
*/
{
return ((Cdb->CDB10.OperationCode == SCSIOP_REPORT_LUNS) ||
(Cdb->CDB10.OperationCode == SCSIOP_INQUIRY) ||
(Cdb->CDB10.OperationCode == SCSIOP_START_STOP_UNIT) ||
(Cdb->CDB10.OperationCode == SCSIOP_SECURITY_PROTOCOL_OUT) ||
(Cdb->CDB10.OperationCode == SCSIOP_SECURITY_PROTOCOL_IN) ||
(Cdb->CDB10.OperationCode == SCSIOP_SYNCHRONIZE_CACHE));
}
__inline
BOOLEAN
RetryCommand(
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PCDB Cdb
)
/*
If initialization triggered by power up in progress, return false;
else if port start/init/restore preserved settings command outstanding, and
command(e.g. enumeration and power transition related) is not in exception
list, return true;
Otherwise, return false.
*/
{
//
// If power up in progress, do not retry anything.
//
if (ChannelExtension->StateFlags.PowerUpInitializationInProgress) {
return FALSE;
}
if ((ChannelExtension->StateFlags.ReservedSlotInUse ||
((ChannelExtension->StartState.ChannelNextStartState != StartComplete) &&
(ChannelExtension->StartState.ChannelNextStartState != StartFailed))) &&
(!IsExceptionCommand(Cdb))) {
return TRUE;
}
return FALSE;
}
ULONG
SCSItoATA(
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb
)
/*
Note: If there is a need to send a command to device,
the translation routine shall set appropriate value to srbExtension->AtaFunction.
For example: srbExtension->AtaFunction = ATA_FUNCTION_ATA_COMMAND;
Not setting this field can cause the Srb being completed earlier than expected.
*/
{
ULONG status;
ULONG cdbLength = 0;
PCDB cdb = RequestGetSrbScsiData(Srb, &cdbLength, NULL, NULL, NULL);
if (cdb != NULL) {
if (IsAtapiDevice(&ChannelExtension->DeviceExtension->DeviceParameters)) {
// Atapi command
status = SrbConvertToATAPICommand(ChannelExtension, Srb, cdb);
} else if (IsAtaDevice(&ChannelExtension->DeviceExtension->DeviceParameters) ||
(cdb->CDB10.OperationCode == SCSIOP_REPORT_LUNS) ||
(cdb->CDB10.OperationCode == SCSIOP_INQUIRY) ) {
//
// Fail SRB with busy status to storport if port start is in progress or init/restore
// preserved settings command outstanding. Storport will retry these IOs later.
//
if (RetryCommand(ChannelExtension, cdb)) {
Srb->SrbStatus = SRB_STATUS_BUSY;
status = STOR_STATUS_BUSY;
} else {
// Ata command, or device enumeration commands.
status = SrbConvertToATACommand(ChannelExtension, Srb, cdb, cdbLength);
}
} else {
Srb->SrbStatus = SRB_STATUS_NO_DEVICE;
status = STOR_STATUS_INVALID_DEVICE_REQUEST;
}
} else {
Srb->SrbStatus = SRB_STATUS_BAD_FUNCTION;
status = STOR_STATUS_INVALID_PARAMETER;
}
return status;
}
ULONG
SrbConvertToATAPICommand(
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb,
_In_ PCDB Cdb
)
/*
Note: If there is a need to send a command to device,
the translation routine shall set appropriate value to srbExtension->AtaFunction.
For example: srbExtension->AtaFunction = ATA_FUNCTION_ATAPI_COMMAND;
Not setting this field can cause the Srb being completed earlier than expected.
*/
{
ULONG status;
switch (Cdb->CDB10.OperationCode) {
case SCSIOP_MODE_SENSE:
if (IsTapeDevice(ChannelExtension->DeviceExtension)) {
// tape drive specific.
status = AtapiCommonRequest(ChannelExtension, Srb, Cdb);
} else {
// special process for 6 bytes command, storahci always send down 10 bytes command to device
status = AtapiModeSenseRequest(ChannelExtension, Srb, Cdb);
}
break;
case SCSIOP_MODE_SELECT:
if (IsTapeDevice(ChannelExtension->DeviceExtension)) {
// tape drive specific.
status = AtapiCommonRequest(ChannelExtension, Srb, Cdb);
} else {
// special process for 6 bytes command, storahci always send down 10 bytes command to device
status = AtapiModeSelectRequest(ChannelExtension, Srb, Cdb);
}
break;
case SCSIOP_INQUIRY:
status = AtapiInquiryRequest(ChannelExtension, Srb);
break;
case SCSIOP_REPORT_LUNS:
//use cached info for this command.
status = AtaReportLunsCommand(ChannelExtension, (PVOID)Srb);
break;
case SCSIOP_ATA_PASSTHROUGH16:
status = AtaPassThroughRequest(ChannelExtension, Srb, Cdb);
break;
default:
status = AtapiCommonRequest(ChannelExtension, Srb, Cdb);
break;
}
return status;
}
ULONG
AtapiCommonRequest (
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb,
_In_ PCDB Cdb
)
/*++
Routine Description:
--*/
{
PAHCI_SRB_EXTENSION srbExtension = GetSrbExtension(Srb);
ULONG srbFlags = SrbGetSrbFlags(Srb);
UNREFERENCED_PARAMETER(ChannelExtension);
srbExtension->AtaFunction = ATA_FUNCTION_ATAPI_COMMAND;
if (srbFlags & SRB_FLAGS_DATA_IN) {
srbExtension->Flags |= ATA_FLAGS_DATA_IN;
}
if (srbFlags & SRB_FLAGS_DATA_OUT) {
srbExtension->Flags |= ATA_FLAGS_DATA_OUT;
}
// set the transfer mode to be used
if ( DmaSafeAtapiCommand(Cdb->CDB10.OperationCode) ) {
srbExtension->Flags |= ATA_FLAGS_USE_DMA;
}
return STOR_STATUS_SUCCESS;
}
VOID
AtapiInquiryCompletion (
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb
)
{
STOR_UNIT_ATTRIBUTES attributes = {0};
UCHAR pathId = 0;
UCHAR targetId = 0;
UCHAR lun = 0;
if (Srb->SrbStatus != SRB_STATUS_SUCCESS) {
return;
}
SrbGetPathTargetLun(Srb, &pathId, &targetId, &lun);
StorPortSetDeviceQueueDepth(ChannelExtension->AdapterExtension,
pathId,
targetId,
lun,
ChannelExtension->MaxPortQueueDepth);
if (IsAtapiDevice(&ChannelExtension->DeviceExtension->DeviceParameters)) {
attributes.DeviceAttentionSupported = ChannelExtension->DeviceExtension[0].IdentifyPacketData->SerialAtaCapabilities.SlimlineDeviceAttention;
attributes.AsyncNotificationSupported = IsDeviceSupportsAN(ChannelExtension->DeviceExtension->IdentifyPacketData);
attributes.D3ColdNotSupported = (ChannelExtension->AdapterExtension->StateFlags.SupportsAcpiDSM == 0);
StorPortSetUnitAttributes(ChannelExtension->AdapterExtension,
(PSTOR_ADDRESS)&ChannelExtension->DeviceExtension[0].DeviceAddress,
attributes);
}
return;
}
ULONG
AtapiInquiryRequest (
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb
)
/*++
Routine Description:
--*/
{
PAHCI_SRB_EXTENSION srbExtension = GetSrbExtension(Srb);
UNREFERENCED_PARAMETER(ChannelExtension);
srbExtension->AtaFunction = ATA_FUNCTION_ATAPI_COMMAND;
srbExtension->CompletionRoutine = AtapiInquiryCompletion;
srbExtension->Flags |= ATA_FLAGS_DATA_IN;
return STOR_STATUS_SUCCESS;
}
VOID
AtapiModeCommandRequestCompletion (
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb
)
/*++
Description
Used as completion routine for: AtapiModeSenseRequest and AtapiModeSelectRequest
Arguments:
Return value:
--*/
{
PVOID dataBuffer = SrbGetDataBuffer(Srb);
UCHAR bytesAdjust = sizeof(MODE_PARAMETER_HEADER10) - sizeof(MODE_PARAMETER_HEADER);
PAHCI_SRB_EXTENSION srbExtension = GetSrbExtension(Srb);
if (Srb->SrbStatus == SRB_STATUS_BUS_RESET) {
if (srbExtension->DataBuffer != NULL) {
AhciFreeDmaBuffer(ChannelExtension->AdapterExtension, (ULONG_PTR)srbExtension->CompletionContext, srbExtension->DataBuffer, srbExtension->DataBufferPhysicalAddress);
srbExtension->DataBuffer = NULL;
}
return;
}
if ((dataBuffer == NULL) || (srbExtension->DataBuffer == NULL) ||
(SrbGetDataTransferLength(Srb) < sizeof(MODE_PARAMETER_HEADER)) ||
(srbExtension->DataTransferLength < sizeof(MODE_PARAMETER_HEADER)) ) {
// free the memory and mark the Srb with error status.
if (srbExtension->DataBuffer != NULL) {
AhciFreeDmaBuffer(ChannelExtension->AdapterExtension, (ULONG_PTR)srbExtension->CompletionContext, srbExtension->DataBuffer, srbExtension->DataBufferPhysicalAddress);
srbExtension->DataBuffer = NULL;
}
Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST;
return;
}
if (srbExtension->Cdb.CDB10.OperationCode == SCSIOP_MODE_SENSE10) {
// if it's completion routine for MODE SENSE, copy the data back to original buffer
PUCHAR originalBuffer;
PUCHAR currentBuffer;
PMODE_PARAMETER_HEADER header;
PMODE_PARAMETER_HEADER10 header10;
ULONG transferLength = RequestGetDataTransferLength(Srb);
originalBuffer = (PUCHAR)dataBuffer;
currentBuffer = (PUCHAR)srbExtension->DataBuffer;
NT_ASSERT(originalBuffer != NULL);
NT_ASSERT(currentBuffer != NULL);
header = (PMODE_PARAMETER_HEADER)originalBuffer;
header10 = (PMODE_PARAMETER_HEADER10)currentBuffer;
// Mode parameter header 10 and mode parameter header 6 differ by 3 bytes
header->ModeDataLength = header10->ModeDataLength[1] - 3;
header->MediumType = header10->MediumType;
// ATAPI Mode Parameter Header doesn't have these fields.
header->DeviceSpecificParameter = header10->DeviceSpecificParameter;
header->BlockDescriptorLength = header10->BlockDescriptorLength[1];
// copy the rest of the data
if (transferLength > sizeof(MODE_PARAMETER_HEADER10)) {
StorPortCopyMemory(originalBuffer+sizeof(MODE_PARAMETER_HEADER),
currentBuffer+sizeof(MODE_PARAMETER_HEADER10),
min(SrbGetDataTransferLength(Srb) - sizeof(MODE_PARAMETER_HEADER), transferLength - sizeof(MODE_PARAMETER_HEADER10)));
}
// adjust data transfer length.
if (transferLength > bytesAdjust) {
SrbSetDataTransferLength(Srb, transferLength - bytesAdjust);
} else {
// error. transfer length should be zero.
// if it is less than the header, we will just pass it up.
SrbSetDataTransferLength(Srb, transferLength);
}
}
if (srbExtension->DataBuffer != NULL) {
AhciFreeDmaBuffer(ChannelExtension->AdapterExtension, (ULONG_PTR)srbExtension->CompletionContext, srbExtension->DataBuffer, srbExtension->DataBufferPhysicalAddress);
srbExtension->DataBuffer = NULL;
}
return;
}
ULONG
AtapiModeSenseRequest (
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb,
_In_ PCDB Cdb
)
/*++
--*/
{
ULONG status;
ULONG modeSenseBufferSize;
PMODE_PARAMETER_HEADER10 modeSenseBuffer;
STOR_PHYSICAL_ADDRESS modeSensePhysicalAddress = {0};
PUCHAR origBuffer;
UCHAR bytesAdjust;
PCDB cdb;
USHORT allocationLength;
PMODE_PARAMETER_HEADER header;
PMODE_PARAMETER_HEADER10 header10;
PAHCI_SRB_EXTENSION srbExtension = GetSrbExtension(Srb);
PVOID srbDataBuffer = SrbGetDataBuffer(Srb);
ULONG srbDataBufferLength = SrbGetDataTransferLength(Srb);
status = STOR_STATUS_SUCCESS;
modeSenseBuffer = NULL;
modeSenseBufferSize = 0;
bytesAdjust = sizeof(MODE_PARAMETER_HEADER10) - sizeof(MODE_PARAMETER_HEADER);
// Validate input length
if (srbDataBufferLength < sizeof(MODE_PARAMETER_HEADER)) {
Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST;
status = STOR_STATUS_BUFFER_TOO_SMALL;
goto Done;
}
if (srbDataBuffer == NULL) {
Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST;
status = STOR_STATUS_INVALID_PARAMETER;
goto Done;
}
modeSenseBufferSize = srbDataBufferLength + bytesAdjust;
origBuffer = (PUCHAR)srbDataBuffer;
if (modeSenseBufferSize < sizeof(MODE_PARAMETER_HEADER10) ) {
Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST;
status = STOR_STATUS_BUFFER_TOO_SMALL;
goto Done;
}
// We need to allocate a new data buffer since the size is different
status = AhciAllocateDmaBuffer(ChannelExtension->AdapterExtension, modeSenseBufferSize, (PVOID*)&modeSenseBuffer, &modeSensePhysicalAddress);
if ( (status != STOR_STATUS_SUCCESS) ||
(modeSenseBuffer == NULL) ) {
// memory allocation failed
Srb->SrbStatus = SRB_STATUS_ERROR;
status = STOR_STATUS_INSUFFICIENT_RESOURCES;
goto Done;
}
AhciZeroMemory((PCHAR)modeSenseBuffer, modeSenseBufferSize);
// fill information in the new MODE_SENSE10 header
allocationLength = Cdb->MODE_SENSE.AllocationLength;
header = (PMODE_PARAMETER_HEADER)origBuffer;
header10 = (PMODE_PARAMETER_HEADER10)modeSenseBuffer;
header10->ModeDataLength[1] = header->ModeDataLength;
header10->MediumType = header->MediumType;
header10->BlockDescriptorLength[1] = header->BlockDescriptorLength;
allocationLength += bytesAdjust;
// set up cdb of MODE_SENSE10
cdb = (PCDB)&srbExtension->Cdb;
cdb->MODE_SENSE10.OperationCode = SCSIOP_MODE_SENSE10;
cdb->MODE_SENSE10.Dbd = Cdb->MODE_SENSE.Dbd;
cdb->MODE_SENSE10.PageCode = Cdb->MODE_SENSE.PageCode;
cdb->MODE_SENSE10.Pc = Cdb->MODE_SENSE.Pc;
cdb->MODE_SENSE10.AllocationLength[0] = (UCHAR) (allocationLength >> 8);
cdb->MODE_SENSE10.AllocationLength[1] = (UCHAR) (allocationLength & 0xff);
cdb->MODE_SENSE10.Control = Cdb->MODE_SENSE.Control;
// fill in the srbExtension fields
srbExtension->AtaFunction = ATA_FUNCTION_ATAPI_COMMAND;
srbExtension->Flags |= ATA_FLAGS_NEW_CDB;
srbExtension->Flags |= ATA_FLAGS_DATA_IN;
srbExtension->DataBuffer = modeSenseBuffer;
srbExtension->DataBufferPhysicalAddress.QuadPart = modeSensePhysicalAddress.QuadPart;
srbExtension->DataTransferLength = modeSenseBufferSize;
srbExtension->CompletionRoutine = AtapiModeCommandRequestCompletion;
srbExtension->CompletionContext = (PVOID)modeSenseBufferSize; // preserve the buffer size, it's needed for freeing the memory
srbExtension->LocalSgl.NumberOfElements = 1;
srbExtension->LocalSgl.List[0].PhysicalAddress.LowPart = modeSensePhysicalAddress.LowPart;
srbExtension->LocalSgl.List[0].PhysicalAddress.HighPart = modeSensePhysicalAddress.HighPart;
srbExtension->LocalSgl.List[0].Length = modeSenseBufferSize;
srbExtension->Sgl = &srbExtension->LocalSgl;
Done:
if (status != STOR_STATUS_SUCCESS) {
if (modeSenseBuffer != NULL) {
AhciFreeDmaBuffer(ChannelExtension->AdapterExtension, modeSenseBufferSize, modeSenseBuffer, modeSensePhysicalAddress);
}
srbExtension->DataBuffer = NULL;
}
return status;
}
ULONG
AtapiModeSelectRequest (
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb,
_In_ PCDB Cdb
)
/*++
return value: STOR_STATUS
--*/
{
ULONG status;
PVOID modeSelectBuffer;
ULONG modeSelectBufferSize;
STOR_PHYSICAL_ADDRESS modeSelectPhysicalAddress = {0};
UCHAR bytesToSkip;
PUCHAR origBuffer;
UCHAR bytesAdjust;
PCDB cdb;
USHORT paramListLength;
PMODE_PARAMETER_HEADER header;
PMODE_PARAMETER_HEADER10 header10;
PAHCI_SRB_EXTENSION srbExtension = GetSrbExtension(Srb);
PVOID srbDataBuffer = SrbGetDataBuffer(Srb);
ULONG srbDataBufferLength = SrbGetDataTransferLength(Srb);
status = STOR_STATUS_SUCCESS;
modeSelectBuffer = NULL;
modeSelectBufferSize = 0;
origBuffer = (PUCHAR)srbDataBuffer;
header = (PMODE_PARAMETER_HEADER)origBuffer;
if (srbDataBuffer == NULL) {
Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST;
status = STOR_STATUS_INVALID_PARAMETER;
goto Done;
}
// Validate input length
if ( (srbDataBufferLength < sizeof(MODE_PARAMETER_HEADER)) ||
(srbDataBufferLength < (sizeof(MODE_PARAMETER_HEADER) + header->BlockDescriptorLength)) ) {
Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST;
status = STOR_STATUS_BUFFER_TOO_SMALL;
goto Done;
}
// Check for invalid BlockDescriptorLength
if ( (sizeof(MODE_PARAMETER_HEADER) + header->BlockDescriptorLength) > 0xFF ) {
Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST;
status = STOR_STATUS_INVALID_PARAMETER;
goto Done;
}
// Atapi devices don't use the block descriptor.
bytesAdjust = sizeof(MODE_PARAMETER_HEADER10) - sizeof(MODE_PARAMETER_HEADER);
modeSelectBufferSize = srbDataBufferLength + bytesAdjust - header->BlockDescriptorLength;
// allocate buffer for the new cdb
status = AhciAllocateDmaBuffer(ChannelExtension->AdapterExtension, modeSelectBufferSize, (PVOID*)&modeSelectBuffer, &modeSelectPhysicalAddress);
if ( (status != STOR_STATUS_SUCCESS) ||
(modeSelectBuffer == NULL) ) {
//
Srb->SrbStatus = SRB_STATUS_ERROR;
status = STOR_STATUS_INSUFFICIENT_RESOURCES;
goto Done;
}
AhciZeroMemory((PCHAR)modeSelectBuffer, modeSelectBufferSize);
header10 = (PMODE_PARAMETER_HEADER10)modeSelectBuffer;
header10->ModeDataLength[1] = header->ModeDataLength;
header10->MediumType = header->MediumType;
// block descriptor length in header10 should be 0 for ATAPI devices
// do not copy the block descriptor. Atapi devices don't use the block descriptor.
bytesToSkip = sizeof(MODE_PARAMETER_HEADER) + header->BlockDescriptorLength;
// Copy any remaining buffer contents
if (srbDataBufferLength > bytesToSkip) {
StorPortCopyMemory( ((PUCHAR)modeSelectBuffer + sizeof(MODE_PARAMETER_HEADER10)),
((PUCHAR)origBuffer + bytesToSkip),
(srbDataBufferLength - bytesToSkip) );
}
paramListLength = Cdb->MODE_SELECT.ParameterListLength;
paramListLength += sizeof(MODE_PARAMETER_HEADER10);
// Check for integer overflow
if (paramListLength < sizeof(MODE_PARAMETER_HEADER10)) {
Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST;
status = STOR_STATUS_INVALID_PARAMETER;
goto Done;
}
// Invalid paramListLength in the original cdb
if (paramListLength < bytesToSkip) {
Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST;
status = STOR_STATUS_INVALID_PARAMETER;
goto Done;
}
paramListLength -= bytesToSkip;
// fill in the srbExtension fields
srbExtension->AtaFunction = ATA_FUNCTION_ATAPI_COMMAND;
srbExtension->Flags |= ATA_FLAGS_NEW_CDB;
srbExtension->Flags |= ATA_FLAGS_DATA_OUT;
srbExtension->DataBuffer = modeSelectBuffer;
srbExtension->DataBufferPhysicalAddress.QuadPart = modeSelectPhysicalAddress.QuadPart;
srbExtension->DataTransferLength = modeSelectBufferSize;
srbExtension->CompletionRoutine = AtapiModeCommandRequestCompletion;
srbExtension->CompletionContext = (PVOID)modeSelectBufferSize; // preserve the buffer size, it's needed for freeing the memory
cdb = (PCDB)&srbExtension->Cdb;
// fill in the cdb
cdb->MODE_SELECT10.OperationCode = SCSIOP_MODE_SELECT10; // ATAPI device supports MODE SELECT 10
cdb->MODE_SELECT10.SPBit = Cdb->MODE_SELECT.SPBit;
cdb->MODE_SELECT10.PFBit = 1;
cdb->MODE_SELECT10.LogicalUnitNumber = Cdb->MODE_SELECT.LogicalUnitNumber;
cdb->MODE_SELECT10.ParameterListLength[0] = (UCHAR)(paramListLength >> 8);
cdb->MODE_SELECT10.ParameterListLength[1] = (UCHAR)(paramListLength & 0xff);
cdb->MODE_SELECT10.Control = Cdb->MODE_SELECT.Control;
srbExtension->LocalSgl.NumberOfElements = 1;
srbExtension->LocalSgl.List[0].PhysicalAddress.LowPart = modeSelectPhysicalAddress.LowPart;
srbExtension->LocalSgl.List[0].PhysicalAddress.HighPart = modeSelectPhysicalAddress.HighPart;
srbExtension->LocalSgl.List[0].Length = modeSelectBufferSize; // preserve the buffer size, it's needed for freeing the memory
srbExtension->Sgl = &srbExtension->LocalSgl;
Done:
if (status != STOR_STATUS_SUCCESS) {
if (modeSelectBuffer != NULL) {
AhciFreeDmaBuffer(ChannelExtension->AdapterExtension, modeSelectBufferSize, modeSelectBuffer, modeSelectPhysicalAddress);
}
srbExtension->DataBuffer = NULL;
}
return status;
}
ULONG
SrbConvertToATACommand(
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb,
_In_ PCDB Cdb,
_In_ ULONG CdbLength
)
/*
Srb to a ATA device must be translated to an ATA command
Note: If there is a need to send a command to device,
the translation routine shall set appropriate value to srbExtension->AtaFunction.
For example: srbExtension->AtaFunction = ATA_FUNCTION_ATA_COMMAND;
Not setting this field can cause the Srb being completed earlier than expected.
*/
{
ULONG status = STOR_STATUS_INVALID_DEVICE_REQUEST;
// translate the cdb to task file register values
switch (Cdb->CDB10.OperationCode) {
case SCSIOP_READ:
case SCSIOP_WRITE:
case SCSIOP_READ16:
case SCSIOP_WRITE16:
status = AtaReadWriteRequest(ChannelExtension, Srb, Cdb, CdbLength);
break;
case SCSIOP_VERIFY:
case SCSIOP_VERIFY16:
status = AtaVerifyRequest(ChannelExtension, Srb, Cdb, CdbLength);
break;
case SCSIOP_MODE_SENSE:
case SCSIOP_MODE_SENSE10:
status = AtaModeSenseRequest(ChannelExtension, Srb, Cdb);
break;
case SCSIOP_MODE_SELECT:
case SCSIOP_MODE_SELECT10:
status = AtaModeSelectRequest(ChannelExtension, Srb, Cdb);
break;
case SCSIOP_READ_CAPACITY:
status = AtaReadCapacityRequest(ChannelExtension, Srb, Cdb, CdbLength);
break;
case SCSIOP_READ_CAPACITY16:
//
// Get physical element status & Remove element and truncate command share the same operation code 0x9e
// with read capacity 16 command.
//
if (Cdb->READ_CAPACITY16.ServiceAction == SERVICE_ACTION_READ_CAPACITY16) {
status = AtaReadCapacityRequest(ChannelExtension, Srb, Cdb, CdbLength);
} else if (Cdb->GET_PHYSICAL_ELEMENT_STATUS.ServiceAction == SERVICE_ACTION_GET_PHYSICAL_ELEMENT_STATUS) {
status = AtaGetPhysicalElementStatusRequest(ChannelExtension, Srb, Cdb);
} else if (Cdb->REMOVE_ELEMENT_AND_TRUNCATE.ServiceAction == SERVICE_ACTION_REMOVE_ELEMENT_AND_TRUNCATE) {
status = AtaRemoveElementAndTruncateRequest(ChannelExtension, Srb, Cdb);
} else {
Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST;
}
break;
case SCSIOP_INQUIRY:
status = AtaInquiryRequest(ChannelExtension, Srb, Cdb);
break;
case SCSIOP_REPORT_LUNS:
status = AtaReportLunsCommand(ChannelExtension, (PVOID)Srb);
break;
case SCSIOP_START_STOP_UNIT:
status = AtaStartStopUnitRequest(ChannelExtension, Srb, Cdb);
break;
case SCSIOP_TEST_UNIT_READY:
status = AtaTestUnitReadyRequest(ChannelExtension, Srb);
break;
case SCSIOP_MEDIUM_REMOVAL:
status = AtaMediumRemovalRequest(ChannelExtension, Srb, Cdb);
break;
case SCSIOP_SYNCHRONIZE_CACHE:
status = AtaFlushCommandRequest(ChannelExtension, Srb);
break;
case SCSIOP_SECURITY_PROTOCOL_IN:
case SCSIOP_SECURITY_PROTOCOL_OUT:
// Use a common function as SECURITY_PROTOCOL_IN and SECURITY_PROTOCOL_OUT structures are same.
status = AtaSecurityProtocolRequest(ChannelExtension, Srb, Cdb);
break;
case SCSIOP_ATA_PASSTHROUGH16:
status = AtaPassThroughRequest(ChannelExtension, Srb, Cdb);
break;
case SCSIOP_UNMAP:
status = AtaUnmapRequest(ChannelExtension, Srb);
break;
case SCSIOP_WRITE_DATA_BUFF:
status = AtaWriteBufferRequest(ChannelExtension, Srb, Cdb);
break;
case SCSIOP_READ_DATA_BUFF16:
if (Cdb->READ_BUFFER_16.Mode == READ_BUFFER_MODE_ERROR_HISTORY) {
if (Cdb->READ_BUFFER_16.BufferId == BUFFER_ID_RETURN_ERROR_HISTORY_DIRECTORY) {
status = AtaGetDeviceCurrentInternalStatusDataHeader(ChannelExtension, Srb, Cdb);
} else if((Cdb->READ_BUFFER_16.BufferId >= BUFFER_ID_RETURN_ERROR_HISTORY_MINIMUM_THRESHOLD) &&
(Cdb->READ_BUFFER_16.BufferId <= BUFFER_ID_RETURN_ERROR_HISTORY_MAXIMUM_THRESHOLD)) {
status = AtaGetDeviceCurrentInternalStatusData(ChannelExtension, Srb, Cdb);
} else {
Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST;
}
} else {
Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST;
}
break;
default:
Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST;
break;
}
if (status != STOR_STATUS_SUCCESS) {
} else {
PAHCI_SRB_EXTENSION srbExtension = GetSrbExtension(Srb);
AHCI_H2D_REGISTER_FIS cfis = srbExtension->Cfis; // Size is 20 bytes (shares first 16 with TaskFile)
// Convert the Cfis to an array of ULONGs to log the struct in pieces
PULONG cfisAsUlong = (PULONG)&cfis; // Length is 5 ULONGs
StorPortEtwEvent8(ChannelExtension->AdapterExtension,
(PSTOR_ADDRESS)&(ChannelExtension->DeviceExtension->DeviceAddress),
AhciEtwEventBuildIO,
L"SrbConvertToATACommand finished",
STORPORT_ETW_EVENT_KEYWORD_COMMAND_TRACE,
StorportEtwLevelInformational,
StorportEtwEventOpcodeInfo,
(PSCSI_REQUEST_BLOCK)Srb,
L"AtaFunction",
srbExtension->AtaFunction,
L"Cfis 0-7",
((ULONGLONG)cfisAsUlong[0] << 32) + cfisAsUlong[1],
L"Cfis 8-15",
((ULONGLONG)cfisAsUlong[2] << 32) + cfisAsUlong[3],
L"Cfis 16-20",
((ULONGLONG)cfisAsUlong[4] << 32),
L"CDB 0-7",
((ULONGLONG)Cdb->AsUlong[0] << 32) + Cdb->AsUlong[1],
L"CDB 8-15",
((ULONGLONG)Cdb->AsUlong[2] << 32) + Cdb->AsUlong[3],
NULL,
0,
NULL,
0);
}
return status;
}
VOID
AtaSetTaskFileDataRange(
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb,
_In_ ULONG64 StartingLba,
_In_ ULONG NumberOfBlocks
)
/*++
Routine Description:
Sets up the following registers in the task file:
sectorCount
sectorNum
CylLow
CylHigh
deviceHead
Arguments:
StartingLba
NumberOfBlocks
Return Value:
None.
--*/
{
LARGE_INTEGER startingSector;
PATAREGISTERS previousReg;
PATAREGISTERS currentReg;
ULONG sectorCount;
PAHCI_SRB_EXTENSION srbExtension = GetSrbExtension(Srb);
startingSector.QuadPart = StartingLba;
sectorCount = NumberOfBlocks;
NT_ASSERT(sectorCount != 0);
NT_ASSERT(sectorCount <= 0x10000);
previousReg = &srbExtension->TaskFile.Previous;
currentReg = &srbExtension->TaskFile.Current;
if (Support48Bit(&ChannelExtension->DeviceExtension->DeviceParameters)) {
// load the higher order bytes - PreviousReg
SetSectorCount(previousReg, (UCHAR)((sectorCount & 0x0000ff00) >> 8));
SetSectorNumber(previousReg, (UCHAR)(((startingSector.LowPart) & 0xff000000) >> 24));
SetCylinderLow(previousReg, (UCHAR)(((startingSector.HighPart) & 0x000000ff) >> 0));
SetCylinderHigh(previousReg, (UCHAR)(((startingSector.HighPart) & 0x0000ff00) >> 8));
// setup the device/head register.
SetDeviceReg(currentReg, IDE_LBA_MODE);
} else {
// we cannot handle more than 256 sectors
NT_ASSERT(sectorCount <= 0x100);
// The starting LBA should be less than 28 bits wide
NT_ASSERT(startingSector.HighPart == 0);
// The upper layers could still send us sectors beyond the
// end of the disk. Do not assert. Let the device fail it.
//
//NT_ASSERT((startingSector.LowPart & 0xF0000000) == 0);
// setup the device/head register.
SetDeviceReg(currentReg, (UCHAR)(IDE_LBA_MODE | (((startingSector.LowPart) & 0x0f000000) >> 24)));
}
// load the lower order bytes - CurrentReg
SetSectorCount(currentReg, (UCHAR)((sectorCount & 0x000000ff) >> 0));
SetSectorNumber(currentReg, (UCHAR)(((startingSector.LowPart) & 0x000000ff) >> 0));
SetCylinderLow(currentReg, (UCHAR)(((startingSector.LowPart) & 0x0000ff00) >> 8));
SetCylinderHigh(currentReg, (UCHAR)(((startingSector.LowPart) & 0x00ff0000) >> 16));
return;
}
VOID
HybridWriteThroughEvictCompletion(
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb
)
{
PAHCI_SRB_EXTENSION srbExtension = GetSrbExtension(Srb);
//
// Free DMA buffer that allocated for EVICT command.
//
AhciFreeDmaBuffer(ChannelExtension->AdapterExtension, ATA_BLOCK_SIZE, srbExtension->DataBuffer, srbExtension->DataBufferPhysicalAddress);
return;
}
VOID
HybridWriteThroughCompletion(
_In_ PAHCI_CHANNEL_EXTENSION ChannelExtension,
_In_ PSTORAGE_REQUEST_BLOCK Srb
)
/*++
Routine Description:
WRITE command is completed; Issue EVICT command to evict data out of caching medium.
Arguments:
ChannelExtension
Srb
Return Value:
None