| 1 |
.TH "libnvme" 9 "enum nvme_cap" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
enum nvme_cap \- This field indicates the controller capabilities register |
| 4 |
.SH SYNOPSIS |
| 5 |
enum nvme_cap { |
| 6 |
.br |
| 7 |
.BI " NVME_CAP_MQES_SHIFT" |
| 8 |
, |
| 9 |
.br |
| 10 |
.br |
| 11 |
.BI " NVME_CAP_CQR_SHIFT" |
| 12 |
, |
| 13 |
.br |
| 14 |
.br |
| 15 |
.BI " NVME_CAP_AMS_SHIFT" |
| 16 |
, |
| 17 |
.br |
| 18 |
.br |
| 19 |
.BI " NVME_CAP_TO_SHIFT" |
| 20 |
, |
| 21 |
.br |
| 22 |
.br |
| 23 |
.BI " NVME_CAP_DSTRD_SHIFT" |
| 24 |
, |
| 25 |
.br |
| 26 |
.br |
| 27 |
.BI " NVME_CAP_NSSRC_SHIFT" |
| 28 |
, |
| 29 |
.br |
| 30 |
.br |
| 31 |
.BI " NVME_CAP_CSS_SHIFT" |
| 32 |
, |
| 33 |
.br |
| 34 |
.br |
| 35 |
.BI " NVME_CAP_BPS_SHIFT" |
| 36 |
, |
| 37 |
.br |
| 38 |
.br |
| 39 |
.BI " NVME_CAP_CPS_SHIFT" |
| 40 |
, |
| 41 |
.br |
| 42 |
.br |
| 43 |
.BI " NVME_CAP_MPSMIN_SHIFT" |
| 44 |
, |
| 45 |
.br |
| 46 |
.br |
| 47 |
.BI " NVME_CAP_MPSMAX_SHIFT" |
| 48 |
, |
| 49 |
.br |
| 50 |
.br |
| 51 |
.BI " NVME_CAP_PMRS_SHIFT" |
| 52 |
, |
| 53 |
.br |
| 54 |
.br |
| 55 |
.BI " NVME_CAP_CMBS_SHIFT" |
| 56 |
, |
| 57 |
.br |
| 58 |
.br |
| 59 |
.BI " NVME_CAP_NSSS_SHIFT" |
| 60 |
, |
| 61 |
.br |
| 62 |
.br |
| 63 |
.BI " NVME_CAP_CRMS_SHIFT" |
| 64 |
, |
| 65 |
.br |
| 66 |
.br |
| 67 |
.BI " NVME_CAP_MQES_MASK" |
| 68 |
, |
| 69 |
.br |
| 70 |
.br |
| 71 |
.BI " NVME_CAP_CQR_MASK" |
| 72 |
, |
| 73 |
.br |
| 74 |
.br |
| 75 |
.BI " NVME_CAP_AMS_MASK" |
| 76 |
, |
| 77 |
.br |
| 78 |
.br |
| 79 |
.BI " NVME_CAP_TO_MASK" |
| 80 |
, |
| 81 |
.br |
| 82 |
.br |
| 83 |
.BI " NVME_CAP_DSTRD_MASK" |
| 84 |
, |
| 85 |
.br |
| 86 |
.br |
| 87 |
.BI " NVME_CAP_NSSRC_MASK" |
| 88 |
, |
| 89 |
.br |
| 90 |
.br |
| 91 |
.BI " NVME_CAP_CSS_MASK" |
| 92 |
, |
| 93 |
.br |
| 94 |
.br |
| 95 |
.BI " NVME_CAP_BPS_MASK" |
| 96 |
, |
| 97 |
.br |
| 98 |
.br |
| 99 |
.BI " NVME_CAP_CPS_MASK" |
| 100 |
, |
| 101 |
.br |
| 102 |
.br |
| 103 |
.BI " NVME_CAP_MPSMIN_MASK" |
| 104 |
, |
| 105 |
.br |
| 106 |
.br |
| 107 |
.BI " NVME_CAP_MPSMAX_MASK" |
| 108 |
, |
| 109 |
.br |
| 110 |
.br |
| 111 |
.BI " NVME_CAP_PMRS_MASK" |
| 112 |
, |
| 113 |
.br |
| 114 |
.br |
| 115 |
.BI " NVME_CAP_CMBS_MASK" |
| 116 |
, |
| 117 |
.br |
| 118 |
.br |
| 119 |
.BI " NVME_CAP_NSSS_MASK" |
| 120 |
, |
| 121 |
.br |
| 122 |
.br |
| 123 |
.BI " NVME_CAP_CRMS_MASK" |
| 124 |
, |
| 125 |
.br |
| 126 |
.br |
| 127 |
.BI " NVME_CAP_AMS_WRR" |
| 128 |
, |
| 129 |
.br |
| 130 |
.br |
| 131 |
.BI " NVME_CAP_AMS_VS" |
| 132 |
, |
| 133 |
.br |
| 134 |
.br |
| 135 |
.BI " NVME_CAP_CSS_NVM" |
| 136 |
, |
| 137 |
.br |
| 138 |
.br |
| 139 |
.BI " NVME_CAP_CSS_CSI" |
| 140 |
, |
| 141 |
.br |
| 142 |
.br |
| 143 |
.BI " NVME_CAP_CSS_ADMIN" |
| 144 |
, |
| 145 |
.br |
| 146 |
.br |
| 147 |
.BI " NVME_CAP_CPS_NONE" |
| 148 |
, |
| 149 |
.br |
| 150 |
.br |
| 151 |
.BI " NVME_CAP_CPS_CTRL" |
| 152 |
, |
| 153 |
.br |
| 154 |
.br |
| 155 |
.BI " NVME_CAP_CPS_DOMAIN" |
| 156 |
, |
| 157 |
.br |
| 158 |
.br |
| 159 |
.BI " NVME_CAP_CPS_NVMS" |
| 160 |
, |
| 161 |
.br |
| 162 |
.br |
| 163 |
.BI " NVME_CAP_CRWMS" |
| 164 |
, |
| 165 |
.br |
| 166 |
.br |
| 167 |
.BI " NVME_CAP_CRIMS" |
| 168 |
|
| 169 |
}; |
| 170 |
.SH Constants |
| 171 |
.IP "NVME_CAP_MQES_SHIFT" 12 |
| 172 |
Shift amount to get the maximum queue entries supported |
| 173 |
.IP "NVME_CAP_CQR_SHIFT" 12 |
| 174 |
Shift amount to get the contiguous queues required |
| 175 |
.IP "NVME_CAP_AMS_SHIFT" 12 |
| 176 |
Shift amount to get the arbitration mechanism supported |
| 177 |
.IP "NVME_CAP_TO_SHIFT" 12 |
| 178 |
Shift amount to get the timeout |
| 179 |
.IP "NVME_CAP_DSTRD_SHIFT" 12 |
| 180 |
Shift amount to get the doorbell stride |
| 181 |
.IP "NVME_CAP_NSSRC_SHIFT" 12 |
| 182 |
Shift amount to get the NVM subsystem reset supported |
| 183 |
.IP "NVME_CAP_CSS_SHIFT" 12 |
| 184 |
Shift amount to get the command sets supported |
| 185 |
.IP "NVME_CAP_BPS_SHIFT" 12 |
| 186 |
Shift amount to get the boot partition support |
| 187 |
.IP "NVME_CAP_CPS_SHIFT" 12 |
| 188 |
Shift amount to get the controller power scope |
| 189 |
.IP "NVME_CAP_MPSMIN_SHIFT" 12 |
| 190 |
Shift amount to get the memory page size minimum |
| 191 |
.IP "NVME_CAP_MPSMAX_SHIFT" 12 |
| 192 |
Shift amount to get the memory page size maximum |
| 193 |
.IP "NVME_CAP_PMRS_SHIFT" 12 |
| 194 |
Shift amount to get the persistent memory region supported |
| 195 |
.IP "NVME_CAP_CMBS_SHIFT" 12 |
| 196 |
Shift amount to get the controller memory buffer supported |
| 197 |
.IP "NVME_CAP_NSSS_SHIFT" 12 |
| 198 |
Shift amount to get the NVM subsystem shutdown supported |
| 199 |
.IP "NVME_CAP_CRMS_SHIFT" 12 |
| 200 |
Shift amount to get the controller ready modes supported |
| 201 |
.IP "NVME_CAP_MQES_MASK" 12 |
| 202 |
Mask to get the maximum queue entries supported |
| 203 |
.IP "NVME_CAP_CQR_MASK" 12 |
| 204 |
Mask to get the contiguous queues required |
| 205 |
.IP "NVME_CAP_AMS_MASK" 12 |
| 206 |
Mask to get the arbitration mechanism supported |
| 207 |
.IP "NVME_CAP_TO_MASK" 12 |
| 208 |
Mask to get the timeout |
| 209 |
.IP "NVME_CAP_DSTRD_MASK" 12 |
| 210 |
Mask to get the doorbell stride |
| 211 |
.IP "NVME_CAP_NSSRC_MASK" 12 |
| 212 |
Mask to get the NVM subsystem reset supported |
| 213 |
.IP "NVME_CAP_CSS_MASK" 12 |
| 214 |
Mask to get the command sets supported |
| 215 |
.IP "NVME_CAP_BPS_MASK" 12 |
| 216 |
Mask to get the boot partition support |
| 217 |
.IP "NVME_CAP_CPS_MASK" 12 |
| 218 |
Mask to get the controller power scope |
| 219 |
.IP "NVME_CAP_MPSMIN_MASK" 12 |
| 220 |
Mask to get the memory page size minimum |
| 221 |
.IP "NVME_CAP_MPSMAX_MASK" 12 |
| 222 |
Mask to get the memory page size maximum |
| 223 |
.IP "NVME_CAP_PMRS_MASK" 12 |
| 224 |
Mask to get the persistent memory region supported |
| 225 |
.IP "NVME_CAP_CMBS_MASK" 12 |
| 226 |
Mask to get the controller memory buffer supported |
| 227 |
.IP "NVME_CAP_NSSS_MASK" 12 |
| 228 |
Mask to get the NVM subsystem shutdown supported |
| 229 |
.IP "NVME_CAP_CRMS_MASK" 12 |
| 230 |
Mask to get the controller ready modes supported |
| 231 |
.IP "NVME_CAP_AMS_WRR" 12 |
| 232 |
Weighted round robin with urgent priority class |
| 233 |
.IP "NVME_CAP_AMS_VS" 12 |
| 234 |
Vendor specific |
| 235 |
.IP "NVME_CAP_CSS_NVM" 12 |
| 236 |
NVM command set or a discovery controller |
| 237 |
.IP "NVME_CAP_CSS_CSI" 12 |
| 238 |
Controller supports one or more I/O command sets |
| 239 |
.IP "NVME_CAP_CSS_ADMIN" 12 |
| 240 |
No I/O command set is supported |
| 241 |
.IP "NVME_CAP_CPS_NONE" 12 |
| 242 |
Not reported |
| 243 |
.IP "NVME_CAP_CPS_CTRL" 12 |
| 244 |
Controller scope |
| 245 |
.IP "NVME_CAP_CPS_DOMAIN" 12 |
| 246 |
Domain scope |
| 247 |
.IP "NVME_CAP_CPS_NVMS" 12 |
| 248 |
NVM subsystem scope |
| 249 |
.IP "NVME_CAP_CRWMS" 12 |
| 250 |
Controller ready with media support |
| 251 |
.IP "NVME_CAP_CRIMS" 12 |
| 252 |
Controller ready independent of media support |