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 uma_zone_t nvme_request_zone; 53 int32_t nvme_retry_count; 54 55 56 MALLOC_DEFINE(M_NVME, "nvme", "nvme(4) memory allocations"); 57 58 devclass_t nvme_devclass; 59 60 static void 61 nvme_init(void) 62 { 63 uint32_t i; 64 65 nvme_request_zone = uma_zcreate("nvme_request", 66 sizeof(struct nvme_request), NULL, NULL, NULL, NULL, 0, 0); 67 68 for (i = 0; i < NVME_MAX_CONSUMERS; i++) 69 nvme_consumer[i].id = INVALID_CONSUMER_ID; 70 } 71 72 SYSINIT(nvme_register, SI_SUB_DRIVERS, SI_ORDER_SECOND, nvme_init, NULL); 73 74 static void 75 nvme_uninit(void) 76 { 77 uma_zdestroy(nvme_request_zone); 78 } 79 80 SYSUNINIT(nvme_unregister, SI_SUB_DRIVERS, SI_ORDER_SECOND, nvme_uninit, NULL); 81 82 int 83 nvme_shutdown(device_t dev) 84 { 85 struct nvme_controller *ctrlr; 86 87 ctrlr = DEVICE2SOFTC(dev); 88 nvme_ctrlr_shutdown(ctrlr); 89 90 return (0); 91 } 92 93 void 94 nvme_dump_command(struct nvme_command *cmd) 95 { 96 97 printf( 98 "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", 99 cmd->opc, cmd->fuse, cmd->cid, le32toh(cmd->nsid), 100 cmd->rsvd2, cmd->rsvd3, 101 (uintmax_t)le64toh(cmd->mptr), (uintmax_t)le64toh(cmd->prp1), (uintmax_t)le64toh(cmd->prp2), 102 le32toh(cmd->cdw10), le32toh(cmd->cdw11), le32toh(cmd->cdw12), 103 le32toh(cmd->cdw13), le32toh(cmd->cdw14), le32toh(cmd->cdw15)); 104 } 105 106 void 107 nvme_dump_completion(struct nvme_completion *cpl) 108 { 109 uint8_t p, sc, sct, m, dnr; 110 uint16_t status; 111 112 status = le16toh(cpl->status); 113 114 p = NVME_STATUS_GET_P(status); 115 sc = NVME_STATUS_GET_SC(status); 116 sct = NVME_STATUS_GET_SCT(status); 117 m = NVME_STATUS_GET_M(status); 118 dnr = NVME_STATUS_GET_DNR(status); 119 120 printf("cdw0:%08x sqhd:%04x sqid:%04x " 121 "cid:%04x p:%x sc:%02x sct:%x m:%x dnr:%x\n", 122 le32toh(cpl->cdw0), le16toh(cpl->sqhd), le16toh(cpl->sqid), 123 cpl->cid, p, sc, sct, m, dnr); 124 } 125 126 int 127 nvme_attach(device_t dev) 128 { 129 struct nvme_controller *ctrlr = DEVICE2SOFTC(dev); 130 int status; 131 132 status = nvme_ctrlr_construct(ctrlr, dev); 133 134 if (status != 0) { 135 nvme_ctrlr_destruct(ctrlr, dev); 136 return (status); 137 } 138 139 /* 140 * Reset controller twice to ensure we do a transition from cc.en==1 to 141 * cc.en==0. This is because we don't really know what status the 142 * controller was left in when boot handed off to OS. Linux doesn't do 143 * this, however. If we adopt that policy, see also nvme_ctrlr_resume(). 144 */ 145 status = nvme_ctrlr_hw_reset(ctrlr); 146 if (status != 0) { 147 nvme_ctrlr_destruct(ctrlr, dev); 148 return (status); 149 } 150 151 status = nvme_ctrlr_hw_reset(ctrlr); 152 if (status != 0) { 153 nvme_ctrlr_destruct(ctrlr, dev); 154 return (status); 155 } 156 157 ctrlr->config_hook.ich_func = nvme_ctrlr_start_config_hook; 158 ctrlr->config_hook.ich_arg = ctrlr; 159 160 config_intrhook_establish(&ctrlr->config_hook); 161 162 return (0); 163 } 164 165 int 166 nvme_detach (device_t dev) 167 { 168 struct nvme_controller *ctrlr = DEVICE2SOFTC(dev); 169 170 nvme_ctrlr_destruct(ctrlr, dev); 171 return (0); 172 } 173 174 static void 175 nvme_notify(struct nvme_consumer *cons, 176 struct nvme_controller *ctrlr) 177 { 178 struct nvme_namespace *ns; 179 void *ctrlr_cookie; 180 int cmpset, ns_idx; 181 182 /* 183 * The consumer may register itself after the nvme devices 184 * have registered with the kernel, but before the 185 * driver has completed initialization. In that case, 186 * return here, and when initialization completes, the 187 * controller will make sure the consumer gets notified. 188 */ 189 if (!ctrlr->is_initialized) 190 return; 191 192 cmpset = atomic_cmpset_32(&ctrlr->notification_sent, 0, 1); 193 if (cmpset == 0) 194 return; 195 196 if (cons->ctrlr_fn != NULL) 197 ctrlr_cookie = (*cons->ctrlr_fn)(ctrlr); 198 else 199 ctrlr_cookie = (void *)(uintptr_t)0xdeadc0dedeadc0de; 200 ctrlr->cons_cookie[cons->id] = ctrlr_cookie; 201 202 /* ctrlr_fn has failed. Nothing to notify here any more. */ 203 if (ctrlr_cookie == NULL) 204 return; 205 206 if (ctrlr->is_failed) { 207 ctrlr->cons_cookie[cons->id] = NULL; 208 if (cons->fail_fn != NULL) 209 (*cons->fail_fn)(ctrlr_cookie); 210 /* 211 * Do not notify consumers about the namespaces of a 212 * failed controller. 213 */ 214 return; 215 } 216 for (ns_idx = 0; ns_idx < min(ctrlr->cdata.nn, NVME_MAX_NAMESPACES); ns_idx++) { 217 ns = &ctrlr->ns[ns_idx]; 218 if (ns->data.nsze == 0) 219 continue; 220 if (cons->ns_fn != NULL) 221 ns->cons_cookie[cons->id] = 222 (*cons->ns_fn)(ns, ctrlr_cookie); 223 } 224 } 225 226 void 227 nvme_notify_new_controller(struct nvme_controller *ctrlr) 228 { 229 int i; 230 231 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 232 if (nvme_consumer[i].id != INVALID_CONSUMER_ID) { 233 nvme_notify(&nvme_consumer[i], ctrlr); 234 } 235 } 236 } 237 238 static void 239 nvme_notify_new_consumer(struct nvme_consumer *cons) 240 { 241 device_t *devlist; 242 struct nvme_controller *ctrlr; 243 int dev_idx, devcount; 244 245 if (devclass_get_devices(nvme_devclass, &devlist, &devcount)) 246 return; 247 248 for (dev_idx = 0; dev_idx < devcount; dev_idx++) { 249 ctrlr = DEVICE2SOFTC(devlist[dev_idx]); 250 nvme_notify(cons, ctrlr); 251 } 252 253 free(devlist, M_TEMP); 254 } 255 256 void 257 nvme_notify_async_consumers(struct nvme_controller *ctrlr, 258 const struct nvme_completion *async_cpl, 259 uint32_t log_page_id, void *log_page_buffer, 260 uint32_t log_page_size) 261 { 262 struct nvme_consumer *cons; 263 void *ctrlr_cookie; 264 uint32_t i; 265 266 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 267 cons = &nvme_consumer[i]; 268 if (cons->id != INVALID_CONSUMER_ID && cons->async_fn != NULL && 269 (ctrlr_cookie = ctrlr->cons_cookie[i]) != NULL) { 270 (*cons->async_fn)(ctrlr_cookie, async_cpl, 271 log_page_id, log_page_buffer, log_page_size); 272 } 273 } 274 } 275 276 void 277 nvme_notify_fail_consumers(struct nvme_controller *ctrlr) 278 { 279 struct nvme_consumer *cons; 280 void *ctrlr_cookie; 281 uint32_t i; 282 283 /* 284 * This controller failed during initialization (i.e. IDENTIFY 285 * command failed or timed out). Do not notify any nvme 286 * consumers of the failure here, since the consumer does not 287 * even know about the controller yet. 288 */ 289 if (!ctrlr->is_initialized) 290 return; 291 292 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 293 cons = &nvme_consumer[i]; 294 if (cons->id != INVALID_CONSUMER_ID && 295 (ctrlr_cookie = ctrlr->cons_cookie[i]) != NULL) { 296 ctrlr->cons_cookie[i] = NULL; 297 if (cons->fail_fn != NULL) 298 cons->fail_fn(ctrlr_cookie); 299 } 300 } 301 } 302 303 void 304 nvme_notify_ns(struct nvme_controller *ctrlr, int nsid) 305 { 306 struct nvme_consumer *cons; 307 struct nvme_namespace *ns = &ctrlr->ns[nsid - 1]; 308 void *ctrlr_cookie; 309 uint32_t i; 310 311 if (!ctrlr->is_initialized) 312 return; 313 314 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 315 cons = &nvme_consumer[i]; 316 if (cons->id != INVALID_CONSUMER_ID && cons->ns_fn != NULL && 317 (ctrlr_cookie = ctrlr->cons_cookie[i]) != NULL) 318 ns->cons_cookie[i] = (*cons->ns_fn)(ns, ctrlr_cookie); 319 } 320 } 321 322 struct nvme_consumer * 323 nvme_register_consumer(nvme_cons_ns_fn_t ns_fn, nvme_cons_ctrlr_fn_t ctrlr_fn, 324 nvme_cons_async_fn_t async_fn, 325 nvme_cons_fail_fn_t fail_fn) 326 { 327 int i; 328 329 /* 330 * TODO: add locking around consumer registration. 331 */ 332 for (i = 0; i < NVME_MAX_CONSUMERS; i++) 333 if (nvme_consumer[i].id == INVALID_CONSUMER_ID) { 334 nvme_consumer[i].id = i; 335 nvme_consumer[i].ns_fn = ns_fn; 336 nvme_consumer[i].ctrlr_fn = ctrlr_fn; 337 nvme_consumer[i].async_fn = async_fn; 338 nvme_consumer[i].fail_fn = fail_fn; 339 340 nvme_notify_new_consumer(&nvme_consumer[i]); 341 return (&nvme_consumer[i]); 342 } 343 344 printf("nvme(4): consumer not registered - no slots available\n"); 345 return (NULL); 346 } 347 348 void 349 nvme_unregister_consumer(struct nvme_consumer *consumer) 350 { 351 352 consumer->id = INVALID_CONSUMER_ID; 353 } 354 355 void 356 nvme_completion_poll_cb(void *arg, const struct nvme_completion *cpl) 357 { 358 struct nvme_completion_poll_status *status = arg; 359 360 /* 361 * Copy status into the argument passed by the caller, so that 362 * the caller can check the status to determine if the 363 * the request passed or failed. 364 */ 365 memcpy(&status->cpl, cpl, sizeof(*cpl)); 366 atomic_store_rel_int(&status->done, 1); 367 } 368 369 static int 370 nvme_modevent(module_t mod __unused, int type __unused, void *argp __unused) 371 { 372 return (0); 373 } 374 375 static moduledata_t nvme_mod = { 376 "nvme", 377 nvme_modevent, 378 0 379 }; 380 381 DECLARE_MODULE(nvme, nvme_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 382 MODULE_VERSION(nvme, 1); 383 MODULE_DEPEND(nvme, cam, 1, 1, 1); 384