xref: /freebsd/sys/dev/sfxge/sfxge.h (revision 15c433351f54e7cd5bec8d36c8e89e6a7fa55b26)
1 /*-
2  * Copyright (c) 2010-2015 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 are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice,
12  *    this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright notice,
14  *    this list of conditions and the following disclaimer in the documentation
15  *    and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
19  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
24  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
27  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * The views and conclusions contained in the software and documentation are
30  * those of the authors and should not be interpreted as representing official
31  * policies, either expressed or implied, of the FreeBSD Project.
32  *
33  * $FreeBSD$
34  */
35 
36 #ifndef _SFXGE_H
37 #define	_SFXGE_H
38 
39 #include <sys/param.h>
40 #include <sys/kernel.h>
41 #include <sys/socket.h>
42 #include <sys/sysctl.h>
43 #include <sys/sx.h>
44 #include <vm/uma.h>
45 
46 #include <net/ethernet.h>
47 #include <net/if.h>
48 #include <net/if_var.h>
49 #include <net/if_media.h>
50 #include <net/if_types.h>
51 
52 #include "sfxge_ioc.h"
53 
54 /*
55  * Debugging
56  */
57 #if 0
58 #define	DBGPRINT(dev, fmt, args...) \
59 	device_printf(dev, "%s: " fmt "\n", __func__, ## args)
60 #else
61 #define	DBGPRINT(dev, fmt, args...)
62 #endif
63 
64 /*
65  * Backward-compatibility
66  */
67 #ifndef CACHE_LINE_SIZE
68 /* This should be right on most machines the driver will be used on, and
69  * we needn't care too much about wasting a few KB per interface.
70  */
71 #define	CACHE_LINE_SIZE 128
72 #endif
73 
74 #ifndef IFCAP_LINKSTATE
75 #define	IFCAP_LINKSTATE 0
76 #endif
77 
78 #ifndef IFCAP_VLAN_HWTSO
79 #define	IFCAP_VLAN_HWTSO 0
80 #endif
81 
82 #ifndef IFM_10G_T
83 #define	IFM_10G_T IFM_UNKNOWN
84 #endif
85 
86 #ifndef IFM_10G_KX4
87 #define	IFM_10G_KX4 IFM_10G_CX4
88 #endif
89 
90 #ifndef IFM_40G_CR4
91 #define	IFM_40G_CR4 IFM_UNKNOWN
92 #endif
93 
94 #if (__FreeBSD_version >= 800501 && __FreeBSD_version < 900000) || \
95 	__FreeBSD_version >= 900003
96 #define	SFXGE_HAVE_DESCRIBE_INTR
97 #endif
98 
99 #ifdef IFM_ETH_RXPAUSE
100 #define	SFXGE_HAVE_PAUSE_MEDIAOPTS
101 #endif
102 
103 #ifndef CTLTYPE_U64
104 #define	CTLTYPE_U64 CTLTYPE_QUAD
105 #endif
106 
107 #include "sfxge_rx.h"
108 #include "sfxge_tx.h"
109 
110 #define	ROUNDUP_POW_OF_TWO(_n)	(1ULL << flsl((_n) - 1))
111 
112 #define	SFXGE_IP_ALIGN	2
113 
114 #define	SFXGE_ETHERTYPE_LOOPBACK	0x9000	/* Xerox loopback */
115 
116 enum sfxge_evq_state {
117 	SFXGE_EVQ_UNINITIALIZED = 0,
118 	SFXGE_EVQ_INITIALIZED,
119 	SFXGE_EVQ_STARTING,
120 	SFXGE_EVQ_STARTED
121 };
122 
123 #define	SFXGE_EV_BATCH	16384
124 
125 struct sfxge_evq {
126 	/* Structure members below are sorted by usage order */
127 	struct sfxge_softc	*sc;
128 	struct mtx		lock;
129 	unsigned int		index;
130 	enum sfxge_evq_state	init_state;
131 	efsys_mem_t		mem;
132 	efx_evq_t		*common;
133 	unsigned int		read_ptr;
134 	boolean_t		exception;
135 	unsigned int		rx_done;
136 	unsigned int		tx_done;
137 
138 	/* Linked list of TX queues with completions to process */
139 	struct sfxge_txq	*txq;
140 	struct sfxge_txq	**txqs;
141 
142 	/* Structure members not used on event processing path */
143 	unsigned int		buf_base_id;
144 	unsigned int		entries;
145 	char			lock_name[SFXGE_LOCK_NAME_MAX];
146 } __aligned(CACHE_LINE_SIZE);
147 
148 #define	SFXGE_NDESCS	1024
149 #define	SFXGE_MODERATION	30
150 
151 enum sfxge_intr_state {
152 	SFXGE_INTR_UNINITIALIZED = 0,
153 	SFXGE_INTR_INITIALIZED,
154 	SFXGE_INTR_TESTING,
155 	SFXGE_INTR_STARTED
156 };
157 
158 struct sfxge_intr_hdl {
159 	int			eih_rid;
160 	void			*eih_tag;
161 	struct resource		*eih_res;
162 };
163 
164 struct sfxge_intr {
165 	enum sfxge_intr_state	state;
166 	struct resource		*msix_res;
167 	struct sfxge_intr_hdl	*table;
168 	int			n_alloc;
169 	int			type;
170 	efsys_mem_t		status;
171 	uint32_t		zero_count;
172 };
173 
174 enum sfxge_mcdi_state {
175 	SFXGE_MCDI_UNINITIALIZED = 0,
176 	SFXGE_MCDI_INITIALIZED,
177 	SFXGE_MCDI_BUSY,
178 	SFXGE_MCDI_COMPLETED
179 };
180 
181 struct sfxge_mcdi {
182 	struct mtx		lock;
183 	efsys_mem_t		mem;
184 	enum sfxge_mcdi_state	state;
185 	efx_mcdi_transport_t	transport;
186 
187 	/* Only used in debugging output */
188 	char			lock_name[SFXGE_LOCK_NAME_MAX];
189 };
190 
191 struct sfxge_hw_stats {
192 	clock_t			update_time;
193 	efsys_mem_t		dma_buf;
194 	void			*decode_buf;
195 };
196 
197 enum sfxge_port_state {
198 	SFXGE_PORT_UNINITIALIZED = 0,
199 	SFXGE_PORT_INITIALIZED,
200 	SFXGE_PORT_STARTED
201 };
202 
203 struct sfxge_port {
204 	struct sfxge_softc	*sc;
205 	struct mtx		lock;
206 	enum sfxge_port_state	init_state;
207 #ifndef SFXGE_HAVE_PAUSE_MEDIAOPTS
208 	unsigned int		wanted_fc;
209 #endif
210 	struct sfxge_hw_stats	phy_stats;
211 	struct sfxge_hw_stats	mac_stats;
212 	efx_link_mode_t		link_mode;
213 	uint8_t			mcast_addrs[EFX_MAC_MULTICAST_LIST_MAX *
214 					    EFX_MAC_ADDR_LEN];
215 	unsigned int		mcast_count;
216 
217 	/* Only used in debugging output */
218 	char			lock_name[SFXGE_LOCK_NAME_MAX];
219 };
220 
221 enum sfxge_softc_state {
222 	SFXGE_UNINITIALIZED = 0,
223 	SFXGE_INITIALIZED,
224 	SFXGE_REGISTERED,
225 	SFXGE_STARTED
226 };
227 
228 struct sfxge_softc {
229 	device_t			dev;
230 	struct sx			softc_lock;
231 	char				softc_lock_name[SFXGE_LOCK_NAME_MAX];
232 	enum sfxge_softc_state		init_state;
233 	struct ifnet			*ifnet;
234 	unsigned int			if_flags;
235 	struct sysctl_oid		*stats_node;
236 	struct sysctl_oid		*txqs_node;
237 
238 	struct task			task_reset;
239 
240 	efx_family_t			family;
241 	caddr_t				vpd_data;
242 	size_t				vpd_size;
243 	efx_nic_t			*enp;
244 	efsys_lock_t			enp_lock;
245 
246 	unsigned int			rxq_entries;
247 	unsigned int			txq_entries;
248 
249 	bus_dma_tag_t			parent_dma_tag;
250 	efsys_bar_t			bar;
251 
252 	struct sfxge_intr		intr;
253 	struct sfxge_mcdi		mcdi;
254 	struct sfxge_port		port;
255 	uint32_t			buffer_table_next;
256 
257 	struct sfxge_evq		*evq[SFXGE_RX_SCALE_MAX];
258 	unsigned int			ev_moderation;
259 #if EFSYS_OPT_QSTATS
260 	clock_t				ev_stats_update_time;
261 	uint64_t			ev_stats[EV_NQSTATS];
262 #endif
263 
264 	unsigned int			max_rss_channels;
265 	uma_zone_t			rxq_cache;
266 	struct sfxge_rxq		*rxq[SFXGE_RX_SCALE_MAX];
267 	unsigned int			rx_indir_table[SFXGE_RX_SCALE_MAX];
268 
269 	struct sfxge_txq		*txq[SFXGE_TXQ_NTYPES + SFXGE_RX_SCALE_MAX];
270 
271 	struct ifmedia			media;
272 
273 	size_t				rx_prefix_size;
274 	size_t				rx_buffer_size;
275 	size_t				rx_buffer_align;
276 	int				rx_cluster_size;
277 
278 	unsigned int			evq_max;
279 	unsigned int			evq_count;
280 	unsigned int			rxq_count;
281 	unsigned int			txq_count;
282 
283 	unsigned int			tso_fw_assisted;
284 #define	SFXGE_FATSOV1	(1 << 0)
285 #define	SFXGE_FATSOV2	(1 << 1)
286 
287 #if EFSYS_OPT_MCDI_LOGGING
288 	int				mcdi_logging;
289 #endif
290 };
291 
292 #define	SFXGE_LINK_UP(sc) ((sc)->port.link_mode != EFX_LINK_DOWN)
293 #define	SFXGE_RUNNING(sc) ((sc)->ifnet->if_drv_flags & IFF_DRV_RUNNING)
294 
295 #define	SFXGE_PARAM(_name)	"hw.sfxge." #_name
296 
297 SYSCTL_DECL(_hw_sfxge);
298 
299 /*
300  * From sfxge.c.
301  */
302 extern void sfxge_schedule_reset(struct sfxge_softc *sc);
303 extern void sfxge_sram_buf_tbl_alloc(struct sfxge_softc *sc, size_t n,
304 				     uint32_t *idp);
305 
306 /*
307  * From sfxge_dma.c.
308  */
309 extern int sfxge_dma_init(struct sfxge_softc *sc);
310 extern void sfxge_dma_fini(struct sfxge_softc *sc);
311 extern int sfxge_dma_alloc(struct sfxge_softc *sc, bus_size_t len,
312 			   efsys_mem_t *esmp);
313 extern void sfxge_dma_free(efsys_mem_t *esmp);
314 extern int sfxge_dma_map_sg_collapse(bus_dma_tag_t tag, bus_dmamap_t map,
315 				     struct mbuf **mp,
316 				     bus_dma_segment_t *segs,
317 				     int *nsegs, int maxsegs);
318 
319 /*
320  * From sfxge_ev.c.
321  */
322 extern int sfxge_ev_init(struct sfxge_softc *sc);
323 extern void sfxge_ev_fini(struct sfxge_softc *sc);
324 extern int sfxge_ev_start(struct sfxge_softc *sc);
325 extern void sfxge_ev_stop(struct sfxge_softc *sc);
326 extern int sfxge_ev_qpoll(struct sfxge_evq *evq);
327 
328 /*
329  * From sfxge_intr.c.
330  */
331 extern int sfxge_intr_init(struct sfxge_softc *sc);
332 extern void sfxge_intr_fini(struct sfxge_softc *sc);
333 extern int sfxge_intr_start(struct sfxge_softc *sc);
334 extern void sfxge_intr_stop(struct sfxge_softc *sc);
335 
336 /*
337  * From sfxge_mcdi.c.
338  */
339 extern int sfxge_mcdi_init(struct sfxge_softc *sc);
340 extern void sfxge_mcdi_fini(struct sfxge_softc *sc);
341 extern int sfxge_mcdi_ioctl(struct sfxge_softc *sc, sfxge_ioc_t *ip);
342 
343 /*
344  * From sfxge_nvram.c.
345  */
346 extern int sfxge_nvram_ioctl(struct sfxge_softc *sc, sfxge_ioc_t *ip);
347 
348 /*
349  * From sfxge_port.c.
350  */
351 extern int sfxge_port_init(struct sfxge_softc *sc);
352 extern void sfxge_port_fini(struct sfxge_softc *sc);
353 extern int sfxge_port_start(struct sfxge_softc *sc);
354 extern void sfxge_port_stop(struct sfxge_softc *sc);
355 extern void sfxge_mac_link_update(struct sfxge_softc *sc,
356 				  efx_link_mode_t mode);
357 extern int sfxge_mac_filter_set(struct sfxge_softc *sc);
358 extern int sfxge_port_ifmedia_init(struct sfxge_softc *sc);
359 extern uint64_t sfxge_get_counter(struct ifnet *ifp, ift_counter c);
360 
361 #define	SFXGE_MAX_MTU (9 * 1024)
362 
363 #define	SFXGE_ADAPTER_LOCK_INIT(_sc, _ifname)				\
364 	do {								\
365 		struct sfxge_softc *__sc = (_sc);			\
366 									\
367 		snprintf((__sc)->softc_lock_name,			\
368 			 sizeof((__sc)->softc_lock_name),		\
369 			 "%s:softc", (_ifname));			\
370 		sx_init(&(__sc)->softc_lock, (__sc)->softc_lock_name);	\
371 	} while (B_FALSE)
372 #define	SFXGE_ADAPTER_LOCK_DESTROY(_sc)					\
373 	sx_destroy(&(_sc)->softc_lock)
374 #define	SFXGE_ADAPTER_LOCK(_sc)						\
375 	sx_xlock(&(_sc)->softc_lock)
376 #define	SFXGE_ADAPTER_UNLOCK(_sc)					\
377 	sx_xunlock(&(_sc)->softc_lock)
378 #define	SFXGE_ADAPTER_LOCK_ASSERT_OWNED(_sc)				\
379 	sx_assert(&(_sc)->softc_lock, LA_XLOCKED)
380 
381 #define	SFXGE_PORT_LOCK_INIT(_port, _ifname)				\
382 	do {								\
383 		struct sfxge_port *__port = (_port);			\
384 									\
385 		snprintf((__port)->lock_name,				\
386 			 sizeof((__port)->lock_name),			\
387 			 "%s:port", (_ifname));				\
388 		mtx_init(&(__port)->lock, (__port)->lock_name,		\
389 			 NULL, MTX_DEF);				\
390 	} while (B_FALSE)
391 #define	SFXGE_PORT_LOCK_DESTROY(_port)					\
392 	mtx_destroy(&(_port)->lock)
393 #define	SFXGE_PORT_LOCK(_port)						\
394 	mtx_lock(&(_port)->lock)
395 #define	SFXGE_PORT_UNLOCK(_port)					\
396 	mtx_unlock(&(_port)->lock)
397 #define	SFXGE_PORT_LOCK_ASSERT_OWNED(_port)				\
398 	mtx_assert(&(_port)->lock, MA_OWNED)
399 
400 #define	SFXGE_MCDI_LOCK_INIT(_mcdi, _ifname)				\
401 	do {								\
402 		struct sfxge_mcdi  *__mcdi = (_mcdi);			\
403 									\
404 		snprintf((__mcdi)->lock_name,				\
405 			 sizeof((__mcdi)->lock_name),			\
406 			 "%s:mcdi", (_ifname));				\
407 		mtx_init(&(__mcdi)->lock, (__mcdi)->lock_name,		\
408 			 NULL, MTX_DEF);				\
409 	} while (B_FALSE)
410 #define	SFXGE_MCDI_LOCK_DESTROY(_mcdi)					\
411 	mtx_destroy(&(_mcdi)->lock)
412 #define	SFXGE_MCDI_LOCK(_mcdi)						\
413 	mtx_lock(&(_mcdi)->lock)
414 #define	SFXGE_MCDI_UNLOCK(_mcdi)					\
415 	mtx_unlock(&(_mcdi)->lock)
416 #define	SFXGE_MCDI_LOCK_ASSERT_OWNED(_mcdi)				\
417 	mtx_assert(&(_mcdi)->lock, MA_OWNED)
418 
419 #define	SFXGE_EVQ_LOCK_INIT(_evq, _ifname, _evq_index)			\
420 	do {								\
421 		struct sfxge_evq  *__evq = (_evq);			\
422 									\
423 		snprintf((__evq)->lock_name,				\
424 			 sizeof((__evq)->lock_name),			\
425 			 "%s:evq%u", (_ifname), (_evq_index));		\
426 		mtx_init(&(__evq)->lock, (__evq)->lock_name,		\
427 			 NULL, MTX_DEF);				\
428 	} while (B_FALSE)
429 #define	SFXGE_EVQ_LOCK_DESTROY(_evq)					\
430 	mtx_destroy(&(_evq)->lock)
431 #define	SFXGE_EVQ_LOCK(_evq)						\
432 	mtx_lock(&(_evq)->lock)
433 #define	SFXGE_EVQ_UNLOCK(_evq)						\
434 	mtx_unlock(&(_evq)->lock)
435 #define	SFXGE_EVQ_LOCK_ASSERT_OWNED(_evq)				\
436 	mtx_assert(&(_evq)->lock, MA_OWNED)
437 
438 #endif /* _SFXGE_H */
439