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 if (status != 0) { 134 nvme_ctrlr_destruct(ctrlr, dev); 135 return (status); 136 } 137 138 ctrlr->config_hook.ich_func = nvme_ctrlr_start_config_hook; 139 ctrlr->config_hook.ich_arg = ctrlr; 140 141 config_intrhook_establish(&ctrlr->config_hook); 142 143 return (0); 144 } 145 146 int 147 nvme_detach (device_t dev) 148 { 149 struct nvme_controller *ctrlr = DEVICE2SOFTC(dev); 150 151 nvme_ctrlr_destruct(ctrlr, dev); 152 return (0); 153 } 154 155 static void 156 nvme_notify(struct nvme_consumer *cons, 157 struct nvme_controller *ctrlr) 158 { 159 struct nvme_namespace *ns; 160 void *ctrlr_cookie; 161 int cmpset, ns_idx; 162 163 /* 164 * The consumer may register itself after the nvme devices 165 * have registered with the kernel, but before the 166 * driver has completed initialization. In that case, 167 * return here, and when initialization completes, the 168 * controller will make sure the consumer gets notified. 169 */ 170 if (!ctrlr->is_initialized) 171 return; 172 173 cmpset = atomic_cmpset_32(&ctrlr->notification_sent, 0, 1); 174 if (cmpset == 0) 175 return; 176 177 if (cons->ctrlr_fn != NULL) 178 ctrlr_cookie = (*cons->ctrlr_fn)(ctrlr); 179 else 180 ctrlr_cookie = (void *)(uintptr_t)0xdeadc0dedeadc0de; 181 ctrlr->cons_cookie[cons->id] = ctrlr_cookie; 182 183 /* ctrlr_fn has failed. Nothing to notify here any more. */ 184 if (ctrlr_cookie == NULL) 185 return; 186 187 if (ctrlr->is_failed) { 188 ctrlr->cons_cookie[cons->id] = NULL; 189 if (cons->fail_fn != NULL) 190 (*cons->fail_fn)(ctrlr_cookie); 191 /* 192 * Do not notify consumers about the namespaces of a 193 * failed controller. 194 */ 195 return; 196 } 197 for (ns_idx = 0; ns_idx < min(ctrlr->cdata.nn, NVME_MAX_NAMESPACES); ns_idx++) { 198 ns = &ctrlr->ns[ns_idx]; 199 if (ns->data.nsze == 0) 200 continue; 201 if (cons->ns_fn != NULL) 202 ns->cons_cookie[cons->id] = 203 (*cons->ns_fn)(ns, ctrlr_cookie); 204 } 205 } 206 207 void 208 nvme_notify_new_controller(struct nvme_controller *ctrlr) 209 { 210 int i; 211 212 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 213 if (nvme_consumer[i].id != INVALID_CONSUMER_ID) { 214 nvme_notify(&nvme_consumer[i], ctrlr); 215 } 216 } 217 } 218 219 static void 220 nvme_notify_new_consumer(struct nvme_consumer *cons) 221 { 222 device_t *devlist; 223 struct nvme_controller *ctrlr; 224 int dev_idx, devcount; 225 226 if (devclass_get_devices(nvme_devclass, &devlist, &devcount)) 227 return; 228 229 for (dev_idx = 0; dev_idx < devcount; dev_idx++) { 230 ctrlr = DEVICE2SOFTC(devlist[dev_idx]); 231 nvme_notify(cons, ctrlr); 232 } 233 234 free(devlist, M_TEMP); 235 } 236 237 void 238 nvme_notify_async_consumers(struct nvme_controller *ctrlr, 239 const struct nvme_completion *async_cpl, 240 uint32_t log_page_id, void *log_page_buffer, 241 uint32_t log_page_size) 242 { 243 struct nvme_consumer *cons; 244 void *ctrlr_cookie; 245 uint32_t i; 246 247 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 248 cons = &nvme_consumer[i]; 249 if (cons->id != INVALID_CONSUMER_ID && cons->async_fn != NULL && 250 (ctrlr_cookie = ctrlr->cons_cookie[i]) != NULL) { 251 (*cons->async_fn)(ctrlr_cookie, async_cpl, 252 log_page_id, log_page_buffer, log_page_size); 253 } 254 } 255 } 256 257 void 258 nvme_notify_fail_consumers(struct nvme_controller *ctrlr) 259 { 260 struct nvme_consumer *cons; 261 void *ctrlr_cookie; 262 uint32_t i; 263 264 /* 265 * This controller failed during initialization (i.e. IDENTIFY 266 * command failed or timed out). Do not notify any nvme 267 * consumers of the failure here, since the consumer does not 268 * even know about the controller yet. 269 */ 270 if (!ctrlr->is_initialized) 271 return; 272 273 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 274 cons = &nvme_consumer[i]; 275 if (cons->id != INVALID_CONSUMER_ID && 276 (ctrlr_cookie = ctrlr->cons_cookie[i]) != NULL) { 277 ctrlr->cons_cookie[i] = NULL; 278 if (cons->fail_fn != NULL) 279 cons->fail_fn(ctrlr_cookie); 280 } 281 } 282 } 283 284 void 285 nvme_notify_ns(struct nvme_controller *ctrlr, int nsid) 286 { 287 struct nvme_consumer *cons; 288 struct nvme_namespace *ns = &ctrlr->ns[nsid - 1]; 289 void *ctrlr_cookie; 290 uint32_t i; 291 292 if (!ctrlr->is_initialized) 293 return; 294 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