2 * Copyright (c) 2009 Yahoo! Inc.
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 /* PCI/PCI-X/PCIe bus interface for the Avago Tech (LSI) MPT3 controllers */
32 /* TODO Move headers to mprvar */
33 #include <sys/types.h>
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/module.h>
40 #include <sys/malloc.h>
41 #include <sys/sysctl.h>
44 #include <machine/bus.h>
45 #include <machine/resource.h>
48 #include <dev/pci/pcireg.h>
49 #include <dev/pci/pcivar.h>
50 #include <dev/pci/pci_private.h>
52 #include <dev/mpr/mpi/mpi2_type.h>
53 #include <dev/mpr/mpi/mpi2.h>
54 #include <dev/mpr/mpi/mpi2_ioc.h>
55 #include <dev/mpr/mpi/mpi2_cnfg.h>
56 #include <dev/mpr/mpi/mpi2_tool.h>
57 #include <dev/mpr/mpi/mpi2_pci.h>
59 #include <sys/queue.h>
60 #include <sys/kthread.h>
61 #include <dev/mpr/mpr_ioctl.h>
62 #include <dev/mpr/mprvar.h>
64 static int mpr_pci_probe(device_t);
65 static int mpr_pci_attach(device_t);
66 static int mpr_pci_detach(device_t);
67 static int mpr_pci_suspend(device_t);
68 static int mpr_pci_resume(device_t);
69 static void mpr_pci_free(struct mpr_softc *);
70 static int mpr_alloc_msix(struct mpr_softc *sc, int msgs);
71 static int mpr_alloc_msi(struct mpr_softc *sc, int msgs);
72 static int mpr_pci_alloc_interrupts(struct mpr_softc *sc);
74 static device_method_t mpr_methods[] = {
75 DEVMETHOD(device_probe, mpr_pci_probe),
76 DEVMETHOD(device_attach, mpr_pci_attach),
77 DEVMETHOD(device_detach, mpr_pci_detach),
78 DEVMETHOD(device_suspend, mpr_pci_suspend),
79 DEVMETHOD(device_resume, mpr_pci_resume),
80 DEVMETHOD(bus_print_child, bus_generic_print_child),
81 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
85 static driver_t mpr_pci_driver = {
88 sizeof(struct mpr_softc)
99 } mpr_identifiers[] = {
100 { MPI2_MFGPAGE_VENDORID_LSI, MPI25_MFGPAGE_DEVID_SAS3004,
101 0xffff, 0xffff, 0, "Avago Technologies (LSI) SAS3004" },
102 { MPI2_MFGPAGE_VENDORID_LSI, MPI25_MFGPAGE_DEVID_SAS3008,
103 0xffff, 0xffff, 0, "Avago Technologies (LSI) SAS3008" },
104 { MPI2_MFGPAGE_VENDORID_LSI, MPI25_MFGPAGE_DEVID_SAS3108_1,
105 0xffff, 0xffff, 0, "Avago Technologies (LSI) SAS3108_1" },
106 { MPI2_MFGPAGE_VENDORID_LSI, MPI25_MFGPAGE_DEVID_SAS3108_2,
107 0xffff, 0xffff, 0, "Avago Technologies (LSI) SAS3108_2" },
108 { MPI2_MFGPAGE_VENDORID_LSI, MPI25_MFGPAGE_DEVID_SAS3108_5,
109 0xffff, 0xffff, 0, "Avago Technologies (LSI) SAS3108_5" },
110 { MPI2_MFGPAGE_VENDORID_LSI, MPI25_MFGPAGE_DEVID_SAS3108_6,
111 0xffff, 0xffff, 0, "Avago Technologies (LSI) SAS3108_6" },
112 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3216,
113 0xffff, 0xffff, 0, "Avago Technologies (LSI) SAS3216" },
114 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3224,
115 0xffff, 0xffff, 0, "Avago Technologies (LSI) SAS3224" },
116 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3316_1,
117 0xffff, 0xffff, 0, "Avago Technologies (LSI) SAS3316_1" },
118 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3316_2,
119 0xffff, 0xffff, 0, "Avago Technologies (LSI) SAS3316_2" },
120 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3324_1,
121 0xffff, 0xffff, 0, "Avago Technologies (LSI) SAS3324_1" },
122 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3324_2,
123 0xffff, 0xffff, 0, "Avago Technologies (LSI) SAS3324_2" },
124 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3408,
125 0xffff, 0xffff, MPR_FLAGS_GEN35_IOC,
126 "Avago Technologies (LSI) SAS3408" },
127 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3416,
128 0xffff, 0xffff, MPR_FLAGS_GEN35_IOC,
129 "Avago Technologies (LSI) SAS3416" },
130 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3508,
131 0xffff, 0xffff, MPR_FLAGS_GEN35_IOC,
132 "Avago Technologies (LSI) SAS3508" },
133 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3508_1,
134 0xffff, 0xffff, MPR_FLAGS_GEN35_IOC,
135 "Avago Technologies (LSI) SAS3508_1" },
136 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3516,
137 0xffff, 0xffff, MPR_FLAGS_GEN35_IOC,
138 "Avago Technologies (LSI) SAS3516" },
139 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3516_1,
140 0xffff, 0xffff, MPR_FLAGS_GEN35_IOC,
141 "Avago Technologies (LSI) SAS3516_1" },
142 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3616,
143 0xffff, 0xffff, MPR_FLAGS_GEN35_IOC,
144 "Avago Technologies (LSI) SAS3616" },
145 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3708,
146 0xffff, 0xffff, MPR_FLAGS_GEN35_IOC,
147 "Avago Technologies (LSI) SAS3708" },
148 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_SAS3716,
149 0xffff, 0xffff, MPR_FLAGS_GEN35_IOC,
150 "Avago Technologies (LSI) SAS3716" },
151 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_INVALID0_SAS3816,
152 0xffff, 0xffff, (MPR_FLAGS_GEN35_IOC | MPR_FLAGS_SEA_IOC),
153 "Broadcom Inc. (LSI) INVALID0 SAS3816" },
154 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_CFG_SEC_SAS3816,
155 0xffff, 0xffff, (MPR_FLAGS_GEN35_IOC | MPR_FLAGS_SEA_IOC),
156 "Broadcom Inc. (LSI) CFG SEC SAS3816" },
157 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_HARD_SEC_SAS3816,
158 0xffff, 0xffff, (MPR_FLAGS_GEN35_IOC | MPR_FLAGS_SEA_IOC),
159 "Broadcom Inc. (LSI) HARD SEC SAS3816" },
160 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_INVALID1_SAS3816,
161 0xffff, 0xffff, (MPR_FLAGS_GEN35_IOC | MPR_FLAGS_SEA_IOC),
162 "Broadcom Inc. (LSI) INVALID1 SAS3816" },
163 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_INVALID0_SAS3916,
164 0xffff, 0xffff, (MPR_FLAGS_GEN35_IOC | MPR_FLAGS_SEA_IOC),
165 "Broadcom Inc. (LSI) INVALID0 SAS3916" },
166 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_CFG_SEC_SAS3916,
167 0xffff, 0xffff, (MPR_FLAGS_GEN35_IOC | MPR_FLAGS_SEA_IOC),
168 "Broadcom Inc. (LSI) CFG SEC SAS3916" },
169 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_HARD_SEC_SAS3916,
170 0xffff, 0xffff, (MPR_FLAGS_GEN35_IOC | MPR_FLAGS_SEA_IOC),
171 "Broadcom Inc. (LSI) HARD SEC SAS3916" },
172 { MPI2_MFGPAGE_VENDORID_LSI, MPI26_MFGPAGE_DEVID_INVALID1_SAS3916,
173 0xffff, 0xffff, (MPR_FLAGS_GEN35_IOC | MPR_FLAGS_SEA_IOC),
174 "Broadcom Inc. (LSI) INVALID1 SAS3916" },
175 { 0, 0, 0, 0, 0, NULL }
179 static devclass_t mpr_devclass;
180 DRIVER_MODULE(mpr, pci, mpr_pci_driver, mpr_devclass, 0, 0);
181 MODULE_PNP_INFO("U16:vendor;U16:device;U16:subvendor;U16:subdevice;D:#", pci,
182 mpr, mpr_identifiers, nitems(mpr_identifiers) - 1);
184 MODULE_DEPEND(mpr, cam, 1, 1, 1);
186 static struct mpr_ident *
187 mpr_find_ident(device_t dev)
191 for (m = mpr_identifiers; m->vendor != 0; m++) {
192 if (m->vendor != pci_get_vendor(dev))
194 if (m->device != pci_get_device(dev))
196 if ((m->subvendor != 0xffff) &&
197 (m->subvendor != pci_get_subvendor(dev)))
199 if ((m->subdevice != 0xffff) &&
200 (m->subdevice != pci_get_subdevice(dev)))
209 mpr_pci_probe(device_t dev)
211 struct mpr_ident *id;
213 if ((id = mpr_find_ident(dev)) != NULL) {
214 device_set_desc(dev, id->desc);
215 return (BUS_PROBE_DEFAULT);
221 mpr_pci_attach(device_t dev)
223 bus_dma_tag_template_t t;
224 struct mpr_softc *sc;
228 sc = device_get_softc(dev);
229 bzero(sc, sizeof(*sc));
231 m = mpr_find_ident(dev);
232 sc->mpr_flags = m->flags;
235 case MPI26_MFGPAGE_DEVID_INVALID0_SAS3816:
236 case MPI26_MFGPAGE_DEVID_INVALID1_SAS3816:
237 case MPI26_MFGPAGE_DEVID_INVALID0_SAS3916:
238 case MPI26_MFGPAGE_DEVID_INVALID1_SAS3916:
239 mpr_printf(sc, "HBA is in Non Secure mode\n");
241 case MPI26_MFGPAGE_DEVID_CFG_SEC_SAS3816:
242 case MPI26_MFGPAGE_DEVID_CFG_SEC_SAS3916:
243 mpr_printf(sc, "HBA is in Configurable Secure mode\n");
249 mpr_get_tunables(sc);
251 /* Twiddle basic PCI config bits for a sanity check */
252 pci_enable_busmaster(dev);
254 for (i = 0; i < PCI_MAXMAPS_0; i++) {
255 sc->mpr_regs_rid = PCIR_BAR(i);
257 if ((sc->mpr_regs_resource = bus_alloc_resource_any(dev,
258 SYS_RES_MEMORY, &sc->mpr_regs_rid, RF_ACTIVE)) != NULL)
262 if (sc->mpr_regs_resource == NULL) {
263 mpr_printf(sc, "Cannot allocate PCI registers\n");
267 sc->mpr_btag = rman_get_bustag(sc->mpr_regs_resource);
268 sc->mpr_bhandle = rman_get_bushandle(sc->mpr_regs_resource);
270 /* Allocate the parent DMA tag */
271 bus_dma_template_init(&t, bus_get_dma_tag(dev));
272 if (bus_dma_template_tag(&t, &sc->mpr_parent_dmat)) {
273 mpr_printf(sc, "Cannot allocate parent DMA tag\n");
278 if (((error = mpr_pci_alloc_interrupts(sc)) != 0) ||
279 ((error = mpr_attach(sc)) != 0))
286 * Allocate, but don't assign interrupts early. Doing it before requesting
287 * the IOCFacts message informs the firmware that we want to do MSI-X
288 * multiqueue. We might not use all of the available messages, but there's
289 * no reason to re-alloc if we don't.
292 mpr_pci_alloc_interrupts(struct mpr_softc *sc)
301 if (sc->disable_msix == 0) {
302 msgs = pci_msix_count(dev);
303 mpr_dprint(sc, MPR_INIT, "Counted %d MSI-X messages\n", msgs);
304 msgs = min(msgs, sc->max_msix);
305 msgs = min(msgs, MPR_MSIX_MAX);
306 msgs = min(msgs, 1); /* XXX */
308 mpr_dprint(sc, MPR_INIT, "Attempting to allocate %d "
309 "MSI-X messages\n", msgs);
310 error = mpr_alloc_msix(sc, msgs);
313 if (((error != 0) || (msgs == 0)) && (sc->disable_msi == 0)) {
314 msgs = pci_msi_count(dev);
315 mpr_dprint(sc, MPR_INIT, "Counted %d MSI messages\n", msgs);
316 msgs = min(msgs, MPR_MSI_MAX);
318 mpr_dprint(sc, MPR_INIT, "Attempting to allocated %d "
319 "MSI messages\n", MPR_MSI_MAX);
320 error = mpr_alloc_msi(sc, MPR_MSI_MAX);
323 if ((error != 0) || (msgs == 0)) {
325 * If neither MSI or MSI-X are available, assume legacy INTx.
326 * This also implies that there will be only 1 queue.
328 mpr_dprint(sc, MPR_INIT, "Falling back to legacy INTx\n");
329 sc->mpr_flags |= MPR_FLAGS_INTX;
332 sc->mpr_flags |= MPR_FLAGS_MSI;
335 mpr_dprint(sc, MPR_INIT, "Allocated %d interrupts\n", msgs);
341 mpr_pci_setup_interrupts(struct mpr_softc *sc)
346 int i, error, rid, initial_rid;
351 if (sc->mpr_flags & MPR_FLAGS_INTX) {
354 } else if (sc->mpr_flags & MPR_FLAGS_MSI) {
356 ihandler = mpr_intr_msi;
358 mpr_dprint(sc, MPR_ERROR|MPR_INIT,
359 "Unable to set up interrupts\n");
363 for (i = 0; i < sc->msi_msgs; i++) {
365 rid = i + initial_rid;
367 q->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ,
368 &q->irq_rid, RF_ACTIVE);
369 if (q->irq == NULL) {
370 mpr_dprint(sc, MPR_ERROR|MPR_INIT,
371 "Cannot allocate interrupt RID %d\n", rid);
375 error = bus_setup_intr(dev, q->irq,
376 INTR_TYPE_BIO | INTR_MPSAFE, NULL, ihandler,
379 mpr_dprint(sc, MPR_ERROR|MPR_INIT,
380 "Cannot setup interrupt RID %d\n", rid);
386 mpr_dprint(sc, MPR_INIT, "Set up %d interrupts\n", sc->msi_msgs);
391 mpr_pci_detach(device_t dev)
393 struct mpr_softc *sc;
396 sc = device_get_softc(dev);
398 if ((error = mpr_free(sc)) != 0)
406 mpr_pci_free_interrupts(struct mpr_softc *sc)
411 if (sc->queues == NULL)
414 for (i = 0; i < sc->msi_msgs; i++) {
416 if (q->irq != NULL) {
417 bus_teardown_intr(sc->mpr_dev, q->irq,
419 bus_release_resource(sc->mpr_dev, SYS_RES_IRQ,
426 mpr_pci_free(struct mpr_softc *sc)
429 if (sc->mpr_parent_dmat != NULL) {
430 bus_dma_tag_destroy(sc->mpr_parent_dmat);
433 mpr_pci_free_interrupts(sc);
435 if (sc->mpr_flags & MPR_FLAGS_MSI)
436 pci_release_msi(sc->mpr_dev);
438 if (sc->mpr_regs_resource != NULL) {
439 bus_release_resource(sc->mpr_dev, SYS_RES_MEMORY,
440 sc->mpr_regs_rid, sc->mpr_regs_resource);
447 mpr_pci_suspend(device_t dev)
453 mpr_pci_resume(device_t dev)
459 mpr_alloc_msix(struct mpr_softc *sc, int msgs)
463 error = pci_alloc_msix(sc->mpr_dev, &msgs);
468 mpr_alloc_msi(struct mpr_softc *sc, int msgs)
472 error = pci_alloc_msi(sc->mpr_dev, &msgs);
477 mpr_pci_restore(struct mpr_softc *sc)
479 struct pci_devinfo *dinfo;
481 mpr_dprint(sc, MPR_TRACE, "%s\n", __func__);
483 dinfo = device_get_ivars(sc->mpr_dev);
485 mpr_dprint(sc, MPR_FAULT, "%s: NULL dinfo\n", __func__);
489 pci_cfg_restore(sc->mpr_dev, dinfo);