summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_format_nvm_args.2
blob: 53f4fcb3a94087629f73966c278d30fb69d8c2ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
.TH "libnvme" 9 "struct nvme_format_nvm_args" "April 2022" "API Manual" LINUX
.SH NAME
struct nvme_format_nvm_args \- Arguments for the Format Nvme Namespace command
.SH SYNOPSIS
struct nvme_format_nvm_args {
.br
.BI "    __u32 *result;"
.br
.BI "    int args_size;"
.br
.BI "    int fd;"
.br
.BI "    __u32 timeout;"
.br
.BI "    __u32 nsid;"
.br
.BI "    enum nvme_cmd_format_mset mset;"
.br
.BI "    enum nvme_cmd_format_pi pi;"
.br
.BI "    enum nvme_cmd_format_pil pil;"
.br
.BI "    enum nvme_cmd_format_ses ses;"
.br
.BI "    __u8 lbaf;"
.br
.BI "
};
.br

.SH Members
.IP "result" 12
The command completion result from CQE dword0
.IP "args_size" 12
Size of \fIstruct nvme_format_nvm_args\fP
.IP "fd" 12
File descriptor of nvme device
.IP "timeout" 12
Set to override default timeout to this value in milliseconds;
useful for long running formats. 0 will use system default.
.IP "nsid" 12
Namespace ID to format
.IP "mset" 12
Metadata settings (extended or separated), true if extended
.IP "pi" 12
Protection information type
.IP "pil" 12
Protection information location (beginning or end), true if end
.IP "ses" 12
Secure erase settings
.IP "lbaf" 12
Logical block address format