| 1 |
.TH "libnvme" 9 "enum nvme_constants" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
enum nvme_constants \- A place to stash various constant nvme values |
| 4 |
.SH SYNOPSIS |
| 5 |
enum nvme_constants { |
| 6 |
.br |
| 7 |
.BI " NVME_NSID_ALL" |
| 8 |
, |
| 9 |
.br |
| 10 |
.br |
| 11 |
.BI " NVME_NSID_NONE" |
| 12 |
, |
| 13 |
.br |
| 14 |
.br |
| 15 |
.BI " NVME_UUID_NONE" |
| 16 |
, |
| 17 |
.br |
| 18 |
.br |
| 19 |
.BI " NVME_CNTLID_NONE" |
| 20 |
, |
| 21 |
.br |
| 22 |
.br |
| 23 |
.BI " NVME_CNSSPECID_NONE" |
| 24 |
, |
| 25 |
.br |
| 26 |
.br |
| 27 |
.BI " NVME_LOG_LSP_NONE" |
| 28 |
, |
| 29 |
.br |
| 30 |
.br |
| 31 |
.BI " NVME_LOG_LSI_NONE" |
| 32 |
, |
| 33 |
.br |
| 34 |
.br |
| 35 |
.BI " NVME_LOG_LPO_NONE" |
| 36 |
, |
| 37 |
.br |
| 38 |
.br |
| 39 |
.BI " NVME_IDENTIFY_DATA_SIZE" |
| 40 |
, |
| 41 |
.br |
| 42 |
.br |
| 43 |
.BI " NVME_LOG_SUPPORTED_LOG_PAGES_MAX" |
| 44 |
, |
| 45 |
.br |
| 46 |
.br |
| 47 |
.BI " NVME_ID_NVMSET_LIST_MAX" |
| 48 |
, |
| 49 |
.br |
| 50 |
.br |
| 51 |
.BI " NVME_ID_UUID_LIST_MAX" |
| 52 |
, |
| 53 |
.br |
| 54 |
.br |
| 55 |
.BI " NVME_ID_CTRL_LIST_MAX" |
| 56 |
, |
| 57 |
.br |
| 58 |
.br |
| 59 |
.BI " NVME_ID_NS_LIST_MAX" |
| 60 |
, |
| 61 |
.br |
| 62 |
.br |
| 63 |
.BI " NVME_ID_SECONDARY_CTRL_MAX" |
| 64 |
, |
| 65 |
.br |
| 66 |
.br |
| 67 |
.BI " NVME_ID_DOMAIN_LIST_MAX" |
| 68 |
, |
| 69 |
.br |
| 70 |
.br |
| 71 |
.BI " NVME_ID_ENDURANCE_GROUP_LIST_MAX" |
| 72 |
, |
| 73 |
.br |
| 74 |
.br |
| 75 |
.BI " NVME_ID_ND_DESCRIPTOR_MAX" |
| 76 |
, |
| 77 |
.br |
| 78 |
.br |
| 79 |
.BI " NVME_FEAT_LBA_RANGE_MAX" |
| 80 |
, |
| 81 |
.br |
| 82 |
.br |
| 83 |
.BI " NVME_LOG_ST_MAX_RESULTS" |
| 84 |
, |
| 85 |
.br |
| 86 |
.br |
| 87 |
.BI " NVME_LOG_TELEM_BLOCK_SIZE" |
| 88 |
, |
| 89 |
.br |
| 90 |
.br |
| 91 |
.BI " NVME_LOG_FID_SUPPORTED_EFFECTS_MAX" |
| 92 |
, |
| 93 |
.br |
| 94 |
.br |
| 95 |
.BI " NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_MAX" |
| 96 |
, |
| 97 |
.br |
| 98 |
.br |
| 99 |
.BI " NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_RESERVED" |
| 100 |
, |
| 101 |
.br |
| 102 |
.br |
| 103 |
.BI " NVME_DSM_MAX_RANGES" |
| 104 |
, |
| 105 |
.br |
| 106 |
.br |
| 107 |
.BI " NVME_NQN_LENGTH" |
| 108 |
, |
| 109 |
.br |
| 110 |
.br |
| 111 |
.BI " NVMF_TRADDR_SIZE" |
| 112 |
, |
| 113 |
.br |
| 114 |
.br |
| 115 |
.BI " NVMF_TSAS_SIZE" |
| 116 |
, |
| 117 |
.br |
| 118 |
.br |
| 119 |
.BI " NVME_ZNS_CHANGED_ZONES_MAX" |
| 120 |
, |
| 121 |
.br |
| 122 |
.br |
| 123 |
.BI " NVME_STREAM_ID_MAX" |
| 124 |
|
| 125 |
}; |
| 126 |
.SH Constants |
| 127 |
.IP "NVME_NSID_ALL" 12 |
| 128 |
A broadcast value that is used to specify all |
| 129 |
namespaces |
| 130 |
.IP "NVME_NSID_NONE" 12 |
| 131 |
The invalid namespace id, for when the nsid |
| 132 |
parameter is not used in a command |
| 133 |
.IP "NVME_UUID_NONE" 12 |
| 134 |
Use to omit a uuid command parameter |
| 135 |
.IP "NVME_CNTLID_NONE" 12 |
| 136 |
Use to omit a cntlid command parameter |
| 137 |
.IP "NVME_CNSSPECID_NONE" 12 |
| 138 |
Use to omit a cns_specific_id command parameter |
| 139 |
.IP "NVME_LOG_LSP_NONE" 12 |
| 140 |
Use to omit a log lsp command parameter |
| 141 |
.IP "NVME_LOG_LSI_NONE" 12 |
| 142 |
Use to omit a log lsi command parameter |
| 143 |
.IP "NVME_LOG_LPO_NONE" 12 |
| 144 |
Use to omit a log lpo command parameter |
| 145 |
.IP "NVME_IDENTIFY_DATA_SIZE" 12 |
| 146 |
The transfer size for nvme identify commands |
| 147 |
.IP "NVME_LOG_SUPPORTED_LOG_PAGES_MAX" 12 |
| 148 |
The largest possible index in the supported |
| 149 |
log pages log. |
| 150 |
.IP "NVME_ID_NVMSET_LIST_MAX" 12 |
| 151 |
The largest possible nvmset index in identify |
| 152 |
nvmeset |
| 153 |
.IP "NVME_ID_UUID_LIST_MAX" 12 |
| 154 |
The largest possible uuid index in identify |
| 155 |
uuid list |
| 156 |
.IP "NVME_ID_CTRL_LIST_MAX" 12 |
| 157 |
The largest possible controller index in |
| 158 |
identify controller list |
| 159 |
.IP "NVME_ID_NS_LIST_MAX" 12 |
| 160 |
The largest possible namespace index in |
| 161 |
identify namespace list |
| 162 |
.IP "NVME_ID_SECONDARY_CTRL_MAX" 12 |
| 163 |
The largest possible secondary controller index |
| 164 |
in identify secondary controller |
| 165 |
.IP "NVME_ID_DOMAIN_LIST_MAX" 12 |
| 166 |
The largest possible domain index in the |
| 167 |
in domain list |
| 168 |
.IP "NVME_ID_ENDURANCE_GROUP_LIST_MAX" 12 |
| 169 |
The largest possible endurance group |
| 170 |
index in the endurance group list |
| 171 |
.IP "NVME_ID_ND_DESCRIPTOR_MAX" 12 |
| 172 |
The largest possible namespace granularity |
| 173 |
index in the namespace granularity descriptor |
| 174 |
list |
| 175 |
.IP "NVME_FEAT_LBA_RANGE_MAX" 12 |
| 176 |
The largest possible LBA range index in feature |
| 177 |
lba range type |
| 178 |
.IP "NVME_LOG_ST_MAX_RESULTS" 12 |
| 179 |
The largest possible self test result index in the |
| 180 |
device self test log |
| 181 |
.IP "NVME_LOG_TELEM_BLOCK_SIZE" 12 |
| 182 |
Specification defined size of Telemetry Data Blocks |
| 183 |
.IP "NVME_LOG_FID_SUPPORTED_EFFECTS_MAX" 12 |
| 184 |
The largest possible FID index in the |
| 185 |
feature identifiers effects log. |
| 186 |
.IP "NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_MAX" 12 |
| 187 |
The largest possible MI Command index |
| 188 |
in the MI Command effects log. |
| 189 |
.IP "NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_RESERVED" 12 |
| 190 |
The reserved space in the MI Command |
| 191 |
effects log. |
| 192 |
.IP "NVME_DSM_MAX_RANGES" 12 |
| 193 |
The largest possible range index in a data-set |
| 194 |
management command |
| 195 |
.IP "NVME_NQN_LENGTH" 12 |
| 196 |
Max length for NVMe Qualified Name |
| 197 |
.IP "NVMF_TRADDR_SIZE" 12 |
| 198 |
Max Transport Address size |
| 199 |
.IP "NVMF_TSAS_SIZE" 12 |
| 200 |
Max Transport Specific Address Subtype size |
| 201 |
.IP "NVME_ZNS_CHANGED_ZONES_MAX" 12 |
| 202 |
Max number of zones in the changed zones log |
| 203 |
page |
| 204 |
.IP "NVME_STREAM_ID_MAX" 12 |
| 205 |
Max number of stream IDs |