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 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         caddr_t         *iru_vaddrs;
  99         qidx_t          *iru_idxs;
 100         qidx_t          iru_pidx;
 101         uint16_t        iru_qsidx;
 102         uint16_t        iru_count;
 103         uint16_t        iru_buf_size;
 104         uint8_t         iru_flidx;
 105 } *if_rxd_update_t;
 106
 107 #define IPI_TX_INTR     0x1             /* send an interrupt when this packet is sent */
 108 #define IPI_TX_IPV4     0x2             /* ethertype IPv4 */
 109 #define IPI_TX_IPV6     0x4             /* ethertype IPv6 */
 110
 111 typedef struct if_pkt_info {
 112         bus_dma_segment_t       *ipi_segs;      /* physical addresses */
 113         uint32_t                ipi_len;        /* packet length */
 114         uint16_t                ipi_qsidx;      /* queue set index */
 115         qidx_t                  ipi_nsegs;      /* number of segments */
 116
 117         qidx_t                  ipi_ndescs;     /* number of descriptors used by encap */
 118         uint16_t                ipi_flags;      /* iflib per-packet flags */
 119         qidx_t                  ipi_pidx;       /* start pidx for encap */
 120         qidx_t                  ipi_new_pidx;   /* next available pidx post-encap */
 121         /* offload handling */
 122         uint8_t                 ipi_ehdrlen;    /* ether header length */
 123         uint8_t                 ipi_ip_hlen;    /* ip header length */
 124         uint8_t                 ipi_tcp_hlen;   /* tcp header length */
 125         uint8_t                 ipi_ipproto;    /* ip protocol */
 126
 127         uint32_t                ipi_csum_flags; /* packet checksum flags */
 128         uint16_t                ipi_tso_segsz;  /* tso segment size */
 129         uint16_t                ipi_vtag;       /* VLAN tag */
 130         uint16_t                ipi_etype;      /* ether header type */
 131         uint8_t                 ipi_tcp_hflags; /* tcp header flags */
 132         uint8_t                 ipi_mflags;     /* packet mbuf flags */
 133
 134         uint32_t                ipi_tcp_seq;    /* tcp seqno */
 135         uint32_t                __spare0__;
 136 } *if_pkt_info_t;
 137
 138 typedef struct if_irq {
 139         struct resource  *ii_res;
 140         int               __spare0__;
 141         void             *ii_tag;
 142 } *if_irq_t;
 143
 144 struct if_int_delay_info {
 145         if_ctx_t iidi_ctx;      /* Back-pointer to the iflib ctx (softc) */
 146         int iidi_offset;                        /* Register offset to read/write */
 147         int iidi_value;                 /* Current value in usecs */
 148         struct sysctl_oid *iidi_oidp;
 149         struct sysctl_req *iidi_req;
 150 };
 151
 152 typedef enum {
 153         IFLIB_INTR_LEGACY,
 154         IFLIB_INTR_MSI,
 155         IFLIB_INTR_MSIX
 156 } iflib_intr_mode_t;
 157
 158 /*
 159  * This really belongs in pciio.h or some place more general
 160  * but this is the only consumer for now.
 161  */
 162 typedef struct pci_vendor_info {
 163         uint32_t        pvi_vendor_id;
 164         uint32_t        pvi_device_id;
 165         uint32_t        pvi_subvendor_id;
 166         uint32_t        pvi_subdevice_id;
 167         uint32_t        pvi_rev_id;
 168         uint32_t        pvi_class_mask;
 169         const char      *pvi_name;
 170 } pci_vendor_info_t;
 171
 172 #define PVID(vendor, devid, name) {vendor, devid, 0, 0, 0, 0, name}
 173 #define PVID_OEM(vendor, devid, svid, sdevid, revid, name) {vendor, devid, svid, sdevid, revid, 0, name}
 174 #define PVID_END {0, 0, 0, 0, 0, 0, NULL}
 175
 176 #define IFLIB_PNP_DESCR "U32:vendor;U32:device;U32:subvendor;U32:subdevice;" \
 177     "U32:revision;U32:class;D:#"
 178 #define IFLIB_PNP_INFO(b, u, t) \
 179     MODULE_PNP_INFO(IFLIB_PNP_DESCR, b, u, t, nitems(t) - 1)
 180
 181 typedef struct if_txrx {
 182         int (*ift_txd_encap) (void *, if_pkt_info_t);
 183         void (*ift_txd_flush) (void *, uint16_t, qidx_t pidx);
 184         int (*ift_txd_credits_update) (void *, uint16_t qsidx, bool clear);
 185
 186         int (*ift_rxd_available) (void *, uint16_t qsidx, qidx_t pidx, qidx_t budget);
 187         int (*ift_rxd_pkt_get) (void *, if_rxd_info_t ri);
 188         void (*ift_rxd_refill) (void * , if_rxd_update_t iru);
 189         void (*ift_rxd_flush) (void *, uint16_t qsidx, uint8_t flidx, qidx_t pidx);
 190         int (*ift_legacy_intr) (void *);
 191 } *if_txrx_t;
 192
 193 typedef struct if_softc_ctx {
 194         int isc_vectors;
 195         int isc_nrxqsets;
 196         int isc_ntxqsets;
 197         uint16_t __spare0__;
 198         uint32_t __spare1__;
 199         int isc_msix_bar;               /* can be model specific - initialize in attach_pre */
 200         int isc_tx_nsegments;           /* can be model specific - initialize in attach_pre */
 201         int isc_ntxd[8];
 202         int isc_nrxd[8];
 203
 204         uint32_t isc_txqsizes[8];
 205         uint32_t isc_rxqsizes[8];
 206         /* is there such thing as a descriptor that is more than 248 bytes ? */
 207         uint8_t isc_txd_size[8];
 208         uint8_t isc_rxd_size[8];
 209
 210         int isc_tx_tso_segments_max;
 211         int isc_tx_tso_size_max;
 212         int isc_tx_tso_segsize_max;
 213         int isc_tx_csum_flags;
 214         int isc_capabilities;
 215         int isc_capenable;
 216         int isc_rss_table_size;
 217         int isc_rss_table_mask;
 218         int isc_nrxqsets_max;
 219         int isc_ntxqsets_max;
 220         uint32_t __spare2__;
 221
 222         iflib_intr_mode_t isc_intr;
 223         uint16_t isc_max_frame_size; /* set at init time by driver */
 224         uint16_t isc_min_frame_size; /* set at init time by driver, only used if
 225                                         IFLIB_NEED_ETHER_PAD is set. */
 226         uint32_t isc_pause_frames;   /* set by driver for iflib_timer to detect */
 227         uint32_t __spare3__;
 228         uint32_t __spare4__;
 229         uint32_t __spare5__;
 230         uint32_t __spare6__;
 231         uint32_t __spare7__;
 232         uint32_t __spare8__;
 233         caddr_t __spare9__;
 234         int isc_disable_msix;
 235         if_txrx_t isc_txrx;
 236         struct ifmedia *isc_media;
 237 } *if_softc_ctx_t;
 238
 239 /*
 240  * Initialization values for device
 241  */
 242 struct if_shared_ctx {
 243         unsigned isc_magic;
 244         driver_t *isc_driver;
 245         bus_size_t isc_q_align;
 246         bus_size_t isc_tx_maxsize;
 247         bus_size_t isc_tx_maxsegsize;
 248         bus_size_t isc_tso_maxsize;
 249         bus_size_t isc_tso_maxsegsize;
 250         bus_size_t isc_rx_maxsize;
 251         bus_size_t isc_rx_maxsegsize;
 252         int isc_rx_nsegments;
 253         int isc_admin_intrcnt;          /* # of admin/link interrupts */
 254
 255         /* fields necessary for probe */
 256         const pci_vendor_info_t *isc_vendor_info;
 257         const char *isc_driver_version;
 258         /* optional function to transform the read values to match the table*/
 259         void (*isc_parse_devinfo) (uint16_t *device_id, uint16_t *subvendor_id,
 260                                    uint16_t *subdevice_id, uint16_t *rev_id);
 261         int isc_nrxd_min[8];
 262         int isc_nrxd_default[8];
 263         int isc_nrxd_max[8];
 264         int isc_ntxd_min[8];
 265         int isc_ntxd_default[8];
 266         int isc_ntxd_max[8];
 267
 268         /* actively used during operation */
 269         int isc_nfl __aligned(CACHE_LINE_SIZE);
 270         int isc_ntxqs;                  /* # of tx queues per tx qset - usually 1 */
 271         int isc_nrxqs;                  /* # of rx queues per rx qset - intel 1, chelsio 2, broadcom 3 */
 272         int __spare0__;
 273         int isc_tx_reclaim_thresh;
 274         int isc_flags;
 275         const char *isc_name;
 276 };
 277
 278 typedef struct iflib_dma_info {
 279         bus_addr_t              idi_paddr;
 280         caddr_t                 idi_vaddr;
 281         bus_dma_tag_t           idi_tag;
 282         bus_dmamap_t            idi_map;
 283         uint32_t                idi_size;
 284 } *iflib_dma_info_t;
 285
 286 #define IFLIB_MAGIC 0xCAFEF00D
 287
 288 typedef enum {
 289         IFLIB_INTR_RX,
 290         IFLIB_INTR_TX,
 291         IFLIB_INTR_RXTX,
 292         IFLIB_INTR_ADMIN,
 293         IFLIB_INTR_IOV,
 294 } iflib_intr_type_t;
 295
 296 /*
 297  * Interface has a separate command queue for RX
 298  */
 299 #define IFLIB_HAS_RXCQ          0x01
 300 /*
 301  * Driver has already allocated vectors
 302  */
 303 #define IFLIB_SKIP_MSIX         0x02
 304 /*
 305  * Interface is a virtual function
 306  */
 307 #define IFLIB_IS_VF             0x04
 308 /*
 309  * Interface has a separate command queue for TX
 310  */
 311 #define IFLIB_HAS_TXCQ          0x08
 312 /*
 313  * Interface does checksum in place
 314  */
 315 #define IFLIB_NEED_SCRATCH      0x10
 316 /*
 317  * Interface doesn't expect in_pseudo for th_sum
 318  */
 319 #define IFLIB_TSO_INIT_IP       0x20
 320 /*
 321  * Interface doesn't align IP header
 322  */
 323 #define IFLIB_DO_RX_FIXUP       0x40
 324 /*
 325  * Driver needs csum zeroed for offloading
 326  */
 327 #define IFLIB_NEED_ZERO_CSUM    0x80
 328 /*
 329  * Driver needs frames padded to some minimum length
 330  */
 331 #define IFLIB_NEED_ETHER_PAD    0x100
 332 /*
 333  * Packets can be freed immediately after encap
 334  */
 335 #define IFLIB_TXD_ENCAP_PIO     0x00200
 336 /*
 337  * Use RX completion handler
 338  */
 339 #define IFLIB_RX_COMPLETION     0x00400
 340 /*
 341  * Skip refilling cluster free lists
 342  */
 343 #define IFLIB_SKIP_CLREFILL     0x00800
 344 /*
 345  * Don't reset on hang
 346  */
 347 #define IFLIB_NO_HANG_RESET     0x01000
 348 /*
 349  * Don't need/want most of the niceties of
 350  * queue management
 351  */
 352 #define IFLIB_PSEUDO    0x02000
 353 /*
 354  * No DMA support needed / wanted
 355  */
 356 #define IFLIB_VIRTUAL   0x04000
 357 /*
 358  * autogenerate a MAC address
 359  */
 360 #define IFLIB_GEN_MAC   0x08000
 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 /*
 371  * field accessors
 372  */
 373 void *iflib_get_softc(if_ctx_t ctx);
 374
 375 device_t iflib_get_dev(if_ctx_t ctx);
 376
 377 if_t iflib_get_ifp(if_ctx_t ctx);
 378
 379 struct ifmedia *iflib_get_media(if_ctx_t ctx);
 380
 381 if_softc_ctx_t iflib_get_softc_ctx(if_ctx_t ctx);
 382 if_shared_ctx_t iflib_get_sctx(if_ctx_t ctx);
 383
 384 void iflib_set_mac(if_ctx_t ctx, uint8_t mac[ETHER_ADDR_LEN]);
 385 void iflib_request_reset(if_ctx_t ctx);
 386 uint8_t iflib_in_detach(if_ctx_t ctx);
 387
 388 uint32_t iflib_get_rx_mbuf_sz(if_ctx_t ctx);
 389
 390 /*
 391  * If the driver can plug cleanly in to newbus use these
 392  */
 393 int iflib_device_probe(device_t);
 394 int iflib_device_attach(device_t);
 395 int iflib_device_detach(device_t);
 396 int iflib_device_suspend(device_t);
 397 int iflib_device_resume(device_t);
 398 int iflib_device_shutdown(device_t);
 399
 400 /*
 401  * Use this instead of iflib_device_probe if the driver should report
 402  * BUS_PROBE_VENDOR instead of BUS_PROBE_DEFAULT. (For example, an out-of-tree
 403  * driver based on iflib).
 404  */
 405 int iflib_device_probe_vendor(device_t);
 406
 407 int iflib_device_iov_init(device_t, uint16_t, const nvlist_t *);
 408 void iflib_device_iov_uninit(device_t);
 409 int iflib_device_iov_add_vf(device_t, uint16_t, const nvlist_t *);
 410
 411 /*
 412  * If the driver can't plug cleanly in to newbus
 413  * use these
 414  */
 415 int iflib_device_register(device_t dev, void *softc, if_shared_ctx_t sctx, if_ctx_t *ctxp);
 416 int iflib_device_deregister(if_ctx_t);
 417
 418 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);
 419 int iflib_irq_alloc_generic(if_ctx_t ctx, if_irq_t irq, int rid,
 420                             iflib_intr_type_t type, driver_filter_t *filter,
 421                             void *filter_arg, int qid, const char *name);
 422 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);
 423
 424 void iflib_irq_free(if_ctx_t ctx, if_irq_t irq);
 425
 426 void iflib_io_tqg_attach(struct grouptask *gt, void *uniq, int cpu,
 427     const char *name);
 428
 429 void iflib_config_gtask_init(void *ctx, struct grouptask *gtask,
 430                              gtask_fn_t *fn, const char *name);
 431 void iflib_config_gtask_deinit(struct grouptask *gtask);
 432
 433 void iflib_tx_intr_deferred(if_ctx_t ctx, int txqid);
 434 void iflib_rx_intr_deferred(if_ctx_t ctx, int rxqid);
 435 void iflib_admin_intr_deferred(if_ctx_t ctx);
 436 void iflib_iov_intr_deferred(if_ctx_t ctx);
 437
 438 void iflib_link_state_change(if_ctx_t ctx, int linkstate, uint64_t baudrate);
 439
 440 int iflib_dma_alloc(if_ctx_t ctx, int size, iflib_dma_info_t dma, int mapflags);
 441 int iflib_dma_alloc_align(if_ctx_t ctx, int size, int align, iflib_dma_info_t dma, int mapflags);
 442 void iflib_dma_free(iflib_dma_info_t dma);
 443 int iflib_dma_alloc_multi(if_ctx_t ctx, int *sizes, iflib_dma_info_t *dmalist, int mapflags, int count);
 444
 445 void iflib_dma_free_multi(iflib_dma_info_t *dmalist, int count);
 446
 447 struct sx *iflib_ctx_lock_get(if_ctx_t);
 448
 449 void iflib_led_create(if_ctx_t ctx);
 450
 451 void iflib_add_int_delay_sysctl(if_ctx_t, const char *, const char *,
 452                                                                 if_int_delay_info_t, int, int);
 453
 454 /*
 455  * Pseudo device support
 456  */
 457 if_pseudo_t iflib_clone_register(if_shared_ctx_t);
 458 void iflib_clone_deregister(if_pseudo_t);
 459
 460 #endif /*  __IFLIB_H_ */