| 1 |
.TH "libnvme" 9 "enum nvme_lm_migration_send_fields" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
enum nvme_lm_migration_send_fields \- Migration Send command fields |
| 4 |
.SH SYNOPSIS |
| 5 |
enum nvme_lm_migration_send_fields { |
| 6 |
.br |
| 7 |
.BI " NVME_LM_MIGRATION_SEND_MOS_SHIFT" |
| 8 |
, |
| 9 |
.br |
| 10 |
.br |
| 11 |
.BI " NVME_LM_MIGRATION_SEND_MOS_MASK" |
| 12 |
, |
| 13 |
.br |
| 14 |
.br |
| 15 |
.BI " NVME_LM_MIGRATION_SEND_SEL_SHIFT" |
| 16 |
, |
| 17 |
.br |
| 18 |
.br |
| 19 |
.BI " NVME_LM_MIGRATION_SEND_SEL_MASK" |
| 20 |
, |
| 21 |
.br |
| 22 |
.br |
| 23 |
.BI " NVME_LM_SEL_SUSPEND" |
| 24 |
, |
| 25 |
.br |
| 26 |
.br |
| 27 |
.BI " NVME_LM_SEL_RESUME" |
| 28 |
, |
| 29 |
.br |
| 30 |
.br |
| 31 |
.BI " NVME_LM_SEL_SET_CONTROLLER_STATE" |
| 32 |
, |
| 33 |
.br |
| 34 |
.br |
| 35 |
.BI " NVME_LM_MIGRATION_SEND_UIDX_SHIFT" |
| 36 |
, |
| 37 |
.br |
| 38 |
.br |
| 39 |
.BI " NVME_LM_MIGRATION_SEND_UIDX_MASK" |
| 40 |
, |
| 41 |
.br |
| 42 |
.br |
| 43 |
.BI " NVME_LM_DUDMQ" |
| 44 |
, |
| 45 |
.br |
| 46 |
.br |
| 47 |
.BI " NVME_LM_STYPE_SHIFT" |
| 48 |
, |
| 49 |
.br |
| 50 |
.br |
| 51 |
.BI " NVME_LM_STYPE_MASK" |
| 52 |
, |
| 53 |
.br |
| 54 |
.br |
| 55 |
.BI " NVME_LM_STYPE_SUSPEND_NOTIFICATION" |
| 56 |
, |
| 57 |
.br |
| 58 |
.br |
| 59 |
.BI " NVME_LM_STYPE_SUSPEND" |
| 60 |
, |
| 61 |
.br |
| 62 |
.br |
| 63 |
.BI " NVME_LM_SUSPEND_CNTLID_SHIFT" |
| 64 |
, |
| 65 |
.br |
| 66 |
.br |
| 67 |
.BI " NVME_LM_SUSPEND_CNTLID_MASK" |
| 68 |
, |
| 69 |
.br |
| 70 |
.br |
| 71 |
.BI " NVME_LM_RESUME_CNTLID_SHIFT" |
| 72 |
, |
| 73 |
.br |
| 74 |
.br |
| 75 |
.BI " NVME_LM_RESUME_CNTLID_MASK" |
| 76 |
, |
| 77 |
.br |
| 78 |
.br |
| 79 |
.BI " NVME_LM_SEQIND_SHIFT" |
| 80 |
, |
| 81 |
.br |
| 82 |
.br |
| 83 |
.BI " NVME_LM_SEQIND_MASK" |
| 84 |
, |
| 85 |
.br |
| 86 |
.br |
| 87 |
.BI " NVME_LM_SEQIND_NOT_FIRST_NOT_LAST" |
| 88 |
, |
| 89 |
.br |
| 90 |
.br |
| 91 |
.BI " NVME_LM_SEQIND_FIRST" |
| 92 |
, |
| 93 |
.br |
| 94 |
.br |
| 95 |
.BI " NVME_LM_SEQIND_LAST" |
| 96 |
, |
| 97 |
.br |
| 98 |
.br |
| 99 |
.BI " NVME_LM_SEQIND_ENTIRE" |
| 100 |
, |
| 101 |
.br |
| 102 |
.br |
| 103 |
.BI " NVME_LM_SET_CONTROLLER_STATE_CSUUIDI_SHIFT" |
| 104 |
, |
| 105 |
.br |
| 106 |
.br |
| 107 |
.BI " NVME_LM_SET_CONTROLLER_STATE_CSUUIDI_MASK" |
| 108 |
, |
| 109 |
.br |
| 110 |
.br |
| 111 |
.BI " NVME_LM_SET_CONTROLLER_STATE_CSVI_SHIFT" |
| 112 |
, |
| 113 |
.br |
| 114 |
.br |
| 115 |
.BI " NVME_LM_SET_CONTROLLER_STATE_CSVI_MASK" |
| 116 |
, |
| 117 |
.br |
| 118 |
.br |
| 119 |
.BI " NVME_LM_SET_CONTROLLER_STATE_CNTLID_SHIFT" |
| 120 |
, |
| 121 |
.br |
| 122 |
.br |
| 123 |
.BI " NVME_LM_SET_CONTROLLER_STATE_CNTLID_MASK" |
| 124 |
|
| 125 |
}; |
| 126 |
.SH Constants |
| 127 |
.IP "NVME_LM_MIGRATION_SEND_MOS_SHIFT" 12 |
| 128 |
Shift to set Management Operation Specific (MOS) |
| 129 |
field |
| 130 |
.IP "NVME_LM_MIGRATION_SEND_MOS_MASK" 12 |
| 131 |
Mask to set MOS field |
| 132 |
.IP "NVME_LM_MIGRATION_SEND_SEL_SHIFT" 12 |
| 133 |
Shift amount to set Select (SEL) field |
| 134 |
.IP "NVME_LM_MIGRATION_SEND_SEL_MASK" 12 |
| 135 |
Mask to set SEL field |
| 136 |
.IP "NVME_LM_SEL_SUSPEND" 12 |
| 137 |
Migration Send - Suspend |
| 138 |
.IP "NVME_LM_SEL_RESUME" 12 |
| 139 |
Migration Send - Resume |
| 140 |
.IP "NVME_LM_SEL_SET_CONTROLLER_STATE" 12 |
| 141 |
Migration Send - Set Controller State |
| 142 |
.IP "NVME_LM_MIGRATION_SEND_UIDX_SHIFT" 12 |
| 143 |
Shift to set UUID Index (UIDX) |
| 144 |
.IP "NVME_LM_MIGRATION_SEND_UIDX_MASK" 12 |
| 145 |
Mask to set UIDX |
| 146 |
.IP "NVME_LM_DUDMQ" 12 |
| 147 |
Delete User Data Migration Queue |
| 148 |
.IP "NVME_LM_STYPE_SHIFT" 12 |
| 149 |
Shift amount to set Suspend Type (STYPE) |
| 150 |
.IP "NVME_LM_STYPE_MASK" 12 |
| 151 |
Mask to set STYPE |
| 152 |
.IP "NVME_LM_STYPE_SUSPEND_NOTIFICATION" 12 |
| 153 |
Suspend Notification - The specified controller is |
| 154 |
going to be suspended in the future with a |
| 155 |
subsequent Migration Send command |
| 156 |
.IP "NVME_LM_STYPE_SUSPEND" 12 |
| 157 |
Suspend - Suspend the controller |
| 158 |
.IP "NVME_LM_SUSPEND_CNTLID_SHIFT" 12 |
| 159 |
Shift amount to set Controller ID (CNTLID) when SEL |
| 160 |
is Suspend |
| 161 |
.IP "NVME_LM_SUSPEND_CNTLID_MASK" 12 |
| 162 |
Mask to set CNTLID with SEL Suspend |
| 163 |
.IP "NVME_LM_RESUME_CNTLID_SHIFT" 12 |
| 164 |
Shift amount to set Controller ID (CNTLID) when SEL |
| 165 |
is Resume |
| 166 |
.IP "NVME_LM_RESUME_CNTLID_MASK" 12 |
| 167 |
Mask to set CNTLID when SEL is Resume |
| 168 |
.IP "NVME_LM_SEQIND_SHIFT" 12 |
| 169 |
Shift amount to set Sequence Indicator (SEQIND) |
| 170 |
field relative to MOS |
| 171 |
.IP "NVME_LM_SEQIND_MASK" 12 |
| 172 |
Mask to set SEQIND field relative to MOS |
| 173 |
.IP "NVME_LM_SEQIND_NOT_FIRST_NOT_LAST" 12 |
| 174 |
This command is not the first or last of a sequence |
| 175 |
of two or more Migration Send commands with this |
| 176 |
management operation used to transfer the controller |
| 177 |
state from host to controller |
| 178 |
.IP "NVME_LM_SEQIND_FIRST" 12 |
| 179 |
This command is the first of a sequence of two or |
| 180 |
more Migration Send commands |
| 181 |
.IP "NVME_LM_SEQIND_LAST" 12 |
| 182 |
This command is the last command of a sequence of |
| 183 |
two or more Migration Send commands |
| 184 |
.IP "NVME_LM_SEQIND_ENTIRE" 12 |
| 185 |
This Migration Send command is the only command and |
| 186 |
contains the entire controller state for this |
| 187 |
management operation |
| 188 |
.IP "NVME_LM_SET_CONTROLLER_STATE_CSUUIDI_SHIFT" 12 |
| 189 |
Shift amount to set Controller State UUID Index |
| 190 |
(CSUUIDI) |
| 191 |
.IP "NVME_LM_SET_CONTROLLER_STATE_CSUUIDI_MASK" 12 |
| 192 |
Mask to set CSUUIDI |
| 193 |
.IP "NVME_LM_SET_CONTROLLER_STATE_CSVI_SHIFT" 12 |
| 194 |
Shift amount to set Controller State Version Index |
| 195 |
(CSVI) |
| 196 |
.IP "NVME_LM_SET_CONTROLLER_STATE_CSVI_MASK" 12 |
| 197 |
Mask to set CSVI |
| 198 |
.IP "NVME_LM_SET_CONTROLLER_STATE_CNTLID_SHIFT" 12 |
| 199 |
Shift amount to set Controller ID (CNTLID) when SEL |
| 200 |
is Set Controller State |
| 201 |
.IP "NVME_LM_SET_CONTROLLER_STATE_CNTLID_MASK" 12 |
| 202 |
Mask to set CNTLID when SEL is Set Controller State |