xref: /freebsd/sys/dev/mfi/mfi_pci.c (revision 52267f7411adcc76ede961420e08c0e42f42d415)
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/uio.h>
70 
71 #include <machine/bus.h>
72 #include <machine/resource.h>
73 #include <sys/rman.h>
74 
75 #include <dev/pci/pcireg.h>
76 #include <dev/pci/pcivar.h>
77 
78 #include <dev/mfi/mfireg.h>
79 #include <dev/mfi/mfi_ioctl.h>
80 #include <dev/mfi/mfivar.h>
81 
82 static int	mfi_pci_probe(device_t);
83 static int	mfi_pci_attach(device_t);
84 static int	mfi_pci_detach(device_t);
85 static int	mfi_pci_suspend(device_t);
86 static int	mfi_pci_resume(device_t);
87 static void	mfi_pci_free(struct mfi_softc *);
88 
89 static device_method_t mfi_methods[] = {
90 	DEVMETHOD(device_probe,		mfi_pci_probe),
91 	DEVMETHOD(device_attach,	mfi_pci_attach),
92 	DEVMETHOD(device_detach,	mfi_pci_detach),
93 	DEVMETHOD(device_suspend,	mfi_pci_suspend),
94 	DEVMETHOD(device_resume,	mfi_pci_resume),
95 	DEVMETHOD(bus_print_child,	bus_generic_print_child),
96 	DEVMETHOD(bus_driver_added,	bus_generic_driver_added),
97 	{ 0, 0 }
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 
109 struct mfi_ident {
110 	uint16_t	vendor;
111 	uint16_t	device;
112 	uint16_t	subvendor;
113 	uint16_t	subdevice;
114 	int		flags;
115 	const char	*desc;
116 } mfi_identifiers[] = {
117 	{0x1000, 0x0411, 0xffff, 0xffff, MFI_FLAGS_1064R, "LSI MegaSAS 1064R"}, /* Brocton IOP */
118 	{0x1000, 0x0413, 0xffff, 0xffff, MFI_FLAGS_1064R, "LSI MegaSAS 1064R"}, /* Verde ZCR */
119 	{0x1028, 0x0015, 0xffff, 0xffff, MFI_FLAGS_1064R, "Dell PERC 5/i"},
120 	{0x1000, 0x0060, 0x1028, 0xffff, MFI_FLAGS_1078,  "Dell PERC 6"},
121  	{0x1000, 0x0060, 0xffff, 0xffff, MFI_FLAGS_1078,  "LSI MegaSAS 1078"},
122 	{0x1000, 0x0079, 0x1028, 0x1f15, MFI_FLAGS_GEN2,  "Dell PERC 607E Adapter"},
123 	{0x1000, 0x0079, 0x1028, 0x1f16, MFI_FLAGS_GEN2,  "Dell PERC 607I Adapter"},
124 	{0x1000, 0x0079, 0x1028, 0x1f17, MFI_FLAGS_GEN2,  "Dell PERC 607I Integrated"},
125 	{0x1000, 0x0079, 0x1028, 0x1f18, MFI_FLAGS_GEN2,  "Dell PERC 607I Modular"},
126 	{0x1000, 0x0078, 0xffff, 0xffff, MFI_FLAGS_GEN2,  "LSI MegaSAS Gen2"},
127 	{0x1000, 0x0079, 0xffff, 0xffff, MFI_FLAGS_GEN2,  "LSI MegaSAS Gen2"},
128 	{0x1000, 0x007c, 0xffff, 0xffff, MFI_FLAGS_1078,  "LSI MegaSAS 1078"},
129 	{0, 0, 0, 0, 0, NULL}
130 };
131 
132 static struct mfi_ident *
133 mfi_find_ident(device_t dev)
134 {
135 	struct mfi_ident *m;
136 
137 	for (m = mfi_identifiers; m->vendor != 0; m++) {
138 		if ((m->vendor == pci_get_vendor(dev)) &&
139 		    (m->device == pci_get_device(dev)) &&
140 		    ((m->subvendor == pci_get_subvendor(dev)) ||
141 		    (m->subvendor == 0xffff)) &&
142 		    ((m->subdevice == pci_get_subdevice(dev)) ||
143 		    (m->subdevice == 0xffff)))
144 			return (m);
145 	}
146 
147 	return (NULL);
148 }
149 
150 static int
151 mfi_pci_probe(device_t dev)
152 {
153 	struct mfi_ident *id;
154 
155 	if ((id = mfi_find_ident(dev)) != NULL) {
156 		device_set_desc(dev, id->desc);
157 		return (BUS_PROBE_DEFAULT);
158 	}
159 	return (ENXIO);
160 }
161 
162 static int
163 mfi_pci_attach(device_t dev)
164 {
165 	struct mfi_softc *sc;
166 	struct mfi_ident *m;
167 	uint32_t command;
168 	int error;
169 
170 	sc = device_get_softc(dev);
171 	bzero(sc, sizeof(*sc));
172 	sc->mfi_dev = dev;
173 	m = mfi_find_ident(dev);
174 	sc->mfi_flags = m->flags;
175 
176 	/* Verify that the adapter can be set up in PCI space */
177 	command = pci_read_config(dev, PCIR_COMMAND, 2);
178 	command |= PCIM_CMD_BUSMASTEREN;
179 	pci_write_config(dev, PCIR_COMMAND, command, 2);
180 	command = pci_read_config(dev, PCIR_COMMAND, 2);
181 	if ((command & PCIM_CMD_BUSMASTEREN) == 0) {
182 		device_printf(dev, "Can't enable PCI busmaster\n");
183 		return (ENXIO);
184 	}
185 	if ((command & PCIM_CMD_MEMEN) == 0) {
186 		device_printf(dev, "PCI memory window not available\n");
187 		return (ENXIO);
188 	}
189 
190 	/* Allocate PCI registers */
191 	if ((sc->mfi_flags & MFI_FLAGS_1064R) ||
192 	    (sc->mfi_flags & MFI_FLAGS_1078)) {
193 		/* 1068/1078: Memory mapped BAR is at offset 0x10 */
194 		sc->mfi_regs_rid = PCIR_BAR(0);
195 	} else if (sc->mfi_flags & MFI_FLAGS_GEN2) {
196 		/* GEN2: Memory mapped BAR is at offset 0x14 */
197 		sc->mfi_regs_rid = PCIR_BAR(1);
198 	}
199 	if ((sc->mfi_regs_resource = bus_alloc_resource_any(sc->mfi_dev,
200 	    SYS_RES_MEMORY, &sc->mfi_regs_rid, RF_ACTIVE)) == NULL) {
201 		device_printf(dev, "Cannot allocate PCI registers\n");
202 		return (ENXIO);
203 	}
204 	sc->mfi_btag = rman_get_bustag(sc->mfi_regs_resource);
205 	sc->mfi_bhandle = rman_get_bushandle(sc->mfi_regs_resource);
206 
207 	error = ENOMEM;
208 
209 	/* Allocate parent DMA tag */
210 	if (bus_dma_tag_create(	NULL,			/* parent */
211 				1, 0,			/* algnmnt, boundary */
212 				BUS_SPACE_MAXADDR,	/* lowaddr */
213 				BUS_SPACE_MAXADDR,	/* highaddr */
214 				NULL, NULL,		/* filter, filterarg */
215 				BUS_SPACE_MAXSIZE_32BIT,/* maxsize */
216 				BUS_SPACE_UNRESTRICTED,	/* nsegments */
217 				BUS_SPACE_MAXSIZE_32BIT,/* maxsegsize */
218 				0,			/* flags */
219 				NULL, NULL,		/* lockfunc, lockarg */
220 				&sc->mfi_parent_dmat)) {
221 		device_printf(dev, "Cannot allocate parent DMA tag\n");
222 		goto out;
223 	}
224 
225 	error = mfi_attach(sc);
226 out:
227 	if (error) {
228 		mfi_free(sc);
229 		mfi_pci_free(sc);
230 	}
231 
232 	return (error);
233 }
234 
235 static int
236 mfi_pci_detach(device_t dev)
237 {
238 	struct mfi_softc *sc;
239 	struct mfi_disk *ld;
240 	int error;
241 
242 	sc = device_get_softc(dev);
243 
244 	sx_xlock(&sc->mfi_config_lock);
245 	mtx_lock(&sc->mfi_io_lock);
246 	if ((sc->mfi_flags & MFI_FLAGS_OPEN) != 0) {
247 		mtx_unlock(&sc->mfi_io_lock);
248 		sx_xunlock(&sc->mfi_config_lock);
249 		return (EBUSY);
250 	}
251 	sc->mfi_detaching = 1;
252 	mtx_unlock(&sc->mfi_io_lock);
253 
254 	while ((ld = TAILQ_FIRST(&sc->mfi_ld_tqh)) != NULL) {
255 		if ((error = device_delete_child(dev, ld->ld_dev)) != 0) {
256 			sc->mfi_detaching = 0;
257 			sx_xunlock(&sc->mfi_config_lock);
258 			return (error);
259 		}
260 	}
261 	sx_xunlock(&sc->mfi_config_lock);
262 
263 	EVENTHANDLER_DEREGISTER(shutdown_final, sc->mfi_eh);
264 
265 	mfi_shutdown(sc);
266 	mfi_free(sc);
267 	mfi_pci_free(sc);
268 	return (0);
269 }
270 
271 static void
272 mfi_pci_free(struct mfi_softc *sc)
273 {
274 
275 	if (sc->mfi_regs_resource != NULL) {
276 		bus_release_resource(sc->mfi_dev, SYS_RES_MEMORY,
277 		    sc->mfi_regs_rid, sc->mfi_regs_resource);
278 	}
279 
280 	return;
281 }
282 
283 static int
284 mfi_pci_suspend(device_t dev)
285 {
286 
287 	return (EINVAL);
288 }
289 
290 static int
291 mfi_pci_resume(device_t dev)
292 {
293 
294 	return (EINVAL);
295 }
296