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
|
// SPDX-License-Identifier: LGPL-2.1-or-later
/*
* This file is part of libnvme.
* Copyright (c) 2020 Western Digital Corporation or its affiliates.
*
* Authors: Keith Busch <keith.busch@wdc.com>
* Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
*/
#ifndef _LIBNVME_LINUX_H
#define _LIBNVME_LINUX_H
#include <stddef.h>
#include "ioctl.h"
#include "types.h"
/**
* DOC: linux.h
*
* linux-specific utility functions
*/
/**
* nvme_fw_download_seq() - Firmware download sequence
* @fd: File descriptor of nvme device
* @size: Total size of the firmware image to transfer
* @xfer: Maximum size to send with each partial transfer
* @offset: Starting offset to send with this firmware download
* @buf: Address of buffer containing all or part of the firmware image.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_fw_download_seq(int fd, __u32 size, __u32 xfer, __u32 offset,
void *buf);
/**
* enum nvme_telemetry_da - Telemetry Log Data Area
* @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
*/
enum nvme_telemetry_da {
NVME_TELEMETRY_DA_1 = 1,
NVME_TELEMETRY_DA_2 = 2,
NVME_TELEMETRY_DA_3 = 3,
NVME_TELEMETRY_DA_4 = 4,
};
/**
* nvme_get_ctrl_telemetry() - Get controller telemetry log
* @fd: File descriptor of nvme device
* @rae: Retain asynchronous events
* @log: On success, set to the value of the allocated and retrieved log.
* @da: Log page data area, valid values: &enum nvme_telemetry_da
* @size: Ptr to the telemetry log size, so it can be returned
*
* 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
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_ctrl_telemetry(int fd, bool rae, struct nvme_telemetry_log **log,
enum nvme_telemetry_da da, size_t *size);
/**
* nvme_get_host_telemetry() - Get host telemetry log
* @fd: File descriptor of nvme device
* @log: On success, set to the value of the allocated and retrieved log.
* @da: Log page data area, valid values: &enum nvme_telemetry_da
* @size: Ptr to the telemetry log size, so it can be returned
*
* 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
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_host_telemetry(int fd, struct nvme_telemetry_log **log,
enum nvme_telemetry_da da, size_t *size);
/**
* nvme_get_new_host_telemetry() - Get new host telemetry log
* @fd: File descriptor of nvme device
* @log: On success, set to the value of the allocated and retrieved log.
* @da: Log page data area, valid values: &enum nvme_telemetry_da
* @size: Ptr to the telemetry log size, so it can be returned
*
* 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
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_new_host_telemetry(int fd, struct nvme_telemetry_log **log,
enum nvme_telemetry_da da, size_t *size);
/**
* nvme_get_ana_log_len() - Retrieve size of the current ANA log
* @fd: File descriptor of nvme device
* @analen: Pointer to where the length will be set on success
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_ana_log_len(int fd, size_t *analen);
/**
* nvme_get_logical_block_size() - Retrieve block size
* @fd: File descriptor of nvme device
* @nsid: Namespace id
* @blksize: Pointer to where the block size will be set on success
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_logical_block_size(int fd, __u32 nsid, int *blksize);
/**
* nvme_get_lba_status_log() - Retrieve the LBA Status log page
* @fd: File descriptor of the nvme device
* @rae: Retain asynchronous events
* @log: On success, set to the value of the allocated and retrieved log.
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_get_lba_status_log(int fd, bool rae, struct nvme_lba_status_log **log);
/**
* nvme_namespace_attach_ctrls() - Attach namespace to controller(s)
* @fd: File descriptor of nvme device
* @nsid: Namespace ID to attach
* @num_ctrls: Number of controllers in ctrlist
* @ctrlist: List of controller IDs to perform the attach action
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_namespace_attach_ctrls(int fd, __u32 nsid, __u16 num_ctrls, __u16 *ctrlist);
/**
* nvme_namespace_detach_ctrls() - Detach namespace from controller(s)
* @fd: File descriptor of nvme device
* @nsid: Namespace ID to detach
* @num_ctrls: Number of controllers in ctrlist
* @ctrlist: List of controller IDs to perform the detach action
*
* Return: The nvme command status if a response was received (see
* &enum nvme_status_field) or -1 with errno set otherwise.
*/
int nvme_namespace_detach_ctrls(int fd, __u32 nsid, __u16 num_ctrls, __u16 *ctrlist);
/**
* nvme_open() - Open an nvme controller or namespace device
* @name: The basename of the device to open
*
* 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.
*/
int nvme_open(const char *name);
/**
* enum nvme_hmac_alg - HMAC algorithm
* @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
*/
enum nvme_hmac_alg {
NVME_HMAC_ALG_NONE = 0,
NVME_HMAC_ALG_SHA2_256 = 1,
NVME_HMAC_ALG_SHA2_384 = 2,
NVME_HMAC_ALG_SHA2_512 = 3,
};
/**
* nvme_gen_dhchap_key() - DH-HMAC-CHAP key generation
* @hostnqn: Host NVMe Qualified Name
* @hmac: HMAC algorithm
* @key_len: Output key length
* @secret: Secret to used for digest
* @key: Generated DH-HMAC-CHAP key
*
* Return: If key generation was successful the function returns 0 or
* -1 with errno set otherwise.
*/
int nvme_gen_dhchap_key(char *hostnqn, enum nvme_hmac_alg hmac,
unsigned int key_len, unsigned char *secret,
unsigned char *key);
/**
* nvme_lookup_keyring() - Lookup keyring serial number
* @keyring: Keyring name
*
* Looks up the serial number of the keyring @keyring.
*
* Return: The key serial number of the keyring
* or 0 with errno set otherwise.
*/
long nvme_lookup_keyring(const char *keyring);
/**
* nvme_describe_key_serial() - Return key description
* @key_id: Key serial number
*
* Fetches the description of the key or keyring identified
* by the serial number @key_id.
*
* Return: The description of @key_id or NULL on failure.
* The returned string needs to be freed by the caller.
*/
char *nvme_describe_key_serial(long key_id);
/**
* nvme_lookup_key() - Lookup key serial number
* @type: Key type
* @identity: Key description
*
* Looks up the serial number of the key @identity
* with type %type in the current session keyring.
*
* Return: The key serial number of the key
* or 0 with errno set otherwise.
*/
long nvme_lookup_key(const char *type, const char *identity);
/**
* nvme_set_keyring() - Link keyring for lookup
* @keyring_id: Keyring id
*
* Links @keyring_id into the session keyring such that
* its keys are available for further key lookups.
*
* Return: 0 on success, a negative number on error
* with errno set.
*/
int nvme_set_keyring(long keyring_id);
/**
* nvme_insert_tls_key() - Derive and insert TLS key
* @keyring: Keyring to use
* @key_type: Type of the resulting key
* @hostnqn: Host NVMe Qualified Name
* @subsysnqn: Subsystem NVMe Qualified Name
* @hmac: HMAC algorithm
* @configured_key: Configured key data to derive the key from
* @key_len: Length of @configured_key
*
* Derives a 'retained' TLS key as specified in NVMe TCP 1.0a and
* stores it as type @key_type in the keyring specified by @keyring.
*
* Return: The key serial number if the key could be inserted into
* the keyring or 0 with errno otherwise.
*/
long nvme_insert_tls_key(const char *keyring, const char *key_type,
const char *hostnqn, const char *subsysnqn, int hmac,
unsigned char *configured_key, int key_len);
#endif /* _LIBNVME_LINUX_H */
|
