2 * Copyright (c) 2014-2017, Matthew Macy (mmacy@mattmacy.io)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
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.
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.
32 #include <sys/cpuset.h>
33 #include <machine/bus.h>
35 #include <sys/gtaskqueue.h>
40 * The value type for indexing, limits max descriptors
41 * to 65535 can be conditionally redefined to uint32_t
42 * in the future if the need arises.
44 typedef uint16_t qidx_t;
45 #define QIDX_INVALID 0xFFFF
48 typedef struct iflib_ctx *if_ctx_t;
50 typedef const struct if_shared_ctx *if_shared_ctx_t;
51 struct if_int_delay_info;
52 typedef struct if_int_delay_info *if_int_delay_info_t;
54 typedef struct if_pseudo *if_pseudo_t;
60 * - iflib utility functions
61 * - iflib core functions
64 typedef struct if_rxd_frag {
70 /* bnxt supports 64 with hardware LRO enabled */
71 #define IFLIB_MAX_RX_SEGS 64
73 typedef struct if_rxd_info {
75 uint16_t iri_qsidx; /* qset index */
76 uint16_t iri_vtag; /* vlan tag - if flag set */
77 /* XXX redundant with the new irf_len field */
78 uint16_t iri_len; /* packet length */
79 qidx_t iri_cidx; /* consumer index of cq */
80 if_t iri_ifp; /* driver may have >1 iface per softc */
82 /* updated by driver */
83 if_rxd_frag_t iri_frags;
84 uint32_t iri_flowid; /* RSS hash for packet */
85 uint32_t iri_csum_flags; /* m_pkthdr csum flags */
87 uint32_t iri_csum_data; /* m_pkthdr csum data */
88 uint8_t iri_flags; /* mbuf flags for packet */
89 uint8_t iri_nfrags; /* number of fragments in packet */
90 uint8_t iri_rsstype; /* RSS hash type */
91 uint8_t iri_pad; /* any padding in the received data */
94 typedef struct if_rxd_update {
100 uint16_t iru_buf_size;
104 #define IPI_TX_INTR 0x1 /* send an interrupt when this packet is sent */
105 #define IPI_TX_IPV4 0x2 /* ethertype IPv4 */
106 #define IPI_TX_IPV6 0x4 /* ethertype IPv6 */
108 typedef struct if_pkt_info {
109 bus_dma_segment_t *ipi_segs; /* physical addresses */
110 uint32_t ipi_len; /* packet length */
111 uint16_t ipi_qsidx; /* queue set index */
112 qidx_t ipi_nsegs; /* number of segments */
114 qidx_t ipi_ndescs; /* number of descriptors used by encap */
115 uint16_t ipi_flags; /* iflib per-packet flags */
116 qidx_t ipi_pidx; /* start pidx for encap */
117 qidx_t ipi_new_pidx; /* next available pidx post-encap */
118 /* offload handling */
119 uint8_t ipi_ehdrlen; /* ether header length */
120 uint8_t ipi_ip_hlen; /* ip header length */
121 uint8_t ipi_tcp_hlen; /* tcp header length */
122 uint8_t ipi_ipproto; /* ip protocol */
124 uint32_t ipi_csum_flags; /* packet checksum flags */
125 uint16_t ipi_tso_segsz; /* tso segment size */
126 uint16_t ipi_vtag; /* VLAN tag */
127 uint16_t ipi_etype; /* ether header type */
128 uint8_t ipi_tcp_hflags; /* tcp header flags */
129 uint8_t ipi_mflags; /* packet mbuf flags */
131 uint32_t ipi_tcp_seq; /* tcp seqno */
132 uint8_t ipi_ip_tos; /* IP ToS field data */
137 typedef struct if_irq {
138 struct resource *ii_res;
143 struct if_int_delay_info {
144 if_ctx_t iidi_ctx; /* Back-pointer to the iflib ctx (softc) */
145 int iidi_offset; /* Register offset to read/write */
146 int iidi_value; /* Current value in usecs */
147 struct sysctl_oid *iidi_oidp;
148 struct sysctl_req *iidi_req;
158 * This really belongs in pciio.h or some place more general
159 * but this is the only consumer for now.
161 typedef struct pci_vendor_info {
162 uint32_t pvi_vendor_id;
163 uint32_t pvi_device_id;
164 uint32_t pvi_subvendor_id;
165 uint32_t pvi_subdevice_id;
167 uint32_t pvi_class_mask;
168 const char *pvi_name;
170 #define PVID(vendor, devid, name) {vendor, devid, 0, 0, 0, 0, name}
171 #define PVID_OEM(vendor, devid, svid, sdevid, revid, name) {vendor, devid, svid, sdevid, revid, 0, name}
172 #define PVID_END {0, 0, 0, 0, 0, 0, NULL}
174 /* No drivers in tree currently match on anything except vendor:device. */
175 #define IFLIB_PNP_DESCR "U32:vendor;U32:device;U32:#;U32:#;" \
177 #define IFLIB_PNP_INFO(b, u, t) \
178 MODULE_PNP_INFO(IFLIB_PNP_DESCR, b, u, t, nitems(t) - 1)
180 typedef struct if_txrx {
181 int (*ift_txd_encap) (void *, if_pkt_info_t);
182 void (*ift_txd_flush) (void *, uint16_t, qidx_t pidx);
183 int (*ift_txd_credits_update) (void *, uint16_t qsidx, bool clear);
185 int (*ift_rxd_available) (void *, uint16_t qsidx, qidx_t pidx, qidx_t budget);
186 int (*ift_rxd_pkt_get) (void *, if_rxd_info_t ri);
187 void (*ift_rxd_refill) (void * , if_rxd_update_t iru);
188 void (*ift_rxd_flush) (void *, uint16_t qsidx, uint8_t flidx, qidx_t pidx);
189 int (*ift_legacy_intr) (void *);
190 qidx_t (*ift_txq_select) (void *, struct mbuf *);
191 qidx_t (*ift_txq_select_v2) (void *, struct mbuf *, if_pkt_info_t);
194 typedef struct if_softc_ctx {
200 int isc_msix_bar; /* can be model specific - initialize in attach_pre */
201 int isc_tx_nsegments; /* can be model specific - initialize in attach_pre */
205 uint32_t isc_txqsizes[8];
206 uint32_t isc_rxqsizes[8];
207 /* is there such thing as a descriptor that is more than 248 bytes ? */
208 uint8_t isc_txd_size[8];
209 uint8_t isc_rxd_size[8];
211 int isc_tx_tso_segments_max;
212 int isc_tx_tso_size_max;
213 int isc_tx_tso_segsize_max;
214 int isc_tx_csum_flags;
215 int isc_capabilities;
217 int isc_rss_table_size;
218 int isc_rss_table_mask;
219 int isc_nrxqsets_max;
220 int isc_ntxqsets_max;
223 iflib_intr_mode_t isc_intr;
224 uint16_t isc_rxd_buf_size[8]; /* set at init time by driver, 0
225 means use iflib-calculated size
226 based on isc_max_frame_size */
227 uint16_t isc_max_frame_size; /* set at init time by driver */
228 uint16_t isc_min_frame_size; /* set at init time by driver, only used if
229 IFLIB_NEED_ETHER_PAD is set. */
230 uint32_t isc_pause_frames; /* set by driver for iflib_timer to detect */
238 int isc_disable_msix;
240 struct ifmedia *isc_media;
244 * Initialization values for device
246 struct if_shared_ctx {
248 driver_t *isc_driver;
249 bus_size_t isc_q_align;
250 bus_size_t isc_tx_maxsize;
251 bus_size_t isc_tx_maxsegsize;
252 bus_size_t isc_tso_maxsize;
253 bus_size_t isc_tso_maxsegsize;
254 bus_size_t isc_rx_maxsize;
255 bus_size_t isc_rx_maxsegsize;
256 int isc_rx_nsegments;
257 int isc_admin_intrcnt; /* # of admin/link interrupts */
259 /* fields necessary for probe */
260 const pci_vendor_info_t *isc_vendor_info;
261 const char *isc_driver_version;
262 /* optional function to transform the read values to match the table*/
263 void (*isc_parse_devinfo) (uint16_t *device_id, uint16_t *subvendor_id,
264 uint16_t *subdevice_id, uint16_t *rev_id);
266 int isc_nrxd_default[8];
269 int isc_ntxd_default[8];
272 /* actively used during operation */
273 int isc_nfl __aligned(CACHE_LINE_SIZE);
274 int isc_ntxqs; /* # of tx queues per tx qset - usually 1 */
275 int isc_nrxqs; /* # of rx queues per rx qset - intel 1, chelsio 2, broadcom 3 */
277 int isc_tx_reclaim_thresh;
279 const char *isc_name;
282 typedef struct iflib_dma_info {
283 bus_addr_t idi_paddr;
285 bus_dma_tag_t idi_tag;
286 bus_dmamap_t idi_map;
290 #define IFLIB_MAGIC 0xCAFEF00D
293 /* Interrupt or softirq handles only receive */
296 /* Interrupt or softirq handles only transmit */
300 * Interrupt will check for both pending receive
301 * and available tx credits and dispatch a task
302 * for one or both depending on the disposition
303 * of the respective queues.
308 * Other interrupt - typically link status and
309 * or error conditions.
313 /* Softirq (task) for iov handling */
318 * Interface has a separate completion queue for RX
320 #define IFLIB_HAS_RXCQ 0x01
322 * Driver has already allocated vectors
324 #define IFLIB_SKIP_MSIX 0x02
326 * Interface is a virtual function
328 #define IFLIB_IS_VF 0x04
330 * Interface has a separate completion queue for TX
332 #define IFLIB_HAS_TXCQ 0x08
334 * Interface does checksum in place
336 #define IFLIB_NEED_SCRATCH 0x10
338 * Interface doesn't expect in_pseudo for th_sum
340 #define IFLIB_TSO_INIT_IP 0x20
342 * Interface doesn't align IP header
344 #define IFLIB_DO_RX_FIXUP 0x40
346 * Driver needs csum zeroed for offloading
348 #define IFLIB_NEED_ZERO_CSUM 0x80
350 * Driver needs frames padded to some minimum length
352 #define IFLIB_NEED_ETHER_PAD 0x100
354 * Packets can be freed immediately after encap
356 #define IFLIB_TXD_ENCAP_PIO 0x00200
358 * Use RX completion handler
360 #define IFLIB_RX_COMPLETION 0x00400
362 * Skip refilling cluster free lists
364 #define IFLIB_SKIP_CLREFILL 0x00800
366 * Don't reset on hang
368 #define IFLIB_NO_HANG_RESET 0x01000
370 * Don't need/want most of the niceties of
373 #define IFLIB_PSEUDO 0x02000
375 * No DMA support needed / wanted
377 #define IFLIB_VIRTUAL 0x04000
379 * autogenerate a MAC address
381 #define IFLIB_GEN_MAC 0x08000
383 * Interface needs admin task to ignore interface up/down status
385 #define IFLIB_ADMIN_ALWAYS_RUN 0x10000
387 * Driver will pass the media
389 #define IFLIB_DRIVER_MEDIA 0x20000
391 * When using a single hardware interrupt for the interface, only process RX
392 * interrupts instead of doing combined RX/TX processing.
394 #define IFLIB_SINGLE_IRQ_RX_ONLY 0x40000
396 * Don't need/want most of the niceties of
399 #define IFLIB_PSEUDO_ETHER 0x80000
401 /* The following IFLIB_FEATURE_* defines are for driver modules to determine
402 * what features this version of iflib supports. They shall be defined to the
403 * first __FreeBSD_version that introduced the feature.
406 * Driver can set its own TX queue selection function
407 * as ift_txq_select in struct if_txrx
409 #define IFLIB_FEATURE_QUEUE_SELECT 1300527
411 * Driver can set its own TX queue selection function
412 * as ift_txq_select_v2 in struct if_txrx. This includes
413 * having iflib send L3+ extra header information to the
416 #define IFLIB_FEATURE_QUEUE_SELECT_V2 1301509
419 * These enum values are used in iflib_needs_restart to indicate to iflib
420 * functions whether or not the interface needs restarting when certain events
423 enum iflib_restart_event {
424 IFLIB_RESTART_VLAN_CONFIG,
430 void *iflib_get_softc(if_ctx_t ctx);
432 device_t iflib_get_dev(if_ctx_t ctx);
434 if_t iflib_get_ifp(if_ctx_t ctx);
436 struct ifmedia *iflib_get_media(if_ctx_t ctx);
438 if_softc_ctx_t iflib_get_softc_ctx(if_ctx_t ctx);
439 if_shared_ctx_t iflib_get_sctx(if_ctx_t ctx);
441 void iflib_set_mac(if_ctx_t ctx, uint8_t mac[ETHER_ADDR_LEN]);
442 void iflib_request_reset(if_ctx_t ctx);
443 uint8_t iflib_in_detach(if_ctx_t ctx);
445 uint32_t iflib_get_rx_mbuf_sz(if_ctx_t ctx);
448 * If the driver can plug cleanly in to newbus use these
450 int iflib_device_probe(device_t);
451 int iflib_device_attach(device_t);
452 int iflib_device_detach(device_t);
453 int iflib_device_suspend(device_t);
454 int iflib_device_resume(device_t);
455 int iflib_device_shutdown(device_t);
458 * Use this instead of iflib_device_probe if the driver should report
459 * BUS_PROBE_VENDOR instead of BUS_PROBE_DEFAULT. (For example, an out-of-tree
460 * driver based on iflib).
462 int iflib_device_probe_vendor(device_t);
464 int iflib_device_iov_init(device_t, uint16_t, const nvlist_t *);
465 void iflib_device_iov_uninit(device_t);
466 int iflib_device_iov_add_vf(device_t, uint16_t, const nvlist_t *);
469 * If the driver can't plug cleanly in to newbus
472 int iflib_device_register(device_t dev, void *softc, if_shared_ctx_t sctx, if_ctx_t *ctxp);
473 int iflib_device_deregister(if_ctx_t);
475 int iflib_irq_alloc(if_ctx_t, if_irq_t, int, driver_filter_t, void *filter_arg,
476 driver_intr_t, void *arg, const char *name);
477 int iflib_irq_alloc_generic(if_ctx_t ctx, if_irq_t irq, int rid,
478 iflib_intr_type_t type, driver_filter_t *filter,
479 void *filter_arg, int qid, const char *name);
480 void iflib_softirq_alloc_generic(if_ctx_t ctx, if_irq_t irq,
481 iflib_intr_type_t type, void *arg, int qid,
484 void iflib_irq_free(if_ctx_t ctx, if_irq_t irq);
486 void iflib_io_tqg_attach(struct grouptask *gt, void *uniq, int cpu,
489 void iflib_config_gtask_init(void *ctx, struct grouptask *gtask,
490 gtask_fn_t *fn, const char *name);
491 void iflib_config_gtask_deinit(struct grouptask *gtask);
493 void iflib_tx_intr_deferred(if_ctx_t ctx, int txqid);
494 void iflib_rx_intr_deferred(if_ctx_t ctx, int rxqid);
495 void iflib_admin_intr_deferred(if_ctx_t ctx);
496 void iflib_iov_intr_deferred(if_ctx_t ctx);
498 void iflib_link_state_change(if_ctx_t ctx, int linkstate, uint64_t baudrate);
500 int iflib_dma_alloc(if_ctx_t ctx, int size, iflib_dma_info_t dma, int mapflags);
501 int iflib_dma_alloc_align(if_ctx_t ctx, int size, int align, iflib_dma_info_t dma, int mapflags);
502 void iflib_dma_free(iflib_dma_info_t dma);
503 int iflib_dma_alloc_multi(if_ctx_t ctx, int *sizes, iflib_dma_info_t *dmalist, int mapflags, int count);
505 void iflib_dma_free_multi(iflib_dma_info_t *dmalist, int count);
507 struct sx *iflib_ctx_lock_get(if_ctx_t);
509 void iflib_led_create(if_ctx_t ctx);
511 void iflib_add_int_delay_sysctl(if_ctx_t, const char *, const char *,
512 if_int_delay_info_t, int, int);
515 * Pseudo device support
517 if_pseudo_t iflib_clone_register(if_shared_ctx_t);
518 void iflib_clone_deregister(if_pseudo_t);
520 #endif /* __IFLIB_H_ */