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 /*
  40  * The value type for indexing, limits max descriptors
  41  * to 65535 can be conditionally redefined to uint32_t
  42  * in the future if the need arises.
  43  */
  44 typedef uint16_t qidx_t;
  45 #define QIDX_INVALID 0xFFFF
  46
  47 struct iflib_ctx;
  48 typedef struct iflib_ctx *if_ctx_t;
  49 struct if_shared_ctx;
  50 typedef const struct if_shared_ctx *if_shared_ctx_t;
  51 struct if_int_delay_info;
  52 typedef struct if_int_delay_info  *if_int_delay_info_t;
  53
  54 /*
  55  * File organization:
  56  *  - public structures
  57  *  - iflib accessors
  58  *  - iflib utility functions
  59  *  - iflib core functions
  60  */
  61
  62 typedef struct if_rxd_frag {
  63         uint8_t irf_flid;
  64         qidx_t irf_idx;
  65         uint16_t irf_len;
  66 } *if_rxd_frag_t;
  67
  68 /* bnxt supports 64 with hardware LRO enabled */
  69 #define IFLIB_MAX_RX_SEGS               64
  70
  71 typedef struct if_rxd_info {
  72         /* set by iflib */
  73         uint16_t iri_qsidx;             /* qset index */
  74         uint16_t iri_vtag;              /* vlan tag - if flag set */
  75         /* XXX redundant with the new irf_len field */
  76         uint16_t iri_len;               /* packet length */
  77         qidx_t iri_cidx;                /* consumer index of cq */
  78         if_t iri_ifp;                   /* driver may have >1 iface per softc */
  79
  80         /* updated by driver */
  81         if_rxd_frag_t iri_frags;
  82         uint32_t iri_flowid;            /* RSS hash for packet */
  83         uint32_t iri_csum_flags;        /* m_pkthdr csum flags */
  84
  85         uint32_t iri_csum_data;         /* m_pkthdr csum data */
  86         uint8_t iri_flags;              /* mbuf flags for packet */
  87         uint8_t  iri_nfrags;            /* number of fragments in packet */
  88         uint8_t  iri_rsstype;           /* RSS hash type */
  89         uint8_t  iri_pad;               /* any padding in the received data */
  90 } *if_rxd_info_t;
  91
  92 typedef struct if_rxd_update {
  93         uint64_t        *iru_paddrs;
  94         qidx_t          *iru_idxs;
  95         qidx_t          iru_pidx;
  96         uint16_t        iru_qsidx;
  97         uint16_t        iru_count;
  98         uint16_t        iru_buf_size;
  99         uint8_t         iru_flidx;
 100 } *if_rxd_update_t;
 101
 102 #define IPI_TX_INTR     0x1             /* send an interrupt when this packet is sent */
 103 #define IPI_TX_IPV4     0x2             /* ethertype IPv4 */
 104 #define IPI_TX_IPV6     0x4             /* ethertype IPv6 */
 105
 106 typedef struct if_pkt_info {
 107         bus_dma_segment_t       *ipi_segs;      /* physical addresses */
 108         uint32_t                ipi_len;        /* packet length */
 109         uint16_t                ipi_qsidx;      /* queue set index */
 110         qidx_t                  ipi_nsegs;      /* number of segments */
 111
 112         qidx_t                  ipi_ndescs;     /* number of descriptors used by encap */
 113         uint16_t                ipi_flags;      /* iflib per-packet flags */
 114         qidx_t                  ipi_pidx;       /* start pidx for encap */
 115         qidx_t                  ipi_new_pidx;   /* next available pidx post-encap */
 116         /* offload handling */
 117         uint8_t                 ipi_ehdrlen;    /* ether header length */
 118         uint8_t                 ipi_ip_hlen;    /* ip header length */
 119         uint8_t                 ipi_tcp_hlen;   /* tcp header length */
 120         uint8_t                 ipi_ipproto;    /* ip protocol */
 121
 122         uint32_t                ipi_csum_flags; /* packet checksum flags */
 123         uint16_t                ipi_tso_segsz;  /* tso segment size */
 124         uint16_t                ipi_vtag;       /* VLAN tag */
 125         uint16_t                ipi_etype;      /* ether header type */
 126         uint8_t                 ipi_tcp_hflags; /* tcp header flags */
 127         uint8_t                 ipi_mflags;     /* packet mbuf flags */
 128
 129         uint32_t                ipi_tcp_seq;    /* tcp seqno */
 130         uint8_t                 ipi_ip_tos;     /* IP ToS field data */
 131         uint8_t                 __spare0__;
 132         uint16_t                __spare1__;
 133 } *if_pkt_info_t;
 134
 135 typedef struct if_irq {
 136         struct resource  *ii_res;
 137         int               __spare0__;
 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         const char      *pvi_name;
 167 } pci_vendor_info_t;
 168 #define PVID(vendor, devid, name) {vendor, devid, 0, 0, 0, 0, name}
 169 #define PVID_OEM(vendor, devid, svid, sdevid, revid, name) {vendor, devid, svid, sdevid, revid, 0, name}
 170 #define PVID_END {0, 0, 0, 0, 0, 0, NULL}
 171
 172 /* No drivers in tree currently match on anything except vendor:device. */
 173 #define IFLIB_PNP_DESCR "U32:vendor;U32:device;U32:#;U32:#;" \
 174     "U32:#;U32:#;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         qidx_t (*ift_txq_select) (void *, struct mbuf *);
 189         qidx_t (*ift_txq_select_v2) (void *, struct mbuf *, if_pkt_info_t);
 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 };
 280
 281 typedef struct iflib_dma_info {
 282         bus_addr_t              idi_paddr;
 283         caddr_t                 idi_vaddr;
 284         bus_dma_tag_t           idi_tag;
 285         bus_dmamap_t            idi_map;
 286         uint32_t                idi_size;
 287 } *iflib_dma_info_t;
 288
 289 #define IFLIB_MAGIC 0xCAFEF00D
 290
 291 typedef enum {
 292         /* Interrupt or softirq handles only receive */
 293         IFLIB_INTR_RX,
 294
 295         /* Interrupt or softirq handles only transmit */
 296         IFLIB_INTR_TX,
 297
 298         /*
 299          * Interrupt will check for both pending receive
 300          * and available tx credits and dispatch a task
 301          * for one or both depending on the disposition
 302          * of the respective queues.
 303          */
 304         IFLIB_INTR_RXTX,
 305
 306         /*
 307          * Other interrupt - typically link status and
 308          * or error conditions.
 309          */
 310         IFLIB_INTR_ADMIN,
 311
 312         /* Softirq (task) for iov handling */
 313         IFLIB_INTR_IOV,
 314 } iflib_intr_type_t;
 315
 316 /*
 317  * Interface has a separate completion queue for RX
 318  */
 319 #define IFLIB_HAS_RXCQ          0x01
 320 /*
 321  * Driver has already allocated vectors
 322  */
 323 #define IFLIB_SKIP_MSIX         0x02
 324 /*
 325  * Interface is a virtual function
 326  */
 327 #define IFLIB_IS_VF             0x04
 328 /*
 329  * Interface has a separate completion queue for TX
 330  */
 331 #define IFLIB_HAS_TXCQ          0x08
 332 /*
 333  * Interface does checksum in place
 334  */
 335 #define IFLIB_NEED_SCRATCH      0x10
 336 /*
 337  * Interface doesn't expect in_pseudo for th_sum
 338  */
 339 #define IFLIB_TSO_INIT_IP       0x20
 340 /*
 341  * Interface doesn't align IP header
 342  */
 343 #define IFLIB_DO_RX_FIXUP       0x40
 344 /*
 345  * Driver needs csum zeroed for offloading
 346  */
 347 #define IFLIB_NEED_ZERO_CSUM    0x80
 348 /*
 349  * Driver needs frames padded to some minimum length
 350  */
 351 #define IFLIB_NEED_ETHER_PAD    0x100
 352 #define IFLIB_SPARE7            0x200
 353 #define IFLIB_SPARE6            0x400
 354 #define IFLIB_SPARE5            0x800
 355 #define IFLIB_SPARE4            0x1000
 356 #define IFLIB_SPARE3            0x2000
 357 #define IFLIB_SPARE2            0x4000
 358 #define IFLIB_SPARE1            0x8000
 359 /*
 360  * Interface needs admin task to ignore interface up/down status
 361  */
 362 #define IFLIB_ADMIN_ALWAYS_RUN  0x10000
 363 /*
 364  * Driver will pass the media
 365  */
 366 #define IFLIB_DRIVER_MEDIA      0x20000
 367 /*
 368  * When using a single hardware interrupt for the interface, only process RX
 369  * interrupts instead of doing combined RX/TX processing.
 370  */
 371 #define IFLIB_SINGLE_IRQ_RX_ONLY        0x40000
 372 #define IFLIB_SPARE0            0x80000
 373 /*
 374  * Interface has an admin completion queue
 375  */
 376 #define IFLIB_HAS_ADMINCQ       0x100000
 377 /*
 378  * Interface needs to preserve TX ring indices across restarts.
 379  */
 380 #define IFLIB_PRESERVE_TX_INDICES       0x200000
 381
 382 /* The following IFLIB_FEATURE_* defines are for driver modules to determine
 383  * what features this version of iflib supports. They shall be defined to the
 384  * first __FreeBSD_version that introduced the feature.
 385  */
 386 /*
 387  * Driver can set its own TX queue selection function
 388  * as ift_txq_select in struct if_txrx
 389  */
 390 #define IFLIB_FEATURE_QUEUE_SELECT      1400050
 391 /*
 392  * Driver can set its own TX queue selection function
 393  * as ift_txq_select_v2 in struct if_txrx. This includes
 394  * having iflib send L3+ extra header information to the
 395  * function.
 396  */
 397 #define IFLIB_FEATURE_QUEUE_SELECT_V2   1400073
 398
 399 /*
 400  * These enum values are used in iflib_needs_restart to indicate to iflib
 401  * functions whether or not the interface needs restarting when certain events
 402  * happen.
 403  */
 404 enum iflib_restart_event {
 405         IFLIB_RESTART_VLAN_CONFIG,
 406 };
 407
 408 /*
 409  * field accessors
 410  */
 411 void *iflib_get_softc(if_ctx_t ctx);
 412
 413 device_t iflib_get_dev(if_ctx_t ctx);
 414
 415 if_t iflib_get_ifp(if_ctx_t ctx);
 416
 417 struct ifmedia *iflib_get_media(if_ctx_t ctx);
 418
 419 if_softc_ctx_t iflib_get_softc_ctx(if_ctx_t ctx);
 420 if_shared_ctx_t iflib_get_sctx(if_ctx_t ctx);
 421
 422 void iflib_set_mac(if_ctx_t ctx, uint8_t mac[ETHER_ADDR_LEN]);
 423 void iflib_request_reset(if_ctx_t ctx);
 424 uint8_t iflib_in_detach(if_ctx_t ctx);
 425
 426 uint32_t iflib_get_rx_mbuf_sz(if_ctx_t ctx);
 427
 428 /*
 429  * If the driver can plug cleanly in to newbus use these
 430  */
 431 int iflib_device_probe(device_t);
 432 int iflib_device_attach(device_t);
 433 int iflib_device_detach(device_t);
 434 int iflib_device_suspend(device_t);
 435 int iflib_device_resume(device_t);
 436 int iflib_device_shutdown(device_t);
 437
 438 /*
 439  * Use this instead of iflib_device_probe if the driver should report
 440  * BUS_PROBE_VENDOR instead of BUS_PROBE_DEFAULT. (For example, an out-of-tree
 441  * driver based on iflib).
 442  */
 443 int iflib_device_probe_vendor(device_t);
 444
 445 int iflib_device_iov_init(device_t, uint16_t, const nvlist_t *);
 446 void iflib_device_iov_uninit(device_t);
 447 int iflib_device_iov_add_vf(device_t, uint16_t, const nvlist_t *);
 448
 449 /*
 450  * If the driver can't plug cleanly in to newbus
 451  * use these
 452  */
 453 int iflib_device_register(device_t dev, void *softc, if_shared_ctx_t sctx, if_ctx_t *ctxp);
 454 int iflib_device_deregister(if_ctx_t);
 455
 456 int iflib_irq_alloc(if_ctx_t, if_irq_t, int, driver_filter_t, void *filter_arg,
 457                     driver_intr_t, void *arg, const char *name);
 458 int iflib_irq_alloc_generic(if_ctx_t ctx, if_irq_t irq, int rid,
 459                             iflib_intr_type_t type, driver_filter_t *filter,
 460                             void *filter_arg, int qid, const char *name);
 461 void iflib_softirq_alloc_generic(if_ctx_t ctx, if_irq_t irq,
 462                                  iflib_intr_type_t type,  void *arg, int qid,
 463                                  const char *name);
 464
 465 void iflib_irq_free(if_ctx_t ctx, if_irq_t irq);
 466
 467 void iflib_io_tqg_attach(struct grouptask *gt, void *uniq, int cpu,
 468     const char *name);
 469
 470 void iflib_config_gtask_init(void *ctx, struct grouptask *gtask,
 471                              gtask_fn_t *fn, const char *name);
 472 void iflib_config_gtask_deinit(struct grouptask *gtask);
 473
 474 void iflib_tx_intr_deferred(if_ctx_t ctx, int txqid);
 475 void iflib_rx_intr_deferred(if_ctx_t ctx, int rxqid);
 476 void iflib_admin_intr_deferred(if_ctx_t ctx);
 477 void iflib_iov_intr_deferred(if_ctx_t ctx);
 478
 479 void iflib_link_state_change(if_ctx_t ctx, int linkstate, uint64_t baudrate);
 480
 481 int iflib_dma_alloc(if_ctx_t ctx, int size, iflib_dma_info_t dma, int mapflags);
 482 int iflib_dma_alloc_align(if_ctx_t ctx, int size, int align, iflib_dma_info_t dma, int mapflags);
 483 void iflib_dma_free(iflib_dma_info_t dma);
 484 int iflib_dma_alloc_multi(if_ctx_t ctx, int *sizes, iflib_dma_info_t *dmalist, int mapflags, int count);
 485
 486 void iflib_dma_free_multi(iflib_dma_info_t *dmalist, int count);
 487
 488 struct sx *iflib_ctx_lock_get(if_ctx_t);
 489
 490 void iflib_led_create(if_ctx_t ctx);
 491
 492 void iflib_add_int_delay_sysctl(if_ctx_t, const char *, const char *,
 493                                                                 if_int_delay_info_t, int, int);
 494
 495 #endif /*  __IFLIB_H_ */