| 1 |
.TH "libnvme" 9 "struct nvme_format_nvm_args" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nvme_format_nvm_args \- Arguments for the Format Nvme Namespace command |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nvme_format_nvm_args { |
| 6 |
.br |
| 7 |
.BI " __u32 *result;" |
| 8 |
.br |
| 9 |
.BI " int args_size;" |
| 10 |
.br |
| 11 |
.BI " int fd;" |
| 12 |
.br |
| 13 |
.BI " __u32 timeout;" |
| 14 |
.br |
| 15 |
.BI " __u32 nsid;" |
| 16 |
.br |
| 17 |
.BI " enum nvme_cmd_format_mset mset;" |
| 18 |
.br |
| 19 |
.BI " enum nvme_cmd_format_pi pi;" |
| 20 |
.br |
| 21 |
.BI " enum nvme_cmd_format_pil pil;" |
| 22 |
.br |
| 23 |
.BI " enum nvme_cmd_format_ses ses;" |
| 24 |
.br |
| 25 |
.BI " __u8 lbaf;" |
| 26 |
.br |
| 27 |
.BI " __u8 rsvd1[7];" |
| 28 |
.br |
| 29 |
.BI " __u8 lbafu;" |
| 30 |
.br |
| 31 |
.BI " |
| 32 |
}; |
| 33 |
.br |
| 34 |
|
| 35 |
.SH Members |
| 36 |
.IP "result" 12 |
| 37 |
The command completion result from CQE dword0 |
| 38 |
.IP "args_size" 12 |
| 39 |
Size of \fIstruct nvme_format_nvm_args\fP |
| 40 |
.IP "fd" 12 |
| 41 |
File descriptor of nvme device |
| 42 |
.IP "timeout" 12 |
| 43 |
Set to override default timeout to this value in milliseconds; |
| 44 |
useful for long running formats. 0 will use system default. |
| 45 |
.IP "nsid" 12 |
| 46 |
Namespace ID to format |
| 47 |
.IP "mset" 12 |
| 48 |
Metadata settings (extended or separated), true if extended |
| 49 |
.IP "pi" 12 |
| 50 |
Protection information type |
| 51 |
.IP "pil" 12 |
| 52 |
Protection information location (beginning or end), true if end |
| 53 |
.IP "ses" 12 |
| 54 |
Secure erase settings |
| 55 |
.IP "lbaf" 12 |
| 56 |
Logical block address format least significant 4 bits |
| 57 |
.IP "rsvd1" 12 |
| 58 |
Reserved |
| 59 |
.IP "lbafu" 12 |
| 60 |
Logical block address format most significant 2 bits |