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
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
|
// SPDX-License-Identifier: LGPL-2.1-or-later
/*
* This file is part of libnvme.
* Copyright (c) 2020 Western Digital Corporation or its affiliates.
*
* Authors: Keith Busch <keith.busch@wdc.com>
* Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
*/
#ifndef _LIBNVME_IOCTL_H
#define _LIBNVME_IOCTL_H
#include <stddef.h>
#include <sys/ioctl.h>
#include "types.h"
#include "api-types.h"
/*
* We can not always count on the kernel UAPI being installed. Use the same
* 'ifdef' guard to avoid double definitions just in case.
*/
#ifndef _UAPI_LINUX_NVME_IOCTL_H
#define _UAPI_LINUX_NVME_IOCTL_H
#ifndef _LINUX_NVME_IOCTL_H
#define _LINUX_NVME_IOCTL_H
/**
* DOC: ioctl.h
*
* Linux NVMe ioctl interface functions
*/
/* '0' is interpreted by the kernel to mean 'apply the default timeout' */
#define NVME_DEFAULT_IOCTL_TIMEOUT 0
/*
* 4k is the smallest possible transfer unit, so restricting to 4k
* avoids having to check the MDTS value of the controller.
*/
#define NVME_LOG_PAGE_PDU_SIZE 4096
/**
* struct nvme_passthru_cmd - nvme passthrough command structure
* @opcode: Operation code, see &enum nvme_io_opcodes and &enum nvme_admin_opcodes
* @flags: Not supported: intended for command flags (eg: SGL, FUSE)
* @rsvd1: Reserved for future use
* @nsid: Namespace Identifier, or Fabrics type
* @cdw2: Command Dword 2 (no spec defined use)
* @cdw3: Command Dword 3 (no spec defined use)
* @metadata: User space address to metadata buffer (NULL if not used)
* @addr: User space address to data buffer (NULL if not used)
* @metadata_len: Metadata buffer transfer length
* @data_len: Data buffer transfer length
* @cdw10: Command Dword 10 (command specific)
* @cdw11: Command Dword 11 (command specific)
* @cdw12: Command Dword 12 (command specific)
* @cdw13: Command Dword 13 (command specific)
* @cdw14: Command Dword 14 (command specific)
* @cdw15: Command Dword 15 (command specific)
* @timeout_ms: If non-zero, overrides system default timeout in milliseconds
* @result: Set on completion to the command's CQE DWORD 0 controller response
*/
struct nvme_passthru_cmd {
__u8 opcode;
__u8 flags;
__u16 rsvd1;
__u32 nsid;
__u32 cdw2;
__u32 cdw3;
__u64 metadata;
__u64 addr;
__u32 metadata_len;
__u32 data_len;
__u32 cdw10;
__u32 cdw11;
__u32 cdw12;
__u32 cdw13;
__u32 cdw14;
__u32 cdw15;
__u32 timeout_ms;
__u32 result;
};
/**
* struct nvme_passthru_cmd64 - 64-bit nvme passthrough command structure
* @opcode: Operation code, see &enum nvme_io_opcodes and &enum nvme_admin_opcodes
* @flags: Not supported: intended for command flags (eg: SGL, FUSE)
* @rsvd1: Reserved for future use
* @nsid: Namespace Identifier, or Fabrics type
* @cdw2: Command Dword 2 (no spec defined use)
* @cdw3: Command Dword 3 (no spec defined use)
* @metadata: User space address to metadata buffer (NULL if not used)
* @addr: User space address to data buffer (NULL if not used)
* @metadata_len: Metadata buffer transfer length
* @data_len: Data buffer transfer length
* @cdw10: Command Dword 10 (command specific)
* @cdw11: Command Dword 11 (command specific)
* @cdw12: Command Dword 12 (command specific)
* @cdw13: Command Dword 13 (command specific)
* @cdw14: Command Dword 14 (command specific)
* @cdw15: Command Dword 15 (command specific)
* @timeout_ms: If non-zero, overrides system default timeout in milliseconds
* @rsvd2: Reserved for future use (and fills an implicit struct pad
* @result: Set on completion to the command's CQE DWORD 0-1 controller response
*/
struct nvme_passthru_cmd64 {
__u8 opcode;
__u8 flags;
__u16 rsvd1;
__u32 nsid;
__u32 cdw2;
__u32 cdw3;
__u64 metadata;
__u64 addr;
__u32 metadata_len;
__u32 data_len;
__u32 cdw10;
__u32 cdw11;
__u32 cdw12;
__u32 cdw13;
__u32 cdw14;
__u32 cdw15;
__u32 timeout_ms;
__u32 rsvd2;
__u64 result;
};
/**
* struct nvme_uring_cmd - nvme uring command structure
* @opcode: Operation code, see &enum nvme_io_opcodes and &enum nvme_admin_opcodes
* @flags: Not supported: intended for command flags (eg: SGL, FUSE)
* @rsvd1: Reserved for future use
* @nsid: Namespace Identifier, or Fabrics type
* @cdw2: Command Dword 2 (no spec defined use)
* @cdw3: Command Dword 3 (no spec defined use)
* @metadata: User space address to metadata buffer (NULL if not used)
* @addr: User space address to data buffer (NULL if not used)
* @metadata_len: Metadata buffer transfer length
* @data_len: Data buffer transfer length
* @cdw10: Command Dword 10 (command specific)
* @cdw11: Command Dword 11 (command specific)
* @cdw12: Command Dword 12 (command specific)
* @cdw13: Command Dword 13 (command specific)
* @cdw14: Command Dword 14 (command specific)
* @cdw15: Command Dword 15 (command specific)
* @timeout_ms: If non-zero, overrides system default timeout in milliseconds
* @rsvd2: Reserved for future use (and fills an implicit struct pad
*/
struct nvme_uring_cmd {
__u8 opcode;
__u8 flags;
__u16 rsvd1;
__u32 nsid;
__u32 cdw2;
__u32 cdw3;
__u64 metadata;
__u64 addr;
__u32 metadata_len;
__u32 data_len;
__u32 cdw10;
__u32 cdw11;
__u32 cdw12;
__u32 cdw13;
__u32 cdw14;
__u32 cdw15;
__u32 timeout_ms;
__u32 rsvd2;
};
#define NVME_IOCTL_ID _IO('N', 0x40)
#define NVME_IOCTL_RESET _IO('N', 0x44)
#define NVME_IOCTL_SUBSYS_RESET _IO('N', 0x45)
#define NVME_IOCTL_RESCAN _IO('N', 0x46)
#define NVME_IOCTL_ADMIN_CMD _IOWR('N', 0x41, struct nvme_passthru_cmd)
#define NVME_IOCTL_IO_CMD _IOWR('N', 0x43, struct nvme_passthru_cmd)
#define NVME_IOCTL_ADMIN64_CMD _IOWR('N', 0x47, struct nvme_passthru_cmd64)
#define NVME_IOCTL_IO64_CMD _IOWR('N', 0x48, struct nvme_passthru_cmd64)
/* io_uring async commands: */
#define NVME_URING_CMD_IO _IOWR('N', 0x80, struct nvme_uring_cmd)
#define NVME_URING_CMD_IO_VEC _IOWR('N', 0x81, struct nvme_uring_cmd)
#endif /* _UAPI_LINUX_NVME_IOCTL_H */
#endif /* _LINUX_NVME_IOCTL_H */
/**
* sizeof_args - Helper function used to determine structure sizes
* @type: Argument structure type
* @member: Member inside the type
* @align: Alignment information
*/
#define sizeof_args(type, member, align) \
({ \
type s; \
size_t t = offsetof(type, member) + sizeof(s.member); \
size_t p = (sizeof(align) - (t % sizeof(align))) % sizeof(align); \
t + p; \
})
/**
* nvme_submit_admin_passthru64() - Submit a 64-bit nvme passthrough admin
* command
* @fd: File descriptor of nvme device
* @cmd: The nvme admin command to send
* @result: Optional field to return the result from the CQE DW0-1
*
* Uses NVME_IOCTL_ADMIN64_CMD for the ioctl request.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_submit_admin_passthru64(int fd, struct nvme_passthru_cmd64 *cmd,
__u64 *result);
/**
* nvme_admin_passthru64() - Submit a 64-bit nvme passthrough command
* @fd: File descriptor of nvme device
* @opcode: The nvme io command to send
* @flags: NVMe command flags (not used)
* @rsvd: Reserved for future use
* @nsid: Namespace identifier
* @cdw2: Command dword 2
* @cdw3: Command dword 3
* @cdw10: Command dword 10
* @cdw11: Command dword 11
* @cdw12: Command dword 12
* @cdw13: Command dword 13
* @cdw14: Command dword 14
* @cdw15: Command dword 15
* @data_len: Length of the data transferred in this command in bytes
* @data: Pointer to user address of the data buffer
* @metadata_len:Length of metadata transferred in this command
* @metadata: Pointer to user address of the metadata buffer
* @timeout_ms: How long the kernel waits for the command to complete
* @result: Optional field to return the result from the CQE dword 0
*
* Parameterized form of nvme_submit_admin_passthru64(). This sets up and
* submits a &struct nvme_passthru_cmd64.
*
* Known values for @opcode are defined in &enum nvme_admin_opcode.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_admin_passthru64(int fd, __u8 opcode, __u8 flags, __u16 rsvd,
__u32 nsid, __u32 cdw2, __u32 cdw3, __u32 cdw10, __u32 cdw11,
__u32 cdw12, __u32 cdw13, __u32 cdw14, __u32 cdw15,
__u32 data_len, void *data, __u32 metadata_len, void *metadata,
__u32 timeout_ms, __u64 *result);
/**
* nvme_submit_admin_passthru() - Submit an nvme passthrough admin command
* @fd: File descriptor of nvme device
* @cmd: The nvme admin command to send
* @result: Optional field to return the result from the CQE DW0
*
* Uses NVME_IOCTL_ADMIN_CMD for the ioctl request.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_submit_admin_passthru(int fd, struct nvme_passthru_cmd *cmd,
__u32 *result);
/**
* nvme_admin_passthru() - Submit an nvme passthrough command
* @fd: File descriptor of nvme device
* @opcode: The nvme io command to send
* @flags: NVMe command flags (not used)
* @rsvd: Reserved for future use
* @nsid: Namespace identifier
* @cdw2: Command dword 2
* @cdw3: Command dword 3
* @cdw10: Command dword 10
* @cdw11: Command dword 11
* @cdw12: Command dword 12
* @cdw13: Command dword 13
* @cdw14: Command dword 14
* @cdw15: Command dword 15
* @data_len: Length of the data transferred in this command in bytes
* @data: Pointer to user address of the data buffer
* @metadata_len:Length of metadata transferred in this command
* @metadata: Pointer to user address of the metadata buffer
* @timeout_ms: How long the kernel waits for the command to complete
* @result: Optional field to return the result from the CQE dword 0
*
* Parameterized form of nvme_submit_admin_passthru(). This sets up and
* submits a &struct nvme_passthru_cmd.
*
* Known values for @opcode are defined in &enum nvme_admin_opcode.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_admin_passthru(int fd, __u8 opcode, __u8 flags, __u16 rsvd,
__u32 nsid, __u32 cdw2, __u32 cdw3, __u32 cdw10, __u32 cdw11,
__u32 cdw12, __u32 cdw13, __u32 cdw14, __u32 cdw15,
__u32 data_len, void *data, __u32 metadata_len, void *metadata,
__u32 timeout_ms, __u32 *result);
/**
* nvme_submit_io_passthru64() - Submit a 64-bit nvme passthrough command
* @fd: File descriptor of nvme device
* @cmd: The nvme io command to send
* @result: Optional field to return the result from the CQE DW0-1
*
* Uses NVME_IOCTL_IO64_CMD for the ioctl request.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_submit_io_passthru64(int fd, struct nvme_passthru_cmd64 *cmd,
__u64 *result);
/**
* nvme_io_passthru64() - Submit an nvme io passthrough command
* @fd: File descriptor of nvme device
* @opcode: The nvme io command to send
* @flags: NVMe command flags (not used)
* @rsvd: Reserved for future use
* @nsid: Namespace identifier
* @cdw2: Command dword 2
* @cdw3: Command dword 3
* @cdw10: Command dword 10
* @cdw11: Command dword 11
* @cdw12: Command dword 12
* @cdw13: Command dword 13
* @cdw14: Command dword 14
* @cdw15: Command dword 15
* @data_len: Length of the data transferred in this command in bytes
* @data: Pointer to user address of the data buffer
* @metadata_len:Length of metadata transferred in this command
* @metadata: Pointer to user address of the metadata buffer
* @timeout_ms: How long the kernel waits for the command to complete
* @result: Optional field to return the result from the CQE dword 0
*
* Parameterized form of nvme_submit_io_passthru64(). This sets up and submits
* a &struct nvme_passthru_cmd64.
*
* Known values for @opcode are defined in &enum nvme_io_opcode.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_io_passthru64(int fd, __u8 opcode, __u8 flags, __u16 rsvd,
__u32 nsid, __u32 cdw2, __u32 cdw3, __u32 cdw10, __u32 cdw11,
__u32 cdw12, __u32 cdw13, __u32 cdw14, __u32 cdw15,
__u32 data_len, void *data, __u32 metadata_len, void *metadata,
__u32 timeout_ms, __u64 *result);
/**
* nvme_submit_io_passthru() - Submit an nvme passthrough command
* @fd: File descriptor of nvme device
* @cmd: The nvme io command to send
* @result: Optional field to return the result from the CQE dword 0
* @result: Optional field to return the result from the CQE DW0
*
* Uses NVME_IOCTL_IO_CMD for the ioctl request.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_submit_io_passthru(int fd, struct nvme_passthru_cmd *cmd,
__u32 *result);
/**
* nvme_io_passthru() - Submit an nvme io passthrough command
* @fd: File descriptor of nvme device
* @opcode: The nvme io command to send
* @flags: NVMe command flags (not used)
* @rsvd: Reserved for future use
* @nsid: Namespace identifier
* @cdw2: Command dword 2
* @cdw3: Command dword 3
* @cdw10: Command dword 10
* @cdw11: Command dword 11
* @cdw12: Command dword 12
* @cdw13: Command dword 13
* @cdw14: Command dword 14
* @cdw15: Command dword 15
* @data_len: Length of the data transferred in this command in bytes
* @data: Pointer to user address of the data buffer
* @metadata_len:Length of metadata transferred in this command
* @metadata: Pointer to user address of the metadata buffer
* @timeout_ms: How long the kernel waits for the command to complete
* @result: Optional field to return the result from the CQE dword 0
*
* Parameterized form of nvme_submit_io_passthru(). This sets up and submits
* a &struct nvme_passthru_cmd.
*
* Known values for @opcode are defined in &enum nvme_io_opcode.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_io_passthru(int fd, __u8 opcode, __u8 flags, __u16 rsvd,
__u32 nsid, __u32 cdw2, __u32 cdw3, __u32 cdw10, __u32 cdw11,
__u32 cdw12, __u32 cdw13, __u32 cdw14, __u32 cdw15,
__u32 data_len, void *data, __u32 metadata_len, void *metadata,
__u32 timeout_ms, __u32 *result);
/**
* nvme_subsystem_reset() - Initiate a subsystem reset
* @fd: File descriptor of nvme device
*
* This should only be sent to controller handles, not to namespaces.
*
* Return: Zero if a subsystem reset was initiated or -1 with errno set
* otherwise.
*/
int nvme_subsystem_reset(int fd);
/**
* nvme_ctrl_reset() - Initiate a controller reset
* @fd: File descriptor of nvme device
*
* This should only be sent to controller handles, not to namespaces.
*
* Return: 0 if a reset was initiated or -1 with errno set otherwise.
*/
int nvme_ctrl_reset(int fd);
/**
* nvme_ns_rescan() - Initiate a controller rescan
* @fd: File descriptor of nvme device
*
* This should only be sent to controller handles, not to namespaces.
*
* Return: 0 if a rescan was initiated or -1 with errno set otherwise.
*/
int nvme_ns_rescan(int fd);
/**
* nvme_get_nsid() - Retrieve the NSID from a namespace file descriptor
* @fd: File descriptor of nvme namespace
* @nsid: User pointer to namespace id
*
* This should only be sent to namespace handles, not to controllers. The
* kernel's interface returns the nsid as the return value. This is unfortunate
* for many architectures that are incapable of allowing distinguishing a
* namespace id > 0x80000000 from a negative error number.
*
* Return: 0 if @nsid was set successfully or -1 with errno set otherwise.
*/
int nvme_get_nsid(int fd, __u32 *nsid);
/**
* nvme_identify() - Send the NVMe Identify command
* @args: &struct nvme_identify_args argument structure
*
* The Identify command returns a data buffer that describes information about
* the NVM subsystem, the controller or the namespace(s).
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_identify(struct nvme_identify_args *args);
static inline int nvme_identify_cns_nsid(int fd, enum nvme_identify_cns cns,
__u32 nsid, void *data)
{
struct nvme_identify_args args = {
.result = NULL,
.data = data,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = cns,
.csi = NVME_CSI_NVM,
.nsid = nsid,
.cntid = NVME_CNTLID_NONE,
.cns_specific_id = NVME_CNSSPECID_NONE,
.uuidx = NVME_UUID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_identify_ctrl() - Retrieves nvme identify controller
* @fd: File descriptor of nvme device
* @id: User space destination address to transfer the data,
*
* Sends nvme identify with CNS value %NVME_IDENTIFY_CNS_CTRL.
*
* See &struct nvme_id_ctrl for details on the data returned.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_ctrl(int fd, struct nvme_id_ctrl *id)
{
return nvme_identify_cns_nsid(fd, NVME_IDENTIFY_CNS_CTRL,
NVME_NSID_NONE, id);
}
/**
* nvme_identify_ns() - Retrieves nvme identify namespace
* @fd: File descriptor of nvme device
* @nsid: Namespace to identify
* @ns: User space destination address to transfer the data
*
* If the Namespace Identifier (NSID) field specifies an active NSID, then the
* Identify Namespace data structure is returned to the host for that specified
* namespace.
*
* If the controller supports the Namespace Management capability and the NSID
* field is set to %NVME_NSID_ALL, then the controller returns an Identify Namespace
* data structure that specifies capabilities that are common across namespaces
* for this controller.
*
* See &struct nvme_id_ns for details on the structure returned.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_ns(int fd, __u32 nsid, struct nvme_id_ns *ns)
{
return nvme_identify_cns_nsid(fd, NVME_IDENTIFY_CNS_NS, nsid, ns);
}
/**
* nvme_identify_allocated_ns() - Same as nvme_identify_ns, but only for
* allocated namespaces
* @fd: File descriptor of nvme device
* @nsid: Namespace to identify
* @ns: User space destination address to transfer the data
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_allocated_ns(int fd, __u32 nsid,
struct nvme_id_ns *ns)
{
return nvme_identify_cns_nsid(fd, NVME_IDENTIFY_CNS_ALLOCATED_NS,
nsid, ns);
}
/**
* nvme_identify_active_ns_list() - Retrieves active namespaces id list
* @fd: File descriptor of nvme device
* @nsid: Return namespaces greater than this identifier
* @list: User space destination address to transfer the data
*
* A list of 1024 namespace IDs is returned to the host containing NSIDs in
* increasing order that are greater than the value specified in the Namespace
* Identifier (nsid) field of the command.
*
* See &struct nvme_ns_list for the definition of the returned structure.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_active_ns_list(int fd, __u32 nsid,
struct nvme_ns_list *list)
{
return nvme_identify_cns_nsid(fd, NVME_IDENTIFY_CNS_NS_ACTIVE_LIST,
nsid, list);
}
/**
* nvme_identify_allocated_ns_list() - Retrieves allocated namespace id list
* @fd: File descriptor of nvme device
* @nsid: Return namespaces greater than this identifier
* @list: User space destination address to transfer the data
*
* A list of 1024 namespace IDs is returned to the host containing NSIDs in
* increasing order that are greater than the value specified in the Namespace
* Identifier (nsid) field of the command.
*
* See &struct nvme_ns_list for the definition of the returned structure.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_allocated_ns_list(int fd, __u32 nsid,
struct nvme_ns_list *list)
{
return nvme_identify_cns_nsid(fd, NVME_IDENTIFY_CNS_ALLOCATED_NS_LIST,
nsid, list);
}
/**
* nvme_identify_ctrl_list() - Retrieves identify controller list
* @fd: File descriptor of nvme device
* @cntid: Starting CNTLID to return in the list
* @cntlist: User space destination address to transfer the data
*
* Up to 2047 controller identifiers is returned containing a controller
* identifier greater than or equal to the controller identifier specified in
* @cntid.
*
* See &struct nvme_ctrl_list for a definition of the structure returned.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_ctrl_list(int fd, __u16 cntid,
struct nvme_ctrl_list *cntlist)
{
struct nvme_identify_args args = {
.result = NULL,
.data = cntlist,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_CTRL_LIST,
.csi = NVME_CSI_NVM,
.nsid = NVME_NSID_NONE,
.cntid = cntid,
.cns_specific_id = NVME_CNSSPECID_NONE,
.uuidx = NVME_UUID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_identify_nsid_ctrl_list() - Retrieves controller list attached to an nsid
* @fd: File descriptor of nvme device
* @nsid: Return controllers that are attached to this nsid
* @cntid: Starting CNTLID to return in the list
* @cntlist: User space destination address to transfer the data
*
* Up to 2047 controller identifiers are returned containing a controller
* identifier greater than or equal to the controller identifier specified in
* @cntid attached to @nsid.
*
* See &struct nvme_ctrl_list for a definition of the structure returned.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1
*/
static inline int nvme_identify_nsid_ctrl_list(int fd, __u32 nsid, __u16 cntid,
struct nvme_ctrl_list *cntlist)
{
struct nvme_identify_args args = {
.result = NULL,
.data = cntlist,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_NS_CTRL_LIST,
.csi = NVME_CSI_NVM,
.nsid = nsid,
.cntid = cntid,
.cns_specific_id = NVME_CNSSPECID_NONE,
.uuidx = NVME_UUID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_identify_ns_descs() - Retrieves namespace descriptor list
* @fd: File descriptor of nvme device
* @nsid: The namespace id to retrieve descriptors
* @descs: User space destination address to transfer the data
*
* A list of Namespace Identification Descriptor structures is returned to the
* host for the namespace specified in the Namespace Identifier (NSID) field if
* it is an active NSID.
*
* The data returned is in the form of an array of 'struct nvme_ns_id_desc'.
*
* See &struct nvme_ns_id_desc for the definition of the returned structure.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_ns_descs(int fd, __u32 nsid,
struct nvme_ns_id_desc *descs)
{
return nvme_identify_cns_nsid(fd, NVME_IDENTIFY_CNS_NS_DESC_LIST,
nsid, descs);
}
/**
* nvme_identify_nvmset_list() - Retrieves NVM Set List
* @fd: File descriptor of nvme device
* @nvmsetid: NVM Set Identifier
* @nvmset: User space destination address to transfer the data
*
* Retrieves an NVM Set List, &struct nvme_id_nvmset_list. The data structure
* is an ordered list by NVM Set Identifier, starting with the first NVM Set
* Identifier supported by the NVM subsystem that is equal to or greater than
* the NVM Set Identifier.
*
* See &struct nvme_id_nvmset_list for the definition of the returned structure.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_nvmset_list(int fd, __u16 nvmsetid,
struct nvme_id_nvmset_list *nvmset)
{
struct nvme_identify_args args = {
.result = NULL,
.data = nvmset,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_NVMSET_LIST,
.csi = NVME_CSI_NVM,
.nsid = NVME_NSID_NONE,
.cntid = NVME_CNTLID_NONE,
.cns_specific_id = nvmsetid,
.uuidx = NVME_UUID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_identify_primary_ctrl() - Retrieve NVMe Primary Controller
* identification
* @fd: File descriptor of nvme device
* @cntid: Return controllers starting at this identifier
* @cap: User space destination buffer address to transfer the data
*
* See &struct nvme_primary_ctrl_cap for the definition of the returned structure, @cap.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_primary_ctrl(int fd, __u16 cntid,
struct nvme_primary_ctrl_cap *cap)
{
struct nvme_identify_args args = {
.result = NULL,
.data = cap,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_PRIMARY_CTRL_CAP,
.csi = NVME_CSI_NVM,
.nsid = NVME_NSID_NONE,
.cntid = cntid,
.cns_specific_id = NVME_CNSSPECID_NONE,
.uuidx = NVME_UUID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_identify_secondary_ctrl_list() - Retrieves secondary controller list
* @fd: File descriptor of nvme device
* @nsid: Namespace identifier
* @cntid: Return controllers starting at this identifier
* @sc_list: User space destination address to transfer the data
*
* A Secondary Controller List is returned to the host for up to 127 secondary
* controllers associated with the primary controller processing this command.
* The list contains entries for controller identifiers greater than or equal
* to the value specified in the Controller Identifier (cntid).
*
* See &struct nvme_secondary_ctrls_list for a definition of the returned
* structure.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_secondary_ctrl_list(int fd, __u32 nsid,
__u16 cntid, struct nvme_secondary_ctrl_list *sc_list)
{
struct nvme_identify_args args = {
.result = NULL,
.data = sc_list,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_SECONDARY_CTRL_LIST,
.csi = NVME_CSI_NVM,
.nsid = nsid,
.cntid = cntid,
.cns_specific_id = NVME_CNSSPECID_NONE,
.uuidx = NVME_UUID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_identify_ns_granularity() - Retrieves namespace granularity
* identification
* @fd: File descriptor of nvme device
* @gr_list: User space destination address to transfer the data
*
* If the controller supports reporting of Namespace Granularity, then a
* Namespace Granularity List is returned to the host for up to sixteen
* namespace granularity descriptors
*
* See &struct nvme_id_ns_granularity_list for the definition of the returned
* structure.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_ns_granularity(int fd,
struct nvme_id_ns_granularity_list *gr_list)
{
return nvme_identify_cns_nsid(fd, NVME_IDENTIFY_CNS_NS_GRANULARITY,
NVME_NSID_NONE, gr_list);
}
/**
* nvme_identify_uuid() - Retrieves device's UUIDs
* @fd: File descriptor of nvme device
* @uuid_list: User space destination address to transfer the data
*
* Each UUID List entry is either 0h, the NVMe Invalid UUID, or a valid UUID.
* Valid UUIDs are those which are non-zero and are not the NVMe Invalid UUID.
*
* See &struct nvme_id_uuid_list for the definition of the returned structure.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_uuid(int fd, struct nvme_id_uuid_list *uuid_list)
{
return nvme_identify_cns_nsid(fd, NVME_IDENTIFY_CNS_UUID_LIST,
NVME_NSID_NONE, uuid_list);
}
/**
* nvme_identify_ns_csi() - I/O command set specific identify namespace data
* @fd: File descriptor of nvme device
* @nsid: Namespace to identify
* @uuidx: UUID Index for differentiating vendor specific encoding
* @csi: Command Set Identifier
* @data: User space destination address to transfer the data
*
* An I/O Command Set specific Identify Namespace data structure is returned
* for the namespace specified in @nsid.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_ns_csi(int fd, __u32 nsid, __u8 uuidx,
enum nvme_csi csi, void *data)
{
struct nvme_identify_args args = {
.result = NULL,
.data = data,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_CSI_NS,
.csi = csi,
.nsid = nsid,
.cntid = NVME_CNTLID_NONE,
.cns_specific_id = NVME_CNSSPECID_NONE,
.uuidx = uuidx,
};
return nvme_identify(&args);
}
/**
* nvme_identify_ctrl_csi() - I/O command set specific Identify Controller data
* @fd: File descriptor of nvme device
* @csi: Command Set Identifier
* @data: User space destination address to transfer the data
*
* An I/O Command Set specific Identify Controller data structure is returned
* to the host for the controller processing the command. The specific Identify
* Controller data structure to be returned is specified by @csi.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_ctrl_csi(int fd, enum nvme_csi csi, void *data)
{
struct nvme_identify_args args = {
.result = NULL,
.data = data,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_CSI_CTRL,
.csi = csi,
.nsid = NVME_NSID_NONE,
.cntid = NVME_CNTLID_NONE,
.cns_specific_id = NVME_CNSSPECID_NONE,
.uuidx = NVME_UUID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_identify_active_ns_list_csi() - Active namespace ID list associated with a specified I/O command set
* @fd: File descriptor of nvme device
* @nsid: Return namespaces greater than this identifier
* @csi: Command Set Identifier
* @ns_list: User space destination address to transfer the data
*
* A list of 1024 namespace IDs is returned to the host containing active
* NSIDs in increasing order that are greater than the value specified in
* the Namespace Identifier (nsid) field of the command and matching the
* I/O Command Set specified in the @csi argument.
*
* See &struct nvme_ns_list for the definition of the returned structure.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_active_ns_list_csi(int fd, __u32 nsid,
enum nvme_csi csi, struct nvme_ns_list *ns_list)
{
struct nvme_identify_args args = {
.result = NULL,
.data = ns_list,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_CSI_NS_ACTIVE_LIST,
.csi = csi,
.nsid = nsid,
.cntid = NVME_CNTLID_NONE,
.cns_specific_id = NVME_CNSSPECID_NONE,
.uuidx = NVME_UUID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_identify_allocated_ns_list_csi() - Allocated namespace ID list associated with a specified I/O command set
* @fd: File descriptor of nvme device
* @nsid: Return namespaces greater than this identifier
* @csi: Command Set Identifier
* @ns_list: User space destination address to transfer the data
*
* A list of 1024 namespace IDs is returned to the host containing allocated
* NSIDs in increasing order that are greater than the value specified in
* the @nsid field of the command and matching the I/O Command Set
* specified in the @csi argument.
*
* See &struct nvme_ns_list for the definition of the returned structure.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_allocated_ns_list_csi(int fd, __u32 nsid,
enum nvme_csi csi, struct nvme_ns_list *ns_list)
{
struct nvme_identify_args args = {
.result = NULL,
.data = ns_list,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_CSI_ALLOCATED_NS_LIST,
.csi = csi,
.nsid = nsid,
.cntid = NVME_CNTLID_NONE,
.cns_specific_id = NVME_CNSSPECID_NONE,
.uuidx = NVME_UUID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_identify_independent_identify_ns() - I/O command set independent Identify namespace data
* @fd: File descriptor of nvme device
* @nsid: Return namespaces greater than this identifier
* @ns: I/O Command Set Independent Identify Namespace data
* structure
*
* The I/O command set independent Identify namespace data structure for
* the namespace identified with @ns is returned to the host.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_independent_identify_ns(int fd, __u32 nsid,
struct nvme_id_independent_id_ns *ns)
{
struct nvme_identify_args args = {
.result = NULL,
.data = ns,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_CSI_INDEPENDENT_ID_NS,
.csi = NVME_CSI_NVM,
.nsid = nsid,
.cntid = NVME_CNTLID_NONE,
.cns_specific_id = NVME_CNSSPECID_NONE,
.uuidx = NVME_UUID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_identify_ns_csi_user_data_format() - Identify namespace user data format
* @fd: File descriptor of nvme device
* @user_data_format: Return namespaces capability of identifier
* @uuidx: UUID selection, if supported
* @csi: Command Set Identifier
* @data: User space destination address to transfer the data
*
* Identify Namespace data structure for the specified User Data Format
* index containing the namespace capabilities for the NVM Command Set.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_ns_csi_user_data_format(int fd,
__u16 user_data_format, __u8 uuidx,
enum nvme_csi csi, void *data)
{
struct nvme_identify_args args = {
.result = NULL,
.data = data,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_NS_USER_DATA_FORMAT,
.csi = csi,
.nsid = NVME_NSID_NONE,
.cntid = NVME_CNTLID_NONE,
.cns_specific_id = user_data_format,
.uuidx = uuidx,
};
return nvme_identify(&args);
}
/**
* nvme_identify_iocs_ns_csi_user_data_format() - Identify I/O command set namespace data structure
* @fd: File descriptor of nvme device
* @user_data_format: Return namespaces capability of identifier
* @uuidx: UUID selection, if supported
* @csi: Command Set Identifier
* @data: User space destination address to transfer the data
*
* I/O Command Set specific Identify Namespace data structure for
* the specified User Data Format index containing the namespace
* capabilities for the I/O Command Set specified in the CSI field.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_iocs_ns_csi_user_data_format(int fd,
__u16 user_data_format, __u8 uuidx,
enum nvme_csi csi, void *data)
{
struct nvme_identify_args args = {
.result = NULL,
.data = data,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_CSI_NS_USER_DATA_FORMAT,
.csi = csi,
.nsid = NVME_NSID_NONE,
.cntid = NVME_CNTLID_NONE,
.cns_specific_id = user_data_format,
.uuidx = uuidx,
};
return nvme_identify(&args);
}
/**
* nvme_nvm_identify_ctrl() - Identify controller data
* @fd: File descriptor of nvme device
* @id: User space destination address to transfer the data
*
* Return an identify controller data structure to the host of
* processing controller.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_nvm_identify_ctrl(int fd, struct nvme_id_ctrl_nvm *id)
{
return nvme_identify_ctrl_csi(fd, NVME_CSI_NVM, id);
}
/**
* nvme_identify_domain_list() - Domain list data
* @fd: File descriptor of nvme device
* @domid: Domain ID
* @list: User space destination address to transfer data
*
* A list of 31 domain IDs is returned to the host containing domain
* attributes in increasing order that are greater than the value
* specified in the @domid field.
*
* See &struct nvme_identify_domain_attr for the definition of the
* returned structure.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_domain_list(int fd, __u16 domid,
struct nvme_id_domain_list *list)
{
struct nvme_identify_args args = {
.result = NULL,
.data = list,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_DOMAIN_LIST,
.csi = NVME_CSI_NVM,
.nsid = NVME_NSID_NONE,
.cntid = NVME_CNTLID_NONE,
.cns_specific_id = domid,
.uuidx = NVME_UUID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_identify_endurance_group_list() - Endurance group list data
* @fd: File descriptor of nvme device
* @endgrp_id: Endurance group identifier
* @list: Array of endurance group identifiers
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_endurance_group_list(int fd, __u16 endgrp_id,
struct nvme_id_endurance_group_list *list)
{
struct nvme_identify_args args = {
.result = NULL,
.data = list,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_ENDURANCE_GROUP_ID,
.csi = NVME_CSI_NVM,
.nsid = NVME_NSID_NONE,
.cntid = NVME_CNTLID_NONE,
.cns_specific_id = endgrp_id,
.uuidx = NVME_UUID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_identify_iocs() - I/O command set data structure
* @fd: File descriptor of nvme device
* @cntlid: Controller ID
* @iocs: User space destination address to transfer the data
*
* Retrieves list of the controller's supported io command set vectors. See
* &struct nvme_id_iocs.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_identify_iocs(int fd, __u16 cntlid,
struct nvme_id_iocs *iocs)
{
struct nvme_identify_args args = {
.result = NULL,
.data = iocs,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_COMMAND_SET_STRUCTURE,
.csi = NVME_CSI_NVM,
.nsid = NVME_NSID_NONE,
.cntid = cntlid,
.cns_specific_id = NVME_CNSSPECID_NONE,
.uuidx = NVME_UUID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_zns_identify_ns() - ZNS identify namespace data
* @fd: File descriptor of nvme device
* @nsid: Namespace to identify
* @data: User space destination address to transfer the data
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_zns_identify_ns(int fd, __u32 nsid,
struct nvme_zns_id_ns *data)
{
struct nvme_identify_args args = {
.result = NULL,
.data = data,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.cns = NVME_IDENTIFY_CNS_CSI_NS,
.csi = NVME_CSI_ZNS,
.nsid = nsid,
.cntid = NVME_CNTLID_NONE,
.cns_specific_id = NVME_CNSSPECID_NONE,
};
return nvme_identify(&args);
}
/**
* nvme_zns_identify_ctrl() - ZNS identify controller data
* @fd: File descriptor of nvme device
* @id: User space destination address to transfer the data
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_zns_identify_ctrl(int fd, struct nvme_zns_id_ctrl *id)
{
return nvme_identify_ctrl_csi(fd, NVME_CSI_ZNS, id);
}
/**
* nvme_get_log() - NVMe Admin Get Log command
* @args: &struct nvme_get_log_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log(struct nvme_get_log_args *args);
/**
* nvme_get_log_page() - Get log page data
* @fd: File descriptor of nvme device
* @xfer_len: Max log transfer size per request to split the total.
* @args: &struct nvme_get_log_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_log_page(int fd, __u32 xfer_len, struct nvme_get_log_args *args);
static inline int nvme_get_nsid_log(int fd, bool rae,
enum nvme_cmd_get_log_lid lid,
__u32 nsid, __u32 len, void *log)
{
struct nvme_get_log_args args = {
.lpo = 0,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = lid,
.len = len,
.nsid = nsid,
.csi = NVME_CSI_NVM,
.lsi = NVME_LOG_LSI_NONE,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
.rae = rae,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
static inline int nvme_get_log_simple(int fd, enum nvme_cmd_get_log_lid lid,
__u32 len, void *log)
{
return nvme_get_nsid_log(fd, false, lid, NVME_NSID_ALL, len, log);
}
/**
* nvme_get_log_supported_log_pages() - Retrieve nmve supported log pages
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @log: Array of LID supported and Effects data structures
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_supported_log_pages(int fd, bool rae,
struct nvme_supported_log_pages *log)
{
return nvme_get_nsid_log(fd, rae, NVME_LOG_LID_SUPPORTED_LOG_PAGES,
NVME_NSID_ALL, sizeof(*log), log);
}
/**
* nvme_get_log_error() - Retrieve nvme error log
* @fd: File descriptor of nvme device
* @nr_entries: Number of error log entries allocated
* @rae: Retain asynchronous events
* @err_log: Array of error logs of size 'entries'
*
* This log page describes extended error information for a command that
* completed with error, or may report an error that is not specific to a
* particular command.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_error(int fd, unsigned int nr_entries, bool rae,
struct nvme_error_log_page *err_log)
{
return nvme_get_nsid_log(fd, rae, NVME_LOG_LID_ERROR,
NVME_NSID_ALL, sizeof(*err_log) * nr_entries,
err_log);
}
/**
* nvme_get_log_smart() - Retrieve nvme smart log
* @fd: File descriptor of nvme device
* @nsid: Optional namespace identifier
* @rae: Retain asynchronous events
* @smart_log: User address to store the smart log
*
* This log page provides SMART and general health information. The information
* provided is over the life of the controller and is retained across power
* cycles. To request the controller log page, the namespace identifier
* specified is FFFFFFFFh. The controller may also support requesting the log
* page on a per namespace basis, as indicated by bit 0 of the LPA field in the
* Identify Controller data structure.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_smart(int fd, __u32 nsid, bool rae,
struct nvme_smart_log *smart_log)
{
return nvme_get_nsid_log(fd, rae, NVME_LOG_LID_SMART,
nsid, sizeof(*smart_log), smart_log);
}
/**
* nvme_get_log_fw_slot() - Retrieves the controller firmware log
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @fw_log: User address to store the log page
*
* This log page describes the firmware revision stored in each firmware slot
* supported. The firmware revision is indicated as an ASCII string. The log
* page also indicates the active slot number.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_fw_slot(int fd, bool rae,
struct nvme_firmware_slot *fw_log)
{
return nvme_get_nsid_log(fd, rae, NVME_LOG_LID_FW_SLOT,
NVME_NSID_ALL, sizeof(*fw_log), fw_log);
}
/**
* nvme_get_log_changed_ns_list() - Retrieve namespace changed list
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @ns_log: User address to store the log page
*
* This log page describes namespaces attached to this controller that have
* changed since the last time the namespace was identified, been added, or
* deleted.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_changed_ns_list(int fd, bool rae,
struct nvme_ns_list *ns_log)
{
return nvme_get_nsid_log(fd, rae, NVME_LOG_LID_CHANGED_NS,
NVME_NSID_ALL, sizeof(*ns_log), ns_log);
}
/**
* nvme_get_log_cmd_effects() - Retrieve nvme command effects log
* @fd: File descriptor of nvme device
* @csi: Command Set Identifier
* @effects_log:User address to store the effects log
*
* This log page describes the commands that the controller supports and the
* effects of those commands on the state of the NVM subsystem.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_cmd_effects(int fd, enum nvme_csi csi,
struct nvme_cmd_effects_log *effects_log)
{
struct nvme_get_log_args args = {
.lpo = 0,
.result = NULL,
.log = effects_log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_CMD_EFFECTS,
.len = sizeof(*effects_log),
.nsid = NVME_NSID_ALL,
.csi = csi,
.lsi = NVME_LOG_LSI_NONE,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
.rae = false,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_device_self_test() - Retrieve the device self test log
* @fd: File descriptor of nvme device
* @log: Userspace address of the log payload
*
* The log page indicates the status of an in progress self test and the
* percent complete of that operation, and the results of the previous 20
* self-test operations.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_device_self_test(int fd,
struct nvme_self_test_log *log)
{
return nvme_get_nsid_log(fd, false, NVME_LOG_LID_DEVICE_SELF_TEST,
NVME_NSID_ALL, sizeof(*log), log);
}
/**
* nvme_get_log_create_telemetry_host() - Create host telemetry log
* @fd: File descriptor of nvme device
* @log: Userspace address of the log payload
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_create_telemetry_host(int fd,
struct nvme_telemetry_log *log)
{
struct nvme_get_log_args args = {
.lpo = 0,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_TELEMETRY_HOST,
.len = sizeof(*log),
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = NVME_LOG_LSI_NONE,
.lsp = NVME_LOG_TELEM_HOST_LSP_CREATE,
.uuidx = NVME_UUID_NONE,
.rae = false,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_telemetry_host() - Get Telemetry Host-Initiated log page
* @fd: File descriptor of nvme device
* @offset: Offset into the telemetry data
* @len: Length of provided user buffer to hold the log data in bytes
* @log: User address for log page data
*
* Retrieves the Telemetry Host-Initiated log page at the requested offset
* using the previously existing capture.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_telemetry_host(int fd, __u64 offset,
__u32 len, void *log)
{
struct nvme_get_log_args args = {
.lpo = offset,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_TELEMETRY_HOST,
.len = len,
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = NVME_LOG_LSI_NONE,
.lsp = NVME_LOG_TELEM_HOST_LSP_RETAIN,
.uuidx = NVME_UUID_NONE,
.rae = false,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_telemetry_ctrl() - Get Telemetry Controller-Initiated log page
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @offset: Offset into the telemetry data
* @len: Length of provided user buffer to hold the log data in bytes
* @log: User address for log page data
*
* Retrieves the Telemetry Controller-Initiated log page at the requested offset
* using the previously existing capture.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_telemetry_ctrl(int fd, bool rae,
__u64 offset, __u32 len, void *log)
{
struct nvme_get_log_args args = {
.lpo = offset,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_TELEMETRY_CTRL,
.len = len,
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = NVME_LOG_LSI_NONE,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
.rae = rae,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_endurance_group() - Get Endurance Group log
* @fd: File descriptor of nvme device
* @endgid: Starting group identifier to return in the list
* @log: User address to store the endurance log
*
* This log page indicates if an Endurance Group Event has occurred for a
* particular Endurance Group. If an Endurance Group Event has occurred, the
* details of the particular event are included in the Endurance Group
* Information log page for that Endurance Group. An asynchronous event is
* generated when an entry for an Endurance Group is newly added to this log
* page.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_endurance_group(int fd, __u16 endgid,
struct nvme_endurance_group_log *log)
{
struct nvme_get_log_args args = {
.lpo = 0,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_ENDURANCE_GROUP,
.len = sizeof(*log),
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = endgid,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
.rae = false,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_predictable_lat_nvmset() - Predictable Latency Per NVM Set
* @fd: File descriptor of nvme device
* @nvmsetid: NVM set id
* @log: User address to store the predictable latency log
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_predictable_lat_nvmset(int fd, __u16 nvmsetid,
struct nvme_nvmset_predictable_lat_log *log)
{
struct nvme_get_log_args args = {
.lpo = 0,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_PREDICTABLE_LAT_NVMSET,
.len = sizeof(*log),
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = nvmsetid,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
.rae = false,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_predictable_lat_event() - Retrieve Predictable Latency Event Aggregate Log Page
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @offset: Offset into the predictable latency event
* @len: Length of provided user buffer to hold the log data in bytes
* @log: User address for log page data
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_predictable_lat_event(int fd, bool rae,
__u32 offset, __u32 len, void *log)
{
struct nvme_get_log_args args = {
.lpo = offset,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_PREDICTABLE_LAT_AGG,
.len = len,
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = NVME_LOG_LSI_NONE,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
.rae = rae,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_fdp_configurations() - Get list of Flexible Data Placement configurations
* @fd: File descriptor of nvme device
* @egid: Endurance group identifier
* @offset: Offset into log page
* @len: Length (in bytes) of provided user buffer to hold the log data
* @log: Log page data buffer
*/
static inline int nvme_get_log_fdp_configurations(int fd, __u16 egid,
__u32 offset, __u32 len, void *log)
{
struct nvme_get_log_args args = {
.lpo = offset,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_FDP_CONFIGS,
.len = len,
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = egid,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
};
return nvme_get_log(&args);
}
/**
* nvme_get_log_reclaim_unit_handle_usage() - Get reclaim unit handle usage
* @fd: File descriptor of nvme device
* @egid: Endurance group identifier
* @offset: Offset into log page
* @len: Length (in bytes) of provided user buffer to hold the log data
* @log: Log page data buffer
*/
static inline int nvme_get_log_reclaim_unit_handle_usage(int fd, __u16 egid,
__u32 offset, __u32 len, void *log)
{
struct nvme_get_log_args args = {
.lpo = offset,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_FDP_RUH_USAGE,
.len = len,
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = egid,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
};
return nvme_get_log(&args);
}
/**
* nvme_get_log_fdp_stats() - Get Flexible Data Placement statistics
* @fd: File descriptor of nvme device
* @egid: Endurance group identifier
* @offset: Offset into log page
* @len: Length (in bytes) of provided user buffer to hold the log data
* @log: Log page data buffer
*/
static inline int nvme_get_log_fdp_stats(int fd, __u16 egid, __u32 offset, __u32 len, void *log)
{
struct nvme_get_log_args args = {
.lpo = offset,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_FDP_STATS,
.len = len,
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = egid,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
};
return nvme_get_log(&args);
}
/**
* nvme_get_log_fdp_events() - Get Flexible Data Placement events
* @fd: File descriptor of nvme device
* @egid: Endurance group identifier
* @host_events: Whether to report host or controller events
* @offset: Offset into log page
* @len: Length (in bytes) of provided user buffer to hold the log data
* @log: Log page data buffer
*/
static inline int nvme_get_log_fdp_events(int fd, __u16 egid, bool host_events, __u32 offset,
__u32 len, void *log)
{
struct nvme_get_log_args args = {
.lpo = offset,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_FDP_EVENTS,
.len = len,
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = egid,
.lsp = (__u8)(host_events ? 0x1 : 0x0),
.uuidx = NVME_UUID_NONE,
};
return nvme_get_log(&args);
}
/**
* nvme_get_log_ana() - Retrieve Asymmetric Namespace Access log page
* @fd: File descriptor of nvme device
* @lsp: Log specific, see &enum nvme_get_log_ana_lsp
* @rae: Retain asynchronous events
* @offset: Offset to the start of the log page
* @len: The allocated length of the log page
* @log: User address to store the ana log
*
* This log consists of a header describing the log and descriptors containing
* the asymmetric namespace access information for ANA Groups that contain
* namespaces that are attached to the controller processing the command.
*
* See &struct nvme_ana_rsp_hdr for the definition of the returned structure.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_ana(int fd, enum nvme_log_ana_lsp lsp, bool rae,
__u64 offset, __u32 len, void *log)
{
struct nvme_get_log_args args = {
.lpo = offset,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_ANA,
.len = len,
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = NVME_LOG_LSI_NONE,
.lsp = (__u8)lsp,
.uuidx = NVME_UUID_NONE,
.rae = false,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_ana_groups() - Retrieve Asymmetric Namespace Access groups only log page
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @len: The allocated length of the log page
* @log: User address to store the ana group log
*
* See &struct nvme_ana_group_desc for the definition of the returned structure.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_ana_groups(int fd, bool rae, __u32 len,
struct nvme_ana_group_desc *log)
{
return nvme_get_log_ana(fd, NVME_LOG_ANA_LSP_RGO_GROUPS_ONLY, rae, 0,
len, log);
}
/**
* nvme_get_log_lba_status() - Retrieve LBA Status
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @offset: Offset to the start of the log page
* @len: The allocated length of the log page
* @log: User address to store the log page
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_lba_status(int fd, bool rae,
__u64 offset, __u32 len, void *log)
{
struct nvme_get_log_args args = {
.lpo = offset,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_LBA_STATUS,
.len = len,
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = NVME_LOG_LSI_NONE,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
.rae = rae,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_endurance_grp_evt() - Retrieve Rotational Media Information
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @offset: Offset to the start of the log page
* @len: The allocated length of the log page
* @log: User address to store the log page
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_endurance_grp_evt(int fd, bool rae,
__u32 offset, __u32 len, void *log)
{
struct nvme_get_log_args args = {
.lpo = offset,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_ENDURANCE_GRP_EVT,
.len = len,
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = NVME_LOG_LSI_NONE,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
.rae = rae,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_fid_supported_effects() - Retrieve Feature Identifiers Supported and Effects
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @log: FID Supported and Effects data structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise
*/
static inline int nvme_get_log_fid_supported_effects(int fd, bool rae,
struct nvme_fid_supported_effects_log *log)
{
return nvme_get_nsid_log(fd, rae, NVME_LOG_LID_FID_SUPPORTED_EFFECTS,
NVME_NSID_NONE, sizeof(*log), log);
}
/**
* nvme_get_log_mi_cmd_supported_effects() - displays the MI Commands Supported by the controller
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @log: MI Command Supported and Effects data structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise
*/
static inline int nvme_get_log_mi_cmd_supported_effects(int fd, bool rae,
struct nvme_mi_cmd_supported_effects_log *log)
{
return nvme_get_nsid_log(fd, rae, NVME_LOG_LID_MI_CMD_SUPPORTED_EFFECTS,
NVME_NSID_NONE, sizeof(*log), log);
}
/**
* nvme_get_log_boot_partition() - Retrieve Boot Partition
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @lsp: The log specified field of LID
* @len: The allocated size, minimum
* struct nvme_boot_partition
* @part: User address to store the log page
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise
*/
static inline int nvme_get_log_boot_partition(int fd, bool rae,
__u8 lsp, __u32 len, struct nvme_boot_partition *part)
{
struct nvme_get_log_args args = {
.lpo = 0,
.result = NULL,
.log = part,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_BOOT_PARTITION,
.len = len,
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = NVME_LOG_LSI_NONE,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
.rae = rae,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_discovery() - Retrieve Discovery log page
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @offset: Offset of this log to retrieve
* @len: The allocated size for this portion of the log
* @log: User address to store the discovery log
*
* Supported only by fabrics discovery controllers, returning discovery
* records.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_discovery(int fd, bool rae,
__u32 offset, __u32 len, void *log)
{
struct nvme_get_log_args args = {
.lpo = offset,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_DISCOVER,
.len = len,
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = NVME_LOG_LSI_NONE,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
.rae = rae,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_media_unit_stat() - Retrieve Media Unit Status
* @fd: File descriptor of nvme device
* @domid: Domain Identifier selection, if supported
* @mus: User address to store the Media Unit statistics log
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise
*/
static inline int nvme_get_log_media_unit_stat(int fd, __u16 domid,
struct nvme_media_unit_stat_log *mus)
{
struct nvme_get_log_args args = {
.lpo = 0,
.result = NULL,
.log = mus,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_MEDIA_UNIT_STATUS,
.len = sizeof(*mus),
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = domid,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
.rae = false,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_support_cap_config_list() - Retrieve Supported Capacity Configuration List
* @fd: File descriptor of nvme device
* @domid: Domain Identifier selection, if supported
* @cap: User address to store supported capabilities config list
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise
*/
static inline int nvme_get_log_support_cap_config_list(int fd, __u16 domid,
struct nvme_supported_cap_config_list_log *cap)
{
struct nvme_get_log_args args = {
.lpo = 0,
.result = NULL,
.log = cap,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_SUPPORTED_CAP_CONFIG_LIST,
.len = sizeof(*cap),
.nsid = NVME_NSID_NONE,
.csi = NVME_CSI_NVM,
.lsi = domid,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
.rae = false,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_reservation() - Retrieve Reservation Notification
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @log: User address to store the reservation log
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise
*/
static inline int nvme_get_log_reservation(int fd, bool rae,
struct nvme_resv_notification_log *log)
{
return nvme_get_nsid_log(fd, rae, NVME_LOG_LID_RESERVATION,
NVME_NSID_ALL, sizeof(*log), log);
}
/**
* nvme_get_log_sanitize() - Retrieve Sanitize Status
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @log: User address to store the sanitize log
*
* The Sanitize Status log page reports sanitize operation time estimates and
* information about the most recent sanitize operation.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_sanitize(int fd, bool rae,
struct nvme_sanitize_log_page *log)
{
return nvme_get_nsid_log(fd, rae, NVME_LOG_LID_SANITIZE,
NVME_NSID_ALL, sizeof(*log), log);
}
/**
* nvme_get_log_zns_changed_zones() - Retrieve list of zones that have changed
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
* @rae: Retain asynchronous events
* @log: User address to store the changed zone log
*
* The list of zones that have changed state due to an exceptional event.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_zns_changed_zones(int fd, __u32 nsid, bool rae,
struct nvme_zns_changed_zone_log *log)
{
struct nvme_get_log_args args = {
.lpo = 0,
.result = NULL,
.log = log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_ZNS_CHANGED_ZONES,
.len = sizeof(*log),
.nsid = nsid,
.csi = NVME_CSI_ZNS,
.lsi = NVME_LOG_LSI_NONE,
.lsp = NVME_LOG_LSP_NONE,
.uuidx = NVME_UUID_NONE,
.rae = rae,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_get_log_persistent_event() - Retrieve Persistent Event Log
* @fd: File descriptor of nvme device
* @action: Action the controller should take during processing this command
* @size: Size of @pevent_log
* @pevent_log: User address to store the persistent event log
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_log_persistent_event(int fd,
enum nvme_pevent_log_action action,
__u32 size, void *pevent_log)
{
struct nvme_get_log_args args = {
.lpo = 0,
.result = NULL,
.log = pevent_log,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.lid = NVME_LOG_LID_PERSISTENT_EVENT,
.len = size,
.nsid = NVME_NSID_ALL,
.csi = NVME_CSI_NVM,
.lsi = NVME_LOG_LSI_NONE,
.lsp = (__u8)action,
.uuidx = NVME_UUID_NONE,
.rae = false,
.ot = false,
};
return nvme_get_log_page(fd, NVME_LOG_PAGE_PDU_SIZE, &args);
}
/**
* nvme_set_features() - Set a feature attribute
* @args: &struct nvme_set_features_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features(struct nvme_set_features_args *args);
/**
* nvme_set_features_data() - Helper function for @nvme_set_features()
* @fd: File descriptor of nvme device
* @fid: Feature identifier
* @nsid: Namespace ID, if applicable
* @cdw11: Value to set the feature to
* @save: Save value across power states
* @data_len: Length of feature data, if applicable, in bytes
* @data: User address of feature data, if applicable
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_set_features_data(int fd, __u8 fid, __u32 nsid,
__u32 cdw11, bool save, __u32 data_len, void *data,
__u32 *result)
{
struct nvme_set_features_args args = {
.result = result,
.data = data,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.nsid = nsid,
.cdw11 = cdw11,
.cdw12 = 0,
.cdw13 = 0,
.cdw15 = 0,
.data_len = data_len,
.save = save,
.uuidx = 0,
.fid = fid,
};
return nvme_set_features(&args);
}
/**
* nvme_set_features_simple() - Helper function for @nvme_set_features()
* @fd: File descriptor of nvme device
* @fid: Feature identifier
* @nsid: Namespace ID, if applicable
* @cdw11: Value to set the feature to
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_set_features_simple(int fd, __u8 fid, __u32 nsid,
__u32 cdw11, bool save, __u32 *result)
{
return nvme_set_features_data(fd, fid, nsid, cdw11, save, 0, NULL,
result);
}
/**
* nvme_set_features_arbitration() - Set arbitration features
* @fd: File descriptor of nvme device
* @ab: Arbitration Burst
* @lpw: Low Priority Weight
* @mpw: Medium Priority Weight
* @hpw: High Priority Weight
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_arbitration(int fd, __u8 ab, __u8 lpw, __u8 mpw,
__u8 hpw, bool save, __u32 *result);
/**
* nvme_set_features_power_mgmt() - Set power management feature
* @fd: File descriptor of nvme device
* @ps: Power State
* @wh: Workload Hint
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_power_mgmt(int fd, __u8 ps, __u8 wh, bool save,
__u32 *result);
/**
* nvme_set_features_lba_range() - Set LBA range feature
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
* @nr_ranges: Number of ranges in @data
* @save: Save value across power states
* @data: User address of feature data
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_lba_range(int fd, __u32 nsid, __u32 nr_ranges, bool save,
struct nvme_lba_range_type *data, __u32 *result);
/**
* nvme_set_features_temp_thresh() - Set temperature threshold feature
* @fd: File descriptor of nvme device
* @tmpth: Temperature Threshold
* @tmpsel: Threshold Temperature Select
* @thsel: Threshold Type Select
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_temp_thresh(int fd, __u16 tmpth, __u8 tmpsel,
enum nvme_feat_tmpthresh_thsel thsel,
bool save, __u32 *result);
/**
* nvme_set_features_err_recovery() - Set error recovery feature
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
* @tler: Time-limited error recovery value
* @dulbe: Deallocated or Unwritten Logical Block Error Enable
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_err_recovery(int fd, __u32 nsid, __u16 tler,
bool dulbe, bool save, __u32 *result);
/**
* nvme_set_features_volatile_wc() - Set volatile write cache feature
* @fd: File descriptor of nvme device
* @wce: Write cache enable
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_volatile_wc(int fd, bool wce, bool save,
__u32 *result);
/**
* nvme_set_features_irq_coalesce() - Set IRQ coalesce feature
* @fd: File descriptor of nvme device
* @thr: Aggregation Threshold
* @time: Aggregation Time
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_irq_coalesce(int fd, __u8 thr, __u8 time,
bool save, __u32 *result);
/**
* nvme_set_features_irq_config() - Set IRQ config feature
* @fd: File descriptor of nvme device
* @iv: Interrupt Vector
* @cd: Coalescing Disable
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_irq_config(int fd, __u16 iv, bool cd, bool save,
__u32 *result);
/**
* nvme_set_features_write_atomic() - Set write atomic feature
* @fd: File descriptor of nvme device
* @dn: Disable Normal
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_write_atomic(int fd, bool dn, bool save,
__u32 *result);
/**
* nvme_set_features_async_event() - Set asynchronous event feature
* @fd: File descriptor of nvme device
* @events: Events to enable
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_async_event(int fd, __u32 events, bool save,
__u32 *result);
/**
* nvme_set_features_auto_pst() - Set autonomous power state feature
* @fd: File descriptor of nvme device
* @apste: Autonomous Power State Transition Enable
* @apst: Autonomous Power State Transition
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_auto_pst(int fd, bool apste, bool save,
struct nvme_feat_auto_pst *apst,
__u32 *result);
/**
* nvme_set_features_timestamp() - Set timestamp feature
* @fd: File descriptor of nvme device
* @save: Save value across power states
* @timestamp: The current timestamp value to assign to this feature
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_timestamp(int fd, bool save, __u64 timestamp);
/**
* nvme_set_features_hctm() - Set thermal management feature
* @fd: File descriptor of nvme device
* @tmt2: Thermal Management Temperature 2
* @tmt1: Thermal Management Temperature 1
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_hctm(int fd, __u16 tmt2, __u16 tmt1, bool save,
__u32 *result);
/**
* nvme_set_features_nopsc() - Set non-operational power state feature
* @fd: File descriptor of nvme device
* @noppme: Non-Operational Power State Permissive Mode Enable
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_nopsc(int fd, bool noppme, bool save, __u32 *result);
/**
* nvme_set_features_rrl() - Set read recovery level feature
* @fd: File descriptor of nvme device
* @rrl: Read recovery level setting
* @nvmsetid: NVM set id
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_rrl(int fd, __u8 rrl, __u16 nvmsetid, bool save,
__u32 *result);
/**
* nvme_set_features_plm_config() - Set predictable latency feature
* @fd: File descriptor of nvme device
* @enable: Predictable Latency Enable
* @nvmsetid: NVM Set Identifier
* @save: Save value across power states
* @data: Pointer to structure nvme_plm_config
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_plm_config(int fd, bool enable, __u16 nvmsetid,
bool save, struct nvme_plm_config *data,
__u32 *result);
/**
* nvme_set_features_plm_window() - Set window select feature
* @fd: File descriptor of nvme device
* @sel: Window Select
* @nvmsetid: NVM Set Identifier
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_plm_window(int fd, enum nvme_feat_plm_window_select sel,
__u16 nvmsetid, bool save, __u32 *result);
/**
* nvme_set_features_lba_sts_interval() - Set LBA status information feature
* @fd: File descriptor of nvme device
* @save: Save value across power states
* @lsiri: LBA Status Information Report Interval
* @lsipi: LBA Status Information Poll Interval
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_lba_sts_interval(int fd, __u16 lsiri, __u16 lsipi,
bool save, __u32 *result);
/**
* nvme_set_features_host_behavior() - Set host behavior feature
* @fd: File descriptor of nvme device
* @save: Save value across power states
* @data: Pointer to structure nvme_feat_host_behavior
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_host_behavior(int fd, bool save,
struct nvme_feat_host_behavior *data);
/**
* nvme_set_features_sanitize() - Set sanitize feature
* @fd: File descriptor of nvme device
* @nodrm: No-Deallocate Response Mode
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_sanitize(int fd, bool nodrm, bool save, __u32 *result);
/**
* nvme_set_features_endurance_evt_cfg() - Set endurance event config feature
* @fd: File descriptor of nvme device
* @endgid: Endurance Group Identifier
* @egwarn: Flags to enable warning, see &enum nvme_eg_critical_warning_flags
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_endurance_evt_cfg(int fd, __u16 endgid, __u8 egwarn,
bool save, __u32 *result);
/**
* nvme_set_features_sw_progress() - Set pre-boot software load count feature
* @fd: File descriptor of nvme device
* @pbslc: Pre-boot Software Load Count
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_sw_progress(int fd, __u8 pbslc, bool save,
__u32 *result);
/**
* nvme_set_features_host_id() - Set enable extended host identifiers feature
* @fd: File descriptor of nvme device
* @exhid: Enable Extended Host Identifier
* @save: Save value across power states
* @hostid: Host ID to set
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_host_id(int fd, bool exhid, bool save, __u8 *hostid);
/**
* nvme_set_features_resv_mask() - Set reservation notification mask feature
* @fd: File descriptor of nvme device
* @mask: Reservation Notification Mask Field
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_resv_mask(int fd, __u32 mask, bool save, __u32 *result);
/**
* nvme_set_features_resv_persist() - Set persist through power loss feature
* @fd: File descriptor of nvme device
* @ptpl: Persist Through Power Loss
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_resv_persist(int fd, bool ptpl, bool save, __u32 *result);
/**
* nvme_set_features_write_protect() - Set write protect feature
* @fd: File descriptor of nvme device
* @state: Write Protection State
* @save: Save value across power states
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_features_write_protect(int fd, enum nvme_feat_nswpcfg_state state,
bool save, __u32 *result);
/**
* nvme_get_features() - Retrieve a feature attribute
* @args: &struct nvme_get_features_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features(struct nvme_get_features_args *args);
/**
* nvme_get_features_data() - Helper function for @nvme_get_features()
* @fd: File descriptor of nvme device
* @fid: Feature identifier
* @nsid: Namespace ID, if applicable
* @data_len: Length of feature data, if applicable, in bytes
* @data: User address of feature data, if applicable
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_features_data(int fd, enum nvme_features_id fid,
__u32 nsid, __u32 data_len, void *data, __u32 *result)
{
struct nvme_get_features_args args = {
.result = result,
.data = data,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.nsid = nsid,
.sel = NVME_GET_FEATURES_SEL_CURRENT,
.cdw11 = 0,
.data_len = data_len,
.fid = (__u8)fid,
.uuidx = NVME_UUID_NONE,
};
return nvme_get_features(&args);
}
/**
* nvme_get_features_simple() - Helper function for @nvme_get_features()
* @fd: File descriptor of nvme device
* @fid: Feature identifier
* @nsid: Namespace ID, if applicable
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_get_features_simple(int fd, enum nvme_features_id fid,
__u32 nsid, __u32 *result)
{
return nvme_get_features_data(fd, fid, nsid, 0, NULL, result);
}
/**
* nvme_get_features_arbitration() - Get arbitration feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_arbitration(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_power_mgmt() - Get power management feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_power_mgmt(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_lba_range() - Get LBA range feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @data: User address of feature data, if applicable
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_lba_range(int fd, enum nvme_get_features_sel sel,
struct nvme_lba_range_type *data,
__u32 *result);
/**
* nvme_get_features_temp_thresh() - Get temperature threshold feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_temp_thresh(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_err_recovery() - Get error recovery feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_err_recovery(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_volatile_wc() - Get volatile write cache feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_volatile_wc(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_num_queues() - Get number of queues feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_num_queues(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_irq_coalesce() - Get IRQ coalesce feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_irq_coalesce(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_irq_config() - Get IRQ config feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @iv:
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_irq_config(int fd, enum nvme_get_features_sel sel,
__u16 iv, __u32 *result);
/**
* nvme_get_features_write_atomic() - Get write atomic feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_write_atomic(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_async_event() - Get asynchronous event feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_async_event(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_auto_pst() - Get autonomous power state feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @apst:
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_auto_pst(int fd, enum nvme_get_features_sel sel,
struct nvme_feat_auto_pst *apst, __u32 *result);
/**
* nvme_get_features_host_mem_buf() - Get host memory buffer feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_host_mem_buf(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_timestamp() - Get timestamp feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @ts: Current timestamp
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_timestamp(int fd, enum nvme_get_features_sel sel,
struct nvme_timestamp *ts);
/**
* nvme_get_features_kato() - Get keep alive timeout feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_kato(int fd, enum nvme_get_features_sel sel, __u32 *result);
/**
* nvme_get_features_hctm() - Get thermal management feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_hctm(int fd, enum nvme_get_features_sel sel, __u32 *result);
/**
* nvme_get_features_nopsc() - Get non-operational power state feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_nopsc(int fd, enum nvme_get_features_sel sel, __u32 *result);
/**
* nvme_get_features_rrl() - Get read recovery level feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_rrl(int fd, enum nvme_get_features_sel sel, __u32 *result);
/**
* nvme_get_features_plm_config() - Get predictable latency feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @nvmsetid: NVM set id
* @data:
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_plm_config(int fd, enum nvme_get_features_sel sel,
__u16 nvmsetid, struct nvme_plm_config *data,
__u32 *result);
/**
* nvme_get_features_plm_window() - Get window select feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @nvmsetid: NVM set id
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_plm_window(int fd, enum nvme_get_features_sel sel,
__u16 nvmsetid, __u32 *result);
/**
* nvme_get_features_lba_sts_interval() - Get LBA status information feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_lba_sts_interval(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_host_behavior() - Get host behavior feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @data: Pointer to structure nvme_feat_host_behavior
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_host_behavior(int fd, enum nvme_get_features_sel sel,
struct nvme_feat_host_behavior *data,
__u32 *result);
/**
* nvme_get_features_sanitize() - Get sanitize feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_sanitize(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_endurance_event_cfg() - Get endurance event config feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @endgid: Endurance Group Identifier
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_endurance_event_cfg(int fd, enum nvme_get_features_sel sel,
__u16 endgid, __u32 *result);
/**
* nvme_get_features_sw_progress() - Get software progress feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_sw_progress(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_host_id() - Get host id feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @exhid: Enable Extended Host Identifier
* @len: Length of @hostid
* @hostid: Buffer for returned host ID
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_host_id(int fd, enum nvme_get_features_sel sel,
bool exhid, __u32 len, __u8 *hostid);
/**
* nvme_get_features_resv_mask() - Get reservation mask feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_resv_mask(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_resv_persist() - Get reservation persist feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_resv_persist(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_write_protect() - Get write protect feature
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_write_protect(int fd, __u32 nsid,
enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_get_features_iocs_profile() - Get IOCS profile feature
* @fd: File descriptor of nvme device
* @sel: Select which type of attribute to return, see &enum nvme_get_features_sel
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_features_iocs_profile(int fd, enum nvme_get_features_sel sel,
__u32 *result);
/**
* nvme_format_nvm() - Format nvme namespace(s)
* @args: &struct nvme_format_nvme_args argument structure
*
* The Format NVM command low level formats the NVM media. This command is used
* by the host to change the LBA data size and/or metadata size. A low level
* format may destroy all data and metadata associated with all namespaces or
* only the specific namespace associated with the command
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_format_nvm(struct nvme_format_nvm_args *args);
/**
* nvme_ns_mgmt() - Issue a Namespace management command
* @args: &struct nvme_ns_mgmt_args Argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_ns_mgmt(struct nvme_ns_mgmt_args *args);
/**
* nvme_ns_mgmt_create() - Create a non attached namespace
* @fd: File descriptor of nvme device
* @ns: Namespace identification that defines ns creation parameters
* @nsid: On success, set to the namespace id that was created
* @timeout: Override the default timeout to this value in milliseconds;
* set to 0 to use the system default.
* @csi: Command Set Identifier
*
* On successful creation, the namespace exists in the subsystem, but is not
* attached to any controller. Use the nvme_ns_attach_ctrls() to assign the
* namespace to one or more controllers.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_ns_mgmt_create(int fd, struct nvme_id_ns *ns,
__u32 *nsid, __u32 timeout, __u8 csi)
{
struct nvme_ns_mgmt_args args = {
.result = nsid,
.ns = ns,
.args_size = sizeof(args),
.fd = fd,
.timeout = timeout,
.nsid = NVME_NSID_NONE,
.sel = NVME_NS_MGMT_SEL_CREATE,
.csi = csi,
};
return nvme_ns_mgmt(&args);
}
/**
* nvme_ns_mgmt_delete() - Delete a non attached namespace
* @fd: File descriptor of nvme device
* @nsid: Namespace identifier to delete
*
* It is recommended that a namespace being deleted is not attached to any
* controller. Use the nvme_ns_detach_ctrls() first if the namespace is still
* attached.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_ns_mgmt_delete(int fd, __u32 nsid)
{
struct nvme_ns_mgmt_args args = {
.result = NULL,
.ns = NULL,
.args_size = sizeof(args),
.fd = fd,
.timeout = 0,
.nsid = nsid,
.sel = NVME_NS_MGMT_SEL_DELETE,
.csi = 0,
};
return nvme_ns_mgmt(&args);
}
/**
* nvme_ns_attach() - Attach or detach namespace to controller(s)
* @args: &struct nvme_ns_attach_args Argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_ns_attach(struct nvme_ns_attach_args *args);
/**
* nvme_ns_attach_ctrls() - Attach namespace to controllers
* @fd: File descriptor of nvme device
* @nsid: Namespace ID to attach
* @ctrlist: Controller list to modify attachment state of nsid
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_ns_attach_ctrls(int fd, __u32 nsid,
struct nvme_ctrl_list *ctrlist)
{
struct nvme_ns_attach_args args = {
.result = NULL,
.ctrlist = ctrlist,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.nsid = nsid,
.sel = NVME_NS_ATTACH_SEL_CTRL_ATTACH,
};
return nvme_ns_attach(&args);
}
/**
* nvme_ns_detach_ctrls() - Detach namespace from controllers
* @fd: File descriptor of nvme device
* @nsid: Namespace ID to detach
* @ctrlist: Controller list to modify attachment state of nsid
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_ns_detach_ctrls(int fd, __u32 nsid,
struct nvme_ctrl_list *ctrlist)
{
struct nvme_ns_attach_args args = {
.result = NULL,
.ctrlist = ctrlist,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.nsid = nsid,
.sel = NVME_NS_ATTACH_SEL_CTRL_DEATTACH,
};
return nvme_ns_attach(&args);
}
/**
* nvme_fw_download() - Download part or all of a firmware image to the
* controller
* @args: &struct nvme_fw_download_args argument structure
*
* The Firmware Image Download command downloads all or a portion of an image
* for a future update to the controller. The Firmware Image Download command
* downloads a new image (in whole or in part) to the controller.
*
* The image may be constructed of multiple pieces that are individually
* downloaded with separate Firmware Image Download commands. Each Firmware
* Image Download command includes a Dword Offset and Number of Dwords that
* specify a dword range.
*
* The new firmware image is not activated as part of the Firmware Image
* Download command. Use the nvme_fw_commit() to activate a newly downloaded
* image.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_fw_download(struct nvme_fw_download_args *args);
/**
* nvme_fw_commit() - Commit firmware using the specified action
* @args: &struct nvme_fw_commit_args argument structure
*
* The Firmware Commit command modifies the firmware image or Boot Partitions.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise. The command
* status response may specify additional reset actions required to complete
* the commit process.
*/
int nvme_fw_commit(struct nvme_fw_commit_args *args);
/**
* nvme_security_send() - Security Send command
* @args: &struct nvme_security_send argument structure
*
* The Security Send command transfers security protocol data to the
* controller. The data structure transferred to the controller as part of this
* command contains security protocol specific commands to be performed by the
* controller. The data structure transferred may also contain data or
* parameters associated with the security protocol commands.
*
* The security data is protocol specific and is not defined by the NVMe
* specification.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_security_send(struct nvme_security_send_args *args);
/**
* nvme_security_receive() - Security Receive command
* @args: &struct nvme_security_receive argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_security_receive(struct nvme_security_receive_args *args);
/**
* nvme_get_lba_status() - Retrieve information on possibly unrecoverable LBAs
* @args: &struct nvme_get_lba_status_args argument structure
*
* The Get LBA Status command requests information about Potentially
* Unrecoverable LBAs. Refer to the specification for action type descriptions.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_lba_status(struct nvme_get_lba_status_args *args);
/**
* nvme_directive_send() - Send directive command
* @args: &struct nvme_directive_send_args argument structure
*
* Directives is a mechanism to enable host and NVM subsystem or controller
* information exchange. The Directive Send command transfers data related to a
* specific Directive Type from the host to the controller.
*
* See the NVMe specification for more information.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_directive_send(struct nvme_directive_send_args *args);
/**
* nvme_directive_send_id_endir() - Directive Send Enable Directive
* @fd: File descriptor of nvme device
* @nsid: Namespace Identifier
* @endir: Enable Directive
* @dtype: Directive Type
* @id: Pointer to structure nvme_id_directives
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_directive_send_id_endir(int fd, __u32 nsid, bool endir,
enum nvme_directive_dtype dtype,
struct nvme_id_directives *id);
/**
* nvme_directive_send_stream_release_identifier() - Directive Send Stream release
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
* @stream_id: Stream identifier
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_directive_send_stream_release_identifier(int fd,
__u32 nsid, __u16 stream_id)
{
struct nvme_directive_send_args args = {
.result = NULL,
.data = NULL,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.nsid = nsid,
.doper = NVME_DIRECTIVE_SEND_STREAMS_DOPER_RELEASE_IDENTIFIER,
.dtype = NVME_DIRECTIVE_DTYPE_STREAMS,
.cdw12 = 0,
.data_len = 0,
.dspec = stream_id,
};
return nvme_directive_send(&args);
}
/**
* nvme_directive_send_stream_release_resource() - Directive Send Stream release resources
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_directive_send_stream_release_resource(int fd, __u32 nsid)
{
struct nvme_directive_send_args args = {
.result = NULL,
.data = NULL,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.nsid = nsid,
.doper = NVME_DIRECTIVE_SEND_STREAMS_DOPER_RELEASE_RESOURCE,
.dtype = NVME_DIRECTIVE_DTYPE_STREAMS,
.cdw12 = 0,
.data_len = 0,
.dspec = 0,
};
return nvme_directive_send(&args);
}
/**
* nvme_directive_recv() - Receive directive specific data
* @args: &struct nvme_directive_recv_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_directive_recv(struct nvme_directive_recv_args *args);
/**
* nvme_directive_recv_identify_parameters() - Directive receive identifier parameters
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
* @id: Identify parameters buffer
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_directive_recv_identify_parameters(int fd, __u32 nsid,
struct nvme_id_directives *id)
{
struct nvme_directive_recv_args args = {
.result = NULL,
.data = id,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.nsid = nsid,
.doper = NVME_DIRECTIVE_RECEIVE_IDENTIFY_DOPER_PARAM,
.dtype = NVME_DIRECTIVE_DTYPE_IDENTIFY,
.cdw12 = 0,
.data_len = sizeof(*id),
.dspec = 0,
};
return nvme_directive_recv(&args);
}
/**
* nvme_directive_recv_stream_parameters() - Directive receive stream parameters
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
* @parms: Streams directive parameters buffer
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_directive_recv_stream_parameters(int fd, __u32 nsid,
struct nvme_streams_directive_params *parms)
{
struct nvme_directive_recv_args args = {
.result = NULL,
.data = parms,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.nsid = nsid,
.doper = NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_PARAM,
.dtype = NVME_DIRECTIVE_DTYPE_STREAMS,
.cdw12 = 0,
.data_len = sizeof(*parms),
.dspec = 0,
};
return nvme_directive_recv(&args);
}
/**
* nvme_directive_recv_stream_status() - Directive receive stream status
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
* @nr_entries: Number of streams to receive
* @id: Stream status buffer
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_directive_recv_stream_status(int fd, __u32 nsid,
unsigned int nr_entries,
struct nvme_streams_directive_status *id)
{
struct nvme_directive_recv_args args = {
.result = NULL,
.data = id,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.nsid = nsid,
.doper = NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_STATUS,
.dtype = NVME_DIRECTIVE_DTYPE_STREAMS,
.cdw12 = 0,
.data_len = sizeof(*id),
.dspec = 0,
};
return nvme_directive_recv(&args);
}
/**
* nvme_directive_recv_stream_allocate() - Directive receive stream allocate
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
* @nsr: Namespace Streams Requested
* @result: If successful, the CQE dword0 value
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_directive_recv_stream_allocate(int fd, __u32 nsid,
__u16 nsr, __u32 *result)
{
struct nvme_directive_recv_args args = {
.result = result,
.data = NULL,
.args_size = sizeof(args),
.fd = fd,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.nsid = nsid,
.doper = NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_RESOURCE,
.dtype = NVME_DIRECTIVE_DTYPE_STREAMS,
.cdw12 = nsr,
.data_len = 0,
.dspec = 0,
};
return nvme_directive_recv(&args);
}
/**
* nvme_capacity_mgmt() - Capacity management command
* @args: &struct nvme_capacity_mgmt_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_capacity_mgmt(struct nvme_capacity_mgmt_args *args);
/**
* nvme_lockdown() - Issue lockdown command
* @args: &struct nvme_lockdown_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_lockdown(struct nvme_lockdown_args *args);
/**
* nvme_set_property() - Set controller property
* @args: &struct nvme_set_property_args argument structure
*
* This is an NVMe-over-Fabrics specific command, not applicable to PCIe. These
* properties align to the PCI MMIO controller registers.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_set_property(struct nvme_set_property_args *args);
/**
* nvme_get_property() - Get a controller property
* @args: &struct nvme_get_propert_args argument structure
*
* This is an NVMe-over-Fabrics specific command, not applicable to PCIe. These
* properties align to the PCI MMIO controller registers.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_property(struct nvme_get_property_args *args);
/**
* nvme_sanitize_nvm() - Start a sanitize operation
* @args: &struct nvme_sanitize_nvm_args argument structure
*
* A sanitize operation alters all user data in the NVM subsystem such that
* recovery of any previous user data from any cache, the non-volatile media,
* or any Controller Memory Buffer is not possible.
*
* The Sanitize command starts a sanitize operation or to recover from a
* previously failed sanitize operation. The sanitize operation types that may
* be supported are Block Erase, Crypto Erase, and Overwrite. All sanitize
* operations are processed in the background, i.e., completion of the sanitize
* command does not indicate completion of the sanitize operation.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_sanitize_nvm(struct nvme_sanitize_nvm_args *args);
/**
* nvme_dev_self_test() - Start or abort a self test
* @args: &struct nvme_dev_self_test argument structure
*
* The Device Self-test command starts a device self-test operation or abort a
* device self-test operation. A device self-test operation is a diagnostic
* testing sequence that tests the integrity and functionality of the
* controller and may include testing of the media associated with namespaces.
* The controller may return a response to this command immediately while
* running the self-test in the background.
*
* Set the 'nsid' field to 0 to not include namespaces in the test. Set to
* 0xffffffff to test all namespaces. All other values tests a specific
* namespace, if present.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_dev_self_test(struct nvme_dev_self_test_args *args);
/**
* nvme_virtual_mgmt() - Virtualization resource management
* @args: &struct nvme_virtual_mgmt_args argument structure
*
* The Virtualization Management command is supported by primary controllers
* that support the Virtualization Enhancements capability. This command is
* used for several functions:
*
* - Modifying Flexible Resource allocation for the primary controller
* - Assigning Flexible Resources for secondary controllers
* - Setting the Online and Offline state for secondary controllers
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_virtual_mgmt(struct nvme_virtual_mgmt_args *args);
/**
* nvme_flush() - Send an nvme flush command
* @fd: File descriptor of nvme device
* @nsid: Namespace identifier
*
* The Flush command requests that the contents of volatile write cache be made
* non-volatile.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_flush(int fd, __u32 nsid)
{
struct nvme_passthru_cmd cmd = {};
cmd.opcode = nvme_cmd_flush;
cmd.nsid = nsid;
return nvme_submit_io_passthru(fd, &cmd, NULL);
}
/**
* nvme_io() - Submit an nvme user I/O command
* @args: &struct nvme_io_args argument structure
* @opcode: Opcode to execute
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_io(struct nvme_io_args *args, __u8 opcode);
/**
* nvme_read() - Submit an nvme user read command
* @args: &struct nvme_io_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_read(struct nvme_io_args *args)
{
return nvme_io(args, nvme_cmd_read);
}
/**
* nvme_write() - Submit an nvme user write command
* @args: &struct nvme_io_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_write(struct nvme_io_args *args)
{
return nvme_io(args, nvme_cmd_write);
}
/**
* nvme_compare() - Submit an nvme user compare command
* @args: &struct nvme_io_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_compare(struct nvme_io_args *args)
{
return nvme_io(args, nvme_cmd_compare);
}
/**
* nvme_write_zeros() - Submit an nvme write zeroes command
* @args: &struct nvme_io_args argument structure
*
* The Write Zeroes command sets a range of logical blocks to zero. After
* successful completion of this command, the value returned by subsequent
* reads of logical blocks in this range shall be all bytes cleared to 0h until
* a write occurs to this LBA range.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_write_zeros(struct nvme_io_args *args)
{
return nvme_io(args, nvme_cmd_write_zeroes);
}
/**
* nvme_write_uncorrectable() - Submit an nvme write uncorrectable command
* @args: &struct nvme_io_args argument structure
*
* The Write Uncorrectable command marks a range of logical blocks as invalid.
* When the specified logical block(s) are read after this operation, a failure
* is returned with Unrecovered Read Error status. To clear the invalid logical
* block status, a write operation on those logical blocks is required.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_write_uncorrectable(struct nvme_io_args *args)
{
return nvme_io(args, nvme_cmd_write_uncor);
}
/**
* nvme_verify() - Send an nvme verify command
* @args: &struct nvme_io_args argument structure
*
* The Verify command verifies integrity of stored information by reading data
* and metadata, if applicable, for the LBAs indicated without transferring any
* data or metadata to the host.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_verify(struct nvme_io_args *args)
{
return nvme_io(args, nvme_cmd_verify);
}
/**
* nvme_dsm() - Send an nvme data set management command
* @args: &struct nvme_dsm_args argument structure
*
* The Dataset Management command is used by the host to indicate attributes
* for ranges of logical blocks. This includes attributes like frequency that
* data is read or written, access size, and other information that may be used
* to optimize performance and reliability, and may be used to
* deallocate/unmap/trim those logical blocks.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_dsm(struct nvme_dsm_args *args);
/**
* nvme_copy() - Copy command
*
* @args: &struct nvme_copy_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_copy(struct nvme_copy_args *args);
/**
* nvme_resv_acquire() - Send an nvme reservation acquire
* @args: &struct nvme_resv_acquire argument structure
*
* The Reservation Acquire command acquires a reservation on a namespace,
* preempt a reservation held on a namespace, and abort a reservation held on a
* namespace.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_resv_acquire(struct nvme_resv_acquire_args *args);
/**
* nvme_resv_register() - Send an nvme reservation register
* @args: &struct nvme_resv_register_args argument structure
*
* The Reservation Register command registers, unregisters, or replaces a
* reservation key.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_resv_register(struct nvme_resv_register_args *args);
/**
* nvme_resv_release() - Send an nvme reservation release
* @args: &struct nvme_resv_release_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_resv_release(struct nvme_resv_release_args *args);
/**
* nvme_resv_report() - Send an nvme reservation report
* @args: struct nvme_resv_report_args argument structure
*
* Returns a Reservation Status data structure to memory that describes the
* registration and reservation status of a namespace. See the definition for
* the returned structure, &struct nvme_reservation_status, for more details.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_resv_report(struct nvme_resv_report_args *args);
/**
* nvme_io_mgmt_recv() - I/O Management Receive command
* @args: &struct nvme_io_mgmt_recv_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_io_mgmt_recv(struct nvme_io_mgmt_recv_args *args);
/**
* nvme_fdp_reclaim_unit_handle_status() - Get reclaim unit handle status
* @fd: File descriptor of nvme device
* @nsid: Namespace identifier
* @data_len: Length of response buffer
* @data: Response buffer
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_fdp_reclaim_unit_handle_status(int fd, __u32 nsid,
__u32 data_len, void *data)
{
struct nvme_io_mgmt_recv_args args = {
.data = data,
.args_size = sizeof(args),
.fd = fd,
.nsid = nsid,
.data_len = data_len,
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.mos = 0,
.mo = NVME_IO_MGMT_RECV_RUH_STATUS,
};
return nvme_io_mgmt_recv(&args);
}
/**
* nvme_io_mgmt_send() - I/O Management Send command
* @args: &struct nvme_io_mgmt_send_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_io_mgmt_send(struct nvme_io_mgmt_send_args *args);
/**
* nvme_fdp_reclaim_unit_handle_update() - Update a list of reclaim unit handles
* @fd: File descriptor of nvme device
* @nsid: Namespace identifier
* @npids: Number of placement identifiers
* @pids: List of placement identifiers
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_fdp_reclaim_unit_handle_update(int fd, __u32 nsid,
unsigned int npids, __u16 *pids)
{
struct nvme_io_mgmt_send_args args = {
.data = (void *)pids,
.args_size = sizeof(args),
.fd = fd,
.nsid = nsid,
.data_len = (__u32)(npids * sizeof(__u16)),
.timeout = NVME_DEFAULT_IOCTL_TIMEOUT,
.mos = (__u16)(npids - 1),
.mo = NVME_IO_MGMT_SEND_RUH_UPDATE,
};
return nvme_io_mgmt_send(&args);
}
/**
* nvme_zns_mgmt_send() - ZNS management send command
* @args: &struct nvme_zns_mgmt_send_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_zns_mgmt_send(struct nvme_zns_mgmt_send_args *args);
/**
* nvme_zns_mgmt_recv() - ZNS management receive command
* @args: &struct nvme_zns_mgmt_recv_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_zns_mgmt_recv(struct nvme_zns_mgmt_recv_args *args);
/**
* nvme_zns_report_zones() - Return the list of zones
* @fd: File descriptor of nvme device
* @nsid: Namespace ID
* @slba: Starting LBA
* @opts: Reporting options
* @extended: Extended report
* @partial: Partial report requested
* @data_len: Length of the data buffer
* @data: Userspace address of the report zones data
* @timeout: timeout in ms
* @result: The command completion result from CQE dword0
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
static inline int nvme_zns_report_zones(int fd, __u32 nsid, __u64 slba,
enum nvme_zns_report_options opts,
bool extended, bool partial,
__u32 data_len, void *data,
__u32 timeout, __u32 *result)
{
struct nvme_zns_mgmt_recv_args args = {
.slba = slba,
.result = result,
.data = data,
.args_size = sizeof(args),
.fd = fd,
.timeout = timeout,
.nsid = nsid,
.zra = extended ? NVME_ZNS_ZRA_EXTENDED_REPORT_ZONES :
NVME_ZNS_ZRA_REPORT_ZONES,
.data_len = data_len,
.zrasf = (__u16)opts,
.zras_feat = partial,
};
return nvme_zns_mgmt_recv(&args);
}
/**
* nvme_zns_append() - Append data to a zone
* @args: &struct nvme_zns_append_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_zns_append(struct nvme_zns_append_args *args);
/**
* nvme_dim_send - Send a Discovery Information Management (DIM) command
* @args: &struct nvme_dim_args argument structure
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_dim_send(struct nvme_dim_args *args);
#endif /* _LIBNVME_IOCTL_H */
|