sfxge_tx.h revision 291488
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: head/sys/dev/sfxge/sfxge_tx.h 291488 2015-11-30 13:27:40Z arybchik $
34 */
35
36#ifndef _SFXGE_TX_H
37#define	_SFXGE_TX_H
38
39#include <netinet/in.h>
40#include <netinet/ip.h>
41#include <netinet/tcp.h>
42
43/* Maximum size of TSO packet */
44#define	SFXGE_TSO_MAX_SIZE		(65535)
45
46/*
47 * Maximum number of segments to be created for a TSO packet.
48 * Allow for a reasonable minimum MSS of 512.
49 */
50#define	SFXGE_TSO_MAX_SEGS		howmany(SFXGE_TSO_MAX_SIZE, 512)
51
52/* Maximum number of DMA segments needed to map an mbuf chain.  With
53 * TSO, the mbuf length may be just over 64K, divided into 2K mbuf
54 * clusters taking into account that the first may be not 2K cluster
55 * boundary aligned.
56 * The chain could be longer than this initially, but can be shortened
57 * with m_collapse().
58 */
59#define	SFXGE_TX_MAPPING_MAX_SEG					\
60	(1 + howmany(SFXGE_TSO_MAX_SIZE, MCLBYTES) + 1)
61
62/*
63 * Buffer mapping flags.
64 *
65 * Buffers and DMA mappings must be freed when the last descriptor
66 * referring to them is completed.  Set the TX_BUF_UNMAP and
67 * TX_BUF_MBUF flags on the last descriptor generated for an mbuf
68 * chain.  Set only the TX_BUF_UNMAP flag on a descriptor referring to
69 * a heap buffer.
70 */
71enum sfxge_tx_buf_flags {
72	TX_BUF_UNMAP = 1,
73	TX_BUF_MBUF = 2,
74};
75
76/*
77 * Buffer mapping information for descriptors in flight.
78 */
79struct sfxge_tx_mapping {
80	union {
81		struct mbuf	*mbuf;
82		caddr_t		heap_buf;
83	}			u;
84	bus_dmamap_t		map;
85	enum sfxge_tx_buf_flags	flags;
86};
87
88#define	SFXGE_TX_DPL_GET_PKT_LIMIT_DEFAULT		(64 * 1024)
89#define	SFXGE_TX_DPL_GET_NON_TCP_PKT_LIMIT_DEFAULT	1024
90#define	SFXGE_TX_DPL_PUT_PKT_LIMIT_DEFAULT		1024
91
92/*
93 * Deferred packet list.
94 */
95struct sfxge_tx_dpl {
96	unsigned int	std_get_max;		/* Maximum number  of packets
97						 * in get list */
98	unsigned int	std_get_non_tcp_max;	/* Maximum number
99						 * of non-TCP packets
100						 * in get list */
101	unsigned int	std_put_max;		/* Maximum number of packets
102						 * in put list */
103	uintptr_t	std_put;		/* Head of put list. */
104	struct mbuf	*std_get;		/* Head of get list. */
105	struct mbuf	**std_getp;		/* Tail of get list. */
106	unsigned int	std_get_count;		/* Packets in get list. */
107	unsigned int	std_get_non_tcp_count;	/* Non-TCP packets
108						 * in get list */
109	unsigned int	std_get_hiwat;		/* Packets in get list
110						 * high watermark */
111	unsigned int	std_put_hiwat;		/* Packets in put list
112						 * high watermark */
113};
114
115
116#define	SFXGE_TX_BUFFER_SIZE	0x400
117#define	SFXGE_TX_HEADER_SIZE	0x100
118#define	SFXGE_TX_COPY_THRESHOLD	0x200
119
120enum sfxge_txq_state {
121	SFXGE_TXQ_UNINITIALIZED = 0,
122	SFXGE_TXQ_INITIALIZED,
123	SFXGE_TXQ_STARTED
124};
125
126enum sfxge_txq_type {
127	SFXGE_TXQ_NON_CKSUM = 0,
128	SFXGE_TXQ_IP_CKSUM,
129	SFXGE_TXQ_IP_TCP_UDP_CKSUM,
130	SFXGE_TXQ_NTYPES
131};
132
133#define	SFXGE_TXQ_UNBLOCK_LEVEL(_entries)	(EFX_TXQ_LIMIT(_entries) / 4)
134
135#define	SFXGE_TX_BATCH	64
136
137#define	SFXGE_TXQ_LOCK_INIT(_txq, _ifname, _txq_index)			\
138	do {								\
139		struct sfxge_txq  *__txq = (_txq);			\
140									\
141		snprintf((__txq)->lock_name,				\
142			 sizeof((__txq)->lock_name),			\
143			 "%s:txq%u", (_ifname), (_txq_index));		\
144		mtx_init(&(__txq)->lock, (__txq)->lock_name,		\
145			 NULL, MTX_DEF);				\
146	} while (B_FALSE)
147#define	SFXGE_TXQ_LOCK_DESTROY(_txq)					\
148	mtx_destroy(&(_txq)->lock)
149#define	SFXGE_TXQ_LOCK(_txq)						\
150	mtx_lock(&(_txq)->lock)
151#define	SFXGE_TXQ_TRYLOCK(_txq)						\
152	mtx_trylock(&(_txq)->lock)
153#define	SFXGE_TXQ_UNLOCK(_txq)						\
154	mtx_unlock(&(_txq)->lock)
155#define	SFXGE_TXQ_LOCK_ASSERT_OWNED(_txq)				\
156	mtx_assert(&(_txq)->lock, MA_OWNED)
157#define	SFXGE_TXQ_LOCK_ASSERT_NOTOWNED(_txq)				\
158	mtx_assert(&(_txq)->lock, MA_NOTOWNED)
159
160
161struct sfxge_txq {
162	/* The following fields should be written very rarely */
163	struct sfxge_softc		*sc;
164	enum sfxge_txq_state		init_state;
165	enum sfxge_flush_state		flush_state;
166	enum sfxge_txq_type		type;
167	unsigned int			txq_index;
168	unsigned int			evq_index;
169	efsys_mem_t			mem;
170	unsigned int			buf_base_id;
171	unsigned int			entries;
172	unsigned int			ptr_mask;
173	unsigned int			max_pkt_desc;
174
175	struct sfxge_tx_mapping		*stmp;	/* Packets in flight. */
176	bus_dma_tag_t			packet_dma_tag;
177	efx_desc_t			*pend_desc;
178	efx_txq_t			*common;
179
180	efsys_mem_t			*tsoh_buffer;
181
182	char				lock_name[SFXGE_LOCK_NAME_MAX];
183
184	/* This field changes more often and is read regularly on both
185	 * the initiation and completion paths
186	 */
187	int				blocked __aligned(CACHE_LINE_SIZE);
188
189	/* The following fields change more often, and are used mostly
190	 * on the initiation path
191	 */
192	struct mtx			lock __aligned(CACHE_LINE_SIZE);
193	struct sfxge_tx_dpl		dpl;	/* Deferred packet list. */
194	unsigned int			n_pend_desc;
195	unsigned int			added;
196	unsigned int			reaped;
197
198	/* The last VLAN TCI seen on the queue if FW-assisted tagging is
199	   used */
200	uint16_t			hw_vlan_tci;
201
202	/* Statistics */
203	unsigned long			tso_bursts;
204	unsigned long			tso_packets;
205	unsigned long			tso_long_headers;
206	unsigned long			collapses;
207	unsigned long			drops;
208	unsigned long			get_overflow;
209	unsigned long			get_non_tcp_overflow;
210	unsigned long			put_overflow;
211	unsigned long			netdown_drops;
212	unsigned long			tso_pdrop_too_many;
213	unsigned long			tso_pdrop_no_rsrc;
214
215	/* The following fields change more often, and are used mostly
216	 * on the completion path
217	 */
218	unsigned int			pending __aligned(CACHE_LINE_SIZE);
219	unsigned int			completed;
220	struct sfxge_txq		*next;
221};
222
223struct sfxge_evq;
224
225extern uint64_t sfxge_tx_get_drops(struct sfxge_softc *sc);
226
227extern int sfxge_tx_init(struct sfxge_softc *sc);
228extern void sfxge_tx_fini(struct sfxge_softc *sc);
229extern int sfxge_tx_start(struct sfxge_softc *sc);
230extern void sfxge_tx_stop(struct sfxge_softc *sc);
231extern void sfxge_tx_qcomplete(struct sfxge_txq *txq, struct sfxge_evq *evq);
232extern void sfxge_tx_qflush_done(struct sfxge_txq *txq);
233extern void sfxge_if_qflush(struct ifnet *ifp);
234extern int sfxge_if_transmit(struct ifnet *ifp, struct mbuf *m);
235
236#endif
237