1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (C) 2012-2014 Intel Corporation 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 AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 #include <sys/param.h> 33 #include <sys/bus.h> 34 #include <sys/conf.h> 35 #include <sys/module.h> 36 37 #include <vm/uma.h> 38 39 #include "nvme_private.h" 40 41 struct nvme_consumer { 42 uint32_t id; 43 nvme_cons_ns_fn_t ns_fn; 44 nvme_cons_ctrlr_fn_t ctrlr_fn; 45 nvme_cons_async_fn_t async_fn; 46 nvme_cons_fail_fn_t fail_fn; 47 }; 48 49 struct nvme_consumer nvme_consumer[NVME_MAX_CONSUMERS]; 50 #define INVALID_CONSUMER_ID 0xFFFF 51 52 int32_t nvme_retry_count; 53 54 MALLOC_DEFINE(M_NVME, "nvme", "nvme(4) memory allocations"); 55 56 devclass_t nvme_devclass; 57 58 static void 59 nvme_init(void) 60 { 61 uint32_t i; 62 63 for (i = 0; i < NVME_MAX_CONSUMERS; i++) 64 nvme_consumer[i].id = INVALID_CONSUMER_ID; 65 } 66 67 SYSINIT(nvme_register, SI_SUB_DRIVERS, SI_ORDER_SECOND, nvme_init, NULL); 68 69 static void 70 nvme_uninit(void) 71 { 72 } 73 74 SYSUNINIT(nvme_unregister, SI_SUB_DRIVERS, SI_ORDER_SECOND, nvme_uninit, NULL); 75 76 int 77 nvme_shutdown(device_t dev) 78 { 79 struct nvme_controller *ctrlr; 80 81 ctrlr = DEVICE2SOFTC(dev); 82 nvme_ctrlr_shutdown(ctrlr); 83 84 return (0); 85 } 86 87 void 88 nvme_dump_command(struct nvme_command *cmd) 89 { 90 91 printf( 92 "opc:%x f:%x cid:%x nsid:%x r2:%x r3:%x mptr:%jx prp1:%jx prp2:%jx cdw:%x %x %x %x %x %x\n", 93 cmd->opc, cmd->fuse, cmd->cid, le32toh(cmd->nsid), 94 cmd->rsvd2, cmd->rsvd3, 95 (uintmax_t)le64toh(cmd->mptr), (uintmax_t)le64toh(cmd->prp1), (uintmax_t)le64toh(cmd->prp2), 96 le32toh(cmd->cdw10), le32toh(cmd->cdw11), le32toh(cmd->cdw12), 97 le32toh(cmd->cdw13), le32toh(cmd->cdw14), le32toh(cmd->cdw15)); 98 } 99 100 void 101 nvme_dump_completion(struct nvme_completion *cpl) 102 { 103 uint8_t p, sc, sct, m, dnr; 104 uint16_t status; 105 106 status = le16toh(cpl->status); 107 108 p = NVME_STATUS_GET_P(status); 109 sc = NVME_STATUS_GET_SC(status); 110 sct = NVME_STATUS_GET_SCT(status); 111 m = NVME_STATUS_GET_M(status); 112 dnr = NVME_STATUS_GET_DNR(status); 113 114 printf("cdw0:%08x sqhd:%04x sqid:%04x " 115 "cid:%04x p:%x sc:%02x sct:%x m:%x dnr:%x\n", 116 le32toh(cpl->cdw0), le16toh(cpl->sqhd), le16toh(cpl->sqid), 117 cpl->cid, p, sc, sct, m, dnr); 118 } 119 120 int 121 nvme_attach(device_t dev) 122 { 123 struct nvme_controller *ctrlr = DEVICE2SOFTC(dev); 124 int status; 125 126 status = nvme_ctrlr_construct(ctrlr, dev); 127 if (status != 0) { 128 nvme_ctrlr_destruct(ctrlr, dev); 129 return (status); 130 } 131 132 ctrlr->config_hook.ich_func = nvme_ctrlr_start_config_hook; 133 ctrlr->config_hook.ich_arg = ctrlr; 134 135 if (config_intrhook_establish(&ctrlr->config_hook) != 0) 136 return (ENOMEM); 137 138 return (0); 139 } 140 141 int 142 nvme_detach (device_t dev) 143 { 144 struct nvme_controller *ctrlr = DEVICE2SOFTC(dev); 145 146 nvme_ctrlr_destruct(ctrlr, dev); 147 return (0); 148 } 149 150 static void 151 nvme_notify(struct nvme_consumer *cons, 152 struct nvme_controller *ctrlr) 153 { 154 struct nvme_namespace *ns; 155 void *ctrlr_cookie; 156 int cmpset, ns_idx; 157 158 /* 159 * The consumer may register itself after the nvme devices 160 * have registered with the kernel, but before the 161 * driver has completed initialization. In that case, 162 * return here, and when initialization completes, the 163 * controller will make sure the consumer gets notified. 164 */ 165 if (!ctrlr->is_initialized) 166 return; 167 168 cmpset = atomic_cmpset_32(&ctrlr->notification_sent, 0, 1); 169 if (cmpset == 0) 170 return; 171 172 if (cons->ctrlr_fn != NULL) 173 ctrlr_cookie = (*cons->ctrlr_fn)(ctrlr); 174 else 175 ctrlr_cookie = (void *)(uintptr_t)0xdeadc0dedeadc0de; 176 ctrlr->cons_cookie[cons->id] = ctrlr_cookie; 177 178 /* ctrlr_fn has failed. Nothing to notify here any more. */ 179 if (ctrlr_cookie == NULL) 180 return; 181 182 if (ctrlr->is_failed) { 183 ctrlr->cons_cookie[cons->id] = NULL; 184 if (cons->fail_fn != NULL) 185 (*cons->fail_fn)(ctrlr_cookie); 186 /* 187 * Do not notify consumers about the namespaces of a 188 * failed controller. 189 */ 190 return; 191 } 192 for (ns_idx = 0; ns_idx < min(ctrlr->cdata.nn, NVME_MAX_NAMESPACES); ns_idx++) { 193 ns = &ctrlr->ns[ns_idx]; 194 if (ns->data.nsze == 0) 195 continue; 196 if (cons->ns_fn != NULL) 197 ns->cons_cookie[cons->id] = 198 (*cons->ns_fn)(ns, ctrlr_cookie); 199 } 200 } 201 202 void 203 nvme_notify_new_controller(struct nvme_controller *ctrlr) 204 { 205 int i; 206 207 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 208 if (nvme_consumer[i].id != INVALID_CONSUMER_ID) { 209 nvme_notify(&nvme_consumer[i], ctrlr); 210 } 211 } 212 } 213 214 static void 215 nvme_notify_new_consumer(struct nvme_consumer *cons) 216 { 217 device_t *devlist; 218 struct nvme_controller *ctrlr; 219 int dev_idx, devcount; 220 221 if (devclass_get_devices(nvme_devclass, &devlist, &devcount)) 222 return; 223 224 for (dev_idx = 0; dev_idx < devcount; dev_idx++) { 225 ctrlr = DEVICE2SOFTC(devlist[dev_idx]); 226 nvme_notify(cons, ctrlr); 227 } 228 229 free(devlist, M_TEMP); 230 } 231 232 void 233 nvme_notify_async_consumers(struct nvme_controller *ctrlr, 234 const struct nvme_completion *async_cpl, 235 uint32_t log_page_id, void *log_page_buffer, 236 uint32_t log_page_size) 237 { 238 struct nvme_consumer *cons; 239 void *ctrlr_cookie; 240 uint32_t i; 241 242 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 243 cons = &nvme_consumer[i]; 244 if (cons->id != INVALID_CONSUMER_ID && cons->async_fn != NULL && 245 (ctrlr_cookie = ctrlr->cons_cookie[i]) != NULL) { 246 (*cons->async_fn)(ctrlr_cookie, async_cpl, 247 log_page_id, log_page_buffer, log_page_size); 248 } 249 } 250 } 251 252 void 253 nvme_notify_fail_consumers(struct nvme_controller *ctrlr) 254 { 255 struct nvme_consumer *cons; 256 void *ctrlr_cookie; 257 uint32_t i; 258 259 /* 260 * This controller failed during initialization (i.e. IDENTIFY 261 * command failed or timed out). Do not notify any nvme 262 * consumers of the failure here, since the consumer does not 263 * even know about the controller yet. 264 */ 265 if (!ctrlr->is_initialized) 266 return; 267 268 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 269 cons = &nvme_consumer[i]; 270 if (cons->id != INVALID_CONSUMER_ID && 271 (ctrlr_cookie = ctrlr->cons_cookie[i]) != NULL) { 272 ctrlr->cons_cookie[i] = NULL; 273 if (cons->fail_fn != NULL) 274 cons->fail_fn(ctrlr_cookie); 275 } 276 } 277 } 278 279 void 280 nvme_notify_ns(struct nvme_controller *ctrlr, int nsid) 281 { 282 struct nvme_consumer *cons; 283 struct nvme_namespace *ns; 284 void *ctrlr_cookie; 285 uint32_t i; 286 287 KASSERT(nsid <= NVME_MAX_NAMESPACES, 288 ("%s: Namespace notification to nsid %d exceeds range\n", 289 device_get_nameunit(ctrlr->dev), nsid)); 290 291 if (!ctrlr->is_initialized) 292 return; 293 294 ns = &ctrlr->ns[nsid - 1]; 295 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 296 cons = &nvme_consumer[i]; 297 if (cons->id != INVALID_CONSUMER_ID && cons->ns_fn != NULL && 298 (ctrlr_cookie = ctrlr->cons_cookie[i]) != NULL) 299 ns->cons_cookie[i] = (*cons->ns_fn)(ns, ctrlr_cookie); 300 } 301 } 302 303 struct nvme_consumer * 304 nvme_register_consumer(nvme_cons_ns_fn_t ns_fn, nvme_cons_ctrlr_fn_t ctrlr_fn, 305 nvme_cons_async_fn_t async_fn, 306 nvme_cons_fail_fn_t fail_fn) 307 { 308 int i; 309 310 /* 311 * TODO: add locking around consumer registration. 312 */ 313 for (i = 0; i < NVME_MAX_CONSUMERS; i++) 314 if (nvme_consumer[i].id == INVALID_CONSUMER_ID) { 315 nvme_consumer[i].id = i; 316 nvme_consumer[i].ns_fn = ns_fn; 317 nvme_consumer[i].ctrlr_fn = ctrlr_fn; 318 nvme_consumer[i].async_fn = async_fn; 319 nvme_consumer[i].fail_fn = fail_fn; 320 321 nvme_notify_new_consumer(&nvme_consumer[i]); 322 return (&nvme_consumer[i]); 323 } 324 325 printf("nvme(4): consumer not registered - no slots available\n"); 326 return (NULL); 327 } 328 329 void 330 nvme_unregister_consumer(struct nvme_consumer *consumer) 331 { 332 333 consumer->id = INVALID_CONSUMER_ID; 334 } 335 336 void 337 nvme_completion_poll_cb(void *arg, const struct nvme_completion *cpl) 338 { 339 struct nvme_completion_poll_status *status = arg; 340 341 /* 342 * Copy status into the argument passed by the caller, so that 343 * the caller can check the status to determine if the 344 * the request passed or failed. 345 */ 346 memcpy(&status->cpl, cpl, sizeof(*cpl)); 347 atomic_store_rel_int(&status->done, 1); 348 } 349 350 static int 351 nvme_modevent(module_t mod __unused, int type __unused, void *argp __unused) 352 { 353 return (0); 354 } 355 356 static moduledata_t nvme_mod = { 357 "nvme", 358 nvme_modevent, 359 0 360 }; 361 362 DECLARE_MODULE(nvme, nvme_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 363 MODULE_VERSION(nvme, 1); 364 MODULE_DEPEND(nvme, cam, 1, 1, 1); 365