1 /*- 2 * Copyright (C) 2012-2014 Intel Corporation 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27 #include <sys/cdefs.h> 28 __FBSDID("$FreeBSD$"); 29 30 #include <sys/param.h> 31 #include <sys/bus.h> 32 #include <sys/conf.h> 33 #include <sys/module.h> 34 35 #include <vm/uma.h> 36 37 #include <dev/pci/pcireg.h> 38 #include <dev/pci/pcivar.h> 39 40 #include "nvme_private.h" 41 42 struct nvme_consumer { 43 uint32_t id; 44 nvme_cons_ns_fn_t ns_fn; 45 nvme_cons_ctrlr_fn_t ctrlr_fn; 46 nvme_cons_async_fn_t async_fn; 47 nvme_cons_fail_fn_t fail_fn; 48 }; 49 50 struct nvme_consumer nvme_consumer[NVME_MAX_CONSUMERS]; 51 #define INVALID_CONSUMER_ID 0xFFFF 52 53 uma_zone_t nvme_request_zone; 54 int32_t nvme_retry_count; 55 56 MALLOC_DEFINE(M_NVME, "nvme", "nvme(4) memory allocations"); 57 58 static int nvme_probe(device_t); 59 static int nvme_attach(device_t); 60 static int nvme_detach(device_t); 61 static int nvme_modevent(module_t mod, int type, void *arg); 62 63 static devclass_t nvme_devclass; 64 65 static device_method_t nvme_pci_methods[] = { 66 /* Device interface */ 67 DEVMETHOD(device_probe, nvme_probe), 68 DEVMETHOD(device_attach, nvme_attach), 69 DEVMETHOD(device_detach, nvme_detach), 70 { 0, 0 } 71 }; 72 73 static driver_t nvme_pci_driver = { 74 "nvme", 75 nvme_pci_methods, 76 sizeof(struct nvme_controller), 77 }; 78 79 DRIVER_MODULE(nvme, pci, nvme_pci_driver, nvme_devclass, nvme_modevent, 0); 80 MODULE_VERSION(nvme, 1); 81 82 static struct _pcsid 83 { 84 uint32_t devid; 85 int match_subdevice; 86 uint16_t subdevice; 87 const char *desc; 88 } pci_ids[] = { 89 { 0x01118086, 0, 0, "NVMe Controller" }, 90 { IDT32_PCI_ID, 0, 0, "IDT NVMe Controller (32 channel)" }, 91 { IDT8_PCI_ID, 0, 0, "IDT NVMe Controller (8 channel)" }, 92 { 0x09538086, 1, 0x3702, "DC P3700 SSD" }, 93 { 0x09538086, 1, 0x3703, "DC P3700 SSD [2.5\" SFF]" }, 94 { 0x09538086, 1, 0x3704, "DC P3500 SSD [Add-in Card]" }, 95 { 0x09538086, 1, 0x3705, "DC P3500 SSD [2.5\" SFF]" }, 96 { 0x09538086, 1, 0x3709, "DC P3600 SSD [Add-in Card]" }, 97 { 0x09538086, 1, 0x370a, "DC P3600 SSD [2.5\" SFF]" }, 98 { 0x00000000, 0, 0, NULL } 99 }; 100 101 static int 102 nvme_match(uint32_t devid, uint16_t subdevice, struct _pcsid *ep) 103 { 104 if (devid != ep->devid) 105 return 0; 106 107 if (!ep->match_subdevice) 108 return 1; 109 110 if (subdevice == ep->subdevice) 111 return 1; 112 else 113 return 0; 114 } 115 116 static int 117 nvme_probe (device_t device) 118 { 119 struct _pcsid *ep; 120 uint32_t devid; 121 uint16_t subdevice; 122 123 devid = pci_get_devid(device); 124 subdevice = pci_get_subdevice(device); 125 ep = pci_ids; 126 127 while (ep->devid) { 128 if (nvme_match(devid, subdevice, ep)) 129 break; 130 ++ep; 131 } 132 133 if (ep->desc) { 134 device_set_desc(device, ep->desc); 135 return (BUS_PROBE_DEFAULT); 136 } 137 138 #if defined(PCIS_STORAGE_NVM) 139 if (pci_get_class(device) == PCIC_STORAGE && 140 pci_get_subclass(device) == PCIS_STORAGE_NVM && 141 pci_get_progif(device) == PCIP_STORAGE_NVM_ENTERPRISE_NVMHCI_1_0) { 142 device_set_desc(device, "Generic NVMe Device"); 143 return (BUS_PROBE_GENERIC); 144 } 145 #endif 146 147 return (ENXIO); 148 } 149 150 static void 151 nvme_init(void) 152 { 153 uint32_t i; 154 155 nvme_request_zone = uma_zcreate("nvme_request", 156 sizeof(struct nvme_request), NULL, NULL, NULL, NULL, 0, 0); 157 158 for (i = 0; i < NVME_MAX_CONSUMERS; i++) 159 nvme_consumer[i].id = INVALID_CONSUMER_ID; 160 } 161 162 SYSINIT(nvme_register, SI_SUB_DRIVERS, SI_ORDER_SECOND, nvme_init, NULL); 163 164 static void 165 nvme_uninit(void) 166 { 167 uma_zdestroy(nvme_request_zone); 168 } 169 170 SYSUNINIT(nvme_unregister, SI_SUB_DRIVERS, SI_ORDER_SECOND, nvme_uninit, NULL); 171 172 static void 173 nvme_load(void) 174 { 175 } 176 177 static void 178 nvme_unload(void) 179 { 180 } 181 182 static void 183 nvme_shutdown(void) 184 { 185 device_t *devlist; 186 struct nvme_controller *ctrlr; 187 int dev, devcount; 188 189 if (devclass_get_devices(nvme_devclass, &devlist, &devcount)) 190 return; 191 192 for (dev = 0; dev < devcount; dev++) { 193 ctrlr = DEVICE2SOFTC(devlist[dev]); 194 nvme_ctrlr_shutdown(ctrlr); 195 } 196 197 free(devlist, M_TEMP); 198 } 199 200 static int 201 nvme_modevent(module_t mod, int type, void *arg) 202 { 203 204 switch (type) { 205 case MOD_LOAD: 206 nvme_load(); 207 break; 208 case MOD_UNLOAD: 209 nvme_unload(); 210 break; 211 case MOD_SHUTDOWN: 212 nvme_shutdown(); 213 break; 214 default: 215 break; 216 } 217 218 return (0); 219 } 220 221 void 222 nvme_dump_command(struct nvme_command *cmd) 223 { 224 printf( 225 "opc:%x f:%x r1:%x cid:%x nsid:%x r2:%x r3:%x mptr:%jx prp1:%jx prp2:%jx cdw:%x %x %x %x %x %x\n", 226 cmd->opc, cmd->fuse, cmd->rsvd1, cmd->cid, cmd->nsid, 227 cmd->rsvd2, cmd->rsvd3, 228 (uintmax_t)cmd->mptr, (uintmax_t)cmd->prp1, (uintmax_t)cmd->prp2, 229 cmd->cdw10, cmd->cdw11, cmd->cdw12, cmd->cdw13, cmd->cdw14, 230 cmd->cdw15); 231 } 232 233 void 234 nvme_dump_completion(struct nvme_completion *cpl) 235 { 236 printf("cdw0:%08x sqhd:%04x sqid:%04x " 237 "cid:%04x p:%x sc:%02x sct:%x m:%x dnr:%x\n", 238 cpl->cdw0, cpl->sqhd, cpl->sqid, 239 cpl->cid, cpl->status.p, cpl->status.sc, cpl->status.sct, 240 cpl->status.m, cpl->status.dnr); 241 } 242 243 static int 244 nvme_attach(device_t dev) 245 { 246 struct nvme_controller *ctrlr = DEVICE2SOFTC(dev); 247 int status; 248 249 status = nvme_ctrlr_construct(ctrlr, dev); 250 251 if (status != 0) { 252 nvme_ctrlr_destruct(ctrlr, dev); 253 return (status); 254 } 255 256 /* 257 * Reset controller twice to ensure we do a transition from cc.en==1 258 * to cc.en==0. This is because we don't really know what status 259 * the controller was left in when boot handed off to OS. 260 */ 261 status = nvme_ctrlr_hw_reset(ctrlr); 262 if (status != 0) { 263 nvme_ctrlr_destruct(ctrlr, dev); 264 return (status); 265 } 266 267 status = nvme_ctrlr_hw_reset(ctrlr); 268 if (status != 0) { 269 nvme_ctrlr_destruct(ctrlr, dev); 270 return (status); 271 } 272 273 pci_enable_busmaster(dev); 274 275 ctrlr->config_hook.ich_func = nvme_ctrlr_start_config_hook; 276 ctrlr->config_hook.ich_arg = ctrlr; 277 278 config_intrhook_establish(&ctrlr->config_hook); 279 280 return (0); 281 } 282 283 static int 284 nvme_detach (device_t dev) 285 { 286 struct nvme_controller *ctrlr = DEVICE2SOFTC(dev); 287 288 nvme_ctrlr_destruct(ctrlr, dev); 289 pci_disable_busmaster(dev); 290 return (0); 291 } 292 293 static void 294 nvme_notify(struct nvme_consumer *cons, 295 struct nvme_controller *ctrlr) 296 { 297 struct nvme_namespace *ns; 298 void *ctrlr_cookie; 299 int cmpset, ns_idx; 300 301 /* 302 * The consumer may register itself after the nvme devices 303 * have registered with the kernel, but before the 304 * driver has completed initialization. In that case, 305 * return here, and when initialization completes, the 306 * controller will make sure the consumer gets notified. 307 */ 308 if (!ctrlr->is_initialized) 309 return; 310 311 cmpset = atomic_cmpset_32(&ctrlr->notification_sent, 0, 1); 312 313 if (cmpset == 0) 314 return; 315 316 if (cons->ctrlr_fn != NULL) 317 ctrlr_cookie = (*cons->ctrlr_fn)(ctrlr); 318 else 319 ctrlr_cookie = NULL; 320 ctrlr->cons_cookie[cons->id] = ctrlr_cookie; 321 if (ctrlr->is_failed) { 322 if (cons->fail_fn != NULL) 323 (*cons->fail_fn)(ctrlr_cookie); 324 /* 325 * Do not notify consumers about the namespaces of a 326 * failed controller. 327 */ 328 return; 329 } 330 for (ns_idx = 0; ns_idx < ctrlr->cdata.nn; ns_idx++) { 331 ns = &ctrlr->ns[ns_idx]; 332 if (cons->ns_fn != NULL) 333 ns->cons_cookie[cons->id] = 334 (*cons->ns_fn)(ns, ctrlr_cookie); 335 } 336 } 337 338 void 339 nvme_notify_new_controller(struct nvme_controller *ctrlr) 340 { 341 int i; 342 343 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 344 if (nvme_consumer[i].id != INVALID_CONSUMER_ID) { 345 nvme_notify(&nvme_consumer[i], ctrlr); 346 } 347 } 348 } 349 350 static void 351 nvme_notify_new_consumer(struct nvme_consumer *cons) 352 { 353 device_t *devlist; 354 struct nvme_controller *ctrlr; 355 int dev_idx, devcount; 356 357 if (devclass_get_devices(nvme_devclass, &devlist, &devcount)) 358 return; 359 360 for (dev_idx = 0; dev_idx < devcount; dev_idx++) { 361 ctrlr = DEVICE2SOFTC(devlist[dev_idx]); 362 nvme_notify(cons, ctrlr); 363 } 364 365 free(devlist, M_TEMP); 366 } 367 368 void 369 nvme_notify_async_consumers(struct nvme_controller *ctrlr, 370 const struct nvme_completion *async_cpl, 371 uint32_t log_page_id, void *log_page_buffer, 372 uint32_t log_page_size) 373 { 374 struct nvme_consumer *cons; 375 uint32_t i; 376 377 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 378 cons = &nvme_consumer[i]; 379 if (cons->id != INVALID_CONSUMER_ID && cons->async_fn != NULL) 380 (*cons->async_fn)(ctrlr->cons_cookie[i], async_cpl, 381 log_page_id, log_page_buffer, log_page_size); 382 } 383 } 384 385 void 386 nvme_notify_fail_consumers(struct nvme_controller *ctrlr) 387 { 388 struct nvme_consumer *cons; 389 uint32_t i; 390 391 /* 392 * This controller failed during initialization (i.e. IDENTIFY 393 * command failed or timed out). Do not notify any nvme 394 * consumers of the failure here, since the consumer does not 395 * even know about the controller yet. 396 */ 397 if (!ctrlr->is_initialized) 398 return; 399 400 for (i = 0; i < NVME_MAX_CONSUMERS; i++) { 401 cons = &nvme_consumer[i]; 402 if (cons->id != INVALID_CONSUMER_ID && cons->fail_fn != NULL) 403 cons->fail_fn(ctrlr->cons_cookie[i]); 404 } 405 } 406 407 struct nvme_consumer * 408 nvme_register_consumer(nvme_cons_ns_fn_t ns_fn, nvme_cons_ctrlr_fn_t ctrlr_fn, 409 nvme_cons_async_fn_t async_fn, 410 nvme_cons_fail_fn_t fail_fn) 411 { 412 int i; 413 414 /* 415 * TODO: add locking around consumer registration. Not an issue 416 * right now since we only have one nvme consumer - nvd(4). 417 */ 418 for (i = 0; i < NVME_MAX_CONSUMERS; i++) 419 if (nvme_consumer[i].id == INVALID_CONSUMER_ID) { 420 nvme_consumer[i].id = i; 421 nvme_consumer[i].ns_fn = ns_fn; 422 nvme_consumer[i].ctrlr_fn = ctrlr_fn; 423 nvme_consumer[i].async_fn = async_fn; 424 nvme_consumer[i].fail_fn = fail_fn; 425 426 nvme_notify_new_consumer(&nvme_consumer[i]); 427 return (&nvme_consumer[i]); 428 } 429 430 printf("nvme(4): consumer not registered - no slots available\n"); 431 return (NULL); 432 } 433 434 void 435 nvme_unregister_consumer(struct nvme_consumer *consumer) 436 { 437 438 consumer->id = INVALID_CONSUMER_ID; 439 } 440 441 void 442 nvme_completion_poll_cb(void *arg, const struct nvme_completion *cpl) 443 { 444 struct nvme_completion_poll_status *status = arg; 445 446 /* 447 * Copy status into the argument passed by the caller, so that 448 * the caller can check the status to determine if the 449 * the request passed or failed. 450 */ 451 memcpy(&status->cpl, cpl, sizeof(*cpl)); 452 wmb(); 453 status->done = TRUE; 454 } 455