sys/net/iflib.h

   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 const 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 /* bnxt supports 64 with hardware LRO enabled */
  73 #define IFLIB_MAX_RX_SEGS               64
  74
  75 typedef struct if_rxd_info {
  76         /* set by iflib */
  77         uint16_t iri_qsidx;             /* qset index */
  78         uint16_t iri_vtag;              /* vlan tag - if flag set */
  79         /* XXX redundant with the new irf_len field */
  80         uint16_t iri_len;               /* packet length */
  81         qidx_t iri_cidx;                /* consumer index of cq */
  82         if_t iri_ifp;                   /* driver may have >1 iface per softc */
  83
  84         /* updated by driver */
  85         if_rxd_frag_t iri_frags;
  86         uint32_t iri_flowid;            /* RSS hash for packet */
  87         uint32_t iri_csum_flags;        /* m_pkthdr csum flags */
  88
  89         uint32_t iri_csum_data;         /* m_pkthdr csum data */
  90         uint8_t iri_flags;              /* mbuf flags for packet */
  91         uint8_t  iri_nfrags;            /* number of fragments in packet */
  92         uint8_t  iri_rsstype;           /* RSS hash type */
  93         uint8_t  iri_pad;               /* any padding in the received data */
  94 } *if_rxd_info_t;
  95
  96 typedef struct if_rxd_update {
  97         uint64_t        *iru_paddrs;
  98         qidx_t          *iru_idxs;
  99         qidx_t          iru_pidx;
 100         uint16_t        iru_qsidx;
 101         uint16_t        iru_count;
 102         uint16_t        iru_buf_size;
 103         uint8_t         iru_flidx;
 104 } *if_rxd_update_t;
 105
 106 #define IPI_TX_INTR     0x1             /* send an interrupt when this packet is sent */
 107 #define IPI_TX_IPV4     0x2             /* ethertype IPv4 */
 108 #define IPI_TX_IPV6     0x4             /* ethertype IPv6 */
 109
 110 typedef struct if_pkt_info {
 111         bus_dma_segment_t       *ipi_segs;      /* physical addresses */
 112         uint32_t                ipi_len;        /* packet length */
 113         uint16_t                ipi_qsidx;      /* queue set index */
 114         qidx_t                  ipi_nsegs;      /* number of segments */
 115
 116         qidx_t                  ipi_ndescs;     /* number of descriptors used by encap */
 117         uint16_t                ipi_flags;      /* iflib per-packet flags */
 118         qidx_t                  ipi_pidx;       /* start pidx for encap */
 119         qidx_t                  ipi_new_pidx;   /* next available pidx post-encap */
 120         /* offload handling */
 121         uint8_t                 ipi_ehdrlen;    /* ether header length */
 122         uint8_t                 ipi_ip_hlen;    /* ip header length */
 123         uint8_t                 ipi_tcp_hlen;   /* tcp header length */
 124         uint8_t                 ipi_ipproto;    /* ip protocol */
 125
 126         uint32_t                ipi_csum_flags; /* packet checksum flags */
 127         uint16_t                ipi_tso_segsz;  /* tso segment size */
 128         uint16_t                ipi_vtag;       /* VLAN tag */
 129         uint16_t                ipi_etype;      /* ether header type */
 130         uint8_t                 ipi_tcp_hflags; /* tcp header flags */
 131         uint8_t                 ipi_mflags;     /* packet mbuf flags */
 132
 133         uint32_t                ipi_tcp_seq;    /* tcp seqno */
 134         uint32_t                __spare0__;
 135 } *if_pkt_info_t;
 136
 137 typedef struct if_irq {
 138         struct resource  *ii_res;
 139         int               __spare0__;
 140         void             *ii_tag;
 141 } *if_irq_t;
 142
 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;
 149 };
 150
 151 typedef enum {
 152         IFLIB_INTR_LEGACY,
 153         IFLIB_INTR_MSI,
 154         IFLIB_INTR_MSIX
 155 } iflib_intr_mode_t;
 156
 157 /*
 158  * This really belongs in pciio.h or some place more general
 159  * but this is the only consumer for now.
 160  */
 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;
 166         uint32_t        pvi_rev_id;
 167         uint32_t        pvi_class_mask;
 168         const char      *pvi_name;
 169 } pci_vendor_info_t;
 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}
 173
 174 /* No drivers in tree currently match on anything except vendor:device. */
 175 #define IFLIB_PNP_DESCR "U32:vendor;U32:device;U32:#;U32:#;" \
 176     "U32:#;U32:#;D:#"
 177 #define IFLIB_PNP_INFO(b, u, t) \
 178     MODULE_PNP_INFO(IFLIB_PNP_DESCR, b, u, t, nitems(t) - 1)
 179
 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);
 184
 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 } *if_txrx_t;
 191
 192 typedef struct if_softc_ctx {
 193         int isc_vectors;
 194         int isc_nrxqsets;
 195         int isc_ntxqsets;
 196         uint16_t __spare0__;
 197         uint32_t __spare1__;
 198         int isc_msix_bar;               /* can be model specific - initialize in attach_pre */
 199         int isc_tx_nsegments;           /* can be model specific - initialize in attach_pre */
 200         int isc_ntxd[8];
 201         int isc_nrxd[8];
 202
 203         uint32_t isc_txqsizes[8];
 204         uint32_t isc_rxqsizes[8];
 205         /* is there such thing as a descriptor that is more than 248 bytes ? */
 206         uint8_t isc_txd_size[8];
 207         uint8_t isc_rxd_size[8];
 208
 209         int isc_tx_tso_segments_max;
 210         int isc_tx_tso_size_max;
 211         int isc_tx_tso_segsize_max;
 212         int isc_tx_csum_flags;
 213         int isc_capabilities;
 214         int isc_capenable;
 215         int isc_rss_table_size;
 216         int isc_rss_table_mask;
 217         int isc_nrxqsets_max;
 218         int isc_ntxqsets_max;
 219         uint32_t __spare2__;
 220
 221         iflib_intr_mode_t isc_intr;
 222         uint16_t isc_rxd_buf_size[8]; /* set at init time by driver, 0
 223                                          means use iflib-calculated size
 224                                          based on isc_max_frame_size */
 225         uint16_t isc_max_frame_size; /* set at init time by driver */
 226         uint16_t isc_min_frame_size; /* set at init time by driver, only used if
 227                                         IFLIB_NEED_ETHER_PAD is set. */
 228         uint32_t isc_pause_frames;   /* set by driver for iflib_timer to detect */
 229         uint32_t __spare3__;
 230         uint32_t __spare4__;
 231         uint32_t __spare5__;
 232         uint32_t __spare6__;
 233         uint32_t __spare7__;
 234         uint32_t __spare8__;
 235         caddr_t __spare9__;
 236         int isc_disable_msix;
 237         if_txrx_t isc_txrx;
 238         struct ifmedia *isc_media;
 239         bus_size_t isc_dma_width;       /* device dma width in bits, 0 means
 240                                            use BUS_SPACE_MAXADDR instead */
 241 } *if_softc_ctx_t;
 242
 243 /*
 244  * Initialization values for device
 245  */
 246 struct if_shared_ctx {
 247         unsigned isc_magic;
 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 */
 258
 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);
 265         int isc_nrxd_min[8];
 266         int isc_nrxd_default[8];
 267         int isc_nrxd_max[8];
 268         int isc_ntxd_min[8];
 269         int isc_ntxd_default[8];
 270         int isc_ntxd_max[8];
 271
 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 */
 276         int __spare0__;
 277         int isc_tx_reclaim_thresh;
 278         int isc_flags;
 279         const char *isc_name;
 280 };
 281
 282 typedef struct iflib_dma_info {
 283         bus_addr_t              idi_paddr;
 284         caddr_t                 idi_vaddr;
 285         bus_dma_tag_t           idi_tag;
 286         bus_dmamap_t            idi_map;
 287         uint32_t                idi_size;
 288 } *iflib_dma_info_t;
 289
 290 #define IFLIB_MAGIC 0xCAFEF00D
 291
 292 typedef enum {
 293         /* Interrupt or softirq handles only receive */
 294         IFLIB_INTR_RX,
 295
 296         /* Interrupt or softirq handles only transmit */
 297         IFLIB_INTR_TX,
 298
 299         /*
 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.
 304          */
 305         IFLIB_INTR_RXTX,
 306
 307         /*
 308          * Other interrupt - typically link status and
 309          * or error conditions.
 310          */
 311         IFLIB_INTR_ADMIN,
 312
 313         /* Softirq (task) for iov handling */
 314         IFLIB_INTR_IOV,
 315 } iflib_intr_type_t;
 316
 317 /*
 318  * Interface has a separate completion queue for RX
 319  */
 320 #define IFLIB_HAS_RXCQ          0x01
 321 /*
 322  * Driver has already allocated vectors
 323  */
 324 #define IFLIB_SKIP_MSIX         0x02
 325 /*
 326  * Interface is a virtual function
 327  */
 328 #define IFLIB_IS_VF             0x04
 329 /*
 330  * Interface has a separate completion queue for TX
 331  */
 332 #define IFLIB_HAS_TXCQ          0x08
 333 /*
 334  * Interface does checksum in place
 335  */
 336 #define IFLIB_NEED_SCRATCH      0x10
 337 /*
 338  * Interface doesn't expect in_pseudo for th_sum
 339  */
 340 #define IFLIB_TSO_INIT_IP       0x20
 341 /*
 342  * Interface doesn't align IP header
 343  */
 344 #define IFLIB_DO_RX_FIXUP       0x40
 345 /*
 346  * Driver needs csum zeroed for offloading
 347  */
 348 #define IFLIB_NEED_ZERO_CSUM    0x80
 349 /*
 350  * Driver needs frames padded to some minimum length
 351  */
 352 #define IFLIB_NEED_ETHER_PAD    0x100
 353 /*
 354  * Packets can be freed immediately after encap
 355  */
 356 #define IFLIB_TXD_ENCAP_PIO     0x00200
 357 /*
 358  * Use RX completion handler
 359  */
 360 #define IFLIB_RX_COMPLETION     0x00400
 361 /*
 362  * Skip refilling cluster free lists
 363  */
 364 #define IFLIB_SKIP_CLREFILL     0x00800
 365 /*
 366  * Don't reset on hang
 367  */
 368 #define IFLIB_NO_HANG_RESET     0x01000
 369 /*
 370  * Don't need/want most of the niceties of
 371  * queue management
 372  */
 373 #define IFLIB_PSEUDO    0x02000
 374 /*
 375  * No DMA support needed / wanted
 376  */
 377 #define IFLIB_VIRTUAL   0x04000
 378 /*
 379  * autogenerate a MAC address
 380  */
 381 #define IFLIB_GEN_MAC   0x08000
 382 /*
 383  * Interface needs admin task to ignore interface up/down status
 384  */
 385 #define IFLIB_ADMIN_ALWAYS_RUN  0x10000
 386 /*
 387  * Driver will pass the media
 388  */
 389 #define IFLIB_DRIVER_MEDIA      0x20000
 390 /*
 391  * When using a single hardware interrupt for the interface, only process RX
 392  * interrupts instead of doing combined RX/TX processing.
 393  */
 394 #define IFLIB_SINGLE_IRQ_RX_ONLY        0x40000
 395 /*
 396  * Don't need/want most of the niceties of
 397  * emulating ethernet
 398  */
 399 #define IFLIB_PSEUDO_ETHER      0x80000
 400
 401 /*
 402  * Interface has an admin completion queue
 403  */
 404 #define IFLIB_HAS_ADMINCQ       0x100000
 405 /*
 406  * Interface needs to preserve TX ring indices across restarts.
 407  */
 408 #define IFLIB_PRESERVE_TX_INDICES       0x200000
 409
 410 /*
 411  * These enum values are used in iflib_needs_restart to indicate to iflib
 412  * functions whether or not the interface needs restarting when certain events
 413  * happen.
 414  */
 415 enum iflib_restart_event {
 416         IFLIB_RESTART_VLAN_CONFIG,
 417 };
 418
 419 /*
 420  * field accessors
 421  */
 422 void *iflib_get_softc(if_ctx_t ctx);
 423
 424 device_t iflib_get_dev(if_ctx_t ctx);
 425
 426 if_t iflib_get_ifp(if_ctx_t ctx);
 427
 428 struct ifmedia *iflib_get_media(if_ctx_t ctx);
 429
 430 if_softc_ctx_t iflib_get_softc_ctx(if_ctx_t ctx);
 431 if_shared_ctx_t iflib_get_sctx(if_ctx_t ctx);
 432
 433 void iflib_set_mac(if_ctx_t ctx, uint8_t mac[ETHER_ADDR_LEN]);
 434 void iflib_request_reset(if_ctx_t ctx);
 435 uint8_t iflib_in_detach(if_ctx_t ctx);
 436
 437 uint32_t iflib_get_rx_mbuf_sz(if_ctx_t ctx);
 438
 439 /*
 440  * If the driver can plug cleanly in to newbus use these
 441  */
 442 int iflib_device_probe(device_t);
 443 int iflib_device_attach(device_t);
 444 int iflib_device_detach(device_t);
 445 int iflib_device_suspend(device_t);
 446 int iflib_device_resume(device_t);
 447 int iflib_device_shutdown(device_t);
 448
 449 /*
 450  * Use this instead of iflib_device_probe if the driver should report
 451  * BUS_PROBE_VENDOR instead of BUS_PROBE_DEFAULT. (For example, an out-of-tree
 452  * driver based on iflib).
 453  */
 454 int iflib_device_probe_vendor(device_t);
 455
 456 int iflib_device_iov_init(device_t, uint16_t, const nvlist_t *);
 457 void iflib_device_iov_uninit(device_t);
 458 int iflib_device_iov_add_vf(device_t, uint16_t, const nvlist_t *);
 459
 460 /*
 461  * If the driver can't plug cleanly in to newbus
 462  * use these
 463  */
 464 int iflib_device_register(device_t dev, void *softc, if_shared_ctx_t sctx, if_ctx_t *ctxp);
 465 int iflib_device_deregister(if_ctx_t);
 466
 467 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);
 468 int iflib_irq_alloc_generic(if_ctx_t ctx, if_irq_t irq, int rid,
 469                             iflib_intr_type_t type, driver_filter_t *filter,
 470                             void *filter_arg, int qid, const char *name);
 471 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);
 472
 473 void iflib_irq_free(if_ctx_t ctx, if_irq_t irq);
 474
 475 void iflib_io_tqg_attach(struct grouptask *gt, void *uniq, int cpu,
 476     const char *name);
 477
 478 void iflib_config_gtask_init(void *ctx, struct grouptask *gtask,
 479                              gtask_fn_t *fn, const char *name);
 480 void iflib_config_gtask_deinit(struct grouptask *gtask);
 481
 482 void iflib_tx_intr_deferred(if_ctx_t ctx, int txqid);
 483 void iflib_rx_intr_deferred(if_ctx_t ctx, int rxqid);
 484 void iflib_admin_intr_deferred(if_ctx_t ctx);
 485 void iflib_iov_intr_deferred(if_ctx_t ctx);
 486
 487 void iflib_link_state_change(if_ctx_t ctx, int linkstate, uint64_t baudrate);
 488
 489 int iflib_dma_alloc(if_ctx_t ctx, int size, iflib_dma_info_t dma, int mapflags);
 490 int iflib_dma_alloc_align(if_ctx_t ctx, int size, int align, iflib_dma_info_t dma, int mapflags);
 491 void iflib_dma_free(iflib_dma_info_t dma);
 492 int iflib_dma_alloc_multi(if_ctx_t ctx, int *sizes, iflib_dma_info_t *dmalist, int mapflags, int count);
 493
 494 void iflib_dma_free_multi(iflib_dma_info_t *dmalist, int count);
 495
 496 struct sx *iflib_ctx_lock_get(if_ctx_t);
 497
 498 void iflib_led_create(if_ctx_t ctx);
 499
 500 void iflib_add_int_delay_sysctl(if_ctx_t, const char *, const char *,
 501                                                                 if_int_delay_info_t, int, int);
 502
 503 /*
 504  * Pseudo device support
 505  */
 506 if_pseudo_t iflib_clone_register(if_shared_ctx_t);
 507 void iflib_clone_deregister(if_pseudo_t);
 508
 509 #endif /*  __IFLIB_H_ */