xref: /freebsd/sys/dev/mfi/mfi_pci.c (revision f677a9e2672665f4eb3dd4111c07ee8f1f954262)
1 /*-
2  * Copyright (c) 2006 IronPort Systems
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  * Copyright (c) 2007 LSI Corp.
28  * Copyright (c) 2007 Rajesh Prabhakaran.
29  * All rights reserved.
30  *
31  * Redistribution and use in source and binary forms, with or without
32  * modification, are permitted provided that the following conditions
33  * are met:
34  * 1. Redistributions of source code must retain the above copyright
35  *    notice, this list of conditions and the following disclaimer.
36  * 2. Redistributions in binary form must reproduce the above copyright
37  *    notice, this list of conditions and the following disclaimer in the
38  *    documentation and/or other materials provided with the distribution.
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  */
52 
53 #include <sys/cdefs.h>
54 __FBSDID("$FreeBSD$");
55 
56 /* PCI/PCI-X/PCIe bus interface for the LSI MegaSAS controllers */
57 
58 #include "opt_mfi.h"
59 
60 #include <sys/param.h>
61 #include <sys/systm.h>
62 #include <sys/kernel.h>
63 #include <sys/selinfo.h>
64 #include <sys/module.h>
65 #include <sys/bus.h>
66 #include <sys/conf.h>
67 #include <sys/bio.h>
68 #include <sys/malloc.h>
69 #include <sys/sysctl.h>
70 #include <sys/uio.h>
71 
72 #include <machine/bus.h>
73 #include <machine/resource.h>
74 #include <sys/rman.h>
75 
76 #include <dev/pci/pcireg.h>
77 #include <dev/pci/pcivar.h>
78 
79 #include <dev/mfi/mfireg.h>
80 #include <dev/mfi/mfi_ioctl.h>
81 #include <dev/mfi/mfivar.h>
82 
83 static int	mfi_pci_probe(device_t);
84 static int	mfi_pci_attach(device_t);
85 static int	mfi_pci_detach(device_t);
86 static int	mfi_pci_suspend(device_t);
87 static int	mfi_pci_resume(device_t);
88 static void	mfi_pci_free(struct mfi_softc *);
89 
90 static device_method_t mfi_methods[] = {
91 	DEVMETHOD(device_probe,		mfi_pci_probe),
92 	DEVMETHOD(device_attach,	mfi_pci_attach),
93 	DEVMETHOD(device_detach,	mfi_pci_detach),
94 	DEVMETHOD(device_suspend,	mfi_pci_suspend),
95 	DEVMETHOD(device_resume,	mfi_pci_resume),
96 
97 	DEVMETHOD_END
98 };
99 
100 static driver_t mfi_pci_driver = {
101 	"mfi",
102 	mfi_methods,
103 	sizeof(struct mfi_softc)
104 };
105 
106 static devclass_t	mfi_devclass;
107 DRIVER_MODULE(mfi, pci, mfi_pci_driver, mfi_devclass, 0, 0);
108 MODULE_VERSION(mfi, 1);
109 
110 static int	mfi_msi = 1;
111 TUNABLE_INT("hw.mfi.msi", &mfi_msi);
112 SYSCTL_INT(_hw_mfi, OID_AUTO, msi, CTLFLAG_RDTUN, &mfi_msi, 0,
113     "Enable use of MSI interrupts");
114 
115 struct mfi_ident {
116 	uint16_t	vendor;
117 	uint16_t	device;
118 	uint16_t	subvendor;
119 	uint16_t	subdevice;
120 	int		flags;
121 	const char	*desc;
122 } mfi_identifiers[] = {
123 	{0x1000, 0x005b, 0x1028, 0x1f2d, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H810 Adapter"},
124 	{0x1000, 0x005b, 0x1028, 0x1f30, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710 Embedded"},
125 	{0x1000, 0x005b, 0x1028, 0x1f31, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710P Adapter"},
126 	{0x1000, 0x005b, 0x1028, 0x1f33, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710P Mini (blades)"},
127 	{0x1000, 0x005b, 0x1028, 0x1f34, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710P Mini (monolithics)"},
128 	{0x1000, 0x005b, 0x1028, 0x1f35, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710 Adapter"},
129 	{0x1000, 0x005b, 0x1028, 0x1f37, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710 Mini (blades)"},
130 	{0x1000, 0x005b, 0x1028, 0x1f38, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710 Mini (monolithics)"},
131 	{0x1000, 0x005b, 0x8086, 0x9265, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Intel (R) RAID Controller RS25DB080"},
132 	{0x1000, 0x005b, 0x8086, 0x9285, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Intel (R) RAID Controller RS25NB008"},
133 	{0x1000, 0x005b, 0xffff, 0xffff, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "ThunderBolt"},
134 	{0x1000, 0x005d, 0xffff, 0xffff, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Invader"},
135 	{0x1000, 0x0060, 0x1028, 0xffff, MFI_FLAGS_1078,  "Dell PERC 6"},
136 	{0x1000, 0x0060, 0xffff, 0xffff, MFI_FLAGS_1078,  "LSI MegaSAS 1078"},
137 	{0x1000, 0x0071, 0xffff, 0xffff, MFI_FLAGS_SKINNY, "Drake Skinny"},
138 	{0x1000, 0x0073, 0xffff, 0xffff, MFI_FLAGS_SKINNY, "Drake Skinny"},
139 	{0x1000, 0x0078, 0xffff, 0xffff, MFI_FLAGS_GEN2,  "LSI MegaSAS Gen2"},
140 	{0x1000, 0x0079, 0x1028, 0x1f15, MFI_FLAGS_GEN2,  "Dell PERC H800 Adapter"},
141 	{0x1000, 0x0079, 0x1028, 0x1f16, MFI_FLAGS_GEN2,  "Dell PERC H700 Adapter"},
142 	{0x1000, 0x0079, 0x1028, 0x1f17, MFI_FLAGS_GEN2,  "Dell PERC H700 Integrated"},
143 	{0x1000, 0x0079, 0x1028, 0x1f18, MFI_FLAGS_GEN2,  "Dell PERC H700 Modular"},
144 	{0x1000, 0x0079, 0x1028, 0x1f19, MFI_FLAGS_GEN2,  "Dell PERC H700"},
145 	{0x1000, 0x0079, 0x1028, 0x1f1a, MFI_FLAGS_GEN2,  "Dell PERC H800 Proto Adapter"},
146 	{0x1000, 0x0079, 0x1028, 0x1f1b, MFI_FLAGS_GEN2,  "Dell PERC H800"},
147 	{0x1000, 0x0079, 0x1028, 0xffff, MFI_FLAGS_GEN2,  "Dell PERC Gen2"},
148 	{0x1000, 0x0079, 0xffff, 0xffff, MFI_FLAGS_GEN2,  "LSI MegaSAS Gen2"},
149 	{0x1000, 0x007c, 0xffff, 0xffff, MFI_FLAGS_1078,  "LSI MegaSAS 1078"},
150 	{0x1000, 0x0411, 0xffff, 0xffff, MFI_FLAGS_1064R, "LSI MegaSAS 1064R"}, /* Brocton IOP */
151 	{0x1000, 0x0413, 0xffff, 0xffff, MFI_FLAGS_1064R, "LSI MegaSAS 1064R"}, /* Verde ZCR */
152 	{0x1028, 0x0015, 0xffff, 0xffff, MFI_FLAGS_1064R, "Dell PERC 5/i"},
153 	{0, 0, 0, 0, 0, NULL}
154 };
155 
156 static struct mfi_ident *
157 mfi_find_ident(device_t dev)
158 {
159 	struct mfi_ident *m;
160 
161 	for (m = mfi_identifiers; m->vendor != 0; m++) {
162 		if ((m->vendor == pci_get_vendor(dev)) &&
163 		    (m->device == pci_get_device(dev)) &&
164 		    ((m->subvendor == pci_get_subvendor(dev)) ||
165 		    (m->subvendor == 0xffff)) &&
166 		    ((m->subdevice == pci_get_subdevice(dev)) ||
167 		    (m->subdevice == 0xffff)))
168 			return (m);
169 	}
170 
171 	return (NULL);
172 }
173 
174 static int
175 mfi_pci_probe(device_t dev)
176 {
177 	struct mfi_ident *id;
178 
179 	if ((id = mfi_find_ident(dev)) != NULL) {
180 		device_set_desc(dev, id->desc);
181 		return (BUS_PROBE_DEFAULT);
182 	}
183 	return (ENXIO);
184 }
185 
186 static int
187 mfi_pci_attach(device_t dev)
188 {
189 	struct mfi_softc *sc;
190 	struct mfi_ident *m;
191 	int count, error;
192 
193 	sc = device_get_softc(dev);
194 	bzero(sc, sizeof(*sc));
195 	sc->mfi_dev = dev;
196 	m = mfi_find_ident(dev);
197 	sc->mfi_flags = m->flags;
198 
199 	/* Ensure busmastering is enabled */
200 	pci_enable_busmaster(dev);
201 
202 	/* Allocate PCI registers */
203 	if ((sc->mfi_flags & MFI_FLAGS_1064R) ||
204 	    (sc->mfi_flags & MFI_FLAGS_1078)) {
205 		/* 1068/1078: Memory mapped BAR is at offset 0x10 */
206 		sc->mfi_regs_rid = PCIR_BAR(0);
207 	}
208 	else if ((sc->mfi_flags & MFI_FLAGS_GEN2) ||
209 		 (sc->mfi_flags & MFI_FLAGS_SKINNY) ||
210 		(sc->mfi_flags & MFI_FLAGS_TBOLT)) {
211 		/* Gen2/Skinny: Memory mapped BAR is at offset 0x14 */
212 		sc->mfi_regs_rid = PCIR_BAR(1);
213 	}
214 	if ((sc->mfi_regs_resource = bus_alloc_resource_any(sc->mfi_dev,
215 	    SYS_RES_MEMORY, &sc->mfi_regs_rid, RF_ACTIVE)) == NULL) {
216 		device_printf(dev, "Cannot allocate PCI registers\n");
217 		return (ENXIO);
218 	}
219 	sc->mfi_btag = rman_get_bustag(sc->mfi_regs_resource);
220 	sc->mfi_bhandle = rman_get_bushandle(sc->mfi_regs_resource);
221 
222 	error = ENOMEM;
223 
224 	/* Allocate parent DMA tag */
225 	if (bus_dma_tag_create(	bus_get_dma_tag(dev),	/* PCI parent */
226 				1, 0,			/* algnmnt, boundary */
227 				BUS_SPACE_MAXADDR,	/* lowaddr */
228 				BUS_SPACE_MAXADDR,	/* highaddr */
229 				NULL, NULL,		/* filter, filterarg */
230 				BUS_SPACE_MAXSIZE_32BIT,/* maxsize */
231 				BUS_SPACE_UNRESTRICTED,	/* nsegments */
232 				BUS_SPACE_MAXSIZE_32BIT,/* maxsegsize */
233 				0,			/* flags */
234 				NULL, NULL,		/* lockfunc, lockarg */
235 				&sc->mfi_parent_dmat)) {
236 		device_printf(dev, "Cannot allocate parent DMA tag\n");
237 		goto out;
238 	}
239 
240 	/* Allocate IRQ resource. */
241 	sc->mfi_irq_rid = 0;
242 	count = 1;
243 	if (mfi_msi && pci_alloc_msi(sc->mfi_dev, &count) == 0) {
244 		device_printf(sc->mfi_dev, "Using MSI\n");
245 		sc->mfi_irq_rid = 1;
246 	}
247 	if ((sc->mfi_irq = bus_alloc_resource_any(sc->mfi_dev, SYS_RES_IRQ,
248 	    &sc->mfi_irq_rid, RF_SHAREABLE | RF_ACTIVE)) == NULL) {
249 		device_printf(sc->mfi_dev, "Cannot allocate interrupt\n");
250 		error = EINVAL;
251 		goto out;
252 	}
253 
254 	error = mfi_attach(sc);
255 out:
256 	if (error) {
257 		mfi_free(sc);
258 		mfi_pci_free(sc);
259 	}
260 
261 	return (error);
262 }
263 
264 static int
265 mfi_pci_detach(device_t dev)
266 {
267 	struct mfi_softc *sc;
268 	int error, devcount, i;
269 	device_t *devlist;
270 
271 	sc = device_get_softc(dev);
272 
273 	sx_xlock(&sc->mfi_config_lock);
274 	mtx_lock(&sc->mfi_io_lock);
275 	if ((sc->mfi_flags & MFI_FLAGS_OPEN) != 0) {
276 		mtx_unlock(&sc->mfi_io_lock);
277 		sx_xunlock(&sc->mfi_config_lock);
278 		return (EBUSY);
279 	}
280 	sc->mfi_detaching = 1;
281 	mtx_unlock(&sc->mfi_io_lock);
282 
283 	if ((error = device_get_children(sc->mfi_dev, &devlist, &devcount)) != 0) {
284 		sx_xunlock(&sc->mfi_config_lock);
285 		return error;
286 	}
287 	for (i = 0; i < devcount; i++)
288 		device_delete_child(sc->mfi_dev, devlist[i]);
289 	free(devlist, M_TEMP);
290 	sx_xunlock(&sc->mfi_config_lock);
291 
292 	EVENTHANDLER_DEREGISTER(shutdown_final, sc->mfi_eh);
293 
294 	mfi_shutdown(sc);
295 	mfi_free(sc);
296 	mfi_pci_free(sc);
297 	return (0);
298 }
299 
300 static void
301 mfi_pci_free(struct mfi_softc *sc)
302 {
303 
304 	if (sc->mfi_regs_resource != NULL) {
305 		bus_release_resource(sc->mfi_dev, SYS_RES_MEMORY,
306 		    sc->mfi_regs_rid, sc->mfi_regs_resource);
307 	}
308 	if (sc->mfi_irq_rid != 0)
309 		pci_release_msi(sc->mfi_dev);
310 
311 	return;
312 }
313 
314 static int
315 mfi_pci_suspend(device_t dev)
316 {
317 
318 	return (EINVAL);
319 }
320 
321 static int
322 mfi_pci_resume(device_t dev)
323 {
324 
325 	return (EINVAL);
326 }
327