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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
.. _linux.h:
**linux.h**
linux-specific utility functions
.. c:function:: int nvme_fw_download_seq (int fd, __u32 size, __u32 xfer, __u32 offset, void *buf)
Firmware download sequence
**Parameters**
``int fd``
File descriptor of nvme device
``__u32 size``
Total size of the firmware image to transfer
``__u32 xfer``
Maximum size to send with each partial transfer
``__u32 offset``
Starting offset to send with this firmware download
``void *buf``
Address of buffer containing all or part of the firmware image.
**Return**
The nvme command status if a response was received (see
:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
.. c:enum:: nvme_telemetry_da
Telemetry Log Data Area
**Constants**
``NVME_TELEMETRY_DA_1``
Data Area 1
``NVME_TELEMETRY_DA_2``
Data Area 2
``NVME_TELEMETRY_DA_3``
Data Area 3
``NVME_TELEMETRY_DA_4``
Data Area 4
.. c:function:: int nvme_get_ctrl_telemetry (int fd, bool rae, struct nvme_telemetry_log **log, enum nvme_telemetry_da da, size_t *size)
Get controller telemetry log
**Parameters**
``int fd``
File descriptor of nvme device
``bool rae``
Retain asynchronous events
``struct nvme_telemetry_log **log``
On success, set to the value of the allocated and retrieved log.
``enum nvme_telemetry_da da``
Log page data area, valid values: :c:type:`enum nvme_telemetry_da <nvme_telemetry_da>`
``size_t *size``
Ptr to the telemetry log size, so it can be returned
**Description**
The total size allocated can be calculated as:
(nvme_telemetry_log da size + 1) * NVME_LOG_TELEM_BLOCK_SIZE.
**Return**
The nvme command status if a response was received (see
:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
.. c:function:: int nvme_get_host_telemetry (int fd, struct nvme_telemetry_log **log, enum nvme_telemetry_da da, size_t *size)
Get host telemetry log
**Parameters**
``int fd``
File descriptor of nvme device
``struct nvme_telemetry_log **log``
On success, set to the value of the allocated and retrieved log.
``enum nvme_telemetry_da da``
Log page data area, valid values: :c:type:`enum nvme_telemetry_da <nvme_telemetry_da>`
``size_t *size``
Ptr to the telemetry log size, so it can be returned
**Description**
The total size allocated can be calculated as:
(nvme_telemetry_log da size + 1) * NVME_LOG_TELEM_BLOCK_SIZE.
**Return**
The nvme command status if a response was received (see
:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
.. c:function:: int nvme_get_new_host_telemetry (int fd, struct nvme_telemetry_log **log, enum nvme_telemetry_da da, size_t *size)
Get new host telemetry log
**Parameters**
``int fd``
File descriptor of nvme device
``struct nvme_telemetry_log **log``
On success, set to the value of the allocated and retrieved log.
``enum nvme_telemetry_da da``
Log page data area, valid values: :c:type:`enum nvme_telemetry_da <nvme_telemetry_da>`
``size_t *size``
Ptr to the telemetry log size, so it can be returned
**Description**
The total size allocated can be calculated as:
(nvme_telemetry_log da size + 1) * NVME_LOG_TELEM_BLOCK_SIZE.
**Return**
The nvme command status if a response was received (see
:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
.. c:function:: int nvme_get_ana_log_len (int fd, size_t *analen)
Retrieve size of the current ANA log
**Parameters**
``int fd``
File descriptor of nvme device
``size_t *analen``
Pointer to where the length will be set on success
**Return**
The nvme command status if a response was received (see
:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
.. c:function:: int nvme_get_logical_block_size (int fd, __u32 nsid, int *blksize)
Retrieve block size
**Parameters**
``int fd``
File descriptor of nvme device
``__u32 nsid``
Namespace id
``int *blksize``
Pointer to where the block size will be set on success
**Return**
The nvme command status if a response was received (see
:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
.. c:function:: int nvme_get_lba_status_log (int fd, bool rae, struct nvme_lba_status_log **log)
Retrieve the LBA Status log page
**Parameters**
``int fd``
File descriptor of the nvme device
``bool rae``
Retain asynchronous events
``struct nvme_lba_status_log **log``
On success, set to the value of the allocated and retrieved log.
**Return**
The nvme command status if a response was received (see
:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
.. c:function:: int nvme_namespace_attach_ctrls (int fd, __u32 nsid, __u16 num_ctrls, __u16 *ctrlist)
Attach namespace to controller(s)
**Parameters**
``int fd``
File descriptor of nvme device
``__u32 nsid``
Namespace ID to attach
``__u16 num_ctrls``
Number of controllers in ctrlist
``__u16 *ctrlist``
List of controller IDs to perform the attach action
**Return**
The nvme command status if a response was received (see
:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
.. c:function:: int nvme_namespace_detach_ctrls (int fd, __u32 nsid, __u16 num_ctrls, __u16 *ctrlist)
Detach namespace from controller(s)
**Parameters**
``int fd``
File descriptor of nvme device
``__u32 nsid``
Namespace ID to detach
``__u16 num_ctrls``
Number of controllers in ctrlist
``__u16 *ctrlist``
List of controller IDs to perform the detach action
**Return**
The nvme command status if a response was received (see
:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
.. c:function:: int nvme_open (const char *name)
Open an nvme controller or namespace device
**Parameters**
``const char *name``
The basename of the device to open
**Description**
This will look for the handle in /dev/ and validate the name and filetype
match linux conventions.
**Return**
A file descriptor for the device on a successful open, or -1 with
errno set otherwise.
.. c:enum:: nvme_hmac_alg
HMAC algorithm
**Constants**
``NVME_HMAC_ALG_NONE``
No HMAC algorithm
``NVME_HMAC_ALG_SHA2_256``
SHA2-256
``NVME_HMAC_ALG_SHA2_384``
SHA2-384
``NVME_HMAC_ALG_SHA2_512``
SHA2-512
.. c:function:: int nvme_gen_dhchap_key (char *hostnqn, enum nvme_hmac_alg hmac, unsigned int key_len, unsigned char *secret, unsigned char *key)
DH-HMAC-CHAP key generation
**Parameters**
``char *hostnqn``
Host NVMe Qualified Name
``enum nvme_hmac_alg hmac``
HMAC algorithm
``unsigned int key_len``
Output key length
``unsigned char *secret``
Secret to used for digest
``unsigned char *key``
Generated DH-HMAC-CHAP key
**Return**
If key generation was successful the function returns 0 or
-1 with errno set otherwise.
|
