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
|
/*
* Copyright (c) 2023-2024 Ian Marco Moffett and the Osmora Team.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of Hyra nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _IC_NVMEVAR_H_
#define _IC_NVMEVAR_H_
#include <sys/cdefs.h>
/* Admin commands */
#define NVME_OP_CREATE_IOSQ 0x01
#define NVME_OP_CREATE_IOCQ 0x05
#define NVME_OP_IDENTIFY 0x06
/* I/O commands */
#define NVME_OP_READ 0x02
struct nvme_common_cmd {
uint8_t opcode;
uint8_t flags;
uint16_t cid;
uint32_t nsid;
uint32_t cdw1[2];
uint64_t metadata;
uint64_t prp1;
uint64_t prp2;
uint32_t cdw2[6];
};
struct nvme_identify_cmd {
uint8_t opcode;
uint8_t flags;
uint16_t cid;
uint32_t nsid;
uint64_t unused1;
uint64_t unused2;
uint64_t prp1;
uint64_t prp2;
uint32_t cns;
uint32_t unused3[5];
};
/* Read/write */
struct nvme_rw_cmd {
uint8_t opcode;
uint8_t flags;
uint16_t cid;
uint32_t nsid;
uint64_t unused;
uint64_t metadata;
uint64_t prp1;
uint64_t prp2;
uint64_t slba;
uint16_t len;
uint16_t control;
uint32_t dsmgmt;
uint32_t ref;
uint16_t apptag;
uint16_t appmask;
};
/* Create I/O completion queue */
struct nvme_create_iocq_cmd {
uint8_t opcode;
uint8_t flags;
uint16_t cid;
uint32_t unused1[5];
uint64_t prp1;
uint64_t unused2;
uint16_t qid;
uint16_t qsize;
uint16_t qflags;
uint16_t irqvec;
uint64_t unused3[2];
};
struct nvme_create_iosq_cmd {
uint8_t opcode;
uint8_t flags;
uint16_t cid;
uint32_t unused1[5];
uint64_t prp1;
uint64_t unused2;
uint16_t sqid;
uint16_t qsize;
uint16_t qflags;
uint16_t cqid;
uint64_t unused3[2];
};
struct nvme_cmd {
union {
struct nvme_identify_cmd identify;
struct nvme_common_cmd common;
struct nvme_create_iocq_cmd create_iocq;
struct nvme_create_iosq_cmd create_iosq;
};
};
struct nvme_id {
uint16_t vid;
uint16_t ssvid;
char sn[20];
char mn[40];
char fr[8];
uint8_t rab;
uint8_t ieee[3];
uint8_t mic;
uint8_t mdts;
uint16_t ctrlid;
uint32_t version;
uint32_t unused1[43];
uint16_t oacs;
uint8_t acl;
uint8_t aerl;
uint8_t fw;
uint8_t lpa;
uint8_t elpe;
uint8_t npss;
uint8_t avscc;
uint8_t apsta;
uint16_t wctemp;
uint16_t cctemp;
uint16_t unused2[121];
uint8_t sqes;
uint8_t cqes;
uint16_t unused3;
uint32_t nn;
uint16_t oncs;
uint16_t fuses;
uint8_t fna;
uint8_t vwc;
uint16_t awun;
uint16_t awupf;
uint8_t nvscc;
uint8_t unused4;
uint16_t acwu;
uint16_t unused5;
uint32_t sgls;
uint32_t unused6[1401];
uint8_t vs[1024];
};
/* Command completion queue entry */
struct nvme_cq_entry {
uint32_t res;
uint32_t unused;
uint16_t sqhead;
uint16_t sqid;
uint16_t cid;
uint16_t status;
};
/* NVMe controller */
struct __packed nvme_bar {
uint64_t caps;
uint32_t version;
uint32_t intms; /* Interrupt mask set */
uint32_t intmc; /* Interrupt mask clear */
uint32_t config;
uint32_t unused1;
uint32_t status;
uint32_t unused2;
uint32_t aqa; /* Admin queue attributes */
uint64_t asq; /* Admin submission queue */
uint64_t acq; /* Admin completion queue */
};
struct nvme_lbaf {
uint16_t ms; /* Number of metadata bytes per LBA */
uint8_t ds; /* Data size */
uint8_t rp;
};
/* Identify namespace data */
struct nvme_id_ns {
uint64_t size;
uint64_t capabilities;
uint64_t nuse;
uint8_t features;
uint8_t nlbaf;
uint8_t flbas;
uint8_t mc;
uint8_t dpc;
uint8_t dps;
uint8_t nmic;
uint8_t rescap;
uint8_t fpi;
uint8_t unused1;
uint16_t nawun;
uint16_t nawupf;
uint16_t nacwu;
uint16_t nabsn;
uint16_t nabo;
uint16_t nabspf;
uint16_t unused2;
uint64_t nvmcap[2];
uint64_t unusued3[5];
uint8_t nguid[16];
uint8_t eui64[8];
struct nvme_lbaf lbaf[16];
uint64_t unused3[24];
uint8_t vs[3712];
};
struct nvme_queue {
struct nvme_cmd *sq; /* Submission queue */
struct nvme_cq_entry *cq; /* Completion queue */
uint16_t sq_head; /* Submission queue head */
uint16_t sq_tail; /* Submission queue tail */
uint16_t cq_head; /* Completion queue head */
uint8_t cq_phase : 1; /* Completion queue phase bit */
uint16_t size; /* Size in elements */
volatile uint32_t *sq_db; /* Submission doorbell */
volatile uint32_t *cq_db; /* Completion doorbell */
};
struct nvme_state {
struct nvme_queue adminq;
struct nvme_bar *bar;
};
/* NVMe namespace */
struct nvme_ns {
size_t nsid; /* Namespace ID */
size_t lba_bsize; /* LBA block size */
size_t size; /* Size in logical blocks */
struct nvme_queue ioq; /* I/O queue */
struct nvme_lbaf lba_fmt; /* LBA format */
struct nvme_state *cntl; /* NVMe controller */
TAILQ_ENTRY(nvme_ns) link;
};
#endif
|
