ld_nvme.c revision 1.22 1 /* $NetBSD: ld_nvme.c,v 1.22 2019/04/26 14:28:40 mlelstv Exp $ */
2
3 /*-
4 * Copyright (C) 2016 NONAKA Kimihiro <nonaka (at) netbsd.org>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 #include <sys/cdefs.h>
29 __KERNEL_RCSID(0, "$NetBSD: ld_nvme.c,v 1.22 2019/04/26 14:28:40 mlelstv Exp $");
30
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
34 #include <sys/device.h>
35 #include <sys/buf.h>
36 #include <sys/bufq.h>
37 #include <sys/disk.h>
38 #include <sys/kmem.h>
39 #include <sys/module.h>
40
41 #include <dev/ldvar.h>
42 #include <dev/ic/nvmereg.h>
43 #include <dev/ic/nvmevar.h>
44
45 #include "ioconf.h"
46
47 struct ld_nvme_softc {
48 struct ld_softc sc_ld;
49 struct nvme_softc *sc_nvme;
50
51 uint16_t sc_nsid;
52 };
53
54 static int ld_nvme_match(device_t, cfdata_t, void *);
55 static void ld_nvme_attach(device_t, device_t, void *);
56 static int ld_nvme_detach(device_t, int);
57
58 CFATTACH_DECL_NEW(ld_nvme, sizeof(struct ld_nvme_softc),
59 ld_nvme_match, ld_nvme_attach, ld_nvme_detach, NULL);
60
61 static int ld_nvme_start(struct ld_softc *, struct buf *);
62 static int ld_nvme_dump(struct ld_softc *, void *, int, int);
63 static int ld_nvme_flush(struct ld_softc *, bool);
64 static int ld_nvme_getcache(struct ld_softc *, int *);
65 static int ld_nvme_ioctl(struct ld_softc *, u_long, void *, int32_t, bool);
66
67 static void ld_nvme_biodone(void *, struct buf *, uint16_t, uint32_t);
68
69 static int
70 ld_nvme_match(device_t parent, cfdata_t match, void *aux)
71 {
72 struct nvme_attach_args *naa = aux;
73
74 if (naa->naa_nsid == 0)
75 return 0;
76
77 return 1;
78 }
79
80 static void
81 ld_nvme_attach(device_t parent, device_t self, void *aux)
82 {
83 struct ld_nvme_softc *sc = device_private(self);
84 struct ld_softc *ld = &sc->sc_ld;
85 struct nvme_softc *nsc = device_private(parent);
86 struct nvme_attach_args *naa = aux;
87 struct nvme_namespace *ns;
88 struct nvm_namespace_format *f;
89 int error;
90
91 ld->sc_dv = self;
92 sc->sc_nvme = nsc;
93 sc->sc_nsid = naa->naa_nsid;
94
95 aprint_naive("\n");
96 aprint_normal("\n");
97
98 error = nvme_ns_identify(sc->sc_nvme, sc->sc_nsid);
99 if (error) {
100 aprint_error_dev(self, "couldn't identify namespace\n");
101 return;
102 }
103
104 ns = nvme_ns_get(sc->sc_nvme, sc->sc_nsid);
105 KASSERT(ns);
106 f = &ns->ident->lbaf[NVME_ID_NS_FLBAS(ns->ident->flbas)];
107
108 ld->sc_secsize = 1 << f->lbads;
109 ld->sc_secperunit = ns->ident->nsze;
110 ld->sc_maxxfer = naa->naa_maxphys;
111 ld->sc_maxqueuecnt = naa->naa_qentries;
112 ld->sc_start = ld_nvme_start;
113 ld->sc_dump = ld_nvme_dump;
114 ld->sc_ioctl = ld_nvme_ioctl;
115 ld->sc_flags = LDF_ENABLED | LDF_NO_RND | LDF_MPSAFE;
116 ld->sc_typename = kmem_asprintf("%s", naa->naa_typename);
117 ldattach(ld, "fcfs");
118 }
119
120 static int
121 ld_nvme_detach(device_t self, int flags)
122 {
123 struct ld_nvme_softc *sc = device_private(self);
124 struct ld_softc *ld = &sc->sc_ld;
125 int rv;
126
127 if ((rv = ldbegindetach(ld, flags)) != 0)
128 return rv;
129 ldenddetach(ld);
130
131 kmem_free(ld->sc_typename, strlen(ld->sc_typename) + 1);
132
133 nvme_ns_free(sc->sc_nvme, sc->sc_nsid);
134
135 return 0;
136 }
137
138 static int
139 ld_nvme_start(struct ld_softc *ld, struct buf *bp)
140 {
141 struct ld_nvme_softc *sc = device_private(ld->sc_dv);
142 int flags = BUF_ISWRITE(bp) ? 0 : NVME_NS_CTX_F_READ;
143
144 if (bp->b_flags & B_MEDIA_FUA)
145 flags |= NVME_NS_CTX_F_FUA;
146
147 return nvme_ns_dobio(sc->sc_nvme, sc->sc_nsid, sc,
148 bp, bp->b_data, bp->b_bcount,
149 sc->sc_ld.sc_secsize, bp->b_rawblkno,
150 flags,
151 ld_nvme_biodone);
152 }
153
154 static int
155 ld_nvme_dump(struct ld_softc *ld, void *data, int blkno, int blkcnt)
156 {
157 struct ld_nvme_softc *sc = device_private(ld->sc_dv);
158
159 return nvme_ns_dobio(sc->sc_nvme, sc->sc_nsid, sc,
160 NULL, data, blkcnt * ld->sc_secsize,
161 sc->sc_ld.sc_secsize, blkno,
162 NVME_NS_CTX_F_POLL,
163 ld_nvme_biodone);
164 }
165
166 static void
167 ld_nvme_biodone(void *xc, struct buf *bp, uint16_t cmd_status, uint32_t cdw0)
168 {
169 struct ld_nvme_softc *sc = xc;
170 uint16_t status = NVME_CQE_SC(cmd_status);
171
172 if (bp != NULL) {
173 if (status != NVME_CQE_SC_SUCCESS) {
174 bp->b_error = EIO;
175 bp->b_resid = bp->b_bcount;
176 aprint_error_dev(sc->sc_ld.sc_dv, "I/O error\n");
177 } else {
178 bp->b_resid = 0;
179 }
180 lddone(&sc->sc_ld, bp);
181 } else {
182 if (status != NVME_CQE_SC_SUCCESS) {
183 aprint_error_dev(sc->sc_ld.sc_dv, "I/O error\n");
184 }
185 }
186 }
187
188 static int
189 ld_nvme_flush(struct ld_softc *ld, bool poll)
190 {
191 struct ld_nvme_softc *sc = device_private(ld->sc_dv);
192
193 return nvme_ns_sync(sc->sc_nvme, sc->sc_nsid,
194 poll ? NVME_NS_CTX_F_POLL : 0);
195 }
196
197 static int
198 ld_nvme_getcache(struct ld_softc *ld, int *addr)
199 {
200 struct ld_nvme_softc *sc = device_private(ld->sc_dv);
201
202 return nvme_admin_getcache(sc->sc_nvme, addr);
203 }
204
205 static int
206 ld_nvme_setcache(struct ld_softc *ld, int addr)
207 {
208 struct ld_nvme_softc *sc = device_private(ld->sc_dv);
209
210 return nvme_admin_setcache(sc->sc_nvme, addr);
211 }
212
213 static int
214 ld_nvme_ioctl(struct ld_softc *ld, u_long cmd, void *addr, int32_t flag, bool poll)
215 {
216 int error;
217
218 switch (cmd) {
219 case DIOCCACHESYNC:
220 error = ld_nvme_flush(ld, poll);
221 break;
222
223 case DIOCGCACHE:
224 error = ld_nvme_getcache(ld, (int *)addr);
225 break;
226
227 case DIOCSCACHE:
228 error = ld_nvme_setcache(ld, *(int *)addr);
229 break;
230
231 default:
232 error = EPASSTHROUGH;
233 break;
234 }
235
236 return error;
237 }
238
239 MODULE(MODULE_CLASS_DRIVER, ld_nvme, "ld,nvme,bufq_fcfs");
240
241 #ifdef _MODULE
242 /*
243 * XXX Don't allow ioconf.c to redefine the "struct cfdriver ld_cd"
244 * XXX it will be defined in the common-code module
245 */
246 #undef CFDRIVER_DECL
247 #define CFDRIVER_DECL(name, class, attr)
248 #include "ioconf.c"
249 #endif
250
251 static int
252 ld_nvme_modcmd(modcmd_t cmd, void *opaque)
253 {
254 #ifdef _MODULE
255 /*
256 * We ignore the cfdriver_vec[] that ioconf provides, since
257 * the cfdrivers are attached already.
258 */
259 static struct cfdriver * const no_cfdriver_vec[] = { NULL };
260 #endif
261 int error = 0;
262
263 #ifdef _MODULE
264 switch (cmd) {
265 case MODULE_CMD_INIT:
266 error = config_init_component(no_cfdriver_vec,
267 cfattach_ioconf_ld_nvme, cfdata_ioconf_ld_nvme);
268 break;
269 case MODULE_CMD_FINI:
270 error = config_fini_component(no_cfdriver_vec,
271 cfattach_ioconf_ld_nvme, cfdata_ioconf_ld_nvme);
272 break;
273 default:
274 error = ENOTTY;
275 break;
276 }
277 #endif
278
279 return error;
280 }
281