Debian Codegraph @

doc/rst/api-types.rst

raw
1
2
3 .. c:type:: struct nvme_identify_args
4
5 Arguments for the NVMe Identify command
6
7 **Definition**
8
9 ::
10
11 struct nvme_identify_args {
12 __u32 *result;
13 void *data;
14 int args_size;
15 int fd;
16 __u32 timeout;
17 enum nvme_identify_cns cns;
18 enum nvme_csi csi;
19 __u32 nsid;
20 __u16 cntid;
21 __u16 cns_specific_id;
22 __u8 uuidx;
23 };
24
25 **Members**
26
27 ``result``
28 The command completion result from CQE dword0
29
30 ``data``
31 User space destination address to transfer the data
32
33 ``args_size``
34 Size of :c:type:`struct nvme_identify_args <nvme_identify_args>`
35
36 ``fd``
37 File descriptor of nvme device
38
39 ``timeout``
40 Timeout in ms (0 for default timeout)
41
42 ``cns``
43 The Controller or Namespace structure, see **enum** nvme_identify_cns
44
45 ``csi``
46 Command Set Identifier
47
48 ``nsid``
49 Namespace identifier, if applicable
50
51 ``cntid``
52 The Controller Identifier, if applicable
53
54 ``cns_specific_id``
55 Identifier that is required for a particular CNS value
56
57 ``uuidx``
58 UUID Index if controller supports this id selection method
59
60
61
62
63
64 .. c:type:: struct nvme_get_log_args
65
66 Arguments for the NVMe Admin Get Log command
67
68 **Definition**
69
70 ::
71
72 struct nvme_get_log_args {
73 __u64 lpo;
74 __u32 *result;
75 void *log;
76 int args_size;
77 int fd;
78 __u32 timeout;
79 enum nvme_cmd_get_log_lid lid;
80 __u32 len;
81 __u32 nsid;
82 enum nvme_csi csi;
83 __u16 lsi;
84 __u8 lsp;
85 __u8 uuidx;
86 bool rae;
87 bool ot;
88 };
89
90 **Members**
91
92 ``lpo``
93 Log page offset for partial log transfers
94
95 ``result``
96 The command completion result from CQE dword0
97
98 ``log``
99 User space destination address to transfer the data
100
101 ``args_size``
102 Length of the structure
103
104 ``fd``
105 File descriptor of nvme device
106
107 ``timeout``
108 Timeout in ms
109
110 ``lid``
111 Log page identifier, see :c:type:`enum nvme_cmd_get_log_lid <nvme_cmd_get_log_lid>` for known
112 values
113
114 ``len``
115 Length of provided user buffer to hold the log data in bytes
116
117 ``nsid``
118 Namespace identifier, if applicable
119
120 ``csi``
121 Command set identifier, see :c:type:`enum nvme_csi <nvme_csi>` for known values
122
123 ``lsi``
124 Log Specific Identifier
125
126 ``lsp``
127 Log specific field
128
129 ``uuidx``
130 UUID selection, if supported
131
132 ``rae``
133 Retain asynchronous events
134
135 ``ot``
136 Offset Type; if set **lpo** specifies the index into the list
137 of data structures, otherwise **lpo** specifies the byte offset
138 into the log page.
139
140
141
142
143
144 .. c:type:: struct nvme_set_features_args
145
146 Arguments for the NVMe Admin Set Feature command
147
148 **Definition**
149
150 ::
151
152 struct nvme_set_features_args {
153 __u32 *result;
154 void *data;
155 int args_size;
156 int fd;
157 __u32 timeout;
158 __u32 nsid;
159 __u32 cdw11;
160 __u32 cdw12;
161 __u32 cdw13;
162 __u32 cdw15;
163 __u32 data_len;
164 bool save;
165 __u8 uuidx;
166 __u8 fid;
167 };
168
169 **Members**
170
171 ``result``
172 The command completion result from CQE dword0
173
174 ``data``
175 User address of feature data, if applicable
176
177 ``args_size``
178 Size of :c:type:`struct nvme_set_features_args <nvme_set_features_args>`
179
180 ``fd``
181 File descriptor of nvme device
182
183 ``timeout``
184 Timeout in ms
185
186 ``nsid``
187 Namespace ID, if applicable
188
189 ``cdw11``
190 Value to set the feature to
191
192 ``cdw12``
193 Feature specific command dword12 field
194
195 ``cdw13``
196 Feature specific command dword13 field
197
198 ``cdw15``
199 Feature specific command dword15 field
200
201 ``data_len``
202 Length of feature data, if applicable, in bytes
203
204 ``save``
205 Save value across power states
206
207 ``uuidx``
208 UUID Index for differentiating vendor specific encoding
209
210 ``fid``
211 Feature identifier
212
213
214
215
216
217 .. c:type:: struct nvme_get_features_args
218
219 Arguments for the NVMe Admin Get Feature command
220
221 **Definition**
222
223 ::
224
225 struct nvme_get_features_args {
226 __u32 *result;
227 void *data;
228 int args_size;
229 int fd;
230 __u32 timeout;
231 __u32 nsid;
232 enum nvme_get_features_sel sel;
233 __u32 cdw11;
234 __u32 data_len;
235 __u8 fid;
236 __u8 uuidx;
237 };
238
239 **Members**
240
241 ``result``
242 The command completion result from CQE dword0
243
244 ``data``
245 User address of feature data, if applicable
246
247 ``args_size``
248 Size of :c:type:`struct nvme_get_features_args <nvme_get_features_args>`
249
250 ``fd``
251 File descriptor of nvme device
252
253 ``timeout``
254 Timeout in ms
255
256 ``nsid``
257 Namespace ID, if applicable
258
259 ``sel``
260 Select which type of attribute to return,
261 see :c:type:`enum nvme_get_features_sel <nvme_get_features_sel>`
262
263 ``cdw11``
264 Feature specific command dword11 field
265
266 ``data_len``
267 Length of feature data, if applicable, in bytes
268
269 ``fid``
270 Feature identifier, see :c:type:`enum nvme_features_id <nvme_features_id>`
271
272 ``uuidx``
273 UUID Index for differentiating vendor specific encoding
274
275
276
277
278
279 .. c:type:: struct nvme_format_nvm_args
280
281 Arguments for the Format Nvme Namespace command
282
283 **Definition**
284
285 ::
286
287 struct nvme_format_nvm_args {
288 __u32 *result;
289 int args_size;
290 int fd;
291 __u32 timeout;
292 __u32 nsid;
293 enum nvme_cmd_format_mset mset;
294 enum nvme_cmd_format_pi pi;
295 enum nvme_cmd_format_pil pil;
296 enum nvme_cmd_format_ses ses;
297 __u8 lbaf;
298 __u8 rsvd1[7];
299 __u8 lbafu;
300 };
301
302 **Members**
303
304 ``result``
305 The command completion result from CQE dword0
306
307 ``args_size``
308 Size of :c:type:`struct nvme_format_nvm_args <nvme_format_nvm_args>`
309
310 ``fd``
311 File descriptor of nvme device
312
313 ``timeout``
314 Set to override default timeout to this value in milliseconds;
315 useful for long running formats. 0 will use system default.
316
317 ``nsid``
318 Namespace ID to format
319
320 ``mset``
321 Metadata settings (extended or separated), true if extended
322
323 ``pi``
324 Protection information type
325
326 ``pil``
327 Protection information location (beginning or end), true if end
328
329 ``ses``
330 Secure erase settings
331
332 ``lbaf``
333 Logical block address format least significant 4 bits
334
335 ``rsvd1``
336 Reserved
337
338 ``lbafu``
339 Logical block address format most significant 2 bits
340
341
342
343
344
345 .. c:type:: struct nvme_ns_mgmt_args
346
347 Arguments for NVMe Namespace Management command
348
349 **Definition**
350
351 ::
352
353 struct nvme_ns_mgmt_args {
354 __u32 *result;
355 struct nvme_id_ns *ns;
356 int args_size;
357 int fd;
358 __u32 timeout;
359 __u32 nsid;
360 enum nvme_ns_mgmt_sel sel;
361 __u8 csi;
362 __u8 rsvd1[3];
363 void *rsvd2;
364 struct nvme_ns_mgmt_host_sw_specified *data;
365 };
366
367 **Members**
368
369 ``result``
370 NVMe command result
371
372 ``ns``
373 Namespace identification descriptors
374
375 ``args_size``
376 Size of :c:type:`struct nvme_ns_mgmt_args <nvme_ns_mgmt_args>`
377
378 ``fd``
379 File descriptor of nvme device
380
381 ``timeout``
382 Timeout in ms
383
384 ``nsid``
385 Namespace identifier
386
387 ``sel``
388 Type of management operation to perform
389
390 ``csi``
391 Command Set Identifier
392
393 ``rsvd1``
394 Reserved
395
396 ``rsvd2``
397 Reserved
398
399 ``data``
400 Host Software Specified Fields
401
402
403
404
405
406 .. c:type:: struct nvme_ns_attach_args
407
408 Arguments for Nvme Namespace Management command
409
410 **Definition**
411
412 ::
413
414 struct nvme_ns_attach_args {
415 __u32 *result;
416 struct nvme_ctrl_list *ctrlist;
417 int args_size;
418 int fd;
419 __u32 timeout;
420 __u32 nsid;
421 enum nvme_ns_attach_sel sel;
422 };
423
424 **Members**
425
426 ``result``
427 NVMe command result
428
429 ``ctrlist``
430 Controller list to modify attachment state of nsid
431
432 ``args_size``
433 Size of :c:type:`struct nvme_ns_attach_args <nvme_ns_attach_args>`
434
435 ``fd``
436 File descriptor of nvme device
437
438 ``timeout``
439 Timeout in ms
440
441 ``nsid``
442 Namespace ID to execute attach selection
443
444 ``sel``
445 Attachment selection, see :c:type:`enum nvme_ns_attach_sel <nvme_ns_attach_sel>`
446
447
448
449
450
451 .. c:type:: struct nvme_fw_download_args
452
453 Arguments for the NVMe Firmware Download command
454
455 **Definition**
456
457 ::
458
459 struct nvme_fw_download_args {
460 __u32 *result;
461 void *data;
462 int args_size;
463 int fd;
464 __u32 timeout;
465 __u32 offset;
466 __u32 data_len;
467 };
468
469 **Members**
470
471 ``result``
472 The command completion result from CQE dword0
473
474 ``data``
475 Userspace address of the firmware data
476
477 ``args_size``
478 Size of :c:type:`struct nvme_fw_download_args <nvme_fw_download_args>`
479
480 ``fd``
481 File descriptor of nvme device
482
483 ``timeout``
484 Timeout in ms
485
486 ``offset``
487 Offset in the firmware data
488
489 ``data_len``
490 Length of data in this command in bytes
491
492
493
494
495
496 .. c:type:: struct nvme_fw_commit_args
497
498 Arguments for the NVMe Firmware Commit command
499
500 **Definition**
501
502 ::
503
504 struct nvme_fw_commit_args {
505 __u32 *result;
506 int args_size;
507 int fd;
508 __u32 timeout;
509 enum nvme_fw_commit_ca action;
510 __u8 slot;
511 bool bpid;
512 };
513
514 **Members**
515
516 ``result``
517 The command completion result from CQE dword0
518
519 ``args_size``
520 Size of :c:type:`struct nvme_fw_commit_args <nvme_fw_commit_args>`
521
522 ``fd``
523 File descriptor of nvme device
524
525 ``timeout``
526 Timeout in ms
527
528 ``action``
529 Action to use for the firmware image, see :c:type:`enum nvme_fw_commit_ca <nvme_fw_commit_ca>`
530
531 ``slot``
532 Firmware slot to commit the downloaded image
533
534 ``bpid``
535 Set to true to select the boot partition id
536
537
538
539
540
541 .. c:type:: struct nvme_security_send_args
542
543 Arguments for the NVMe Security Send command
544
545 **Definition**
546
547 ::
548
549 struct nvme_security_send_args {
550 __u32 *result;
551 void *data;
552 int args_size;
553 int fd;
554 __u32 timeout;
555 __u32 nsid;
556 __u32 tl;
557 __u32 data_len;
558 __u8 nssf;
559 __u8 spsp0;
560 __u8 spsp1;
561 __u8 secp;
562 };
563
564 **Members**
565
566 ``result``
567 The command completion result from CQE dword0
568
569 ``data``
570 Security data payload to send
571
572 ``args_size``
573 Size of :c:type:`struct nvme_security_send_args <nvme_security_send_args>`
574
575 ``fd``
576 File descriptor of nvme device
577
578 ``timeout``
579 Timeout in ms
580
581 ``nsid``
582 Namespace ID to issue security command on
583
584 ``tl``
585 Protocol specific transfer length
586
587 ``data_len``
588 Data length of the payload in bytes
589
590 ``nssf``
591 NVMe Security Specific field
592
593 ``spsp0``
594 Security Protocol Specific field
595
596 ``spsp1``
597 Security Protocol Specific field
598
599 ``secp``
600 Security Protocol
601
602
603
604
605
606 .. c:type:: struct nvme_security_receive_args
607
608 Arguments for the NVMe Security Receive command
609
610 **Definition**
611
612 ::
613
614 struct nvme_security_receive_args {
615 __u32 *result;
616 void *data;
617 int args_size;
618 int fd;
619 __u32 timeout;
620 __u32 nsid;
621 __u32 al;
622 __u32 data_len;
623 __u8 nssf;
624 __u8 spsp0;
625 __u8 spsp1;
626 __u8 secp;
627 };
628
629 **Members**
630
631 ``result``
632 The command completion result from CQE dword0
633
634 ``data``
635 Security data payload to send
636
637 ``args_size``
638 Size of :c:type:`struct nvme_security_receive_args <nvme_security_receive_args>`
639
640 ``fd``
641 File descriptor of nvme device
642
643 ``timeout``
644 Timeout in ms
645
646 ``nsid``
647 Namespace ID to issue security command on
648
649 ``al``
650 Protocol specific allocation length
651
652 ``data_len``
653 Data length of the payload in bytes
654
655 ``nssf``
656 NVMe Security Specific field
657
658 ``spsp0``
659 Security Protocol Specific field
660
661 ``spsp1``
662 Security Protocol Specific field
663
664 ``secp``
665 Security Protocol
666
667
668
669
670
671 .. c:type:: struct nvme_get_lba_status_args
672
673 Arguments for the NVMe Get LBA Status command
674
675 **Definition**
676
677 ::
678
679 struct nvme_get_lba_status_args {
680 __u64 slba;
681 __u32 *result;
682 struct nvme_lba_status *lbas;
683 int args_size;
684 int fd;
685 __u32 timeout;
686 __u32 nsid;
687 __u32 mndw;
688 enum nvme_lba_status_atype atype;
689 __u16 rl;
690 };
691
692 **Members**
693
694 ``slba``
695 Starting logical block address to check statuses
696
697 ``result``
698 The command completion result from CQE dword0
699
700 ``lbas``
701 Data payload to return status descriptors
702
703 ``args_size``
704 Size of :c:type:`struct nvme_get_lba_status_args <nvme_get_lba_status_args>`
705
706 ``fd``
707 File descriptor of nvme device
708
709 ``timeout``
710 Timeout in ms
711
712 ``nsid``
713 Namespace ID to retrieve LBA status
714
715 ``mndw``
716 Maximum number of dwords to return
717
718 ``atype``
719 Action type mechanism to determine LBA status descriptors to
720 return, see :c:type:`enum nvme_lba_status_atype <nvme_lba_status_atype>`
721
722 ``rl``
723 Range length from slba to perform the action
724
725
726
727
728
729 .. c:type:: struct nvme_directive_send_args
730
731 Arguments for the NVMe Directive Send command
732
733 **Definition**
734
735 ::
736
737 struct nvme_directive_send_args {
738 __u32 *result;
739 void *data;
740 int args_size;
741 int fd;
742 __u32 timeout;
743 __u32 nsid;
744 enum nvme_directive_send_doper doper;
745 enum nvme_directive_dtype dtype;
746 __u32 cdw12;
747 __u32 data_len;
748 __u16 dspec;
749 };
750
751 **Members**
752
753 ``result``
754 If successful, the CQE dword0 value
755
756 ``data``
757 Data payload to be send
758
759 ``args_size``
760 Size of :c:type:`struct nvme_directive_send_args <nvme_directive_send_args>`
761
762 ``fd``
763 File descriptor of nvme device
764
765 ``timeout``
766 Timeout in ms
767
768 ``nsid``
769 Namespace ID, if applicable
770
771 ``doper``
772 Directive send operation, see :c:type:`enum nvme_directive_send_doper <nvme_directive_send_doper>`
773
774 ``dtype``
775 Directive type, see :c:type:`enum nvme_directive_dtype <nvme_directive_dtype>`
776
777 ``cdw12``
778 Directive specific command dword12
779
780 ``data_len``
781 Length of data payload in bytes
782
783 ``dspec``
784 Directive specific field
785
786
787
788
789
790 .. c:type:: struct nvme_directive_recv_args
791
792 Arguments for the NVMe Directive Receive command
793
794 **Definition**
795
796 ::
797
798 struct nvme_directive_recv_args {
799 __u32 *result;
800 void *data;
801 int args_size;
802 int fd;
803 __u32 timeout;
804 __u32 nsid;
805 enum nvme_directive_receive_doper doper;
806 enum nvme_directive_dtype dtype;
807 __u32 cdw12;
808 __u32 data_len;
809 __u16 dspec;
810 };
811
812 **Members**
813
814 ``result``
815 If successful, the CQE dword0 value
816
817 ``data``
818 Userspace address of data payload
819
820 ``args_size``
821 Size of :c:type:`struct nvme_directive_recv_args <nvme_directive_recv_args>`
822
823 ``fd``
824 File descriptor of nvme device
825
826 ``timeout``
827 Timeout in ms
828
829 ``nsid``
830 Namespace ID, if applicable
831
832 ``doper``
833 Directive send operation, see :c:type:`enum nvme_directive_send_doper <nvme_directive_send_doper>`
834
835 ``dtype``
836 Directive type, see :c:type:`enum nvme_directive_dtype <nvme_directive_dtype>`
837
838 ``cdw12``
839 Directive specific command dword12
840
841 ``data_len``
842 Length of data payload in bytes
843
844 ``dspec``
845 Directive specific field
846
847
848
849
850
851 .. c:type:: struct nvme_capacity_mgmt_args
852
853 Arguments for the NVMe Capacity Management command
854
855 **Definition**
856
857 ::
858
859 struct nvme_capacity_mgmt_args {
860 __u32 *result;
861 int args_size;
862 int fd;
863 __u32 timeout;
864 __u32 cdw11;
865 __u32 cdw12;
866 __u16 element_id;
867 __u8 op;
868 };
869
870 **Members**
871
872 ``result``
873 If successful, the CQE dword0 value
874
875 ``args_size``
876 Size of :c:type:`struct nvme_capacity_mgmt_args <nvme_capacity_mgmt_args>`
877
878 ``fd``
879 File descriptor of nvme device
880
881 ``timeout``
882 Timeout in ms
883
884 ``cdw11``
885 Least significant 32 bits of the capacity in bytes of the
886 Endurance Group or NVM Set to be created
887
888 ``cdw12``
889 Most significant 32 bits of the capacity in bytes of the
890 Endurance Group or NVM Set to be created
891
892 ``element_id``
893 Value specific to the value of the Operation field
894
895 ``op``
896 Operation to be performed by the controller
897
898
899
900
901
902 .. c:type:: struct nvme_lockdown_args
903
904 Arguments for the NVME Lockdown command
905
906 **Definition**
907
908 ::
909
910 struct nvme_lockdown_args {
911 __u32 *result;
912 int args_size;
913 int fd;
914 __u32 timeout;
915 __u8 scp;
916 __u8 prhbt;
917 __u8 ifc;
918 __u8 ofi;
919 __u8 uuidx;
920 };
921
922 **Members**
923
924 ``result``
925 The command completion result from CQE dword0
926
927 ``args_size``
928 Size of :c:type:`struct nvme_lockdown_args <nvme_lockdown_args>`
929
930 ``fd``
931 File descriptor of nvme device
932
933 ``timeout``
934 Timeout in ms (0 for default timeout)
935
936 ``scp``
937 Scope of the command
938
939 ``prhbt``
940 Prohibit or allow the command opcode or Set Features command
941
942 ``ifc``
943 Affected interface
944
945 ``ofi``
946 Opcode or Feature Identifier
947
948 ``uuidx``
949 UUID Index if controller supports this id selection method
950
951
952
953
954
955 .. c:type:: struct nvme_set_property_args
956
957 Arguments for NVMe Set Property command
958
959 **Definition**
960
961 ::
962
963 struct nvme_set_property_args {
964 __u64 value;
965 __u32 *result;
966 int args_size;
967 int fd;
968 __u32 timeout;
969 int offset;
970 };
971
972 **Members**
973
974 ``value``
975 The value to set the property
976
977 ``result``
978 The command completion result from CQE dword0
979
980 ``args_size``
981 Size of :c:type:`struct nvme_set_property_args <nvme_set_property_args>`
982
983 ``fd``
984 File descriptor of nvme device
985
986 ``timeout``
987 Timeout in ms
988
989 ``offset``
990 Property offset from the base to set
991
992
993
994
995
996 .. c:type:: struct nvme_get_property_args
997
998 Arguments for NVMe Get Property command
999
1000 **Definition**
1001
1002 ::
1003
1004 struct nvme_get_property_args {
1005 __u64 *value;
1006 int args_size;
1007 int fd;
1008 __u32 timeout;
1009 int offset;
1010 };
1011
1012 **Members**
1013
1014 ``value``
1015 Where the property's value will be stored on success
1016
1017 ``args_size``
1018 Size of :c:type:`struct nvme_get_property_args <nvme_get_property_args>`
1019
1020 ``fd``
1021 File descriptor of nvme device
1022
1023 ``timeout``
1024 Timeout in ms
1025
1026 ``offset``
1027 Property offset from the base to retrieve
1028
1029
1030
1031
1032
1033 .. c:type:: struct nvme_sanitize_nvm_args
1034
1035 Arguments for the NVMe Sanitize NVM command
1036
1037 **Definition**
1038
1039 ::
1040
1041 struct nvme_sanitize_nvm_args {
1042 __u32 *result;
1043 int args_size;
1044 int fd;
1045 __u32 timeout;
1046 enum nvme_sanitize_sanact sanact;
1047 __u32 ovrpat;
1048 bool ause;
1049 __u8 owpass;
1050 bool oipbp;
1051 bool nodas;
1052 bool emvs;
1053 };
1054
1055 **Members**
1056
1057 ``result``
1058 The command completion result from CQE dword0
1059
1060 ``args_size``
1061 Size of :c:type:`struct nvme_sanitize_nvm_args <nvme_sanitize_nvm_args>`
1062
1063 ``fd``
1064 File descriptor of nvme device
1065
1066 ``timeout``
1067 Timeout in ms
1068
1069 ``sanact``
1070 Sanitize action, see :c:type:`enum nvme_sanitize_sanact <nvme_sanitize_sanact>`
1071
1072 ``ovrpat``
1073 Overwrite pattern
1074
1075 ``ause``
1076 Set to allow unrestricted sanitize exit
1077
1078 ``owpass``
1079 Overwrite pass count
1080
1081 ``oipbp``
1082 Set to overwrite invert pattern between passes
1083
1084 ``nodas``
1085 Set to not deallocate blocks after sanitizing
1086
1087 ``emvs``
1088 Set to enter media verification state
1089
1090
1091
1092
1093
1094 .. c:type:: struct nvme_dev_self_test_args
1095
1096 Arguments for the NVMe Device Self Test command
1097
1098 **Definition**
1099
1100 ::
1101
1102 struct nvme_dev_self_test_args {
1103 __u32 *result;
1104 int args_size;
1105 int fd;
1106 __u32 timeout;
1107 __u32 nsid;
1108 enum nvme_dst_stc stc;
1109 };
1110
1111 **Members**
1112
1113 ``result``
1114 The command completion result from CQE dword0
1115
1116 ``args_size``
1117 Size of :c:type:`struct nvme_dev_self_test_args <nvme_dev_self_test_args>`
1118
1119 ``fd``
1120 File descriptor of nvme device
1121
1122 ``timeout``
1123 Timeout in ms
1124
1125 ``nsid``
1126 Namespace ID to test
1127
1128 ``stc``
1129 Self test code, see :c:type:`enum nvme_dst_stc <nvme_dst_stc>`
1130
1131
1132
1133
1134
1135 .. c:type:: struct nvme_virtual_mgmt_args
1136
1137 Arguments for the NVMe Virtualization resource management command
1138
1139 **Definition**
1140
1141 ::
1142
1143 struct nvme_virtual_mgmt_args {
1144 __u32 *result;
1145 int args_size;
1146 int fd;
1147 __u32 timeout;
1148 enum nvme_virt_mgmt_act act;
1149 enum nvme_virt_mgmt_rt rt;
1150 __u16 cntlid;
1151 __u16 nr;
1152 };
1153
1154 **Members**
1155
1156 ``result``
1157 If successful, the CQE dword0
1158
1159 ``args_size``
1160 Size of :c:type:`struct nvme_virtual_mgmt_args <nvme_virtual_mgmt_args>`
1161
1162 ``fd``
1163 File descriptor of nvme device
1164
1165 ``timeout``
1166 Timeout in ms
1167
1168 ``act``
1169 Virtual resource action, see :c:type:`enum nvme_virt_mgmt_act <nvme_virt_mgmt_act>`
1170
1171 ``rt``
1172 Resource type to modify, see :c:type:`enum nvme_virt_mgmt_rt <nvme_virt_mgmt_rt>`
1173
1174 ``cntlid``
1175 Controller id for which resources are bing modified
1176
1177 ``nr``
1178 Number of resources being allocated or assigned
1179
1180
1181
1182
1183
1184 .. c:type:: struct nvme_io_args
1185
1186 Arguments for NVMe I/O commands
1187
1188 **Definition**
1189
1190 ::
1191
1192 struct nvme_io_args {
1193 __u64 slba;
1194 __u64 storage_tag;
1195 __u32 *result;
1196 void *data;
1197 void *metadata;
1198 int args_size;
1199 int fd;
1200 __u32 timeout;
1201 __u32 nsid;
1202 __u32 reftag;
1203 __u32 data_len;
1204 __u32 metadata_len;
1205 __u16 nlb;
1206 __u16 control;
1207 __u16 apptag;
1208 __u16 appmask;
1209 __u16 dspec;
1210 __u8 dsm;
1211 __u8 rsvd1[1];
1212 __u64 reftag_u64;
1213 __u8 sts;
1214 __u8 pif;
1215 };
1216
1217 **Members**
1218
1219 ``slba``
1220 Starting logical block
1221
1222 ``storage_tag``
1223 This filed specifies Variable Sized Expected Logical Block
1224 Storage Tag (ELBST) or Logical Block Storage Tag (LBST)
1225
1226 ``result``
1227 The command completion result from CQE dword0
1228
1229 ``data``
1230 Pointer to user address of the data buffer
1231
1232 ``metadata``
1233 Pointer to user address of the metadata buffer
1234
1235 ``args_size``
1236 Size of :c:type:`struct nvme_io_args <nvme_io_args>`
1237
1238 ``fd``
1239 File descriptor of nvme device
1240
1241 ``timeout``
1242 Timeout in ms
1243
1244 ``nsid``
1245 Namespace ID
1246
1247 ``reftag``
1248 This field specifies the variable sized Expected Initial
1249 Logical Block Reference Tag (EILBRT) or Initial Logical Block
1250 Reference Tag (ILBRT). Used only if the namespace is formatted
1251 to use end-to-end protection information.
1252
1253 ``data_len``
1254 Length of user buffer, **data**, in bytes
1255
1256 ``metadata_len``
1257 Length of user buffer, **metadata**, in bytes
1258
1259 ``nlb``
1260 Number of logical blocks to send (0's based value)
1261
1262 ``control``
1263 Command control flags, see :c:type:`enum nvme_io_control_flags <nvme_io_control_flags>`.
1264
1265 ``apptag``
1266 This field specifies the Application Tag Mask expected value.
1267 Used only if the namespace is formatted to use end-to-end
1268 protection information.
1269
1270 ``appmask``
1271 This field specifies the Application Tag expected value. Used
1272 only if the namespace is formatted to use end-to-end protection
1273 information.
1274
1275 ``dspec``
1276 Directive specific value
1277
1278 ``dsm``
1279 Data set management attributes, see :c:type:`enum nvme_io_dsm_flags <nvme_io_dsm_flags>`
1280
1281 ``rsvd1``
1282 Reserved
1283
1284 ``reftag_u64``
1285 This field specifies the variable sized Expected Initial
1286 Logical Block Reference Tag (EILBRT) or Initial Logical Block
1287 Reference Tag (ILBRT). It is the 8 byte version required for
1288 enhanced protection information. Used only if the namespace is
1289 formatted to use end-to-end protection information.
1290
1291 ``sts``
1292 Storage tag size in bits, set by namespace Extended LBA Format
1293
1294 ``pif``
1295 Protection information format, determines how variable sized
1296 storage_tag and reftag are put into dwords 2, 3, and 14. Set by
1297 namespace Extended LBA Format.
1298
1299
1300
1301
1302
1303 .. c:type:: struct nvme_dsm_args
1304
1305 Arguments for the NVMe Dataset Management command
1306
1307 **Definition**
1308
1309 ::
1310
1311 struct nvme_dsm_args {
1312 __u32 *result;
1313 struct nvme_dsm_range *dsm;
1314 int args_size;
1315 int fd;
1316 __u32 timeout;
1317 __u32 nsid;
1318 __u32 attrs;
1319 __u16 nr_ranges;
1320 };
1321
1322 **Members**
1323
1324 ``result``
1325 The command completion result from CQE dword0
1326
1327 ``dsm``
1328 The data set management attributes
1329
1330 ``args_size``
1331 Size of :c:type:`struct nvme_dsm_args <nvme_dsm_args>`
1332
1333 ``fd``
1334 File descriptor of nvme device
1335
1336 ``timeout``
1337 Timeout in ms
1338
1339 ``nsid``
1340 Namespace identifier
1341
1342 ``attrs``
1343 DSM attributes, see :c:type:`enum nvme_dsm_attributes <nvme_dsm_attributes>`
1344
1345 ``nr_ranges``
1346 Number of block ranges in the data set management attributes
1347
1348
1349
1350
1351
1352 .. c:type:: struct nvme_copy_args
1353
1354 Arguments for the NVMe Copy command
1355
1356 **Definition**
1357
1358 ::
1359
1360 struct nvme_copy_args {
1361 __u64 sdlba;
1362 __u32 *result;
1363 struct nvme_copy_range *copy;
1364 int args_size;
1365 int fd;
1366 __u32 timeout;
1367 __u32 nsid;
1368 __u32 ilbrt;
1369 int lr;
1370 int fua;
1371 __u16 nr;
1372 __u16 dspec;
1373 __u16 lbatm;
1374 __u16 lbat;
1375 __u8 prinfor;
1376 __u8 prinfow;
1377 __u8 dtype;
1378 __u8 format;
1379 __u64 ilbrt_u64;
1380 };
1381
1382 **Members**
1383
1384 ``sdlba``
1385 Start destination LBA
1386
1387 ``result``
1388 The command completion result from CQE dword0
1389
1390 ``copy``
1391 Range description
1392
1393 ``args_size``
1394 Size of :c:type:`struct nvme_copy_args <nvme_copy_args>`
1395
1396 ``fd``
1397 File descriptor of the nvme device
1398
1399 ``timeout``
1400 Timeout in ms
1401
1402 ``nsid``
1403 Namespace identifier
1404
1405 ``ilbrt``
1406 Initial logical block reference tag
1407
1408 ``lr``
1409 Limited retry
1410
1411 ``fua``
1412 Force unit access
1413
1414 ``nr``
1415 Number of ranges
1416
1417 ``dspec``
1418 Directive specific value
1419
1420 ``lbatm``
1421 Logical block application tag mask
1422
1423 ``lbat``
1424 Logical block application tag
1425
1426 ``prinfor``
1427 Protection information field for read
1428
1429 ``prinfow``
1430 Protection information field for write
1431
1432 ``dtype``
1433 Directive type
1434
1435 ``format``
1436 Descriptor format
1437
1438 ``ilbrt_u64``
1439 Initial logical block reference tag - 8 byte
1440 version required for enhanced protection info
1441
1442
1443
1444
1445
1446 .. c:type:: struct nvme_resv_acquire_args
1447
1448 Arguments for the NVMe Reservation Acquire Command
1449
1450 **Definition**
1451
1452 ::
1453
1454 struct nvme_resv_acquire_args {
1455 __u64 crkey;
1456 __u64 nrkey;
1457 __u32 *result;
1458 int args_size;
1459 int fd;
1460 __u32 timeout;
1461 __u32 nsid;
1462 enum nvme_resv_rtype rtype;
1463 enum nvme_resv_racqa racqa;
1464 bool iekey;
1465 };
1466
1467 **Members**
1468
1469 ``crkey``
1470 The current reservation key associated with the host
1471
1472 ``nrkey``
1473 The reservation key to be unregistered from the namespace if
1474 the action is preempt
1475
1476 ``result``
1477 The command completion result from CQE dword0
1478
1479 ``args_size``
1480 Size of :c:type:`struct nvme_resv_acquire_args <nvme_resv_acquire_args>`
1481
1482 ``fd``
1483 File descriptor of nvme device
1484
1485 ``timeout``
1486 Timeout in ms
1487
1488 ``nsid``
1489 Namespace identifier
1490
1491 ``rtype``
1492 The type of reservation to be create, see :c:type:`enum nvme_resv_rtype <nvme_resv_rtype>`
1493
1494 ``racqa``
1495 The action that is performed by the command, see :c:type:`enum nvme_resv_racqa <nvme_resv_racqa>`
1496
1497 ``iekey``
1498 Set to ignore the existing key
1499
1500
1501
1502
1503
1504 .. c:type:: struct nvme_resv_register_args
1505
1506 Arguments for the NVMe Reservation Register command
1507
1508 **Definition**
1509
1510 ::
1511
1512 struct nvme_resv_register_args {
1513 __u64 crkey;
1514 __u64 nrkey;
1515 __u32 *result;
1516 int args_size;
1517 int fd;
1518 __u32 timeout;
1519 __u32 nsid;
1520 enum nvme_resv_rrega rrega;
1521 enum nvme_resv_cptpl cptpl;
1522 bool iekey;
1523 };
1524
1525 **Members**
1526
1527 ``crkey``
1528 The current reservation key associated with the host
1529
1530 ``nrkey``
1531 The new reservation key to be register if action is register or
1532 replace
1533
1534 ``result``
1535 The command completion result from CQE dword0
1536
1537 ``args_size``
1538 Size of :c:type:`struct nvme_resv_register_args <nvme_resv_register_args>`
1539
1540 ``fd``
1541 File descriptor of nvme device
1542
1543 ``timeout``
1544 Timeout in ms
1545
1546 ``nsid``
1547 Namespace identifier
1548
1549 ``rrega``
1550 The registration action, see :c:type:`enum nvme_resv_rrega <nvme_resv_rrega>`
1551
1552 ``cptpl``
1553 Change persist through power loss, see :c:type:`enum nvme_resv_cptpl <nvme_resv_cptpl>`
1554
1555 ``iekey``
1556 Set to ignore the existing key
1557
1558
1559
1560
1561
1562 .. c:type:: struct nvme_resv_release_args
1563
1564 Arguments for the NVMe Reservation Release Command
1565
1566 **Definition**
1567
1568 ::
1569
1570 struct nvme_resv_release_args {
1571 __u64 crkey;
1572 __u32 *result;
1573 int args_size;
1574 int fd;
1575 __u32 timeout;
1576 __u32 nsid;
1577 enum nvme_resv_rtype rtype;
1578 enum nvme_resv_rrela rrela;
1579 bool iekey;
1580 };
1581
1582 **Members**
1583
1584 ``crkey``
1585 The current reservation key to release
1586
1587 ``result``
1588 The command completion result from CQE dword0
1589
1590 ``args_size``
1591 Size of :c:type:`struct nvme_resv_release_args <nvme_resv_release_args>`
1592
1593 ``fd``
1594 File descriptor of nvme device
1595
1596 ``timeout``
1597 Timeout in ms
1598
1599 ``nsid``
1600 Namespace identifier
1601
1602 ``rtype``
1603 The type of reservation to be create, see :c:type:`enum nvme_resv_rtype <nvme_resv_rtype>`
1604
1605 ``rrela``
1606 Reservation release action, see :c:type:`enum nvme_resv_rrela <nvme_resv_rrela>`
1607
1608 ``iekey``
1609 Set to ignore the existing key
1610
1611
1612
1613
1614
1615 .. c:type:: struct nvme_resv_report_args
1616
1617 Arguments for the NVMe Reservation Report command
1618
1619 **Definition**
1620
1621 ::
1622
1623 struct nvme_resv_report_args {
1624 __u32 *result;
1625 struct nvme_resv_status *report;
1626 int args_size;
1627 int fd;
1628 __u32 timeout;
1629 __u32 nsid;
1630 __u32 len;
1631 bool eds;
1632 };
1633
1634 **Members**
1635
1636 ``result``
1637 The command completion result from CQE dword0
1638
1639 ``report``
1640 The user space destination address to store the reservation
1641 report
1642
1643 ``args_size``
1644 Size of :c:type:`struct nvme_resv_report_args <nvme_resv_report_args>`
1645
1646 ``fd``
1647 File descriptor of nvme device
1648
1649 ``timeout``
1650 Timeout in ms
1651
1652 ``nsid``
1653 Namespace identifier
1654
1655 ``len``
1656 Number of bytes to request transferred with this command
1657
1658 ``eds``
1659 Request extended Data Structure
1660
1661
1662
1663
1664
1665 .. c:type:: struct nvme_io_mgmt_recv_args
1666
1667 Arguments for the NVMe I/O Management Receive command
1668
1669 **Definition**
1670
1671 ::
1672
1673 struct nvme_io_mgmt_recv_args {
1674 void *data;
1675 int args_size;
1676 int fd;
1677 __u32 nsid;
1678 __u32 data_len;
1679 __u32 timeout;
1680 __u16 mos;
1681 __u8 mo;
1682 };
1683
1684 **Members**
1685
1686 ``data``
1687 Userspace address of the data
1688
1689 ``args_size``
1690 Size of :c:type:`struct nvme_io_mgmt_recv_args <nvme_io_mgmt_recv_args>`
1691
1692 ``fd``
1693 File descriptor of nvme device
1694
1695 ``nsid``
1696 Namespace identifier
1697
1698 ``data_len``
1699 Length of **data**
1700
1701 ``timeout``
1702 Timeout in ms
1703
1704 ``mos``
1705 Management Operation Specific
1706
1707 ``mo``
1708 Management Operation
1709
1710
1711
1712
1713
1714 .. c:type:: struct nvme_io_mgmt_send_args
1715
1716 Arguments for the NVMe I/O Management Send command
1717
1718 **Definition**
1719
1720 ::
1721
1722 struct nvme_io_mgmt_send_args {
1723 void *data;
1724 int args_size;
1725 int fd;
1726 __u32 nsid;
1727 __u32 data_len;
1728 __u32 timeout;
1729 __u16 mos;
1730 __u8 mo;
1731 };
1732
1733 **Members**
1734
1735 ``data``
1736 Userspace address of the data
1737
1738 ``args_size``
1739 Size of :c:type:`struct nvme_io_mgmt_send_args <nvme_io_mgmt_send_args>`
1740
1741 ``fd``
1742 File descriptor of nvme device
1743
1744 ``nsid``
1745 Namespace identifier
1746
1747 ``data_len``
1748 Length of **data**
1749
1750 ``timeout``
1751 Timeout in ms
1752
1753 ``mos``
1754 Management Operation Specific
1755
1756 ``mo``
1757 Management Operation
1758
1759
1760
1761
1762
1763 .. c:type:: struct nvme_zns_mgmt_send_args
1764
1765 Arguments for the NVMe ZNS Management Send command
1766
1767 **Definition**
1768
1769 ::
1770
1771 struct nvme_zns_mgmt_send_args {
1772 __u64 slba;
1773 __u32 *result;
1774 void *data;
1775 int args_size;
1776 int fd;
1777 __u32 timeout;
1778 __u32 nsid;
1779 enum nvme_zns_send_action zsa;
1780 __u32 data_len;
1781 bool select_all;
1782 __u8 zsaso;
1783 };
1784
1785 **Members**
1786
1787 ``slba``
1788 Starting logical block address
1789
1790 ``result``
1791 The command completion result from CQE dword0
1792
1793 ``data``
1794 Userspace address of the data
1795
1796 ``args_size``
1797 Size of :c:type:`struct nvme_zns_mgmt_send_args <nvme_zns_mgmt_send_args>`
1798
1799 ``fd``
1800 File descriptor of nvme device
1801
1802 ``timeout``
1803 timeout in ms
1804
1805 ``nsid``
1806 Namespace ID
1807
1808 ``zsa``
1809 Zone send action
1810
1811 ``data_len``
1812 Length of **data**
1813
1814 ``select_all``
1815 Select all flag
1816
1817 ``zsaso``
1818 Zone Send Action Specific Option
1819
1820
1821
1822
1823
1824 .. c:type:: struct nvme_zns_mgmt_recv_args
1825
1826 Arguments for the NVMe ZNS Management Receive command
1827
1828 **Definition**
1829
1830 ::
1831
1832 struct nvme_zns_mgmt_recv_args {
1833 __u64 slba;
1834 __u32 *result;
1835 void *data;
1836 int args_size;
1837 int fd;
1838 __u32 timeout;
1839 __u32 nsid;
1840 enum nvme_zns_recv_action zra;
1841 __u32 data_len;
1842 __u16 zrasf;
1843 bool zras_feat;
1844 };
1845
1846 **Members**
1847
1848 ``slba``
1849 Starting logical block address
1850
1851 ``result``
1852 The command completion result from CQE dword0
1853
1854 ``data``
1855 Userspace address of the data
1856
1857 ``args_size``
1858 Size of :c:type:`struct nvme_zns_mgmt_recv_args <nvme_zns_mgmt_recv_args>`
1859
1860 ``fd``
1861 File descriptor of nvme device
1862
1863 ``timeout``
1864 timeout in ms
1865
1866 ``nsid``
1867 Namespace ID
1868
1869 ``zra``
1870 zone receive action
1871
1872 ``data_len``
1873 Length of **data**
1874
1875 ``zrasf``
1876 Zone receive action specific field
1877
1878 ``zras_feat``
1879 Zone receive action specific features
1880
1881
1882
1883
1884
1885 .. c:type:: struct nvme_zns_append_args
1886
1887 Arguments for the NVMe ZNS Append command
1888
1889 **Definition**
1890
1891 ::
1892
1893 struct nvme_zns_append_args {
1894 __u64 zslba;
1895 __u64 *result;
1896 void *data;
1897 void *metadata;
1898 int args_size;
1899 int fd;
1900 __u32 timeout;
1901 __u32 nsid;
1902 __u32 ilbrt;
1903 __u32 data_len;
1904 __u32 metadata_len;
1905 __u16 nlb;
1906 __u16 control;
1907 __u16 lbat;
1908 __u16 lbatm;
1909 __u8 rsvd1[4];
1910 __u64 ilbrt_u64;
1911 };
1912
1913 **Members**
1914
1915 ``zslba``
1916 Zone start logical block address
1917
1918 ``result``
1919 The command completion result from CQE dword0
1920
1921 ``data``
1922 Userspace address of the data
1923
1924 ``metadata``
1925 Userspace address of the metadata
1926
1927 ``args_size``
1928 Size of :c:type:`struct nvme_zns_append_args <nvme_zns_append_args>`
1929
1930 ``fd``
1931 File descriptor of nvme device
1932
1933 ``timeout``
1934 Timeout in ms
1935
1936 ``nsid``
1937 Namespace ID
1938
1939 ``ilbrt``
1940 Initial logical block reference tag
1941
1942 ``data_len``
1943 Length of **data**
1944
1945 ``metadata_len``
1946 Length of **metadata**
1947
1948 ``nlb``
1949 Number of logical blocks
1950
1951 ``control``
1952
1953 ``lbat``
1954 Logical block application tag
1955
1956 ``lbatm``
1957 Logical block application tag mask
1958
1959 ``rsvd1``
1960 Reserved
1961
1962 ``ilbrt_u64``
1963 Initial logical block reference tag - 8 byte
1964 version required for enhanced protection info
1965
1966
1967
1968
1969
1970 .. c:type:: struct nvme_dim_args
1971
1972 Arguments for the Discovery Information Management (DIM) command
1973
1974 **Definition**
1975
1976 ::
1977
1978 struct nvme_dim_args {
1979 __u32 *result;
1980 void *data;
1981 int args_size;
1982 int fd;
1983 __u32 timeout;
1984 __u32 data_len;
1985 __u8 tas;
1986 };
1987
1988 **Members**
1989
1990 ``result``
1991 Set on completion to the command's CQE DWORD 0 controller response.
1992
1993 ``data``
1994 Pointer to the DIM data
1995
1996 ``args_size``
1997 Length of the structure
1998
1999 ``fd``
2000 File descriptor of nvme device
2001
2002 ``timeout``
2003 Timeout in ms
2004
2005 ``data_len``
2006 Length of **data**
2007
2008 ``tas``
2009 Task field of the Command Dword 10 (cdw10)
2010
2011
2012
2013
2014
2015 .. c:type:: struct nvme_lm_cdq_args
2016
2017 Arguments for Controller Data Queue (CDQ) command
2018
2019 **Definition**
2020
2021 ::
2022
2023 struct nvme_lm_cdq_args {
2024 __u32 *result;
2025 void *data;
2026 int args_size;
2027 int fd;
2028 __u32 timeout;
2029 __u16 mos;
2030 __u16 cntlid;
2031 __u16 cdqid;
2032 __u8 sel;
2033 __u8 sz_u8;
2034 __u8 rsvd1[4];
2035 __u32 sz;
2036 };
2037
2038 **Members**
2039
2040 ``result``
2041 Set on completion to the command's CQE DWORD 0 controller response
2042
2043 ``data``
2044 Pointer to data
2045
2046 ``args_size``
2047 Length of structure
2048
2049 ``fd``
2050 File descriptor of nvme device
2051
2052 ``timeout``
2053 Timeout in ms
2054
2055 ``mos``
2056 Management Operation Specific (MOS): This field is specific to the SEL type
2057
2058 ``cntlid``
2059 Controller ID: For Create CDQ, specifies the target migratable controller
2060
2061 ``cdqid``
2062 Controller Data Queue ID (CDQID): For Create CDQ, this field is the CDQID created
2063 by the controller if no error is present. For Delete CDQ, this field is the CDQID
2064 to delete.
2065
2066 ``sel``
2067 Select (SEL): This field specifies the type of management operation to perform.
2068
2069 ``sz_u8``
2070 For Create CDQ, specifies the size of CDQ, in dwords - 1 byte
2071
2072 ``rsvd1``
2073 Reserved
2074
2075 ``sz``
2076 For Create CDQ, specifies the size of CDQ, in dwords - 4 byte
2077
2078
2079
2080
2081
2082 .. c:type:: struct nvme_lm_track_send_args
2083
2084 Arguments for the Track Send command
2085
2086 **Definition**
2087
2088 ::
2089
2090 struct nvme_lm_track_send_args {
2091 __u32 *result;
2092 int args_size;
2093 int fd;
2094 __u32 timeout;
2095 __u16 mos;
2096 __u16 cdqid;
2097 __u8 sel;
2098 };
2099
2100 **Members**
2101
2102 ``result``
2103 Set on completion to the command's CQE DWORD 0 controller response
2104
2105 ``args_size``
2106 Length of structure
2107
2108 ``fd``
2109 File descriptor of nvme device
2110
2111 ``timeout``
2112 Timeout in ms
2113
2114 ``mos``
2115 Management Operation Specific (MOS): This field is specific to the SEL type
2116
2117 ``cdqid``
2118 Controller Data Queue ID (CDQID)
2119
2120 ``sel``
2121 Select (SEL): This field specifies the type of management operation to perform
2122
2123
2124
2125
2126
2127 .. c:type:: struct nvme_lm_migration_send_args
2128
2129 Arguments for the Migration Send command
2130
2131 **Definition**
2132
2133 ::
2134
2135 struct nvme_lm_migration_send_args {
2136 __u64 offset;
2137 __u32 *result;
2138 void *data;
2139 int args_size;
2140 int fd;
2141 __u32 timeout;
2142 __u32 numd;
2143 __u16 mos;
2144 __u16 cntlid;
2145 __u16 csuuidi;
2146 __u8 sel;
2147 __u8 uidx;
2148 __u8 stype;
2149 __u8 seqind;
2150 __u8 csvi;
2151 bool dudmq;
2152 };
2153
2154 **Members**
2155
2156 ``offset``
2157 Offset: This field specifies the offset, in bytes, within the data available to be
2158 returned and specifies the starting point for that data for what is actually
2159 returned to the host.
2160
2161 ``result``
2162 Set on completion to the command's CQE DWORD 0 controller response
2163
2164 ``data``
2165 Pointer to data
2166
2167 ``args_size``
2168 Length of structure
2169
2170 ``fd``
2171 File descriptor of nvme device
2172
2173 ``timeout``
2174 Timeout in ms
2175
2176 ``numd``
2177 Number of Dwords (NUMD): This field specifies the number of dwords being transferred
2178
2179 ``mos``
2180 Management Operation Specific (MOS): This field is specific to the SEL type
2181
2182 ``cntlid``
2183 Controller ID: This field specifies the identifier of the controller to which the
2184 operation is performed.
2185
2186 ``csuuidi``
2187 Controller State UUID Index (CSUUIDI): A non-zero value in this field specifies the
2188 index to a specific entry in the Vendor Specific Controller State UUID Supported.
2189 list of the Supported Controller State Formats data structure.
2190
2191 ``sel``
2192 Select (SEL): This field specifies the type of management operation to perform.
2193
2194 ``uidx``
2195 UUID Index (UIDX): If this field is set to a non-zero value, then the value of this
2196 field is the index of a UUID in the UUID List (refer to Figure 320) that is used by
2197 the command.
2198
2199 ``stype``
2200 Suspend Type (STYPE): This field specifies the type of suspend.
2201
2202 ``seqind``
2203 Sequence Identifier (SEQIND): This field identified the sequences of this Migration
2204 Send command in relation to other Migration Send commands.
2205
2206 ``csvi``
2207 Controller State Version Index (CSVI): A non-zero value in this field specifies the
2208 index to a specific entry in the NVMe Controller State Version list of the Supported
2209 Controller State Formats data structure.
2210
2211 ``dudmq``
2212 Delete User Data Migration Queue (DUDMQ): If set, the migration queue is deleted
2213 is deleted as part of the Suspend operation. If cleared, it is retained.
2214
2215
2216
2217
2218
2219 .. c:type:: struct nvme_lm_migration_recv_args
2220
2221 Arguments for the Migration Receive command
2222
2223 **Definition**
2224
2225 ::
2226
2227 struct nvme_lm_migration_recv_args {
2228 __u64 offset;
2229 __u32 *result;
2230 void *data;
2231 int args_size;
2232 int fd;
2233 __u32 timeout;
2234 __u32 numd;
2235 __u16 mos;
2236 __u16 cntlid;
2237 __u16 csuuidi;
2238 __u8 sel;
2239 __u8 uidx;
2240 __u8 csuidxp;
2241 };
2242
2243 **Members**
2244
2245 ``offset``
2246 Offset: This field specifies the offset, in bytes, within the data available to be
2247 returned and specifies the starting point for that data for what is actually
2248 returned to the host.
2249
2250 ``result``
2251 Set on completion to the command's CQE DWORD 0 controller response
2252
2253 ``data``
2254 Pointer to data
2255
2256 ``args_size``
2257 Length of structure
2258
2259 ``fd``
2260 File descriptor of nvme device
2261
2262 ``timeout``
2263 Timeout in ms
2264
2265 ``numd``
2266 Number of Dwords (NUMD): This field specifies the number of dwords to return. This
2267 is a 0's based value.
2268
2269 ``mos``
2270 Management Operation Specific (MOS): This field is specific to the SEL type
2271
2272 ``cntlid``
2273 Controller ID: This field specifies the identifier of the controller to which the
2274 operation is performed.
2275
2276 ``csuuidi``
2277 Controller State UUID Index (CSUUIDI): A non-zero value in this field specifies the
2278 index to a specific entry in the Vendor Specific Controller State UUID Supported.
2279 list of the Supported Controller State Formats data structure.
2280
2281 ``sel``
2282 Select (SEL): This field specifies the type of management operation to perform
2283
2284 ``uidx``
2285 UUID Index (UIDX): If this field is set to a non-zero value, then the value of this
2286 field is the index of a UUID in the UUID List (refer to Figure 320) that is used by
2287 the command.
2288
2289 ``csuidxp``
2290 Controller State UUID Index Parameter (CSUIDXP): This field is vendor specific.
2291
2292
2293