1 /*- 2 * Copyright (c) 2014-2017, Matthew Macy (mmacy@mattmacy.io) 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/nv.h> 37 #include <sys/gtaskqueue.h> 38 39 struct if_clone; 40 41 /* 42 * The value type for indexing, limits max descriptors 43 * to 65535 can be conditionally redefined to uint32_t 44 * in the future if the need arises. 45 */ 46 typedef uint16_t qidx_t; 47 #define QIDX_INVALID 0xFFFF 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 struct if_pseudo; 56 typedef struct if_pseudo *if_pseudo_t; 57 58 /* 59 * File organization: 60 * - public structures 61 * - iflib accessors 62 * - iflib utility functions 63 * - iflib core functions 64 */ 65 66 typedef struct if_rxd_frag { 67 uint8_t irf_flid; 68 qidx_t irf_idx; 69 uint16_t irf_len; 70 } *if_rxd_frag_t; 71 72 typedef struct if_rxd_info { 73 /* set by iflib */ 74 uint16_t iri_qsidx; /* qset index */ 75 uint16_t iri_vtag; /* vlan tag - if flag set */ 76 /* XXX redundant with the new irf_len field */ 77 uint16_t iri_len; /* packet length */ 78 qidx_t iri_cidx; /* consumer index of cq */ 79 struct ifnet *iri_ifp; /* some drivers >1 interface per softc */ 80 81 /* updated by driver */ 82 if_rxd_frag_t iri_frags; 83 uint32_t iri_flowid; /* RSS hash for packet */ 84 uint32_t iri_csum_flags; /* m_pkthdr csum flags */ 85 86 uint32_t iri_csum_data; /* m_pkthdr csum data */ 87 uint8_t iri_flags; /* mbuf flags for packet */ 88 uint8_t iri_nfrags; /* number of fragments in packet */ 89 uint8_t iri_rsstype; /* RSS hash type */ 90 uint8_t iri_pad; /* any padding in the received data */ 91 } *if_rxd_info_t; 92 93 typedef struct if_rxd_update { 94 uint64_t *iru_paddrs; 95 caddr_t *iru_vaddrs; 96 qidx_t *iru_idxs; 97 qidx_t iru_pidx; 98 uint16_t iru_qsidx; 99 uint16_t iru_count; 100 uint16_t iru_buf_size; 101 uint8_t iru_flidx; 102 } *if_rxd_update_t; 103 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 */ 107 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 */ 113 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 */ 123 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 */ 130 131 uint32_t ipi_tcp_seq; /* tcp seqno */ 132 uint32_t ipi_tcp_sum; /* tcp csum */ 133 } *if_pkt_info_t; 134 135 typedef struct if_irq { 136 struct resource *ii_res; 137 int ii_rid; 138 void *ii_tag; 139 } *if_irq_t; 140 141 struct if_int_delay_info { 142 if_ctx_t iidi_ctx; /* Back-pointer to the iflib ctx (softc) */ 143 int iidi_offset; /* Register offset to read/write */ 144 int iidi_value; /* Current value in usecs */ 145 struct sysctl_oid *iidi_oidp; 146 struct sysctl_req *iidi_req; 147 }; 148 149 typedef enum { 150 IFLIB_INTR_LEGACY, 151 IFLIB_INTR_MSI, 152 IFLIB_INTR_MSIX 153 } iflib_intr_mode_t; 154 155 /* 156 * This really belongs in pciio.h or some place more general 157 * but this is the only consumer for now. 158 */ 159 typedef struct pci_vendor_info { 160 uint32_t pvi_vendor_id; 161 uint32_t pvi_device_id; 162 uint32_t pvi_subvendor_id; 163 uint32_t pvi_subdevice_id; 164 uint32_t pvi_rev_id; 165 uint32_t pvi_class_mask; 166 caddr_t pvi_name; 167 } pci_vendor_info_t; 168 169 #define PVID(vendor, devid, name) {vendor, devid, 0, 0, 0, 0, name} 170 #define PVID_OEM(vendor, devid, svid, sdevid, revid, name) {vendor, devid, svid, sdevid, revid, 0, name} 171 #define PVID_END {0, 0, 0, 0, 0, 0, NULL} 172 173 #define IFLIB_PNP_DESCR "U32:vendor;U32:device;U32:subvendor;U32:subdevice;" \ 174 "U32:revision;U32:class;D:#" 175 #define IFLIB_PNP_INFO(b, u, t) \ 176 MODULE_PNP_INFO(IFLIB_PNP_DESCR, b, u, t, nitems(t) - 1) 177 178 typedef struct if_txrx { 179 int (*ift_txd_encap) (void *, if_pkt_info_t); 180 void (*ift_txd_flush) (void *, uint16_t, qidx_t pidx); 181 int (*ift_txd_credits_update) (void *, uint16_t qsidx, bool clear); 182 183 int (*ift_rxd_available) (void *, uint16_t qsidx, qidx_t pidx, qidx_t budget); 184 int (*ift_rxd_pkt_get) (void *, if_rxd_info_t ri); 185 void (*ift_rxd_refill) (void * , if_rxd_update_t iru); 186 void (*ift_rxd_flush) (void *, uint16_t qsidx, uint8_t flidx, qidx_t pidx); 187 int (*ift_legacy_intr) (void *); 188 } *if_txrx_t; 189 190 typedef struct if_softc_ctx { 191 int isc_vectors; 192 int isc_nrxqsets; 193 int isc_ntxqsets; 194 uint8_t isc_min_tx_latency; /* disable doorbell update batching */ 195 uint8_t isc_rx_mvec_enable; /* generate mvecs on rx */ 196 uint32_t isc_txrx_budget_bytes_max; 197 int isc_msix_bar; /* can be model specific - initialize in attach_pre */ 198 int isc_tx_nsegments; /* can be model specific - initialize in attach_pre */ 199 int isc_ntxd[8]; 200 int isc_nrxd[8]; 201 202 uint32_t isc_txqsizes[8]; 203 uint32_t isc_rxqsizes[8]; 204 /* is there such thing as a descriptor that is more than 248 bytes ? */ 205 uint8_t isc_txd_size[8]; 206 uint8_t isc_rxd_size[8]; 207 208 int isc_tx_tso_segments_max; 209 int isc_tx_tso_size_max; 210 int isc_tx_tso_segsize_max; 211 int isc_tx_csum_flags; 212 int isc_capabilities; 213 int isc_capenable; 214 int isc_rss_table_size; 215 int isc_rss_table_mask; 216 int isc_nrxqsets_max; 217 int isc_ntxqsets_max; 218 uint32_t isc_tx_qdepth; 219 220 iflib_intr_mode_t isc_intr; 221 uint16_t isc_max_frame_size; /* set at init time by driver */ 222 uint16_t isc_min_frame_size; /* set at init time by driver, only used if 223 IFLIB_NEED_ETHER_PAD is set. */ 224 uint32_t isc_pause_frames; /* set by driver for iflib_timer to detect */ 225 pci_vendor_info_t isc_vendor_info; /* set by iflib prior to attach_pre */ 226 int isc_disable_msix; 227 if_txrx_t isc_txrx; 228 } *if_softc_ctx_t; 229 230 /* 231 * Initialization values for device 232 */ 233 struct if_shared_ctx { 234 unsigned isc_magic; 235 driver_t *isc_driver; 236 bus_size_t isc_q_align; 237 bus_size_t isc_tx_maxsize; 238 bus_size_t isc_tx_maxsegsize; 239 bus_size_t isc_tso_maxsize; 240 bus_size_t isc_tso_maxsegsize; 241 bus_size_t isc_rx_maxsize; 242 bus_size_t isc_rx_maxsegsize; 243 int isc_rx_nsegments; 244 int isc_admin_intrcnt; /* # of admin/link interrupts */ 245 246 /* fields necessary for probe */ 247 pci_vendor_info_t *isc_vendor_info; 248 char *isc_driver_version; 249 /* optional function to transform the read values to match the table*/ 250 void (*isc_parse_devinfo) (uint16_t *device_id, uint16_t *subvendor_id, 251 uint16_t *subdevice_id, uint16_t *rev_id); 252 int isc_nrxd_min[8]; 253 int isc_nrxd_default[8]; 254 int isc_nrxd_max[8]; 255 int isc_ntxd_min[8]; 256 int isc_ntxd_default[8]; 257 int isc_ntxd_max[8]; 258 259 /* actively used during operation */ 260 int isc_nfl __aligned(CACHE_LINE_SIZE); 261 int isc_ntxqs; /* # of tx queues per tx qset - usually 1 */ 262 int isc_nrxqs; /* # of rx queues per rx qset - intel 1, chelsio 2, broadcom 3 */ 263 int isc_rx_process_limit; 264 int isc_tx_reclaim_thresh; 265 int isc_flags; 266 const char *isc_name; 267 }; 268 269 typedef struct iflib_dma_info { 270 bus_addr_t idi_paddr; 271 caddr_t idi_vaddr; 272 bus_dma_tag_t idi_tag; 273 bus_dmamap_t idi_map; 274 uint32_t idi_size; 275 } *iflib_dma_info_t; 276 277 #define IFLIB_MAGIC 0xCAFEF00D 278 279 typedef enum { 280 IFLIB_INTR_RX, 281 IFLIB_INTR_TX, 282 IFLIB_INTR_RXTX, 283 IFLIB_INTR_ADMIN, 284 IFLIB_INTR_IOV, 285 } iflib_intr_type_t; 286 287 #ifndef ETH_ADDR_LEN 288 #define ETH_ADDR_LEN 6 289 #endif 290 291 292 /* 293 * Interface has a separate command queue for RX 294 */ 295 #define IFLIB_HAS_RXCQ 0x01 296 /* 297 * Driver has already allocated vectors 298 */ 299 #define IFLIB_SKIP_MSIX 0x02 300 /* 301 * Interface is a virtual function 302 */ 303 #define IFLIB_IS_VF 0x04 304 /* 305 * Interface has a separate command queue for TX 306 */ 307 #define IFLIB_HAS_TXCQ 0x08 308 /* 309 * Interface does checksum in place 310 */ 311 #define IFLIB_NEED_SCRATCH 0x10 312 /* 313 * Interface doesn't expect in_pseudo for th_sum 314 */ 315 #define IFLIB_TSO_INIT_IP 0x20 316 /* 317 * Interface doesn't align IP header 318 */ 319 #define IFLIB_DO_RX_FIXUP 0x40 320 /* 321 * Driver needs csum zeroed for offloading 322 */ 323 #define IFLIB_NEED_ZERO_CSUM 0x80 324 /* 325 * Driver needs frames padded to some minimum length 326 */ 327 #define IFLIB_NEED_ETHER_PAD 0x100 328 /* 329 * Packets can be freed immediately after encap 330 */ 331 #define IFLIB_TXD_ENCAP_PIO 0x00200 332 /* 333 * Use RX completion handler 334 */ 335 #define IFLIB_RX_COMPLETION 0x00400 336 /* 337 * Skip refilling cluster free lists 338 */ 339 #define IFLIB_SKIP_CLREFILL 0x00800 340 /* 341 * Don't reset on hang 342 */ 343 #define IFLIB_NO_HANG_RESET 0x01000 344 /* 345 * Don't need/want most of the niceties of 346 * queue management 347 */ 348 #define IFLIB_PSEUDO 0x02000 349 /* 350 * No DMA support needed / wanted 351 */ 352 #define IFLIB_VIRTUAL 0x04000 353 /* 354 * autogenerate a MAC address 355 */ 356 #define IFLIB_GEN_MAC 0x08000 357 /* 358 * Interface needs admin task to ignore interface up/down status 359 */ 360 #define IFLIB_ADMIN_ALWAYS_RUN 0x10000 361 362 363 /* 364 * field accessors 365 */ 366 void *iflib_get_softc(if_ctx_t ctx); 367 368 device_t iflib_get_dev(if_ctx_t ctx); 369 370 if_t iflib_get_ifp(if_ctx_t ctx); 371 372 struct ifmedia *iflib_get_media(if_ctx_t ctx); 373 374 if_softc_ctx_t iflib_get_softc_ctx(if_ctx_t ctx); 375 if_shared_ctx_t iflib_get_sctx(if_ctx_t ctx); 376 377 void iflib_set_mac(if_ctx_t ctx, uint8_t mac[ETHER_ADDR_LEN]); 378 void iflib_request_reset(if_ctx_t ctx); 379 uint8_t iflib_in_detach(if_ctx_t ctx); 380 381 /* 382 * If the driver can plug cleanly in to newbus use these 383 */ 384 int iflib_device_probe(device_t); 385 int iflib_device_attach(device_t); 386 int iflib_device_detach(device_t); 387 int iflib_device_suspend(device_t); 388 int iflib_device_resume(device_t); 389 int iflib_device_shutdown(device_t); 390 391 392 int iflib_device_iov_init(device_t, uint16_t, const nvlist_t *); 393 void iflib_device_iov_uninit(device_t); 394 int iflib_device_iov_add_vf(device_t, uint16_t, const nvlist_t *); 395 396 /* 397 * If the driver can't plug cleanly in to newbus 398 * use these 399 */ 400 int iflib_device_register(device_t dev, void *softc, if_shared_ctx_t sctx, if_ctx_t *ctxp); 401 int iflib_device_deregister(if_ctx_t); 402 403 404 405 int iflib_irq_alloc(if_ctx_t, if_irq_t, int, driver_filter_t, void *filter_arg, driver_intr_t, void *arg, const char *name); 406 int iflib_irq_alloc_generic(if_ctx_t ctx, if_irq_t irq, int rid, 407 iflib_intr_type_t type, driver_filter_t *filter, 408 void *filter_arg, int qid, const char *name); 409 void iflib_softirq_alloc_generic(if_ctx_t ctx, if_irq_t irq, iflib_intr_type_t type, void *arg, int qid, const char *name); 410 411 void iflib_irq_free(if_ctx_t ctx, if_irq_t irq); 412 413 void iflib_io_tqg_attach(struct grouptask *gt, void *uniq, int cpu, char *name); 414 415 void iflib_config_gtask_init(void *ctx, struct grouptask *gtask, 416 gtask_fn_t *fn, const char *name); 417 418 void iflib_config_gtask_deinit(struct grouptask *gtask); 419 420 421 422 void iflib_tx_intr_deferred(if_ctx_t ctx, int txqid); 423 void iflib_rx_intr_deferred(if_ctx_t ctx, int rxqid); 424 void iflib_admin_intr_deferred(if_ctx_t ctx); 425 void iflib_iov_intr_deferred(if_ctx_t ctx); 426 427 428 void iflib_link_state_change(if_ctx_t ctx, int linkstate, uint64_t baudrate); 429 430 int iflib_dma_alloc(if_ctx_t ctx, int size, iflib_dma_info_t dma, int mapflags); 431 void iflib_dma_free(iflib_dma_info_t dma); 432 433 int iflib_dma_alloc_multi(if_ctx_t ctx, int *sizes, iflib_dma_info_t *dmalist, int mapflags, int count); 434 435 void iflib_dma_free_multi(iflib_dma_info_t *dmalist, int count); 436 437 438 struct sx *iflib_ctx_lock_get(if_ctx_t); 439 struct mtx *iflib_qset_lock_get(if_ctx_t, uint16_t); 440 441 void iflib_led_create(if_ctx_t ctx); 442 443 void iflib_add_int_delay_sysctl(if_ctx_t, const char *, const char *, 444 if_int_delay_info_t, int, int); 445 446 /* 447 * Pseudo device support 448 */ 449 if_pseudo_t iflib_clone_register(if_shared_ctx_t); 450 void iflib_clone_deregister(if_pseudo_t); 451 #endif /* __IFLIB_H_ */ 452