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