xref: /freebsd/sys/dev/hyperv/netvsc/if_hnvar.h (revision 40427cca7a9ae77b095936fb1954417c290cfb17)
1 /*-
2  * Copyright (c) 2016-2017 Microsoft Corp.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice unmodified, this list of conditions, and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _IF_HNVAR_H_
30 #define _IF_HNVAR_H_
31 
32 #define HN_USE_TXDESC_BUFRING
33 
34 #define HN_CHIM_SIZE			(15 * 1024 * 1024)
35 
36 #define HN_RXBUF_SIZE			(16 * 1024 * 1024)
37 #define HN_RXBUF_SIZE_COMPAT		(15 * 1024 * 1024)
38 
39 /* Claimed to be 12232B */
40 #define HN_MTU_MAX			(9 * 1024)
41 
42 #define HN_TXBR_SIZE			(128 * PAGE_SIZE)
43 #define HN_RXBR_SIZE			(128 * PAGE_SIZE)
44 
45 #define HN_XACT_REQ_PGCNT		2
46 #define HN_XACT_RESP_PGCNT		2
47 #define HN_XACT_REQ_SIZE		(HN_XACT_REQ_PGCNT * PAGE_SIZE)
48 #define HN_XACT_RESP_SIZE		(HN_XACT_RESP_PGCNT * PAGE_SIZE)
49 
50 #define HN_GPACNT_MAX			32
51 
52 struct hn_txdesc;
53 #ifndef HN_USE_TXDESC_BUFRING
54 SLIST_HEAD(hn_txdesc_list, hn_txdesc);
55 #else
56 struct buf_ring;
57 #endif
58 struct hn_tx_ring;
59 
60 struct hn_rx_ring {
61 	struct ifnet	*hn_ifp;
62 	struct ifnet	*hn_rxvf_ifp;	/* SR-IOV VF for RX */
63 	struct hn_tx_ring *hn_txr;
64 	void		*hn_pktbuf;
65 	int		hn_pktbuf_len;
66 	int		hn_rx_flags;	/* HN_RX_FLAG_ */
67 	uint8_t		*hn_rxbuf;	/* shadow sc->hn_rxbuf */
68 	int		hn_rx_idx;
69 
70 	/* Trust csum verification on host side */
71 	int		hn_trust_hcsum;	/* HN_TRUST_HCSUM_ */
72 	struct lro_ctrl	hn_lro;
73 
74 	u_long		hn_csum_ip;
75 	u_long		hn_csum_tcp;
76 	u_long		hn_csum_udp;
77 	u_long		hn_csum_trusted;
78 	u_long		hn_lro_tried;
79 	u_long		hn_small_pkts;
80 	u_long		hn_pkts;
81 	u_long		hn_rss_pkts;
82 	u_long		hn_ack_failed;
83 
84 	/* Rarely used stuffs */
85 	struct sysctl_oid *hn_rx_sysctl_tree;
86 
87 	void		*hn_br;		/* TX/RX bufring */
88 	struct hyperv_dma hn_br_dma;
89 
90 	struct vmbus_channel *hn_chan;
91 } __aligned(CACHE_LINE_SIZE);
92 
93 #define HN_TRUST_HCSUM_IP	0x0001
94 #define HN_TRUST_HCSUM_TCP	0x0002
95 #define HN_TRUST_HCSUM_UDP	0x0004
96 
97 #define HN_RX_FLAG_ATTACHED	0x0001
98 #define HN_RX_FLAG_BR_REF	0x0002
99 #define HN_RX_FLAG_XPNT_VF	0x0004
100 
101 struct hn_tx_ring {
102 #ifndef HN_USE_TXDESC_BUFRING
103 	struct mtx	hn_txlist_spin;
104 	struct hn_txdesc_list hn_txlist;
105 #else
106 	struct buf_ring	*hn_txdesc_br;
107 #endif
108 	int		hn_txdesc_cnt;
109 	int		hn_txdesc_avail;
110 	u_short		hn_has_txeof;
111 	u_short		hn_txdone_cnt;
112 
113 	int		hn_sched_tx;
114 	void		(*hn_txeof)(struct hn_tx_ring *);
115 	struct taskqueue *hn_tx_taskq;
116 	struct task	hn_tx_task;
117 	struct task	hn_txeof_task;
118 
119 	struct buf_ring	*hn_mbuf_br;
120 	int		hn_oactive;
121 	int		hn_tx_idx;
122 	int		hn_tx_flags;
123 
124 	struct mtx	hn_tx_lock;
125 	struct hn_softc	*hn_sc;
126 	struct vmbus_channel *hn_chan;
127 
128 	int		hn_direct_tx_size;
129 	int		hn_chim_size;
130 	bus_dma_tag_t	hn_tx_data_dtag;
131 	uint64_t	hn_csum_assist;
132 
133 	/* Applied packet transmission aggregation limits. */
134 	int		hn_agg_szmax;
135 	short		hn_agg_pktmax;
136 	short		hn_agg_align;
137 
138 	/* Packet transmission aggregation states. */
139 	struct hn_txdesc *hn_agg_txd;
140 	int		hn_agg_szleft;
141 	short		hn_agg_pktleft;
142 	struct rndis_packet_msg *hn_agg_prevpkt;
143 
144 	/* Temporary stats for each sends. */
145 	int		hn_stat_size;
146 	short		hn_stat_pkts;
147 	short		hn_stat_mcasts;
148 
149 	int		(*hn_sendpkt)(struct hn_tx_ring *, struct hn_txdesc *);
150 	int		hn_suspended;
151 	int		hn_gpa_cnt;
152 	struct vmbus_gpa hn_gpa[HN_GPACNT_MAX];
153 
154 	u_long		hn_no_txdescs;
155 	u_long		hn_send_failed;
156 	u_long		hn_txdma_failed;
157 	u_long		hn_tx_collapsed;
158 	u_long		hn_tx_chimney_tried;
159 	u_long		hn_tx_chimney;
160 	u_long		hn_pkts;
161 	u_long		hn_sends;
162 	u_long		hn_flush_failed;
163 
164 	/* Rarely used stuffs */
165 	struct hn_txdesc *hn_txdesc;
166 	bus_dma_tag_t	hn_tx_rndis_dtag;
167 	struct sysctl_oid *hn_tx_sysctl_tree;
168 } __aligned(CACHE_LINE_SIZE);
169 
170 #define HN_TX_FLAG_ATTACHED	0x0001
171 #define HN_TX_FLAG_HASHVAL	0x0002	/* support HASHVAL pktinfo */
172 
173 /*
174  * Device-specific softc structure
175  */
176 struct hn_softc {
177 	struct ifnet    *hn_ifp;
178 	struct ifmedia	hn_media;
179 	device_t        hn_dev;
180 	int             hn_if_flags;
181 	struct sx	hn_lock;
182 	struct vmbus_channel *hn_prichan;
183 
184 	int		hn_rx_ring_cnt;
185 	int		hn_rx_ring_inuse;
186 	struct hn_rx_ring *hn_rx_ring;
187 
188 	struct rmlock	hn_vf_lock;
189 	struct ifnet	*hn_vf_ifp;	/* SR-IOV VF */
190 	uint32_t	hn_xvf_flags;	/* transparent VF flags */
191 
192 	int		hn_tx_ring_cnt;
193 	int		hn_tx_ring_inuse;
194 	struct hn_tx_ring *hn_tx_ring;
195 
196 	uint8_t		*hn_chim;
197 	u_long		*hn_chim_bmap;
198 	int		hn_chim_bmap_cnt;
199 	int		hn_chim_cnt;
200 	int		hn_chim_szmax;
201 
202 	int		hn_cpu;
203 	struct taskqueue **hn_tx_taskqs;
204 	struct sysctl_oid *hn_tx_sysctl_tree;
205 	struct sysctl_oid *hn_rx_sysctl_tree;
206 	struct vmbus_xact_ctx *hn_xact;
207 	uint32_t	hn_nvs_ver;
208 	uint32_t	hn_rx_filter;
209 
210 	/* Packet transmission aggregation user settings. */
211 	int			hn_agg_size;
212 	int			hn_agg_pkts;
213 
214 	struct taskqueue	*hn_mgmt_taskq;
215 	struct taskqueue	*hn_mgmt_taskq0;
216 	struct task		hn_link_task;
217 	struct task		hn_netchg_init;
218 	struct timeout_task	hn_netchg_status;
219 	uint32_t		hn_link_flags;	/* HN_LINK_FLAG_ */
220 
221 	uint32_t		hn_caps;	/* HN_CAP_ */
222 	uint32_t		hn_flags;	/* HN_FLAG_ */
223 	u_int			hn_pollhz;
224 
225 	void			*hn_rxbuf;
226 	uint32_t		hn_rxbuf_gpadl;
227 	struct hyperv_dma	hn_rxbuf_dma;
228 
229 	uint32_t		hn_chim_gpadl;
230 	struct hyperv_dma	hn_chim_dma;
231 
232 	uint32_t		hn_rndis_rid;
233 	uint32_t		hn_ndis_ver;
234 	int			hn_ndis_tso_szmax;
235 	int			hn_ndis_tso_sgmin;
236 	uint32_t		hn_rndis_agg_size;
237 	uint32_t		hn_rndis_agg_pkts;
238 	uint32_t		hn_rndis_agg_align;
239 
240 	int			hn_rss_ind_size;
241 	uint32_t		hn_rss_hash;	/* NDIS_HASH_ */
242 	struct ndis_rssprm_toeplitz hn_rss;
243 
244 	eventhandler_tag	hn_ifaddr_evthand;
245 	eventhandler_tag	hn_ifnet_evthand;
246 	eventhandler_tag	hn_ifnet_atthand;
247 	eventhandler_tag	hn_ifnet_dethand;
248 	eventhandler_tag	hn_ifnet_lnkhand;
249 
250 	/*
251 	 * Transparent VF delayed initialization.
252 	 */
253 	int			hn_vf_rdytick;	/* ticks, 0 == ready */
254 	struct taskqueue	*hn_vf_taskq;
255 	struct timeout_task	hn_vf_init;
256 
257 	/*
258 	 * Saved information for VF under transparent mode.
259 	 */
260 	void			(*hn_vf_input)
261 				(struct ifnet *, struct mbuf *);
262 	int			hn_saved_caps;
263 	u_int			hn_saved_tsomax;
264 	u_int			hn_saved_tsosegcnt;
265 	u_int			hn_saved_tsosegsz;
266 };
267 
268 #define HN_FLAG_RXBUF_CONNECTED		0x0001
269 #define HN_FLAG_CHIM_CONNECTED		0x0002
270 #define HN_FLAG_HAS_RSSKEY		0x0004
271 #define HN_FLAG_HAS_RSSIND		0x0008
272 #define HN_FLAG_SYNTH_ATTACHED		0x0010
273 #define HN_FLAG_NO_SLEEPING		0x0020
274 #define HN_FLAG_RXBUF_REF		0x0040
275 #define HN_FLAG_CHIM_REF		0x0080
276 #define HN_FLAG_RXVF			0x0100
277 
278 #define HN_FLAG_ERRORS			(HN_FLAG_RXBUF_REF | HN_FLAG_CHIM_REF)
279 
280 #define HN_XVFFLAG_ENABLED		0x0001
281 #define HN_XVFFLAG_ACCBPF		0x0002
282 
283 #define HN_NO_SLEEPING(sc)			\
284 do {						\
285 	(sc)->hn_flags |= HN_FLAG_NO_SLEEPING;	\
286 } while (0)
287 
288 #define HN_SLEEPING_OK(sc)			\
289 do {						\
290 	(sc)->hn_flags &= ~HN_FLAG_NO_SLEEPING;	\
291 } while (0)
292 
293 #define HN_CAN_SLEEP(sc)		\
294 	(((sc)->hn_flags & HN_FLAG_NO_SLEEPING) == 0)
295 
296 #define HN_CAP_VLAN			0x0001
297 #define HN_CAP_MTU			0x0002
298 #define HN_CAP_IPCS			0x0004
299 #define HN_CAP_TCP4CS			0x0008
300 #define HN_CAP_TCP6CS			0x0010
301 #define HN_CAP_UDP4CS			0x0020
302 #define HN_CAP_UDP6CS			0x0040
303 #define HN_CAP_TSO4			0x0080
304 #define HN_CAP_TSO6			0x0100
305 #define HN_CAP_HASHVAL			0x0200
306 
307 /* Capability description for use with printf(9) %b identifier. */
308 #define HN_CAP_BITS				\
309 	"\020\1VLAN\2MTU\3IPCS\4TCP4CS\5TCP6CS"	\
310 	"\6UDP4CS\7UDP6CS\10TSO4\11TSO6\12HASHVAL"
311 
312 #define HN_LINK_FLAG_LINKUP		0x0001
313 #define HN_LINK_FLAG_NETCHG		0x0002
314 
315 #endif	/* !_IF_HNVAR_H_ */
316