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