Debian Codegraph @

doc/rst/types.rst

raw
1 .. _types.h:
2
3 **types.h**
4
5
6 NVMe standard definitions
7
8 .. c:function:: NVME_GET (value, name)
9
10 extract field from complex value
11
12 **Parameters**
13
14 ``value``
15 The original value of a complex field
16
17 ``name``
18 The name of the sub-field within an nvme value
19
20 **Description**
21
22 By convention, this library defines _SHIFT and _MASK such that mask can be
23 applied after the shift to isolate a specific set of bits that decode to a
24 sub-field.
25
26 **Return**
27
28 The 'name' field from 'value'
29
30
31 .. c:function:: NVME_SET (value, name)
32
33 set field into complex value
34
35 **Parameters**
36
37 ``value``
38 The value to be set in its completed position
39
40 ``name``
41 The name of the sub-field within an nvme value
42
43 **Return**
44
45 The 'name' field from 'value'
46
47
48 .. c:function:: NVME_CHECK (value, name, check)
49
50 check value to compare field value
51
52 **Parameters**
53
54 ``value``
55 The value to be checked
56
57 ``name``
58 The name of the sub-field within an nvme value
59
60 ``check``
61 The sub-field value to check
62
63 **Return**
64
65 The result of compare the value and the sub-field value
66
67
68 .. c:function:: NVME_VAL (name)
69
70 get mask value shifted
71
72 **Parameters**
73
74 ``name``
75 The name of the sub-field within an nvme value
76
77 **Return**
78
79 The mask value shifted
80
81
82
83
84 .. c:type:: enum nvme_constants
85
86 A place to stash various constant nvme values
87
88 **Constants**
89
90 ``NVME_NSID_ALL``
91 A broadcast value that is used to specify all
92 namespaces
93
94 ``NVME_NSID_NONE``
95 The invalid namespace id, for when the nsid
96 parameter is not used in a command
97
98 ``NVME_UUID_NONE``
99 Use to omit a uuid command parameter
100
101 ``NVME_CNTLID_NONE``
102 Use to omit a cntlid command parameter
103
104 ``NVME_CNSSPECID_NONE``
105 Use to omit a cns_specific_id command parameter
106
107 ``NVME_LOG_LSP_NONE``
108 Use to omit a log lsp command parameter
109
110 ``NVME_LOG_LSI_NONE``
111 Use to omit a log lsi command parameter
112
113 ``NVME_LOG_LPO_NONE``
114 Use to omit a log lpo command parameter
115
116 ``NVME_IDENTIFY_DATA_SIZE``
117 The transfer size for nvme identify commands
118
119 ``NVME_LOG_SUPPORTED_LOG_PAGES_MAX``
120 The largest possible index in the supported
121 log pages log.
122
123 ``NVME_ID_NVMSET_LIST_MAX``
124 The largest possible nvmset index in identify
125 nvmeset
126
127 ``NVME_ID_UUID_LIST_MAX``
128 The largest possible uuid index in identify
129 uuid list
130
131 ``NVME_ID_CTRL_LIST_MAX``
132 The largest possible controller index in
133 identify controller list
134
135 ``NVME_ID_NS_LIST_MAX``
136 The largest possible namespace index in
137 identify namespace list
138
139 ``NVME_ID_SECONDARY_CTRL_MAX``
140 The largest possible secondary controller index
141 in identify secondary controller
142
143 ``NVME_ID_DOMAIN_LIST_MAX``
144 The largest possible domain index in the
145 in domain list
146
147 ``NVME_ID_ENDURANCE_GROUP_LIST_MAX``
148 The largest possible endurance group
149 index in the endurance group list
150
151 ``NVME_ID_ND_DESCRIPTOR_MAX``
152 The largest possible namespace granularity
153 index in the namespace granularity descriptor
154 list
155
156 ``NVME_FEAT_LBA_RANGE_MAX``
157 The largest possible LBA range index in feature
158 lba range type
159
160 ``NVME_LOG_ST_MAX_RESULTS``
161 The largest possible self test result index in the
162 device self test log
163
164 ``NVME_LOG_TELEM_BLOCK_SIZE``
165 Specification defined size of Telemetry Data Blocks
166
167 ``NVME_LOG_FID_SUPPORTED_EFFECTS_MAX``
168 The largest possible FID index in the
169 feature identifiers effects log.
170
171 ``NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_MAX``
172 The largest possible MI Command index
173 in the MI Command effects log.
174
175 ``NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_RESERVED``
176 The reserved space in the MI Command
177 effects log.
178
179 ``NVME_DSM_MAX_RANGES``
180 The largest possible range index in a data-set
181 management command
182
183 ``NVME_NQN_LENGTH``
184 Max length for NVMe Qualified Name
185
186 ``NVMF_TRADDR_SIZE``
187 Max Transport Address size
188
189 ``NVMF_TSAS_SIZE``
190 Max Transport Specific Address Subtype size
191
192 ``NVME_ZNS_CHANGED_ZONES_MAX``
193 Max number of zones in the changed zones log
194 page
195
196 ``NVME_STREAM_ID_MAX``
197 Max number of stream IDs
198
199
200
201
202 .. c:type:: enum nvme_csi
203
204 Defined command set indicators
205
206 **Constants**
207
208 ``NVME_CSI_NVM``
209 NVM Command Set Indicator
210
211 ``NVME_CSI_KV``
212 Key Value Command Set
213
214 ``NVME_CSI_ZNS``
215 Zoned Namespace Command Set
216
217 ``NVME_CSI_SLM``
218 Subsystem Local Memory Command Set
219
220 ``NVME_CSI_CP``
221 Computational Programs Command Set
222
223
224
225
226 .. c:type:: enum nvme_register_offsets
227
228 controller registers for all transports. This is the layout of BAR0/1 for PCIe, and properties for fabrics.
229
230 **Constants**
231
232 ``NVME_REG_CAP``
233 Controller Capabilities
234
235 ``NVME_REG_VS``
236 Version
237
238 ``NVME_REG_INTMS``
239 Interrupt Mask Set
240
241 ``NVME_REG_INTMC``
242 Interrupt Mask Clear
243
244 ``NVME_REG_CC``
245 Controller Configuration
246
247 ``NVME_REG_CSTS``
248 Controller Status
249
250 ``NVME_REG_NSSR``
251 NVM Subsystem Reset
252
253 ``NVME_REG_AQA``
254 Admin Queue Attributes
255
256 ``NVME_REG_ASQ``
257 Admin SQ Base Address
258
259 ``NVME_REG_ACQ``
260 Admin CQ Base Address
261
262 ``NVME_REG_CMBLOC``
263 Controller Memory Buffer Location
264
265 ``NVME_REG_CMBSZ``
266 Controller Memory Buffer Size
267
268 ``NVME_REG_BPINFO``
269 Boot Partition Information
270
271 ``NVME_REG_BPRSEL``
272 Boot Partition Read Select
273
274 ``NVME_REG_BPMBL``
275 Boot Partition Memory Buffer Location
276
277 ``NVME_REG_CMBMSC``
278 Controller Memory Buffer Memory Space Control
279
280 ``NVME_REG_CMBSTS``
281 Controller Memory Buffer Status
282
283 ``NVME_REG_CMBEBS``
284 Controller Memory Buffer Elasticity Buffer Size
285
286 ``NVME_REG_CMBSWTP``
287 Controller Memory Buffer Sustained Write Throughput
288
289 ``NVME_REG_NSSD``
290 NVM Subsystem Shutdown
291
292 ``NVME_REG_CRTO``
293 Controller Ready Timeouts
294
295 ``NVME_REG_PMRCAP``
296 Persistent Memory Capabilities
297
298 ``NVME_REG_PMRCTL``
299 Persistent Memory Region Control
300
301 ``NVME_REG_PMRSTS``
302 Persistent Memory Region Status
303
304 ``NVME_REG_PMREBS``
305 Persistent Memory Region Elasticity Buffer Size
306
307 ``NVME_REG_PMRSWTP``
308 Memory Region Sustained Write Throughput
309
310 ``NVME_REG_PMRMSCL``
311 Persistent Memory Region Controller Memory Space Control Lower
312
313 ``NVME_REG_PMRMSCU``
314 Persistent Memory Region Controller Memory Space Control Upper
315
316
317 .. c:function:: bool nvme_is_64bit_reg (__u32 offset)
318
319 Checks if offset of the controller register is a know 64bit value.
320
321 **Parameters**
322
323 ``__u32 offset``
324 Offset of controller register field in bytes
325
326 **Description**
327
328 This function does not care about transport so that the offset is not going
329 to be checked inside of this function for the unsupported fields in a
330 specific transport. For example, BPMBL(Boot Partition Memory Buffer
331 Location) register is not supported by fabrics, but it can be checked here.
332
333 **Return**
334
335 true if given offset is 64bit register, otherwise it returns false.
336
337
338
339
340 .. c:type:: enum nvme_cap
341
342 This field indicates the controller capabilities register
343
344 **Constants**
345
346 ``NVME_CAP_MQES_SHIFT``
347 Shift amount to get the maximum queue entries supported
348
349 ``NVME_CAP_CQR_SHIFT``
350 Shift amount to get the contiguous queues required
351
352 ``NVME_CAP_AMS_SHIFT``
353 Shift amount to get the arbitration mechanism supported
354
355 ``NVME_CAP_TO_SHIFT``
356 Shift amount to get the timeout
357
358 ``NVME_CAP_DSTRD_SHIFT``
359 Shift amount to get the doorbell stride
360
361 ``NVME_CAP_NSSRC_SHIFT``
362 Shift amount to get the NVM subsystem reset supported
363
364 ``NVME_CAP_CSS_SHIFT``
365 Shift amount to get the command sets supported
366
367 ``NVME_CAP_BPS_SHIFT``
368 Shift amount to get the boot partition support
369
370 ``NVME_CAP_CPS_SHIFT``
371 Shift amount to get the controller power scope
372
373 ``NVME_CAP_MPSMIN_SHIFT``
374 Shift amount to get the memory page size minimum
375
376 ``NVME_CAP_MPSMAX_SHIFT``
377 Shift amount to get the memory page size maximum
378
379 ``NVME_CAP_PMRS_SHIFT``
380 Shift amount to get the persistent memory region supported
381
382 ``NVME_CAP_CMBS_SHIFT``
383 Shift amount to get the controller memory buffer supported
384
385 ``NVME_CAP_NSSS_SHIFT``
386 Shift amount to get the NVM subsystem shutdown supported
387
388 ``NVME_CAP_CRMS_SHIFT``
389 Shift amount to get the controller ready modes supported
390
391 ``NVME_CAP_MQES_MASK``
392 Mask to get the maximum queue entries supported
393
394 ``NVME_CAP_CQR_MASK``
395 Mask to get the contiguous queues required
396
397 ``NVME_CAP_AMS_MASK``
398 Mask to get the arbitration mechanism supported
399
400 ``NVME_CAP_TO_MASK``
401 Mask to get the timeout
402
403 ``NVME_CAP_DSTRD_MASK``
404 Mask to get the doorbell stride
405
406 ``NVME_CAP_NSSRC_MASK``
407 Mask to get the NVM subsystem reset supported
408
409 ``NVME_CAP_CSS_MASK``
410 Mask to get the command sets supported
411
412 ``NVME_CAP_BPS_MASK``
413 Mask to get the boot partition support
414
415 ``NVME_CAP_CPS_MASK``
416 Mask to get the controller power scope
417
418 ``NVME_CAP_MPSMIN_MASK``
419 Mask to get the memory page size minimum
420
421 ``NVME_CAP_MPSMAX_MASK``
422 Mask to get the memory page size maximum
423
424 ``NVME_CAP_PMRS_MASK``
425 Mask to get the persistent memory region supported
426
427 ``NVME_CAP_CMBS_MASK``
428 Mask to get the controller memory buffer supported
429
430 ``NVME_CAP_NSSS_MASK``
431 Mask to get the NVM subsystem shutdown supported
432
433 ``NVME_CAP_CRMS_MASK``
434 Mask to get the controller ready modes supported
435
436 ``NVME_CAP_AMS_WRR``
437 Weighted round robin with urgent priority class
438
439 ``NVME_CAP_AMS_VS``
440 Vendor specific
441
442 ``NVME_CAP_CSS_NVM``
443 NVM command set or a discovery controller
444
445 ``NVME_CAP_CSS_CSI``
446 Controller supports one or more I/O command sets
447
448 ``NVME_CAP_CSS_ADMIN``
449 No I/O command set is supported
450
451 ``NVME_CAP_CPS_NONE``
452 Not reported
453
454 ``NVME_CAP_CPS_CTRL``
455 Controller scope
456
457 ``NVME_CAP_CPS_DOMAIN``
458 Domain scope
459
460 ``NVME_CAP_CPS_NVMS``
461 NVM subsystem scope
462
463 ``NVME_CAP_CRWMS``
464 Controller ready with media support
465
466 ``NVME_CAP_CRIMS``
467 Controller ready independent of media support
468
469
470
471
472 .. c:type:: enum nvme_vs
473
474 This field indicates the version
475
476 **Constants**
477
478 ``NVME_VS_TER_SHIFT``
479 Shift amount to get the tertiary version
480
481 ``NVME_VS_MNR_SHIFT``
482 Shift amount to get the minor version
483
484 ``NVME_VS_MJR_SHIFT``
485 Shift amount to get the major version
486
487 ``NVME_VS_TER_MASK``
488 Mask to get the tertiary version
489
490 ``NVME_VS_MNR_MASK``
491 Mask to get the minor version
492
493 ``NVME_VS_MJR_MASK``
494 Mask to get the major version
495
496
497
498
499 .. c:type:: enum nvme_cc
500
501 This field indicates the controller configuration
502
503 **Constants**
504
505 ``NVME_CC_EN_SHIFT``
506 Shift amount to get the enable
507
508 ``NVME_CC_CSS_SHIFT``
509 Shift amount to get the I/O command set selected
510
511 ``NVME_CC_MPS_SHIFT``
512 Shift amount to get the memory page size
513
514 ``NVME_CC_AMS_SHIFT``
515 Shift amount to get the arbitration mechanism selected
516
517 ``NVME_CC_SHN_SHIFT``
518 Shift amount to get the shutdown notification
519
520 ``NVME_CC_IOSQES_SHIFT``
521 Shift amount to get the I/O submission queue entry size
522
523 ``NVME_CC_IOCQES_SHIFT``
524 Shift amount to get the I/O completion queue entry size
525
526 ``NVME_CC_CRIME_SHIFT``
527 Shift amount to get the controller ready independent of media enable
528
529 ``NVME_CC_EN_MASK``
530 Mask to get the enable
531
532 ``NVME_CC_CSS_MASK``
533 Mask to get the I/O command set selected
534
535 ``NVME_CC_MPS_MASK``
536 Mask to get the memory page size
537
538 ``NVME_CC_AMS_MASK``
539 Mask to get the arbitration mechanism selected
540
541 ``NVME_CC_SHN_MASK``
542 Mask to get the shutdown notification
543
544 ``NVME_CC_CRIME_MASK``
545 Mask to get the I/O submission queue entry size
546
547 ``NVME_CC_IOSQES_MASK``
548 Mask to get the I/O completion queue entry size
549
550 ``NVME_CC_IOCQES_MASK``
551 Mask to get the controller ready independent of media enable
552
553 ``NVME_CC_CSS_NVM``
554 NVM command set
555
556 ``NVME_CC_CSS_CSI``
557 All supported I/O command sets
558
559 ``NVME_CC_CSS_ADMIN``
560 Admin command set only
561
562 ``NVME_CC_AMS_RR``
563 Round robin
564
565 ``NVME_CC_AMS_WRRU``
566 Weighted round robin with urgent priority class
567
568 ``NVME_CC_AMS_VS``
569 Vendor specific
570
571 ``NVME_CC_SHN_NONE``
572 No notification; no effect
573
574 ``NVME_CC_SHN_NORMAL``
575 Normal shutdown notification
576
577 ``NVME_CC_SHN_ABRUPT``
578 Abrupt shutdown notification
579
580 ``NVME_CC_CRWME``
581 Controller ready with media enable
582
583 ``NVME_CC_CRIME``
584 Controller ready independent of media enable
585
586
587
588
589 .. c:type:: enum nvme_csts
590
591 This field indicates the controller status register
592
593 **Constants**
594
595 ``NVME_CSTS_RDY_SHIFT``
596 Shift amount to get the ready
597
598 ``NVME_CSTS_CFS_SHIFT``
599 Shift amount to get the controller fatal status
600
601 ``NVME_CSTS_SHST_SHIFT``
602 Shift amount to get the shutdown status
603
604 ``NVME_CSTS_NSSRO_SHIFT``
605 Shift amount to get the NVM subsystem reset occurred
606
607 ``NVME_CSTS_PP_SHIFT``
608 Shift amount to get the processing paused
609
610 ``NVME_CSTS_ST_SHIFT``
611 Shift amount to get the shutdown type
612
613 ``NVME_CSTS_RDY_MASK``
614 Mask to get the ready
615
616 ``NVME_CSTS_CFS_MASK``
617 Mask to get the controller fatal status
618
619 ``NVME_CSTS_SHST_MASK``
620 Mask to get the shutdown status
621
622 ``NVME_CSTS_NSSRO_MASK``
623 Mask to get the NVM subsystem reset occurred
624
625 ``NVME_CSTS_PP_MASK``
626 Mask to get the processing paused
627
628 ``NVME_CSTS_ST_MASK``
629 Mask to get the shutdown type
630
631 ``NVME_CSTS_SHST_NORMAL``
632 Normal operation
633
634 ``NVME_CSTS_SHST_OCCUR``
635 Shutdown processing occurring
636
637 ``NVME_CSTS_SHST_CMPLT``
638 Shutdown processing complete
639
640 ``NVME_CSTS_SHN_MASK``
641 Deprecated mask to get the shutdown status
642
643
644
645
646 .. c:type:: enum nvme_aqa
647
648 This field indicates the admin queue attributes
649
650 **Constants**
651
652 ``NVME_AQA_ASQS_SHIFT``
653 Shift amount to get the admin submission queue size
654
655 ``NVME_AQA_ACQS_SHIFT``
656 Shift amount to get the admin completion queue size
657
658 ``NVME_AQA_ASQS_MASK``
659 Mask to get the admin submission queue size
660
661 ``NVME_AQA_ACQS_MASK``
662 Mask to get the admin completion queue size
663
664
665
666
667 .. c:type:: enum nvme_asq
668
669 This field indicates the admin submission queue base address
670
671 **Constants**
672
673 ``NVME_ASQ_ASQB_SHIFT``
674 Shift amount to get the admin submission queue base
675
676
677
678
679 .. c:type:: enum nvme_acq
680
681 This field indicates the admin completion queue base address
682
683 **Constants**
684
685 ``NVME_ACQ_ACQB_SHIFT``
686 Shift amount to get the admin completion queue base
687
688
689
690
691 .. c:type:: enum nvme_cmbloc
692
693 This field indicates the controller memory buffer location
694
695 **Constants**
696
697 ``NVME_CMBLOC_BIR_SHIFT``
698 Shift amount to get the base indicator register
699
700 ``NVME_CMBLOC_CQMMS_SHIFT``
701 Shift amount to get the CMB queue mixed memory support
702
703 ``NVME_CMBLOC_CQPDS_SHIFT``
704 Shift amount to get the CMB queue physically discontiguous support
705
706 ``NVME_CMBLOC_CDPLMS_SHIFT``
707 Shift amount to get the CMB data pointer mixed locations support
708
709 ``NVME_CMBLOC_CDPCILS_SHIFT``
710 Shift amount to get the CMB data pointer and command independent locations support
711
712 ``NVME_CMBLOC_CDMMMS_SHIFT``
713 Shift amount to get the CMB data metadata mixed memory support
714
715 ``NVME_CMBLOC_CQDA_SHIFT``
716 Shift amount to get the CMB queue dword alignment
717
718 ``NVME_CMBLOC_OFST_SHIFT``
719 Shift amount to get the offset
720
721 ``NVME_CMBLOC_BIR_MASK``
722 Mask to get the base indicator register
723
724 ``NVME_CMBLOC_CQMMS_MASK``
725 Mask to get the CMB queue mixed memory support
726
727 ``NVME_CMBLOC_CQPDS_MASK``
728 Mask to get the CMB queue physically discontiguous support
729
730 ``NVME_CMBLOC_CDPLMS_MASK``
731 Mask to get the CMB data pointer mixed locations support
732
733 ``NVME_CMBLOC_CDPCILS_MASK``
734 Mask to get the CMB data pointer and command independent locations support
735
736 ``NVME_CMBLOC_CDMMMS_MASK``
737 Mask to get the CMB data metadata mixed memory support
738
739 ``NVME_CMBLOC_CQDA_MASK``
740 Mask to get the CMB queue dword alignment
741
742 ``NVME_CMBLOC_OFST_MASK``
743 Mask to get the offset
744
745
746
747
748 .. c:type:: enum nvme_cmbsz
749
750 This field indicates the controller memory buffer size
751
752 **Constants**
753
754 ``NVME_CMBSZ_SQS_SHIFT``
755 Shift amount to get the submission queue support
756
757 ``NVME_CMBSZ_CQS_SHIFT``
758 Shift amount to get the completion queue support
759
760 ``NVME_CMBSZ_LISTS_SHIFT``
761 Shift amount to get the PLP SGL list support
762
763 ``NVME_CMBSZ_RDS_SHIFT``
764 Shift amount to get the read data support
765
766 ``NVME_CMBSZ_WDS_SHIFT``
767 Shift amount to get the write data support
768
769 ``NVME_CMBSZ_SZU_SHIFT``
770 Shift amount to get the size units
771
772 ``NVME_CMBSZ_SZ_SHIFT``
773 Shift amount to get the size
774
775 ``NVME_CMBSZ_SQS_MASK``
776 Mask to get the submission queue support
777
778 ``NVME_CMBSZ_CQS_MASK``
779 Mask to get the completion queue support
780
781 ``NVME_CMBSZ_LISTS_MASK``
782 Mask to get the PLP SGL list support
783
784 ``NVME_CMBSZ_RDS_MASK``
785 Mask to get the read data support
786
787 ``NVME_CMBSZ_WDS_MASK``
788 Mask to get the write data support
789
790 ``NVME_CMBSZ_SZU_MASK``
791 Mask to get the size units
792
793 ``NVME_CMBSZ_SZ_MASK``
794 Mask to get the size
795
796 ``NVME_CMBSZ_SZU_4K``
797 4 KiB
798
799 ``NVME_CMBSZ_SZU_64K``
800 64 KiB
801
802 ``NVME_CMBSZ_SZU_1M``
803 1 MiB
804
805 ``NVME_CMBSZ_SZU_16M``
806 16 MiB
807
808 ``NVME_CMBSZ_SZU_256M``
809 256 MiB
810
811 ``NVME_CMBSZ_SZU_4G``
812 4 GiB
813
814 ``NVME_CMBSZ_SZU_64G``
815 64 GiB
816
817
818 .. c:function:: __u64 nvme_cmb_size (__u32 cmbsz)
819
820 Calculate size of the controller memory buffer
821
822 **Parameters**
823
824 ``__u32 cmbsz``
825 Value from controller register ``NVME_REG_CMBSZ``
826
827 **Return**
828
829 size of controller memory buffer in bytes
830
831
832
833
834 .. c:type:: enum nvme_bpinfo
835
836 This field indicates the boot partition information
837
838 **Constants**
839
840 ``NVME_BPINFO_BPSZ_SHIFT``
841 Shift amount to get the boot partition size
842
843 ``NVME_BPINFO_BRS_SHIFT``
844 Shift amount to get the boot read status
845
846 ``NVME_BPINFO_ABPID_SHIFT``
847 Shift amount to get the active boot partition ID
848
849 ``NVME_BPINFO_BPSZ_MASK``
850 Mask to get the boot partition size
851
852 ``NVME_BPINFO_BRS_MASK``
853 Mask to get the boot read status
854
855 ``NVME_BPINFO_ABPID_MASK``
856 Mask to get the active boot partition ID
857
858 ``NVME_BPINFO_BRS_NONE``
859 No boot partition read operation requested
860
861 ``NVME_BPINFO_BRS_READ_IN_PROGRESS``
862 Boot partition read in progress
863
864 ``NVME_BPINFO_BRS_READ_SUCCESS``
865 Boot partition read completed successfully
866
867 ``NVME_BPINFO_BRS_READ_ERROR``
868 Error completing boot partition read
869
870
871
872
873 .. c:type:: enum nvme_bprsel
874
875 This field indicates the boot partition read select
876
877 **Constants**
878
879 ``NVME_BPRSEL_BPRSZ_SHIFT``
880 Shift amount to get the boot partition read size
881
882 ``NVME_BPRSEL_BPROF_SHIFT``
883 Shift amount to get the boot partition read offset
884
885 ``NVME_BPRSEL_BPID_SHIFT``
886 Shift amount to get the boot partition identifier
887
888 ``NVME_BPRSEL_BPRSZ_MASK``
889 Mask to get the boot partition read size
890
891 ``NVME_BPRSEL_BPROF_MASK``
892 Mask to get the boot partition read offset
893
894 ``NVME_BPRSEL_BPID_MASK``
895 Mask to get the boot partition identifier
896
897
898
899
900 .. c:type:: enum nvme_bpmbl
901
902 This field indicates the boot partition memory buffer location
903
904 **Constants**
905
906 ``NVME_BPMBL_BMBBA_SHIFT``
907 Shift amount to get the boot partition memory buffer base address
908
909
910
911
912 .. c:type:: enum nvme_cmbmsc
913
914 This field indicates the controller memory buffer memory space control
915
916 **Constants**
917
918 ``NVME_CMBMSC_CRE_SHIFT``
919 Shift amount to get the capabilities registers enabled
920
921 ``NVME_CMBMSC_CMSE_SHIFT``
922 Shift amount to get the controller memory space enable
923
924 ``NVME_CMBMSC_CBA_SHIFT``
925 Shift amount to get the controller base address
926
927 ``NVME_CMBMSC_CRE_MASK``
928 Mask to get the capabilities registers enabled
929
930 ``NVME_CMBMSC_CMSE_MASK``
931 Mask to get the controller memory space enable
932
933
934
935
936 .. c:type:: enum nvme_cmbsts
937
938 This field indicates the controller memory buffer status
939
940 **Constants**
941
942 ``NVME_CMBSTS_CBAI_SHIFT``
943 Shift amount to get the controller base address invalid
944
945 ``NVME_CMBSTS_CBAI_MASK``
946 Mask to get the controller base address invalid
947
948
949
950
951 .. c:type:: enum nvme_unit
952
953 Defined buffer size and write throughput granularity units
954
955 **Constants**
956
957 ``NVME_UNIT_B``
958 Bytes or Bytes/second
959
960 ``NVME_UNIT_1K``
961 1 KiB or 1 KiB/second
962
963 ``NVME_UNIT_1M``
964 1 MiB or 1 MiB/second
965
966 ``NVME_UNIT_1G``
967 1 GiB or 1 GiB/second
968
969
970
971
972 .. c:type:: enum nvme_cmbebs
973
974 This field indicates the controller memory buffer elasticity buffer size
975
976 **Constants**
977
978 ``NVME_CMBEBS_CMBSZU_SHIFT``
979 Shift amount to get the CMB elasticity buffer size units
980
981 ``NVME_CMBEBS_RBB_SHIFT``
982 Shift amount to get the read bypass behavior
983
984 ``NVME_CMBEBS_CMBWBZ_SHIFT``
985 Shift amount to get the CMB elasiticity buffer size base
986
987 ``NVME_CMBEBS_CMBSZU_MASK``
988 Mask to get the CMB elasticity buffer size units
989
990 ``NVME_CMBEBS_RBB_MASK``
991 Mask to get the read bypass behavior
992
993 ``NVME_CMBEBS_CMBWBZ_MASK``
994 Mask to get the CMB elasiticity buffer size base
995
996 ``NVME_CMBEBS_CMBSZU_B``
997 Bytes granularity
998
999 ``NVME_CMBEBS_CMBSZU_1K``
1000 1 KiB granularity
1001
1002 ``NVME_CMBEBS_CMBSZU_1M``
1003 1 MiB granularity
1004
1005 ``NVME_CMBEBS_CMBSZU_1G``
1006 1 GiB granularity
1007
1008
1009
1010
1011 .. c:type:: enum nvme_cmbswtp
1012
1013 This field indicates the controller memory buffer sustained write throughput
1014
1015 **Constants**
1016
1017 ``NVME_CMBSWTP_CMBSWTU_SHIFT``
1018 Shift amount to get the CMB sustained write throughput units
1019
1020 ``NVME_CMBSWTP_CMBSWTV_SHIFT``
1021 Shift amount to get the CMB sustained write throughput
1022
1023 ``NVME_CMBSWTP_CMBSWTU_MASK``
1024 Mask to get the CMB sustained write throughput units
1025
1026 ``NVME_CMBSWTP_CMBSWTV_MASK``
1027 Mask to get the CMB sustained write throughput
1028
1029 ``NVME_CMBSWTP_CMBSWTU_B``
1030 Bytes/second granularity
1031
1032 ``NVME_CMBSWTP_CMBSWTU_1K``
1033 1 KiB/second granularity
1034
1035 ``NVME_CMBSWTP_CMBSWTU_1M``
1036 1 MiB/second granularity
1037
1038 ``NVME_CMBSWTP_CMBSWTU_1G``
1039 1 GiB/second granularity
1040
1041
1042
1043
1044 .. c:type:: enum nvme_crto
1045
1046 This field indicates the controller ready timeouts
1047
1048 **Constants**
1049
1050 ``NVME_CRTO_CRWMT_SHIFT``
1051 Shift amount to get the controller ready with media timeout
1052
1053 ``NVME_CRTO_CRIMT_SHIFT``
1054 Shift amount to get the controller ready independent of media timeout
1055
1056 ``NVME_CRTO_CRWMT_MASK``
1057 Mask to get the controller ready with media timeout
1058
1059 ``NVME_CRTO_CRIMT_MASK``
1060 Mask to get the controller ready independent of media timeout
1061
1062
1063
1064
1065 .. c:type:: enum nvme_pmrcap
1066
1067 This field indicates the persistent memory region capabilities
1068
1069 **Constants**
1070
1071 ``NVME_PMRCAP_RDS_SHIFT``
1072 Shift amount to get the read data support
1073
1074 ``NVME_PMRCAP_WDS_SHIFT``
1075 Shift amount to get the write data support
1076
1077 ``NVME_PMRCAP_BIR_SHIFT``
1078 Shift amount to get the base indicator register
1079
1080 ``NVME_PMRCAP_PMRTU_SHIFT``
1081 Shift amount to get the persistent memory region time units
1082
1083 ``NVME_PMRCAP_PMRWBM_SHIFT``
1084 Shift amount to get the persistent memory region write barrier mechanisms
1085
1086 ``NVME_PMRCAP_PMRTO_SHIFT``
1087 Shift amount to get the persistent memory region timeout
1088
1089 ``NVME_PMRCAP_CMSS_SHIFT``
1090 Shift amount to get the controller memory space supported
1091
1092 ``NVME_PMRCAP_PMRWMB_SHIFT``
1093 Deprecated shift amount to get the persistent memory region write barrier mechanisms
1094
1095 ``NVME_PMRCAP_RDS_MASK``
1096 Mask to get the read data support
1097
1098 ``NVME_PMRCAP_WDS_MASK``
1099 Mask to get the write data support
1100
1101 ``NVME_PMRCAP_BIR_MASK``
1102 Mask to get the base indicator register
1103
1104 ``NVME_PMRCAP_PMRTU_MASK``
1105 Mask to get the persistent memory region time units
1106
1107 ``NVME_PMRCAP_PMRWBM_MASK``
1108 Mask to get the persistent memory region write barrier mechanisms
1109
1110 ``NVME_PMRCAP_PMRTO_MASK``
1111 Mask to get the persistent memory region timeout
1112
1113 ``NVME_PMRCAP_CMSS_MASK``
1114 Mask to get the controller memory space supported
1115
1116 ``NVME_PMRCAP_PMRWMB_MASK``
1117 Deprecated mask to get the persistent memory region write barrier mechanisms
1118
1119 ``NVME_PMRCAP_PMRTU_500MS``
1120 500 milliseconds
1121
1122 ``NVME_PMRCAP_PMRTU_60S``
1123 minutes
1124
1125
1126
1127
1128 .. c:type:: enum nvme_pmrctl
1129
1130 This field indicates the persistent memory region control
1131
1132 **Constants**
1133
1134 ``NVME_PMRCTL_EN_SHIFT``
1135 Shift amount to get the enable
1136
1137 ``NVME_PMRCTL_EN_MASK``
1138 Mask to get the enable
1139
1140
1141
1142
1143 .. c:type:: enum nvme_pmrsts
1144
1145 This field indicates the persistent memory region status
1146
1147 **Constants**
1148
1149 ``NVME_PMRSTS_ERR_SHIFT``
1150 Shift amount to get the error
1151
1152 ``NVME_PMRSTS_NRDY_SHIFT``
1153 Shift amount to get the not ready
1154
1155 ``NVME_PMRSTS_HSTS_SHIFT``
1156 Shift amount to get the health status
1157
1158 ``NVME_PMRSTS_CBAI_SHIFT``
1159 Shift amount to get the controller base address invalid
1160
1161 ``NVME_PMRSTS_ERR_MASK``
1162 Mask to get the error
1163
1164 ``NVME_PMRSTS_NRDY_MASK``
1165 Mask to get the not ready
1166
1167 ``NVME_PMRSTS_HSTS_MASK``
1168 Mask to get the health status
1169
1170 ``NVME_PMRSTS_CBAI_MASK``
1171 Mask to get the controller base address invalid
1172
1173
1174
1175
1176 .. c:type:: enum nvme_pmrebs
1177
1178 This field indicates the persistent memory region elasticity buffer size
1179
1180 **Constants**
1181
1182 ``NVME_PMREBS_PMRSZU_SHIFT``
1183 Shift amount to get the PMR elasticity buffer size units
1184
1185 ``NVME_PMREBS_RBB_SHIFT``
1186 Shift amount to get the read bypass behavior
1187
1188 ``NVME_PMREBS_PMRWBZ_SHIFT``
1189 Shift amount to get the PMR elasticity buffer size base
1190
1191 ``NVME_PMREBS_PMRSZU_MASK``
1192 Mask to get the PMR elasticity buffer size units
1193
1194 ``NVME_PMREBS_RBB_MASK``
1195 Mask to get the read bypass behavior
1196
1197 ``NVME_PMREBS_PMRWBZ_MASK``
1198 Mask to get the PMR elasticity buffer size base
1199
1200 ``NVME_PMREBS_PMRSZU_B``
1201 Bytes
1202
1203 ``NVME_PMREBS_PMRSZU_1K``
1204 1 KiB
1205
1206 ``NVME_PMREBS_PMRSZU_1M``
1207 1 MiB
1208
1209 ``NVME_PMREBS_PMRSZU_1G``
1210 1 GiB
1211
1212
1213 .. c:function:: __u64 nvme_pmr_size (__u32 pmrebs)
1214
1215 Calculate size of persistent memory region elasticity buffer
1216
1217 **Parameters**
1218
1219 ``__u32 pmrebs``
1220 Value from controller register ``NVME_REG_PMREBS``
1221
1222 **Return**
1223
1224 size of controller persistent memory buffer in bytes
1225
1226
1227
1228
1229 .. c:type:: enum nvme_pmrswtp
1230
1231 This field indicates the persistent memory region sustained write throughput
1232
1233 **Constants**
1234
1235 ``NVME_PMRSWTP_PMRSWTU_SHIFT``
1236 Shift amount to get the PMR sustained write throughput units
1237
1238 ``NVME_PMRSWTP_PMRSWTV_SHIFT``
1239 Shift amount to get the PMR sustained write throughput
1240
1241 ``NVME_PMRSWTP_PMRSWTU_MASK``
1242 Mask to get the PMR sustained write throughput units
1243
1244 ``NVME_PMRSWTP_PMRSWTV_MASK``
1245 Mask to get the PMR sustained write throughput
1246
1247 ``NVME_PMRSWTP_PMRSWTU_BPS``
1248 Bytes per second
1249
1250 ``NVME_PMRSWTP_PMRSWTU_KBPS``
1251 1 KiB / s
1252
1253 ``NVME_PMRSWTP_PMRSWTU_MBPS``
1254 1 MiB / s
1255
1256 ``NVME_PMRSWTP_PMRSWTU_GBPS``
1257 1 GiB / s
1258
1259
1260 .. c:function:: __u64 nvme_pmr_throughput (__u32 pmrswtp)
1261
1262 Calculate throughput of persistent memory buffer
1263
1264 **Parameters**
1265
1266 ``__u32 pmrswtp``
1267 Value from controller register ``NVME_REG_PMRSWTP``
1268
1269 **Return**
1270
1271 throughput of controller persistent memory buffer in bytes/second
1272
1273
1274
1275
1276 .. c:type:: enum nvme_pmrmsc
1277
1278 This field indicates the persistent memory region memory space control
1279
1280 **Constants**
1281
1282 ``NVME_PMRMSC_CMSE_SHIFT``
1283 Shift amount to get the controller memory space enable
1284
1285 ``NVME_PMRMSC_CBA_SHIFT``
1286 Shift amount to get the controller base address
1287
1288 ``NVME_PMRMSC_CMSE_MASK``
1289 Mask to get the controller memory space enable
1290
1291
1292
1293
1294 .. c:type:: enum nvme_flbas
1295
1296 This field indicates the formatted LBA size
1297
1298 **Constants**
1299
1300 ``NVME_FLBAS_LOWER_SHIFT``
1301 Shift amount to get the format index least significant 4 bits
1302
1303 ``NVME_FLBAS_META_EXT_SHIFT``
1304 Shift amount to get the metadata transferred
1305
1306 ``NVME_FLBAS_HIGHER_SHIFT``
1307 Shift amount to get the format index most significant 2 bits
1308
1309 ``NVME_FLBAS_LOWER_MASK``
1310 Mask to get the format index least significant 4 bits
1311
1312 ``NVME_FLBAS_META_EXT_MASK``
1313 Mask to get the metadata transferred
1314
1315 ``NVME_FLBAS_HIGHER_MASK``
1316 Mask to get the format index most significant 2 bits
1317
1318
1319
1320
1321 .. c:type:: enum nvme_psd_flags
1322
1323 Possible flag values in nvme power state descriptor
1324
1325 **Constants**
1326
1327 ``NVME_PSD_FLAGS_MXPS``
1328 Indicates the scale for the Maximum Power
1329 field. If this bit is cleared, then the scale of the
1330 Maximum Power field is in 0.01 Watts. If this bit is
1331 set, then the scale of the Maximum Power field is in
1332 0.0001 Watts.
1333
1334 ``NVME_PSD_FLAGS_NOPS``
1335 Indicates whether the controller processes I/O
1336 commands in this power state. If this bit is cleared,
1337 then the controller processes I/O commands in this
1338 power state. If this bit is set, then the controller
1339 does not process I/O commands in this power state.
1340
1341
1342
1343
1344 .. c:type:: enum nvme_psd_ps
1345
1346 Known values for :c:type:`struct nvme_psd <nvme_psd>` ``ips`` and ``aps``. Use with nvme_psd_power_scale() to extract the power scale field to match this enum.
1347
1348 **Constants**
1349
1350 ``NVME_PSD_PS_NOT_REPORTED``
1351 Not reported
1352
1353 ``NVME_PSD_PS_100_MICRO_WATT``
1354 0.0001 watt scale
1355
1356 ``NVME_PSD_PS_10_MILLI_WATT``
1357 0.01 watt scale
1358
1359
1360 .. c:function:: unsigned int nvme_psd_power_scale (__u8 ps)
1361
1362 power scale occupies the upper 3 bits
1363
1364 **Parameters**
1365
1366 ``__u8 ps``
1367 power scale value
1368
1369 **Return**
1370
1371 power scale value
1372
1373
1374
1375
1376 .. c:type:: enum nvme_psd_workload
1377
1378 Specifies a workload hint in the Power Management Feature (see :c:type:`struct nvme_psd <nvme_psd>`.apw) to inform the NVM subsystem or indicate the conditions for the active power level.
1379
1380 **Constants**
1381
1382 ``NVME_PSD_WORKLOAD_NP``
1383 The workload is unknown or not provided.
1384
1385 ``NVME_PSD_WORKLOAD_1``
1386 Extended Idle Period with a Burst of Random Write
1387 consists of five minutes of idle followed by
1388 thirty-two random write commands of size 1 MiB
1389 submitted to a single controller while all other
1390 controllers in the NVM subsystem are idle, and then
1391 thirty (30) seconds of idle.
1392
1393 ``NVME_PSD_WORKLOAD_2``
1394 Heavy Sequential Writes consists of 80,000
1395 sequential write commands of size 128 KiB submitted to
1396 a single controller while all other controllers in the
1397 NVM subsystem are idle. The submission queue(s)
1398 should be sufficiently large allowing the host to
1399 ensure there are multiple commands pending at all
1400 times during the workload.
1401
1402
1403
1404
1405 .. c:type:: struct nvme_id_psd
1406
1407 Power Management data structure
1408
1409 **Definition**
1410
1411 ::
1412
1413 struct nvme_id_psd {
1414 __le16 mp;
1415 __u8 rsvd2;
1416 __u8 flags;
1417 __le32 enlat;
1418 __le32 exlat;
1419 __u8 rrt;
1420 __u8 rrl;
1421 __u8 rwt;
1422 __u8 rwl;
1423 __le16 idlp;
1424 __u8 ips;
1425 __u8 rsvd19;
1426 __le16 actp;
1427 __u8 apws;
1428 __u8 epfrt;
1429 __u8 fqvt;
1430 __u8 epfvt;
1431 __u8 epfr_fqv_ts;
1432 __u8 epfvts;
1433 __u8 rsvd28[4];
1434 };
1435
1436 **Members**
1437
1438 ``mp``
1439 Maximum Power indicates the sustained maximum power consumed by the
1440 NVM subsystem in this power state. The power in Watts is equal to
1441 the value in this field multiplied by the scale specified in the Max
1442 Power Scale bit (see :c:type:`enum nvme_psd_flags <nvme_psd_flags>`). A value of 0 indicates
1443 Maximum Power is not reported.
1444
1445 ``rsvd2``
1446 Reserved
1447
1448 ``flags``
1449 Additional decoding flags, see :c:type:`enum nvme_psd_flags <nvme_psd_flags>`.
1450
1451 ``enlat``
1452 Entry Latency indicates the maximum latency in microseconds
1453 associated with entering this power state. A value of 0 indicates
1454 Entry Latency is not reported.
1455
1456 ``exlat``
1457 Exit Latency indicates the maximum latency in microseconds
1458 associated with exiting this power state. A value of 0 indicates
1459 Exit Latency is not reported.
1460
1461 ``rrt``
1462 Relative Read Throughput indicates the read throughput rank
1463 associated with this power state relative to others. The value in
1464 this is less than the number of supported power states.
1465
1466 ``rrl``
1467 Relative Read Latency indicates the read latency rank associated
1468 with this power state relative to others. The value in this field is
1469 less than the number of supported power states.
1470
1471 ``rwt``
1472 Relative Write Throughput indicates write throughput rank associated
1473 with this power state relative to others. The value in this field is
1474 less than the number of supported power states
1475
1476 ``rwl``
1477 Relative Write Latency indicates the write latency rank associated
1478 with this power state relative to others. The value in this field is
1479 less than the number of supported power states
1480
1481 ``idlp``
1482 Idle Power indicates the typical power consumed by the NVM
1483 subsystem over 30 seconds in this power state when idle.
1484
1485 ``ips``
1486 Idle Power Scale indicates the scale for :c:type:`struct nvme_id_psd <nvme_id_psd>`.idlp,
1487 see :c:type:`enum nvme_psd_ps <nvme_psd_ps>` for decoding this field.
1488
1489 ``rsvd19``
1490 Reserved
1491
1492 ``actp``
1493 Active Power indicates the largest average power consumed by the
1494 NVM subsystem over a 10 second period in this power state with
1495 the workload indicated in the Active Power Workload field.
1496
1497 ``apws``
1498 Bits 7-6: Active Power Scale(APS) indicates the scale for the :c:type:`struct
1499 nvme_id_psd <nvme_id_psd>`.actp, see :c:type:`enum nvme_psd_ps <nvme_psd_ps>` for decoding this value.
1500 Bits 2-0: Active Power Workload(APW) indicates the workload
1501 used to calculate maximum power for this power state.
1502 See :c:type:`enum nvme_psd_workload <nvme_psd_workload>` for decoding this field.
1503
1504 ``epfrt``
1505 Emergency power fail recovery time
1506
1507 ``fqvt``
1508 Forced quiescence vault time
1509
1510 ``epfvt``
1511 Emergency power fail vault time
1512
1513 ``epfr_fqv_ts``
1514 Bits 7-4: Forced quiescence vault time scale
1515 Bits 3-0: Emergency power fail recovery time scale
1516
1517 ``epfvts``
1518 Bits 3-0: Emergency power fail vault time scale
1519
1520 ``rsvd28``
1521 Reserved
1522
1523
1524
1525
1526
1527 .. c:type:: struct nvme_id_ctrl
1528
1529 Identify Controller data structure
1530
1531 **Definition**
1532
1533 ::
1534
1535 struct nvme_id_ctrl {
1536 __le16 vid;
1537 __le16 ssvid;
1538 char sn[20];
1539 char mn[40];
1540 char fr[8];
1541 __u8 rab;
1542 __u8 ieee[3];
1543 __u8 cmic;
1544 __u8 mdts;
1545 __le16 cntlid;
1546 __le32 ver;
1547 __le32 rtd3r;
1548 __le32 rtd3e;
1549 __le32 oaes;
1550 __le32 ctratt;
1551 __le16 rrls;
1552 __u8 bpcap;
1553 __u8 rsvd103;
1554 __le32 nssl;
1555 __u8 rsvd108[2];
1556 __u8 plsi;
1557 __u8 cntrltype;
1558 __u8 fguid[16];
1559 __le16 crdt1;
1560 __le16 crdt2;
1561 __le16 crdt3;
1562 __u8 crcap;
1563 __u8 rsvd135[118];
1564 __u8 nvmsr;
1565 __u8 vwci;
1566 __u8 mec;
1567 __le16 oacs;
1568 __u8 acl;
1569 __u8 aerl;
1570 __u8 frmw;
1571 __u8 lpa;
1572 __u8 elpe;
1573 __u8 npss;
1574 __u8 avscc;
1575 __u8 apsta;
1576 __le16 wctemp;
1577 __le16 cctemp;
1578 __le16 mtfa;
1579 __le32 hmpre;
1580 __le32 hmmin;
1581 __u8 tnvmcap[16];
1582 __u8 unvmcap[16];
1583 __le32 rpmbs;
1584 __le16 edstt;
1585 __u8 dsto;
1586 __u8 fwug;
1587 __le16 kas;
1588 __le16 hctma;
1589 __le16 mntmt;
1590 __le16 mxtmt;
1591 __le32 sanicap;
1592 __le32 hmminds;
1593 __le16 hmmaxd;
1594 __le16 nsetidmax;
1595 __le16 endgidmax;
1596 __u8 anatt;
1597 __u8 anacap;
1598 __le32 anagrpmax;
1599 __le32 nanagrpid;
1600 __le32 pels;
1601 __le16 domainid;
1602 __u8 kpioc;
1603 __u8 rsvd359;
1604 __le16 mptfawr;
1605 __u8 rsvd362[6];
1606 __u8 megcap[16];
1607 __u8 tmpthha;
1608 __u8 rsvd385;
1609 __le16 cqt;
1610 __u8 rsvd388[124];
1611 __u8 sqes;
1612 __u8 cqes;
1613 __le16 maxcmd;
1614 __le32 nn;
1615 __le16 oncs;
1616 __le16 fuses;
1617 __u8 fna;
1618 __u8 vwc;
1619 __le16 awun;
1620 __le16 awupf;
1621 __u8 icsvscc;
1622 __u8 nwpc;
1623 __le16 acwu;
1624 __le16 ocfs;
1625 __le32 sgls;
1626 __le32 mnan;
1627 __u8 maxdna[16];
1628 __le32 maxcna;
1629 __le32 oaqd;
1630 __u8 rhiri;
1631 __u8 hirt;
1632 __le16 cmmrtd;
1633 __le16 nmmrtd;
1634 __u8 minmrtg;
1635 __u8 maxmrtg;
1636 __u8 trattr;
1637 __u8 rsvd577;
1638 __le16 mcudmq;
1639 __le16 mnsudmq;
1640 __le16 mcmr;
1641 __le16 nmcmr;
1642 __le16 mcdqpc;
1643 __u8 rsvd588[180];
1644 char subnqn[NVME_NQN_LENGTH];
1645 __u8 rsvd1024[768];
1646 __le32 ioccsz;
1647 __le32 iorcsz;
1648 __le16 icdoff;
1649 __u8 fcatt;
1650 __u8 msdbd;
1651 __le16 ofcs;
1652 __u8 dctype;
1653 __u8 rsvd1807[241];
1654 struct nvme_id_psd psd[32];
1655 __u8 vs[1024];
1656 };
1657
1658 **Members**
1659
1660 ``vid``
1661 PCI Vendor ID, the company vendor identifier that is assigned by
1662 the PCI SIG.
1663
1664 ``ssvid``
1665 PCI Subsystem Vendor ID, the company vendor identifier that is
1666 assigned by the PCI SIG for the subsystem.
1667
1668 ``sn``
1669 Serial Number in ASCII
1670
1671 ``mn``
1672 Model Number in ASCII
1673
1674 ``fr``
1675 Firmware Revision in ASCII, the currently active firmware
1676 revision for the NVM subsystem
1677
1678 ``rab``
1679 Recommended Arbitration Burst, reported as a power of two
1680
1681 ``ieee``
1682 IEEE assigned Organization Unique Identifier
1683
1684 ``cmic``
1685 Controller Multipath IO and Namespace Sharing Capabilities of
1686 the controller and NVM subsystem. See :c:type:`enum nvme_id_ctrl_cmic <nvme_id_ctrl_cmic>`.
1687
1688 ``mdts``
1689 Max Data Transfer Size is the largest data transfer size. The
1690 host should not submit a command that exceeds this maximum data
1691 transfer size. The value is in units of the minimum memory page
1692 size (CAP.MPSMIN) and is reported as a power of two
1693
1694 ``cntlid``
1695 Controller ID, the NVM subsystem unique controller identifier
1696 associated with the controller.
1697
1698 ``ver``
1699 Version, this field contains the value reported in the Version
1700 register, or property (see :c:type:`enum nvme_registers <nvme_registers>` ``NVME_REG_VS``).
1701
1702 ``rtd3r``
1703 RTD3 Resume Latency, the expected latency in microseconds to resume
1704 from Runtime D3
1705
1706 ``rtd3e``
1707 RTD3 Exit Latency, the typical latency in microseconds to enter
1708 Runtime D3.
1709
1710 ``oaes``
1711 Optional Async Events Supported, see **enum** nvme_id_ctrl_oaes.
1712
1713 ``ctratt``
1714 Controller Attributes, see **enum** nvme_id_ctrl_ctratt.
1715
1716 ``rrls``
1717 Read Recovery Levels. If a bit is set, then the corresponding
1718 Read Recovery Level is supported. If a bit is cleared, then the
1719 corresponding Read Recovery Level is not supported.
1720
1721 ``bpcap``
1722 Boot Partition Capabilities, see :c:type:`enum nvme_id_ctrl_bpcap <nvme_id_ctrl_bpcap>`.
1723
1724 ``rsvd103``
1725 Reserved
1726
1727 ``nssl``
1728 NVM Subsystem Shutdown Latency (NSSL). This field indicates the
1729 typical latency in microseconds for an NVM Subsystem Shutdown to
1730 complete.
1731
1732 ``rsvd108``
1733 Reserved
1734
1735 ``plsi``
1736 Power Loss Signaling Information (PLSI), see :c:type:`enum nvme_id_ctrl_plsi <nvme_id_ctrl_plsi>`
1737
1738 ``cntrltype``
1739 Controller Type, see :c:type:`enum nvme_id_ctrl_cntrltype <nvme_id_ctrl_cntrltype>`
1740
1741 ``fguid``
1742 FRU GUID, a 128-bit value that is globally unique for a given
1743 Field Replaceable Unit
1744
1745 ``crdt1``
1746 Controller Retry Delay time in 100 millisecond units if CQE CRD
1747 field is 1
1748
1749 ``crdt2``
1750 Controller Retry Delay time in 100 millisecond units if CQE CRD
1751 field is 2
1752
1753 ``crdt3``
1754 Controller Retry Delay time in 100 millisecond units if CQE CRD
1755 field is 3
1756
1757 ``crcap``
1758 Controller Reachability Capabilities (CRCAP), see
1759 :c:type:`enum nvme_id_ctrl_crcap <nvme_id_ctrl_crcap>`
1760
1761 ``rsvd135``
1762 Reserved
1763
1764 ``nvmsr``
1765 NVM Subsystem Report, see :c:type:`enum nvme_id_ctrl_nvmsr <nvme_id_ctrl_nvmsr>`
1766
1767 ``vwci``
1768 VPD Write Cycle Information, see :c:type:`enum nvme_id_ctrl_vwci <nvme_id_ctrl_vwci>`
1769
1770 ``mec``
1771 Management Endpoint Capabilities, see :c:type:`enum nvme_id_ctrl_mec <nvme_id_ctrl_mec>`
1772
1773 ``oacs``
1774 Optional Admin Command Support,the optional Admin commands and
1775 features supported by the controller, see :c:type:`enum nvme_id_ctrl_oacs <nvme_id_ctrl_oacs>`.
1776
1777 ``acl``
1778 Abort Command Limit, the maximum number of concurrently
1779 executing Abort commands supported by the controller. This is a
1780 0's based value.
1781
1782 ``aerl``
1783 Async Event Request Limit, the maximum number of concurrently
1784 outstanding Asynchronous Event Request commands supported by the
1785 controller This is a 0's based value.
1786
1787 ``frmw``
1788 Firmware Updates indicates capabilities regarding firmware
1789 updates. See :c:type:`enum nvme_id_ctrl_frmw <nvme_id_ctrl_frmw>`.
1790
1791 ``lpa``
1792 Log Page Attributes, see :c:type:`enum nvme_id_ctrl_lpa <nvme_id_ctrl_lpa>`.
1793
1794 ``elpe``
1795 Error Log Page Entries, the maximum number of Error Information
1796 log entries that are stored by the controller. This field is a
1797 0's based value.
1798
1799 ``npss``
1800 Number of Power States Supported, the number of NVM Express
1801 power states supported by the controller, indicating the number
1802 of valid entries in :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.psd. This is a 0's
1803 based value.
1804
1805 ``avscc``
1806 Admin Vendor Specific Command Configuration, see
1807 :c:type:`enum nvme_id_ctrl_avscc <nvme_id_ctrl_avscc>`.
1808
1809 ``apsta``
1810 Autonomous Power State Transition Attributes, see
1811 :c:type:`enum nvme_id_ctrl_apsta <nvme_id_ctrl_apsta>`.
1812
1813 ``wctemp``
1814 Warning Composite Temperature Threshold indicates
1815 the minimum Composite Temperature field value (see :c:type:`struct
1816 nvme_smart_log <nvme_smart_log>`.critical_comp_time) that indicates an overheating
1817 condition during which controller operation continues.
1818
1819 ``cctemp``
1820 Critical Composite Temperature Threshold, field indicates the
1821 minimum Composite Temperature field value (see :c:type:`struct
1822 nvme_smart_log <nvme_smart_log>`.critical_comp_time) that indicates a critical
1823 overheating condition.
1824
1825 ``mtfa``
1826 Maximum Time for Firmware Activation indicates the maximum time
1827 the controller temporarily stops processing commands to activate
1828 the firmware image, specified in 100 millisecond units. This
1829 field is always valid if the controller supports firmware
1830 activation without a reset.
1831
1832 ``hmpre``
1833 Host Memory Buffer Preferred Size indicates the preferred size
1834 that the host is requested to allocate for the Host Memory
1835 Buffer feature in 4 KiB units.
1836
1837 ``hmmin``
1838 Host Memory Buffer Minimum Size indicates the minimum size that
1839 the host is requested to allocate for the Host Memory Buffer
1840 feature in 4 KiB units.
1841
1842 ``tnvmcap``
1843 Total NVM Capacity, the total NVM capacity in the NVM subsystem.
1844 The value is in bytes.
1845
1846 ``unvmcap``
1847 Unallocated NVM Capacity, the unallocated NVM capacity in the
1848 NVM subsystem. The value is in bytes.
1849
1850 ``rpmbs``
1851 Replay Protected Memory Block Support, see
1852 :c:type:`enum nvme_id_ctrl_rpmbs <nvme_id_ctrl_rpmbs>`.
1853
1854 ``edstt``
1855 Extended Device Self-test Time, if Device Self-test command is
1856 supported (see :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.oacs, ``NVME_CTRL_OACS_SELF_TEST``),
1857 then this field indicates the nominal amount of time in one
1858 minute units that the controller takes to complete an extended
1859 device self-test operation when in power state 0.
1860
1861 ``dsto``
1862 Device Self-test Options, see :c:type:`enum nvme_id_ctrl_dsto <nvme_id_ctrl_dsto>`.
1863
1864 ``fwug``
1865 Firmware Update Granularity indicates the granularity and
1866 alignment requirement of the firmware image being updated by the
1867 Firmware Image Download command. The value is reported in 4 KiB
1868 units. A value of 0h indicates no information on granularity is
1869 provided. A value of FFh indicates no restriction
1870
1871 ``kas``
1872 Keep Alive Support indicates the granularity of the Keep Alive
1873 Timer in 100 millisecond units.
1874
1875 ``hctma``
1876 Host Controlled Thermal Management Attributes, see
1877 :c:type:`enum nvme_id_ctrl_hctm <nvme_id_ctrl_hctm>`.
1878
1879 ``mntmt``
1880 Minimum Thermal Management Temperature indicates the minimum
1881 temperature, in degrees Kelvin, that the host may request in the
1882 Thermal Management Temperature 1 field and Thermal Management
1883 Temperature 2 field of a Set Features command with the Feature
1884 Identifier field set to ``NVME_FEAT_FID_HCTM``.
1885
1886 ``mxtmt``
1887 Maximum Thermal Management Temperature indicates the maximum
1888 temperature, in degrees Kelvin, that the host may request in the
1889 Thermal Management Temperature 1 field and Thermal Management
1890 Temperature 2 field of the Set Features command with the Feature
1891 Identifier set to ``NVME_FEAT_FID_HCTM``.
1892
1893 ``sanicap``
1894 Sanitize Capabilities, see :c:type:`enum nvme_id_ctrl_sanicap <nvme_id_ctrl_sanicap>`
1895
1896 ``hmminds``
1897 Host Memory Buffer Minimum Descriptor Entry Size indicates the
1898 minimum usable size of a Host Memory Buffer Descriptor Entry in
1899 4 KiB units.
1900
1901 ``hmmaxd``
1902 Host Memory Maximum Descriptors Entries indicates the number of
1903 usable Host Memory Buffer Descriptor Entries.
1904
1905 ``nsetidmax``
1906 NVM Set Identifier Maximum, defines the maximum value of a valid
1907 NVM Set Identifier for any controller in the NVM subsystem.
1908
1909 ``endgidmax``
1910 Endurance Group Identifier Maximum, defines the maximum value of
1911 a valid Endurance Group Identifier for any controller in the NVM
1912 subsystem.
1913
1914 ``anatt``
1915 ANA Transition Time indicates the maximum amount of time, in
1916 seconds, for a transition between ANA states or the maximum
1917 amount of time, in seconds, that the controller reports the ANA
1918 change state.
1919
1920 ``anacap``
1921 Asymmetric Namespace Access Capabilities, see
1922 :c:type:`enum nvme_id_ctrl_anacap <nvme_id_ctrl_anacap>`.
1923
1924 ``anagrpmax``
1925 ANA Group Identifier Maximum indicates the maximum value of a
1926 valid ANA Group Identifier for any controller in the NVM
1927 subsystem.
1928
1929 ``nanagrpid``
1930 Number of ANA Group Identifiers indicates the number of ANA
1931 groups supported by this controller.
1932
1933 ``pels``
1934 Persistent Event Log Size indicates the maximum reportable size
1935 for the Persistent Event Log.
1936
1937 ``domainid``
1938 Domain Identifier indicates the identifier of the domain
1939 that contains this controller.
1940
1941 ``kpioc``
1942 Key Per I/O Capabilities (KPIOC), see :c:type:`enum nvme_id_ctrl_kpioc <nvme_id_ctrl_kpioc>`
1943
1944 ``rsvd359``
1945 Reserved
1946
1947 ``mptfawr``
1948 Maximum Processing Time for Firmware Activation Without Reset
1949 (MPTFAWR). This field shall indicate the estimated maximum time
1950 in 100 ms units required by the controller to process a Firmware
1951 Commit command that specifies a value of 011b in the Commit
1952 Action field
1953
1954 ``rsvd362``
1955 Reserved
1956
1957 ``megcap``
1958 Max Endurance Group Capacity indicates the maximum capacity
1959 of a single Endurance Group.
1960
1961 ``tmpthha``
1962 Temperature Threshold Hysteresis Attributes
1963
1964 ``rsvd385``
1965 Reserved
1966
1967 ``cqt``
1968 Command Quiesce Time (CQT). his field indicates the expected
1969 worst-case time in 1 millisecond units for the controller to
1970 quiesce all outstanding commands after a Keep Alive Timeout or
1971 other communication loss.
1972
1973 ``rsvd388``
1974 Reserved
1975
1976 ``sqes``
1977 Submission Queue Entry Size, see :c:type:`enum nvme_id_ctrl_sqes <nvme_id_ctrl_sqes>`.
1978
1979 ``cqes``
1980 Completion Queue Entry Size, see :c:type:`enum nvme_id_ctrl_cqes <nvme_id_ctrl_cqes>`.
1981
1982 ``maxcmd``
1983 Maximum Outstanding Commands indicates the maximum number of
1984 commands that the controller processes at one time for a
1985 particular queue.
1986
1987 ``nn``
1988 Number of Namespaces indicates the maximum value of a valid
1989 nsid for the NVM subsystem. If the MNAN (:c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.mnan
1990 field is cleared to 0h, then this field also indicates the
1991 maximum number of namespaces supported by the NVM subsystem.
1992
1993 ``oncs``
1994 Optional NVM Command Support, see :c:type:`enum nvme_id_ctrl_oncs <nvme_id_ctrl_oncs>`.
1995
1996 ``fuses``
1997 Fused Operation Support, see :c:type:`enum nvme_id_ctrl_fuses <nvme_id_ctrl_fuses>`.
1998
1999 ``fna``
2000 Format NVM Attributes, see :c:type:`enum nvme_id_ctrl_fna <nvme_id_ctrl_fna>`.
2001
2002 ``vwc``
2003 Volatile Write Cache, see :c:type:`enum nvme_id_ctrl_vwc <nvme_id_ctrl_vwc>`.
2004
2005 ``awun``
2006 Atomic Write Unit Normal indicates the size of the write
2007 operation guaranteed to be written atomically to the NVM across
2008 all namespaces with any supported namespace format during normal
2009 operation. This field is specified in logical blocks and is a
2010 0's based value.
2011
2012 ``awupf``
2013 Atomic Write Unit Power Fail indicates the size of the write
2014 operation guaranteed to be written atomically to the NVM across
2015 all namespaces with any supported namespace format during a
2016 power fail or error condition. This field is specified in
2017 logical blocks and is a 0’s based value.
2018
2019 ``icsvscc``
2020 NVM Vendor Specific Command Configuration, see
2021 :c:type:`enum nvme_id_ctrl_nvscc <nvme_id_ctrl_nvscc>`.
2022
2023 ``nwpc``
2024 Namespace Write Protection Capabilities, see
2025 :c:type:`enum nvme_id_ctrl_nwpc <nvme_id_ctrl_nwpc>`.
2026
2027 ``acwu``
2028 Atomic Compare & Write Unit indicates the size of the write
2029 operation guaranteed to be written atomically to the NVM across
2030 all namespaces with any supported namespace format for a Compare
2031 and Write fused operation. This field is specified in logical
2032 blocks and is a 0’s based value.
2033
2034 ``ocfs``
2035 Optional Copy Formats Supported, each bit n means controller
2036 supports Copy Format n.
2037
2038 ``sgls``
2039 SGL Support, see :c:type:`enum nvme_id_ctrl_sgls <nvme_id_ctrl_sgls>`
2040
2041 ``mnan``
2042 Maximum Number of Allowed Namespaces indicates the maximum
2043 number of namespaces supported by the NVM subsystem.
2044
2045 ``maxdna``
2046 Maximum Domain Namespace Attachments indicates the maximum
2047 of the sum of the number of namespaces attached to each I/O
2048 controller in the Domain.
2049
2050 ``maxcna``
2051 Maximum I/O Controller Namespace Attachments indicates the
2052 maximum number of namespaces that are allowed to be attached to
2053 this I/O controller.
2054
2055 ``oaqd``
2056 Optimal Aggregated Queue Depth indicates the recommended maximum
2057 total number of outstanding I/O commands across all I/O queues
2058 on the controller for optimal operation.
2059
2060 ``rhiri``
2061 Recommended Host-Initiated Refresh Interval (RHIRI). If the
2062 Host-Initiated Refresh capability is supported, then this field
2063 indicates the recommended time interval in days from last power
2064 down to the time at which the host should initiate the
2065 Host-Initiated Refresh operation. If this field is cleared to
2066 0h, then this field is not reported.
2067
2068 ``hirt``
2069 Host-Initiated Refresh Time (HIRT). If the Host-Initiated
2070 Refresh capability is supported, then this field indicates the
2071 nominal amount of time in minutes that the controller takes to
2072 complete the Host-Initiated Refresh operation. If this field is
2073 cleared to 0h, then this field is not reported.
2074
2075 ``cmmrtd``
2076 Controller Maximum Memory Range Tracking Descriptors indicates
2077 the maximum number of Memory Range Tracking Descriptors the
2078 controller supports.
2079
2080 ``nmmrtd``
2081 NVM Subsystem Maximum Memory Range Tracking Descriptors
2082 indicates the maximum number of Memory Range Tracking Descriptors
2083 the NVM subsystem supports.
2084
2085 ``minmrtg``
2086 Minimum Memory Range Tracking Granularity indicates the minimum
2087 value supported in the Requested Memory Range Tracking
2088 Granularity (RMRTG) field of the Track Memory Ranges data
2089 structure.
2090
2091 ``maxmrtg``
2092 Maximum Memory Range Tracking Granularity indicates the maximum
2093 value supported in the Requested Memory Range Tracking
2094 Granularity (RMRTG) field of the Track Memory Ranges data
2095 structure.
2096
2097 ``trattr``
2098 Tracking Attributes indicates supported attributes for the Track Send
2099 command and Track Receive command. see :c:type:`enum nvme_id_ctrl_trattr <nvme_id_ctrl_trattr>`
2100
2101 ``rsvd577``
2102 Reserved
2103
2104 ``mcudmq``
2105 Maximum Controller User Data Migration Queues indicates the
2106 maximum number of User Data Migration Queues supported by the
2107 controller.
2108
2109 ``mnsudmq``
2110 Maximum NVM Subsystem User Data Migration Queues indicates the
2111 maximum number of User Data Migration Queues supported by the NVM
2112 subsystem.
2113
2114 ``mcmr``
2115 Maximum CDQ Memory Ranges indicates the maximum number of
2116 memory ranges allowed to be specified by the PRP1 field of a
2117 Controller Data Queue command.
2118
2119 ``nmcmr``
2120 NVM Subsystem Maximum CDQ Memory Ranges indicates the maximum
2121 number of memory ranges for all Controller Data Queues in the
2122 NVM subsystem.
2123
2124 ``mcdqpc``
2125 Maximum Controller Data Queue PRP Count indicates the maximum
2126 number of PRPs allowed to be specified in the PRP list in the
2127 Controller Data Queue command.
2128
2129 ``rsvd588``
2130 Reserved
2131
2132 ``subnqn``
2133 NVM Subsystem NVMe Qualified Name, UTF-8 null terminated string
2134
2135 ``rsvd1024``
2136 Reserved
2137
2138 ``ioccsz``
2139 I/O Queue Command Capsule Supported Size, defines the maximum
2140 I/O command capsule size in 16 byte units.
2141
2142 ``iorcsz``
2143 I/O Queue Response Capsule Supported Size, defines the maximum
2144 I/O response capsule size in 16 byte units.
2145
2146 ``icdoff``
2147 In Capsule Data Offset, defines the offset where data starts
2148 within a capsule. This value is applicable to I/O Queues only.
2149
2150 ``fcatt``
2151 Fabrics Controller Attributes, see :c:type:`enum nvme_id_ctrl_fcatt <nvme_id_ctrl_fcatt>`.
2152
2153 ``msdbd``
2154 Maximum SGL Data Block Descriptors indicates the maximum
2155 number of SGL Data Block or Keyed SGL Data Block descriptors
2156 that a host is allowed to place in a capsule. A value of 0h
2157 indicates no limit.
2158
2159 ``ofcs``
2160 Optional Fabric Commands Support, see :c:type:`enum nvme_id_ctrl_ofcs <nvme_id_ctrl_ofcs>`.
2161
2162 ``dctype``
2163 Discovery Controller Type (DCTYPE). This field indicates what
2164 type of Discovery controller the controller is (see enum
2165 nvme_id_ctrl_dctype)
2166
2167 ``rsvd1807``
2168 Reserved
2169
2170 ``psd``
2171 Power State Descriptors, see :c:type:`struct nvme_id_psd <nvme_id_psd>`.
2172
2173 ``vs``
2174 Vendor Specific
2175
2176
2177
2178
2179
2180 .. c:type:: enum nvme_cmic
2181
2182 This field indicates the controller multi-path I/O and NS sharing capabilities
2183
2184 **Constants**
2185
2186 ``NVME_CMIC_MULTI_PORT_SHIFT``
2187 Shift amount to get the NVM subsystem port
2188
2189 ``NVME_CMIC_MULTI_CTRL_SHIFT``
2190 Shift amount to get the controllers
2191
2192 ``NVME_CMIC_MULTI_SRIOV_SHIFT``
2193 Shift amount to get the SR-IOV virtual function
2194
2195 ``NVME_CMIC_MULTI_ANA_SHIFT``
2196 Shift amount to get the asymmetric namespace access reporting
2197
2198 ``NVME_CMIC_MULTI_RSVD_SHIFT``
2199 Shift amount to get the reserved
2200
2201 ``NVME_CMIC_MULTI_PORT_MASK``
2202 Mask to get the NVM subsystem port
2203
2204 ``NVME_CMIC_MULTI_CTRL_MASK``
2205 Mask to get the controllers
2206
2207 ``NVME_CMIC_MULTI_SRIOV_MASK``
2208 Mask to get the SR-IOV virtual function
2209
2210 ``NVME_CMIC_MULTI_ANA_MASK``
2211 Mask to get the asymmetric namespace access reporting
2212
2213 ``NVME_CMIC_MULTI_RSVD_MASK``
2214 Mask to get the reserved
2215
2216
2217
2218
2219 .. c:type:: enum nvme_id_ctrl_cmic
2220
2221 Controller Multipath IO and Namespace Sharing Capabilities of the controller and NVM subsystem.
2222
2223 **Constants**
2224
2225 ``NVME_CTRL_CMIC_MULTI_PORT``
2226 If set, then the NVM subsystem may contain
2227 more than one NVM subsystem port, otherwise
2228 the NVM subsystem contains only a single
2229 NVM subsystem port.
2230
2231 ``NVME_CTRL_CMIC_MULTI_CTRL``
2232 If set, then the NVM subsystem may contain
2233 two or more controllers, otherwise the
2234 NVM subsystem contains only a single
2235 controller. An NVM subsystem that contains
2236 multiple controllers may be used by
2237 multiple hosts, or may provide multiple
2238 paths for a single host.
2239
2240 ``NVME_CTRL_CMIC_MULTI_SRIOV``
2241 If set, then the controller is associated
2242 with an SR-IOV Virtual Function, otherwise
2243 it is associated with a PCI Function
2244 or a Fabrics connection.
2245
2246 ``NVME_CTRL_CMIC_MULTI_ANA_REPORTING``
2247 If set, then the NVM subsystem supports
2248 Asymmetric Namespace Access Reporting.
2249
2250
2251
2252
2253 .. c:type:: enum nvme_id_ctrl_oaes
2254
2255 Optional Asynchronous Events Supported
2256
2257 **Constants**
2258
2259 ``NVME_CTRL_OAES_NA_SHIFT``
2260 Shift amount to get the Namespace Attribute Notices event supported
2261
2262 ``NVME_CTRL_OAES_FA_SHIFT``
2263 Shift amount to get the Firmware Activation Notices event supported
2264
2265 ``NVME_CTRL_OAES_ANA_SHIFT``
2266 Shift amount to get the ANA Change Notices supported
2267
2268 ``NVME_CTRL_OAES_PLEA_SHIFT``
2269 Shift amount to get the Predictable Latency Event Aggregate Log
2270 Change Notices event supported
2271
2272 ``NVME_CTRL_OAES_LBAS_SHIFT``
2273 Shift amount to get the LBA Status Information Notices event
2274 supported
2275
2276 ``NVME_CTRL_OAES_EGE_SHIFT``
2277 Shift amount to get the Endurance Group Events Aggregate Log Change
2278 Notices event supported
2279
2280 ``NVME_CTRL_OAES_NS_SHIFT``
2281 Shift amount to get the Normal NVM Subsystem Shutdown event supported
2282
2283 ``NVME_CTRL_OAES_TTH_SHIFT``
2284 Shift amount to get the Temperature Threshold Hysteresis Recovery
2285 event supported
2286
2287 ``NVME_CTRL_OAES_RGCNS_SHIFT``
2288 Shift amount to get the Reachability Groups Change Notices supported
2289
2290 ``NVME_CTRL_OAES_ANSAN_SHIFT``
2291 Shift amount to get the Allocated Namespace Attribute Notices
2292 supported
2293
2294 ``NVME_CTRL_OAES_ZD_SHIFT``
2295 Shift amount to get the Zone Descriptor Change Notifications supported
2296
2297 ``NVME_CTRL_OAES_DL_SHIFT``
2298 Shift amount to get the Discover Log Page Change Notifications
2299 supported
2300
2301 ``NVME_CTRL_OAES_NA_MASK``
2302 Mask to get the Namespace Attribute Notices event supported
2303
2304 ``NVME_CTRL_OAES_FA_MASK``
2305 Mask to get the Firmware Activation Notices event supported
2306
2307 ``NVME_CTRL_OAES_ANA_MASK``
2308 Mask to get the ANA Change Notices supported
2309
2310 ``NVME_CTRL_OAES_PLEA_MASK``
2311 Mask to get the Predictable Latency Event Aggregate Log Change Notices
2312 event supported
2313
2314 ``NVME_CTRL_OAES_LBAS_MASK``
2315 Mask to get the LBA Status Information Notices event supported
2316
2317 ``NVME_CTRL_OAES_EGE_MASK``
2318 Mask to get the Endurance Group Events Aggregate Log Change Notices
2319 event supported
2320
2321 ``NVME_CTRL_OAES_NS_MASK``
2322 Mask to get the Normal NVM Subsystem Shutdown event supported
2323
2324 ``NVME_CTRL_OAES_TTH_MASK``
2325 Mask to get the Temperature Threshold Hysteresis Recovery event
2326 supported
2327
2328 ``NVME_CTRL_OAES_RGCNS_MASK``
2329 Mask to get the Reachability Groups Change Notices supported
2330
2331 ``NVME_CTRL_OAES_ANSAN_MASK``
2332 Mask to get the Allocated Namespace Attribute Notices supported
2333
2334 ``NVME_CTRL_OAES_ZD_MASK``
2335 Mask to get the Zone Descriptor Change Notifications supported
2336
2337 ``NVME_CTRL_OAES_DL_MASK``
2338 Mask to get the Discover Log Page Change Notifications supported
2339
2340 ``NVME_CTRL_OAES_NA``
2341 Namespace Attribute Notices event supported
2342
2343 ``NVME_CTRL_OAES_FA``
2344 Firmware Activation Notices event supported
2345
2346 ``NVME_CTRL_OAES_ANA``
2347 ANA Change Notices supported
2348
2349 ``NVME_CTRL_OAES_PLEA``
2350 Predictable Latency Event Aggregate Log Change Notices event supported
2351
2352 ``NVME_CTRL_OAES_LBAS``
2353 LBA Status Information Notices event supported
2354
2355 ``NVME_CTRL_OAES_EGE``
2356 Endurance Group Events Aggregate Log Change Notices event supported
2357
2358 ``NVME_CTRL_OAES_NS``
2359 Normal NVM Subsystem Shutdown event supported
2360
2361 ``NVME_CTRL_OAES_TTH``
2362 Temperature Threshold Hysteresis Recovery event supported
2363
2364 ``NVME_CTRL_OAES_RGCNS``
2365 Reachability Groups Change Notices supported
2366
2367 ``NVME_CTRL_OAES_ANSAN``
2368 Allocated Namespace Attribute Notices supported
2369
2370 ``NVME_CTRL_OAES_ZD``
2371 Zone Descriptor Change Notifications supported
2372
2373 ``NVME_CTRL_OAES_DL``
2374 Discover Log Page Change Notifications supported
2375
2376
2377
2378
2379 .. c:type:: enum nvme_id_ctrl_ctratt
2380
2381 Controller attributes
2382
2383 **Constants**
2384
2385 ``NVME_CTRL_CTRATT_128_ID``
2386 128-bit Host Identifier supported
2387
2388 ``NVME_CTRL_CTRATT_NON_OP_PSP``
2389 Non-Operational Poser State Permissive Mode
2390 supported
2391
2392 ``NVME_CTRL_CTRATT_NVM_SETS``
2393 NVM Sets supported
2394
2395 ``NVME_CTRL_CTRATT_READ_RECV_LVLS``
2396 Read Recovery Levels supported
2397
2398 ``NVME_CTRL_CTRATT_ENDURANCE_GROUPS``
2399 Endurance Groups supported
2400
2401 ``NVME_CTRL_CTRATT_PREDICTABLE_LAT``
2402 Predictable Latency Mode supported
2403
2404 ``NVME_CTRL_CTRATT_TBKAS``
2405 Traffic Based Keep Alive Support
2406
2407 ``NVME_CTRL_CTRATT_NAMESPACE_GRANULARITY``
2408 Namespace Granularity reporting
2409 supported
2410
2411 ``NVME_CTRL_CTRATT_SQ_ASSOCIATIONS``
2412 SQ Associations supported
2413
2414 ``NVME_CTRL_CTRATT_UUID_LIST``
2415 UUID List reporting supported
2416
2417 ``NVME_CTRL_CTRATT_MDS``
2418 Multi-Domain Subsystem supported
2419
2420 ``NVME_CTRL_CTRATT_FIXED_CAP``
2421 Fixed Capacity Management supported
2422
2423 ``NVME_CTRL_CTRATT_VARIABLE_CAP``
2424 Variable Capacity Management supported
2425
2426 ``NVME_CTRL_CTRATT_DEL_ENDURANCE_GROUPS``
2427 Delete Endurance Groups supported
2428
2429 ``NVME_CTRL_CTRATT_DEL_NVM_SETS``
2430 Delete NVM Sets supported
2431
2432 ``NVME_CTRL_CTRATT_ELBAS``
2433 Extended LBA Formats supported
2434
2435 ``NVME_CTRL_CTRATT_MEM``
2436 MDTS and Size Limits Exclude Metadata supported
2437
2438 ``NVME_CTRL_CTRATT_HMBR``
2439 HMB Restrict Non-Operational Power State Access
2440
2441 ``NVME_CTRL_CTRATT_RHII``
2442 Reservations and Host Identifier Interaction
2443
2444 ``NVME_CTRL_CTRATT_FDPS``
2445 Flexible Data Placement supported
2446
2447
2448
2449
2450 .. c:type:: enum nvme_id_ctrl_bpcap
2451
2452 Boot Partition Capabilities
2453
2454 **Constants**
2455
2456 ``NVME_CTRL_BACAP_RPMBBPWPS_SHIFT``
2457 Shift amount to get the RPMB Boot Partition Write
2458 Protection Support from the :c:type:`struct
2459 nvme_id_ctrl <nvme_id_ctrl>`.bpcap field.
2460
2461 ``NVME_CTRL_BACAP_SFBPWPS_SHIFT``
2462 Shift amount to get the Set Features Boot Partition
2463 Write Protection Support from the :c:type:`struct
2464 nvme_id_ctrl <nvme_id_ctrl>`.bpcap field.
2465
2466 ``NVME_CTRL_BACAP_RPMBBPWPS_MASK``
2467 Mask to get the RPMB Boot Partition Write
2468 Protection Support from the :c:type:`struct
2469 nvme_id_ctrl <nvme_id_ctrl>`.bpcap field.
2470
2471 ``NVME_CTRL_BACAP_SFBPWPS_MASK``
2472 Mask to get the Set Features Boot Partition Write
2473 Protection Support from the :c:type:`struct
2474 nvme_id_ctrl <nvme_id_ctrl>`.bpcap field.
2475
2476 ``NVME_CTRL_BACAP_RPMBBPWPS_NOT_SPECIFIED``
2477 Support for RPMB Boot Partition Write Protection
2478 is not specified.
2479
2480 ``NVME_CTRL_BACAP_RPMBBPWPS_NOT_SUPPORTED``
2481 RPMB Boot Partition Write Protection is not
2482 supported by this controller.
2483
2484 ``NVME_CTRL_BACAP_RPMBBPWPS_SUPPORTED``
2485 RPMB Boot Partition Write Protection is supported
2486 by this controller.
2487
2488
2489
2490
2491 .. c:type:: enum nvme_id_ctrl_plsi
2492
2493 Power Loss Signaling Information
2494
2495 **Constants**
2496
2497 ``NVME_CTRL_PLSI_PLSEPF_SHIFT``
2498 Shift amount to get the PLS Emergency Power Fail from the
2499 :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.plsi field.
2500
2501 ``NVME_CTRL_PLSI_PLSFQ_SHIFT``
2502 Shift amount to get the PLS Forced Quiescence from the
2503 :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.plsi field.
2504
2505 ``NVME_CTRL_PLSI_PLSEPF_MASK``
2506 Mask to get the PLS Emergency Power Fail from the
2507 :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.plsi field.
2508
2509 ``NVME_CTRL_PLSI_PLSFQ_MASK``
2510 Mask to get the PLS Forced Quiescence from the
2511 :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.plsi field.
2512
2513
2514
2515
2516 .. c:type:: enum nvme_id_ctrl_crcap
2517
2518 Power Loss Signaling Information
2519
2520 **Constants**
2521
2522 ``NVME_CTRL_CRCAP_RRSUP_SHIFT``
2523 Shift amount to get the Reachability Reporting Supported
2524 from the :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.crcap field.
2525
2526 ``NVME_CTRL_CRCAP_RGIDC_SHIFT``
2527 Shift amount to get the Reachability Group ID Changeable
2528 from the :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.crcap field.
2529
2530 ``NVME_CTRL_CRCAP_RRSUP_MASK``
2531 Mask to get the Reachability Reporting Supported from the
2532 :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.crcap field.
2533
2534 ``NVME_CTRL_CRCAP_RGIDC_MASK``
2535 Mask to get the Reachability Group ID Changeable from the
2536 :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.crcap field.
2537
2538
2539
2540
2541 .. c:type:: enum nvme_id_ctrl_cntrltype
2542
2543 Controller types
2544
2545 **Constants**
2546
2547 ``NVME_CTRL_CNTRLTYPE_IO``
2548 NVM I/O controller
2549
2550 ``NVME_CTRL_CNTRLTYPE_DISCOVERY``
2551 Discovery controller
2552
2553 ``NVME_CTRL_CNTRLTYPE_ADMIN``
2554 Admin controller
2555
2556
2557
2558
2559 .. c:type:: enum nvme_id_ctrl_dctype
2560
2561 Discovery Controller types
2562
2563 **Constants**
2564
2565 ``NVME_CTRL_DCTYPE_NOT_REPORTED``
2566 Not reported (I/O, Admin, and pre-TP8010)
2567
2568 ``NVME_CTRL_DCTYPE_DDC``
2569 Direct Discovery controller
2570
2571 ``NVME_CTRL_DCTYPE_CDC``
2572 Central Discovery controller
2573
2574
2575
2576
2577 .. c:type:: enum nvme_id_ctrl_nvmsr
2578
2579 This field reports information associated with the NVM Subsystem, see :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.nvmsr.
2580
2581 **Constants**
2582
2583 ``NVME_CTRL_NVMSR_NVMESD``
2584 If set, then the NVM Subsystem is part of an NVMe
2585 Storage Device; if cleared, then the NVM Subsystem
2586 is not part of an NVMe Storage Device.
2587
2588 ``NVME_CTRL_NVMSR_NVMEE``
2589 If set, then the NVM Subsystem is part of an NVMe
2590 Enclosure; if cleared, then the NVM Subsystem is
2591 not part of an NVMe Enclosure.
2592
2593
2594
2595
2596 .. c:type:: enum nvme_id_ctrl_vwci
2597
2598 This field indicates information about remaining number of times that VPD contents are able to be updated using the VPD Write command, see :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.vwci.
2599
2600 **Constants**
2601
2602 ``NVME_CTRL_VWCI_VWCR``
2603 Mask to get value of VPD Write Cycles Remaining. If
2604 the VPD Write Cycle Remaining Valid bit is set, then
2605 this field contains a value indicating the remaining
2606 number of times that VPD contents are able to be
2607 updated using the VPD Write command. If this field is
2608 set to 7Fh, then the remaining number of times that
2609 VPD contents are able to be updated using the VPD
2610 Write command is greater than or equal to 7Fh.
2611
2612 ``NVME_CTRL_VWCI_VWCRV``
2613 VPD Write Cycle Remaining Valid. If this bit is set,
2614 then the VPD Write Cycle Remaining field is valid. If
2615 this bit is cleared, then the VPD Write Cycles
2616 Remaining field is invalid and cleared to 0h.
2617
2618
2619
2620
2621 .. c:type:: enum nvme_id_ctrl_mec
2622
2623 Flags indicating the capabilities of the Management Endpoint in the Controller, :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.mec.
2624
2625 **Constants**
2626
2627 ``NVME_CTRL_MEC_SMBUSME``
2628 If set, then the NVM Subsystem contains a Management
2629 Endpoint on an SMBus/I2C port.
2630
2631 ``NVME_CTRL_MEC_PCIEME``
2632 If set, then the NVM Subsystem contains a Management
2633 Endpoint on a PCIe port.
2634
2635
2636
2637
2638 .. c:type:: enum nvme_id_ctrl_oacs
2639
2640 Flags indicating the optional Admin commands and features supported by the controller, see :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.oacs.
2641
2642 **Constants**
2643
2644 ``NVME_CTRL_OACS_SSRS_SHIFT``
2645 Shift amount to get the Security Send Receive supported
2646
2647 ``NVME_CTRL_OACS_FNVMS_SHIFT``
2648 Shift amount to get the Format NVM supported
2649
2650 ``NVME_CTRL_OACS_FWDS_SHIFT``
2651 Shift amount to get the Firmware Download supported
2652
2653 ``NVME_CTRL_OACS_NMS_SHIFT``
2654 Shift amount to get the Namespace Management supported
2655
2656 ``NVME_CTRL_OACS_DSTS_SHIFT``
2657 Shift amount to get the Device Self-test supported
2658
2659 ``NVME_CTRL_OACS_DIRS_SHIFT``
2660 Shift amount to get the Directives supported
2661
2662 ``NVME_CTRL_OACS_NSRS_SHIFT``
2663 Shift amount to get the NVMe-MI Send Receive supported
2664
2665 ``NVME_CTRL_OACS_VMS_SHIFT``
2666 Shift amount to get the Virtualization Management supported
2667
2668 ``NVME_CTRL_OACS_DBCS_SHIFT``
2669 Shift amount to get the Doorbell Buffer Config supported
2670
2671 ``NVME_CTRL_OACS_GLSS_SHIFT``
2672 Shift amount to get the Get LBA Status supported
2673
2674 ``NVME_CTRL_OACS_CFLS_SHIFT``
2675 Shift amount to get the Command and Feature Lockdown supported
2676
2677 ``NVME_CTRL_OACS_HMLMS_SHIFT``
2678 Shift amount to get the Host Managed Live Migration support
2679
2680 ``NVME_CTRL_OACS_SSRS_MASK``
2681 Mask to get the Security Send Receive supported
2682
2683 ``NVME_CTRL_OACS_FNVMS_MASK``
2684 Mask to get the Format NVM supported
2685
2686 ``NVME_CTRL_OACS_FWDS_MASK``
2687 Mask to get the Firmware Download supported
2688
2689 ``NVME_CTRL_OACS_NMS_MASK``
2690 Mask to get the Namespace Management supported
2691
2692 ``NVME_CTRL_OACS_DSTS_MASK``
2693 Mask to get the Device Self-test supported
2694
2695 ``NVME_CTRL_OACS_DIRS_MASK``
2696 Mask to get the Directives supported
2697
2698 ``NVME_CTRL_OACS_NSRS_MASK``
2699 Mask to get the NVMe-MI Send Receive supported
2700
2701 ``NVME_CTRL_OACS_VMS_MASK``
2702 Mask to get the Virtualization Management supported
2703
2704 ``NVME_CTRL_OACS_DBCS_MASK``
2705 Mask to get the Doorbell Buffer Config supported
2706
2707 ``NVME_CTRL_OACS_GLSS_MASK``
2708 Mask to get the Get LBA Status supported
2709
2710 ``NVME_CTRL_OACS_CFLS_MASK``
2711 Mask to get the Command and Feature Lockdown supported
2712
2713 ``NVME_CTRL_OACS_HMLMS_MASK``
2714 Mask to get the Host Managed Live Migration support
2715
2716 ``NVME_CTRL_OACS_SECURITY``
2717 If set, then the controller supports the
2718 Security Send and Security Receive commands.
2719
2720 ``NVME_CTRL_OACS_FORMAT``
2721 If set then the controller supports the Format
2722 NVM command.
2723
2724 ``NVME_CTRL_OACS_FW``
2725 If set, then the controller supports the
2726 Firmware Commit and Firmware Image Download commands.
2727
2728 ``NVME_CTRL_OACS_NS_MGMT``
2729 If set, then the controller supports the
2730 Namespace Management capability
2731
2732 ``NVME_CTRL_OACS_SELF_TEST``
2733 If set, then the controller supports the Device
2734 Self-test command.
2735
2736 ``NVME_CTRL_OACS_DIRECTIVES``
2737 If set, then the controller supports Directives
2738 and the Directive Send and Directive Receive
2739 commands.
2740
2741 ``NVME_CTRL_OACS_NVME_MI``
2742 If set, then the controller supports the NVMe-MI
2743 Send and NVMe-MI Receive commands.
2744
2745 ``NVME_CTRL_OACS_VIRT_MGMT``
2746 If set, then the controller supports the
2747 Virtualization Management command.
2748
2749 ``NVME_CTRL_OACS_DBBUF_CFG``
2750 If set, then the controller supports the
2751 Doorbell Buffer Config command.
2752
2753 ``NVME_CTRL_OACS_LBA_STATUS``
2754 If set, then the controller supports the Get LBA
2755 Status capability.
2756
2757 ``NVME_CTRL_OACS_CMD_FEAT_LD``
2758 If set, then the controller supports the command
2759 and feature lockdown capability.
2760
2761 ``NVME_CTRL_OACS_HMLM``
2762 If set, then the controller supports the command
2763 and Host Managed Live Migration capability.
2764
2765
2766
2767
2768 .. c:type:: enum nvme_id_ctrl_frmw
2769
2770 Flags and values indicates capabilities regarding firmware updates from :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.frmw.
2771
2772 **Constants**
2773
2774 ``NVME_CTRL_FRMW_1ST_RO``
2775 If set, the first firmware slot is readonly
2776
2777 ``NVME_CTRL_FRMW_NR_SLOTS``
2778 Mask to get the value of the number of
2779 firmware slots that the controller supports.
2780
2781 ``NVME_CTRL_FRMW_FW_ACT_NO_RESET``
2782 If set, the controller supports firmware
2783 activation without a reset.
2784
2785 ``NVME_CTRL_FRMW_MP_UP_DETECTION``
2786 If set, the controller is able to detect
2787 overlapping firmware/boot partition
2788 image update.
2789
2790
2791
2792
2793 .. c:type:: enum nvme_id_ctrl_lpa
2794
2795 Flags indicating optional attributes for log pages that are accessed via the Get Log Page command.
2796
2797 **Constants**
2798
2799 ``NVME_CTRL_LPA_SMART_PER_NS``
2800 If set, controller supports SMART/Health log
2801 page on a per namespace basis.
2802
2803 ``NVME_CTRL_LPA_CMD_EFFECTS``
2804 If Set, the controller supports the commands
2805 supported and effects log page.
2806
2807 ``NVME_CTRL_LPA_EXTENDED``
2808 If set, the controller supports extended data
2809 for log page command including extended number
2810 of dwords and log page offset fields.
2811
2812 ``NVME_CTRL_LPA_TELEMETRY``
2813 If set, the controller supports the telemetry
2814 host-initiated and telemetry controller-initiated
2815 log pages and sending telemetry log notices.
2816
2817 ``NVME_CTRL_LPA_PERSETENT_EVENT``
2818 If set, the controller supports
2819 persistent event log.
2820
2821 ``NVME_CTRL_LPA_LI0_LI5_LI12_LI13``
2822 If set, the controller supports
2823 - log pages log page.
2824 - returning scope of each command in
2825 commands supported and effects log
2826 page.
2827 - feature identifiers supported and
2828 effects log page.
2829 - NVMe-MI commands supported and
2830 effects log page.
2831
2832 ``NVME_CTRL_LPA_DA4_TELEMETRY``
2833 If set, the controller supports data
2834 area 4 for telemetry host-initiated and
2835 telemetry.
2836
2837
2838
2839
2840 .. c:type:: enum nvme_id_ctrl_avscc
2841
2842 Flags indicating the configuration settings for Admin Vendor Specific command handling.
2843
2844 **Constants**
2845
2846 ``NVME_CTRL_AVSCC_AVS``
2847 If set, all Admin Vendor Specific Commands use the
2848 optional vendor specific command format with NDT and
2849 NDM fields.
2850
2851
2852
2853
2854 .. c:type:: enum nvme_id_ctrl_apsta
2855
2856 Flags indicating the attributes of the autonomous power state transition feature.
2857
2858 **Constants**
2859
2860 ``NVME_CTRL_APSTA_APST``
2861 If set, then the controller supports autonomous power
2862 state transitions.
2863
2864
2865
2866
2867 .. c:type:: enum nvme_id_ctrl_rpmbs
2868
2869 This field indicates if the controller supports one or more Replay Protected Memory Blocks, from :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.rpmbs.
2870
2871 **Constants**
2872
2873 ``NVME_CTRL_RPMBS_NR_UNITS``
2874 Mask to get the value of the Number of RPMB Units
2875
2876 ``NVME_CTRL_RPMBS_AUTH_METHOD``
2877 Mask to get the value of the Authentication Method
2878
2879 ``NVME_CTRL_RPMBS_TOTAL_SIZE``
2880 Mask to get the value of Total Size
2881
2882 ``NVME_CTRL_RPMBS_ACCESS_SIZE``
2883 Mask to get the value of Access Size
2884
2885
2886
2887
2888 .. c:type:: enum nvme_id_ctrl_dsto
2889
2890 Flags indicating the optional Device Self-test command or operation behaviors supported by the controller or NVM subsystem.
2891
2892 **Constants**
2893
2894 ``NVME_CTRL_DSTO_SDSO_SHIFT``
2895 Shift amount to get the value of Single Device Self-test
2896 Operation from Device Self-test Options field.
2897
2898 ``NVME_CTRL_DSTO_HIRS_SHIFT``
2899 Shift amount to get the value of Host-Initiated Refresh
2900 Support from Device Self-test Options field.
2901
2902 ``NVME_CTRL_DSTO_SDSO_MASK``
2903 Mask to get the value of Single Device Self-test Operation
2904
2905 ``NVME_CTRL_DSTO_HIRS_MASK``
2906 Mask to get the value of Host-Initiated Refresh Support
2907
2908 ``NVME_CTRL_DSTO_ONE_DST``
2909 If set, then the NVM subsystem supports only one device
2910 self-test operation in progress at a time. If cleared,
2911 then the NVM subsystem supports one device self-test
2912 operation per controller at a time.
2913
2914 ``NVME_CTRL_DSTO_HIRS``
2915 If set, then the controller supports the Host-Initiated
2916 Refresh capability.
2917
2918
2919
2920
2921 .. c:type:: enum nvme_id_ctrl_hctm
2922
2923 Flags indicate the attributes of the host controlled thermal management feature
2924
2925 **Constants**
2926
2927 ``NVME_CTRL_HCTMA_HCTM``
2928 then the controller supports host controlled thermal
2929 management, and the Set Features command and Get
2930 Features command with the Feature Identifier field
2931 set to ``NVME_FEAT_FID_HCTM``.
2932
2933
2934
2935
2936 .. c:type:: enum nvme_id_ctrl_sanicap
2937
2938 Indicates attributes for sanitize operations.
2939
2940 **Constants**
2941
2942 ``NVME_CTRL_SANICAP_CES``
2943 Crypto Erase Support. If set, then the
2944 controller supports the Crypto Erase sanitize operation.
2945
2946 ``NVME_CTRL_SANICAP_BES``
2947 Block Erase Support. If set, then the controller
2948 supports the Block Erase sanitize operation.
2949
2950 ``NVME_CTRL_SANICAP_OWS``
2951 Overwrite Support. If set, then the controller
2952 supports the Overwrite sanitize operation.
2953
2954 ``NVME_CTRL_SANICAP_NDI``
2955 No-Deallocate Inhibited. If set and the No-
2956 Deallocate Response Mode bit is set, then the
2957 controller deallocates after the sanitize
2958 operation even if the No-Deallocate After
2959 Sanitize bit is set in a Sanitize command.
2960
2961 ``NVME_CTRL_SANICAP_NODMMAS``
2962 No-Deallocate Modifies Media After Sanitize,
2963 mask to extract value.
2964
2965
2966
2967
2968 .. c:type:: enum nvme_id_ctrl_anacap
2969
2970 This field indicates the capabilities associated with Asymmetric Namespace Access Reporting.
2971
2972 **Constants**
2973
2974 ``NVME_CTRL_ANACAP_OPT``
2975 If set, then the controller is able to
2976 report ANA Optimized state.
2977
2978 ``NVME_CTRL_ANACAP_NON_OPT``
2979 If set, then the controller is able to
2980 report ANA Non-Optimized state.
2981
2982 ``NVME_CTRL_ANACAP_INACCESSIBLE``
2983 If set, then the controller is able to
2984 report ANA Inaccessible state.
2985
2986 ``NVME_CTRL_ANACAP_PERSISTENT_LOSS``
2987 If set, then the controller is able to
2988 report ANA Persistent Loss state.
2989
2990 ``NVME_CTRL_ANACAP_CHANGE``
2991 If set, then the controller is able to
2992 report ANA Change state.
2993
2994 ``NVME_CTRL_ANACAP_GRPID_NO_CHG``
2995 If set, then the ANAGRPID field in the
2996 Identify Namespace data structure
2997 (:c:type:`struct nvme_id_ns <nvme_id_ns>`.anagrpid), does not
2998 change while the namespace is attached to
2999 any controller.
3000
3001 ``NVME_CTRL_ANACAP_GRPID_MGMT``
3002 If set, then the controller supports a
3003 non-zero value in the ANAGRPID field of
3004 the Namespace Management command.
3005
3006
3007
3008
3009 .. c:type:: enum nvme_id_ctrl_kpioc
3010
3011 Key Per I/O Capabilities
3012
3013 **Constants**
3014
3015 ``NVME_CTRL_KPIOC_KPIOS_SHIFT``
3016 Shift amount to get the Key Per I/O Supported from the
3017 :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.kpioc field.
3018
3019 ``NVME_CTRL_KPIOC_KPIOSC_SHIFT``
3020 Shift amount to get the Key Per I/O Scope from the
3021 :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.kpioc field.
3022
3023 ``NVME_CTRL_KPIOC_KPIOS_MASK``
3024 Mask to get the Key Per I/O Supported from the
3025 :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.kpioc field.
3026
3027 ``NVME_CTRL_KPIOC_KPIOSC_MASK``
3028 Mask to get the Key Per I/O Scope from the
3029 :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.kpioc field.
3030
3031
3032
3033
3034 .. c:type:: enum nvme_id_ctrl_sqes
3035
3036 Defines the required and maximum Submission Queue entry size when using the NVM Command Set.
3037
3038 **Constants**
3039
3040 ``NVME_CTRL_SQES_MIN``
3041 Mask to get the value of the required Submission Queue
3042 Entry size when using the NVM Command Set.
3043
3044 ``NVME_CTRL_SQES_MAX``
3045 Mask to get the value of the maximum Submission Queue
3046 entry size when using the NVM Command Set.
3047
3048
3049
3050
3051 .. c:type:: enum nvme_id_ctrl_cqes
3052
3053 Defines the required and maximum Completion Queue entry size when using the NVM Command Set.
3054
3055 **Constants**
3056
3057 ``NVME_CTRL_CQES_MIN``
3058 Mask to get the value of the required Completion Queue
3059 Entry size when using the NVM Command Set.
3060
3061 ``NVME_CTRL_CQES_MAX``
3062 Mask to get the value of the maximum Completion Queue
3063 entry size when using the NVM Command Set.
3064
3065
3066
3067
3068 .. c:type:: enum nvme_id_ctrl_oncs
3069
3070 This field indicates the optional NVM commands and features supported by the controller.
3071
3072 **Constants**
3073
3074 ``NVME_CTRL_ONCS_COMPARE``
3075 If set, then the controller supports
3076 the Compare command.
3077
3078 ``NVME_CTRL_ONCS_WRITE_UNCORRECTABLE``
3079 If set, then the controller supports
3080 the Write Uncorrectable command.
3081
3082 ``NVME_CTRL_ONCS_DSM``
3083 If set, then the controller supports
3084 the Dataset Management command.
3085
3086 ``NVME_CTRL_ONCS_WRITE_ZEROES``
3087 If set, then the controller supports
3088 the Write Zeroes command.
3089
3090 ``NVME_CTRL_ONCS_SAVE_FEATURES``
3091 If set, then the controller supports
3092 the Save field set to a non-zero value
3093 in the Set Features command and the
3094 Select field set to a non-zero value in
3095 the Get Features command.
3096
3097 ``NVME_CTRL_ONCS_RESERVATIONS``
3098 If set, then the controller supports
3099 reservations.
3100
3101 ``NVME_CTRL_ONCS_TIMESTAMP``
3102 If set, then the controller supports
3103 the Timestamp feature.
3104
3105 ``NVME_CTRL_ONCS_VERIFY``
3106 If set, then the controller supports
3107 the Verify command.
3108
3109 ``NVME_CTRL_ONCS_COPY``
3110 If set, then the controller supports
3111 the copy command.
3112
3113 ``NVME_CTRL_ONCS_COPY_SINGLE_ATOMICITY``
3114 If set, then the write portion of a
3115 Copy command is performed as a single
3116 write command to which the same
3117 atomicity requirements that apply to
3118 a write command apply.
3119
3120 ``NVME_CTRL_ONCS_ALL_FAST_COPY``
3121 If set, then all copy operations for
3122 the Copy command are fast copy
3123 operations.
3124
3125 ``NVME_CTRL_ONCS_WRITE_ZEROES_DEALLOCATE``
3126 If MAXWZD bit set, then the maximum data
3127 size for Write Zeroes command depends on the
3128 value of the Deallocate bit in the Write Zeroes
3129 command and the value in the WZDSL field in the
3130 I/O Command Set specific Identify Controller
3131 data structure.
3132
3133 ``NVME_CTRL_ONCS_NAMESPACE_ZEROES``
3134 If NSZS bit set, then the controller supports
3135 the Namespace Zeroes (NSZ) bit in the NVM
3136 Command Set Write Zeroes command.
3137
3138
3139
3140
3141 .. c:type:: enum nvme_id_ctrl_fuses
3142
3143 This field indicates the fused operations that the controller supports.
3144
3145 **Constants**
3146
3147 ``NVME_CTRL_FUSES_COMPARE_AND_WRITE``
3148 If set, then the controller supports the
3149 Compare and Write fused operation.
3150
3151
3152
3153
3154 .. c:type:: enum nvme_id_ctrl_fna
3155
3156 This field indicates attributes for the Format NVM command.
3157
3158 **Constants**
3159
3160 ``NVME_CTRL_FNA_FMT_ALL_NS_SHIFT``
3161 Shift amount to get the format applied to all namespaces
3162
3163 ``NVME_CTRL_FNA_SEC_ALL_NS_SHIFT``
3164 Shift amount to get the secure erase applied to all namespaces
3165
3166 ``NVME_CTRL_FNA_CES_SHIFT``
3167 Shift amount to get the cryptographic erase supported
3168
3169 ``NVME_CTRL_FNA_NSID_ALL_F_SHIFT``
3170 Shift amount to get the format supported an NSID FFFFFFFFh
3171
3172 ``NVME_CTRL_FNA_FMT_ALL_NS_MASK``
3173 Mask to get the format applied to all namespaces
3174
3175 ``NVME_CTRL_FNA_SEC_ALL_NS_MASK``
3176 Mask to get the secure erase applied to all namespaces
3177
3178 ``NVME_CTRL_FNA_CES_MASK``
3179 Mask to get the cryptographic erase supported
3180
3181 ``NVME_CTRL_FNA_NSID_ALL_F_MASK``
3182 Mask to get the format supported an NSID FFFFFFFFh
3183
3184 ``NVME_CTRL_FNA_FMT_ALL_NAMESPACES``
3185 If set, then all namespaces in an NVM
3186 subsystem shall be configured with the
3187 same attributes and a format (excluding
3188 secure erase) of any namespace results in
3189 a format of all namespaces in an NVM
3190 subsystem. If cleared, then the
3191 controller supports format on a per
3192 namespace basis.
3193
3194 ``NVME_CTRL_FNA_SEC_ALL_NAMESPACES``
3195 If set, then any secure erase performed
3196 as part of a format operation results in
3197 a secure erase of all namespaces in the
3198 NVM subsystem. If cleared, then any
3199 secure erase performed as part of a
3200 format results in a secure erase of the
3201 particular namespace specified.
3202
3203 ``NVME_CTRL_FNA_CRYPTO_ERASE``
3204 If set, then cryptographic erase is
3205 supported. If cleared, then cryptographic
3206 erase is not supported.
3207
3208 ``NVME_CTRL_FNA_NSID_FFFFFFFF``
3209 If set, then format does not support
3210 nsid value set to FFFFFFFFh. If cleared,
3211 format supports nsid value set to
3212 FFFFFFFFh.
3213
3214
3215
3216
3217 .. c:type:: enum nvme_id_ctrl_vwc
3218
3219 Volatile write cache
3220
3221 **Constants**
3222
3223 ``NVME_CTRL_VWC_PRESENT``
3224 If set, indicates a volatile write cache is present.
3225 If a volatile write cache is present, then the host
3226 controls whether the volatile write cache is enabled
3227 with a Set Features command specifying the value
3228 ``NVME_FEAT_FID_VOLATILE_WC``.
3229
3230 ``NVME_CTRL_VWC_FLUSH``
3231 Mask to get the value of the flush command behavior.
3232
3233
3234
3235
3236 .. c:type:: enum nvme_id_ctrl_nvscc
3237
3238 This field indicates the configuration settings for NVM Vendor Specific command handling.
3239
3240 **Constants**
3241
3242 ``NVME_CTRL_NVSCC_FMT``
3243 If set, all NVM Vendor Specific Commands use the
3244 format with NDT and NDM fields.
3245
3246
3247
3248
3249 .. c:type:: enum nvme_id_ctrl_nwpc
3250
3251 This field indicates the optional namespace write protection capabilities supported by the controller.
3252
3253 **Constants**
3254
3255 ``NVME_CTRL_NWPC_WRITE_PROTECT``
3256 If set, then the controller shall
3257 support the No Write Protect and
3258 Write Protect namespace write
3259 protection states and may support
3260 the Write Protect Until Power
3261 Cycle state and Permanent Write
3262 Protect namespace write
3263 protection states.
3264
3265 ``NVME_CTRL_NWPC_WRITE_PROTECT_POWER_CYCLE``
3266 If set, then the controller
3267 supports the Write Protect Until
3268 Power Cycle state.
3269
3270 ``NVME_CTRL_NWPC_WRITE_PROTECT_PERMANENT``
3271 If set, then the controller
3272 supports the Permanent Write
3273 Protect state.
3274
3275
3276
3277
3278 .. c:type:: enum nvme_id_ctrl_sgls
3279
3280 This field indicates if SGLs are supported for the NVM Command Set and the particular SGL types supported.
3281
3282 **Constants**
3283
3284 ``NVME_CTRL_SGLS_SUPPORTED``
3285
3286 ``NVME_CTRL_SGLS_KEYED``
3287
3288 ``NVME_CTRL_SGLS_BIT_BUCKET``
3289
3290 ``NVME_CTRL_SGLS_MPTR_BYTE_ALIGNED``
3291
3292 ``NVME_CTRL_SGLS_OVERSIZE``
3293
3294 ``NVME_CTRL_SGLS_MPTR_SGL``
3295
3296 ``NVME_CTRL_SGLS_OFFSET``
3297
3298 ``NVME_CTRL_SGLS_TPORT``
3299
3300
3301
3302
3303 .. c:type:: enum nvme_id_ctrl_trattr
3304
3305 Tracking Attributes
3306
3307 **Constants**
3308
3309 ``NVME_CTRL_TRATTR_THMCS_SHIFT``
3310 Shift amount to get the Track Host Memory Changes Support
3311 from the :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.trattr field.
3312
3313 ``NVME_CTRL_TRATTR_TUDCS_SHIFT``
3314 Shift amount to get the Track User Data Changes Support
3315 from the :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.trattr field.
3316
3317 ``NVME_CTRL_TRATTR_MRTLL_SHIFT``
3318 Shift amount to get the Memory Range Tracking Length Limit
3319 from the :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.trattr field.
3320
3321 ``NVME_CTRL_TRATTR_THMCS_MASK``
3322 Mask to get the Track Host Memory Changes Support
3323 from the :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.trattr field.
3324
3325 ``NVME_CTRL_TRATTR_TUDCS_MASK``
3326 Mask to get the Track User Data Changes Support
3327 from the :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.trattr field.
3328
3329 ``NVME_CTRL_TRATTR_MRTLL_MASK``
3330 Mask to get the Memory Range Tracking Length Limit
3331 from the :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`.trattr field.
3332
3333
3334
3335
3336 .. c:type:: enum nvme_id_ctrl_fcatt
3337
3338 This field indicates attributes of the controller that are specific to NVMe over Fabrics.
3339
3340 **Constants**
3341
3342 ``NVME_CTRL_FCATT_DYNAMIC``
3343 If cleared, then the NVM subsystem uses a dynamic
3344 controller model. If set, then the NVM subsystem
3345 uses a static controller model.
3346
3347
3348
3349
3350 .. c:type:: enum nvme_id_ctrl_ofcs
3351
3352 Indicate whether the controller supports optional fabric commands.
3353
3354 **Constants**
3355
3356 ``NVME_CTRL_OFCS_DISCONNECT``
3357 If set, then the controller supports the
3358 Disconnect command and deletion of individual
3359 I/O Queues.
3360
3361
3362
3363
3364 .. c:type:: struct nvme_lbaf
3365
3366 LBA Format Data Structure
3367
3368 **Definition**
3369
3370 ::
3371
3372 struct nvme_lbaf {
3373 __le16 ms;
3374 __u8 ds;
3375 __u8 rp;
3376 };
3377
3378 **Members**
3379
3380 ``ms``
3381 Metadata Size indicates the number of metadata bytes provided per LBA
3382 based on the LBA Data Size indicated.
3383
3384 ``ds``
3385 LBA Data Size indicates the LBA data size supported, reported as a
3386 power of two.
3387
3388 ``rp``
3389 Relative Performance, see :c:type:`enum nvme_lbaf_rp <nvme_lbaf_rp>`.
3390
3391
3392
3393
3394
3395 .. c:type:: enum nvme_lbaf_rp
3396
3397 This field indicates the relative performance of the LBA format indicated relative to other LBA formats supported by the controller.
3398
3399 **Constants**
3400
3401 ``NVME_LBAF_RP_BEST``
3402 Best performance
3403
3404 ``NVME_LBAF_RP_BETTER``
3405 Better performance
3406
3407 ``NVME_LBAF_RP_GOOD``
3408 Good performance
3409
3410 ``NVME_LBAF_RP_DEGRADED``
3411 Degraded performance
3412
3413 ``NVME_LBAF_RP_MASK``
3414 Mask to get the relative performance value from the
3415 field
3416
3417
3418
3419
3420 .. c:type:: struct nvme_id_ns
3421
3422 Identify Namespace data structure
3423
3424 **Definition**
3425
3426 ::
3427
3428 struct nvme_id_ns {
3429 __le64 nsze;
3430 __le64 ncap;
3431 __le64 nuse;
3432 __u8 nsfeat;
3433 __u8 nlbaf;
3434 __u8 flbas;
3435 __u8 mc;
3436 __u8 dpc;
3437 __u8 dps;
3438 __u8 nmic;
3439 __u8 rescap;
3440 __u8 fpi;
3441 __u8 dlfeat;
3442 __le16 nawun;
3443 __le16 nawupf;
3444 __le16 nacwu;
3445 __le16 nabsn;
3446 __le16 nabo;
3447 __le16 nabspf;
3448 __le16 noiob;
3449 __u8 nvmcap[16];
3450 __le16 npwg;
3451 __le16 npwa;
3452 __le16 npdg;
3453 __le16 npda;
3454 __le16 nows;
3455 __le16 mssrl;
3456 __le32 mcl;
3457 __u8 msrc;
3458 __u8 kpios;
3459 __u8 nulbaf;
3460 __u8 rsvd83;
3461 __le32 kpiodaag;
3462 __u8 rsvd88[4];
3463 __le32 anagrpid;
3464 __u8 rsvd96[3];
3465 __u8 nsattr;
3466 __le16 nvmsetid;
3467 __le16 endgid;
3468 __u8 nguid[16];
3469 __u8 eui64[8];
3470 struct nvme_lbaf lbaf[64];
3471 __u8 vs[3712];
3472 };
3473
3474 **Members**
3475
3476 ``nsze``
3477 Namespace Size indicates the total size of the namespace in
3478 logical blocks. The number of logical blocks is based on the
3479 formatted LBA size.
3480
3481 ``ncap``
3482 Namespace Capacity indicates the maximum number of logical blocks
3483 that may be allocated in the namespace at any point in time. The
3484 number of logical blocks is based on the formatted LBA size.
3485
3486 ``nuse``
3487 Namespace Utilization indicates the current number of logical
3488 blocks allocated in the namespace. This field is smaller than or
3489 equal to the Namespace Capacity. The number of logical blocks is
3490 based on the formatted LBA size.
3491
3492 ``nsfeat``
3493 Namespace Features, see :c:type:`enum nvme_id_nsfeat <nvme_id_nsfeat>`.
3494
3495 ``nlbaf``
3496 Number of LBA Formats defines the number of supported LBA data
3497 size and metadata size combinations supported by the namespace
3498 and the highest possible index to :c:type:`struct nvme_id_ns <nvme_id_ns>`.lbaf.
3499
3500 ``flbas``
3501 Formatted LBA Size, see :c:type:`enum nvme_id_ns_flbas <nvme_id_ns_flbas>`.
3502
3503 ``mc``
3504 Metadata Capabilities, see :c:type:`enum nvme_id_ns_mc <nvme_id_ns_mc>`.
3505
3506 ``dpc``
3507 End-to-end Data Protection Capabilities, see
3508 :c:type:`enum nvme_id_ns_dpc <nvme_id_ns_dpc>`.
3509
3510 ``dps``
3511 End-to-end Data Protection Type Settings, see
3512 :c:type:`enum nvme_id_ns_dps <nvme_id_ns_dps>`.
3513
3514 ``nmic``
3515 Namespace Multi-path I/O and Namespace Sharing Capabilities, see
3516 :c:type:`enum nvme_id_ns_nmic <nvme_id_ns_nmic>`.
3517
3518 ``rescap``
3519 Reservation Capabilities, see :c:type:`enum nvme_id_ns_rescap <nvme_id_ns_rescap>`.
3520
3521 ``fpi``
3522 Format Progress Indicator, see :c:type:`enum nvme_nd_ns_fpi <nvme_nd_ns_fpi>`.
3523
3524 ``dlfeat``
3525 Deallocate Logical Block Features, see :c:type:`enum nvme_id_ns_dlfeat <nvme_id_ns_dlfeat>`.
3526
3527 ``nawun``
3528 Namespace Atomic Write Unit Normal indicates the
3529 namespace specific size of the write operation guaranteed to be
3530 written atomically to the NVM during normal operation.
3531
3532 ``nawupf``
3533 Namespace Atomic Write Unit Power Fail indicates the
3534 namespace specific size of the write operation guaranteed to be
3535 written atomically to the NVM during a power fail or error
3536 condition.
3537
3538 ``nacwu``
3539 Namespace Atomic Compare & Write Unit indicates the namespace
3540 specific size of the write operation guaranteed to be written
3541 atomically to the NVM for a Compare and Write fused command.
3542
3543 ``nabsn``
3544 Namespace Atomic Boundary Size Normal indicates the atomic
3545 boundary size for this namespace for the NAWUN value. This field
3546 is specified in logical blocks.
3547
3548 ``nabo``
3549 Namespace Atomic Boundary Offset indicates the LBA on this
3550 namespace where the first atomic boundary starts.
3551
3552 ``nabspf``
3553 Namespace Atomic Boundary Size Power Fail indicates the atomic
3554 boundary size for this namespace specific to the Namespace Atomic
3555 Write Unit Power Fail value. This field is specified in logical
3556 blocks.
3557
3558 ``noiob``
3559 Namespace Optimal I/O Boundary indicates the optimal I/O boundary
3560 for this namespace. This field is specified in logical blocks.
3561 The host should construct Read and Write commands that do not
3562 cross the I/O boundary to achieve optimal performance.
3563
3564 ``nvmcap``
3565 NVM Capacity indicates the total size of the NVM allocated to
3566 this namespace. The value is in bytes.
3567
3568 ``npwg``
3569 Namespace Preferred Write Granularity indicates the smallest
3570 recommended write granularity in logical blocks for this
3571 namespace. This is a 0's based value.
3572
3573 ``npwa``
3574 Namespace Preferred Write Alignment indicates the recommended
3575 write alignment in logical blocks for this namespace. This is a
3576 0's based value.
3577
3578 ``npdg``
3579 Namespace Preferred Deallocate Granularity indicates the
3580 recommended granularity in logical blocks for the Dataset
3581 Management command with the Attribute - Deallocate bit.
3582
3583 ``npda``
3584 Namespace Preferred Deallocate Alignment indicates the
3585 recommended alignment in logical blocks for the Dataset
3586 Management command with the Attribute - Deallocate bit
3587
3588 ``nows``
3589 Namespace Optimal Write Size indicates the size in logical blocks
3590 for optimal write performance for this namespace. This is a 0's
3591 based value.
3592
3593 ``mssrl``
3594 Maximum Single Source Range Length indicates the maximum number
3595 of logical blocks that may be specified in each valid Source Range
3596 field of a Copy command.
3597
3598 ``mcl``
3599 Maximum Copy Length indicates the maximum number of logical
3600 blocks that may be specified in a Copy command.
3601
3602 ``msrc``
3603 Maximum Source Range Count indicates the maximum number of Source
3604 Range entries that may be used to specify source data in a Copy
3605 command. This is a 0’s based value.
3606
3607 ``kpios``
3608 Key Per I/O Status indicates namespace Key Per I/O capability status.
3609
3610 ``nulbaf``
3611 Number of Unique Capability LBA Formats defines the number of
3612 supported user data size and metadata size combinations supported
3613 by the namespace that may not share the same capabilities. LBA
3614 formats shall be allocated in order and packed sequentially.
3615
3616 ``rsvd83``
3617 Reserved
3618
3619 ``kpiodaag``
3620 Key Per I/O Data Access Alignment and Granularity indicates the
3621 alignment and granularity in logical blocks that is required
3622 for commands that support a KPIOTAG value in the CETYPE field.
3623
3624 ``rsvd88``
3625 Reserved
3626
3627 ``anagrpid``
3628 ANA Group Identifier indicates the ANA Group Identifier of the
3629 ANA group of which the namespace is a member.
3630
3631 ``rsvd96``
3632 Reserved
3633
3634 ``nsattr``
3635 Namespace Attributes, see :c:type:`enum nvme_id_ns_attr <nvme_id_ns_attr>`.
3636
3637 ``nvmsetid``
3638 NVM Set Identifier indicates the NVM Set with which this
3639 namespace is associated.
3640
3641 ``endgid``
3642 Endurance Group Identifier indicates the Endurance Group with
3643 which this namespace is associated.
3644
3645 ``nguid``
3646 Namespace Globally Unique Identifier contains a 128-bit value
3647 that is globally unique and assigned to the namespace when the
3648 namespace is created. This field remains fixed throughout the
3649 life of the namespace and is preserved across namespace and
3650 controller operations
3651
3652 ``eui64``
3653 IEEE Extended Unique Identifier contains a 64-bit IEEE Extended
3654 Unique Identifier (EUI-64) that is globally unique and assigned
3655 to the namespace when the namespace is created. This field
3656 remains fixed throughout the life of the namespace and is
3657 preserved across namespace and controller operations
3658
3659 ``lbaf``
3660 LBA Format, see :c:type:`struct nvme_lbaf <nvme_lbaf>`.
3661
3662 ``vs``
3663 Vendor Specific
3664
3665
3666
3667
3668
3669 .. c:type:: enum nvme_id_nsfeat
3670
3671 This field defines features of the namespace.
3672
3673 **Constants**
3674
3675 ``NVME_NS_FEAT_THIN``
3676 If set, indicates that the namespace supports thin
3677 provisioning. Specifically, the Namespace Capacity
3678 reported may be less than the Namespace Size.
3679
3680 ``NVME_NS_FEAT_NATOMIC``
3681 If set, indicates that the fields NAWUN, NAWUPF, and
3682 NACWU are defined for this namespace and should be
3683 used by the host for this namespace instead of the
3684 AWUN, AWUPF, and ACWU fields in the Identify
3685 Controller data structure.
3686
3687 ``NVME_NS_FEAT_DULBE``
3688 If set, indicates that the controller supports the
3689 Deallocated or Unwritten Logical Block error for
3690 this namespace.
3691
3692 ``NVME_NS_FEAT_ID_REUSE``
3693 If set, indicates that the value in the NGUID field
3694 for this namespace, if non- zero, is never reused by
3695 the controller and that the value in the EUI64 field
3696 for this namespace, if non-zero, is never reused by
3697 the controller.
3698
3699 ``NVME_NS_FEAT_IO_OPT``
3700 If set, indicates that the fields NPWG, NPWA, NPDG,
3701 NPDA, and NOWS are defined for this namespace and
3702 should be used by the host for I/O optimization
3703
3704
3705
3706
3707 .. c:type:: enum nvme_id_ns_flbas
3708
3709 This field indicates the LBA data size & metadata size combination that the namespace has been formatted with
3710
3711 **Constants**
3712
3713 ``NVME_NS_FLBAS_LOWER_MASK``
3714 Mask to get the index of one of the supported
3715 LBA Formats's least significant
3716 4bits indicated in
3717 :c:type:`struct nvme_id_ns <nvme_id_ns>`.lbaf.
3718
3719 ``NVME_NS_FLBAS_META_EXT``
3720 Applicable only if format contains metadata. If
3721 this bit is set, indicates that the metadata is
3722 transferred at the end of the data LBA, creating an
3723 extended data LBA. If cleared, indicates that all
3724 of the metadata for a command is transferred as a
3725 separate contiguous buffer of data.
3726
3727 ``NVME_NS_FLBAS_HIGHER_MASK``
3728 Mask to get the index of one of
3729 the supported LBA Formats's most significant
3730 2bits indicated in
3731 :c:type:`struct nvme_id_ns <nvme_id_ns>`.lbaf.
3732
3733
3734
3735
3736 .. c:type:: enum nvme_nvm_id_ns_elbaf
3737
3738 This field indicates the extended LBA format
3739
3740 **Constants**
3741
3742 ``NVME_NVM_ELBAF_STS_MASK``
3743 Mask to get the storage tag size used to determine
3744 the variable-sized storage tag/reference tag fields
3745
3746 ``NVME_NVM_ELBAF_PIF_MASK``
3747 Mask to get the protection information format for
3748 the extended LBA format.
3749
3750 ``NVME_NVM_ELBAF_QPIF_MASK``
3751 Mask to get the Qualified Protection Information
3752 Format.
3753
3754
3755
3756
3757 .. c:type:: enum nvme_nvm_id_ns_pif
3758
3759 This field indicates the type of the Protection Information Format
3760
3761 **Constants**
3762
3763 ``NVME_NVM_PIF_16B_GUARD``
3764 16-bit Guard Protection Information Format
3765
3766 ``NVME_NVM_PIF_32B_GUARD``
3767 32-bit Guard Protection Information Format
3768
3769 ``NVME_NVM_PIF_64B_GUARD``
3770 64-bit Guard Protection Information Format
3771
3772 ``NVME_NVM_PIF_QTYPE``
3773 If Qualified Protection Information Format Supports
3774 and Protection Information Format is set to 3, then
3775 protection information format is taken from Qualified
3776 Protection Information Format field.
3777
3778
3779
3780
3781 .. c:type:: enum nvme_id_ns_mc
3782
3783 This field indicates the capabilities for metadata.
3784
3785 **Constants**
3786
3787 ``NVME_NS_MC_EXTENDED``
3788 If set, indicates the namespace supports the metadata
3789 being transferred as part of a separate buffer that is
3790 specified in the Metadata Pointer.
3791
3792 ``NVME_NS_MC_SEPARATE``
3793 If set, indicates that the namespace supports the
3794 metadata being transferred as part of an extended data LBA.
3795
3796
3797
3798
3799 .. c:type:: enum nvme_id_ns_dpc
3800
3801 This field indicates the capabilities for the end-to-end data protection feature.
3802
3803 **Constants**
3804
3805 ``NVME_NS_DPC_PI_TYPE1``
3806 If set, indicates that the namespace supports
3807 Protection Information Type 1.
3808
3809 ``NVME_NS_DPC_PI_TYPE2``
3810 If set, indicates that the namespace supports
3811 Protection Information Type 2.
3812
3813 ``NVME_NS_DPC_PI_TYPE3``
3814 If set, indicates that the namespace supports
3815 Protection Information Type 3.
3816
3817 ``NVME_NS_DPC_PI_FIRST``
3818 If set, indicates that the namespace supports
3819 protection information transferred as the first eight
3820 bytes of metadata.
3821
3822 ``NVME_NS_DPC_PI_LAST``
3823 If set, indicates that the namespace supports
3824 protection information transferred as the last eight
3825 bytes of metadata.
3826
3827
3828
3829
3830 .. c:type:: enum nvme_id_ns_dps
3831
3832 This field indicates the Type settings for the end-to-end data protection feature.
3833
3834 **Constants**
3835
3836 ``NVME_NS_DPS_PI_NONE``
3837 Protection information is not enabled
3838
3839 ``NVME_NS_DPS_PI_TYPE1``
3840 Protection information is enabled, Type 1
3841
3842 ``NVME_NS_DPS_PI_TYPE2``
3843 Protection information is enabled, Type 2
3844
3845 ``NVME_NS_DPS_PI_TYPE3``
3846 Protection information is enabled, Type 3
3847
3848 ``NVME_NS_DPS_PI_MASK``
3849 Mask to get the value of the PI type
3850
3851 ``NVME_NS_DPS_PI_FIRST``
3852 If set, indicates that the protection information, if
3853 enabled, is transferred as the first eight bytes of
3854 metadata.
3855
3856
3857
3858
3859 .. c:type:: enum nvme_id_ns_nmic
3860
3861 This field specifies multi-path I/O and namespace sharing capabilities of the namespace.
3862
3863 **Constants**
3864
3865 ``NVME_NS_NMIC_SHARED``
3866 If set, then the namespace may be attached to two or
3867 more controllers in the NVM subsystem concurrently
3868
3869
3870
3871
3872 .. c:type:: enum nvme_id_ns_rescap
3873
3874 This field indicates the reservation capabilities of the namespace.
3875
3876 **Constants**
3877
3878 ``NVME_NS_RESCAP_PTPL``
3879 If set, indicates that the namespace supports the
3880 Persist Through Power Loss capability.
3881
3882 ``NVME_NS_RESCAP_WE``
3883 If set, indicates that the namespace supports the
3884 Write Exclusive reservation type.
3885
3886 ``NVME_NS_RESCAP_EA``
3887 If set, indicates that the namespace supports the
3888 Exclusive Access reservation type.
3889
3890 ``NVME_NS_RESCAP_WERO``
3891 If set, indicates that the namespace supports the
3892 Write Exclusive - Registrants Only reservation type.
3893
3894 ``NVME_NS_RESCAP_EARO``
3895 If set, indicates that the namespace supports the
3896 Exclusive Access - Registrants Only reservation type.
3897
3898 ``NVME_NS_RESCAP_WEAR``
3899 If set, indicates that the namespace supports the
3900 Write Exclusive - All Registrants reservation type.
3901
3902 ``NVME_NS_RESCAP_EAAR``
3903 If set, indicates that the namespace supports the
3904 Exclusive Access - All Registrants reservation type.
3905
3906 ``NVME_NS_RESCAP_IEK_13``
3907 If set, indicates that Ignore Existing Key is used
3908 as defined in revision 1.3 or later of this specification.
3909
3910
3911
3912
3913 .. c:type:: enum nvme_nd_ns_fpi
3914
3915 If a format operation is in progress, this field indicates the percentage of the namespace that remains to be formatted.
3916
3917 **Constants**
3918
3919 ``NVME_NS_FPI_REMAINING``
3920 Mask to get the format percent remaining value
3921
3922 ``NVME_NS_FPI_SUPPORTED``
3923 If set, indicates that the namespace supports the
3924 Format Progress Indicator defined for the field.
3925
3926
3927
3928
3929 .. c:type:: enum nvme_id_ns_dlfeat
3930
3931 This field indicates information about features that affect deallocating logical blocks for this namespace.
3932
3933 **Constants**
3934
3935 ``NVME_NS_DLFEAT_RB``
3936 Mask to get the value of the read behavior
3937
3938 ``NVME_NS_DLFEAT_RB_NR``
3939 Read behvaior is not reported
3940
3941 ``NVME_NS_DLFEAT_RB_ALL_0S``
3942 A deallocated logical block returns all bytes
3943 cleared to 0h.
3944
3945 ``NVME_NS_DLFEAT_RB_ALL_FS``
3946 A deallocated logical block returns all bytes
3947 set to FFh.
3948
3949 ``NVME_NS_DLFEAT_WRITE_ZEROES``
3950 If set, indicates that the controller supports
3951 the Deallocate bit in the Write Zeroes command
3952 for this namespace.
3953
3954 ``NVME_NS_DLFEAT_CRC_GUARD``
3955 If set, indicates that the Guard field for
3956 deallocated logical blocks that contain
3957 protection information is set to the CRC for
3958 the value read from the deallocated logical
3959 block and its metadata
3960
3961
3962
3963
3964 .. c:type:: enum nvme_id_ns_attr
3965
3966 Specifies attributes of the namespace.
3967
3968 **Constants**
3969
3970 ``NVME_NS_NSATTR_WRITE_PROTECTED``
3971 If set, then the namespace is currently
3972 write protected and all write access to the
3973 namespace shall fail.
3974
3975
3976
3977
3978 .. c:type:: struct nvme_ns_id_desc
3979
3980 Namespace identifier type descriptor
3981
3982 **Definition**
3983
3984 ::
3985
3986 struct nvme_ns_id_desc {
3987 __u8 nidt;
3988 __u8 nidl;
3989 __le16 rsvd;
3990 __u8 nid[];
3991 };
3992
3993 **Members**
3994
3995 ``nidt``
3996 Namespace Identifier Type, see :c:type:`enum nvme_ns_id_desc_nidt <nvme_ns_id_desc_nidt>`
3997
3998 ``nidl``
3999 Namespace Identifier Length contains the length in bytes of the
4000 :c:type:`struct nvme_id_ns <nvme_id_ns>`.nid.
4001
4002 ``rsvd``
4003 Reserved
4004
4005 ``nid``
4006 Namespace Identifier contains a value that is globally unique and
4007 assigned to the namespace when the namespace is created. The length
4008 is defined in :c:type:`struct nvme_id_ns <nvme_id_ns>`.nidl.
4009
4010
4011
4012
4013
4014 .. c:type:: enum nvme_ns_id_desc_nidt
4015
4016 Known namespace identifier types
4017
4018 **Constants**
4019
4020 ``NVME_NIDT_EUI64``
4021 IEEE Extended Unique Identifier, the NID field contains a
4022 copy of the EUI64 field in the struct nvme_id_ns.eui64.
4023
4024 ``NVME_NIDT_NGUID``
4025 Namespace Globally Unique Identifier, the NID field
4026 contains a copy of the NGUID field in struct nvme_id_ns.nguid.
4027
4028 ``NVME_NIDT_UUID``
4029 The NID field contains a 128-bit Universally Unique
4030 Identifier (UUID) as specified in RFC 4122.
4031
4032 ``NVME_NIDT_CSI``
4033 The NID field contains the command set identifier.
4034
4035
4036
4037
4038 .. c:type:: struct nvme_nvmset_attr
4039
4040 NVM Set Attributes Entry
4041
4042 **Definition**
4043
4044 ::
4045
4046 struct nvme_nvmset_attr {
4047 __le16 nvmsetid;
4048 __le16 endgid;
4049 __u8 rsvd4[4];
4050 __le32 rr4kt;
4051 __le32 ows;
4052 __u8 tnvmsetcap[16];
4053 __u8 unvmsetcap[16];
4054 __u8 rsvd48[80];
4055 };
4056
4057 **Members**
4058
4059 ``nvmsetid``
4060 NVM Set Identifier
4061
4062 ``endgid``
4063 Endurance Group Identifier
4064
4065 ``rsvd4``
4066 Reserved
4067
4068 ``rr4kt``
4069 Random 4 KiB Read Typical indicates the typical
4070 time to complete a 4 KiB random read in 100 nanosecond units
4071 when the NVM Set is in a Predictable Latency Mode Deterministic
4072 Window and there is 1 outstanding command per NVM Set.
4073
4074 ``ows``
4075 Optimal Write Size
4076
4077 ``tnvmsetcap``
4078 Total NVM Set Capacity
4079
4080 ``unvmsetcap``
4081 Unallocated NVM Set Capacity
4082
4083 ``rsvd48``
4084 Reserved
4085
4086
4087
4088
4089
4090 .. c:type:: struct nvme_id_nvmset_list
4091
4092 NVM set list
4093
4094 **Definition**
4095
4096 ::
4097
4098 struct nvme_id_nvmset_list {
4099 __u8 nid;
4100 __u8 rsvd1[127];
4101 struct nvme_nvmset_attr ent[NVME_ID_NVMSET_LIST_MAX];
4102 };
4103
4104 **Members**
4105
4106 ``nid``
4107 Nvmset id
4108
4109 ``rsvd1``
4110 Reserved
4111
4112 ``ent``
4113 nvmset id list
4114
4115
4116
4117
4118
4119 .. c:type:: struct nvme_id_independent_id_ns
4120
4121 Identify - I/O Command Set Independent Identify Namespace Data Structure
4122
4123 **Definition**
4124
4125 ::
4126
4127 struct nvme_id_independent_id_ns {
4128 __u8 nsfeat;
4129 __u8 nmic;
4130 __u8 rescap;
4131 __u8 fpi;
4132 __le32 anagrpid;
4133 __u8 nsattr;
4134 __u8 rsvd9;
4135 __le16 nvmsetid;
4136 __le16 endgid;
4137 __u8 nstat;
4138 __u8 kpios;
4139 __le16 maxkt;
4140 __u8 rsvd18[2];
4141 __le32 rgrpid;
4142 __u8 rsvd24[4072];
4143 };
4144
4145 **Members**
4146
4147 ``nsfeat``
4148 common namespace features
4149
4150 ``nmic``
4151 Namespace Multi-path I/O and Namespace
4152 Sharing Capabilities
4153
4154 ``rescap``
4155 Reservation Capabilities
4156
4157 ``fpi``
4158 Format Progress Indicator
4159
4160 ``anagrpid``
4161 ANA Group Identifier
4162
4163 ``nsattr``
4164 Namespace Attributes
4165
4166 ``rsvd9``
4167 reserved
4168
4169 ``nvmsetid``
4170 NVM Set Identifier
4171
4172 ``endgid``
4173 Endurance Group Identifier
4174
4175 ``nstat``
4176 Namespace Status
4177
4178 ``kpios``
4179 Key Per I/O Status
4180
4181 ``maxkt``
4182 Maximum Key Tag
4183
4184 ``rsvd18``
4185 Reserved
4186
4187 ``rgrpid``
4188 Reachability Group Identifier
4189
4190 ``rsvd24``
4191 Reserved
4192
4193
4194
4195
4196
4197 .. c:type:: struct nvme_id_ns_granularity_desc
4198
4199 Namespace Granularity Descriptor
4200
4201 **Definition**
4202
4203 ::
4204
4205 struct nvme_id_ns_granularity_desc {
4206 __le64 nszegran;
4207 __le64 ncapgran;
4208 };
4209
4210 **Members**
4211
4212 ``nszegran``
4213 Namespace Size Granularity
4214
4215 ``ncapgran``
4216 Namespace Capacity Granularity
4217
4218
4219
4220
4221
4222 .. c:type:: struct nvme_id_ns_granularity_list
4223
4224 Namespace Granularity List
4225
4226 **Definition**
4227
4228 ::
4229
4230 struct nvme_id_ns_granularity_list {
4231 __le32 attributes;
4232 __u8 num_descriptors;
4233 __u8 rsvd5[27];
4234 struct nvme_id_ns_granularity_desc entry[NVME_ID_ND_DESCRIPTOR_MAX];
4235 __u8 rsvd288[3808];
4236 };
4237
4238 **Members**
4239
4240 ``attributes``
4241 Namespace Granularity Attributes
4242
4243 ``num_descriptors``
4244 Number of Descriptors
4245
4246 ``rsvd5``
4247 reserved
4248
4249 ``entry``
4250 Namespace Granularity Descriptor
4251
4252 ``rsvd288``
4253 reserved
4254
4255
4256
4257
4258
4259 .. c:type:: struct nvme_id_uuid_list_entry
4260
4261 UUID List Entry
4262
4263 **Definition**
4264
4265 ::
4266
4267 struct nvme_id_uuid_list_entry {
4268 __u8 header;
4269 __u8 rsvd1[15];
4270 __u8 uuid[16];
4271 };
4272
4273 **Members**
4274
4275 ``header``
4276 UUID Lists Entry Header
4277
4278 ``rsvd1``
4279 reserved
4280
4281 ``uuid``
4282 128-bit Universally Unique Identifier
4283
4284
4285
4286
4287
4288 .. c:type:: enum nvme_id_uuid
4289
4290 Identifier Association
4291
4292 **Constants**
4293
4294 ``NVME_ID_UUID_HDR_ASSOCIATION_MASK``
4295
4296 ``NVME_ID_UUID_ASSOCIATION_NONE``
4297
4298 ``NVME_ID_UUID_ASSOCIATION_VENDOR``
4299
4300 ``NVME_ID_UUID_ASSOCIATION_SUBSYSTEM_VENDOR``
4301
4302
4303
4304
4305 .. c:type:: struct nvme_id_uuid_list
4306
4307 UUID list
4308
4309 **Definition**
4310
4311 ::
4312
4313 struct nvme_id_uuid_list {
4314 __u8 rsvd0[32];
4315 struct nvme_id_uuid_list_entry entry[NVME_ID_UUID_LIST_MAX];
4316 };
4317
4318 **Members**
4319
4320 ``rsvd0``
4321 reserved
4322
4323 ``entry``
4324 UUID list entry
4325
4326
4327
4328
4329
4330 .. c:type:: struct nvme_ctrl_list
4331
4332 Controller List
4333
4334 **Definition**
4335
4336 ::
4337
4338 struct nvme_ctrl_list {
4339 __le16 num;
4340 __le16 identifier[NVME_ID_CTRL_LIST_MAX];
4341 };
4342
4343 **Members**
4344
4345 ``num``
4346 Number of Identifiers
4347
4348 ``identifier``
4349 NVM subsystem unique controller identifier
4350
4351
4352
4353
4354
4355 .. c:type:: struct nvme_ns_list
4356
4357 Namespace List
4358
4359 **Definition**
4360
4361 ::
4362
4363 struct nvme_ns_list {
4364 __le32 ns[NVME_ID_NS_LIST_MAX];
4365 };
4366
4367 **Members**
4368
4369 ``ns``
4370 Namespace Identifier
4371
4372
4373
4374
4375
4376 .. c:type:: enum nvme_id_ctrl_nvm_lbamqf
4377
4378 LBA Migration Queue Format
4379
4380 **Constants**
4381
4382 ``NVME_ID_CTRL_NVM_LBAMQF_TYPE_0``
4383
4384 ``NVME_ID_CTRL_NVM_LBAMQF_VENDOR_MIN``
4385
4386 ``NVME_ID_CTRL_NVM_LBAMQF_VENDOR_MAX``
4387
4388
4389
4390
4391 .. c:type:: struct nvme_id_ctrl_nvm
4392
4393 I/O Command Set Specific Identify Controller data structure
4394
4395 **Definition**
4396
4397 ::
4398
4399 struct nvme_id_ctrl_nvm {
4400 __u8 vsl;
4401 __u8 wzsl;
4402 __u8 wusl;
4403 __u8 dmrl;
4404 __le32 dmrsl;
4405 __le64 dmsl;
4406 __u8 kpiocap;
4407 __u8 wzdsl;
4408 __le16 aocs;
4409 __le32 ver;
4410 __u8 lbamqf;
4411 __u8 rsvd25[4071];
4412 };
4413
4414 **Members**
4415
4416 ``vsl``
4417 Verify Size Limit
4418
4419 ``wzsl``
4420 Write Zeroes Size Limit
4421
4422 ``wusl``
4423 Write Uncorrectable Size Limit
4424
4425 ``dmrl``
4426 Dataset Management Ranges Limit
4427
4428 ``dmrsl``
4429 Dataset Management Range Size Limit
4430
4431 ``dmsl``
4432 Dataset Management Size Limit
4433
4434 ``kpiocap``
4435 Key Per I/O Capabilities
4436
4437 ``wzdsl``
4438 Write Zeroes With Deallocate Size Limit
4439
4440 ``aocs``
4441 Admin Optional Command Support
4442
4443 ``ver``
4444 Version
4445
4446 ``lbamqf``
4447 LBA Migration Queue Format
4448
4449 ``rsvd25``
4450 Reserved
4451
4452
4453
4454
4455
4456 .. c:type:: struct nvme_nvm_id_ns
4457
4458 NVME Command Set I/O Command Set Specific Identify Namespace Data Structure
4459
4460 **Definition**
4461
4462 ::
4463
4464 struct nvme_nvm_id_ns {
4465 __le64 lbstm;
4466 __u8 pic;
4467 __u8 pifa;
4468 __u8 rsvd10[2];
4469 __le32 elbaf[64];
4470 __le32 npdgl;
4471 __le32 nprg;
4472 __le32 npra;
4473 __le32 nors;
4474 __le32 npdal;
4475 __le32 lbapss;
4476 __le32 tlbaag;
4477 __u8 rsvd296[3800];
4478 };
4479
4480 **Members**
4481
4482 ``lbstm``
4483 Logical Block Storage Tag Mask
4484
4485 ``pic``
4486 Protection Information Capabilities
4487
4488 ``pifa``
4489 Protection Information Format Attribute
4490
4491 ``rsvd10``
4492 Reserved
4493
4494 ``elbaf``
4495 List of Extended LBA Format Support
4496
4497 ``npdgl``
4498 Namespace Preferred Deallocate Granularity Large
4499
4500 ``nprg``
4501 Namespace Preferred Read Granularity
4502
4503 ``npra``
4504 Namespace Preferred Read Alignment
4505
4506 ``nors``
4507 Namespace Optimal Read Size
4508
4509 ``npdal``
4510 Namespace Preferred Deallocate Alignment Large
4511
4512 ``lbapss``
4513 LBA Format Placement Shard Size
4514
4515 ``tlbaag``
4516 Tracked LBA Allocation Granularity
4517
4518 ``rsvd296``
4519 Reserved
4520
4521
4522
4523
4524
4525 .. c:type:: struct nvme_zns_lbafe
4526
4527 LBA Format Extension Data Structure
4528
4529 **Definition**
4530
4531 ::
4532
4533 struct nvme_zns_lbafe {
4534 __le64 zsze;
4535 __u8 zdes;
4536 __u8 rsvd9[7];
4537 };
4538
4539 **Members**
4540
4541 ``zsze``
4542 Zone Size
4543
4544 ``zdes``
4545 Zone Descriptor Extension Size
4546
4547 ``rsvd9``
4548 reserved
4549
4550
4551
4552
4553
4554 .. c:type:: struct nvme_zns_id_ns
4555
4556 Zoned Namespace Command Set Specific Identify Namespace Data Structure
4557
4558 **Definition**
4559
4560 ::
4561
4562 struct nvme_zns_id_ns {
4563 __le16 zoc;
4564 __le16 ozcs;
4565 __le32 mar;
4566 __le32 mor;
4567 __le32 rrl;
4568 __le32 frl;
4569 __le32 rrl1;
4570 __le32 rrl2;
4571 __le32 rrl3;
4572 __le32 frl1;
4573 __le32 frl2;
4574 __le32 frl3;
4575 __le32 numzrwa;
4576 __le16 zrwafg;
4577 __le16 zrwasz;
4578 __u8 zrwacap;
4579 __u8 rsvd53[2763];
4580 struct nvme_zns_lbafe lbafe[64];
4581 __u8 vs[256];
4582 };
4583
4584 **Members**
4585
4586 ``zoc``
4587 Zone Operation Characteristics
4588
4589 ``ozcs``
4590 Optional Zoned Command Support
4591
4592 ``mar``
4593 Maximum Active Resources
4594
4595 ``mor``
4596 Maximum Open Resources
4597
4598 ``rrl``
4599 Reset Recommended Limit
4600
4601 ``frl``
4602 Finish Recommended Limit
4603
4604 ``rrl1``
4605 Reset Recommended Limit 1
4606
4607 ``rrl2``
4608 Reset Recommended Limit 2
4609
4610 ``rrl3``
4611 Reset Recommended Limit 3
4612
4613 ``frl1``
4614 Finish Recommended Limit 1
4615
4616 ``frl2``
4617 Finish Recommended Limit 2
4618
4619 ``frl3``
4620 Finish Recommended Limit 3
4621
4622 ``numzrwa``
4623 Number of ZRWA Resources
4624
4625 ``zrwafg``
4626 ZRWA Flush Granularity
4627
4628 ``zrwasz``
4629 ZRWA Size
4630
4631 ``zrwacap``
4632 ZRWA Capability
4633
4634 ``rsvd53``
4635 Reserved
4636
4637 ``lbafe``
4638 LBA Format Extension
4639
4640 ``vs``
4641 Vendor Specific
4642
4643
4644
4645
4646
4647 .. c:type:: struct nvme_zns_id_ctrl
4648
4649 I/O Command Set Specific Identify Controller Data Structure for the Zoned Namespace Command Set
4650
4651 **Definition**
4652
4653 ::
4654
4655 struct nvme_zns_id_ctrl {
4656 __u8 zasl;
4657 __u8 rsvd1[4095];
4658 };
4659
4660 **Members**
4661
4662 ``zasl``
4663 Zone Append Size Limit
4664
4665 ``rsvd1``
4666 Reserved
4667
4668
4669
4670
4671
4672 .. c:type:: struct nvme_primary_ctrl_cap
4673
4674 Identify - Controller Capabilities Structure
4675
4676 **Definition**
4677
4678 ::
4679
4680 struct nvme_primary_ctrl_cap {
4681 __le16 cntlid;
4682 __le16 portid;
4683 __u8 crt;
4684 __u8 rsvd5[27];
4685 __le32 vqfrt;
4686 __le32 vqrfa;
4687 __le16 vqrfap;
4688 __le16 vqprt;
4689 __le16 vqfrsm;
4690 __le16 vqgran;
4691 __u8 rsvd48[16];
4692 __le32 vifrt;
4693 __le32 virfa;
4694 __le16 virfap;
4695 __le16 viprt;
4696 __le16 vifrsm;
4697 __le16 vigran;
4698 __u8 rsvd80[4016];
4699 };
4700
4701 **Members**
4702
4703 ``cntlid``
4704 Controller Identifier
4705
4706 ``portid``
4707 Port Identifier
4708
4709 ``crt``
4710 Controller Resource Types
4711
4712 ``rsvd5``
4713 reserved
4714
4715 ``vqfrt``
4716 VQ Resources Flexible Total
4717
4718 ``vqrfa``
4719 VQ Resources Flexible Assigned
4720
4721 ``vqrfap``
4722 VQ Resources Flexible Allocated to Primary
4723
4724 ``vqprt``
4725 VQ Resources Private Total
4726
4727 ``vqfrsm``
4728 VQ Resources Flexible Secondary Maximum
4729
4730 ``vqgran``
4731 VQ Flexible Resource Preferred Granularity
4732
4733 ``rsvd48``
4734 reserved
4735
4736 ``vifrt``
4737 VI Resources Flexible Total
4738
4739 ``virfa``
4740 VI Resources Flexible Assigned
4741
4742 ``virfap``
4743 VI Resources Flexible Allocated to Primary
4744
4745 ``viprt``
4746 VI Resources Private Total
4747
4748 ``vifrsm``
4749 VI Resources Flexible Secondary Maximum
4750
4751 ``vigran``
4752 VI Flexible Resource Preferred Granularity
4753
4754 ``rsvd80``
4755 reserved
4756
4757
4758
4759
4760
4761 .. c:type:: struct nvme_secondary_ctrl
4762
4763 Secondary Controller Entry
4764
4765 **Definition**
4766
4767 ::
4768
4769 struct nvme_secondary_ctrl {
4770 __le16 scid;
4771 __le16 pcid;
4772 __u8 scs;
4773 __u8 rsvd5[3];
4774 __le16 vfn;
4775 __le16 nvq;
4776 __le16 nvi;
4777 __u8 rsvd14[18];
4778 };
4779
4780 **Members**
4781
4782 ``scid``
4783 Secondary Controller Identifier
4784
4785 ``pcid``
4786 Primary Controller Identifier
4787
4788 ``scs``
4789 Secondary Controller State
4790
4791 ``rsvd5``
4792 Reserved
4793
4794 ``vfn``
4795 Virtual Function Number
4796
4797 ``nvq``
4798 Number of VQ Flexible Resources Assigned
4799
4800 ``nvi``
4801 Number of VI Flexible Resources Assigned
4802
4803 ``rsvd14``
4804 Reserved
4805
4806
4807
4808
4809
4810 .. c:type:: struct nvme_secondary_ctrl_list
4811
4812 Secondary Controller List
4813
4814 **Definition**
4815
4816 ::
4817
4818 struct nvme_secondary_ctrl_list {
4819 __u8 num;
4820 __u8 rsvd[31];
4821 struct nvme_secondary_ctrl sc_entry[NVME_ID_SECONDARY_CTRL_MAX];
4822 };
4823
4824 **Members**
4825
4826 ``num``
4827 Number of Identifiers
4828
4829 ``rsvd``
4830 Reserved
4831
4832 ``sc_entry``
4833 Secondary Controller Entry
4834
4835
4836
4837
4838
4839 .. c:type:: struct nvme_id_iocs
4840
4841 NVMe Identify IO Command Set data structure
4842
4843 **Definition**
4844
4845 ::
4846
4847 struct nvme_id_iocs {
4848 __le64 iocsc[512];
4849 };
4850
4851 **Members**
4852
4853 ``iocsc``
4854 List of supported IO Command Set Combination vectors
4855
4856
4857
4858
4859
4860 .. c:type:: enum nvme_id_iocs_iocsc
4861
4862 This field indicates the Identify I/O Command Set Data Structure
4863
4864 **Constants**
4865
4866 ``NVME_IOCS_IOCSC_NVMCS_SHIFT``
4867 Shift amount to get the value of NVM Command Set
4868
4869 ``NVME_IOCS_IOCSC_NVMCS_MASK``
4870 Mask to get the value of NVM Command Set
4871
4872 ``NVME_IOCS_IOCSC_KVCS_SHIFT``
4873 Shift amount to get the value of Key Value Command Set
4874
4875 ``NVME_IOCS_IOCSC_KVCS_MASK``
4876 Mask to get the value of Key Value Command Set
4877
4878 ``NVME_IOCS_IOCSC_ZNSCS_SHIFT``
4879 Shift amount to get the value of Zoned Namespace Command
4880 Set
4881
4882 ``NVME_IOCS_IOCSC_ZNSCS_MASK``
4883 Mask to get the value of Zoned Namespace Command Set
4884
4885 ``NVME_IOCS_IOCSC_SLMCS_SHIFT``
4886 Shift amount to get the value of Subsystem Local Memory
4887 Command Set
4888
4889 ``NVME_IOCS_IOCSC_SLMCS_MASK``
4890 Mask to get the value of Subsystem Local Memory Command Set
4891
4892 ``NVME_IOCS_IOCSC_CPNCS_SHIFT``
4893 Shift amount to get the value of Computational Programs
4894 Namespace Command Set
4895
4896 ``NVME_IOCS_IOCSC_CPNCS_MASK``
4897 Mask to get the value of Computational Programs Namespace
4898 Command Set
4899
4900
4901
4902
4903 .. c:type:: struct nvme_id_domain_attr
4904
4905 Domain Attributes Entry
4906
4907 **Definition**
4908
4909 ::
4910
4911 struct nvme_id_domain_attr {
4912 __le16 dom_id;
4913 __u8 rsvd2[14];
4914 __u8 dom_cap[16];
4915 __u8 unalloc_dom_cap[16];
4916 __u8 max_egrp_dom_cap[16];
4917 __u8 rsvd64[64];
4918 };
4919
4920 **Members**
4921
4922 ``dom_id``
4923 Domain Identifier
4924
4925 ``rsvd2``
4926 Reserved
4927
4928 ``dom_cap``
4929 Total Domain Capacity
4930
4931 ``unalloc_dom_cap``
4932 Unallocated Domain Capacity
4933
4934 ``max_egrp_dom_cap``
4935 Max Endurance Group Domain Capacity
4936
4937 ``rsvd64``
4938 Reserved
4939
4940
4941
4942
4943
4944 .. c:type:: struct nvme_id_domain_list
4945
4946 Domain List
4947
4948 **Definition**
4949
4950 ::
4951
4952 struct nvme_id_domain_list {
4953 __u8 num;
4954 __u8 rsvd[127];
4955 struct nvme_id_domain_attr domain_attr[NVME_ID_DOMAIN_LIST_MAX];
4956 };
4957
4958 **Members**
4959
4960 ``num``
4961 Number of domain attributes
4962
4963 ``rsvd``
4964 Reserved
4965
4966 ``domain_attr``
4967 List of domain attributes
4968
4969
4970
4971
4972
4973 .. c:type:: struct nvme_id_endurance_group_list
4974
4975 Endurance Group List
4976
4977 **Definition**
4978
4979 ::
4980
4981 struct nvme_id_endurance_group_list {
4982 __le16 num;
4983 __le16 identifier[NVME_ID_ENDURANCE_GROUP_LIST_MAX];
4984 };
4985
4986 **Members**
4987
4988 ``num``
4989 Number of Identifiers
4990
4991 ``identifier``
4992 Endurance Group Identifier
4993
4994
4995
4996
4997
4998 .. c:type:: struct nvme_supported_log_pages
4999
5000 Supported Log Pages - Log
5001
5002 **Definition**
5003
5004 ::
5005
5006 struct nvme_supported_log_pages {
5007 __le32 lid_support[NVME_LOG_SUPPORTED_LOG_PAGES_MAX];
5008 };
5009
5010 **Members**
5011
5012 ``lid_support``
5013 Log Page Identifier Supported
5014
5015
5016 **Description**
5017
5018 Supported Log Pages (Log Identifier 00h)
5019
5020
5021
5022
5023 .. c:type:: struct nvme_error_log_page
5024
5025 Error Information Log Entry (Log Identifier 01h)
5026
5027 **Definition**
5028
5029 ::
5030
5031 struct nvme_error_log_page {
5032 __le64 error_count;
5033 __le16 sqid;
5034 __le16 cmdid;
5035 __le16 status_field;
5036 __le16 parm_error_location;
5037 __le64 lba;
5038 __le32 nsid;
5039 __u8 vs;
5040 __u8 trtype;
5041 __u8 csi;
5042 __u8 opcode;
5043 __le64 cs;
5044 __le16 trtype_spec_info;
5045 __u8 rsvd[21];
5046 __u8 log_page_version;
5047 };
5048
5049 **Members**
5050
5051 ``error_count``
5052 Error Count: a 64-bit incrementing error count,
5053 indicating a unique identifier for this error. The error
5054 count starts at ``1h``, is incremented for each unique error
5055 log entry, and is retained across power off conditions.
5056 A value of ``0h`` indicates an invalid entry; this value
5057 is used when there are lost entries or when there are
5058 fewer errors than the maximum number of entries the
5059 controller supports. If the value of this field is
5060 ``FFFFFFFFh``, then the field shall be set to 1h when
5061 incremented (i.e., rolls over to ``1h``). Prior to NVMe
5062 1.4, processing of incrementing beyond ``FFFFFFFFh`` is
5063 unspecified.
5064
5065 ``sqid``
5066 Submission Queue ID: indicates the Submission Queue
5067 Identifier of the command that the error information is
5068 associated with. If the error is not specific to
5069 a particular command, then this field shall be set to
5070 ``FFFFh``.
5071
5072 ``cmdid``
5073 Command ID: indicates the Command Identifier of the
5074 command that the error is associated with. If the error
5075 is not specific to a particular command, then this field
5076 shall be set to ``FFFFh``.
5077
5078 ``status_field``
5079 Bits 15-1: Status Field: indicates the Status Field for
5080 the command that completed. If the error is not specific
5081 to a particular command, then this field reports the most
5082 applicable status value.
5083 Bit 0: Phase Tag: may indicate the Phase Tag posted for
5084 the command.
5085
5086 ``parm_error_location``
5087 Parameter Error Location: indicates the byte and bit of
5088 the command parameter that the error is associated with,
5089 if applicable. If the parameter spans multiple bytes or
5090 bits, then the location indicates the first byte and bit
5091 of the parameter.
5092 Bits 10-8: Bit in command that contained the error.
5093 Valid values are 0 to 7.
5094 Bits 7-0: Byte in command that contained the error.
5095 Valid values are 0 to 63.
5096
5097 ``lba``
5098 LBA: This field indicates the first LBA that experienced
5099 the error condition, if applicable.
5100
5101 ``nsid``
5102 Namespace: This field indicates the NSID of the namespace
5103 that the error is associated with, if applicable.
5104
5105 ``vs``
5106 Vendor Specific Information Available: If there is
5107 additional vendor specific error information available,
5108 this field provides the log page identifier associated
5109 with that page. A value of ``0h`` indicates that no additional
5110 information is available. Valid values are in the range
5111 of ``80h`` to ``FFh``.
5112
5113 ``trtype``
5114 Transport Type (TRTYPE): indicates the Transport Type of
5115 the transport associated with the error. The values in
5116 this field are the same as the TRTYPE values in the
5117 Discovery Log Page Entry. If the error is not transport
5118 related, this field shall be cleared to ``0h``. If the error
5119 is transport related, this field shall be set to the type
5120 of the transport - see :c:type:`enum nvme_trtype <nvme_trtype>`.
5121
5122 ``csi``
5123 Command Set Indicator: This field contains command set
5124 indicator for the command that the error is associated
5125 with.
5126
5127 ``opcode``
5128 Opcode: This field contains opcode for the command that
5129 the error is associated with.
5130
5131 ``cs``
5132 Command Specific Information: This field contains command
5133 specific information. If used, the command definition
5134 specifies the information returned.
5135
5136 ``trtype_spec_info``
5137 Transport Type Specific Information
5138
5139 ``rsvd``
5140 Reserved: [62:42]
5141
5142 ``log_page_version``
5143 This field shall be set to 1h. If set, **csi** and **opcode**
5144 will have valid values.
5145
5146
5147
5148
5149
5150 .. c:type:: enum nvme_err_status_field
5151
5152 This field indicates the error information log entry status field
5153
5154 **Constants**
5155
5156 ``NVME_ERR_SF_PHASE_TAG_SHIFT``
5157 Shift amount to get the phase tag
5158
5159 ``NVME_ERR_SF_STATUS_FIELD_SHIFT``
5160 Shift amount to get the status field
5161
5162 ``NVME_ERR_SF_PHASE_TAG_MASK``
5163 Mask to get the phase tag
5164
5165 ``NVME_ERR_SF_STATUS_FIELD_MASK``
5166 Mask to get the status field
5167
5168
5169
5170
5171 .. c:type:: struct nvme_smart_log
5172
5173 SMART / Health Information Log (Log Identifier 02h)
5174
5175 **Definition**
5176
5177 ::
5178
5179 struct nvme_smart_log {
5180 __u8 critical_warning;
5181 __u8 temperature[2];
5182 __u8 avail_spare;
5183 __u8 spare_thresh;
5184 __u8 percent_used;
5185 __u8 endu_grp_crit_warn_sumry;
5186 __u8 rsvd7[25];
5187 __u8 data_units_read[16];
5188 __u8 data_units_written[16];
5189 __u8 host_reads[16];
5190 __u8 host_writes[16];
5191 __u8 ctrl_busy_time[16];
5192 __u8 power_cycles[16];
5193 __u8 power_on_hours[16];
5194 __u8 unsafe_shutdowns[16];
5195 __u8 media_errors[16];
5196 __u8 num_err_log_entries[16];
5197 __le32 warning_temp_time;
5198 __le32 critical_comp_time;
5199 __le16 temp_sensor[8];
5200 __le32 thm_temp1_trans_count;
5201 __le32 thm_temp2_trans_count;
5202 __le32 thm_temp1_total_time;
5203 __le32 thm_temp2_total_time;
5204 __u8 rsvd232[280];
5205 };
5206
5207 **Members**
5208
5209 ``critical_warning``
5210 This field indicates critical warnings for the state
5211 of the controller. Critical warnings may result in an
5212 asynchronous event notification to the host. Bits in
5213 this field represent the current associated state and
5214 are not persistent (see :c:type:`enum nvme_smart_crit <nvme_smart_crit>`).
5215
5216 ``temperature``
5217 Composite Temperature: Contains a value corresponding
5218 to a temperature in Kelvins that represents the current
5219 composite temperature of the controller and namespace(s)
5220 associated with that controller. The manner in which
5221 this value is computed is implementation specific and
5222 may not represent the actual temperature of any physical
5223 point in the NVM subsystem. Warning and critical
5224 overheating composite temperature threshold values are
5225 reported by the WCTEMP and CCTEMP fields in the Identify
5226 Controller data structure.
5227
5228 ``avail_spare``
5229 Available Spare: Contains a normalized percentage (0%
5230 to 100%) of the remaining spare capacity available.
5231
5232 ``spare_thresh``
5233 Available Spare Threshold: When the Available Spare
5234 falls below the threshold indicated in this field, an
5235 asynchronous event completion may occur. The value is
5236 indicated as a normalized percentage (0% to 100%).
5237 The values 101 to 255 are reserved.
5238
5239 ``percent_used``
5240 Percentage Used: Contains a vendor specific estimate
5241 of the percentage of NVM subsystem life used based on
5242 the actual usage and the manufacturer's prediction of
5243 NVM life. A value of 100 indicates that the estimated
5244 endurance of the NVM in the NVM subsystem has been
5245 consumed, but may not indicate an NVM subsystem failure.
5246 The value is allowed to exceed 100. Percentages greater
5247 than 254 shall be represented as 255. This value shall
5248 be updated once per power-on hour (when the controller
5249 is not in a sleep state).
5250
5251 ``endu_grp_crit_warn_sumry``
5252 Endurance Group Critical Warning Summary: This field
5253 indicates critical warnings for the state of Endurance
5254 Groups. Bits in this field represent the current associated
5255 state and are not persistent (see :c:type:`enum nvme_smart_egcw <nvme_smart_egcw>`).
5256
5257 ``rsvd7``
5258 Reserved
5259
5260 ``data_units_read``
5261 Data Units Read: Contains the number of 512 byte data
5262 units the host has read from the controller; this value
5263 does not include metadata. This value is reported in
5264 thousands (i.e., a value of 1 corresponds to 1000
5265 units of 512 bytes read) and is rounded up (e.g., one
5266 indicates the that number of 512 byte data units read
5267 is from 1 to 1000, three indicates that the number of
5268 512 byte data units read is from 2001 to 3000). When
5269 the LBA size is a value other than 512 bytes, the
5270 controller shall convert the amount of data read to
5271 512 byte units. For the NVM command set, logical blocks
5272 read as part of Compare, Read, and Verify operations
5273 shall be included in this value. A value of ``0h`` in
5274 this field indicates that the number of Data Units Read
5275 is not reported.
5276
5277 ``data_units_written``
5278 Data Units Written: Contains the number of 512 byte
5279 data units the host has written to the controller;
5280 this value does not include metadata. This value is
5281 reported in thousands (i.e., a value of 1 corresponds
5282 to 1000 units of 512 bytes written) and is rounded up
5283 (e.g., one indicates that the number of 512 byte data
5284 units written is from 1 to 1,000, three indicates that
5285 the number of 512 byte data units written is from 2001
5286 to 3000). When the LBA size is a value other than 512
5287 bytes, the controller shall convert the amount of data
5288 written to 512 byte units. For the NVM command set,
5289 logical blocks written as part of Write operations shall
5290 be included in this value. Write Uncorrectable commands
5291 and Write Zeroes commands shall not impact this value.
5292 A value of ``0h`` in this field indicates that the number
5293 of Data Units Written is not reported.
5294
5295 ``host_reads``
5296 Host Read Commands: Contains the number of read commands
5297 completed by the controller. For the NVM command set,
5298 this value is the sum of the number of Compare commands
5299 and the number of Read commands.
5300
5301 ``host_writes``
5302 Host Write Commands: Contains the number of write
5303 commands completed by the controller. For the NVM
5304 command set, this is the number of Write commands.
5305
5306 ``ctrl_busy_time``
5307 Controller Busy Time: Contains the amount of time the
5308 controller is busy with I/O commands. The controller
5309 is busy when there is a command outstanding to an I/O
5310 Queue (specifically, a command was issued via an I/O
5311 Submission Queue Tail doorbell write and the corresponding
5312 completion queue entry has not been posted yet to the
5313 associated I/O Completion Queue). This value is
5314 reported in minutes.
5315
5316 ``power_cycles``
5317 Power Cycles: Contains the number of power cycles.
5318
5319 ``power_on_hours``
5320 Power On Hours: Contains the number of power-on hours.
5321 This may not include time that the controller was
5322 powered and in a non-operational power state.
5323
5324 ``unsafe_shutdowns``
5325 Unsafe Shutdowns: Contains the number of unsafe
5326 shutdowns. This count is incremented when a Shutdown
5327 Notification (CC.SHN) is not received prior to loss of power.
5328
5329 ``media_errors``
5330 Media and Data Integrity Errors: Contains the number
5331 of occurrences where the controller detected an
5332 unrecovered data integrity error. Errors such as
5333 uncorrectable ECC, CRC checksum failure, or LBA tag
5334 mismatch are included in this field. Errors introduced
5335 as a result of a Write Uncorrectable command may or
5336 may not be included in this field.
5337
5338 ``num_err_log_entries``
5339 Number of Error Information Log Entries: Contains the
5340 number of Error Information log entries over the life
5341 of the controller.
5342
5343 ``warning_temp_time``
5344 Warning Composite Temperature Time: Contains the amount
5345 of time in minutes that the controller is operational
5346 and the Composite Temperature is greater than or equal
5347 to the Warning Composite Temperature Threshold (WCTEMP)
5348 field and less than the Critical Composite Temperature
5349 Threshold (CCTEMP) field in the Identify Controller
5350 data structure. If the value of the WCTEMP or CCTEMP
5351 field is ``0h``, then this field is always cleared to ``0h``
5352 regardless of the Composite Temperature value.
5353
5354 ``critical_comp_time``
5355 Critical Composite Temperature Time: Contains the amount
5356 of time in minutes that the controller is operational
5357 and the Composite Temperature is greater than or equal
5358 to the Critical Composite Temperature Threshold (CCTEMP)
5359 field in the Identify Controller data structure. If
5360 the value of the CCTEMP field is ``0h``, then this field
5361 is always cleared to 0h regardless of the Composite
5362 Temperature value.
5363
5364 ``temp_sensor``
5365 Temperature Sensor 1-8: Contains the current temperature
5366 in degrees Kelvin reported by temperature sensors 1-8.
5367 The physical point in the NVM subsystem whose temperature
5368 is reported by the temperature sensor and the temperature
5369 accuracy is implementation specific. An implementation
5370 that does not implement the temperature sensor reports
5371 a value of ``0h``.
5372
5373 ``thm_temp1_trans_count``
5374 Thermal Management Temperature 1 Transition Count:
5375 Contains the number of times the controller transitioned
5376 to lower power active power states or performed vendor
5377 specific thermal management actions while minimizing
5378 the impact on performance in order to attempt to reduce
5379 the Composite Temperature because of the host controlled
5380 thermal management feature (i.e., the Composite
5381 Temperature rose above the Thermal Management
5382 Temperature 1). This counter shall not wrap once the
5383 value ``FFFFFFFFh`` is reached. A value of ``0h``, indicates
5384 that this transition has never occurred or this field
5385 is not implemented.
5386
5387 ``thm_temp2_trans_count``
5388 Thermal Management Temperature 2 Transition Count
5389
5390 ``thm_temp1_total_time``
5391 Total Time For Thermal Management Temperature 1:
5392 Contains the number of seconds that the controller
5393 had transitioned to lower power active power states or
5394 performed vendor specific thermal management actions
5395 while minimizing the impact on performance in order to
5396 attempt to reduce the Composite Temperature because of
5397 the host controlled thermal management feature. This
5398 counter shall not wrap once the value ``FFFFFFFFh`` is
5399 reached. A value of ``0h``, indicates that this transition
5400 has never occurred or this field is not implemented.
5401
5402 ``thm_temp2_total_time``
5403 Total Time For Thermal Management Temperature 2
5404
5405 ``rsvd232``
5406 Reserved
5407
5408
5409
5410
5411
5412 .. c:type:: enum nvme_smart_crit
5413
5414 Critical Warning
5415
5416 **Constants**
5417
5418 ``NVME_SMART_CW_ASCBT_SHIFT``
5419 Shift amount to get the available spare capacity has fallen
5420 below the threshold.
5421
5422 ``NVME_SMART_CW_TTC_SHIFT``
5423 Shift amount to get the temperature is either greater
5424 than or equal to an over temperature threshold; or
5425 less than or equal to an under temperature threshold.
5426
5427 ``NVME_SMART_CW_NDR_SHIFT``
5428 Shift amount to get the NVM subsystem reliability has
5429 been degraded due to significant media related errors
5430 or any internal error that degrades NVM subsystem
5431 reliability.
5432
5433 ``NVME_SMART_CW_AMRO_SHIFT``
5434 Shift amount to get the all of the media has been placed in read
5435 only mode. The controller shall not set this bit if
5436 the read-only condition on the media is a result of
5437 a change in the write protection state of a namespace.
5438
5439 ``NVME_SMART_CW_VMBF_SHIFT``
5440 Shift amount to get the volatile memory backup
5441 device has failed. This field is only valid if the
5442 controller has a volatile memory backup solution.
5443
5444 ``NVME_SMART_CW_PMRRO_SHIFT``
5445 Shift amount to get the Persistent Memory Region has become
5446 read-only or unreliable.
5447
5448 ``NVME_SMART_CW_ASCBT_MASK``
5449 If set, then the available spare capacity has fallen
5450 below the threshold.
5451
5452 ``NVME_SMART_CW_TTC_MASK``
5453 Mask to get the temperature is either greater
5454 than or equal to an over temperature threshold; or
5455 less than or equal to an under temperature threshold.
5456
5457 ``NVME_SMART_CW_NDR_MASK``
5458 Mask to get the NVM subsystem reliability has
5459 been degraded due to significant media related errors
5460 or any internal error that degrades NVM subsystem
5461 reliability.
5462
5463 ``NVME_SMART_CW_AMRO_MASK``
5464 Mask to get the all of the media has been placed in read
5465 only mode. The controller shall not set this bit if
5466 the read-only condition on the media is a result of
5467 a change in the write protection state of a namespace.
5468
5469 ``NVME_SMART_CW_VMBF_MASK``
5470 Mask to get the volatile memory backup
5471 device has failed. This field is only valid if the
5472 controller has a volatile memory backup solution.
5473
5474 ``NVME_SMART_CW_PMRRO_MASK``
5475 Mask to get the Persistent Memory Region has become
5476 read-only or unreliable.
5477
5478 ``NVME_SMART_CRIT_SPARE``
5479 If set, then the available spare capacity has fallen
5480 below the threshold.
5481
5482 ``NVME_SMART_CRIT_TEMPERATURE``
5483 If set, then a temperature is either greater
5484 than or equal to an over temperature threshold; or
5485 less than or equal to an under temperature threshold.
5486
5487 ``NVME_SMART_CRIT_DEGRADED``
5488 If set, then the NVM subsystem reliability has
5489 been degraded due to significant media related errors
5490 or any internal error that degrades NVM subsystem
5491 reliability.
5492
5493 ``NVME_SMART_CRIT_MEDIA``
5494 If set, then all of the media has been placed in read
5495 only mode. The controller shall not set this bit if
5496 the read-only condition on the media is a result of
5497 a change in the write protection state of a namespace.
5498
5499 ``NVME_SMART_CRIT_VOLATILE_MEMORY``
5500 If set, then the volatile memory backup
5501 device has failed. This field is only valid if the
5502 controller has a volatile memory backup solution.
5503
5504 ``NVME_SMART_CRIT_PMR_RO``
5505 If set, then the Persistent Memory Region has become
5506 read-only or unreliable.
5507
5508
5509
5510
5511 .. c:type:: enum nvme_smart_egcw
5512
5513 Endurance Group Critical Warning Summary
5514
5515 **Constants**
5516
5517 ``NVME_SMART_EGCW_SPARE``
5518 If set, then the available spare capacity of one or
5519 more Endurance Groups has fallen below the threshold.
5520
5521 ``NVME_SMART_EGCW_DEGRADED``
5522 If set, then the reliability of one or more
5523 Endurance Groups has been degraded due to significant
5524 media related errors or any internal error that
5525 degrades NVM subsystem reliability.
5526
5527 ``NVME_SMART_EGCW_RO``
5528 If set, then the namespaces in one or more Endurance
5529 Groups have been placed in read only mode not as
5530 a result of a change in the write protection state
5531 of a namespace.
5532
5533
5534
5535
5536 .. c:type:: struct nvme_firmware_slot
5537
5538 Firmware Slot Information Log
5539
5540 **Definition**
5541
5542 ::
5543
5544 struct nvme_firmware_slot {
5545 __u8 afi;
5546 __u8 rsvd1[7];
5547 char frs[7][8];
5548 __u8 rsvd2[448];
5549 };
5550
5551 **Members**
5552
5553 ``afi``
5554 Active Firmware Info
5555
5556 ``rsvd1``
5557 Reserved
5558
5559 ``frs``
5560 Firmware Revision for Slot
5561
5562 ``rsvd2``
5563 Reserved
5564
5565
5566
5567
5568
5569 .. c:type:: struct nvme_cmd_effects_log
5570
5571 Commands Supported and Effects Log
5572
5573 **Definition**
5574
5575 ::
5576
5577 struct nvme_cmd_effects_log {
5578 __le32 acs[256];
5579 __le32 iocs[256];
5580 __u8 rsvd[2048];
5581 };
5582
5583 **Members**
5584
5585 ``acs``
5586 Admin Command Supported
5587
5588 ``iocs``
5589 I/O Command Supported
5590
5591 ``rsvd``
5592 Reserved
5593
5594
5595
5596
5597
5598 .. c:type:: enum nvme_cmd_effects
5599
5600 Commands Supported and Effects
5601
5602 **Constants**
5603
5604 ``NVME_CMD_EFFECTS_CSUPP``
5605 Command Supported
5606
5607 ``NVME_CMD_EFFECTS_LBCC``
5608 Logical Block Content Change
5609
5610 ``NVME_CMD_EFFECTS_NCC``
5611 Namespace Capability Change
5612
5613 ``NVME_CMD_EFFECTS_NIC``
5614 Namespace Inventory Change
5615
5616 ``NVME_CMD_EFFECTS_CCC``
5617 Controller Capability Change
5618
5619 ``NVME_CMD_EFFECTS_CSER_MASK``
5620 Command Submission and Execution Relaxations
5621
5622 ``NVME_CMD_EFFECTS_CSE_MASK``
5623 Command Submission and Execution
5624
5625 ``NVME_CMD_EFFECTS_UUID_SEL``
5626 UUID Selection Supported
5627
5628
5629
5630
5631 .. c:type:: struct nvme_st_result
5632
5633 Self-test Result
5634
5635 **Definition**
5636
5637 ::
5638
5639 struct nvme_st_result {
5640 __u8 dsts;
5641 __u8 seg;
5642 __u8 vdi;
5643 __u8 rsvd;
5644 __le64 poh;
5645 __le32 nsid;
5646 __le64 flba;
5647 __u8 sct;
5648 __u8 sc;
5649 __u8 vs[2];
5650 };
5651
5652 **Members**
5653
5654 ``dsts``
5655 Device Self-test Status: Indicates the device self-test code and the
5656 status of the operation (see :c:type:`enum nvme_status_result <nvme_status_result>` and :c:type:`enum nvme_st_code <nvme_st_code>`).
5657
5658 ``seg``
5659 Segment Number: Iindicates the segment number where the first self-test
5660 failure occurred. If Device Self-test Status (**dsts**) is not set to
5661 #NVME_ST_RESULT_KNOWN_SEG_FAIL, then this field should be ignored.
5662
5663 ``vdi``
5664 Valid Diagnostic Information: Indicates the diagnostic failure
5665 information that is reported. See :c:type:`enum nvme_st_valid_diag_info <nvme_st_valid_diag_info>`.
5666
5667 ``rsvd``
5668 Reserved
5669
5670 ``poh``
5671 Power On Hours (POH): Indicates the number of power-on hours at the
5672 time the device self-test operation was completed or aborted. This
5673 does not include time that the controller was powered and in a low
5674 power state condition.
5675
5676 ``nsid``
5677 Namespace Identifier (NSID): Indicates the namespace that the Failing
5678 LBA occurred on. Valid only when the NSID Valid bit
5679 (#NVME_ST_VALID_DIAG_INFO_NSID) is set in the Valid Diagnostic
5680 Information (**vdi**) field.
5681
5682 ``flba``
5683 Failing LBA: indicates the LBA of the logical block that caused the
5684 test to fail. If the device encountered more than one failed logical
5685 block during the test, then this field only indicates one of those
5686 failed logical blocks. Valid only when the NSID Valid bit
5687 (#NVME_ST_VALID_DIAG_INFO_FLBA) is set in the Valid Diagnostic
5688 Information (**vdi**) field.
5689
5690 ``sct``
5691 Status Code Type: This field may contain additional information related
5692 to errors or conditions. Bits 2:0 may contain additional information
5693 relating to errors or conditions that occurred during the device
5694 self-test operation represented in the same format used in the Status
5695 Code Type field of the completion queue entry (refer to :c:type:`enum nvme_status_field <nvme_status_field>`).
5696 Valid only when the NSID Valid bit (#NVME_ST_VALID_DIAG_INFO_SCT) is
5697 set in the Valid Diagnostic Information (**vdi**) field.
5698
5699 ``sc``
5700 Status Code: This field may contain additional information relating
5701 to errors or conditions that occurred during the device self-test
5702 operation represented in the same format used in the Status Code field
5703 of the completion queue entry. Valid only when the SCT Valid bit
5704 (#NVME_ST_VALID_DIAG_INFO_SC) is set in the Valid Diagnostic
5705 Information (**vdi**) field.
5706
5707 ``vs``
5708 Vendor Specific.
5709
5710
5711
5712
5713
5714 .. c:type:: enum nvme_status_result
5715
5716 Result of the device self-test operation
5717
5718 **Constants**
5719
5720 ``NVME_ST_RESULT_NO_ERR``
5721 Operation completed without error.
5722
5723 ``NVME_ST_RESULT_ABORTED``
5724 Operation was aborted by a Device Self-test command.
5725
5726 ``NVME_ST_RESULT_CLR``
5727 Operation was aborted by a Controller Level Reset.
5728
5729 ``NVME_ST_RESULT_NS_REMOVED``
5730 Operation was aborted due to a removal of
5731 a namespace from the namespace inventory.
5732
5733 ``NVME_ST_RESULT_ABORTED_FORMAT``
5734 Operation was aborted due to the processing
5735 of a Format NVM command.
5736
5737 ``NVME_ST_RESULT_FATAL_ERR``
5738 A fatal error or unknown test error occurred
5739 while the controller was executing the device
5740 self-test operation and the operation did
5741 not complete.
5742
5743 ``NVME_ST_RESULT_UNKNOWN_SEG_FAIL``
5744 Operation completed with a segment that failed
5745 and the segment that failed is not known.
5746
5747 ``NVME_ST_RESULT_KNOWN_SEG_FAIL``
5748 Operation completed with one or more failed
5749 segments and the first segment that failed
5750 is indicated in the Segment Number field.
5751
5752 ``NVME_ST_RESULT_ABORTED_UNKNOWN``
5753 Operation was aborted for unknown reason.
5754
5755 ``NVME_ST_RESULT_ABORTED_SANITIZE``
5756 Operation was aborted due to a sanitize operation.
5757
5758 ``NVME_ST_RESULT_NOT_USED``
5759 Entry not used (does not contain a test result).
5760
5761 ``NVME_ST_RESULT_MASK``
5762 Mask to get the status result value from
5763 the :c:type:`struct nvme_st_result <nvme_st_result>`.dsts field.
5764
5765
5766
5767
5768 .. c:type:: enum nvme_st_code
5769
5770 Self-test Code value
5771
5772 **Constants**
5773
5774 ``NVME_ST_CODE_RESERVED``
5775 Reserved.
5776
5777 ``NVME_ST_CODE_SHORT``
5778 Short device self-test operation.
5779
5780 ``NVME_ST_CODE_EXTENDED``
5781 Extended device self-test operation.
5782
5783 ``NVME_ST_CODE_HOST_INIT``
5784 Host-Initiated Refresh operation.
5785
5786 ``NVME_ST_CODE_VS``
5787 Vendor specific.
5788
5789 ``NVME_ST_CODE_ABORT``
5790 Abort device self-test operation.
5791
5792 ``NVME_ST_CODE_SHIFT``
5793 Shift amount to get the code value from the
5794 :c:type:`struct nvme_st_result <nvme_st_result>`.dsts field.
5795
5796
5797
5798
5799 .. c:type:: enum nvme_st_curr_op
5800
5801 Current Device Self-Test Operation
5802
5803 **Constants**
5804
5805 ``NVME_ST_CURR_OP_NOT_RUNNING``
5806 No device self-test operation in progress.
5807
5808 ``NVME_ST_CURR_OP_SHORT``
5809 Short device self-test operation in progress.
5810
5811 ``NVME_ST_CURR_OP_EXTENDED``
5812 Extended device self-test operation in progress.
5813
5814 ``NVME_ST_CURR_OP_VS``
5815 Vendor specific.
5816
5817 ``NVME_ST_CURR_OP_RESERVED``
5818 Reserved.
5819
5820 ``NVME_ST_CURR_OP_MASK``
5821 Mask to get the current operation value from the
5822 :c:type:`struct nvme_self_test_log <nvme_self_test_log>`.current_operation field.
5823
5824 ``NVME_ST_CURR_OP_CMPL_MASK``
5825 Mask to get the current operation completion value
5826 from the :c:type:`struct nvme_self_test_log <nvme_self_test_log>`.completion field.
5827
5828
5829
5830
5831 .. c:type:: enum nvme_st_valid_diag_info
5832
5833 Valid Diagnostic Information
5834
5835 **Constants**
5836
5837 ``NVME_ST_VALID_DIAG_INFO_NSID``
5838 NSID Valid: if set, then the contents of
5839 the Namespace Identifier field are valid.
5840
5841 ``NVME_ST_VALID_DIAG_INFO_FLBA``
5842 FLBA Valid: if set, then the contents of
5843 the Failing LBA field are valid.
5844
5845 ``NVME_ST_VALID_DIAG_INFO_SCT``
5846 SCT Valid: if set, then the contents of
5847 the Status Code Type field are valid.
5848
5849 ``NVME_ST_VALID_DIAG_INFO_SC``
5850 SC Valid: if set, then the contents of
5851 the Status Code field are valid.
5852
5853
5854
5855
5856 .. c:type:: struct nvme_self_test_log
5857
5858 Device Self-test (Log Identifier 06h)
5859
5860 **Definition**
5861
5862 ::
5863
5864 struct nvme_self_test_log {
5865 __u8 current_operation;
5866 __u8 completion;
5867 __u8 rsvd[2];
5868 struct nvme_st_result result[NVME_LOG_ST_MAX_RESULTS];
5869 };
5870
5871 **Members**
5872
5873 ``current_operation``
5874 Current Device Self-Test Operation: indicates the status
5875 of the current device self-test operation. If a device
5876 self-test operation is in process (i.e., this field is set
5877 to #NVME_ST_CURR_OP_SHORT or #NVME_ST_CURR_OP_EXTENDED),
5878 then the controller shall not set this field to
5879 #NVME_ST_CURR_OP_NOT_RUNNING until a new Self-test Result
5880 Data Structure is created (i.e., if a device self-test
5881 operation completes or is aborted, then the controller
5882 shall create a Self-test Result Data Structure prior to
5883 setting this field to #NVME_ST_CURR_OP_NOT_RUNNING).
5884 See :c:type:`enum nvme_st_curr_op <nvme_st_curr_op>`.
5885
5886 ``completion``
5887 Current Device Self-Test Completion: indicates the percentage
5888 of the device self-test operation that is complete (e.g.,
5889 a value of 25 indicates that 25% of the device self-test
5890 operation is complete and 75% remains to be tested).
5891 If the **current_operation** field is cleared to
5892 #NVME_ST_CURR_OP_NOT_RUNNING (indicating there is no device
5893 self-test operation in progress), then this field is ignored.
5894
5895 ``rsvd``
5896 Reserved
5897
5898 ``result``
5899 Self-test Result Data Structures, see :c:type:`struct nvme_st_result <nvme_st_result>`.
5900
5901
5902
5903
5904
5905 .. c:type:: enum nvme_cmd_get_log_telemetry_host_lsp
5906
5907 Telemetry Host-Initiated log specific field
5908
5909 **Constants**
5910
5911 ``NVME_LOG_TELEM_HOST_LSP_RETAIN``
5912 Get Telemetry Data Blocks
5913
5914 ``NVME_LOG_TELEM_HOST_LSP_CREATE``
5915 Create Telemetry Data Blocks
5916
5917
5918
5919
5920 .. c:type:: enum nvme_telemetry_da
5921
5922 Telemetry Log Data Area
5923
5924 **Constants**
5925
5926 ``NVME_TELEMETRY_DA_CTRL_DETERMINE``
5927 The controller determines the data areas to be created
5928
5929 ``NVME_TELEMETRY_DA_1``
5930 Data Area 1
5931
5932 ``NVME_TELEMETRY_DA_2``
5933 Data Area 2
5934
5935 ``NVME_TELEMETRY_DA_3``
5936 Data Area 3
5937
5938 ``NVME_TELEMETRY_DA_4``
5939 Data Area 4
5940
5941
5942
5943
5944 .. c:type:: struct nvme_telemetry_log
5945
5946 Retrieve internal data specific to the manufacturer.
5947
5948 **Definition**
5949
5950 ::
5951
5952 struct nvme_telemetry_log {
5953 __u8 lpi;
5954 __u8 rsvd1[4];
5955 __u8 ieee[3];
5956 __le16 dalb1;
5957 __le16 dalb2;
5958 __le16 dalb3;
5959 __u8 rsvd14[2];
5960 __le32 dalb4;
5961 __u8 rsvd20[360];
5962 __u8 ths;
5963 union {
5964 __u8 hostdgn;
5965 __u8 tcs;
5966 };
5967 __u8 ctrlavail;
5968 __u8 ctrldgn;
5969 __u8 rsnident[128];
5970 __u8 data_area[];
5971 };
5972
5973 **Members**
5974
5975 ``lpi``
5976 Log Identifier, either ``NVME_LOG_LID_TELEMETRY_HOST`` or
5977 ``NVME_LOG_LID_TELEMETRY_CTRL``
5978
5979 ``rsvd1``
5980 Reserved
5981
5982 ``ieee``
5983 IEEE OUI Identifier is the Organization Unique Identifier (OUI)
5984 for the controller vendor that is able to interpret the data.
5985
5986 ``dalb1``
5987 Telemetry Host/Controller Initiated Data Area 1 Last Block is
5988 the value of the last block in this area.
5989
5990 ``dalb2``
5991 Telemetry Host/Controller Initiated Data Area 1 Last Block is
5992 the value of the last block in this area.
5993
5994 ``dalb3``
5995 Telemetry Host/ControllerInitiated Data Area 1 Last Block is
5996 the value of the last block in this area.
5997
5998 ``rsvd14``
5999 Reserved
6000
6001 ``dalb4``
6002 Telemetry Host/Controller Initiated Data Area 4 Last Block is
6003 the value of the last block in this area.
6004
6005 ``rsvd20``
6006 Reserved
6007
6008 ``ths``
6009 Telemetry Host-Initiated Scope
6010
6011 ``{unnamed_union}``
6012 anonymous
6013
6014 ``hostdgn``
6015 Telemetry Host-Initiated Data Generation Number is a
6016 value that is incremented each time the host initiates a
6017 capture of its internal controller state in the controller.
6018
6019 ``tcs``
6020 Telemetry Controller-Initiated Scope
6021
6022 ``ctrlavail``
6023 Telemetry Controller-Initiated Data Available, if cleared,
6024 then the controller telemetry log does not contain saved
6025 internal controller state. If this field is set to 1h, the
6026 controller log contains saved internal controller state. If
6027 this field is set to 1h, the data will be latched until the
6028 host releases it by reading the log with RAE cleared.
6029
6030 ``ctrldgn``
6031 Telemetry Controller-Initiated Data Generation Number is
6032 a value that is incremented each time the controller initiates a
6033 capture of its internal controller state in the controller .
6034
6035 ``rsnident``
6036 Reason Identifiers a vendor specific identifier that describes
6037 the operating conditions of the controller at the time of
6038 capture.
6039
6040 ``data_area``
6041 Telemetry data blocks, vendor specific information data.
6042
6043
6044 **Description**
6045
6046 This log consists of a header describing the log and zero or more Telemetry
6047 Data Blocks. All Telemetry Data Blocks are ``NVME_LOG_TELEM_BLOCK_SIZE``, 512
6048 bytes, in size. This log captures the controller’s internal state.
6049
6050
6051
6052
6053 .. c:type:: struct nvme_endurance_group_log
6054
6055 Endurance Group Information Log
6056
6057 **Definition**
6058
6059 ::
6060
6061 struct nvme_endurance_group_log {
6062 __u8 critical_warning;
6063 __u8 endurance_group_features;
6064 __u8 rsvd2;
6065 __u8 avl_spare;
6066 __u8 avl_spare_threshold;
6067 __u8 percent_used;
6068 __le16 domain_identifier;
6069 __u8 rsvd8[24];
6070 __u8 endurance_estimate[16];
6071 __u8 data_units_read[16];
6072 __u8 data_units_written[16];
6073 __u8 media_units_written[16];
6074 __u8 host_read_cmds[16];
6075 __u8 host_write_cmds[16];
6076 __u8 media_data_integrity_err[16];
6077 __u8 num_err_info_log_entries[16];
6078 __u8 total_end_grp_cap[16];
6079 __u8 unalloc_end_grp_cap[16];
6080 __u8 rsvd192[320];
6081 };
6082
6083 **Members**
6084
6085 ``critical_warning``
6086 Critical Warning
6087
6088 ``endurance_group_features``
6089 Endurance Group Features
6090
6091 ``rsvd2``
6092 Reserved
6093
6094 ``avl_spare``
6095 Available Spare
6096
6097 ``avl_spare_threshold``
6098 Available Spare Threshold
6099
6100 ``percent_used``
6101 Percentage Used
6102
6103 ``domain_identifier``
6104 Domain Identifier
6105
6106 ``rsvd8``
6107 Reserved
6108
6109 ``endurance_estimate``
6110 Endurance Estimate
6111
6112 ``data_units_read``
6113 Data Units Read
6114
6115 ``data_units_written``
6116 Data Units Written
6117
6118 ``media_units_written``
6119 Media Units Written
6120
6121 ``host_read_cmds``
6122 Host Read Commands
6123
6124 ``host_write_cmds``
6125 Host Write Commands
6126
6127 ``media_data_integrity_err``
6128 Media and Data Integrity Errors
6129
6130 ``num_err_info_log_entries``
6131 Number of Error Information Log Entries
6132
6133 ``total_end_grp_cap``
6134 Total Endurance Group Capacity
6135
6136 ``unalloc_end_grp_cap``
6137 Unallocated Endurance Group Capacity
6138
6139 ``rsvd192``
6140 Reserved
6141
6142
6143
6144
6145
6146 .. c:type:: enum nvme_eg_critical_warning_flags
6147
6148 Endurance Group Information Log - Critical Warning
6149
6150 **Constants**
6151
6152 ``NVME_EG_CRITICAL_WARNING_SPARE``
6153 Available spare capacity of the Endurance Group
6154 has fallen below the threshold
6155
6156 ``NVME_EG_CRITICAL_WARNING_DEGRADED``
6157 Endurance Group reliability has been degraded
6158
6159 ``NVME_EG_CRITICAL_WARNING_READ_ONLY``
6160 Endurance Group have been placed in read only
6161 mode
6162
6163
6164
6165
6166 .. c:type:: struct nvme_aggregate_endurance_group_event
6167
6168 Endurance Group Event Aggregate
6169
6170 **Definition**
6171
6172 ::
6173
6174 struct nvme_aggregate_endurance_group_event {
6175 __le64 num_entries;
6176 __le16 entries[];
6177 };
6178
6179 **Members**
6180
6181 ``num_entries``
6182 Number or entries
6183
6184 ``entries``
6185 List of entries
6186
6187
6188
6189
6190
6191 .. c:type:: struct nvme_nvmset_predictable_lat_log
6192
6193 Predictable Latency Mode - Deterministic Threshold Configuration Data
6194
6195 **Definition**
6196
6197 ::
6198
6199 struct nvme_nvmset_predictable_lat_log {
6200 __u8 status;
6201 __u8 rsvd1;
6202 __le16 event_type;
6203 __u8 rsvd4[28];
6204 __le64 dtwin_rt;
6205 __le64 dtwin_wt;
6206 __le64 dtwin_tmax;
6207 __le64 ndwin_tmin_hi;
6208 __le64 ndwin_tmin_lo;
6209 __u8 rsvd72[56];
6210 __le64 dtwin_re;
6211 __le64 dtwin_we;
6212 __le64 dtwin_te;
6213 __u8 rsvd152[360];
6214 };
6215
6216 **Members**
6217
6218 ``status``
6219 Status
6220
6221 ``rsvd1``
6222 Reserved
6223
6224 ``event_type``
6225 Event Type
6226
6227 ``rsvd4``
6228 Reserved
6229
6230 ``dtwin_rt``
6231 DTWIN Reads Typical
6232
6233 ``dtwin_wt``
6234 DTWIN Writes Typical
6235
6236 ``dtwin_tmax``
6237 DTWIN Time Maximum
6238
6239 ``ndwin_tmin_hi``
6240 NDWIN Time Minimum High
6241
6242 ``ndwin_tmin_lo``
6243 NDWIN Time Minimum Low
6244
6245 ``rsvd72``
6246 Reserved
6247
6248 ``dtwin_re``
6249 DTWIN Reads Estimate
6250
6251 ``dtwin_we``
6252 DTWIN Writes Estimate
6253
6254 ``dtwin_te``
6255 DTWIN Time Estimate
6256
6257 ``rsvd152``
6258 Reserved
6259
6260
6261
6262
6263
6264 .. c:type:: enum nvme_nvmeset_pl_status
6265
6266 Predictable Latency Per NVM Set Log - Status
6267
6268 **Constants**
6269
6270 ``NVME_NVMSET_PL_STATUS_DISABLED``
6271 Not used (Predictable Latency Mode not enabled)
6272
6273 ``NVME_NVMSET_PL_STATUS_DTWIN``
6274 Deterministic Window (DTWIN)
6275
6276 ``NVME_NVMSET_PL_STATUS_NDWIN``
6277 Non-Deterministic Window (NDWIN)
6278
6279
6280
6281
6282 .. c:type:: enum nvme_nvmset_pl_events
6283
6284 Predictable Latency Per NVM Set Log - Event Type
6285
6286 **Constants**
6287
6288 ``NVME_NVMSET_PL_EVENT_DTWIN_READ_WARN``
6289 DTWIN Reads Warning
6290
6291 ``NVME_NVMSET_PL_EVENT_DTWIN_WRITE_WARN``
6292 DTWIN Writes Warning
6293
6294 ``NVME_NVMSET_PL_EVENT_DTWIN_TIME_WARN``
6295 DTWIN Time Warning
6296
6297 ``NVME_NVMSET_PL_EVENT_DTWIN_EXCEEDED``
6298 Autonomous transition from DTWIN
6299 to NDWIN due to typical or
6300 maximum value exceeded
6301
6302 ``NVME_NVMSET_PL_EVENT_DTWIN_EXCURSION``
6303 Autonomous transition from DTWIN
6304 to NDWIN due to Deterministic
6305 Excursion
6306
6307
6308
6309
6310 .. c:type:: struct nvme_aggregate_predictable_lat_event
6311
6312 Predictable Latency Event Aggregate Log Page
6313
6314 **Definition**
6315
6316 ::
6317
6318 struct nvme_aggregate_predictable_lat_event {
6319 __le64 num_entries;
6320 __le16 entries[];
6321 };
6322
6323 **Members**
6324
6325 ``num_entries``
6326 Number of entries
6327
6328 ``entries``
6329 Entry list
6330
6331
6332
6333
6334
6335 .. c:type:: struct nvme_ana_group_desc
6336
6337 ANA Group Descriptor
6338
6339 **Definition**
6340
6341 ::
6342
6343 struct nvme_ana_group_desc {
6344 __le32 grpid;
6345 __le32 nnsids;
6346 __le64 chgcnt;
6347 __u8 state;
6348 __u8 rsvd17[15];
6349 __le32 nsids[];
6350 };
6351
6352 **Members**
6353
6354 ``grpid``
6355 ANA group id
6356
6357 ``nnsids``
6358 Number of namespaces in **nsids**
6359
6360 ``chgcnt``
6361 Change counter
6362
6363 ``state``
6364 ANA state
6365
6366 ``rsvd17``
6367 Reserved
6368
6369 ``nsids``
6370 List of namespaces
6371
6372
6373
6374
6375
6376 .. c:type:: enum nvme_ana_state
6377
6378 ANA Group Descriptor - Asymmetric Namespace Access State
6379
6380 **Constants**
6381
6382 ``NVME_ANA_STATE_OPTIMIZED``
6383 ANA Optimized state
6384
6385 ``NVME_ANA_STATE_NONOPTIMIZED``
6386 ANA Non-Optimized state
6387
6388 ``NVME_ANA_STATE_INACCESSIBLE``
6389 ANA Inaccessible state
6390
6391 ``NVME_ANA_STATE_PERSISTENT_LOSS``
6392 ANA Persistent Loss state
6393
6394 ``NVME_ANA_STATE_CHANGE``
6395 ANA Change state
6396
6397
6398
6399
6400 .. c:type:: struct nvme_ana_log
6401
6402 Asymmetric Namespace Access Log
6403
6404 **Definition**
6405
6406 ::
6407
6408 struct nvme_ana_log {
6409 __le64 chgcnt;
6410 __le16 ngrps;
6411 __u8 rsvd10[6];
6412 struct nvme_ana_group_desc descs[];
6413 };
6414
6415 **Members**
6416
6417 ``chgcnt``
6418 Change Count
6419
6420 ``ngrps``
6421 Number of ANA Group Descriptors
6422
6423 ``rsvd10``
6424 Reserved
6425
6426 ``descs``
6427 ANA Group Descriptor
6428
6429
6430
6431
6432
6433 .. c:type:: struct nvme_persistent_event_log
6434
6435 Persistent Event Log
6436
6437 **Definition**
6438
6439 ::
6440
6441 struct nvme_persistent_event_log {
6442 __u8 lid;
6443 __u8 rsvd1[3];
6444 __le32 tnev;
6445 __le64 tll;
6446 __u8 rv;
6447 __u8 rsvd17;
6448 __le16 lhl;
6449 __le64 ts;
6450 __u8 poh[16];
6451 __le64 pcc;
6452 __le16 vid;
6453 __le16 ssvid;
6454 char sn[20];
6455 char mn[40];
6456 char subnqn[NVME_NQN_LENGTH];
6457 __le16 gen_number;
6458 __le32 rci;
6459 __u8 rsvd378[102];
6460 __u8 seb[32];
6461 };
6462
6463 **Members**
6464
6465 ``lid``
6466 Log Identifier
6467
6468 ``rsvd1``
6469 Reserved
6470
6471 ``tnev``
6472 Total Number of Events
6473
6474 ``tll``
6475 Total Log Length
6476
6477 ``rv``
6478 Log Revision
6479
6480 ``rsvd17``
6481 Reserved
6482
6483 ``lhl``
6484 Log Header Length
6485
6486 ``ts``
6487 Timestamp
6488
6489 ``poh``
6490 Power on Hours
6491
6492 ``pcc``
6493 Power Cycle Count
6494
6495 ``vid``
6496 PCI Vendor ID
6497
6498 ``ssvid``
6499 PCI Subsystem Vendor ID
6500
6501 ``sn``
6502 Serial Number
6503
6504 ``mn``
6505 Model Number
6506
6507 ``subnqn``
6508 NVM Subsystem NVMe Qualified Name
6509
6510 ``gen_number``
6511 Generation Number
6512
6513 ``rci``
6514 Reporting Context Information
6515
6516 ``rsvd378``
6517 Reserved
6518
6519 ``seb``
6520 Supported Events Bitmap
6521
6522
6523
6524
6525
6526 .. c:type:: enum nvme_pel_rci
6527
6528 This field indicates the persistent event log reporting context
6529
6530 **Constants**
6531
6532 ``NVME_PEL_RCI_RCPID_SHIFT``
6533 Shift amount to get the reporting context port identifier
6534 from the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
6535
6536 ``NVME_PEL_RCI_RCPIT_SHIFT``
6537 Shift amount to get the reporting context port identifier
6538 type from the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
6539
6540 ``NVME_PEL_RCI_RCE_SHIFT``
6541 Shift amount to get the reporting context exists
6542 from the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
6543
6544 ``NVME_PEL_RCI_RSVD_SHIFT``
6545 Shift amount to get the reserved reporting context
6546 from the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
6547
6548 ``NVME_PEL_RCI_RCPID_MASK``
6549 Mask to get the reporting context port identifier from
6550 the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
6551
6552 ``NVME_PEL_RCI_RCPIT_MASK``
6553 Mask to get the reporting context port identifier type from
6554 the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
6555
6556 ``NVME_PEL_RCI_RCE_MASK``
6557 Mask to get the reporting context exists from
6558 the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
6559
6560 ``NVME_PEL_RCI_RSVD_MASK``
6561 Mask to get the reserved reporting context from
6562 the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
6563
6564
6565
6566
6567 .. c:type:: enum nvme_pel_rci_rcpit
6568
6569 Persistent Event Log Reporting Context - Port Identifier Type
6570
6571 **Constants**
6572
6573 ``NVME_PEL_RCI_RCPIT_NOT_EXIST``
6574 Does not already exist
6575
6576 ``NVME_PEL_RCI_RCPIT_EST_PORT``
6577 Established by an NVM subsystem port
6578
6579 ``NVME_PEL_RCI_RCPIT_EST_ME``
6580 Established by a Management Endpoint
6581
6582
6583
6584
6585 .. c:type:: struct nvme_persistent_event_entry
6586
6587 Persistent Event
6588
6589 **Definition**
6590
6591 ::
6592
6593 struct nvme_persistent_event_entry {
6594 __u8 etype;
6595 __u8 etype_rev;
6596 __u8 ehl;
6597 __u8 ehai;
6598 __le16 cntlid;
6599 __le64 ets;
6600 __le16 pelpid;
6601 __u8 rsvd16[4];
6602 __le16 vsil;
6603 __le16 el;
6604 };
6605
6606 **Members**
6607
6608 ``etype``
6609 Event Type
6610
6611 ``etype_rev``
6612 Event Type Revision
6613
6614 ``ehl``
6615 Event Header Length
6616
6617 ``ehai``
6618 Event Header Additional Info
6619
6620 ``cntlid``
6621 Controller Identifier
6622
6623 ``ets``
6624 Event Timestamp
6625
6626 ``pelpid``
6627 Port Identifier
6628
6629 ``rsvd16``
6630 Reserved
6631
6632 ``vsil``
6633 Vendor Specific Information Length
6634
6635 ``el``
6636 Event Length
6637
6638
6639
6640
6641
6642 .. c:type:: enum nvme_persistent_event_types
6643
6644 Persistent event log events
6645
6646 **Constants**
6647
6648 ``NVME_PEL_SMART_HEALTH_EVENT``
6649 SMART / Health Log Snapshot Event
6650
6651 ``NVME_PEL_FW_COMMIT_EVENT``
6652 Firmware Commit Event
6653
6654 ``NVME_PEL_TIMESTAMP_EVENT``
6655 Timestamp Change Event
6656
6657 ``NVME_PEL_POWER_ON_RESET_EVENT``
6658 Power-on or Reset Event
6659
6660 ``NVME_PEL_NSS_HW_ERROR_EVENT``
6661 NVM Subsystem Hardware Error Event
6662
6663 ``NVME_PEL_CHANGE_NS_EVENT``
6664 Change Namespace Event
6665
6666 ``NVME_PEL_FORMAT_START_EVENT``
6667 Format NVM Start Event
6668
6669 ``NVME_PEL_FORMAT_COMPLETION_EVENT``
6670 Format NVM Completion Event
6671
6672 ``NVME_PEL_SANITIZE_START_EVENT``
6673 Sanitize Start Event
6674
6675 ``NVME_PEL_SANITIZE_COMPLETION_EVENT``
6676 Sanitize Completion Event
6677
6678 ``NVME_PEL_SET_FEATURE_EVENT``
6679 Set Feature Event
6680
6681 ``NVME_PEL_TELEMETRY_CRT``
6682 Telemetry Log Create Event
6683
6684 ``NVME_PEL_THERMAL_EXCURSION_EVENT``
6685 Thermal Excursion Event
6686
6687 ``NVME_PEL_SANITIZE_MEDIA_VERIF_EVENT``
6688 Sanitize Media Verification Event
6689
6690 ``NVME_PEL_VENDOR_SPECIFIC_EVENT``
6691 Vendor Specific Event
6692
6693 ``NVME_PEL_TCG_DEFINED_EVENT``
6694 TCG Defined Event
6695
6696
6697
6698
6699 .. c:type:: enum nvme_pel_ehai
6700
6701 This field indicates the persistent event header additional information
6702
6703 **Constants**
6704
6705 ``NVME_PEL_EHAI_PIT_SHIFT``
6706 Shift amount to get the reporting context port identifier
6707 from the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
6708
6709 ``NVME_PEL_EHAI_RSVD_SHIFT``
6710 Shift amount to get the reserved reporting context
6711 from the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
6712
6713 ``NVME_PEL_EHAI_PIT_MASK``
6714 Mask to get the reporting context port identifier from
6715 the :c:type:`struct nvme_st_result <nvme_st_result>`.dsts field.
6716
6717 ``NVME_PEL_EHAI_RSVD_MASK``
6718 Mask to get the reserved reporting context from
6719 the :c:type:`struct nvme_st_result <nvme_st_result>`.dsts field.
6720
6721
6722
6723
6724 .. c:type:: enum nvme_pel_ehai_pit
6725
6726 Persistent Event Header Additional Information - Port Identifier Type
6727
6728 **Constants**
6729
6730 ``NVME_PEL_EHAI_PIT_NOT_REPORTED``
6731 PIT not reported and PELPID does not apply
6732
6733 ``NVME_PEL_EHAI_PIT_NSS_PORT``
6734 NVM subsystem port
6735
6736 ``NVME_PEL_EHAI_PIT_NMI_PORT``
6737 NVMe-MI port
6738
6739 ``NVME_PEL_EHAI_PIT_NOT_ASSOCIATED``
6740 Event not associated with any port and PELPID does not apply
6741
6742
6743
6744
6745 .. c:type:: struct nvme_fw_commit_event
6746
6747 Firmware Commit Event Data
6748
6749 **Definition**
6750
6751 ::
6752
6753 struct nvme_fw_commit_event {
6754 __le64 old_fw_rev;
6755 __le64 new_fw_rev;
6756 __u8 fw_commit_action;
6757 __u8 fw_slot;
6758 __u8 sct_fw;
6759 __u8 sc_fw;
6760 __le16 vndr_assign_fw_commit_rc;
6761 };
6762
6763 **Members**
6764
6765 ``old_fw_rev``
6766 Old Firmware Revision
6767
6768 ``new_fw_rev``
6769 New Firmware Revision
6770
6771 ``fw_commit_action``
6772 Firmware Commit Action
6773
6774 ``fw_slot``
6775 Firmware Slot
6776
6777 ``sct_fw``
6778 Status Code Type for Firmware Commit Command
6779
6780 ``sc_fw``
6781 Status Returned for Firmware Commit Command
6782
6783 ``vndr_assign_fw_commit_rc``
6784 Vendor Assigned Firmware Commit Result Code
6785
6786
6787
6788
6789
6790 .. c:type:: struct nvme_timestamp
6791
6792 Timestamp - Data Structure for Get Features
6793
6794 **Definition**
6795
6796 ::
6797
6798 struct nvme_timestamp {
6799 __u8 timestamp[6];
6800 __u8 attr;
6801 __u8 rsvd;
6802 };
6803
6804 **Members**
6805
6806 ``timestamp``
6807 Timestamp value based on origin and synch field
6808
6809 ``attr``
6810 Attribute
6811
6812 ``rsvd``
6813 Reserved
6814
6815
6816
6817
6818
6819 .. c:type:: struct nvme_time_stamp_change_event
6820
6821 Timestamp Change Event
6822
6823 **Definition**
6824
6825 ::
6826
6827 struct nvme_time_stamp_change_event {
6828 __le64 previous_timestamp;
6829 __le64 ml_secs_since_reset;
6830 };
6831
6832 **Members**
6833
6834 ``previous_timestamp``
6835 Previous Timestamp
6836
6837 ``ml_secs_since_reset``
6838 Milliseconds Since Reset
6839
6840
6841
6842
6843
6844 .. c:type:: struct nvme_power_on_reset_info_list
6845
6846 Controller Reset Information
6847
6848 **Definition**
6849
6850 ::
6851
6852 struct nvme_power_on_reset_info_list {
6853 __le16 cid;
6854 __u8 fw_act;
6855 __u8 op_in_prog;
6856 __u8 rsvd4[12];
6857 __le32 ctrl_power_cycle;
6858 __le64 power_on_ml_seconds;
6859 __le64 ctrl_time_stamp;
6860 };
6861
6862 **Members**
6863
6864 ``cid``
6865 Controller ID
6866
6867 ``fw_act``
6868 Firmware Activation
6869
6870 ``op_in_prog``
6871 Operation in Progress
6872
6873 ``rsvd4``
6874 Reserved
6875
6876 ``ctrl_power_cycle``
6877 Controller Power Cycle
6878
6879 ``power_on_ml_seconds``
6880 Power on milliseconds
6881
6882 ``ctrl_time_stamp``
6883 Controller Timestamp
6884
6885
6886
6887
6888
6889 .. c:type:: struct nvme_nss_hw_err_event
6890
6891 NVM Subsystem Hardware Error Event
6892
6893 **Definition**
6894
6895 ::
6896
6897 struct nvme_nss_hw_err_event {
6898 __le16 nss_hw_err_event_code;
6899 __u8 rsvd2[2];
6900 __u8 *add_hw_err_info;
6901 };
6902
6903 **Members**
6904
6905 ``nss_hw_err_event_code``
6906 NVM Subsystem Hardware Error Event Code
6907
6908 ``rsvd2``
6909 Reserved
6910
6911 ``add_hw_err_info``
6912 Additional Hardware Error Information
6913
6914
6915
6916
6917
6918 .. c:type:: struct nvme_change_ns_event
6919
6920 Change Namespace Event Data
6921
6922 **Definition**
6923
6924 ::
6925
6926 struct nvme_change_ns_event {
6927 __le32 nsmgt_cdw10;
6928 __u8 rsvd4[4];
6929 __le64 nsze;
6930 __u8 rsvd16[8];
6931 __le64 nscap;
6932 __u8 flbas;
6933 __u8 dps;
6934 __u8 nmic;
6935 __u8 rsvd35;
6936 __le32 ana_grp_id;
6937 __le16 nvmset_id;
6938 __le16 rsvd42;
6939 __le32 nsid;
6940 };
6941
6942 **Members**
6943
6944 ``nsmgt_cdw10``
6945 Namespace Management CDW10
6946
6947 ``rsvd4``
6948 Reserved
6949
6950 ``nsze``
6951 Namespace Size
6952
6953 ``rsvd16``
6954 Reserved
6955
6956 ``nscap``
6957 Namespace Capacity
6958
6959 ``flbas``
6960 Formatted LBA Size
6961
6962 ``dps``
6963 End-to-end Data Protection Type Settings
6964
6965 ``nmic``
6966 Namespace Multi-path I/O and Namespace Sharing Capabilities
6967
6968 ``rsvd35``
6969 Reserved
6970
6971 ``ana_grp_id``
6972 ANA Group Identifier
6973
6974 ``nvmset_id``
6975 NVM Set Identifier
6976
6977 ``rsvd42``
6978 Reserved
6979
6980 ``nsid``
6981 Namespace ID
6982
6983
6984
6985
6986
6987 .. c:type:: struct nvme_format_nvm_start_event
6988
6989 Format NVM Start Event Data
6990
6991 **Definition**
6992
6993 ::
6994
6995 struct nvme_format_nvm_start_event {
6996 __le32 nsid;
6997 __u8 fna;
6998 __u8 rsvd5[3];
6999 __le32 format_nvm_cdw10;
7000 };
7001
7002 **Members**
7003
7004 ``nsid``
7005 Namespace Identifier
7006
7007 ``fna``
7008 Format NVM Attributes
7009
7010 ``rsvd5``
7011 Reserved
7012
7013 ``format_nvm_cdw10``
7014 Format NVM CDW10
7015
7016
7017
7018
7019
7020 .. c:type:: struct nvme_format_nvm_compln_event
7021
7022 Format NVM Completion Event Data
7023
7024 **Definition**
7025
7026 ::
7027
7028 struct nvme_format_nvm_compln_event {
7029 __le32 nsid;
7030 __u8 smallest_fpi;
7031 __u8 format_nvm_status;
7032 __le16 compln_info;
7033 __le32 status_field;
7034 };
7035
7036 **Members**
7037
7038 ``nsid``
7039 Namespace Identifier
7040
7041 ``smallest_fpi``
7042 Smallest Format Progress Indicator
7043
7044 ``format_nvm_status``
7045 Format NVM Status
7046
7047 ``compln_info``
7048 Completion Information
7049
7050 ``status_field``
7051 Status Field
7052
7053
7054
7055
7056
7057 .. c:type:: struct nvme_sanitize_start_event
7058
7059 Sanitize Start Event Data
7060
7061 **Definition**
7062
7063 ::
7064
7065 struct nvme_sanitize_start_event {
7066 __le32 sani_cap;
7067 __le32 sani_cdw10;
7068 __le32 sani_cdw11;
7069 };
7070
7071 **Members**
7072
7073 ``sani_cap``
7074 SANICAP
7075
7076 ``sani_cdw10``
7077 Sanitize CDW10
7078
7079 ``sani_cdw11``
7080 Sanitize CDW11
7081
7082
7083
7084
7085
7086 .. c:type:: struct nvme_sanitize_compln_event
7087
7088 Sanitize Completion Event Data
7089
7090 **Definition**
7091
7092 ::
7093
7094 struct nvme_sanitize_compln_event {
7095 __le16 sani_prog;
7096 __le16 sani_status;
7097 __le16 cmpln_info;
7098 __u8 rsvd6[2];
7099 };
7100
7101 **Members**
7102
7103 ``sani_prog``
7104 Sanitize Progress
7105
7106 ``sani_status``
7107 Sanitize Status
7108
7109 ``cmpln_info``
7110 Completion Information
7111
7112 ``rsvd6``
7113 Reserved
7114
7115
7116
7117
7118
7119 .. c:type:: struct nvme_set_feature_event
7120
7121 Set Feature Event Data
7122
7123 **Definition**
7124
7125 ::
7126
7127 struct nvme_set_feature_event {
7128 __le32 layout;
7129 __le32 cdw_mem[0];
7130 };
7131
7132 **Members**
7133
7134 ``layout``
7135 Set Feature Event Layout
7136
7137 ``cdw_mem``
7138 Command Dwords Memory buffer
7139
7140
7141
7142
7143
7144 .. c:type:: enum nvme_set_feat_event_layout
7145
7146 This field indicates the set feature event layout
7147
7148 **Constants**
7149
7150 ``NVME_SET_FEAT_EVENT_DW_COUNT_SHIFT``
7151 Shift amount to get the Dword count from the
7152 :c:type:`struct nvme_set_feature_event <nvme_set_feature_event>`.layout field.
7153
7154 ``NVME_SET_FEAT_EVENT_CC_DW0_SHIFT``
7155 Shift amount to get the logged command completion Dword 0
7156 from the :c:type:`struct nvme_set_feature_event <nvme_set_feature_event>`.layout field.
7157
7158 ``NVME_SET_FEAT_EVENT_MB_COUNT_SHIFT``
7159 Shift amount to get the memory buffer count from
7160 the :c:type:`struct nvme_set_feature_event <nvme_set_feature_event>`.layout field.
7161
7162 ``NVME_SET_FEAT_EVENT_DW_COUNT_MASK``
7163 Mask to get the Dword count from the :c:type:`struct
7164 nvme_set_feature_event <nvme_set_feature_event>`.layout field.
7165
7166 ``NVME_SET_FEAT_EVENT_CC_DW0_MASK``
7167 Mask to get the logged command completion Dword 0 from
7168 the :c:type:`struct nvme_set_feature_event <nvme_set_feature_event>`.layout field.
7169
7170 ``NVME_SET_FEAT_EVENT_MB_COUNT_MASK``
7171 Mask to get the memory buffer count from the :c:type:`struct
7172 nvme_set_feature_event <nvme_set_feature_event>`.layout field.
7173
7174
7175
7176
7177 .. c:type:: struct nvme_thermal_exc_event
7178
7179 Thermal Excursion Event Data
7180
7181 **Definition**
7182
7183 ::
7184
7185 struct nvme_thermal_exc_event {
7186 __u8 over_temp;
7187 __u8 threshold;
7188 };
7189
7190 **Members**
7191
7192 ``over_temp``
7193 Over Temperature
7194
7195 ``threshold``
7196 temperature threshold
7197
7198
7199
7200
7201
7202 .. c:type:: struct nvme_lba_rd
7203
7204 LBA Range Descriptor
7205
7206 **Definition**
7207
7208 ::
7209
7210 struct nvme_lba_rd {
7211 __le64 rslba;
7212 __le32 rnlb;
7213 __u8 rsvd12[4];
7214 };
7215
7216 **Members**
7217
7218 ``rslba``
7219 Range Starting LBA
7220
7221 ``rnlb``
7222 Range Number of Logical Blocks
7223
7224 ``rsvd12``
7225 Reserved
7226
7227
7228
7229
7230
7231 .. c:type:: struct nvme_lbas_ns_element
7232
7233 LBA Status Log Namespace Element
7234
7235 **Definition**
7236
7237 ::
7238
7239 struct nvme_lbas_ns_element {
7240 __le32 neid;
7241 __le32 nlrd;
7242 __u8 ratype;
7243 __u8 rsvd8[7];
7244 struct nvme_lba_rd lba_rd[];
7245 };
7246
7247 **Members**
7248
7249 ``neid``
7250 Namespace Element Identifier
7251
7252 ``nlrd``
7253 Number of LBA Range Descriptors
7254
7255 ``ratype``
7256 Recommended Action Type. see **enum** nvme_lba_status_atype
7257
7258 ``rsvd8``
7259 Reserved
7260
7261 ``lba_rd``
7262 LBA Range Descriptor
7263
7264
7265
7266
7267
7268 .. c:type:: enum nvme_lba_status_atype
7269
7270 Action type the controller uses to return LBA status
7271
7272 **Constants**
7273
7274 ``NVME_LBA_STATUS_ATYPE_ALLOCATED``
7275 Return tracked allocated LBAs status
7276
7277 ``NVME_LBA_STATUS_ATYPE_SCAN_UNTRACKED``
7278 Perform scan and return Untracked and
7279 Tracked Potentially Unrecoverable LBAs
7280 status
7281
7282 ``NVME_LBA_STATUS_ATYPE_TRACKED``
7283 Return Tracked Potentially Unrecoverable
7284 LBAs associated with physical storage
7285
7286
7287
7288
7289 .. c:type:: struct nvme_lba_status_log
7290
7291 LBA Status Information Log
7292
7293 **Definition**
7294
7295 ::
7296
7297 struct nvme_lba_status_log {
7298 __le32 lslplen;
7299 __le32 nlslne;
7300 __le32 estulb;
7301 __u8 rsvd12[2];
7302 __le16 lsgc;
7303 struct nvme_lbas_ns_element elements[];
7304 };
7305
7306 **Members**
7307
7308 ``lslplen``
7309 LBA Status Log Page Length
7310
7311 ``nlslne``
7312 Number of LBA Status Log Namespace Elements
7313
7314 ``estulb``
7315 Estimate of Unrecoverable Logical Blocks
7316
7317 ``rsvd12``
7318 Reserved
7319
7320 ``lsgc``
7321 LBA Status Generation Counter
7322
7323 ``elements``
7324 LBA Status Log Namespace Element List
7325
7326
7327
7328
7329
7330 .. c:type:: struct nvme_eg_event_aggregate_log
7331
7332 Endurance Group Event Aggregate
7333
7334 **Definition**
7335
7336 ::
7337
7338 struct nvme_eg_event_aggregate_log {
7339 __le64 nr_entries;
7340 __le16 egids[];
7341 };
7342
7343 **Members**
7344
7345 ``nr_entries``
7346 Number of Entries
7347
7348 ``egids``
7349 Endurance Group Identifier
7350
7351
7352
7353
7354
7355 .. c:type:: enum nvme_fid_supported_effects
7356
7357 FID Supported and Effects Data Structure definitions
7358
7359 **Constants**
7360
7361 ``NVME_FID_SUPPORTED_EFFECTS_FSUPP``
7362 FID Supported
7363
7364 ``NVME_FID_SUPPORTED_EFFECTS_UDCC``
7365 User Data Content Change
7366
7367 ``NVME_FID_SUPPORTED_EFFECTS_NCC``
7368 Namespace Capability Change
7369
7370 ``NVME_FID_SUPPORTED_EFFECTS_NIC``
7371 Namespace Inventory Change
7372
7373 ``NVME_FID_SUPPORTED_EFFECTS_CCC``
7374 Controller Capability Change
7375
7376 ``NVME_FID_SUPPORTED_EFFECTS_UUID_SEL``
7377 UUID Selection Supported
7378
7379 ``NVME_FID_SUPPORTED_EFFECTS_SCOPE_SHIFT``
7380 FID Scope Shift
7381
7382 ``NVME_FID_SUPPORTED_EFFECTS_SCOPE_MASK``
7383 FID Scope Mask
7384
7385 ``NVME_FID_SUPPORTED_EFFECTS_SCOPE_NS``
7386 Namespace Scope
7387
7388 ``NVME_FID_SUPPORTED_EFFECTS_SCOPE_CTRL``
7389 Controller Scope
7390
7391 ``NVME_FID_SUPPORTED_EFFECTS_SCOPE_NVM_SET``
7392 NVM Set Scope
7393
7394 ``NVME_FID_SUPPORTED_EFFECTS_SCOPE_ENDGRP``
7395 Endurance Group Scope
7396
7397 ``NVME_FID_SUPPORTED_EFFECTS_SCOPE_DOMAIN``
7398 Domain Scope
7399
7400 ``NVME_FID_SUPPORTED_EFFECTS_SCOPE_NSS``
7401 NVM Subsystem Scope
7402
7403 ``NVME_FID_SUPPORTED_EFFECTS_CDQSCP``
7404 Controller Data Queue
7405
7406
7407
7408
7409 .. c:type:: struct nvme_fid_supported_effects_log
7410
7411 Feature Identifiers Supported and Effects
7412
7413 **Definition**
7414
7415 ::
7416
7417 struct nvme_fid_supported_effects_log {
7418 __le32 fid_support[NVME_LOG_FID_SUPPORTED_EFFECTS_MAX];
7419 };
7420
7421 **Members**
7422
7423 ``fid_support``
7424 Feature Identifier Supported
7425
7426
7427
7428
7429
7430 .. c:type:: enum nvme_mi_cmd_supported_effects
7431
7432 MI Command Supported and Effects Data Structure
7433
7434 **Constants**
7435
7436 ``NVME_MI_CMD_SUPPORTED_EFFECTS_CSUPP``
7437 Command Supported
7438
7439 ``NVME_MI_CMD_SUPPORTED_EFFECTS_UDCC``
7440 User Data Content Change
7441
7442 ``NVME_MI_CMD_SUPPORTED_EFFECTS_NCC``
7443 Namespace Capability Change
7444
7445 ``NVME_MI_CMD_SUPPORTED_EFFECTS_NIC``
7446 Namespace Inventory Change
7447
7448 ``NVME_MI_CMD_SUPPORTED_EFFECTS_CCC``
7449 Controller Capability Change
7450
7451 ``NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_SHIFT``
7452 20 bit shift
7453
7454 ``NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_MASK``
7455 12 bit mask - 0xfff
7456
7457 ``NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_NS``
7458 Namespace Scope
7459
7460 ``NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_CTRL``
7461 Controller Scope
7462
7463 ``NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_NVM_SET``
7464 NVM Set Scope
7465
7466 ``NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_ENDGRP``
7467 Endurance Group Scope
7468
7469 ``NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_DOMAIN``
7470 Domain Scope
7471
7472 ``NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_NSS``
7473 NVM Subsystem Scope
7474
7475
7476
7477
7478 .. c:type:: struct nvme_mi_cmd_supported_effects_log
7479
7480 NVMe-MI Commands Supported and Effects Log
7481
7482 **Definition**
7483
7484 ::
7485
7486 struct nvme_mi_cmd_supported_effects_log {
7487 __le32 mi_cmd_support[NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_MAX];
7488 __le32 reserved1[NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_RESERVED];
7489 };
7490
7491 **Members**
7492
7493 ``mi_cmd_support``
7494 NVMe-MI Commands Supported
7495
7496 ``reserved1``
7497 Reserved
7498
7499
7500
7501
7502
7503 .. c:type:: struct nvme_boot_partition
7504
7505 Boot Partition Log
7506
7507 **Definition**
7508
7509 ::
7510
7511 struct nvme_boot_partition {
7512 __u8 lid;
7513 __u8 rsvd1[3];
7514 __le32 bpinfo;
7515 __u8 rsvd8[8];
7516 __u8 boot_partition_data[];
7517 };
7518
7519 **Members**
7520
7521 ``lid``
7522 Boot Partition Identifier
7523
7524 ``rsvd1``
7525 Reserved
7526
7527 ``bpinfo``
7528 Boot Partition Information
7529
7530 ``rsvd8``
7531 Reserved
7532
7533 ``boot_partition_data``
7534 Contains the contents of the
7535 specified Boot Partition
7536
7537
7538
7539
7540
7541 .. c:type:: enum nvme_boot_partition_info
7542
7543 This field indicates the boot partition information
7544
7545 **Constants**
7546
7547 ``NVME_BOOT_PARTITION_INFO_BPSZ_SHIFT``
7548 Shift amount to get the boot partition size from
7549 the :c:type:`struct nvme_boot_partition <nvme_boot_partition>`.bpinfo field.
7550
7551 ``NVME_BOOT_PARTITION_INFO_ABPID_SHIFT``
7552 Shift amount to get the active boot partition ID
7553 from the :c:type:`struct nvme_boot_partition <nvme_boot_partition>`.bpinfo field.
7554
7555 ``NVME_BOOT_PARTITION_INFO_BPSZ_MASK``
7556 Mask to get the boot partition size from the
7557 :c:type:`struct nvme_boot_partition <nvme_boot_partition>`.bpinfo field.
7558
7559 ``NVME_BOOT_PARTITION_INFO_ABPID_MASK``
7560 Mask to get the active boot partition ID from the
7561 :c:type:`struct nvme_boot_partition <nvme_boot_partition>`.bpinfo field.
7562
7563
7564
7565
7566 .. c:type:: struct nvme_rotational_media_info_log
7567
7568 Rotational Media Information Log
7569
7570 **Definition**
7571
7572 ::
7573
7574 struct nvme_rotational_media_info_log {
7575 __le16 endgid;
7576 __le16 numa;
7577 __le16 nrs;
7578 __u8 rsvd6[2];
7579 __le32 spinc;
7580 __le32 fspinc;
7581 __le32 ldc;
7582 __le32 fldc;
7583 __u8 rsvd24[488];
7584 };
7585
7586 **Members**
7587
7588 ``endgid``
7589 Endurance Group Identifier
7590
7591 ``numa``
7592 Number of Actuators
7593
7594 ``nrs``
7595 Nominal Rotational Speed
7596
7597 ``rsvd6``
7598 Reserved
7599
7600 ``spinc``
7601 Spinup Count
7602
7603 ``fspinc``
7604 Failed Spinup Count
7605
7606 ``ldc``
7607 Load Count
7608
7609 ``fldc``
7610 Failed Load Count
7611
7612 ``rsvd24``
7613 Reserved
7614
7615
7616
7617
7618
7619 .. c:type:: struct nvme_dispersed_ns_participating_nss_log
7620
7621 Dispersed Namespace Participating NVM Subsystems Log
7622
7623 **Definition**
7624
7625 ::
7626
7627 struct nvme_dispersed_ns_participating_nss_log {
7628 __le64 genctr;
7629 __le64 numpsub;
7630 __u8 rsvd16[240];
7631 __u8 participating_nss[];
7632 };
7633
7634 **Members**
7635
7636 ``genctr``
7637 Generation Counter
7638
7639 ``numpsub``
7640 Number of Participating NVM Subsystems
7641
7642 ``rsvd16``
7643 Reserved
7644
7645 ``participating_nss``
7646 Participating NVM Subsystem Entry
7647
7648
7649
7650
7651
7652 .. c:type:: struct nvme_mgmt_addr_desc
7653
7654 Management Address Descriptor
7655
7656 **Definition**
7657
7658 ::
7659
7660 struct nvme_mgmt_addr_desc {
7661 __u8 mat;
7662 __u8 rsvd1[3];
7663 __u8 madrs[508];
7664 };
7665
7666 **Members**
7667
7668 ``mat``
7669 Management Address Type
7670
7671 ``rsvd1``
7672 Reserved
7673
7674 ``madrs``
7675 Management Address
7676
7677
7678
7679
7680
7681 .. c:type:: struct nvme_mgmt_addr_list_log
7682
7683 Management Address List Log
7684
7685 **Definition**
7686
7687 ::
7688
7689 struct nvme_mgmt_addr_list_log {
7690 struct nvme_mgmt_addr_desc mad[8];
7691 };
7692
7693 **Members**
7694
7695 ``mad``
7696 Management Address Descriptor
7697
7698
7699
7700
7701
7702 .. c:type:: struct nvme_eom_lane_desc
7703
7704 EOM Lane Descriptor
7705
7706 **Definition**
7707
7708 ::
7709
7710 struct nvme_eom_lane_desc {
7711 __u8 rsvd0;
7712 __u8 mstatus;
7713 __u8 lane;
7714 __u8 eye;
7715 __le16 top;
7716 __le16 bottom;
7717 __le16 left;
7718 __le16 right;
7719 __le16 nrows;
7720 __le16 ncols;
7721 __le16 edlen;
7722 __u8 rsvd18[14];
7723 __u8 eye_desc[];
7724 };
7725
7726 **Members**
7727
7728 ``rsvd0``
7729 Reserved
7730
7731 ``mstatus``
7732 Measurement Status
7733
7734 ``lane``
7735 Lane number
7736
7737 ``eye``
7738 Eye number
7739
7740 ``top``
7741 Absolute number of rows from center to top edge of eye
7742
7743 ``bottom``
7744 Absolute number of rows from center to bottom edge of eye
7745
7746 ``left``
7747 Absolute number of rows from center to left edge of eye
7748
7749 ``right``
7750 Absolute number of rows from center to right edge of eye
7751
7752 ``nrows``
7753 Number of Rows
7754
7755 ``ncols``
7756 Number of Columns
7757
7758 ``edlen``
7759 Eye Data Length
7760
7761 ``rsvd18``
7762 Reserved
7763
7764 ``eye_desc``
7765 Printable Eye, Eye Data, and any Padding
7766
7767
7768
7769
7770
7771 .. c:type:: struct nvme_phy_rx_eom_log
7772
7773 Physical Interface Receiver Eye Opening Measurement Log
7774
7775 **Definition**
7776
7777 ::
7778
7779 struct nvme_phy_rx_eom_log {
7780 __u8 lid;
7781 __u8 eomip;
7782 __le16 hsize;
7783 __le32 rsize;
7784 __u8 eomdgn;
7785 __u8 lr;
7786 __u8 odp;
7787 __u8 lanes;
7788 __u8 epl;
7789 __u8 lspfc;
7790 __u8 li;
7791 __u8 rsvd15[3];
7792 __le16 lsic;
7793 __le32 dsize;
7794 __le16 nd;
7795 __le16 maxtb;
7796 __le16 maxlr;
7797 __le16 etgood;
7798 __le16 etbetter;
7799 __le16 etbest;
7800 __u8 rsvd36[28];
7801 struct nvme_eom_lane_desc descs[];
7802 };
7803
7804 **Members**
7805
7806 ``lid``
7807 Log Identifier
7808
7809 ``eomip``
7810 EOM In Progress
7811
7812 ``hsize``
7813 Header Size
7814
7815 ``rsize``
7816 Result Size
7817
7818 ``eomdgn``
7819 EOM Data Generation Number
7820
7821 ``lr``
7822 Log Revision
7823
7824 ``odp``
7825 Optional Data Present
7826
7827 ``lanes``
7828 Number of lanes configured for this port
7829
7830 ``epl``
7831 Eyes Per Lane
7832
7833 ``lspfc``
7834 Log Specific Parameter Field Copy
7835
7836 ``li``
7837 Link Information
7838
7839 ``rsvd15``
7840 Reserved
7841
7842 ``lsic``
7843 Log Specific Identifier Copy
7844
7845 ``dsize``
7846 Descriptor Size
7847
7848 ``nd``
7849 Number of Descriptors
7850
7851 ``maxtb``
7852 Maximum Top Bottom
7853
7854 ``maxlr``
7855 Maximum Left Right
7856
7857 ``etgood``
7858 Estimated Time for Good Quality
7859
7860 ``etbetter``
7861 Estimated Time for Better Quality
7862
7863 ``etbest``
7864 Estimated Time for Best Quality
7865
7866 ``rsvd36``
7867 Reserved
7868
7869 ``descs``
7870 EOM Lane Descriptors
7871
7872
7873
7874
7875
7876 .. c:type:: enum nvme_eom_optional_data_present
7877
7878 EOM Optional Data Present Fields
7879
7880 **Constants**
7881
7882 ``NVME_EOM_ODP_PEFP_SHIFT``
7883 Shift amount to get the printable eye field present
7884 from the :c:type:`struct nvme_phy_rx_eom_log <nvme_phy_rx_eom_log>`.odp field.
7885
7886 ``NVME_EOM_ODP_EDFP_SHIFT``
7887 Shift amount to get the eye data field present
7888 from the :c:type:`struct nvme_phy_rx_eom_log <nvme_phy_rx_eom_log>`.odp field.
7889
7890 ``NVME_EOM_ODP_RSVD_SHIFT``
7891 Shift amount to get the reserved optional data present
7892 from the :c:type:`struct nvme_phy_rx_eom_log <nvme_phy_rx_eom_log>`.odp field.
7893
7894 ``NVME_EOM_ODP_PEFP_MASK``
7895 Mask to get the printable eye field present
7896 from the :c:type:`struct nvme_phy_rx_eom_log <nvme_phy_rx_eom_log>`.odp field.
7897
7898 ``NVME_EOM_ODP_EDFP_MASK``
7899 Mask to get the eye data field present
7900 from the :c:type:`struct nvme_phy_rx_eom_log <nvme_phy_rx_eom_log>`.odp field.
7901
7902 ``NVME_EOM_ODP_RSVD_MASK``
7903 Mask to get the reserved data present
7904 from the :c:type:`struct nvme_phy_rx_eom_log <nvme_phy_rx_eom_log>`.odp field.
7905
7906
7907
7908
7909 .. c:type:: enum nvme_eom_optional_data
7910
7911 EOM Optional Data Present Fields (Deprecated)
7912
7913 **Constants**
7914
7915 ``NVME_EOM_PRINTABLE_EYE_PRESENT``
7916 Printable Eye Present
7917
7918 ``NVME_EOM_EYE_DATA_PRESENT``
7919 Eye Data Present
7920
7921
7922
7923
7924 .. c:type:: enum nvme_phy_rx_eom_progress
7925
7926 EOM In Progress Values
7927
7928 **Constants**
7929
7930 ``NVME_PHY_RX_EOM_NOT_STARTED``
7931 EOM Not Started
7932
7933 ``NVME_PHY_RX_EOM_IN_PROGRESS``
7934 EOM In Progress
7935
7936 ``NVME_PHY_RX_EOM_COMPLETED``
7937 EOM Completed
7938
7939
7940
7941
7942 .. c:type:: struct nvme_reachability_group_desc
7943
7944 Reachability Group Descriptor
7945
7946 **Definition**
7947
7948 ::
7949
7950 struct nvme_reachability_group_desc {
7951 __le32 rgid;
7952 __le32 nnid;
7953 __le64 chngc;
7954 __u8 rsvd16[16];
7955 __le32 nsid[];
7956 };
7957
7958 **Members**
7959
7960 ``rgid``
7961 Reachability Group ID
7962
7963 ``nnid``
7964 Number of NSID Values
7965
7966 ``chngc``
7967 Change Count
7968
7969 ``rsvd16``
7970 Reserved
7971
7972 ``nsid``
7973 Namespace Identifier List
7974
7975
7976
7977
7978
7979 .. c:type:: struct nvme_reachability_groups_log
7980
7981 Reachability Groups Log
7982
7983 **Definition**
7984
7985 ::
7986
7987 struct nvme_reachability_groups_log {
7988 __le64 chngc;
7989 __le16 nrgd;
7990 __u8 rsvd10[6];
7991 struct nvme_reachability_group_desc rgd[];
7992 };
7993
7994 **Members**
7995
7996 ``chngc``
7997 Change Count
7998
7999 ``nrgd``
8000 Number of Reachability Group Descriptors
8001
8002 ``rsvd10``
8003 Reserved
8004
8005 ``rgd``
8006 Reachability Group Descriptor List
8007
8008
8009
8010
8011
8012 .. c:type:: struct nvme_reachability_association_desc
8013
8014 Reachability Association Descriptor
8015
8016 **Definition**
8017
8018 ::
8019
8020 struct nvme_reachability_association_desc {
8021 __le32 rasid;
8022 __le32 nrid;
8023 __le64 chngc;
8024 __u8 rac;
8025 __u8 rsvd17[15];
8026 __le32 rgid[];
8027 };
8028
8029 **Members**
8030
8031 ``rasid``
8032 Reachability Association ID
8033
8034 ``nrid``
8035 Number of RGID Values
8036
8037 ``chngc``
8038 Change Count
8039
8040 ``rac``
8041 Reachability Association Characteristics
8042
8043 ``rsvd17``
8044 Reserved
8045
8046 ``rgid``
8047 Reachability Group Identifier List
8048
8049
8050
8051
8052
8053 .. c:type:: struct nvme_reachability_associations_log
8054
8055 Reachability Associations Log
8056
8057 **Definition**
8058
8059 ::
8060
8061 struct nvme_reachability_associations_log {
8062 __le64 chngc;
8063 __le16 nrad;
8064 __u8 rsvd10[6];
8065 struct nvme_reachability_association_desc rad[];
8066 };
8067
8068 **Members**
8069
8070 ``chngc``
8071 Change Count
8072
8073 ``nrad``
8074 Number of Reachability Association Descriptors
8075
8076 ``rsvd10``
8077 Reserved
8078
8079 ``rad``
8080 Reachability Association Descriptor List
8081
8082
8083
8084
8085
8086 .. c:type:: struct nvme_media_unit_stat_desc
8087
8088 Media Unit Status Descriptor
8089
8090 **Definition**
8091
8092 ::
8093
8094 struct nvme_media_unit_stat_desc {
8095 __le16 muid;
8096 __le16 domainid;
8097 __le16 endgid;
8098 __le16 nvmsetid;
8099 __le16 cap_adj_fctr;
8100 __u8 avl_spare;
8101 __u8 percent_used;
8102 __u8 mucs;
8103 __u8 cio;
8104 };
8105
8106 **Members**
8107
8108 ``muid``
8109 Media Unit Identifier
8110
8111 ``domainid``
8112 Domain Identifier
8113
8114 ``endgid``
8115 Endurance Group Identifier
8116
8117 ``nvmsetid``
8118 NVM Set Identifier
8119
8120 ``cap_adj_fctr``
8121 Capacity Adjustment Factor
8122
8123 ``avl_spare``
8124 Available Spare
8125
8126 ``percent_used``
8127 Percentage Used
8128
8129 ``mucs``
8130 Number of Channels attached to media units
8131
8132 ``cio``
8133 Channel Identifiers Offset
8134
8135
8136
8137
8138
8139 .. c:type:: struct nvme_media_unit_stat_log
8140
8141 Media Unit Status
8142
8143 **Definition**
8144
8145 ::
8146
8147 struct nvme_media_unit_stat_log {
8148 __le16 nmu;
8149 __le16 cchans;
8150 __le16 sel_config;
8151 __u8 rsvd6[10];
8152 struct nvme_media_unit_stat_desc mus_desc[];
8153 };
8154
8155 **Members**
8156
8157 ``nmu``
8158 Number unit status descriptor
8159
8160 ``cchans``
8161 Number of Channels
8162
8163 ``sel_config``
8164 Selected Configuration
8165
8166 ``rsvd6``
8167 Reserved
8168
8169 ``mus_desc``
8170 Media unit statistic descriptors
8171
8172
8173
8174
8175
8176 .. c:type:: struct nvme_media_unit_config_desc
8177
8178 Media Unit Configuration Descriptor
8179
8180 **Definition**
8181
8182 ::
8183
8184 struct nvme_media_unit_config_desc {
8185 __le16 muid;
8186 __u8 rsvd2[4];
8187 __le16 mudl;
8188 };
8189
8190 **Members**
8191
8192 ``muid``
8193 Media Unit Identifier
8194
8195 ``rsvd2``
8196 Reserved
8197
8198 ``mudl``
8199 Media Unit Descriptor Length
8200
8201
8202
8203
8204
8205 .. c:type:: struct nvme_channel_config_desc
8206
8207 Channel Configuration Descriptor
8208
8209 **Definition**
8210
8211 ::
8212
8213 struct nvme_channel_config_desc {
8214 __le16 chanid;
8215 __le16 chmus;
8216 struct nvme_media_unit_config_desc mu_config_desc[];
8217 };
8218
8219 **Members**
8220
8221 ``chanid``
8222 Channel Identifier
8223
8224 ``chmus``
8225 Number Channel Media Units
8226
8227 ``mu_config_desc``
8228 Channel Unit config descriptors.
8229 See **struct** nvme_media_unit_config_desc
8230
8231
8232
8233
8234
8235 .. c:type:: struct nvme_end_grp_chan_desc
8236
8237 Endurance Group Channel Configuration Descriptor
8238
8239 **Definition**
8240
8241 ::
8242
8243 struct nvme_end_grp_chan_desc {
8244 __le16 egchans;
8245 struct nvme_channel_config_desc chan_config_desc[];
8246 };
8247
8248 **Members**
8249
8250 ``egchans``
8251 Number of Channels
8252
8253 ``chan_config_desc``
8254 Channel config descriptors.
8255 See **struct** nvme_channel_config_desc
8256
8257
8258
8259
8260
8261 .. c:type:: struct nvme_end_grp_config_desc
8262
8263 Endurance Group Configuration Descriptor
8264
8265 **Definition**
8266
8267 ::
8268
8269 struct nvme_end_grp_config_desc {
8270 __le16 endgid;
8271 __le16 cap_adj_factor;
8272 __u8 rsvd4[12];
8273 __u8 tegcap[16];
8274 __u8 segcap[16];
8275 __u8 end_est[16];
8276 __u8 rsvd64[16];
8277 __le16 egsets;
8278 __le16 nvmsetid[];
8279 };
8280
8281 **Members**
8282
8283 ``endgid``
8284 Endurance Group Identifier
8285
8286 ``cap_adj_factor``
8287 Capacity Adjustment Factor
8288
8289 ``rsvd4``
8290 Reserved
8291
8292 ``tegcap``
8293 Total Endurance Group Capacity
8294
8295 ``segcap``
8296 Spare Endurance Group Capacity
8297
8298 ``end_est``
8299 Endurance Estimate
8300
8301 ``rsvd64``
8302 Reserved
8303
8304 ``egsets``
8305 Number of NVM Sets
8306
8307 ``nvmsetid``
8308 NVM Set Identifier
8309
8310
8311
8312
8313
8314 .. c:type:: struct nvme_capacity_config_desc
8315
8316 Capacity Configuration structure definitions
8317
8318 **Definition**
8319
8320 ::
8321
8322 struct nvme_capacity_config_desc {
8323 __le16 cap_config_id;
8324 __le16 domainid;
8325 __le16 egcn;
8326 __u8 rsvd6[26];
8327 struct nvme_end_grp_config_desc egcd[];
8328 };
8329
8330 **Members**
8331
8332 ``cap_config_id``
8333 Capacity Configuration Identifier
8334
8335 ``domainid``
8336 Domain Identifier
8337
8338 ``egcn``
8339 Number Endurance Group Configuration
8340 Descriptors
8341
8342 ``rsvd6``
8343 Reserved
8344
8345 ``egcd``
8346 Endurance Group Config descriptors.
8347 See **struct** nvme_end_grp_config_desc
8348
8349
8350
8351
8352
8353 .. c:type:: struct nvme_supported_cap_config_list_log
8354
8355 Supported Capacity Configuration list log page
8356
8357 **Definition**
8358
8359 ::
8360
8361 struct nvme_supported_cap_config_list_log {
8362 __u8 sccn;
8363 __u8 rsvd1[15];
8364 struct nvme_capacity_config_desc cap_config_desc[];
8365 };
8366
8367 **Members**
8368
8369 ``sccn``
8370 Number of capacity configuration
8371
8372 ``rsvd1``
8373 Reserved
8374
8375 ``cap_config_desc``
8376 Capacity configuration descriptor.
8377 See **struct** nvme_capacity_config_desc
8378
8379
8380
8381
8382
8383 .. c:type:: struct nvme_lockdown_log
8384
8385 Command and Feature Lockdown Log
8386
8387 **Definition**
8388
8389 ::
8390
8391 struct nvme_lockdown_log {
8392 __u8 cfila;
8393 __u8 rsvd1[2];
8394 __u8 lngth;
8395 __u8 cfil[508];
8396 };
8397
8398 **Members**
8399
8400 ``cfila``
8401 Contents of the Command and Feature Identifier List field in the log page.
8402
8403 ``rsvd1``
8404 Reserved
8405
8406 ``lngth``
8407 Length of Command and Feature Identifier List field
8408
8409 ``cfil``
8410 Command and Feature Identifier List
8411
8412
8413
8414
8415
8416 .. c:type:: struct nvme_resv_notification_log
8417
8418 Reservation Notification Log
8419
8420 **Definition**
8421
8422 ::
8423
8424 struct nvme_resv_notification_log {
8425 __le64 lpc;
8426 __u8 rnlpt;
8427 __u8 nalp;
8428 __u8 rsvd9[2];
8429 __le32 nsid;
8430 __u8 rsvd16[48];
8431 };
8432
8433 **Members**
8434
8435 ``lpc``
8436 Log Page Count
8437
8438 ``rnlpt``
8439 See :c:type:`enum nvme_resv_notify_rnlpt <nvme_resv_notify_rnlpt>`.
8440
8441 ``nalp``
8442 Number of Available Log Pages
8443
8444 ``rsvd9``
8445 Reserved
8446
8447 ``nsid``
8448 Namespace ID
8449
8450 ``rsvd16``
8451 Reserved
8452
8453
8454
8455
8456
8457 .. c:type:: enum nvme_resv_notify_rnlpt
8458
8459 Reservation Notification Log - Reservation Notification Log Page Type
8460
8461 **Constants**
8462
8463 ``NVME_RESV_NOTIFY_RNLPT_EMPTY``
8464 Empty Log Page
8465
8466 ``NVME_RESV_NOTIFY_RNLPT_REGISTRATION_PREEMPTED``
8467 Registration Preempted
8468
8469 ``NVME_RESV_NOTIFY_RNLPT_RESERVATION_RELEASED``
8470 Reservation Released
8471
8472 ``NVME_RESV_NOTIFY_RNLPT_RESERVATION_PREEMPTED``
8473 Reservation Preempted
8474
8475
8476
8477
8478 .. c:type:: struct nvme_sanitize_log_page
8479
8480 Sanitize Status (Log Identifier 81h)
8481
8482 **Definition**
8483
8484 ::
8485
8486 struct nvme_sanitize_log_page {
8487 __le16 sprog;
8488 __le16 sstat;
8489 __le32 scdw10;
8490 __le32 eto;
8491 __le32 etbe;
8492 __le32 etce;
8493 __le32 etond;
8494 __le32 etbend;
8495 __le32 etcend;
8496 __le32 etpvds;
8497 __u8 ssi;
8498 __u8 rsvd37[475];
8499 };
8500
8501 **Members**
8502
8503 ``sprog``
8504 Sanitize Progress (SPROG): indicates the fraction complete of the
8505 sanitize operation. The value is a numerator of the fraction
8506 complete that has 65,536 (10000h) as its denominator. This value
8507 shall be set to FFFFh if the **sstat** field is not set to
8508 ``NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS``.
8509
8510 ``sstat``
8511 Sanitize Status (SSTAT): indicates the status associated with
8512 the most recent sanitize operation. See :c:type:`enum nvme_sanitize_sstat <nvme_sanitize_sstat>`.
8513
8514 ``scdw10``
8515 Sanitize Command Dword 10 Information (SCDW10): contains the value
8516 of the Command Dword 10 field of the Sanitize command that started
8517 the sanitize operation.
8518
8519 ``eto``
8520 Estimated Time For Overwrite: indicates the number of seconds required
8521 to complete an Overwrite sanitize operation with 16 passes in
8522 the background when the No-Deallocate Modifies Media After Sanitize
8523 field is not set to 10b. A value of 0h indicates that the sanitize
8524 operation is expected to be completed in the background when the
8525 Sanitize command that started that operation is completed. A value
8526 of FFFFFFFFh indicates that no time period is reported.
8527
8528 ``etbe``
8529 Estimated Time For Block Erase: indicates the number of seconds
8530 required to complete a Block Erase sanitize operation in the
8531 background when the No-Deallocate Modifies Media After Sanitize
8532 field is not set to 10b. A value of 0h indicates that the sanitize
8533 operation is expected to be completed in the background when the
8534 Sanitize command that started that operation is completed.
8535 A value of FFFFFFFFh indicates that no time period is reported.
8536
8537 ``etce``
8538 Estimated Time For Crypto Erase: indicates the number of seconds
8539 required to complete a Crypto Erase sanitize operation in the
8540 background when the No-Deallocate Modifies Media After Sanitize
8541 field is not set to 10b. A value of 0h indicates that the sanitize
8542 operation is expected to be completed in the background when the
8543 Sanitize command that started that operation is completed.
8544 A value of FFFFFFFFh indicates that no time period is reported.
8545
8546 ``etond``
8547 Estimated Time For Overwrite With No-Deallocate Media Modification:
8548 indicates the number of seconds required to complete an Overwrite
8549 sanitize operation and the associated additional media modification
8550 after the Overwrite sanitize operation in the background when
8551 the No-Deallocate After Sanitize bit was set to 1 in the Sanitize
8552 command that requested the Overwrite sanitize operation; and
8553 the No-Deallocate Modifies Media After Sanitize field is set to 10b.
8554 A value of 0h indicates that the sanitize operation is expected
8555 to be completed in the background when the Sanitize command that
8556 started that operation is completed. A value of FFFFFFFFh indicates
8557 that no time period is reported.
8558
8559 ``etbend``
8560 Estimated Time For Block Erase With No-Deallocate Media Modification:
8561 indicates the number of seconds required to complete a Block Erase
8562 sanitize operation and the associated additional media modification
8563 after the Block Erase sanitize operation in the background when
8564 the No-Deallocate After Sanitize bit was set to 1 in the Sanitize
8565 command that requested the Overwrite sanitize operation; and
8566 the No-Deallocate Modifies Media After Sanitize field is set to 10b.
8567 A value of 0h indicates that the sanitize operation is expected
8568 to be completed in the background when the Sanitize command that
8569 started that operation is completed. A value of FFFFFFFFh indicates
8570 that no time period is reported.
8571
8572 ``etcend``
8573 Estimated Time For Crypto Erase With No-Deallocate Media Modification:
8574 indicates the number of seconds required to complete a Crypto Erase
8575 sanitize operation and the associated additional media modification
8576 after the Crypto Erase sanitize operation in the background when
8577 the No-Deallocate After Sanitize bit was set to 1 in the Sanitize
8578 command that requested the Overwrite sanitize operation; and
8579 the No-Deallocate Modifies Media After Sanitize field is set to 10b.
8580 A value of 0h indicates that the sanitize operation is expected
8581 to be completed in the background when the Sanitize command that
8582 started that operation is completed. A value of FFFFFFFFh indicates
8583 that no time period is reported.
8584
8585 ``etpvds``
8586 Estimated Time For Post-Verification Deallocation State: indicates the
8587 number of seconds required to deallocate all media allocated for user data
8588 after exiting the Media Verification state (i.e., the time difference between
8589 entering and exiting the Post-Verification Deallocation state), if that state
8590 is entered as part of the sanitize operation. A value of FFFFFFFFh indicates
8591 that no time period is reported.
8592
8593 ``ssi``
8594 Sanitize State Information: indicate the state of the Sanitize Operation
8595 State Machine.
8596
8597 ``rsvd37``
8598 Reserved
8599
8600
8601
8602
8603
8604 .. c:type:: enum nvme_sanitize_sstat
8605
8606 Sanitize Status (SSTAT)
8607
8608 **Constants**
8609
8610 ``NVME_SANITIZE_SSTAT_STATUS_SHIFT``
8611 Shift amount to get the status value of
8612 the most recent sanitize operation from
8613 the :c:type:`struct nvme_sanitize_log_page <nvme_sanitize_log_page>`.sstat
8614 field.
8615
8616 ``NVME_SANITIZE_SSTAT_STATUS_MASK``
8617 Mask to get the status value of the most
8618 recent sanitize operation.
8619
8620 ``NVME_SANITIZE_SSTAT_STATUS_NEVER_SANITIZED``
8621 The NVM subsystem has never been
8622 sanitized.
8623
8624 ``NVME_SANITIZE_SSTAT_STATUS_COMPLETE_SUCCESS``
8625 The most recent sanitize operation
8626 completed successfully including any
8627 additional media modification.
8628
8629 ``NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS``
8630 A sanitize operation is currently in progress.
8631
8632 ``NVME_SANITIZE_SSTAT_STATUS_COMPLETED_FAILED``
8633 The most recent sanitize operation
8634 failed.
8635
8636 ``NVME_SANITIZE_SSTAT_STATUS_ND_COMPLETE_SUCCESS``
8637 The most recent sanitize operation
8638 for which No-Deallocate After Sanitize was
8639 requested has completed successfully with
8640 deallocation of all user data.
8641
8642 ``NVME_SANITIZE_SSTAT_COMPLETED_PASSES_SHIFT``
8643 Shift amount to get the number
8644 of completed passes if the most recent
8645 sanitize operation was an Overwrite. This
8646 value shall be cleared to 0h if the most
8647 recent sanitize operation was not
8648 an Overwrite.
8649
8650 ``NVME_SANITIZE_SSTAT_COMPLETED_PASSES_MASK``
8651 Mask to get the number of completed
8652 passes.
8653
8654 ``NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_SHIFT``
8655 Shift amount to get the Global
8656 Data Erased value from the
8657 :c:type:`struct nvme_sanitize_log_page <nvme_sanitize_log_page>`.sstat field.
8658
8659 ``NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_MASK``
8660 Mask to get the Global Data Erased
8661 value.
8662
8663 ``NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED``
8664 Global Data Erased: if set, then no
8665 namespace user data in the NVM subsystem
8666 has been written to and no Persistent
8667 Memory Region in the NVM subsystem has
8668 been enabled since being manufactured and
8669 the NVM subsystem has never been sanitized;
8670 or since the most recent successful sanitize
8671 operation.
8672
8673 ``NVME_SANITIZE_SSTAT_MVCNCLD_SHIFT``
8674 Shift amount to get the value of Media Verification
8675 Canceled bit of Sanitize status field.
8676
8677 ``NVME_SANITIZE_SSTAT_MVCNCLD_MASK``
8678 Mask to get the value of Media Verification Canceled
8679 bit of Sanitize status field.
8680
8681
8682
8683
8684 .. c:type:: enum nvme_sanitize_ssi
8685
8686 Sanitize State Information (SSI)
8687
8688 **Constants**
8689
8690 ``NVME_SANITIZE_SSI_SANS_SHIFT``
8691 Shift amount to get the value of Sanitize State
8692 from Sanitize State Information (SSI) field.
8693
8694 ``NVME_SANITIZE_SSI_SANS_MASK``
8695 Mask to get the value of Sanitize State from
8696 Sanitize State Information (SSI) field.
8697
8698 ``NVME_SANITIZE_SSI_FAILS_SHIFT``
8699 Shift amount to get the value of Failure State
8700 from Sanitize State Information (SSI) field.
8701
8702 ``NVME_SANITIZE_SSI_FAILS_MASK``
8703 Mask to get the value of Failure State from
8704 Sanitize State Information (SSI) field.
8705
8706 ``NVME_SANITIZE_SSI_IDLE``
8707 No sanitize operation is in process.
8708
8709 ``NVME_SANITIZE_SSI_RESTRICT_PROCESSING``
8710 The Sanitize operation is in Restricted Processing
8711 State.
8712
8713 ``NVME_SANITIZE_SSI_RESTRICT_FAILURE``
8714 The Sanitize operation is in Restricted Failure
8715 State. This state is entered if sanitize processing
8716 was performed in the Restricted Processing state and
8717 sanitize processing failed or a failure occurred
8718 during deallocation of media allocated for user data
8719 in the Post-Verification Deallocation state.
8720
8721 ``NVME_SANITIZE_SSI_UNRESTRICT_PROCESSING``
8722 The Sanitize operation is in Unrestricted Processing
8723 State.
8724
8725 ``NVME_SANITIZE_SSI_UNRESTRICT_FAILURE``
8726 The Sanitize operation is in Unrestricted Failure
8727 State. This state is entered if sanitize processing
8728 was performed in the Unrestricted Processing state
8729 and sanitize processing failed or a failure occurred
8730 during deallocation of media allocated for user data
8731 in the Post-Verification.
8732
8733 ``NVME_SANITIZE_SSI_MEDIA_VERIFICATION``
8734 The Sanitize operation is in Media Verification
8735 State. In this state, the sanitize processing
8736 completed successfully, and all media allocated for
8737 user data in the sanitization target is readable by
8738 the host for purposes of verifying sanitization.
8739
8740 ``NVME_SANITIZE_SSI_POST_VERIF_DEALLOC``
8741 The Sanitize operation is in Post-Verification
8742 Deallocation State. In this state, the controller
8743 shall deallocate all media allocated for user data
8744 in the sanitization target.
8745
8746
8747
8748
8749 .. c:type:: struct nvme_zns_changed_zone_log
8750
8751 ZNS Changed Zone List log
8752
8753 **Definition**
8754
8755 ::
8756
8757 struct nvme_zns_changed_zone_log {
8758 __le16 nrzid;
8759 __u8 rsvd2[6];
8760 __le64 zid[NVME_ZNS_CHANGED_ZONES_MAX];
8761 };
8762
8763 **Members**
8764
8765 ``nrzid``
8766 Number of Zone Identifiers
8767
8768 ``rsvd2``
8769 Reserved
8770
8771 ``zid``
8772 Zone Identifier
8773
8774
8775
8776
8777
8778 .. c:type:: enum nvme_zns_zt
8779
8780 Zone Descriptor Data Structure - Zone Type
8781
8782 **Constants**
8783
8784 ``NVME_ZONE_TYPE_SEQWRITE_REQ``
8785 Sequential Write Required
8786
8787
8788
8789
8790 .. c:type:: enum nvme_zns_za
8791
8792 Zone Descriptor Data Structure
8793
8794 **Constants**
8795
8796 ``NVME_ZNS_ZA_ZFC``
8797 Zone Finished by Controller
8798
8799 ``NVME_ZNS_ZA_FZR``
8800 Finish Zone Recommended
8801
8802 ``NVME_ZNS_ZA_RZR``
8803 Reset Zone Recommended
8804
8805 ``NVME_ZNS_ZA_ZRWAV``
8806
8807 ``NVME_ZNS_ZA_ZDEV``
8808 Zone Descriptor Extension Valid
8809
8810
8811
8812
8813 .. c:type:: enum nvme_zns_zs
8814
8815 Zone Descriptor Data Structure - Zone State
8816
8817 **Constants**
8818
8819 ``NVME_ZNS_ZS_EMPTY``
8820 Empty state
8821
8822 ``NVME_ZNS_ZS_IMPL_OPEN``
8823 Implicitly open state
8824
8825 ``NVME_ZNS_ZS_EXPL_OPEN``
8826 Explicitly open state
8827
8828 ``NVME_ZNS_ZS_CLOSED``
8829 Closed state
8830
8831 ``NVME_ZNS_ZS_READ_ONLY``
8832 Read only state
8833
8834 ``NVME_ZNS_ZS_FULL``
8835 Full state
8836
8837 ``NVME_ZNS_ZS_OFFLINE``
8838 Offline state
8839
8840
8841
8842
8843 .. c:type:: struct nvme_zns_desc
8844
8845 Zone Descriptor Data Structure
8846
8847 **Definition**
8848
8849 ::
8850
8851 struct nvme_zns_desc {
8852 __u8 zt;
8853 __u8 zs;
8854 __u8 za;
8855 __u8 zai;
8856 __u8 rsvd4[4];
8857 __le64 zcap;
8858 __le64 zslba;
8859 __le64 wp;
8860 __u8 rsvd32[32];
8861 };
8862
8863 **Members**
8864
8865 ``zt``
8866 Zone Type
8867
8868 ``zs``
8869 Zone State
8870
8871 ``za``
8872 Zone Attributes
8873
8874 ``zai``
8875 Zone Attributes Information
8876
8877 ``rsvd4``
8878 Reserved
8879
8880 ``zcap``
8881 Zone Capacity
8882
8883 ``zslba``
8884 Zone Start Logical Block Address
8885
8886 ``wp``
8887 Write Pointer
8888
8889 ``rsvd32``
8890 Reserved
8891
8892
8893
8894
8895
8896 .. c:type:: struct nvme_zone_report
8897
8898 Report Zones Data Structure
8899
8900 **Definition**
8901
8902 ::
8903
8904 struct nvme_zone_report {
8905 __le64 nr_zones;
8906 __u8 rsvd8[56];
8907 struct nvme_zns_desc entries[];
8908 };
8909
8910 **Members**
8911
8912 ``nr_zones``
8913 Number of descriptors in **entries**
8914
8915 ``rsvd8``
8916 Reserved
8917
8918 ``entries``
8919 Zoned namespace descriptors
8920
8921
8922
8923
8924
8925 .. c:type:: enum nvme_fdp_ruh_type
8926
8927 Reclaim Unit Handle Type
8928
8929 **Constants**
8930
8931 ``NVME_FDP_RUHT_INITIALLY_ISOLATED``
8932 Initially Isolated
8933
8934 ``NVME_FDP_RUHT_PERSISTENTLY_ISOLATED``
8935 Persistently Isolated
8936
8937
8938
8939
8940 .. c:type:: struct nvme_fdp_ruh_desc
8941
8942 Reclaim Unit Handle Descriptor
8943
8944 **Definition**
8945
8946 ::
8947
8948 struct nvme_fdp_ruh_desc {
8949 __u8 ruht;
8950 __u8 rsvd1[3];
8951 };
8952
8953 **Members**
8954
8955 ``ruht``
8956 Reclaim Unit Handle Type
8957
8958 ``rsvd1``
8959 Reserved
8960
8961
8962
8963
8964
8965 .. c:type:: enum nvme_fdp_config_fdpa
8966
8967 FDP Attributes
8968
8969 **Constants**
8970
8971 ``NVME_FDP_CONFIG_FDPA_RGIF_SHIFT``
8972 Reclaim Group Identifier Format Shift
8973
8974 ``NVME_FDP_CONFIG_FDPA_RGIF_MASK``
8975 Reclaim Group Identifier Format Mask
8976
8977 ``NVME_FDP_CONFIG_FDPA_FDPVWC_SHIFT``
8978 FDP Volatile Write Cache Shift
8979
8980 ``NVME_FDP_CONFIG_FDPA_FDPVWC_MASK``
8981 FDP Volatile Write Cache Mask
8982
8983 ``NVME_FDP_CONFIG_FDPA_VALID_SHIFT``
8984 FDP Configuration Valid Shift
8985
8986 ``NVME_FDP_CONFIG_FDPA_VALID_MASK``
8987 FDP Configuration Valid Mask
8988
8989
8990
8991
8992 .. c:type:: enum nvme_lockdown_log_scope
8993
8994 lockdown log page scope attributes
8995
8996 **Constants**
8997
8998 ``NVME_LOCKDOWN_ADMIN_CMD``
8999 Scope value for Admin commandS
9000
9001 ``NVME_LOCKDOWN_FEATURE_ID``
9002 Scope value for Feature ID
9003
9004 ``NVME_LOCKDOWN_MI_CMD_SET``
9005 Scope value for Management Interface commands
9006
9007 ``NVME_LOCKDOWN_PCI_CMD_SET``
9008 Scope value for PCI commands
9009
9010
9011
9012
9013 .. c:type:: enum nvme_lockdown_log_contents
9014
9015 lockdown log page content attributes
9016
9017 **Constants**
9018
9019 ``NVME_LOCKDOWN_SUPPORTED_CMD``
9020 Content value for Supported commands
9021
9022 ``NVME_LOCKDOWN_PROHIBITED_CMD``
9023 Content value for prohibited commands
9024
9025 ``NVME_LOCKDOWN_PROHIBITED_OUTOFBAND_CMD``
9026 Content value for prohibited side band commands
9027
9028
9029
9030
9031 .. c:type:: enum nvme_lockdown_scope_contents
9032
9033 Lockdown Log shift and mask
9034
9035 **Constants**
9036
9037 ``NVME_LOCKDOWN_SS_SHIFT``
9038 Lockdown log scope select Shift
9039
9040 ``NVME_LOCKDOWN_SS_MASK``
9041 Lockdown log scope select Mask
9042
9043 ``NVME_LOCKDOWN_CS_SHIFT``
9044 Lockdown log contents Shift
9045
9046 ``NVME_LOCKDOWN_CS_MASK``
9047 Lockdown log contents Mask
9048
9049
9050
9051
9052 .. c:type:: struct nvme_fdp_config_desc
9053
9054 FDP Configuration Descriptor
9055
9056 **Definition**
9057
9058 ::
9059
9060 struct nvme_fdp_config_desc {
9061 __le16 size;
9062 __u8 fdpa;
9063 __u8 vss;
9064 __le32 nrg;
9065 __le16 nruh;
9066 __le16 maxpids;
9067 __le32 nnss;
9068 __le64 runs;
9069 __le32 erutl;
9070 __u8 rsvd28[36];
9071 struct nvme_fdp_ruh_desc ruhs[];
9072 };
9073
9074 **Members**
9075
9076 ``size``
9077 Descriptor size
9078
9079 ``fdpa``
9080 FDP Attributes (:c:type:`enum nvme_fdp_config_fdpa <nvme_fdp_config_fdpa>`)
9081
9082 ``vss``
9083 Vendor Specific Size
9084
9085 ``nrg``
9086 Number of Reclaim Groups
9087
9088 ``nruh``
9089 Number of Reclaim Unit Handles
9090
9091 ``maxpids``
9092 Max Placement Identifiers
9093
9094 ``nnss``
9095 Number of Namespaces Supported
9096
9097 ``runs``
9098 Reclaim Unit Nominal Size
9099
9100 ``erutl``
9101 Estimated Reclaim Unit Time Limit
9102
9103 ``rsvd28``
9104 Reserved
9105
9106 ``ruhs``
9107 Reclaim Unit Handle descriptors (:c:type:`struct nvme_fdp_ruh_desc <nvme_fdp_ruh_desc>`)
9108
9109
9110
9111
9112
9113 .. c:type:: struct nvme_fdp_config_log
9114
9115 FDP Configurations Log Page
9116
9117 **Definition**
9118
9119 ::
9120
9121 struct nvme_fdp_config_log {
9122 __le16 n;
9123 __u8 version;
9124 __u8 rsvd3;
9125 __le32 size;
9126 __u8 rsvd8[8];
9127 struct nvme_fdp_config_desc configs[];
9128 };
9129
9130 **Members**
9131
9132 ``n``
9133 Number of FDP Configurations
9134
9135 ``version``
9136 Log page version
9137
9138 ``rsvd3``
9139 Reserved
9140
9141 ``size``
9142 Log page size in bytes
9143
9144 ``rsvd8``
9145 Reserved
9146
9147 ``configs``
9148 FDP Configuration descriptors (:c:type:`struct nvme_fdp_config_desc <nvme_fdp_config_desc>`)
9149
9150
9151
9152
9153
9154 .. c:type:: enum nvme_fdp_ruha
9155
9156 Reclaim Unit Handle Attributes
9157
9158 **Constants**
9159
9160 ``NVME_FDP_RUHA_HOST_SHIFT``
9161 Host Specified Reclaim Unit Handle Shift
9162
9163 ``NVME_FDP_RUHA_HOST_MASK``
9164 Host Specified Reclaim Unit Handle Mask
9165
9166 ``NVME_FDP_RUHA_CTRL_SHIFT``
9167 Controller Specified Reclaim Unit Handle Shift
9168
9169 ``NVME_FDP_RUHA_CTRL_MASK``
9170 Controller Specified Reclaim Unit Handle Mask
9171
9172
9173
9174
9175 .. c:type:: struct nvme_fdp_ruhu_desc
9176
9177 Reclaim Unit Handle Usage Descriptor
9178
9179 **Definition**
9180
9181 ::
9182
9183 struct nvme_fdp_ruhu_desc {
9184 __u8 ruha;
9185 __u8 rsvd1[7];
9186 };
9187
9188 **Members**
9189
9190 ``ruha``
9191 Reclaim Unit Handle Attributes (:c:type:`enum nvme_fdp_ruha <nvme_fdp_ruha>`)
9192
9193 ``rsvd1``
9194 Reserved
9195
9196
9197
9198
9199
9200 .. c:type:: struct nvme_fdp_ruhu_log
9201
9202 Reclaim Unit Handle Usage Log Page
9203
9204 **Definition**
9205
9206 ::
9207
9208 struct nvme_fdp_ruhu_log {
9209 __le16 nruh;
9210 __u8 rsvd2[6];
9211 struct nvme_fdp_ruhu_desc ruhus[];
9212 };
9213
9214 **Members**
9215
9216 ``nruh``
9217 Number of Reclaim Unit Handles
9218
9219 ``rsvd2``
9220 Reserved
9221
9222 ``ruhus``
9223 Reclaim Unit Handle Usage descriptors
9224
9225
9226
9227
9228
9229 .. c:type:: struct nvme_fdp_stats_log
9230
9231 FDP Statistics Log Page
9232
9233 **Definition**
9234
9235 ::
9236
9237 struct nvme_fdp_stats_log {
9238 __u8 hbmw[16];
9239 __u8 mbmw[16];
9240 __u8 mbe[16];
9241 __u8 rsvd48[16];
9242 };
9243
9244 **Members**
9245
9246 ``hbmw``
9247 Host Bytes with Metadata Written
9248
9249 ``mbmw``
9250 Media Bytes with Metadata Written
9251
9252 ``mbe``
9253 Media Bytes Erased
9254
9255 ``rsvd48``
9256 Reserved
9257
9258
9259
9260
9261
9262 .. c:type:: enum nvme_fdp_event_type
9263
9264 FDP Event Types
9265
9266 **Constants**
9267
9268 ``NVME_FDP_EVENT_RUNFW``
9269 Reclaim Unit Not Fully Written
9270
9271 ``NVME_FDP_EVENT_RUTLE``
9272 Reclaim Unit Time Limit Exceeded
9273
9274 ``NVME_FDP_EVENT_RESET``
9275 Controller Level Reset Modified Reclaim Unit Handles
9276
9277 ``NVME_FDP_EVENT_PID``
9278 Invalid Placement Identifier
9279
9280 ``NVME_FDP_EVENT_REALLOC``
9281 Media Reallocated
9282
9283 ``NVME_FDP_EVENT_MODIFY``
9284 Implicitly Modified Reclaim Unit Handle
9285
9286
9287
9288
9289 .. c:type:: enum nvme_fdp_event_realloc_flags
9290
9291 Media Reallocated Event Type Specific Flags
9292
9293 **Constants**
9294
9295 ``NVME_FDP_EVENT_REALLOC_F_LBAV``
9296 LBA Valid
9297
9298
9299
9300
9301 .. c:type:: struct nvme_fdp_event_realloc
9302
9303 Media Reallocated Event Type Specific Information
9304
9305 **Definition**
9306
9307 ::
9308
9309 struct nvme_fdp_event_realloc {
9310 __u8 flags;
9311 __u8 rsvd1;
9312 __le16 nlbam;
9313 __le64 lba;
9314 __u8 rsvd12[4];
9315 };
9316
9317 **Members**
9318
9319 ``flags``
9320 Event Type Specific flags (:c:type:`enum nvme_fdp_event_realloc_flags <nvme_fdp_event_realloc_flags>`)
9321
9322 ``rsvd1``
9323 Reserved
9324
9325 ``nlbam``
9326 Number of LBAs Moved
9327
9328 ``lba``
9329 Logical Block Address
9330
9331 ``rsvd12``
9332 Reserved
9333
9334
9335
9336
9337
9338 .. c:type:: enum nvme_fdp_event_flags
9339
9340 FDP Event Flags
9341
9342 **Constants**
9343
9344 ``NVME_FDP_EVENT_F_PIV``
9345 Placement Identifier Valid
9346
9347 ``NVME_FDP_EVENT_F_NSIDV``
9348 Namespace Identifier Valid
9349
9350 ``NVME_FDP_EVENT_F_LV``
9351 Location Valid
9352
9353
9354
9355
9356 .. c:type:: struct nvme_fdp_event
9357
9358 FDP Event
9359
9360 **Definition**
9361
9362 ::
9363
9364 struct nvme_fdp_event {
9365 __u8 type;
9366 __u8 flags;
9367 __le16 pid;
9368 struct nvme_timestamp ts;
9369 __le32 nsid;
9370 __u8 type_specific[16];
9371 __le16 rgid;
9372 __u8 ruhid;
9373 __u8 rsvd35[5];
9374 __u8 vs[24];
9375 };
9376
9377 **Members**
9378
9379 ``type``
9380 Event Type (:c:type:`enum nvme_fdp_event_type <nvme_fdp_event_type>`)
9381
9382 ``flags``
9383 Event Flags (:c:type:`enum nvme_fdp_event_flags <nvme_fdp_event_flags>`)
9384
9385 ``pid``
9386 Placement Identifier
9387
9388 ``ts``
9389 Timestamp
9390
9391 ``nsid``
9392 Namespace Identifier
9393
9394 ``type_specific``
9395 Event Type Specific Information
9396
9397 ``rgid``
9398 Reclaim Group Identifier
9399
9400 ``ruhid``
9401 Reclaim Unit Handle Identifier
9402
9403 ``rsvd35``
9404 Reserved
9405
9406 ``vs``
9407 Vendor Specific
9408
9409
9410
9411
9412
9413 .. c:type:: struct nvme_fdp_events_log
9414
9415 FDP Events Log Page
9416
9417 **Definition**
9418
9419 ::
9420
9421 struct nvme_fdp_events_log {
9422 __le32 n;
9423 __u8 rsvd4[60];
9424 struct nvme_fdp_event events[63];
9425 };
9426
9427 **Members**
9428
9429 ``n``
9430 Number of FDP Events
9431
9432 ``rsvd4``
9433 Reserved
9434
9435 ``events``
9436 FDP Events (:c:type:`struct nvme_fdp_event <nvme_fdp_event>`)
9437
9438
9439
9440
9441
9442 .. c:type:: struct nvme_feat_fdp_events_cdw11
9443
9444 FDP Events Feature Command Dword 11 Deprecated: doesn't support this struct. Use NVME_FEAT_FDPE_*** definitions instead.
9445
9446 **Definition**
9447
9448 ::
9449
9450 struct nvme_feat_fdp_events_cdw11 {
9451 __le16 phndl;
9452 __u8 noet;
9453 __u8 rsvd24;
9454 };
9455
9456 **Members**
9457
9458 ``phndl``
9459 Placement Handle
9460
9461 ``noet``
9462 Number of FDP Event Types
9463
9464 ``rsvd24``
9465 Reserved
9466
9467
9468
9469
9470
9471 .. c:type:: enum nvme_fdp_supported_event_attributes
9472
9473 Supported FDP Event Attributes
9474
9475 **Constants**
9476
9477 ``NVME_FDP_SUPP_EVENT_ENABLED_SHIFT``
9478 FDP Event Enable Shift
9479
9480 ``NVME_FDP_SUPP_EVENT_ENABLED_MASK``
9481 FDP Event Enable Mask
9482
9483
9484
9485
9486 .. c:type:: struct nvme_fdp_supported_event_desc
9487
9488 Supported FDP Event Descriptor
9489
9490 **Definition**
9491
9492 ::
9493
9494 struct nvme_fdp_supported_event_desc {
9495 __u8 evt;
9496 __u8 evta;
9497 };
9498
9499 **Members**
9500
9501 ``evt``
9502 FDP Event Type
9503
9504 ``evta``
9505 FDP Event Type Attributes (:c:type:`enum nvme_fdp_supported_event_attributes <nvme_fdp_supported_event_attributes>`)
9506
9507
9508
9509
9510
9511 .. c:type:: struct nvme_fdp_ruh_status_desc
9512
9513 Reclaim Unit Handle Status Descriptor
9514
9515 **Definition**
9516
9517 ::
9518
9519 struct nvme_fdp_ruh_status_desc {
9520 __le16 pid;
9521 __le16 ruhid;
9522 __le32 earutr;
9523 __le64 ruamw;
9524 __u8 rsvd16[16];
9525 };
9526
9527 **Members**
9528
9529 ``pid``
9530 Placement Identifier
9531
9532 ``ruhid``
9533 Reclaim Unit Handle Identifier
9534
9535 ``earutr``
9536 Estimated Active Reclaim Unit Time Remaining
9537
9538 ``ruamw``
9539 Reclaim Unit Available Media Writes
9540
9541 ``rsvd16``
9542 Reserved
9543
9544
9545
9546
9547
9548 .. c:type:: struct nvme_fdp_ruh_status
9549
9550 Reclaim Unit Handle Status
9551
9552 **Definition**
9553
9554 ::
9555
9556 struct nvme_fdp_ruh_status {
9557 __u8 rsvd0[14];
9558 __le16 nruhsd;
9559 struct nvme_fdp_ruh_status_desc ruhss[];
9560 };
9561
9562 **Members**
9563
9564 ``rsvd0``
9565 Reserved
9566
9567 ``nruhsd``
9568 Number of Reclaim Unit Handle Status Descriptors
9569
9570 ``ruhss``
9571 Reclaim Unit Handle Status descriptors
9572
9573
9574
9575
9576
9577 .. c:type:: struct nvme_lba_status_desc
9578
9579 LBA Status Descriptor Entry
9580
9581 **Definition**
9582
9583 ::
9584
9585 struct nvme_lba_status_desc {
9586 __le64 dslba;
9587 __le32 nlb;
9588 __u8 rsvd12;
9589 __u8 status;
9590 __u8 rsvd14[2];
9591 };
9592
9593 **Members**
9594
9595 ``dslba``
9596 Descriptor Starting LBA
9597
9598 ``nlb``
9599 Number of Logical Blocks
9600
9601 ``rsvd12``
9602 Reserved
9603
9604 ``status``
9605 Additional status about this LBA range
9606
9607 ``rsvd14``
9608 Reserved
9609
9610
9611
9612
9613
9614 .. c:type:: struct nvme_lba_status
9615
9616 LBA Status Descriptor List
9617
9618 **Definition**
9619
9620 ::
9621
9622 struct nvme_lba_status {
9623 __le32 nlsd;
9624 __u8 cmpc;
9625 __u8 rsvd5[3];
9626 struct nvme_lba_status_desc descs[];
9627 };
9628
9629 **Members**
9630
9631 ``nlsd``
9632 Number of LBA Status Descriptors
9633
9634 ``cmpc``
9635 Completion Condition
9636
9637 ``rsvd5``
9638 Reserved
9639
9640 ``descs``
9641 LBA status descriptor Entry
9642
9643
9644
9645
9646
9647 .. c:type:: enum nvme_lba_status_cmpc
9648
9649 Get LBA Status Command Completion Condition
9650
9651 **Constants**
9652
9653 ``NVME_LBA_STATUS_CMPC_NO_CMPC``
9654 No indication of the completion condition
9655
9656 ``NVME_LBA_STATUS_CMPC_INCOMPLETE``
9657 Command completed, but additional LBA Status
9658 Descriptor Entries are available to transfer
9659 or scan did not complete (if ATYPE = 10h)
9660
9661 ``NVME_LBA_STATUS_CMPC_COMPLETE``
9662 Completed the specified action over the number
9663 of LBAs specified in the Range Length field and
9664 transferred all available LBA Status Descriptors
9665
9666
9667
9668
9669 .. c:type:: struct nvme_feat_auto_pst
9670
9671 Autonomous Power State Transition
9672
9673 **Definition**
9674
9675 ::
9676
9677 struct nvme_feat_auto_pst {
9678 __le64 apst_entry[32];
9679 };
9680
9681 **Members**
9682
9683 ``apst_entry``
9684 See :c:type:`enum nvme_apst_entry <nvme_apst_entry>`
9685
9686
9687
9688
9689
9690 .. c:type:: enum nvme_apst_entry
9691
9692 Autonomous Power State Transition
9693
9694 **Constants**
9695
9696 ``NVME_APST_ENTRY_ITPS_SHIFT``
9697 Idle Transition Power State Shift
9698
9699 ``NVME_APST_ENTRY_ITPT_SHIFT``
9700 Idle Time Prior to Transition Shift
9701
9702 ``NVME_APST_ENTRY_ITPS_MASK``
9703 Idle Transition Power State Mask
9704
9705 ``NVME_APST_ENTRY_ITPT_MASK``
9706 Idle Time Prior to Transition Mask
9707
9708
9709
9710
9711 .. c:type:: struct nvme_std_perf_attr
9712
9713 Standard performance attribute structure
9714
9715 **Definition**
9716
9717 ::
9718
9719 struct nvme_std_perf_attr {
9720 __u8 rsvd0[4];
9721 __u8 r4karl;
9722 __u8 rsvd5[4091];
9723 };
9724
9725 **Members**
9726
9727 ``rsvd0``
9728 Reserved
9729
9730 ``r4karl``
9731 Random 4 KiB average read latency
9732
9733 ``rsvd5``
9734 Reserved
9735
9736
9737
9738
9739
9740 .. c:type:: struct nvme_perf_attr_id
9741
9742 Performance attribute identifier structure
9743
9744 **Definition**
9745
9746 ::
9747
9748 struct nvme_perf_attr_id {
9749 __u8 id[NVME_UUID_LEN];
9750 };
9751
9752 **Members**
9753
9754 ``id``
9755 Performance attribute identifier
9756
9757
9758
9759
9760
9761 .. c:type:: struct nvme_perf_attr_id_list
9762
9763 Performance attribute identifier list structure
9764
9765 **Definition**
9766
9767 ::
9768
9769 struct nvme_perf_attr_id_list {
9770 __u8 attrtyp;
9771 __u8 msvspa;
9772 __u8 usvspa;
9773 __u8 rsvd3[13];
9774 struct nvme_perf_attr_id id_list[63];
9775 __u8 rsvd1024[3072];
9776 };
9777
9778 **Members**
9779
9780 ``attrtyp``
9781 Bits 7-3: Reserved
9782 Bits 2-0: Attribute type
9783
9784 ``msvspa``
9785 Maximum saveable vendor specific performance attributes
9786
9787 ``usvspa``
9788 Unused saveable vendor specific performance attributes
9789
9790 ``rsvd3``
9791 Reserved
9792
9793 ``id_list``
9794 Performance attribute identifier list
9795
9796 ``rsvd1024``
9797 Reserved
9798
9799
9800
9801
9802
9803 .. c:type:: struct nvme_vs_perf_attr
9804
9805 Vendor specific performance attribute structure
9806
9807 **Definition**
9808
9809 ::
9810
9811 struct nvme_vs_perf_attr {
9812 __u8 paid[16];
9813 __u8 rsvd16[14];
9814 __le16 attrl;
9815 __u8 vs[4064];
9816 };
9817
9818 **Members**
9819
9820 ``paid``
9821 Performance attribute identifier
9822
9823 ``rsvd16``
9824 Reserved
9825
9826 ``attrl``
9827 Attribute Length
9828
9829 ``vs``
9830 Vendor specific
9831
9832
9833
9834
9835
9836 .. c:type:: struct nvme_perf_characteristics
9837
9838 Performance attribute structure
9839
9840 **Definition**
9841
9842 ::
9843
9844 struct nvme_perf_characteristics {
9845 union {
9846 struct nvme_std_perf_attr std_perf[0];
9847 struct nvme_perf_attr_id_list id_list[0];
9848 struct nvme_vs_perf_attr vs_perf[0];
9849 __u8 attr_buf[4096];
9850 };
9851 };
9852
9853 **Members**
9854
9855 ``{unnamed_union}``
9856 anonymous
9857
9858 ``std_perf``
9859 Standard performance attribute
9860
9861 ``id_list``
9862 Performance attribute identifier list
9863
9864 ``vs_perf``
9865 Vendor specific performance attribute
9866
9867 ``attr_buf``
9868 Attribute buffer
9869
9870
9871
9872
9873
9874 .. c:type:: struct nvme_metadata_element_desc
9875
9876 Metadata Element Descriptor
9877
9878 **Definition**
9879
9880 ::
9881
9882 struct nvme_metadata_element_desc {
9883 __u8 type;
9884 __u8 rev;
9885 __le16 len;
9886 __u8 val[0];
9887 };
9888
9889 **Members**
9890
9891 ``type``
9892 Element Type (ET)
9893
9894 ``rev``
9895 Element Revision (ER)
9896
9897 ``len``
9898 Element Length (ELEN)
9899
9900 ``val``
9901 Element Value (EVAL), UTF-8 string
9902
9903
9904
9905
9906
9907 .. c:type:: struct nvme_host_metadata
9908
9909 Host Metadata Data Structure
9910
9911 **Definition**
9912
9913 ::
9914
9915 struct nvme_host_metadata {
9916 __u8 ndesc;
9917 __u8 rsvd1;
9918 union {
9919 struct nvme_metadata_element_desc descs[0];
9920 __u8 descs_buf[4094];
9921 };
9922 };
9923
9924 **Members**
9925
9926 ``ndesc``
9927 Number of metadata element descriptors
9928
9929 ``rsvd1``
9930 Reserved
9931
9932 ``{unnamed_union}``
9933 anonymous
9934
9935 ``descs``
9936 Metadata element descriptors
9937
9938 ``descs_buf``
9939 Metadata element descriptor buffer
9940
9941
9942
9943
9944
9945 .. c:type:: enum nvme_ctrl_metadata_type
9946
9947 Controller Metadata Element Types
9948
9949 **Constants**
9950
9951 ``NVME_CTRL_METADATA_OS_CTRL_NAME``
9952 Name of the controller in
9953 the operating system.
9954
9955 ``NVME_CTRL_METADATA_OS_DRIVER_NAME``
9956 Name of the driver in the
9957 operating system.
9958
9959 ``NVME_CTRL_METADATA_OS_DRIVER_VER``
9960 Version of the driver in
9961 the operating system.
9962
9963 ``NVME_CTRL_METADATA_PRE_BOOT_CTRL_NAME``
9964 Name of the controller in
9965 the pre-boot environment.
9966
9967 ``NVME_CTRL_METADATA_PRE_BOOT_DRIVER_NAME``
9968 Name of the driver in the
9969 pre-boot environment.
9970
9971 ``NVME_CTRL_METADATA_PRE_BOOT_DRIVER_VER``
9972 Version of the driver in the
9973 pre-boot environment.
9974
9975 ``NVME_CTRL_METADATA_SYS_PROC_MODEL``
9976 Model of the processor.
9977
9978 ``NVME_CTRL_METADATA_CHIPSET_DRV_NAME``
9979 Chipset driver name.
9980
9981 ``NVME_CTRL_METADATA_CHIPSET_DRV_VERSION``
9982 Chipset driver version.
9983
9984 ``NVME_CTRL_METADATA_OS_NAME_AND_BUILD``
9985 Operating system name and build.
9986
9987 ``NVME_CTRL_METADATA_SYS_PROD_NAME``
9988 System product name.
9989
9990 ``NVME_CTRL_METADATA_FIRMWARE_VERSION``
9991 Host firmware (e.g UEFI) version.
9992
9993 ``NVME_CTRL_METADATA_OS_DRIVER_FILENAME``
9994 Operating system driver filename.
9995
9996 ``NVME_CTRL_METADATA_DISPLAY_DRV_NAME``
9997 Display driver name.
9998
9999 ``NVME_CTRL_METADATA_DISPLAY_DRV_VERSION``
10000 Display driver version.
10001
10002 ``NVME_CTRL_METADATA_HOST_DET_FAIL_REC``
10003 Failure record.
10004
10005
10006
10007
10008 .. c:type:: enum nvme_ns_metadata_type
10009
10010 Namespace Metadata Element Types
10011
10012 **Constants**
10013
10014 ``NVME_NS_METADATA_OS_NS_NAME``
10015 Name of the namespace in the
10016 operating system
10017
10018 ``NVME_NS_METADATA_PRE_BOOT_NS_NAME``
10019 Name of the namespace in the pre-boot
10020 environment.
10021
10022 ``NVME_NS_METADATA_OS_NS_QUAL_1``
10023 First qualifier of the Operating System
10024 Namespace Name.
10025
10026 ``NVME_NS_METADATA_OS_NS_QUAL_2``
10027 Second qualifier of the Operating System
10028 Namespace Name.
10029
10030
10031
10032
10033 .. c:type:: struct nvme_lba_range_type_entry
10034
10035 LBA Range Type - Data Structure Entry
10036
10037 **Definition**
10038
10039 ::
10040
10041 struct nvme_lba_range_type_entry {
10042 __u8 type;
10043 __u8 attributes;
10044 __u8 rsvd2[14];
10045 __le64 slba;
10046 __le64 nlb;
10047 __u8 guid[16];
10048 __u8 rsvd48[16];
10049 };
10050
10051 **Members**
10052
10053 ``type``
10054 Specifies the Type of the LBA range
10055
10056 ``attributes``
10057 Specifies attributes of the LBA range
10058
10059 ``rsvd2``
10060 Reserved
10061
10062 ``slba``
10063 Starting LBA
10064
10065 ``nlb``
10066 Number of Logical Blocks
10067
10068 ``guid``
10069 Unique Identifier
10070
10071 ``rsvd48``
10072 Reserved
10073
10074
10075
10076
10077
10078 .. c:type:: enum nvme_lbart
10079
10080 LBA Range Type - Data Structure Entry
10081
10082 **Constants**
10083
10084 ``NVME_LBART_TYPE_GP``
10085 General Purpose
10086
10087 ``NVME_LBART_TYPE_FS``
10088 Filesystem
10089
10090 ``NVME_LBART_TYPE_RAID``
10091 RAID
10092
10093 ``NVME_LBART_TYPE_CACHE``
10094 Cache
10095
10096 ``NVME_LBART_TYPE_SWAP``
10097 Page / swap file
10098
10099 ``NVME_LBART_ATTRIB_TEMP``
10100 Temp
10101
10102 ``NVME_LBART_ATTRIB_HIDE``
10103 Hidden
10104
10105
10106
10107
10108 .. c:type:: struct nvme_lba_range_type
10109
10110 LBA Range Type
10111
10112 **Definition**
10113
10114 ::
10115
10116 struct nvme_lba_range_type {
10117 struct nvme_lba_range_type_entry entry[NVME_FEAT_LBA_RANGE_MAX];
10118 };
10119
10120 **Members**
10121
10122 ``entry``
10123 LBA range type entry. See **struct** nvme_lba_range_type_entry
10124
10125
10126
10127
10128
10129 .. c:type:: struct nvme_plm_config
10130
10131 Predictable Latency Mode - Deterministic Threshold Configuration Data Structure
10132
10133 **Definition**
10134
10135 ::
10136
10137 struct nvme_plm_config {
10138 __le16 ee;
10139 __u8 rsvd2[30];
10140 __le64 dtwinrt;
10141 __le64 dtwinwt;
10142 __le64 dtwintt;
10143 __u8 rsvd56[456];
10144 };
10145
10146 **Members**
10147
10148 ``ee``
10149 Enable Event
10150
10151 ``rsvd2``
10152 Reserved
10153
10154 ``dtwinrt``
10155 DTWIN Reads Threshold
10156
10157 ``dtwinwt``
10158 DTWIN Writes Threshold
10159
10160 ``dtwintt``
10161 DTWIN Time Threshold
10162
10163 ``rsvd56``
10164 Reserved
10165
10166
10167
10168
10169
10170 .. c:type:: struct nvme_feat_host_behavior
10171
10172 Host Behavior Support - Data Structure
10173
10174 **Definition**
10175
10176 ::
10177
10178 struct nvme_feat_host_behavior {
10179 __u8 acre;
10180 __u8 etdas;
10181 __u8 lbafee;
10182 __u8 hdisns;
10183 __le16 cdfe;
10184 __u8 rsvd6[506];
10185 };
10186
10187 **Members**
10188
10189 ``acre``
10190 Advanced Command Retry Enable
10191
10192 ``etdas``
10193 Extended Telemetry Data Area 4 Supported
10194
10195 ``lbafee``
10196 LBA Format Extension Enable
10197
10198 ``hdisns``
10199 Host Dispersed Namespace Support
10200
10201 ``cdfe``
10202 Copy Descriptor Formats Enable
10203
10204 ``rsvd6``
10205 Reserved
10206
10207
10208
10209
10210
10211 .. c:type:: enum nvme_host_behavior_support
10212
10213 Enable Advanced Command
10214
10215 **Constants**
10216
10217 ``NVME_ENABLE_ACRE``
10218 Enable Advanced Command Retry Enable
10219
10220
10221
10222
10223 .. c:type:: struct nvme_dsm_range
10224
10225 Dataset Management - Range Definition
10226
10227 **Definition**
10228
10229 ::
10230
10231 struct nvme_dsm_range {
10232 __le32 cattr;
10233 __le32 nlb;
10234 __le64 slba;
10235 };
10236
10237 **Members**
10238
10239 ``cattr``
10240 Context Attributes
10241
10242 ``nlb``
10243 Length in logical blocks
10244
10245 ``slba``
10246 Starting LBA
10247
10248
10249
10250
10251
10252 .. c:type:: struct nvme_copy_range
10253
10254 Copy - Source Range Entries Descriptor Format
10255
10256 **Definition**
10257
10258 ::
10259
10260 struct nvme_copy_range {
10261 __u8 rsvd0[8];
10262 __le64 slba;
10263 __le16 nlb;
10264 __u8 rsvd18[6];
10265 __le32 eilbrt;
10266 __le16 elbat;
10267 __le16 elbatm;
10268 };
10269
10270 **Members**
10271
10272 ``rsvd0``
10273 Reserved
10274
10275 ``slba``
10276 Starting LBA
10277
10278 ``nlb``
10279 Number of Logical Blocks
10280
10281 ``rsvd18``
10282 Reserved
10283
10284 ``eilbrt``
10285 Expected Initial Logical Block Reference Tag /
10286 Expected Logical Block Storage Tag
10287
10288 ``elbat``
10289 Expected Logical Block Application Tag
10290
10291 ``elbatm``
10292 Expected Logical Block Application Tag Mask
10293
10294
10295
10296
10297
10298 .. c:type:: struct nvme_copy_range_f1
10299
10300 Copy - Source Range Entries Descriptor Format 1h
10301
10302 **Definition**
10303
10304 ::
10305
10306 struct nvme_copy_range_f1 {
10307 __u8 rsvd0[8];
10308 __le64 slba;
10309 __le16 nlb;
10310 __u8 rsvd18[8];
10311 __u8 elbt[10];
10312 __le16 elbat;
10313 __le16 elbatm;
10314 };
10315
10316 **Members**
10317
10318 ``rsvd0``
10319 Reserved
10320
10321 ``slba``
10322 Starting LBA
10323
10324 ``nlb``
10325 Number of Logical Blocks
10326
10327 ``rsvd18``
10328 Reserved
10329
10330 ``elbt``
10331 Expected Initial Logical Block Reference Tag /
10332 Expected Logical Block Storage Tag
10333
10334 ``elbat``
10335 Expected Logical Block Application Tag
10336
10337 ``elbatm``
10338 Expected Logical Block Application Tag Mask
10339
10340
10341
10342
10343
10344 .. c:type:: enum nvme_copy_range_sopt
10345
10346 NVMe Copy Range Source Options
10347
10348 **Constants**
10349
10350 ``NVME_COPY_SOPT_FCO``
10351 NVMe Copy Source Option Fast Copy Only
10352
10353
10354
10355
10356 .. c:type:: struct nvme_copy_range_f2
10357
10358 Copy - Source Range Entries Descriptor Format 2h
10359
10360 **Definition**
10361
10362 ::
10363
10364 struct nvme_copy_range_f2 {
10365 __le32 snsid;
10366 __u8 rsvd4[4];
10367 __le64 slba;
10368 __le16 nlb;
10369 __u8 rsvd18[4];
10370 __le16 sopt;
10371 __le32 eilbrt;
10372 __le16 elbat;
10373 __le16 elbatm;
10374 };
10375
10376 **Members**
10377
10378 ``snsid``
10379 Source Namespace Identifier
10380
10381 ``rsvd4``
10382 Reserved
10383
10384 ``slba``
10385 Starting LBA
10386
10387 ``nlb``
10388 Number of Logical Blocks
10389
10390 ``rsvd18``
10391 Reserved
10392
10393 ``sopt``
10394 Source Options
10395
10396 ``eilbrt``
10397 Expected Initial Logical Block Reference Tag /
10398 Expected Logical Block Storage Tag
10399
10400 ``elbat``
10401 Expected Logical Block Application Tag
10402
10403 ``elbatm``
10404 Expected Logical Block Application Tag Mask
10405
10406
10407
10408
10409
10410 .. c:type:: struct nvme_copy_range_f3
10411
10412 Copy - Source Range Entries Descriptor Format 3h
10413
10414 **Definition**
10415
10416 ::
10417
10418 struct nvme_copy_range_f3 {
10419 __le32 snsid;
10420 __u8 rsvd4[4];
10421 __le64 slba;
10422 __le16 nlb;
10423 __u8 rsvd18[4];
10424 __le16 sopt;
10425 __u8 rsvd24[2];
10426 __u8 elbt[10];
10427 __le16 elbat;
10428 __le16 elbatm;
10429 };
10430
10431 **Members**
10432
10433 ``snsid``
10434 Source Namespace Identifier
10435
10436 ``rsvd4``
10437 Reserved
10438
10439 ``slba``
10440 Starting LBA
10441
10442 ``nlb``
10443 Number of Logical Blocks
10444
10445 ``rsvd18``
10446 Reserved
10447
10448 ``sopt``
10449 Source Options
10450
10451 ``rsvd24``
10452 Reserved
10453
10454 ``elbt``
10455 Expected Initial Logical Block Reference Tag /
10456 Expected Logical Block Storage Tag
10457
10458 ``elbat``
10459 Expected Logical Block Application Tag
10460
10461 ``elbatm``
10462 Expected Logical Block Application Tag Mask
10463
10464
10465
10466
10467
10468 .. c:type:: struct nvme_registered_ctrl
10469
10470 Registered Controller Data Structure
10471
10472 **Definition**
10473
10474 ::
10475
10476 struct nvme_registered_ctrl {
10477 __le16 cntlid;
10478 __u8 rcsts;
10479 __u8 rsvd3[5];
10480 __le64 hostid;
10481 __le64 rkey;
10482 };
10483
10484 **Members**
10485
10486 ``cntlid``
10487 Controller ID
10488
10489 ``rcsts``
10490 Reservation Status
10491
10492 ``rsvd3``
10493 Reserved
10494
10495 ``hostid``
10496 Host Identifier
10497
10498 ``rkey``
10499 Reservation Key
10500
10501
10502
10503
10504
10505 .. c:type:: struct nvme_registered_ctrl_ext
10506
10507 Registered Controller Extended Data Structure
10508
10509 **Definition**
10510
10511 ::
10512
10513 struct nvme_registered_ctrl_ext {
10514 __le16 cntlid;
10515 __u8 rcsts;
10516 __u8 rsvd3[5];
10517 __le64 rkey;
10518 __u8 hostid[16];
10519 __u8 rsvd32[32];
10520 };
10521
10522 **Members**
10523
10524 ``cntlid``
10525 Controller ID
10526
10527 ``rcsts``
10528 Reservation Status
10529
10530 ``rsvd3``
10531 Reserved
10532
10533 ``rkey``
10534 Reservation Key
10535
10536 ``hostid``
10537 Host Identifier
10538
10539 ``rsvd32``
10540 Reserved
10541
10542
10543
10544
10545
10546 .. c:type:: struct nvme_resv_status
10547
10548 Reservation Status Data Structure
10549
10550 **Definition**
10551
10552 ::
10553
10554 struct nvme_resv_status {
10555 __le32 gen;
10556 __u8 rtype;
10557 __u8 regctl[2];
10558 __u8 rsvd7[2];
10559 __u8 ptpls;
10560 __u8 rsvd10[14];
10561 union {
10562 struct {
10563 __u8 rsvd24[40];
10564 struct nvme_registered_ctrl_ext regctl_eds[0];
10565 };
10566 struct nvme_registered_ctrl regctl_ds[0];
10567 };
10568 };
10569
10570 **Members**
10571
10572 ``gen``
10573 Generation
10574
10575 ``rtype``
10576 Reservation Type
10577
10578 ``regctl``
10579 Number of Registered Controllers
10580
10581 ``rsvd7``
10582 Reserved
10583
10584 ``ptpls``
10585 Persist Through Power Loss State
10586
10587 ``rsvd10``
10588 Reserved
10589
10590 ``{unnamed_union}``
10591 anonymous
10592
10593 ``{unnamed_struct}``
10594 anonymous
10595
10596 ``rsvd24``
10597 Reserved
10598
10599 ``regctl_eds``
10600 Registered Controller Extended Data Structure
10601
10602 ``regctl_ds``
10603 Registered Controller Data Structure
10604
10605
10606
10607
10608
10609 .. c:type:: struct nvme_streams_directive_params
10610
10611 Streams Directive - Return Parameters Data Structure
10612
10613 **Definition**
10614
10615 ::
10616
10617 struct nvme_streams_directive_params {
10618 __le16 msl;
10619 __le16 nssa;
10620 __le16 nsso;
10621 __u8 nssc;
10622 __u8 rsvd[9];
10623 __le32 sws;
10624 __le16 sgs;
10625 __le16 nsa;
10626 __le16 nso;
10627 __u8 rsvd2[6];
10628 };
10629
10630 **Members**
10631
10632 ``msl``
10633 Max Streams Limit
10634
10635 ``nssa``
10636 NVM Subsystem Streams Available
10637
10638 ``nsso``
10639 NVM Subsystem Streams Open
10640
10641 ``nssc``
10642 NVM Subsystem Stream Capability
10643
10644 ``rsvd``
10645 Reserved
10646
10647 ``sws``
10648 Stream Write Size
10649
10650 ``sgs``
10651 Stream Granularity Size
10652
10653 ``nsa``
10654 Namespace Streams Allocated
10655
10656 ``nso``
10657 Namespace Streams Open
10658
10659 ``rsvd2``
10660 Reserved
10661
10662
10663
10664
10665
10666 .. c:type:: struct nvme_streams_directive_status
10667
10668 Streams Directive - Get Status Data Structure
10669
10670 **Definition**
10671
10672 ::
10673
10674 struct nvme_streams_directive_status {
10675 __le16 osc;
10676 __le16 sid[];
10677 };
10678
10679 **Members**
10680
10681 ``osc``
10682 Open Stream Count
10683
10684 ``sid``
10685 Stream Identifier
10686
10687
10688
10689
10690
10691 .. c:type:: struct nvme_id_directives
10692
10693 Identify Directive - Return Parameters Data Structure
10694
10695 **Definition**
10696
10697 ::
10698
10699 struct nvme_id_directives {
10700 __u8 supported[32];
10701 __u8 enabled[32];
10702 __u8 rsvd64[4032];
10703 };
10704
10705 **Members**
10706
10707 ``supported``
10708 Identify directive is supported
10709
10710 ``enabled``
10711 Identify directive is Enabled
10712
10713 ``rsvd64``
10714 Reserved
10715
10716
10717
10718
10719
10720 .. c:type:: enum nvme_directive_types
10721
10722 Directives Supported or Enabled
10723
10724 **Constants**
10725
10726 ``NVME_ID_DIR_ID_BIT``
10727 Identify directive is supported
10728
10729 ``NVME_ID_DIR_SD_BIT``
10730 Streams directive is supported
10731
10732 ``NVME_ID_DIR_DP_BIT``
10733 Direct Placement directive is supported
10734
10735
10736
10737
10738 .. c:type:: struct nvme_host_mem_buf_attrs
10739
10740 Host Memory Buffer - Attributes Data Structure
10741
10742 **Definition**
10743
10744 ::
10745
10746 struct nvme_host_mem_buf_attrs {
10747 __le32 hsize;
10748 __le32 hmdlal;
10749 __le32 hmdlau;
10750 __le32 hmdlec;
10751 __u8 rsvd16[4080];
10752 };
10753
10754 **Members**
10755
10756 ``hsize``
10757 Host Memory Buffer Size
10758
10759 ``hmdlal``
10760 Host Memory Descriptor List Lower Address
10761
10762 ``hmdlau``
10763 Host Memory Descriptor List Upper Address
10764
10765 ``hmdlec``
10766 Host Memory Descriptor List Entry Count
10767
10768 ``rsvd16``
10769 Reserved
10770
10771
10772
10773
10774
10775 .. c:type:: enum nvme_ae_type
10776
10777 Asynchronous Event Type
10778
10779 **Constants**
10780
10781 ``NVME_AER_ERROR``
10782 Error event
10783
10784 ``NVME_AER_SMART``
10785 SMART / Health Status event
10786
10787 ``NVME_AER_NOTICE``
10788 Notice event
10789
10790 ``NVME_AER_IMMEDIATE``
10791 Immediate
10792
10793 ``NVME_AER_ONESHOT``
10794 One-Shot
10795
10796 ``NVME_AER_CSS``
10797 NVM Command Set Specific events
10798
10799 ``NVME_AER_VS``
10800 Vendor Specific event
10801
10802
10803
10804
10805 .. c:type:: enum nvme_ae_info_error
10806
10807 Asynchronous Event Information - Error Status
10808
10809 **Constants**
10810
10811 ``NVME_AER_ERROR_INVALID_DB_REG``
10812 Write to Invalid Doorbell Register
10813
10814 ``NVME_AER_ERROR_INVALID_DB_VAL``
10815 Invalid Doorbell Write Value
10816
10817 ``NVME_AER_ERROR_DIAG_FAILURE``
10818 Diagnostic Failure
10819
10820 ``NVME_AER_ERROR_PERSISTENT_INTERNAL_ERROR``
10821 Persistent Internal Error
10822
10823 ``NVME_AER_ERROR_TRANSIENT_INTERNAL_ERROR``
10824 Transient Internal Error
10825
10826 ``NVME_AER_ERROR_FW_IMAGE_LOAD_ERROR``
10827 Firmware Image Load Error
10828
10829
10830
10831
10832 .. c:type:: enum nvme_ae_info_smart
10833
10834 Asynchronous Event Information - SMART / Health Status
10835
10836 **Constants**
10837
10838 ``NVME_AER_SMART_SUBSYSTEM_RELIABILITY``
10839 NVM subsystem Reliability
10840
10841 ``NVME_AER_SMART_TEMPERATURE_THRESHOLD``
10842 Temperature Threshold
10843
10844 ``NVME_AER_SMART_SPARE_THRESHOLD``
10845 Spare Below Threshold
10846
10847
10848
10849
10850 .. c:type:: enum nvme_ae_info_css_nvm
10851
10852 Asynchronous Event Information - I/O Command Specific Status
10853
10854 **Constants**
10855
10856 ``NVME_AER_CSS_NVM_RESERVATION``
10857 Reservation Log Page Available
10858
10859 ``NVME_AER_CSS_NVM_SANITIZE_COMPLETED``
10860 Sanitize Operation Completed
10861
10862 ``NVME_AER_CSS_NVM_UNEXPECTED_SANITIZE_DEALLOC``
10863 Sanitize Operation Completed
10864 With Unexpected Deallocation
10865
10866
10867
10868
10869 .. c:type:: enum nvme_ae_info_notice
10870
10871 Asynchronous Event Information - Notice
10872
10873 **Constants**
10874
10875 ``NVME_AER_NOTICE_NS_CHANGED``
10876 Namespace Attribute Changed
10877
10878 ``NVME_AER_NOTICE_FW_ACT_STARTING``
10879 Firmware Activation Starting
10880
10881 ``NVME_AER_NOTICE_TELEMETRY``
10882 Telemetry Log Changed
10883
10884 ``NVME_AER_NOTICE_ANA``
10885 Asymmetric Namespace Access Change
10886
10887 ``NVME_AER_NOTICE_PL_EVENT``
10888 Predictable Latency Event Aggregate Log Change
10889
10890 ``NVME_AER_NOTICE_LBA_STATUS_ALERT``
10891 LBA Status Information Alert
10892
10893 ``NVME_AER_NOTICE_EG_EVENT``
10894 Endurance Group Event Aggregate Log Page Change
10895
10896 ``NVME_AER_NOTICE_DISC_CHANGED``
10897 Discovery Log Page Change
10898
10899
10900
10901
10902 .. c:type:: enum nvme_subsys_type
10903
10904 Type of the NVM subsystem.
10905
10906 **Constants**
10907
10908 ``NVME_NQN_DISC``
10909 Discovery type target subsystem. Describes a referral to another
10910 Discovery Service composed of Discovery controllers that provide
10911 additional discovery records. Multiple Referral entries may
10912 be reported for each Discovery Service (if that Discovery Service
10913 has multiple NVM subsystem ports or supports multiple protocols).
10914
10915 ``NVME_NQN_NVME``
10916 NVME type target subsystem. Describes an NVM subsystem whose
10917 controllers may have attached namespaces (an NVM subsystem
10918 that is not composed of Discovery controllers). Multiple NVM
10919 Subsystem entries may be reported for each NVM subsystem if
10920 that NVM subsystem has multiple NVM subsystem ports.
10921
10922 ``NVME_NQN_CURR``
10923 Current Discovery type target subsystem. Describes this Discovery
10924 subsystem (the Discovery Service that contains the controller
10925 processing the Get Log Page command). Multiple Current Discovery
10926 Subsystem entries may be reported for this Discovery subsystem
10927 if the current Discovery subsystem has multiple NVM subsystem
10928 ports.
10929
10930
10931
10932
10933 .. c:type:: enum nvmf_disc_eflags
10934
10935 Discovery Log Page entry flags.
10936
10937 **Constants**
10938
10939 ``NVMF_DISC_EFLAGS_NONE``
10940 Indicates that none of the DUPRETINFO or EPCSD
10941 features are supported.
10942
10943 ``NVMF_DISC_EFLAGS_DUPRETINFO``
10944 Duplicate Returned Information (DUPRETINFO):
10945 Indicates that using the content of this entry
10946 to access this Discovery Service returns the same
10947 information that is returned by using the content
10948 of other entries in this log page that also have
10949 this flag set.
10950
10951 ``NVMF_DISC_EFLAGS_EPCSD``
10952 Explicit Persistent Connection Support for Discovery (EPCSD):
10953 Indicates that Explicit Persistent Connections are
10954 supported for the Discovery controller.
10955
10956 ``NVMF_DISC_EFLAGS_NCC``
10957 No CDC Connectivity (NCC): If set to
10958 '1', then no DDC that describes this entry
10959 is currently connected to the CDC. If
10960 cleared to '0', then at least one DDC that
10961 describes this entry is currently
10962 connected to the CDC. If the Discovery
10963 controller returning this log page is not
10964 a CDC, then this bit shall be cleared to
10965 '0' and should be ignored by the host.
10966
10967
10968
10969
10970 .. c:type:: union nvmf_tsas
10971
10972 Transport Specific Address Subtype
10973
10974 **Definition**
10975
10976 ::
10977
10978 union nvmf_tsas {
10979 char common[NVMF_TSAS_SIZE];
10980 struct rdma {
10981 __u8 qptype;
10982 __u8 prtype;
10983 __u8 cms;
10984 __u8 rsvd3[5];
10985 __le16 pkey;
10986 __u8 rsvd10[246];
10987 } rdma;
10988 struct tcp {
10989 __u8 sectype;
10990 } tcp;
10991 };
10992
10993 **Members**
10994
10995 ``common``
10996 Common transport specific attributes
10997
10998 ``rdma``
10999 RDMA transport specific attribute settings
11000
11001 ``tcp``
11002 TCP transport specific attribute settings
11003
11004
11005
11006
11007
11008 .. c:type:: struct nvmf_disc_log_entry
11009
11010 Discovery Log Page entry
11011
11012 **Definition**
11013
11014 ::
11015
11016 struct nvmf_disc_log_entry {
11017 __u8 trtype;
11018 __u8 adrfam;
11019 __u8 subtype;
11020 __u8 treq;
11021 __le16 portid;
11022 __le16 cntlid;
11023 __le16 asqsz;
11024 __le16 eflags;
11025 __u8 rsvd12[20];
11026 char trsvcid[NVMF_TRSVCID_SIZE];
11027 __u8 rsvd64[192];
11028 char subnqn[NVME_NQN_LENGTH];
11029 char traddr[NVMF_TRADDR_SIZE];
11030 union nvmf_tsas tsas;
11031 };
11032
11033 **Members**
11034
11035 ``trtype``
11036 Transport Type (TRTYPE): Specifies the NVMe Transport type.
11037 See :c:type:`enum nvmf_trtype <nvmf_trtype>`.
11038
11039 ``adrfam``
11040 Address Family (ADRFAM): Specifies the address family.
11041 See :c:type:`enum nvmf_addr_family <nvmf_addr_family>`.
11042
11043 ``subtype``
11044 Subsystem Type (SUBTYPE): Specifies the type of the NVM subsystem
11045 that is indicated in this entry. See :c:type:`enum nvme_subsys_type <nvme_subsys_type>`.
11046
11047 ``treq``
11048 Transport Requirements (TREQ): Indicates requirements for the NVMe
11049 Transport. See :c:type:`enum nvmf_treq <nvmf_treq>`.
11050
11051 ``portid``
11052 Port ID (PORTID): Specifies a particular NVM subsystem port.
11053 Different NVMe Transports or address families may utilize the same
11054 Port ID value (e.g. a Port ID may support both iWARP and RoCE).
11055
11056 ``cntlid``
11057 Controller ID (CNTLID): Specifies the controller ID. If the NVM
11058 subsystem uses a dynamic controller model, then this field shall
11059 be set to FFFFh. If the NVM subsystem uses a static controller model,
11060 then this field may be set to a specific controller ID (values 0h
11061 to FFEFh are valid). If the NVM subsystem uses a static controller
11062 model and the value indicated is FFFEh, then the host should remember
11063 the Controller ID returned as part of the Fabrics Connect command
11064 in order to re-establish an association in the future with the same
11065 controller.
11066
11067 ``asqsz``
11068 Admin Max SQ Size (ASQSZ): Specifies the maximum size of an Admin
11069 Submission Queue. This applies to all controllers in the NVM
11070 subsystem. The value shall be a minimum of 32 entries.
11071
11072 ``eflags``
11073 Entry Flags (EFLAGS): Indicates additional information related to
11074 the current entry. See :c:type:`enum nvmf_disc_eflags <nvmf_disc_eflags>`.
11075
11076 ``rsvd12``
11077 Reserved
11078
11079 ``trsvcid``
11080 Transport Service Identifier (TRSVCID): Specifies the NVMe Transport
11081 service identifier as an ASCII string. The NVMe Transport service
11082 identifier is specified by the associated NVMe Transport binding
11083 specification.
11084
11085 ``rsvd64``
11086 Reserved
11087
11088 ``subnqn``
11089 NVM Subsystem Qualified Name (SUBNQN): NVMe Qualified Name (NQN)
11090 that uniquely identifies the NVM subsystem. For a subsystem, if that
11091 Discovery subsystem has a unique NQN (i.e., the NVM Subsystem NVMe
11092 Qualified Name (SUBNQN) field in that Discovery subsystem's Identify
11093 Controller data structure contains a unique NQN value), then the
11094 value returned shall be that unique NQN. If the Discovery subsystem
11095 does not have a unique NQN, then the value returned shall be the
11096 well-known Discovery Service NQN (nqn.2014-08.org.nvmexpress.discovery).
11097
11098 ``traddr``
11099 Transport Address (TRADDR): Specifies the address of the NVM subsystem
11100 that may be used for a Connect command as an ASCII string. The
11101 Address Family field describes the reference for parsing this field.
11102
11103 ``tsas``
11104 Transport specific attribute settings
11105
11106
11107
11108
11109
11110 .. c:type:: enum nvmf_trtype
11111
11112 Transport Type codes for Discovery Log Page entry TRTYPE field
11113
11114 **Constants**
11115
11116 ``NVMF_TRTYPE_UNSPECIFIED``
11117 Not indicated
11118
11119 ``NVMF_TRTYPE_RDMA``
11120 RDMA
11121
11122 ``NVMF_TRTYPE_FC``
11123 Fibre Channel
11124
11125 ``NVMF_TRTYPE_TCP``
11126 TCP
11127
11128 ``NVMF_TRTYPE_LOOP``
11129 Intra-host Transport (i.e., loopback), reserved
11130 for host usage.
11131
11132 ``NVMF_TRTYPE_MAX``
11133 Maximum value for :c:type:`enum nvmf_trtype <nvmf_trtype>`
11134
11135
11136
11137
11138 .. c:type:: enum nvmf_addr_family
11139
11140 Address Family codes for Discovery Log Page entry ADRFAM field
11141
11142 **Constants**
11143
11144 ``NVMF_ADDR_FAMILY_PCI``
11145 PCIe
11146
11147 ``NVMF_ADDR_FAMILY_IP4``
11148 AF_INET: IPv4 address family.
11149
11150 ``NVMF_ADDR_FAMILY_IP6``
11151 AF_INET6: IPv6 address family.
11152
11153 ``NVMF_ADDR_FAMILY_IB``
11154 AF_IB: InfiniBand address family.
11155
11156 ``NVMF_ADDR_FAMILY_FC``
11157 Fibre Channel address family.
11158
11159 ``NVMF_ADDR_FAMILY_LOOP``
11160 Intra-host Transport (i.e., loopback), reserved
11161 for host usage.
11162
11163
11164
11165
11166 .. c:type:: enum nvmf_treq
11167
11168 Transport Requirements codes for Discovery Log Page entry TREQ field
11169
11170 **Constants**
11171
11172 ``NVMF_TREQ_NOT_SPECIFIED``
11173 Not specified
11174
11175 ``NVMF_TREQ_REQUIRED``
11176 Required
11177
11178 ``NVMF_TREQ_NOT_REQUIRED``
11179 Not Required
11180
11181 ``NVMF_TREQ_DISABLE_SQFLOW``
11182 SQ flow control disable supported
11183
11184
11185
11186
11187 .. c:type:: enum nvmf_rdma_qptype
11188
11189 RDMA QP Service Type codes for Discovery Log Page entry TSAS RDMA_QPTYPE field
11190
11191 **Constants**
11192
11193 ``NVMF_RDMA_QPTYPE_CONNECTED``
11194 Reliable Connected
11195
11196 ``NVMF_RDMA_QPTYPE_DATAGRAM``
11197 Reliable Datagram
11198
11199
11200
11201
11202 .. c:type:: enum nvmf_rdma_prtype
11203
11204 RDMA Provider Type codes for Discovery Log Page entry TSAS RDMA_PRTYPE field
11205
11206 **Constants**
11207
11208 ``NVMF_RDMA_PRTYPE_NOT_SPECIFIED``
11209 No Provider Specified
11210
11211 ``NVMF_RDMA_PRTYPE_IB``
11212 InfiniBand
11213
11214 ``NVMF_RDMA_PRTYPE_ROCE``
11215 InfiniBand RoCE
11216
11217 ``NVMF_RDMA_PRTYPE_ROCEV2``
11218 InfiniBand RoCEV2
11219
11220 ``NVMF_RDMA_PRTYPE_IWARP``
11221 iWARP
11222
11223
11224
11225
11226 .. c:type:: enum nvmf_rdma_cms
11227
11228 RDMA Connection Management Service Type codes for Discovery Log Page entry TSAS RDMA_CMS field
11229
11230 **Constants**
11231
11232 ``NVMF_RDMA_CMS_RDMA_CM``
11233 Sockets based endpoint addressing
11234
11235
11236
11237
11238 .. c:type:: enum nvmf_tcp_sectype
11239
11240 Transport Specific Address Subtype Definition for NVMe/TCP Transport
11241
11242 **Constants**
11243
11244 ``NVMF_TCP_SECTYPE_NONE``
11245 No Security
11246
11247 ``NVMF_TCP_SECTYPE_TLS``
11248 Transport Layer Security version 1.2
11249
11250 ``NVMF_TCP_SECTYPE_TLS13``
11251 Transport Layer Security version 1.3 or a subsequent
11252 version. The TLS protocol negotiates the version and
11253 cipher suite for each TCP connection.
11254
11255
11256
11257
11258 .. c:type:: enum nvmf_log_discovery_lid_support
11259
11260 Discovery log specific support
11261
11262 **Constants**
11263
11264 ``NVMF_LOG_DISC_LID_NONE``
11265 None
11266
11267 ``NVMF_LOG_DISC_LID_EXTDLPES``
11268 Extended Discovery Log Page Entries Supported
11269
11270 ``NVMF_LOG_DISC_LID_PLEOS``
11271 Port Local Entries Only Supported
11272
11273 ``NVMF_LOG_DISC_LID_ALLSUBES``
11274 All NVM Subsystem Entries Supported
11275
11276
11277
11278
11279 .. c:type:: enum nvmf_log_discovery_lsp
11280
11281 Discovery log specific field
11282
11283 **Constants**
11284
11285 ``NVMF_LOG_DISC_LSP_NONE``
11286 None
11287
11288 ``NVMF_LOG_DISC_LSP_EXTDLPE``
11289 Extended Discovery Log Page Entries
11290
11291 ``NVMF_LOG_DISC_LSP_PLEO``
11292 Port Local Entries Only
11293
11294 ``NVMF_LOG_DISC_LSP_ALLSUBE``
11295 All NVM Subsystem Entries
11296
11297
11298
11299
11300 .. c:type:: struct nvmf_discovery_log
11301
11302 Discovery Log Page (Log Identifier 70h)
11303
11304 **Definition**
11305
11306 ::
11307
11308 struct nvmf_discovery_log {
11309 __le64 genctr;
11310 __le64 numrec;
11311 __le16 recfmt;
11312 __u8 rsvd14[1006];
11313 struct nvmf_disc_log_entry entries[];
11314 };
11315
11316 **Members**
11317
11318 ``genctr``
11319 Generation Counter (GENCTR): Indicates the version of the discovery
11320 information, starting at a value of 0h. For each change in the
11321 Discovery Log Page, this counter is incremented by one. If the value
11322 of this field is FFFFFFFF_FFFFFFFFh, then the field shall be cleared
11323 to 0h when incremented (i.e., rolls over to 0h).
11324
11325 ``numrec``
11326 Number of Records (NUMREC): Indicates the number of records
11327 contained in the log.
11328
11329 ``recfmt``
11330 Record Format (RECFMT): Specifies the format of the Discovery Log
11331 Page. If a new format is defined, this value is incremented by one.
11332 The format of the record specified in this definition shall be 0h.
11333
11334 ``rsvd14``
11335 Reserved
11336
11337 ``entries``
11338 Discovery Log Page Entries - see :c:type:`struct nvmf_disc_log_entry <nvmf_disc_log_entry>`.
11339
11340
11341
11342
11343
11344 .. c:type:: enum nvmf_dim_tas
11345
11346 Discovery Information Management Task
11347
11348 **Constants**
11349
11350 ``NVMF_DIM_TAS_REGISTER``
11351 Register
11352
11353 ``NVMF_DIM_TAS_DEREGISTER``
11354 Deregister
11355
11356 ``NVMF_DIM_TAS_UPDATE``
11357 Update
11358
11359
11360
11361
11362 .. c:type:: enum nvmf_dim_entfmt
11363
11364 Discovery Information Management Entry Format
11365
11366 **Constants**
11367
11368 ``NVMF_DIM_ENTFMT_BASIC``
11369 Basic discovery information entry
11370
11371 ``NVMF_DIM_ENTFMT_EXTENDED``
11372 Extended discovery information entry
11373
11374
11375
11376
11377 .. c:type:: enum nvmf_dim_etype
11378
11379 Discovery Information Management Entity Type
11380
11381 **Constants**
11382
11383 ``NVMF_DIM_ETYPE_HOST``
11384 Host
11385
11386 ``NVMF_DIM_ETYPE_DDC``
11387 Direct Discovery controller
11388
11389 ``NVMF_DIM_ETYPE_CDC``
11390 Centralized Discovery controller
11391
11392
11393
11394
11395 .. c:type:: enum nvmf_exattype
11396
11397 Extended Attribute Type
11398
11399 **Constants**
11400
11401 ``NVMF_EXATTYPE_HOSTID``
11402 Host Identifier
11403
11404 ``NVMF_EXATTYPE_SYMNAME``
11405 Symblic Name
11406
11407
11408
11409
11410 .. c:type:: struct nvmf_ext_attr
11411
11412 Extended Attribute (EXAT)
11413
11414 **Definition**
11415
11416 ::
11417
11418 struct nvmf_ext_attr {
11419 __le16 exattype;
11420 __le16 exatlen;
11421 __u8 exatval[];
11422 };
11423
11424 **Members**
11425
11426 ``exattype``
11427 Extended Attribute Type (EXATTYPE) - see **enum** nvmf_exattype
11428
11429 ``exatlen``
11430 Extended Attribute Length (EXATLEN)
11431
11432 ``exatval``
11433 Extended Attribute Value (EXATVAL) - size allocated for array
11434 must be a multiple of 4 bytes
11435
11436
11437
11438
11439
11440 .. c:type:: struct nvmf_ext_die
11441
11442 Extended Discovery Information Entry (DIE)
11443
11444 **Definition**
11445
11446 ::
11447
11448 struct nvmf_ext_die {
11449 __u8 trtype;
11450 __u8 adrfam;
11451 __u8 subtype;
11452 __u8 treq;
11453 __le16 portid;
11454 __le16 cntlid;
11455 __le16 asqsz;
11456 __u8 rsvd10[22];
11457 char trsvcid[NVMF_TRSVCID_SIZE];
11458 __u8 resv64[192];
11459 char nqn[NVME_NQN_LENGTH];
11460 char traddr[NVMF_TRADDR_SIZE];
11461 union nvmf_tsas tsas;
11462 __le32 tel;
11463 __le16 numexat;
11464 __u8 resv1030[2];
11465 struct nvmf_ext_attr exat[];
11466 };
11467
11468 **Members**
11469
11470 ``trtype``
11471 Transport Type (:c:type:`enum nvmf_trtype <nvmf_trtype>`)
11472
11473 ``adrfam``
11474 Address Family (:c:type:`enum nvmf_addr_family <nvmf_addr_family>`)
11475
11476 ``subtype``
11477 Subsystem Type (:c:type:`enum nvme_subsys_type <nvme_subsys_type>`)
11478
11479 ``treq``
11480 Transport Requirements (:c:type:`enum nvmf_treq <nvmf_treq>`)
11481
11482 ``portid``
11483 Port ID
11484
11485 ``cntlid``
11486 Controller ID
11487
11488 ``asqsz``
11489 Admin Max SQ Size
11490
11491 ``rsvd10``
11492 Reserved
11493
11494 ``trsvcid``
11495 Transport Service Identifier
11496
11497 ``resv64``
11498 Reserved
11499
11500 ``nqn``
11501 NVM Qualified Name
11502
11503 ``traddr``
11504 Transport Address
11505
11506 ``tsas``
11507 Transport Specific Address Subtype (:c:type:`union nvmf_tsas <nvmf_tsas>`)
11508
11509 ``tel``
11510 Total Entry Length
11511
11512 ``numexat``
11513 Number of Extended Attributes
11514
11515 ``resv1030``
11516 Reserved
11517
11518 ``exat``
11519 Extended Attributes 0 (:c:type:`struct nvmf_ext_attr <nvmf_ext_attr>`)
11520
11521
11522
11523
11524
11525 .. c:type:: union nvmf_die
11526
11527 Discovery Information Entry (DIE)
11528
11529 **Definition**
11530
11531 ::
11532
11533 union nvmf_die {
11534 struct nvmf_disc_log_entry basic[0];
11535 struct nvmf_ext_die extended;
11536 };
11537
11538 **Members**
11539
11540 ``basic``
11541 Basic format (:c:type:`struct nvmf_disc_log_entry <nvmf_disc_log_entry>`)
11542
11543 ``extended``
11544 Extended format (:c:type:`struct nvmf_ext_die <nvmf_ext_die>`)
11545
11546
11547 **Description**
11548
11549 Depending on the ENTFMT specified in the DIM, DIEs can be entered
11550 with the Basic or Extended formats. For Basic format, each entry
11551 has a fixed length. Therefore, the "basic" field defined below can
11552 be accessed as a C array. For the Extended format, however, each
11553 entry is of variable length (TEL). Therefore, the "extended" field
11554 defined below cannot be accessed as a C array. Instead, the
11555 "extended" field is akin to a linked-list, where one can "walk"
11556 through the list. To move to the next entry, one simply adds the
11557 current entry's length (TEL) to the "walk" pointer. The number of
11558 entries in the list is specified by NUMENT. Although extended
11559 entries are of a variable lengths (TEL), TEL is always a multiple of
11560 4 bytes.
11561
11562
11563
11564
11565 .. c:type:: struct nvmf_dim_data
11566
11567 Discovery Information Management (DIM) - Data
11568
11569 **Definition**
11570
11571 ::
11572
11573 struct nvmf_dim_data {
11574 __le32 tdl;
11575 __u8 rsvd4[4];
11576 __le64 nument;
11577 __le16 entfmt;
11578 __le16 etype;
11579 __u8 portlcl;
11580 __u8 rsvd21;
11581 __le16 ektype;
11582 char eid[NVME_NQN_LENGTH];
11583 char ename[NVMF_ENAME_LEN];
11584 char ever[NVMF_EVER_LEN];
11585 __u8 rsvd600[424];
11586 union nvmf_die die[];
11587 };
11588
11589 **Members**
11590
11591 ``tdl``
11592 Total Data Length
11593
11594 ``rsvd4``
11595 Reserved
11596
11597 ``nument``
11598 Number of entries
11599
11600 ``entfmt``
11601 Entry Format (:c:type:`enum nvmf_dim_entfmt <nvmf_dim_entfmt>`)
11602
11603 ``etype``
11604 Entity Type (:c:type:`enum nvmf_dim_etype <nvmf_dim_etype>`)
11605
11606 ``portlcl``
11607 Port Local
11608
11609 ``rsvd21``
11610 Reserved
11611
11612 ``ektype``
11613 Entry Key Type
11614
11615 ``eid``
11616 Entity Identifier (e.g. Host NQN)
11617
11618 ``ename``
11619 Entity Name (e.g. hostname)
11620
11621 ``ever``
11622 Entity Version (e.g. OS Name/Version)
11623
11624 ``rsvd600``
11625 Reserved
11626
11627 ``die``
11628 Discovery Information Entry (see **nument** above)
11629
11630
11631
11632
11633
11634 .. c:type:: struct nvmf_connect_data
11635
11636 Data payload for the 'connect' command
11637
11638 **Definition**
11639
11640 ::
11641
11642 struct nvmf_connect_data {
11643 __u8 hostid[16];
11644 __le16 cntlid;
11645 char rsvd4[238];
11646 char subsysnqn[NVME_NQN_LENGTH];
11647 char hostnqn[NVME_NQN_LENGTH];
11648 char rsvd5[256];
11649 };
11650
11651 **Members**
11652
11653 ``hostid``
11654 Host ID of the connecting host
11655
11656 ``cntlid``
11657 Requested controller ID
11658
11659 ``rsvd4``
11660 Reserved
11661
11662 ``subsysnqn``
11663 Subsystem NQN to connect to
11664
11665 ``hostnqn``
11666 Host NQN of the connecting host
11667
11668 ``rsvd5``
11669 Reserved
11670
11671
11672
11673
11674
11675 .. c:type:: struct nvme_host_ext_discover_log
11676
11677 Host Extended Discovery Log
11678
11679 **Definition**
11680
11681 ::
11682
11683 struct nvme_host_ext_discover_log {
11684 __u8 trtype;
11685 __u8 adrfam;
11686 __u8 rsvd2[8];
11687 __le16 eflags;
11688 __u8 rsvd12[244];
11689 char hostnqn[NVME_NQN_LENGTH];
11690 char traddr[NVMF_TRADDR_SIZE];
11691 union nvmf_tsas tsas;
11692 __le32 tel;
11693 __le16 numexat;
11694 __u8 rsvd1030[2];
11695 struct nvmf_ext_attr exat[];
11696 };
11697
11698 **Members**
11699
11700 ``trtype``
11701 Transport Type
11702
11703 ``adrfam``
11704 Address Family
11705
11706 ``rsvd2``
11707 Reserved
11708
11709 ``eflags``
11710 Entry Flags
11711
11712 ``rsvd12``
11713 Reserved
11714
11715 ``hostnqn``
11716 Host NVMe Qualified Name
11717
11718 ``traddr``
11719 Transport Address
11720
11721 ``tsas``
11722 Transport Specific Address Subtype
11723
11724 ``tel``
11725 Total Entry Length
11726
11727 ``numexat``
11728 Number of Extended Attributes
11729
11730 ``rsvd1030``
11731 Reserved
11732
11733 ``exat``
11734 Extended Attributes List
11735
11736
11737
11738
11739
11740 .. c:type:: struct nvme_host_discover_log
11741
11742 Host Discovery Log
11743
11744 **Definition**
11745
11746 ::
11747
11748 struct nvme_host_discover_log {
11749 __le64 genctr;
11750 __le64 numrec;
11751 __le16 recfmt;
11752 __u8 hdlpf;
11753 __u8 rsvd19;
11754 __le32 thdlpl;
11755 __u8 rsvd24[1000];
11756 struct nvme_host_ext_discover_log hedlpe[];
11757 };
11758
11759 **Members**
11760
11761 ``genctr``
11762 Generation Counter
11763
11764 ``numrec``
11765 Number of Records
11766
11767 ``recfmt``
11768 Record Format
11769
11770 ``hdlpf``
11771 Host Discovery Log Page Flags
11772
11773 ``rsvd19``
11774 Reserved
11775
11776 ``thdlpl``
11777 Total Host Discovery Log Page Length
11778
11779 ``rsvd24``
11780 Reserved
11781
11782 ``hedlpe``
11783 Host Extended Discovery Log Page Entry List
11784
11785
11786
11787
11788
11789 .. c:type:: struct nvme_ave_tr_record
11790
11791 AVE Transport Record
11792
11793 **Definition**
11794
11795 ::
11796
11797 struct nvme_ave_tr_record {
11798 __u8 aveadrfam;
11799 __u8 rsvd1;
11800 __le16 avetrsvcid;
11801 __u8 avetraddr[16];
11802 };
11803
11804 **Members**
11805
11806 ``aveadrfam``
11807 AVE Address Family
11808
11809 ``rsvd1``
11810 Reserved
11811
11812 ``avetrsvcid``
11813 AVE Transport Service Identifier
11814
11815 ``avetraddr``
11816 AVE Transport Address
11817
11818
11819
11820
11821
11822 .. c:type:: struct nvme_ave_discover_log_entry
11823
11824 AVE Discovery Log Entry
11825
11826 **Definition**
11827
11828 ::
11829
11830 struct nvme_ave_discover_log_entry {
11831 __le32 tel;
11832 char avenqn[224];
11833 __u8 numatr;
11834 __u8 rsvd229[3];
11835 struct nvme_ave_tr_record atr[];
11836 };
11837
11838 **Members**
11839
11840 ``tel``
11841 Total Entry Length
11842
11843 ``avenqn``
11844 AVE NQN
11845
11846 ``numatr``
11847 Number of AVE Transport Records
11848
11849 ``rsvd229``
11850 Reserved
11851
11852 ``atr``
11853 AVE Transport Record List
11854
11855
11856
11857
11858
11859 .. c:type:: struct nvme_ave_discover_log
11860
11861 AVE Discovery Log
11862
11863 **Definition**
11864
11865 ::
11866
11867 struct nvme_ave_discover_log {
11868 __le64 genctr;
11869 __le64 numrec;
11870 __le16 recfmt;
11871 __u8 rsvd18[2];
11872 __le32 tadlpl;
11873 __u8 rsvd24[1000];
11874 struct nvme_ave_discover_log_entry adlpe[];
11875 };
11876
11877 **Members**
11878
11879 ``genctr``
11880 Generation Counter
11881
11882 ``numrec``
11883 Number of Records
11884
11885 ``recfmt``
11886 Record Format
11887
11888 ``rsvd18``
11889 Reserved
11890
11891 ``tadlpl``
11892 Total AVE Discovery Log Page Length
11893
11894 ``rsvd24``
11895 Reserved
11896
11897 ``adlpe``
11898 AVE Discovery Log Page Entry List
11899
11900
11901
11902
11903
11904 .. c:type:: struct nvme_pull_model_ddc_req_log
11905
11906 Pull Model DDC Request Log
11907
11908 **Definition**
11909
11910 ::
11911
11912 struct nvme_pull_model_ddc_req_log {
11913 __u8 ori;
11914 __u8 rsvd1[3];
11915 __le32 tpdrpl;
11916 __u8 osp[];
11917 };
11918
11919 **Members**
11920
11921 ``ori``
11922 Operation Request Identifier
11923
11924 ``rsvd1``
11925 Reserved
11926
11927 ``tpdrpl``
11928 Total Pull Model DDC Request Log Page Length
11929
11930 ``osp``
11931 Operation Specific Parameters
11932
11933
11934
11935
11936
11937 .. c:type:: struct nvme_mi_read_nvm_ss_info
11938
11939 NVM Subsystem Information Data Structure
11940
11941 **Definition**
11942
11943 ::
11944
11945 struct nvme_mi_read_nvm_ss_info {
11946 __u8 nump;
11947 __u8 mjr;
11948 __u8 mnr;
11949 __u8 rsvd3[29];
11950 };
11951
11952 **Members**
11953
11954 ``nump``
11955 Number of Ports
11956
11957 ``mjr``
11958 NVMe-MI Major Version Number
11959
11960 ``mnr``
11961 NVMe-MI Minor Version Number
11962
11963 ``rsvd3``
11964 Reserved
11965
11966
11967
11968
11969
11970 .. c:type:: struct nvme_mi_port_pcie
11971
11972 PCIe Port Specific Data
11973
11974 **Definition**
11975
11976 ::
11977
11978 struct nvme_mi_port_pcie {
11979 __u8 mps;
11980 __u8 sls;
11981 __u8 cls;
11982 __u8 mlw;
11983 __u8 nlw;
11984 __u8 pn;
11985 __u8 rsvd14[18];
11986 };
11987
11988 **Members**
11989
11990 ``mps``
11991 PCIe Maximum Payload Size
11992
11993 ``sls``
11994 PCIe Supported Link Speeds Vector
11995
11996 ``cls``
11997 PCIe Current Link Speed
11998
11999 ``mlw``
12000 PCIe Maximum Link Width
12001
12002 ``nlw``
12003 PCIe Negotiated Link Width
12004
12005 ``pn``
12006 PCIe Port Number
12007
12008 ``rsvd14``
12009 Reserved
12010
12011
12012
12013
12014
12015 .. c:type:: struct nvme_mi_port_smb
12016
12017 SMBus Port Specific Data
12018
12019 **Definition**
12020
12021 ::
12022
12023 struct nvme_mi_port_smb {
12024 __u8 vpd_addr;
12025 __u8 mvpd_freq;
12026 __u8 mme_addr;
12027 __u8 mme_freq;
12028 __u8 nvmebm;
12029 __u8 rsvd13[19];
12030 };
12031
12032 **Members**
12033
12034 ``vpd_addr``
12035 Current VPD SMBus/I2C Address
12036
12037 ``mvpd_freq``
12038 Maximum VPD Access SMBus/I2C Frequency
12039
12040 ``mme_addr``
12041 Current Management Endpoint SMBus/I2C Address
12042
12043 ``mme_freq``
12044 Maximum Management Endpoint SMBus/I2C Frequency
12045
12046 ``nvmebm``
12047 NVMe Basic Management
12048
12049 ``rsvd13``
12050 Reserved
12051
12052
12053
12054
12055
12056 .. c:type:: struct nvme_mi_read_port_info
12057
12058 Port Information Data Structure
12059
12060 **Definition**
12061
12062 ::
12063
12064 struct nvme_mi_read_port_info {
12065 __u8 portt;
12066 __u8 rsvd1;
12067 __le16 mmctptus;
12068 __le32 meb;
12069 union {
12070 struct nvme_mi_port_pcie pcie;
12071 struct nvme_mi_port_smb smb;
12072 };
12073 };
12074
12075 **Members**
12076
12077 ``portt``
12078 Port Type
12079
12080 ``rsvd1``
12081 Reserved
12082
12083 ``mmctptus``
12084 Maximum MCTP Transmission Unit Size
12085
12086 ``meb``
12087 Management Endpoint Buffer Size
12088
12089 ``{unnamed_union}``
12090 anonymous
12091
12092 ``pcie``
12093 PCIe Port Specific Data
12094
12095 ``smb``
12096 SMBus Port Specific Data
12097
12098
12099
12100
12101
12102 .. c:type:: struct nvme_mi_read_ctrl_info
12103
12104 Controller Information Data Structure
12105
12106 **Definition**
12107
12108 ::
12109
12110 struct nvme_mi_read_ctrl_info {
12111 __u8 portid;
12112 __u8 rsvd1[4];
12113 __u8 prii;
12114 __le16 pri;
12115 __le16 vid;
12116 __le16 did;
12117 __le16 ssvid;
12118 __le16 ssid;
12119 __u8 rsvd16[16];
12120 };
12121
12122 **Members**
12123
12124 ``portid``
12125 Port Identifier
12126
12127 ``rsvd1``
12128 Reserved
12129
12130 ``prii``
12131 PCIe Routing ID Information
12132
12133 ``pri``
12134 PCIe Routing ID
12135
12136 ``vid``
12137 PCI Vendor ID
12138
12139 ``did``
12140 PCI Device ID
12141
12142 ``ssvid``
12143 PCI Subsystem Vendor ID
12144
12145 ``ssid``
12146 PCI Subsystem Device ID
12147
12148 ``rsvd16``
12149 Reserved
12150
12151
12152
12153
12154
12155 .. c:type:: struct nvme_mi_osc
12156
12157 Optionally Supported Command Data Structure
12158
12159 **Definition**
12160
12161 ::
12162
12163 struct nvme_mi_osc {
12164 __u8 type;
12165 __u8 opc;
12166 };
12167
12168 **Members**
12169
12170 ``type``
12171 Command Type
12172
12173 ``opc``
12174 Opcode
12175
12176
12177
12178
12179
12180 .. c:type:: struct nvme_mi_read_sc_list
12181
12182 Management Endpoint Buffer Supported Command List Data Structure
12183
12184 **Definition**
12185
12186 ::
12187
12188 struct nvme_mi_read_sc_list {
12189 __le16 numcmd;
12190 struct nvme_mi_osc cmds[];
12191 };
12192
12193 **Members**
12194
12195 ``numcmd``
12196 Number of Commands
12197
12198 ``cmds``
12199 MEB supported Command Data Structure.
12200 See **struct** nvme_mi_osc
12201
12202
12203
12204
12205
12206 .. c:type:: struct nvme_mi_nvm_ss_health_status
12207
12208 Subsystem Management Data Structure
12209
12210 **Definition**
12211
12212 ::
12213
12214 struct nvme_mi_nvm_ss_health_status {
12215 __u8 nss;
12216 __u8 sw;
12217 __u8 ctemp;
12218 __u8 pdlu;
12219 __le16 ccs;
12220 __u8 rsvd8[2];
12221 };
12222
12223 **Members**
12224
12225 ``nss``
12226 NVM Subsystem Status
12227
12228 ``sw``
12229 Smart Warnings
12230
12231 ``ctemp``
12232 Composite Temperature
12233
12234 ``pdlu``
12235 Percentage Drive Life Used
12236
12237 ``ccs``
12238 Composite Controller Status
12239
12240 ``rsvd8``
12241 Reserved
12242
12243
12244
12245
12246
12247 .. c:type:: enum nvme_mi_ccs
12248
12249 Get State Control Primitive Success Response Fields - Control Primitive Specific Response
12250
12251 **Constants**
12252
12253 ``NVME_MI_CCS_RDY``
12254 Ready
12255
12256 ``NVME_MI_CCS_CFS``
12257 Controller Fatal Status
12258
12259 ``NVME_MI_CCS_SHST``
12260 Shutdown Status
12261
12262 ``NVME_MI_CCS_NSSRO``
12263 NVM Subsystem Reset Occurred
12264
12265 ``NVME_MI_CCS_CECO``
12266 Controller Enable Change Occurred
12267
12268 ``NVME_MI_CCS_NAC``
12269 Namespace Attribute Changed
12270
12271 ``NVME_MI_CCS_FA``
12272 Firmware Activated
12273
12274 ``NVME_MI_CCS_CSTS``
12275 Controller Status Change
12276
12277 ``NVME_MI_CCS_CTEMP``
12278 Composite Temperature Change
12279
12280 ``NVME_MI_CCS_PDLU``
12281 Percentage Used
12282
12283 ``NVME_MI_CCS_SPARE``
12284 Available Spare
12285
12286 ``NVME_MI_CCS_CCWARN``
12287 Critical Warning
12288
12289
12290
12291
12292 .. c:type:: struct nvme_mi_ctrl_health_status
12293
12294 Controller Health Data Structure (CHDS)
12295
12296 **Definition**
12297
12298 ::
12299
12300 struct nvme_mi_ctrl_health_status {
12301 __le16 ctlid;
12302 __le16 csts;
12303 __le16 ctemp;
12304 __u8 pdlu;
12305 __u8 spare;
12306 __u8 cwarn;
12307 __u8 rsvd9[7];
12308 };
12309
12310 **Members**
12311
12312 ``ctlid``
12313 Controller Identifier
12314
12315 ``csts``
12316 Controller Status
12317
12318 ``ctemp``
12319 Composite Temperature
12320
12321 ``pdlu``
12322 Percentage Used
12323
12324 ``spare``
12325 Available Spare
12326
12327 ``cwarn``
12328 Critical Warning
12329
12330 ``rsvd9``
12331 Reserved
12332
12333
12334
12335
12336
12337 .. c:type:: enum nvme_mi_csts
12338
12339 Controller Health Data Structure (CHDS) - Controller Status (CSTS)
12340
12341 **Constants**
12342
12343 ``NVME_MI_CSTS_RDY``
12344 Ready
12345
12346 ``NVME_MI_CSTS_CFS``
12347 Controller Fatal Status
12348
12349 ``NVME_MI_CSTS_SHST``
12350 Shutdown Status
12351
12352 ``NVME_MI_CSTS_NSSRO``
12353 NVM Subsystem Reset Occurred
12354
12355 ``NVME_MI_CSTS_CECO``
12356 Controller Enable Change Occurred
12357
12358 ``NVME_MI_CSTS_NAC``
12359 Namespace Attribute Changed
12360
12361 ``NVME_MI_CSTS_FA``
12362 Firmware Activated
12363
12364
12365
12366
12367 .. c:type:: enum nvme_mi_cwarn
12368
12369 Controller Health Data Structure (CHDS) - Critical Warning (CWARN)
12370
12371 **Constants**
12372
12373 ``NVME_MI_CWARN_ST``
12374 Spare Threshold
12375
12376 ``NVME_MI_CWARN_TAUT``
12377 Temperature Above or Under Threshold
12378
12379 ``NVME_MI_CWARN_RD``
12380 Reliability Degraded
12381
12382 ``NVME_MI_CWARN_RO``
12383 Read Only
12384
12385 ``NVME_MI_CWARN_VMBF``
12386 Volatile Memory Backup Failed
12387
12388
12389
12390
12391 .. c:type:: struct nvme_mi_vpd_mra
12392
12393 NVMe MultiRecord Area
12394
12395 **Definition**
12396
12397 ::
12398
12399 struct nvme_mi_vpd_mra {
12400 __u8 nmravn;
12401 __u8 ff;
12402 __u8 rsvd7[6];
12403 __u8 i18vpwr;
12404 __u8 m18vpwr;
12405 __u8 i33vpwr;
12406 __u8 m33vpwr;
12407 __u8 rsvd17;
12408 __u8 m33vapsr;
12409 __u8 i5vapsr;
12410 __u8 m5vapsr;
12411 __u8 i12vapsr;
12412 __u8 m12vapsr;
12413 __u8 mtl;
12414 __u8 tnvmcap[16];
12415 __u8 rsvd37[27];
12416 };
12417
12418 **Members**
12419
12420 ``nmravn``
12421 NVMe MultiRecord Area Version Number
12422
12423 ``ff``
12424 Form Factor
12425
12426 ``rsvd7``
12427 Reserved
12428
12429 ``i18vpwr``
12430 Initial 1.8 V Power Supply Requirements
12431
12432 ``m18vpwr``
12433 Maximum 1.8 V Power Supply Requirements
12434
12435 ``i33vpwr``
12436 Initial 3.3 V Power Supply Requirements
12437
12438 ``m33vpwr``
12439 Maximum 3.3 V Power Supply Requirements
12440
12441 ``rsvd17``
12442 Reserved
12443
12444 ``m33vapsr``
12445 Maximum 3.3 Vi aux Power Supply Requirements
12446
12447 ``i5vapsr``
12448 Initial 5 V Power Supply Requirements
12449
12450 ``m5vapsr``
12451 Maximum 5 V Power Supply Requirements
12452
12453 ``i12vapsr``
12454 Initial 12 V Power Supply Requirements
12455
12456 ``m12vapsr``
12457 Maximum 12 V Power Supply Requirements
12458
12459 ``mtl``
12460 Maximum Thermal Load
12461
12462 ``tnvmcap``
12463 Total NVM Capacity
12464
12465 ``rsvd37``
12466 Reserved
12467
12468
12469
12470
12471
12472 .. c:type:: struct nvme_mi_vpd_ppmra
12473
12474 NVMe PCIe Port MultiRecord Area
12475
12476 **Definition**
12477
12478 ::
12479
12480 struct nvme_mi_vpd_ppmra {
12481 __u8 nppmravn;
12482 __u8 pn;
12483 __u8 ppi;
12484 __u8 ls;
12485 __u8 mlw;
12486 __u8 mctp;
12487 __u8 refccap;
12488 __u8 pi;
12489 __u8 rsvd13[3];
12490 };
12491
12492 **Members**
12493
12494 ``nppmravn``
12495 NVMe PCIe Port MultiRecord Area Version Number
12496
12497 ``pn``
12498 PCIe Port Number
12499
12500 ``ppi``
12501 Port Information
12502
12503 ``ls``
12504 PCIe Link Speed
12505
12506 ``mlw``
12507 PCIe Maximum Link Width
12508
12509 ``mctp``
12510 MCTP Support
12511
12512 ``refccap``
12513 Ref Clk Capability
12514
12515 ``pi``
12516 Port Identifier
12517
12518 ``rsvd13``
12519 Reserved
12520
12521
12522
12523
12524
12525 .. c:type:: struct nvme_mi_vpd_telem
12526
12527 Vital Product Data Element Descriptor
12528
12529 **Definition**
12530
12531 ::
12532
12533 struct nvme_mi_vpd_telem {
12534 __u8 type;
12535 __u8 rev;
12536 __u8 len;
12537 __u8 data[0];
12538 };
12539
12540 **Members**
12541
12542 ``type``
12543 Type of the Element Descriptor
12544
12545 ``rev``
12546 Revision of the Element Descriptor
12547
12548 ``len``
12549 Number of bytes in the Element Descriptor
12550
12551 ``data``
12552 Type-specific information associated with
12553 the Element Descriptor
12554
12555
12556
12557
12558
12559 .. c:type:: enum nvme_mi_elem
12560
12561 Element Descriptor Types
12562
12563 **Constants**
12564
12565 ``NVME_MI_ELEM_EED``
12566 Extended Element Descriptor
12567
12568 ``NVME_MI_ELEM_USCE``
12569 Upstream Connector Element Descriptor
12570
12571 ``NVME_MI_ELEM_ECED``
12572 Expansion Connector Element Descriptor
12573
12574 ``NVME_MI_ELEM_LED``
12575 Label Element Descriptor
12576
12577 ``NVME_MI_ELEM_SMBMED``
12578 SMBus/I2C Mux Element Descriptor
12579
12580 ``NVME_MI_ELEM_PCIESED``
12581 PCIe Switch Element Descriptor
12582
12583 ``NVME_MI_ELEM_NVMED``
12584 NVM Subsystem Element Descriptor
12585
12586
12587
12588
12589 .. c:type:: struct nvme_mi_vpd_tra
12590
12591 Vital Product Data Topology MultiRecord
12592
12593 **Definition**
12594
12595 ::
12596
12597 struct nvme_mi_vpd_tra {
12598 __u8 vn;
12599 __u8 rsvd6;
12600 __u8 ec;
12601 struct nvme_mi_vpd_telem elems[0];
12602 };
12603
12604 **Members**
12605
12606 ``vn``
12607 Version Number
12608
12609 ``rsvd6``
12610 Reserved
12611
12612 ``ec``
12613 Element Count
12614
12615 ``elems``
12616 Element Descriptor
12617
12618
12619
12620
12621
12622 .. c:type:: struct nvme_mi_vpd_mr_common
12623
12624 NVMe MultiRecord Area
12625
12626 **Definition**
12627
12628 ::
12629
12630 struct nvme_mi_vpd_mr_common {
12631 __u8 type;
12632 __u8 rf;
12633 __u8 rlen;
12634 __u8 rchksum;
12635 __u8 hchksum;
12636 union {
12637 struct nvme_mi_vpd_mra nmra;
12638 struct nvme_mi_vpd_ppmra ppmra;
12639 struct nvme_mi_vpd_tra tmra;
12640 };
12641 };
12642
12643 **Members**
12644
12645 ``type``
12646 NVMe Record Type ID
12647
12648 ``rf``
12649 Record Format
12650
12651 ``rlen``
12652 Record Length
12653
12654 ``rchksum``
12655 Record Checksum
12656
12657 ``hchksum``
12658 Header Checksum
12659
12660 ``{unnamed_union}``
12661 anonymous
12662
12663 ``nmra``
12664 NVMe MultiRecord Area
12665
12666 ``ppmra``
12667 NVMe PCIe Port MultiRecord Area
12668
12669 ``tmra``
12670 Topology MultiRecord Area
12671
12672
12673
12674
12675
12676 .. c:type:: struct nvme_mi_vpd_hdr
12677
12678 Vital Product Data Common Header
12679
12680 **Definition**
12681
12682 ::
12683
12684 struct nvme_mi_vpd_hdr {
12685 __u8 ipmiver;
12686 __u8 iuaoff;
12687 __u8 ciaoff;
12688 __u8 biaoff;
12689 __u8 piaoff;
12690 __u8 mrioff;
12691 __u8 rsvd6;
12692 __u8 chchk;
12693 __u8 vpd[];
12694 };
12695
12696 **Members**
12697
12698 ``ipmiver``
12699 IPMI Format Version Number
12700
12701 ``iuaoff``
12702 Internal Use Area Starting Offset
12703
12704 ``ciaoff``
12705 Chassis Info Area Starting Offset
12706
12707 ``biaoff``
12708 Board Info Area Starting Offset
12709
12710 ``piaoff``
12711 Product Info Area Starting Offset
12712
12713 ``mrioff``
12714 MultiRecord Info Area Starting Offset
12715
12716 ``rsvd6``
12717 Reserved
12718
12719 ``chchk``
12720 Common Header Checksum
12721
12722 ``vpd``
12723 Vital Product Data
12724
12725
12726
12727
12728
12729 .. c:type:: enum nvme_status_field
12730
12731 Defines all parts of the nvme status field: status code, status code type, and additional flags.
12732
12733 **Constants**
12734
12735 ``NVME_SCT_GENERIC``
12736 Generic errors applicable to multiple opcodes
12737
12738 ``NVME_SCT_CMD_SPECIFIC``
12739 Errors associated to a specific opcode
12740
12741 ``NVME_SCT_MEDIA``
12742 Errors associated with media and data integrity
12743
12744 ``NVME_SCT_PATH``
12745 Errors associated with the paths connection
12746
12747 ``NVME_SCT_VS``
12748 Vendor specific errors
12749
12750 ``NVME_SCT_MASK``
12751 Mask to get the value of the Status Code Type
12752
12753 ``NVME_SCT_SHIFT``
12754 Shift value to get the value of the Status
12755 Code Type
12756
12757 ``NVME_SC_MASK``
12758 Mask to get the value of the status code.
12759
12760 ``NVME_SC_SHIFT``
12761 Shift value to get the value of the status
12762 code.
12763
12764 ``NVME_SC_SUCCESS``
12765 Successful Completion: The command
12766 completed without error.
12767
12768 ``NVME_SC_INVALID_OPCODE``
12769 Invalid Command Opcode: A reserved coded
12770 value or an unsupported value in the
12771 command opcode field.
12772
12773 ``NVME_SC_INVALID_FIELD``
12774 Invalid Field in Command: A reserved
12775 coded value or an unsupported value in a
12776 defined field.
12777
12778 ``NVME_SC_CMDID_CONFLICT``
12779 Command ID Conflict: The command
12780 identifier is already in use.
12781
12782 ``NVME_SC_DATA_XFER_ERROR``
12783 Data Transfer Error: Transferring the
12784 data or metadata associated with a
12785 command experienced an error.
12786
12787 ``NVME_SC_POWER_LOSS``
12788 Commands Aborted due to Power Loss
12789 Notification: Indicates that the command
12790 was aborted due to a power loss
12791 notification.
12792
12793 ``NVME_SC_INTERNAL``
12794 Internal Error: The command was not
12795 completed successfully due to an internal error.
12796
12797 ``NVME_SC_ABORT_REQ``
12798 Command Abort Requested: The command was
12799 aborted due to an Abort command being
12800 received that specified the Submission
12801 Queue Identifier and Command Identifier
12802 of this command.
12803
12804 ``NVME_SC_ABORT_QUEUE``
12805 Command Aborted due to SQ Deletion: The
12806 command was aborted due to a Delete I/O
12807 Submission Queue request received for the
12808 Submission Queue to which the command was
12809 submitted.
12810
12811 ``NVME_SC_FUSED_FAIL``
12812 Command Aborted due to Failed Fused Command:
12813 The command was aborted due to the other
12814 command in a fused operation failing.
12815
12816 ``NVME_SC_FUSED_MISSING``
12817 Aborted due to Missing Fused Command: The
12818 fused command was aborted due to the
12819 adjacent submission queue entry not
12820 containing a fused command that is the
12821 other command.
12822
12823 ``NVME_SC_INVALID_NS``
12824 Invalid Namespace or Format: The
12825 namespace or the format of that namespace
12826 is invalid.
12827
12828 ``NVME_SC_CMD_SEQ_ERROR``
12829 Command Sequence Error: The command was
12830 aborted due to a protocol violation in a
12831 multi-command sequence.
12832
12833 ``NVME_SC_SGL_INVALID_LAST``
12834 Invalid SGL Segment Descriptor: The
12835 command includes an invalid SGL Last
12836 Segment or SGL Segment descriptor.
12837
12838 ``NVME_SC_SGL_INVALID_COUNT``
12839 Invalid Number of SGL Descriptors: There
12840 is an SGL Last Segment descriptor or an
12841 SGL Segment descriptor in a location
12842 other than the last descriptor of a
12843 segment based on the length indicated.
12844
12845 ``NVME_SC_SGL_INVALID_DATA``
12846 Data SGL Length Invalid: This may occur
12847 if the length of a Data SGL is too short.
12848 This may occur if the length of a Data
12849 SGL is too long and the controller does
12850 not support SGL transfers longer than the
12851 amount of data to be transferred as
12852 indicated in the SGL Support field of the
12853 Identify Controller data structure.
12854
12855 ``NVME_SC_SGL_INVALID_METADATA``
12856 Metadata SGL Length Invalid: This may
12857 occur if the length of a Metadata SGL is
12858 too short. This may occur if the length
12859 of a Metadata SGL is too long and the
12860 controller does not support SGL transfers
12861 longer than the amount of data to be
12862 transferred as indicated in the SGL
12863 Support field of the Identify Controller
12864 data structure.
12865
12866 ``NVME_SC_SGL_INVALID_TYPE``
12867 SGL Descriptor Type Invalid: The type of
12868 an SGL Descriptor is a type that is not
12869 supported by the controller.
12870
12871 ``NVME_SC_CMB_INVALID_USE``
12872 Invalid Use of Controller Memory Buffer:
12873 The attempted use of the Controller
12874 Memory Buffer is not supported by the
12875 controller.
12876
12877 ``NVME_SC_PRP_INVALID_OFFSET``
12878 PRP Offset Invalid: The Offset field for
12879 a PRP entry is invalid.
12880
12881 ``NVME_SC_AWU_EXCEEDED``
12882 Atomic Write Unit Exceeded: The length
12883 specified exceeds the atomic write unit size.
12884
12885 ``NVME_SC_OP_DENIED``
12886 Operation Denied: The command was denied
12887 due to lack of access rights. Refer to
12888 the appropriate security specification.
12889
12890 ``NVME_SC_SGL_INVALID_OFFSET``
12891 SGL Offset Invalid: The offset specified
12892 in a descriptor is invalid. This may
12893 occur when using capsules for data
12894 transfers in NVMe over Fabrics
12895 implementations and an invalid offset in
12896 the capsule is specified.
12897
12898 ``NVME_SC_HOSTID_FORMAT``
12899 Host Identifier Inconsistent Format: The
12900 NVM subsystem detected the simultaneous
12901 use of 64- bit and 128-bit Host
12902 Identifier values on different
12903 controllers.
12904
12905 ``NVME_SC_KAT_EXPIRED``
12906 Keep Alive Timer Expired: The Keep Alive
12907 Timer expired.
12908
12909 ``NVME_SC_KAT_INVALID``
12910 Keep Alive Timeout Invalid: The Keep
12911 Alive Timeout value specified is invalid.
12912
12913 ``NVME_SC_CMD_ABORTED_PREMEPT``
12914 Command Aborted due to Preempt and Abort:
12915 The command was aborted due to a
12916 Reservation Acquire command.
12917
12918 ``NVME_SC_SANITIZE_FAILED``
12919 Sanitize Failed: The most recent sanitize
12920 operation failed and no recovery action
12921 has been successfully completed.
12922
12923 ``NVME_SC_SANITIZE_IN_PROGRESS``
12924 Sanitize In Progress: The requested
12925 function (e.g., command) is prohibited
12926 while a sanitize operation is in
12927 progress.
12928
12929 ``NVME_SC_SGL_INVALID_GRANULARITY``
12930 SGL Data Block Granularity Invalid: The
12931 Address alignment or Length granularity
12932 for an SGL Data Block descriptor is
12933 invalid.
12934
12935 ``NVME_SC_CMD_IN_CMBQ_NOT_SUPP``
12936 Command Not Supported for Queue in CMB:
12937 The implementation does not support
12938 submission of the command to a Submission
12939 Queue in the Controller Memory Buffer or
12940 command completion to a Completion Queue
12941 in the Controller Memory Buffer.
12942
12943 ``NVME_SC_NS_WRITE_PROTECTED``
12944 Namespace is Write Protected: The command
12945 is prohibited while the namespace is
12946 write protected as a result of a change
12947 in the namespace write protection state
12948 as defined by the Namespace Write
12949 Protection State Machine.
12950
12951 ``NVME_SC_CMD_INTERRUPTED``
12952 Command Interrupted: Command processing
12953 was interrupted and the controller is
12954 unable to successfully complete the
12955 command. The host should retry the
12956 command.
12957
12958 ``NVME_SC_TRAN_TPORT_ERROR``
12959 Transient Transport Error: A transient
12960 transport error was detected. If the
12961 command is retried on the same
12962 controller, the command is likely to
12963 succeed. A command that fails with a
12964 transient transport error four or more
12965 times should be treated as a persistent
12966 transport error that is not likely to
12967 succeed if retried on the same
12968 controller.
12969
12970 ``NVME_SC_PROHIBITED_BY_CMD_AND_FEAT``
12971 Command Prohibited by Command and Feature
12972 Lockdown: The command was aborted due to
12973 command execution being prohibited by
12974 the Command and Feature Lockdown.
12975
12976 ``NVME_SC_ADMIN_CMD_MEDIA_NOT_READY``
12977 Admin Command Media Not Ready: The Admin
12978 command requires access to media and
12979 the media is not ready.
12980
12981 ``NVME_SC_INVALID_KEY_TAG``
12982 The command was aborted due to an invalid KEYTAG
12983 field value.
12984
12985 ``NVME_SC_HOST_DISPERSED_NS_NOT_ENABLED``
12986 The command is prohibited while the
12987 Host Disperesed Namespace Support (HDISNS) field is not
12988 set to 1h in the Host Behavior Support feature.
12989
12990 ``NVME_SC_HOST_ID_NOT_INITIALIZED``
12991 Host Identifier Not Initialized.
12992
12993 ``NVME_SC_INCORRECT_KEY``
12994 The command was aborted due to the key associated
12995 with the KEYTAG field being incorrect.
12996
12997 ``NVME_SC_FDP_DISABLED``
12998 Command is not allowed when
12999 Flexible Data Placement is disabled.
13000
13001 ``NVME_SC_INVALID_PLACEMENT_HANDLE_LIST``
13002 The Placement Handle List is invalid
13003 due to invalid Reclaim Unit Handle Identifier or
13004 valid Reclaim Unit Handle Identifier but restricted or
13005 the Placement Handle List number of entries exceeded the
13006 maximum number allowed.
13007
13008 ``NVME_SC_LBA_RANGE``
13009 LBA Out of Range: The command references
13010 an LBA that exceeds the size of the namespace.
13011
13012 ``NVME_SC_CAP_EXCEEDED``
13013 Capacity Exceeded: Execution of the
13014 command has caused the capacity of the
13015 namespace to be exceeded.
13016
13017 ``NVME_SC_NS_NOT_READY``
13018 Namespace Not Ready: The namespace is not
13019 ready to be accessed as a result of a
13020 condition other than a condition that is
13021 reported as an Asymmetric Namespace
13022 Access condition.
13023
13024 ``NVME_SC_RESERVATION_CONFLICT``
13025 Reservation Conflict: The command was
13026 aborted due to a conflict with a
13027 reservation held on the accessed
13028 namespace.
13029
13030 ``NVME_SC_FORMAT_IN_PROGRESS``
13031 Format In Progress: A Format NVM command
13032 is in progress on the namespace.
13033
13034 ``NVME_SC_INVALID_VALUE_SIZE``
13035 The value size is not valid.
13036
13037 ``NVME_SC_INVALID_KEY_SIZE``
13038 The KV key size is not valid.
13039
13040 ``NVME_SC_KV_KEY_NOT_EXISTS``
13041 The Store If Key Exists (SIKE) bit is set to
13042 '1' in the Store Option field and the KV key does not
13043 exists.
13044
13045 ``NVME_SC_UNRECOVERED_ERROR``
13046 There was an unrecovered error when reading
13047 from the meidum.
13048
13049 ``NVME_SC_KEY_EXISTS``
13050 The Store If No Key Exists (SINKE) bit is set to '1'
13051 in the Store Option field and the KV key exists.
13052
13053 ``NVME_SC_CQ_INVALID``
13054 Completion Queue Invalid: The Completion
13055 Queue identifier specified in the command
13056 does not exist.
13057
13058 ``NVME_SC_QID_INVALID``
13059 Invalid Queue Identifier: The creation of
13060 the I/O Completion Queue failed due to an
13061 invalid queue identifier specified as
13062 part of the command. An invalid queue
13063 identifier is one that is currently in
13064 use or one that is outside the range
13065 supported by the controller.
13066
13067 ``NVME_SC_QUEUE_SIZE``
13068 Invalid Queue Size: The host attempted to
13069 create an I/O Completion Queue with an
13070 invalid number of entries.
13071
13072 ``NVME_SC_ABORT_LIMIT``
13073 Abort Command Limit Exceeded: The number
13074 of concurrently outstanding Abort commands
13075 has exceeded the limit indicated in the
13076 Identify Controller data structure.
13077
13078 ``NVME_SC_ABORT_MISSING``
13079 Abort Command is missing: The abort
13080 command is missing.
13081
13082 ``NVME_SC_ASYNC_LIMIT``
13083 Asynchronous Event Request Limit
13084 Exceeded: The number of concurrently
13085 outstanding Asynchronous Event Request
13086 commands has been exceeded.
13087
13088 ``NVME_SC_FIRMWARE_SLOT``
13089 Invalid Firmware Slot: The firmware slot
13090 indicated is invalid or read only. This
13091 error is indicated if the firmware slot
13092 exceeds the number supported.
13093
13094 ``NVME_SC_FIRMWARE_IMAGE``
13095 Invalid Firmware Image: The firmware
13096 image specified for activation is invalid
13097 and not loaded by the controller.
13098
13099 ``NVME_SC_INVALID_VECTOR``
13100 Invalid Interrupt Vector: The creation of
13101 the I/O Completion Queue failed due to an
13102 invalid interrupt vector specified as
13103 part of the command.
13104
13105 ``NVME_SC_INVALID_LOG_PAGE``
13106 Invalid Log Page: The log page indicated
13107 is invalid. This error condition is also
13108 returned if a reserved log page is
13109 requested.
13110
13111 ``NVME_SC_INVALID_FORMAT``
13112 Invalid Format: The LBA Format specified
13113 is not supported.
13114
13115 ``NVME_SC_FW_NEEDS_CONV_RESET``
13116 Firmware Activation Requires Conventional Reset:
13117 The firmware commit was successful,
13118 however, activation of the firmware image
13119 requires a conventional reset.
13120
13121 ``NVME_SC_INVALID_QUEUE``
13122 Invalid Queue Deletion: Invalid I/O
13123 Completion Queue specified to delete.
13124
13125 ``NVME_SC_FEATURE_NOT_SAVEABLE``
13126 Feature Identifier Not Saveable: The
13127 Feature Identifier specified does not
13128 support a saveable value.
13129
13130 ``NVME_SC_FEATURE_NOT_CHANGEABLE``
13131 Feature Not Changeable: The Feature
13132 Identifier is not able to be changed.
13133
13134 ``NVME_SC_FEATURE_NOT_PER_NS``
13135 Feature Not Namespace Specific: The
13136 Feature Identifier specified is not
13137 namespace specific. The Feature
13138 Identifier settings apply across all
13139 namespaces.
13140
13141 ``NVME_SC_FW_NEEDS_SUBSYS_RESET``
13142 Firmware Activation Requires NVM
13143 Subsystem Reset: The firmware commit was
13144 successful, however, activation of the
13145 firmware image requires an NVM Subsystem.
13146
13147 ``NVME_SC_FW_NEEDS_RESET``
13148 Firmware Activation Requires Controller
13149 Level Reset: The firmware commit was
13150 successful; however, the image specified
13151 does not support being activated without
13152 a reset.
13153
13154 ``NVME_SC_FW_NEEDS_MAX_TIME``
13155 Firmware Activation Requires Maximum Time
13156 Violation: The image specified if
13157 activated immediately would exceed the
13158 Maximum Time for Firmware Activation
13159 (MTFA) value reported in Identify
13160 Controller.
13161
13162 ``NVME_SC_FW_ACTIVATE_PROHIBITED``
13163 Firmware Activation Prohibited: The image
13164 specified is being prohibited from
13165 activation by the controller for vendor
13166 specific reasons.
13167
13168 ``NVME_SC_OVERLAPPING_RANGE``
13169 Overlapping Range: The downloaded
13170 firmware image has overlapping ranges.
13171
13172 ``NVME_SC_NS_INSUFFICIENT_CAP``
13173 Namespace Insufficient Capacity: Creating
13174 the namespace requires more free space
13175 than is currently available.
13176
13177 ``NVME_SC_NS_ID_UNAVAILABLE``
13178 Namespace Identifier Unavailable: The
13179 number of namespaces supported has been
13180 exceeded.
13181
13182 ``NVME_SC_NS_ALREADY_ATTACHED``
13183 Namespace Already Attached: The
13184 controller is already attached to the
13185 namespace specified.
13186
13187 ``NVME_SC_NS_IS_PRIVATE``
13188 Namespace Is Private: The namespace is
13189 private and is already attached to one
13190 controller.
13191
13192 ``NVME_SC_NS_NOT_ATTACHED``
13193 Namespace Not Attached: The request to
13194 detach the controller could not be
13195 completed because the controller is not
13196 attached to the namespace.
13197
13198 ``NVME_SC_THIN_PROV_NOT_SUPP``
13199 Thin Provisioning Not Supported: Thin
13200 provisioning is not supported by the
13201 controller.
13202
13203 ``NVME_SC_CTRL_LIST_INVALID``
13204 Controller List Invalid: The controller
13205 list provided contains invalid controller
13206 ids.
13207
13208 ``NVME_SC_SELF_TEST_IN_PROGRESS``
13209 Device Self-test In Progress: The controller
13210 or NVM subsystem already has a device
13211 self-test operation in process.
13212
13213 ``NVME_SC_BP_WRITE_PROHIBITED``
13214 Boot Partition Write Prohibited: The
13215 command is trying to modify a locked Boot
13216 Partition.
13217
13218 ``NVME_SC_INVALID_CTRL_ID``
13219 Invalid Controller Identifier:
13220
13221 ``NVME_SC_INVALID_SEC_CTRL_STATE``
13222 Invalid Secondary Controller State
13223
13224 ``NVME_SC_INVALID_CTRL_RESOURCES``
13225 Invalid Number of Controller Resources
13226
13227 ``NVME_SC_INVALID_RESOURCE_ID``
13228 Invalid Resource Identifier
13229
13230 ``NVME_SC_PMR_SAN_PROHIBITED``
13231 Sanitize Prohibited While Persistent
13232 Memory Region is Enabled
13233
13234 ``NVME_SC_ANA_GROUP_ID_INVALID``
13235 ANA Group Identifier Invalid: The specified
13236 ANA Group Identifier (ANAGRPID) is not
13237 supported in the submitted command.
13238
13239 ``NVME_SC_ANA_ATTACH_FAILED``
13240 ANA Attach Failed: The controller is not
13241 attached to the namespace as a result
13242 of an ANA condition.
13243
13244 ``NVME_SC_INSUFFICIENT_CAP``
13245 Insufficient Capacity: Requested operation
13246 requires more free space than is currently
13247 available.
13248
13249 ``NVME_SC_NS_ATTACHMENT_LIMIT_EXCEEDED``
13250 Namespace Attachment Limit Exceeded:
13251 Attaching the ns to a controller causes
13252 max number of ns attachments allowed
13253 to be exceeded.
13254
13255 ``NVME_SC_PROHIBIT_CMD_EXEC_NOT_SUPPORTED``
13256 Prohibition of Command Execution
13257 Not Supported
13258
13259 ``NVME_SC_IOCS_NOT_SUPPORTED``
13260 I/O Command Set Not Supported
13261
13262 ``NVME_SC_IOCS_NOT_ENABLED``
13263 I/O Command Set Not Enabled
13264
13265 ``NVME_SC_IOCS_COMBINATION_REJECTED``
13266 I/O Command Set Combination Rejected
13267
13268 ``NVME_SC_INVALID_IOCS``
13269 Invalid I/O Command Set
13270
13271 ``NVME_SC_ID_UNAVAILABLE``
13272 Identifier Unavailable
13273
13274 ``NVME_SC_INVALID_DISCOVERY_INFO``
13275 The discovery information provided in
13276 one or more extended discovery
13277 information entries is not applicable
13278 for the type of entity selected in
13279 the Entity Type (ETYPE) field of the
13280 Discovery Information Management
13281 command data portion’s header.
13282
13283 ``NVME_SC_ZONING_DATA_STRUCT_LOCKED``
13284 The requested Zoning data structure
13285 is locked on the CDC.
13286
13287 ``NVME_SC_ZONING_DATA_STRUCT_NOTFND``
13288 The requested Zoning data structure
13289 does not exist on the CDC.
13290
13291 ``NVME_SC_INSUFFICIENT_DISC_RES``
13292 The number of discover information
13293 entries provided in the data portion
13294 of the Discovery Information
13295 Management command for a registration
13296 task (i.e., TAS field cleared to 0h)
13297 exceeds the available capacity for
13298 new discovery information entries on
13299 the CDC or DDC. This may be a
13300 transient condition.
13301
13302 ``NVME_SC_REQSTD_FUNCTION_DISABLED``
13303 Fabric Zoning is not enabled on the
13304 CDC
13305
13306 ``NVME_SC_ZONEGRP_ORIGINATOR_INVLD``
13307 The NQN contained in the ZoneGroup
13308 Originator field does not match the
13309 Host NQN used by the DDC to connect
13310 to the CDC.
13311
13312 ``NVME_SC_INVALID_CONTROLER_DATA_QUEUE``
13313 This error indicates that the
13314 specified Controller Data Queue
13315 Identifier is invalid for the controller
13316 processing the command.
13317
13318 ``NVME_SC_NOT_ENOUGH_RESOURCES``
13319 This error indicates that there is not
13320 enough resources in the controller to
13321 process the command.
13322
13323 ``NVME_SC_CONTROLLER_SUSPENDED``
13324 The operation requested is not allowed if
13325 the specified controller is suspended.
13326
13327 ``NVME_SC_CONTROLLER_NOT_SUSPENDED``
13328 The operation requested is not allowed if
13329 the specified controller is not
13330 suspended.
13331
13332 ``NVME_SC_CONTROLLER_DATA_QUEUE_FULL``
13333 The controller detected that a
13334 Controller Data Queue became full.
13335
13336 ``NVME_SC_BAD_ATTRIBUTES``
13337 Conflicting Dataset Management Attributes
13338
13339 ``NVME_SC_INVALID_PI``
13340 Invalid Protection Information
13341
13342 ``NVME_SC_READ_ONLY``
13343 Attempted Write to Read Only Range
13344
13345 ``NVME_SC_CMD_SIZE_LIMIT_EXCEEDED``
13346 Command Size Limit Exceeded
13347
13348 ``NVME_SC_INCOMPATIBLE_NS``
13349 Incompatible Namespace or Format: At
13350 least one source namespace and the
13351 destination namespace have incompatible
13352 formats.
13353
13354 ``NVME_SC_FAST_COPY_NOT_POSSIBLE``
13355 Fast Copy Not Possible: The Fast Copy
13356 Only (FCO) bit was set to ‘1’ in a Source
13357 Range entry and the controller was not
13358 able to use fast copy operations to copy
13359 the specified data.
13360
13361 ``NVME_SC_OVERLAPPING_IO_RANGE``
13362 Overlapping I/O Range: A source logical
13363 block range overlaps the destination
13364 logical block range.
13365
13366 ``NVME_SC_INSUFFICIENT_RESOURCES``
13367 Insufficient Resources: A resource
13368 shortage prevented the controller from
13369 performing the requested copy.
13370
13371 ``NVME_SC_CONNECT_FORMAT``
13372 Incompatible Format: The NVM subsystem
13373 does not support the record format
13374 specified by the host.
13375
13376 ``NVME_SC_CONNECT_CTRL_BUSY``
13377 Controller Busy: The controller is
13378 already associated with a host.
13379
13380 ``NVME_SC_CONNECT_INVALID_PARAM``
13381 Connect Invalid Parameters: One or more
13382 of the command parameters.
13383
13384 ``NVME_SC_CONNECT_RESTART_DISC``
13385 Connect Restart Discovery: The NVM
13386 subsystem requested is not available.
13387
13388 ``NVME_SC_CONNECT_INVALID_HOST``
13389 Connect Invalid Host: The host is either
13390 not allowed to establish an association
13391 to any controller in the NVM subsystem or
13392 the host is not allowed to establish an
13393 association to the specified controller
13394
13395 ``NVME_SC_DISCONNECT_INVALID_QTYPE``
13396 Invalid Queue Type: The command was sent
13397 on the wrong queue type.
13398
13399 ``NVME_SC_DISCOVERY_RESTART``
13400 Discover Restart: The snapshot of the
13401 records is now invalid or out of date.
13402
13403 ``NVME_SC_AUTH_REQUIRED``
13404 Authentication Required: NVMe in-band
13405 authentication is required and the queue
13406 has not yet been authenticated.
13407
13408 ``NVME_SC_ZNS_INVALID_OP_REQUEST``
13409 Invalid Zone Operation Request:
13410 The operation requested is invalid. This may be due to
13411 various conditions, including: attempting to allocate a
13412 ZRWA when a zone is not in the ZSE:Empty state; or
13413 invalid Flush Explicit ZRWA Range Send Zone Action
13414 operation.
13415
13416 ``NVME_SC_ZNS_ZRWA_RESOURCES_UNAVAILABLE``
13417 ZRWA Resources Unavailable:
13418 No ZRWAs are available.
13419
13420 ``NVME_SC_ZNS_BOUNDARY_ERROR``
13421 Zone Boundary Error: The command specifies
13422 logical blocks in more than one zone.
13423
13424 ``NVME_SC_ZNS_FULL``
13425 Zone Is Full: The accessed zone is in the
13426 ZSF:Full state.
13427
13428 ``NVME_SC_ZNS_READ_ONLY``
13429 Zone Is Read Only: The accessed zone is
13430 in the ZSRO:Read Only state.
13431
13432 ``NVME_SC_ZNS_OFFLINE``
13433 Zone Is Offline: The accessed zone is
13434 in the ZSO:Offline state.
13435
13436 ``NVME_SC_ZNS_INVALID_WRITE``
13437 Zone Invalid Write: The write to a zone
13438 was not at the write pointer.
13439
13440 ``NVME_SC_ZNS_TOO_MANY_ACTIVE``
13441 Too Many Active Zones: The controller
13442 does not allow additional active zones.
13443
13444 ``NVME_SC_ZNS_TOO_MANY_OPENS``
13445 Too Many Open Zones: The controller does
13446 not allow additional open zones.
13447
13448 ``NVME_SC_ZNS_INVAL_TRANSITION``
13449 Invalid Zone State Transition: The request
13450 is not a valid zone state transition.
13451
13452 ``NVME_SC_WRITE_FAULT``
13453 Write Fault: The write data could not be
13454 committed to the media.
13455
13456 ``NVME_SC_READ_ERROR``
13457 Unrecovered Read Error: The read data
13458 could not be recovered from the media.
13459
13460 ``NVME_SC_GUARD_CHECK``
13461 End-to-end Guard Check Error: The command
13462 was aborted due to an end-to-end guard
13463 check failure.
13464
13465 ``NVME_SC_APPTAG_CHECK``
13466 End-to-end Application Tag Check Error:
13467 The command was aborted due to an
13468 end-to-end application tag check failure.
13469
13470 ``NVME_SC_REFTAG_CHECK``
13471 End-to-end Reference Tag Check Error: The
13472 command was aborted due to an end-to-end
13473 reference tag check failure.
13474
13475 ``NVME_SC_COMPARE_FAILED``
13476 Compare Failure: The command failed due
13477 to a miscompare during a Compare command.
13478
13479 ``NVME_SC_ACCESS_DENIED``
13480 Access Denied: Access to the namespace
13481 and/or LBA range is denied due to lack of
13482 access rights.
13483
13484 ``NVME_SC_UNWRITTEN_BLOCK``
13485 Deallocated or Unwritten Logical Block:
13486 The command failed due to an attempt to
13487 read from or verify an LBA range
13488 containing a deallocated or unwritten
13489 logical block.
13490
13491 ``NVME_SC_STORAGE_TAG_CHECK``
13492 End-to-End Storage Tag Check Error: The
13493 command was aborted due to an end-to-end
13494 storage tag check failure.
13495
13496 ``NVME_SC_ANA_INTERNAL_PATH_ERROR``
13497 Internal Path Error: The command was not
13498 completed as the result of a controller
13499 internal error that is specific to the
13500 controller processing the command.
13501
13502 ``NVME_SC_ANA_PERSISTENT_LOSS``
13503 Asymmetric Access Persistent Loss: The
13504 requested function (e.g., command) is not
13505 able to be performed as a result of the
13506 relationship between the controller and
13507 the namespace being in the ANA Persistent
13508 Loss state.
13509
13510 ``NVME_SC_ANA_INACCESSIBLE``
13511 Asymmetric Access Inaccessible: The
13512 requested function (e.g., command) is not
13513 able to be performed as a result of the
13514 relationship between the controller and
13515 the namespace being in the ANA
13516 Inaccessible state.
13517
13518 ``NVME_SC_ANA_TRANSITION``
13519 Asymmetric Access Transition: The
13520 requested function (e.g., command) is not
13521 able to be performed as a result of the
13522 relationship between the controller and
13523 the namespace transitioning between
13524 Asymmetric Namespace Access states.
13525
13526 ``NVME_SC_CTRL_PATH_ERROR``
13527 Controller Pathing Error: A pathing error
13528 was detected by the controller.
13529
13530 ``NVME_SC_HOST_PATH_ERROR``
13531 Host Pathing Error: A pathing error was
13532 detected by the host.
13533
13534 ``NVME_SC_CMD_ABORTED_BY_HOST``
13535 Command Aborted By Host: The command was
13536 aborted as a result of host action.
13537
13538 ``NVME_SC_CRD``
13539 Mask to get value of Command Retry Delay
13540 index
13541
13542 ``NVME_SC_MORE``
13543 More bit. If set, more status information
13544 for this command as part of the Error
13545 Information log that may be retrieved with
13546 the Get Log Page command.
13547
13548 ``NVME_SC_DNR``
13549 Do Not Retry bit. If set, if the same
13550 command is re-submitted to any controller
13551 in the NVM subsystem, then that
13552 re-submitted command is expected to fail.
13553
13554
13555 .. c:function:: __u16 nvme_status_code_type (__u16 status_field)
13556
13557 Returns the NVMe Status Code Type
13558
13559 **Parameters**
13560
13561 ``__u16 status_field``
13562 The NVMe Completion Queue Entry's Status Field
13563 See :c:type:`enum nvme_status_field <nvme_status_field>`
13564
13565 **Return**
13566
13567 status code type
13568
13569
13570 .. c:function:: __u16 nvme_status_code (__u16 status_field)
13571
13572 Returns the NVMe Status Code
13573
13574 **Parameters**
13575
13576 ``__u16 status_field``
13577 The NVMe Completion Queue Entry's Status Field
13578 See :c:type:`enum nvme_status_field <nvme_status_field>`
13579
13580 **Return**
13581
13582 status code
13583
13584
13585
13586
13587 .. c:type:: enum nvme_status_type
13588
13589 type encoding for NVMe return values, when represented as an int.
13590
13591 **Constants**
13592
13593 ``NVME_STATUS_TYPE_SHIFT``
13594 shift value for status bits
13595
13596 ``NVME_STATUS_TYPE_MASK``
13597 mask value for status bits
13598
13599 ``NVME_STATUS_TYPE_NVME``
13600 NVMe command status value, typically from CDW3
13601
13602 ``NVME_STATUS_TYPE_MI``
13603 NVMe-MI header status
13604
13605 **Description**
13606
13607
13608 The nvme_* api returns an int, with negative values indicating an internal
13609 or syscall error, zero signifying success, positive values representing
13610 the NVMe status.
13611
13612 That latter case (the NVMe status) may represent status values from
13613 different parts of the transport/controller/etc, and are at most 16 bits of
13614 data. So, we use the most-significant 3 bits of the signed int to indicate
13615 which type of status this is.
13616
13617
13618 .. c:function:: __u32 nvme_status_get_type (int status)
13619
13620 extract the type from a nvme_* return value
13621
13622 **Parameters**
13623
13624 ``int status``
13625 the (non-negative) return value from the NVMe API
13626
13627 **Return**
13628
13629 the type component of the status.
13630
13631
13632 .. c:function:: __u32 nvme_status_get_value (int status)
13633
13634 extract the status value from a nvme_* return value
13635
13636 **Parameters**
13637
13638 ``int status``
13639 the (non-negative) return value from the NVMe API
13640
13641 **Return**
13642
13643 the value component of the status; the set of values will depend
13644 on the status type.
13645
13646
13647 .. c:function:: __u32 nvme_status_equals (int status, enum nvme_status_type type, unsigned int value)
13648
13649 helper to check a status against a type and value
13650
13651 **Parameters**
13652
13653 ``int status``
13654 the (non-negative) return value from the NVMe API
13655
13656 ``enum nvme_status_type type``
13657 the status type
13658
13659 ``unsigned int value``
13660 the status value
13661
13662 **Return**
13663
13664 true if **status** is of the specified type and value
13665
13666
13667
13668
13669 .. c:type:: enum nvme_admin_opcode
13670
13671 Known NVMe admin opcodes
13672
13673 **Constants**
13674
13675 ``nvme_admin_delete_sq``
13676 Delete I/O Submission Queue
13677
13678 ``nvme_admin_create_sq``
13679 Create I/O Submission Queue
13680
13681 ``nvme_admin_get_log_page``
13682 Get Log Page
13683
13684 ``nvme_admin_delete_cq``
13685 Delete I/O Completion Queue
13686
13687 ``nvme_admin_create_cq``
13688 Create I/O Completion Queue
13689
13690 ``nvme_admin_identify``
13691 Identify
13692
13693 ``nvme_admin_abort_cmd``
13694 Abort
13695
13696 ``nvme_admin_set_features``
13697 Set Features
13698
13699 ``nvme_admin_get_features``
13700 Get Features
13701
13702 ``nvme_admin_async_event``
13703 Asynchronous Event Request
13704
13705 ``nvme_admin_ns_mgmt``
13706 Namespace Management
13707
13708 ``nvme_admin_fw_commit``
13709 Firmware Commit
13710
13711 ``nvme_admin_fw_activate``
13712 Firmware Commit
13713
13714 ``nvme_admin_fw_download``
13715 Firmware Image Download
13716
13717 ``nvme_admin_dev_self_test``
13718 Device Self-test
13719
13720 ``nvme_admin_ns_attach``
13721 Namespace Attachment
13722
13723 ``nvme_admin_keep_alive``
13724 Keep Alive
13725
13726 ``nvme_admin_directive_send``
13727 Directive Send
13728
13729 ``nvme_admin_directive_recv``
13730 Directive Receive
13731
13732 ``nvme_admin_virtual_mgmt``
13733 Virtualization Management
13734
13735 ``nvme_admin_nvme_mi_send``
13736 NVMe-MI Send
13737
13738 ``nvme_admin_nvme_mi_recv``
13739 NVMe-MI Receive
13740
13741 ``nvme_admin_capacity_mgmt``
13742 Capacity Management
13743
13744 ``nvme_admin_discovery_info_mgmt``
13745 Discovery Information Management (DIM)
13746
13747 ``nvme_admin_fabric_zoning_recv``
13748 Fabric Zoning Receive
13749
13750 ``nvme_admin_lockdown``
13751 Lockdown
13752
13753 ``nvme_admin_fabric_zoning_lookup``
13754 Fabric Zoning Lookup
13755
13756 ``nvme_admin_clear_export_nvm_res``
13757 Clear Exported NVM Resource Configuration
13758
13759 ``nvme_admin_fabric_zoning_send``
13760 Fabric Zoning Send
13761
13762 ``nvme_admin_create_export_nvms``
13763 Create Exported NVM Subsystem
13764
13765 ``nvme_admin_manage_export_nvms``
13766 Manage Exported NVM Subsystem
13767
13768 ``nvme_admin_manage_export_ns``
13769 Manage Exported Namespace
13770
13771 ``nvme_admin_manage_export_port``
13772 Manage Exported Port
13773
13774 ``nvme_admin_send_disc_log_page``
13775 Send Discovery Log Page
13776
13777 ``nvme_admin_track_send``
13778 Track Send
13779
13780 ``nvme_admin_track_receive``
13781 Track Receive
13782
13783 ``nvme_admin_migration_send``
13784 Migration Send
13785
13786 ``nvme_admin_migration_receive``
13787 Migration Receive
13788
13789 ``nvme_admin_ctrl_data_queue``
13790 Controller Data Queue
13791
13792 ``nvme_admin_dbbuf``
13793 Doorbell Buffer Config
13794
13795 ``nvme_admin_fabrics``
13796 Fabrics Commands
13797
13798 ``nvme_admin_format_nvm``
13799 Format NVM
13800
13801 ``nvme_admin_security_send``
13802 Security Send
13803
13804 ``nvme_admin_security_recv``
13805 Security Receive
13806
13807 ``nvme_admin_sanitize_nvm``
13808 Sanitize
13809
13810 ``nvme_admin_load_program``
13811 Load Program
13812
13813 ``nvme_admin_get_lba_status``
13814 Get LBA Status
13815
13816 ``nvme_admin_program_act_mgmt``
13817 Program Activation Management
13818
13819 ``nvme_admin_mem_range_set_mgmt``
13820 Memory Range Set Management
13821
13822
13823
13824
13825 .. c:type:: enum nvme_identify_cns
13826
13827 Identify - CNS Values
13828
13829 **Constants**
13830
13831 ``NVME_IDENTIFY_CNS_NS``
13832 Identify Namespace data structure
13833
13834 ``NVME_IDENTIFY_CNS_CTRL``
13835 Identify Controller data structure
13836
13837 ``NVME_IDENTIFY_CNS_NS_ACTIVE_LIST``
13838 Active Namespace ID list
13839
13840 ``NVME_IDENTIFY_CNS_NS_DESC_LIST``
13841 Namespace Identification Descriptor list
13842
13843 ``NVME_IDENTIFY_CNS_NVMSET_LIST``
13844 NVM Set List
13845
13846 ``NVME_IDENTIFY_CNS_CSI_NS``
13847 I/O Command Set specific Identify
13848 Namespace data structure
13849
13850 ``NVME_IDENTIFY_CNS_CSI_CTRL``
13851 I/O Command Set specific Identify
13852 Controller data structure
13853
13854 ``NVME_IDENTIFY_CNS_CSI_NS_ACTIVE_LIST``
13855 Active Namespace ID list associated
13856 with the specified I/O Command Set
13857
13858 ``NVME_IDENTIFY_CNS_CSI_INDEPENDENT_ID_NS``
13859 I/O Command Set Independent Identify
13860
13861 ``NVME_IDENTIFY_CNS_NS_USER_DATA_FORMAT``
13862 Namespace user data format
13863
13864 ``NVME_IDENTIFY_CNS_CSI_NS_USER_DATA_FORMAT``
13865 I/O Command Set specific user data
13866 format
13867 Namespace data structure
13868
13869 ``NVME_IDENTIFY_CNS_ALLOCATED_NS_LIST``
13870 Allocated Namespace ID list
13871
13872 ``NVME_IDENTIFY_CNS_ALLOCATED_NS``
13873 Identify Namespace data structure for
13874 the specified allocated NSID
13875
13876 ``NVME_IDENTIFY_CNS_NS_CTRL_LIST``
13877 Controller List of controllers attached
13878 to the specified NSID
13879
13880 ``NVME_IDENTIFY_CNS_CTRL_LIST``
13881 Controller List of controllers that exist
13882 in the NVM subsystem
13883
13884 ``NVME_IDENTIFY_CNS_PRIMARY_CTRL_CAP``
13885 Primary Controller Capabilities data
13886 structure for the specified primary controller
13887
13888 ``NVME_IDENTIFY_CNS_SECONDARY_CTRL_LIST``
13889 Secondary Controller list of controllers
13890 associated with the primary controller
13891 processing the command
13892
13893 ``NVME_IDENTIFY_CNS_NS_GRANULARITY``
13894 A Namespace Granularity List
13895
13896 ``NVME_IDENTIFY_CNS_UUID_LIST``
13897 A UUID List
13898
13899 ``NVME_IDENTIFY_CNS_DOMAIN_LIST``
13900 Domain List
13901
13902 ``NVME_IDENTIFY_CNS_ENDURANCE_GROUP_ID``
13903 Endurance Group List
13904
13905 ``NVME_IDENTIFY_CNS_CSI_ALLOCATED_NS_LIST``
13906 I/O Command Set specific Allocated Namespace
13907 ID list
13908
13909 ``NVME_IDENTIFY_CNS_CSI_ID_NS_DATA_STRUCTURE``
13910 I/O Command Set specific ID Namespace
13911 Data Structure for Allocated Namespace ID
13912
13913 ``NVME_IDENTIFY_CNS_COMMAND_SET_STRUCTURE``
13914 I/O Command Set data structure
13915
13916 ``NVME_IDENTIFY_CNS_UNDERLYING_NS_LIST``
13917 Get Underlying Namespace List
13918
13919 ``NVME_IDENTIFY_CNS_PORTS_LIST``
13920 Get Ports List
13921
13922 ``NVME_IDENTIFY_CNS_IOCS_IND_ID_ALLOC_NS``
13923 I/O Command Set Independent Identify Namespace data
13924 structure for the specified allocated NSID
13925
13926 ``NVME_IDENTIFY_CNS_SUPPORTED_CTRL_STATE_FORMATS``
13927 Supported Controller State Formats
13928 identifying the supported NVMe Controller
13929 State data structures
13930
13931
13932
13933
13934 .. c:type:: enum nvme_cmd_get_log_lid
13935
13936 Get Log Page -Log Page Identifiers
13937
13938 **Constants**
13939
13940 ``NVME_LOG_LID_SUPPORTED_LOG_PAGES``
13941 Supported Log Pages
13942
13943 ``NVME_LOG_LID_ERROR``
13944 Error Information
13945
13946 ``NVME_LOG_LID_SMART``
13947 SMART / Health Information
13948
13949 ``NVME_LOG_LID_FW_SLOT``
13950 Firmware Slot Information
13951
13952 ``NVME_LOG_LID_CHANGED_NS``
13953 Changed Namespace List
13954
13955 ``NVME_LOG_LID_CMD_EFFECTS``
13956 Commands Supported and Effects
13957
13958 ``NVME_LOG_LID_DEVICE_SELF_TEST``
13959 Device Self-test
13960
13961 ``NVME_LOG_LID_TELEMETRY_HOST``
13962 Telemetry Host-Initiated
13963
13964 ``NVME_LOG_LID_TELEMETRY_CTRL``
13965 Telemetry Controller-Initiated
13966
13967 ``NVME_LOG_LID_ENDURANCE_GROUP``
13968 Endurance Group Information
13969
13970 ``NVME_LOG_LID_PREDICTABLE_LAT_NVMSET``
13971 Predictable Latency Per NVM Set
13972
13973 ``NVME_LOG_LID_PREDICTABLE_LAT_AGG``
13974 Predictable Latency Event Aggregate
13975
13976 ``NVME_LOG_LID_ANA``
13977 Asymmetric Namespace Access
13978
13979 ``NVME_LOG_LID_PERSISTENT_EVENT``
13980 Persistent Event Log
13981
13982 ``NVME_LOG_LID_LBA_STATUS``
13983 LBA Status Information
13984
13985 ``NVME_LOG_LID_ENDURANCE_GRP_EVT``
13986 Endurance Group Event Aggregate
13987
13988 ``NVME_LOG_LID_MEDIA_UNIT_STATUS``
13989 Media Unit Status
13990
13991 ``NVME_LOG_LID_SUPPORTED_CAP_CONFIG_LIST``
13992 Supported Capacity Configuration Lis
13993
13994 ``NVME_LOG_LID_FID_SUPPORTED_EFFECTS``
13995 Feature Identifiers Supported and Effects
13996
13997 ``NVME_LOG_LID_MI_CMD_SUPPORTED_EFFECTS``
13998 NVMe-MI Commands Supported and Effects
13999
14000 ``NVME_LOG_LID_CMD_AND_FEAT_LOCKDOWN``
14001 Command and Feature Lockdown
14002
14003 ``NVME_LOG_LID_BOOT_PARTITION``
14004 Boot Partition
14005
14006 ``NVME_LOG_LID_ROTATIONAL_MEDIA_INFO``
14007 Rotational Media Information
14008
14009 ``NVME_LOG_LID_DISPERSED_NS_PARTICIPATING_NSS``
14010 Dispersed Namespace Participating NVM Subsystems
14011
14012 ``NVME_LOG_LID_MGMT_ADDR_LIST``
14013 Management Address List
14014
14015 ``NVME_LOG_LID_PHY_RX_EOM``
14016 Physical Interface Receiver Eye Opening Measurement
14017
14018 ``NVME_LOG_LID_REACHABILITY_GROUPS``
14019 Reachability Groups
14020
14021 ``NVME_LOG_LID_REACHABILITY_ASSOCIATIONS``
14022 Reachability Associations
14023
14024 ``NVME_LOG_LID_CHANGED_ALLOC_NS_LIST``
14025 Changed Allocated Namespace List
14026
14027 ``NVME_LOG_LID_FDP_CONFIGS``
14028 FDP Configurations
14029
14030 ``NVME_LOG_LID_FDP_RUH_USAGE``
14031 Reclaim Unit Handle Usage
14032
14033 ``NVME_LOG_LID_FDP_STATS``
14034 FDP Statistics
14035
14036 ``NVME_LOG_LID_FDP_EVENTS``
14037 FDP Events
14038
14039 ``NVME_LOG_LID_DISCOVER``
14040 Discovery
14041
14042 ``NVME_LOG_LID_HOST_DISCOVER``
14043 Host Discovery
14044
14045 ``NVME_LOG_LID_AVE_DISCOVER``
14046 AVE Discovery
14047
14048 ``NVME_LOG_LID_PULL_MODEL_DDC_REQ``
14049 Pull Model DDC Request
14050
14051 ``NVME_LOG_LID_RESERVATION``
14052 Reservation Notification
14053
14054 ``NVME_LOG_LID_SANITIZE``
14055 Sanitize Status
14056
14057 ``NVME_LOG_LID_ZNS_CHANGED_ZONES``
14058 Changed Zone List
14059
14060
14061
14062
14063 .. c:type:: enum nvme_features_id
14064
14065 Features - Feature Identifiers
14066
14067 **Constants**
14068
14069 ``NVME_FEAT_FID_ARBITRATION``
14070 Arbitration
14071
14072 ``NVME_FEAT_FID_POWER_MGMT``
14073 Power Management
14074
14075 ``NVME_FEAT_FID_LBA_RANGE``
14076 LBA Range Type
14077
14078 ``NVME_FEAT_FID_TEMP_THRESH``
14079 Temperature Threshold
14080
14081 ``NVME_FEAT_FID_ERR_RECOVERY``
14082 Error Recovery
14083
14084 ``NVME_FEAT_FID_VOLATILE_WC``
14085 Volatile Write Cache
14086
14087 ``NVME_FEAT_FID_NUM_QUEUES``
14088 Number of Queues
14089
14090 ``NVME_FEAT_FID_IRQ_COALESCE``
14091 Interrupt Coalescing
14092
14093 ``NVME_FEAT_FID_IRQ_CONFIG``
14094 Interrupt Vector Configuration
14095
14096 ``NVME_FEAT_FID_WRITE_ATOMIC``
14097 Write Atomicity Normal
14098
14099 ``NVME_FEAT_FID_ASYNC_EVENT``
14100 Asynchronous Event Configuration
14101
14102 ``NVME_FEAT_FID_AUTO_PST``
14103 Autonomous Power State Transition
14104
14105 ``NVME_FEAT_FID_HOST_MEM_BUF``
14106 Host Memory Buffer
14107
14108 ``NVME_FEAT_FID_TIMESTAMP``
14109 Timestamp
14110
14111 ``NVME_FEAT_FID_KATO``
14112 Keep Alive Timer
14113
14114 ``NVME_FEAT_FID_HCTM``
14115 Host Controlled Thermal Management
14116
14117 ``NVME_FEAT_FID_NOPSC``
14118 Non-Operational Power State Config
14119
14120 ``NVME_FEAT_FID_RRL``
14121 Read Recovery Level Config
14122
14123 ``NVME_FEAT_FID_PLM_CONFIG``
14124 Predictable Latency Mode Config
14125
14126 ``NVME_FEAT_FID_PLM_WINDOW``
14127 Predictable Latency Mode Window
14128
14129 ``NVME_FEAT_FID_LBA_STS_INTERVAL``
14130 LBA Status Information Report Interval
14131
14132 ``NVME_FEAT_FID_HOST_BEHAVIOR``
14133 Host Behavior Support
14134
14135 ``NVME_FEAT_FID_SANITIZE``
14136 Sanitize Config
14137
14138 ``NVME_FEAT_FID_ENDURANCE_EVT_CFG``
14139 Endurance Group Event Configuration
14140
14141 ``NVME_FEAT_FID_IOCS_PROFILE``
14142 I/O Command Set Profile
14143
14144 ``NVME_FEAT_FID_SPINUP_CONTROL``
14145 Spinup Control
14146
14147 ``NVME_FEAT_FID_POWER_LOSS_SIGNAL``
14148 Power Loss Signaling Config
14149
14150 ``NVME_FEAT_FID_PERF_CHARACTERISTICS``
14151 Performance Characteristics
14152
14153 ``NVME_FEAT_FID_FDP``
14154 Flexible Data Placement
14155
14156 ``NVME_FEAT_FID_FDP_EVENTS``
14157 FDP Events
14158
14159 ``NVME_FEAT_FID_NS_ADMIN_LABEL``
14160 Namespace Admin Label
14161
14162 ``NVME_FEAT_FID_KEY_VALUE``
14163 Key Value Configuration
14164
14165 ``NVME_FEAT_FID_CTRL_DATA_QUEUE``
14166 Controller Data Queue
14167
14168 ``NVME_FEAT_FID_EMB_MGMT_CTRL_ADDR``
14169 Embedded Management Controller Address
14170
14171 ``NVME_FEAT_FID_HOST_MGMT_AGENT_ADDR``
14172 Host Management Agent Address
14173
14174 ``NVME_FEAT_FID_ENH_CTRL_METADATA``
14175 Enhanced Controller Metadata
14176
14177 ``NVME_FEAT_FID_CTRL_METADATA``
14178 Controller Metadata
14179
14180 ``NVME_FEAT_FID_NS_METADATA``
14181 Namespace Metadata
14182
14183 ``NVME_FEAT_FID_SW_PROGRESS``
14184 Software Progress Marker
14185
14186 ``NVME_FEAT_FID_HOST_ID``
14187 Host Identifier
14188
14189 ``NVME_FEAT_FID_RESV_MASK``
14190 Reservation Notification Mask
14191
14192 ``NVME_FEAT_FID_RESV_PERSIST``
14193 Reservation Persistence
14194
14195 ``NVME_FEAT_FID_WRITE_PROTECT``
14196 Namespace Write Protection Config
14197
14198 ``NVME_FEAT_FID_BP_WRITE_PROTECT``
14199 Boot Partition Write Protection Config
14200
14201
14202
14203
14204 .. c:type:: enum nvme_feat
14205
14206 Features Access Shifts/Masks values
14207
14208 **Constants**
14209
14210 ``NVME_FEAT_ARBITRATION_BURST_SHIFT``
14211
14212 ``NVME_FEAT_ARBITRATION_BURST_MASK``
14213
14214 ``NVME_FEAT_ARBITRATION_LPW_SHIFT``
14215
14216 ``NVME_FEAT_ARBITRATION_LPW_MASK``
14217
14218 ``NVME_FEAT_ARBITRATION_MPW_SHIFT``
14219
14220 ``NVME_FEAT_ARBITRATION_MPW_MASK``
14221
14222 ``NVME_FEAT_ARBITRATION_HPW_SHIFT``
14223
14224 ``NVME_FEAT_ARBITRATION_HPW_MASK``
14225
14226 ``NVME_FEAT_PWRMGMT_PS_SHIFT``
14227
14228 ``NVME_FEAT_PWRMGMT_PS_MASK``
14229
14230 ``NVME_FEAT_PWRMGMT_WH_SHIFT``
14231
14232 ``NVME_FEAT_PWRMGMT_WH_MASK``
14233
14234 ``NVME_FEAT_LBAR_NR_SHIFT``
14235
14236 ``NVME_FEAT_LBAR_NR_MASK``
14237
14238 ``NVME_FEAT_TT_TMPTH_SHIFT``
14239
14240 ``NVME_FEAT_TT_TMPTH_MASK``
14241
14242 ``NVME_FEAT_TT_TMPSEL_SHIFT``
14243
14244 ``NVME_FEAT_TT_TMPSEL_MASK``
14245
14246 ``NVME_FEAT_TT_THSEL_SHIFT``
14247
14248 ``NVME_FEAT_TT_THSEL_MASK``
14249
14250 ``NVME_FEAT_TT_TMPTHH_SHIFT``
14251
14252 ``NVME_FEAT_TT_TMPTHH_MASK``
14253
14254 ``NVME_FEAT_ERROR_RECOVERY_TLER_SHIFT``
14255
14256 ``NVME_FEAT_ERROR_RECOVERY_TLER_MASK``
14257
14258 ``NVME_FEAT_ERROR_RECOVERY_DULBE_SHIFT``
14259
14260 ``NVME_FEAT_ERROR_RECOVERY_DULBE_MASK``
14261
14262 ``NVME_FEAT_VWC_WCE_SHIFT``
14263
14264 ``NVME_FEAT_VWC_WCE_MASK``
14265
14266 ``NVME_FEAT_NRQS_NSQR_SHIFT``
14267
14268 ``NVME_FEAT_NRQS_NSQR_MASK``
14269
14270 ``NVME_FEAT_NRQS_NCQR_SHIFT``
14271
14272 ``NVME_FEAT_NRQS_NCQR_MASK``
14273
14274 ``NVME_FEAT_IRQC_THR_SHIFT``
14275
14276 ``NVME_FEAT_IRQC_THR_MASK``
14277
14278 ``NVME_FEAT_IRQC_TIME_SHIFT``
14279
14280 ``NVME_FEAT_IRQC_TIME_MASK``
14281
14282 ``NVME_FEAT_ICFG_IV_SHIFT``
14283
14284 ``NVME_FEAT_ICFG_IV_MASK``
14285
14286 ``NVME_FEAT_ICFG_CD_SHIFT``
14287
14288 ``NVME_FEAT_ICFG_CD_MASK``
14289
14290 ``NVME_FEAT_WA_DN_SHIFT``
14291
14292 ``NVME_FEAT_WA_DN_MASK``
14293
14294 ``NVME_FEAT_AE_SMART_SHIFT``
14295
14296 ``NVME_FEAT_AE_SMART_MASK``
14297
14298 ``NVME_FEAT_AE_NAN_SHIFT``
14299
14300 ``NVME_FEAT_AE_NAN_MASK``
14301
14302 ``NVME_FEAT_AE_FW_SHIFT``
14303
14304 ``NVME_FEAT_AE_FW_MASK``
14305
14306 ``NVME_FEAT_AE_TELEM_SHIFT``
14307
14308 ``NVME_FEAT_AE_TELEM_MASK``
14309
14310 ``NVME_FEAT_AE_ANA_SHIFT``
14311
14312 ``NVME_FEAT_AE_ANA_MASK``
14313
14314 ``NVME_FEAT_AE_PLA_SHIFT``
14315
14316 ``NVME_FEAT_AE_PLA_MASK``
14317
14318 ``NVME_FEAT_AE_LBAS_SHIFT``
14319
14320 ``NVME_FEAT_AE_LBAS_MASK``
14321
14322 ``NVME_FEAT_AE_EGA_SHIFT``
14323
14324 ``NVME_FEAT_AE_EGA_MASK``
14325
14326 ``NVME_FEAT_AE_NNSSHDN_SHIFT``
14327
14328 ``NVME_FEAT_AE_NNSSHDN_MASK``
14329
14330 ``NVME_FEAT_AE_TTHRY_SHIFT``
14331
14332 ``NVME_FEAT_AE_TTHRY_MASK``
14333
14334 ``NVME_FEAT_AE_RASSN_SHIFT``
14335
14336 ``NVME_FEAT_AE_RASSN_MASK``
14337
14338 ``NVME_FEAT_AE_RGRP0_SHIFT``
14339
14340 ``NVME_FEAT_AE_RGRP0_MASK``
14341
14342 ``NVME_FEAT_AE_ANSAN_SHIFT``
14343
14344 ``NVME_FEAT_AE_ANSAN_MASK``
14345
14346 ``NVME_FEAT_AE_ZDCN_SHIFT``
14347
14348 ``NVME_FEAT_AE_ZDCN_MASK``
14349
14350 ``NVME_FEAT_AE_PMDRLPCN_SHIFT``
14351
14352 ``NVME_FEAT_AE_PMDRLPCN_MASK``
14353
14354 ``NVME_FEAT_AE_ADLPCN_SHIFT``
14355
14356 ``NVME_FEAT_AE_ADLPCN_MASK``
14357
14358 ``NVME_FEAT_AE_HDLPCN_SHIFT``
14359
14360 ``NVME_FEAT_AE_HDLPCN_MASK``
14361
14362 ``NVME_FEAT_AE_DLPCN_SHIFT``
14363
14364 ``NVME_FEAT_AE_DLPCN_MASK``
14365
14366 ``NVME_FEAT_APST_APSTE_SHIFT``
14367
14368 ``NVME_FEAT_APST_APSTE_MASK``
14369
14370 ``NVME_FEAT_HMEM_EHM_SHIFT``
14371
14372 ``NVME_FEAT_HMEM_EHM_MASK``
14373
14374 ``NVME_FEAT_HCTM_TMT2_SHIFT``
14375
14376 ``NVME_FEAT_HCTM_TMT2_MASK``
14377
14378 ``NVME_FEAT_HCTM_TMT1_SHIFT``
14379
14380 ``NVME_FEAT_HCTM_TMT1_MASK``
14381
14382 ``NVME_FEAT_NOPS_NOPPME_SHIFT``
14383
14384 ``NVME_FEAT_NOPS_NOPPME_MASK``
14385
14386 ``NVME_FEAT_RRL_RRL_SHIFT``
14387
14388 ``NVME_FEAT_RRL_RRL_MASK``
14389
14390 ``NVME_FEAT_PLM_PLME_SHIFT``
14391
14392 ``NVME_FEAT_PLM_PLME_MASK``
14393
14394 ``NVME_FEAT_PLMW_WS_SHIFT``
14395
14396 ``NVME_FEAT_PLMW_WS_MASK``
14397
14398 ``NVME_FEAT_LBAS_LSIRI_SHIFT``
14399
14400 ``NVME_FEAT_LBAS_LSIRI_MASK``
14401
14402 ``NVME_FEAT_LBAS_LSIPI_SHIFT``
14403
14404 ``NVME_FEAT_LBAS_LSIPI_MASK``
14405
14406 ``NVME_FEAT_SC_NODRM_SHIFT``
14407
14408 ``NVME_FEAT_SC_NODRM_MASK``
14409
14410 ``NVME_FEAT_EG_ENDGID_SHIFT``
14411
14412 ``NVME_FEAT_EG_ENDGID_MASK``
14413
14414 ``NVME_FEAT_EG_EGCW_SHIFT``
14415
14416 ``NVME_FEAT_EG_EGCW_MASK``
14417
14418 ``NVME_FEAT_FDPE_PHNDL_SHIFT``
14419
14420 ``NVME_FEAT_FDPE_PHNDL_MASK``
14421
14422 ``NVME_FEAT_FDPE_NOET_SHIFT``
14423
14424 ``NVME_FEAT_FDPE_NOET_MASK``
14425
14426 ``NVME_FEAT_SPM_PBSLC_SHIFT``
14427
14428 ``NVME_FEAT_SPM_PBSLC_MASK``
14429
14430 ``NVME_FEAT_HOSTID_EXHID_SHIFT``
14431
14432 ``NVME_FEAT_HOSTID_EXHID_MASK``
14433
14434 ``NVME_FEAT_RM_REGPRE_SHIFT``
14435
14436 ``NVME_FEAT_RM_REGPRE_MASK``
14437
14438 ``NVME_FEAT_RM_RESREL_SHIFT``
14439
14440 ``NVME_FEAT_RM_RESREL_MASK``
14441
14442 ``NVME_FEAT_RM_RESPRE_SHIFT``
14443
14444 ``NVME_FEAT_RM_RESPRE_MASK``
14445
14446 ``NVME_FEAT_RP_PTPL_SHIFT``
14447
14448 ``NVME_FEAT_RP_PTPL_MASK``
14449
14450 ``NVME_FEAT_WP_WPS_SHIFT``
14451
14452 ``NVME_FEAT_WP_WPS_MASK``
14453
14454 ``NVME_FEAT_IOCSP_IOCSCI_SHIFT``
14455
14456 ``NVME_FEAT_IOCSP_IOCSCI_MASK``
14457
14458 ``NVME_FEAT_SPINUP_CONTROL_SHIFT``
14459
14460 ``NVME_FEAT_SPINUP_CONTROL_MASK``
14461
14462 ``NVME_FEAT_PLS_MODE_SHIFT``
14463
14464 ``NVME_FEAT_PLS_MODE_MASK``
14465
14466 ``NVME_FEAT_PERFC_ATTRI_SHIFT``
14467
14468 ``NVME_FEAT_PERFC_ATTRI_MASK``
14469
14470 ``NVME_FEAT_PERFC_RVSPA_SHIFT``
14471
14472 ``NVME_FEAT_PERFC_RVSPA_MASK``
14473
14474 ``NVME_FEAT_PERFC_ATTRTYP_SHIFT``
14475
14476 ``NVME_FEAT_PERFC_ATTRTYP_MASK``
14477
14478 ``NVME_FEAT_FDP_ENABLED_SHIFT``
14479
14480 ``NVME_FEAT_FDP_ENABLED_MASK``
14481
14482 ``NVME_FEAT_FDP_INDEX_SHIFT``
14483
14484 ``NVME_FEAT_FDP_INDEX_MASK``
14485
14486 ``NVME_FEAT_FDP_EVENTS_ENABLE_SHIFT``
14487
14488 ``NVME_FEAT_FDP_EVENTS_ENABLE_MASK``
14489
14490 ``NVME_FEAT_BPWPC_BP0WPS_SHIFT``
14491
14492 ``NVME_FEAT_BPWPC_BP0WPS_MASK``
14493
14494 ``NVME_FEAT_BPWPC_BP1WPS_SHIFT``
14495
14496 ``NVME_FEAT_BPWPC_BP1WPS_MASK``
14497
14498
14499
14500
14501 .. c:type:: enum nvme_get_features_sel
14502
14503 Get Features - Select
14504
14505 **Constants**
14506
14507 ``NVME_GET_FEATURES_SEL_CURRENT``
14508 Current value
14509
14510 ``NVME_GET_FEATURES_SEL_DEFAULT``
14511 Default value
14512
14513 ``NVME_GET_FEATURES_SEL_SAVED``
14514 Saved value
14515
14516 ``NVME_GET_FEATURES_SEL_SUPPORTED``
14517 Supported capabilities
14518
14519
14520
14521
14522 .. c:type:: enum nvme_cmd_format_mset
14523
14524 Format NVM - Metadata Settings
14525
14526 **Constants**
14527
14528 ``NVME_FORMAT_MSET_SEPARATE``
14529 indicates that the metadata is transferred
14530 as part of a separate buffer.
14531
14532 ``NVME_FORMAT_MSET_EXTENDED``
14533 indicates that the metadata is transferred
14534 as part of an extended data LBA.
14535
14536
14537
14538
14539 .. c:type:: enum nvme_cmd_format_pi
14540
14541 Format NVM - Protection Information
14542
14543 **Constants**
14544
14545 ``NVME_FORMAT_PI_DISABLE``
14546 Protection information is not enabled.
14547
14548 ``NVME_FORMAT_PI_TYPE1``
14549 Protection information is enabled, Type 1.
14550
14551 ``NVME_FORMAT_PI_TYPE2``
14552 Protection information is enabled, Type 2.
14553
14554 ``NVME_FORMAT_PI_TYPE3``
14555 Protection information is enabled, Type 3.
14556
14557
14558
14559
14560 .. c:type:: enum nvme_cmd_format_pil
14561
14562 Format NVM - Protection Information Location
14563
14564 **Constants**
14565
14566 ``NVME_FORMAT_PIL_LAST``
14567 Protection information is transferred as the last
14568 bytes of metadata.
14569
14570 ``NVME_FORMAT_PIL_FIRST``
14571 Protection information is transferred as the first
14572 bytes of metadata.
14573
14574
14575
14576
14577 .. c:type:: enum nvme_cmd_format_ses
14578
14579 Format NVM - Secure Erase Settings
14580
14581 **Constants**
14582
14583 ``NVME_FORMAT_SES_NONE``
14584 No secure erase operation requested.
14585
14586 ``NVME_FORMAT_SES_USER_DATA_ERASE``
14587 User Data Erase: All user data shall be erased,
14588 contents of the user data after the erase is
14589 indeterminate (e.g. the user data may be zero
14590 filled, one filled, etc.). If a User Data Erase
14591 is requested and all affected user data is
14592 encrypted, then the controller is allowed
14593 to use a cryptographic erase to perform
14594 the requested User Data Erase.
14595
14596 ``NVME_FORMAT_SES_CRYPTO_ERASE``
14597 Cryptographic Erase: All user data shall
14598 be erased cryptographically. This is
14599 accomplished by deleting the encryption key.
14600
14601
14602
14603
14604 .. c:type:: enum nvme_ns_mgmt_sel
14605
14606 Namespace Management - Select
14607
14608 **Constants**
14609
14610 ``NVME_NS_MGMT_SEL_CREATE``
14611 Namespace Create selection
14612
14613 ``NVME_NS_MGMT_SEL_DELETE``
14614 Namespace Delete selection
14615
14616
14617
14618
14619 .. c:type:: enum nvme_ns_attach_sel
14620
14621 Namespace Attachment - Select
14622
14623 **Constants**
14624
14625 ``NVME_NS_ATTACH_SEL_CTRL_ATTACH``
14626 Namespace attach selection
14627
14628 ``NVME_NS_ATTACH_SEL_CTRL_DEATTACH``
14629 Namespace detach selection
14630
14631
14632
14633
14634 .. c:type:: enum nvme_fw_commit_ca
14635
14636 Firmware Commit - Commit Action
14637
14638 **Constants**
14639
14640 ``NVME_FW_COMMIT_CA_REPLACE``
14641 Downloaded image replaces the existing
14642 image, if any, in the specified Firmware
14643 Slot. The newly placed image is not
14644 activated.
14645
14646 ``NVME_FW_COMMIT_CA_REPLACE_AND_ACTIVATE``
14647 Downloaded image replaces the existing
14648 image, if any, in the specified Firmware
14649 Slot. The newly placed image is activated
14650 at the next Controller Level Reset.
14651
14652 ``NVME_FW_COMMIT_CA_SET_ACTIVE``
14653 The existing image in the specified
14654 Firmware Slot is activated at the
14655 next Controller Level Reset.
14656
14657 ``NVME_FW_COMMIT_CA_REPLACE_AND_ACTIVATE_IMMEDIATE``
14658 Downloaded image replaces the existing
14659 image, if any, in the specified Firmware
14660 Slot and is then activated immediately.
14661 If there is not a newly downloaded image,
14662 then the existing image in the specified
14663 firmware slot is activated immediately.
14664
14665 ``NVME_FW_COMMIT_CA_REPLACE_BOOT_PARTITION``
14666 Downloaded image replaces the Boot
14667 Partition specified by the Boot
14668 Partition ID field.
14669
14670 ``NVME_FW_COMMIT_CA_ACTIVATE_BOOT_PARTITION``
14671 Mark the Boot Partition specified in
14672 the BPID field as active and update
14673 BPINFO.ABPID.
14674
14675
14676
14677
14678 .. c:type:: enum nvme_directive_dtype
14679
14680 Directive Types
14681
14682 **Constants**
14683
14684 ``NVME_DIRECTIVE_DTYPE_IDENTIFY``
14685 Identify directive type
14686
14687 ``NVME_DIRECTIVE_DTYPE_STREAMS``
14688 Streams directive type
14689
14690
14691
14692
14693 .. c:type:: enum nvme_directive_receive_doper
14694
14695 Directive Receive Directive Operation
14696
14697 **Constants**
14698
14699 ``NVME_DIRECTIVE_RECEIVE_IDENTIFY_DOPER_PARAM``
14700
14701 ``NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_PARAM``
14702
14703 ``NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_STATUS``
14704
14705 ``NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_RESOURCE``
14706
14707
14708
14709
14710 .. c:type:: enum nvme_directive_send_doper
14711
14712 Directive Send Directive Operation
14713
14714 **Constants**
14715
14716 ``NVME_DIRECTIVE_SEND_IDENTIFY_DOPER_ENDIR``
14717
14718 ``NVME_DIRECTIVE_SEND_STREAMS_DOPER_RELEASE_IDENTIFIER``
14719
14720 ``NVME_DIRECTIVE_SEND_STREAMS_DOPER_RELEASE_RESOURCE``
14721
14722
14723
14724
14725 .. c:type:: enum nvme_directive_send_identify_endir
14726
14727 Enable Directive
14728
14729 **Constants**
14730
14731 ``NVME_DIRECTIVE_SEND_IDENTIFY_ENDIR_DISABLE``
14732
14733 ``NVME_DIRECTIVE_SEND_IDENTIFY_ENDIR_ENABLE``
14734
14735
14736
14737
14738 .. c:type:: enum nvme_sanitize_sanact
14739
14740 Sanitize Action
14741
14742 **Constants**
14743
14744 ``NVME_SANITIZE_SANACT_EXIT_FAILURE``
14745 Exit Failure Mode.
14746
14747 ``NVME_SANITIZE_SANACT_START_BLOCK_ERASE``
14748 Start a Block Erase sanitize operation.
14749
14750 ``NVME_SANITIZE_SANACT_START_OVERWRITE``
14751 Start an Overwrite sanitize operation.
14752
14753 ``NVME_SANITIZE_SANACT_START_CRYPTO_ERASE``
14754 Start a Crypto Erase sanitize operation.
14755
14756 ``NVME_SANITIZE_SANACT_EXIT_MEDIA_VERIF``
14757 Exit Media Verification State
14758
14759
14760
14761
14762 .. c:type:: enum nvme_dst_stc
14763
14764 Action taken by the Device Self-test command
14765
14766 **Constants**
14767
14768 ``NVME_DST_STC_SHORT``
14769 Start a short device self-test operation
14770
14771 ``NVME_DST_STC_LONG``
14772 Start an extended device self-test operation
14773
14774 ``NVME_DST_STC_HOST_INIT``
14775 Start a Host-Initiated Refresh operation
14776
14777 ``NVME_DST_STC_VS``
14778 Start a vendor specific device self-test operation
14779
14780 ``NVME_DST_STC_ABORT``
14781 Abort device self-test operation
14782
14783
14784
14785
14786 .. c:type:: enum nvme_virt_mgmt_act
14787
14788 Virtualization Management - Action
14789
14790 **Constants**
14791
14792 ``NVME_VIRT_MGMT_ACT_PRIM_CTRL_FLEX_ALLOC``
14793 Primary Controller Flexible
14794 Allocation
14795
14796 ``NVME_VIRT_MGMT_ACT_OFFLINE_SEC_CTRL``
14797 Secondary Controller Offline
14798
14799 ``NVME_VIRT_MGMT_ACT_ASSIGN_SEC_CTRL``
14800 Secondary Controller Assign
14801
14802 ``NVME_VIRT_MGMT_ACT_ONLINE_SEC_CTRL``
14803 Secondary Controller Online
14804
14805
14806
14807
14808 .. c:type:: enum nvme_virt_mgmt_rt
14809
14810 Virtualization Management - Resource Type
14811
14812 **Constants**
14813
14814 ``NVME_VIRT_MGMT_RT_VQ_RESOURCE``
14815 VQ Resources
14816
14817 ``NVME_VIRT_MGMT_RT_VI_RESOURCE``
14818 VI Resources
14819
14820
14821
14822
14823 .. c:type:: enum nvme_ns_write_protect_cfg
14824
14825 Write Protection - Write Protection State
14826
14827 **Constants**
14828
14829 ``NVME_NS_WP_CFG_NONE``
14830 No Write Protect
14831
14832 ``NVME_NS_WP_CFG_PROTECT``
14833 Write Protect
14834
14835 ``NVME_NS_WP_CFG_PROTECT_POWER_CYCLE``
14836 Write Protect Until Power Cycle
14837
14838 ``NVME_NS_WP_CFG_PROTECT_PERMANENT``
14839 Permanent Write Protect
14840
14841
14842
14843
14844 .. c:type:: enum nvme_log_ana_lsp
14845
14846 Asymmetric Namespace Access - Return Groups Only
14847
14848 **Constants**
14849
14850 ``NVME_LOG_ANA_LSP_RGO_NAMESPACES``
14851
14852 ``NVME_LOG_ANA_LSP_RGO_GROUPS_ONLY``
14853
14854
14855
14856
14857 .. c:type:: enum nvme_log_phy_rx_eom_action
14858
14859 Physical Interface Receiver Eye Opening Measurement Action
14860
14861 **Constants**
14862
14863 ``NVME_LOG_PHY_RX_EOM_READ``
14864 Read Log Data
14865
14866 ``NVME_LOG_PHY_RX_EOM_START_READ``
14867 Start Measurement and Read Log Data
14868
14869 ``NVME_LOG_PHY_RX_EOM_ABORT_CLEAR``
14870 Abort Measurement and Clear Log Data
14871
14872
14873
14874
14875 .. c:type:: enum nvme_log_phy_rx_eom_quality
14876
14877 Physical Interface Receiver Eye Opening Measurement Quality
14878
14879 **Constants**
14880
14881 ``NVME_LOG_PHY_RX_EOM_GOOD``
14882 <= Better Quality
14883
14884 ``NVME_LOG_PHY_RX_EOM_BETTER``
14885 <= Best Quality, >= Good Quality
14886
14887 ``NVME_LOG_PHY_RX_EOM_BEST``
14888 >= Better Quality
14889
14890
14891
14892
14893 .. c:type:: enum nvme_pevent_log_action
14894
14895 Persistent Event Log - Action
14896
14897 **Constants**
14898
14899 ``NVME_PEVENT_LOG_READ``
14900 Read Log Data
14901
14902 ``NVME_PEVENT_LOG_EST_CTX_AND_READ``
14903 Establish Context and Read Log Data
14904
14905 ``NVME_PEVENT_LOG_RELEASE_CTX``
14906 Release Context
14907
14908
14909
14910
14911 .. c:type:: enum nvme_feat_tmpthresh_thsel
14912
14913 Temperature Threshold - Threshold Type Select
14914
14915 **Constants**
14916
14917 ``NVME_FEATURE_TEMPTHRESH_THSEL_OVER``
14918 Over temperature threshold select
14919
14920 ``NVME_FEATURE_TEMPTHRESH_THSEL_UNDER``
14921 Under temperature threshold select
14922
14923
14924
14925
14926 .. c:type:: enum nvme_features_async_event_config_flags
14927
14928 Asynchronous Event Configuration configuration flags
14929
14930 **Constants**
14931
14932 ``NVME_FEATURE_AENCFG_SMART_CRIT_SPARE``
14933
14934 ``NVME_FEATURE_AENCFG_SMART_CRIT_TEMPERATURE``
14935
14936 ``NVME_FEATURE_AENCFG_SMART_CRIT_DEGRADED``
14937
14938 ``NVME_FEATURE_AENCFG_SMART_CRIT_READ_ONLY``
14939
14940 ``NVME_FEATURE_AENCFG_SMART_CRIT_VOLATILE_BACKUP``
14941
14942 ``NVME_FEATURE_AENCFG_SMART_CRIT_READ_ONLY_PMR``
14943
14944 ``NVME_FEATURE_AENCFG_NOTICE_NAMESPACE_ATTRIBUTES``
14945
14946 ``NVME_FEATURE_AENCFG_NOTICE_FIRMWARE_ACTIVATION``
14947
14948 ``NVME_FEATURE_AENCFG_NOTICE_TELEMETRY_LOG``
14949
14950 ``NVME_FEATURE_AENCFG_NOTICE_ANA_CHANGE``
14951
14952 ``NVME_FEATURE_AENCFG_NOTICE_PL_EVENT``
14953
14954 ``NVME_FEATURE_AENCFG_NOTICE_LBA_STATUS``
14955
14956 ``NVME_FEATURE_AENCFG_NOTICE_EG_EVENT``
14957
14958 ``NVME_FEATURE_AENCFG_NOTICE_DISCOVERY_CHANGE``
14959
14960
14961
14962
14963 .. c:type:: enum nvme_feat_plm_window_select
14964
14965 Predictable Latency Per NVM Set Log
14966
14967 **Constants**
14968
14969 ``NVME_FEATURE_PLM_DTWIN``
14970 Deterministic Window select
14971
14972 ``NVME_FEATURE_PLM_NDWIN``
14973 Non-Deterministic Window select
14974
14975
14976
14977
14978 .. c:type:: enum nvme_feat_resv_notify_flags
14979
14980 Reservation Notification Configuration
14981
14982 **Constants**
14983
14984 ``NVME_FEAT_RESV_NOTIFY_REGPRE``
14985 Mask Registration Preempted Notification
14986
14987 ``NVME_FEAT_RESV_NOTIFY_RESREL``
14988 Mask Reservation Released Notification
14989
14990 ``NVME_FEAT_RESV_NOTIFY_RESPRE``
14991 Mask Reservation Preempted Notification
14992
14993
14994
14995
14996 .. c:type:: enum nvme_feat_nswpcfg_state
14997
14998 Write Protection - Write Protection State
14999
15000 **Constants**
15001
15002 ``NVME_FEAT_NS_NO_WRITE_PROTECT``
15003 No Write Protect
15004
15005 ``NVME_FEAT_NS_WRITE_PROTECT``
15006 Write Protect
15007
15008 ``NVME_FEAT_NS_WRITE_PROTECT_PWR_CYCLE``
15009 Write Protect Until Power Cycle
15010
15011 ``NVME_FEAT_NS_WRITE_PROTECT_PERMANENT``
15012 Permanent Write Protect
15013
15014
15015
15016
15017 .. c:type:: enum nvme_feat_perfc_attri
15018
15019 performance characteristics attribute index
15020
15021 **Constants**
15022
15023 ``NVME_FEAT_PERFC_ATTRI_STD``
15024 standard performance attribute
15025
15026 ``NVME_FEAT_PERFC_ATTRI_ID_LIST``
15027 performance attribute identifier list
15028
15029 ``NVME_FEAT_PERFC_ATTRI_VS_MIN``
15030 vendor specific performance attribute minimum index
15031
15032 ``NVME_FEAT_PERFC_ATTRI_VS_MAX``
15033 vendor specific performance attribute maximum index
15034
15035
15036
15037
15038 .. c:type:: enum nvme_feat_perfc_r4karl
15039
15040 standard performance attribute random 4 kib average latency
15041
15042 **Constants**
15043
15044 ``NVME_FEAT_PERFC_R4KARL_NO_REPORT``
15045 not reported
15046
15047 ``NVME_FEAT_PERFC_R4KARL_GE_100_SEC``
15048 greater than or equal to 100 secs
15049
15050 ``NVME_FEAT_PERFC_R4KARL_GE_50_SEC``
15051 greater than or equal to 50 secs and less than 100 secs
15052
15053 ``NVME_FEAT_PERFC_R4KARL_GE_10_SEC``
15054 greater than or equal to 10 secs and less than 50 secs
15055
15056 ``NVME_FEAT_PERFC_R4KARL_GE_5_SEC``
15057 greater than or equal to 5 secs and less than 10 secs
15058
15059 ``NVME_FEAT_PERFC_R4KARL_GE_1_SEC``
15060 greater than or equal to 1 sec and less than 5 secs
15061
15062 ``NVME_FEAT_PERFC_R4KARL_GE_500_MS``
15063 greater than or equal to 500 msecs and less than 1 sec
15064
15065 ``NVME_FEAT_PERFC_R4KARL_GE_100_MS``
15066 greater than or equal to 100 msecs and less than 500 msecs
15067
15068 ``NVME_FEAT_PERFC_R4KARL_GE_50_MS``
15069 greater than or equal to 50 msecs and less than 100 msecs
15070
15071 ``NVME_FEAT_PERFC_R4KARL_GE_10_MS``
15072 greater than or equal to 10 msecs and less than 50 msecs
15073
15074 ``NVME_FEAT_PERFC_R4KARL_GE_5_MS``
15075 greater than or equal to 5 msecs and less than 10 msecs
15076
15077 ``NVME_FEAT_PERFC_R4KARL_GE_1_MS``
15078 greater than or equal to 1 msec and less than 5 msecs
15079
15080 ``NVME_FEAT_PERFC_R4KARL_GE_500_US``
15081 greater than or equal to 500 usecs and less than 1 msec
15082
15083 ``NVME_FEAT_PERFC_R4KARL_GE_100_US``
15084 greater than or equal to 100 usecs and less than 500 usecs
15085
15086 ``NVME_FEAT_PERFC_R4KARL_GE_50_US``
15087 greater than or equal to 50 usecs and less than 100 usecs
15088
15089 ``NVME_FEAT_PERFC_R4KARL_GE_10_US``
15090 greater than or equal to 10 usecs and less than 50 usecs
15091
15092 ``NVME_FEAT_PERFC_R4KARL_GE_5_US``
15093 greater than or equal to 5 usecs and less than 10 usecs
15094
15095 ``NVME_FEAT_PERFC_R4KARL_GE_1_US``
15096 greater than or equal to 1 usec and less than 5 usecs
15097
15098 ``NVME_FEAT_PERFC_R4KARL_GE_500_NS``
15099 greater than or equal to 500 nsecs and less than 1 usec
15100
15101 ``NVME_FEAT_PERFC_R4KARL_GE_100_NS``
15102 greater than or equal to 100 nsecs and less than 500 nsecs
15103
15104 ``NVME_FEAT_PERFC_R4KARL_GE_50_NS``
15105 greater than or equal to 50 nsecs and less than 100 nsecs
15106
15107 ``NVME_FEAT_PERFC_R4KARL_GE_10_NS``
15108 greater than or equal to 10 nsecs and less than 50 nsecs
15109
15110 ``NVME_FEAT_PERFC_R4KARL_GE_5_NS``
15111 greater than or equal to 5 nsecs and less than 10 nsecs
15112
15113 ``NVME_FEAT_PERFC_R4KARL_GE_1_NS``
15114 greater than or equal to 1 nsec and less than 5 nsecs
15115
15116
15117
15118
15119 .. c:type:: enum nvme_feat_bpwp_state
15120
15121 Boot Partition Write Protection State
15122
15123 **Constants**
15124
15125 ``NVME_FEAT_BPWPS_CHANGE_NOT_REQUESTED``
15126 Change in state not requested
15127
15128 ``NVME_FEAT_BPWPS_WRITE_UNLOCKED``
15129 Write Unlocked
15130
15131 ``NVME_FEAT_BPWPS_WRITE_LOCKED``
15132 Write Locked
15133
15134 ``NVME_FEAT_BPWPS_WRITE_LOCKED_PWR_CYCLE``
15135 Write Locked Until Power Cycle
15136
15137 ``NVME_FEAT_BPWPS_WRITE_PROTECTION_RPMB``
15138 Write Protection controlled by RPMB
15139
15140
15141
15142
15143 .. c:type:: enum nvme_fctype
15144
15145 Fabrics Command Types
15146
15147 **Constants**
15148
15149 ``nvme_fabrics_type_property_set``
15150 Property set
15151
15152 ``nvme_fabrics_type_connect``
15153 Connect
15154
15155 ``nvme_fabrics_type_property_get``
15156 Property Get
15157
15158 ``nvme_fabrics_type_auth_send``
15159 Authentication Send
15160
15161 ``nvme_fabrics_type_auth_receive``
15162 Authentication Receive
15163
15164 ``nvme_fabrics_type_disconnect``
15165 Disconnect
15166
15167
15168
15169
15170 .. c:type:: enum nvme_data_tfr
15171
15172 Data transfer direction of the command
15173
15174 **Constants**
15175
15176 ``NVME_DATA_TFR_NO_DATA_TFR``
15177 No data transfer
15178
15179 ``NVME_DATA_TFR_HOST_TO_CTRL``
15180 Host to controller
15181
15182 ``NVME_DATA_TFR_CTRL_TO_HOST``
15183 Controller to host
15184
15185 ``NVME_DATA_TFR_BIDIRECTIONAL``
15186 Bidirectional
15187
15188
15189
15190
15191 .. c:type:: enum nvme_io_opcode
15192
15193 Opcodes for I/O Commands
15194
15195 **Constants**
15196
15197 ``nvme_cmd_flush``
15198 Flush
15199
15200 ``nvme_cmd_write``
15201 Write
15202
15203 ``nvme_cmd_read``
15204 Read
15205
15206 ``nvme_cmd_write_uncor``
15207 Write Uncorrectable
15208
15209 ``nvme_cmd_compare``
15210 Compare
15211
15212 ``nvme_cmd_write_zeroes``
15213 write Zeros
15214
15215 ``nvme_cmd_dsm``
15216 Dataset Management
15217
15218 ``nvme_cmd_verify``
15219 Verify
15220
15221 ``nvme_cmd_resv_register``
15222 Reservation Register
15223
15224 ``nvme_cmd_resv_report``
15225 Reservation Report
15226
15227 ``nvme_cmd_resv_acquire``
15228 Reservation Acquire
15229
15230 ``nvme_cmd_io_mgmt_recv``
15231 I/O Management Receive
15232
15233 ``nvme_cmd_resv_release``
15234 Reservation Release
15235
15236 ``nvme_cmd_cancel``
15237 Cancel
15238
15239 ``nvme_cmd_copy``
15240 Copy
15241
15242 ``nvme_cmd_io_mgmt_send``
15243 I/O Management Send
15244
15245 ``nvme_zns_cmd_mgmt_send``
15246 Zone Management Send
15247
15248 ``nvme_zns_cmd_mgmt_recv``
15249 Zone Management Receive
15250
15251 ``nvme_zns_cmd_append``
15252 Zone Append
15253
15254 ``nvme_cmd_fabric``
15255 Fabric Commands
15256
15257
15258
15259
15260 .. c:type:: enum nvme_kv_opcode
15261
15262 Opcodes for KV Commands
15263
15264 **Constants**
15265
15266 ``nvme_kv_cmd_flush``
15267 Flush
15268
15269 ``nvme_kv_cmd_store``
15270 Store
15271
15272 ``nvme_kv_cmd_retrieve``
15273 Retrieve
15274
15275 ``nvme_kv_cmd_list``
15276 List
15277
15278 ``nvme_kv_cmd_resv_register``
15279 Reservation Register
15280
15281 ``nvme_kv_cmd_resv_report``
15282 Reservation Report
15283
15284 ``nvme_kv_cmd_delete``
15285 Delete
15286
15287 ``nvme_kv_cmd_resv_acquire``
15288 Reservation Acquire
15289
15290 ``nvme_kv_cmd_exist``
15291 Exist
15292
15293 ``nvme_kv_cmd_resv_release``
15294 Reservation Release
15295
15296
15297
15298
15299 .. c:type:: enum nvme_io_control_flags
15300
15301 I/O control flags
15302
15303 **Constants**
15304
15305 ``NVME_IO_DTYPE_STREAMS``
15306 Directive Type Streams
15307
15308 ``NVME_IO_NSZ``
15309 Namespace Zeroes
15310
15311 ``NVME_IO_STC``
15312 Storage Tag Check
15313
15314 ``NVME_IO_DEAC``
15315 Deallocate
15316
15317 ``NVME_IO_ZNS_APPEND_PIREMAP``
15318 Protection Information Remap
15319
15320 ``NVME_IO_PRINFO_PRCHK_REF``
15321 Protection Information Check Reference Tag
15322
15323 ``NVME_IO_PRINFO_PRCHK_APP``
15324 Protection Information Check Application Tag
15325
15326 ``NVME_IO_PRINFO_PRCHK_GUARD``
15327 Protection Information Check Guard field
15328
15329 ``NVME_IO_PRINFO_PRACT``
15330 Protection Information Action
15331
15332 ``NVME_IO_FUA``
15333 Force Unit Access
15334
15335 ``NVME_IO_LR``
15336 Limited Retry
15337
15338
15339
15340
15341 .. c:type:: enum nvme_io_dsm_flags
15342
15343 Dataset Management flags
15344
15345 **Constants**
15346
15347 ``NVME_IO_DSM_FREQ_UNSPEC``
15348 No frequency information provided
15349
15350 ``NVME_IO_DSM_FREQ_TYPICAL``
15351 Typical number of reads and writes
15352 expected for this LBA range
15353
15354 ``NVME_IO_DSM_FREQ_RARE``
15355 Infrequent writes and infrequent
15356 reads to the LBA range indicated
15357
15358 ``NVME_IO_DSM_FREQ_READS``
15359 Infrequent writes and frequent
15360 reads to the LBA range indicated
15361
15362 ``NVME_IO_DSM_FREQ_WRITES``
15363 Frequent writes and infrequent
15364 reads to the LBA range indicated
15365
15366 ``NVME_IO_DSM_FREQ_RW``
15367 Frequent writes and frequent reads
15368 to the LBA range indicated
15369
15370 ``NVME_IO_DSM_FREQ_ONCE``
15371
15372 ``NVME_IO_DSM_FREQ_PREFETCH``
15373
15374 ``NVME_IO_DSM_FREQ_TEMP``
15375
15376 ``NVME_IO_DSM_LATENCY_NONE``
15377 No latency information provided
15378
15379 ``NVME_IO_DSM_LATENCY_IDLE``
15380 Longer latency acceptable
15381
15382 ``NVME_IO_DSM_LATENCY_NORM``
15383 Typical latency
15384
15385 ``NVME_IO_DSM_LATENCY_LOW``
15386 Smallest possible latency
15387
15388 ``NVME_IO_DSM_SEQ_REQ``
15389
15390 ``NVME_IO_DSM_COMPRESSED``
15391
15392
15393
15394
15395 .. c:type:: enum nvme_dsm_attributes
15396
15397 Dataset Management attributes
15398
15399 **Constants**
15400
15401 ``NVME_DSMGMT_IDR``
15402 Attribute -Integral Dataset for Read
15403
15404 ``NVME_DSMGMT_IDW``
15405 Attribute - Integral Dataset for Write
15406
15407 ``NVME_DSMGMT_AD``
15408 Attribute - Deallocate
15409
15410
15411
15412
15413 .. c:type:: enum nvme_resv_rtype
15414
15415 Reservation Type Encoding
15416
15417 **Constants**
15418
15419 ``NVME_RESERVATION_RTYPE_WE``
15420 Write Exclusive Reservation
15421
15422 ``NVME_RESERVATION_RTYPE_EA``
15423 Exclusive Access Reservation
15424
15425 ``NVME_RESERVATION_RTYPE_WERO``
15426 Write Exclusive - Registrants Only Reservation
15427
15428 ``NVME_RESERVATION_RTYPE_EARO``
15429 Exclusive Access - Registrants Only Reservation
15430
15431 ``NVME_RESERVATION_RTYPE_WEAR``
15432 Write Exclusive - All Registrants Reservation
15433
15434 ``NVME_RESERVATION_RTYPE_EAAR``
15435 Exclusive Access - All Registrants Reservation
15436
15437
15438
15439
15440 .. c:type:: enum nvme_resv_racqa
15441
15442 Reservation Acquire - Reservation Acquire Action
15443
15444 **Constants**
15445
15446 ``NVME_RESERVATION_RACQA_ACQUIRE``
15447 Acquire
15448
15449 ``NVME_RESERVATION_RACQA_PREEMPT``
15450 Preempt
15451
15452 ``NVME_RESERVATION_RACQA_PREEMPT_AND_ABORT``
15453 Preempt and Abort
15454
15455
15456
15457
15458 .. c:type:: enum nvme_resv_rrega
15459
15460 Reservation Register - Reservation Register Action
15461
15462 **Constants**
15463
15464 ``NVME_RESERVATION_RREGA_REGISTER_KEY``
15465 Register Reservation Key
15466
15467 ``NVME_RESERVATION_RREGA_UNREGISTER_KEY``
15468 Unregister Reservation Key
15469
15470 ``NVME_RESERVATION_RREGA_REPLACE_KEY``
15471 Replace Reservation Key
15472
15473
15474
15475
15476 .. c:type:: enum nvme_resv_cptpl
15477
15478 Reservation Register - Change Persist Through Power Loss State
15479
15480 **Constants**
15481
15482 ``NVME_RESERVATION_CPTPL_NO_CHANGE``
15483 No change to PTPL state
15484
15485 ``NVME_RESERVATION_CPTPL_CLEAR``
15486 Reservations are released and
15487 registrants are cleared on a power on
15488
15489 ``NVME_RESERVATION_CPTPL_PERSIST``
15490 Reservations and registrants persist
15491 across a power loss
15492
15493
15494
15495
15496 .. c:type:: enum nvme_resv_rrela
15497
15498 Reservation Release - Reservation Release Action
15499
15500 **Constants**
15501
15502 ``NVME_RESERVATION_RRELA_RELEASE``
15503 Release
15504
15505 ``NVME_RESERVATION_RRELA_CLEAR``
15506 Clear
15507
15508
15509
15510
15511 .. c:type:: enum nvme_zns_send_action
15512
15513 Zone Management Send - Zone Send Action
15514
15515 **Constants**
15516
15517 ``NVME_ZNS_ZSA_CLOSE``
15518 Close Zone
15519
15520 ``NVME_ZNS_ZSA_FINISH``
15521 Finish Zone
15522
15523 ``NVME_ZNS_ZSA_OPEN``
15524 Open Zone
15525
15526 ``NVME_ZNS_ZSA_RESET``
15527 Reset Zone
15528
15529 ``NVME_ZNS_ZSA_OFFLINE``
15530 Offline Zone
15531
15532 ``NVME_ZNS_ZSA_SET_DESC_EXT``
15533 Set Zone Descriptor Extension
15534
15535 ``NVME_ZNS_ZSA_ZRWA_FLUSH``
15536 Flush
15537
15538
15539
15540
15541 .. c:type:: enum nvme_zns_recv_action
15542
15543 Zone Management Receive - Zone Receive Action Specific Features
15544
15545 **Constants**
15546
15547 ``NVME_ZNS_ZRA_REPORT_ZONES``
15548 Report Zones
15549
15550 ``NVME_ZNS_ZRA_EXTENDED_REPORT_ZONES``
15551 Extended Report Zones
15552
15553
15554
15555
15556 .. c:type:: enum nvme_zns_report_options
15557
15558 Zone Management Receive - Zone Receive Action Specific Field
15559
15560 **Constants**
15561
15562 ``NVME_ZNS_ZRAS_REPORT_ALL``
15563 List all zones
15564
15565 ``NVME_ZNS_ZRAS_REPORT_EMPTY``
15566 List the zones in the ZSE:Empty state
15567
15568 ``NVME_ZNS_ZRAS_REPORT_IMPL_OPENED``
15569 List the zones in the ZSIO:Implicitly Opened state
15570
15571 ``NVME_ZNS_ZRAS_REPORT_EXPL_OPENED``
15572 List the zones in the ZSEO:Explicitly Opened state
15573
15574 ``NVME_ZNS_ZRAS_REPORT_CLOSED``
15575 List the zones in the ZSC:Closed state
15576
15577 ``NVME_ZNS_ZRAS_REPORT_FULL``
15578 List the zones in the ZSF:Full state
15579
15580 ``NVME_ZNS_ZRAS_REPORT_READ_ONLY``
15581 List the zones in the ZSRO:Read Only state
15582
15583 ``NVME_ZNS_ZRAS_REPORT_OFFLINE``
15584 List the zones in the ZSO:Offline state
15585
15586
15587
15588
15589 .. c:type:: enum nvme_io_mgmt_recv_mo
15590
15591 I/O Management Receive - Management Operation
15592
15593 **Constants**
15594
15595 ``NVME_IO_MGMT_RECV_RUH_STATUS``
15596 Reclaim Unit Handle Status
15597
15598
15599
15600
15601 .. c:type:: enum nvme_io_mgmt_send_mo
15602
15603 I/O Management Send - Management Operation
15604
15605 **Constants**
15606
15607 ``NVME_IO_MGMT_SEND_RUH_UPDATE``
15608 Reclaim Unit Handle Update
15609
15610
15611
15612
15613 .. c:type:: struct nvme_ns_mgmt_host_sw_specified
15614
15615 Namespace management Host Software Specified Fields.
15616
15617 **Definition**
15618
15619 ::
15620
15621 struct nvme_ns_mgmt_host_sw_specified {
15622 __le64 nsze;
15623 __le64 ncap;
15624 __u8 rsvd16[10];
15625 __u8 flbas;
15626 __u8 rsvd27[2];
15627 __u8 dps;
15628 __u8 nmic;
15629 __u8 rsvd31[61];
15630 __le32 anagrpid;
15631 __u8 rsvd96[4];
15632 __le16 nvmsetid;
15633 __le16 endgid;
15634 __u8 rsvd104[280];
15635 __le64 lbstm;
15636 __le16 nphndls;
15637 __u8 rsvd394[105];
15638 union {
15639 __u8 rsvd499[13];
15640 struct {
15641 __u8 znsco;
15642 __le32 rar;
15643 __le32 ror;
15644 __le32 rnumzrwa;
15645 } zns;
15646 };
15647 __le16 phndl[128];
15648 __u8 rsvd768[3328];
15649 };
15650
15651 **Members**
15652
15653 ``nsze``
15654 Namespace Size indicates the total size of the namespace in
15655 logical blocks. The number of logical blocks is based on the
15656 formatted LBA size.
15657
15658 ``ncap``
15659 Namespace Capacity indicates the maximum number of logical blocks
15660 that may be allocated in the namespace at any point in time. The
15661 number of logical blocks is based on the formatted LBA size.
15662
15663 ``rsvd16``
15664 Reserved
15665
15666 ``flbas``
15667 Formatted LBA Size, see :c:type:`enum nvme_id_ns_flbas <nvme_id_ns_flbas>`.
15668
15669 ``rsvd27``
15670 Reserved
15671
15672 ``dps``
15673 End-to-end Data Protection Type Settings, see
15674 :c:type:`enum nvme_id_ns_dps <nvme_id_ns_dps>`.
15675
15676 ``nmic``
15677 Namespace Multi-path I/O and Namespace Sharing Capabilities, see
15678 :c:type:`enum nvme_id_ns_nmic <nvme_id_ns_nmic>`.
15679
15680 ``rsvd31``
15681 Reserved
15682
15683 ``anagrpid``
15684 ANA Group Identifier indicates the ANA Group Identifier of the
15685 ANA group of which the namespace is a member.
15686
15687 ``rsvd96``
15688 Reserved
15689
15690 ``nvmsetid``
15691 NVM Set Identifier indicates the NVM Set with which this
15692 namespace is associated.
15693
15694 ``endgid``
15695 Endurance Group Identifier indicates the Endurance Group with
15696 which this namespace is associated.
15697
15698 ``rsvd104``
15699 Reserved
15700
15701 ``lbstm``
15702 Logical Block Storage Tag Mask Identifies the mask for the
15703 Storage Tag field for the protection information
15704
15705 ``nphndls``
15706 Number of Placement Handles specifies the number of Placement
15707 Handles included in the Placement Handle List
15708
15709 ``rsvd394``
15710 Reserved
15711
15712 ``{unnamed_union}``
15713 anonymous
15714
15715 ``rsvd499``
15716 Reserved for I/O Command Sets that extend this specification.
15717
15718 ``zns``
15719 rsvd499( Zoned Namespace Command Set specific field )
15720
15721 ``phndl``
15722 Placement Handle Associated RUH : This field specifies the Reclaim
15723 Unit Handle Identifier to be associated with the Placement Handle
15724 value. If the Flexible Data Placement capability is not supported or
15725 not enabled in specified Endurance Group, then the controller shall
15726 ignore this field.
15727
15728 ``rsvd768``
15729 Reserved
15730
15731
15732
15733
15734
15735 .. c:type:: enum nvme_lm_cdq_fields
15736
15737 Controller Data Queue command fields
15738
15739 **Constants**
15740
15741 ``NVME_LM_CDQ_MOS_SHIFT``
15742 Shift to set Management Operation Specific (MOS) field
15743
15744 ``NVME_LM_CDQ_MOS_MASK``
15745 Mask to set MOS field
15746
15747 ``NVME_LM_CDQ_SEL_SHIFT``
15748 Shift to set Select (SEL) field
15749
15750 ``NVME_LM_CDQ_SEL_MASK``
15751 Mask to set SEL field
15752
15753 ``NVME_LM_SEL_CREATE_CDQ``
15754 Create CDQ select option
15755
15756 ``NVME_LM_SEL_DELETE_CDQ``
15757 Delete CDQ select option
15758
15759 ``NVME_LM_QT_SHIFT``
15760 Shift amount to set Queue Type (QT) field relative to MOS
15761
15762 ``NVME_LM_QT_MASK``
15763 Mask to set QT field relative to MOS
15764
15765 ``NVME_LM_CQS_SHIFT``
15766 Shift amount for Create Queue Specific (CQS) field
15767
15768 ``NVME_LM_CQS_MASK``
15769 Mask to set CQS field
15770
15771 ``NVME_LM_QT_USER_DATA_MIGRATION_QUEUE``
15772 User Data Migration Queue type
15773
15774 ``NVME_LM_CREATE_CDQ_PC``
15775 Physically Contiguous (PC)
15776
15777 ``NVME_LM_CREATE_CDQ_CNTLID_SHIFT``
15778 Shift amount to set CNTLID field relative to MOS
15779
15780 ``NVME_LM_CREATE_CDQ_CNTLID_MASK``
15781 Mask to set CNTLID field relative to MOS
15782
15783 ``NVME_LM_DELETE_CDQ_CDQID_SHIFT``
15784 Shift amount to set CDQID field for deletion
15785
15786 ``NVME_LM_DELETE_CDQ_CDQID_MASK``
15787 Mask to set CDQID field for deletion
15788
15789 ``NVME_LM_CREATE_CDQ_CDQID_SHIFT``
15790 Shift amount to get CDQID field from Create response in
15791 completion dword0
15792
15793 ``NVME_LM_CREATE_CDQ_CDQID_MASK``
15794 Mask to get CNTLID field from Create response in
15795 completion dword0
15796
15797
15798
15799
15800 .. c:type:: enum nvme_lm_track_send_fields
15801
15802 Track Send command fields
15803
15804 **Constants**
15805
15806 ``NVME_LM_TRACK_SEND_MOS_SHIFT``
15807 Shift to set Management Operation Specific (MOS) field
15808
15809 ``NVME_LM_TRACK_SEND_MOS_MASK``
15810 Mask to set MOS field
15811
15812 ``NVME_LM_TRACK_SEND_SEL_SHIFT``
15813 Shift to set Select (SEL) field
15814
15815 ``NVME_LM_TRACK_SEND_SEL_MASK``
15816 Mask to set SEL field
15817
15818 ``NVME_LM_SEL_LOG_USER_DATA_CHANGES``
15819 Log User Data Changes select option
15820
15821 ``NVME_LM_SEL_TRACK_MEMORY_CHANGES``
15822 Track Memory Changes select option
15823
15824 ``NVME_LM_LACT_SHIFT``
15825 Shift to set Logging Action (LACT) relative to MOS
15826
15827 ``NVME_LM_LACT_MASK``
15828 Mask to set LACT relative to MOS
15829
15830 ``NVME_LM_LACT_STOP_LOGGING``
15831 The controller shall stop logging user data changes to
15832 namespaces attached to the controller associated with the
15833 User Data Migration Queue specified in the CDQ ID.
15834
15835 ``NVME_LM_LACT_START_LOGGING``
15836 The controller shall start logging user data changes to
15837 namespaces attached to the controller associated with the
15838 User Data Migration Queue into that User Data Migration
15839 Queue where those user data changes are caused by the
15840 controller associated with that User Data Migration Queue
15841 processing commands.
15842
15843
15844
15845
15846 .. c:type:: enum nvme_lm_migration_send_fields
15847
15848 Migration Send command fields
15849
15850 **Constants**
15851
15852 ``NVME_LM_MIGRATION_SEND_MOS_SHIFT``
15853 Shift to set Management Operation Specific (MOS)
15854 field
15855
15856 ``NVME_LM_MIGRATION_SEND_MOS_MASK``
15857 Mask to set MOS field
15858
15859 ``NVME_LM_MIGRATION_SEND_SEL_SHIFT``
15860 Shift amount to set Select (SEL) field
15861
15862 ``NVME_LM_MIGRATION_SEND_SEL_MASK``
15863 Mask to set SEL field
15864
15865 ``NVME_LM_SEL_SUSPEND``
15866 Migration Send - Suspend
15867
15868 ``NVME_LM_SEL_RESUME``
15869 Migration Send - Resume
15870
15871 ``NVME_LM_SEL_SET_CONTROLLER_STATE``
15872 Migration Send - Set Controller State
15873
15874 ``NVME_LM_MIGRATION_SEND_UIDX_SHIFT``
15875 Shift to set UUID Index (UIDX)
15876
15877 ``NVME_LM_MIGRATION_SEND_UIDX_MASK``
15878 Mask to set UIDX
15879
15880 ``NVME_LM_DUDMQ``
15881 Delete User Data Migration Queue
15882
15883 ``NVME_LM_STYPE_SHIFT``
15884 Shift amount to set Suspend Type (STYPE)
15885
15886 ``NVME_LM_STYPE_MASK``
15887 Mask to set STYPE
15888
15889 ``NVME_LM_STYPE_SUSPEND_NOTIFICATION``
15890 Suspend Notification - The specified controller is
15891 going to be suspended in the future with a
15892 subsequent Migration Send command
15893
15894 ``NVME_LM_STYPE_SUSPEND``
15895 Suspend - Suspend the controller
15896
15897 ``NVME_LM_SUSPEND_CNTLID_SHIFT``
15898 Shift amount to set Controller ID (CNTLID) when SEL
15899 is Suspend
15900
15901 ``NVME_LM_SUSPEND_CNTLID_MASK``
15902 Mask to set CNTLID with SEL Suspend
15903
15904 ``NVME_LM_RESUME_CNTLID_SHIFT``
15905 Shift amount to set Controller ID (CNTLID) when SEL
15906 is Resume
15907
15908 ``NVME_LM_RESUME_CNTLID_MASK``
15909 Mask to set CNTLID when SEL is Resume
15910
15911 ``NVME_LM_SEQIND_SHIFT``
15912 Shift amount to set Sequence Indicator (SEQIND)
15913 field relative to MOS
15914
15915 ``NVME_LM_SEQIND_MASK``
15916 Mask to set SEQIND field relative to MOS
15917
15918 ``NVME_LM_SEQIND_NOT_FIRST_NOT_LAST``
15919 This command is not the first or last of a sequence
15920 of two or more Migration Send commands with this
15921 management operation used to transfer the controller
15922 state from host to controller
15923
15924 ``NVME_LM_SEQIND_FIRST``
15925 This command is the first of a sequence of two or
15926 more Migration Send commands
15927
15928 ``NVME_LM_SEQIND_LAST``
15929 This command is the last command of a sequence of
15930 two or more Migration Send commands
15931
15932 ``NVME_LM_SEQIND_ENTIRE``
15933 This Migration Send command is the only command and
15934 contains the entire controller state for this
15935 management operation
15936
15937 ``NVME_LM_SET_CONTROLLER_STATE_CSUUIDI_SHIFT``
15938 Shift amount to set Controller State UUID Index
15939 (CSUUIDI)
15940
15941 ``NVME_LM_SET_CONTROLLER_STATE_CSUUIDI_MASK``
15942 Mask to set CSUUIDI
15943
15944 ``NVME_LM_SET_CONTROLLER_STATE_CSVI_SHIFT``
15945 Shift amount to set Controller State Version Index
15946 (CSVI)
15947
15948 ``NVME_LM_SET_CONTROLLER_STATE_CSVI_MASK``
15949 Mask to set CSVI
15950
15951 ``NVME_LM_SET_CONTROLLER_STATE_CNTLID_SHIFT``
15952 Shift amount to set Controller ID (CNTLID) when SEL
15953 is Set Controller State
15954
15955 ``NVME_LM_SET_CONTROLLER_STATE_CNTLID_MASK``
15956 Mask to set CNTLID when SEL is Set Controller State
15957
15958
15959
15960
15961 .. c:type:: enum nvme_lm_migration_recv_fields
15962
15963 Migration Receive command fields
15964
15965 **Constants**
15966
15967 ``NVME_LM_MIGRATION_RECV_MOS_SHIFT``
15968 Shift amount to set Management Specific Operation
15969 (MOS) field
15970
15971 ``NVME_LM_MIGRATION_RECV_MOS_MASK``
15972 Mask to set MOS field
15973
15974 ``NVME_LM_MIGRATION_RECV_SEL_SHIFT``
15975 Shift amount to set Select (SEL) field
15976
15977 ``NVME_LM_MIGRATION_RECV_SEL_MASK``
15978 Mask to set SEL field
15979
15980 ``NVME_LM_SEL_GET_CONTROLLER_STATE``
15981 Get Controller State select option
15982
15983 ``NVME_LM_MIGRATION_RECV_UIDX_SHIFT``
15984 Shift to set UUID Index (UIDX)
15985
15986 ``NVME_LM_MIGRATION_RECV_UIDX_MASK``
15987 Mask to set UIDX
15988
15989 ``NVME_LM_GET_CONTROLLER_STATE_CSVI_SHIFT``
15990 Shift amount to set Controller State Version Index
15991 (CSVI) relative to MOS
15992
15993 ``NVME_LM_GET_CONTROLLER_STATE_CSVI_MASK``
15994 Mask to set CSVI relative to MOS
15995
15996 ``NVME_LM_GET_CONTROLLER_STATE_CSUIDXP_SHIFT``
15997 Shift amount to set Controller State UUID Index
15998 Parameter (CSUIDXP)
15999
16000 ``NVME_LM_GET_CONTROLLER_STATE_CSUIDXP_MASK``
16001 Mask to set CSUIDXP
16002
16003 ``NVME_LM_GET_CONTROLLER_STATE_CSUUIDI_SHIFT``
16004 Shift amount to set Controller State UUID Index
16005 (CSUUIDI)
16006
16007 ``NVME_LM_GET_CONTROLLER_STATE_CSUUIDI_MASK``
16008 Mask to set CSUUIDI
16009
16010 ``NVME_LM_GET_CONTROLLER_STATE_CNTLID_SHIFT``
16011 Shift amount to set Controller ID (CNTLID)
16012
16013 ``NVME_LM_GET_CONTROLLER_STATE_CNTLID_MASK``
16014 Mask to set CNTLID
16015
16016 ``NVME_LM_GET_CONTROLLER_STATE_CSUP``
16017 Controller Suspended
16018
16019
16020
16021
16022 .. c:type:: struct nvme_lm_io_submission_queue_data
16023
16024 I/O Submission Queue data structure. Fields related to the contents of Create I/O Submission Queue command that created an I/O Submission Queue.
16025
16026 **Definition**
16027
16028 ::
16029
16030 struct nvme_lm_io_submission_queue_data {
16031 __le64 iosqprp1;
16032 __le16 iosqqsize;
16033 __le16 iosqqid;
16034 __le16 iosqcqid;
16035 __le16 iosqa;
16036 __le16 iosqhp;
16037 __le16 iosqtp;
16038 __u8 rsvd20[4];
16039 };
16040
16041 **Members**
16042
16043 ``iosqprp1``
16044 I/O Submission PRP Entry 1 (IOSQPRP1)
16045
16046 ``iosqqsize``
16047 I/O Submission Queue Size (IOSQQSIZE)
16048
16049 ``iosqqid``
16050 I/O Submission Queue Identifier (IOSQQID)
16051
16052 ``iosqcqid``
16053 I/O Completion Queue Identifier (IOSQCQID)
16054
16055 ``iosqa``
16056 I/O Submission Queue Attributes (IOSQA)
16057
16058 ``iosqhp``
16059 I/O Submission Queue Head Pointer (IOSQHP)
16060
16061 ``iosqtp``
16062 I/O Submission Queue Tail Pointer (IOSQTP)
16063
16064 ``rsvd20``
16065 Reserved
16066
16067
16068
16069
16070
16071 .. c:type:: struct nvme_lm_io_completion_queue_data
16072
16073 I/O Completion Queue data structure. Fields related to the contents of Create I/O Completion Queue command that created an I/O Completion Queue.
16074
16075 **Definition**
16076
16077 ::
16078
16079 struct nvme_lm_io_completion_queue_data {
16080 __le64 iocqprp1;
16081 __le16 iocqqsize;
16082 __le16 iocqqid;
16083 __le16 iocqhp;
16084 __le16 iocqtp;
16085 __le32 iocqa;
16086 __u8 rsvd20[4];
16087 };
16088
16089 **Members**
16090
16091 ``iocqprp1``
16092 I/O Completion Queue PRP Entry 1 (IOCQPRP1)
16093
16094 ``iocqqsize``
16095 I/O Completion Queue Size (IOCQQSIZE)
16096
16097 ``iocqqid``
16098 I/O Completion Queue Identifier (IOCQQID)
16099
16100 ``iocqhp``
16101 I/O Completion Queue Head Pointer (IOCQHP)
16102
16103 ``iocqtp``
16104 I/O Completion Queue Tail Pointer (IOCQTP)
16105
16106 ``iocqa``
16107 I/O Completion Queue Attributes (IOCQA)
16108
16109 ``rsvd20``
16110 Reserved
16111
16112
16113
16114
16115
16116 .. c:type:: struct nvme_lm_nvme_controller_state_data_header
16117
16118 Controller State data structure header
16119
16120 **Definition**
16121
16122 ::
16123
16124 struct nvme_lm_nvme_controller_state_data_header {
16125 __le16 ver;
16126 __le16 niosq;
16127 __le16 niocq;
16128 __le16 rsvd6;
16129 };
16130
16131 **Members**
16132
16133 ``ver``
16134 The version of this data structure.
16135
16136 ``niosq``
16137 The number of I/O Submission Queues contained in this data structure.
16138
16139 ``niocq``
16140 The number of I/O Completion Queues contained in this data structure.
16141
16142 ``rsvd6``
16143 Reserved
16144
16145
16146
16147
16148
16149 .. c:type:: struct nvme_lm_nvme_controller_state_data
16150
16151 NVMe Controller State data structure describes the state of a NVMe Controller's I/O Submission and I/O Completion queues
16152
16153 **Definition**
16154
16155 ::
16156
16157 struct nvme_lm_nvme_controller_state_data {
16158 struct nvme_lm_nvme_controller_state_data_header hdr;
16159 union {
16160 struct nvme_lm_io_submission_queue_data sqs[0];
16161 struct nvme_lm_io_completion_queue_data cqs[0];
16162 };
16163 };
16164
16165 **Members**
16166
16167 ``hdr``
16168 Header
16169
16170 ``{unnamed_union}``
16171 anonymous
16172
16173 ``sqs``
16174 I/O Submission Queue list
16175
16176 ``cqs``
16177 I/O Completion Queue list
16178
16179
16180
16181
16182
16183 .. c:type:: struct nvme_lm_controller_state_data_header
16184
16185 Controller State data header structure describes the contents of the Controller State data
16186
16187 **Definition**
16188
16189 ::
16190
16191 struct nvme_lm_controller_state_data_header {
16192 __le16 ver;
16193 __u8 csattr;
16194 __u8 rsvd3[13];
16195 __u8 nvmecss[16];
16196 __u8 vss[16];
16197 };
16198
16199 **Members**
16200
16201 ``ver``
16202 Version of this data structure
16203
16204 ``csattr``
16205 Controller state attributes
16206
16207 ``rsvd3``
16208 Reserved
16209
16210 ``nvmecss``
16211 NVMe Controller state size in dwords
16212
16213 ``vss``
16214 Vendor specific size in dowrds
16215
16216
16217
16218
16219
16220 .. c:type:: struct nvme_lm_controller_state_data
16221
16222 Controller State data structure contains data on the controller's state.
16223
16224 **Definition**
16225
16226 ::
16227
16228 struct nvme_lm_controller_state_data {
16229 struct nvme_lm_controller_state_data_header hdr;
16230 struct nvme_lm_nvme_controller_state_data data;
16231 };
16232
16233 **Members**
16234
16235 ``hdr``
16236 Header
16237
16238 ``data``
16239 Data
16240
16241
16242
16243
16244
16245 .. c:type:: enum nvme_lm_queue_attributes
16246
16247 I/O Submission and I/O Completion Queue Attributes
16248
16249 **Constants**
16250
16251 ``NVME_LM_IOSQPC_MASK``
16252 Mask to get the Physically Contiguous (PC) bit for this I/O
16253 submission queue.
16254
16255 ``NVME_LM_IOSQPC_SHIFT``
16256 Shift to get the PC bit for this I/O submission queue
16257
16258 ``NVME_LM_IOSQPRIO_MASK``
16259 Mask to get the Priority for this I/O submission queue.
16260
16261 ``NVME_LM_IOSQPRIO_SHIFT``
16262 Shift to get the Priority for this I/O submission queue.
16263
16264 ``NVME_LM_IOCQPC_MASK``
16265 Mask to get the Physicaly Contiguous (PC) bit for this I/O
16266 completion queue.
16267
16268 ``NVME_LM_IOCQPC_SHIFT``
16269 Shift to get the PC bit for this I/O completion queue.
16270
16271 ``NVME_LM_IOCQIEN_MASK``
16272 Mask to get the Interrupts Enabled bit for this I/O completion
16273 queue
16274
16275 ``NVME_LM_IOCQIEN_SHIFT``
16276 Shift to get the Interrupts Enabled bit for this I/O completion
16277
16278 ``NVME_LM_S0PT_MASK``
16279 Mask to get the value of the Phase Tag bit for Slot 0 of this I/O
16280 completion queue.
16281
16282 ``NVME_LM_S0PT_SHIFT``
16283 Shift to get the value of the Phase Tag bit for Slot 0 of this I/O
16284 completion queue.
16285
16286 ``NVME_LM_IOCQIV_MASK``
16287 Mask to get the Interrupt Vector (IV) for this I/O completion
16288 queue.
16289
16290 ``NVME_LM_IOCQIV_SHIFT``
16291 Shift to get the IV for this I/O completion queue.
16292
16293
16294
16295
16296 .. c:type:: enum nvme_lm_ctrl_data_queue_fid
16297
16298 Controller Data Queue - Set Feature
16299
16300 **Constants**
16301
16302 ``NVME_LM_CTRL_DATA_QUEUE_ETPT_MASK``
16303 Mask to set Enable Tail Pointer Trigger (ETPT)
16304
16305 ``NVME_LM_CTRL_DATA_QUEUE_ETPT_SHIFT``
16306 Shift to set ETPT
16307
16308
16309
16310
16311 .. c:type:: struct nvme_lm_ctrl_data_queue_fid_data
16312
16313 Get Controller Data Queue feature data
16314
16315 **Definition**
16316
16317 ::
16318
16319 struct nvme_lm_ctrl_data_queue_fid_data {
16320 __le32 hp;
16321 __le32 tpt;
16322 };
16323
16324 **Members**
16325
16326 ``hp``
16327 Head Pointer
16328
16329 ``tpt``
16330 Tail Pointer Trigger
16331
16332
16333