1 /* $NetBSD: ld_nvme.c,v 1.23 2019/10/01 10:59:49 mlelstv Exp $ */ 2 3 /*- 4 * Copyright (C) 2016 NONAKA Kimihiro <nonaka@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.23 2019/10/01 10:59:49 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 /* 109 * NVME1.0e 6.11 Identify command 110 * 111 * LBADS values smaller than 9 are not supported, a value 112 * of zero means that the format is not used. 113 */ 114 if (f->lbads < 9) { 115 if (f->lbads > 0) 116 aprint_error_dev(self, 117 "unsupported logical data size %u\n", f->lbads); 118 return; 119 } 120 121 ld->sc_secsize = 1 << f->lbads; 122 ld->sc_secperunit = ns->ident->nsze; 123 ld->sc_maxxfer = naa->naa_maxphys; 124 ld->sc_maxqueuecnt = naa->naa_qentries; 125 ld->sc_start = ld_nvme_start; 126 ld->sc_dump = ld_nvme_dump; 127 ld->sc_ioctl = ld_nvme_ioctl; 128 ld->sc_flags = LDF_ENABLED | LDF_NO_RND | LDF_MPSAFE; 129 ld->sc_typename = kmem_asprintf("%s", naa->naa_typename); 130 ldattach(ld, "fcfs"); 131 } 132 133 static int 134 ld_nvme_detach(device_t self, int flags) 135 { 136 struct ld_nvme_softc *sc = device_private(self); 137 struct ld_softc *ld = &sc->sc_ld; 138 int rv; 139 140 if ((rv = ldbegindetach(ld, flags)) != 0) 141 return rv; 142 ldenddetach(ld); 143 144 kmem_free(ld->sc_typename, strlen(ld->sc_typename) + 1); 145 146 nvme_ns_free(sc->sc_nvme, sc->sc_nsid); 147 148 return 0; 149 } 150 151 static int 152 ld_nvme_start(struct ld_softc *ld, struct buf *bp) 153 { 154 struct ld_nvme_softc *sc = device_private(ld->sc_dv); 155 int flags = BUF_ISWRITE(bp) ? 0 : NVME_NS_CTX_F_READ; 156 157 if (bp->b_flags & B_MEDIA_FUA) 158 flags |= NVME_NS_CTX_F_FUA; 159 160 return nvme_ns_dobio(sc->sc_nvme, sc->sc_nsid, sc, 161 bp, bp->b_data, bp->b_bcount, 162 sc->sc_ld.sc_secsize, bp->b_rawblkno, 163 flags, 164 ld_nvme_biodone); 165 } 166 167 static int 168 ld_nvme_dump(struct ld_softc *ld, void *data, int blkno, int blkcnt) 169 { 170 struct ld_nvme_softc *sc = device_private(ld->sc_dv); 171 172 return nvme_ns_dobio(sc->sc_nvme, sc->sc_nsid, sc, 173 NULL, data, blkcnt * ld->sc_secsize, 174 sc->sc_ld.sc_secsize, blkno, 175 NVME_NS_CTX_F_POLL, 176 ld_nvme_biodone); 177 } 178 179 static void 180 ld_nvme_biodone(void *xc, struct buf *bp, uint16_t cmd_status, uint32_t cdw0) 181 { 182 struct ld_nvme_softc *sc = xc; 183 uint16_t status = NVME_CQE_SC(cmd_status); 184 185 if (bp != NULL) { 186 if (status != NVME_CQE_SC_SUCCESS) { 187 bp->b_error = EIO; 188 bp->b_resid = bp->b_bcount; 189 aprint_error_dev(sc->sc_ld.sc_dv, "I/O error\n"); 190 } else { 191 bp->b_resid = 0; 192 } 193 lddone(&sc->sc_ld, bp); 194 } else { 195 if (status != NVME_CQE_SC_SUCCESS) { 196 aprint_error_dev(sc->sc_ld.sc_dv, "I/O error\n"); 197 } 198 } 199 } 200 201 static int 202 ld_nvme_flush(struct ld_softc *ld, bool poll) 203 { 204 struct ld_nvme_softc *sc = device_private(ld->sc_dv); 205 206 return nvme_ns_sync(sc->sc_nvme, sc->sc_nsid, 207 poll ? NVME_NS_CTX_F_POLL : 0); 208 } 209 210 static int 211 ld_nvme_getcache(struct ld_softc *ld, int *addr) 212 { 213 struct ld_nvme_softc *sc = device_private(ld->sc_dv); 214 215 return nvme_admin_getcache(sc->sc_nvme, addr); 216 } 217 218 static int 219 ld_nvme_setcache(struct ld_softc *ld, int addr) 220 { 221 struct ld_nvme_softc *sc = device_private(ld->sc_dv); 222 223 return nvme_admin_setcache(sc->sc_nvme, addr); 224 } 225 226 static int 227 ld_nvme_ioctl(struct ld_softc *ld, u_long cmd, void *addr, int32_t flag, bool poll) 228 { 229 int error; 230 231 switch (cmd) { 232 case DIOCCACHESYNC: 233 error = ld_nvme_flush(ld, poll); 234 break; 235 236 case DIOCGCACHE: 237 error = ld_nvme_getcache(ld, (int *)addr); 238 break; 239 240 case DIOCSCACHE: 241 error = ld_nvme_setcache(ld, *(int *)addr); 242 break; 243 244 default: 245 error = EPASSTHROUGH; 246 break; 247 } 248 249 return error; 250 } 251 252 MODULE(MODULE_CLASS_DRIVER, ld_nvme, "ld,nvme,bufq_fcfs"); 253 254 #ifdef _MODULE 255 /* 256 * XXX Don't allow ioconf.c to redefine the "struct cfdriver ld_cd" 257 * XXX it will be defined in the common-code module 258 */ 259 #undef CFDRIVER_DECL 260 #define CFDRIVER_DECL(name, class, attr) 261 #include "ioconf.c" 262 #endif 263 264 static int 265 ld_nvme_modcmd(modcmd_t cmd, void *opaque) 266 { 267 #ifdef _MODULE 268 /* 269 * We ignore the cfdriver_vec[] that ioconf provides, since 270 * the cfdrivers are attached already. 271 */ 272 static struct cfdriver * const no_cfdriver_vec[] = { NULL }; 273 #endif 274 int error = 0; 275 276 #ifdef _MODULE 277 switch (cmd) { 278 case MODULE_CMD_INIT: 279 error = config_init_component(no_cfdriver_vec, 280 cfattach_ioconf_ld_nvme, cfdata_ioconf_ld_nvme); 281 break; 282 case MODULE_CMD_FINI: 283 error = config_fini_component(no_cfdriver_vec, 284 cfattach_ioconf_ld_nvme, cfdata_ioconf_ld_nvme); 285 break; 286 default: 287 error = ENOTTY; 288 break; 289 } 290 #endif 291 292 return error; 293 } 294