Debian Codegraph @

doc/man/nvme_id_ns.2

raw
1 .TH "libnvme" 9 "struct nvme_id_ns" "November 2025" "API Manual" LINUX
2 .SH NAME
3 struct nvme_id_ns \- Identify Namespace data structure
4 .SH SYNOPSIS
5 struct nvme_id_ns {
6 .br
7 .BI " __le64 nsze;"
8 .br
9 .BI " __le64 ncap;"
10 .br
11 .BI " __le64 nuse;"
12 .br
13 .BI " __u8 nsfeat;"
14 .br
15 .BI " __u8 nlbaf;"
16 .br
17 .BI " __u8 flbas;"
18 .br
19 .BI " __u8 mc;"
20 .br
21 .BI " __u8 dpc;"
22 .br
23 .BI " __u8 dps;"
24 .br
25 .BI " __u8 nmic;"
26 .br
27 .BI " __u8 rescap;"
28 .br
29 .BI " __u8 fpi;"
30 .br
31 .BI " __u8 dlfeat;"
32 .br
33 .BI " __le16 nawun;"
34 .br
35 .BI " __le16 nawupf;"
36 .br
37 .BI " __le16 nacwu;"
38 .br
39 .BI " __le16 nabsn;"
40 .br
41 .BI " __le16 nabo;"
42 .br
43 .BI " __le16 nabspf;"
44 .br
45 .BI " __le16 noiob;"
46 .br
47 .BI " __u8 nvmcap[16];"
48 .br
49 .BI " __le16 npwg;"
50 .br
51 .BI " __le16 npwa;"
52 .br
53 .BI " __le16 npdg;"
54 .br
55 .BI " __le16 npda;"
56 .br
57 .BI " __le16 nows;"
58 .br
59 .BI " __le16 mssrl;"
60 .br
61 .BI " __le32 mcl;"
62 .br
63 .BI " __u8 msrc;"
64 .br
65 .BI " __u8 kpios;"
66 .br
67 .BI " __u8 nulbaf;"
68 .br
69 .BI " __u8 rsvd83;"
70 .br
71 .BI " __le32 kpiodaag;"
72 .br
73 .BI " __u8 rsvd88[4];"
74 .br
75 .BI " __le32 anagrpid;"
76 .br
77 .BI " __u8 rsvd96[3];"
78 .br
79 .BI " __u8 nsattr;"
80 .br
81 .BI " __le16 nvmsetid;"
82 .br
83 .BI " __le16 endgid;"
84 .br
85 .BI " __u8 nguid[16];"
86 .br
87 .BI " __u8 eui64[8];"
88 .br
89 .BI " struct nvme_lbaf lbaf[64];"
90 .br
91 .BI " __u8 vs[3712];"
92 .br
93 .BI "
94 };
95 .br
96
97 .SH Members
98 .IP "nsze" 12
99 Namespace Size indicates the total size of the namespace in
100 logical blocks. The number of logical blocks is based on the
101 formatted LBA size.
102 .IP "ncap" 12
103 Namespace Capacity indicates the maximum number of logical blocks
104 that may be allocated in the namespace at any point in time. The
105 number of logical blocks is based on the formatted LBA size.
106 .IP "nuse" 12
107 Namespace Utilization indicates the current number of logical
108 blocks allocated in the namespace. This field is smaller than or
109 equal to the Namespace Capacity. The number of logical blocks is
110 based on the formatted LBA size.
111 .IP "nsfeat" 12
112 Namespace Features, see \fIenum nvme_id_nsfeat\fP.
113 .IP "nlbaf" 12
114 Number of LBA Formats defines the number of supported LBA data
115 size and metadata size combinations supported by the namespace
116 and the highest possible index to \fIstruct nvme_id_ns\fP.lbaf.
117 .IP "flbas" 12
118 Formatted LBA Size, see \fIenum nvme_id_ns_flbas\fP.
119 .IP "mc" 12
120 Metadata Capabilities, see \fIenum nvme_id_ns_mc\fP.
121 .IP "dpc" 12
122 End-to-end Data Protection Capabilities, see
123 \fIenum nvme_id_ns_dpc\fP.
124 .IP "dps" 12
125 End-to-end Data Protection Type Settings, see
126 \fIenum nvme_id_ns_dps\fP.
127 .IP "nmic" 12
128 Namespace Multi-path I/O and Namespace Sharing Capabilities, see
129 \fIenum nvme_id_ns_nmic\fP.
130 .IP "rescap" 12
131 Reservation Capabilities, see \fIenum nvme_id_ns_rescap\fP.
132 .IP "fpi" 12
133 Format Progress Indicator, see \fIenum nvme_nd_ns_fpi\fP.
134 .IP "dlfeat" 12
135 Deallocate Logical Block Features, see \fIenum nvme_id_ns_dlfeat\fP.
136 .IP "nawun" 12
137 Namespace Atomic Write Unit Normal indicates the
138 namespace specific size of the write operation guaranteed to be
139 written atomically to the NVM during normal operation.
140 .IP "nawupf" 12
141 Namespace Atomic Write Unit Power Fail indicates the
142 namespace specific size of the write operation guaranteed to be
143 written atomically to the NVM during a power fail or error
144 condition.
145 .IP "nacwu" 12
146 Namespace Atomic Compare & Write Unit indicates the namespace
147 specific size of the write operation guaranteed to be written
148 atomically to the NVM for a Compare and Write fused command.
149 .IP "nabsn" 12
150 Namespace Atomic Boundary Size Normal indicates the atomic
151 boundary size for this namespace for the NAWUN value. This field
152 is specified in logical blocks.
153 .IP "nabo" 12
154 Namespace Atomic Boundary Offset indicates the LBA on this
155 namespace where the first atomic boundary starts.
156 .IP "nabspf" 12
157 Namespace Atomic Boundary Size Power Fail indicates the atomic
158 boundary size for this namespace specific to the Namespace Atomic
159 Write Unit Power Fail value. This field is specified in logical
160 blocks.
161 .IP "noiob" 12
162 Namespace Optimal I/O Boundary indicates the optimal I/O boundary
163 for this namespace. This field is specified in logical blocks.
164 The host should construct Read and Write commands that do not
165 cross the I/O boundary to achieve optimal performance.
166 .IP "nvmcap" 12
167 NVM Capacity indicates the total size of the NVM allocated to
168 this namespace. The value is in bytes.
169 .IP "npwg" 12
170 Namespace Preferred Write Granularity indicates the smallest
171 recommended write granularity in logical blocks for this
172 namespace. This is a 0's based value.
173 .IP "npwa" 12
174 Namespace Preferred Write Alignment indicates the recommended
175 write alignment in logical blocks for this namespace. This is a
176 0's based value.
177 .IP "npdg" 12
178 Namespace Preferred Deallocate Granularity indicates the
179 recommended granularity in logical blocks for the Dataset
180 Management command with the Attribute - Deallocate bit.
181 .IP "npda" 12
182 Namespace Preferred Deallocate Alignment indicates the
183 recommended alignment in logical blocks for the Dataset
184 Management command with the Attribute - Deallocate bit
185 .IP "nows" 12
186 Namespace Optimal Write Size indicates the size in logical blocks
187 for optimal write performance for this namespace. This is a 0's
188 based value.
189 .IP "mssrl" 12
190 Maximum Single Source Range Length indicates the maximum number
191 of logical blocks that may be specified in each valid Source Range
192 field of a Copy command.
193 .IP "mcl" 12
194 Maximum Copy Length indicates the maximum number of logical
195 blocks that may be specified in a Copy command.
196 .IP "msrc" 12
197 Maximum Source Range Count indicates the maximum number of Source
198 Range entries that may be used to specify source data in a Copy
199 command. This is a 0’s based value.
200 .IP "kpios" 12
201 Key Per I/O Status indicates namespace Key Per I/O capability status.
202 .IP "nulbaf" 12
203 Number of Unique Capability LBA Formats defines the number of
204 supported user data size and metadata size combinations supported
205 by the namespace that may not share the same capabilities. LBA
206 formats shall be allocated in order and packed sequentially.
207 .IP "rsvd83" 12
208 Reserved
209 .IP "kpiodaag" 12
210 Key Per I/O Data Access Alignment and Granularity indicates the
211 alignment and granularity in logical blocks that is required
212 for commands that support a KPIOTAG value in the CETYPE field.
213 .IP "rsvd88" 12
214 Reserved
215 .IP "anagrpid" 12
216 ANA Group Identifier indicates the ANA Group Identifier of the
217 ANA group of which the namespace is a member.
218 .IP "rsvd96" 12
219 Reserved
220 .IP "nsattr" 12
221 Namespace Attributes, see \fIenum nvme_id_ns_attr\fP.
222 .IP "nvmsetid" 12
223 NVM Set Identifier indicates the NVM Set with which this
224 namespace is associated.
225 .IP "endgid" 12
226 Endurance Group Identifier indicates the Endurance Group with
227 which this namespace is associated.
228 .IP "nguid" 12
229 Namespace Globally Unique Identifier contains a 128-bit value
230 that is globally unique and assigned to the namespace when the
231 namespace is created. This field remains fixed throughout the
232 life of the namespace and is preserved across namespace and
233 controller operations
234 .IP "eui64" 12
235 IEEE Extended Unique Identifier contains a 64-bit IEEE Extended
236 Unique Identifier (EUI-64) that is globally unique and assigned
237 to the namespace when the namespace is created. This field
238 remains fixed throughout the life of the namespace and is
239 preserved across namespace and controller operations
240 .IP "lbaf" 12
241 LBA Format, see \fIstruct nvme_lbaf\fP.
242 .IP "vs" 12
243 Vendor Specific