sys/dev/netif/jme/if_jmevar.h

   1 /*-
   2  * Copyright (c) 2008, Pyun YongHyeon <yongari@FreeBSD.org>
   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
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * 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 AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD: src/sys/dev/jme/if_jmevar.h,v 1.1 2008/05/27 01:42:01 yongari Exp $
  28  * $DragonFly: src/sys/dev/netif/jme/if_jmevar.h,v 1.8 2008/11/26 11:55:18 sephe Exp $
  29  */
  30
  31 #ifndef _IF_JMEVAR_H
  32 #define _IF_JMEVAR_H
  33
  34 #include <sys/queue.h>
  35 #include <sys/callout.h>
  36 #include <sys/taskqueue.h>
  37
  38 /*
  39  * JMC250 supports upto JME_NDESC_MAX descriptors and the number of
  40  * descriptors should be multiple of JME_NDESC_ALIGN.
  41  */
  42 #define JME_TX_DESC_CNT_DEF     384
  43 #define JME_RX_DESC_CNT_DEF     256
  44
  45 #define JME_NDESC_ALIGN         16
  46 #define JME_NDESC_MAX           1024
  47
  48 #define JME_NRXRING_MAX         4
  49
  50 /*
  51  * Tx/Rx descriptor queue base should be 16bytes aligned and
  52  * should not cross 4G bytes boundary on the 64bits address
  53  * mode.
  54  */
  55 #define JME_TX_RING_ALIGN       16
  56 #define JME_RX_RING_ALIGN       16
  57 #define JME_TSO_MAXSEGSIZE      4096
  58 #define JME_TSO_MAXSIZE         (65535 + sizeof(struct ether_vlan_header))
  59 #define JME_MAXTXSEGS           32
  60 #define JME_RX_BUF_ALIGN        sizeof(uint64_t)
  61 #define JME_SSB_ALIGN           16
  62
  63 #define JME_ADDR_LO(x)          ((uint64_t) (x) & 0xFFFFFFFF)
  64 #define JME_ADDR_HI(x)          ((uint64_t) (x) >> 32)
  65
  66 #define JME_MSI_MESSAGES        8
  67 #define JME_MSIX_MESSAGES       8
  68
  69 /* Water mark to kick reclaiming Tx buffers. */
  70 #define JME_TX_DESC_HIWAT(sc)   \
  71         ((sc)->jme_tx_desc_cnt - (((sc)->jme_tx_desc_cnt * 3) / 10))
  72
  73 /*
  74  * JMC250 can send 9K jumbo frame on Tx path and can receive
  75  * 65535 bytes.
  76  */
  77 #define JME_JUMBO_FRAMELEN      9216
  78 #define JME_JUMBO_MTU                                                   \
  79         (JME_JUMBO_FRAMELEN - sizeof(struct ether_vlan_header) -        \
  80          ETHER_HDR_LEN - ETHER_CRC_LEN)
  81 #define JME_MAX_MTU                                                     \
  82         (ETHER_MAX_LEN + sizeof(struct ether_vlan_header) -             \
  83          ETHER_HDR_LEN - ETHER_CRC_LEN)
  84 /*
  85  * JMC250 can't handle Tx checksum offload/TSO if frame length
  86  * is larger than its FIFO size(2K). It's also good idea to not
  87  * use jumbo frame if hardware is running at half-duplex media.
  88  * Because the jumbo frame may not fit into the Tx FIFO,
  89  * collisions make hardware fetch frame from host memory with
  90  * DMA again which in turn slows down Tx performance
  91  * significantly.
  92  */
  93 #define JME_TX_FIFO_SIZE        2000
  94 /*
  95  * JMC250 has just 4K Rx FIFO. To support jumbo frame that is
  96  * larger than 4K bytes in length, Rx FIFO threshold should be
  97  * adjusted to minimize Rx FIFO overrun.
  98  */
  99 #define JME_RX_FIFO_SIZE        4000
 100
 101 #define JME_DESC_INC(x, y)      ((x) = ((x) + 1) % (y))
 102
 103 struct jme_txdesc {
 104         struct mbuf             *tx_m;
 105         bus_dmamap_t            tx_dmamap;
 106         int                     tx_ndesc;
 107         struct jme_desc         *tx_desc;
 108 };
 109
 110 struct jme_rxdesc {
 111         struct mbuf             *rx_m;
 112         bus_dmamap_t            rx_dmamap;
 113         struct jme_desc         *rx_desc;
 114 };
 115
 116 /*
 117  * RX ring/descs
 118  */
 119 struct jme_rxdata {
 120         bus_dma_tag_t           jme_rx_tag;     /* RX mbuf tag */
 121         bus_dmamap_t            jme_rx_sparemap;
 122         struct jme_rxdesc       *jme_rxdesc;
 123
 124         struct jme_desc         *jme_rx_ring;
 125         bus_addr_t              jme_rx_ring_paddr;
 126         bus_dma_tag_t           jme_rx_ring_tag;
 127         bus_dmamap_t            jme_rx_ring_map;
 128
 129         int                     jme_rx_cons;
 130
 131         int                     jme_rxlen;
 132         struct mbuf             *jme_rxhead;
 133         struct mbuf             *jme_rxtail;
 134 };
 135
 136 struct jme_chain_data {
 137         /*
 138          * Top level tags
 139          */
 140         bus_dma_tag_t           jme_ring_tag;   /* parent ring tag */
 141         bus_dma_tag_t           jme_buffer_tag; /* parent mbuf/ssb tag */
 142
 143         /*
 144          * Shadow status block
 145          */
 146         struct jme_ssb          *jme_ssb_block;
 147         bus_addr_t              jme_ssb_block_paddr;
 148         bus_dma_tag_t           jme_ssb_tag;
 149         bus_dmamap_t            jme_ssb_map;
 150
 151         /*
 152          * TX ring/descs
 153          */
 154         bus_dma_tag_t           jme_tx_tag;     /* TX mbuf tag */
 155         struct jme_txdesc       *jme_txdesc;
 156
 157         struct jme_desc         *jme_tx_ring;
 158         bus_addr_t              jme_tx_ring_paddr;
 159         bus_dma_tag_t           jme_tx_ring_tag;
 160         bus_dmamap_t            jme_tx_ring_map;
 161
 162         int                     jme_tx_prod;
 163         int                     jme_tx_cons;
 164         int                     jme_tx_cnt;
 165
 166         struct jme_rxdata       jme_rx_data[JME_NRXRING_MAX];
 167 };
 168
 169 #define JME_TX_RING_SIZE(sc)    \
 170     (sizeof(struct jme_desc) * (sc)->jme_tx_desc_cnt)
 171 #define JME_RX_RING_SIZE(sc)    \
 172     (sizeof(struct jme_desc) * (sc)->jme_rx_desc_cnt)
 173 #define JME_SSB_SIZE            sizeof(struct jme_ssb)
 174
 175 struct jme_dmamap_ctx {
 176         int                     nsegs;
 177         bus_dma_segment_t       *segs;
 178 };
 179
 180 /*
 181  * Software state per device.
 182  */
 183 struct jme_softc {
 184         struct arpcom           arpcom;
 185         device_t                jme_dev;
 186
 187         int                     jme_mem_rid;
 188         struct resource         *jme_mem_res;
 189         bus_space_tag_t         jme_mem_bt;
 190         bus_space_handle_t      jme_mem_bh;
 191
 192         int                     jme_irq_rid;
 193         struct resource         *jme_irq_res;
 194         void                    *jme_irq_handle;
 195
 196         device_t                jme_miibus;
 197         int                     jme_phyaddr;
 198         bus_addr_t              jme_lowaddr;
 199
 200         uint32_t                jme_clksrc;
 201         uint32_t                jme_clksrc_1000;
 202         uint32_t                jme_tx_dma_size;
 203         uint32_t                jme_rx_dma_size;
 204
 205         uint32_t                jme_caps;
 206 #define JME_CAP_FPGA            0x0001
 207 #define JME_CAP_PCIE            0x0002
 208 #define JME_CAP_PMCAP           0x0004
 209 #define JME_CAP_FASTETH         0x0008
 210 #define JME_CAP_JUMBO           0x0010
 211 #define JME_CAP_RSS             0x0020
 212
 213         uint32_t                jme_workaround;
 214 #define JME_WA_EXTFIFO          0x0001
 215 #define JME_WA_HDX              0x0002
 216
 217         uint32_t                jme_flags;
 218 #define JME_FLAG_MSI            0x0001
 219 #define JME_FLAG_MSIX           0x0002
 220 #define JME_FLAG_DETACH         0x0004
 221 #define JME_FLAG_LINK           0x0008
 222 #define JME_FLAG_RSS            0x0010
 223
 224         struct callout          jme_tick_ch;
 225         struct jme_chain_data   jme_cdata;
 226         int                     jme_if_flags;
 227         uint32_t                jme_txcsr;
 228         uint32_t                jme_rxcsr;
 229         int                     jme_rx_ring_inuse;
 230
 231         int                     jme_txd_spare;
 232
 233         struct sysctl_ctx_list  jme_sysctl_ctx;
 234         struct sysctl_oid       *jme_sysctl_tree;
 235
 236         /*
 237          * Sysctl variables
 238          */
 239         int                     jme_tx_coal_to;
 240         int                     jme_tx_coal_pkt;
 241         int                     jme_rx_coal_to;
 242         int                     jme_rx_coal_pkt;
 243         int                     jme_rx_desc_cnt;
 244         int                     jme_tx_desc_cnt;
 245         int                     jme_rx_ring_cnt;
 246 };
 247
 248 /* Register access macros. */
 249 #define CSR_WRITE_4(_sc, reg, val)      \
 250         bus_space_write_4((_sc)->jme_mem_bt, (_sc)->jme_mem_bh, (reg), (val))
 251 #define CSR_READ_4(_sc, reg)            \
 252         bus_space_read_4((_sc)->jme_mem_bt, (_sc)->jme_mem_bh, (reg))
 253
 254 #define JME_MAXERR      5
 255
 256 #define JME_RXCHAIN_RESET(sc, ring)                             \
 257 do {                                                            \
 258         (sc)->jme_cdata.jme_rx_data[(ring)].jme_rxhead = NULL;  \
 259         (sc)->jme_cdata.jme_rx_data[(ring)].jme_rxtail = NULL;  \
 260         (sc)->jme_cdata.jme_rx_data[(ring)].jme_rxlen = 0;      \
 261 } while (0)
 262
 263 #define JME_TX_TIMEOUT          5
 264 #define JME_TIMEOUT             1000
 265 #define JME_PHY_TIMEOUT         1000
 266 #define JME_EEPROM_TIMEOUT      1000
 267
 268 #define JME_TXD_RSVD            1
 269
 270 #endif