ld_nvme.c revision 1.11 1 /* $NetBSD: ld_nvme.c,v 1.11 2017/02/27 21:32:33 jdolecek 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.11 2017/02/27 21:32:33 jdolecek 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_ioctl(struct ld_softc *, u_long, void *, int32_t, bool);
65
66 static void ld_nvme_biodone(void *, struct buf *, uint16_t);
67 static void ld_nvme_syncdone(void *, struct buf *, uint16_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 uint64_t nsze;
90 int error;
91
92 ld->sc_dv = self;
93 sc->sc_nvme = nsc;
94 sc->sc_nsid = naa->naa_nsid;
95
96 aprint_naive("\n");
97 aprint_normal("\n");
98
99 error = nvme_ns_identify(sc->sc_nvme, sc->sc_nsid);
100 if (error) {
101 aprint_error_dev(self, "couldn't identify namespace\n");
102 return;
103 }
104
105 ns = nvme_ns_get(sc->sc_nvme, sc->sc_nsid);
106 KASSERT(ns);
107 nsze = lemtoh64(&ns->ident->nsze);
108 f = &ns->ident->lbaf[NVME_ID_NS_FLBAS(ns->ident->flbas)];
109
110 ld->sc_secsize = 1 << f->lbads;
111 ld->sc_secperunit = nsze;
112 ld->sc_maxxfer = naa->naa_maxphys;
113 ld->sc_maxqueuecnt = naa->naa_qentries;
114 ld->sc_start = ld_nvme_start;
115 ld->sc_dump = ld_nvme_dump;
116 ld->sc_ioctl = ld_nvme_ioctl;
117 ld->sc_flags = LDF_ENABLED;
118 ldattach(ld, "fcfs");
119 }
120
121 static int
122 ld_nvme_detach(device_t self, int flags)
123 {
124 struct ld_nvme_softc *sc = device_private(self);
125 struct ld_softc *ld = &sc->sc_ld;
126 int rv;
127
128 if ((rv = ldbegindetach(ld, flags)) != 0)
129 return rv;
130 ldenddetach(ld);
131
132 nvme_ns_free(sc->sc_nvme, sc->sc_nsid);
133
134 return 0;
135 }
136
137 static int
138 ld_nvme_start(struct ld_softc *ld, struct buf *bp)
139 {
140 struct ld_nvme_softc *sc = device_private(ld->sc_dv);
141
142 return nvme_ns_dobio(sc->sc_nvme, sc->sc_nsid, sc,
143 bp, bp->b_data, bp->b_bcount,
144 sc->sc_ld.sc_secsize, bp->b_rawblkno,
145 BUF_ISWRITE(bp) ? 0 : NVME_NS_CTX_F_READ,
146 ld_nvme_biodone);
147 }
148
149 static int
150 ld_nvme_dump(struct ld_softc *ld, void *data, int blkno, int blkcnt)
151 {
152 struct ld_nvme_softc *sc = device_private(ld->sc_dv);
153
154 return nvme_ns_dobio(sc->sc_nvme, sc->sc_nsid, sc,
155 NULL, data, blkcnt * ld->sc_secsize,
156 sc->sc_ld.sc_secsize, blkno,
157 NVME_NS_CTX_F_POLL,
158 ld_nvme_biodone);
159 }
160
161 static void
162 ld_nvme_biodone(void *xc, struct buf *bp, uint16_t cmd_status)
163 {
164 struct ld_nvme_softc *sc = xc;
165 uint16_t status = NVME_CQE_SC(cmd_status);
166
167 if (bp != NULL) {
168 if (status != NVME_CQE_SC_SUCCESS) {
169 bp->b_error = EIO;
170 bp->b_resid = bp->b_bcount;
171 aprint_error_dev(sc->sc_ld.sc_dv, "I/O error\n");
172 } else {
173 bp->b_resid = 0;
174 }
175 lddone(&sc->sc_ld, bp);
176 } else {
177 if (status != NVME_CQE_SC_SUCCESS) {
178 aprint_error_dev(sc->sc_ld.sc_dv, "I/O error\n");
179 }
180 }
181 }
182
183 static int
184 ld_nvme_flush(struct ld_softc *ld, bool poll)
185 {
186 struct ld_nvme_softc *sc = device_private(ld->sc_dv);
187
188 return nvme_ns_sync(sc->sc_nvme, sc->sc_nsid, sc,
189 poll ? NVME_NS_CTX_F_POLL : 0,
190 ld_nvme_syncdone);
191 }
192
193 static int
194 ld_nvme_ioctl(struct ld_softc *ld, u_long cmd, void *addr, int32_t flag, bool poll)
195 {
196 int error;
197 struct ld_nvme_softc *sc = device_private(ld->sc_dv);
198
199 switch (cmd) {
200 case DIOCCACHESYNC:
201 error = ld_nvme_flush(ld, poll);
202 break;
203
204 default:
205 error = EPASSTHROUGH;
206 break;
207 }
208
209 return error;
210 }
211
212 static void
213 ld_nvme_syncdone(void *xc, struct buf *bp, uint16_t cmd_status)
214 {
215 /* nothing to do */
216 }
217
218 MODULE(MODULE_CLASS_DRIVER, ld_nvme, "ld,nvme");
219
220 #ifdef _MODULE
221 /*
222 * XXX Don't allow ioconf.c to redefine the "struct cfdriver ld_cd"
223 * XXX it will be defined in the common-code module
224 */
225 #undef CFDRIVER_DECL
226 #define CFDRIVER_DECL(name, class, attr)
227 #include "ioconf.c"
228 #endif
229
230 static int
231 ld_nvme_modcmd(modcmd_t cmd, void *opaque)
232 {
233 #ifdef _MODULE
234 /*
235 * We ignore the cfdriver_vec[] that ioconf provides, since
236 * the cfdrivers are attached already.
237 */
238 static struct cfdriver * const no_cfdriver_vec[] = { NULL };
239 #endif
240 int error = 0;
241
242 #ifdef _MODULE
243 switch (cmd) {
244 case MODULE_CMD_INIT:
245 error = config_init_component(no_cfdriver_vec,
246 cfattach_ioconf_ld_nvme, cfdata_ioconf_ld_nvme);
247 break;
248 case MODULE_CMD_FINI:
249 error = config_fini_component(no_cfdriver_vec,
250 cfattach_ioconf_ld_nvme, cfdata_ioconf_ld_nvme);
251 break;
252 default:
253 error = ENOTTY;
254 break;
255 }
256 #endif
257
258 return error;
259 }
260