sys/dev/netif/mxge/if_mxge_var.h

   1 /*******************************************************************************
   2
   3 Copyright (c) 2006-2013, Myricom Inc.
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions are met:
   8
   9  1. Redistributions of source code must retain the above copyright notice,
  10     this list of conditions and the following disclaimer.
  11
  12  2. Neither the name of the Myricom Inc, nor the names of its
  13     contributors may be used to endorse or promote products derived from
  14     this software without specific prior written permission.
  15
  16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  20 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26 POSSIBILITY OF SUCH DAMAGE.
  27
  28 $FreeBSD: head/sys/dev/mxge/if_mxge_var.h 247160 2013-02-22 19:23:33Z gallatin $
  29
  30 ***************************************************************************/
  31
  32 #define MXGE_ETH_STOPPED                0
  33 #define MXGE_ETH_STOPPING               1
  34 #define MXGE_ETH_STARTING               2
  35 #define MXGE_ETH_RUNNING                3
  36 #define MXGE_ETH_OPEN_FAILED            4
  37
  38 #define MXGE_FW_OFFSET                  (1024*1024)
  39 #define MXGE_EEPROM_STRINGS_SIZE        256
  40 #define MXGE_MAX_SEND_DESC              128
  41
  42 #define MXGE_INTR_COAL_DELAY            150
  43
  44 typedef struct {
  45         mcp_slot_t *entry;
  46         bus_dmamem_t dma;
  47         int cnt;
  48         int idx;
  49         int mask;
  50 } mxge_rx_done_t;
  51
  52 typedef struct {
  53         uint32_t data0;
  54         uint32_t data1;
  55         uint32_t data2;
  56 } mxge_cmd_t;
  57
  58 struct mxge_rx_buffer_state {
  59         struct mbuf *m;
  60         bus_dmamap_t map;
  61 };
  62
  63 struct mxge_tx_buffer_state {
  64         struct mbuf *m;
  65         bus_dmamap_t map;
  66         int flag;
  67 };
  68
  69 typedef struct {
  70         volatile mcp_kreq_ether_recv_t *lanai;  /* lanai ptr for recv ring */
  71         mcp_kreq_ether_recv_t *shadow;  /* host shadow of recv ring */
  72         struct mxge_rx_buffer_state *info;
  73         bus_dma_tag_t dmat;
  74         bus_dmamap_t extra_map;
  75         int cnt;
  76         int cl_size;
  77         int alloc_fail;
  78         int mask;                       /* number of rx slots -1 */
  79         int mlen;
  80 } mxge_rx_ring_t;
  81
  82 typedef struct {
  83         volatile mcp_kreq_ether_send_t *lanai;  /* lanai ptr for sendq  */
  84         volatile uint32_t *send_go;             /* doorbell for sendq */
  85         volatile uint32_t *send_stop;           /* doorbell for sendq */
  86         mcp_kreq_ether_send_t *req_list;        /* host shadow of sendq */
  87         bus_dma_segment_t *seg_list;
  88         struct mxge_tx_buffer_state *info;
  89         bus_dma_tag_t dmat;
  90         int req;                        /* transmits submitted  */
  91         int mask;                       /* number of transmit slots -1 */
  92         int done;                       /* transmits completed  */
  93         int pkt_done;                   /* packets completed */
  94         int max_desc;                   /* max descriptors per xmit */
  95         int queue_active;               /* fw currently polling this queue*/
  96         int activate;
  97         int deactivate;
  98         int watchdog_rx_pause;          /* cache of pause rq recvd */
  99 } mxge_tx_ring_t;
 100
 101 struct mxge_softc;
 102 typedef struct mxge_softc mxge_softc_t;
 103
 104 struct mxge_slice_state {
 105         mxge_softc_t *sc;
 106         mxge_tx_ring_t tx;              /* transmit ring */
 107         mxge_rx_ring_t rx_small;
 108         mxge_rx_ring_t rx_big;
 109         mxge_rx_done_t rx_done;
 110         mcp_irq_data_t *fw_stats;
 111         volatile uint32_t *irq_claim;
 112         u_long ipackets;
 113         u_long opackets;
 114         u_long oerrors;
 115         bus_dmamem_t fw_stats_dma;
 116         struct sysctl_oid *sysctl_tree;
 117         struct sysctl_ctx_list sysctl_ctx;
 118 };
 119
 120 struct mxge_softc {
 121         struct arpcom arpcom;
 122         struct ifnet* ifp;              /* points to arpcom.ac_if */
 123         struct mxge_slice_state *ss;
 124         int tx_boundary;                /* boundary transmits cannot cross*/
 125         bus_dma_tag_t parent_dmat;
 126         volatile uint8_t *sram;
 127         int sram_size;
 128         volatile uint32_t *irq_deassert;
 129         mcp_cmd_response_t *cmd;
 130         bus_dmamem_t cmd_dma;
 131         bus_dmamem_t zeropad_dma;
 132         struct pci_dev *pdev;
 133         int irq_rid;
 134         int irq_type;
 135         int link_state;
 136         unsigned int rdma_tags_available;
 137         int intr_coal_delay;
 138         volatile uint32_t *intr_coal_delay_ptr;
 139         int wc;
 140         int wake_queue;
 141         int stop_queue;
 142         int down_cnt;
 143         int watchdog_resets;
 144         int pause;
 145         struct resource *mem_res;
 146         struct resource *irq_res;
 147         struct resource **msix_irq_res;
 148         struct resource *msix_table_res;
 149         struct resource *msix_pba_res;
 150         void *ih;
 151         void **msix_ih;
 152         const char *fw_name;
 153         char eeprom_strings[MXGE_EEPROM_STRINGS_SIZE];
 154         char fw_version[128];
 155         int fw_ver_major;
 156         int fw_ver_minor;
 157         int fw_ver_tiny;
 158         int adopted_rx_filter_bug;
 159         device_t dev;
 160         struct ifmedia media;
 161         int read_dma;
 162         int write_dma;
 163         int read_write_dma;
 164         int fw_multicast_support;
 165         int link_width;
 166         int max_mtu;
 167         int throttle;
 168         int media_flags;
 169         int need_media_probe;
 170         int num_slices;
 171         int rx_ring_size;
 172         int dying;
 173         int connector;
 174         int current_media;
 175         bus_dmamem_t dmabench_dma;
 176         struct callout co_hdl;
 177         struct sysctl_ctx_list sysctl_ctx;
 178         struct sysctl_oid *sysctl_tree;
 179         struct sysctl_oid *slice_sysctl_tree;
 180         struct sysctl_ctx_list slice_sysctl_ctx;
 181         uint8_t mac_addr[6];            /* eeprom mac address */
 182         uint16_t pectl;                 /* save PCIe CTL state */
 183         char product_code_string[64];
 184         char serial_number_string[64];
 185 };
 186
 187 #define MXGE_PCI_VENDOR_MYRICOM         0x14c1
 188 #define MXGE_PCI_DEVICE_Z8E             0x0008
 189 #define MXGE_PCI_DEVICE_Z8E_9           0x0009
 190 #define MXGE_PCI_REV_Z8E                0
 191 #define MXGE_PCI_REV_Z8ES               1
 192
 193 #define MXGE_XFP_COMPLIANCE_BYTE        131
 194 #define MXGE_SFP_COMPLIANCE_BYTE        3
 195
 196 #define MXGE_MIN_THROTTLE               416
 197 #define MXGE_MAX_THROTTLE               4096
 198
 199 /* Types of connectors on NICs supported by this driver */
 200 #define MXGE_CX4 0
 201 #define MXGE_XFP 1
 202 #define MXGE_SFP 2
 203 #define MXGE_QRF 3
 204
 205 #define MXGE_HIGHPART_TO_U32(X) \
 206         (sizeof (X) == 8) ? ((uint32_t)((uint64_t)(X) >> 32)) : (0)
 207 #define MXGE_LOWPART_TO_U32(X) ((uint32_t)(X))
 208
 209 struct mxge_media_type {
 210         int flag;
 211         uint8_t bitmask;
 212         char *name;
 213 };
 214
 215 #if defined(__GNUC__)
 216 #if defined(__i386__) || defined(__x86_64__)
 217 #define wmb()  __asm__ __volatile__ ("sfence;": : :"memory")
 218 #else
 219 #error "unknown arch"
 220 #endif
 221 #else
 222 #error "unknown compiler"
 223 #endif
 224
 225 static __inline void
 226 mxge_pio_copy(volatile void *to_v, void *from_v, size_t size)
 227 {
 228         register volatile uintptr_t *to;
 229         volatile uintptr_t *from;
 230         size_t i;
 231
 232         to = (volatile uintptr_t *)to_v;
 233         from = from_v;
 234         for (i = (size / sizeof(uintptr_t)); i; i--) {
 235                 *to = *from;
 236                 to++;
 237                 from++;
 238         }
 239 }