summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_constants.2
blob: e16aec49375c6d05d1056f69b7073220e1576c8b (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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
.TH "libnvme" 9 "enum nvme_constants" "January 2023" "API Manual" LINUX
.SH NAME
enum nvme_constants \- A place to stash various constant nvme values
.SH SYNOPSIS
enum nvme_constants {
.br
.BI "    NVME_NSID_ALL"
, 
.br
.br
.BI "    NVME_NSID_NONE"
, 
.br
.br
.BI "    NVME_UUID_NONE"
, 
.br
.br
.BI "    NVME_CNTLID_NONE"
, 
.br
.br
.BI "    NVME_CNSSPECID_NONE"
, 
.br
.br
.BI "    NVME_LOG_LSP_NONE"
, 
.br
.br
.BI "    NVME_LOG_LSI_NONE"
, 
.br
.br
.BI "    NVME_LOG_LPO_NONE"
, 
.br
.br
.BI "    NVME_IDENTIFY_DATA_SIZE"
, 
.br
.br
.BI "    NVME_LOG_SUPPORTED_LOG_PAGES_MAX"
, 
.br
.br
.BI "    NVME_ID_NVMSET_LIST_MAX"
, 
.br
.br
.BI "    NVME_ID_UUID_LIST_MAX"
, 
.br
.br
.BI "    NVME_ID_CTRL_LIST_MAX"
, 
.br
.br
.BI "    NVME_ID_NS_LIST_MAX"
, 
.br
.br
.BI "    NVME_ID_SECONDARY_CTRL_MAX"
, 
.br
.br
.BI "    NVME_ID_DOMAIN_LIST_MAX"
, 
.br
.br
.BI "    NVME_ID_ENDURANCE_GROUP_LIST_MAX"
, 
.br
.br
.BI "    NVME_ID_ND_DESCRIPTOR_MAX"
, 
.br
.br
.BI "    NVME_FEAT_LBA_RANGE_MAX"
, 
.br
.br
.BI "    NVME_LOG_ST_MAX_RESULTS"
, 
.br
.br
.BI "    NVME_LOG_TELEM_BLOCK_SIZE"
, 
.br
.br
.BI "    NVME_LOG_FID_SUPPORTED_EFFECTS_MAX"
, 
.br
.br
.BI "    NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_MAX"
, 
.br
.br
.BI "    NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_RESERVED"
, 
.br
.br
.BI "    NVME_DSM_MAX_RANGES"
, 
.br
.br
.BI "    NVME_NQN_LENGTH"
, 
.br
.br
.BI "    NVMF_TRADDR_SIZE"
, 
.br
.br
.BI "    NVMF_TSAS_SIZE"
, 
.br
.br
.BI "    NVME_ZNS_CHANGED_ZONES_MAX"

};
.SH Constants
.IP "NVME_NSID_ALL" 12
A broadcast value that is used to specify all
namespaces
.IP "NVME_NSID_NONE" 12
The invalid namespace id, for when the nsid
parameter is not used in a command
.IP "NVME_UUID_NONE" 12
Use to omit a uuid command parameter
.IP "NVME_CNTLID_NONE" 12
Use to omit a cntlid command parameter
.IP "NVME_CNSSPECID_NONE" 12
Use to omit a cns_specific_id command parameter
.IP "NVME_LOG_LSP_NONE" 12
Use to omit a log lsp command parameter
.IP "NVME_LOG_LSI_NONE" 12
Use to omit a log lsi command parameter
.IP "NVME_LOG_LPO_NONE" 12
Use to omit a log lpo command parameter
.IP "NVME_IDENTIFY_DATA_SIZE" 12
The transfer size for nvme identify commands
.IP "NVME_LOG_SUPPORTED_LOG_PAGES_MAX" 12
The largest possible index in the supported
log pages log.
.IP "NVME_ID_NVMSET_LIST_MAX" 12
The largest possible nvmset index in identify
nvmeset
.IP "NVME_ID_UUID_LIST_MAX" 12
The largest possible uuid index in identify
uuid list
.IP "NVME_ID_CTRL_LIST_MAX" 12
The largest possible controller index in
identify controller list
.IP "NVME_ID_NS_LIST_MAX" 12
The largest possible namespace index in
identify namespace list
.IP "NVME_ID_SECONDARY_CTRL_MAX" 12
The largest possible secondary controller index
in identify secondary controller
.IP "NVME_ID_DOMAIN_LIST_MAX" 12
The largest possible domain index in the
in domain list
.IP "NVME_ID_ENDURANCE_GROUP_LIST_MAX" 12
The largest possible endurance group
index in the endurance group list
.IP "NVME_ID_ND_DESCRIPTOR_MAX" 12
The largest possible namespace granularity
index in the namespace granularity descriptor
list
.IP "NVME_FEAT_LBA_RANGE_MAX" 12
The largest possible LBA range index in feature
lba range type
.IP "NVME_LOG_ST_MAX_RESULTS" 12
The largest possible self test result index in the
device self test log
.IP "NVME_LOG_TELEM_BLOCK_SIZE" 12
Specification defined size of Telemetry Data Blocks
.IP "NVME_LOG_FID_SUPPORTED_EFFECTS_MAX" 12
The largest possible FID index in the
feature identifiers effects log.
.IP "NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_MAX" 12
The largest possible MI Command index
in the MI Command effects log.
.IP "NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_RESERVED" 12
The reserved space in the MI Command
effects log.
.IP "NVME_DSM_MAX_RANGES" 12
The largest possible range index in a data-set
management command
.IP "NVME_NQN_LENGTH" 12
Max length for NVMe Qualified Name
.IP "NVMF_TRADDR_SIZE" 12
Max Transport Address size
.IP "NVMF_TSAS_SIZE" 12
Max Transport Specific Address Subtype size
.IP "NVME_ZNS_CHANGED_ZONES_MAX" 12
Max number of zones in the changed zones log
page