xref: /freebsd/sys/dev/sfxge/sfxge.c (revision 44d314f704764f0247a540648a4b4fc3e8012133)
1 /*-
2  * Copyright (c) 2010-2011 Solarflare Communications, Inc.
3  * All rights reserved.
4  *
5  * This software was developed in part by Philip Paeps under contract for
6  * Solarflare Communications, Inc.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 #include <sys/param.h>
34 #include <sys/kernel.h>
35 #include <sys/bus.h>
36 #include <sys/rman.h>
37 #include <sys/lock.h>
38 #include <sys/module.h>
39 #include <sys/mutex.h>
40 #include <sys/smp.h>
41 #include <sys/socket.h>
42 #include <sys/taskqueue.h>
43 #include <sys/sockio.h>
44 #include <sys/sysctl.h>
45 #include <sys/syslog.h>
46 
47 #include <dev/pci/pcireg.h>
48 #include <dev/pci/pcivar.h>
49 
50 #include <net/ethernet.h>
51 #include <net/if.h>
52 #include <net/if_var.h>
53 #include <net/if_media.h>
54 #include <net/if_types.h>
55 
56 #include "common/efx.h"
57 
58 #include "sfxge.h"
59 #include "sfxge_rx.h"
60 #include "sfxge_version.h"
61 
62 #define	SFXGE_CAP (IFCAP_VLAN_MTU | IFCAP_VLAN_HWCSUM |			\
63 		   IFCAP_RXCSUM | IFCAP_TXCSUM |			\
64 		   IFCAP_RXCSUM_IPV6 | IFCAP_TXCSUM_IPV6 |		\
65 		   IFCAP_TSO4 | IFCAP_TSO6 |				\
66 		   IFCAP_JUMBO_MTU |					\
67 		   IFCAP_VLAN_HWTSO | IFCAP_LINKSTATE | IFCAP_HWSTATS)
68 #define	SFXGE_CAP_ENABLE SFXGE_CAP
69 #define	SFXGE_CAP_FIXED (IFCAP_VLAN_MTU |				\
70 			 IFCAP_JUMBO_MTU | IFCAP_LINKSTATE | IFCAP_HWSTATS)
71 
72 MALLOC_DEFINE(M_SFXGE, "sfxge", "Solarflare 10GigE driver");
73 
74 
75 SYSCTL_NODE(_hw, OID_AUTO, sfxge, CTLFLAG_RD, 0,
76 	    "SFXGE driver parameters");
77 
78 #define	SFXGE_PARAM_RX_RING	SFXGE_PARAM(rx_ring)
79 static int sfxge_rx_ring_entries = SFXGE_NDESCS;
80 TUNABLE_INT(SFXGE_PARAM_RX_RING, &sfxge_rx_ring_entries);
81 SYSCTL_INT(_hw_sfxge, OID_AUTO, rx_ring, CTLFLAG_RDTUN,
82 	   &sfxge_rx_ring_entries, 0,
83 	   "Maximum number of descriptors in a receive ring");
84 
85 #define	SFXGE_PARAM_TX_RING	SFXGE_PARAM(tx_ring)
86 static int sfxge_tx_ring_entries = SFXGE_NDESCS;
87 TUNABLE_INT(SFXGE_PARAM_TX_RING, &sfxge_tx_ring_entries);
88 SYSCTL_INT(_hw_sfxge, OID_AUTO, tx_ring, CTLFLAG_RDTUN,
89 	   &sfxge_tx_ring_entries, 0,
90 	   "Maximum number of descriptors in a transmit ring");
91 
92 static void
93 sfxge_reset(void *arg, int npending);
94 
95 static int
96 sfxge_start(struct sfxge_softc *sc)
97 {
98 	int rc;
99 
100 	SFXGE_ADAPTER_LOCK_ASSERT_OWNED(sc);
101 
102 	if (sc->init_state == SFXGE_STARTED)
103 		return (0);
104 
105 	if (sc->init_state != SFXGE_REGISTERED) {
106 		rc = EINVAL;
107 		goto fail;
108 	}
109 
110 	if ((rc = efx_nic_init(sc->enp)) != 0)
111 		goto fail;
112 
113 	/* Start processing interrupts. */
114 	if ((rc = sfxge_intr_start(sc)) != 0)
115 		goto fail2;
116 
117 	/* Start processing events. */
118 	if ((rc = sfxge_ev_start(sc)) != 0)
119 		goto fail3;
120 
121 	/* Start the receiver side. */
122 	if ((rc = sfxge_rx_start(sc)) != 0)
123 		goto fail4;
124 
125 	/* Start the transmitter side. */
126 	if ((rc = sfxge_tx_start(sc)) != 0)
127 		goto fail5;
128 
129 	/* Fire up the port. */
130 	if ((rc = sfxge_port_start(sc)) != 0)
131 		goto fail6;
132 
133 	sc->init_state = SFXGE_STARTED;
134 
135 	/* Tell the stack we're running. */
136 	sc->ifnet->if_drv_flags |= IFF_DRV_RUNNING;
137 	sc->ifnet->if_drv_flags &= ~IFF_DRV_OACTIVE;
138 
139 	return (0);
140 
141 fail6:
142 	sfxge_tx_stop(sc);
143 
144 fail5:
145 	sfxge_rx_stop(sc);
146 
147 fail4:
148 	sfxge_ev_stop(sc);
149 
150 fail3:
151 	sfxge_intr_stop(sc);
152 
153 fail2:
154 	efx_nic_fini(sc->enp);
155 
156 fail:
157 	device_printf(sc->dev, "sfxge_start: %d\n", rc);
158 
159 	return (rc);
160 }
161 
162 static void
163 sfxge_if_init(void *arg)
164 {
165 	struct sfxge_softc *sc;
166 
167 	sc = (struct sfxge_softc *)arg;
168 
169 	SFXGE_ADAPTER_LOCK(sc);
170 	(void)sfxge_start(sc);
171 	SFXGE_ADAPTER_UNLOCK(sc);
172 }
173 
174 static void
175 sfxge_stop(struct sfxge_softc *sc)
176 {
177 	SFXGE_ADAPTER_LOCK_ASSERT_OWNED(sc);
178 
179 	if (sc->init_state != SFXGE_STARTED)
180 		return;
181 
182 	sc->init_state = SFXGE_REGISTERED;
183 
184 	/* Stop the port. */
185 	sfxge_port_stop(sc);
186 
187 	/* Stop the transmitter. */
188 	sfxge_tx_stop(sc);
189 
190 	/* Stop the receiver. */
191 	sfxge_rx_stop(sc);
192 
193 	/* Stop processing events. */
194 	sfxge_ev_stop(sc);
195 
196 	/* Stop processing interrupts. */
197 	sfxge_intr_stop(sc);
198 
199 	efx_nic_fini(sc->enp);
200 
201 	sc->ifnet->if_drv_flags &= ~IFF_DRV_RUNNING;
202 }
203 
204 static int
205 sfxge_if_ioctl(struct ifnet *ifp, unsigned long command, caddr_t data)
206 {
207 	struct sfxge_softc *sc;
208 	struct ifreq *ifr;
209 	int error;
210 
211 	ifr = (struct ifreq *)data;
212 	sc = ifp->if_softc;
213 	error = 0;
214 
215 	switch (command) {
216 	case SIOCSIFFLAGS:
217 		SFXGE_ADAPTER_LOCK(sc);
218 		if (ifp->if_flags & IFF_UP) {
219 			if (ifp->if_drv_flags & IFF_DRV_RUNNING) {
220 				if ((ifp->if_flags ^ sc->if_flags) &
221 				    (IFF_PROMISC | IFF_ALLMULTI)) {
222 					sfxge_mac_filter_set(sc);
223 				}
224 			} else
225 				sfxge_start(sc);
226 		} else
227 			if (ifp->if_drv_flags & IFF_DRV_RUNNING)
228 				sfxge_stop(sc);
229 		sc->if_flags = ifp->if_flags;
230 		SFXGE_ADAPTER_UNLOCK(sc);
231 		break;
232 	case SIOCSIFMTU:
233 		if (ifr->ifr_mtu == ifp->if_mtu) {
234 			/* Nothing to do */
235 			error = 0;
236 		} else if (ifr->ifr_mtu > SFXGE_MAX_MTU) {
237 			error = EINVAL;
238 		} else if (!(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
239 			ifp->if_mtu = ifr->ifr_mtu;
240 			error = 0;
241 		} else {
242 			/* Restart required */
243 			SFXGE_ADAPTER_LOCK(sc);
244 			sfxge_stop(sc);
245 			ifp->if_mtu = ifr->ifr_mtu;
246 			error = sfxge_start(sc);
247 			SFXGE_ADAPTER_UNLOCK(sc);
248 			if (error != 0) {
249 				ifp->if_flags &= ~IFF_UP;
250 				ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
251 				if_down(ifp);
252 			}
253 		}
254 		break;
255 	case SIOCADDMULTI:
256 	case SIOCDELMULTI:
257 		if (ifp->if_drv_flags & IFF_DRV_RUNNING)
258 			sfxge_mac_filter_set(sc);
259 		break;
260 	case SIOCSIFCAP:
261 	{
262 		int reqcap = ifr->ifr_reqcap;
263 		int capchg_mask;
264 
265 		SFXGE_ADAPTER_LOCK(sc);
266 
267 		/* Capabilities to be changed in accordance with request */
268 		capchg_mask = ifp->if_capenable ^ reqcap;
269 
270 		/*
271 		 * The networking core already rejects attempts to
272 		 * enable capabilities we don't have.  We still have
273 		 * to reject attempts to disable capabilities that we
274 		 * can't (yet) disable.
275 		 */
276 		KASSERT((reqcap & ~ifp->if_capabilities) == 0,
277 		    ("Unsupported capabilities %x requested %x vs %x",
278 		     reqcap & ~ifp->if_capabilities,
279 		     reqcap , ifp->if_capabilities));
280 		if (capchg_mask & SFXGE_CAP_FIXED) {
281 			error = EINVAL;
282 			SFXGE_ADAPTER_UNLOCK(sc);
283 			break;
284 		}
285 
286 		/* Check request before any changes */
287 		if ((capchg_mask & IFCAP_TSO4) &&
288 		    (reqcap & (IFCAP_TSO4 | IFCAP_TXCSUM)) == IFCAP_TSO4) {
289 			error = EAGAIN;
290 			SFXGE_ADAPTER_UNLOCK(sc);
291 			if_printf(ifp, "enable txcsum before tso4\n");
292 			break;
293 		}
294 		if ((capchg_mask & IFCAP_TSO6) &&
295 		    (reqcap & (IFCAP_TSO6 | IFCAP_TXCSUM_IPV6)) == IFCAP_TSO6) {
296 			error = EAGAIN;
297 			SFXGE_ADAPTER_UNLOCK(sc);
298 			if_printf(ifp, "enable txcsum6 before tso6\n");
299 			break;
300 		}
301 
302 		if (reqcap & IFCAP_TXCSUM) {
303 			ifp->if_hwassist |= (CSUM_IP | CSUM_TCP | CSUM_UDP);
304 		} else {
305 			ifp->if_hwassist &= ~(CSUM_IP | CSUM_TCP | CSUM_UDP);
306 			if (reqcap & IFCAP_TSO4) {
307 				reqcap &= ~IFCAP_TSO4;
308 				if_printf(ifp,
309 				    "tso4 disabled due to -txcsum\n");
310 			}
311 		}
312 		if (reqcap & IFCAP_TXCSUM_IPV6) {
313 			ifp->if_hwassist |= (CSUM_TCP_IPV6 | CSUM_UDP_IPV6);
314 		} else {
315 			ifp->if_hwassist &= ~(CSUM_TCP_IPV6 | CSUM_UDP_IPV6);
316 			if (reqcap & IFCAP_TSO6) {
317 				reqcap &= ~IFCAP_TSO6;
318 				if_printf(ifp,
319 				    "tso6 disabled due to -txcsum6\n");
320 			}
321 		}
322 
323 		/*
324 		 * The kernel takes both IFCAP_TSOx and CSUM_TSO into
325 		 * account before using TSO. So, we do not touch
326 		 * checksum flags when IFCAP_TSOx is modified.
327 		 * Note that CSUM_TSO is (CSUM_IP_TSO|CSUM_IP6_TSO),
328 		 * but both bits are set in IPv4 and IPv6 mbufs.
329 		 */
330 
331 		ifp->if_capenable = reqcap;
332 
333 		SFXGE_ADAPTER_UNLOCK(sc);
334 		break;
335 	}
336 	case SIOCSIFMEDIA:
337 	case SIOCGIFMEDIA:
338 		error = ifmedia_ioctl(ifp, ifr, &sc->media, command);
339 		break;
340 	default:
341 		error = ether_ioctl(ifp, command, data);
342 	}
343 
344 	return (error);
345 }
346 
347 static void
348 sfxge_ifnet_fini(struct ifnet *ifp)
349 {
350 	struct sfxge_softc *sc = ifp->if_softc;
351 
352 	SFXGE_ADAPTER_LOCK(sc);
353 	sfxge_stop(sc);
354 	SFXGE_ADAPTER_UNLOCK(sc);
355 
356 	ifmedia_removeall(&sc->media);
357 	ether_ifdetach(ifp);
358 	if_free(ifp);
359 }
360 
361 static int
362 sfxge_ifnet_init(struct ifnet *ifp, struct sfxge_softc *sc)
363 {
364 	const efx_nic_cfg_t *encp = efx_nic_cfg_get(sc->enp);
365 	device_t dev;
366 	int rc;
367 
368 	dev = sc->dev;
369 	sc->ifnet = ifp;
370 
371 	if_initname(ifp, device_get_name(dev), device_get_unit(dev));
372 	ifp->if_init = sfxge_if_init;
373 	ifp->if_softc = sc;
374 	ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
375 	ifp->if_ioctl = sfxge_if_ioctl;
376 
377 	ifp->if_capabilities = SFXGE_CAP;
378 	ifp->if_capenable = SFXGE_CAP_ENABLE;
379 
380 #ifdef SFXGE_LRO
381 	ifp->if_capabilities |= IFCAP_LRO;
382 	ifp->if_capenable |= IFCAP_LRO;
383 #endif
384 
385 	ifp->if_hwassist = CSUM_TCP | CSUM_UDP | CSUM_IP | CSUM_TSO |
386 			   CSUM_TCP_IPV6 | CSUM_UDP_IPV6;
387 
388 	ether_ifattach(ifp, encp->enc_mac_addr);
389 
390 	ifp->if_transmit = sfxge_if_transmit;
391 	ifp->if_qflush = sfxge_if_qflush;
392 
393 	ifp->if_get_counter = sfxge_get_counter;
394 
395 	if ((rc = sfxge_port_ifmedia_init(sc)) != 0)
396 		goto fail;
397 
398 	return (0);
399 
400 fail:
401 	ether_ifdetach(sc->ifnet);
402 	return (rc);
403 }
404 
405 void
406 sfxge_sram_buf_tbl_alloc(struct sfxge_softc *sc, size_t n, uint32_t *idp)
407 {
408 	KASSERT(sc->buffer_table_next + n <=
409 		efx_nic_cfg_get(sc->enp)->enc_buftbl_limit,
410 		("buffer table full"));
411 
412 	*idp = sc->buffer_table_next;
413 	sc->buffer_table_next += n;
414 }
415 
416 static int
417 sfxge_bar_init(struct sfxge_softc *sc)
418 {
419 	efsys_bar_t *esbp = &sc->bar;
420 
421 	esbp->esb_rid = PCIR_BAR(EFX_MEM_BAR);
422 	if ((esbp->esb_res = bus_alloc_resource_any(sc->dev, SYS_RES_MEMORY,
423 	    &esbp->esb_rid, RF_ACTIVE)) == NULL) {
424 		device_printf(sc->dev, "Cannot allocate BAR region %d\n",
425 		    EFX_MEM_BAR);
426 		return (ENXIO);
427 	}
428 	esbp->esb_tag = rman_get_bustag(esbp->esb_res);
429 	esbp->esb_handle = rman_get_bushandle(esbp->esb_res);
430 
431 	SFXGE_BAR_LOCK_INIT(esbp, device_get_nameunit(sc->dev));
432 
433 	return (0);
434 }
435 
436 static void
437 sfxge_bar_fini(struct sfxge_softc *sc)
438 {
439 	efsys_bar_t *esbp = &sc->bar;
440 
441 	bus_release_resource(sc->dev, SYS_RES_MEMORY, esbp->esb_rid,
442 	    esbp->esb_res);
443 	SFXGE_BAR_LOCK_DESTROY(esbp);
444 }
445 
446 static int
447 sfxge_create(struct sfxge_softc *sc)
448 {
449 	device_t dev;
450 	efx_nic_t *enp;
451 	int error;
452 	char rss_param_name[sizeof(SFXGE_PARAM(%d.max_rss_channels))];
453 
454 	dev = sc->dev;
455 
456 	SFXGE_ADAPTER_LOCK_INIT(sc, device_get_nameunit(sc->dev));
457 
458 	sc->max_rss_channels = 0;
459 	snprintf(rss_param_name, sizeof(rss_param_name),
460 		 SFXGE_PARAM(%d.max_rss_channels),
461 		 (int)device_get_unit(dev));
462 	TUNABLE_INT_FETCH(rss_param_name, &sc->max_rss_channels);
463 
464 	sc->stats_node = SYSCTL_ADD_NODE(
465 		device_get_sysctl_ctx(dev),
466 		SYSCTL_CHILDREN(device_get_sysctl_tree(dev)),
467 		OID_AUTO, "stats", CTLFLAG_RD, NULL, "Statistics");
468 	if (sc->stats_node == NULL) {
469 		error = ENOMEM;
470 		goto fail;
471 	}
472 
473 	TASK_INIT(&sc->task_reset, 0, sfxge_reset, sc);
474 
475 	(void) pci_enable_busmaster(dev);
476 
477 	/* Initialize DMA mappings. */
478 	if ((error = sfxge_dma_init(sc)) != 0)
479 		goto fail;
480 
481 	/* Map the device registers. */
482 	if ((error = sfxge_bar_init(sc)) != 0)
483 		goto fail;
484 
485 	error = efx_family(pci_get_vendor(dev), pci_get_device(dev),
486 	    &sc->family);
487 	KASSERT(error == 0, ("Family should be filtered by sfxge_probe()"));
488 
489 	/* Create the common code nic object. */
490 	SFXGE_EFSYS_LOCK_INIT(&sc->enp_lock,
491 			      device_get_nameunit(sc->dev), "nic");
492 	if ((error = efx_nic_create(sc->family, (efsys_identifier_t *)sc,
493 	    &sc->bar, &sc->enp_lock, &enp)) != 0)
494 		goto fail3;
495 	sc->enp = enp;
496 
497 	if (!ISP2(sfxge_rx_ring_entries) ||
498 	    !(sfxge_rx_ring_entries & EFX_RXQ_NDESCS_MASK)) {
499 		log(LOG_ERR, "%s=%d must be power of 2 from %u to %u",
500 		    SFXGE_PARAM_RX_RING, sfxge_rx_ring_entries,
501 		    EFX_RXQ_MINNDESCS, EFX_RXQ_MAXNDESCS);
502 		error = EINVAL;
503 		goto fail_rx_ring_entries;
504 	}
505 	sc->rxq_entries = sfxge_rx_ring_entries;
506 
507 	if (!ISP2(sfxge_tx_ring_entries) ||
508 	    !(sfxge_tx_ring_entries & EFX_TXQ_NDESCS_MASK)) {
509 		log(LOG_ERR, "%s=%d must be power of 2 from %u to %u",
510 		    SFXGE_PARAM_TX_RING, sfxge_tx_ring_entries,
511 		    EFX_TXQ_MINNDESCS, EFX_TXQ_MAXNDESCS);
512 		error = EINVAL;
513 		goto fail_tx_ring_entries;
514 	}
515 	sc->txq_entries = sfxge_tx_ring_entries;
516 
517 	/* Initialize MCDI to talk to the microcontroller. */
518 	if ((error = sfxge_mcdi_init(sc)) != 0)
519 		goto fail4;
520 
521 	/* Probe the NIC and build the configuration data area. */
522 	if ((error = efx_nic_probe(enp)) != 0)
523 		goto fail5;
524 
525 	SYSCTL_ADD_STRING(device_get_sysctl_ctx(dev),
526 			  SYSCTL_CHILDREN(device_get_sysctl_tree(dev)),
527 			  OID_AUTO, "version", CTLFLAG_RD,
528 			  SFXGE_VERSION_STRING, 0,
529 			  "Driver version");
530 
531 	/* Initialize the NVRAM. */
532 	if ((error = efx_nvram_init(enp)) != 0)
533 		goto fail6;
534 
535 	/* Initialize the VPD. */
536 	if ((error = efx_vpd_init(enp)) != 0)
537 		goto fail7;
538 
539 	/* Reset the NIC. */
540 	if ((error = efx_nic_reset(enp)) != 0)
541 		goto fail8;
542 
543 	/* Initialize buffer table allocation. */
544 	sc->buffer_table_next = 0;
545 
546 	/* Set up interrupts. */
547 	if ((error = sfxge_intr_init(sc)) != 0)
548 		goto fail8;
549 
550 	/* Initialize event processing state. */
551 	if ((error = sfxge_ev_init(sc)) != 0)
552 		goto fail11;
553 
554 	/* Initialize receive state. */
555 	if ((error = sfxge_rx_init(sc)) != 0)
556 		goto fail12;
557 
558 	/* Initialize transmit state. */
559 	if ((error = sfxge_tx_init(sc)) != 0)
560 		goto fail13;
561 
562 	/* Initialize port state. */
563 	if ((error = sfxge_port_init(sc)) != 0)
564 		goto fail14;
565 
566 	sc->init_state = SFXGE_INITIALIZED;
567 
568 	return (0);
569 
570 fail14:
571 	sfxge_tx_fini(sc);
572 
573 fail13:
574 	sfxge_rx_fini(sc);
575 
576 fail12:
577 	sfxge_ev_fini(sc);
578 
579 fail11:
580 	sfxge_intr_fini(sc);
581 
582 fail8:
583 	efx_vpd_fini(enp);
584 
585 fail7:
586 	efx_nvram_fini(enp);
587 
588 fail6:
589 	efx_nic_unprobe(enp);
590 
591 fail5:
592 	sfxge_mcdi_fini(sc);
593 
594 fail4:
595 fail_tx_ring_entries:
596 fail_rx_ring_entries:
597 	sc->enp = NULL;
598 	efx_nic_destroy(enp);
599 	SFXGE_EFSYS_LOCK_DESTROY(&sc->enp_lock);
600 
601 fail3:
602 	sfxge_bar_fini(sc);
603 	(void) pci_disable_busmaster(sc->dev);
604 
605 fail:
606 	sc->dev = NULL;
607 	SFXGE_ADAPTER_LOCK_DESTROY(sc);
608 	return (error);
609 }
610 
611 static void
612 sfxge_destroy(struct sfxge_softc *sc)
613 {
614 	efx_nic_t *enp;
615 
616 	/* Clean up port state. */
617 	sfxge_port_fini(sc);
618 
619 	/* Clean up transmit state. */
620 	sfxge_tx_fini(sc);
621 
622 	/* Clean up receive state. */
623 	sfxge_rx_fini(sc);
624 
625 	/* Clean up event processing state. */
626 	sfxge_ev_fini(sc);
627 
628 	/* Clean up interrupts. */
629 	sfxge_intr_fini(sc);
630 
631 	/* Tear down common code subsystems. */
632 	efx_nic_reset(sc->enp);
633 	efx_vpd_fini(sc->enp);
634 	efx_nvram_fini(sc->enp);
635 	efx_nic_unprobe(sc->enp);
636 
637 	/* Tear down MCDI. */
638 	sfxge_mcdi_fini(sc);
639 
640 	/* Destroy common code context. */
641 	enp = sc->enp;
642 	sc->enp = NULL;
643 	efx_nic_destroy(enp);
644 
645 	/* Free DMA memory. */
646 	sfxge_dma_fini(sc);
647 
648 	/* Free mapped BARs. */
649 	sfxge_bar_fini(sc);
650 
651 	(void) pci_disable_busmaster(sc->dev);
652 
653 	taskqueue_drain(taskqueue_thread, &sc->task_reset);
654 
655 	/* Destroy the softc lock. */
656 	SFXGE_ADAPTER_LOCK_DESTROY(sc);
657 }
658 
659 static int
660 sfxge_vpd_handler(SYSCTL_HANDLER_ARGS)
661 {
662 	struct sfxge_softc *sc = arg1;
663 	efx_vpd_value_t value;
664 	int rc;
665 
666 	value.evv_tag = arg2 >> 16;
667 	value.evv_keyword = arg2 & 0xffff;
668 	if ((rc = efx_vpd_get(sc->enp, sc->vpd_data, sc->vpd_size, &value))
669 	    != 0)
670 		return (rc);
671 
672 	return (SYSCTL_OUT(req, value.evv_value, value.evv_length));
673 }
674 
675 static void
676 sfxge_vpd_try_add(struct sfxge_softc *sc, struct sysctl_oid_list *list,
677 		  efx_vpd_tag_t tag, const char *keyword)
678 {
679 	struct sysctl_ctx_list *ctx = device_get_sysctl_ctx(sc->dev);
680 	efx_vpd_value_t value;
681 
682 	/* Check whether VPD tag/keyword is present */
683 	value.evv_tag = tag;
684 	value.evv_keyword = EFX_VPD_KEYWORD(keyword[0], keyword[1]);
685 	if (efx_vpd_get(sc->enp, sc->vpd_data, sc->vpd_size, &value) != 0)
686 		return;
687 
688 	SYSCTL_ADD_PROC(
689 		ctx, list, OID_AUTO, keyword, CTLTYPE_STRING|CTLFLAG_RD,
690 		sc, tag << 16 | EFX_VPD_KEYWORD(keyword[0], keyword[1]),
691 		sfxge_vpd_handler, "A", "");
692 }
693 
694 static int
695 sfxge_vpd_init(struct sfxge_softc *sc)
696 {
697 	struct sysctl_ctx_list *ctx = device_get_sysctl_ctx(sc->dev);
698 	struct sysctl_oid *vpd_node;
699 	struct sysctl_oid_list *vpd_list;
700 	char keyword[3];
701 	efx_vpd_value_t value;
702 	int rc;
703 
704 	if ((rc = efx_vpd_size(sc->enp, &sc->vpd_size)) != 0)
705 		goto fail;
706 	sc->vpd_data = malloc(sc->vpd_size, M_SFXGE, M_WAITOK);
707 	if ((rc = efx_vpd_read(sc->enp, sc->vpd_data, sc->vpd_size)) != 0)
708 		goto fail2;
709 
710 	/* Copy ID (product name) into device description, and log it. */
711 	value.evv_tag = EFX_VPD_ID;
712 	if (efx_vpd_get(sc->enp, sc->vpd_data, sc->vpd_size, &value) == 0) {
713 		value.evv_value[value.evv_length] = 0;
714 		device_set_desc_copy(sc->dev, value.evv_value);
715 		device_printf(sc->dev, "%s\n", value.evv_value);
716 	}
717 
718 	vpd_node = SYSCTL_ADD_NODE(
719 		ctx, SYSCTL_CHILDREN(device_get_sysctl_tree(sc->dev)),
720 		OID_AUTO, "vpd", CTLFLAG_RD, NULL, "Vital Product Data");
721 	vpd_list = SYSCTL_CHILDREN(vpd_node);
722 
723 	/* Add sysctls for all expected and any vendor-defined keywords. */
724 	sfxge_vpd_try_add(sc, vpd_list, EFX_VPD_RO, "PN");
725 	sfxge_vpd_try_add(sc, vpd_list, EFX_VPD_RO, "EC");
726 	sfxge_vpd_try_add(sc, vpd_list, EFX_VPD_RO, "SN");
727 	keyword[0] = 'V';
728 	keyword[2] = 0;
729 	for (keyword[1] = '0'; keyword[1] <= '9'; keyword[1]++)
730 		sfxge_vpd_try_add(sc, vpd_list, EFX_VPD_RO, keyword);
731 	for (keyword[1] = 'A'; keyword[1] <= 'Z'; keyword[1]++)
732 		sfxge_vpd_try_add(sc, vpd_list, EFX_VPD_RO, keyword);
733 
734 	return (0);
735 
736 fail2:
737 	free(sc->vpd_data, M_SFXGE);
738 fail:
739 	return (rc);
740 }
741 
742 static void
743 sfxge_vpd_fini(struct sfxge_softc *sc)
744 {
745 	free(sc->vpd_data, M_SFXGE);
746 }
747 
748 static void
749 sfxge_reset(void *arg, int npending)
750 {
751 	struct sfxge_softc *sc;
752 	int rc;
753 
754 	(void)npending;
755 
756 	sc = (struct sfxge_softc *)arg;
757 
758 	SFXGE_ADAPTER_LOCK(sc);
759 
760 	if (sc->init_state != SFXGE_STARTED)
761 		goto done;
762 
763 	sfxge_stop(sc);
764 	efx_nic_reset(sc->enp);
765 	if ((rc = sfxge_start(sc)) != 0)
766 		device_printf(sc->dev,
767 			      "reset failed (%d); interface is now stopped\n",
768 			      rc);
769 
770 done:
771 	SFXGE_ADAPTER_UNLOCK(sc);
772 }
773 
774 void
775 sfxge_schedule_reset(struct sfxge_softc *sc)
776 {
777 	taskqueue_enqueue(taskqueue_thread, &sc->task_reset);
778 }
779 
780 static int
781 sfxge_attach(device_t dev)
782 {
783 	struct sfxge_softc *sc;
784 	struct ifnet *ifp;
785 	int error;
786 
787 	sc = device_get_softc(dev);
788 	sc->dev = dev;
789 
790 	/* Allocate ifnet. */
791 	ifp = if_alloc(IFT_ETHER);
792 	if (ifp == NULL) {
793 		device_printf(dev, "Couldn't allocate ifnet\n");
794 		error = ENOMEM;
795 		goto fail;
796 	}
797 	sc->ifnet = ifp;
798 
799 	/* Initialize hardware. */
800 	if ((error = sfxge_create(sc)) != 0)
801 		goto fail2;
802 
803 	/* Create the ifnet for the port. */
804 	if ((error = sfxge_ifnet_init(ifp, sc)) != 0)
805 		goto fail3;
806 
807 	if ((error = sfxge_vpd_init(sc)) != 0)
808 		goto fail4;
809 
810 	sc->init_state = SFXGE_REGISTERED;
811 
812 	return (0);
813 
814 fail4:
815 	sfxge_ifnet_fini(ifp);
816 fail3:
817 	sfxge_destroy(sc);
818 
819 fail2:
820 	if_free(sc->ifnet);
821 
822 fail:
823 	return (error);
824 }
825 
826 static int
827 sfxge_detach(device_t dev)
828 {
829 	struct sfxge_softc *sc;
830 
831 	sc = device_get_softc(dev);
832 
833 	sfxge_vpd_fini(sc);
834 
835 	/* Destroy the ifnet. */
836 	sfxge_ifnet_fini(sc->ifnet);
837 
838 	/* Tear down hardware. */
839 	sfxge_destroy(sc);
840 
841 	return (0);
842 }
843 
844 static int
845 sfxge_probe(device_t dev)
846 {
847 	uint16_t pci_vendor_id;
848 	uint16_t pci_device_id;
849 	efx_family_t family;
850 	int rc;
851 
852 	pci_vendor_id = pci_get_vendor(dev);
853 	pci_device_id = pci_get_device(dev);
854 
855 	rc = efx_family(pci_vendor_id, pci_device_id, &family);
856 	if (rc != 0)
857 		return (ENXIO);
858 
859 	KASSERT(family == EFX_FAMILY_SIENA, ("impossible controller family"));
860 	device_set_desc(dev, "Solarflare SFC9000 family");
861 	return (0);
862 }
863 
864 static device_method_t sfxge_methods[] = {
865 	DEVMETHOD(device_probe,		sfxge_probe),
866 	DEVMETHOD(device_attach,	sfxge_attach),
867 	DEVMETHOD(device_detach,	sfxge_detach),
868 
869 	DEVMETHOD_END
870 };
871 
872 static devclass_t sfxge_devclass;
873 
874 static driver_t sfxge_driver = {
875 	"sfxge",
876 	sfxge_methods,
877 	sizeof(struct sfxge_softc)
878 };
879 
880 DRIVER_MODULE(sfxge, pci, sfxge_driver, sfxge_devclass, 0, 0);
881