2 * Copyright (C) 2012-2014 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>
31 #include <sys/systm.h>
35 #include <sys/ioccom.h>
40 #include <dev/pci/pcireg.h>
41 #include <dev/pci/pcivar.h>
43 #include "nvme_private.h"
45 static void nvme_ctrlr_construct_and_submit_aer(struct nvme_controller *ctrlr,
46 struct nvme_async_event_request *aer);
49 nvme_ctrlr_allocate_bar(struct nvme_controller *ctrlr)
52 ctrlr->resource_id = PCIR_BAR(0);
54 ctrlr->resource = bus_alloc_resource(ctrlr->dev, SYS_RES_MEMORY,
55 &ctrlr->resource_id, 0, ~0, 1, RF_ACTIVE);
57 if(ctrlr->resource == NULL) {
58 nvme_printf(ctrlr, "unable to allocate pci resource\n");
62 ctrlr->bus_tag = rman_get_bustag(ctrlr->resource);
63 ctrlr->bus_handle = rman_get_bushandle(ctrlr->resource);
64 ctrlr->regs = (struct nvme_registers *)ctrlr->bus_handle;
67 * The NVMe spec allows for the MSI-X table to be placed behind
68 * BAR 4/5, separate from the control/doorbell registers. Always
69 * try to map this bar, because it must be mapped prior to calling
70 * pci_alloc_msix(). If the table isn't behind BAR 4/5,
71 * bus_alloc_resource() will just return NULL which is OK.
73 ctrlr->bar4_resource_id = PCIR_BAR(4);
74 ctrlr->bar4_resource = bus_alloc_resource(ctrlr->dev, SYS_RES_MEMORY,
75 &ctrlr->bar4_resource_id, 0, ~0, 1, RF_ACTIVE);
81 nvme_ctrlr_construct_admin_qpair(struct nvme_controller *ctrlr)
83 struct nvme_qpair *qpair;
86 qpair = &ctrlr->adminq;
88 num_entries = NVME_ADMIN_ENTRIES;
89 TUNABLE_INT_FETCH("hw.nvme.admin_entries", &num_entries);
91 * If admin_entries was overridden to an invalid value, revert it
92 * back to our default value.
94 if (num_entries < NVME_MIN_ADMIN_ENTRIES ||
95 num_entries > NVME_MAX_ADMIN_ENTRIES) {
96 nvme_printf(ctrlr, "invalid hw.nvme.admin_entries=%d "
97 "specified\n", num_entries);
98 num_entries = NVME_ADMIN_ENTRIES;
102 * The admin queue's max xfer size is treated differently than the
103 * max I/O xfer size. 16KB is sufficient here - maybe even less?
105 nvme_qpair_construct(qpair,
114 nvme_ctrlr_construct_io_qpairs(struct nvme_controller *ctrlr)
116 struct nvme_qpair *qpair;
117 union cap_lo_register cap_lo;
118 int i, num_entries, num_trackers;
120 num_entries = NVME_IO_ENTRIES;
121 TUNABLE_INT_FETCH("hw.nvme.io_entries", &num_entries);
124 * NVMe spec sets a hard limit of 64K max entries, but
125 * devices may specify a smaller limit, so we need to check
126 * the MQES field in the capabilities register.
128 cap_lo.raw = nvme_mmio_read_4(ctrlr, cap_lo);
129 num_entries = min(num_entries, cap_lo.bits.mqes+1);
131 num_trackers = NVME_IO_TRACKERS;
132 TUNABLE_INT_FETCH("hw.nvme.io_trackers", &num_trackers);
134 num_trackers = max(num_trackers, NVME_MIN_IO_TRACKERS);
135 num_trackers = min(num_trackers, NVME_MAX_IO_TRACKERS);
137 * No need to have more trackers than entries in the submit queue.
138 * Note also that for a queue size of N, we can only have (N-1)
139 * commands outstanding, hence the "-1" here.
141 num_trackers = min(num_trackers, (num_entries-1));
143 ctrlr->ioq = malloc(ctrlr->num_io_queues * sizeof(struct nvme_qpair),
144 M_NVME, M_ZERO | M_WAITOK);
146 for (i = 0; i < ctrlr->num_io_queues; i++) {
147 qpair = &ctrlr->ioq[i];
150 * Admin queue has ID=0. IO queues start at ID=1 -
151 * hence the 'i+1' here.
153 * For I/O queues, use the controller-wide max_xfer_size
154 * calculated in nvme_attach().
156 nvme_qpair_construct(qpair,
158 ctrlr->msix_enabled ? i+1 : 0, /* vector */
163 if (ctrlr->per_cpu_io_queues)
164 bus_bind_intr(ctrlr->dev, qpair->res, i);
171 nvme_ctrlr_fail(struct nvme_controller *ctrlr)
175 ctrlr->is_failed = TRUE;
176 nvme_qpair_fail(&ctrlr->adminq);
177 for (i = 0; i < ctrlr->num_io_queues; i++)
178 nvme_qpair_fail(&ctrlr->ioq[i]);
179 nvme_notify_fail_consumers(ctrlr);
183 nvme_ctrlr_post_failed_request(struct nvme_controller *ctrlr,
184 struct nvme_request *req)
187 mtx_lock(&ctrlr->lock);
188 STAILQ_INSERT_TAIL(&ctrlr->fail_req, req, stailq);
189 mtx_unlock(&ctrlr->lock);
190 taskqueue_enqueue(ctrlr->taskqueue, &ctrlr->fail_req_task);
194 nvme_ctrlr_fail_req_task(void *arg, int pending)
196 struct nvme_controller *ctrlr = arg;
197 struct nvme_request *req;
199 mtx_lock(&ctrlr->lock);
200 while (!STAILQ_EMPTY(&ctrlr->fail_req)) {
201 req = STAILQ_FIRST(&ctrlr->fail_req);
202 STAILQ_REMOVE_HEAD(&ctrlr->fail_req, stailq);
203 nvme_qpair_manual_complete_request(req->qpair, req,
204 NVME_SCT_GENERIC, NVME_SC_ABORTED_BY_REQUEST, TRUE);
206 mtx_unlock(&ctrlr->lock);
210 nvme_ctrlr_wait_for_ready(struct nvme_controller *ctrlr)
213 union cc_register cc;
214 union csts_register csts;
216 cc.raw = nvme_mmio_read_4(ctrlr, cc);
217 csts.raw = nvme_mmio_read_4(ctrlr, csts);
220 nvme_printf(ctrlr, "%s called with cc.en = 0\n", __func__);
226 while (!csts.bits.rdy) {
228 if (ms_waited++ > ctrlr->ready_timeout_in_ms) {
229 nvme_printf(ctrlr, "controller did not become ready "
230 "within %d ms\n", ctrlr->ready_timeout_in_ms);
233 csts.raw = nvme_mmio_read_4(ctrlr, csts);
240 nvme_ctrlr_disable(struct nvme_controller *ctrlr)
242 union cc_register cc;
243 union csts_register csts;
245 cc.raw = nvme_mmio_read_4(ctrlr, cc);
246 csts.raw = nvme_mmio_read_4(ctrlr, csts);
248 if (cc.bits.en == 1 && csts.bits.rdy == 0)
249 nvme_ctrlr_wait_for_ready(ctrlr);
252 nvme_mmio_write_4(ctrlr, cc, cc.raw);
257 nvme_ctrlr_enable(struct nvme_controller *ctrlr)
259 union cc_register cc;
260 union csts_register csts;
261 union aqa_register aqa;
263 cc.raw = nvme_mmio_read_4(ctrlr, cc);
264 csts.raw = nvme_mmio_read_4(ctrlr, csts);
266 if (cc.bits.en == 1) {
267 if (csts.bits.rdy == 1)
270 return (nvme_ctrlr_wait_for_ready(ctrlr));
273 nvme_mmio_write_8(ctrlr, asq, ctrlr->adminq.cmd_bus_addr);
275 nvme_mmio_write_8(ctrlr, acq, ctrlr->adminq.cpl_bus_addr);
279 /* acqs and asqs are 0-based. */
280 aqa.bits.acqs = ctrlr->adminq.num_entries-1;
281 aqa.bits.asqs = ctrlr->adminq.num_entries-1;
282 nvme_mmio_write_4(ctrlr, aqa, aqa.raw);
289 cc.bits.iosqes = 6; /* SQ entry size == 64 == 2^6 */
290 cc.bits.iocqes = 4; /* CQ entry size == 16 == 2^4 */
292 /* This evaluates to 0, which is according to spec. */
293 cc.bits.mps = (PAGE_SIZE >> 13);
295 nvme_mmio_write_4(ctrlr, cc, cc.raw);
298 return (nvme_ctrlr_wait_for_ready(ctrlr));
302 nvme_ctrlr_hw_reset(struct nvme_controller *ctrlr)
306 nvme_admin_qpair_disable(&ctrlr->adminq);
307 for (i = 0; i < ctrlr->num_io_queues; i++)
308 nvme_io_qpair_disable(&ctrlr->ioq[i]);
312 nvme_ctrlr_disable(ctrlr);
313 return (nvme_ctrlr_enable(ctrlr));
317 nvme_ctrlr_reset(struct nvme_controller *ctrlr)
321 cmpset = atomic_cmpset_32(&ctrlr->is_resetting, 0, 1);
323 if (cmpset == 0 || ctrlr->is_failed)
325 * Controller is already resetting or has failed. Return
326 * immediately since there is no need to kick off another
327 * reset in these cases.
331 taskqueue_enqueue(ctrlr->taskqueue, &ctrlr->reset_task);
335 nvme_ctrlr_identify(struct nvme_controller *ctrlr)
337 struct nvme_completion_poll_status status;
340 nvme_ctrlr_cmd_identify_controller(ctrlr, &ctrlr->cdata,
341 nvme_completion_poll_cb, &status);
342 while (status.done == FALSE)
344 if (nvme_completion_is_error(&status.cpl)) {
345 nvme_printf(ctrlr, "nvme_identify_controller failed!\n");
350 * Use MDTS to ensure our default max_xfer_size doesn't exceed what the
351 * controller supports.
353 if (ctrlr->cdata.mdts > 0)
354 ctrlr->max_xfer_size = min(ctrlr->max_xfer_size,
355 ctrlr->min_page_size * (1 << (ctrlr->cdata.mdts)));
361 nvme_ctrlr_set_num_qpairs(struct nvme_controller *ctrlr)
363 struct nvme_completion_poll_status status;
364 int cq_allocated, i, sq_allocated;
367 nvme_ctrlr_cmd_set_num_queues(ctrlr, ctrlr->num_io_queues,
368 nvme_completion_poll_cb, &status);
369 while (status.done == FALSE)
371 if (nvme_completion_is_error(&status.cpl)) {
372 nvme_printf(ctrlr, "nvme_set_num_queues failed!\n");
377 * Data in cdw0 is 0-based.
378 * Lower 16-bits indicate number of submission queues allocated.
379 * Upper 16-bits indicate number of completion queues allocated.
381 sq_allocated = (status.cpl.cdw0 & 0xFFFF) + 1;
382 cq_allocated = (status.cpl.cdw0 >> 16) + 1;
385 * Check that the controller was able to allocate the number of
386 * queues we requested. If not, revert to one IO queue pair.
388 if (sq_allocated < ctrlr->num_io_queues ||
389 cq_allocated < ctrlr->num_io_queues) {
392 * Destroy extra IO queue pairs that were created at
393 * controller construction time but are no longer
394 * needed. This will only happen when a controller
395 * supports fewer queues than MSI-X vectors. This
396 * is not the normal case, but does occur with the
397 * Chatham prototype board.
399 for (i = 1; i < ctrlr->num_io_queues; i++)
400 nvme_io_qpair_destroy(&ctrlr->ioq[i]);
402 ctrlr->num_io_queues = 1;
403 ctrlr->per_cpu_io_queues = 0;
410 nvme_ctrlr_create_qpairs(struct nvme_controller *ctrlr)
412 struct nvme_completion_poll_status status;
413 struct nvme_qpair *qpair;
416 for (i = 0; i < ctrlr->num_io_queues; i++) {
417 qpair = &ctrlr->ioq[i];
420 nvme_ctrlr_cmd_create_io_cq(ctrlr, qpair, qpair->vector,
421 nvme_completion_poll_cb, &status);
422 while (status.done == FALSE)
424 if (nvme_completion_is_error(&status.cpl)) {
425 nvme_printf(ctrlr, "nvme_create_io_cq failed!\n");
430 nvme_ctrlr_cmd_create_io_sq(qpair->ctrlr, qpair,
431 nvme_completion_poll_cb, &status);
432 while (status.done == FALSE)
434 if (nvme_completion_is_error(&status.cpl)) {
435 nvme_printf(ctrlr, "nvme_create_io_sq failed!\n");
444 nvme_ctrlr_construct_namespaces(struct nvme_controller *ctrlr)
446 struct nvme_namespace *ns;
449 for (i = 0; i < ctrlr->cdata.nn; i++) {
451 status = nvme_ns_construct(ns, i+1, ctrlr);
460 is_log_page_id_valid(uint8_t page_id)
465 case NVME_LOG_HEALTH_INFORMATION:
466 case NVME_LOG_FIRMWARE_SLOT:
474 nvme_ctrlr_get_log_page_size(struct nvme_controller *ctrlr, uint8_t page_id)
476 uint32_t log_page_size;
481 sizeof(struct nvme_error_information_entry) *
483 NVME_MAX_AER_LOG_SIZE);
485 case NVME_LOG_HEALTH_INFORMATION:
486 log_page_size = sizeof(struct nvme_health_information_page);
488 case NVME_LOG_FIRMWARE_SLOT:
489 log_page_size = sizeof(struct nvme_firmware_page);
496 return (log_page_size);
500 nvme_ctrlr_log_critical_warnings(struct nvme_controller *ctrlr,
501 union nvme_critical_warning_state state)
504 if (state.bits.available_spare == 1)
505 nvme_printf(ctrlr, "available spare space below threshold\n");
507 if (state.bits.temperature == 1)
508 nvme_printf(ctrlr, "temperature above threshold\n");
510 if (state.bits.device_reliability == 1)
511 nvme_printf(ctrlr, "device reliability degraded\n");
513 if (state.bits.read_only == 1)
514 nvme_printf(ctrlr, "media placed in read only mode\n");
516 if (state.bits.volatile_memory_backup == 1)
517 nvme_printf(ctrlr, "volatile memory backup device failed\n");
519 if (state.bits.reserved != 0)
521 "unknown critical warning(s): state = 0x%02x\n", state.raw);
525 nvme_ctrlr_async_event_log_page_cb(void *arg, const struct nvme_completion *cpl)
527 struct nvme_async_event_request *aer = arg;
528 struct nvme_health_information_page *health_info;
531 * If the log page fetch for some reason completed with an error,
532 * don't pass log page data to the consumers. In practice, this case
533 * should never happen.
535 if (nvme_completion_is_error(cpl))
536 nvme_notify_async_consumers(aer->ctrlr, &aer->cpl,
537 aer->log_page_id, NULL, 0);
539 if (aer->log_page_id == NVME_LOG_HEALTH_INFORMATION) {
540 health_info = (struct nvme_health_information_page *)
541 aer->log_page_buffer;
542 nvme_ctrlr_log_critical_warnings(aer->ctrlr,
543 health_info->critical_warning);
545 * Critical warnings reported through the
546 * SMART/health log page are persistent, so
547 * clear the associated bits in the async event
548 * config so that we do not receive repeated
549 * notifications for the same event.
551 aer->ctrlr->async_event_config.raw &=
552 ~health_info->critical_warning.raw;
553 nvme_ctrlr_cmd_set_async_event_config(aer->ctrlr,
554 aer->ctrlr->async_event_config, NULL, NULL);
559 * Pass the cpl data from the original async event completion,
560 * not the log page fetch.
562 nvme_notify_async_consumers(aer->ctrlr, &aer->cpl,
563 aer->log_page_id, aer->log_page_buffer, aer->log_page_size);
567 * Repost another asynchronous event request to replace the one
568 * that just completed.
570 nvme_ctrlr_construct_and_submit_aer(aer->ctrlr, aer);
574 nvme_ctrlr_async_event_cb(void *arg, const struct nvme_completion *cpl)
576 struct nvme_async_event_request *aer = arg;
578 if (nvme_completion_is_error(cpl)) {
580 * Do not retry failed async event requests. This avoids
581 * infinite loops where a new async event request is submitted
582 * to replace the one just failed, only to fail again and
583 * perpetuate the loop.
588 /* Associated log page is in bits 23:16 of completion entry dw0. */
589 aer->log_page_id = (cpl->cdw0 & 0xFF0000) >> 16;
591 nvme_printf(aer->ctrlr, "async event occurred (log page id=0x%x)\n",
594 if (is_log_page_id_valid(aer->log_page_id)) {
595 aer->log_page_size = nvme_ctrlr_get_log_page_size(aer->ctrlr,
597 memcpy(&aer->cpl, cpl, sizeof(*cpl));
598 nvme_ctrlr_cmd_get_log_page(aer->ctrlr, aer->log_page_id,
599 NVME_GLOBAL_NAMESPACE_TAG, aer->log_page_buffer,
600 aer->log_page_size, nvme_ctrlr_async_event_log_page_cb,
602 /* Wait to notify consumers until after log page is fetched. */
604 nvme_notify_async_consumers(aer->ctrlr, cpl, aer->log_page_id,
608 * Repost another asynchronous event request to replace the one
609 * that just completed.
611 nvme_ctrlr_construct_and_submit_aer(aer->ctrlr, aer);
616 nvme_ctrlr_construct_and_submit_aer(struct nvme_controller *ctrlr,
617 struct nvme_async_event_request *aer)
619 struct nvme_request *req;
622 req = nvme_allocate_request_null(nvme_ctrlr_async_event_cb, aer);
626 * Disable timeout here, since asynchronous event requests should by
627 * nature never be timed out.
629 req->timeout = FALSE;
630 req->cmd.opc = NVME_OPC_ASYNC_EVENT_REQUEST;
631 nvme_ctrlr_submit_admin_request(ctrlr, req);
635 nvme_ctrlr_configure_aer(struct nvme_controller *ctrlr)
637 struct nvme_completion_poll_status status;
638 struct nvme_async_event_request *aer;
641 ctrlr->async_event_config.raw = 0xFF;
642 ctrlr->async_event_config.bits.reserved = 0;
645 nvme_ctrlr_cmd_get_feature(ctrlr, NVME_FEAT_TEMPERATURE_THRESHOLD,
646 0, NULL, 0, nvme_completion_poll_cb, &status);
647 while (status.done == FALSE)
649 if (nvme_completion_is_error(&status.cpl) ||
650 (status.cpl.cdw0 & 0xFFFF) == 0xFFFF ||
651 (status.cpl.cdw0 & 0xFFFF) == 0x0000) {
652 nvme_printf(ctrlr, "temperature threshold not supported\n");
653 ctrlr->async_event_config.bits.temperature = 0;
656 nvme_ctrlr_cmd_set_async_event_config(ctrlr,
657 ctrlr->async_event_config, NULL, NULL);
659 /* aerl is a zero-based value, so we need to add 1 here. */
660 ctrlr->num_aers = min(NVME_MAX_ASYNC_EVENTS, (ctrlr->cdata.aerl+1));
662 for (i = 0; i < ctrlr->num_aers; i++) {
663 aer = &ctrlr->aer[i];
664 nvme_ctrlr_construct_and_submit_aer(ctrlr, aer);
669 nvme_ctrlr_configure_int_coalescing(struct nvme_controller *ctrlr)
672 ctrlr->int_coal_time = 0;
673 TUNABLE_INT_FETCH("hw.nvme.int_coal_time",
674 &ctrlr->int_coal_time);
676 ctrlr->int_coal_threshold = 0;
677 TUNABLE_INT_FETCH("hw.nvme.int_coal_threshold",
678 &ctrlr->int_coal_threshold);
680 nvme_ctrlr_cmd_set_interrupt_coalescing(ctrlr, ctrlr->int_coal_time,
681 ctrlr->int_coal_threshold, NULL, NULL);
685 nvme_ctrlr_start(void *ctrlr_arg)
687 struct nvme_controller *ctrlr = ctrlr_arg;
690 nvme_qpair_reset(&ctrlr->adminq);
691 for (i = 0; i < ctrlr->num_io_queues; i++)
692 nvme_qpair_reset(&ctrlr->ioq[i]);
694 nvme_admin_qpair_enable(&ctrlr->adminq);
696 if (nvme_ctrlr_identify(ctrlr) != 0) {
697 nvme_ctrlr_fail(ctrlr);
701 if (nvme_ctrlr_set_num_qpairs(ctrlr) != 0) {
702 nvme_ctrlr_fail(ctrlr);
706 if (nvme_ctrlr_create_qpairs(ctrlr) != 0) {
707 nvme_ctrlr_fail(ctrlr);
711 if (nvme_ctrlr_construct_namespaces(ctrlr) != 0) {
712 nvme_ctrlr_fail(ctrlr);
716 nvme_ctrlr_configure_aer(ctrlr);
717 nvme_ctrlr_configure_int_coalescing(ctrlr);
719 for (i = 0; i < ctrlr->num_io_queues; i++)
720 nvme_io_qpair_enable(&ctrlr->ioq[i]);
724 nvme_ctrlr_start_config_hook(void *arg)
726 struct nvme_controller *ctrlr = arg;
728 nvme_ctrlr_start(ctrlr);
729 config_intrhook_disestablish(&ctrlr->config_hook);
731 ctrlr->is_initialized = 1;
732 nvme_notify_new_controller(ctrlr);
736 nvme_ctrlr_reset_task(void *arg, int pending)
738 struct nvme_controller *ctrlr = arg;
741 nvme_printf(ctrlr, "resetting controller\n");
742 status = nvme_ctrlr_hw_reset(ctrlr);
744 * Use pause instead of DELAY, so that we yield to any nvme interrupt
745 * handlers on this CPU that were blocked on a qpair lock. We want
746 * all nvme interrupts completed before proceeding with restarting the
749 * XXX - any way to guarantee the interrupt handlers have quiesced?
751 pause("nvmereset", hz / 10);
753 nvme_ctrlr_start(ctrlr);
755 nvme_ctrlr_fail(ctrlr);
757 atomic_cmpset_32(&ctrlr->is_resetting, 1, 0);
761 nvme_ctrlr_intx_handler(void *arg)
763 struct nvme_controller *ctrlr = arg;
765 nvme_mmio_write_4(ctrlr, intms, 1);
767 nvme_qpair_process_completions(&ctrlr->adminq);
769 if (ctrlr->ioq[0].cpl)
770 nvme_qpair_process_completions(&ctrlr->ioq[0]);
772 nvme_mmio_write_4(ctrlr, intmc, 1);
776 nvme_ctrlr_configure_intx(struct nvme_controller *ctrlr)
779 ctrlr->num_io_queues = 1;
780 ctrlr->per_cpu_io_queues = 0;
782 ctrlr->res = bus_alloc_resource_any(ctrlr->dev, SYS_RES_IRQ,
783 &ctrlr->rid, RF_SHAREABLE | RF_ACTIVE);
785 if (ctrlr->res == NULL) {
786 nvme_printf(ctrlr, "unable to allocate shared IRQ\n");
790 bus_setup_intr(ctrlr->dev, ctrlr->res,
791 INTR_TYPE_MISC | INTR_MPSAFE, NULL, nvme_ctrlr_intx_handler,
794 if (ctrlr->tag == NULL) {
795 nvme_printf(ctrlr, "unable to setup intx handler\n");
803 nvme_pt_done(void *arg, const struct nvme_completion *cpl)
805 struct nvme_pt_command *pt = arg;
807 bzero(&pt->cpl, sizeof(pt->cpl));
808 pt->cpl.cdw0 = cpl->cdw0;
809 pt->cpl.status = cpl->status;
810 pt->cpl.status.p = 0;
812 mtx_lock(pt->driver_lock);
814 mtx_unlock(pt->driver_lock);
818 nvme_ctrlr_passthrough_cmd(struct nvme_controller *ctrlr,
819 struct nvme_pt_command *pt, uint32_t nsid, int is_user_buffer,
822 struct nvme_request *req;
824 struct buf *buf = NULL;
828 if (pt->len > ctrlr->max_xfer_size) {
829 nvme_printf(ctrlr, "pt->len (%d) "
830 "exceeds max_xfer_size (%d)\n", pt->len,
831 ctrlr->max_xfer_size);
834 if (is_user_buffer) {
836 * Ensure the user buffer is wired for the duration of
837 * this passthrough command.
841 buf->b_saveaddr = buf->b_data;
842 buf->b_data = pt->buf;
843 buf->b_bufsize = pt->len;
844 buf->b_iocmd = pt->is_read ? BIO_READ : BIO_WRITE;
845 #ifdef NVME_UNMAPPED_BIO_SUPPORT
846 if (vmapbuf(buf, 1) < 0) {
848 if (vmapbuf(buf) < 0) {
853 req = nvme_allocate_request_vaddr(buf->b_data, pt->len,
856 req = nvme_allocate_request_vaddr(pt->buf, pt->len,
859 req = nvme_allocate_request_null(nvme_pt_done, pt);
861 req->cmd.opc = pt->cmd.opc;
862 req->cmd.cdw10 = pt->cmd.cdw10;
863 req->cmd.cdw11 = pt->cmd.cdw11;
864 req->cmd.cdw12 = pt->cmd.cdw12;
865 req->cmd.cdw13 = pt->cmd.cdw13;
866 req->cmd.cdw14 = pt->cmd.cdw14;
867 req->cmd.cdw15 = pt->cmd.cdw15;
869 req->cmd.nsid = nsid;
874 mtx = &ctrlr->ns[nsid-1].lock;
877 pt->driver_lock = mtx;
880 nvme_ctrlr_submit_admin_request(ctrlr, req);
882 nvme_ctrlr_submit_io_request(ctrlr, req);
884 mtx_sleep(pt, mtx, PRIBIO, "nvme_pt", 0);
887 pt->driver_lock = NULL;
899 nvme_ctrlr_ioctl(struct cdev *cdev, u_long cmd, caddr_t arg, int flag,
902 struct nvme_controller *ctrlr;
903 struct nvme_pt_command *pt;
905 ctrlr = cdev->si_drv1;
908 case NVME_RESET_CONTROLLER:
909 nvme_ctrlr_reset(ctrlr);
911 case NVME_PASSTHROUGH_CMD:
912 pt = (struct nvme_pt_command *)arg;
913 return (nvme_ctrlr_passthrough_cmd(ctrlr, pt, pt->cmd.nsid,
914 1 /* is_user_buffer */, 1 /* is_admin_cmd */));
922 static struct cdevsw nvme_ctrlr_cdevsw = {
923 .d_version = D_VERSION,
925 .d_ioctl = nvme_ctrlr_ioctl
929 nvme_ctrlr_construct(struct nvme_controller *ctrlr, device_t dev)
931 union cap_lo_register cap_lo;
932 union cap_hi_register cap_hi;
933 int i, per_cpu_io_queues, rid;
934 int num_vectors_requested, num_vectors_allocated;
935 int status, timeout_period;
939 mtx_init(&ctrlr->lock, "nvme ctrlr lock", NULL, MTX_DEF);
941 status = nvme_ctrlr_allocate_bar(ctrlr);
947 * Software emulators may set the doorbell stride to something
948 * other than zero, but this driver is not set up to handle that.
950 cap_hi.raw = nvme_mmio_read_4(ctrlr, cap_hi);
951 if (cap_hi.bits.dstrd != 0)
954 ctrlr->min_page_size = 1 << (12 + cap_hi.bits.mpsmin);
956 /* Get ready timeout value from controller, in units of 500ms. */
957 cap_lo.raw = nvme_mmio_read_4(ctrlr, cap_lo);
958 ctrlr->ready_timeout_in_ms = cap_lo.bits.to * 500;
960 timeout_period = NVME_DEFAULT_TIMEOUT_PERIOD;
961 TUNABLE_INT_FETCH("hw.nvme.timeout_period", &timeout_period);
962 timeout_period = min(timeout_period, NVME_MAX_TIMEOUT_PERIOD);
963 timeout_period = max(timeout_period, NVME_MIN_TIMEOUT_PERIOD);
964 ctrlr->timeout_period = timeout_period;
966 nvme_retry_count = NVME_DEFAULT_RETRY_COUNT;
967 TUNABLE_INT_FETCH("hw.nvme.retry_count", &nvme_retry_count);
969 per_cpu_io_queues = 1;
970 TUNABLE_INT_FETCH("hw.nvme.per_cpu_io_queues", &per_cpu_io_queues);
971 ctrlr->per_cpu_io_queues = per_cpu_io_queues ? TRUE : FALSE;
973 if (ctrlr->per_cpu_io_queues)
974 ctrlr->num_io_queues = mp_ncpus;
976 ctrlr->num_io_queues = 1;
978 ctrlr->force_intx = 0;
979 TUNABLE_INT_FETCH("hw.nvme.force_intx", &ctrlr->force_intx);
981 ctrlr->enable_aborts = 0;
982 TUNABLE_INT_FETCH("hw.nvme.enable_aborts", &ctrlr->enable_aborts);
984 ctrlr->msix_enabled = 1;
986 if (ctrlr->force_intx) {
987 ctrlr->msix_enabled = 0;
991 /* One vector per IO queue, plus one vector for admin queue. */
992 num_vectors_requested = ctrlr->num_io_queues + 1;
995 * If we cannot even allocate 2 vectors (one for admin, one for
996 * I/O), then revert to INTx.
998 if (pci_msix_count(dev) < 2) {
999 ctrlr->msix_enabled = 0;
1001 } else if (pci_msix_count(dev) < num_vectors_requested) {
1002 ctrlr->per_cpu_io_queues = FALSE;
1003 ctrlr->num_io_queues = 1;
1004 num_vectors_requested = 2; /* one for admin, one for I/O */
1007 num_vectors_allocated = num_vectors_requested;
1008 if (pci_alloc_msix(dev, &num_vectors_allocated) != 0) {
1009 ctrlr->msix_enabled = 0;
1011 } else if (num_vectors_allocated < num_vectors_requested) {
1012 if (num_vectors_allocated < 2) {
1013 pci_release_msi(dev);
1014 ctrlr->msix_enabled = 0;
1017 ctrlr->per_cpu_io_queues = FALSE;
1018 ctrlr->num_io_queues = 1;
1020 * Release whatever vectors were allocated, and just
1021 * reallocate the two needed for the admin and single
1024 num_vectors_allocated = 2;
1025 pci_release_msi(dev);
1026 if (pci_alloc_msix(dev, &num_vectors_allocated) != 0)
1027 panic("could not reallocate any vectors\n");
1028 if (num_vectors_allocated != 2)
1029 panic("could not reallocate 2 vectors\n");
1034 * On earlier FreeBSD releases, there are reports that
1035 * pci_alloc_msix() can return successfully with all vectors
1036 * requested, but a subsequent bus_alloc_resource_any()
1037 * for one of those vectors fails. This issue occurs more
1038 * readily with multiple devices using per-CPU vectors.
1039 * To workaround this issue, try to allocate the resources now,
1040 * and fall back to INTx if we cannot allocate all of them.
1041 * This issue cannot be reproduced on more recent versions of
1042 * FreeBSD which have increased the maximum number of MSI-X
1043 * vectors, but adding the workaround makes it easier for
1044 * vendors wishing to import this driver into kernels based on
1045 * older versions of FreeBSD.
1047 for (i = 0; i < num_vectors_allocated; i++) {
1049 ctrlr->msi_res[i] = bus_alloc_resource_any(ctrlr->dev,
1050 SYS_RES_IRQ, &rid, RF_ACTIVE);
1052 if (ctrlr->msi_res[i] == NULL) {
1053 ctrlr->msix_enabled = 0;
1056 bus_release_resource(ctrlr->dev,
1058 rman_get_rid(ctrlr->msi_res[i]),
1061 pci_release_msi(dev);
1062 nvme_printf(ctrlr, "could not obtain all MSI-X "
1063 "resources, reverting to intx\n");
1070 if (!ctrlr->msix_enabled)
1071 nvme_ctrlr_configure_intx(ctrlr);
1073 ctrlr->max_xfer_size = NVME_MAX_XFER_SIZE;
1074 nvme_ctrlr_construct_admin_qpair(ctrlr);
1075 status = nvme_ctrlr_construct_io_qpairs(ctrlr);
1080 ctrlr->cdev = make_dev(&nvme_ctrlr_cdevsw, device_get_unit(dev),
1081 UID_ROOT, GID_WHEEL, 0600, "nvme%d", device_get_unit(dev));
1083 if (ctrlr->cdev == NULL)
1086 ctrlr->cdev->si_drv1 = (void *)ctrlr;
1088 ctrlr->taskqueue = taskqueue_create("nvme_taskq", M_WAITOK,
1089 taskqueue_thread_enqueue, &ctrlr->taskqueue);
1090 taskqueue_start_threads(&ctrlr->taskqueue, 1, PI_DISK, "nvme taskq");
1092 ctrlr->is_resetting = 0;
1093 ctrlr->is_initialized = 0;
1094 ctrlr->notification_sent = 0;
1095 TASK_INIT(&ctrlr->reset_task, 0, nvme_ctrlr_reset_task, ctrlr);
1097 TASK_INIT(&ctrlr->fail_req_task, 0, nvme_ctrlr_fail_req_task, ctrlr);
1098 STAILQ_INIT(&ctrlr->fail_req);
1099 ctrlr->is_failed = FALSE;
1105 nvme_ctrlr_destruct(struct nvme_controller *ctrlr, device_t dev)
1110 * Notify the controller of a shutdown, even though this is due to
1111 * a driver unload, not a system shutdown (this path is not invoked
1112 * during shutdown). This ensures the controller receives a
1113 * shutdown notification in case the system is shutdown before
1114 * reloading the driver.
1116 nvme_ctrlr_shutdown(ctrlr);
1118 nvme_ctrlr_disable(ctrlr);
1119 taskqueue_free(ctrlr->taskqueue);
1121 for (i = 0; i < NVME_MAX_NAMESPACES; i++)
1122 nvme_ns_destruct(&ctrlr->ns[i]);
1125 destroy_dev(ctrlr->cdev);
1127 for (i = 0; i < ctrlr->num_io_queues; i++) {
1128 nvme_io_qpair_destroy(&ctrlr->ioq[i]);
1131 free(ctrlr->ioq, M_NVME);
1133 nvme_admin_qpair_destroy(&ctrlr->adminq);
1135 if (ctrlr->resource != NULL) {
1136 bus_release_resource(dev, SYS_RES_MEMORY,
1137 ctrlr->resource_id, ctrlr->resource);
1140 if (ctrlr->bar4_resource != NULL) {
1141 bus_release_resource(dev, SYS_RES_MEMORY,
1142 ctrlr->bar4_resource_id, ctrlr->bar4_resource);
1146 bus_teardown_intr(ctrlr->dev, ctrlr->res, ctrlr->tag);
1149 bus_release_resource(ctrlr->dev, SYS_RES_IRQ,
1150 rman_get_rid(ctrlr->res), ctrlr->res);
1152 if (ctrlr->msix_enabled)
1153 pci_release_msi(dev);
1157 nvme_ctrlr_shutdown(struct nvme_controller *ctrlr)
1159 union cc_register cc;
1160 union csts_register csts;
1163 cc.raw = nvme_mmio_read_4(ctrlr, cc);
1164 cc.bits.shn = NVME_SHN_NORMAL;
1165 nvme_mmio_write_4(ctrlr, cc, cc.raw);
1166 csts.raw = nvme_mmio_read_4(ctrlr, csts);
1167 while ((csts.bits.shst != NVME_SHST_COMPLETE) && (ticks++ < 5*hz)) {
1168 pause("nvme shn", 1);
1169 csts.raw = nvme_mmio_read_4(ctrlr, csts);
1171 if (csts.bits.shst != NVME_SHST_COMPLETE)
1172 nvme_printf(ctrlr, "did not complete shutdown within 5 seconds "
1173 "of notification\n");
1177 nvme_ctrlr_submit_admin_request(struct nvme_controller *ctrlr,
1178 struct nvme_request *req)
1181 nvme_qpair_submit_request(&ctrlr->adminq, req);
1185 nvme_ctrlr_submit_io_request(struct nvme_controller *ctrlr,
1186 struct nvme_request *req)
1188 struct nvme_qpair *qpair;
1190 if (ctrlr->per_cpu_io_queues)
1191 qpair = &ctrlr->ioq[curcpu];
1193 qpair = &ctrlr->ioq[0];
1195 nvme_qpair_submit_request(qpair, req);
1199 nvme_ctrlr_get_device(struct nvme_controller *ctrlr)
1202 return (ctrlr->dev);
1205 const struct nvme_controller_data *
1206 nvme_ctrlr_get_data(struct nvme_controller *ctrlr)
1209 return (&ctrlr->cdata);