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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
|
/** @file
NvmExpressDxe driver is used to manage non-volatile memory subsystem which follows
NVM Express specification.
Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "NvmExpress.h"
/**
Read some sectors from the device.
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data structure.
@param Buffer The buffer used to store the data read from the device.
@param Lba The start block number.
@param Blocks Total block number to be read.
@retval EFI_SUCCESS Datum are read from the device.
@retval Others Fail to read all the datum.
**/
EFI_STATUS
ReadSectors (
IN NVME_DEVICE_PRIVATE_DATA *Device,
IN UINT64 Buffer,
IN UINT64 Lba,
IN UINT32 Blocks
)
{
NVME_CONTROLLER_PRIVATE_DATA *Private;
UINT32 Bytes;
EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;
EFI_NVM_EXPRESS_COMMAND Command;
EFI_NVM_EXPRESS_COMPLETION Completion;
EFI_STATUS Status;
UINT32 BlockSize;
Private = Device->Controller;
BlockSize = Device->Media.BlockSize;
Bytes = Blocks * BlockSize;
ZeroMem (&CommandPacket, sizeof(EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
ZeroMem (&Command, sizeof(EFI_NVM_EXPRESS_COMMAND));
ZeroMem (&Completion, sizeof(EFI_NVM_EXPRESS_COMPLETION));
CommandPacket.NvmeCmd = &Command;
CommandPacket.NvmeCompletion = &Completion;
CommandPacket.NvmeCmd->Cdw0.Opcode = NVME_IO_READ_OPC;
CommandPacket.NvmeCmd->Nsid = Device->NamespaceId;
CommandPacket.TransferBuffer = (VOID *)(UINTN)Buffer;
CommandPacket.TransferLength = Bytes;
CommandPacket.CommandTimeout = NVME_GENERIC_TIMEOUT;
CommandPacket.QueueType = NVME_IO_QUEUE;
CommandPacket.NvmeCmd->Cdw10 = (UINT32)Lba;
CommandPacket.NvmeCmd->Cdw11 = (UINT32)RShiftU64(Lba, 32);
CommandPacket.NvmeCmd->Cdw12 = (Blocks - 1) & 0xFFFF;
CommandPacket.NvmeCmd->Flags = CDW10_VALID | CDW11_VALID | CDW12_VALID;
Status = Private->Passthru.PassThru (
&Private->Passthru,
Device->NamespaceId,
&CommandPacket,
NULL
);
return Status;
}
/**
Write some sectors to the device.
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data structure.
@param Buffer The buffer to be written into the device.
@param Lba The start block number.
@param Blocks Total block number to be written.
@retval EFI_SUCCESS Datum are written into the buffer.
@retval Others Fail to write all the datum.
**/
EFI_STATUS
WriteSectors (
IN NVME_DEVICE_PRIVATE_DATA *Device,
IN UINT64 Buffer,
IN UINT64 Lba,
IN UINT32 Blocks
)
{
NVME_CONTROLLER_PRIVATE_DATA *Private;
EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;
EFI_NVM_EXPRESS_COMMAND Command;
EFI_NVM_EXPRESS_COMPLETION Completion;
EFI_STATUS Status;
UINT32 Bytes;
UINT32 BlockSize;
Private = Device->Controller;
BlockSize = Device->Media.BlockSize;
Bytes = Blocks * BlockSize;
ZeroMem (&CommandPacket, sizeof(EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
ZeroMem (&Command, sizeof(EFI_NVM_EXPRESS_COMMAND));
ZeroMem (&Completion, sizeof(EFI_NVM_EXPRESS_COMPLETION));
CommandPacket.NvmeCmd = &Command;
CommandPacket.NvmeCompletion = &Completion;
CommandPacket.NvmeCmd->Cdw0.Opcode = NVME_IO_WRITE_OPC;
CommandPacket.NvmeCmd->Nsid = Device->NamespaceId;
CommandPacket.TransferBuffer = (VOID *)(UINTN)Buffer;
CommandPacket.TransferLength = Bytes;
CommandPacket.CommandTimeout = NVME_GENERIC_TIMEOUT;
CommandPacket.QueueType = NVME_IO_QUEUE;
CommandPacket.NvmeCmd->Cdw10 = (UINT32)Lba;
CommandPacket.NvmeCmd->Cdw11 = (UINT32)RShiftU64(Lba, 32);
//
// Set Force Unit Access bit (bit 30) to use write-through behaviour
//
CommandPacket.NvmeCmd->Cdw12 = ((Blocks - 1) & 0xFFFF) | BIT30;
CommandPacket.MetadataBuffer = NULL;
CommandPacket.MetadataLength = 0;
CommandPacket.NvmeCmd->Flags = CDW10_VALID | CDW11_VALID | CDW12_VALID;
Status = Private->Passthru.PassThru (
&Private->Passthru,
Device->NamespaceId,
&CommandPacket,
NULL
);
return Status;
}
/**
Read some blocks from the device.
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data structure.
@param Buffer The buffer used to store the data read from the device.
@param Lba The start block number.
@param Blocks Total block number to be read.
@retval EFI_SUCCESS Datum are read from the device.
@retval Others Fail to read all the datum.
**/
EFI_STATUS
NvmeRead (
IN NVME_DEVICE_PRIVATE_DATA *Device,
OUT VOID *Buffer,
IN UINT64 Lba,
IN UINTN Blocks
)
{
EFI_STATUS Status;
UINT32 BlockSize;
NVME_CONTROLLER_PRIVATE_DATA *Private;
UINT32 MaxTransferBlocks;
UINTN OrginalBlocks;
BOOLEAN IsEmpty;
EFI_TPL OldTpl;
//
// Wait for the device's asynchronous I/O queue to become empty.
//
while (TRUE) {
OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
IsEmpty = IsListEmpty (&Device->AsyncQueue);
gBS->RestoreTPL (OldTpl);
if (IsEmpty) {
break;
}
gBS->Stall (100);
}
Status = EFI_SUCCESS;
Private = Device->Controller;
BlockSize = Device->Media.BlockSize;
OrginalBlocks = Blocks;
if (Private->ControllerData->Mdts != 0) {
MaxTransferBlocks = (1 << (Private->ControllerData->Mdts)) * (1 << (Private->Cap.Mpsmin + 12)) / BlockSize;
} else {
MaxTransferBlocks = 1024;
}
while (Blocks > 0) {
if (Blocks > MaxTransferBlocks) {
Status = ReadSectors (Device, (UINT64)(UINTN)Buffer, Lba, MaxTransferBlocks);
Blocks -= MaxTransferBlocks;
Buffer = (VOID *)(UINTN)((UINT64)(UINTN)Buffer + MaxTransferBlocks * BlockSize);
Lba += MaxTransferBlocks;
} else {
Status = ReadSectors (Device, (UINT64)(UINTN)Buffer, Lba, (UINT32)Blocks);
Blocks = 0;
}
if (EFI_ERROR(Status)) {
break;
}
}
DEBUG ((DEBUG_BLKIO, "%a: Lba = 0x%08Lx, Original = 0x%08Lx, "
"Remaining = 0x%08Lx, BlockSize = 0x%x, Status = %r\n", __FUNCTION__, Lba,
(UINT64)OrginalBlocks, (UINT64)Blocks, BlockSize, Status));
return Status;
}
/**
Write some blocks to the device.
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data structure.
@param Buffer The buffer to be written into the device.
@param Lba The start block number.
@param Blocks Total block number to be written.
@retval EFI_SUCCESS Datum are written into the buffer.
@retval Others Fail to write all the datum.
**/
EFI_STATUS
NvmeWrite (
IN NVME_DEVICE_PRIVATE_DATA *Device,
IN VOID *Buffer,
IN UINT64 Lba,
IN UINTN Blocks
)
{
EFI_STATUS Status;
UINT32 BlockSize;
NVME_CONTROLLER_PRIVATE_DATA *Private;
UINT32 MaxTransferBlocks;
UINTN OrginalBlocks;
BOOLEAN IsEmpty;
EFI_TPL OldTpl;
//
// Wait for the device's asynchronous I/O queue to become empty.
//
while (TRUE) {
OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
IsEmpty = IsListEmpty (&Device->AsyncQueue);
gBS->RestoreTPL (OldTpl);
if (IsEmpty) {
break;
}
gBS->Stall (100);
}
Status = EFI_SUCCESS;
Private = Device->Controller;
BlockSize = Device->Media.BlockSize;
OrginalBlocks = Blocks;
if (Private->ControllerData->Mdts != 0) {
MaxTransferBlocks = (1 << (Private->ControllerData->Mdts)) * (1 << (Private->Cap.Mpsmin + 12)) / BlockSize;
} else {
MaxTransferBlocks = 1024;
}
while (Blocks > 0) {
if (Blocks > MaxTransferBlocks) {
Status = WriteSectors (Device, (UINT64)(UINTN)Buffer, Lba, MaxTransferBlocks);
Blocks -= MaxTransferBlocks;
Buffer = (VOID *)(UINTN)((UINT64)(UINTN)Buffer + MaxTransferBlocks * BlockSize);
Lba += MaxTransferBlocks;
} else {
Status = WriteSectors (Device, (UINT64)(UINTN)Buffer, Lba, (UINT32)Blocks);
Blocks = 0;
}
if (EFI_ERROR(Status)) {
break;
}
}
DEBUG ((DEBUG_BLKIO, "%a: Lba = 0x%08Lx, Original = 0x%08Lx, "
"Remaining = 0x%08Lx, BlockSize = 0x%x, Status = %r\n", __FUNCTION__, Lba,
(UINT64)OrginalBlocks, (UINT64)Blocks, BlockSize, Status));
return Status;
}
/**
Flushes all modified data to the device.
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data structure.
@retval EFI_SUCCESS Datum are written into the buffer.
@retval Others Fail to write all the datum.
**/
EFI_STATUS
NvmeFlush (
IN NVME_DEVICE_PRIVATE_DATA *Device
)
{
NVME_CONTROLLER_PRIVATE_DATA *Private;
EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;
EFI_NVM_EXPRESS_COMMAND Command;
EFI_NVM_EXPRESS_COMPLETION Completion;
EFI_STATUS Status;
Private = Device->Controller;
ZeroMem (&CommandPacket, sizeof(EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
ZeroMem (&Command, sizeof(EFI_NVM_EXPRESS_COMMAND));
ZeroMem (&Completion, sizeof(EFI_NVM_EXPRESS_COMPLETION));
CommandPacket.NvmeCmd = &Command;
CommandPacket.NvmeCompletion = &Completion;
CommandPacket.NvmeCmd->Cdw0.Opcode = NVME_IO_FLUSH_OPC;
CommandPacket.NvmeCmd->Nsid = Device->NamespaceId;
CommandPacket.CommandTimeout = NVME_GENERIC_TIMEOUT;
CommandPacket.QueueType = NVME_IO_QUEUE;
Status = Private->Passthru.PassThru (
&Private->Passthru,
Device->NamespaceId,
&CommandPacket,
NULL
);
return Status;
}
/**
Nonblocking I/O callback funtion when the event is signaled.
@param[in] Event The Event this notify function registered to.
@param[in] Context Pointer to the context data registered to the
Event.
**/
VOID
EFIAPI
AsyncIoCallback (
IN EFI_EVENT Event,
IN VOID *Context
)
{
NVME_BLKIO2_SUBTASK *Subtask;
NVME_BLKIO2_REQUEST *Request;
NVME_CQ *Completion;
EFI_BLOCK_IO2_TOKEN *Token;
gBS->CloseEvent (Event);
Subtask = (NVME_BLKIO2_SUBTASK *) Context;
Completion = (NVME_CQ *) Subtask->CommandPacket->NvmeCompletion;
Request = Subtask->BlockIo2Request;
Token = Request->Token;
if (Token->TransactionStatus == EFI_SUCCESS) {
//
// If previous subtask already fails, do not check the result of
// subsequent subtasks.
//
if ((Completion->Sct != 0) || (Completion->Sc != 0)) {
Token->TransactionStatus = EFI_DEVICE_ERROR;
//
// Dump completion entry status for debugging.
//
DEBUG_CODE_BEGIN();
NvmeDumpStatus (Completion);
DEBUG_CODE_END();
}
}
//
// Remove the subtask from the BlockIo2 subtasks list.
//
RemoveEntryList (&Subtask->Link);
if (IsListEmpty (&Request->SubtasksQueue) && Request->LastSubtaskSubmitted) {
//
// Remove the BlockIo2 request from the device asynchronous queue.
//
RemoveEntryList (&Request->Link);
FreePool (Request);
gBS->SignalEvent (Token->Event);
}
FreePool (Subtask->CommandPacket->NvmeCmd);
FreePool (Subtask->CommandPacket->NvmeCompletion);
FreePool (Subtask->CommandPacket);
FreePool (Subtask);
}
/**
Read some sectors from the device in an asynchronous manner.
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data
structure.
@param Request The pointer to the NVME_BLKIO2_REQUEST data structure.
@param Buffer The buffer used to store the data read from the device.
@param Lba The start block number.
@param Blocks Total block number to be read.
@param IsLast The last subtask of an asynchronous read request.
@retval EFI_SUCCESS Asynchronous read request has been queued.
@retval Others Fail to send the asynchronous request.
**/
EFI_STATUS
AsyncReadSectors (
IN NVME_DEVICE_PRIVATE_DATA *Device,
IN NVME_BLKIO2_REQUEST *Request,
IN UINT64 Buffer,
IN UINT64 Lba,
IN UINT32 Blocks,
IN BOOLEAN IsLast
)
{
NVME_CONTROLLER_PRIVATE_DATA *Private;
UINT32 Bytes;
NVME_BLKIO2_SUBTASK *Subtask;
EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET *CommandPacket;
EFI_NVM_EXPRESS_COMMAND *Command;
EFI_NVM_EXPRESS_COMPLETION *Completion;
EFI_STATUS Status;
UINT32 BlockSize;
EFI_TPL OldTpl;
Private = Device->Controller;
BlockSize = Device->Media.BlockSize;
Bytes = Blocks * BlockSize;
CommandPacket = NULL;
Command = NULL;
Completion = NULL;
Subtask = AllocateZeroPool (sizeof (NVME_BLKIO2_SUBTASK));
if (Subtask == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ErrorExit;
}
Subtask->Signature = NVME_BLKIO2_SUBTASK_SIGNATURE;
Subtask->IsLast = IsLast;
Subtask->NamespaceId = Device->NamespaceId;
Subtask->BlockIo2Request = Request;
CommandPacket = AllocateZeroPool (sizeof (EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
if (CommandPacket == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ErrorExit;
} else {
Subtask->CommandPacket = CommandPacket;
}
Command = AllocateZeroPool (sizeof (EFI_NVM_EXPRESS_COMMAND));
if (Command == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ErrorExit;
}
Completion = AllocateZeroPool (sizeof (EFI_NVM_EXPRESS_COMPLETION));
if (Completion == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ErrorExit;
}
//
// Create Event
//
Status = gBS->CreateEvent (
EVT_NOTIFY_SIGNAL,
TPL_NOTIFY,
AsyncIoCallback,
Subtask,
&Subtask->Event
);
if (EFI_ERROR(Status)) {
goto ErrorExit;
}
CommandPacket->NvmeCmd = Command;
CommandPacket->NvmeCompletion = Completion;
CommandPacket->NvmeCmd->Cdw0.Opcode = NVME_IO_READ_OPC;
CommandPacket->NvmeCmd->Nsid = Device->NamespaceId;
CommandPacket->TransferBuffer = (VOID *)(UINTN)Buffer;
CommandPacket->TransferLength = Bytes;
CommandPacket->CommandTimeout = NVME_GENERIC_TIMEOUT;
CommandPacket->QueueType = NVME_IO_QUEUE;
CommandPacket->NvmeCmd->Cdw10 = (UINT32)Lba;
CommandPacket->NvmeCmd->Cdw11 = (UINT32)RShiftU64(Lba, 32);
CommandPacket->NvmeCmd->Cdw12 = (Blocks - 1) & 0xFFFF;
CommandPacket->NvmeCmd->Flags = CDW10_VALID | CDW11_VALID | CDW12_VALID;
OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
InsertTailList (&Private->UnsubmittedSubtasks, &Subtask->Link);
Request->UnsubmittedSubtaskNum++;
gBS->RestoreTPL (OldTpl);
return EFI_SUCCESS;
ErrorExit:
//
// Resource cleanup if asynchronous read request has not been queued.
//
if (Completion != NULL) {
FreePool (Completion);
}
if (Command != NULL) {
FreePool (Command);
}
if (CommandPacket != NULL) {
FreePool (CommandPacket);
}
if (Subtask != NULL) {
if (Subtask->Event != NULL) {
gBS->CloseEvent (Subtask->Event);
}
FreePool (Subtask);
}
return Status;
}
/**
Write some sectors from the device in an asynchronous manner.
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data
structure.
@param Request The pointer to the NVME_BLKIO2_REQUEST data structure.
@param Buffer The buffer used to store the data written to the
device.
@param Lba The start block number.
@param Blocks Total block number to be written.
@param IsLast The last subtask of an asynchronous write request.
@retval EFI_SUCCESS Asynchronous write request has been queued.
@retval Others Fail to send the asynchronous request.
**/
EFI_STATUS
AsyncWriteSectors (
IN NVME_DEVICE_PRIVATE_DATA *Device,
IN NVME_BLKIO2_REQUEST *Request,
IN UINT64 Buffer,
IN UINT64 Lba,
IN UINT32 Blocks,
IN BOOLEAN IsLast
)
{
NVME_CONTROLLER_PRIVATE_DATA *Private;
UINT32 Bytes;
NVME_BLKIO2_SUBTASK *Subtask;
EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET *CommandPacket;
EFI_NVM_EXPRESS_COMMAND *Command;
EFI_NVM_EXPRESS_COMPLETION *Completion;
EFI_STATUS Status;
UINT32 BlockSize;
EFI_TPL OldTpl;
Private = Device->Controller;
BlockSize = Device->Media.BlockSize;
Bytes = Blocks * BlockSize;
CommandPacket = NULL;
Command = NULL;
Completion = NULL;
Subtask = AllocateZeroPool (sizeof (NVME_BLKIO2_SUBTASK));
if (Subtask == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ErrorExit;
}
Subtask->Signature = NVME_BLKIO2_SUBTASK_SIGNATURE;
Subtask->IsLast = IsLast;
Subtask->NamespaceId = Device->NamespaceId;
Subtask->BlockIo2Request = Request;
CommandPacket = AllocateZeroPool (sizeof (EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
if (CommandPacket == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ErrorExit;
} else {
Subtask->CommandPacket = CommandPacket;
}
Command = AllocateZeroPool (sizeof (EFI_NVM_EXPRESS_COMMAND));
if (Command == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ErrorExit;
}
Completion = AllocateZeroPool (sizeof (EFI_NVM_EXPRESS_COMPLETION));
if (Completion == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ErrorExit;
}
//
// Create Event
//
Status = gBS->CreateEvent (
EVT_NOTIFY_SIGNAL,
TPL_NOTIFY,
AsyncIoCallback,
Subtask,
&Subtask->Event
);
if (EFI_ERROR(Status)) {
goto ErrorExit;
}
CommandPacket->NvmeCmd = Command;
CommandPacket->NvmeCompletion = Completion;
CommandPacket->NvmeCmd->Cdw0.Opcode = NVME_IO_WRITE_OPC;
CommandPacket->NvmeCmd->Nsid = Device->NamespaceId;
CommandPacket->TransferBuffer = (VOID *)(UINTN)Buffer;
CommandPacket->TransferLength = Bytes;
CommandPacket->CommandTimeout = NVME_GENERIC_TIMEOUT;
CommandPacket->QueueType = NVME_IO_QUEUE;
CommandPacket->NvmeCmd->Cdw10 = (UINT32)Lba;
CommandPacket->NvmeCmd->Cdw11 = (UINT32)RShiftU64(Lba, 32);
//
// Set Force Unit Access bit (bit 30) to use write-through behaviour
//
CommandPacket->NvmeCmd->Cdw12 = ((Blocks - 1) & 0xFFFF) | BIT30;
CommandPacket->NvmeCmd->Flags = CDW10_VALID | CDW11_VALID | CDW12_VALID;
OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
InsertTailList (&Private->UnsubmittedSubtasks, &Subtask->Link);
Request->UnsubmittedSubtaskNum++;
gBS->RestoreTPL (OldTpl);
return EFI_SUCCESS;
ErrorExit:
//
// Resource cleanup if asynchronous read request has not been queued.
//
if (Completion != NULL) {
FreePool (Completion);
}
if (Command != NULL) {
FreePool (Command);
}
if (CommandPacket != NULL) {
FreePool (CommandPacket);
}
if (Subtask != NULL) {
if (Subtask->Event != NULL) {
gBS->CloseEvent (Subtask->Event);
}
FreePool (Subtask);
}
return Status;
}
/**
Read some blocks from the device in an asynchronous manner.
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data
structure.
@param Buffer The buffer used to store the data read from the device.
@param Lba The start block number.
@param Blocks Total block number to be read.
@param Token A pointer to the token associated with the transaction.
@retval EFI_SUCCESS Data are read from the device.
@retval Others Fail to read all the data.
**/
EFI_STATUS
NvmeAsyncRead (
IN NVME_DEVICE_PRIVATE_DATA *Device,
OUT VOID *Buffer,
IN UINT64 Lba,
IN UINTN Blocks,
IN EFI_BLOCK_IO2_TOKEN *Token
)
{
EFI_STATUS Status;
UINT32 BlockSize;
NVME_CONTROLLER_PRIVATE_DATA *Private;
NVME_BLKIO2_REQUEST *BlkIo2Req;
UINT32 MaxTransferBlocks;
UINTN OrginalBlocks;
BOOLEAN IsEmpty;
EFI_TPL OldTpl;
Status = EFI_SUCCESS;
Private = Device->Controller;
BlockSize = Device->Media.BlockSize;
OrginalBlocks = Blocks;
BlkIo2Req = AllocateZeroPool (sizeof (NVME_BLKIO2_REQUEST));
if (BlkIo2Req == NULL) {
return EFI_OUT_OF_RESOURCES;
}
BlkIo2Req->Signature = NVME_BLKIO2_REQUEST_SIGNATURE;
BlkIo2Req->Token = Token;
OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
InsertTailList (&Device->AsyncQueue, &BlkIo2Req->Link);
gBS->RestoreTPL (OldTpl);
InitializeListHead (&BlkIo2Req->SubtasksQueue);
if (Private->ControllerData->Mdts != 0) {
MaxTransferBlocks = (1 << (Private->ControllerData->Mdts)) * (1 << (Private->Cap.Mpsmin + 12)) / BlockSize;
} else {
MaxTransferBlocks = 1024;
}
while (Blocks > 0) {
if (Blocks > MaxTransferBlocks) {
Status = AsyncReadSectors (
Device,
BlkIo2Req, (UINT64)(UINTN)Buffer,
Lba,
MaxTransferBlocks,
FALSE
);
Blocks -= MaxTransferBlocks;
Buffer = (VOID *)(UINTN)((UINT64)(UINTN)Buffer + MaxTransferBlocks * BlockSize);
Lba += MaxTransferBlocks;
} else {
Status = AsyncReadSectors (
Device,
BlkIo2Req,
(UINT64)(UINTN)Buffer,
Lba,
(UINT32)Blocks,
TRUE
);
Blocks = 0;
}
if (EFI_ERROR(Status)) {
OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
IsEmpty = IsListEmpty (&BlkIo2Req->SubtasksQueue) &&
(BlkIo2Req->UnsubmittedSubtaskNum == 0);
if (IsEmpty) {
//
// Remove the BlockIo2 request from the device asynchronous queue.
//
RemoveEntryList (&BlkIo2Req->Link);
FreePool (BlkIo2Req);
Status = EFI_DEVICE_ERROR;
} else {
//
// There are previous BlockIo2 subtasks still running, EFI_SUCCESS
// should be returned to make sure that the caller does not free
// resources still using by these requests.
//
Status = EFI_SUCCESS;
Token->TransactionStatus = EFI_DEVICE_ERROR;
BlkIo2Req->LastSubtaskSubmitted = TRUE;
}
gBS->RestoreTPL (OldTpl);
break;
}
}
DEBUG ((DEBUG_BLKIO, "%a: Lba = 0x%08Lx, Original = 0x%08Lx, "
"Remaining = 0x%08Lx, BlockSize = 0x%x, Status = %r\n", __FUNCTION__, Lba,
(UINT64)OrginalBlocks, (UINT64)Blocks, BlockSize, Status));
return Status;
}
/**
Write some blocks from the device in an asynchronous manner.
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data
structure.
@param Buffer The buffer used to store the data written to the
device.
@param Lba The start block number.
@param Blocks Total block number to be written.
@param Token A pointer to the token associated with the transaction.
@retval EFI_SUCCESS Data are written to the device.
@retval Others Fail to write all the data.
**/
EFI_STATUS
NvmeAsyncWrite (
IN NVME_DEVICE_PRIVATE_DATA *Device,
IN VOID *Buffer,
IN UINT64 Lba,
IN UINTN Blocks,
IN EFI_BLOCK_IO2_TOKEN *Token
)
{
EFI_STATUS Status;
UINT32 BlockSize;
NVME_CONTROLLER_PRIVATE_DATA *Private;
NVME_BLKIO2_REQUEST *BlkIo2Req;
UINT32 MaxTransferBlocks;
UINTN OrginalBlocks;
BOOLEAN IsEmpty;
EFI_TPL OldTpl;
Status = EFI_SUCCESS;
Private = Device->Controller;
BlockSize = Device->Media.BlockSize;
OrginalBlocks = Blocks;
BlkIo2Req = AllocateZeroPool (sizeof (NVME_BLKIO2_REQUEST));
if (BlkIo2Req == NULL) {
return EFI_OUT_OF_RESOURCES;
}
BlkIo2Req->Signature = NVME_BLKIO2_REQUEST_SIGNATURE;
BlkIo2Req->Token = Token;
OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
InsertTailList (&Device->AsyncQueue, &BlkIo2Req->Link);
gBS->RestoreTPL (OldTpl);
InitializeListHead (&BlkIo2Req->SubtasksQueue);
if (Private->ControllerData->Mdts != 0) {
MaxTransferBlocks = (1 << (Private->ControllerData->Mdts)) * (1 << (Private->Cap.Mpsmin + 12)) / BlockSize;
} else {
MaxTransferBlocks = 1024;
}
while (Blocks > 0) {
if (Blocks > MaxTransferBlocks) {
Status = AsyncWriteSectors (
Device,
BlkIo2Req,
(UINT64)(UINTN)Buffer,
Lba,
MaxTransferBlocks,
FALSE
);
Blocks -= MaxTransferBlocks;
Buffer = (VOID *)(UINTN)((UINT64)(UINTN)Buffer + MaxTransferBlocks * BlockSize);
Lba += MaxTransferBlocks;
} else {
Status = AsyncWriteSectors (
Device,
BlkIo2Req,
(UINT64)(UINTN)Buffer,
Lba,
(UINT32)Blocks,
TRUE
);
Blocks = 0;
}
if (EFI_ERROR(Status)) {
OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
IsEmpty = IsListEmpty (&BlkIo2Req->SubtasksQueue) &&
(BlkIo2Req->UnsubmittedSubtaskNum == 0);
if (IsEmpty) {
//
// Remove the BlockIo2 request from the device asynchronous queue.
//
RemoveEntryList (&BlkIo2Req->Link);
FreePool (BlkIo2Req);
Status = EFI_DEVICE_ERROR;
} else {
//
// There are previous BlockIo2 subtasks still running, EFI_SUCCESS
// should be returned to make sure that the caller does not free
// resources still using by these requests.
//
Status = EFI_SUCCESS;
Token->TransactionStatus = EFI_DEVICE_ERROR;
BlkIo2Req->LastSubtaskSubmitted = TRUE;
}
gBS->RestoreTPL (OldTpl);
break;
}
}
DEBUG ((DEBUG_BLKIO, "%a: Lba = 0x%08Lx, Original = 0x%08Lx, "
"Remaining = 0x%08Lx, BlockSize = 0x%x, Status = %r\n", __FUNCTION__, Lba,
(UINT64)OrginalBlocks, (UINT64)Blocks, BlockSize, Status));
return Status;
}
/**
Reset the Block Device.
@param This Indicates a pointer to the calling context.
@param ExtendedVerification Driver may perform diagnostics on reset.
@retval EFI_SUCCESS The device was reset.
@retval EFI_DEVICE_ERROR The device is not functioning properly and could
not be reset.
**/
EFI_STATUS
EFIAPI
NvmeBlockIoReset (
IN EFI_BLOCK_IO_PROTOCOL *This,
IN BOOLEAN ExtendedVerification
)
{
EFI_TPL OldTpl;
NVME_CONTROLLER_PRIVATE_DATA *Private;
NVME_DEVICE_PRIVATE_DATA *Device;
EFI_STATUS Status;
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
//
// For Nvm Express subsystem, reset block device means reset controller.
//
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
Device = NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO (This);
Private = Device->Controller;
Status = NvmeControllerInit (Private);
if (EFI_ERROR (Status)) {
Status = EFI_DEVICE_ERROR;
}
gBS->RestoreTPL (OldTpl);
return Status;
}
/**
Read BufferSize bytes from Lba into Buffer.
@param This Indicates a pointer to the calling context.
@param MediaId Id of the media, changes every time the media is replaced.
@param Lba The starting Logical Block Address to read from.
@param BufferSize Size of Buffer, must be a multiple of device block size.
@param Buffer A pointer to the destination buffer for the data. The caller is
responsible for either having implicit or explicit ownership of the buffer.
@retval EFI_SUCCESS The data was read correctly from the device.
@retval EFI_DEVICE_ERROR The device reported an error while performing the read.
@retval EFI_NO_MEDIA There is no media in the device.
@retval EFI_MEDIA_CHANGED The MediaId does not matched the current device.
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
@retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,
or the buffer is not on proper alignment.
**/
EFI_STATUS
EFIAPI
NvmeBlockIoReadBlocks (
IN EFI_BLOCK_IO_PROTOCOL *This,
IN UINT32 MediaId,
IN EFI_LBA Lba,
IN UINTN BufferSize,
OUT VOID *Buffer
)
{
NVME_DEVICE_PRIVATE_DATA *Device;
EFI_STATUS Status;
EFI_BLOCK_IO_MEDIA *Media;
UINTN BlockSize;
UINTN NumberOfBlocks;
UINTN IoAlign;
EFI_TPL OldTpl;
//
// Check parameters.
//
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Media = This->Media;
if (MediaId != Media->MediaId) {
return EFI_MEDIA_CHANGED;
}
if (Buffer == NULL) {
return EFI_INVALID_PARAMETER;
}
if (BufferSize == 0) {
return EFI_SUCCESS;
}
BlockSize = Media->BlockSize;
if ((BufferSize % BlockSize) != 0) {
return EFI_BAD_BUFFER_SIZE;
}
NumberOfBlocks = BufferSize / BlockSize;
if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {
return EFI_INVALID_PARAMETER;
}
IoAlign = Media->IoAlign;
if (IoAlign > 0 && (((UINTN) Buffer & (IoAlign - 1)) != 0)) {
return EFI_INVALID_PARAMETER;
}
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
Device = NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO (This);
Status = NvmeRead (Device, Buffer, Lba, NumberOfBlocks);
gBS->RestoreTPL (OldTpl);
return Status;
}
/**
Write BufferSize bytes from Lba into Buffer.
@param This Indicates a pointer to the calling context.
@param MediaId The media ID that the write request is for.
@param Lba The starting logical block address to be written. The caller is
responsible for writing to only legitimate locations.
@param BufferSize Size of Buffer, must be a multiple of device block size.
@param Buffer A pointer to the source buffer for the data.
@retval EFI_SUCCESS The data was written correctly to the device.
@retval EFI_WRITE_PROTECTED The device can not be written to.
@retval EFI_DEVICE_ERROR The device reported an error while performing the write.
@retval EFI_NO_MEDIA There is no media in the device.
@retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
@retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,
or the buffer is not on proper alignment.
**/
EFI_STATUS
EFIAPI
NvmeBlockIoWriteBlocks (
IN EFI_BLOCK_IO_PROTOCOL *This,
IN UINT32 MediaId,
IN EFI_LBA Lba,
IN UINTN BufferSize,
IN VOID *Buffer
)
{
NVME_DEVICE_PRIVATE_DATA *Device;
EFI_STATUS Status;
EFI_BLOCK_IO_MEDIA *Media;
UINTN BlockSize;
UINTN NumberOfBlocks;
UINTN IoAlign;
EFI_TPL OldTpl;
//
// Check parameters.
//
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Media = This->Media;
if (MediaId != Media->MediaId) {
return EFI_MEDIA_CHANGED;
}
if (Buffer == NULL) {
return EFI_INVALID_PARAMETER;
}
if (BufferSize == 0) {
return EFI_SUCCESS;
}
BlockSize = Media->BlockSize;
if ((BufferSize % BlockSize) != 0) {
return EFI_BAD_BUFFER_SIZE;
}
NumberOfBlocks = BufferSize / BlockSize;
if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {
return EFI_INVALID_PARAMETER;
}
IoAlign = Media->IoAlign;
if (IoAlign > 0 && (((UINTN) Buffer & (IoAlign - 1)) != 0)) {
return EFI_INVALID_PARAMETER;
}
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
Device = NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO (This);
Status = NvmeWrite (Device, Buffer, Lba, NumberOfBlocks);
gBS->RestoreTPL (OldTpl);
return Status;
}
/**
Flush the Block Device.
@param This Indicates a pointer to the calling context.
@retval EFI_SUCCESS All outstanding data was written to the device.
@retval EFI_DEVICE_ERROR The device reported an error while writing back the data.
@retval EFI_NO_MEDIA There is no media in the device.
**/
EFI_STATUS
EFIAPI
NvmeBlockIoFlushBlocks (
IN EFI_BLOCK_IO_PROTOCOL *This
)
{
NVME_DEVICE_PRIVATE_DATA *Device;
EFI_STATUS Status;
EFI_TPL OldTpl;
//
// Check parameters.
//
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
Device = NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO (This);
Status = NvmeFlush (Device);
gBS->RestoreTPL (OldTpl);
return Status;
}
/**
Reset the block device hardware.
@param[in] This Indicates a pointer to the calling context.
@param[in] ExtendedVerification Indicates that the driver may perform a more
exhausive verfication operation of the
device during reset.
@retval EFI_SUCCESS The device was reset.
@retval EFI_DEVICE_ERROR The device is not functioning properly and could
not be reset.
**/
EFI_STATUS
EFIAPI
NvmeBlockIoResetEx (
IN EFI_BLOCK_IO2_PROTOCOL *This,
IN BOOLEAN ExtendedVerification
)
{
EFI_STATUS Status;
NVME_DEVICE_PRIVATE_DATA *Device;
NVME_CONTROLLER_PRIVATE_DATA *Private;
BOOLEAN IsEmpty;
EFI_TPL OldTpl;
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Device = NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO2 (This);
Private = Device->Controller;
//
// Wait for the asynchronous PassThru queue to become empty.
//
while (TRUE) {
OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
IsEmpty = IsListEmpty (&Private->AsyncPassThruQueue) &&
IsListEmpty (&Private->UnsubmittedSubtasks);
gBS->RestoreTPL (OldTpl);
if (IsEmpty) {
break;
}
gBS->Stall (100);
}
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
Status = NvmeControllerInit (Private);
if (EFI_ERROR (Status)) {
Status = EFI_DEVICE_ERROR;
}
gBS->RestoreTPL (OldTpl);
return Status;
}
/**
Read BufferSize bytes from Lba into Buffer.
This function reads the requested number of blocks from the device. All the
blocks are read, or an error is returned.
If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_or EFI_MEDIA_CHANGED is returned and
non-blocking I/O is being used, the Event associated with this request will
not be signaled.
@param[in] This Indicates a pointer to the calling context.
@param[in] MediaId Id of the media, changes every time the media is
replaced.
@param[in] Lba The starting Logical Block Address to read from.
@param[in, out] Token A pointer to the token associated with the
transaction.
@param[in] BufferSize Size of Buffer, must be a multiple of device
block size.
@param[out] Buffer A pointer to the destination buffer for the data.
The caller is responsible for either having
implicit or explicit ownership of the buffer.
@retval EFI_SUCCESS The read request was queued if Token->Event is
not NULL.The data was read correctly from the
device if the Token->Event is NULL.
@retval EFI_DEVICE_ERROR The device reported an error while performing
the read.
@retval EFI_NO_MEDIA There is no media in the device.
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
@retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of
the intrinsic block size of the device.
@retval EFI_INVALID_PARAMETER The read request contains LBAs that are not
valid, or the buffer is not on proper
alignment.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a
lack of resources.
**/
EFI_STATUS
EFIAPI
NvmeBlockIoReadBlocksEx (
IN EFI_BLOCK_IO2_PROTOCOL *This,
IN UINT32 MediaId,
IN EFI_LBA Lba,
IN OUT EFI_BLOCK_IO2_TOKEN *Token,
IN UINTN BufferSize,
OUT VOID *Buffer
)
{
NVME_DEVICE_PRIVATE_DATA *Device;
EFI_STATUS Status;
EFI_BLOCK_IO_MEDIA *Media;
UINTN BlockSize;
UINTN NumberOfBlocks;
UINTN IoAlign;
EFI_TPL OldTpl;
//
// Check parameters.
//
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Media = This->Media;
if (MediaId != Media->MediaId) {
return EFI_MEDIA_CHANGED;
}
if (Buffer == NULL) {
return EFI_INVALID_PARAMETER;
}
if (BufferSize == 0) {
if ((Token != NULL) && (Token->Event != NULL)) {
Token->TransactionStatus = EFI_SUCCESS;
gBS->SignalEvent (Token->Event);
}
return EFI_SUCCESS;
}
BlockSize = Media->BlockSize;
if ((BufferSize % BlockSize) != 0) {
return EFI_BAD_BUFFER_SIZE;
}
NumberOfBlocks = BufferSize / BlockSize;
if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {
return EFI_INVALID_PARAMETER;
}
IoAlign = Media->IoAlign;
if (IoAlign > 0 && (((UINTN) Buffer & (IoAlign - 1)) != 0)) {
return EFI_INVALID_PARAMETER;
}
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
Device = NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO2 (This);
if ((Token != NULL) && (Token->Event != NULL)) {
Token->TransactionStatus = EFI_SUCCESS;
Status = NvmeAsyncRead (Device, Buffer, Lba, NumberOfBlocks, Token);
} else {
Status = NvmeRead (Device, Buffer, Lba, NumberOfBlocks);
}
gBS->RestoreTPL (OldTpl);
return Status;
}
/**
Write BufferSize bytes from Lba into Buffer.
This function writes the requested number of blocks to the device. All blocks
are written, or an error is returned.If EFI_DEVICE_ERROR, EFI_NO_MEDIA,
EFI_WRITE_PROTECTED or EFI_MEDIA_CHANGED is returned and non-blocking I/O is
being used, the Event associated with this request will not be signaled.
@param[in] This Indicates a pointer to the calling context.
@param[in] MediaId The media ID that the write request is for.
@param[in] Lba The starting logical block address to be written.
The caller is responsible for writing to only
legitimate locations.
@param[in, out] Token A pointer to the token associated with the
transaction.
@param[in] BufferSize Size of Buffer, must be a multiple of device
block size.
@param[in] Buffer A pointer to the source buffer for the data.
@retval EFI_SUCCESS The write request was queued if Event is not
NULL.
The data was written correctly to the device if
the Event is NULL.
@retval EFI_WRITE_PROTECTED The device can not be written to.
@retval EFI_NO_MEDIA There is no media in the device.
@retval EFI_MEDIA_CHNAGED The MediaId does not matched the current
device.
@retval EFI_DEVICE_ERROR The device reported an error while performing
the write.
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size
of the device.
@retval EFI_INVALID_PARAMETER The write request contains LBAs that are not
valid, or the buffer is not on proper
alignment.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a
lack of resources.
**/
EFI_STATUS
EFIAPI
NvmeBlockIoWriteBlocksEx (
IN EFI_BLOCK_IO2_PROTOCOL *This,
IN UINT32 MediaId,
IN EFI_LBA Lba,
IN OUT EFI_BLOCK_IO2_TOKEN *Token,
IN UINTN BufferSize,
IN VOID *Buffer
)
{
NVME_DEVICE_PRIVATE_DATA *Device;
EFI_STATUS Status;
EFI_BLOCK_IO_MEDIA *Media;
UINTN BlockSize;
UINTN NumberOfBlocks;
UINTN IoAlign;
EFI_TPL OldTpl;
//
// Check parameters.
//
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Media = This->Media;
if (MediaId != Media->MediaId) {
return EFI_MEDIA_CHANGED;
}
if (Buffer == NULL) {
return EFI_INVALID_PARAMETER;
}
if (BufferSize == 0) {
if ((Token != NULL) && (Token->Event != NULL)) {
Token->TransactionStatus = EFI_SUCCESS;
gBS->SignalEvent (Token->Event);
}
return EFI_SUCCESS;
}
BlockSize = Media->BlockSize;
if ((BufferSize % BlockSize) != 0) {
return EFI_BAD_BUFFER_SIZE;
}
NumberOfBlocks = BufferSize / BlockSize;
if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {
return EFI_INVALID_PARAMETER;
}
IoAlign = Media->IoAlign;
if (IoAlign > 0 && (((UINTN) Buffer & (IoAlign - 1)) != 0)) {
return EFI_INVALID_PARAMETER;
}
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
Device = NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO2 (This);
if ((Token != NULL) && (Token->Event != NULL)) {
Token->TransactionStatus = EFI_SUCCESS;
Status = NvmeAsyncWrite (Device, Buffer, Lba, NumberOfBlocks, Token);
} else {
Status = NvmeWrite (Device, Buffer, Lba, NumberOfBlocks);
}
gBS->RestoreTPL (OldTpl);
return Status;
}
/**
Flush the Block Device.
If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_EFI_WRITE_PROTECTED or EFI_MEDIA_CHANGED
is returned and non-blocking I/O is being used, the Event associated with
this request will not be signaled.
@param[in] This Indicates a pointer to the calling context.
@param[in,out] Token A pointer to the token associated with the
transaction.
@retval EFI_SUCCESS The flush request was queued if Event is not
NULL.
All outstanding data was written correctly to
the device if the Event is NULL.
@retval EFI_DEVICE_ERROR The device reported an error while writting back
the data.
@retval EFI_WRITE_PROTECTED The device cannot be written to.
@retval EFI_NO_MEDIA There is no media in the device.
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack
of resources.
**/
EFI_STATUS
EFIAPI
NvmeBlockIoFlushBlocksEx (
IN EFI_BLOCK_IO2_PROTOCOL *This,
IN OUT EFI_BLOCK_IO2_TOKEN *Token
)
{
NVME_DEVICE_PRIVATE_DATA *Device;
BOOLEAN IsEmpty;
EFI_TPL OldTpl;
//
// Check parameters.
//
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Device = NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO2 (This);
//
// Wait for the asynchronous I/O queue to become empty.
//
while (TRUE) {
OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
IsEmpty = IsListEmpty (&Device->AsyncQueue);
gBS->RestoreTPL (OldTpl);
if (IsEmpty) {
break;
}
gBS->Stall (100);
}
//
// Signal caller event
//
if ((Token != NULL) && (Token->Event != NULL)) {
Token->TransactionStatus = EFI_SUCCESS;
gBS->SignalEvent (Token->Event);
}
return EFI_SUCCESS;
}
/**
Trust transfer data from/to NVMe device.
This function performs one NVMe transaction to do a trust transfer from/to NVMe device.
@param Private The pointer to the NVME_CONTROLLER_PRIVATE_DATA data structure.
@param Buffer The pointer to the current transaction buffer.
@param SecurityProtocolId The value of the "Security Protocol" parameter of
the security protocol command to be sent.
@param SecurityProtocolSpecificData The value of the "Security Protocol Specific" parameter
of the security protocol command to be sent.
@param TransferLength The block number or sector count of the transfer.
@param IsTrustSend Indicates whether it is a trust send operation or not.
@param Timeout The timeout, in 100ns units, to use for the execution
of the security protocol command. A Timeout value of 0
means that this function will wait indefinitely for the
security protocol command to execute. If Timeout is greater
than zero, then this function will return EFI_TIMEOUT
if the time required to execute the receive data command
is greater than Timeout.
@param TransferLengthOut A pointer to a buffer to store the size in bytes of the data
written to the buffer. Ignore it when IsTrustSend is TRUE.
@retval EFI_SUCCESS The data transfer is complete successfully.
@return others Some error occurs when transferring data.
**/
EFI_STATUS
TrustTransferNvmeDevice (
IN OUT NVME_CONTROLLER_PRIVATE_DATA *Private,
IN OUT VOID *Buffer,
IN UINT8 SecurityProtocolId,
IN UINT16 SecurityProtocolSpecificData,
IN UINTN TransferLength,
IN BOOLEAN IsTrustSend,
IN UINT64 Timeout,
OUT UINTN *TransferLengthOut
)
{
EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;
EFI_NVM_EXPRESS_COMMAND Command;
EFI_NVM_EXPRESS_COMPLETION Completion;
EFI_STATUS Status;
UINT16 SpecificData;
ZeroMem (&CommandPacket, sizeof (EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
ZeroMem (&Command, sizeof (EFI_NVM_EXPRESS_COMMAND));
ZeroMem (&Completion, sizeof (EFI_NVM_EXPRESS_COMPLETION));
CommandPacket.NvmeCmd = &Command;
CommandPacket.NvmeCompletion = &Completion;
//
// Change Endianness of SecurityProtocolSpecificData
//
SpecificData = (((SecurityProtocolSpecificData << 8) & 0xFF00) | (SecurityProtocolSpecificData >> 8));
if (IsTrustSend) {
Command.Cdw0.Opcode = NVME_ADMIN_SECURITY_SEND_CMD;
CommandPacket.TransferBuffer = Buffer;
CommandPacket.TransferLength = (UINT32)TransferLength;
CommandPacket.NvmeCmd->Cdw10 = (UINT32)((SecurityProtocolId << 24) | (SpecificData << 8));
CommandPacket.NvmeCmd->Cdw11 = (UINT32)TransferLength;
} else {
Command.Cdw0.Opcode = NVME_ADMIN_SECURITY_RECEIVE_CMD;
CommandPacket.TransferBuffer = Buffer;
CommandPacket.TransferLength = (UINT32)TransferLength;
CommandPacket.NvmeCmd->Cdw10 = (UINT32)((SecurityProtocolId << 24) | (SpecificData << 8));
CommandPacket.NvmeCmd->Cdw11 = (UINT32)TransferLength;
}
CommandPacket.NvmeCmd->Flags = CDW10_VALID | CDW11_VALID;
CommandPacket.NvmeCmd->Nsid = NVME_CONTROLLER_ID;
CommandPacket.CommandTimeout = Timeout;
CommandPacket.QueueType = NVME_ADMIN_QUEUE;
Status = Private->Passthru.PassThru (
&Private->Passthru,
NVME_CONTROLLER_ID,
&CommandPacket,
NULL
);
if (!IsTrustSend) {
if (EFI_ERROR (Status)) {
*TransferLengthOut = 0;
} else {
*TransferLengthOut = (UINTN) TransferLength;
}
}
return Status;
}
/**
Send a security protocol command to a device that receives data and/or the result
of one or more commands sent by SendData.
The ReceiveData function sends a security protocol command to the given MediaId.
The security protocol command sent is defined by SecurityProtocolId and contains
the security protocol specific data SecurityProtocolSpecificData. The function
returns the data from the security protocol command in PayloadBuffer.
For devices supporting the SCSI command set, the security protocol command is sent
using the SECURITY PROTOCOL IN command defined in SPC-4.
For devices supporting the ATA command set, the security protocol command is sent
using one of the TRUSTED RECEIVE commands defined in ATA8-ACS if PayloadBufferSize
is non-zero.
If the PayloadBufferSize is zero, the security protocol command is sent using the
Trusted Non-Data command defined in ATA8-ACS.
If PayloadBufferSize is too small to store the available data from the security
protocol command, the function shall copy PayloadBufferSize bytes into the
PayloadBuffer and return EFI_WARN_BUFFER_TOO_SMALL.
If PayloadBuffer or PayloadTransferSize is NULL and PayloadBufferSize is non-zero,
the function shall return EFI_INVALID_PARAMETER.
If the given MediaId does not support security protocol commands, the function shall
return EFI_UNSUPPORTED. If there is no media in the device, the function returns
EFI_NO_MEDIA. If the MediaId is not the ID for the current media in the device,
the function returns EFI_MEDIA_CHANGED.
If the security protocol fails to complete within the Timeout period, the function
shall return EFI_TIMEOUT.
If the security protocol command completes without an error, the function shall
return EFI_SUCCESS. If the security protocol command completes with an error, the
function shall return EFI_DEVICE_ERROR.
@param This Indicates a pointer to the calling context.
@param MediaId ID of the medium to receive data from.
@param Timeout The timeout, in 100ns units, to use for the execution
of the security protocol command. A Timeout value of 0
means that this function will wait indefinitely for the
security protocol command to execute. If Timeout is greater
than zero, then this function will return EFI_TIMEOUT
if the time required to execute the receive data command
is greater than Timeout.
@param SecurityProtocolId The value of the "Security Protocol" parameter of
the security protocol command to be sent.
@param SecurityProtocolSpecificData The value of the "Security Protocol Specific" parameter
of the security protocol command to be sent.
@param PayloadBufferSize Size in bytes of the payload data buffer.
@param PayloadBuffer A pointer to a destination buffer to store the security
protocol command specific payload data for the security
protocol command. The caller is responsible for having
either implicit or explicit ownership of the buffer.
@param PayloadTransferSize A pointer to a buffer to store the size in bytes of the
data written to the payload data buffer.
@retval EFI_SUCCESS The security protocol command completed successfully.
@retval EFI_WARN_BUFFER_TOO_SMALL The PayloadBufferSize was too small to store the available
data from the device. The PayloadBuffer contains the truncated data.
@retval EFI_UNSUPPORTED The given MediaId does not support security protocol commands.
@retval EFI_DEVICE_ERROR The security protocol command completed with an error.
@retval EFI_NO_MEDIA There is no media in the device.
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
@retval EFI_INVALID_PARAMETER The PayloadBuffer or PayloadTransferSize is NULL and
PayloadBufferSize is non-zero.
@retval EFI_TIMEOUT A timeout occurred while waiting for the security
protocol command to execute.
**/
EFI_STATUS
EFIAPI
NvmeStorageSecurityReceiveData (
IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *This,
IN UINT32 MediaId,
IN UINT64 Timeout,
IN UINT8 SecurityProtocolId,
IN UINT16 SecurityProtocolSpecificData,
IN UINTN PayloadBufferSize,
OUT VOID *PayloadBuffer,
OUT UINTN *PayloadTransferSize
)
{
EFI_STATUS Status;
NVME_DEVICE_PRIVATE_DATA *Device;
Status = EFI_SUCCESS;
if ((PayloadBuffer == NULL) || (PayloadTransferSize == NULL) || (PayloadBufferSize == 0)) {
return EFI_INVALID_PARAMETER;
}
Device = NVME_DEVICE_PRIVATE_DATA_FROM_STORAGE_SECURITY (This);
if (MediaId != Device->BlockIo.Media->MediaId) {
return EFI_MEDIA_CHANGED;
}
if (!Device->BlockIo.Media->MediaPresent) {
return EFI_NO_MEDIA;
}
Status = TrustTransferNvmeDevice (
Device->Controller,
PayloadBuffer,
SecurityProtocolId,
SecurityProtocolSpecificData,
PayloadBufferSize,
FALSE,
Timeout,
PayloadTransferSize
);
return Status;
}
/**
Send a security protocol command to a device.
The SendData function sends a security protocol command containing the payload
PayloadBuffer to the given MediaId. The security protocol command sent is
defined by SecurityProtocolId and contains the security protocol specific data
SecurityProtocolSpecificData. If the underlying protocol command requires a
specific padding for the command payload, the SendData function shall add padding
bytes to the command payload to satisfy the padding requirements.
For devices supporting the SCSI command set, the security protocol command is sent
using the SECURITY PROTOCOL OUT command defined in SPC-4.
For devices supporting the ATA command set, the security protocol command is sent
using one of the TRUSTED SEND commands defined in ATA8-ACS if PayloadBufferSize
is non-zero. If the PayloadBufferSize is zero, the security protocol command is
sent using the Trusted Non-Data command defined in ATA8-ACS.
If PayloadBuffer is NULL and PayloadBufferSize is non-zero, the function shall
return EFI_INVALID_PARAMETER.
If the given MediaId does not support security protocol commands, the function
shall return EFI_UNSUPPORTED. If there is no media in the device, the function
returns EFI_NO_MEDIA. If the MediaId is not the ID for the current media in the
device, the function returns EFI_MEDIA_CHANGED.
If the security protocol fails to complete within the Timeout period, the function
shall return EFI_TIMEOUT.
If the security protocol command completes without an error, the function shall return
EFI_SUCCESS. If the security protocol command completes with an error, the function
shall return EFI_DEVICE_ERROR.
@param This Indicates a pointer to the calling context.
@param MediaId ID of the medium to receive data from.
@param Timeout The timeout, in 100ns units, to use for the execution
of the security protocol command. A Timeout value of 0
means that this function will wait indefinitely for the
security protocol command to execute. If Timeout is greater
than zero, then this function will return EFI_TIMEOUT
if the time required to execute the send data command
is greater than Timeout.
@param SecurityProtocolId The value of the "Security Protocol" parameter of
the security protocol command to be sent.
@param SecurityProtocolSpecificData The value of the "Security Protocol Specific" parameter
of the security protocol command to be sent.
@param PayloadBufferSize Size in bytes of the payload data buffer.
@param PayloadBuffer A pointer to a destination buffer to store the security
protocol command specific payload data for the security
protocol command.
@retval EFI_SUCCESS The security protocol command completed successfully.
@retval EFI_UNSUPPORTED The given MediaId does not support security protocol commands.
@retval EFI_DEVICE_ERROR The security protocol command completed with an error.
@retval EFI_NO_MEDIA There is no media in the device.
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
@retval EFI_INVALID_PARAMETER The PayloadBuffer is NULL and PayloadBufferSize is non-zero.
@retval EFI_TIMEOUT A timeout occurred while waiting for the security
protocol command to execute.
**/
EFI_STATUS
EFIAPI
NvmeStorageSecuritySendData (
IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *This,
IN UINT32 MediaId,
IN UINT64 Timeout,
IN UINT8 SecurityProtocolId,
IN UINT16 SecurityProtocolSpecificData,
IN UINTN PayloadBufferSize,
IN VOID *PayloadBuffer
)
{
EFI_STATUS Status;
NVME_DEVICE_PRIVATE_DATA *Device;
Status = EFI_SUCCESS;
if ((PayloadBuffer == NULL) && (PayloadBufferSize != 0)) {
return EFI_INVALID_PARAMETER;
}
Device = NVME_DEVICE_PRIVATE_DATA_FROM_STORAGE_SECURITY (This);
if (MediaId != Device->BlockIo.Media->MediaId) {
return EFI_MEDIA_CHANGED;
}
if (!Device->BlockIo.Media->MediaPresent) {
return EFI_NO_MEDIA;
}
Status = TrustTransferNvmeDevice (
Device->Controller,
PayloadBuffer,
SecurityProtocolId,
SecurityProtocolSpecificData,
PayloadBufferSize,
TRUE,
Timeout,
NULL
);
return Status;
}
|