| 1 |
.TH "libnvme" 9 "enum nvme_cc" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
enum nvme_cc \- This field indicates the controller configuration |
| 4 |
.SH SYNOPSIS |
| 5 |
enum nvme_cc { |
| 6 |
.br |
| 7 |
.BI " NVME_CC_EN_SHIFT" |
| 8 |
, |
| 9 |
.br |
| 10 |
.br |
| 11 |
.BI " NVME_CC_CSS_SHIFT" |
| 12 |
, |
| 13 |
.br |
| 14 |
.br |
| 15 |
.BI " NVME_CC_MPS_SHIFT" |
| 16 |
, |
| 17 |
.br |
| 18 |
.br |
| 19 |
.BI " NVME_CC_AMS_SHIFT" |
| 20 |
, |
| 21 |
.br |
| 22 |
.br |
| 23 |
.BI " NVME_CC_SHN_SHIFT" |
| 24 |
, |
| 25 |
.br |
| 26 |
.br |
| 27 |
.BI " NVME_CC_IOSQES_SHIFT" |
| 28 |
, |
| 29 |
.br |
| 30 |
.br |
| 31 |
.BI " NVME_CC_IOCQES_SHIFT" |
| 32 |
, |
| 33 |
.br |
| 34 |
.br |
| 35 |
.BI " NVME_CC_CRIME_SHIFT" |
| 36 |
, |
| 37 |
.br |
| 38 |
.br |
| 39 |
.BI " NVME_CC_EN_MASK" |
| 40 |
, |
| 41 |
.br |
| 42 |
.br |
| 43 |
.BI " NVME_CC_CSS_MASK" |
| 44 |
, |
| 45 |
.br |
| 46 |
.br |
| 47 |
.BI " NVME_CC_MPS_MASK" |
| 48 |
, |
| 49 |
.br |
| 50 |
.br |
| 51 |
.BI " NVME_CC_AMS_MASK" |
| 52 |
, |
| 53 |
.br |
| 54 |
.br |
| 55 |
.BI " NVME_CC_SHN_MASK" |
| 56 |
, |
| 57 |
.br |
| 58 |
.br |
| 59 |
.BI " NVME_CC_CRIME_MASK" |
| 60 |
, |
| 61 |
.br |
| 62 |
.br |
| 63 |
.BI " NVME_CC_IOSQES_MASK" |
| 64 |
, |
| 65 |
.br |
| 66 |
.br |
| 67 |
.BI " NVME_CC_IOCQES_MASK" |
| 68 |
, |
| 69 |
.br |
| 70 |
.br |
| 71 |
.BI " NVME_CC_CSS_NVM" |
| 72 |
, |
| 73 |
.br |
| 74 |
.br |
| 75 |
.BI " NVME_CC_CSS_CSI" |
| 76 |
, |
| 77 |
.br |
| 78 |
.br |
| 79 |
.BI " NVME_CC_CSS_ADMIN" |
| 80 |
, |
| 81 |
.br |
| 82 |
.br |
| 83 |
.BI " NVME_CC_AMS_RR" |
| 84 |
, |
| 85 |
.br |
| 86 |
.br |
| 87 |
.BI " NVME_CC_AMS_WRRU" |
| 88 |
, |
| 89 |
.br |
| 90 |
.br |
| 91 |
.BI " NVME_CC_AMS_VS" |
| 92 |
, |
| 93 |
.br |
| 94 |
.br |
| 95 |
.BI " NVME_CC_SHN_NONE" |
| 96 |
, |
| 97 |
.br |
| 98 |
.br |
| 99 |
.BI " NVME_CC_SHN_NORMAL" |
| 100 |
, |
| 101 |
.br |
| 102 |
.br |
| 103 |
.BI " NVME_CC_SHN_ABRUPT" |
| 104 |
, |
| 105 |
.br |
| 106 |
.br |
| 107 |
.BI " NVME_CC_CRWME" |
| 108 |
, |
| 109 |
.br |
| 110 |
.br |
| 111 |
.BI " NVME_CC_CRIME" |
| 112 |
|
| 113 |
}; |
| 114 |
.SH Constants |
| 115 |
.IP "NVME_CC_EN_SHIFT" 12 |
| 116 |
Shift amount to get the enable |
| 117 |
.IP "NVME_CC_CSS_SHIFT" 12 |
| 118 |
Shift amount to get the I/O command set selected |
| 119 |
.IP "NVME_CC_MPS_SHIFT" 12 |
| 120 |
Shift amount to get the memory page size |
| 121 |
.IP "NVME_CC_AMS_SHIFT" 12 |
| 122 |
Shift amount to get the arbitration mechanism selected |
| 123 |
.IP "NVME_CC_SHN_SHIFT" 12 |
| 124 |
Shift amount to get the shutdown notification |
| 125 |
.IP "NVME_CC_IOSQES_SHIFT" 12 |
| 126 |
Shift amount to get the I/O submission queue entry size |
| 127 |
.IP "NVME_CC_IOCQES_SHIFT" 12 |
| 128 |
Shift amount to get the I/O completion queue entry size |
| 129 |
.IP "NVME_CC_CRIME_SHIFT" 12 |
| 130 |
Shift amount to get the controller ready independent of media enable |
| 131 |
.IP "NVME_CC_EN_MASK" 12 |
| 132 |
Mask to get the enable |
| 133 |
.IP "NVME_CC_CSS_MASK" 12 |
| 134 |
Mask to get the I/O command set selected |
| 135 |
.IP "NVME_CC_MPS_MASK" 12 |
| 136 |
Mask to get the memory page size |
| 137 |
.IP "NVME_CC_AMS_MASK" 12 |
| 138 |
Mask to get the arbitration mechanism selected |
| 139 |
.IP "NVME_CC_SHN_MASK" 12 |
| 140 |
Mask to get the shutdown notification |
| 141 |
.IP "NVME_CC_CRIME_MASK" 12 |
| 142 |
Mask to get the I/O submission queue entry size |
| 143 |
.IP "NVME_CC_IOSQES_MASK" 12 |
| 144 |
Mask to get the I/O completion queue entry size |
| 145 |
.IP "NVME_CC_IOCQES_MASK" 12 |
| 146 |
Mask to get the controller ready independent of media enable |
| 147 |
.IP "NVME_CC_CSS_NVM" 12 |
| 148 |
NVM command set |
| 149 |
.IP "NVME_CC_CSS_CSI" 12 |
| 150 |
All supported I/O command sets |
| 151 |
.IP "NVME_CC_CSS_ADMIN" 12 |
| 152 |
Admin command set only |
| 153 |
.IP "NVME_CC_AMS_RR" 12 |
| 154 |
Round robin |
| 155 |
.IP "NVME_CC_AMS_WRRU" 12 |
| 156 |
Weighted round robin with urgent priority class |
| 157 |
.IP "NVME_CC_AMS_VS" 12 |
| 158 |
Vendor specific |
| 159 |
.IP "NVME_CC_SHN_NONE" 12 |
| 160 |
No notification; no effect |
| 161 |
.IP "NVME_CC_SHN_NORMAL" 12 |
| 162 |
Normal shutdown notification |
| 163 |
.IP "NVME_CC_SHN_ABRUPT" 12 |
| 164 |
Abrupt shutdown notification |
| 165 |
.IP "NVME_CC_CRWME" 12 |
| 166 |
Controller ready with media enable |
| 167 |
.IP "NVME_CC_CRIME" 12 |
| 168 |
Controller ready independent of media enable |