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 #ifndef __IFLIB_H_ 28 #define __IFLIB_H_ 29 30 #include <sys/kobj.h> 31 #include <sys/bus.h> 32 #include <sys/cpuset.h> 33 #include <machine/bus.h> 34 #include <sys/nv.h> 35 #include <sys/gtaskqueue.h> 36 37 /* 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. 41 */ 42 typedef uint16_t qidx_t; 43 #define QIDX_INVALID 0xFFFF 44 45 struct iflib_ctx; 46 typedef struct iflib_ctx *if_ctx_t; 47 struct if_shared_ctx; 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; 51 52 /* 53 * File organization: 54 * - public structures 55 * - iflib accessors 56 * - iflib utility functions 57 * - iflib core functions 58 */ 59 60 typedef struct if_rxd_frag { 61 uint8_t irf_flid; 62 qidx_t irf_idx; 63 uint16_t irf_len; 64 } *if_rxd_frag_t; 65 66 /* bnxt supports 64 with hardware LRO enabled */ 67 #define IFLIB_MAX_RX_SEGS 64 68 69 typedef struct if_rxd_info { 70 /* set by iflib */ 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 */ 77 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 */ 82 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 */ 88 } *if_rxd_info_t; 89 90 typedef struct if_rxd_update { 91 uint64_t *iru_paddrs; 92 qidx_t *iru_idxs; 93 qidx_t iru_pidx; 94 uint16_t iru_qsidx; 95 uint16_t iru_count; 96 uint16_t iru_buf_size; 97 uint8_t iru_flidx; 98 } *if_rxd_update_t; 99 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 */ 103 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 */ 109 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 */ 119 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 uint16_t ipi_tcp_hflags; /* tcp header flags */ 125 126 uint32_t ipi_tcp_seq; /* tcp seqno */ 127 uint8_t ipi_ip_tos; /* IP ToS field data */ 128 uint8_t ipi_mflags; /* packet mbuf flags */ 129 uint8_t __spare0__; 130 uint8_t __spare1__; 131 struct mbuf *ipi_mbuf; /* mbuf for ktls */ 132 } *if_pkt_info_t; 133 134 typedef struct if_irq { 135 struct resource *ii_res; 136 int __spare0__; 137 void *ii_tag; 138 } *if_irq_t; 139 140 struct if_int_delay_info { 141 if_ctx_t iidi_ctx; /* Back-pointer to the iflib ctx (softc) */ 142 int iidi_offset; /* Register offset to read/write */ 143 int iidi_value; /* Current value in usecs */ 144 struct sysctl_oid *iidi_oidp; 145 struct sysctl_req *iidi_req; 146 }; 147 148 typedef enum { 149 IFLIB_INTR_LEGACY, 150 IFLIB_INTR_MSI, 151 IFLIB_INTR_MSIX 152 } iflib_intr_mode_t; 153 154 /* 155 * This really belongs in pciio.h or some place more general 156 * but this is the only consumer for now. 157 */ 158 typedef struct pci_vendor_info { 159 uint32_t pvi_vendor_id; 160 uint32_t pvi_device_id; 161 uint32_t pvi_subvendor_id; 162 uint32_t pvi_subdevice_id; 163 uint32_t pvi_rev_id; 164 uint32_t pvi_class_mask; 165 const char *pvi_name; 166 } pci_vendor_info_t; 167 #define PVID(vendor, devid, name) {vendor, devid, 0, 0, 0, 0, name} 168 #define PVID_OEM(vendor, devid, svid, sdevid, revid, name) {vendor, devid, svid, sdevid, revid, 0, name} 169 #define PVID_END {0, 0, 0, 0, 0, 0, NULL} 170 171 /* No drivers in tree currently match on anything except vendor:device. */ 172 #define IFLIB_PNP_DESCR "U32:vendor;U32:device;U32:#;U32:#;" \ 173 "U32:#;U32:#;D:#" 174 #define IFLIB_PNP_INFO(b, u, t) \ 175 MODULE_PNP_INFO(IFLIB_PNP_DESCR, b, u, t, nitems(t) - 1) 176 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); 181 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 *); 187 qidx_t (*ift_txq_select) (void *, struct mbuf *); 188 qidx_t (*ift_txq_select_v2) (void *, struct mbuf *, if_pkt_info_t); 189 } *if_txrx_t; 190 191 typedef struct if_softc_ctx { 192 int isc_vectors; 193 int isc_nrxqsets; 194 int isc_ntxqsets; 195 uint16_t isc_tx_pad; 196 uint32_t __spare1__; 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 __spare2__; 219 220 iflib_intr_mode_t isc_intr; 221 uint16_t isc_rxd_buf_size[8]; /* set at init time by driver, 0 222 means use iflib-calculated size 223 based on isc_max_frame_size */ 224 uint16_t isc_max_frame_size; /* set at init time by driver */ 225 uint16_t isc_min_frame_size; /* set at init time by driver, only used if 226 IFLIB_NEED_ETHER_PAD is set. */ 227 uint32_t isc_pause_frames; /* set by driver for iflib_timer to detect */ 228 uint32_t __spare3__; 229 uint32_t __spare4__; 230 uint32_t __spare5__; 231 uint32_t __spare6__; 232 uint32_t __spare7__; 233 uint32_t __spare8__; 234 caddr_t __spare9__; 235 int isc_disable_msix; 236 if_txrx_t isc_txrx; 237 struct ifmedia *isc_media; 238 bus_size_t isc_dma_width; /* device dma width in bits, 0 means 239 use BUS_SPACE_MAXADDR instead */ 240 } *if_softc_ctx_t; 241 242 /* 243 * Initialization values for device 244 */ 245 struct if_shared_ctx { 246 unsigned isc_magic; 247 driver_t *isc_driver; 248 bus_size_t isc_q_align; 249 bus_size_t isc_tx_maxsize; 250 bus_size_t isc_tx_maxsegsize; 251 bus_size_t isc_tso_maxsize; 252 bus_size_t isc_tso_maxsegsize; 253 bus_size_t isc_rx_maxsize; 254 bus_size_t isc_rx_maxsegsize; 255 int isc_rx_nsegments; 256 int isc_admin_intrcnt; /* # of admin/link interrupts */ 257 258 /* fields necessary for probe */ 259 const pci_vendor_info_t *isc_vendor_info; 260 const char *isc_driver_version; 261 /* optional function to transform the read values to match the table*/ 262 void (*isc_parse_devinfo) (uint16_t *device_id, uint16_t *subvendor_id, 263 uint16_t *subdevice_id, uint16_t *rev_id); 264 int isc_nrxd_min[8]; 265 int isc_nrxd_default[8]; 266 int isc_nrxd_max[8]; 267 int isc_ntxd_min[8]; 268 int isc_ntxd_default[8]; 269 int isc_ntxd_max[8]; 270 271 /* actively used during operation */ 272 int isc_nfl __aligned(CACHE_LINE_SIZE); 273 int isc_ntxqs; /* # of tx queues per tx qset - usually 1 */ 274 int isc_nrxqs; /* # of rx queues per rx qset - intel 1, chelsio 2, broadcom 3 */ 275 int __spare0__; 276 int __spare1__; 277 int isc_flags; 278 }; 279 280 typedef struct iflib_dma_info { 281 bus_addr_t idi_paddr; 282 caddr_t idi_vaddr; 283 bus_dma_tag_t idi_tag; 284 bus_dmamap_t idi_map; 285 uint32_t idi_size; 286 } *iflib_dma_info_t; 287 288 #define IFLIB_MAGIC 0xCAFEF00D 289 290 typedef enum { 291 /* Interrupt or softirq handles only receive */ 292 IFLIB_INTR_RX, 293 294 /* Interrupt or softirq handles only transmit */ 295 IFLIB_INTR_TX, 296 297 /* 298 * Interrupt will check for both pending receive 299 * and available tx credits and dispatch a task 300 * for one or both depending on the disposition 301 * of the respective queues. 302 */ 303 IFLIB_INTR_RXTX, 304 305 /* 306 * Other interrupt - typically link status and 307 * or error conditions. 308 */ 309 IFLIB_INTR_ADMIN, 310 311 /* Softirq (task) for iov handling */ 312 IFLIB_INTR_IOV, 313 } iflib_intr_type_t; 314 315 /* 316 * Interface has a separate completion queue for RX 317 */ 318 #define IFLIB_HAS_RXCQ 0x01 319 /* 320 * Driver has already allocated vectors 321 */ 322 #define IFLIB_SKIP_MSIX 0x02 323 /* 324 * Interface is a virtual function 325 */ 326 #define IFLIB_IS_VF 0x04 327 /* 328 * Interface has a separate completion queue for TX 329 */ 330 #define IFLIB_HAS_TXCQ 0x08 331 /* 332 * Interface does checksum in place 333 */ 334 #define IFLIB_NEED_SCRATCH 0x10 335 /* 336 * Interface doesn't expect in_pseudo for th_sum 337 */ 338 #define IFLIB_TSO_INIT_IP 0x20 339 /* 340 * Interface doesn't align IP header 341 */ 342 #define IFLIB_DO_RX_FIXUP 0x40 343 /* 344 * Driver needs csum zeroed for offloading 345 */ 346 #define IFLIB_NEED_ZERO_CSUM 0x80 347 /* 348 * Driver needs frames padded to some minimum length 349 */ 350 #define IFLIB_NEED_ETHER_PAD 0x100 351 /* 352 * Driver understands page/bank i2c reads 353 */ 354 #define IFLIB_I2C_PAGE_BANK 0x200 355 #define IFLIB_SPARE6 0x400 356 #define IFLIB_SPARE5 0x800 357 #define IFLIB_SPARE4 0x1000 358 #define IFLIB_SPARE3 0x2000 359 #define IFLIB_SPARE2 0x4000 360 #define IFLIB_SPARE1 0x8000 361 /* 362 * Interface needs admin task to ignore interface up/down status 363 */ 364 #define IFLIB_ADMIN_ALWAYS_RUN 0x10000 365 /* 366 * Driver will pass the media 367 */ 368 #define IFLIB_DRIVER_MEDIA 0x20000 369 /* 370 * When using a single hardware interrupt for the interface, only process RX 371 * interrupts instead of doing combined RX/TX processing. 372 */ 373 #define IFLIB_SINGLE_IRQ_RX_ONLY 0x40000 374 #define IFLIB_SPARE0 0x80000 375 /* 376 * Interface has an admin completion queue 377 */ 378 #define IFLIB_HAS_ADMINCQ 0x100000 379 /* 380 * Interface needs to preserve TX ring indices across restarts. 381 */ 382 #define IFLIB_PRESERVE_TX_INDICES 0x200000 383 384 /* The following IFLIB_FEATURE_* defines are for driver modules to determine 385 * what features this version of iflib supports. They shall be defined to the 386 * first __FreeBSD_version that introduced the feature. 387 */ 388 /* 389 * Driver can set its own TX queue selection function 390 * as ift_txq_select in struct if_txrx 391 */ 392 #define IFLIB_FEATURE_QUEUE_SELECT 1400050 393 /* 394 * Driver can set its own TX queue selection function 395 * as ift_txq_select_v2 in struct if_txrx. This includes 396 * having iflib send L3+ extra header information to the 397 * function. 398 */ 399 #define IFLIB_FEATURE_QUEUE_SELECT_V2 1400073 400 /* 401 * Driver can create subinterfaces with their own Tx/Rx queues 402 * that all share a single device (or commonly, port) 403 */ 404 #define IFLIB_FEATURE_SUB_INTERFACES 1500014 405 406 /* 407 * These enum values are used in iflib_needs_restart to indicate to iflib 408 * functions whether or not the interface needs restarting when certain events 409 * happen. 410 */ 411 enum iflib_restart_event { 412 IFLIB_RESTART_VLAN_CONFIG, 413 }; 414 415 /* 416 * field accessors 417 */ 418 void *iflib_get_softc(if_ctx_t ctx); 419 420 device_t iflib_get_dev(if_ctx_t ctx); 421 422 if_t iflib_get_ifp(if_ctx_t ctx); 423 424 struct ifmedia *iflib_get_media(if_ctx_t ctx); 425 426 if_softc_ctx_t iflib_get_softc_ctx(if_ctx_t ctx); 427 if_shared_ctx_t iflib_get_sctx(if_ctx_t ctx); 428 429 void iflib_set_mac(if_ctx_t ctx, uint8_t mac[ETHER_ADDR_LEN]); 430 void iflib_request_reset(if_ctx_t ctx); 431 uint8_t iflib_in_detach(if_ctx_t ctx); 432 433 uint32_t iflib_get_rx_mbuf_sz(if_ctx_t ctx); 434 435 /* 436 * If the driver can plug cleanly in to newbus use these 437 */ 438 int iflib_device_probe(device_t); 439 int iflib_device_attach(device_t); 440 int iflib_device_detach(device_t); 441 int iflib_device_suspend(device_t); 442 int iflib_device_resume(device_t); 443 int iflib_device_shutdown(device_t); 444 445 /* 446 * Use this instead of iflib_device_probe if the driver should report 447 * BUS_PROBE_VENDOR instead of BUS_PROBE_DEFAULT. (For example, an out-of-tree 448 * driver based on iflib). 449 */ 450 int iflib_device_probe_vendor(device_t); 451 452 int iflib_device_iov_init(device_t, uint16_t, const nvlist_t *); 453 void iflib_device_iov_uninit(device_t); 454 int iflib_device_iov_add_vf(device_t, uint16_t, const nvlist_t *); 455 456 /* 457 * If the driver can't plug cleanly in to newbus 458 * use these 459 */ 460 int iflib_device_register(device_t dev, void *softc, if_shared_ctx_t sctx, if_ctx_t *ctxp); 461 int iflib_device_deregister(if_ctx_t); 462 463 int iflib_irq_alloc(if_ctx_t, if_irq_t, int, driver_filter_t, void *filter_arg, 464 driver_intr_t, void *arg, const char *name); 465 int iflib_irq_alloc_generic(if_ctx_t ctx, if_irq_t irq, int rid, 466 iflib_intr_type_t type, driver_filter_t *filter, 467 void *filter_arg, int qid, const char *name); 468 void iflib_softirq_alloc_generic(if_ctx_t ctx, if_irq_t irq, 469 iflib_intr_type_t type, void *arg, int qid, 470 const char *name); 471 472 void iflib_irq_free(if_ctx_t ctx, if_irq_t irq); 473 474 void iflib_io_tqg_attach(struct grouptask *gt, void *uniq, int cpu, 475 const char *name); 476 477 void iflib_config_task_init(if_ctx_t ctx, struct task *config_task, 478 task_fn_t *fn); 479 void iflib_config_task_enqueue(if_ctx_t ctx, struct task *config_task); 480 481 void iflib_tx_intr_deferred(if_ctx_t ctx, int txqid); 482 void iflib_rx_intr_deferred(if_ctx_t ctx, int rxqid); 483 void iflib_admin_intr_deferred(if_ctx_t ctx); 484 void iflib_iov_intr_deferred(if_ctx_t ctx); 485 486 void iflib_link_state_change(if_ctx_t ctx, int linkstate, uint64_t baudrate); 487 488 int iflib_dma_alloc(if_ctx_t ctx, int size, iflib_dma_info_t dma, int mapflags); 489 int iflib_dma_alloc_align(if_ctx_t ctx, int size, int align, iflib_dma_info_t dma, int mapflags); 490 void iflib_dma_free(iflib_dma_info_t dma); 491 int iflib_dma_alloc_multi(if_ctx_t ctx, int *sizes, iflib_dma_info_t *dmalist, int mapflags, int count); 492 493 void iflib_dma_free_multi(iflib_dma_info_t *dmalist, int count); 494 495 struct sx *iflib_ctx_lock_get(if_ctx_t); 496 497 void iflib_led_create(if_ctx_t ctx); 498 499 void iflib_add_int_delay_sysctl(if_ctx_t, const char *, const char *, 500 if_int_delay_info_t, int, int); 501 uint16_t iflib_get_extra_msix_vectors_sysctl(if_ctx_t ctx); 502 503 /* 504 * Sub-interface support 505 */ 506 int iflib_irq_alloc_generic_subctx(if_ctx_t ctx, if_ctx_t subctx, if_irq_t irq, 507 int rid, iflib_intr_type_t type, 508 driver_filter_t *filter, void *filter_arg, 509 int qid, const char *name); 510 #endif /* __IFLIB_H_ */ 511