1 /*-
2 * Copyright (C) 2012-2016 Intel Corporation
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27 #include <sys/param.h>
28 #include <sys/systm.h>
29 #include <sys/buf.h>
30 #include <sys/bus.h>
31 #include <sys/conf.h>
32 #include <sys/proc.h>
33 #include <sys/smp.h>
34 #include <vm/vm.h>
35
36 #include <dev/pci/pcireg.h>
37 #include <dev/pci/pcivar.h>
38
39 #include "nvme_private.h"
40
41 static int nvme_pci_probe(device_t);
42 static int nvme_pci_attach(device_t);
43 static int nvme_pci_detach(device_t);
44 static int nvme_pci_suspend(device_t);
45 static int nvme_pci_resume(device_t);
46
47 static int nvme_ctrlr_setup_interrupts(struct nvme_controller *ctrlr);
48
49 static device_method_t nvme_pci_methods[] = {
50 /* Device interface */
51 DEVMETHOD(device_probe, nvme_pci_probe),
52 DEVMETHOD(device_attach, nvme_pci_attach),
53 DEVMETHOD(device_detach, nvme_pci_detach),
54 DEVMETHOD(device_suspend, nvme_pci_suspend),
55 DEVMETHOD(device_resume, nvme_pci_resume),
56 DEVMETHOD(device_shutdown, nvme_shutdown),
57 { 0, 0 }
58 };
59
60 static driver_t nvme_pci_driver = {
61 "nvme",
62 nvme_pci_methods,
63 sizeof(struct nvme_controller),
64 };
65
66 DRIVER_MODULE(nvme, pci, nvme_pci_driver, NULL, NULL);
67
68 static struct _pcsid
69 {
70 uint32_t devid;
71 int match_subdevice;
72 uint16_t subdevice;
73 const char *desc;
74 uint32_t quirks;
75 } pci_ids[] = {
76 { 0x01118086, 0, 0, "NVMe Controller" },
77 { IDT32_PCI_ID, 0, 0, "IDT NVMe Controller (32 channel)" },
78 { IDT8_PCI_ID, 0, 0, "IDT NVMe Controller (8 channel)" },
79 { 0x09538086, 1, 0x3702, "DC P3700 SSD" },
80 { 0x09538086, 1, 0x3703, "DC P3700 SSD [2.5\" SFF]" },
81 { 0x09538086, 1, 0x3704, "DC P3500 SSD [Add-in Card]" },
82 { 0x09538086, 1, 0x3705, "DC P3500 SSD [2.5\" SFF]" },
83 { 0x09538086, 1, 0x3709, "DC P3600 SSD [Add-in Card]" },
84 { 0x09538086, 1, 0x370a, "DC P3600 SSD [2.5\" SFF]" },
85 { 0x09538086, 0, 0, "Intel DC PC3500", QUIRK_INTEL_ALIGNMENT },
86 { 0x0a538086, 0, 0, "Intel DC PC3520", QUIRK_INTEL_ALIGNMENT },
87 { 0x0a548086, 0, 0, "Intel DC PC4500", QUIRK_INTEL_ALIGNMENT },
88 { 0x0a558086, 0, 0, "Dell Intel P4600", QUIRK_INTEL_ALIGNMENT },
89 { 0x00031c58, 0, 0, "HGST SN100", QUIRK_DELAY_B4_CHK_RDY },
90 { 0x00231c58, 0, 0, "WDC SN200", QUIRK_DELAY_B4_CHK_RDY },
91 { 0x05401c5f, 0, 0, "Memblaze Pblaze4", QUIRK_DELAY_B4_CHK_RDY },
92 { 0xa821144d, 0, 0, "Samsung PM1725", QUIRK_DELAY_B4_CHK_RDY },
93 { 0xa822144d, 0, 0, "Samsung PM1725a", QUIRK_DELAY_B4_CHK_RDY },
94 { 0x07f015ad, 0, 0, "VMware NVMe Controller" },
95 { 0x2003106b, 0, 0, "Apple S3X NVMe Controller" },
96 { 0x00000000, 0, 0, NULL }
97 };
98
99 static int
nvme_match(uint32_t devid,uint16_t subdevice,struct _pcsid * ep)100 nvme_match(uint32_t devid, uint16_t subdevice, struct _pcsid *ep)
101 {
102 if (devid != ep->devid)
103 return 0;
104
105 if (!ep->match_subdevice)
106 return 1;
107
108 if (subdevice == ep->subdevice)
109 return 1;
110 else
111 return 0;
112 }
113
114 static int
nvme_pci_probe(device_t device)115 nvme_pci_probe (device_t device)
116 {
117 struct nvme_controller *ctrlr = DEVICE2SOFTC(device);
118 struct _pcsid *ep;
119 uint32_t devid;
120 uint16_t subdevice;
121
122 devid = pci_get_devid(device);
123 subdevice = pci_get_subdevice(device);
124 ep = pci_ids;
125
126 while (ep->devid) {
127 if (nvme_match(devid, subdevice, ep))
128 break;
129 ++ep;
130 }
131 if (ep->devid)
132 ctrlr->quirks = ep->quirks;
133
134 if (ep->desc) {
135 device_set_desc(device, ep->desc);
136 return (BUS_PROBE_DEFAULT);
137 }
138
139 #if defined(PCIS_STORAGE_NVM)
140 if (pci_get_class(device) == PCIC_STORAGE &&
141 pci_get_subclass(device) == PCIS_STORAGE_NVM &&
142 pci_get_progif(device) == PCIP_STORAGE_NVM_ENTERPRISE_NVMHCI_1_0) {
143 device_set_desc(device, "Generic NVMe Device");
144 return (BUS_PROBE_GENERIC);
145 }
146 #endif
147
148 return (ENXIO);
149 }
150
151 static int
nvme_ctrlr_allocate_bar(struct nvme_controller * ctrlr)152 nvme_ctrlr_allocate_bar(struct nvme_controller *ctrlr)
153 {
154 ctrlr->resource_id = PCIR_BAR(0);
155
156 ctrlr->resource = bus_alloc_resource_any(ctrlr->dev, SYS_RES_MEMORY,
157 &ctrlr->resource_id, RF_ACTIVE);
158
159 if(ctrlr->resource == NULL) {
160 nvme_printf(ctrlr, "unable to allocate pci resource\n");
161 return (ENOMEM);
162 }
163
164 ctrlr->bus_tag = rman_get_bustag(ctrlr->resource);
165 ctrlr->bus_handle = rman_get_bushandle(ctrlr->resource);
166 ctrlr->regs = (struct nvme_registers *)ctrlr->bus_handle;
167
168 /*
169 * The NVMe spec allows for the MSI-X table to be placed behind
170 * BAR 4/5, separate from the control/doorbell registers. Always
171 * try to map this bar, because it must be mapped prior to calling
172 * pci_alloc_msix(). If the table isn't behind BAR 4/5,
173 * bus_alloc_resource() will just return NULL which is OK.
174 */
175 ctrlr->bar4_resource_id = PCIR_BAR(4);
176 ctrlr->bar4_resource = bus_alloc_resource_any(ctrlr->dev, SYS_RES_MEMORY,
177 &ctrlr->bar4_resource_id, RF_ACTIVE);
178
179 return (0);
180 }
181
182 static int
nvme_pci_attach(device_t dev)183 nvme_pci_attach(device_t dev)
184 {
185 struct nvme_controller*ctrlr = DEVICE2SOFTC(dev);
186 int status;
187
188 ctrlr->dev = dev;
189 status = nvme_ctrlr_allocate_bar(ctrlr);
190 if (status != 0)
191 goto bad;
192 pci_enable_busmaster(dev);
193 status = nvme_ctrlr_setup_interrupts(ctrlr);
194 if (status != 0)
195 goto bad;
196 return nvme_attach(dev);
197 bad:
198 if (ctrlr->resource != NULL) {
199 bus_release_resource(dev, SYS_RES_MEMORY,
200 ctrlr->resource_id, ctrlr->resource);
201 }
202
203 if (ctrlr->bar4_resource != NULL) {
204 bus_release_resource(dev, SYS_RES_MEMORY,
205 ctrlr->bar4_resource_id, ctrlr->bar4_resource);
206 }
207
208 if (ctrlr->tag)
209 bus_teardown_intr(dev, ctrlr->res, ctrlr->tag);
210
211 if (ctrlr->res)
212 bus_release_resource(dev, SYS_RES_IRQ,
213 rman_get_rid(ctrlr->res), ctrlr->res);
214
215 if (ctrlr->msi_count > 0)
216 pci_release_msi(dev);
217
218 return status;
219 }
220
221 static int
nvme_pci_detach(device_t dev)222 nvme_pci_detach(device_t dev)
223 {
224 struct nvme_controller*ctrlr = DEVICE2SOFTC(dev);
225 int rv;
226
227 rv = nvme_detach(dev);
228 if (ctrlr->msi_count > 0)
229 pci_release_msi(dev);
230 pci_disable_busmaster(dev);
231 return (rv);
232 }
233
234 static int
nvme_ctrlr_setup_shared(struct nvme_controller * ctrlr,int rid)235 nvme_ctrlr_setup_shared(struct nvme_controller *ctrlr, int rid)
236 {
237 int error;
238
239 ctrlr->num_io_queues = 1;
240 ctrlr->rid = rid;
241 ctrlr->res = bus_alloc_resource_any(ctrlr->dev, SYS_RES_IRQ,
242 &ctrlr->rid, RF_SHAREABLE | RF_ACTIVE);
243 if (ctrlr->res == NULL) {
244 nvme_printf(ctrlr, "unable to allocate shared interrupt\n");
245 return (ENOMEM);
246 }
247
248 error = bus_setup_intr(ctrlr->dev, ctrlr->res,
249 INTR_TYPE_MISC | INTR_MPSAFE, NULL, nvme_ctrlr_shared_handler,
250 ctrlr, &ctrlr->tag);
251 if (error) {
252 nvme_printf(ctrlr, "unable to setup shared interrupt\n");
253 return (error);
254 }
255
256 return (0);
257 }
258
259 static int
nvme_ctrlr_setup_interrupts(struct nvme_controller * ctrlr)260 nvme_ctrlr_setup_interrupts(struct nvme_controller *ctrlr)
261 {
262 device_t dev;
263 int force_intx, num_io_queues, per_cpu_io_queues;
264 int min_cpus_per_ioq;
265 int num_vectors_requested;
266
267 dev = ctrlr->dev;
268
269 force_intx = 0;
270 TUNABLE_INT_FETCH("hw.nvme.force_intx", &force_intx);
271 if (force_intx)
272 return (nvme_ctrlr_setup_shared(ctrlr, 0));
273
274 if (pci_msix_count(dev) == 0)
275 goto msi;
276
277 /*
278 * Try to allocate one MSI-X per core for I/O queues, plus one
279 * for admin queue, but accept single shared MSI-X if have to.
280 * Fall back to MSI if can't get any MSI-X.
281 */
282 num_io_queues = mp_ncpus;
283 TUNABLE_INT_FETCH("hw.nvme.num_io_queues", &num_io_queues);
284 if (num_io_queues < 1 || num_io_queues > mp_ncpus)
285 num_io_queues = mp_ncpus;
286
287 per_cpu_io_queues = 1;
288 TUNABLE_INT_FETCH("hw.nvme.per_cpu_io_queues", &per_cpu_io_queues);
289 if (per_cpu_io_queues == 0)
290 num_io_queues = 1;
291
292 min_cpus_per_ioq = smp_threads_per_core;
293 TUNABLE_INT_FETCH("hw.nvme.min_cpus_per_ioq", &min_cpus_per_ioq);
294 if (min_cpus_per_ioq > 1) {
295 num_io_queues = min(num_io_queues,
296 max(1, mp_ncpus / min_cpus_per_ioq));
297 }
298
299 num_io_queues = min(num_io_queues, max(1, pci_msix_count(dev) - 1));
300
301 again:
302 if (num_io_queues > vm_ndomains)
303 num_io_queues -= num_io_queues % vm_ndomains;
304 num_vectors_requested = min(num_io_queues + 1, pci_msix_count(dev));
305 ctrlr->msi_count = num_vectors_requested;
306 if (pci_alloc_msix(dev, &ctrlr->msi_count) != 0) {
307 nvme_printf(ctrlr, "unable to allocate MSI-X\n");
308 ctrlr->msi_count = 0;
309 goto msi;
310 }
311 if (ctrlr->msi_count == 1)
312 return (nvme_ctrlr_setup_shared(ctrlr, 1));
313 if (ctrlr->msi_count != num_vectors_requested) {
314 pci_release_msi(dev);
315 num_io_queues = ctrlr->msi_count - 1;
316 goto again;
317 }
318
319 ctrlr->num_io_queues = num_io_queues;
320 return (0);
321
322 msi:
323 /*
324 * Try to allocate 2 MSIs (admin and I/O queues), but accept single
325 * shared if have to. Fall back to INTx if can't get any MSI.
326 */
327 ctrlr->msi_count = min(pci_msi_count(dev), 2);
328 if (ctrlr->msi_count > 0) {
329 if (pci_alloc_msi(dev, &ctrlr->msi_count) != 0) {
330 nvme_printf(ctrlr, "unable to allocate MSI\n");
331 ctrlr->msi_count = 0;
332 } else if (ctrlr->msi_count == 2) {
333 ctrlr->num_io_queues = 1;
334 return (0);
335 }
336 }
337 return (nvme_ctrlr_setup_shared(ctrlr, ctrlr->msi_count > 0 ? 1 : 0));
338 }
339
340 static int
nvme_pci_suspend(device_t dev)341 nvme_pci_suspend(device_t dev)
342 {
343 struct nvme_controller *ctrlr;
344
345 ctrlr = DEVICE2SOFTC(dev);
346 return (nvme_ctrlr_suspend(ctrlr));
347 }
348
349 static int
nvme_pci_resume(device_t dev)350 nvme_pci_resume(device_t dev)
351 {
352 struct nvme_controller *ctrlr;
353
354 ctrlr = DEVICE2SOFTC(dev);
355 return (nvme_ctrlr_resume(ctrlr));
356 }
357