| 1 |
.TH "libnvme" 9 "struct nvme_lm_migration_send_args" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nvme_lm_migration_send_args \- Arguments for the Migration Send command |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nvme_lm_migration_send_args { |
| 6 |
.br |
| 7 |
.BI " __u64 offset;" |
| 8 |
.br |
| 9 |
.BI " __u32 *result;" |
| 10 |
.br |
| 11 |
.BI " void *data;" |
| 12 |
.br |
| 13 |
.BI " int args_size;" |
| 14 |
.br |
| 15 |
.BI " int fd;" |
| 16 |
.br |
| 17 |
.BI " __u32 timeout;" |
| 18 |
.br |
| 19 |
.BI " __u32 numd;" |
| 20 |
.br |
| 21 |
.BI " __u16 mos;" |
| 22 |
.br |
| 23 |
.BI " __u16 cntlid;" |
| 24 |
.br |
| 25 |
.BI " __u16 csuuidi;" |
| 26 |
.br |
| 27 |
.BI " __u8 sel;" |
| 28 |
.br |
| 29 |
.BI " __u8 uidx;" |
| 30 |
.br |
| 31 |
.BI " __u8 stype;" |
| 32 |
.br |
| 33 |
.BI " __u8 seqind;" |
| 34 |
.br |
| 35 |
.BI " __u8 csvi;" |
| 36 |
.br |
| 37 |
.BI " bool dudmq;" |
| 38 |
.br |
| 39 |
.BI " |
| 40 |
}; |
| 41 |
.br |
| 42 |
|
| 43 |
.SH Members |
| 44 |
.IP "offset" 12 |
| 45 |
Offset: This field specifies the offset, in bytes, within the data available to be |
| 46 |
returned and specifies the starting point for that data for what is actually |
| 47 |
returned to the host. |
| 48 |
.IP "result" 12 |
| 49 |
Set on completion to the command's CQE DWORD 0 controller response |
| 50 |
.IP "data" 12 |
| 51 |
Pointer to data |
| 52 |
.IP "args_size" 12 |
| 53 |
Length of structure |
| 54 |
.IP "fd" 12 |
| 55 |
File descriptor of nvme device |
| 56 |
.IP "timeout" 12 |
| 57 |
Timeout in ms |
| 58 |
.IP "numd" 12 |
| 59 |
Number of Dwords (NUMD): This field specifies the number of dwords being transferred |
| 60 |
.IP "mos" 12 |
| 61 |
Management Operation Specific (MOS): This field is specific to the SEL type |
| 62 |
.IP "cntlid" 12 |
| 63 |
Controller ID: This field specifies the identifier of the controller to which the |
| 64 |
operation is performed. |
| 65 |
.IP "csuuidi" 12 |
| 66 |
Controller State UUID Index (CSUUIDI): A non-zero value in this field specifies the |
| 67 |
index to a specific entry in the Vendor Specific Controller State UUID Supported. |
| 68 |
list of the Supported Controller State Formats data structure. |
| 69 |
.IP "sel" 12 |
| 70 |
Select (SEL): This field specifies the type of management operation to perform. |
| 71 |
.IP "uidx" 12 |
| 72 |
UUID Index (UIDX): If this field is set to a non-zero value, then the value of this |
| 73 |
field is the index of a UUID in the UUID List (refer to Figure 320) that is used by |
| 74 |
the command. |
| 75 |
.IP "stype" 12 |
| 76 |
Suspend Type (STYPE): This field specifies the type of suspend. |
| 77 |
.IP "seqind" 12 |
| 78 |
Sequence Identifier (SEQIND): This field identified the sequences of this Migration |
| 79 |
Send command in relation to other Migration Send commands. |
| 80 |
.IP "csvi" 12 |
| 81 |
Controller State Version Index (CSVI): A non-zero value in this field specifies the |
| 82 |
index to a specific entry in the NVMe Controller State Version list of the Supported |
| 83 |
Controller State Formats data structure. |
| 84 |
.IP "dudmq" 12 |
| 85 |
Delete User Data Migration Queue (DUDMQ): If set, the migration queue is deleted |
| 86 |
is deleted as part of the Suspend operation. If cleared, it is retained. |