2 * Copyright (C) 2012 Intel Corporation
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
33 #include <sys/module.h>
37 #include <dev/pci/pcireg.h>
38 #include <dev/pci/pcivar.h>
40 #include "nvme_private.h"
42 struct nvme_consumer {
43 nvme_consumer_cb_fn_t cb_fn;
47 struct nvme_consumer nvme_consumer[NVME_MAX_CONSUMERS];
49 uma_zone_t nvme_request_zone;
51 MALLOC_DEFINE(M_NVME, "nvme", "nvme(4) memory allocations");
53 static int nvme_probe(device_t);
54 static int nvme_attach(device_t);
55 static int nvme_detach(device_t);
57 static devclass_t nvme_devclass;
59 static device_method_t nvme_pci_methods[] = {
60 /* Device interface */
61 DEVMETHOD(device_probe, nvme_probe),
62 DEVMETHOD(device_attach, nvme_attach),
63 DEVMETHOD(device_detach, nvme_detach),
67 static driver_t nvme_pci_driver = {
70 sizeof(struct nvme_controller),
73 DRIVER_MODULE(nvme, pci, nvme_pci_driver, nvme_devclass, 0, 0);
74 MODULE_VERSION(nvme, 1);
81 { 0x01118086, "NVMe Controller" },
82 { CHATHAM_PCI_ID, "Chatham Prototype NVMe Controller" },
83 { IDT_PCI_ID, "IDT NVMe Controller" },
88 nvme_probe (device_t device)
93 type = pci_get_devid(device);
96 while (ep->type && ep->type != type)
100 device_set_desc(device, ep->desc);
101 return (BUS_PROBE_DEFAULT);
104 #if defined(PCIS_STORAGE_NVM)
105 if (pci_get_class(device) == PCIC_STORAGE &&
106 pci_get_subclass(device) == PCIS_STORAGE_NVM &&
107 pci_get_progif(device) == PCIP_STORAGE_NVM_ENTERPRISE_NVMHCI_1_0) {
108 device_set_desc(device, "Generic NVMe Device");
109 return (BUS_PROBE_GENERIC);
119 nvme_request_zone = uma_zcreate("nvme_request",
120 sizeof(struct nvme_request), NULL, NULL, NULL, NULL, 0, 0);
123 SYSINIT(nvme_register, SI_SUB_DRIVERS, SI_ORDER_SECOND, nvme_init, NULL);
128 uma_zdestroy(nvme_request_zone);
131 SYSUNINIT(nvme_unregister, SI_SUB_DRIVERS, SI_ORDER_SECOND, nvme_uninit, NULL);
147 struct nvme_controller *ctrlr;
148 union cc_register cc;
149 union csts_register csts;
152 if (devclass_get_devices(nvme_devclass, &devlist, &devcount))
155 for (dev = 0; dev < devcount; dev++) {
157 * Only notify controller of shutdown when a real shutdown is
158 * in process, not when a module unload occurs. It seems at
159 * least some controllers (Chatham at least) don't let you
160 * re-enable the controller after shutdown notification has
163 ctrlr = DEVICE2SOFTC(devlist[dev]);
164 cc.raw = nvme_mmio_read_4(ctrlr, cc);
165 cc.bits.shn = NVME_SHN_NORMAL;
166 nvme_mmio_write_4(ctrlr, cc, cc.raw);
167 csts.raw = nvme_mmio_read_4(ctrlr, csts);
168 while (csts.bits.shst != NVME_SHST_COMPLETE) {
170 csts.raw = nvme_mmio_read_4(ctrlr, csts);
174 free(devlist, M_TEMP);
178 nvme_modevent(module_t mod, int type, void *arg)
198 moduledata_t nvme_mod = {
200 (modeventhand_t)nvme_modevent,
204 DECLARE_MODULE(nvme, nvme_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
207 nvme_dump_command(struct nvme_command *cmd)
209 printf("opc:%x f:%x r1:%x cid:%x nsid:%x r2:%x r3:%x "
210 "mptr:%qx prp1:%qx prp2:%qx cdw:%x %x %x %x %x %x\n",
211 cmd->opc, cmd->fuse, cmd->rsvd1, cmd->cid, cmd->nsid,
212 cmd->rsvd2, cmd->rsvd3,
213 (long long unsigned int)cmd->mptr,
214 (long long unsigned int)cmd->prp1,
215 (long long unsigned int)cmd->prp2,
216 cmd->cdw10, cmd->cdw11, cmd->cdw12, cmd->cdw13, cmd->cdw14,
221 nvme_dump_completion(struct nvme_completion *cpl)
223 printf("cdw0:%08x sqhd:%04x sqid:%04x "
224 "cid:%04x p:%x sc:%02x sct:%x m:%x dnr:%x\n",
225 cpl->cdw0, cpl->sqhd, cpl->sqid,
226 cpl->cid, cpl->p, cpl->sf_sc, cpl->sf_sct, cpl->sf_m,
231 nvme_payload_map(void *arg, bus_dma_segment_t *seg, int nseg, int error)
233 struct nvme_tracker *tr = arg;
236 KASSERT(error == 0, ("nvme_payload_map error != 0\n"));
239 * Note that we specified PAGE_SIZE for alignment and max
240 * segment size when creating the bus dma tags. So here
241 * we can safely just transfer each segment to its
242 * associated PRP entry.
244 tr->req->cmd.prp1 = seg[0].ds_addr;
247 tr->req->cmd.prp2 = seg[1].ds_addr;
248 } else if (nseg > 2) {
250 tr->req->cmd.prp2 = (uint64_t)tr->prp_bus_addr;
251 while (cur_nseg < nseg) {
252 tr->prp[cur_nseg-1] =
253 (uint64_t)seg[cur_nseg].ds_addr;
258 nvme_qpair_submit_cmd(tr->qpair, tr);
262 nvme_attach(device_t dev)
264 struct nvme_controller *ctrlr = DEVICE2SOFTC(dev);
267 status = nvme_ctrlr_construct(ctrlr, dev);
273 * Reset controller twice to ensure we do a transition from cc.en==1
274 * to cc.en==0. This is because we don't really know what status
275 * the controller was left in when boot handed off to OS.
277 status = nvme_ctrlr_reset(ctrlr);
281 status = nvme_ctrlr_reset(ctrlr);
285 ctrlr->config_hook.ich_func = nvme_ctrlr_start;
286 ctrlr->config_hook.ich_arg = ctrlr;
288 config_intrhook_establish(&ctrlr->config_hook);
294 nvme_detach (device_t dev)
296 struct nvme_controller *ctrlr = DEVICE2SOFTC(dev);
297 struct nvme_namespace *ns;
300 if (ctrlr->taskqueue) {
301 taskqueue_drain(ctrlr->taskqueue, &ctrlr->task);
302 taskqueue_free(ctrlr->taskqueue);
305 for (i = 0; i < NVME_MAX_NAMESPACES; i++) {
308 destroy_dev(ns->cdev);
312 destroy_dev(ctrlr->cdev);
314 for (i = 0; i < ctrlr->num_io_queues; i++) {
315 nvme_io_qpair_destroy(&ctrlr->ioq[i]);
318 free(ctrlr->ioq, M_NVME);
320 nvme_admin_qpair_destroy(&ctrlr->adminq);
322 if (ctrlr->resource != NULL) {
323 bus_release_resource(dev, SYS_RES_MEMORY,
324 ctrlr->resource_id, ctrlr->resource);
328 if (ctrlr->chatham_resource != NULL) {
329 bus_release_resource(dev, SYS_RES_MEMORY,
330 ctrlr->chatham_resource_id, ctrlr->chatham_resource);
335 bus_teardown_intr(ctrlr->dev, ctrlr->res, ctrlr->tag);
338 bus_release_resource(ctrlr->dev, SYS_RES_IRQ,
339 rman_get_rid(ctrlr->res), ctrlr->res);
341 if (ctrlr->msix_enabled)
342 pci_release_msi(dev);
348 nvme_notify_consumer(struct nvme_consumer *consumer)
351 struct nvme_controller *ctrlr;
352 int dev, ns, devcount;
354 if (devclass_get_devices(nvme_devclass, &devlist, &devcount))
357 for (dev = 0; dev < devcount; dev++) {
358 ctrlr = DEVICE2SOFTC(devlist[dev]);
359 for (ns = 0; ns < ctrlr->cdata.nn; ns++)
360 (*consumer->cb_fn)(consumer->cb_arg, &ctrlr->ns[ns]);
363 free(devlist, M_TEMP);
366 struct nvme_consumer *
367 nvme_register_consumer(nvme_consumer_cb_fn_t cb_fn, void *cb_arg)
372 * TODO: add locking around consumer registration. Not an issue
373 * right now since we only have one nvme consumer - nvd(4).
375 for (i = 0; i < NVME_MAX_CONSUMERS; i++)
376 if (nvme_consumer[i].cb_fn == NULL) {
377 nvme_consumer[i].cb_fn = cb_fn;
378 nvme_consumer[i].cb_arg = cb_arg;
380 nvme_notify_consumer(&nvme_consumer[i]);
381 return (&nvme_consumer[i]);
384 printf("nvme(4): consumer not registered - no slots available\n");
389 nvme_unregister_consumer(struct nvme_consumer *consumer)
392 consumer->cb_fn = NULL;
393 consumer->cb_arg = NULL;