xref: /freebsd/sys/dev/nvme/nvme_ctrlr.c (revision 0d787e9b35c2fc01e724f06b4eda2807774e7f4e)
1bb0ec6b3SJim Harris /*-
2718cf2ccSPedro F. Giffuni  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3718cf2ccSPedro F. Giffuni  *
450dea2daSJim Harris  * Copyright (C) 2012-2016 Intel Corporation
5bb0ec6b3SJim Harris  * All rights reserved.
6bb0ec6b3SJim Harris  *
7bb0ec6b3SJim Harris  * Redistribution and use in source and binary forms, with or without
8bb0ec6b3SJim Harris  * modification, are permitted provided that the following conditions
9bb0ec6b3SJim Harris  * are met:
10bb0ec6b3SJim Harris  * 1. Redistributions of source code must retain the above copyright
11bb0ec6b3SJim Harris  *    notice, this list of conditions and the following disclaimer.
12bb0ec6b3SJim Harris  * 2. Redistributions in binary form must reproduce the above copyright
13bb0ec6b3SJim Harris  *    notice, this list of conditions and the following disclaimer in the
14bb0ec6b3SJim Harris  *    documentation and/or other materials provided with the distribution.
15bb0ec6b3SJim Harris  *
16bb0ec6b3SJim Harris  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17bb0ec6b3SJim Harris  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18bb0ec6b3SJim Harris  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19bb0ec6b3SJim Harris  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20bb0ec6b3SJim Harris  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21bb0ec6b3SJim Harris  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22bb0ec6b3SJim Harris  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23bb0ec6b3SJim Harris  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24bb0ec6b3SJim Harris  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25bb0ec6b3SJim Harris  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26bb0ec6b3SJim Harris  * SUCH DAMAGE.
27bb0ec6b3SJim Harris  */
28bb0ec6b3SJim Harris 
29bb0ec6b3SJim Harris #include <sys/cdefs.h>
30bb0ec6b3SJim Harris __FBSDID("$FreeBSD$");
31bb0ec6b3SJim Harris 
32f24c011bSWarner Losh #include "opt_cam.h"
33f24c011bSWarner Losh 
34bb0ec6b3SJim Harris #include <sys/param.h>
357c3f19d7SJim Harris #include <sys/systm.h>
367c3f19d7SJim Harris #include <sys/buf.h>
37bb0ec6b3SJim Harris #include <sys/bus.h>
38bb0ec6b3SJim Harris #include <sys/conf.h>
39bb0ec6b3SJim Harris #include <sys/ioccom.h>
407c3f19d7SJim Harris #include <sys/proc.h>
41bb0ec6b3SJim Harris #include <sys/smp.h>
427c3f19d7SJim Harris #include <sys/uio.h>
43*0d787e9bSWojciech Macek #include <sys/endian.h>
44bb0ec6b3SJim Harris 
45bb0ec6b3SJim Harris #include <dev/pci/pcireg.h>
46bb0ec6b3SJim Harris #include <dev/pci/pcivar.h>
47bb0ec6b3SJim Harris 
48bb0ec6b3SJim Harris #include "nvme_private.h"
49bb0ec6b3SJim Harris 
50*0d787e9bSWojciech Macek #define B4_CHK_RDY_DELAY_MS	2300		/* work around controller bug */
51ce1ec9c1SWarner Losh 
520a0b08ccSJim Harris static void nvme_ctrlr_construct_and_submit_aer(struct nvme_controller *ctrlr,
530a0b08ccSJim Harris 						struct nvme_async_event_request *aer);
54d400f790SJim Harris static void nvme_ctrlr_setup_interrupts(struct nvme_controller *ctrlr);
550a0b08ccSJim Harris 
56bb0ec6b3SJim Harris static int
57bb0ec6b3SJim Harris nvme_ctrlr_allocate_bar(struct nvme_controller *ctrlr)
58bb0ec6b3SJim Harris {
59bb0ec6b3SJim Harris 
60bb0ec6b3SJim Harris 	ctrlr->resource_id = PCIR_BAR(0);
61bb0ec6b3SJim Harris 
6243cd6160SJustin Hibbits 	ctrlr->resource = bus_alloc_resource_any(ctrlr->dev, SYS_RES_MEMORY,
6343cd6160SJustin Hibbits 	    &ctrlr->resource_id, RF_ACTIVE);
64bb0ec6b3SJim Harris 
65bb0ec6b3SJim Harris 	if(ctrlr->resource == NULL) {
66547d523eSJim Harris 		nvme_printf(ctrlr, "unable to allocate pci resource\n");
67bb0ec6b3SJim Harris 		return (ENOMEM);
68bb0ec6b3SJim Harris 	}
69bb0ec6b3SJim Harris 
70bb0ec6b3SJim Harris 	ctrlr->bus_tag = rman_get_bustag(ctrlr->resource);
71bb0ec6b3SJim Harris 	ctrlr->bus_handle = rman_get_bushandle(ctrlr->resource);
72bb0ec6b3SJim Harris 	ctrlr->regs = (struct nvme_registers *)ctrlr->bus_handle;
73bb0ec6b3SJim Harris 
7491fe20e3SJim Harris 	/*
7591fe20e3SJim Harris 	 * The NVMe spec allows for the MSI-X table to be placed behind
7691fe20e3SJim Harris 	 *  BAR 4/5, separate from the control/doorbell registers.  Always
7791fe20e3SJim Harris 	 *  try to map this bar, because it must be mapped prior to calling
7891fe20e3SJim Harris 	 *  pci_alloc_msix().  If the table isn't behind BAR 4/5,
7991fe20e3SJim Harris 	 *  bus_alloc_resource() will just return NULL which is OK.
8091fe20e3SJim Harris 	 */
8191fe20e3SJim Harris 	ctrlr->bar4_resource_id = PCIR_BAR(4);
8243cd6160SJustin Hibbits 	ctrlr->bar4_resource = bus_alloc_resource_any(ctrlr->dev, SYS_RES_MEMORY,
8343cd6160SJustin Hibbits 	    &ctrlr->bar4_resource_id, RF_ACTIVE);
8491fe20e3SJim Harris 
85bb0ec6b3SJim Harris 	return (0);
86bb0ec6b3SJim Harris }
87bb0ec6b3SJim Harris 
88a965389bSScott Long static int
89bb0ec6b3SJim Harris nvme_ctrlr_construct_admin_qpair(struct nvme_controller *ctrlr)
90bb0ec6b3SJim Harris {
91bb0ec6b3SJim Harris 	struct nvme_qpair	*qpair;
92bb0ec6b3SJim Harris 	uint32_t		num_entries;
93a965389bSScott Long 	int			error;
94bb0ec6b3SJim Harris 
95bb0ec6b3SJim Harris 	qpair = &ctrlr->adminq;
96bb0ec6b3SJim Harris 
97bb0ec6b3SJim Harris 	num_entries = NVME_ADMIN_ENTRIES;
98bb0ec6b3SJim Harris 	TUNABLE_INT_FETCH("hw.nvme.admin_entries", &num_entries);
99bb0ec6b3SJim Harris 	/*
100bb0ec6b3SJim Harris 	 * If admin_entries was overridden to an invalid value, revert it
101bb0ec6b3SJim Harris 	 *  back to our default value.
102bb0ec6b3SJim Harris 	 */
103bb0ec6b3SJim Harris 	if (num_entries < NVME_MIN_ADMIN_ENTRIES ||
104bb0ec6b3SJim Harris 	    num_entries > NVME_MAX_ADMIN_ENTRIES) {
105547d523eSJim Harris 		nvme_printf(ctrlr, "invalid hw.nvme.admin_entries=%d "
106547d523eSJim Harris 		    "specified\n", num_entries);
107bb0ec6b3SJim Harris 		num_entries = NVME_ADMIN_ENTRIES;
108bb0ec6b3SJim Harris 	}
109bb0ec6b3SJim Harris 
110bb0ec6b3SJim Harris 	/*
111bb0ec6b3SJim Harris 	 * The admin queue's max xfer size is treated differently than the
112bb0ec6b3SJim Harris 	 *  max I/O xfer size.  16KB is sufficient here - maybe even less?
113bb0ec6b3SJim Harris 	 */
114a965389bSScott Long 	error = nvme_qpair_construct(qpair,
11521b6da58SJim Harris 				     0, /* qpair ID */
11621b6da58SJim Harris 				     0, /* vector */
11721b6da58SJim Harris 				     num_entries,
11821b6da58SJim Harris 				     NVME_ADMIN_TRACKERS,
11921b6da58SJim Harris 				     ctrlr);
120a965389bSScott Long 	return (error);
121bb0ec6b3SJim Harris }
122bb0ec6b3SJim Harris 
123bb0ec6b3SJim Harris static int
124bb0ec6b3SJim Harris nvme_ctrlr_construct_io_qpairs(struct nvme_controller *ctrlr)
125bb0ec6b3SJim Harris {
126bb0ec6b3SJim Harris 	struct nvme_qpair	*qpair;
127*0d787e9bSWojciech Macek 	uint32_t		cap_lo;
128*0d787e9bSWojciech Macek 	uint16_t		mqes;
129a965389bSScott Long 	int			i, error, num_entries, num_trackers;
130bb0ec6b3SJim Harris 
131bb0ec6b3SJim Harris 	num_entries = NVME_IO_ENTRIES;
132bb0ec6b3SJim Harris 	TUNABLE_INT_FETCH("hw.nvme.io_entries", &num_entries);
133bb0ec6b3SJim Harris 
134bb0ec6b3SJim Harris 	/*
135bb0ec6b3SJim Harris 	 * NVMe spec sets a hard limit of 64K max entries, but
136bb0ec6b3SJim Harris 	 *  devices may specify a smaller limit, so we need to check
137bb0ec6b3SJim Harris 	 *  the MQES field in the capabilities register.
138bb0ec6b3SJim Harris 	 */
139*0d787e9bSWojciech Macek 	cap_lo = nvme_mmio_read_4(ctrlr, cap_lo);
140*0d787e9bSWojciech Macek 	mqes = (cap_lo >> NVME_CAP_LO_REG_MQES_SHIFT) & NVME_CAP_LO_REG_MQES_MASK;
141*0d787e9bSWojciech Macek 	num_entries = min(num_entries, mqes + 1);
142bb0ec6b3SJim Harris 
14321b6da58SJim Harris 	num_trackers = NVME_IO_TRACKERS;
14421b6da58SJim Harris 	TUNABLE_INT_FETCH("hw.nvme.io_trackers", &num_trackers);
14521b6da58SJim Harris 
14621b6da58SJim Harris 	num_trackers = max(num_trackers, NVME_MIN_IO_TRACKERS);
14721b6da58SJim Harris 	num_trackers = min(num_trackers, NVME_MAX_IO_TRACKERS);
14821b6da58SJim Harris 	/*
14921b6da58SJim Harris 	 * No need to have more trackers than entries in the submit queue.
15021b6da58SJim Harris 	 *  Note also that for a queue size of N, we can only have (N-1)
15121b6da58SJim Harris 	 *  commands outstanding, hence the "-1" here.
15221b6da58SJim Harris 	 */
15321b6da58SJim Harris 	num_trackers = min(num_trackers, (num_entries-1));
15421b6da58SJim Harris 
1552b647da7SJim Harris 	/*
156c02565f9SWarner Losh 	 * Our best estimate for the maximum number of I/Os that we should
157c02565f9SWarner Losh 	 * noramlly have in flight at one time. This should be viewed as a hint,
158c02565f9SWarner Losh 	 * not a hard limit and will need to be revisitted when the upper layers
159c02565f9SWarner Losh 	 * of the storage system grows multi-queue support.
160c02565f9SWarner Losh 	 */
1615fff95ccSWarner Losh 	ctrlr->max_hw_pend_io = num_trackers * ctrlr->num_io_queues * 3 / 4;
162c02565f9SWarner Losh 
163c02565f9SWarner Losh 	/*
1642b647da7SJim Harris 	 * This was calculated previously when setting up interrupts, but
1652b647da7SJim Harris 	 *  a controller could theoretically support fewer I/O queues than
1662b647da7SJim Harris 	 *  MSI-X vectors.  So calculate again here just to be safe.
1672b647da7SJim Harris 	 */
1689c6b5d40SJim Harris 	ctrlr->num_cpus_per_ioq = howmany(mp_ncpus, ctrlr->num_io_queues);
1692b647da7SJim Harris 
170bb0ec6b3SJim Harris 	ctrlr->ioq = malloc(ctrlr->num_io_queues * sizeof(struct nvme_qpair),
171237d2019SJim Harris 	    M_NVME, M_ZERO | M_WAITOK);
172bb0ec6b3SJim Harris 
173bb0ec6b3SJim Harris 	for (i = 0; i < ctrlr->num_io_queues; i++) {
174bb0ec6b3SJim Harris 		qpair = &ctrlr->ioq[i];
175bb0ec6b3SJim Harris 
176bb0ec6b3SJim Harris 		/*
177bb0ec6b3SJim Harris 		 * Admin queue has ID=0. IO queues start at ID=1 -
178bb0ec6b3SJim Harris 		 *  hence the 'i+1' here.
179bb0ec6b3SJim Harris 		 *
180bb0ec6b3SJim Harris 		 * For I/O queues, use the controller-wide max_xfer_size
181bb0ec6b3SJim Harris 		 *  calculated in nvme_attach().
182bb0ec6b3SJim Harris 		 */
183a965389bSScott Long 		error = nvme_qpair_construct(qpair,
184bb0ec6b3SJim Harris 				     i+1, /* qpair ID */
185bb0ec6b3SJim Harris 				     ctrlr->msix_enabled ? i+1 : 0, /* vector */
186bb0ec6b3SJim Harris 				     num_entries,
18721b6da58SJim Harris 				     num_trackers,
188bb0ec6b3SJim Harris 				     ctrlr);
189a965389bSScott Long 		if (error)
190a965389bSScott Long 			return (error);
191bb0ec6b3SJim Harris 
1922b647da7SJim Harris 		/*
1932b647da7SJim Harris 		 * Do not bother binding interrupts if we only have one I/O
1942b647da7SJim Harris 		 *  interrupt thread for this controller.
1952b647da7SJim Harris 		 */
196c75ad8ceSJim Harris 		if (ctrlr->num_io_queues > 1)
1972b647da7SJim Harris 			bus_bind_intr(ctrlr->dev, qpair->res,
1982b647da7SJim Harris 			    i * ctrlr->num_cpus_per_ioq);
199bb0ec6b3SJim Harris 	}
200bb0ec6b3SJim Harris 
201bb0ec6b3SJim Harris 	return (0);
202bb0ec6b3SJim Harris }
203bb0ec6b3SJim Harris 
204232e2edbSJim Harris static void
205232e2edbSJim Harris nvme_ctrlr_fail(struct nvme_controller *ctrlr)
206232e2edbSJim Harris {
207232e2edbSJim Harris 	int i;
208232e2edbSJim Harris 
209232e2edbSJim Harris 	ctrlr->is_failed = TRUE;
210232e2edbSJim Harris 	nvme_qpair_fail(&ctrlr->adminq);
211824073fbSWarner Losh 	if (ctrlr->ioq != NULL) {
212232e2edbSJim Harris 		for (i = 0; i < ctrlr->num_io_queues; i++)
213232e2edbSJim Harris 			nvme_qpair_fail(&ctrlr->ioq[i]);
214824073fbSWarner Losh 	}
215232e2edbSJim Harris 	nvme_notify_fail_consumers(ctrlr);
216232e2edbSJim Harris }
217232e2edbSJim Harris 
218232e2edbSJim Harris void
219232e2edbSJim Harris nvme_ctrlr_post_failed_request(struct nvme_controller *ctrlr,
220232e2edbSJim Harris     struct nvme_request *req)
221232e2edbSJim Harris {
222232e2edbSJim Harris 
223a90b8104SJim Harris 	mtx_lock(&ctrlr->lock);
224232e2edbSJim Harris 	STAILQ_INSERT_TAIL(&ctrlr->fail_req, req, stailq);
225a90b8104SJim Harris 	mtx_unlock(&ctrlr->lock);
226232e2edbSJim Harris 	taskqueue_enqueue(ctrlr->taskqueue, &ctrlr->fail_req_task);
227232e2edbSJim Harris }
228232e2edbSJim Harris 
229232e2edbSJim Harris static void
230232e2edbSJim Harris nvme_ctrlr_fail_req_task(void *arg, int pending)
231232e2edbSJim Harris {
232232e2edbSJim Harris 	struct nvme_controller	*ctrlr = arg;
233232e2edbSJim Harris 	struct nvme_request	*req;
234232e2edbSJim Harris 
235a90b8104SJim Harris 	mtx_lock(&ctrlr->lock);
236232e2edbSJim Harris 	while (!STAILQ_EMPTY(&ctrlr->fail_req)) {
237232e2edbSJim Harris 		req = STAILQ_FIRST(&ctrlr->fail_req);
238232e2edbSJim Harris 		STAILQ_REMOVE_HEAD(&ctrlr->fail_req, stailq);
239232e2edbSJim Harris 		nvme_qpair_manual_complete_request(req->qpair, req,
240232e2edbSJim Harris 		    NVME_SCT_GENERIC, NVME_SC_ABORTED_BY_REQUEST, TRUE);
241232e2edbSJim Harris 	}
242a90b8104SJim Harris 	mtx_unlock(&ctrlr->lock);
243232e2edbSJim Harris }
244232e2edbSJim Harris 
245bb0ec6b3SJim Harris static int
246cbdec09cSJim Harris nvme_ctrlr_wait_for_ready(struct nvme_controller *ctrlr, int desired_val)
247bb0ec6b3SJim Harris {
248bb0ec6b3SJim Harris 	int ms_waited;
249*0d787e9bSWojciech Macek 	uint32_t csts;
250bb0ec6b3SJim Harris 
251*0d787e9bSWojciech Macek 	csts = nvme_mmio_read_4(ctrlr, csts);
252bb0ec6b3SJim Harris 
253bb0ec6b3SJim Harris 	ms_waited = 0;
254*0d787e9bSWojciech Macek 	while (((csts >> NVME_CSTS_REG_RDY_SHIFT) & NVME_CSTS_REG_RDY_MASK) != desired_val) {
255bb0ec6b3SJim Harris 		if (ms_waited++ > ctrlr->ready_timeout_in_ms) {
256cbdec09cSJim Harris 			nvme_printf(ctrlr, "controller ready did not become %d "
257cbdec09cSJim Harris 			    "within %d ms\n", desired_val, ctrlr->ready_timeout_in_ms);
258bb0ec6b3SJim Harris 			return (ENXIO);
259bb0ec6b3SJim Harris 		}
260ce1ec9c1SWarner Losh 		DELAY(1000);
261*0d787e9bSWojciech Macek 		csts = nvme_mmio_read_4(ctrlr, csts);
262bb0ec6b3SJim Harris 	}
263bb0ec6b3SJim Harris 
264bb0ec6b3SJim Harris 	return (0);
265bb0ec6b3SJim Harris }
266bb0ec6b3SJim Harris 
267ce1ec9c1SWarner Losh static int
268bb0ec6b3SJim Harris nvme_ctrlr_disable(struct nvme_controller *ctrlr)
269bb0ec6b3SJim Harris {
270*0d787e9bSWojciech Macek 	uint32_t cc;
271*0d787e9bSWojciech Macek 	uint32_t csts;
272*0d787e9bSWojciech Macek 	uint8_t  en, rdy;
273ce1ec9c1SWarner Losh 	int err;
274bb0ec6b3SJim Harris 
275*0d787e9bSWojciech Macek 	cc = nvme_mmio_read_4(ctrlr, cc);
276*0d787e9bSWojciech Macek 	csts = nvme_mmio_read_4(ctrlr, csts);
277*0d787e9bSWojciech Macek 
278*0d787e9bSWojciech Macek 	en = (cc >> NVME_CC_REG_EN_SHIFT) & NVME_CC_REG_EN_MASK;
279*0d787e9bSWojciech Macek 	rdy = (csts >> NVME_CSTS_REG_RDY_SHIFT) & NVME_CSTS_REG_RDY_MASK;
280bb0ec6b3SJim Harris 
281ce1ec9c1SWarner Losh 	/*
282ce1ec9c1SWarner Losh 	 * Per 3.1.5 in NVME 1.3 spec, transitioning CC.EN from 0 to 1
283ce1ec9c1SWarner Losh 	 * when CSTS.RDY is 1 or transitioning CC.EN from 1 to 0 when
284ce1ec9c1SWarner Losh 	 * CSTS.RDY is 0 "has undefined results" So make sure that CSTS.RDY
285ce1ec9c1SWarner Losh 	 * isn't the desired value. Short circuit if we're already disabled.
286ce1ec9c1SWarner Losh 	 */
287*0d787e9bSWojciech Macek 	if (en == 1) {
288*0d787e9bSWojciech Macek 		if (rdy == 0) {
289ce1ec9c1SWarner Losh 			/* EN == 1, wait for  RDY == 1 or fail */
290ce1ec9c1SWarner Losh 			err = nvme_ctrlr_wait_for_ready(ctrlr, 1);
291ce1ec9c1SWarner Losh 			if (err != 0)
292ce1ec9c1SWarner Losh 				return (err);
293ce1ec9c1SWarner Losh 		}
294ce1ec9c1SWarner Losh 	} else {
295ce1ec9c1SWarner Losh 		/* EN == 0 already wait for RDY == 0 */
296*0d787e9bSWojciech Macek 		if (rdy == 0)
297ce1ec9c1SWarner Losh 			return (0);
298ce1ec9c1SWarner Losh 		else
299ce1ec9c1SWarner Losh 			return (nvme_ctrlr_wait_for_ready(ctrlr, 0));
300ce1ec9c1SWarner Losh 	}
301bb0ec6b3SJim Harris 
302*0d787e9bSWojciech Macek 	cc &= ~NVME_CC_REG_EN_MASK;
303*0d787e9bSWojciech Macek 	nvme_mmio_write_4(ctrlr, cc, cc);
304ce1ec9c1SWarner Losh 	/*
305ce1ec9c1SWarner Losh 	 * Some drives have issues with accessing the mmio after we
306ce1ec9c1SWarner Losh 	 * disable, so delay for a bit after we write the bit to
307ce1ec9c1SWarner Losh 	 * cope with these issues.
308ce1ec9c1SWarner Losh 	 */
309989c7f0bSWarner Losh 	if (ctrlr->quirks & QUIRK_DELAY_B4_CHK_RDY)
310ce1ec9c1SWarner Losh 		pause("nvmeR", B4_CHK_RDY_DELAY_MS * hz / 1000);
311ce1ec9c1SWarner Losh 	return (nvme_ctrlr_wait_for_ready(ctrlr, 0));
312bb0ec6b3SJim Harris }
313bb0ec6b3SJim Harris 
314bb0ec6b3SJim Harris static int
315bb0ec6b3SJim Harris nvme_ctrlr_enable(struct nvme_controller *ctrlr)
316bb0ec6b3SJim Harris {
317*0d787e9bSWojciech Macek 	uint32_t	cc;
318*0d787e9bSWojciech Macek 	uint32_t	csts;
319*0d787e9bSWojciech Macek 	uint32_t	aqa;
320*0d787e9bSWojciech Macek 	uint32_t	qsize;
321*0d787e9bSWojciech Macek 	uint8_t		en, rdy;
322ce1ec9c1SWarner Losh 	int		err;
323bb0ec6b3SJim Harris 
324*0d787e9bSWojciech Macek 	cc = nvme_mmio_read_4(ctrlr, cc);
325*0d787e9bSWojciech Macek 	csts = nvme_mmio_read_4(ctrlr, csts);
326*0d787e9bSWojciech Macek 
327*0d787e9bSWojciech Macek 	en = (cc >> NVME_CC_REG_EN_SHIFT) & NVME_CC_REG_EN_MASK;
328*0d787e9bSWojciech Macek 	rdy = (csts >> NVME_CSTS_REG_RDY_SHIFT) & NVME_CSTS_REG_RDY_MASK;
329bb0ec6b3SJim Harris 
330ce1ec9c1SWarner Losh 	/*
331ce1ec9c1SWarner Losh 	 * See note in nvme_ctrlr_disable. Short circuit if we're already enabled.
332ce1ec9c1SWarner Losh 	 */
333*0d787e9bSWojciech Macek 	if (en == 1) {
334*0d787e9bSWojciech Macek 		if (rdy == 1)
335bb0ec6b3SJim Harris 			return (0);
336bb0ec6b3SJim Harris 		else
337cbdec09cSJim Harris 			return (nvme_ctrlr_wait_for_ready(ctrlr, 1));
338ce1ec9c1SWarner Losh 	} else {
339ce1ec9c1SWarner Losh 		/* EN == 0 already wait for RDY == 0 or fail */
340ce1ec9c1SWarner Losh 		err = nvme_ctrlr_wait_for_ready(ctrlr, 0);
341ce1ec9c1SWarner Losh 		if (err != 0)
342ce1ec9c1SWarner Losh 			return (err);
343bb0ec6b3SJim Harris 	}
344bb0ec6b3SJim Harris 
345bb0ec6b3SJim Harris 	nvme_mmio_write_8(ctrlr, asq, ctrlr->adminq.cmd_bus_addr);
346bb0ec6b3SJim Harris 	DELAY(5000);
347bb0ec6b3SJim Harris 	nvme_mmio_write_8(ctrlr, acq, ctrlr->adminq.cpl_bus_addr);
348bb0ec6b3SJim Harris 	DELAY(5000);
349bb0ec6b3SJim Harris 
350bb0ec6b3SJim Harris 	/* acqs and asqs are 0-based. */
351*0d787e9bSWojciech Macek 	qsize = ctrlr->adminq.num_entries - 1;
352*0d787e9bSWojciech Macek 
353*0d787e9bSWojciech Macek 	aqa = 0;
354*0d787e9bSWojciech Macek 	aqa = (qsize & NVME_AQA_REG_ACQS_MASK) << NVME_AQA_REG_ACQS_SHIFT;
355*0d787e9bSWojciech Macek 	aqa |= (qsize & NVME_AQA_REG_ASQS_MASK) << NVME_AQA_REG_ASQS_SHIFT;
356*0d787e9bSWojciech Macek 	nvme_mmio_write_4(ctrlr, aqa, aqa);
357bb0ec6b3SJim Harris 	DELAY(5000);
358bb0ec6b3SJim Harris 
359*0d787e9bSWojciech Macek 	/* Initialization values for CC */
360*0d787e9bSWojciech Macek 	cc = 0;
361*0d787e9bSWojciech Macek 	cc |= 1 << NVME_CC_REG_EN_SHIFT;
362*0d787e9bSWojciech Macek 	cc |= 0 << NVME_CC_REG_CSS_SHIFT;
363*0d787e9bSWojciech Macek 	cc |= 0 << NVME_CC_REG_AMS_SHIFT;
364*0d787e9bSWojciech Macek 	cc |= 0 << NVME_CC_REG_SHN_SHIFT;
365*0d787e9bSWojciech Macek 	cc |= 6 << NVME_CC_REG_IOSQES_SHIFT; /* SQ entry size == 64 == 2^6 */
366*0d787e9bSWojciech Macek 	cc |= 4 << NVME_CC_REG_IOCQES_SHIFT; /* CQ entry size == 16 == 2^4 */
367bb0ec6b3SJim Harris 
368bb0ec6b3SJim Harris 	/* This evaluates to 0, which is according to spec. */
369*0d787e9bSWojciech Macek 	cc |= (PAGE_SIZE >> 13) << NVME_CC_REG_MPS_SHIFT;
370bb0ec6b3SJim Harris 
371*0d787e9bSWojciech Macek 	nvme_mmio_write_4(ctrlr, cc, cc);
372bb0ec6b3SJim Harris 
373cbdec09cSJim Harris 	return (nvme_ctrlr_wait_for_ready(ctrlr, 1));
374bb0ec6b3SJim Harris }
375bb0ec6b3SJim Harris 
376bb0ec6b3SJim Harris int
377b846efd7SJim Harris nvme_ctrlr_hw_reset(struct nvme_controller *ctrlr)
378bb0ec6b3SJim Harris {
379ce1ec9c1SWarner Losh 	int i, err;
380b846efd7SJim Harris 
381b846efd7SJim Harris 	nvme_admin_qpair_disable(&ctrlr->adminq);
3822b647da7SJim Harris 	/*
3832b647da7SJim Harris 	 * I/O queues are not allocated before the initial HW
3842b647da7SJim Harris 	 *  reset, so do not try to disable them.  Use is_initialized
3852b647da7SJim Harris 	 *  to determine if this is the initial HW reset.
3862b647da7SJim Harris 	 */
3872b647da7SJim Harris 	if (ctrlr->is_initialized) {
388b846efd7SJim Harris 		for (i = 0; i < ctrlr->num_io_queues; i++)
389b846efd7SJim Harris 			nvme_io_qpair_disable(&ctrlr->ioq[i]);
3902b647da7SJim Harris 	}
391b846efd7SJim Harris 
392b846efd7SJim Harris 	DELAY(100*1000);
393bb0ec6b3SJim Harris 
394ce1ec9c1SWarner Losh 	err = nvme_ctrlr_disable(ctrlr);
395ce1ec9c1SWarner Losh 	if (err != 0)
396ce1ec9c1SWarner Losh 		return err;
397bb0ec6b3SJim Harris 	return (nvme_ctrlr_enable(ctrlr));
398bb0ec6b3SJim Harris }
399bb0ec6b3SJim Harris 
400b846efd7SJim Harris void
401b846efd7SJim Harris nvme_ctrlr_reset(struct nvme_controller *ctrlr)
402b846efd7SJim Harris {
403f37c22a3SJim Harris 	int cmpset;
404f37c22a3SJim Harris 
405f37c22a3SJim Harris 	cmpset = atomic_cmpset_32(&ctrlr->is_resetting, 0, 1);
406f37c22a3SJim Harris 
407232e2edbSJim Harris 	if (cmpset == 0 || ctrlr->is_failed)
408232e2edbSJim Harris 		/*
409232e2edbSJim Harris 		 * Controller is already resetting or has failed.  Return
410232e2edbSJim Harris 		 *  immediately since there is no need to kick off another
411232e2edbSJim Harris 		 *  reset in these cases.
412232e2edbSJim Harris 		 */
413f37c22a3SJim Harris 		return;
414b846efd7SJim Harris 
41548ce3178SJim Harris 	taskqueue_enqueue(ctrlr->taskqueue, &ctrlr->reset_task);
416b846efd7SJim Harris }
417b846efd7SJim Harris 
418bb0ec6b3SJim Harris static int
419bb0ec6b3SJim Harris nvme_ctrlr_identify(struct nvme_controller *ctrlr)
420bb0ec6b3SJim Harris {
421955910a9SJim Harris 	struct nvme_completion_poll_status	status;
422bb0ec6b3SJim Harris 
42329077eb4SWarner Losh 	status.done = 0;
424bb0ec6b3SJim Harris 	nvme_ctrlr_cmd_identify_controller(ctrlr, &ctrlr->cdata,
425955910a9SJim Harris 	    nvme_completion_poll_cb, &status);
42629077eb4SWarner Losh 	while (!atomic_load_acq_int(&status.done))
4278e0ac13fSJim Harris 		pause("nvme", 1);
428955910a9SJim Harris 	if (nvme_completion_is_error(&status.cpl)) {
429547d523eSJim Harris 		nvme_printf(ctrlr, "nvme_identify_controller failed!\n");
430bb0ec6b3SJim Harris 		return (ENXIO);
431bb0ec6b3SJim Harris 	}
432bb0ec6b3SJim Harris 
433*0d787e9bSWojciech Macek 	/* Convert data to host endian */
434*0d787e9bSWojciech Macek 	nvme_controller_data_swapbytes(&ctrlr->cdata);
435*0d787e9bSWojciech Macek 
43602e33484SJim Harris 	/*
43702e33484SJim Harris 	 * Use MDTS to ensure our default max_xfer_size doesn't exceed what the
43802e33484SJim Harris 	 *  controller supports.
43902e33484SJim Harris 	 */
44002e33484SJim Harris 	if (ctrlr->cdata.mdts > 0)
44102e33484SJim Harris 		ctrlr->max_xfer_size = min(ctrlr->max_xfer_size,
44202e33484SJim Harris 		    ctrlr->min_page_size * (1 << (ctrlr->cdata.mdts)));
44302e33484SJim Harris 
444bb0ec6b3SJim Harris 	return (0);
445bb0ec6b3SJim Harris }
446bb0ec6b3SJim Harris 
447bb0ec6b3SJim Harris static int
448bb0ec6b3SJim Harris nvme_ctrlr_set_num_qpairs(struct nvme_controller *ctrlr)
449bb0ec6b3SJim Harris {
450955910a9SJim Harris 	struct nvme_completion_poll_status	status;
4512b647da7SJim Harris 	int					cq_allocated, sq_allocated;
452bb0ec6b3SJim Harris 
45329077eb4SWarner Losh 	status.done = 0;
454bb0ec6b3SJim Harris 	nvme_ctrlr_cmd_set_num_queues(ctrlr, ctrlr->num_io_queues,
455955910a9SJim Harris 	    nvme_completion_poll_cb, &status);
45629077eb4SWarner Losh 	while (!atomic_load_acq_int(&status.done))
4578e0ac13fSJim Harris 		pause("nvme", 1);
458955910a9SJim Harris 	if (nvme_completion_is_error(&status.cpl)) {
459824073fbSWarner Losh 		nvme_printf(ctrlr, "nvme_ctrlr_set_num_qpairs failed!\n");
460bb0ec6b3SJim Harris 		return (ENXIO);
461bb0ec6b3SJim Harris 	}
462bb0ec6b3SJim Harris 
463bb0ec6b3SJim Harris 	/*
464bb0ec6b3SJim Harris 	 * Data in cdw0 is 0-based.
465bb0ec6b3SJim Harris 	 * Lower 16-bits indicate number of submission queues allocated.
466bb0ec6b3SJim Harris 	 * Upper 16-bits indicate number of completion queues allocated.
467bb0ec6b3SJim Harris 	 */
468955910a9SJim Harris 	sq_allocated = (status.cpl.cdw0 & 0xFFFF) + 1;
469955910a9SJim Harris 	cq_allocated = (status.cpl.cdw0 >> 16) + 1;
470bb0ec6b3SJim Harris 
471bb0ec6b3SJim Harris 	/*
4722b647da7SJim Harris 	 * Controller may allocate more queues than we requested,
4732b647da7SJim Harris 	 *  so use the minimum of the number requested and what was
4742b647da7SJim Harris 	 *  actually allocated.
475bb0ec6b3SJim Harris 	 */
4762b647da7SJim Harris 	ctrlr->num_io_queues = min(ctrlr->num_io_queues, sq_allocated);
4772b647da7SJim Harris 	ctrlr->num_io_queues = min(ctrlr->num_io_queues, cq_allocated);
478bb0ec6b3SJim Harris 
479bb0ec6b3SJim Harris 	return (0);
480bb0ec6b3SJim Harris }
481bb0ec6b3SJim Harris 
482bb0ec6b3SJim Harris static int
483bb0ec6b3SJim Harris nvme_ctrlr_create_qpairs(struct nvme_controller *ctrlr)
484bb0ec6b3SJim Harris {
485955910a9SJim Harris 	struct nvme_completion_poll_status	status;
486bb0ec6b3SJim Harris 	struct nvme_qpair			*qpair;
487955910a9SJim Harris 	int					i;
488bb0ec6b3SJim Harris 
489bb0ec6b3SJim Harris 	for (i = 0; i < ctrlr->num_io_queues; i++) {
490bb0ec6b3SJim Harris 		qpair = &ctrlr->ioq[i];
491bb0ec6b3SJim Harris 
49229077eb4SWarner Losh 		status.done = 0;
493bb0ec6b3SJim Harris 		nvme_ctrlr_cmd_create_io_cq(ctrlr, qpair, qpair->vector,
494955910a9SJim Harris 		    nvme_completion_poll_cb, &status);
49529077eb4SWarner Losh 		while (!atomic_load_acq_int(&status.done))
4968e0ac13fSJim Harris 			pause("nvme", 1);
497955910a9SJim Harris 		if (nvme_completion_is_error(&status.cpl)) {
498547d523eSJim Harris 			nvme_printf(ctrlr, "nvme_create_io_cq failed!\n");
499bb0ec6b3SJim Harris 			return (ENXIO);
500bb0ec6b3SJim Harris 		}
501bb0ec6b3SJim Harris 
50229077eb4SWarner Losh 		status.done = 0;
503bb0ec6b3SJim Harris 		nvme_ctrlr_cmd_create_io_sq(qpair->ctrlr, qpair,
504955910a9SJim Harris 		    nvme_completion_poll_cb, &status);
50529077eb4SWarner Losh 		while (!atomic_load_acq_int(&status.done))
5068e0ac13fSJim Harris 			pause("nvme", 1);
507955910a9SJim Harris 		if (nvme_completion_is_error(&status.cpl)) {
508547d523eSJim Harris 			nvme_printf(ctrlr, "nvme_create_io_sq failed!\n");
509bb0ec6b3SJim Harris 			return (ENXIO);
510bb0ec6b3SJim Harris 		}
511bb0ec6b3SJim Harris 	}
512bb0ec6b3SJim Harris 
513bb0ec6b3SJim Harris 	return (0);
514bb0ec6b3SJim Harris }
515bb0ec6b3SJim Harris 
516bb0ec6b3SJim Harris static int
517bb0ec6b3SJim Harris nvme_ctrlr_construct_namespaces(struct nvme_controller *ctrlr)
518bb0ec6b3SJim Harris {
519bb0ec6b3SJim Harris 	struct nvme_namespace	*ns;
520696c9502SWarner Losh 	uint32_t 		i;
521bb0ec6b3SJim Harris 
522a8a18dd5SWarner Losh 	for (i = 0; i < min(ctrlr->cdata.nn, NVME_MAX_NAMESPACES); i++) {
523bb0ec6b3SJim Harris 		ns = &ctrlr->ns[i];
524a8a18dd5SWarner Losh 		nvme_ns_construct(ns, i+1, ctrlr);
525bb0ec6b3SJim Harris 	}
526bb0ec6b3SJim Harris 
527bb0ec6b3SJim Harris 	return (0);
528bb0ec6b3SJim Harris }
529bb0ec6b3SJim Harris 
5302868353aSJim Harris static boolean_t
5312868353aSJim Harris is_log_page_id_valid(uint8_t page_id)
5322868353aSJim Harris {
5332868353aSJim Harris 
5342868353aSJim Harris 	switch (page_id) {
5352868353aSJim Harris 	case NVME_LOG_ERROR:
5362868353aSJim Harris 	case NVME_LOG_HEALTH_INFORMATION:
5372868353aSJim Harris 	case NVME_LOG_FIRMWARE_SLOT:
5382868353aSJim Harris 		return (TRUE);
5392868353aSJim Harris 	}
5402868353aSJim Harris 
5412868353aSJim Harris 	return (FALSE);
5422868353aSJim Harris }
5432868353aSJim Harris 
5442868353aSJim Harris static uint32_t
5452868353aSJim Harris nvme_ctrlr_get_log_page_size(struct nvme_controller *ctrlr, uint8_t page_id)
5462868353aSJim Harris {
5472868353aSJim Harris 	uint32_t	log_page_size;
5482868353aSJim Harris 
5492868353aSJim Harris 	switch (page_id) {
5502868353aSJim Harris 	case NVME_LOG_ERROR:
5512868353aSJim Harris 		log_page_size = min(
5522868353aSJim Harris 		    sizeof(struct nvme_error_information_entry) *
553*0d787e9bSWojciech Macek 		    (ctrlr->cdata.elpe + 1), NVME_MAX_AER_LOG_SIZE);
5542868353aSJim Harris 		break;
5552868353aSJim Harris 	case NVME_LOG_HEALTH_INFORMATION:
5562868353aSJim Harris 		log_page_size = sizeof(struct nvme_health_information_page);
5572868353aSJim Harris 		break;
5582868353aSJim Harris 	case NVME_LOG_FIRMWARE_SLOT:
5592868353aSJim Harris 		log_page_size = sizeof(struct nvme_firmware_page);
5602868353aSJim Harris 		break;
5612868353aSJim Harris 	default:
5622868353aSJim Harris 		log_page_size = 0;
5632868353aSJim Harris 		break;
5642868353aSJim Harris 	}
5652868353aSJim Harris 
5662868353aSJim Harris 	return (log_page_size);
5672868353aSJim Harris }
5682868353aSJim Harris 
5692868353aSJim Harris static void
570bb2f67fdSJim Harris nvme_ctrlr_log_critical_warnings(struct nvme_controller *ctrlr,
571*0d787e9bSWojciech Macek     uint8_t state)
572bb2f67fdSJim Harris {
573bb2f67fdSJim Harris 
574*0d787e9bSWojciech Macek 	if (state & NVME_CRIT_WARN_ST_AVAILABLE_SPARE)
575bb2f67fdSJim Harris 		nvme_printf(ctrlr, "available spare space below threshold\n");
576bb2f67fdSJim Harris 
577*0d787e9bSWojciech Macek 	if (state & NVME_CRIT_WARN_ST_TEMPERATURE)
578bb2f67fdSJim Harris 		nvme_printf(ctrlr, "temperature above threshold\n");
579bb2f67fdSJim Harris 
580*0d787e9bSWojciech Macek 	if (state & NVME_CRIT_WARN_ST_DEVICE_RELIABILITY)
581bb2f67fdSJim Harris 		nvme_printf(ctrlr, "device reliability degraded\n");
582bb2f67fdSJim Harris 
583*0d787e9bSWojciech Macek 	if (state & NVME_CRIT_WARN_ST_READ_ONLY)
584bb2f67fdSJim Harris 		nvme_printf(ctrlr, "media placed in read only mode\n");
585bb2f67fdSJim Harris 
586*0d787e9bSWojciech Macek 	if (state & NVME_CRIT_WARN_ST_VOLATILE_MEMORY_BACKUP)
587bb2f67fdSJim Harris 		nvme_printf(ctrlr, "volatile memory backup device failed\n");
588bb2f67fdSJim Harris 
589*0d787e9bSWojciech Macek 	if (state & NVME_CRIT_WARN_ST_RESERVED_MASK)
590bb2f67fdSJim Harris 		nvme_printf(ctrlr,
591*0d787e9bSWojciech Macek 		    "unknown critical warning(s): state = 0x%02x\n", state);
592bb2f67fdSJim Harris }
593bb2f67fdSJim Harris 
594bb2f67fdSJim Harris static void
5952868353aSJim Harris nvme_ctrlr_async_event_log_page_cb(void *arg, const struct nvme_completion *cpl)
5962868353aSJim Harris {
5972868353aSJim Harris 	struct nvme_async_event_request		*aer = arg;
598bb2f67fdSJim Harris 	struct nvme_health_information_page	*health_info;
599*0d787e9bSWojciech Macek 	struct nvme_error_information_entry	*err;
600*0d787e9bSWojciech Macek 	int i;
6012868353aSJim Harris 
6020d7e13ecSJim Harris 	/*
6030d7e13ecSJim Harris 	 * If the log page fetch for some reason completed with an error,
6040d7e13ecSJim Harris 	 *  don't pass log page data to the consumers.  In practice, this case
6050d7e13ecSJim Harris 	 *  should never happen.
6060d7e13ecSJim Harris 	 */
6070d7e13ecSJim Harris 	if (nvme_completion_is_error(cpl))
6080d7e13ecSJim Harris 		nvme_notify_async_consumers(aer->ctrlr, &aer->cpl,
6090d7e13ecSJim Harris 		    aer->log_page_id, NULL, 0);
610bb2f67fdSJim Harris 	else {
611*0d787e9bSWojciech Macek 		/* Convert data to host endian */
612*0d787e9bSWojciech Macek 		switch (aer->log_page_id) {
613*0d787e9bSWojciech Macek 		case NVME_LOG_ERROR:
614*0d787e9bSWojciech Macek 			err = (struct nvme_error_information_entry *)aer->log_page_buffer;
615*0d787e9bSWojciech Macek 			for (i = 0; i < (aer->ctrlr->cdata.elpe + 1); i++)
616*0d787e9bSWojciech Macek 				nvme_error_information_entry_swapbytes(err++);
617*0d787e9bSWojciech Macek 			break;
618*0d787e9bSWojciech Macek 		case NVME_LOG_HEALTH_INFORMATION:
619*0d787e9bSWojciech Macek 			nvme_health_information_page_swapbytes(
620*0d787e9bSWojciech Macek 			    (struct nvme_health_information_page *)aer->log_page_buffer);
621*0d787e9bSWojciech Macek 			break;
622*0d787e9bSWojciech Macek 		case NVME_LOG_FIRMWARE_SLOT:
623*0d787e9bSWojciech Macek 			nvme_firmware_page_swapbytes(
624*0d787e9bSWojciech Macek 			    (struct nvme_firmware_page *)aer->log_page_buffer);
625*0d787e9bSWojciech Macek 			break;
626*0d787e9bSWojciech Macek 		case INTEL_LOG_TEMP_STATS:
627*0d787e9bSWojciech Macek 			intel_log_temp_stats_swapbytes(
628*0d787e9bSWojciech Macek 			    (struct intel_log_temp_stats *)aer->log_page_buffer);
629*0d787e9bSWojciech Macek 			break;
630*0d787e9bSWojciech Macek 		default:
631*0d787e9bSWojciech Macek 			break;
632*0d787e9bSWojciech Macek 		}
633*0d787e9bSWojciech Macek 
634bb2f67fdSJim Harris 		if (aer->log_page_id == NVME_LOG_HEALTH_INFORMATION) {
635bb2f67fdSJim Harris 			health_info = (struct nvme_health_information_page *)
636bb2f67fdSJim Harris 			    aer->log_page_buffer;
637bb2f67fdSJim Harris 			nvme_ctrlr_log_critical_warnings(aer->ctrlr,
638bb2f67fdSJim Harris 			    health_info->critical_warning);
639bb2f67fdSJim Harris 			/*
640bb2f67fdSJim Harris 			 * Critical warnings reported through the
641bb2f67fdSJim Harris 			 *  SMART/health log page are persistent, so
642bb2f67fdSJim Harris 			 *  clear the associated bits in the async event
643bb2f67fdSJim Harris 			 *  config so that we do not receive repeated
644bb2f67fdSJim Harris 			 *  notifications for the same event.
645bb2f67fdSJim Harris 			 */
646*0d787e9bSWojciech Macek 			aer->ctrlr->async_event_config &=
647*0d787e9bSWojciech Macek 			    ~health_info->critical_warning;
648bb2f67fdSJim Harris 			nvme_ctrlr_cmd_set_async_event_config(aer->ctrlr,
649bb2f67fdSJim Harris 			    aer->ctrlr->async_event_config, NULL, NULL);
650bb2f67fdSJim Harris 		}
651bb2f67fdSJim Harris 
652bb2f67fdSJim Harris 
6530d7e13ecSJim Harris 		/*
6540d7e13ecSJim Harris 		 * Pass the cpl data from the original async event completion,
6550d7e13ecSJim Harris 		 *  not the log page fetch.
6560d7e13ecSJim Harris 		 */
6570d7e13ecSJim Harris 		nvme_notify_async_consumers(aer->ctrlr, &aer->cpl,
6580d7e13ecSJim Harris 		    aer->log_page_id, aer->log_page_buffer, aer->log_page_size);
659bb2f67fdSJim Harris 	}
6602868353aSJim Harris 
6612868353aSJim Harris 	/*
6622868353aSJim Harris 	 * Repost another asynchronous event request to replace the one
6632868353aSJim Harris 	 *  that just completed.
6642868353aSJim Harris 	 */
6652868353aSJim Harris 	nvme_ctrlr_construct_and_submit_aer(aer->ctrlr, aer);
6662868353aSJim Harris }
6672868353aSJim Harris 
668bb0ec6b3SJim Harris static void
6690a0b08ccSJim Harris nvme_ctrlr_async_event_cb(void *arg, const struct nvme_completion *cpl)
6700a0b08ccSJim Harris {
6710a0b08ccSJim Harris 	struct nvme_async_event_request	*aer = arg;
6720a0b08ccSJim Harris 
673ec526ea9SJim Harris 	if (nvme_completion_is_error(cpl)) {
6740a0b08ccSJim Harris 		/*
675ec526ea9SJim Harris 		 *  Do not retry failed async event requests.  This avoids
676ec526ea9SJim Harris 		 *  infinite loops where a new async event request is submitted
677ec526ea9SJim Harris 		 *  to replace the one just failed, only to fail again and
678ec526ea9SJim Harris 		 *  perpetuate the loop.
6790a0b08ccSJim Harris 		 */
6800a0b08ccSJim Harris 		return;
6810a0b08ccSJim Harris 	}
6820a0b08ccSJim Harris 
6832868353aSJim Harris 	/* Associated log page is in bits 23:16 of completion entry dw0. */
6840d7e13ecSJim Harris 	aer->log_page_id = (cpl->cdw0 & 0xFF0000) >> 16;
6852868353aSJim Harris 
686547d523eSJim Harris 	nvme_printf(aer->ctrlr, "async event occurred (log page id=0x%x)\n",
687547d523eSJim Harris 	    aer->log_page_id);
688547d523eSJim Harris 
6890d7e13ecSJim Harris 	if (is_log_page_id_valid(aer->log_page_id)) {
6902868353aSJim Harris 		aer->log_page_size = nvme_ctrlr_get_log_page_size(aer->ctrlr,
6910d7e13ecSJim Harris 		    aer->log_page_id);
6922868353aSJim Harris 		memcpy(&aer->cpl, cpl, sizeof(*cpl));
6930d7e13ecSJim Harris 		nvme_ctrlr_cmd_get_log_page(aer->ctrlr, aer->log_page_id,
6942868353aSJim Harris 		    NVME_GLOBAL_NAMESPACE_TAG, aer->log_page_buffer,
6952868353aSJim Harris 		    aer->log_page_size, nvme_ctrlr_async_event_log_page_cb,
6962868353aSJim Harris 		    aer);
6972868353aSJim Harris 		/* Wait to notify consumers until after log page is fetched. */
6982868353aSJim Harris 	} else {
6990d7e13ecSJim Harris 		nvme_notify_async_consumers(aer->ctrlr, cpl, aer->log_page_id,
7000d7e13ecSJim Harris 		    NULL, 0);
701038a5ee4SJim Harris 
7020a0b08ccSJim Harris 		/*
7032868353aSJim Harris 		 * Repost another asynchronous event request to replace the one
7042868353aSJim Harris 		 *  that just completed.
7050a0b08ccSJim Harris 		 */
7060a0b08ccSJim Harris 		nvme_ctrlr_construct_and_submit_aer(aer->ctrlr, aer);
7070a0b08ccSJim Harris 	}
7082868353aSJim Harris }
7090a0b08ccSJim Harris 
7100a0b08ccSJim Harris static void
7110a0b08ccSJim Harris nvme_ctrlr_construct_and_submit_aer(struct nvme_controller *ctrlr,
7120a0b08ccSJim Harris     struct nvme_async_event_request *aer)
7130a0b08ccSJim Harris {
7140a0b08ccSJim Harris 	struct nvme_request *req;
7150a0b08ccSJim Harris 
7160a0b08ccSJim Harris 	aer->ctrlr = ctrlr;
7171e526bc4SJim Harris 	req = nvme_allocate_request_null(nvme_ctrlr_async_event_cb, aer);
7180a0b08ccSJim Harris 	aer->req = req;
7190a0b08ccSJim Harris 
7200a0b08ccSJim Harris 	/*
72194143332SJim Harris 	 * Disable timeout here, since asynchronous event requests should by
72294143332SJim Harris 	 *  nature never be timed out.
7230a0b08ccSJim Harris 	 */
72494143332SJim Harris 	req->timeout = FALSE;
725*0d787e9bSWojciech Macek 	req->cmd.opc_fuse = NVME_CMD_SET_OPC(NVME_OPC_ASYNC_EVENT_REQUEST);
7260a0b08ccSJim Harris 	nvme_ctrlr_submit_admin_request(ctrlr, req);
7270a0b08ccSJim Harris }
7280a0b08ccSJim Harris 
7290a0b08ccSJim Harris static void
730bb0ec6b3SJim Harris nvme_ctrlr_configure_aer(struct nvme_controller *ctrlr)
731bb0ec6b3SJim Harris {
732d5fc9821SJim Harris 	struct nvme_completion_poll_status	status;
7330a0b08ccSJim Harris 	struct nvme_async_event_request		*aer;
7340a0b08ccSJim Harris 	uint32_t				i;
735bb0ec6b3SJim Harris 
736*0d787e9bSWojciech Macek 	ctrlr->async_event_config = 0xFF;
737*0d787e9bSWojciech Macek 	ctrlr->async_event_config &= ~NVME_CRIT_WARN_ST_RESERVED_MASK;
738d5fc9821SJim Harris 
73929077eb4SWarner Losh 	status.done = 0;
740d5fc9821SJim Harris 	nvme_ctrlr_cmd_get_feature(ctrlr, NVME_FEAT_TEMPERATURE_THRESHOLD,
741d5fc9821SJim Harris 	    0, NULL, 0, nvme_completion_poll_cb, &status);
74229077eb4SWarner Losh 	while (!atomic_load_acq_int(&status.done))
743d5fc9821SJim Harris 		pause("nvme", 1);
744d5fc9821SJim Harris 	if (nvme_completion_is_error(&status.cpl) ||
745d5fc9821SJim Harris 	    (status.cpl.cdw0 & 0xFFFF) == 0xFFFF ||
746d5fc9821SJim Harris 	    (status.cpl.cdw0 & 0xFFFF) == 0x0000) {
747d5fc9821SJim Harris 		nvme_printf(ctrlr, "temperature threshold not supported\n");
748*0d787e9bSWojciech Macek 		ctrlr->async_event_config &= ~NVME_CRIT_WARN_ST_TEMPERATURE;
749d5fc9821SJim Harris 	}
750d5fc9821SJim Harris 
751bb2f67fdSJim Harris 	nvme_ctrlr_cmd_set_async_event_config(ctrlr,
752bb2f67fdSJim Harris 	    ctrlr->async_event_config, NULL, NULL);
753bb0ec6b3SJim Harris 
754bb0ec6b3SJim Harris 	/* aerl is a zero-based value, so we need to add 1 here. */
7550a0b08ccSJim Harris 	ctrlr->num_aers = min(NVME_MAX_ASYNC_EVENTS, (ctrlr->cdata.aerl+1));
756bb0ec6b3SJim Harris 
7570a0b08ccSJim Harris 	for (i = 0; i < ctrlr->num_aers; i++) {
7580a0b08ccSJim Harris 		aer = &ctrlr->aer[i];
7590a0b08ccSJim Harris 		nvme_ctrlr_construct_and_submit_aer(ctrlr, aer);
7600a0b08ccSJim Harris 	}
761bb0ec6b3SJim Harris }
762bb0ec6b3SJim Harris 
763bb0ec6b3SJim Harris static void
764bb0ec6b3SJim Harris nvme_ctrlr_configure_int_coalescing(struct nvme_controller *ctrlr)
765bb0ec6b3SJim Harris {
766bb0ec6b3SJim Harris 
767bb0ec6b3SJim Harris 	ctrlr->int_coal_time = 0;
768bb0ec6b3SJim Harris 	TUNABLE_INT_FETCH("hw.nvme.int_coal_time",
769bb0ec6b3SJim Harris 	    &ctrlr->int_coal_time);
770bb0ec6b3SJim Harris 
771bb0ec6b3SJim Harris 	ctrlr->int_coal_threshold = 0;
772bb0ec6b3SJim Harris 	TUNABLE_INT_FETCH("hw.nvme.int_coal_threshold",
773bb0ec6b3SJim Harris 	    &ctrlr->int_coal_threshold);
774bb0ec6b3SJim Harris 
775bb0ec6b3SJim Harris 	nvme_ctrlr_cmd_set_interrupt_coalescing(ctrlr, ctrlr->int_coal_time,
776bb0ec6b3SJim Harris 	    ctrlr->int_coal_threshold, NULL, NULL);
777bb0ec6b3SJim Harris }
778bb0ec6b3SJim Harris 
779be34f216SJim Harris static void
780bb0ec6b3SJim Harris nvme_ctrlr_start(void *ctrlr_arg)
781bb0ec6b3SJim Harris {
782bb0ec6b3SJim Harris 	struct nvme_controller *ctrlr = ctrlr_arg;
7832b647da7SJim Harris 	uint32_t old_num_io_queues;
784b846efd7SJim Harris 	int i;
785b846efd7SJim Harris 
7862b647da7SJim Harris 	/*
7872b647da7SJim Harris 	 * Only reset adminq here when we are restarting the
7882b647da7SJim Harris 	 *  controller after a reset.  During initialization,
7892b647da7SJim Harris 	 *  we have already submitted admin commands to get
7902b647da7SJim Harris 	 *  the number of I/O queues supported, so cannot reset
7912b647da7SJim Harris 	 *  the adminq again here.
7922b647da7SJim Harris 	 */
7932b647da7SJim Harris 	if (ctrlr->is_resetting) {
794cb5b7c13SJim Harris 		nvme_qpair_reset(&ctrlr->adminq);
7952b647da7SJim Harris 	}
7962b647da7SJim Harris 
797cb5b7c13SJim Harris 	for (i = 0; i < ctrlr->num_io_queues; i++)
798cb5b7c13SJim Harris 		nvme_qpair_reset(&ctrlr->ioq[i]);
799cb5b7c13SJim Harris 
800b846efd7SJim Harris 	nvme_admin_qpair_enable(&ctrlr->adminq);
801bb0ec6b3SJim Harris 
802232e2edbSJim Harris 	if (nvme_ctrlr_identify(ctrlr) != 0) {
803232e2edbSJim Harris 		nvme_ctrlr_fail(ctrlr);
804be34f216SJim Harris 		return;
805232e2edbSJim Harris 	}
806bb0ec6b3SJim Harris 
8072b647da7SJim Harris 	/*
8082b647da7SJim Harris 	 * The number of qpairs are determined during controller initialization,
8092b647da7SJim Harris 	 *  including using NVMe SET_FEATURES/NUMBER_OF_QUEUES to determine the
8102b647da7SJim Harris 	 *  HW limit.  We call SET_FEATURES again here so that it gets called
8112b647da7SJim Harris 	 *  after any reset for controllers that depend on the driver to
8122b647da7SJim Harris 	 *  explicit specify how many queues it will use.  This value should
8132b647da7SJim Harris 	 *  never change between resets, so panic if somehow that does happen.
8142b647da7SJim Harris 	 */
8157b036d77SJim Harris 	if (ctrlr->is_resetting) {
8162b647da7SJim Harris 		old_num_io_queues = ctrlr->num_io_queues;
817232e2edbSJim Harris 		if (nvme_ctrlr_set_num_qpairs(ctrlr) != 0) {
818232e2edbSJim Harris 			nvme_ctrlr_fail(ctrlr);
819be34f216SJim Harris 			return;
820232e2edbSJim Harris 		}
821bb0ec6b3SJim Harris 
8222b647da7SJim Harris 		if (old_num_io_queues != ctrlr->num_io_queues) {
8237b036d77SJim Harris 			panic("num_io_queues changed from %u to %u",
8247b036d77SJim Harris 			      old_num_io_queues, ctrlr->num_io_queues);
8257b036d77SJim Harris 		}
8262b647da7SJim Harris 	}
8272b647da7SJim Harris 
828232e2edbSJim Harris 	if (nvme_ctrlr_create_qpairs(ctrlr) != 0) {
829232e2edbSJim Harris 		nvme_ctrlr_fail(ctrlr);
830be34f216SJim Harris 		return;
831232e2edbSJim Harris 	}
832bb0ec6b3SJim Harris 
833232e2edbSJim Harris 	if (nvme_ctrlr_construct_namespaces(ctrlr) != 0) {
834232e2edbSJim Harris 		nvme_ctrlr_fail(ctrlr);
835be34f216SJim Harris 		return;
836232e2edbSJim Harris 	}
837bb0ec6b3SJim Harris 
838bb0ec6b3SJim Harris 	nvme_ctrlr_configure_aer(ctrlr);
839bb0ec6b3SJim Harris 	nvme_ctrlr_configure_int_coalescing(ctrlr);
840bb0ec6b3SJim Harris 
841b846efd7SJim Harris 	for (i = 0; i < ctrlr->num_io_queues; i++)
842b846efd7SJim Harris 		nvme_io_qpair_enable(&ctrlr->ioq[i]);
843bb0ec6b3SJim Harris }
844bb0ec6b3SJim Harris 
845be34f216SJim Harris void
846be34f216SJim Harris nvme_ctrlr_start_config_hook(void *arg)
847be34f216SJim Harris {
848be34f216SJim Harris 	struct nvme_controller *ctrlr = arg;
849be34f216SJim Harris 
8502b647da7SJim Harris 	nvme_qpair_reset(&ctrlr->adminq);
8512b647da7SJim Harris 	nvme_admin_qpair_enable(&ctrlr->adminq);
8522b647da7SJim Harris 
8532b647da7SJim Harris 	if (nvme_ctrlr_set_num_qpairs(ctrlr) == 0 &&
8542b647da7SJim Harris 	    nvme_ctrlr_construct_io_qpairs(ctrlr) == 0)
855be34f216SJim Harris 		nvme_ctrlr_start(ctrlr);
8562b647da7SJim Harris 	else
8572b647da7SJim Harris 		nvme_ctrlr_fail(ctrlr);
8582b647da7SJim Harris 
8592b647da7SJim Harris 	nvme_sysctl_initialize_ctrlr(ctrlr);
860be34f216SJim Harris 	config_intrhook_disestablish(&ctrlr->config_hook);
861496a2752SJim Harris 
862496a2752SJim Harris 	ctrlr->is_initialized = 1;
863496a2752SJim Harris 	nvme_notify_new_controller(ctrlr);
864b846efd7SJim Harris }
865b846efd7SJim Harris 
866bb0ec6b3SJim Harris static void
86748ce3178SJim Harris nvme_ctrlr_reset_task(void *arg, int pending)
86812d191ecSJim Harris {
86912d191ecSJim Harris 	struct nvme_controller	*ctrlr = arg;
87048ce3178SJim Harris 	int			status;
87112d191ecSJim Harris 
872547d523eSJim Harris 	nvme_printf(ctrlr, "resetting controller\n");
87348ce3178SJim Harris 	status = nvme_ctrlr_hw_reset(ctrlr);
87448ce3178SJim Harris 	/*
87548ce3178SJim Harris 	 * Use pause instead of DELAY, so that we yield to any nvme interrupt
87648ce3178SJim Harris 	 *  handlers on this CPU that were blocked on a qpair lock. We want
87748ce3178SJim Harris 	 *  all nvme interrupts completed before proceeding with restarting the
87848ce3178SJim Harris 	 *  controller.
87948ce3178SJim Harris 	 *
88048ce3178SJim Harris 	 * XXX - any way to guarantee the interrupt handlers have quiesced?
88148ce3178SJim Harris 	 */
88248ce3178SJim Harris 	pause("nvmereset", hz / 10);
88348ce3178SJim Harris 	if (status == 0)
88412d191ecSJim Harris 		nvme_ctrlr_start(ctrlr);
885232e2edbSJim Harris 	else
886232e2edbSJim Harris 		nvme_ctrlr_fail(ctrlr);
887f37c22a3SJim Harris 
888f37c22a3SJim Harris 	atomic_cmpset_32(&ctrlr->is_resetting, 1, 0);
88912d191ecSJim Harris }
89012d191ecSJim Harris 
891bb1c7be4SWarner Losh /*
892bb1c7be4SWarner Losh  * Poll all the queues enabled on the device for completion.
893bb1c7be4SWarner Losh  */
894bb1c7be4SWarner Losh void
895bb1c7be4SWarner Losh nvme_ctrlr_poll(struct nvme_controller *ctrlr)
896bb1c7be4SWarner Losh {
897bb1c7be4SWarner Losh 	int i;
898bb1c7be4SWarner Losh 
899bb1c7be4SWarner Losh 	nvme_qpair_process_completions(&ctrlr->adminq);
900bb1c7be4SWarner Losh 
901bb1c7be4SWarner Losh 	for (i = 0; i < ctrlr->num_io_queues; i++)
902bb1c7be4SWarner Losh 		if (ctrlr->ioq && ctrlr->ioq[i].cpl)
903bb1c7be4SWarner Losh 			nvme_qpair_process_completions(&ctrlr->ioq[i]);
904bb1c7be4SWarner Losh }
905bb1c7be4SWarner Losh 
906bb1c7be4SWarner Losh /*
907bb1c7be4SWarner Losh  * Poll the single-vector intertrupt case: num_io_queues will be 1 and
908bb1c7be4SWarner Losh  * there's only a single vector. While we're polling, we mask further
909bb1c7be4SWarner Losh  * interrupts in the controller.
910bb1c7be4SWarner Losh  */
911f24c011bSWarner Losh void
9124d6abcb1SJim Harris nvme_ctrlr_intx_handler(void *arg)
913bb0ec6b3SJim Harris {
914bb0ec6b3SJim Harris 	struct nvme_controller *ctrlr = arg;
915bb0ec6b3SJim Harris 
9164d6abcb1SJim Harris 	nvme_mmio_write_4(ctrlr, intms, 1);
917bb1c7be4SWarner Losh 	nvme_ctrlr_poll(ctrlr);
918bb0ec6b3SJim Harris 	nvme_mmio_write_4(ctrlr, intmc, 1);
919bb0ec6b3SJim Harris }
920bb0ec6b3SJim Harris 
921bb0ec6b3SJim Harris static int
922bb0ec6b3SJim Harris nvme_ctrlr_configure_intx(struct nvme_controller *ctrlr)
923bb0ec6b3SJim Harris {
924bb0ec6b3SJim Harris 
925d400f790SJim Harris 	ctrlr->msix_enabled = 0;
926bb0ec6b3SJim Harris 	ctrlr->num_io_queues = 1;
9272b647da7SJim Harris 	ctrlr->num_cpus_per_ioq = mp_ncpus;
928bb0ec6b3SJim Harris 	ctrlr->rid = 0;
929bb0ec6b3SJim Harris 	ctrlr->res = bus_alloc_resource_any(ctrlr->dev, SYS_RES_IRQ,
930bb0ec6b3SJim Harris 	    &ctrlr->rid, RF_SHAREABLE | RF_ACTIVE);
931bb0ec6b3SJim Harris 
932bb0ec6b3SJim Harris 	if (ctrlr->res == NULL) {
933547d523eSJim Harris 		nvme_printf(ctrlr, "unable to allocate shared IRQ\n");
934bb0ec6b3SJim Harris 		return (ENOMEM);
935bb0ec6b3SJim Harris 	}
936bb0ec6b3SJim Harris 
937bb0ec6b3SJim Harris 	bus_setup_intr(ctrlr->dev, ctrlr->res,
938bb0ec6b3SJim Harris 	    INTR_TYPE_MISC | INTR_MPSAFE, NULL, nvme_ctrlr_intx_handler,
939bb0ec6b3SJim Harris 	    ctrlr, &ctrlr->tag);
940bb0ec6b3SJim Harris 
941bb0ec6b3SJim Harris 	if (ctrlr->tag == NULL) {
942547d523eSJim Harris 		nvme_printf(ctrlr, "unable to setup intx handler\n");
943bb0ec6b3SJim Harris 		return (ENOMEM);
944bb0ec6b3SJim Harris 	}
945bb0ec6b3SJim Harris 
946bb0ec6b3SJim Harris 	return (0);
947bb0ec6b3SJim Harris }
948bb0ec6b3SJim Harris 
9497c3f19d7SJim Harris static void
9507c3f19d7SJim Harris nvme_pt_done(void *arg, const struct nvme_completion *cpl)
9517c3f19d7SJim Harris {
9527c3f19d7SJim Harris 	struct nvme_pt_command *pt = arg;
953*0d787e9bSWojciech Macek 	uint16_t status;
9547c3f19d7SJim Harris 
9557c3f19d7SJim Harris 	bzero(&pt->cpl, sizeof(pt->cpl));
9567c3f19d7SJim Harris 	pt->cpl.cdw0 = cpl->cdw0;
957*0d787e9bSWojciech Macek 
958*0d787e9bSWojciech Macek 	status = cpl->status;
959*0d787e9bSWojciech Macek 	status &= ~NVME_STATUS_P_MASK;
960*0d787e9bSWojciech Macek 	pt->cpl.status = status;
9617c3f19d7SJim Harris 
9627c3f19d7SJim Harris 	mtx_lock(pt->driver_lock);
9637c3f19d7SJim Harris 	wakeup(pt);
9647c3f19d7SJim Harris 	mtx_unlock(pt->driver_lock);
9657c3f19d7SJim Harris }
9667c3f19d7SJim Harris 
9677c3f19d7SJim Harris int
9687c3f19d7SJim Harris nvme_ctrlr_passthrough_cmd(struct nvme_controller *ctrlr,
9697c3f19d7SJim Harris     struct nvme_pt_command *pt, uint32_t nsid, int is_user_buffer,
9707c3f19d7SJim Harris     int is_admin_cmd)
9717c3f19d7SJim Harris {
9727c3f19d7SJim Harris 	struct nvme_request	*req;
9737c3f19d7SJim Harris 	struct mtx		*mtx;
9747c3f19d7SJim Harris 	struct buf		*buf = NULL;
9757c3f19d7SJim Harris 	int			ret = 0;
976a3a6c48dSWarner Losh 	vm_offset_t		addr, end;
9777c3f19d7SJim Harris 
9787b68ae1eSJim Harris 	if (pt->len > 0) {
979a3a6c48dSWarner Losh 		/*
980a3a6c48dSWarner Losh 		 * vmapbuf calls vm_fault_quick_hold_pages which only maps full
981a3a6c48dSWarner Losh 		 * pages. Ensure this request has fewer than MAXPHYS bytes when
982a3a6c48dSWarner Losh 		 * extended to full pages.
983a3a6c48dSWarner Losh 		 */
984a3a6c48dSWarner Losh 		addr = (vm_offset_t)pt->buf;
985a3a6c48dSWarner Losh 		end = round_page(addr + pt->len);
986a3a6c48dSWarner Losh 		addr = trunc_page(addr);
987a3a6c48dSWarner Losh 		if (end - addr > MAXPHYS)
988a3a6c48dSWarner Losh 			return EIO;
989a3a6c48dSWarner Losh 
9907b68ae1eSJim Harris 		if (pt->len > ctrlr->max_xfer_size) {
9917b68ae1eSJim Harris 			nvme_printf(ctrlr, "pt->len (%d) "
9927b68ae1eSJim Harris 			    "exceeds max_xfer_size (%d)\n", pt->len,
9937b68ae1eSJim Harris 			    ctrlr->max_xfer_size);
9947b68ae1eSJim Harris 			return EIO;
9957b68ae1eSJim Harris 		}
9967c3f19d7SJim Harris 		if (is_user_buffer) {
9977c3f19d7SJim Harris 			/*
9987c3f19d7SJim Harris 			 * Ensure the user buffer is wired for the duration of
9997c3f19d7SJim Harris 			 *  this passthrough command.
10007c3f19d7SJim Harris 			 */
10017c3f19d7SJim Harris 			PHOLD(curproc);
10027c3f19d7SJim Harris 			buf = getpbuf(NULL);
10037c3f19d7SJim Harris 			buf->b_data = pt->buf;
10047c3f19d7SJim Harris 			buf->b_bufsize = pt->len;
10057c3f19d7SJim Harris 			buf->b_iocmd = pt->is_read ? BIO_READ : BIO_WRITE;
10067c3f19d7SJim Harris #ifdef NVME_UNMAPPED_BIO_SUPPORT
10077c3f19d7SJim Harris 			if (vmapbuf(buf, 1) < 0) {
10087c3f19d7SJim Harris #else
10097c3f19d7SJim Harris 			if (vmapbuf(buf) < 0) {
10107c3f19d7SJim Harris #endif
10117c3f19d7SJim Harris 				ret = EFAULT;
10127c3f19d7SJim Harris 				goto err;
10137c3f19d7SJim Harris 			}
10147c3f19d7SJim Harris 			req = nvme_allocate_request_vaddr(buf->b_data, pt->len,
10157c3f19d7SJim Harris 			    nvme_pt_done, pt);
10167c3f19d7SJim Harris 		} else
10177c3f19d7SJim Harris 			req = nvme_allocate_request_vaddr(pt->buf, pt->len,
10187c3f19d7SJim Harris 			    nvme_pt_done, pt);
10197b68ae1eSJim Harris 	} else
10207c3f19d7SJim Harris 		req = nvme_allocate_request_null(nvme_pt_done, pt);
10217c3f19d7SJim Harris 
1022*0d787e9bSWojciech Macek 	/* Assume userspace already converted to little-endian */
1023*0d787e9bSWojciech Macek 	req->cmd.opc_fuse = pt->cmd.opc_fuse;
10247c3f19d7SJim Harris 	req->cmd.cdw10 = pt->cmd.cdw10;
10257c3f19d7SJim Harris 	req->cmd.cdw11 = pt->cmd.cdw11;
10267c3f19d7SJim Harris 	req->cmd.cdw12 = pt->cmd.cdw12;
10277c3f19d7SJim Harris 	req->cmd.cdw13 = pt->cmd.cdw13;
10287c3f19d7SJim Harris 	req->cmd.cdw14 = pt->cmd.cdw14;
10297c3f19d7SJim Harris 	req->cmd.cdw15 = pt->cmd.cdw15;
10307c3f19d7SJim Harris 
1031*0d787e9bSWojciech Macek 	req->cmd.nsid = htole32(nsid);
10327c3f19d7SJim Harris 
10337c3f19d7SJim Harris 	if (is_admin_cmd)
10347c3f19d7SJim Harris 		mtx = &ctrlr->lock;
1035*0d787e9bSWojciech Macek 	else {
1036*0d787e9bSWojciech Macek 		KASSERT((nsid-1) >= 0 && (nsid-1) < NVME_MAX_NAMESPACES,
1037*0d787e9bSWojciech Macek 		    ("%s: invalid namespace ID %d\n", __func__, nsid));
10387c3f19d7SJim Harris 		mtx = &ctrlr->ns[nsid-1].lock;
1039*0d787e9bSWojciech Macek 	}
10407c3f19d7SJim Harris 
10417c3f19d7SJim Harris 	mtx_lock(mtx);
10427c3f19d7SJim Harris 	pt->driver_lock = mtx;
10437c3f19d7SJim Harris 
10447c3f19d7SJim Harris 	if (is_admin_cmd)
10457c3f19d7SJim Harris 		nvme_ctrlr_submit_admin_request(ctrlr, req);
10467c3f19d7SJim Harris 	else
10477c3f19d7SJim Harris 		nvme_ctrlr_submit_io_request(ctrlr, req);
10487c3f19d7SJim Harris 
10497c3f19d7SJim Harris 	mtx_sleep(pt, mtx, PRIBIO, "nvme_pt", 0);
10507c3f19d7SJim Harris 	mtx_unlock(mtx);
10517c3f19d7SJim Harris 
10527c3f19d7SJim Harris 	pt->driver_lock = NULL;
10537c3f19d7SJim Harris 
10547c3f19d7SJim Harris err:
10557c3f19d7SJim Harris 	if (buf != NULL) {
10567c3f19d7SJim Harris 		relpbuf(buf, NULL);
10577c3f19d7SJim Harris 		PRELE(curproc);
10587c3f19d7SJim Harris 	}
10597c3f19d7SJim Harris 
10607c3f19d7SJim Harris 	return (ret);
10617c3f19d7SJim Harris }
10627c3f19d7SJim Harris 
1063bb0ec6b3SJim Harris static int
1064bb0ec6b3SJim Harris nvme_ctrlr_ioctl(struct cdev *cdev, u_long cmd, caddr_t arg, int flag,
1065bb0ec6b3SJim Harris     struct thread *td)
1066bb0ec6b3SJim Harris {
1067bb0ec6b3SJim Harris 	struct nvme_controller			*ctrlr;
10687c3f19d7SJim Harris 	struct nvme_pt_command			*pt;
1069bb0ec6b3SJim Harris 
1070bb0ec6b3SJim Harris 	ctrlr = cdev->si_drv1;
1071bb0ec6b3SJim Harris 
1072bb0ec6b3SJim Harris 	switch (cmd) {
1073b846efd7SJim Harris 	case NVME_RESET_CONTROLLER:
1074b846efd7SJim Harris 		nvme_ctrlr_reset(ctrlr);
1075b846efd7SJim Harris 		break;
10767c3f19d7SJim Harris 	case NVME_PASSTHROUGH_CMD:
10777c3f19d7SJim Harris 		pt = (struct nvme_pt_command *)arg;
1078*0d787e9bSWojciech Macek 		return (nvme_ctrlr_passthrough_cmd(ctrlr, pt, le32toh(pt->cmd.nsid),
10797c3f19d7SJim Harris 		    1 /* is_user_buffer */, 1 /* is_admin_cmd */));
1080bb0ec6b3SJim Harris 	default:
1081bb0ec6b3SJim Harris 		return (ENOTTY);
1082bb0ec6b3SJim Harris 	}
1083bb0ec6b3SJim Harris 
1084bb0ec6b3SJim Harris 	return (0);
1085bb0ec6b3SJim Harris }
1086bb0ec6b3SJim Harris 
1087bb0ec6b3SJim Harris static struct cdevsw nvme_ctrlr_cdevsw = {
1088bb0ec6b3SJim Harris 	.d_version =	D_VERSION,
1089bb0ec6b3SJim Harris 	.d_flags =	0,
1090bb0ec6b3SJim Harris 	.d_ioctl =	nvme_ctrlr_ioctl
1091bb0ec6b3SJim Harris };
1092bb0ec6b3SJim Harris 
1093d400f790SJim Harris static void
1094d400f790SJim Harris nvme_ctrlr_setup_interrupts(struct nvme_controller *ctrlr)
1095d400f790SJim Harris {
1096d400f790SJim Harris 	device_t	dev;
1097d400f790SJim Harris 	int		per_cpu_io_queues;
109850dea2daSJim Harris 	int		min_cpus_per_ioq;
1099d400f790SJim Harris 	int		num_vectors_requested, num_vectors_allocated;
11002b647da7SJim Harris 	int		num_vectors_available;
1101d400f790SJim Harris 
1102d400f790SJim Harris 	dev = ctrlr->dev;
110350dea2daSJim Harris 	min_cpus_per_ioq = 1;
110450dea2daSJim Harris 	TUNABLE_INT_FETCH("hw.nvme.min_cpus_per_ioq", &min_cpus_per_ioq);
110550dea2daSJim Harris 
110650dea2daSJim Harris 	if (min_cpus_per_ioq < 1) {
110750dea2daSJim Harris 		min_cpus_per_ioq = 1;
110850dea2daSJim Harris 	} else if (min_cpus_per_ioq > mp_ncpus) {
110950dea2daSJim Harris 		min_cpus_per_ioq = mp_ncpus;
111050dea2daSJim Harris 	}
111150dea2daSJim Harris 
1112d400f790SJim Harris 	per_cpu_io_queues = 1;
1113d400f790SJim Harris 	TUNABLE_INT_FETCH("hw.nvme.per_cpu_io_queues", &per_cpu_io_queues);
1114d400f790SJim Harris 
111550dea2daSJim Harris 	if (per_cpu_io_queues == 0) {
111650dea2daSJim Harris 		min_cpus_per_ioq = mp_ncpus;
111750dea2daSJim Harris 	}
111850dea2daSJim Harris 
1119d400f790SJim Harris 	ctrlr->force_intx = 0;
1120d400f790SJim Harris 	TUNABLE_INT_FETCH("hw.nvme.force_intx", &ctrlr->force_intx);
1121d400f790SJim Harris 
11222b647da7SJim Harris 	/*
11232b647da7SJim Harris 	 * FreeBSD currently cannot allocate more than about 190 vectors at
11242b647da7SJim Harris 	 *  boot, meaning that systems with high core count and many devices
11252b647da7SJim Harris 	 *  requesting per-CPU interrupt vectors will not get their full
11262b647da7SJim Harris 	 *  allotment.  So first, try to allocate as many as we may need to
11272b647da7SJim Harris 	 *  understand what is available, then immediately release them.
11282b647da7SJim Harris 	 *  Then figure out how many of those we will actually use, based on
11292b647da7SJim Harris 	 *  assigning an equal number of cores to each I/O queue.
11302b647da7SJim Harris 	 */
11312b647da7SJim Harris 
11322b647da7SJim Harris 	/* One vector for per core I/O queue, plus one vector for admin queue. */
11332b647da7SJim Harris 	num_vectors_available = min(pci_msix_count(dev), mp_ncpus + 1);
11342b647da7SJim Harris 	if (pci_alloc_msix(dev, &num_vectors_available) != 0) {
11352b647da7SJim Harris 		num_vectors_available = 0;
11362b647da7SJim Harris 	}
11372b647da7SJim Harris 	pci_release_msi(dev);
11382b647da7SJim Harris 
11392b647da7SJim Harris 	if (ctrlr->force_intx || num_vectors_available < 2) {
1140d400f790SJim Harris 		nvme_ctrlr_configure_intx(ctrlr);
1141d400f790SJim Harris 		return;
1142d400f790SJim Harris 	}
1143d400f790SJim Harris 
114450dea2daSJim Harris 	/*
114550dea2daSJim Harris 	 * Do not use all vectors for I/O queues - one must be saved for the
114650dea2daSJim Harris 	 *  admin queue.
114750dea2daSJim Harris 	 */
114850dea2daSJim Harris 	ctrlr->num_cpus_per_ioq = max(min_cpus_per_ioq,
11499c6b5d40SJim Harris 	    howmany(mp_ncpus, num_vectors_available - 1));
1150d400f790SJim Harris 
11519c6b5d40SJim Harris 	ctrlr->num_io_queues = howmany(mp_ncpus, ctrlr->num_cpus_per_ioq);
1152d400f790SJim Harris 	num_vectors_requested = ctrlr->num_io_queues + 1;
1153d400f790SJim Harris 	num_vectors_allocated = num_vectors_requested;
11542b647da7SJim Harris 
11552b647da7SJim Harris 	/*
11562b647da7SJim Harris 	 * Now just allocate the number of vectors we need.  This should
11572b647da7SJim Harris 	 *  succeed, since we previously called pci_alloc_msix()
11582b647da7SJim Harris 	 *  successfully returning at least this many vectors, but just to
11592b647da7SJim Harris 	 *  be safe, if something goes wrong just revert to INTx.
11602b647da7SJim Harris 	 */
1161d400f790SJim Harris 	if (pci_alloc_msix(dev, &num_vectors_allocated) != 0) {
1162d400f790SJim Harris 		nvme_ctrlr_configure_intx(ctrlr);
1163d400f790SJim Harris 		return;
1164d400f790SJim Harris 	}
1165d400f790SJim Harris 
1166d400f790SJim Harris 	if (num_vectors_allocated < num_vectors_requested) {
1167d400f790SJim Harris 		pci_release_msi(dev);
1168d400f790SJim Harris 		nvme_ctrlr_configure_intx(ctrlr);
1169d400f790SJim Harris 		return;
1170d400f790SJim Harris 	}
1171d400f790SJim Harris 
11722b647da7SJim Harris 	ctrlr->msix_enabled = 1;
1173d400f790SJim Harris }
1174d400f790SJim Harris 
1175bb0ec6b3SJim Harris int
1176bb0ec6b3SJim Harris nvme_ctrlr_construct(struct nvme_controller *ctrlr, device_t dev)
1177bb0ec6b3SJim Harris {
1178*0d787e9bSWojciech Macek 	uint32_t	cap_lo;
1179*0d787e9bSWojciech Macek 	uint32_t	cap_hi;
1180*0d787e9bSWojciech Macek 	uint8_t		to;
1181*0d787e9bSWojciech Macek 	uint8_t		dstrd;
1182*0d787e9bSWojciech Macek 	uint8_t		mpsmin;
1183f42ca756SJim Harris 	int		status, timeout_period;
1184bb0ec6b3SJim Harris 
1185bb0ec6b3SJim Harris 	ctrlr->dev = dev;
1186bb0ec6b3SJim Harris 
1187a90b8104SJim Harris 	mtx_init(&ctrlr->lock, "nvme ctrlr lock", NULL, MTX_DEF);
1188a90b8104SJim Harris 
1189bb0ec6b3SJim Harris 	status = nvme_ctrlr_allocate_bar(ctrlr);
1190bb0ec6b3SJim Harris 
1191bb0ec6b3SJim Harris 	if (status != 0)
1192bb0ec6b3SJim Harris 		return (status);
1193bb0ec6b3SJim Harris 
1194bb0ec6b3SJim Harris 	/*
1195bb0ec6b3SJim Harris 	 * Software emulators may set the doorbell stride to something
1196bb0ec6b3SJim Harris 	 *  other than zero, but this driver is not set up to handle that.
1197bb0ec6b3SJim Harris 	 */
1198*0d787e9bSWojciech Macek 	cap_hi = nvme_mmio_read_4(ctrlr, cap_hi);
1199*0d787e9bSWojciech Macek 	dstrd = (cap_hi >> NVME_CAP_HI_REG_DSTRD_SHIFT) & NVME_CAP_HI_REG_DSTRD_MASK;
1200*0d787e9bSWojciech Macek 	if (dstrd != 0)
1201bb0ec6b3SJim Harris 		return (ENXIO);
1202bb0ec6b3SJim Harris 
1203*0d787e9bSWojciech Macek 	mpsmin = (cap_hi >> NVME_CAP_HI_REG_MPSMIN_SHIFT) & NVME_CAP_HI_REG_MPSMIN_MASK;
1204*0d787e9bSWojciech Macek 	ctrlr->min_page_size = 1 << (12 + mpsmin);
120502e33484SJim Harris 
1206bb0ec6b3SJim Harris 	/* Get ready timeout value from controller, in units of 500ms. */
1207*0d787e9bSWojciech Macek 	cap_lo = nvme_mmio_read_4(ctrlr, cap_lo);
1208*0d787e9bSWojciech Macek 	to = (cap_lo >> NVME_CAP_LO_REG_TO_SHIFT) & NVME_CAP_LO_REG_TO_MASK;
1209*0d787e9bSWojciech Macek 	ctrlr->ready_timeout_in_ms = to * 500;
1210bb0ec6b3SJim Harris 
121194143332SJim Harris 	timeout_period = NVME_DEFAULT_TIMEOUT_PERIOD;
121294143332SJim Harris 	TUNABLE_INT_FETCH("hw.nvme.timeout_period", &timeout_period);
121394143332SJim Harris 	timeout_period = min(timeout_period, NVME_MAX_TIMEOUT_PERIOD);
121494143332SJim Harris 	timeout_period = max(timeout_period, NVME_MIN_TIMEOUT_PERIOD);
121594143332SJim Harris 	ctrlr->timeout_period = timeout_period;
121694143332SJim Harris 
1217cb5b7c13SJim Harris 	nvme_retry_count = NVME_DEFAULT_RETRY_COUNT;
1218cb5b7c13SJim Harris 	TUNABLE_INT_FETCH("hw.nvme.retry_count", &nvme_retry_count);
1219cb5b7c13SJim Harris 
122048ce3178SJim Harris 	ctrlr->enable_aborts = 0;
122148ce3178SJim Harris 	TUNABLE_INT_FETCH("hw.nvme.enable_aborts", &ctrlr->enable_aborts);
122248ce3178SJim Harris 
1223d400f790SJim Harris 	nvme_ctrlr_setup_interrupts(ctrlr);
1224bb0ec6b3SJim Harris 
12258d09e3c4SJim Harris 	ctrlr->max_xfer_size = NVME_MAX_XFER_SIZE;
1226a965389bSScott Long 	if (nvme_ctrlr_construct_admin_qpair(ctrlr) != 0)
1227a965389bSScott Long 		return (ENXIO);
1228bb0ec6b3SJim Harris 
1229d603c3d7SJim Harris 	ctrlr->cdev = make_dev(&nvme_ctrlr_cdevsw, device_get_unit(dev),
1230d603c3d7SJim Harris 	    UID_ROOT, GID_WHEEL, 0600, "nvme%d", device_get_unit(dev));
1231bb0ec6b3SJim Harris 
1232bb0ec6b3SJim Harris 	if (ctrlr->cdev == NULL)
1233bb0ec6b3SJim Harris 		return (ENXIO);
1234bb0ec6b3SJim Harris 
1235bb0ec6b3SJim Harris 	ctrlr->cdev->si_drv1 = (void *)ctrlr;
1236bb0ec6b3SJim Harris 
123712d191ecSJim Harris 	ctrlr->taskqueue = taskqueue_create("nvme_taskq", M_WAITOK,
123812d191ecSJim Harris 	    taskqueue_thread_enqueue, &ctrlr->taskqueue);
123912d191ecSJim Harris 	taskqueue_start_threads(&ctrlr->taskqueue, 1, PI_DISK, "nvme taskq");
124012d191ecSJim Harris 
1241f37c22a3SJim Harris 	ctrlr->is_resetting = 0;
1242496a2752SJim Harris 	ctrlr->is_initialized = 0;
1243496a2752SJim Harris 	ctrlr->notification_sent = 0;
1244232e2edbSJim Harris 	TASK_INIT(&ctrlr->reset_task, 0, nvme_ctrlr_reset_task, ctrlr);
1245232e2edbSJim Harris 
1246232e2edbSJim Harris 	TASK_INIT(&ctrlr->fail_req_task, 0, nvme_ctrlr_fail_req_task, ctrlr);
1247232e2edbSJim Harris 	STAILQ_INIT(&ctrlr->fail_req);
1248232e2edbSJim Harris 	ctrlr->is_failed = FALSE;
1249f37c22a3SJim Harris 
1250bb0ec6b3SJim Harris 	return (0);
1251bb0ec6b3SJim Harris }
1252d281e8fbSJim Harris 
1253d281e8fbSJim Harris void
1254990e741cSJim Harris nvme_ctrlr_destruct(struct nvme_controller *ctrlr, device_t dev)
1255990e741cSJim Harris {
1256990e741cSJim Harris 	int				i;
1257990e741cSJim Harris 
125856183abcSJim Harris 	/*
125956183abcSJim Harris 	 *  Notify the controller of a shutdown, even though this is due to
126056183abcSJim Harris 	 *   a driver unload, not a system shutdown (this path is not invoked
126156183abcSJim Harris 	 *   during shutdown).  This ensures the controller receives a
126256183abcSJim Harris 	 *   shutdown notification in case the system is shutdown before
126356183abcSJim Harris 	 *   reloading the driver.
126456183abcSJim Harris 	 */
126556183abcSJim Harris 	nvme_ctrlr_shutdown(ctrlr);
126656183abcSJim Harris 
12673d7eb41cSJim Harris 	nvme_ctrlr_disable(ctrlr);
126812d191ecSJim Harris 	taskqueue_free(ctrlr->taskqueue);
126912d191ecSJim Harris 
1270b846efd7SJim Harris 	for (i = 0; i < NVME_MAX_NAMESPACES; i++)
1271b846efd7SJim Harris 		nvme_ns_destruct(&ctrlr->ns[i]);
1272990e741cSJim Harris 
1273990e741cSJim Harris 	if (ctrlr->cdev)
1274990e741cSJim Harris 		destroy_dev(ctrlr->cdev);
1275990e741cSJim Harris 
1276990e741cSJim Harris 	for (i = 0; i < ctrlr->num_io_queues; i++) {
1277990e741cSJim Harris 		nvme_io_qpair_destroy(&ctrlr->ioq[i]);
1278990e741cSJim Harris 	}
1279990e741cSJim Harris 
1280990e741cSJim Harris 	free(ctrlr->ioq, M_NVME);
1281990e741cSJim Harris 
1282990e741cSJim Harris 	nvme_admin_qpair_destroy(&ctrlr->adminq);
1283990e741cSJim Harris 
1284990e741cSJim Harris 	if (ctrlr->resource != NULL) {
1285990e741cSJim Harris 		bus_release_resource(dev, SYS_RES_MEMORY,
1286990e741cSJim Harris 		    ctrlr->resource_id, ctrlr->resource);
1287990e741cSJim Harris 	}
1288990e741cSJim Harris 
1289990e741cSJim Harris 	if (ctrlr->bar4_resource != NULL) {
1290990e741cSJim Harris 		bus_release_resource(dev, SYS_RES_MEMORY,
1291990e741cSJim Harris 		    ctrlr->bar4_resource_id, ctrlr->bar4_resource);
1292990e741cSJim Harris 	}
1293990e741cSJim Harris 
1294990e741cSJim Harris 	if (ctrlr->tag)
1295990e741cSJim Harris 		bus_teardown_intr(ctrlr->dev, ctrlr->res, ctrlr->tag);
1296990e741cSJim Harris 
1297990e741cSJim Harris 	if (ctrlr->res)
1298990e741cSJim Harris 		bus_release_resource(ctrlr->dev, SYS_RES_IRQ,
1299990e741cSJim Harris 		    rman_get_rid(ctrlr->res), ctrlr->res);
1300990e741cSJim Harris 
1301990e741cSJim Harris 	if (ctrlr->msix_enabled)
1302990e741cSJim Harris 		pci_release_msi(dev);
1303990e741cSJim Harris }
1304990e741cSJim Harris 
1305990e741cSJim Harris void
130656183abcSJim Harris nvme_ctrlr_shutdown(struct nvme_controller *ctrlr)
130756183abcSJim Harris {
1308*0d787e9bSWojciech Macek 	uint32_t	cc;
1309*0d787e9bSWojciech Macek 	uint32_t	csts;
131056183abcSJim Harris 	int		ticks = 0;
131156183abcSJim Harris 
1312*0d787e9bSWojciech Macek 	cc = nvme_mmio_read_4(ctrlr, cc);
1313*0d787e9bSWojciech Macek 	cc &= ~(NVME_CC_REG_SHN_MASK << NVME_CC_REG_SHN_SHIFT);
1314*0d787e9bSWojciech Macek 	cc |= NVME_SHN_NORMAL << NVME_CC_REG_SHN_SHIFT;
1315*0d787e9bSWojciech Macek 	nvme_mmio_write_4(ctrlr, cc, cc);
1316*0d787e9bSWojciech Macek 
1317*0d787e9bSWojciech Macek 	csts = nvme_mmio_read_4(ctrlr, csts);
1318*0d787e9bSWojciech Macek 	while ((NVME_CSTS_GET_SHST(csts) != NVME_SHST_COMPLETE) && (ticks++ < 5*hz)) {
131956183abcSJim Harris 		pause("nvme shn", 1);
1320*0d787e9bSWojciech Macek 		csts = nvme_mmio_read_4(ctrlr, csts);
132156183abcSJim Harris 	}
1322*0d787e9bSWojciech Macek 	if (NVME_CSTS_GET_SHST(csts) != NVME_SHST_COMPLETE)
132356183abcSJim Harris 		nvme_printf(ctrlr, "did not complete shutdown within 5 seconds "
132456183abcSJim Harris 		    "of notification\n");
132556183abcSJim Harris }
132656183abcSJim Harris 
132756183abcSJim Harris void
1328d281e8fbSJim Harris nvme_ctrlr_submit_admin_request(struct nvme_controller *ctrlr,
1329d281e8fbSJim Harris     struct nvme_request *req)
1330d281e8fbSJim Harris {
1331d281e8fbSJim Harris 
13325ae9ed68SJim Harris 	nvme_qpair_submit_request(&ctrlr->adminq, req);
1333d281e8fbSJim Harris }
1334d281e8fbSJim Harris 
1335d281e8fbSJim Harris void
1336d281e8fbSJim Harris nvme_ctrlr_submit_io_request(struct nvme_controller *ctrlr,
1337d281e8fbSJim Harris     struct nvme_request *req)
1338d281e8fbSJim Harris {
1339d281e8fbSJim Harris 	struct nvme_qpair       *qpair;
1340d281e8fbSJim Harris 
13412b647da7SJim Harris 	qpair = &ctrlr->ioq[curcpu / ctrlr->num_cpus_per_ioq];
13425ae9ed68SJim Harris 	nvme_qpair_submit_request(qpair, req);
1343d281e8fbSJim Harris }
1344038a5ee4SJim Harris 
1345038a5ee4SJim Harris device_t
1346038a5ee4SJim Harris nvme_ctrlr_get_device(struct nvme_controller *ctrlr)
1347038a5ee4SJim Harris {
1348038a5ee4SJim Harris 
1349038a5ee4SJim Harris 	return (ctrlr->dev);
1350038a5ee4SJim Harris }
1351dbba7442SJim Harris 
1352dbba7442SJim Harris const struct nvme_controller_data *
1353dbba7442SJim Harris nvme_ctrlr_get_data(struct nvme_controller *ctrlr)
1354dbba7442SJim Harris {
1355dbba7442SJim Harris 
1356dbba7442SJim Harris 	return (&ctrlr->cdata);
1357dbba7442SJim Harris }
1358