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>
38 * The value type for indexing, limits max descriptors
39 * to 65535 can be conditionally redefined to uint32_t
40 * in the future if the need arises.
42 typedef uint16_t qidx_t;
43 #define QIDX_INVALID 0xFFFF
46 typedef struct iflib_ctx *if_ctx_t;
48 typedef const struct if_shared_ctx *if_shared_ctx_t;
49 struct if_int_delay_info;
50 typedef struct if_int_delay_info *if_int_delay_info_t;
56 * - iflib utility functions
57 * - iflib core functions
60 typedef struct if_rxd_frag {
66 /* bnxt supports 64 with hardware LRO enabled */
67 #define IFLIB_MAX_RX_SEGS 64
69 typedef struct if_rxd_info {
71 uint16_t iri_qsidx; /* qset index */
72 uint16_t iri_vtag; /* vlan tag - if flag set */
73 /* XXX redundant with the new irf_len field */
74 uint16_t iri_len; /* packet length */
75 qidx_t iri_cidx; /* consumer index of cq */
76 if_t iri_ifp; /* driver may have >1 iface per softc */
78 /* updated by driver */
79 if_rxd_frag_t iri_frags;
80 uint32_t iri_flowid; /* RSS hash for packet */
81 uint32_t iri_csum_flags; /* m_pkthdr csum flags */
83 uint32_t iri_csum_data; /* m_pkthdr csum data */
84 uint8_t iri_flags; /* mbuf flags for packet */
85 uint8_t iri_nfrags; /* number of fragments in packet */
86 uint8_t iri_rsstype; /* RSS hash type */
87 uint8_t iri_pad; /* any padding in the received data */
90 typedef struct if_rxd_update {
96 uint16_t iru_buf_size;
100 #define IPI_TX_INTR 0x1 /* send an interrupt when this packet is sent */
101 #define IPI_TX_IPV4 0x2 /* ethertype IPv4 */
102 #define IPI_TX_IPV6 0x4 /* ethertype IPv6 */
104 typedef struct if_pkt_info {
105 bus_dma_segment_t *ipi_segs; /* physical addresses */
106 uint32_t ipi_len; /* packet length */
107 uint16_t ipi_qsidx; /* queue set index */
108 qidx_t ipi_nsegs; /* number of segments */
110 qidx_t ipi_ndescs; /* number of descriptors used by encap */
111 uint16_t ipi_flags; /* iflib per-packet flags */
112 qidx_t ipi_pidx; /* start pidx for encap */
113 qidx_t ipi_new_pidx; /* next available pidx post-encap */
114 /* offload handling */
115 uint8_t ipi_ehdrlen; /* ether header length */
116 uint8_t ipi_ip_hlen; /* ip header length */
117 uint8_t ipi_tcp_hlen; /* tcp header length */
118 uint8_t ipi_ipproto; /* ip protocol */
120 uint32_t ipi_csum_flags; /* packet checksum flags */
121 uint16_t ipi_tso_segsz; /* tso segment size */
122 uint16_t ipi_vtag; /* VLAN tag */
123 uint16_t ipi_etype; /* ether header type */
124 uint8_t ipi_tcp_hflags; /* tcp header flags */
125 uint8_t ipi_mflags; /* packet mbuf flags */
127 uint32_t ipi_tcp_seq; /* tcp seqno */
128 uint8_t ipi_ip_tos; /* IP ToS field data */
133 typedef struct if_irq {
134 struct resource *ii_res;
139 struct if_int_delay_info {
140 if_ctx_t iidi_ctx; /* Back-pointer to the iflib ctx (softc) */
141 int iidi_offset; /* Register offset to read/write */
142 int iidi_value; /* Current value in usecs */
143 struct sysctl_oid *iidi_oidp;
144 struct sysctl_req *iidi_req;
154 * This really belongs in pciio.h or some place more general
155 * but this is the only consumer for now.
157 typedef struct pci_vendor_info {
158 uint32_t pvi_vendor_id;
159 uint32_t pvi_device_id;
160 uint32_t pvi_subvendor_id;
161 uint32_t pvi_subdevice_id;
163 uint32_t pvi_class_mask;
164 const char *pvi_name;
166 #define PVID(vendor, devid, name) {vendor, devid, 0, 0, 0, 0, name}
167 #define PVID_OEM(vendor, devid, svid, sdevid, revid, name) {vendor, devid, svid, sdevid, revid, 0, name}
168 #define PVID_END {0, 0, 0, 0, 0, 0, NULL}
170 /* No drivers in tree currently match on anything except vendor:device. */
171 #define IFLIB_PNP_DESCR "U32:vendor;U32:device;U32:#;U32:#;" \
173 #define IFLIB_PNP_INFO(b, u, t) \
174 MODULE_PNP_INFO(IFLIB_PNP_DESCR, b, u, t, nitems(t) - 1)
176 typedef struct if_txrx {
177 int (*ift_txd_encap) (void *, if_pkt_info_t);
178 void (*ift_txd_flush) (void *, uint16_t, qidx_t pidx);
179 int (*ift_txd_credits_update) (void *, uint16_t qsidx, bool clear);
181 int (*ift_rxd_available) (void *, uint16_t qsidx, qidx_t pidx, qidx_t budget);
182 int (*ift_rxd_pkt_get) (void *, if_rxd_info_t ri);
183 void (*ift_rxd_refill) (void * , if_rxd_update_t iru);
184 void (*ift_rxd_flush) (void *, uint16_t qsidx, uint8_t flidx, qidx_t pidx);
185 int (*ift_legacy_intr) (void *);
186 qidx_t (*ift_txq_select) (void *, struct mbuf *);
187 qidx_t (*ift_txq_select_v2) (void *, struct mbuf *, if_pkt_info_t);
190 typedef struct if_softc_ctx {
196 int isc_msix_bar; /* can be model specific - initialize in attach_pre */
197 int isc_tx_nsegments; /* can be model specific - initialize in attach_pre */
201 uint32_t isc_txqsizes[8];
202 uint32_t isc_rxqsizes[8];
203 /* is there such thing as a descriptor that is more than 248 bytes ? */
204 uint8_t isc_txd_size[8];
205 uint8_t isc_rxd_size[8];
207 int isc_tx_tso_segments_max;
208 int isc_tx_tso_size_max;
209 int isc_tx_tso_segsize_max;
210 int isc_tx_csum_flags;
211 int isc_capabilities;
213 int isc_rss_table_size;
214 int isc_rss_table_mask;
215 int isc_nrxqsets_max;
216 int isc_ntxqsets_max;
219 iflib_intr_mode_t isc_intr;
220 uint16_t isc_rxd_buf_size[8]; /* set at init time by driver, 0
221 means use iflib-calculated size
222 based on isc_max_frame_size */
223 uint16_t isc_max_frame_size; /* set at init time by driver */
224 uint16_t isc_min_frame_size; /* set at init time by driver, only used if
225 IFLIB_NEED_ETHER_PAD is set. */
226 uint32_t isc_pause_frames; /* set by driver for iflib_timer to detect */
234 int isc_disable_msix;
236 struct ifmedia *isc_media;
237 bus_size_t isc_dma_width; /* device dma width in bits, 0 means
238 use BUS_SPACE_MAXADDR instead */
242 * Initialization values for device
244 struct if_shared_ctx {
246 driver_t *isc_driver;
247 bus_size_t isc_q_align;
248 bus_size_t isc_tx_maxsize;
249 bus_size_t isc_tx_maxsegsize;
250 bus_size_t isc_tso_maxsize;
251 bus_size_t isc_tso_maxsegsize;
252 bus_size_t isc_rx_maxsize;
253 bus_size_t isc_rx_maxsegsize;
254 int isc_rx_nsegments;
255 int isc_admin_intrcnt; /* # of admin/link interrupts */
257 /* fields necessary for probe */
258 const pci_vendor_info_t *isc_vendor_info;
259 const char *isc_driver_version;
260 /* optional function to transform the read values to match the table*/
261 void (*isc_parse_devinfo) (uint16_t *device_id, uint16_t *subvendor_id,
262 uint16_t *subdevice_id, uint16_t *rev_id);
264 int isc_nrxd_default[8];
267 int isc_ntxd_default[8];
270 /* actively used during operation */
271 int isc_nfl __aligned(CACHE_LINE_SIZE);
272 int isc_ntxqs; /* # of tx queues per tx qset - usually 1 */
273 int isc_nrxqs; /* # of rx queues per rx qset - intel 1, chelsio 2, broadcom 3 */
275 int isc_tx_reclaim_thresh;
279 typedef struct iflib_dma_info {
280 bus_addr_t idi_paddr;
282 bus_dma_tag_t idi_tag;
283 bus_dmamap_t idi_map;
287 #define IFLIB_MAGIC 0xCAFEF00D
290 /* Interrupt or softirq handles only receive */
293 /* Interrupt or softirq handles only transmit */
297 * Interrupt will check for both pending receive
298 * and available tx credits and dispatch a task
299 * for one or both depending on the disposition
300 * of the respective queues.
305 * Other interrupt - typically link status and
306 * or error conditions.
310 /* Softirq (task) for iov handling */
315 * Interface has a separate completion queue for RX
317 #define IFLIB_HAS_RXCQ 0x01
319 * Driver has already allocated vectors
321 #define IFLIB_SKIP_MSIX 0x02
323 * Interface is a virtual function
325 #define IFLIB_IS_VF 0x04
327 * Interface has a separate completion queue for TX
329 #define IFLIB_HAS_TXCQ 0x08
331 * Interface does checksum in place
333 #define IFLIB_NEED_SCRATCH 0x10
335 * Interface doesn't expect in_pseudo for th_sum
337 #define IFLIB_TSO_INIT_IP 0x20
339 * Interface doesn't align IP header
341 #define IFLIB_DO_RX_FIXUP 0x40
343 * Driver needs csum zeroed for offloading
345 #define IFLIB_NEED_ZERO_CSUM 0x80
347 * Driver needs frames padded to some minimum length
349 #define IFLIB_NEED_ETHER_PAD 0x100
350 #define IFLIB_SPARE7 0x200
351 #define IFLIB_SPARE6 0x400
352 #define IFLIB_SPARE5 0x800
353 #define IFLIB_SPARE4 0x1000
354 #define IFLIB_SPARE3 0x2000
355 #define IFLIB_SPARE2 0x4000
356 #define IFLIB_SPARE1 0x8000
358 * Interface needs admin task to ignore interface up/down status
360 #define IFLIB_ADMIN_ALWAYS_RUN 0x10000
362 * Driver will pass the media
364 #define IFLIB_DRIVER_MEDIA 0x20000
366 * When using a single hardware interrupt for the interface, only process RX
367 * interrupts instead of doing combined RX/TX processing.
369 #define IFLIB_SINGLE_IRQ_RX_ONLY 0x40000
370 #define IFLIB_SPARE0 0x80000
372 * Interface has an admin completion queue
374 #define IFLIB_HAS_ADMINCQ 0x100000
376 * Interface needs to preserve TX ring indices across restarts.
378 #define IFLIB_PRESERVE_TX_INDICES 0x200000
380 /* The following IFLIB_FEATURE_* defines are for driver modules to determine
381 * what features this version of iflib supports. They shall be defined to the
382 * first __FreeBSD_version that introduced the feature.
385 * Driver can set its own TX queue selection function
386 * as ift_txq_select in struct if_txrx
388 #define IFLIB_FEATURE_QUEUE_SELECT 1400050
390 * Driver can set its own TX queue selection function
391 * as ift_txq_select_v2 in struct if_txrx. This includes
392 * having iflib send L3+ extra header information to the
395 #define IFLIB_FEATURE_QUEUE_SELECT_V2 1400073
398 * These enum values are used in iflib_needs_restart to indicate to iflib
399 * functions whether or not the interface needs restarting when certain events
402 enum iflib_restart_event {
403 IFLIB_RESTART_VLAN_CONFIG,
409 void *iflib_get_softc(if_ctx_t ctx);
411 device_t iflib_get_dev(if_ctx_t ctx);
413 if_t iflib_get_ifp(if_ctx_t ctx);
415 struct ifmedia *iflib_get_media(if_ctx_t ctx);
417 if_softc_ctx_t iflib_get_softc_ctx(if_ctx_t ctx);
418 if_shared_ctx_t iflib_get_sctx(if_ctx_t ctx);
420 void iflib_set_mac(if_ctx_t ctx, uint8_t mac[ETHER_ADDR_LEN]);
421 void iflib_request_reset(if_ctx_t ctx);
422 uint8_t iflib_in_detach(if_ctx_t ctx);
424 uint32_t iflib_get_rx_mbuf_sz(if_ctx_t ctx);
427 * If the driver can plug cleanly in to newbus use these
429 int iflib_device_probe(device_t);
430 int iflib_device_attach(device_t);
431 int iflib_device_detach(device_t);
432 int iflib_device_suspend(device_t);
433 int iflib_device_resume(device_t);
434 int iflib_device_shutdown(device_t);
437 * Use this instead of iflib_device_probe if the driver should report
438 * BUS_PROBE_VENDOR instead of BUS_PROBE_DEFAULT. (For example, an out-of-tree
439 * driver based on iflib).
441 int iflib_device_probe_vendor(device_t);
443 int iflib_device_iov_init(device_t, uint16_t, const nvlist_t *);
444 void iflib_device_iov_uninit(device_t);
445 int iflib_device_iov_add_vf(device_t, uint16_t, const nvlist_t *);
448 * If the driver can't plug cleanly in to newbus
451 int iflib_device_register(device_t dev, void *softc, if_shared_ctx_t sctx, if_ctx_t *ctxp);
452 int iflib_device_deregister(if_ctx_t);
454 int iflib_irq_alloc(if_ctx_t, if_irq_t, int, driver_filter_t, void *filter_arg,
455 driver_intr_t, void *arg, const char *name);
456 int iflib_irq_alloc_generic(if_ctx_t ctx, if_irq_t irq, int rid,
457 iflib_intr_type_t type, driver_filter_t *filter,
458 void *filter_arg, int qid, const char *name);
459 void iflib_softirq_alloc_generic(if_ctx_t ctx, if_irq_t irq,
460 iflib_intr_type_t type, void *arg, int qid,
463 void iflib_irq_free(if_ctx_t ctx, if_irq_t irq);
465 void iflib_io_tqg_attach(struct grouptask *gt, void *uniq, int cpu,
468 void iflib_config_gtask_init(void *ctx, struct grouptask *gtask,
469 gtask_fn_t *fn, const char *name);
470 void iflib_config_gtask_deinit(struct grouptask *gtask);
472 void iflib_tx_intr_deferred(if_ctx_t ctx, int txqid);
473 void iflib_rx_intr_deferred(if_ctx_t ctx, int rxqid);
474 void iflib_admin_intr_deferred(if_ctx_t ctx);
475 void iflib_iov_intr_deferred(if_ctx_t ctx);
477 void iflib_link_state_change(if_ctx_t ctx, int linkstate, uint64_t baudrate);
479 int iflib_dma_alloc(if_ctx_t ctx, int size, iflib_dma_info_t dma, int mapflags);
480 int iflib_dma_alloc_align(if_ctx_t ctx, int size, int align, iflib_dma_info_t dma, int mapflags);
481 void iflib_dma_free(iflib_dma_info_t dma);
482 int iflib_dma_alloc_multi(if_ctx_t ctx, int *sizes, iflib_dma_info_t *dmalist, int mapflags, int count);
484 void iflib_dma_free_multi(iflib_dma_info_t *dmalist, int count);
486 struct sx *iflib_ctx_lock_get(if_ctx_t);
488 void iflib_led_create(if_ctx_t ctx);
490 void iflib_add_int_delay_sysctl(if_ctx_t, const char *, const char *,
491 if_int_delay_info_t, int, int);
493 #endif /* __IFLIB_H_ */