2 * Copyright (c) 2014-2017, Matthew Macy (mmacy@nextbsd.org)
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.
34 #include <sys/cpuset.h>
35 #include <machine/bus.h>
36 #include <sys/bus_dma.h>
38 #include <sys/gtaskqueue.h>
41 * The value type for indexing, limits max descriptors
42 * to 65535 can be conditionally redefined to uint32_t
43 * in the future if the need arises.
45 typedef uint16_t qidx_t;
46 #define QIDX_INVALID 0xFFFF
48 * Most cards can handle much larger TSO requests
49 * but the FreeBSD TCP stack will break on larger
52 #define FREEBSD_TSO_SIZE_MAX 65518
56 typedef struct iflib_ctx *if_ctx_t;
58 typedef struct if_shared_ctx *if_shared_ctx_t;
59 struct if_int_delay_info;
60 typedef struct if_int_delay_info *if_int_delay_info_t;
66 * - iflib utility functions
67 * - iflib core functions
70 typedef struct if_rxd_frag {
76 typedef struct if_rxd_info {
78 uint16_t iri_qsidx; /* qset index */
79 uint16_t iri_vtag; /* vlan tag - if flag set */
80 /* XXX redundant with the new irf_len field */
81 uint16_t iri_len; /* packet length */
82 qidx_t iri_cidx; /* consumer index of cq */
83 struct ifnet *iri_ifp; /* some drivers >1 interface per softc */
85 /* updated by driver */
86 if_rxd_frag_t iri_frags;
87 uint32_t iri_flowid; /* RSS hash for packet */
88 uint32_t iri_csum_flags; /* m_pkthdr csum flags */
90 uint32_t iri_csum_data; /* m_pkthdr csum data */
91 uint8_t iri_flags; /* mbuf flags for packet */
92 uint8_t iri_nfrags; /* number of fragments in packet */
93 uint8_t iri_rsstype; /* RSS hash type */
94 uint8_t iri_pad; /* any padding in the received data */
97 typedef struct if_rxd_update {
104 uint16_t iru_buf_size;
108 #define IPI_TX_INTR 0x1 /* send an interrupt when this packet is sent */
109 #define IPI_TX_IPV4 0x2 /* ethertype IPv4 */
110 #define IPI_TX_IPV6 0x4 /* ethertype IPv6 */
112 typedef struct if_pkt_info {
113 bus_dma_segment_t *ipi_segs; /* physical addresses */
114 uint32_t ipi_len; /* packet length */
115 uint16_t ipi_qsidx; /* queue set index */
116 qidx_t ipi_nsegs; /* number of segments */
118 qidx_t ipi_ndescs; /* number of descriptors used by encap */
119 uint16_t ipi_flags; /* iflib per-packet flags */
120 qidx_t ipi_pidx; /* start pidx for encap */
121 qidx_t ipi_new_pidx; /* next available pidx post-encap */
122 /* offload handling */
123 uint8_t ipi_ehdrlen; /* ether header length */
124 uint8_t ipi_ip_hlen; /* ip header length */
125 uint8_t ipi_tcp_hlen; /* tcp header length */
126 uint8_t ipi_ipproto; /* ip protocol */
128 uint32_t ipi_csum_flags; /* packet checksum flags */
129 uint16_t ipi_tso_segsz; /* tso segment size */
130 uint16_t ipi_vtag; /* VLAN tag */
131 uint16_t ipi_etype; /* ether header type */
132 uint8_t ipi_tcp_hflags; /* tcp header flags */
133 uint8_t ipi_mflags; /* packet mbuf flags */
135 uint32_t ipi_tcp_seq; /* tcp seqno */
136 uint32_t ipi_tcp_sum; /* tcp csum */
139 typedef struct if_irq {
140 struct resource *ii_res;
145 struct if_int_delay_info {
146 if_ctx_t iidi_ctx; /* Back-pointer to the iflib ctx (softc) */
147 int iidi_offset; /* Register offset to read/write */
148 int iidi_value; /* Current value in usecs */
149 struct sysctl_oid *iidi_oidp;
150 struct sysctl_req *iidi_req;
160 * This really belongs in pciio.h or some place more general
161 * but this is the only consumer for now.
163 typedef struct pci_vendor_info {
164 uint32_t pvi_vendor_id;
165 uint32_t pvi_device_id;
166 uint32_t pvi_subvendor_id;
167 uint32_t pvi_subdevice_id;
169 uint32_t pvi_class_mask;
173 #define PVID(vendor, devid, name) {vendor, devid, 0, 0, 0, 0, name}
174 #define PVID_OEM(vendor, devid, svid, sdevid, revid, name) {vendor, devid, svid, sdevid, revid, 0, name}
175 #define PVID_END {0, 0, 0, 0, 0, 0, NULL}
177 typedef struct if_txrx {
178 int (*ift_txd_encap) (void *, if_pkt_info_t);
179 void (*ift_txd_flush) (void *, uint16_t, qidx_t pidx);
180 int (*ift_txd_credits_update) (void *, uint16_t qsidx, bool clear);
182 int (*ift_rxd_available) (void *, uint16_t qsidx, qidx_t pidx, qidx_t budget);
183 int (*ift_rxd_pkt_get) (void *, if_rxd_info_t ri);
184 void (*ift_rxd_refill) (void * , if_rxd_update_t iru);
185 void (*ift_rxd_flush) (void *, uint16_t qsidx, uint8_t flidx, qidx_t pidx);
186 int (*ift_legacy_intr) (void *);
189 typedef struct if_softc_ctx {
193 int isc_msix_bar; /* can be model specific - initialize in attach_pre */
194 int isc_tx_nsegments; /* can be model specific - initialize in attach_pre */
198 uint32_t isc_txqsizes[8];
199 uint32_t isc_rxqsizes[8];
200 /* is there such thing as a descriptor that is more than 248 bytes ? */
201 uint8_t isc_txd_size[8];
202 uint8_t isc_rxd_size[8];
206 int isc_tx_tso_segments_max;
207 int isc_tx_tso_size_max;
208 int isc_tx_tso_segsize_max;
209 int isc_tx_csum_flags;
211 int isc_rss_table_size;
212 int isc_rss_table_mask;
213 int isc_nrxqsets_max;
214 int isc_ntxqsets_max;
216 iflib_intr_mode_t isc_intr;
217 uint16_t isc_max_frame_size; /* set at init time by driver */
218 uint32_t isc_pause_frames; /* set by driver for iflib_timer to detect */
219 pci_vendor_info_t isc_vendor_info; /* set by iflib prior to attach_pre */
220 int isc_disable_msix;
225 * Initialization values for device
227 struct if_shared_ctx {
229 driver_t *isc_driver;
230 bus_size_t isc_q_align;
231 bus_size_t isc_tx_maxsize;
232 bus_size_t isc_tx_maxsegsize;
233 bus_size_t isc_rx_maxsize;
234 bus_size_t isc_rx_maxsegsize;
235 int isc_rx_nsegments;
236 int isc_admin_intrcnt; /* # of admin/link interrupts */
238 /* fields necessary for probe */
239 pci_vendor_info_t *isc_vendor_info;
240 char *isc_driver_version;
241 /* optional function to transform the read values to match the table*/
242 void (*isc_parse_devinfo) (uint16_t *device_id, uint16_t *subvendor_id,
243 uint16_t *subdevice_id, uint16_t *rev_id);
245 int isc_nrxd_default[8];
248 int isc_ntxd_default[8];
251 /* actively used during operation */
252 int isc_nfl __aligned(CACHE_LINE_SIZE);
253 int isc_ntxqs; /* # of tx queues per tx qset - usually 1 */
254 int isc_nrxqs; /* # of rx queues per rx qset - intel 1, chelsio 2, broadcom 3 */
255 int isc_rx_process_limit;
256 int isc_tx_reclaim_thresh;
260 typedef struct iflib_dma_info {
261 bus_addr_t idi_paddr;
263 bus_dma_tag_t idi_tag;
264 bus_dmamap_t idi_map;
268 #define IFLIB_MAGIC 0xCAFEF00D
279 #define ETH_ADDR_LEN 6
284 * Interface has a separate command queue for RX
286 #define IFLIB_HAS_RXCQ 0x01
288 * Driver has already allocated vectors
290 #define IFLIB_SKIP_MSIX 0x02
292 * Interface is a virtual function
294 #define IFLIB_IS_VF 0x04
296 * Interface has a separate command queue for TX
298 #define IFLIB_HAS_TXCQ 0x08
300 * Interface does checksum in place
302 #define IFLIB_NEED_SCRATCH 0x10
304 * Interface doesn't expect in_pseudo for th_sum
306 #define IFLIB_TSO_INIT_IP 0x20
308 * Interface doesn't align IP header
310 #define IFLIB_DO_RX_FIXUP 0x40
317 void *iflib_get_softc(if_ctx_t ctx);
319 device_t iflib_get_dev(if_ctx_t ctx);
321 if_t iflib_get_ifp(if_ctx_t ctx);
323 struct ifmedia *iflib_get_media(if_ctx_t ctx);
325 if_softc_ctx_t iflib_get_softc_ctx(if_ctx_t ctx);
326 if_shared_ctx_t iflib_get_sctx(if_ctx_t ctx);
328 void iflib_set_mac(if_ctx_t ctx, uint8_t mac[ETHER_ADDR_LEN]);
331 * If the driver can plug cleanly in to newbus use these
333 int iflib_device_probe(device_t);
334 int iflib_device_attach(device_t);
335 int iflib_device_detach(device_t);
336 int iflib_device_suspend(device_t);
337 int iflib_device_resume(device_t);
338 int iflib_device_shutdown(device_t);
341 int iflib_device_iov_init(device_t, uint16_t, const nvlist_t *);
342 void iflib_device_iov_uninit(device_t);
343 int iflib_device_iov_add_vf(device_t, uint16_t, const nvlist_t *);
346 * If the driver can't plug cleanly in to newbus
349 int iflib_device_register(device_t dev, void *softc, if_shared_ctx_t sctx, if_ctx_t *ctxp);
350 int iflib_device_deregister(if_ctx_t);
354 int iflib_irq_alloc(if_ctx_t, if_irq_t, int, driver_filter_t, void *filter_arg, driver_intr_t, void *arg, char *name);
355 int iflib_irq_alloc_generic(if_ctx_t ctx, if_irq_t irq, int rid,
356 iflib_intr_type_t type, driver_filter_t *filter,
357 void *filter_arg, int qid, char *name);
358 void iflib_softirq_alloc_generic(if_ctx_t ctx, int rid, iflib_intr_type_t type, void *arg, int qid, char *name);
360 void iflib_irq_free(if_ctx_t ctx, if_irq_t irq);
362 void iflib_io_tqg_attach(struct grouptask *gt, void *uniq, int cpu, char *name);
364 void iflib_config_gtask_init(if_ctx_t ctx, struct grouptask *gtask,
365 gtask_fn_t *fn, char *name);
367 void iflib_config_gtask_deinit(struct grouptask *gtask);
371 void iflib_tx_intr_deferred(if_ctx_t ctx, int txqid);
372 void iflib_rx_intr_deferred(if_ctx_t ctx, int rxqid);
373 void iflib_admin_intr_deferred(if_ctx_t ctx);
374 void iflib_iov_intr_deferred(if_ctx_t ctx);
377 void iflib_link_state_change(if_ctx_t ctx, int linkstate, uint64_t baudrate);
379 int iflib_dma_alloc(if_ctx_t ctx, int size, iflib_dma_info_t dma, int mapflags);
380 void iflib_dma_free(iflib_dma_info_t dma);
382 int iflib_dma_alloc_multi(if_ctx_t ctx, int *sizes, iflib_dma_info_t *dmalist, int mapflags, int count);
384 void iflib_dma_free_multi(iflib_dma_info_t *dmalist, int count);
387 struct mtx *iflib_ctx_lock_get(if_ctx_t);
388 struct mtx *iflib_qset_lock_get(if_ctx_t, uint16_t);
390 void iflib_led_create(if_ctx_t ctx);
392 void iflib_add_int_delay_sysctl(if_ctx_t, const char *, const char *,
393 if_int_delay_info_t, int, int);
395 #endif /* __IFLIB_H_ */