sys/dev/mxge/if_mxge_var.h

   1 /*******************************************************************************
   2 SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3
   4 Copyright (c) 2006-2013, Myricom Inc.
   5 All rights reserved.
   6
   7 Redistribution and use in source and binary forms, with or without
   8 modification, are permitted provided that the following conditions are met:
   9
  10  1. Redistributions of source code must retain the above copyright notice,
  11     this list of conditions and the following disclaimer.
  12
  13  2. Neither the name of the Myricom Inc, nor the names of its
  14     contributors may be used to endorse or promote products derived from
  15     this software without specific prior written permission.
  16
  17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  18 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  21 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  25 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27 POSSIBILITY OF SUCH DAMAGE.
  28
  29 $FreeBSD$
  30
  31 ***************************************************************************/
  32
  33 #define MXGE_ETH_STOPPED 0
  34 #define MXGE_ETH_STOPPING 1
  35 #define MXGE_ETH_STARTING 2
  36 #define MXGE_ETH_RUNNING 3
  37 #define MXGE_ETH_OPEN_FAILED 4
  38
  39 #define MXGE_FW_OFFSET 1024*1024
  40 #define MXGE_EEPROM_STRINGS_SIZE 256
  41 #define MXGE_MAX_SEND_DESC 128
  42
  43 #if ((__FreeBSD_version > 800000 && __FreeBSD_version < 800005) \
  44      || __FreeBSD_version < 700111)
  45 #define MXGE_VIRT_JUMBOS 1
  46 #else
  47 #define MXGE_VIRT_JUMBOS 0
  48 #endif
  49
  50 #if (__FreeBSD_version > 800082)
  51 #define IFNET_BUF_RING 1
  52 #endif
  53
  54 #if (__FreeBSD_version < 1000020)
  55 #undef IF_Kbps
  56 #undef IF_Mbps
  57 #undef IF_Gbps
  58 #define IF_Kbps(x)      ((uintmax_t)(x) * 1000) /* kilobits/sec. */
  59 #define IF_Mbps(x)      (IF_Kbps((x) * 1000))   /* megabits/sec. */
  60 #define IF_Gbps(x)      (IF_Mbps((x) * 1000))   /* gigabits/sec. */
  61 #endif
  62
  63 #ifndef VLAN_CAPABILITIES
  64 #define VLAN_CAPABILITIES(ifp)
  65 #define mxge_vlans_active(sc) (sc)->ifp->if_nvlans
  66 #else
  67 #define mxge_vlans_active(sc) (sc)->ifp->if_vlantrunk
  68 #endif
  69
  70 #ifndef VLAN_TAG_VALUE
  71 #define MXGE_NEW_VLAN_API
  72 #endif
  73
  74 #ifndef IFCAP_LRO
  75 #define IFCAP_LRO 0
  76 #endif
  77
  78 #ifndef IFCAP_TSO
  79 #define IFCAP_TSO 0
  80 #endif
  81
  82 #ifndef IFCAP_TSO4
  83 #define IFCAP_TSO4 0
  84 #endif
  85
  86 #ifndef IFCAP_TSO6
  87 #define IFCAP_TSO6 0
  88 #endif
  89
  90 #ifndef IFCAP_TXCSUM_IPV6
  91 #define IFCAP_TXCSUM_IPV6 0
  92 #endif
  93
  94 #ifndef IFCAP_RXCSUM_IPV6
  95 #define IFCAP_RXCSUM_IPV6 0
  96 #endif
  97
  98 #ifndef CSUM_TSO
  99 #define CSUM_TSO 0
 100 #endif
 101
 102 #ifndef CSUM_TCP_IPV6
 103 #define CSUM_TCP_IPV6 0
 104 #endif
 105
 106 #ifndef CSUM_UDP_IPV6
 107 #define CSUM_UDP_IPV6 0
 108 #endif
 109
 110 #ifndef CSUM_DELAY_DATA_IPV6
 111 #define CSUM_DELAY_DATA_IPV6 0
 112 #endif
 113
 114 typedef struct {
 115         void *addr;
 116         bus_addr_t bus_addr;
 117         bus_dma_tag_t dmat;
 118         bus_dmamap_t map;
 119 } mxge_dma_t;
 120
 121 typedef struct {
 122         mcp_slot_t *entry;
 123         mxge_dma_t dma;
 124         int cnt;
 125         int idx;
 126         int mask;
 127 } mxge_rx_done_t;
 128
 129 typedef struct
 130 {
 131   uint32_t data0;
 132   uint32_t data1;
 133   uint32_t data2;
 134 } mxge_cmd_t;
 135
 136 struct mxge_rx_buffer_state {
 137         struct mbuf *m;
 138         bus_dmamap_t map;
 139 };
 140
 141 struct mxge_tx_buffer_state {
 142         struct mbuf *m;
 143         bus_dmamap_t map;
 144         int flag;
 145 };
 146
 147 typedef struct
 148 {
 149         volatile mcp_kreq_ether_recv_t *lanai;  /* lanai ptr for recv ring */
 150         mcp_kreq_ether_recv_t *shadow;  /* host shadow of recv ring */
 151         struct mxge_rx_buffer_state *info;
 152         bus_dma_tag_t dmat;
 153         bus_dmamap_t extra_map;
 154         int cnt;
 155         int nbufs;
 156         int cl_size;
 157         int alloc_fail;
 158         int mask;                       /* number of rx slots -1 */
 159         int mlen;
 160 } mxge_rx_ring_t;
 161
 162 typedef struct
 163 {
 164         struct mtx mtx;
 165 #ifdef IFNET_BUF_RING
 166         struct buf_ring *br;
 167 #endif
 168         volatile mcp_kreq_ether_send_t *lanai;  /* lanai ptr for sendq  */
 169         volatile uint32_t *send_go;             /* doorbell for sendq */
 170         volatile uint32_t *send_stop;           /* doorbell for sendq */
 171         mcp_kreq_ether_send_t *req_list;        /* host shadow of sendq */
 172         char *req_bytes;
 173         bus_dma_segment_t *seg_list;
 174         struct mxge_tx_buffer_state *info;
 175         bus_dma_tag_t dmat;
 176         int req;                        /* transmits submitted  */
 177         int mask;                       /* number of transmit slots -1 */
 178         int done;                       /* transmits completed  */
 179         int pkt_done;                   /* packets completed */
 180         int max_desc;                   /* max descriptors per xmit */
 181         int queue_active;               /* fw currently polling this queue*/
 182         int activate;
 183         int deactivate;
 184         int stall;                      /* #times hw queue exhausted */
 185         int wake;                       /* #times irq re-enabled xmit */
 186         int watchdog_req;               /* cache of req */
 187         int watchdog_done;              /* cache of done */
 188         int watchdog_rx_pause;          /* cache of pause rq recvd */
 189         int defrag;
 190         char mtx_name[16];
 191 } mxge_tx_ring_t;
 192
 193 struct mxge_softc;
 194 typedef struct mxge_softc mxge_softc_t;
 195
 196 struct mxge_slice_state {
 197         mxge_softc_t *sc;
 198         mxge_tx_ring_t tx;              /* transmit ring        */
 199         mxge_rx_ring_t rx_small;
 200         mxge_rx_ring_t rx_big;
 201         mxge_rx_done_t rx_done;
 202         mcp_irq_data_t *fw_stats;
 203         volatile uint32_t *irq_claim;
 204         u_long ipackets;
 205         u_long opackets;
 206         u_long obytes;
 207         u_long omcasts;
 208         u_long oerrors;
 209         int if_drv_flags;
 210         struct lro_ctrl lc;
 211         mxge_dma_t fw_stats_dma;
 212         struct sysctl_oid *sysctl_tree;
 213         struct sysctl_ctx_list sysctl_ctx;
 214         char scratch[256];
 215 };
 216
 217 struct mxge_softc {
 218         struct ifnet* ifp;
 219         struct mxge_slice_state *ss;
 220         int tx_boundary;                /* boundary transmits cannot cross*/
 221         int lro_cnt;
 222         bus_dma_tag_t   parent_dmat;
 223         volatile uint8_t *sram;
 224         int sram_size;
 225         volatile uint32_t *irq_deassert;
 226         mcp_cmd_response_t *cmd;
 227         mxge_dma_t cmd_dma;
 228         mxge_dma_t zeropad_dma;
 229         struct pci_dev *pdev;
 230         int legacy_irq;
 231         int link_state;
 232         unsigned int rdma_tags_available;
 233         int intr_coal_delay;
 234         volatile uint32_t *intr_coal_delay_ptr;
 235         int wc;
 236         struct mtx cmd_mtx;
 237         struct mtx driver_mtx;
 238         int wake_queue;
 239         int stop_queue;
 240         int down_cnt;
 241         int watchdog_resets;
 242         int watchdog_countdown;
 243         int pause;
 244         struct resource *mem_res;
 245         struct resource *irq_res;
 246         struct resource **msix_irq_res;
 247         struct resource *msix_table_res;
 248         struct resource *msix_pba_res;
 249         void *ih;
 250         void **msix_ih;
 251         char *fw_name;
 252         char eeprom_strings[MXGE_EEPROM_STRINGS_SIZE];
 253         char fw_version[128];
 254         int fw_ver_major;
 255         int fw_ver_minor;
 256         int fw_ver_tiny;
 257         int adopted_rx_filter_bug;
 258         device_t dev;
 259         struct ifmedia media;
 260         int read_dma;
 261         int write_dma;
 262         int read_write_dma;
 263         int fw_multicast_support;
 264         int link_width;
 265         int max_mtu;
 266         int throttle;
 267         int tx_defrag;
 268         int media_flags;
 269         int need_media_probe;
 270         int num_slices;
 271         int rx_ring_size;
 272         int dying;
 273         int connector;
 274         int current_media;
 275         int max_tso6_hlen;
 276         mxge_dma_t dmabench_dma;
 277         struct callout co_hdl;
 278         struct taskqueue *tq;
 279         struct task watchdog_task;
 280         struct sysctl_oid *slice_sysctl_tree;
 281         struct sysctl_ctx_list slice_sysctl_ctx;
 282         char *mac_addr_string;
 283         uint8_t mac_addr[6];            /* eeprom mac address */
 284         uint16_t pectl;                 /* save PCIe CTL state */
 285         char product_code_string[64];
 286         char serial_number_string[64];
 287         char cmd_mtx_name[16];
 288         char driver_mtx_name[16];
 289 };
 290
 291 #define MXGE_PCI_VENDOR_MYRICOM         0x14c1
 292 #define MXGE_PCI_DEVICE_Z8E     0x0008
 293 #define MXGE_PCI_DEVICE_Z8E_9   0x0009
 294 #define MXGE_PCI_REV_Z8E        0
 295 #define MXGE_PCI_REV_Z8ES       1
 296 #define MXGE_XFP_COMPLIANCE_BYTE        131
 297 #define MXGE_SFP_COMPLIANCE_BYTE          3
 298 #define MXGE_MIN_THROTTLE       416
 299 #define MXGE_MAX_THROTTLE       4096
 300
 301 /* Types of connectors on NICs supported by this driver */
 302 #define MXGE_CX4 0
 303 #define MXGE_XFP 1
 304 #define MXGE_SFP 2
 305 #define MXGE_QRF 3
 306
 307 #define MXGE_HIGHPART_TO_U32(X) \
 308 (sizeof (X) == 8) ? ((uint32_t)((uint64_t)(X) >> 32)) : (0)
 309 #define MXGE_LOWPART_TO_U32(X) ((uint32_t)(X))
 310
 311 struct mxge_media_type
 312 {
 313         int flag;
 314         uint8_t bitmask;
 315         char *name;
 316 };
 317
 318 struct mxge_pkt_info {
 319         int ip_off;
 320         int ip_hlen;
 321         struct ip *ip;
 322         struct ip6_hdr *ip6;
 323         struct tcphdr *tcp;
 324 };
 325
 326 static inline void
 327 mxge_pio_copy(volatile void *to_v, void *from_v, size_t size)
 328 {
 329   register volatile uintptr_t *to;
 330   volatile uintptr_t *from;
 331   size_t i;
 332
 333   to = (volatile uintptr_t *) to_v;
 334   from = from_v;
 335   for (i = (size / sizeof (uintptr_t)); i; i--) {
 336           *to = *from;
 337           to++;
 338           from++;
 339   }
 340
 341 }
 342
 343 void mxge_lro_flush(struct mxge_slice_state *ss, struct lro_entry *lro);
 344 int mxge_lro_rx(struct mxge_slice_state *ss, struct mbuf *m_head,
 345                 uint32_t csum);
 346
 347
 348 /*
 349   This file uses Myri10GE driver indentation.
 350
 351   Local Variables:
 352   c-file-style:"linux"
 353   tab-width:8
 354   End:
 355 */