xref: /dflybsd-src/sys/dev/raid/mfi/mfi_pci.c (revision 8bb2400d5e4f21e6ed6fe870515c2d9a1cdfb5c7)
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  * $FreeBSD: src/sys/dev/mfi/mfi_pci.c,v 1.16 2010/03/02 17:34:11 kib Exp $
53  * FreeBSD projects/head_mfi/ r232888
54  */
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/module.h>
64 #include <sys/bus.h>
65 #include <sys/conf.h>
66 #include <sys/buf2.h>
67 #include <sys/malloc.h>
68 #include <sys/uio.h>
69 #include <sys/eventhandler.h>
70 #include <sys/rman.h>
71 
72 #include <bus/pci/pcireg.h>
73 #include <bus/pci/pcivar.h>
74 
75 #include <dev/raid/mfi/mfireg.h>
76 #include <dev/raid/mfi/mfi_ioctl.h>
77 #include <dev/raid/mfi/mfivar.h>
78 
79 static int	mfi_pci_probe(device_t);
80 static int	mfi_pci_attach(device_t);
81 static int	mfi_pci_detach(device_t);
82 static int	mfi_pci_suspend(device_t);
83 static int	mfi_pci_resume(device_t);
84 static void	mfi_pci_free(struct mfi_softc *);
85 
86 static device_method_t mfi_methods[] = {
87 	DEVMETHOD(device_probe,		mfi_pci_probe),
88 	DEVMETHOD(device_attach,	mfi_pci_attach),
89 	DEVMETHOD(device_detach,	mfi_pci_detach),
90 	DEVMETHOD(device_suspend,	mfi_pci_suspend),
91 	DEVMETHOD(device_resume,	mfi_pci_resume),
92 	DEVMETHOD(bus_print_child,	bus_generic_print_child),
93 	DEVMETHOD(bus_driver_added,	bus_generic_driver_added),
94 	{ 0, 0 }
95 };
96 
97 static driver_t mfi_pci_driver = {
98 	"mfi",
99 	mfi_methods,
100 	sizeof(struct mfi_softc)
101 };
102 
103 static devclass_t	mfi_devclass;
104 DRIVER_MODULE(mfi, pci, mfi_pci_driver, mfi_devclass, NULL, NULL);
105 MODULE_VERSION(mfi, 1);
106 
107 static int	mfi_msi_enable = 1;
108 TUNABLE_INT("hw.mfi.msi.enable", &mfi_msi_enable);
109 
110 struct mfi_ident {
111 	uint16_t	vendor;
112 	uint16_t	device;
113 	uint16_t	subvendor;
114 	uint16_t	subdevice;
115 	int		flags;
116 	const char	*desc;
117 } mfi_identifiers[] = {
118 	{0x1000, 0x005b, 0x1028, 0x1f2d, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H810 Adapter"},
119 	{0x1000, 0x005b, 0x1028, 0x1f30, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710 Embedded"},
120 	{0x1000, 0x005b, 0x1028, 0x1f31, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710P Adapter"},
121 	{0x1000, 0x005b, 0x1028, 0x1f33, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710P Mini (blades)"},
122 	{0x1000, 0x005b, 0x1028, 0x1f34, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710P Mini (monolithics)"},
123 	{0x1000, 0x005b, 0x1028, 0x1f35, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710 Adapter"},
124 	{0x1000, 0x005b, 0x1028, 0x1f37, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710 Mini (blades)"},
125 	{0x1000, 0x005b, 0x1028, 0x1f38, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710 Mini (monolithics)"},
126 	{0x1000, 0x005b, 0x8086, 0x9265, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Intel (R) RAID Controller RS25DB080"},
127 	{0x1000, 0x005b, 0x8086, 0x9285, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Intel (R) RAID Controller RS25NB008"},
128 	{0x1000, 0x005b, 0xffff, 0xffff, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "ThunderBolt"},
129 	{0x1000, 0x0060, 0x1028, 0xffff, MFI_FLAGS_1078,  "Dell PERC 6"},
130 	{0x1000, 0x0060, 0xffff, 0xffff, MFI_FLAGS_1078,  "LSI MegaSAS 1078"},
131 	{0x1000, 0x0071, 0xffff, 0xffff, MFI_FLAGS_SKINNY, "Drake Skinny"},
132 	{0x1000, 0x0073, 0xffff, 0xffff, MFI_FLAGS_SKINNY, "Drake Skinny"},
133 	{0x1000, 0x0078, 0xffff, 0xffff, MFI_FLAGS_GEN2,  "LSI MegaSAS Gen2"},
134 	{0x1000, 0x0079, 0x1028, 0x1f15, MFI_FLAGS_GEN2,  "Dell PERC H800 Adapter"},
135 	{0x1000, 0x0079, 0x1028, 0x1f16, MFI_FLAGS_GEN2,  "Dell PERC H700 Adapter"},
136 	{0x1000, 0x0079, 0x1028, 0x1f17, MFI_FLAGS_GEN2,  "Dell PERC H700 Integrated"},
137 	{0x1000, 0x0079, 0x1028, 0x1f18, MFI_FLAGS_GEN2,  "Dell PERC H700 Modular"},
138 	{0x1000, 0x0079, 0x1028, 0x1f19, MFI_FLAGS_GEN2,  "Dell PERC H700"},
139 	{0x1000, 0x0079, 0x1028, 0x1f1a, MFI_FLAGS_GEN2,  "Dell PERC H800 Proto Adapter"},
140 	{0x1000, 0x0079, 0x1028, 0x1f1b, MFI_FLAGS_GEN2,  "Dell PERC H800"},
141 	{0x1000, 0x0079, 0x1028, 0xffff, MFI_FLAGS_GEN2,  "Dell PERC Gen2"},
142 	{0x1000, 0x0079, 0xffff, 0xffff, MFI_FLAGS_GEN2,  "LSI MegaSAS Gen2"},
143 	{0x1000, 0x007c, 0xffff, 0xffff, MFI_FLAGS_1078,  "LSI MegaSAS 1078"},
144 	{0x1000, 0x0411, 0xffff, 0xffff, MFI_FLAGS_1064R, "LSI MegaSAS 1064R"}, /* Brocton IOP */
145 	{0x1000, 0x0413, 0xffff, 0xffff, MFI_FLAGS_1064R, "LSI MegaSAS 1064R"}, /* Verde ZCR */
146 	{0x1028, 0x0015, 0xffff, 0xffff, MFI_FLAGS_1064R, "Dell PERC 5/i"},
147 	{0, 0, 0, 0, 0, NULL}
148 };
149 
150 static struct mfi_ident *
151 mfi_find_ident(device_t dev)
152 {
153 	struct mfi_ident *m;
154 
155 	for (m = mfi_identifiers; m->vendor != 0; m++) {
156 		if ((m->vendor == pci_get_vendor(dev)) &&
157 		    (m->device == pci_get_device(dev)) &&
158 		    ((m->subvendor == pci_get_subvendor(dev)) ||
159 		    (m->subvendor == 0xffff)) &&
160 		    ((m->subdevice == pci_get_subdevice(dev)) ||
161 		    (m->subdevice == 0xffff)))
162 			return (m);
163 	}
164 
165 	return (NULL);
166 }
167 
168 static int
169 mfi_pci_probe(device_t dev)
170 {
171 	struct mfi_ident *id;
172 
173 	if ((id = mfi_find_ident(dev)) != NULL) {
174 		device_set_desc(dev, id->desc);
175 		return (BUS_PROBE_DEFAULT);
176 	}
177 	return (ENXIO);
178 }
179 
180 static int
181 mfi_pci_attach(device_t dev)
182 {
183 	struct mfi_softc *sc;
184 	struct mfi_ident *m;
185 	uint32_t command;
186 	int error;
187 	u_int irq_flags;
188 
189 	sc = device_get_softc(dev);
190 	bzero(sc, sizeof(*sc));
191 	sc->mfi_dev = dev;
192 	m = mfi_find_ident(dev);
193 	sc->mfi_flags = m->flags;
194 
195 	/* Verify that the adapter can be set up in PCI space */
196 	command = pci_read_config(dev, PCIR_COMMAND, 2);
197 	command |= PCIM_CMD_BUSMASTEREN;
198 	pci_write_config(dev, PCIR_COMMAND, command, 2);
199 	command = pci_read_config(dev, PCIR_COMMAND, 2);
200 	if ((command & PCIM_CMD_BUSMASTEREN) == 0) {
201 		device_printf(dev, "Can't enable PCI busmaster\n");
202 		return (ENXIO);
203 	}
204 	if ((command & PCIM_CMD_MEMEN) == 0) {
205 		device_printf(dev, "PCI memory window not available\n");
206 		return (ENXIO);
207 	}
208 
209 	/* Allocate PCI registers */
210 	if ((sc->mfi_flags & MFI_FLAGS_1064R) ||
211 	    (sc->mfi_flags & MFI_FLAGS_1078)) {
212 		/* 1068/1078: Memory mapped BAR is at offset 0x10 */
213 		sc->mfi_regs_rid = PCIR_BAR(0);
214 	} else if ((sc->mfi_flags & MFI_FLAGS_GEN2) ||
215 		   (sc->mfi_flags & MFI_FLAGS_SKINNY) ||
216 		   (sc->mfi_flags & MFI_FLAGS_TBOLT)) {
217 		/* GEN2/Skinny: Memory mapped BAR is at offset 0x14 */
218 		sc->mfi_regs_rid = PCIR_BAR(1);
219 	}
220 	if ((sc->mfi_regs_resource = bus_alloc_resource_any(sc->mfi_dev,
221 	    SYS_RES_MEMORY, &sc->mfi_regs_rid, RF_ACTIVE)) == NULL) {
222 		device_printf(dev, "Cannot allocate PCI registers\n");
223 		return (ENXIO);
224 	}
225 	sc->mfi_btag = rman_get_bustag(sc->mfi_regs_resource);
226 	sc->mfi_bhandle = rman_get_bushandle(sc->mfi_regs_resource);
227 
228 	error = ENOMEM;
229 
230 	/* Allocate parent DMA tag */
231 	if (bus_dma_tag_create(	NULL,			/* parent */
232 				1, 0,			/* algnmnt, boundary */
233 				BUS_SPACE_MAXADDR,	/* lowaddr */
234 				BUS_SPACE_MAXADDR,	/* highaddr */
235 				NULL, NULL,		/* filter, filterarg */
236 				BUS_SPACE_MAXSIZE_32BIT,/* maxsize */
237 				BUS_SPACE_UNRESTRICTED,	/* nsegments */
238 				BUS_SPACE_MAXSIZE_32BIT,/* maxsegsize */
239 				0,			/* flags */
240 				&sc->mfi_parent_dmat)) {
241 		device_printf(dev, "Cannot allocate parent DMA tag\n");
242 		goto out;
243 	}
244 
245 	/* Allocate IRQ resource. */
246 	sc->mfi_irq_rid = 0;
247 	sc->mfi_irq_type = pci_alloc_1intr(sc->mfi_dev, mfi_msi_enable,
248 	    &sc->mfi_irq_rid, &irq_flags);
249 	if ((sc->mfi_irq = bus_alloc_resource_any(sc->mfi_dev, SYS_RES_IRQ,
250 	    &sc->mfi_irq_rid, irq_flags)) == NULL) {
251 		device_printf(sc->mfi_dev, "Cannot allocate interrupt\n");
252 		return (EINVAL);
253 	}
254 
255 	error = mfi_attach(sc);
256 out:
257 	if (error) {
258 		mfi_free(sc);
259 		mfi_pci_free(sc);
260 	}
261 
262 	return (error);
263 }
264 
265 static int
266 mfi_pci_detach(device_t dev)
267 {
268 	struct mfi_softc *sc;
269 	device_t *devlist;
270 	int error, devcount, i;
271 
272 	sc = device_get_softc(dev);
273 
274 	lockmgr(&sc->mfi_config_lock, LK_EXCLUSIVE);
275 	lockmgr(&sc->mfi_io_lock, LK_EXCLUSIVE);
276 	if ((sc->mfi_flags & MFI_FLAGS_OPEN) != 0) {
277 		lockmgr(&sc->mfi_io_lock, LK_RELEASE);
278 		lockmgr(&sc->mfi_config_lock, LK_RELEASE);
279 		return (EBUSY);
280 	}
281 	sc->mfi_detaching = 1;
282 	lockmgr(&sc->mfi_io_lock, LK_RELEASE);
283 
284 	if ((error = device_get_children(sc->mfi_dev, &devlist, &devcount)) != 0) {
285 		lockmgr(&sc->mfi_config_lock, LK_RELEASE);
286 		return error;
287 	}
288 	for (i = 0; i < devcount; i++)
289 		device_delete_child(sc->mfi_dev, devlist[i]);
290 	kfree(devlist, M_TEMP);
291 	lockmgr(&sc->mfi_config_lock, LK_RELEASE);
292 
293 	EVENTHANDLER_DEREGISTER(shutdown_final, sc->mfi_eh);
294 
295 	mfi_shutdown(sc);
296 	mfi_free(sc);
297 	mfi_pci_free(sc);
298 	return (0);
299 }
300 
301 static void
302 mfi_pci_free(struct mfi_softc *sc)
303 {
304 
305 	if (sc->mfi_regs_resource != NULL) {
306 		bus_release_resource(sc->mfi_dev, SYS_RES_MEMORY,
307 		    sc->mfi_regs_rid, sc->mfi_regs_resource);
308 	}
309 	if (sc->mfi_irq_type == PCI_INTR_TYPE_MSI)
310 		pci_release_msi(sc->mfi_dev);
311 }
312 
313 static int
314 mfi_pci_suspend(device_t dev)
315 {
316 
317 	return (EINVAL);
318 }
319 
320 static int
321 mfi_pci_resume(device_t dev)
322 {
323 
324 	return (EINVAL);
325 }
326