xref: /freebsd/sys/net/iflib.h (revision 63d1fd5970ec814904aa0f4580b10a0d302d08b2)
1 /*-
2  * Copyright (c) 2014-2015, Matthew Macy (mmacy@nextbsd.org)
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 are met:
7  *
8  *  1. Redistributions of source code must retain the above copyright notice,
9  *     this list of conditions and the following disclaimer.
10  *
11  *  2. Neither the name of Matthew Macy nor the names of its
12  *     contributors may be used to endorse or promote products derived from
13  *     this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 #ifndef __IFLIB_H_
30 #define __IFLIB_H_
31 
32 #include <sys/kobj.h>
33 #include <sys/bus.h>
34 #include <sys/cpuset.h>
35 #include <machine/bus.h>
36 #include <sys/bus_dma.h>
37 #include <sys/nv.h>
38 #include <sys/gtaskqueue.h>
39 
40 
41 /*
42  * Most cards can handle much larger TSO requests
43  * but the FreeBSD TCP stack will break on larger
44  * values
45  */
46 #define FREEBSD_TSO_SIZE_MAX 65518
47 
48 
49 struct iflib_ctx;
50 typedef struct iflib_ctx *if_ctx_t;
51 struct if_shared_ctx;
52 typedef struct if_shared_ctx *if_shared_ctx_t;
53 struct if_int_delay_info;
54 typedef struct if_int_delay_info  *if_int_delay_info_t;
55 
56 /*
57  * File organization:
58  *  - public structures
59  *  - iflib accessors
60  *  - iflib utility functions
61  *  - iflib core functions
62  */
63 
64 typedef struct if_rxd_frag {
65 	uint8_t irf_flid;
66 	uint16_t irf_idx;
67 	uint16_t irf_len;
68 } *if_rxd_frag_t;
69 
70 typedef struct if_rxd_info {
71 	/* set by iflib */
72 	uint16_t iri_qsidx;		/* qset index */
73 	uint16_t iri_vtag;		/* vlan tag - if flag set */
74 	/* XXX redundant with the new irf_len field */
75 	uint16_t iri_len;		/* packet length */
76 	uint16_t iri_cidx;		/* consumer index of cq */
77 	struct ifnet *iri_ifp;		/* some drivers >1 interface per softc */
78 
79 	/* updated by driver */
80 	uint16_t iri_flags;		/* mbuf flags for packet */
81 	uint32_t iri_flowid;		/* RSS hash for packet */
82 	uint32_t iri_csum_flags;	/* m_pkthdr csum flags */
83 	uint32_t iri_csum_data;		/* m_pkthdr csum data */
84 	uint8_t	 iri_nfrags;		/* number of fragments in packet */
85 	uint8_t	 iri_rsstype;		/* RSS hash type */
86 	uint8_t	 iri_pad;		/* any padding in the received data */
87 	if_rxd_frag_t iri_frags;
88 } *if_rxd_info_t;
89 
90 #define IPI_TX_INTR	0x1		/* send an interrupt when this packet is sent */
91 #define IPI_TX_IPV4	0x2		/* ethertype IPv4 */
92 #define IPI_TX_IPV6	0x4		/* ethertype IPv6 */
93 
94 typedef struct if_pkt_info {
95 	uint32_t			ipi_len;	/* packet length */
96 	bus_dma_segment_t		*ipi_segs;	/* physical addresses */
97 	uint16_t			ipi_qsidx;	/* queue set index */
98 	uint16_t			ipi_nsegs;	/* number of segments */
99 	uint16_t			ipi_ndescs;	/* number of descriptors used by encap */
100 	uint16_t			ipi_flags;	/* iflib per-packet flags */
101 	uint32_t			ipi_pidx;	/* start pidx for encap */
102 	uint32_t			ipi_new_pidx;	/* next available pidx post-encap */
103 	/* offload handling */
104 	uint64_t			ipi_csum_flags;	/* packet checksum flags */
105 	uint16_t			ipi_tso_segsz;	/* tso segment size */
106 	uint16_t			ipi_mflags;	/* packet mbuf flags */
107 	uint16_t			ipi_vtag;	/* VLAN tag */
108 	uint16_t			ipi_etype;	/* ether header type */
109 	uint8_t				ipi_ehdrlen;	/* ether header length */
110 	uint8_t				ipi_ip_hlen;	/* ip header length */
111 	uint8_t				ipi_tcp_hlen;	/* tcp header length */
112 	uint8_t				ipi_tcp_hflags;	/* tcp header flags */
113 	uint8_t				ipi_ipproto;	/* ip protocol */
114 	/* implied padding */
115 	uint32_t			ipi_tcp_seq;	/* tcp seqno */
116 	uint32_t			ipi_tcp_sum;	/* tcp csum */
117 } *if_pkt_info_t;
118 
119 typedef struct if_irq {
120 	struct resource  *ii_res;
121 	int               ii_rid;
122 	void             *ii_tag;
123 } *if_irq_t;
124 
125 struct if_int_delay_info {
126 	if_ctx_t iidi_ctx;	/* Back-pointer to the iflib ctx (softc) */
127 	int iidi_offset;			/* Register offset to read/write */
128 	int iidi_value;			/* Current value in usecs */
129 	struct sysctl_oid *iidi_oidp;
130 	struct sysctl_req *iidi_req;
131 };
132 
133 typedef enum {
134 	IFLIB_INTR_LEGACY,
135 	IFLIB_INTR_MSI,
136 	IFLIB_INTR_MSIX
137 } iflib_intr_mode_t;
138 
139 /*
140  * This really belongs in pciio.h or some place more general
141  * but this is the only consumer for now.
142  */
143 typedef struct pci_vendor_info {
144 	uint32_t	pvi_vendor_id;
145 	uint32_t	pvi_device_id;
146 	uint32_t	pvi_subvendor_id;
147 	uint32_t	pvi_subdevice_id;
148 	uint32_t	pvi_rev_id;
149 	uint32_t	pvi_class_mask;
150 	caddr_t		pvi_name;
151 } pci_vendor_info_t;
152 
153 #define PVID(vendor, devid, name) {vendor, devid, 0, 0, 0, 0, name}
154 #define PVID_OEM(vendor, devid, svid, sdevid, revid, name) {vendor, devid, svid, sdevid, revid, 0, name}
155 #define PVID_END {0, 0, 0, 0, 0, 0, NULL}
156 
157 typedef struct if_txrx {
158 	int (*ift_txd_encap) (void *, if_pkt_info_t);
159 	void (*ift_txd_flush) (void *, uint16_t, uint32_t);
160 	int (*ift_txd_credits_update) (void *, uint16_t, uint32_t, bool);
161 
162 	int (*ift_rxd_available) (void *, uint16_t qsidx, uint32_t pidx,
163 	    int budget);
164 	int (*ift_rxd_pkt_get) (void *, if_rxd_info_t ri);
165 	void (*ift_rxd_refill) (void * , uint16_t qsidx, uint8_t flidx, uint32_t pidx,
166 							uint64_t *paddrs, caddr_t *vaddrs, uint16_t count, uint16_t buf_size);
167 	void (*ift_rxd_flush) (void *, uint16_t qsidx, uint8_t flidx, uint32_t pidx);
168 	int (*ift_legacy_intr) (void *);
169 } *if_txrx_t;
170 
171 typedef struct if_softc_ctx {
172 	int isc_vectors;
173 	int isc_nrxqsets;
174 	int isc_ntxqsets;
175 	int isc_msix_bar;		/* can be model specific - initialize in attach_pre */
176 	int isc_tx_nsegments;		/* can be model specific - initialize in attach_pre */
177 	int isc_ntxd[8];
178 	int isc_nrxd[8];
179 
180 	uint32_t isc_txqsizes[8];
181 	uint32_t isc_rxqsizes[8];
182 	int isc_max_txqsets;
183 	int isc_max_rxqsets;
184 	int isc_tx_tso_segments_max;
185 	int isc_tx_tso_size_max;
186 	int isc_tx_tso_segsize_max;
187 	int isc_tx_csum_flags;
188 	int isc_capenable;
189 	int isc_rss_table_size;
190 	int isc_rss_table_mask;
191 	int isc_nrxqsets_max;
192 	int isc_ntxqsets_max;
193 
194 	iflib_intr_mode_t isc_intr;
195 	uint16_t isc_max_frame_size; /* set at init time by driver */
196 	pci_vendor_info_t isc_vendor_info;	/* set by iflib prior to attach_pre */
197 	if_txrx_t isc_txrx;
198 } *if_softc_ctx_t;
199 
200 /*
201  * Initialization values for device
202  */
203 struct if_shared_ctx {
204 	int isc_magic;
205 	driver_t *isc_driver;
206 	int isc_nfl;
207 	int isc_flags;
208 	bus_size_t isc_q_align;
209 	bus_size_t isc_tx_maxsize;
210 	bus_size_t isc_tx_maxsegsize;
211 	bus_size_t isc_rx_maxsize;
212 	bus_size_t isc_rx_maxsegsize;
213 	int isc_rx_nsegments;
214 	int isc_rx_process_limit;
215 	int isc_ntxqs;			/* # of tx queues per tx qset - usually 1 */
216 	int isc_nrxqs;			/* # of rx queues per rx qset - intel 1, chelsio 2, broadcom 3 */
217 	int isc_admin_intrcnt;		/* # of admin/link interrupts */
218 
219 
220 	int isc_tx_reclaim_thresh;
221 
222 	/* fields necessary for probe */
223 	pci_vendor_info_t *isc_vendor_info;
224 	char *isc_driver_version;
225 /* optional function to transform the read values to match the table*/
226 	void (*isc_parse_devinfo) (uint16_t *device_id, uint16_t *subvendor_id,
227 				   uint16_t *subdevice_id, uint16_t *rev_id);
228 	int isc_nrxd_min[8];
229 	int isc_nrxd_default[8];
230 	int isc_nrxd_max[8];
231 	int isc_ntxd_min[8];
232 	int isc_ntxd_default[8];
233 	int isc_ntxd_max[8];
234 };
235 
236 typedef struct iflib_dma_info {
237 	bus_addr_t		idi_paddr;
238 	caddr_t			idi_vaddr;
239 	bus_dma_tag_t		idi_tag;
240 	bus_dmamap_t		idi_map;
241 	uint32_t		idi_size;
242 } *iflib_dma_info_t;
243 
244 #define IFLIB_MAGIC 0xCAFEF00D
245 
246 typedef enum {
247 	IFLIB_INTR_TX,
248 	IFLIB_INTR_RX,
249 	IFLIB_INTR_ADMIN,
250 	IFLIB_INTR_IOV,
251 } iflib_intr_type_t;
252 
253 #ifndef ETH_ADDR_LEN
254 #define ETH_ADDR_LEN 6
255 #endif
256 
257 
258 /*
259  * Interface has a separate command queue for RX
260  */
261 #define IFLIB_HAS_RXCQ		0x01
262 /*
263  * Driver has already allocated vectors
264  */
265 #define IFLIB_SKIP_MSIX		0x02
266 /*
267  * Interface is a virtual function
268  */
269 #define IFLIB_IS_VF		0x04
270 /*
271  * Interface has a separate command queue for TX
272  */
273 #define IFLIB_HAS_TXCQ		0x08
274 /*
275  * Interface does checksum in place
276  */
277 #define IFLIB_NEED_SCRATCH	0x10
278 /*
279  * Interface doesn't expect in_pseudo for th_sum
280  */
281 #define IFLIB_TSO_INIT_IP	0x20
282 
283 
284 
285 /*
286  * field accessors
287  */
288 void *iflib_get_softc(if_ctx_t ctx);
289 
290 device_t iflib_get_dev(if_ctx_t ctx);
291 
292 if_t iflib_get_ifp(if_ctx_t ctx);
293 
294 struct ifmedia *iflib_get_media(if_ctx_t ctx);
295 
296 if_softc_ctx_t iflib_get_softc_ctx(if_ctx_t ctx);
297 if_shared_ctx_t iflib_get_sctx(if_ctx_t ctx);
298 
299 void iflib_set_mac(if_ctx_t ctx, uint8_t mac[ETHER_ADDR_LEN]);
300 
301 
302 
303 
304 /*
305  * If the driver can plug cleanly in to newbus use these
306  */
307 int iflib_device_probe(device_t);
308 int iflib_device_attach(device_t);
309 int iflib_device_detach(device_t);
310 int iflib_device_suspend(device_t);
311 int iflib_device_resume(device_t);
312 int iflib_device_shutdown(device_t);
313 
314 
315 int iflib_device_iov_init(device_t, uint16_t, const nvlist_t *);
316 void iflib_device_iov_uninit(device_t);
317 int iflib_device_iov_add_vf(device_t, uint16_t, const nvlist_t *);
318 
319 /*
320  * If the driver can't plug cleanly in to newbus
321  * use these
322  */
323 int iflib_device_register(device_t dev, void *softc, if_shared_ctx_t sctx, if_ctx_t *ctxp);
324 int iflib_device_deregister(if_ctx_t);
325 
326 
327 
328 int iflib_irq_alloc(if_ctx_t, if_irq_t, int, driver_filter_t, void *filter_arg, driver_intr_t, void *arg, char *name);
329 int iflib_irq_alloc_generic(if_ctx_t ctx, if_irq_t irq, int rid,
330 							iflib_intr_type_t type, driver_filter_t *filter,
331 							void *filter_arg, int qid, char *name);
332 void iflib_softirq_alloc_generic(if_ctx_t ctx, int rid, iflib_intr_type_t type,  void *arg, int qid, char *name);
333 
334 void iflib_irq_free(if_ctx_t ctx, if_irq_t irq);
335 
336 void iflib_io_tqg_attach(struct grouptask *gt, void *uniq, int cpu, char *name);
337 
338 void iflib_config_gtask_init(if_ctx_t ctx, struct grouptask *gtask,
339 			     gtask_fn_t *fn, char *name);
340 
341 void iflib_config_gtask_deinit(struct grouptask *gtask);
342 
343 
344 
345 void iflib_tx_intr_deferred(if_ctx_t ctx, int txqid);
346 void iflib_rx_intr_deferred(if_ctx_t ctx, int rxqid);
347 void iflib_admin_intr_deferred(if_ctx_t ctx);
348 void iflib_iov_intr_deferred(if_ctx_t ctx);
349 
350 
351 void iflib_link_state_change(if_ctx_t ctx, int linkstate, uint64_t baudrate);
352 
353 int iflib_dma_alloc(if_ctx_t ctx, int size, iflib_dma_info_t dma, int mapflags);
354 void iflib_dma_free(iflib_dma_info_t dma);
355 
356 int iflib_dma_alloc_multi(if_ctx_t ctx, int *sizes, iflib_dma_info_t *dmalist, int mapflags, int count);
357 
358 void iflib_dma_free_multi(iflib_dma_info_t *dmalist, int count);
359 
360 
361 struct mtx *iflib_ctx_lock_get(if_ctx_t);
362 struct mtx *iflib_qset_lock_get(if_ctx_t, uint16_t);
363 
364 void iflib_led_create(if_ctx_t ctx);
365 
366 void iflib_add_int_delay_sysctl(if_ctx_t, const char *, const char *,
367 								if_int_delay_info_t, int, int);
368 
369 #endif /*  __IFLIB_H_ */
370